regis

CRMTaxReceiptsRequest

**Requires Authentication**
Required role:	REGISUserRole

The following routes are available for this service:
POST	/DynamicsCRM/TaxReceipts
POST	/DynamicsCRM/TaxReceipts/{regent_id}

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CRMTaxReceiptResponse:
    regent_id: int = 0
    donor_first_name: Optional[str] = None
    donor_last_name: Optional[str] = None
    guid: Optional[str] = None
    title: Optional[str] = None
    total_paid_amount: Decimal = decimal.Decimal(0)
    total_receipt_amount: Decimal = decimal.Decimal(0)
    is_annual: bool = False
    year: Optional[int] = None
    has_document: bool = False
    tax_receipt_send_method: Optional[str] = None
    status: Optional[str] = None
    tax_receipt_template_guid: Optional[str] = None
    tax_receipt_template_name: Optional[str] = None
    tax_receipt_email: Optional[str] = None
    email_sent_date: Optional[datetime.datetime] = None
    email_sent_to: Optional[str] = None
    gift_date: Optional[datetime.datetime] = None
    sent_date: Optional[datetime.datetime] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CRMTaxReceiptsResponse:
    response_status: Optional[ResponseStatus] = None
    tax_receipts: Optional[List[CRMTaxReceiptResponse]] = None
    from_date: Optional[datetime.datetime] = None
    to_date: Optional[datetime.datetime] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CRMTaxReceiptsRequest:
    regent_id: Optional[int] = None
    from_date: Optional[datetime.datetime] = None
    to_date: Optional[datetime.datetime] = None
    has_document: bool = False
    year: Optional[int] = None

Python CRMTaxReceiptsRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /DynamicsCRM/TaxReceipts HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CRMTaxReceiptsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.DynamicsCRM.Requests">
  <from_date>0001-01-01T00:00:00</from_date>
  <has_document>false</has_document>
  <regent_id>0</regent_id>
  <to_date>0001-01-01T00:00:00</to_date>
  <year>0</year>
</CRMTaxReceiptsRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CRMTaxReceiptsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.DynamicsCRM.Responses">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <from_date>0001-01-01T00:00:00</from_date>
  <tax_receipts>
    <CRMTaxReceiptResponse>
      <donor_first_name>String</donor_first_name>
      <donor_last_name>String</donor_last_name>
      <email_sent_date>0001-01-01T00:00:00</email_sent_date>
      <email_sent_to>String</email_sent_to>
      <gift_date>0001-01-01T00:00:00</gift_date>
      <guid>String</guid>
      <has_document>false</has_document>
      <is_annual>false</is_annual>
      <regent_id>0</regent_id>
      <sent_date>0001-01-01T00:00:00</sent_date>
      <status>String</status>
      <tax_receipt_email>String</tax_receipt_email>
      <tax_receipt_send_method>String</tax_receipt_send_method>
      <tax_receipt_template_guid>String</tax_receipt_template_guid>
      <tax_receipt_template_name>String</tax_receipt_template_name>
      <title>String</title>
      <total_paid_amount>0</total_paid_amount>
      <total_receipt_amount>0</total_receipt_amount>
      <year>0</year>
    </CRMTaxReceiptResponse>
  </tax_receipts>
  <to_date>0001-01-01T00:00:00</to_date>
</CRMTaxReceiptsResponse>