🔒 Create proforma invoice V3

post

https://{xentralId}.xentral.biz/api/v3/proformaInvoices

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:create.

Create a new proforma invoice.

Recent Requests

Log in to see full request history

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Indicates that the entity has a deviating shipTo address.

address

object

required

project

documentDate

date

Date of the document. Current date is used when omitted.

language

string

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

tags

array of objects

List of tags associated with the document. New tags will be automatically created if they do not exist.

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.

customFields

documentAddress

object

The recipients postal address of the document. If not provided, the address of the business partner will be used.

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

VAT ID of the business partner. Defaults to the VAT ID of the address when omitted.

deliveryTerms

string

Delivery terms for the document. Defaults to the delivery terms of the address when omitted.

internalComment

string

Internal comment for the document

printSettings

object

editor

object

Editor information

deviatingShipToAddress

object

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.

salesOrder

Optional reference to a sales order.

deliveryDate

date

Delivery date for the proforma invoice.

useAlternativeDocumentTitle

boolean

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

customerOrderNumber

string

length ≤ 255

Customer order number / reference.

addCustomsInformation

boolean

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

customsInformation

string | null

Free-text customs information shown on the proforma invoice, e.g. regarding customs clearance. If not provided, it is taken from the customs information stored on the document address.

deviatingCustomsToAddress

A separate customs-to address for the proforma invoice. If omitted, the document address is used as the customs-to address.

lineItems

array of objects

List of line items for the proforma invoice.

lineItems

Headers

accept

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

401

Unauthorized

403

Forbidden

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