Skip to content

Get invoice

Request

Returns one stored invoice, exactly as it was accepted.

Security
OAuth2(Required scopes: enrichment.read)
Path
externalIdstringrequired

Previously sent externalId

curl -i -X GET \
  'https://api.cloud.hypatos.ai/v2/enrichment/invoices/{externalId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

The stored invoice

Bodyapplication/json
metadataobject(recordMetadata)required
dataobject(invoice)required

The stored resource, exactly as it was accepted.

Response
{ "metadata": { "createdAt": "2026-10-01T09:12:44.123456Z", "updatedAt": "2026-10-03T15:02:10.654321Z" }, "data": { "externalId": "SUPPLIER_INVOICE-3-1", "externalClientId": "EXTERNAL_CLIENT_ID", "documentId": "63cac12c37bb02accb396cae", "documents": [ … ], "supplierInvoiceNumber": "10000001", "invoiceNumber": "12345", "externalCompanyId": "DE01", "externalSupplierId": "0000100000", "externalBankAccountId": "12341234", "fiscalYearLabel": "2023", "issuedDate": "2000-12-31", "receivedDate": "2000-12-31", "postingDate": "2000-12-31", "isCanceled": false, "isCreditNote": true, "externalCustomerId": "string", "relatedInvoice": "SUPPLIER_INVOICE-3-2", "currency": "EUR", "totalNetAmount": 81, "totalFreightCharges": 9, "totalOtherCharges": 10, "totalTaxAmount": 19, "totalGrossAmount": 119, "paymentTerms": { … }, "externalApproverId": "UserID#1234", "customFields": { … }, "customMetadata": { … }, "headerText": "doc header text", "type": "FI", "invoiceLines": [ … ], "withholdingTax": [ … ], "documentType": "supplier invoice" } }