Partially update quote

Request

Security

OAuth2(Required scopes: enrichment.write)

Path

externalIdstringrequired

Previously sent externalId

Bodyapplication/merge-patch+jsonrequired

externalIdstring^\S+$required

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

Example:"QUOTE12345"

externalClientIdstring

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

Example:"CLIENT123"

documentIdstring

Document id that was assigned during upload to Hypatos

Example:"DOC12345"

documentsArray of objects

quoteNumberstring

Quote number from the source system

Example:"Q12345"

customerOrderNumberstring

Customer order number the quote refers to

Example:"CO12345"

externalCompanyIdstring

External unique id of the company in the source system

Example:"COMP123"

externalCustomerIdstring

External unique id of the customer in the source system

Example:"CUST123"

statusstring

Status of the quote

Example:"approved"

salesOrganizationCodestring

Sales organization code

Example:"SO123"

distributionChannelstring

Distribution channel code

Example:"DC123"

divisionstring

Division code

Example:"DIV123"

salesGroupstring

Sales group responsible for the quote

Example:"123"

salesOfficestring

Sales office responsible for the quote

Example:"456"

typestring

Type of the quote as defined in the source system

Example:"standard"

subTypestring

Sub-type of the quote as defined in the source system

Example:"recurring"

issuedDatestring, (date)

Date when the quote was issued

Example:"2023-01-01"

validUntilDatestring, (date)

Date until the quote is valid

Example:"2023-12-31"

fiscalYearLabelstring

Fiscal year label used in the source system

Example:"FY2023"

isCanceledboolean

Indicator if the quote is canceled

Example:false

currencystring

Three letter currency code as defined in ISO 4217

Example:"USD"

totalNetAmountnumber

Total net amount of the quote

Example:1000

totalTaxAmountnumber

Total tax amount of the quote

Example:190

totalGrossAmountnumber

Total gross amount of the quote

Example:1190

paymentTermsobject(paymentTerms)

headerTextstring

Header text describing the quote

Example:"This is a sample quote."

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"
  ]
}

quoteLinesArray of objects

curl -i -X PATCH \
  'https://api.cloud.hypatos.ai/v2/enrichment/quotes/{externalId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/merge-patch+json' \
  -d '{
    "externalId": "QUOTE12345",
    "externalClientId": "CLIENT123",
    "documentId": "DOC12345",
    "documents": [
      {
        "id": "DOC12345",
        "type": "invoice"
      }
    ],
    "quoteNumber": "Q12345",
    "customerOrderNumber": "CO12345",
    "externalCompanyId": "COMP123",
    "externalCustomerId": "CUST123",
    "status": "approved",
    "salesOrganizationCode": "SO123",
    "distributionChannel": "DC123",
    "division": "DIV123",
    "salesGroup": "123",
    "salesOffice": "456",
    "type": "standard",
    "subType": "recurring",
    "issuedDate": "2023-01-01",
    "validUntilDate": "2023-12-31",
    "fiscalYearLabel": "FY2023",
    "isCanceled": false,
    "currency": "USD",
    "totalNetAmount": 1000,
    "totalTaxAmount": 190,
    "totalGrossAmount": 1190,
    "paymentTerms": {
      "paymentTermKey": "T10",
      "descriptions": [
        {
          "text": "Please pay us",
          "language": "en"
        }
      ]
    },
    "headerText": "This is a sample quote.",
    "customFields": {
      "property1": "string",
      "property2": "string"
    },
    "customMetadata": {
      "someTopLevelProperty": "value1",
      "someNestedProperty": {
        "nestedProperty": "value2"
      },
      "someArrayProperty": [
        "value3",
        "value4"
      ]
    },
    "quoteLines": [
      {
        "quoteLineNumber": "QL12345",
        "externalCompanyId": "COMP123",
        "product": {
          "externalId": "PROD123",
          "productNumber": "PN123",
          "customerProductNumber": "CPN123",
          "type": "standard",
          "group": "electronics",
          "description": "A high-quality electronic product.",
          "manufacturer": "Acme Corp.",
          "manufacturerNumber": "MN123",
          "unspsc": "43211508",
          "ean": "4006381333931",
          "upc": "036000291452"
        },
        "status": "approved",
        "quantity": 10,
        "unitOfMeasure": "kg",
        "unitPrice": 100,
        "netAmount": 1000,
        "totalTaxAmount": 190,
        "grossAmount": 1190,
        "taxCode": {
          "code": "DEU_Standard",
          "description": "DEU - Standard (19%)"
        },
        "description": "This is a sample quote line.",
        "plant": "PLANT123",
        "storageLocation": "LOC123",
        "externalShippingAddressId": "ADDR123",
        "externalBillingAddressId": "ADDR456",
        "itemText": "Sample item text.",
        "type": "standard",
        "externalContractId": "CONTRACT123",
        "customFields": {
          "property1": "string",
          "property2": "string"
        },
        "customMetadata": {
          "someTopLevelProperty": "value1",
          "someNestedProperty": {
            "nestedProperty": "value2"
          },
          "someArrayProperty": [
            "value3",
            "value4"
          ]
        }
      }
    ]
  }'

Responses

Successfully updated

Bodyapplication/json