| Required role: | REGISUserRole |
| POST | /DynamicsCRM/TaxReceipts | ||
|---|---|---|---|
| POST | /DynamicsCRM/TaxReceipts/{regent_id} |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| regent_id | path | int? | No | |
| from_date | body | DateTime? | No | |
| to_date | body | DateTime? | No | |
| has_document | body | bool | No | |
| year | body | int? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No | |
| tax_receipts | form | List<CRMTaxReceiptResponse> | No | |
| from_date | form | DateTime? | No | |
| to_date | form | DateTime? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| regent_id | form | int | No | |
| donor_first_name | form | string | No | |
| donor_last_name | form | string | No | |
| guid | form | string | No | |
| title | form | string | No | |
| total_paid_amount | form | decimal | No | |
| total_receipt_amount | form | decimal | No | |
| is_annual | form | bool | No | |
| year | form | int? | No | |
| has_document | form | bool | No | |
| tax_receipt_send_method | form | string | No | |
| status | form | string | No | |
| tax_receipt_template_guid | form | string | No | |
| tax_receipt_template_name | form | string | No | |
| tax_receipt_email | form | string | No | |
| email_sent_date | form | DateTime? | No | |
| email_sent_to | form | string | No | |
| gift_date | form | DateTime? | No | |
| sent_date | form | DateTime? | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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
}