Private Tax Year PDF

The REST call Get Tax Year PDF provides a single Compassion tax statement on file for a sponsor. The statements do not go any farther back than the 2013 tax statement.

This service runs in conjunction with Private Tax Years Available, which returns the tax years of Compassion tax statements on file for a sponsor.

Sample Request
Request Parameters
Response Parameters
Sample Unsuccessful Response
Error Response Codes

Sample Request

This is an example only.

Prod:    https://api2.compassion.com/US/1/pdfservice/constituent/taxreceipts/pdf?ConId=[string]&TaxYear=[yyyy]ClientReferenceId=[string]&api_key=[string]

Request Parameters

Name Description Required Data Type Constraints
ConId ConId (Constituent Id) is assigned by Compassion International to an individual or group. Yes String Max 10
TaxYear One tax year returned by a call to Private Tax Years Available Yes YYYY Only one tax year
ClientReferenceId Uniquely represents the transaction in the client's system. Optional String Max 100
api_key Your Mashery supplied key for an application running Compassion International services. Yes String  

Response Parameters

Name Description
Returns a PDF file

Sample Unsuccessful Response

The service operation will provide the following response when there are missing required parameters.
Exception Returned: (ResponseCode = "1", HTTP Status Code ="404")

<TaxReceiptsPdf xmlns="http://schemas.ci.org/ci/services/constituent/2011/06 / " ResponseCode="1" SchemaVersion="1.0">
  <ExceptionMessage>Incorrect tax year.</ExceptionMessage>
</TaxReceiptsPdf>

Error Response Codes

For ResponseCode = 1, the table below indicates the HTTP error response and HTTP Error message.

HTTP Error Response HTTP Error Message
HTTP 400 Service Parameter Failure
HTTP 401 Not Authenticated / Authorized for Service Data
HTTP 403 Not Authorized
HTTP 403 Account Inactive
HTTP 403 Over Queries Per Second Limit
HTTP 403 Over Rate Limit
HTTP 403 Unknown Referrer
HTTP 404 Requested Resource Not Found
HTTP 408 Request Timeout
HTTP 414 Request URI Too Long
HTTP 500 Internal Server Error
HTTP 502 Bad Gateway
HTTP 503 API Maintenance / Service Unavailable
HTTP 504 Gateway Timeout

Docs Navigation