Skip to content
Aller au contenu
Charitips

API reference · Invoices

List invoices

GET/v1/invoices

List all invoices.

Requires a Bearer access token.

Parameters

  • limit#numberin queryintegerminimum 1maximum 100

    The max number of items to return.

  • cursor#stringin queryUUID

    The id of the last item from the previous page. Used to fetch the next page.

  • accountId#stringin queryUUID

    Id of the account. Only useful for Platform customers to filter fiscal receipts by child accounts

  • status#stringin query

    Status of the invoices to filter by

    PENDINGPOSTEDPAYMENT_DUEPAIDNOT_PAIDVOIDED

  • campaignId#stringin queryUUID

    Id of the campaign to filter by

Response

200 · Invoice[]

No field is described in the spec.

  • invoiceId#stringalways returned

  • fiscalId#stringalways returned

  • status#InvoiceStatus

    PENDINGPOSTEDPAYMENT_DUEPAIDNOT_PAIDVOIDED

  • total#integer (int64)

  • date#string (date-time)

  • plan#string

  • donationVolume#integer (int64)

  • donationFee#integer (int64)

  • subscriptionFee#integer (int64)

  • chargesFee#integer (int64)

  • addonsFee#integer (int64)

  • tax#integer (int64)

  • taxItems#object

  • accountId#stringalways returned

  • campaignId#string

  • createdAt#string (date-time)always returned

  • updatedAt#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"
    }
GET /v1/invoices
curl -X GET https://api.sandbox.charitips.com/v1/invoices \  -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.