API Reference📝documents

Get a paginated list of documents

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

pageintegerOptionalDefaults to 1
per_pageintegerOptionalDefaults to 10
issue_date_fromstringOptional

Filter from this date (inclusive). Format AAAA-MM-DD

issue_date_tostringOptional

Filter to this date (inclusive). Format AAAA-MM-DD

taxbureau_sending_statusintegerOptional

0 = Sending.
1XX = Retrying sending.
2XX = Rejected by Tax Bureau.
1 = Received by Tax Bureau.
2 = Closed without sending.
3 = Imported from another system.

taxbureau_validation_statusintegerOptional

0,1 = In process.
2 = Sending rejected by tax bureau.
3 = Accepted by tax bureau.
4 = Accepted by tax bureau with warnings.
5 = Content Rejected by tax bureau.

document_numberstringOptional
Document number
document_type_idintegerOptional
Document type ID according to the country
received_issued_flagdoubleOptional

0 = issued
1 = received

receiver_tax_id_codestringOptional
Receiver document number
min_total_amountstringOptional

Filter that allows searching with a minimum of total_amount and also supports using both filters together.

max_total_amountstringOptional

Filter that allows searching with a maximum of total_amount and also supports using both filters together.

reference_document_idintegerOptional
Filter that allows searching by reference document ID.
reference_codeintegerOptional

Filter that allows searching by reference code. 1 = cancel, 2 = correct text, 3 = correct quantity, 4 = set, 5 = reference to other non-tax documents, 6 = reference to dispatch guide, 7 = global reference to a type of document (allows reducing the amount for all documents of this type for this particular client).

reference_numberstringOptional

Filter that allows searching by reference number ONLY for non-tax documents, for tax documents, use the reference_document_id parameter

reference_typestringOptional

Filter that allows searching by reference type. This is the document type ONLY for non-tax documents, for tax documents, use the reference_document_id parameter.

order_bystringOptional

asc = ascending
desc = descending
Filter based on the date, which can also be combined with another parameter.

document_statusintegerOptional

0 = Draft
1 = Issued
2 = Cancelled (mexico)
Filter based on the document_status: draft, issued or cancelled.

Response

Successful response
documentslist of objects or null
page_countinteger or null
page_sizeinteger or null
total_itemsinteger or null
pageinteger or null