CAcardda
Payable

Get a PDF export

Returns a payable PDF export of the current user (exports of other users return 404). Exports belong to the user, so the company-id header is not used. Poll this endpoint every few seconds until status is completed, failed or expired.

Once completed, files holds one ZIP per company. Each files[].url is signed for 1 hour and is re-signed on every call, so request the export again if a link expired. The ZIP files are purged 7 days after completion (status becomes expired, files is empty). See POST /v1/erp/payouts/payables/pdf_exports for the ZIP layout, the indice.csv format and a full polling example.

get/v1/erp/payouts/payables/pdf_exports/{id}

Request

  • Base URL
    https://api.cardda.com
  • URL
    https://api.cardda.com/v1/erp/payouts/payables/pdf_exports/{id}
  • Auth
    HTTP bearer

Parameters

#/paths/~1v1~1erp~1payouts~1rules~1%7Bid%7D/get/parameters/1 (unresolved $ref)

Response

The export.

idstring uuid required
status'fetching' | 'zipping' | 'completed' | 'failed' | 'expired' required
  • fetching: the PDFs are being retrieved (stored documents, attachments and, when needed, the SII).
  • zipping: the ZIP files are being built.
  • completed: the ZIP files are ready in files.
  • failed: the export could not be completed.
  • expired: the ZIP files were purged (7 days after completion); files is empty. Create a new export.
include_attachmentsboolean

Whether the attachments of payables that do have a PDF were included.

company_idsstring[]

Companies covered by the export.

date_fromstring date nullable

Start of the issue-date range of the exported payables (used in the ZIP filename).

date_tostring date nullable

End of the issue-date range of the exported payables (used in the ZIP filename).

created_atstring date-time
completed_atstring date-time nullable
expires_atstring date-time nullable

When the ZIP files will be purged (7 days after completed_at). null until completed.

Example response

{
  "id": "0d6f8a52-3c1e-4b8e-9f3a-2a7f5f6c9b10",
  "status": "completed",
  "progress": {
    "total": 710,
    "processed": 710,
    "included": 573,
    "failed": 137
  },
  "failures_by_reason": [
    {
      "reason": "missing_admin_key",
      "count": 137,
      "message": "la empresa no tiene registrada una clave SII de administrador, Nubox ni BCS. Regístrala en Configuración, en Integraciones y vuelve a generar la descarga."
    }
  ],
  "include_attachments": false,
  "company_ids": [
    "550e8400-e29b-41d4-a716-446655440000"
  ],
  "date_from": "2026-04-01",
  "date_to": "2026-09-30",
  "created_at": "2026-10-26T13:02:11Z",
  "completed_at": "2026-10-26T13:18:47Z",
  "expires_at": "2026-11-02T13:18:47Z",
  "files": [
    {
      "company_id": "550e8400-e29b-41d4-a716-446655440000",
      "company_name": "FI WEG 1",
      "filename": "FI WEG 1_2026-04-01_2026-09-30.zip",
      "byte_size": 41231234,
      "url": "https://storage.example.com/pdf_exports/FI%20WEG%201_2026-04-01_2026-09-30.zip?signature=..."
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.