Draft Journal Entries (v2)
Create draft journal entries in batch (v2)
Credential: a company's API key or OAuth token.
Atomically creates 1–100 draft journal entries in a single transaction. Each entry follows the same restrictions as POST /api/v2/draft-journal-entries: auto-append of the AR/AP leg for locked types, tenant-scoped customerId / supplierId / journalCategoryId / line accountId validation.
If any entry fails validation or persistence the entire batch is rolled back — no draft rows are created. journalCategoryId / customerId / supplierId / accountId from another tenant rejects the whole batch with the matching error code.
Answers with every created draft in entries, in request order, each as
GET /api/v2/draft-journal-entries/:id returns it. A retry with the same x-api-idempotency-key
creates nothing and answers { idempotentReplay: true, id: null }; a retry while the first is still
running answers 409 IDEMPOTENT_REQUEST_IN_PROGRESS, and a key already used on a different endpoint
answers 422 IDEMPOTENCY_KEY_REUSED. The body is not compared: the same key with a different body
also answers the replay above and creates nothing.
Attachments: each entry may include up to 10 base64-encoded attachments[]. A failure on any
entry rolls back the whole batch and deletes every already-uploaded blob — no orphan documents
survive.
Required Scope
journal-entries-write
Headers
x-api-idempotency-keyOptional idempotency key for safely retrying mutating requests.
Create draft journal entries in batch (v2) › Request Body
Array of 1–100 draft journal entries, carrying at most 10000 lines in total across the batch. Wrapped in a single transaction; one bad entry rolls back the whole batch.
Create draft journal entries in batch (v2) › Responses
Batch created — every draft persisted
totalCreatedNumber of drafts created (= entries.length on success).
Created draft journal entries, ordered to match the request entries[].
List draft journal entries (v2)
Credential: a company's API key or OAuth token.
Returns a paginated list of draft journal entries owned by the API key's app company. Tenant-scoped: drafts created by other companies are never visible here. Identical response shape to GET /api/v1/draft-journal-entries.
Required Scope
journal-entries-read
query Parameters
cursorOpaque cursor from the previous response's nextCursor. Returns the rows after it, in the same order. Send the same filters and sort as the request that produced it, and do not send page. The preferred way to page through a list.
pageDeprecated: page with cursor instead. Page number (1-indexed). From 2026-12-31, a page past the first of a list with more than 10,000 matching rows is refused.
limitMaximum items per page
fromDateOnly include drafts on or after this date (YYYY-MM-DD)
toDateOnly include drafts on or before this date (YYYY-MM-DD)
accountIdFilter by account ID (matches any draft line on this account)
customerIdFilter by customer ID
supplierIdFilter by supplier ID
vendorIdDeprecated — use supplierId. Legacy alias for the supplier filter.
journalTypeFilter by journal type
journalCategoryIdOnly include drafts in this journal category
minBaseCurrencyAmountOnly include drafts whose baseCurrencyAmount (the draft in your company base currency) is greater than or equal to this value (inclusive).
maxBaseCurrencyAmountOnly include drafts whose baseCurrencyAmount (the draft in your company base currency) is less than or equal to this value (inclusive).
minAmountDeprecated — use minBaseCurrencyAmount. The same filter under its old name. Sending both with different values returns 400 DRAFT_DEPRECATED_FIELD_CONFLICT.
maxAmountDeprecated — use maxBaseCurrencyAmount. The same filter under its old name. Sending both with different values returns 400 DRAFT_DEPRECATED_FIELD_CONFLICT.
externalSystemIdExact-match filter on your own system's id. Not unique — several drafts may share one id, so expect zero or more results.
searchFree-text search in description and reference fields
List draft journal entries (v2) › Responses
Drafts retrieved
List of draft journal entries
totalTotal number of matching drafts
limitItems per page
nextCursorCursor for the next page; pass it as cursor. null on the last page, and on every page of a sort that cannot page by cursor — hasMore then says whether another page follows by page number.
hasMoreWhether more rows follow this page.
pageDeprecated: page with nextCursor instead. Current page number.
totalPagesDeprecated: page with nextCursor instead. Total number of pages.
Create a draft journal entry (v2)
Credential: a company's API key or OAuth token.
Creates a draft journal entry with the V2 restriction matrix enforced at create-time (unlike v1, which only validates on book). For CUSTOMER_INVOICE / CUSTOMER_PAYMENT / SUPPLIER_INVOICE / SUPPLIER_PAYMENT submit only the counter-side lines — the server auto-appends the AR/AP leg on the partner group default account.
Answers with the created draft, the body GET /api/v2/draft-journal-entries/:id returns. A retry
with the same x-api-idempotency-key creates nothing and answers { idempotentReplay: true, id };
a retry while the first is still running answers 409 IDEMPOTENT_REQUEST_IN_PROGRESS, and a key
already used on a different endpoint answers 422 IDEMPOTENCY_KEY_REUSED. The body is not compared:
the same key with a different body also answers the replay above and creates nothing.
Tenant scoping: every customerId / supplierId / journalCategoryId / line accountId is validated against the API key's app company. Cross-tenant or unknown ids reject with 400 (JOURNAL_CATEGORY_NOT_FOUND, ACCOUNT_NOT_FOUND, CUSTOMER_HAS_NO_GROUP, SUPPLIER_HAS_NO_GROUP, INVOICE_AR_LEG_NOT_ON_GROUP_DEFAULT, PAYMENT_AR_LEG_NOT_ON_GROUP_DEFAULT, INVOICE_AP_LEG_NOT_ON_GROUP_DEFAULT, PAYMENT_AP_LEG_NOT_ON_GROUP_DEFAULT).
Attachments: include up to 10 base64-encoded files in the optional attachments[] field —
same shape and limits as POST /api/v2/journal-entries. Each becomes a Document linked to the
draft; when the draft is booked, the documents migrate to the posted JE and surface via
GET /api/v1/journal-entries/:id/attachments. Rejection paths: an invalid MIME type rejects at
DTO validation with 400 SHARED_VALIDATION_FAILED; malformed base64 reaches the service and
rejects with 400 JOURNAL_ENTRY_INVALID_ATTACHMENT_TYPE.
Required Scope
journal-entries-write
Headers
x-api-idempotency-keyOptional idempotency key for safely retrying mutating requests.
Create a draft journal entry (v2) › Request Body
entryTypeJournal type. For CUSTOMER_INVOICE / CUSTOMER_PAYMENT / SUPPLIER_INVOICE / SUPPLIER_PAYMENT the AR/AP leg is appended automatically; do not include it in lines.
datePosting date (YYYY-MM-DD).
originalAmountFace value of the document — what the counterparty is invoiced or pays. NOT the sum of lines. On CUSTOMER_INVOICE / CUSTOMER_PAYMENT / SUPPLIER_INVOICE / SUPPLIER_PAYMENT this value IS the appended AR/AP leg (its absolute value), so an account that appears on both sides of the entry — a clearing or pass-through account — must not be counted into it. Sign carries direction: positive = invoice / payment, negative = credit-note / refund.
Counter-side lines (revenue / expense / bank / outlay). For locked types do NOT include the AR/AP leg. The cap is per ENTRY, not per request or per journal category — nothing accumulates across entries, so a company with many unposted drafts is never refused for that reason.
documentDateDocument date (YYYY-MM-DD): the date printed on the invoice or voucher. The VAT period follows it, so a supplier invoice dated 28 March and booked on 3 April lands in March. Omit it and the entry has no document date of its own; its VAT period then follows date. null is read as omitted.
dueDateDue date (YYYY-MM-DD) of a customer or supplier invoice, used exactly as sent. Omit it and the due date is calculated from the customer's or supplier's payment term (else the company default), counted from documentDate when sent and from date otherwise. Accepted only on customer_invoice, supplier_invoice and the deprecated invoice, and only with a reference, which is what registers the invoice the due date belongs to. Sent on any other entry type, it is refused with 400 JOURNAL_ENTRY_DUE_DATE_NOT_ALLOWED; sent without a reference, with 400 JOURNAL_ENTRY_DUE_DATE_REQUIRES_REFERENCE. null is read as omitted.
customerIdCustomer reference. Required for CUSTOMER_* types.
supplierIdSupplier reference. Required for SUPPLIER_* types.
descriptionOptional human-readable description.
referenceInvoice number / external reference. On CUSTOMER_PAYMENT it names the invoice being paid, and the appended receivable leg follows where that invoice was booked: on the one account it sits on, which is the customer group account unless the invoice lines sent the receivable elsewhere (a deposit invoice). An invoice owed across several receivable accounts is cleared one leg per account when the payment pays everything it still has open; a part payment of such an invoice is refused with JOURNAL_ENTRY_RECEIVABLE_SPLIT_REQUIRED, because nothing here states which account it clears and it is never divided in proportion.
externalSystemIdYour own system's id for this draft. Carried onto the booked journal entry. Not unique — several drafts/entries may share one id. Filter the list endpoint by externalSystemId.
tagIdsTag IDs applied at the entry level.
journalCategoryIdJournal category ID (UUID). Must belong to the API key's app company; cross-tenant or unknown IDs are rejected with 400 JOURNAL_CATEGORY_NOT_FOUND. When omitted the entry uses the company's default category.
Inline file attachments (base64-encoded). Same shape and limits as v1: maximum 10 attachments per entry, a 10MB ceiling on each file measured AFTER base64 decoding (over it is rejected with DOCUMENT_UPLOAD_FILE_TOO_LARGE), and a 15MB ceiling on the total request body (JSON + base64 payload). Either can be the binding one: base64 inflates a payload by about a third, so two 6MB files each clear the per-file bound and exceed the request one. Each attachment becomes a Document linked to the created journal entry — equivalent to what GET /api/v1/journal-entries/:id/attachments returns. An invalid MIME type rejects at DTO validation with 400 SHARED_VALIDATION_FAILED; malformed base64 reaches the service and rejects with 400 JOURNAL_ENTRY_INVALID_ATTACHMENT_TYPE. Either rejects the whole entry, and in a batch the whole batch rolls back.
originalCurrency^[A-Za-z]{3}$ISO 4217 alpha-3 code of the currency the draft is entered in; originalAmount and lines[].amount are in this currency. Omitted under both names, the draft is in your company base currency.
originalCurrencyToBaseCurrencyExchangeRateWhat one unit of originalCurrency is worth in your company base currency, e.g. 7.4612 for EUR to DKK. Must be greater than zero; a non-positive rate is rejected whatever the draft currency. Omit it and exchangeRate to have the rate resolved from the rate feed at the posting date. Not applied when the draft is already in your company base currency, where the conversion is the identity.
vendorIdDeprecated — use supplierId. Legacy alias; sending both with different values returns 400.
currency^[A-Za-z]{3}$Deprecated — use originalCurrency. The same currency code under its old name. Sending both with different codes returns 400 DRAFT_DEPRECATED_FIELD_CONFLICT.
exchangeRateDeprecated — use originalCurrencyToBaseCurrencyExchangeRate. The same rate under its old name. Sending both with different values returns 400 DRAFT_DEPRECATED_FIELD_CONFLICT.
Create a draft journal entry (v2) › Responses
Draft created
idDraft journal entry ID
dateDate in YYYY-MM-DD format
baseCurrencyAmountHow large this draft is, in your company base currency — the one your company reports in. A draft entered as EUR 1,000 by a company reporting in DKK is 7450 here.
Do not display this number beside originalCurrency. That field names the currency the draft was entered in (EUR in the example), while this number is in DKK. originalAmount is the figure that belongs beside originalCurrency.
Reads 0 on a draft that holds no figure in this currency. The minBaseCurrencyAmount and maxBaseCurrencyAmount list filters run on this field, so a draft reading 0 here is excluded whenever either filter is applied.
originalAmountHow large this draft is, in the currency it was entered in — the currency originalCurrency names, and the one lines[].amount uses. A draft entered as EUR 1,000 is 1000 here, whatever your company reports in.
This is the figure to display beside originalCurrency. baseCurrencyAmount is the same draft in your company base currency: on that EUR draft this field reads 1000 and baseCurrencyAmount reads 7450. Reads 0 on a draft that carries no amount yet.
originalCurrencyThe currency this draft was entered in — EUR for a supplier invoice received in EUR. originalAmount and lines[].amount are in this currency; baseCurrencyAmount is in your company base currency, which is this one only when the draft was entered in it.
journalTypeJournal type
journalCategoryIdID of the journal category the draft is in. Set it with journalCategoryId on the v2 draft create and on PATCH /v2/draft-journal-entries/{id}. Booking the draft keeps it on the journal entry. List the categories with GET /v1/journal-categories. Null when the draft has no category.
Every line of the draft. Always present, an empty array included, so a client never has to distinguish absent from empty. The name matches the lines the v2 draft endpoints take, so a draft reads back through the field it was written with.
statusAlways "DRAFT" for draft journal entries
createdAtCreation timestamp
updatedAtLast update timestamp
documentDateDocument date (date on the invoice/voucher). Null when not set.
dueDateDue date stated on the draft (YYYY-MM-DD). Null when none was stated; booking a customer or supplier invoice then calculates one from the payment term.
originalCurrencyToBaseCurrencyExchangeRateWhat one unit of originalCurrency is worth in your company base currency. 7.45 on a EUR draft of a company reporting in DKK means 1 EUR buys 7.45 DKK.
This is the rate the draft is converted at, not a factor between the two amounts on this response. baseCurrencyAmount is built from the draft lines rather than from originalAmount, so multiplying originalAmount by this rate does not reliably reproduce it — on a draft whose sides disagree the two figures differ with no rate involved at all. A draft already entered in your own currency carries 1. Null only while a foreign-currency draft has no rate yet — booking gives it one.
originalCurrencyToBaseCurrencyExchangeRateDateDate the originalCurrencyToBaseCurrencyExchangeRate was captured for. Null whenever that rate is.
descriptionDescription
referenceReference number
externalSystemIdYour own system's id for this draft, when set. Not unique. null when unset or cleared.
typeTransaction type (debit or credit)
accountIdPrimary account ID
contraAccountIdContra account ID
customerIdCustomer ID
supplierIdSupplier ID
vatCodeIdVAT/Tax code ID
tagIdsTag/Dimension IDs
documentRefsDocument IDs attached to the draft
amountDeprecated — use baseCurrencyAmount, which carries the same value. The draft in your company base currency. Do not display it beside currency: that names the currency the draft was entered in. The v1 create takes a request field of the same name carrying the figure the draft is entered in, so a EUR draft sent as amount: 1000 is returned with amount: 7450 — one name, two currencies.
currencyDeprecated — use originalCurrency, which carries the same value. The currency the draft was entered in.
exchangeRateDeprecated — use originalCurrencyToBaseCurrencyExchangeRate, which carries the same value.
exchangeRateDateDeprecated — use originalCurrencyToBaseCurrencyExchangeRateDate, which carries the same value.
vendorIdDeprecated — use supplierId. Legacy alias, emitted with the same value.
Deprecated — use lines. Present only on drafts that need it: a plain one-debit-one-credit draft with no per-line memo or dimensions reports its accounts through accountId / contraAccountId and omits this field entirely. It also reports a placeholder line's account as "", which the write side rejects. lines is populated either way and round-trips.
Get a draft journal entry (v2)
Credential: a company's API key or OAuth token.
Returns the draft if it belongs to the API key's app company; 404 otherwise. Identical response shape to GET /api/v1/draft-journal-entries/:id. Each amount, currency and rate field is named for the currency it is in: originalAmount and originalCurrency are the draft as entered, baseCurrencyAmount is the draft in your company base currency, and originalCurrencyToBaseCurrencyExchangeRate / originalCurrencyToBaseCurrencyExchangeRateDate are the rate from originalCurrency into your company base currency and its date. The deprecated amount, currency, exchangeRate and exchangeRateDate carry the same values as baseCurrencyAmount, originalCurrency and the two rate fields.
Required Scope
journal-entries-read
path Parameters
idDraft journal entry ID (UUID)
Get a draft journal entry (v2) › Responses
Draft retrieved
idDraft journal entry ID
dateDate in YYYY-MM-DD format
baseCurrencyAmountHow large this draft is, in your company base currency — the one your company reports in. A draft entered as EUR 1,000 by a company reporting in DKK is 7450 here.
Do not display this number beside originalCurrency. That field names the currency the draft was entered in (EUR in the example), while this number is in DKK. originalAmount is the figure that belongs beside originalCurrency.
Reads 0 on a draft that holds no figure in this currency. The minBaseCurrencyAmount and maxBaseCurrencyAmount list filters run on this field, so a draft reading 0 here is excluded whenever either filter is applied.
originalAmountHow large this draft is, in the currency it was entered in — the currency originalCurrency names, and the one lines[].amount uses. A draft entered as EUR 1,000 is 1000 here, whatever your company reports in.
This is the figure to display beside originalCurrency. baseCurrencyAmount is the same draft in your company base currency: on that EUR draft this field reads 1000 and baseCurrencyAmount reads 7450. Reads 0 on a draft that carries no amount yet.
originalCurrencyThe currency this draft was entered in — EUR for a supplier invoice received in EUR. originalAmount and lines[].amount are in this currency; baseCurrencyAmount is in your company base currency, which is this one only when the draft was entered in it.
journalTypeJournal type
journalCategoryIdID of the journal category the draft is in. Set it with journalCategoryId on the v2 draft create and on PATCH /v2/draft-journal-entries/{id}. Booking the draft keeps it on the journal entry. List the categories with GET /v1/journal-categories. Null when the draft has no category.
Every line of the draft. Always present, an empty array included, so a client never has to distinguish absent from empty. The name matches the lines the v2 draft endpoints take, so a draft reads back through the field it was written with.
statusAlways "DRAFT" for draft journal entries
createdAtCreation timestamp
updatedAtLast update timestamp
documentDateDocument date (date on the invoice/voucher). Null when not set.
dueDateDue date stated on the draft (YYYY-MM-DD). Null when none was stated; booking a customer or supplier invoice then calculates one from the payment term.
originalCurrencyToBaseCurrencyExchangeRateWhat one unit of originalCurrency is worth in your company base currency. 7.45 on a EUR draft of a company reporting in DKK means 1 EUR buys 7.45 DKK.
This is the rate the draft is converted at, not a factor between the two amounts on this response. baseCurrencyAmount is built from the draft lines rather than from originalAmount, so multiplying originalAmount by this rate does not reliably reproduce it — on a draft whose sides disagree the two figures differ with no rate involved at all. A draft already entered in your own currency carries 1. Null only while a foreign-currency draft has no rate yet — booking gives it one.
originalCurrencyToBaseCurrencyExchangeRateDateDate the originalCurrencyToBaseCurrencyExchangeRate was captured for. Null whenever that rate is.
descriptionDescription
referenceReference number
externalSystemIdYour own system's id for this draft, when set. Not unique. null when unset or cleared.
typeTransaction type (debit or credit)
accountIdPrimary account ID
contraAccountIdContra account ID
customerIdCustomer ID
supplierIdSupplier ID
vatCodeIdVAT/Tax code ID
tagIdsTag/Dimension IDs
documentRefsDocument IDs attached to the draft
amountDeprecated — use baseCurrencyAmount, which carries the same value. The draft in your company base currency. Do not display it beside currency: that names the currency the draft was entered in. The v1 create takes a request field of the same name carrying the figure the draft is entered in, so a EUR draft sent as amount: 1000 is returned with amount: 7450 — one name, two currencies.
currencyDeprecated — use originalCurrency, which carries the same value. The currency the draft was entered in.
exchangeRateDeprecated — use originalCurrencyToBaseCurrencyExchangeRate, which carries the same value.
exchangeRateDateDeprecated — use originalCurrencyToBaseCurrencyExchangeRateDate, which carries the same value.
vendorIdDeprecated — use supplierId. Legacy alias, emitted with the same value.
Deprecated — use lines. Present only on drafts that need it: a plain one-debit-one-credit draft with no per-line memo or dimensions reports its accounts through accountId / contraAccountId and omits this field entirely. It also reports a placeholder line's account as "", which the write side rejects. lines is populated either way and round-trips.
Delete a draft journal entry (v2)
Credential: a company's API key or OAuth token.
Deletes a draft journal entry. Returns 404 if the draft id does not belong to the API key's app company.
The draft's documents are deleted with it: they go to the bin in LedgerBee, where they can be restored for 30
days. Send ?detachDocuments=true to return them to the inbox instead. A document another draft or a journal
entry still uses is never deleted; it stays where it is.
When a bank payment still references the draft, the delete is refused with 409 DRAFT_LINKED_TO_BANK_PAYMENT
(the linked payment ids are in the error details); re-send with ?detachBankPayments=true to confirm —
the payments survive, only their draft link is cleared.
Required Scope
journal-entries-write
path Parameters
idDraft journal entry ID (UUID)
query Parameters
detachBankPaymentsConfirm detaching any bank payments still linked to this draft.
detachDocumentsReturn the draft's documents to the inbox instead of deleting them.
Headers
x-api-idempotency-keyOptional idempotency key for safely retrying mutating requests.
Delete a draft journal entry (v2) › Responses
Draft deleted successfully
Update a draft journal entry (v2)
Credential: a company's API key or OAuth token.
Partial update: every create-time field is accepted except entryType (the journal type pins
constraints decided at creation and is immutable) and attachments (own lifecycle). Omitted fields
keep their current values; lines, when provided, replaces the full line set.
externalSystemId is carried onto the booked journal entry when the draft is booked, and is not
unique: several drafts or entries may share one id. Filter
GET /draft-journal-entries?externalSystemId=... to list carriers.
Reviewed (locked) drafts reject updates with 400 DRAFT_REVIEWED_LOCKED — unmark the review first. Concurrent updates are last-write-wins.
Required Scope
journal-entries-write
path Parameters
idDraft journal entry ID (UUID)
Headers
x-api-idempotency-keyOptional idempotency key for safely retrying mutating requests.
Update a draft journal entry (v2) › Request Body
datePosting date (YYYY-MM-DD).
documentDateDocument date (YYYY-MM-DD). null clears it, so the VAT period follows date again; omitting the field keeps it.
dueDateDue date (YYYY-MM-DD) of a customer or supplier invoice draft. null clears it, so booking calculates one from the payment term again; omitting the field keeps it. The same rules as on create apply: refused on other entry types (JOURNAL_ENTRY_DUE_DATE_NOT_ALLOWED) and on a draft without a reference (JOURNAL_ENTRY_DUE_DATE_REQUIRES_REFERENCE).
originalAmountFace value of the document — what the counterparty is invoiced or pays. NOT the sum of lines. On CUSTOMER_INVOICE / CUSTOMER_PAYMENT / SUPPLIER_INVOICE / SUPPLIER_PAYMENT this value IS the appended AR/AP leg (its absolute value), so an account that appears on both sides of the entry — a clearing or pass-through account — must not be counted into it. Sign carries direction: positive = invoice / payment, negative = credit-note / refund.
customerIdCustomer reference. null clears it; omitting keeps it. Changing it reshapes the entry — requires lines and re-runs the per-entryType validation (CUSTOMER_* types cannot clear their counterparty).
supplierIdSupplier reference. null clears it; omitting keeps it. Changing it reshapes the entry — requires lines and re-runs the per-entryType validation (SUPPLIER_* types cannot clear their counterparty).
descriptionOptional human-readable description.
referenceInvoice number / external reference. On CUSTOMER_PAYMENT it names the invoice being paid, and the appended receivable leg follows where that invoice was booked: on the one account it sits on, which is the customer group account unless the invoice lines sent the receivable elsewhere (a deposit invoice). An invoice owed across several receivable accounts is cleared one leg per account when the payment pays everything it still has open; a part payment of such an invoice is refused with JOURNAL_ENTRY_RECEIVABLE_SPLIT_REQUIRED, because nothing here states which account it clears and it is never divided in proportion.
externalSystemIdYour own system's id. null clears the value; omitting the field keeps it.
Counter-side lines (revenue / expense / bank / outlay). For locked types do NOT include the AR/AP leg. The cap is per ENTRY, not per request or per journal category — nothing accumulates across entries, so a company with many unposted drafts is never refused for that reason.
tagIdsTag IDs applied at the entry level.
journalCategoryIdJournal category ID (UUID). Must belong to the API key's app company; cross-tenant or unknown IDs are rejected with 400 JOURNAL_CATEGORY_NOT_FOUND. When omitted the entry uses the company's default category.
originalCurrency^[A-Za-z]{3}$ISO 4217 alpha-3 code of the currency the draft is entered in. Omitting it under both names keeps the stored one.
originalCurrencyToBaseCurrencyExchangeRateWhat one unit of originalCurrency is worth in your company base currency, e.g. 7.4612 for EUR to DKK. Must be greater than zero; a non-positive rate is rejected whatever the draft currency. Omit it and exchangeRate to have the rate resolved from the rate feed at the posting date. Not applied when the draft is already in your company base currency, where the conversion is the identity.
vendorIdDeprecated — use supplierId. Legacy alias for the supplier reference (null clears it); sending both supplierId and vendorId with different values returns 400.
currency^[A-Za-z]{3}$Deprecated — use originalCurrency. The same currency code under its old name. Sending both with different codes returns 400 DRAFT_DEPRECATED_FIELD_CONFLICT.
exchangeRateDeprecated — use originalCurrencyToBaseCurrencyExchangeRate. The same rate under its old name. Sending both with different values returns 400 DRAFT_DEPRECATED_FIELD_CONFLICT.
Update a draft journal entry (v2) › Responses
Draft updated
idDraft journal entry ID
dateDate in YYYY-MM-DD format
baseCurrencyAmountHow large this draft is, in your company base currency — the one your company reports in. A draft entered as EUR 1,000 by a company reporting in DKK is 7450 here.
Do not display this number beside originalCurrency. That field names the currency the draft was entered in (EUR in the example), while this number is in DKK. originalAmount is the figure that belongs beside originalCurrency.
Reads 0 on a draft that holds no figure in this currency. The minBaseCurrencyAmount and maxBaseCurrencyAmount list filters run on this field, so a draft reading 0 here is excluded whenever either filter is applied.
originalAmountHow large this draft is, in the currency it was entered in — the currency originalCurrency names, and the one lines[].amount uses. A draft entered as EUR 1,000 is 1000 here, whatever your company reports in.
This is the figure to display beside originalCurrency. baseCurrencyAmount is the same draft in your company base currency: on that EUR draft this field reads 1000 and baseCurrencyAmount reads 7450. Reads 0 on a draft that carries no amount yet.
originalCurrencyThe currency this draft was entered in — EUR for a supplier invoice received in EUR. originalAmount and lines[].amount are in this currency; baseCurrencyAmount is in your company base currency, which is this one only when the draft was entered in it.
journalTypeJournal type
journalCategoryIdID of the journal category the draft is in. Set it with journalCategoryId on the v2 draft create and on PATCH /v2/draft-journal-entries/{id}. Booking the draft keeps it on the journal entry. List the categories with GET /v1/journal-categories. Null when the draft has no category.
Every line of the draft. Always present, an empty array included, so a client never has to distinguish absent from empty. The name matches the lines the v2 draft endpoints take, so a draft reads back through the field it was written with.
statusAlways "DRAFT" for draft journal entries
createdAtCreation timestamp
updatedAtLast update timestamp
documentDateDocument date (date on the invoice/voucher). Null when not set.
dueDateDue date stated on the draft (YYYY-MM-DD). Null when none was stated; booking a customer or supplier invoice then calculates one from the payment term.
originalCurrencyToBaseCurrencyExchangeRateWhat one unit of originalCurrency is worth in your company base currency. 7.45 on a EUR draft of a company reporting in DKK means 1 EUR buys 7.45 DKK.
This is the rate the draft is converted at, not a factor between the two amounts on this response. baseCurrencyAmount is built from the draft lines rather than from originalAmount, so multiplying originalAmount by this rate does not reliably reproduce it — on a draft whose sides disagree the two figures differ with no rate involved at all. A draft already entered in your own currency carries 1. Null only while a foreign-currency draft has no rate yet — booking gives it one.
originalCurrencyToBaseCurrencyExchangeRateDateDate the originalCurrencyToBaseCurrencyExchangeRate was captured for. Null whenever that rate is.
descriptionDescription
referenceReference number
externalSystemIdYour own system's id for this draft, when set. Not unique. null when unset or cleared.
typeTransaction type (debit or credit)
accountIdPrimary account ID
contraAccountIdContra account ID
customerIdCustomer ID
supplierIdSupplier ID
vatCodeIdVAT/Tax code ID
tagIdsTag/Dimension IDs
documentRefsDocument IDs attached to the draft
amountDeprecated — use baseCurrencyAmount, which carries the same value. The draft in your company base currency. Do not display it beside currency: that names the currency the draft was entered in. The v1 create takes a request field of the same name carrying the figure the draft is entered in, so a EUR draft sent as amount: 1000 is returned with amount: 7450 — one name, two currencies.
currencyDeprecated — use originalCurrency, which carries the same value. The currency the draft was entered in.
exchangeRateDeprecated — use originalCurrencyToBaseCurrencyExchangeRate, which carries the same value.
exchangeRateDateDeprecated — use originalCurrencyToBaseCurrencyExchangeRateDate, which carries the same value.
vendorIdDeprecated — use supplierId. Legacy alias, emitted with the same value.
Deprecated — use lines. Present only on drafts that need it: a plain one-debit-one-credit draft with no per-line memo or dimensions reports its accounts through accountId / contraAccountId and omits this field entirely. It also reports a placeholder line's account as "", which the write side rejects. lines is populated either way and round-trips.
Get attachments for a draft journal entry (v2)
Credential: a company's API key or OAuth token.
Retrieves the documents attached to a draft journal entry, with their content base64-encoded. Each is also
listed by id in the draft's documentRefs; a document whose file cannot be read is left out of this list.
Required Scope
journal-entries-read
path Parameters
idDraft journal entry ID (UUID)
Get attachments for a draft journal entry (v2) › Responses
Attachments retrieved
draftJournalEntryIdDraft journal entry ID the attachments belong to
List of attachments
Add a document to a draft journal entry (v2)
Credential: a company's API key or OAuth token.
Uploads a file and attaches it to an existing draft. When the draft is booked, its documents move onto the journal entry.
Send the file as the multipart form field file: PDF, JPEG or PNG, up to 10 MB. When the part is sent as
application/octet-stream, the type is taken from the file name's extension. The content must match the
type, or the upload is rejected with 400 DOCUMENT_UPLOAD_INVALID_FILE_TYPE. A file over 10 MB is rejected
with 413.
Reviewed (locked) drafts reject the upload with 400 DRAFT_REVIEWED_LOCKED; the review has to be undone in
LedgerBee first. A draft frozen by a pending or granted approval rejects it with 400
DRAFT_EDIT_BLOCKED_BY_APPROVAL.
The response carries the new document id; pass it to
DELETE /api/v2/draft-journal-entries/{id}/attachments/{documentId} to take the document off again.
Required Scope
journal-entries-write
path Parameters
idDraft journal entry ID (UUID)
Headers
x-api-idempotency-keyOptional idempotency key for safely retrying mutating requests.
Add a document to a draft journal entry (v2) › Request Body
fileThe document: PDF, JPEG or PNG, up to 10 MB.
Add a document to a draft journal entry (v2) › Responses
Document attached
idID of the new attachment/document. Pass it to the remove endpoint to take the document off again.
draftJournalEntryIdDraft journal entry ID the attachment was added to
Remove a document from a draft journal entry (v2)
Credential: a company's API key or OAuth token.
Takes a document off a draft, leaving its other documents in place, and deletes it: it goes to the bin in
LedgerBee, where it can be restored for 30 days. Send ?detach=true to return it to the inbox instead. A
document another draft or a journal entry still uses is never deleted; it stays where it is.
Reviewed (locked) drafts reject the removal with 400 DRAFT_REVIEWED_LOCKED, and a draft frozen by an
approval with 400 DRAFT_EDIT_BLOCKED_BY_APPROVAL. Returns 404 DRAFT_DOCUMENT_NOT_ATTACHED when the
document is not attached to the draft.
Required Scope
journal-entries-write
path Parameters
idDraft journal entry ID (UUID)
documentIdDocument ID (UUID), as listed in the draft's documentRefs
query Parameters
detachReturn the document to the inbox instead of deleting it.
Headers
x-api-idempotency-keyOptional idempotency key for safely retrying mutating requests.
Remove a document from a draft journal entry (v2) › Responses
Document removed from the draft
Book a draft journal entry (v2)
Credential: a company's API key or OAuth token.
Converts a draft journal entry into a posted journal entry. Validates the posting period and balance, then permanently deletes the draft. V2 drafts already carry the auto-appended AR/AP leg, so booking is a clean handoff to the posted-JE pipeline — no duplicate anchor leg is created. Returns 404 if the draft id does not belong to the API key's app company.
Required Scope
journal-entries-write
path Parameters
idDraft journal entry ID (UUID)
Headers
x-api-idempotency-keyOptional idempotency key for safely retrying mutating requests.
Book a draft journal entry (v2) › Responses
Draft booked successfully — returns the created journal entry
idUnique identifier of the created journal entry
entryNumberEntry number assigned to the journal entry
dateDate of the journal entry
amountAmount of the line accountId names, in that line's account currency (currency). On a two-line entry this is the entry total. On a wider entry it is one line of several — sum lines[].functionalAmount on either side for the total.
currencyCurrency amount is denominated in — the operating currency of that first line's account.
journalTypeJournal type
journalCategoryIdID of the journal category the entry is in. A draft booked with a category keeps it. List the categories with GET /v1/journal-categories. Null when the entry has no category.
typeTransaction type
statusStatus of the journal entry
reversedByEntryIdThe id of the entry that reverses this one, or null when no reversal made in LedgerBee points at it. A reversed entry keeps its status, so this field is what says it no longer counts: it and its reversal cancel each other out. A reversal imported from e-conomic cancels its entry through opposite amounts and is not linked, so the entry it cancels reads null here.
reversalOfEntryIdOn a reversal, the id of the entry it reverses; null on every other entry. The entry named here names this one in its reversedByEntryId.
accountIdOne non-VAT line of the entry, paired with contraAccountId as a two-line summary. On a two-line entry the pair describes the whole entry. On a wider one it describes two of its lines and nothing about the rest — read lines for the full picture. Which two are picked is not part of this contract and differs by endpoint (a read takes them in posting order; the draft-booking response takes a debit and a credit), so do not infer a line's position from it.
createdAtTimestamp when the entry was created
documentDateDocument date (date on the invoice/voucher). Null when the entry was booked without one; its VAT period then follows date.
dueDateDue date of the customer or supplier invoice this entry books (YYYY-MM-DD). Null on every other entry type, on a credit note booked without one, and on an invoice posted through this API without a reference (no invoice is registered for it).
originalAmountWhat you posted, in the currency you posted it in — the document figure, before any conversion. Distinct from amount, which is denominated in the ACCOUNT currency (currency): a EUR entry against DKK accounts reports originalAmount: 200 / originalCurrency: "EUR" and amount: 1492.24 / currency: "DKK". Null on historical entries that stored no document amount.
originalCurrencyThe currency the entry was posted in: what originalAmount is denominated in, and what originalCurrencyToBaseCurrencyExchangeRate converts FROM. Present independently of originalAmount — an entry can name a currency and store no document amount, which is the historical shape, and the currency still says what its rate converts from. Null only on an entry that names no currency at all.
originalCurrencyToBaseCurrencyExchangeRateRate converting originalCurrency to the company base currency — 7.45 on a EUR entry of a DKK-based company means 1 EUR = 7.45 DKK, so originalAmount * originalCurrencyToBaseCurrencyExchangeRate is the base-currency total that lines[].functionalAmount sums to. Reported whether you supplied it on create or the platform resolved it, which is what lets you compute the difference against the rate your own settlement later used. 1 on an entry posted in the base currency, since that is the conversion that was applied and stored. Null only on historical entries that stored no rate at all.
originalCurrencyToBaseCurrencyExchangeRateDateDate the originalCurrencyToBaseCurrencyExchangeRate was captured for. Set on every posted entry, including one that stored no rate; an entry posted in your company base currency carries its own date.
descriptionDescription of the journal entry
referenceReference number
externalSystemIdYour own system's id for this entry, when set. Not unique — several entries may share one id.
contraAccountIdThe other half of the accountId pair, when the entry has a second non-VAT line. Same caveat: it is one line, not a summary of every line other than accountId.
Every line of the entry, including VAT lines the platform derived. This is the complete picture: accountId, contraAccountId, amount, currency and vatCodeId above all describe one line, or two, and nothing about the rest. Debits and credits balance across the array on functionalAmount. The order is stable for a given entry — normally the order the lines were posted in — but match lines by account rather than by position, and use vatSourceLineIndex to link a VAT line to its source.
customerIdCustomer ID if applicable
supplierIdSupplier ID if applicable
vatCodeIdVAT/Tax code on the line accountId names, if it has one. Lines can carry different codes — read lines[].vatCodeId for the per-line codes.
tagIdsTag IDs attached to the entry as a whole. Per-line dimensions are on lines[].tagIds.
documentRefsDocument IDs attached to the entry
Notes on the posted entry, as codes. Present only when there is one. JOURNAL_ENTRY_YEAR_END_ACCOUNT_POSTED: the entry has a line on the company year-end account and every other line is on a balance-sheet account; details.accountId names the account. An entry with a line there and an income or expense line is refused with 400 JOURNAL_ENTRY_YEAR_END_ACCOUNT_RESULT_LINE.
exchangeRateDeprecated — use originalCurrencyToBaseCurrencyExchangeRate, which carries the same value.
exchangeRateDateDeprecated — use originalCurrencyToBaseCurrencyExchangeRateDate, which carries the same value.
vendorIdDeprecated — use supplierId. Legacy alias, emitted with the same value.