🔒 Create offer V3

post

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

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

Create an offer.

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

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

deliveryTerms

string

Delivery terms for the document

internalComment

string

Internal comment for the document

printSettings

object

editor

object

Editor information

costCenter

string

length ≤ 255

Cost center for the document

financials

object

preferredWarehouse

object

The preferred warehouse.

sales

object

Sales information

deviatingShipToAddress

object

customerReference

string

length ≤ 255

Customer reference for the offer.

validUntilDate

date

Date until which the offer is valid.

plannedOrderDate

date

Date when the order is planned to be executed.

desiredDeliveryDate

date

Desired delivery date of the offer. This is the date when the customer wants to receive the goods.

desiredDeliveryDateAsCalendarWeek

boolean

Indicates if the desired delivery date is expressed as a calendar week. If true, the desiredDeliveryDate should be interpreted as the start of the calendar week.

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.

manualShippingCostApproval

boolean

Use this field to manually approve the shipping costs of the offer. Depending on the shipping method configuration, this might be required before the offer can be dispatched.

shippingMethod

object

Reference to the shipping method used for this offer.

paymentMethod

object

Reference to the payment method used for this offer.

lineItems

array of objects

List of line items for the offer.

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