Payments API ReferenceBilling

Update received document

Updates an existing received document with new information

Path parameters

merchantIdstringRequired
Merchant ID
receivedDocumentIdstringRequired
Received Document ID
organizationIdstringRequired
Organization ID

Headers

AuthorizationstringRequired

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

Request

This endpoint expects an object.
documentStatusenumRequired
Accept or Reject a document param
Allowed values:

Response

Received document successfully updated
receivedDocumentIddouble
Unique identifier for the document
emailSubjectstring
The subject line of the email.
senderEmailstring
The email address of the sender.
documentDatestring
The date when the document was created or issued.
receiveDatestring
The date when the document was received.
receivedDocumentStatusdouble
The current status of the document in the inbox.
documentIddouble
The identifier assigned to the created document.
issuerNamestring
Issuer name
issuerTaxIdCodestring
Tax ID code according to tax id table. Required when the document requires the receiver to be specified.
issuerTaxIdTypestring
Tax ID type according to tax id table. Required when the document requires the receiver to be specified.
documentTypeIddouble
Document type ID according to document type table.
documentTypeTaxbureaustring
Type of document at the tax bureau.
documentNumberdouble
A unique number assigned to the document.
accountIddouble
Account ID.
purchaseOrderstring
The identifier for the purchase order.
receptionConfirmationStatusdouble
Indicates the status of the reception confirmation for the document.
receptionConfirmationDatestring
The date when the reception of the document was confirmed.
receiverTaxIdCodestring
The tax identification code of the document receiver.
receiverTaxIdTypestring
Tax ID type according to tax id table. Required when the document requires the receiver to be specified.
documentApprovalStatusdouble
Indicates the current approval status of the document.
documentApprovalDatestring
The date on which the document was approved.
productReceiptStatusdouble
Indicates the current status of the product receipt.
productReceiptDatestring
productReceiptLocationstring
The date on which the product was received.
netAmountstring
Total of all net values from each of the detail lines.
totalAmountstring
Document grand total
documentXmlstring
Base64 encoded XML
documentPdfstring
Base64 encoded PDF
stampImgstring
Base64 encoded stamp image

Errors