🔒 Update proforma invoice V3

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: proformaInvoice:update.

Update a proforma invoice.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
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.

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.

string
length ≤ 255

Internal designation, might be displayed in the letterhead

string

Introduction text for the body of the document

string

Outroduction text for the body of the document

string
length ≤ 255

VAT ID of the business partner

string

Delivery terms for the document

string

Internal comment for the document

string

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

printSettings
object

Print settings for the document

editor
object

Editor information

tags
array of objects

List of tags associated with the document. The passed list replaces the currently associated tags.

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
financials
object
sales
object

Sales information

shippingMethod
object

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

date | null

Delivery date for the proforma invoice.

boolean

Indicates if the alternative document title should be used. The alternative document title can be configured per document type in the system settings.

string
length ≤ 255

Customer order number / reference.

boolean

Whether customs information (customs tariff numbers, country of origin and weight per line item) should be printed on the proforma invoice.

string | null

Free-text customs information shown on the proforma invoice, e.g. regarding customs clearance. Pass null to clear it.

deviatingCustomsToAddress

A separate customs-to address for the proforma invoice. Pass null to remove it, so the document address becomes the customs-to address again.

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
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json