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 .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	regent_id: 0,
	from_date: 0001-01-01,
	to_date: 0001-01-01,
	has_document: False,
	year: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	},
	tax_receipts: 
	[
		{
			regent_id: 0,
			donor_first_name: String,
			donor_last_name: String,
			guid: String,
			title: String,
			total_paid_amount: 0,
			total_receipt_amount: 0,
			is_annual: False,
			year: 0,
			has_document: False,
			tax_receipt_send_method: String,
			status: String,
			tax_receipt_template_guid: String,
			tax_receipt_template_name: String,
			tax_receipt_email: String,
			email_sent_date: 0001-01-01,
			email_sent_to: String,
			gift_date: 0001-01-01,
			sent_date: 0001-01-01
		}
	],
	from_date: 0001-01-01,
	to_date: 0001-01-01
}