Menu
Patch Sales Invoice
Updates an object of type salesInvoice in Dynamics 365 Business Central
/companies({company_id})/salesInvoices({salesInvoice_id})Use it in a workflow
- Add a step and choose the Microsoft Dynamics 365 Business Central connector.
- Pick the Patch Sales Invoice action (under Business Central).
- Fill in the fields below, then reference the result from later steps as
{{patchSalesInvoice.response.data}}.
Request
Path parameters
company_idstring (uuid)required(v1.0) id for company
salesInvoice_idstring (uuid)required(v1.0) id for salesInvoice
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 {{patchSalesInvoice.response.data.<field>}}.
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
sellingPostalAddressobjectstreetstring(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 fieldspicturearray<object>6 fieldsdefaultDimensionsarray<object>9 fieldscurrencyobject7 fieldspaymentTermobject8 fieldsshipmentMethodobject4 fieldspaymentMethodobject4 fieldsbillingPostalAddressobjectstreetstring(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 fieldspicturearray<object>6 fieldsdefaultDimensionsarray<object>9 fieldscurrencyobject7 fieldspaymentTermobject8 fieldsshipmentMethodobject4 fieldspaymentMethodobject4 fieldsshippingPostalAddressobjectstreetstring(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 fieldspicturearray<object>6 fieldsdefaultDimensionsarray<object>9 fieldscurrencyobject7 fieldspaymentTermobject8 fieldsshipmentMethodobject4 fieldspaymentMethodobject4 fieldscurrencyIdstring (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>idstring(v1.0) The id property for the Dynamics 365 Business Central salesInvoiceLine entity
documentIdstring (uuid)(v1.0) The documentId property for the Dynamics 365 Business Central salesInvoiceLine entity
sequenceinteger (int32)(v1.0) The sequence property for the Dynamics 365 Business Central salesInvoiceLine entity
itemIdstring (uuid)(v1.0) The itemId property for the Dynamics 365 Business Central salesInvoiceLine entity
accountIdstring (uuid)(v1.0) The accountId property for the Dynamics 365 Business Central salesInvoiceLine entity
lineTypestring(v1.0) The lineType property for the Dynamics 365 Business Central salesInvoiceLine entity
lineDetailsobject4 fieldsdescriptionstring(v1.0) The description property for the Dynamics 365 Business Central salesInvoiceLine entity
unitOfMeasureIdstring (uuid)(v1.0) The unitOfMeasureId property for the Dynamics 365 Business Central salesInvoiceLine entity
unitOfMeasureobject7 fieldsunitPricenumber (decimal)(v1.0) The unitPrice property for the Dynamics 365 Business Central salesInvoiceLine entity
quantitynumber (decimal)(v1.0) The quantity property for the Dynamics 365 Business Central salesInvoiceLine entity
discountAmountnumber (decimal)(v1.0) The discountAmount property for the Dynamics 365 Business Central salesInvoiceLine entity
discountPercentnumber (decimal)(v1.0) The discountPercent property for the Dynamics 365 Business Central salesInvoiceLine entity
discountAppliedBeforeTaxboolean(v1.0) The discountAppliedBeforeTax property for the Dynamics 365 Business Central salesInvoiceLine entity
amountExcludingTaxnumber (decimal)(v1.0) The amountExcludingTax property for the Dynamics 365 Business Central salesInvoiceLine entity
taxCodestring(v1.0) The taxCode property for the Dynamics 365 Business Central salesInvoiceLine entity
taxPercentnumber (decimal)(v1.0) The taxPercent property for the Dynamics 365 Business Central salesInvoiceLine entity
totalTaxAmountnumber (decimal)(v1.0) The totalTaxAmount property for the Dynamics 365 Business Central salesInvoiceLine entity
amountIncludingTaxnumber (decimal)(v1.0) The amountIncludingTax property for the Dynamics 365 Business Central salesInvoiceLine entity
invoiceDiscountAllocationnumber (decimal)(v1.0) The invoiceDiscountAllocation property for the Dynamics 365 Business Central salesInvoiceLine entity
netAmountnumber (decimal)(v1.0) The netAmount property for the Dynamics 365 Business Central salesInvoiceLine entity
netTaxAmountnumber (decimal)(v1.0) The netTaxAmount property for the Dynamics 365 Business Central salesInvoiceLine entity
netAmountIncludingTaxnumber (decimal)(v1.0) The netAmountIncludingTax property for the Dynamics 365 Business Central salesInvoiceLine entity
shipmentDatestring (date-time)(v1.0) The shipmentDate property for the Dynamics 365 Business Central salesInvoiceLine entity
itemobject20 fieldsaccountobject(schema truncated: exceeded maximum nesting depth)
pdfDocumentarray<object>idstring (uuid)(v1.0) The id property for the Dynamics 365 Business Central pdfDocument entity
contentstring (binary)(v1.0) The content property for the Dynamics 365 Business Central pdfDocument entity
customerobjectidstring (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 fieldsphoneNumberstring(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 fieldspicturearray<object>6 fieldsdefaultDimensionsarray<object>9 fieldscurrencyobject7 fieldspaymentTermobject8 fieldsshipmentMethodobject4 fieldspaymentMethodobject4 fieldscurrencyobjectidstring (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
{
"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.