# Partially update sales order

Endpoint: PATCH /enrichment/sales-orders/{externalId}
Version: 2.51.0
Security: OAuth2

## Path parameters:

  - `externalId` (string, required)
    Previously sent externalId

## Request fields (application/merge-patch+json):

  - `externalId` (string, required)
    External id of the sales order that is globally unique across the provided sales order data
    Example: "DE01"

  - `externalClientId` (string)
    Identifier of the client entity in the source system which can be used to separate data
    Example: "EXTERNAL_CLIENT_ID"

  - `documentId` (string)
    Document id that was assigned during upload to Hypatos
    Example: "63cac12c37bb02accb396cae"

  - `documents` (array)

  - `documents.id` (string)
    Document id that was assigned during upload to Hypatos
    Example: "63cac12c37bb02accb396cae"

  - `documents.type` (string)
    Document type that was assigned during upload to Hypatos
    Example: "invoice"

  - `customerOrderNumber` (string)
    Sales order number provided by the issuing customer
    Example: "CUSTOMER_ORDER_NUMBER"

  - `salesOrderNumber` (string)
    Number of the sales order in the source system (not unique across clients)
    Example: "SALES_ORDER_NUMBER"

  - `externalCompanyId` (string)
    External unique id of the company in the source system
    Example: "DE01"

  - `externalCustomerId` (string)
    External unique id of the customer in the source system
    Example: "CO01"

  - `salesOrganizationCode` (string)
    Sales organization code
    Example: "SO001"

  - `distributionChannel` (string)
    Distribution channel code
    Example: "CH1"

  - `division` (string)
    Division code
    Example: "DIV01"

  - `salesGroup` (string)
    Sales group responsible for the order
    Example: "123456"

  - `salesOffice` (string)
    Sales office responsible for the order
    Example: "98765"

  - `type` (string)
    Type of the invoice as defined in the source system
    Example: "OR"

  - `subType` (string)
    Sub type of the invoice as defined in the source system
    Example: "recurring"

  - `issuedDate` (string)
    Date when the invoice was issued by the supplier (printed on invoice document)
    Example: "2000-12-31"

  - `receivedDate` (string)
    Date when the invoice was received by the company
    Example: "2000-12-31"

  - `fiscalYearLabel` (string)
    Label used in the source system for the fiscal year that the invoice was posted in
    Example: "2023"

  - `requestedDeliveryDate` (string)
    Requested delivery date
    Example: "2000-12-31"

  - `isCanceled` (boolean)
    Indicator if the invoice is canceled

  - `currency` (string,null)
    Three letter currency code as defined in ISO 4217
    Enum: "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLE", "SLL", "SOS", "SRD", "SSP", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "UYI", "UYU", "UYW", "UZS", "VED", "VES", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XSU", "XTS", "XUA", "XXX", "YER", "ZAR", "ZMW", "ZWL", null

  - `totalNetAmount` (number)
    Total net amount of sales order (sum of line item net amounts)
    Example: 100

  - `totalTaxAmount` (number)
    Total tax amount of sales order (sum of all taxes)
    Example: 19

  - `totalGrossAmount` (number)
    Total gross amount of sales order (total net amount + total tax amount)
    Example: 119

  - `paymentTerms` (object)

  - `paymentTerms.paymentTermKey` (string)
    Key of the payment term as defined in the source system
    Example: "T10"

  - `paymentTerms.descriptions` (array)
    Descriptions of the payment terms in different languages
    Example: [{"text":"Please pay us","language":"en"}]

  - `paymentTerms.descriptions.text` (string)
    Text content
    Example: "Fish & Chips"

  - `paymentTerms.descriptions.language` (string,null)
    Two letter language code as defined in ISO 639-1
    Enum: "aa", "ab", "ae", "af", "ak", "am", "an", "ar", "as", "av", "ay", "az", "ba", "be", "bg", "bh", "bi", "bm", "bn", "bo", "br", "bs", "ca", "ce", "ch", "co", "cr", "cs", "cu", "cv", "cy", "da", "de", "dv", "dz", "ee", "el", "en", "eo", "es", "et", "eu", "fa", "ff", "fi", "fj", "fo", "fr", "fy", "ga", "gd", "gl", "gn", "gu", "gv", "ha", "he", "hi", "ho", "hr", "ht", "hu", "hy", "hz", "ia", "id", "ie", "ig", "ii", "ik", "io", "is", "it", "iu", "ja", "jv", "ka", "kg", "ki", "kj", "kk", "kl", "km", "kn", "ko", "kr", "ks", "ku", "kv", "kw", "ky", "la", "lb", "lg", "li", "ln", "lo", "lt", "lu", "lv", "mg", "mh", "mi", "mk", "ml", "mn", "mr", "ms", "mt", "my", "na", "nb", "nd", "ne", "ng", "nl", "nn", "no", "nr", "nv", "ny", "oc", "oj", "om", "or", "os", "pa", "pi", "pl", "ps", "pt", "qu", "rm", "rn", "ro", "ru", "rw", "sa", "sc", "sd", "se", "sg", "si", "sk", "sl", "sm", "sn", "so", "sq", "sr", "ss", "st", "su", "sv", "sw", "ta", "te", "tg", "th", "ti", "tk", "tl", "tn", "to", "tr", "ts", "tt", "tw", "ty", "ug", "uk", "ur", "uz", "ve", "vi", "vo", "wa", "wo", "xh", "yi", "yo", "za", "zh", "zu", null

  - `headerText` (string)
    Header Text describing the invoice
    Example: "doc header text"

  - `customFields` (object)
    List of key value pairs containing custom fields from the source system

  - `customMetadata` (object)
    Any nested structure with metadata that source system needs to send
    Example: {"someTopLevelProperty":"value1","someNestedProperty":{"nestedProperty":"value2"},"someArrayProperty":["value3","value4"]}

  - `salesOrderLines` (array)

  - `salesOrderLines.plannedDeliveryDate` (string)
    Planned delivery date (YYYY-MM-DD)
    Example: "2025-08-27"

  - `salesOrderLines.orderLineNumber` (string)
    External unique id of the sales order line in the source system
    Example: "00000001"

  - `salesOrderLines.externalCompanyId` (string)
    Company that the sales order is assigned to
    Example: "DE01"

  - `salesOrderLines.externalProductId` (string)
    External unique id of the product in the source system
    Example: "PO01"

  - `salesOrderLines.quantity` (number)
    Ordered quantity of the sales order line
    Example: 2

  - `salesOrderLines.unitOfMeasure` (string)
    Unit of measure of the sales order line
    Example: "kg"

  - `salesOrderLines.unitPrice` (number)
    Unit price of the sales order line
    Example: 100

  - `salesOrderLines.netAmount` (number)
    Net amount of the sales order line
    Example: 200

  - `salesOrderLines.totalTaxAmount` (number)
    Tax amount of the sales order line
    Example: 38

  - `salesOrderLines.grossAmount` (number)
    Gross amount of the sales order line
    Example: 238

  - `salesOrderLines.taxCode` (object)

  - `salesOrderLines.taxCode.code` (string)
    Unique code of the type of tax in the source system
    Example: "DEU_Standard"

  - `salesOrderLines.taxCode.description` (string)
    Description of the type of tax in the source system
    Example: "DEU - Standard (19%)"

  - `salesOrderLines.plant` (string)
    Plant responsible for fulfilling the sales order line
    Example: "PLANT-001"

  - `salesOrderLines.storageLocation` (string)
    Storage location of the sales order line
    Example: "BOX-001"

  - `salesOrderLines.externalShippingAddressId` (string)
    Shipping address for the sales order line
    Example: "DE-123E"

  - `salesOrderLines.externalBillingAddressId` (string)
    Billing address related to the sales order line
    Example: "DE-123E"

  - `salesOrderLines.itemText` (string)
    Text describing the sales order line
    Example: "Sold item ABC"

  - `salesOrderLines.type` (string)
    Type of the sales order line
    Example: "Item type"

  - `salesOrderLines.externalQuoteId` (string)
    Quote that the sales order line was ordered from
    Example: "EQ01"

  - `salesOrderLines.quoteLineNumber` (string)
    Line number from the linked quote
    Example: "LN01"

  - `salesOrderLines.externalContractId` (string)
    Contract that the sales order line is related to
    Example: "ECID01"

## Response 200 fields (application/json):

  - `externalId` (string, required)
    External id of the sales order that is globally unique across the provided sales order data
    Example: "DE01"

  - `externalClientId` (string)
    Identifier of the client entity in the source system which can be used to separate data
    Example: "EXTERNAL_CLIENT_ID"

  - `documentId` (string)
    Document id that was assigned during upload to Hypatos
    Example: "63cac12c37bb02accb396cae"

  - `documents` (array)

  - `documents.id` (string)
    Document id that was assigned during upload to Hypatos
    Example: "63cac12c37bb02accb396cae"

  - `documents.type` (string)
    Document type that was assigned during upload to Hypatos
    Example: "invoice"

  - `customerOrderNumber` (string)
    Sales order number provided by the issuing customer
    Example: "CUSTOMER_ORDER_NUMBER"

  - `salesOrderNumber` (string)
    Number of the sales order in the source system (not unique across clients)
    Example: "SALES_ORDER_NUMBER"

  - `externalCompanyId` (string)
    External unique id of the company in the source system
    Example: "DE01"

  - `externalCustomerId` (string)
    External unique id of the customer in the source system
    Example: "CO01"

  - `salesOrganizationCode` (string)
    Sales organization code
    Example: "SO001"

  - `distributionChannel` (string)
    Distribution channel code
    Example: "CH1"

  - `division` (string)
    Division code
    Example: "DIV01"

  - `salesGroup` (string)
    Sales group responsible for the order
    Example: "123456"

  - `salesOffice` (string)
    Sales office responsible for the order
    Example: "98765"

  - `type` (string)
    Type of the invoice as defined in the source system
    Example: "OR"

  - `subType` (string)
    Sub type of the invoice as defined in the source system
    Example: "recurring"

  - `issuedDate` (string)
    Date when the invoice was issued by the supplier (printed on invoice document)
    Example: "2000-12-31"

  - `receivedDate` (string)
    Date when the invoice was received by the company
    Example: "2000-12-31"

  - `fiscalYearLabel` (string)
    Label used in the source system for the fiscal year that the invoice was posted in
    Example: "2023"

  - `requestedDeliveryDate` (string)
    Requested delivery date
    Example: "2000-12-31"

  - `isCanceled` (boolean)
    Indicator if the invoice is canceled

  - `currency` (string,null)
    Three letter currency code as defined in ISO 4217
    Enum: "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLE", "SLL", "SOS", "SRD", "SSP", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "UYI", "UYU", "UYW", "UZS", "VED", "VES", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XSU", "XTS", "XUA", "XXX", "YER", "ZAR", "ZMW", "ZWL", null

  - `totalNetAmount` (number)
    Total net amount of sales order (sum of line item net amounts)
    Example: 100

  - `totalTaxAmount` (number)
    Total tax amount of sales order (sum of all taxes)
    Example: 19

  - `totalGrossAmount` (number)
    Total gross amount of sales order (total net amount + total tax amount)
    Example: 119

  - `paymentTerms` (object)

  - `paymentTerms.paymentTermKey` (string)
    Key of the payment term as defined in the source system
    Example: "T10"

  - `paymentTerms.descriptions` (array)
    Descriptions of the payment terms in different languages
    Example: [{"text":"Please pay us","language":"en"}]

  - `paymentTerms.descriptions.text` (string)
    Text content
    Example: "Fish & Chips"

  - `paymentTerms.descriptions.language` (string,null)
    Two letter language code as defined in ISO 639-1
    Enum: "aa", "ab", "ae", "af", "ak", "am", "an", "ar", "as", "av", "ay", "az", "ba", "be", "bg", "bh", "bi", "bm", "bn", "bo", "br", "bs", "ca", "ce", "ch", "co", "cr", "cs", "cu", "cv", "cy", "da", "de", "dv", "dz", "ee", "el", "en", "eo", "es", "et", "eu", "fa", "ff", "fi", "fj", "fo", "fr", "fy", "ga", "gd", "gl", "gn", "gu", "gv", "ha", "he", "hi", "ho", "hr", "ht", "hu", "hy", "hz", "ia", "id", "ie", "ig", "ii", "ik", "io", "is", "it", "iu", "ja", "jv", "ka", "kg", "ki", "kj", "kk", "kl", "km", "kn", "ko", "kr", "ks", "ku", "kv", "kw", "ky", "la", "lb", "lg", "li", "ln", "lo", "lt", "lu", "lv", "mg", "mh", "mi", "mk", "ml", "mn", "mr", "ms", "mt", "my", "na", "nb", "nd", "ne", "ng", "nl", "nn", "no", "nr", "nv", "ny", "oc", "oj", "om", "or", "os", "pa", "pi", "pl", "ps", "pt", "qu", "rm", "rn", "ro", "ru", "rw", "sa", "sc", "sd", "se", "sg", "si", "sk", "sl", "sm", "sn", "so", "sq", "sr", "ss", "st", "su", "sv", "sw", "ta", "te", "tg", "th", "ti", "tk", "tl", "tn", "to", "tr", "ts", "tt", "tw", "ty", "ug", "uk", "ur", "uz", "ve", "vi", "vo", "wa", "wo", "xh", "yi", "yo", "za", "zh", "zu", null

  - `headerText` (string)
    Header Text describing the invoice
    Example: "doc header text"

  - `customFields` (object)
    List of key value pairs containing custom fields from the source system

  - `customMetadata` (object)
    Any nested structure with metadata that source system needs to send
    Example: {"someTopLevelProperty":"value1","someNestedProperty":{"nestedProperty":"value2"},"someArrayProperty":["value3","value4"]}

  - `salesOrderLines` (array)

  - `salesOrderLines.plannedDeliveryDate` (string)
    Planned delivery date (YYYY-MM-DD)
    Example: "2025-08-27"

  - `salesOrderLines.orderLineNumber` (string)
    External unique id of the sales order line in the source system
    Example: "00000001"

  - `salesOrderLines.externalCompanyId` (string)
    Company that the sales order is assigned to
    Example: "DE01"

  - `salesOrderLines.externalProductId` (string)
    External unique id of the product in the source system
    Example: "PO01"

  - `salesOrderLines.quantity` (number)
    Ordered quantity of the sales order line
    Example: 2

  - `salesOrderLines.unitOfMeasure` (string)
    Unit of measure of the sales order line
    Example: "kg"

  - `salesOrderLines.unitPrice` (number)
    Unit price of the sales order line
    Example: 100

  - `salesOrderLines.netAmount` (number)
    Net amount of the sales order line
    Example: 200

  - `salesOrderLines.totalTaxAmount` (number)
    Tax amount of the sales order line
    Example: 38

  - `salesOrderLines.grossAmount` (number)
    Gross amount of the sales order line
    Example: 238

  - `salesOrderLines.taxCode` (object)

  - `salesOrderLines.taxCode.code` (string)
    Unique code of the type of tax in the source system
    Example: "DEU_Standard"

  - `salesOrderLines.taxCode.description` (string)
    Description of the type of tax in the source system
    Example: "DEU - Standard (19%)"

  - `salesOrderLines.plant` (string)
    Plant responsible for fulfilling the sales order line
    Example: "PLANT-001"

  - `salesOrderLines.storageLocation` (string)
    Storage location of the sales order line
    Example: "BOX-001"

  - `salesOrderLines.externalShippingAddressId` (string)
    Shipping address for the sales order line
    Example: "DE-123E"

  - `salesOrderLines.externalBillingAddressId` (string)
    Billing address related to the sales order line
    Example: "DE-123E"

  - `salesOrderLines.itemText` (string)
    Text describing the sales order line
    Example: "Sold item ABC"

  - `salesOrderLines.type` (string)
    Type of the sales order line
    Example: "Item type"

  - `salesOrderLines.externalQuoteId` (string)
    Quote that the sales order line was ordered from
    Example: "EQ01"

  - `salesOrderLines.quoteLineNumber` (string)
    Line number from the linked quote
    Example: "LN01"

  - `salesOrderLines.externalContractId` (string)
    Contract that the sales order line is related to
    Example: "ECID01"

## Response 400 fields (application/json):

  - `detail` (array)

  - `detail.loc` (array, required)

  - `detail.msg` (string, required)

  - `detail.type` (string, required)

## Response 404 fields (application/json):

  - `type` (string)
    A URI reference that uniquely identifies the problem type only in the context of the provided API. Opposed to the specification in RFC-7807, it is neither recommended to be dereferenceable and point to a human-readable documentation nor globally unique for the problem type.
    Example: "/some/uri-reference"

  - `title` (string)
    A short summary of the problem type. Written in English and readable for engineers, usually not suited for non technical stakeholders and not localized.
    Example: "some title for the error situation"

  - `status` (integer)
    The HTTP status code generated by the origin server for this occurrence of the problem.

  - `detail` (string)
    A human readable explanation specific to this occurrence of the problem that is helpful to locate the problem and give advice on how to proceed. Written in English and readable for engineers, usually not suited for non technical stakeholders and not localized.
    Example: "some description for the error situation"

  - `instance` (string)
    A URI reference that identifies the specific occurrence of the problem, e.g. by adding a fragment identifier or sub-path to the problem type. May be used to locate the root of this problem in the source code.
    Example: "/some/uri-reference#specific-occurrence-context"

## Response 415 fields (application/json):

  - `detail` (array)

  - `detail.loc` (array, required)

  - `detail.msg` (string, required)

  - `detail.type` (string, required)


## Response 429 fields