Authorizations
Your API key is available in the Production and Sandbox dashboards.
Body
application/json
Format for your resource
Available options:
csv
, xlsx
, json
Use any supported content type's collection endpoints and use its query parameters to filter
Example of supported URI values
- /entities
- /taxpayers/{id}/tax-returns
- /taxpayers/{id}/invoices
If a this field is specified it will return a ZIP file with the content files (Available just for Invoices) Use the prefixed values corresponding to the data that you want
Minimum length:
1
Response
Export resource response
Export IRI reference
Example:
"/exports/91106968-1abd-4d64-85c1-4e73d96fb997"
Example:
"91106968-1abd-4d64-85c1-4e73d96fb997"
Example:
{
"type": "Export",
"resource": "/exports/91106968-1abd-4d64-85c1-4e73d96fb997",
"mimeType": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
"extension": "xlsx",
"filename": "9137b53f-1abd-4d64-85c1-4e73d96fb997.xlsx"
}
Example:
"xlsx"
Minimum length:
1
Available options:
pending
, running
, finished
, failed
Example:
"pending"
Example:
"/taxpayers/PEIC211118IS0/invoices?usage=I01&type=I&issuedAt[after]=2020-01-01"
Date and time the resource was created
Example:
"2020-01-01T12:15:00.000Z"
Date and time the resource was last updated
Example:
"2020-01-01T12:15:00.000Z"