🔒 Update sales order V3

patch

https://{xentralId}.xentral.biz/api/v3/salesOrders/{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: salesOrder:update.

Update a sales order.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

Body Params

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

costCenter

string

length ≤ 255

Cost center for the document

financials

object

preferredWarehouse

object

The preferred warehouse.

sales

object

Sales information

deviatingShipToAddress

masterReferenceNumber

string

length ≤ 255

Master reference number for the sales order.

commissionConsignmentWarehouse

object | null

Commission/consignment warehouse for the sales order. This is used by the commission/consignment module.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

401

Unauthorized

403

Forbidden

404

Not Found

Language

Credentials

Bearer

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

200Update a sales order.

400Failed validation

409Problem occurred

429Too Many Requests