API Reference
GuidesAPI ReferenceRoadmap
API Reference
API Reference

šŸ”’ Update offer V3

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

Update an offer.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requestsā€¦
LoadingLoadingā€¦
Path Params
string
required
Body Params
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
string
length ā‰¤ 255

Cost center for the document

financials
object
preferredWarehouse
object

The preferred warehouse.

sales
object

Sales information

deviatingShipToAddress
string
length ā‰¤ 255

Customer reference for the offer.

date

Date until which the offer is valid.

date

Date when the order is planned to be executed.

date

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

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.

boolean

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

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.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

401

Unauthorized

403

Forbidden

404

Not Found

Updated about 1 month ago

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

Updated about 1 month ago