BUburodeingresos
Exports

Get Export

Changed on

Returns the state of an export and, once completed, one signed download link per file.

Each url is valid for about 1 hour and is re-issued fresh on every read, so if a link expires, call this endpoint again. The export itself is available for 7 days after completion; after that the files are purged and files comes back empty.

get/exports/{export_id}

Request

Path parameters

export_idstring uuid required

The export_id returned by POST /exports.

Response

Export state, with download links while completed and not expired.

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