regis

<back to all web services

CRMTaxReceiptsRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/DynamicsCRM/TaxReceipts
POST/DynamicsCRM/TaxReceipts/{regent_id}

export class CRMTaxReceiptResponse
{
    public regent_id: number;
    public donor_first_name: string;
    public donor_last_name: string;
    public guid: string;
    public title: string;
    public total_paid_amount: number;
    public total_receipt_amount: number;
    public is_annual: boolean;
    public year?: number;
    public has_document: boolean;
    public tax_receipt_send_method: string;
    public status: string;
    public tax_receipt_template_guid: string;
    public tax_receipt_template_name: string;
    public tax_receipt_email: string;
    public email_sent_date?: string;
    public email_sent_to: string;
    public gift_date?: string;
    public sent_date?: string;

    public constructor(init?: Partial<CRMTaxReceiptResponse>) { (Object as any).assign(this, init); }
}

export class CRMTaxReceiptsResponse
{
    public responseStatus: ResponseStatus;
    public tax_receipts: CRMTaxReceiptResponse[];
    public from_date?: string;
    public to_date?: string;

    public constructor(init?: Partial<CRMTaxReceiptsResponse>) { (Object as any).assign(this, init); }
}

export class CRMTaxReceiptsRequest
{
    public regent_id?: number;
    public from_date?: string;
    public to_date?: string;
    public has_document: boolean;
    public year?: number;

    public constructor(init?: Partial<CRMTaxReceiptsRequest>) { (Object as any).assign(this, init); }
}

TypeScript 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>