Skip to main content
POST

Authorizations

​
X-API-Key
string
header
required

Your API key is available in the Production and Sandbox dashboards.

Body

application/json
​
format
enum<string>
required

Format for your resource.

Use csv, xlsx, or json for collection URIs. Use pdf only for report URIs.

Available options:
csv,
xlsx,
json,
pdf
​
uri
string
required

Collection URI used as the export source. Use the collection's query parameters to filter the exported data.

Example of supported URI values

  • /entities
  • /entities/{entityId}/tax-returns
  • /entities/{entityId}/invoices
  • /entities/{entityId}/reports/{reportId}?exporting=true

Report PDF exports

To download a report as a PDF document, set format to pdf and uri to /entities/{entityId}/reports/{reportId}?exporting=true. The exporting=true query parameter is required; other query parameters are not supported on report URIs. The generated PDF renders the report the same way the dashboard shows it to the requesting user, in the user's locale and over the report's default period, and is attached to the export as a report.insights.pdf file.

Example:

"/entities/91106968-1abd-4d64-85c1-4e73d96fb997/invoices?issuedAt[after]=2026-01-01"

​
fileTypes
enum<string>[]

Optional file types to include in the generated export; when specified, the export file includes the matching content files

Minimum array length: 1
Available options:
invoice.cfdi.xml,
invoice.cfdi.pdf,
tax_return.transcript,
tax_return.ack_receipt,
tax_return.payment_receipt
Example:

Response

Export resource response

​
@context
string
default:/contexts/Export
​
@id
string<iri-reference>

Export IRI reference

Example:

"/exports/91106968-1abd-4d64-85c1-4e73d96fb997"

​
@type
string
default:Export

JSON-LD resource type

​
id
string<uuid>

Unique export ID

Example:

"91106968-1abd-4d64-85c1-4e73d96fb997"

​
file
object

Generated file once the export is finished

Example:
​
format
string

Output format for the generated export file

Example:

"xlsx"

​
fileTypes
enum<string>[]

File types to include in the export

Minimum array length: 1
Available options:
invoice.cfdi.xml,
invoice.cfdi.pdf,
tax_return.transcript,
tax_return.ack_receipt,
tax_return.payment_receipt
Example:
​
status
enum<string>

Current export processing status

Available options:
pending,
running,
finished,
failed
Example:

"pending"

​
uri
string

API collection URI used as the export source

Example:

"/entities/91106968-1abd-4d64-85c1-4e73d96fb997/invoices?usage=I01&type=I&issuedAt[after]=2020-01-01"

​
createdAt
string

Date and time the resource was created

Example:

"2020-01-01T12:15:00.000Z"

​
updatedAt
string

Date and time the resource was last updated

Example:

"2020-01-01T12:15:00.000Z"