Partially update Internal Order

Request

Security

OAuth2(Required scopes: enrichment.write)

Path

externalIdstringrequired

Previously sent externalId

Bodyapplication/merge-patch+jsonrequired

externalIdstring^\S([\S ]*\S)?$required

External id of the internal order that is globally unique across the provided order data

Example:"SAP:AUFK:000300123456"

externalClientIdstring

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

Example:"100"

internalOrderCodestring^\S([\S ]*\S)?$required

Internal order code/number from the source system (not unique across clients)

Example:"000300123456"

internalOrderReferenceNumberstring

Additional internal order reference number from the source system

Example:"ABC1234"

createdDatestring, (date)

Date when the internal order record was created in the source system (YYYY-MM-DD)

Example:"2025-02-10"

fiscalYearLabelstring

Label used in the source system for the fiscal year relevant to the internal order

Example:"2023"

languagestring or null(LanguageCode)

Two letter language code as defined in ISO 639-1

Enum:"aa""ab""ae""af""ak""am""an""ar""as""av"

Example:"en"

externalCompanyIdstring

External unique id of the company in the source system.

Example:"DE01"

statusstring

Lifecycle status of the internal order

Example:"OPEN"

typestring

Order type/category as defined in the source system

Example:"overhead"

subTypestring

Sub-classification of the internal order as defined in the source system

Example:"category"

descriptionstring

Long description of the internal order

Example:"Marketing campaign Q2 2025 – brand awareness and lead generation"

shortDescriptionstring

Short description used in UIs and search

Example:"MKT Q2/2025"

profitCenterCodestring

Assigned profit center code

Example:"PC4100"

costCenterCodeForSettlementstring

Default receiver cost center used when settling the internal order (if applicable)

Example:"CC4105"

glAccountCodeForSettlementstring

Default G/L account (or cost element) used for settlement postings where relevant

Example:"GL3094"

currencystring or null(CurrencyCode)

Three letter currency code as defined in ISO 4217

Enum:"AED""AFN""ALL""AMD""ANG""AOA""ARS""AUD""AWG""AZN"

Example:"EUR"

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/internal-orders/{externalId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/merge-patch+json' \
  -d '{
    "externalId": "SAP:AUFK:000300123456",
    "externalClientId": "100",
    "internalOrderCode": "000300123456",
    "internalOrderReferenceNumber": "ABC1234",
    "createdDate": "2025-02-10",
    "fiscalYearLabel": "2023",
    "language": "en",
    "externalCompanyId": "DE01",
    "status": "OPEN",
    "type": "overhead",
    "subType": "category",
    "description": "Marketing campaign Q2 2025 – brand awareness and lead generation",
    "shortDescription": "MKT Q2/2025",
    "profitCenterCode": "PC4100",
    "costCenterCodeForSettlement": "CC4105",
    "glAccountCodeForSettlement": "GL3094",
    "currency": "EUR",
    "customFields": {
      "property1": "string",
      "property2": "string"
    },
    "customMetadata": {
      "someTopLevelProperty": "value1",
      "someNestedProperty": {
        "nestedProperty": "value2"
      },
      "someArrayProperty": [
        "value3",
        "value4"
      ]
    }
  }'

Responses

Successfully updated

Bodyapplication/json