This instance couldn't reach its API specification on the last attempt, so this page shows the copy fetched before that. Anything added or changed since then is missing here, and the reference updates itself as soon as the specification is readable again. Last fetched 2026-10-22 22:52 UTC.
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
Input DTO for a credit note line item.
Values
Values:Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Fields
Field
Type
Description
originalLineItemIdrequired
string (uuid)
The invoice line being credited. When set, the tax is derived from that line at its effective
rate and the credit cannot exceed the line's net plus tax. Leave null for a free-form credit.nullable
Values:Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
descriptionrequired
string
nullablemax length 500
Values:Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
quantityrequired
number (double)
greater than 0
Values:Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
unitPricerequired
number (double)
Price per unit credited. May carry more than two decimals; the line's net is rounded to the cent.
Values:Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
taxAmountrequired
number (double)
Tax credited on this line. Honoured, rounded to the cent and floored at zero, only on a free-form
line; on a line that references an original invoice line it is ignored and derived server-side.
Values:Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
lineTotalrequired
number (double)
Ignored. The persisted line total is always computed server-side and returned on the response.
Kept so existing requests keep deserialising.
Values:Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
This model has no documented fields.
Reconnecting to the server
Could not reconnect
This session has ended
Attempt 1
Your work on this page is still here. Retrying keeps it; reloading starts the page again.
The server no longer holds this page's state, so it has to be loaded again.