🔒 Update purchase order V3

patch

https://{xentralId}.xentral.biz/api/v3/purchaseOrders/{id}

This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues.

This endpoint requires the following scopes: purchaseOrder:update.

Update a purchase order. Line items can be written inline through lineItems: an entry with an id updates, an entry without one creates, an entry with deleted: true deletes. The response body carries the updated line items and tags, so an inline-created line item comes back with its new id.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

Body Params

Indicates that the entity has a deviating shipTo address.

address

object

The business partner the document is issued to. Re-pointing it to a different partner re-derives every partner-dependent value from the new partner: documentAddress, project, language, taxation, tax rates, payment method and terms, VAT ID, delivery terms, shipping method, preferred warehouse, sales representative, editor, and the line item discounts. Line item prices and the document currency are deliberately kept unchanged, so negotiated prices survive the change. Fields sent in the same request take precedence over the derived values; a project sent alongside also replaces the one the new partner would bring, and the project-dependent values derive from it. Passing the id the document already has has no effect. Write-protected documents are rejected.

documentDate

date

Date of the document

documentAddress

object

The recipients postal address of the document

project

The project associated with the document. Set to null to remove project association.

internalDesignation

string

length ≤ 255

Internal designation, might be displayed in the letterhead

bodyIntroduction

string

Introduction text for the body of the document

bodyOutroduction

string

Outroduction text for the body of the document

vatId

string

length ≤ 255

VAT ID of the business partner

deliveryTerms

string

Delivery terms for the document

internalComment

string

Internal comment for the document

language

string

Language of the document in an ISO-639-1 format.

printSettings

object

Print settings for the document

editor

object

Editor information

tags

customFields

array of objects

Custom field values for the document. Only custom fields configured for this document in your Xentral instance are accepted here; the customField1 to customField40 keys exist on line items only. Listed keys are written, keys that are not listed are left untouched. Pass value: null to clear a single field.

customFields

deviatingShipToAddress

costCenter

string

length ≤ 255

Cost center for the document

financials

object

shippingMethod

object

Reference to the shipping method used for this document. Defaults to the address, project or company shipping method when omitted.

confirmedDeliveryDate

date | null

Confirmed delivery date of the purchase order.

desiredDeliveryDate

date | null

Desired delivery date of the purchase order.

lineItems

array of objects

length ≤ 100

Line items to write together with the purchase order. An entry with an id updates that product line item of this purchase order (only the provided fields), an entry without an id creates a new line item appended at the end, and an entry with deleted: true deletes the referenced line item. Line items not included in the list are left unchanged - only an explicit deleted entry removes one. Intermediate line items (ids prefixed with il-) can be updated inline as well, limited to their name and description; creating or deleting them requires the dedicated line-item endpoints.

lineItems

useAlternativeDocumentTitle

boolean

Indicates if the alternative document title should be used.

confirmationType

string | null

enum

Type of confirmation for the purchase order.

Allowed:

isConfirmed

boolean

Whether the purchase order has been confirmed by the supplier.

supplierOrderNumber

string | null

Order number provided by the supplier.

supplierOfferNumber

string | null

Offer number provided by the supplier.

customerNumberAtSupplier

string | null

Our customer number as registered with the supplier (shown as "Unsere Kundennummer" on the purchase order PDF).

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

401

Unauthorized

403

Forbidden

404

Not Found

200Update a purchase order. Line items can be written inline through lineItems: an entry with an id updates, an entry without one creates, an entry with deleted: true deletes. The response body carries the updated line items and tags, so an inline-created line item comes back with its new id.

400Failed validation

409Problem occurred

429Too Many Requests