younifyd
Menu

List Sales Orders

Returns a list of salesOrders

GET/companies({company_id})/salesOrders

Use it in a workflow

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

Request

Path parameters

company_idstring (uuid)required

(v1.0) id for company

Query parameters

$topinteger

(v1.0) Number of items to return from the top of the list

$skipinteger

(v1.0) Number of items to skip from the list

$limitinteger

(v1.0) Number of items to return from the list

$filterstring

(v1.0) Filtering expression

$expandarray<string>

(v1.0) Entities to expand

$selectarray<string>

(v1.0) Selected properties to be retrieved

Response

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

valuearray<object>
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

sellingPostalAddressobject12 fields
billingPostalAddressobject12 fields
shippingPostalAddressobject12 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>31 fields
customerobject26 fields
currencyobject7 fields
paymentTermobject8 fields
shipmentMethodobject4 fields
json
{
  "value": [
    {
      "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.

List Sales Orders — Microsoft Dynamics 365 Business Central — Documentation