Exports create downloadable files from Syntage data. Use them when your integration needs a file that can be stored, shared, imported into another system, or delivered to an operations team.
Creating an export starts asynchronous processing and returns an Export resource. The export keeps track of the requested source data, output format, processing status, and generated file.
How Exports Work
- Create an export with the collection URI and output format you need.
- Store the returned export ID.
- Retrieve the export until its
status is finished or failed.
- Download the generated file from the File resource referenced by the export.
Exports are useful for workflows such as finance reports, invoice handoffs, customer support investigations, back-office review, and scheduled data delivery.
Example Create Request
This example creates an XLSX export from an entity’s invoices collection and includes invoice CFDI XML files.
{
"format": "xlsx",
"fileTypes": ["invoice.cfdi.xml"],
"uri": "/entities/91106968-1abd-4d64-85c1-4e73d96fb997/invoices?issuedAt[after]=2026-01-01"
}
Example Export
{
"@id": "/exports/91106968-1abd-4d64-85c1-4e73d96fb997",
"@type": "Export",
"id": "91106968-1abd-4d64-85c1-4e73d96fb997",
"format": "xlsx",
"fileTypes": ["invoice.cfdi.xml"],
"status": "finished",
"uri": "/entities/91106968-1abd-4d64-85c1-4e73d96fb997/invoices?issuedAt[after]=2026-01-01",
"file": {
"@id": "/files/9137b53f-1abd-4d64-85c1-4e73d96fb997",
"@type": "File",
"id": "9137b53f-1abd-4d64-85c1-4e73d96fb997",
"type": "Export",
"resource": "/exports/91106968-1abd-4d64-85c1-4e73d96fb997",
"mimeType": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
"extension": "xlsx",
"size": 24576,
"filename": "9137b53f-1abd-4d64-85c1-4e73d96fb997.xlsx"
},
"createdAt": "2026-06-16T14:30:00.000Z",
"updatedAt": "2026-06-16T14:32:00.000Z"
}
| Status | Meaning |
|---|
pending | The export has been accepted and is waiting to run. |
running | Syntage is building the export file. |
finished | The export file is ready to download. |
failed | The export could not be completed. Create a new export after correcting the request. |
The export response references a File resource when the generated file is ready. Use the file metadata to inspect the filename, media type, and size before downloading it.
