Skip to content

Get sales order

Request

Returns one stored sales order, 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/sales-orders/{externalId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

The stored sales order

Bodyapplication/json
metadataobject(recordMetadata)required
dataobject(salesOrder)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": "DE01", "externalClientId": "EXTERNAL_CLIENT_ID", "documentId": "63cac12c37bb02accb396cae", "documents": [ … ], "customerOrderNumber": "CUSTOMER_ORDER_NUMBER", "salesOrderNumber": "SALES_ORDER_NUMBER", "externalCompanyId": "DE01", "externalCustomerId": "CO01", "salesOrganizationCode": "SO001", "distributionChannel": "CH1", "division": "DIV01", "salesGroup": "123456", "salesOffice": "98765", "type": "OR", "subType": "recurring", "issuedDate": "2000-12-31", "receivedDate": "2000-12-31", "fiscalYearLabel": "2023", "requestedDeliveryDate": "2000-12-31", "isCanceled": false, "currency": "EUR", "totalNetAmount": 100, "totalTaxAmount": 19, "totalGrossAmount": 119, "paymentTerms": { … }, "headerText": "doc header text", "customFields": { … }, "customMetadata": { … }, "salesOrderLines": [ … ] } }