Partially update supplier

Request

Security

OAuth2(Required scopes: enrichment.write)

Path

externalIdstringrequired

Previously sent externalId

Bodyapplication/merge-patch+jsonrequired

defaultAccountAssignmentobject

externalIdstring^\S+$required

External id of the supplier that is globally unique across the provided supplier data

Example:"0000100000"

externalClientIdstring

Identifier of the client entity in the source system which can be used to separate data

Example:"EXTERNAL_CLIENT_ID"

codestring

Code of the supplier in the source system (not unique across clients)

Example:"CODE1"

typestring

Type assigned to the supplier in the source system. Can be used to categorize suppliers and control supplier-specific processing logic.

Example:"SUPPLIER_TYPE_01"

groupstring

Group identifier assigned to the supplier in the source system. Can be used to associate multiple supplier records that belong to the same corporate group or other supplier grouping.

Example:"GROUP_001"

namestring^[\S ]*\S[\S ]*$required

Name of the supplier

Example:"Acmne Corp."

nameAlternative1string

Alternative name of the supplier

Example:"Acmne Corp."

nameAlternative2string

Alternative name of the supplier

Example:"Acmne Corp."

nameAlternative3string

Alternative name of the supplier

Example:"Acmne Corp."

nameAlternative4string

Alternative name of the supplier

Example:"Acmne Corp."

alternativePayeestring^\S+$

externalId of the supplier which is the alternative payee for this supplier

streetstring

Street and street number where the supplier is located

Example:"Hauptstr. 1"

addressAdditionalstring

Additional address data (e.g. apartment or suite)

Example:"Eingang B"

postcodestring

Postcode where the supplier is located

Example:"10001"

citystring

City where the supplier is located

Example:"Berlin"

statestring

State where the company is located

Example:"Berlin"

countryCodestring or null(CountryCode)

Two letter country code as defined in ISO 3166-1 alpha-2

Enum:"AF""AX""AL""DZ""AS""AD""AO""AI""AQ""AG"

Example:"DE"

vatIdsArray of objects(vatId)

List of VAT IDs assigned to the supplier

Example:

[
  {
    "id": "DE123456789",
    "countryCode": "DE"
  }
]

taxIdsArray of objects(taxId)

List of Tax IDs assigned to the supplier

Example:

[
  {
    "id": "123-456-789",
    "type": "TIN"
  }
]

blockedForPostingboolean

Indicator if the supplier is blocked for posting

Example:false

blockedForPaymentboolean

Indicator if the supplier is blocked for payment

Example:false

globalLocationNumberstring

13-digit Global Location Number (GLN) used for unique location identification in B2B transactions

Example:"4000001000002"

dunsstring

D-U-N-S Number issued by Dun & Bradstreet. A globally used identifier for business entities.

Example:"123456789"

supplierSubsidiariesArray of objects(subsidiary)

supplierBankAccountsArray of objects(bankAccount)

customFieldsobject(customFields)

List of key value pairs containing custom fields from the source system

customMetadataobject(JsonObject)

Any nested structure with metadata that source system needs to send

Example:

{
  "someTopLevelProperty": "value1",
  "someNestedProperty": {
    "nestedProperty": "value2"
  },
  "someArrayProperty": [
    "value3",
    "value4"
  ]
}

curl -i -X PATCH \
  'https://api.cloud.hypatos.ai/v2/enrichment/suppliers/{externalId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/merge-patch+json' \
  -d '{
    "defaultAccountAssignment": {
      "glAccountCode": "0000100GL1",
      "costCenterCode": "0000100CC1",
      "externalApproverId": "MMUSTERMANN",
      "externalProjectId": "PROJ1234",
      "externalOrderId": "ORDER1234"
    },
    "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": [
      {
        "id": "DE123456789",
        "countryCode": "DE"
      }
    ],
    "taxIds": [
      {
        "id": "123-456-789",
        "type": "TIN"
      }
    ],
    "blockedForPosting": false,
    "blockedForPayment": false,
    "globalLocationNumber": "4000001000002",
    "duns": "123456789",
    "supplierSubsidiaries": [
      {
        "defaultAccountAssignment": {
          "glAccountCode": "0000100GL1",
          "costCenterCode": "0000100CC1",
          "externalApproverId": "MMUSTERMANN",
          "externalProjectId": "PROJ1234",
          "externalOrderId": "ORDER1234"
        },
        "externalCompanyId": "DE01",
        "paymentTerms": {
          "paymentTermKey": "T10",
          "descriptions": [
            {
              "text": "Please pay us",
              "language": "en"
            }
          ]
        },
        "blockedForPosting": false,
        "blockedForPayment": false,
        "enabledForAutoPosting": true,
        "withholdingTaxInfo": [
          {
            "key": "WHT-432",
            "descriptions": [
              {
                "text": "Some very deep description of the type of withholding tax",
                "language": "en"
              }
            ]
          }
        ]
      }
    ],
    "supplierBankAccounts": [
      {
        "externalId": "12341234",
        "countryCode": "DE",
        "bankAccountNumber": "78090",
        "bankAccountHolder": "Maximilian Mustermann",
        "iban": "DE91100000000123456789",
        "bic": "CHASUS33XXX",
        "bankName": "Deutsche Bank",
        "bankStreet": "Hauptstr. 1",
        "bankPostcode": "10001",
        "bankCity": "Berlin",
        "isActive": true,
        "type": "SAVINGS",
        "bankKey": "60-16-13"
      }
    ],
    "customFields": {
      "property1": "string",
      "property2": "string"
    },
    "customMetadata": {
      "someTopLevelProperty": "value1",
      "someNestedProperty": {
        "nestedProperty": "value2"
      },
      "someArrayProperty": [
        "value3",
        "value4"
      ]
    }
  }'

Responses

Successfully updated

Bodyapplication/json

defaultAccountAssignmentobject

externalIdstring^\S+$required

External id of the supplier that is globally unique across the provided supplier data

Example:"0000100000"

externalClientIdstring

Identifier of the client entity in the source system which can be used to separate data

Example:"EXTERNAL_CLIENT_ID"

codestring

Code of the supplier in the source system (not unique across clients)

Example:"CODE1"

typestring

Type assigned to the supplier in the source system. Can be used to categorize suppliers and control supplier-specific processing logic.

Example:"SUPPLIER_TYPE_01"

groupstring

Group identifier assigned to the supplier in the source system. Can be used to associate multiple supplier records that belong to the same corporate group or other supplier grouping.

Example:"GROUP_001"

namestring^[\S ]*\S[\S ]*$required

Name of the supplier

Example:"Acmne Corp."

nameAlternative1string

Alternative name of the supplier

Example:"Acmne Corp."

nameAlternative2string

Alternative name of the supplier

Example:"Acmne Corp."

nameAlternative3string

Alternative name of the supplier

Example:"Acmne Corp."

nameAlternative4string

Alternative name of the supplier

Example:"Acmne Corp."

alternativePayeestring^\S+$

externalId of the supplier which is the alternative payee for this supplier

streetstring

Street and street number where the supplier is located

Example:"Hauptstr. 1"

addressAdditionalstring

Additional address data (e.g. apartment or suite)

Example:"Eingang B"

postcodestring

Postcode where the supplier is located

Example:"10001"

citystring

City where the supplier is located

Example:"Berlin"

statestring

State where the company is located

Example:"Berlin"

countryCodestring or null(CountryCode)

Two letter country code as defined in ISO 3166-1 alpha-2

Enum:"AF""AX""AL""DZ""AS""AD""AO""AI""AQ""AG"

Example:"DE"

vatIdsArray of objects(vatId)

List of VAT IDs assigned to the supplier

Example:

[
  {
    "id": "DE123456789",
    "countryCode": "DE"
  }
]

taxIdsArray of objects(taxId)

List of Tax IDs assigned to the supplier

Example:

[
  {
    "id": "123-456-789",
    "type": "TIN"
  }
]

blockedForPostingboolean

Indicator if the supplier is blocked for posting

Example:false

blockedForPaymentboolean

Indicator if the supplier is blocked for payment

Example:false

globalLocationNumberstring

13-digit Global Location Number (GLN) used for unique location identification in B2B transactions

Example:"4000001000002"

dunsstring

D-U-N-S Number issued by Dun & Bradstreet. A globally used identifier for business entities.

Example:"123456789"

supplierSubsidiariesArray of objects(subsidiary)

supplierBankAccountsArray of objects(bankAccount)

customFieldsobject(customFields)

List of key value pairs containing custom fields from the source system

customMetadataobject(JsonObject)

Any nested structure with metadata that source system needs to send

Example:

{
  "someTopLevelProperty": "value1",
  "someNestedProperty": {
    "nestedProperty": "value2"
  },
  "someArrayProperty": [
    "value3",
    "value4"
  ]
}

Response

{
  "defaultAccountAssignment": {
    "glAccountCode": "0000100GL1",
    "costCenterCode": "0000100CC1",
    "externalApproverId": "MMUSTERMANN",
    "externalProjectId": "PROJ1234",
    "externalOrderId": "ORDER1234"
  },
  "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": {
    "property1": "string",
    "property2": "string"
  },
  "customMetadata": {
    "someTopLevelProperty": "value1",
    "someNestedProperty": { … },
    "someArrayProperty": [ … ]
  }
}