Create credit note line item V3

post

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

This endpoint requires the following scopes: creditNote:update.

Create a new credit note line item. Pass type naming an intermediate type (heading, subtotal, group total, image, page break) to create an intermediate line item instead of a product line item.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

Body Params

OpenAPI-only union schema for the credit note line-item create endpoint: the request body is
either a product line item or an intermediate line item, discriminated by the type field:
absent or product for a product line item, an intermediate type otherwise. The controller
dispatches to the matching data class.

product

object

required

Product information.

quantity

float

required

Quantity of the line item.

name

string

length ≤ 255

Line item name. If not provided, the product name will be used.

description

string

Line item description. If not provided, the product description will be used.

countryOfOrigin

string

length ≤ 128

Country of origin for the product. If not provided, the product's country of origin will be used.

hsCode

string

length ≤ 128

Harmonized System (HS) code for the product. If not provided, the product's HS code will be used.

deliveryDate

date

Delivery date of the line item.

deliveryDateAsCalendarWeek

boolean

Defaults to false

Whether to show the delivery date as calendar week or explicit.

internalComment

string

Internal comment for the line item.

customerProductNumber

string

length ≤ 128

Customer product number for the line item.

unit

string

length ≤ 128

Unit of the line item (e.g., "kg", "pcs"). If not provided, the product's unit will be used.

packagingUnit

string

length ≤ 255

Packaging unit (VPE) of the line item — how many units one package contains. On purchase orders a numeric value greater than 1 makes the generated PDF present the line in packages: the price is printed per package, the quantity in packages, and the unit as "VPE". On all other document types the value is stored and carried over on document conversion, but nothing reads it — in particular, the stored quantity, the stored unit price, and the values returned by the API are never derived from it.

project

Project of the line item. If not provided, the product's project will be used. Explicitly pass null to assign no project.

customFields

array of objects

Custom field values for the line item. Accepts the customField1 to customField40 keys as well as any custom field configured for this line item in your Xentral instance. Listed keys are written, keys that are not listed are left untouched.

customFields

position

object

Where to place the line item. If omitted, it is appended after the last line item of the document.

discount

float

Discount percentage

price

object

Price information

taxLegalNotice

string

length ≤ 255

Legal notice regarding tax for this line item

printSettings

object

Print settings for this line item

noDiscountAllowed

boolean

Defaults to false

If true, no discount may be applied to this line item.

quantityFormula

string | null

Formula used to compute the quantity.

priceFormula

string | null

Formula used to compute the price.

costCenter

string | null

Cost center for this line item.

purchasePrice

object

Purchase price (cost price) of this line item. The currency must match the document currency. Setting it marks the price as manually provided (not resolved from a price list) and it is used for the contribution margin calculation.

taxRate

enum

The tax rate applied to this line item. Either one of the predefined tax categories - standard and reduced use the corresponding tax rate of the document (see financials.tax.taxRates), exempt uses 0% - or an explicit percentage that replaces the category. Stored with two decimals. When omitted on creation, the tax category of the product applies.

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

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 line item. Pass type naming an intermediate type (heading, subtotal, group total, image, page break) to create an intermediate line item instead of a product line item.

400Failed validation

409Problem occurred

429Too Many Requests