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}
"use strict";
export class CRMTaxReceiptResponse {
    /** @param {{regent_id?:number,donor_first_name?:string,donor_last_name?:string,guid?:string,title?:string,total_paid_amount?:number,total_receipt_amount?:number,is_annual?:boolean,year?:number,has_document?:boolean,tax_receipt_send_method?:string,status?:string,tax_receipt_template_guid?:string,tax_receipt_template_name?:string,tax_receipt_email?:string,email_sent_date?:string,email_sent_to?:string,gift_date?:string,sent_date?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    regent_id;
    /** @type {string} */
    donor_first_name;
    /** @type {string} */
    donor_last_name;
    /** @type {string} */
    guid;
    /** @type {string} */
    title;
    /** @type {number} */
    total_paid_amount;
    /** @type {number} */
    total_receipt_amount;
    /** @type {boolean} */
    is_annual;
    /** @type {?number} */
    year;
    /** @type {boolean} */
    has_document;
    /** @type {string} */
    tax_receipt_send_method;
    /** @type {string} */
    status;
    /** @type {string} */
    tax_receipt_template_guid;
    /** @type {string} */
    tax_receipt_template_name;
    /** @type {string} */
    tax_receipt_email;
    /** @type {?string} */
    email_sent_date;
    /** @type {string} */
    email_sent_to;
    /** @type {?string} */
    gift_date;
    /** @type {?string} */
    sent_date;
}
export class CRMTaxReceiptsResponse {
    /** @param {{responseStatus?:ResponseStatus,tax_receipts?:CRMTaxReceiptResponse[],from_date?:string,to_date?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {CRMTaxReceiptResponse[]} */
    tax_receipts;
    /** @type {?string} */
    from_date;
    /** @type {?string} */
    to_date;
}
export class CRMTaxReceiptsRequest {
    /** @param {{regent_id?:number,from_date?:string,to_date?:string,has_document?:boolean,year?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?number} */
    regent_id;
    /** @type {?string} */
    from_date;
    /** @type {?string} */
    to_date;
    /** @type {boolean} */
    has_document;
    /** @type {?number} */
    year;
}

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