Documents

Export documents to CSV

GET
/v1/ec/documents/export

The documents that match the filters, from newest to oldest, as UTF-8 CSV: number, type, counterparty_name, counterparty_identification, issue_date, total (negative on a credit note; empty on a delivery note), status, channel, access_key, authorization_number and authorized_at. It is streamed as it is built. Up to 10000 documents; if there are more, 422: narrow it down with filters.

Authorization

AuthorizationBearer <token>

Your API key, which acts for the one business it was created for: fb_sandbox_… issues in sandbox, fb_test_… in test, the tax authority's testing service, and fb_live_… in live.

In: header

Query Parameters

status?|array<>

Only in these statuses; repeat it for several (status=returned&status=not_authorized).

channel?|array<>

Only those that arrived through these channels; repeat it for several.

counterparty?string

The identification of the document's buyer or supplier; on a delivery note, that of the carrier or of any of its recipients.

q?string

Searches words in the number (001-001-000000123), the access key, the name of whoever appears on the document (ignoring case and accents) or the start of their identification. Each word must appear somewhere; it combines with the other filters.

Length1 <= length <= 100
issue_date[gte]?string
Formatdate
issue_date[lte]?string
Formatdate
type?|array<>

Only these types, by their object; repeat it for several (type=invoice&type=credit_note). Without it, all of them.

Response Body

text/csv

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://example.com/v1/ec/documents/export"
"string"