Skip to content

Get supplier

Request

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

Responses

The stored supplier

Bodyapplication/json
metadataobject(recordMetadata)required
dataobject(supplier)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": { "defaultAccountAssignment": { … }, "externalId": "0000100000", "externalClientId": "EXTERNAL_CLIENT_ID", "code": "CODE1", "type": "SUPPLIER_TYPE_01", "group": "GROUP_001", "name": "Acmne Corp.", "nameAlternative1": "Acmne Corp.", "nameAlternative2": "Acmne Corp.", "nameAlternative3": "Acmne Corp.", "nameAlternative4": "Acmne Corp.", "alternativePayee": "string", "street": "Hauptstr. 1", "addressAdditional": "Eingang B", "postcode": "10001", "city": "Berlin", "state": "Berlin", "countryCode": "DE", "vatIds": [ … ], "taxIds": [ … ], "blockedForPosting": false, "blockedForPayment": false, "globalLocationNumber": "4000001000002", "duns": "123456789", "supplierSubsidiaries": [ … ], "supplierBankAccounts": [ … ], "customFields": { … }, "customMetadata": { … } } }