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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
Content-Type: application/json
Content-Length: length

{"regent_id":0,"from_date":"0001-01-01T00:00:00.0000000","to_date":"0001-01-01T00:00:00.0000000","has_document":false,"year":0}
HTTP/1.1 200 OK
Content-Type: application/json
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-01T00:00:00.0000000","email_sent_to":"String","gift_date":"0001-01-01T00:00:00.0000000","sent_date":"0001-01-01T00:00:00.0000000"}],"from_date":"0001-01-01T00:00:00.0000000","to_date":"0001-01-01T00:00:00.0000000"}