API reference · Invoices
List invoices
GET/v1/invoices
List all invoices.
Requires a Bearer access token.
Parameters
limit#numberin queryintegerminimum 1maximum 100The max number of items to return.
cursor#stringin queryUUIDThe id of the last item from the previous page. Used to fetch the next page.
accountId#stringin queryUUIDId of the account. Only useful for Platform customers to filter fiscal receipts by child accounts
status#stringin queryStatus of the invoices to filter by
PENDINGPOSTEDPAYMENT_DUEPAIDNOT_PAIDVOIDEDcampaignId#stringin queryUUIDId of the campaign to filter by
Response
200 · Invoice[]No field is described in the spec.
invoiceId#stringalways returnedfiscalId#stringalways returnedstatus#InvoiceStatusPENDINGPOSTEDPAYMENT_DUEPAIDNOT_PAIDVOIDEDtotal#integer (int64)date#string (date-time)plan#stringdonationVolume#integer (int64)donationFee#integer (int64)subscriptionFee#integer (int64)chargesFee#integer (int64)addonsFee#integer (int64)tax#integer (int64)taxItems#objectaccountId#stringalways returnedcampaignId#stringcreatedAt#string (date-time)always returnedupdatedAt#string (date-time)always returned
Errors
400A field is missing, has the wrong type, or is not part of the request schema.
Every request with a body or query is validated.
{ "statusCode": 400, "message": [ "amount must not be less than 1", "property foo should not exist" ], "error": "Bad Request" }401Unauthorized
Missing, expired or invalid access token.
{ "statusCode": 401, "message": "Unauthorized" }403Account closed
{ "message": "Account closed", "code": "ACCOUNT_CLOSED" }
curl -X GET https://api.sandbox.charitips.com/v1/invoices \ -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.