younifyd
Menu

Patch Sales Order

Updates an object of type salesOrder in Dynamics 365 Business Central

PATCH/companies({company_id})/salesOrders({salesOrder_id})

Use it in a workflow

  1. Add a step and choose the Microsoft Dynamics 365 Business Central connector.
  2. Pick the Patch Sales Order action (under Business Central).
  3. Fill in the fields below, then reference the result from later steps as {{patchSalesOrder.response.data}}.

Request

Path parameters

company_idstring (uuid)required

(v1.0) id for company

salesOrder_idstring (uuid)required

(v1.0) id for salesOrder

Headers

Content-Typestringrequired

(v1.0) application/json

If-Matchstringrequired

(v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.

Response

Returns 200 with an object. Read it in later steps with {{patchSalesOrder.response.data.<field>}}.

idstring (uuid)

(v1.0) The id property for the Dynamics 365 Business Central salesOrder entity

numberstring

(v1.0) The number property for the Dynamics 365 Business Central salesOrder entity

externalDocumentNumberstring

(v1.0) The externalDocumentNumber property for the Dynamics 365 Business Central salesOrder entity

orderDatestring (date-time)

(v1.0) The orderDate property for the Dynamics 365 Business Central salesOrder entity

customerIdstring (uuid)

(v1.0) The customerId property for the Dynamics 365 Business Central salesOrder entity

contactIdstring

(v1.0) The contactId property for the Dynamics 365 Business Central salesOrder entity

customerNumberstring

(v1.0) The customerNumber property for the Dynamics 365 Business Central salesOrder entity

customerNamestring

(v1.0) The customerName property for the Dynamics 365 Business Central salesOrder entity

billToNamestring

(v1.0) The billToName property for the Dynamics 365 Business Central salesOrder entity

billToCustomerIdstring (uuid)

(v1.0) The billToCustomerId property for the Dynamics 365 Business Central salesOrder entity

billToCustomerNumberstring

(v1.0) The billToCustomerNumber property for the Dynamics 365 Business Central salesOrder entity

shipToNamestring

(v1.0) The shipToName property for the Dynamics 365 Business Central salesOrder entity

shipToContactstring

(v1.0) The shipToContact property for the Dynamics 365 Business Central salesOrder entity

sellingPostalAddressobject
streetstring

(v1.0) The street property for the Dynamics 365 Business Central postaladdresstype entity

citystring

(v1.0) The city property for the Dynamics 365 Business Central postaladdresstype entity

statestring

(v1.0) The state property for the Dynamics 365 Business Central postaladdresstype entity

countryLetterCodestring

(v1.0) The countryLetterCode property for the Dynamics 365 Business Central postaladdresstype entity

postalCodestring

(v1.0) The postalCode property for the Dynamics 365 Business Central postaladdresstype entity

customerFinancialDetailsarray<object>5 fields
picturearray<object>6 fields
defaultDimensionsarray<object>9 fields
currencyobject7 fields
paymentTermobject8 fields
shipmentMethodobject4 fields
paymentMethodobject4 fields
billingPostalAddressobject
streetstring

(v1.0) The street property for the Dynamics 365 Business Central postaladdresstype entity

citystring

(v1.0) The city property for the Dynamics 365 Business Central postaladdresstype entity

statestring

(v1.0) The state property for the Dynamics 365 Business Central postaladdresstype entity

countryLetterCodestring

(v1.0) The countryLetterCode property for the Dynamics 365 Business Central postaladdresstype entity

postalCodestring

(v1.0) The postalCode property for the Dynamics 365 Business Central postaladdresstype entity

customerFinancialDetailsarray<object>5 fields
picturearray<object>6 fields
defaultDimensionsarray<object>9 fields
currencyobject7 fields
paymentTermobject8 fields
shipmentMethodobject4 fields
paymentMethodobject4 fields
shippingPostalAddressobject
streetstring

(v1.0) The street property for the Dynamics 365 Business Central postaladdresstype entity

citystring

(v1.0) The city property for the Dynamics 365 Business Central postaladdresstype entity

statestring

(v1.0) The state property for the Dynamics 365 Business Central postaladdresstype entity

countryLetterCodestring

(v1.0) The countryLetterCode property for the Dynamics 365 Business Central postaladdresstype entity

postalCodestring

(v1.0) The postalCode property for the Dynamics 365 Business Central postaladdresstype entity

customerFinancialDetailsarray<object>5 fields
picturearray<object>6 fields
defaultDimensionsarray<object>9 fields
currencyobject7 fields
paymentTermobject8 fields
shipmentMethodobject4 fields
paymentMethodobject4 fields
currencyIdstring (uuid)

(v1.0) The currencyId property for the Dynamics 365 Business Central salesOrder entity

currencyCodestring

(v1.0) The currencyCode property for the Dynamics 365 Business Central salesOrder entity

pricesIncludeTaxboolean

(v1.0) The pricesIncludeTax property for the Dynamics 365 Business Central salesOrder entity

paymentTermsIdstring (uuid)

(v1.0) The paymentTermsId property for the Dynamics 365 Business Central salesOrder entity

shipmentMethodIdstring (uuid)

(v1.0) The shipmentMethodId property for the Dynamics 365 Business Central salesOrder entity

salespersonstring

(v1.0) The salesperson property for the Dynamics 365 Business Central salesOrder entity

partialShippingboolean

(v1.0) The partialShipping property for the Dynamics 365 Business Central salesOrder entity

requestedDeliveryDatestring (date-time)

(v1.0) The requestedDeliveryDate property for the Dynamics 365 Business Central salesOrder entity

discountAmountnumber (decimal)

(v1.0) The discountAmount property for the Dynamics 365 Business Central salesOrder entity

discountAppliedBeforeTaxboolean

(v1.0) The discountAppliedBeforeTax property for the Dynamics 365 Business Central salesOrder entity

totalAmountExcludingTaxnumber (decimal)

(v1.0) The totalAmountExcludingTax property for the Dynamics 365 Business Central salesOrder entity

totalTaxAmountnumber (decimal)

(v1.0) The totalTaxAmount property for the Dynamics 365 Business Central salesOrder entity

totalAmountIncludingTaxnumber (decimal)

(v1.0) The totalAmountIncludingTax property for the Dynamics 365 Business Central salesOrder entity

fullyShippedboolean

(v1.0) The fullyShipped property for the Dynamics 365 Business Central salesOrder entity

statusstring

(v1.0) The status property for the Dynamics 365 Business Central salesOrder entity

lastModifiedDateTimestring (date-time)

(v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central salesOrder entity

phoneNumberstring

(v1.0) The phoneNumber property for the Dynamics 365 Business Central salesOrder entity

emailstring

(v1.0) The email property for the Dynamics 365 Business Central salesOrder entity

salesOrderLinesarray<object>
idstring

(v1.0) The id property for the Dynamics 365 Business Central salesOrderLine entity

documentIdstring (uuid)

(v1.0) The documentId property for the Dynamics 365 Business Central salesOrderLine entity

sequenceinteger (int32)

(v1.0) The sequence property for the Dynamics 365 Business Central salesOrderLine entity

itemIdstring (uuid)

(v1.0) The itemId property for the Dynamics 365 Business Central salesOrderLine entity

accountIdstring (uuid)

(v1.0) The accountId property for the Dynamics 365 Business Central salesOrderLine entity

lineTypestring

(v1.0) The lineType property for the Dynamics 365 Business Central salesOrderLine entity

lineDetailsobject4 fields
descriptionstring

(v1.0) The description property for the Dynamics 365 Business Central salesOrderLine entity

unitOfMeasureIdstring (uuid)

(v1.0) The unitOfMeasureId property for the Dynamics 365 Business Central salesOrderLine entity

unitOfMeasureobject7 fields
quantitynumber (decimal)

(v1.0) The quantity property for the Dynamics 365 Business Central salesOrderLine entity

unitPricenumber (decimal)

(v1.0) The unitPrice property for the Dynamics 365 Business Central salesOrderLine entity

discountAmountnumber (decimal)

(v1.0) The discountAmount property for the Dynamics 365 Business Central salesOrderLine entity

discountPercentnumber (decimal)

(v1.0) The discountPercent property for the Dynamics 365 Business Central salesOrderLine entity

discountAppliedBeforeTaxboolean

(v1.0) The discountAppliedBeforeTax property for the Dynamics 365 Business Central salesOrderLine entity

amountExcludingTaxnumber (decimal)

(v1.0) The amountExcludingTax property for the Dynamics 365 Business Central salesOrderLine entity

taxCodestring

(v1.0) The taxCode property for the Dynamics 365 Business Central salesOrderLine entity

taxPercentnumber (decimal)

(v1.0) The taxPercent property for the Dynamics 365 Business Central salesOrderLine entity

totalTaxAmountnumber (decimal)

(v1.0) The totalTaxAmount property for the Dynamics 365 Business Central salesOrderLine entity

amountIncludingTaxnumber (decimal)

(v1.0) The amountIncludingTax property for the Dynamics 365 Business Central salesOrderLine entity

invoiceDiscountAllocationnumber (decimal)

(v1.0) The invoiceDiscountAllocation property for the Dynamics 365 Business Central salesOrderLine entity

netAmountnumber (decimal)

(v1.0) The netAmount property for the Dynamics 365 Business Central salesOrderLine entity

netTaxAmountnumber (decimal)

(v1.0) The netTaxAmount property for the Dynamics 365 Business Central salesOrderLine entity

netAmountIncludingTaxnumber (decimal)

(v1.0) The netAmountIncludingTax property for the Dynamics 365 Business Central salesOrderLine entity

shipmentDatestring (date-time)

(v1.0) The shipmentDate property for the Dynamics 365 Business Central salesOrderLine entity

shippedQuantitynumber (decimal)

(v1.0) The shippedQuantity property for the Dynamics 365 Business Central salesOrderLine entity

invoicedQuantitynumber (decimal)

(v1.0) The invoicedQuantity property for the Dynamics 365 Business Central salesOrderLine entity

invoiceQuantitynumber (decimal)

(v1.0) The invoiceQuantity property for the Dynamics 365 Business Central salesOrderLine entity

shipQuantitynumber (decimal)

(v1.0) The shipQuantity property for the Dynamics 365 Business Central salesOrderLine entity

itemobject20 fields
accountobject

(schema truncated: exceeded maximum nesting depth)

customerobject
idstring (uuid)

(v1.0) The id property for the Dynamics 365 Business Central customer entity

numberstring

(v1.0) The number property for the Dynamics 365 Business Central customer entity

displayNamestring

(v1.0) The displayName property for the Dynamics 365 Business Central customer entity

typestring

(v1.0) The type property for the Dynamics 365 Business Central customer entity

addressobject12 fields
phoneNumberstring

(v1.0) The phoneNumber property for the Dynamics 365 Business Central customer entity

emailstring

(v1.0) The email property for the Dynamics 365 Business Central customer entity

websitestring

(v1.0) The website property for the Dynamics 365 Business Central customer entity

taxLiableboolean

(v1.0) The taxLiable property for the Dynamics 365 Business Central customer entity

taxAreaIdstring (uuid)

(v1.0) The taxAreaId property for the Dynamics 365 Business Central customer entity

taxAreaDisplayNamestring

(v1.0) The taxAreaDisplayName property for the Dynamics 365 Business Central customer entity

taxRegistrationNumberstring

(v1.0) The taxRegistrationNumber property for the Dynamics 365 Business Central customer entity

currencyIdstring (uuid)

(v1.0) The currencyId property for the Dynamics 365 Business Central customer entity

currencyCodestring

(v1.0) The currencyCode property for the Dynamics 365 Business Central customer entity

paymentTermsIdstring (uuid)

(v1.0) The paymentTermsId property for the Dynamics 365 Business Central customer entity

shipmentMethodIdstring (uuid)

(v1.0) The shipmentMethodId property for the Dynamics 365 Business Central customer entity

paymentMethodIdstring (uuid)

(v1.0) The paymentMethodId property for the Dynamics 365 Business Central customer entity

blockedstring

(v1.0) The blocked property for the Dynamics 365 Business Central customer entity

lastModifiedDateTimestring (date-time)

(v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central customer entity

customerFinancialDetailsarray<object>5 fields
picturearray<object>6 fields
defaultDimensionsarray<object>9 fields
currencyobject7 fields
paymentTermobject8 fields
shipmentMethodobject4 fields
paymentMethodobject4 fields
currencyobject
idstring (uuid)

(v1.0) The id property for the Dynamics 365 Business Central currency entity

codestring

(v1.0) The code property for the Dynamics 365 Business Central currency entity

displayNamestring

(v1.0) The displayName property for the Dynamics 365 Business Central currency entity

symbolstring

(v1.0) The symbol property for the Dynamics 365 Business Central currency entity

amountDecimalPlacesstring

(v1.0) The amountDecimalPlaces property for the Dynamics 365 Business Central currency entity

amountRoundingPrecisionnumber (decimal)

(v1.0) The amountRoundingPrecision property for the Dynamics 365 Business Central currency entity

lastModifiedDateTimestring (date-time)

(v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central currency entity

paymentTermobject
idstring (uuid)

(v1.0) The id property for the Dynamics 365 Business Central paymentTerm entity

codestring

(v1.0) The code property for the Dynamics 365 Business Central paymentTerm entity

displayNamestring

(v1.0) The displayName property for the Dynamics 365 Business Central paymentTerm entity

dueDateCalculationstring

(v1.0) The dueDateCalculation property for the Dynamics 365 Business Central paymentTerm entity

discountDateCalculationstring

(v1.0) The discountDateCalculation property for the Dynamics 365 Business Central paymentTerm entity

discountPercentnumber (decimal)

(v1.0) The discountPercent property for the Dynamics 365 Business Central paymentTerm entity

calculateDiscountOnCreditMemosboolean

(v1.0) The calculateDiscountOnCreditMemos property for the Dynamics 365 Business Central paymentTerm entity

lastModifiedDateTimestring (date-time)

(v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central paymentTerm entity

shipmentMethodobject
idstring (uuid)

(v1.0) The id property for the Dynamics 365 Business Central shipmentMethod entity

codestring

(v1.0) The code property for the Dynamics 365 Business Central shipmentMethod entity

displayNamestring

(v1.0) The displayName property for the Dynamics 365 Business Central shipmentMethod entity

lastModifiedDateTimestring (date-time)

(v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central shipmentMethod entity

json
{
  "id": "00000000-0000-0000-0000-000000000000",
  "number": "string",
  "externalDocumentNumber": "string",
  "orderDate": "2025-01-01T00:00:00Z",
  "customerId": "00000000-0000-0000-0000-000000000000",
  "contactId": "string",
  "customerNumber": "string",
  "customerName": "string",
  "billToName": "string",
  "billToCustomerId": "00000000-0000-0000-0000-000000000000",
  "billToCustomerNumber": "string",
  "shipToName": "string"
}

Need more? See the Microsoft Dynamics 365 Business Central guide for connection setup and behaviour shared by every action.

Patch Sales Order — Microsoft Dynamics 365 Business Central — Documentation