Abrir o ver documento entrante
inbox:inbox.readhttps://api.holded.com/api/v2/inbox/{incomingDocumentId}Retrieves the full details of a single incoming document by its unique identifier.
Parámetros
Parámetros de ruta
stringobligatorioIdentificador único del documento entrante (ObjectId hexadecimal de 24 caracteres)
Petición
import requests
url = "https://api.holded.com/api/v2/inbox/507f1f77bcf86cd799439011"
headers = {
"Authorization": "Bearer YOUR_API_KEY",
"Accept": "application/json",
}
response = requests.get(url, headers=headers)
print(response.json())Respuestas
Respuesta
{
"id": "string",
"status": "pending_to_verify",
"origin": {
"id": "string",
"name": "string",
"type": "upload",
"source": "string"
},
"document_number": "string",
"type": "invoice",
"outcome": {
"documentId": "string",
"documentNumber": "string",
"type": "string",
"isDraft": false,
"exportedAt": "2024-01-15T10:30:00Z",
"attached": false
},
"date": "2024-01-15T10:30:00Z",
"contact_name": "string",
"total": "100,00",
"file": {
"filename": "string",
"path": "string"
},
"thumbnail": "string",
"signature": {
"filename": "string",
"path": "string"
},
"scanned_at": "string",
"seen_at": "string",
"errors": [
"string"
],
"draft": {
"description": "string"
}
}Respuestas exitosas
200Documento entrante encontradoapplication/jsonUnique identifier of the incoming document
Current status
newprocessingerrorpending_to_verifydonerejectedOrigin metadata
emailuploadholdedToHoldedbankTransactionDocument number extracted from the file
Document type
invoicesalesreceiptcreditnotepurchaseorderpurchaseshipmentsalesorderreceiptpurchaserefundestimatewaybillproformreceiptnoteinvoicerecurringpurchaserecurringpayrollpayrollrecurringamazonorderproductionorderinvoicingforecastLinked document outcome if the document has been processed
True if the incoming document was attached to an existing document (as opposed to creating a new one)
Creation date in ISO 8601 format
Name of the associated contact
Total amount as decimal string
Primary file associated with the document
Thumbnail URL (reserved for future use)
Certified digitization signature file
Date the document was scanned (ISO 8601)
Date the document was first seen (ISO 8601)
List of error codes if the scan failed
Draft metadata extracted from the document
Respuestas de error
401API key inválida o no proporcionadaapplication/json403Permisos insuficientesapplication/json404Documento entrante no encontradoapplication/json429Límite de solicitudes excedidoapplication/json