Skip to navigation

Get a sales order

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.

Required scope: read:sales_orders.

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.
idlong or stringRequired

Sales order ID. Either the numeric id or the public_id (doc_…).

Response

OK
idlong
public_idstringRead-onlyformat: "^[a-z]+_[0-7][0-9a-hjkmnp-tv-z]{25}$"

Stable public identifier of this record. Never changes once assigned. Its prefix names the entity: doc_ document (invoice, proforma, credit note, quote, sales order), exp_ expense, cnt_ contact, prj_ project, ba_ bank account or cash register, txn_ transaction, lon_ loan, bst_ bank statement. Accepted in place of the numeric id in this resource’s path parameters and in request fields that reference it (customer_id, bank_account_id, …).

typeenum
Allowed values:
statusenum

Sales order lifecycle state: draft while it is being entered or extracted; confirmed once accepted (this is where the number is minted); fulfilled once every ordered line has been invoiced — a system transition driven by the fulfilment query, which also moves it back to confirmed if the invoiced total drops; rejected when the order was refused; reopened after a locked order was unlocked for editing; canceled when it was explicitly retired.

currencystring

ISO-4217 currency code.

created_atdatetime
updated_atdatetime
payment_statusenum or nullOptional

Always null: a sales order is not payable, so no settlement is derived for it (the field is reserved for the shared document shape).

Allowed values:
overdueboolean or nullOptional

Always null here — non-payable document type.

paid_lateboolean or nullOptional

Always null here — non-payable document type.

status_transitionsobjectOptional
numberstring or nullOptional

Sales order number (formatted via number_series). Null until the order is confirmed.

issue_datedate or nullOptional
delivery_datedate or nullOptional
exchange_ratestring or nullOptionalformat: "decimal"
included_in_turnoverboolean or nullOptional
reverse_chargeboolean or nullOptional
reverse_charge_textstring or nullOptional
tax_schemestringOptional

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

due_datedate or nullOptional
due_daysinteger or nullOptional
order_numberstring or nullOptional
The customer's own order reference.
discount_descriptionstring or nullOptional
discount_percentagestring or nullOptionalformat: "decimal"
discount_amountstring or nullOptionalformat: "decimal"
opening_textstring or nullOptional
closing_textstring or nullOptional
footer_notestring or nullOptional
internal_notestring or nullOptional
pdf_languagestring or nullOptional
pdf_localestring or nullOptional
delivery_methodstring or nullOptional

Delivery/carrier mode

email_sent_atdatetime or nullOptional
amount_paidstring or nullOptionalformat: "decimal"

Always null here — non-payable document type.

amount_duestring or nullOptionalformat: "decimal"

Always null here — non-payable document type.

import_sourceenum or nullOptional

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 — on this type that is the normal case, since a customer’s order usually arrives as a PDF. 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. The enum is kept as the union across resources rather than narrowed, so a legacy row cannot fail validation.

Allowed values:
totalsobjectOptional
settingsobjectOptional
line_itemslist of objectsOptional
customerobject or nullOptional

The party identity as it appears on a document. On an ISSUED document this is the identity the document was issued with — a snapshot pinned at issue, which does NOT change when the legal entity is later renamed, re-registered, or moved. A draft follows the entity’s current identity. id is the legal entity’s id and is stable across identity changes, so a stored reference keeps resolving. This matches the PDF and the ISDOC export of the same document. vat_period is not part of this projection — a counterparty’s filing period is not knowable.

supplierobject or nullOptional

The party identity as it appears on a document. On an ISSUED document this is the identity the document was issued with — a snapshot pinned at issue, which does NOT change when the legal entity is later renamed, re-registered, or moved. A draft follows the entity’s current identity. id is the legal entity’s id and is stable across identity changes, so a stored reference keeps resolving. This matches the PDF and the ISDOC export of the same document. vat_period is not part of this projection — a counterparty’s filing period is not knowable.

Errors

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