regis

<back to all web services

TaxReceiptListRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/TaxReceipt/{uuid}/List
TaxReceiptListRequest Parameters:
NameParameterData TypeRequiredDescription
uuidpathstringNo
TaxReceiptsResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
is_missing_tax_numberformboolNo
receiptsformList<TaxReceiptResponse>No
TaxReceiptResponse Parameters:
NameParameterData TypeRequiredDescription
is_t4aformboolNo
is_t2202aformboolNo
yearformintNo
urlformstringNo

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 /TaxReceipt/{uuid}/List HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"uuid":"String"}
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"}},"is_missing_tax_number":false,"receipts":[{"is_t4a":false,"is_t2202a":false,"year":0,"url":"String"}]}