Get a paginated list of received documents

Authorizations

Authorization

string

header

required

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

Query Parameters

page

integer

default:

per_page

integer

default:

issuer_tax_id_code

string

receiver_tax_id_code

string

receiver_name

string

issuer_name

string

amount_lte

number

amount_gte

number

document_type_id

string

Response

200 - application/json

data

object[]

data.account_id

number

Account ID.

data.document_approval_date

string

The date on which the document was approved.

data.document_approval_status

number

Indicates the current approval status of the document.

data.document_date

string

The date when the document was created or issued.

data.document_id

number

The identifier assigned to the created document.

data.document_number

number

A unique number assigned to the document.

data.document_pdf

string

Base64 encoded PDF

data.document_type_id

number

Document type ID according to document type table.

data.document_type_taxbureau

string

Type of document at the tax bureau.

data.document_xml

string

Base64 encoded XML

data.email_subject

string

The subject line of the email.

data.inbox_document_id

number

Inbox document ID.

data.inbox_document_status

number

The current status of the document in the inbox.

data.issuer_name

string

Issuer name.

data.issuer_tax_id_code

string

Tax ID code according to tax id table. Required when the document requires the receiver to be specified.

data.issuer_tax_id_type

string

Tax ID type according to tax id table. Required when the document requires the receiver to be specified.

data.net_amount

string

Total of all net values from each of the detail lines.

data.product_receipt_date

string

The date on which the product was received.

data.product_receipt_location

string

The location where the product was received.

data.product_receipt_status

number

Indicates the current status of the product receipt.

data.purchase_order

string

The identifier for the purchase order.

data.receive_date

string

The date when the document was received.

data.receiver_tax_id_code

string

The tax identification code of the document receiver.

data.receiver_tax_id_type

string

Tax ID type according to tax id table. Required when the document requires the receiver to be specified.

data.reception_confirmation_date

string

The date when the reception of the document was confirmed.

data.reception_confirmation_status

number

Indicates the status of the reception confirmation for the document.

data.sender_email

string

The email address of the sender.

data.total_amount

string

Document grand total

page

integer

per_page

integer

total

integer

Quickstart

About us

API Endpoints

Examples

Get a paginated list of received documents

Authorizations

Query Parameters

Response