Skip to main content
GET
Retrieve an export

Authorizations

X-API-Key
string
header
required

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

Path Parameters

id
string<uuid>
required

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"