API Reference📩inbox

Get a specific received document

Path parameters

inbox_document_idstringRequired

Headers

AuthorizationstringRequired

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

Response

Successful response
inbox_document_iddouble or null
Inbox document ID.
email_subjectstring or null
The subject line of the email.
sender_emailstring or null
The email address of the sender.
document_datestring or nullformat: "date"
The date when the document was created or issued.
receive_datestring or nullformat: "date"
The date when the document was received.
inbox_document_statusdouble or null
The current status of the document in the inbox.
document_iddouble or null
The identifier assigned to the created document.
issuer_namestring or null
Issuer name.
issuer_tax_id_codestring or null
Tax ID code according to tax id table. Required when the document requires the receiver to be specified.
issuer_tax_id_typestring or null
Tax ID type according to tax id table. Required when the document requires the receiver to be specified.
document_type_iddouble or null
Document type ID according to document type table.
document_type_taxbureaustring or null
Type of document at the tax bureau.
document_numberdouble or null
A unique number assigned to the document.
account_idinteger or null
Account ID.
purchase_orderstring or null
The identifier for the purchase order.
reception_confirmation_statusdouble or null
Indicates the status of the reception confirmation for the document.
reception_confirmation_datedatetime or null
The date when the reception of the document was confirmed.
receiver_tax_id_codestring or null
The tax identification code of the document receiver.
receiver_tax_id_typestring or null
Tax ID type according to tax id table. Required when the document requires the receiver to be specified.
document_approval_statusdouble or null
Indicates the current approval status of the document.
document_approval_datedatetime or null
The date on which the document was approved.
product_receipt_statusdouble or null
Indicates the current status of the product receipt.
product_receipt_datedatetime or null
The date on which the product was received.
product_receipt_locationstring or null
The location where the product was received.
net_amountstring or null
Total of all net values from each of the detail lines.
total_amountstring or null
Document grand total
document_xmlstring or null
Base64 encoded XML
document_pdfstring or null
Base64 encoded PDF
stamp_imgstring or null
Base64 encoded stamp image

Errors