API ReferenceCredit Notes

Get a credit note

View as Markdown

Returns 404 if the ID belongs to a document of a different type (e.g. an invoice ID) — each document type is isolated to its own endpoint.

Authentication

AuthorizationBearer

JWT issued via POST /api/v1/auth/sign_in. Used by mobile and SPA clients. Revoked tokens are rejected.

OR
AuthorizationBearer
Lucanto API key. Two prefixes: - `lct_pat_<random><checksum>` — personal access token (owner: User) - `lct_live_<random><checksum>` — workspace token, live data Issue keys at `/settings/api_keys` (personal) or `/:workspace_id/settings/api_keys` (workspace). Plaintext token is shown once and never again.

Path parameters

workspace_idlongRequired>=1
Workspace ID. The numeric ID shown in your URLs.
idlongRequired>=1
Credit note ID

Response

OK
idlong
typeenum
statusenum

Credit note lifecycle state. The full payment-derived state set can appear here even though credit notes are not themselves a payment obligation. Practically: consumers should treat draft and exposed as the meaningful credit-note lifecycle states; the paid-family states reflect how the credit note has been applied against the source invoice.

currencystring

ISO-4217 currency code.

created_atdatetime
updated_atdatetime
numberstring or null

Credit note number (formatted via number_series, e.g. ‘DOB2026-0001’). Null for drafts.

issue_datedate or null
delivery_datedate or null
exchange_ratestring or nullformat: "decimal"
included_in_turnoverboolean or null
reverse_chargeboolean or null
reverse_charge_textstring or null
tax_schemestring

Tax scheme (UNCL 5153), e.g. “VAT”.

due_datedate or null
due_daysinteger or null
order_numberstring or null
discount_descriptionstring or null
discount_percentagestring or nullformat: "decimal"
discount_amountstring or nullformat: "decimal"
opening_textstring or null
closing_textstring or null
footer_notestring or null
internal_notestring or null
pdf_languagestring or null
pdf_localestring or null
delivery_methodstring or null

Delivery/carrier mode

email_sent_atdatetime or null
amount_paidstring or nullformat: "decimal"

Amount settled so far (payments + advance deductions).

amount_duestring or nullformat: "decimal"

Outstanding amount (tax_inclusive − amount_paid).

paymentobject
import_sourceenum or null

Origin of the document. null when it was created in Lucanto, in which case totals are Lucanto’s EN 16931 calculation. A non-null value means the document was imported from that system and initially carries the source system’s own figures, preserved verbatim; those may differ by cents from Lucanto’s calculation because systems round VAT at different levels (line vs. category). insight means AI extraction from an uploaded file, not an import from another vendor. This records provenance only, not which calculation is currently in effect — editing line items or document discounts recomputes totals in Lucanto while leaving import_source set. In practice a document only ever carries kros_developer, isdoc, superfaktura or null. kros appears only on rows imported before the writer was renamed, and insight is written by the expense path only. The enum is kept as the union across resources rather than narrowed, so a legacy row cannot fail validation.

totalsobject
settingsobject
line_itemslist of objects
customerobject or null
supplierobject or null

Errors

401
Unauthorized Error
402
Payment Required Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error