API ReferenceCredit Notes

Suggested bank transactions for this credit note

View as Markdown
Bank transactions that most likely settled this credit note — the mirror of [`listTransactionSuggestions`](#operation/listTransactionSuggestions), same engine, record on the other side. Read-only. To act on one, post it to [`pair`](#operation/pairTransaction) on the SUGGESTED TRANSACTION (`pairable.id` here is the transaction), naming this credit note as the pairable — pairing is always written from the transaction's side.

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
CreditNote ID.

Query parameters

limitintegerOptional1-20Defaults to 5

How many suggestions to return. Values above the maximum are clamped rather than rejected, and a non-positive value falls back to the default.

Response

OK
datalist of objects

Errors

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