younifyd
Menu

Patch Purchase Invoice

Updates an object of type purchaseInvoice in Dynamics 365 Business Central

PATCH/companies({company_id})/purchaseInvoices({purchaseInvoice_id})

Use it in a workflow

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

Request

Path parameters

company_idstring (uuid)required

(v1.0) id for company

purchaseInvoice_idstring (uuid)required

(v1.0) id for purchaseInvoice

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 {{patchPurchaseInvoice.response.data.<field>}}.

idstring (uuid)

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

numberstring

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

invoiceDatestring (date-time)

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

dueDatestring (date-time)

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

vendorInvoiceNumberstring

(v1.0) The vendorInvoiceNumber property for the Dynamics 365 Business Central purchaseInvoice entity

vendorIdstring (uuid)

(v1.0) The vendorId property for the Dynamics 365 Business Central purchaseInvoice entity

vendorNumberstring

(v1.0) The vendorNumber property for the Dynamics 365 Business Central purchaseInvoice entity

vendorNamestring

(v1.0) The vendorName property for the Dynamics 365 Business Central purchaseInvoice entity

payToNamestring

(v1.0) The payToName property for the Dynamics 365 Business Central purchaseInvoice entity

payToContactstring

(v1.0) The payToContact property for the Dynamics 365 Business Central purchaseInvoice entity

payToVendorIdstring (uuid)

(v1.0) The payToVendorId property for the Dynamics 365 Business Central purchaseInvoice entity

payToVendorNumberstring

(v1.0) The payToVendorNumber property for the Dynamics 365 Business Central purchaseInvoice entity

shipToNamestring

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

shipToContactstring

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

buyFromAddressobject
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
payToAddressobject
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
shipToAddressobject
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 purchaseInvoice entity

currencyCodestring

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

pricesIncludeTaxboolean

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

discountAmountnumber (decimal)

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

discountAppliedBeforeTaxboolean

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

totalAmountExcludingTaxnumber (decimal)

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

totalTaxAmountnumber (decimal)

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

totalAmountIncludingTaxnumber (decimal)

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

statusstring

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

lastModifiedDateTimestring (date-time)

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

purchaseInvoiceLinesarray<object>
idstring

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

documentIdstring (uuid)

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

sequenceinteger (int32)

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

itemIdstring (uuid)

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

accountIdstring (uuid)

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

lineTypestring

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

lineDetailsobject4 fields
descriptionstring

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

unitOfMeasureobject7 fields
unitCostnumber (decimal)

(v1.0) The unitCost property for the Dynamics 365 Business Central purchaseInvoiceLine entity

quantitynumber (decimal)

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

discountAmountnumber (decimal)

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

discountPercentnumber (decimal)

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

discountAppliedBeforeTaxboolean

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

amountExcludingTaxnumber (decimal)

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

taxCodestring

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

taxPercentnumber (decimal)

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

totalTaxAmountnumber (decimal)

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

amountIncludingTaxnumber (decimal)

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

invoiceDiscountAllocationnumber (decimal)

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

netAmountnumber (decimal)

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

netTaxAmountnumber (decimal)

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

netAmountIncludingTaxnumber (decimal)

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

expectedReceiptDatestring (date-time)

(v1.0) The expectedReceiptDate property for the Dynamics 365 Business Central purchaseInvoiceLine entity

itemobject20 fields
accountobject

(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

vendorobject
idstring (uuid)

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

numberstring

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

displayNamestring

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

addressobject12 fields
phoneNumberstring

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

emailstring

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

websitestring

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

taxRegistrationNumberstring

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

currencyIdstring (uuid)

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

currencyCodestring

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

irs1099Codestring

(v1.0) The irs1099Code property for the Dynamics 365 Business Central vendor entity

paymentTermsIdstring (uuid)

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

paymentMethodIdstring (uuid)

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

taxLiableboolean

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

blockedstring

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

balancenumber (decimal)

(v1.0) The balance property for the Dynamics 365 Business Central vendor entity

lastModifiedDateTimestring (date-time)

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

picturearray<object>6 fields
defaultDimensionsarray<object>9 fields
currencyobject7 fields
paymentTermobject8 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

json
{
  "id": "00000000-0000-0000-0000-000000000000",
  "number": "string",
  "invoiceDate": "2025-01-01T00:00:00Z",
  "dueDate": "2025-01-01T00:00:00Z",
  "vendorInvoiceNumber": "string",
  "vendorId": "00000000-0000-0000-0000-000000000000",
  "vendorNumber": "string",
  "vendorName": "string",
  "payToName": "string",
  "payToContact": "string",
  "payToVendorId": "00000000-0000-0000-0000-000000000000",
  "payToVendorNumber": "string"
}

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

Patch Purchase Invoice — Microsoft Dynamics 365 Business Central — Documentation