API reference · Donations
Create a donation fiscal receipt
POST/v1/donations/{donationId}/fiscal-receipts
Generate the fiscal receipt linked to this donation. Only available for B2C donations created with hasBeenCharged and withFiscalReceipt set to true.
Requires a Bearer access token.
Parameters
This field has no description in the spec.
donationId#stringin pathrequired
Response
200 · FiscalReceiptNo field is described in the spec.
fiscalReceiptId#stringalways returnedamount#integer (int64)always returnedfiscalReceiptNumber#stringalways returneddonationDate#string (date-time)always returnedtype#FiscalReceiptTypealways returnedYEARLYSINGLE_DONATIONisLegacy#booleanalways returnedaccountId#stringalways returnedcharityId#stringalways returnedbeneficiaryId#stringalways returnedcreatedAt#string (date-time)always returnedupdatedAt#string (date-time)always returned
Errors
- 401 Unauthorized
Unauthorized
Missing, expired or invalid access token.
{ "statusCode": 401, "message": "Unauthorized" }- 402 Payment Required
Plan upgrade required
{ "statusCode": 402, "message": "Plan upgrade required" }- 403 Forbidden
Only avaible for donation created with hasBeenCharged set to true.
{ "statusCode": 403, "message": "Only avaible for donation created with hasBeenCharged set to true.", "error": "Forbidden" }Only avaible for donation created with withFiscalReceipt set to true.
{ "statusCode": 403, "message": "Only avaible for donation created with withFiscalReceipt set to true.", "error": "Forbidden" }Donation has not been processed yet.
{ "statusCode": 403, "message": "Donation has not been processed yet.", "error": "Forbidden" }Donor is missing required fiscal information.
{ "statusCode": 403, "message": "Donor is missing required fiscal information.", "error": "Forbidden" }This charity does not support fiscal receipts.
{ "statusCode": 403, "message": "This charity does not support fiscal receipts.", "error": "Forbidden" }Account closed
{ "message": "Account closed", "code": "ACCOUNT_CLOSED" }Forbidden
Your credentials cannot perform this action on this resource. An id from another account answers 404 in the path, 400 in the body or the query.
{ "statusCode": 403, "message": "Forbidden" }- 404 Not Found
Not Found
No resource with this id on your account: the API answers as if it did not exist.
{ "statusCode": 404, "message": "Not Found" }
curl -X POST https://api.sandbox.charitips.com/v1/donations/<donationId>/fiscal-receipts \ -H "Authorization: Bearer $CHARITIPS_TOKEN"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.