Skip to content
Aller au contenu
Charitips

API reference · Fiscal Receipts

Generate a fiscal receipts bulk download url

POST/v1/fiscal-receipts/bulk-download

Generate a download url for each provided fiscal receipts. ⚠️ This endpoint is rate limited.

Requires a Bearer access token.

Body

BulkDownloadFiscalReceiptsDto

This field has no description in the spec.

  • fiscalReceiptIds#string[]requiredUUID

Response

200 · DownloadUrl[]

No field is described in the spec.

  • filename#stringalways returned

  • downloadUrl#stringalways 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"
    }
  • 403Forbidden

    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"
    }
  • 404Not Found

    No resource with this id on your account: the API answers as if it did not exist.

    {
      "statusCode": 404,
      "message": "Not Found"
    }
  • 429Rate limit exceeded

    Too many calls to this endpoint in a short time.

    {
      "statusCode": 429,
      "message": "Rate limit exceeded"
    }
POST /v1/fiscal-receipts/bulk-download
curl -X POST https://api.sandbox.charitips.com/v1/fiscal-receipts/bulk-download \  -H "Authorization: Bearer $CHARITIPS_TOKEN" \  -H "Content-Type: application/json" \  -d '{    "fiscalReceiptIds": [      "<fiscalReceiptId>"    ]  }'
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.