List Sales Invoices

Returns a list of salesInvoices

GET/companies({company_id})/salesInvoices

Use it in a workflow

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

valuearray<object>

idstring (uuid)

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

numberstring

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

externalDocumentNumberstring

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

invoiceDatestring (date-time)

(v1.0) The invoiceDate property for the Dynamics 365 Business Central salesInvoice entity

dueDatestring (date-time)

(v1.0) The dueDate property for the Dynamics 365 Business Central salesInvoice entity

customerPurchaseOrderReferencestring

(v1.0) The customerPurchaseOrderReference property for the Dynamics 365 Business Central salesInvoice entity

customerIdstring (uuid)

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

contactIdstring

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

customerNumberstring

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

customerNamestring

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

billToNamestring

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

billToCustomerIdstring (uuid)

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

billToCustomerNumberstring

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

shipToNamestring

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

shipToContactstring

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

sellingPostalAddressobject12 fields

billingPostalAddressobject12 fields

shippingPostalAddressobject12 fields

currencyIdstring (uuid)

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

currencyCodestring

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

orderIdstring (uuid)

(v1.0) The orderId property for the Dynamics 365 Business Central salesInvoice entity

orderNumberstring

(v1.0) The orderNumber property for the Dynamics 365 Business Central salesInvoice entity

paymentTermsIdstring (uuid)

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

shipmentMethodIdstring (uuid)

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

salespersonstring

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

pricesIncludeTaxboolean

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

remainingAmountnumber (decimal)

(v1.0) The remainingAmount property for the Dynamics 365 Business Central salesInvoice entity

discountAmountnumber (decimal)

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

discountAppliedBeforeTaxboolean

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

totalAmountExcludingTaxnumber (decimal)

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

totalTaxAmountnumber (decimal)

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

totalAmountIncludingTaxnumber (decimal)

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

statusstring

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

lastModifiedDateTimestring (date-time)

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

phoneNumberstring

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

emailstring

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

salesInvoiceLinesarray<object>27 fields

pdfDocumentarray<object>2 fields

customerobject26 fields

currencyobject7 fields

json

{
  "value": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "number": "string",
      "externalDocumentNumber": "string",
      "invoiceDate": "2025-01-01T00:00:00Z",
      "dueDate": "2025-01-01T00:00:00Z",
      "customerPurchaseOrderReference": "string",
      "customerId": "00000000-0000-0000-0000-000000000000",
      "contactId": "string",
      "customerNumber": "string",
      "customerName": "string",
      "billToName": "string",
      "billToCustomerId": "00000000-0000-0000-0000-000000000000"
    }
  ]
}

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

Was this page helpful?