API reference · Fiscal Receipts

Get a fiscal receipt

GET/v1/fiscal-receipts/{fiscalReceiptId}

Retrieve information about a fiscal receipt.

Requires a Bearer access token.

Parameters

This field has no description in the spec.

fiscalReceiptId#stringin pathrequired

Response

200 · FiscalReceipt

No field is described in the spec.

fiscalReceiptId#stringalways returned
amount#integer (int64)always returned
fiscalReceiptNumber#stringalways returned
donationDate#string (date-time)always returned
type#FiscalReceiptTypealways returned
YEARLYSINGLE_DONATION
isLegacy#booleanalways returned
accountId#stringalways returned
charityId#stringalways returned
beneficiaryId#stringalways returned
createdAt#string (date-time)always returned
updatedAt#string (date-time)always returned

Errors

401Unauthorized
Missing, expired or invalid access token.
```
{
  "statusCode": 401,
  "message": "Unauthorized"
}
```

403Account closed

{
  "message": "Account closed",
  "code": "ACCOUNT_CLOSED"
}

404Not Found

{
  "statusCode": 404,
  "message": "Not Found"
}

GET /v1/fiscal-receipts/<fiscalReceiptId>

1curl -X GET https://api.sandbox.charitips.com/v1/fiscal-receipts/<fiscalReceiptId> \2  -H "Authorization: Bearer $CHARITIPS_TOKEN"

Built from the spec and the API code

Request bodies are written for this docs and checked against the API's validation; ids in angle brackets are placeholders. Response values are placeholders built from the schema.