Create credit note V3

post

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

This endpoint requires the following scopes: creditNote:create.

Create a new credit note.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

address

object

required

project

The project the document is assigned to. Defaults to the preferred project of the requesting user when one is configured, otherwise to the project of the address. Send null to create the document without a project; that also suppresses the default.

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

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

length ≤ 255

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

Print settings for the document

editor

object

Editor information

costCenter

string

length ≤ 35

Cost center for the document

financials

object

sales

object

Sales information

lineItems

array of objects

length ≤ 100

List of line items for the credit note. Entries are either product line items (no type, or type: product) or intermediate line items (type naming the intermediate type). Array order defines placement: an intermediate entry is anchored to the product entry preceding it in the array.

lineItems

deliveryDate

date | null

Delivery date for the credit note.

debtStatus

object

deviatingDebtorAccountNumber

string

length ≤ 32

Deviating debtor account number for accounting purposes.

customerOrderNumber

string

length ≤ 255

Purchase order number provided by the customer, typically used in a B2B context.

documentNumber

string

length ≤ 64

Custom document number to assign to the credit note. By default, the document number is generated by Xentral when the credit note is released. Providing this field overrides that default: the supplied number is used and the credit note is created as released immediately (no separate actions/release call needed). Intended for use cases where the document number originates from an external system (e.g. Amazon VCS mirroring credit notes from Amazon's own number range). The number must be unique across all credit notes.

invoice

Reference to an invoice to link the credit note to. The link is reference-only: the invoice's line items are not copied, and the invoice is neither changed nor cancelled. Two things do depend on the link — the exchange rate is taken from the invoice when the company setting for it is enabled and none is sent, and the cash-discount terms keep their regular defaults instead of being zeroed as they are on a credit note without a link.

Headers

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

201Create a new credit note.

400Failed validation

429Too Many Requests