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}
CRMTaxReceiptsRequest Parameters:
NameParameterData TypeRequiredDescription
regent_idpathint?No
from_datebodyDateTime?No
to_datebodyDateTime?No
has_documentbodyboolNo
yearbodyint?No
CRMTaxReceiptsResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
tax_receiptsformList<CRMTaxReceiptResponse>No
from_dateformDateTime?No
to_dateformDateTime?No
CRMTaxReceiptResponse Parameters:
NameParameterData TypeRequiredDescription
regent_idformintNo
donor_first_nameformstringNo
donor_last_nameformstringNo
guidformstringNo
titleformstringNo
total_paid_amountformdecimalNo
total_receipt_amountformdecimalNo
is_annualformboolNo
yearformint?No
has_documentformboolNo
tax_receipt_send_methodformstringNo
statusformstringNo
tax_receipt_template_guidformstringNo
tax_receipt_template_nameformstringNo
tax_receipt_emailformstringNo
email_sent_dateformDateTime?No
email_sent_toformstringNo
gift_dateformDateTime?No
sent_dateformDateTime?No

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

HTTP + CSV

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/csv
Content-Type: text/csv
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: text/csv
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"}