Saltar al contenido principal
GET

Abrir o ver documento entrante

Scope:inbox:inbox.read
https://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

incomingDocumentIdstringobligatorio

Identificador único del documento entrante (ObjectId hexadecimal de 24 caracteres)

Petición

python
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

json
{
  "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/json
object
idstring

Unique identifier of the incoming document

statusstring

Current status

Enum:newprocessingerrorpending_to_verifydonerejected
originobject

Origin metadata

idstring
namestring
typestring
Enum:emailuploadholdedToHoldedbankTransaction
sourcestring | null
document_numberstring | null

Document number extracted from the file

typestring | null

Document type

Enum:invoicesalesreceiptcreditnotepurchaseorderpurchaseshipmentsalesorderreceiptpurchaserefundestimatewaybillproformreceiptnoteinvoicerecurringpurchaserecurringpayrollpayrollrecurringamazonorderproductionorderinvoicingforecast
outcomeobject | null

Linked document outcome if the document has been processed

documentIdstring | null
documentNumberstring | null
typestring | null
isDraftboolean | null
exportedAtstring<date-time> | null
attachedboolean

True if the incoming document was attached to an existing document (as opposed to creating a new one)

datestring<date-time>

Creation date in ISO 8601 format

contact_namestring | null

Name of the associated contact

totalstring | null

Total amount as decimal string

fileobject | null

Primary file associated with the document

filenamestring
pathstring
thumbnailstring | null

Thumbnail URL (reserved for future use)

signatureobject | null

Certified digitization signature file

filenamestring
pathstring
scanned_atstring | null

Date the document was scanned (ISO 8601)

seen_atstring | null

Date the document was first seen (ISO 8601)

errors[]string[]

List of error codes if the scan failed

draftobject

Draft metadata extracted from the document

descriptionstring | null

Respuestas de error

401API key inválida o no proporcionadaapplication/json
403Permisos insuficientesapplication/json
404Documento entrante no encontradoapplication/json
429Límite de solicitudes excedidoapplication/json