BUburodeingresos
Exports

Create Export

Changed on

Requests an asynchronous CSV export of a completed verification bulk. One file is generated per entity. The company is always taken from the API key, never from the request body.

Requests are idempotent: the same bulk_id with the same entities returns 202 with the same export_id instead of generating a duplicate. A failed or expired export can be requested again.

When the files are ready, the export.completed webhook event is sent (no download links in the event). Webhooks created before this feature launched must subscribe to the event via PATCH /webhooks/{webhook_id}.

post/exports

Request

Request body

bulk_idstring uuid required

A completed verification bulk that belongs to your account.

entitiesstring[] required

Entities to export; one CSV file is generated per entity. Order and duplicates are ignored.

include_payment_infoboolean

Optional. When true, invoices.csv includes a payment_info column with the payment details of each invoice, with the same fields as GET /invoices?include_payment_info=true. Invoices with no associated payments carry an empty array []. The flag is part of the idempotency key: the same bulk_id and entities with a different include_payment_info value is a new export. Defaults to false.

Response

Export accepted — or already requested with the same scope, in which case the same export_id is returned.

export_idstring uuid
bulk_idstring uuid
status'queued' | 'processing' | 'completed' | 'failed' | 'expired'
requested_atstring date-time
finished_atstring date-time
expires_atstring date-time

The export is available for 7 days after completion. After this moment the files are purged.

error_codestring

Present only when status is failed.

error_messagestring

Present only when status is failed.

Example response

{
  "files": [
    {
      "name": "invoices.csv",
      "rows": 812000,
      "bytes": 410000000
    }
  ]
}

Changes