List Sales Order Lines

Returns a list of salesOrderLines

GET/companies({company_id})/salesOrderLines

Use it in a workflow

Add a step and choose the Microsoft Dynamics 365 Business Central connector.
Pick the List Sales Order Lines action (under Business Central).
Fill in the fields below, then reference the result from later steps as {{listSalesOrderLines.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 {{listSalesOrderLines.response.data.<field>}}.

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

json

{
  "value": [
    {
      "id": "string",
      "documentId": "00000000-0000-0000-0000-000000000000",
      "sequence": 0,
      "itemId": "00000000-0000-0000-0000-000000000000",
      "accountId": "00000000-0000-0000-0000-000000000000",
      "lineType": "string",
      "lineDetails": {
        "number": "string",
        "displayName": "string",
        "item": {
          "id": "00000000-0000-0000-0000-000000000000",
          "number": "string",
          "displayName": "string",
          "type": "string",
          "itemCategoryId": "00000000-0000-0000-0000-000000000000",
          "itemCategoryCode": "string",
          "blocked": false,
          "baseUnitOfMeasureId": "00000000-0000-0000-0000-000000000000",
          "baseUnitOfMeasure": {
            "code": "string",
            "displayName": "string",
            "symbol": "string",
            "unitConversion": {
              "toUnitOfMeasure": null,
              "fromToConversionRate": null,
              "picture": null,
              "defaultDimensions": null,
              "itemCategory": null
            },
            "picture": [
              null
            ],
            "defaultDimensions": [
              null
            ],
            "itemCategory": {
              "id": null,
              "code": null,
              "displayName": null,
              "lastModifiedDateTime": null
            }
          },
          "gtin": "string",
          "inventory": 0,
          "unitPrice": 0
        },
        "account": {}
      },
      "description": "string",
      "unitOfMeasureId": "00000000-0000-0000-0000-000000000000",
      "unitOfMeasure": {
        "code": "string",
        "displayName": "string",
        "symbol": "string",
        "unitConversion": {
          "toUnitOfMeasure": "string",
          "fromToConversionRate": 0,
          "picture": [
            {
              "id": null,
              "width": null,
              "height": null,
              "contentType": null,
              "content@odata.mediaEditLink": null,
              "content@odata.mediaReadLink": null
            }
          ],
          "defaultDimensions": [
            {
              "parentId": null,
              "dimensionId": null,
              "dimensionCode": null,
              "dimensionValueId": null,
              "dimensionValueCode": null,
              "postingValidation": null,
              "account": null,
              "dimension": null,
              "dimensionValue": null
            }
          ],
          "itemCategory": {
            "id": "00000000-0000-0000-0000-000000000000",
            "code": "string",
            "displayName": "string",
            "lastModifiedDateTime": "2025-01-01T00:00:00Z"
          }
        },
        "picture": [
          {
            "id": "00000000-0000-0000-0000-000000000000",
            "width": 0,
            "height": 0,
            "contentType": "string",
            "content@odata.mediaEditLink": "string",
            "content@odata.mediaReadLink": "string"
          }
        ],
        "defaultDimensions": [
          {
            "parentId": "00000000-0000-0000-0000-000000000000",
            "dimensionId": "00000000-0000-0000-0000-000000000000",
            "dimensionCode": "string",
            "dimensionValueId": "00000000-0000-0000-0000-000000000000",
            "dimensionValueCode": "string",
            "postingValidation": "string",
            "account": {},
            "dimension": {},
            "dimensionValue": {}
          }
        ],
        "itemCategory": {
          "id": "00000000-0000-0000-0000-000000000000",
          "code": "string",
          "displayName": "string",
          "lastModifiedDateTime": "2025-01-01T00:00:00Z"
        }
      },
      "quantity": 0,
      "unitPrice": 0
    }
  ]
}

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

Was this page helpful?