Skip to main content
Preview exporting a company

Authorizations

Authorization
string
header
required

Personal API key sent as a bearer token, together with X-Organization-Id. The key must have at least the access level the endpoint requires (read, write or admin).

Headers

X-Organization-Id
string

The organization to act in. Required for personal API keys; list the organizations you can access with GET /v1/organizations.

Path Parameters

id
string<uuid>
required

Response

What the export includes.

invoices
integer
required

The company's invoices and credit notes, not deleted.

documents
integer
required

The files of the company's invoices.

purchase_orders
integer
required

The company's purchase orders.

recipients
integer
required

The company's recipients.

agreements
integer
required

Agreements covering the company and no other company, listed in the export.

shared_agreements
integer
required

Agreements covering this company and others, listed in the export; they stay with the other companies.

fits
boolean
required

The export fits one ZIP file: its CSV files and the invoice files together are at most 65,535 files. When false, exportCompany refuses it (422 export_too_large).