Schemas
CompanyFiscalYear
startDateFirst day of the fiscal year, inclusive (YYYY-MM-DD)
endDateLast day of the fiscal year, inclusive (YYYY-MM-DD)
statusWhether the year is still open for posting
CompanyAccounting
baseCurrencyThe company's base (functional) currency, ISO 4217. Every figure a report labels a base-currency total is denominated in this.
currentFiscalYearThe fiscal year containing today. Null when no accounting year covers today — a company mid-setup, or one whose years stop short of the current date.
CompanyResponse
idUnique identifier for the company, uuidv7 based
nameCompany name
emailPrimary email address
addressStreet address
The company's accounting configuration: base currency and the fiscal year covering today.
vatVAT / company registration number, as registered
billingEmailBilling email address
cityCity
postalCodePostal code
countryCodeCountry code (ISO 3166-1 alpha-2)
phonePhone number
preferredLanguagePreferred language code
contactPersonFirstNameContact person first name
contactPersonLastNameContact person last name
RateLimitTierResponse
nameName of the rate limit tier
ttlTime-to-live in milliseconds for this rate limit tier (0 means no time limit)
limitMaximum number of requests allowed within the TTL window (-1 means unlimited)
ApiKeyInfoResponse
Available rate limit tiers for this API key
expiresAtExpiration date and time of the API key
ipWhitelistList of IP addresses allowed to use this API key
scopesList of scopes granted to this API key
AccountResponse
idThe unique identifier of the account
nameName of the account
accountNumberAccount type number
publicAccountIdPublic account id that the account maps to
ledgerTypeType of ledger account. Only BALANCE_SHEET and PROFIT_AND_LOSS accounts can be used in journal entries.
debitCreditThe side a journal-entry line on this account pre-selects: debit or credit. This is the Debit/Credit choice on the account form. It does not decide how a balance is reported; accountClassification does.
requiredDimensionIdsIDs of the dimensions this account requires: every journal entry line posting to the account must carry a value from each of them, or the entry is refused with JOURNAL_TAG_REQUIRED_DIMENSION_MISSING. Empty when the account requires none. This is the account setting as stored: a dimension that has since been deactivated stays listed and is not enforced until it is active again, so match the ids against the dimensions list, which returns active dimensions only.
accountClassificationAccount classification (ASSET, LIABILITY, EQUITY, REVENUE, EXPENSE)
controlAccountTypeControl account type. ACCOUNTS_RECEIVABLE requires customerId on journal entries, ACCOUNTS_PAYABLE requires vendorId. Null for regular accounts.
vatCodeIdVAT code applied by default to journal-entry lines on this account, or null
AccountInterval
fromFirst account number of the range (inclusive)
toLast account number of the range (inclusive)
AccountDetailResponse
idThe unique identifier of the account
nameName of the account
accountNumberAccount type number
publicAccountIdPublic account id that the account maps to
ledgerTypeType of ledger account. Only BALANCE_SHEET and PROFIT_AND_LOSS accounts can be used in journal entries.
debitCreditThe side a journal-entry line on this account pre-selects: debit or credit. This is the Debit/Credit choice on the account form. It does not decide how a balance is reported; accountClassification does.
requiredDimensionIdsIDs of the dimensions this account requires: every journal entry line posting to the account must carry a value from each of them, or the entry is refused with JOURNAL_TAG_REQUIRED_DIMENSION_MISSING. Empty when the account requires none. This is the account setting as stored: a dimension that has since been deactivated stays listed and is not enforced until it is active again, so match the ids against the dimensions list, which returns active dimensions only.
currencyThe currency the account is kept in (ISO 4217). A balance-sheet account may be kept in a foreign currency; every other account is kept in the company's base currency.
tagsFree-form tags for grouping accounts
createdAtWhen the account was created
updatedAtWhen the account was last changed
accountClassificationAccount classification (ASSET, LIABILITY, EQUITY, REVENUE, EXPENSE)
controlAccountTypeControl account type. ACCOUNTS_RECEIVABLE requires customerId on journal entries, ACCOUNTS_PAYABLE requires vendorId. Null for regular accounts.
vatCodeIdVAT code applied by default to journal-entry lines on this account, or null
mapsToThe account number this account reports under. When set, publicAccountId follows it.
totalFromFor a TOTAL_FROM account: the first account number it sums from, up to the account's own number
For a TOTAL_INTERVALS account: the account-number ranges it sums
deactivatedAtWhen the account was deactivated, or null while it is active
CreateAccountRequest
nameName of the account
accountNumberAccount number, unique within the company
ledgerTypeKind of account. Only BALANCE_SHEET and PROFIT_AND_LOSS accounts take postings; HEADING, HEADING_BREAK, TOTAL_FROM and TOTAL_INTERVALS structure the chart.
accountClassificationClassification of a postable account; required whenever the request sets ledgerType to BALANCE_SHEET or PROFIT_AND_LOSS. Decides which statement the account belongs to and which side a journal-entry line on it pre-selects. It cannot be cleared.
controlAccountTypeMarks a control account. Lines on an ACCOUNTS_RECEIVABLE account need a customerId, lines on an ACCOUNTS_PAYABLE account a supplierId. The classification must fit: receivable is an ASSET, payable a LIABILITY. Null clears it.
debitCreditThe side a journal-entry line on this account pre-selects: debit or credit. Omitted on create, it follows accountClassification (ASSET and EXPENSE pre-select debit, the rest credit); an account with no classification, which only a heading or total account can be, pre-selects debit. It cannot be cleared.
vatCodeIdVAT code applied by default to journal-entry lines on this account. Null clears it.
currencyCurrency the account is kept in, as an ISO 4217 code. Applies to a BALANCE_SHEET account only; every other account is kept in the company's base currency and the field is ignored. Moving an account off BALANCE_SHEET resets it to the base currency.
tagsFree-form tags for grouping accounts (at most 25, each at most 50 characters)
mapsToThe account number this account reports under. When set, publicAccountId reports it instead of accountNumber. Null clears it.
totalFromFor a TOTAL_FROM account: the first account number to sum from; the total runs up to the account's own number. Required whenever the request sets ledgerType to TOTAL_FROM.
For a TOTAL_INTERVALS account: the account-number ranges to sum (at most 50). Required whenever the request sets ledgerType to TOTAL_INTERVALS.
UpdateAccountRequest
accountClassificationClassification of a postable account; required whenever the request sets ledgerType to BALANCE_SHEET or PROFIT_AND_LOSS. Decides which statement the account belongs to and which side a journal-entry line on it pre-selects. It cannot be cleared.
controlAccountTypeMarks a control account. Lines on an ACCOUNTS_RECEIVABLE account need a customerId, lines on an ACCOUNTS_PAYABLE account a supplierId. The classification must fit: receivable is an ASSET, payable a LIABILITY. Null clears it.
debitCreditThe side a journal-entry line on this account pre-selects: debit or credit. Omitted on create, it follows accountClassification (ASSET and EXPENSE pre-select debit, the rest credit); an account with no classification, which only a heading or total account can be, pre-selects debit. It cannot be cleared.
vatCodeIdVAT code applied by default to journal-entry lines on this account. Null clears it.
currencyCurrency the account is kept in, as an ISO 4217 code. Applies to a BALANCE_SHEET account only; every other account is kept in the company's base currency and the field is ignored. Moving an account off BALANCE_SHEET resets it to the base currency.
tagsFree-form tags for grouping accounts (at most 25, each at most 50 characters)
mapsToThe account number this account reports under. When set, publicAccountId reports it instead of accountNumber. Null clears it.
totalFromFor a TOTAL_FROM account: the first account number to sum from; the total runs up to the account's own number. Required whenever the request sets ledgerType to TOTAL_FROM.
For a TOTAL_INTERVALS account: the account-number ranges to sum (at most 50). Required whenever the request sets ledgerType to TOTAL_INTERVALS.
nameName of the account
accountNumberAccount number, unique within the company
ledgerTypeKind of account. Setting a postable type requires accountClassification in the same request; setting TOTAL_FROM requires totalFrom, and TOTAL_INTERVALS requires intervals.
PublicAuthorityExtractIngestRequest
The extract items — one object per extract (momsindberetning, erhvervsselvangivelse, udbytteindberetning, e-indkomst, skattekonto, lønsum, …). Each item is stored as received.
senderThe delivering system, e.g. 'revibot'.
batchIdThe sender's own id for this batch. Folded into the idempotency claim, so an x-api-idempotency-key reused across two DIFFERENT batches is refused (422) instead of silently replaying the first batch's response.
PublicAdvisorAuthorityExtractIngestResponse
totalCreatedNumber of extract items stored.
unmatchedCvrsDistinct CVRs in this batch that are not clients of the firm, as digits only. Their items are stored all the same; a CVR listed here usually means the firm's client list is missing that client.
itemsWithoutCvrItems whose cvr was missing or not a registration number. They are stored without a subject.
PublicAdvisorClient
idThe id of the firm's own record of the client when it keeps one, else the client's company id. Key a sync on companyNumber and productionUnitNumber together: a client the firm first knows through its company id takes the record's id once the firm records it.
companyNumberThe CVR (Danish company registration number), digits only. Name the client by it when delivering data about it.
productionUnitNumberThe P-number of the office the client is, 10 digits, when the client is one office of a company; null for the whole company. Offices of one company share a companyNumber and differ here.
nameexternalClientNumberThe firm's own client number, when it keeps one.
onLedgerBeeTrue while the client keeps its books in LedgerBee; false again once it stops.
updatedAtWhen the client was added to the firm, or the firm's record of it or the client's own company last changed, whichever is later.
PublicListAdvisorClientsResponse
Clients on this page, sorted by name.
totalTotal clients matching the query.
limitClients 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 (1-indexed).
totalPagesDeprecated: page with nextCursor instead. Total pages.
CustomerGroupResponse
idThe unique identifier of the customer group
numberCustomer group number
nameName of the customer group
accountIdThe ledger account ID associated with this customer group. Present with the customers-read scope; omitted for checkout-only keys.
accountNumberThe ledger account number associated with this customer group
accountNameThe ledger account name associated with this customer group
Key-value metadata attached to the customer group
discountDeprecated - always 0. No pricing path applies it. Present with the customers-read scope; omitted for checkout-only keys.
CustomerDepartmentResponse
idThe unique identifier of the department
nameName of the department
isDefaultWhether this is the default department for the customer
isActiveWhether the department is active
poNumberPurchase order number
eanNumberEAN number for e-invoicing
addressStreet address
cityCity
postalCodePostal code
countryCodeTwo-letter country code (ISO 3166-1 alpha-2)
CustomerContactResponse
idThe unique identifier of the contact
nameName of the contact
isDefaultForCustomerWhether this is the default contact for the customer
emailEmail address
phonePhone number
CustomerResponse
idThe unique identifier of the customer
customerNumberCustomer number
customerTypeCustomer type
nameName of the customer
vatZoneVAT zone classification
customerGroupIdCustomer group ID
isActiveWhether the customer is active
billingRelationshipBilling relationship. self = this customer is billed directly. parent_pays = the parent customer (set via parentCustomerId) is billed instead.
includeChildDetailsPdfWhether to attach a zip of per-child detail PDFs when sending consolidated invoices. Only relevant for parent customers in single_invoice mode.
selfServiceDetailsEnabledWhether this customer's portal users may fill in their own billing details (VAT number, street, postal code, city), both on the portal's Company settings page and during checkout, instead of only confirming a read-only copy of the record. Country and customer type stay operator-owned either way, which is what keeps them inside the VAT regime the operator assigned.
customerGroupNumberCustomer group number
customerGroupNameCustomer group name
emailEmail address
phonePhone number
addressStreet address
cityCity
postalCodePostal code
countryCodeTwo-letter country code (ISO 3166-1 alpha-2)
vatNumberVAT registration number
websiteWebsite URL
externalSystemIdExternal system identifier for tracking the customer across other systems
eanNumberEAN number for e-invoicing. Absent when the customer has none.
creditLimitCredit limit
openingBalanceOpening balance in the company base currency (signed: positive = the customer owes us)
paymentTermsPayment terms in days
paymentTermTypePayment term type
defaultCurrencyDefault currency code
parentCustomerIdParent customer ID. When set, this customer is a child in a parent-child billing relationship. Set together with billingRelationship to change how this customer is billed.
consolidationModeConsolidation mode for a parent customer. single_invoice = all child subscriptions are consolidated onto one parent invoice on billingDay. per_child_invoice = each child receives its own invoice. Only meaningful on parent customers.
billingDayDay of month (1-28) when the parent consolidated invoice is generated. Required for single_invoice consolidation mode.
parentInvoiceTemplateIdParent single invoice PDF template override
Key-value metadata attached to the customer
PublicListCustomersResponse
Customers on this page
totalTotal customers matching the query
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 (1-indexed).
totalPagesDeprecated: page with nextCursor instead. Total pages.
CreateCustomerRequest
customerTypeSpecifies whether the customer is a business or a private person
nameCustomer name
vatZoneVAT zone classification
customerGroupIdCustomer group ID
countryCodeTwo-letter country code
defaultCurrency^[A-Za-z]{3}$ · requiredThe currency this customer is invoiced in, ISO 4217 alpha-3.
customerNumberUnique customer number. Omit it, or send an empty value, to have the next number assigned from the company customer sequence; the assigned number comes back on the response.
emailEmail address
phonePhone number
addressStreet address
cityCity
postalCodePostal code
vatNumberVAT registration number
websiteWebsite URL
externalSystemIdExternal system identifier for tracking the customer across other systems
eanNumberEAN number for e-invoicing. Digits only.
notesAdditional notes
creditLimitCredit limit
openingBalanceOpening balance in the company base currency, seeding receivables that predate LedgerBee. Signed: positive = the customer owes us, negative = a credit position.
paymentTermsPayment terms in days
paymentTermTypePayment term type
isActiveWhether the customer is active
parentCustomerIdParent customer ID. Set when creating this customer as a child in a parent-child billing relationship. Must be combined with billingRelationship = parent_pays to route billing to the parent. Send null to create a standalone customer.
billingRelationshipBilling relationship. self (default) = this customer is billed directly. parent_pays = the parent customer (set via parentCustomerId) is billed instead.
consolidationModeConsolidation mode (parent customers only). single_invoice = all child subscriptions consolidated onto one invoice on billingDay. per_child_invoice = each child receives its own invoice.
billingDayDay of month (1-28) for the parent consolidated invoice. Required for single_invoice consolidation.
includeChildDetailsPdfWhether to attach a zip of per-child detail PDFs when sending consolidated invoices
selfServiceDetailsEnabledWhether this customer's portal users may fill in their own billing details (VAT number, street, postal code, city), both on the portal's Company settings page and during checkout, instead of only confirming a read-only copy of the record. Country and customer type stay operator-owned either way, which is what keeps them inside the VAT regime the operator assigned.
parentInvoiceTemplateIdParent single invoice PDF template override. Send null to clear.
Key-value metadata to attach to the customer. At most 50 entries; keys up to 128 characters, string values up to 500 characters.
CreateCustomerResponse
idThe unique identifier of the created customer
customerNumberCustomer number
SubscriptionTransitionItem
customerSubscriptionIdThe subscription to move onto the new billing arrangement: the id GET /v1/subscriptions returns, the same stable id every subscription endpoint takes.
UpdateCustomerRequest
customerTypeCustomer type
customerNumberUnique customer number
nameCustomer name
vatZoneVAT zone classification
customerGroupIdCustomer group ID
emailEmail address. Send null or empty string to clear.
phonePhone number
addressStreet address
cityCity
postalCodePostal code
countryCodeTwo-letter country code
vatNumberVAT registration number
websiteWebsite URL
externalSystemIdExternal system identifier for tracking the customer across other systems
eanNumberEAN number for e-invoicing. Digits only. Send null or empty string to clear.
notesAdditional notes
creditLimitCredit limit
openingBalanceOpening balance in the company base currency, seeding receivables that predate LedgerBee. Signed: positive = the customer owes us, negative = a credit position.
paymentTermsPayment terms in days
paymentTermTypePayment term type
defaultCurrency^[A-Za-z]{3}$The currency this customer is invoiced in, ISO 4217 alpha-3. Omit it, or send a blank one, to leave the stored currency alone.
isActiveWhether the customer is active
parentCustomerIdParent customer ID. Send null to detach from parent. Changing this field on a customer with active subscriptions will transition those subscriptions to the parent's billing day with a clean cut at today's date: advance-billed subscriptions receive a credit note for the remaining days of the current period, and arrears-billed subscriptions are invoiced up to the transition date. When transitioning, subscriptionTransitions must list every active subscription on this customer as explicit acknowledgement that they will be migrated.
billingRelationshipBilling relationship. Change to parent_pays together with parentCustomerId to route billing to the parent.
consolidationModeConsolidation mode (parent customers only). Send null to clear.
billingDayDay of month (1-28) for the parent consolidated invoice. Send null to clear.
includeChildDetailsPdfWhether to attach a zip of per-child detail PDFs when sending consolidated invoices
selfServiceDetailsEnabledWhether this customer's portal users may fill in their own billing details (VAT number, street, postal code, city), both on the portal's Company settings page and during checkout, instead of only confirming a read-only copy of the record. Country and customer type stay operator-owned either way, which is what keeps them inside the VAT regime the operator assigned.
parentInvoiceTemplateIdParent single invoice PDF template override. Send null to clear.
Subscription transitions — required when changing parentCustomerId, billingRelationship, or consolidationMode on a customer with active subscriptions, and when changing billingDay or consolidationMode on a single_invoice parent (then it must cover every child customer's subscriptions). Lists every active subscription as explicit acknowledgement that each one is migrated to the new billing arrangement with a clean cut at today's date. Entries for subscriptions that need no transition are accepted and ignored.
Key-value metadata. When provided, REPLACES the customer metadata wholesale — send the complete desired map; an empty object clears all entries. Omit the field to leave metadata unchanged. At most 50 entries; keys up to 128 characters, string values up to 500 characters.
DeleteCustomerResponse
idThe unique identifier of the customer
customerNumberCustomer number
resultDELETED when the customer had no history and is gone. DEACTIVATED when bookings, invoices or subscriptions kept it: it stays readable with isActive: false, so its history is intact.
DimensionValue
idUnique identifier of the dimension value
nameDisplay name of the dimension value
parentIdParent dimension value ID for hierarchical structures. Null for root-level values. Use this to create nested structures like "Sales > Europe > Denmark".
Child dimension values (nested structure). Only populated in list responses.
Dimension
idUnique identifier of the dimension category
nameDisplay name of the dimension category
isUniqueWhen true, only one value from this dimension can be assigned to a journal entry (mutually exclusive). When false, multiple values can be assigned (additive tags). Example: A "Department" dimension is typically unique (one department per entry), while a "Tags" dimension might allow multiple values.
Available dimension values within this category, organized as a hierarchical tree. Root values have parentId as null, nested values reference their parent.
requiredOnAccountIdsIDs of the accounts that require this dimension: every journal entry line posting to one of them must carry a value from this dimension, or the entry is refused with JOURNAL_TAG_REQUIRED_DIMENSION_MISSING. Empty when no account requires it.
PublicDimensionValueListItem
idUnique identifier of the dimension value
nameName of the value
parentIdParent value id for hierarchical dimensions. Absent on root values. Rebuild the tree client-side.
PublicListDimensionValuesResponse
Dimension values as a FLAT page ordered by name; use parentId to rebuild hierarchy
totalTotal number of values in this dimension
pageCurrent page number (1-indexed)
limitMaximum number of items per page
totalPagesTotal number of pages available
PublicDistributionKeyAllocation
valueIdThe dimension value this share is allocated to
valueNameName of the target dimension value
percentageShare of the amount, in percent with up to six decimal places. All shares sum to exactly 100.
sortOrderDisplay order of the allocation row (0-based)
PublicDistributionKey
idUnique identifier of the distribution key
nameDisplay name
isAdHocTrue for a one-document split created inline on a draft. Ad-hoc keys are excluded from listings unless includeAdHoc=true, and their lifecycle is system-managed.
isActiveFalse once the key is archived (a posted ad-hoc key archives automatically)
The allocations, in display order. Percentages sum to exactly 100.
PublicListDistributionKeysResponse
Distribution keys, ordered by name
totalTotal number of keys matching the query
pageCurrent page number (1-indexed)
limitMaximum number of items per page
totalPagesTotal number of pages available
PublicCreateDistributionKeyAllocation
valueIdThe dimension value to allocate to. Must belong to this dimension.
percentageShare in percent, up to six decimal places. All allocations must sum to exactly 100.
sortOrderDisplay order of the allocation row (0-based)
PublicCreateDistributionKey
Allocations that must sum to exactly 100%. Between 2 and 100 entries.
nameDisplay name. Required for a reusable key; omit it on an ad-hoc key, which names itself from its allocations server-side.
isAdHocTrue to create a one-document split. Ad-hoc keys are hidden from listings by default and their lifecycle is system-managed: archived when the document they are applied to posts, deleted with the draft that owned them, and swept if left orphaned. Reference the returned id from a draft’s tagIds to apply the split.
CreateDimensionRequest
nameDisplay name for the dimension category. Must be unique within your company. Choose a descriptive name that clearly indicates the categorization purpose.
isUniqueWhether only one value from this dimension can be assigned to a journal entry. Set to true for mutually exclusive categories (e.g., Department - an entry belongs to exactly one department). Set to false for additive tags (e.g., Tags - an entry can have multiple tags). This constraint is enforced when assigning dimension values to journal entries, and it is fixed once the category is created.
DimensionResponse
idUnique identifier of the created/updated dimension category
nameDisplay name of the dimension category
isUniqueWhether only one value from this dimension can be assigned per journal entry
requiredOnAccountIdsIDs of the accounts that require this dimension on every line posting to them. Empty when no account requires it.
UpdateDimensionRequest
nameNew display name for the dimension category. Must be unique within your company. Changing the name does not affect existing dimension value assignments.
CreateDimensionValueRequest
dimensionIdID of the dimension category this value belongs to. The category must exist and belong to your company.
nameDisplay name for the dimension value. Must be unique within the dimension category. Choose descriptive names that will be clear when selecting values in the UI.
parentIdParent dimension value ID for creating hierarchical structures. Leave null or omit for root-level values. The parent must exist within the same dimension category. Example: Create "Europe" first, then create "Denmark" with parentId set to Europe's ID.
DimensionValueResponse
idUnique identifier of the created/updated dimension value
nameDisplay name of the dimension value
dimensionIdID of the dimension category this value belongs to
dimensionNameName of the dimension category this value belongs to
dimensionIsUniqueWhether the parent category enforces single selection
parentIdParent dimension value ID, if this is a nested value
UpdateDimensionValueRequest
nameNew display name for the dimension value. Must be unique within the dimension category. Changing the name does not affect existing journal entry assignments.
parentIdNew parent dimension value ID. Set to null to move to root level. The parent must exist within the same dimension category and cannot create circular references (e.g., A cannot be parent of B if B is already an ancestor of A).
AttachmentRequest
filenameFilename with extension
contentBase64-encoded file content. Note: Base64 encoding adds ~33% overhead. Individual files should not exceed 10MB before encoding.
mimeTypeMIME type of the file
DraftSplitEntryLine
typeTransaction type for this line (debit or credit)
amountAmount for this line (must be non-negative)
accountIdAccount ID for this line (UUID). Optional for drafts — empty lines (type + amount with no account) are persisted as placeholders and must be completed in the platform UI before booking. Cannot be a heading or total account when provided.
vatCodeIdVAT/Tax code ID for this line (UUID)
descriptionOptional per-line memo (max 500 characters). Persisted on the draft line and carried onto the booked ledger transaction when the draft is booked.
tagIdsDimension tag IDs to attach to this specific line. Per-line tagIds MUST come from single-select (dimension) categories — multi-select tags belong at the entry-level tagIds instead.
CreateDraftJournalEntryRequest
accountIdPrimary account ID (UUID). Cannot be a heading or total account. For typed entries (supplier_invoice, customer_invoice, etc.), must have appropriate account classification.
dateDate of the journal entry in YYYY-MM-DD format
contraAccountIdContra account ID (UUID). Optional for drafts — partial drafts (primary line only) are allowed and must be completed in the platform UI before booking. Cannot be a heading or total account.
entryTypeEntry type determines the journal type and enforces account classification rules. Account classification requirements: supplier_invoice: account=EXPENSE|ASSET, contraAccount=LIABILITY; supplier_payment: account=LIABILITY, contraAccount=ASSET; customer_invoice: account=ASSET, contraAccount=REVENUE; customer_payment: account=ASSET, contraAccount=ASSET; journal: no restrictions. Legacy values "invoice" and "payment" map to supplier types.
typeTransaction type (debit or credit)
descriptionDescription of the journal entry
referenceReference number or identifier
customerIdCustomer ID (UUID) for customer-related entries
supplierIdSupplier ID (UUID). Required for supplier_invoice / supplier_payment entry types, and for any posting that touches an accounts-payable control account.
tagIdsTag/Dimension IDs to attach to the journal entry
vatCodeIdVAT/Tax code ID (UUID). Applied to the primary account unless split entries are used.
File attachments (base64-encoded). Maximum 10 attachments per entry. Total request size limit is 15MB.
originalAmountThe draft amount in the currency it is entered in, the one originalCurrency names (zero or more). Ignored when splitEntries is sent: the draft then stores the sum of the debit lines. Required unless the deprecated amount is sent instead.
originalCurrency^[A-Za-z]{3}$ISO 4217 alpha-3 code of the currency the draft is entered in. Omitted under both names, the draft is in your company base currency.
Split entry lines for multi-account drafts. Each line may omit accountId to act as a placeholder; the draft is persisted with NULL on those lines and the user completes them in the platform UI. Booking still requires every line to carry a real account and the entry to balance.
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.
vendorIdDeprecated — use supplierId. Legacy alias for the supplier reference; still accepted, but sending both supplierId and vendorId with different values returns 400.
amountDeprecated — use originalAmount. The same figure under its old name. Sending both with different values returns 400 DRAFT_DEPRECATED_FIELD_CONFLICT.
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.
CreateDraftJournalEntryBatchRequest
Array of draft journal entries to create (1-100 entries per batch)
DraftJournalEntryLine
typeWhich side of the entry this line sits on
accountIdAccount this line posts to. Absent on a placeholder line — one persisted with an amount and a side but no account yet, which must be completed before the draft can be booked.
amountAmount for this line in the draft's own currency, the one originalCurrency names. Absent on a line persisted without one, which must be completed before the draft can be booked — reported as absent rather than as 0, so an unfinished line is never mistaken for a zero-value one.
vatCodeIdVAT/Tax code ID
descriptionPer-line memo
tagIdsTag/Dimension IDs attached to this line. Per-line dimensions override the entry-level tagIds on this specific ledger transaction.
DraftSplitEntryLineResponse
accountIdAccount ID
typeTransaction type (debit or credit)
amountAmount for this line in transaction currency
vatCodeIdVAT/Tax code ID
descriptionPer-line memo
tagIdsTag/Dimension IDs attached to this line. Per-line dimensions override the entry-level tagIds on this specific ledger transaction.
DraftJournalEntryResponse
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.
CreateDraftJournalEntryBatchResponse
totalCreatedNumber of draft entries successfully created
Details of all created draft journal entries
ListDraftJournalEntriesResponse
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.
JournalEntryLine
accountIdAccount this line posts to
typeWhich side of the entry this line sits on
accountAmountAmount posted to the account, in that account's own currency (accountCurrency). For an account operating in the company base currency this equals functionalAmount.
accountCurrencyThe account's operating currency — the currency accountAmount is denominated in.
functionalAmountAmount posted, converted to the company's base currency. This is the figure to sum when comparing or aggregating across accounts — summing accountAmount across accounts of different currencies would add unlike units.
isVatLineTrue when this line is VAT that the platform derived from another line, rather than a line you posted. Derived VAT lines are included so the lines of an entry balance; vatSourceLineIndex points at the line they came from.
originalAmountThis line's amount in the entry's originalCurrency — the third currency layer, alongside accountAmount (the account currency) and functionalAmount (the company base). On an entry posted in the base currency all three agree. Do not sum this to get the entry total. It is absent on a derived VAT line — the platform computes VAT in base currency and stores no document figure for it — so the sum falls short by the VAT whenever a line is VAT-coded. Use the entry-level originalAmount for the document total, or sum functionalAmount for the base-currency total. Also absent on historical lines that stored no document amount.
vatSourceLineIndexIndex into this same lines array of the line this VAT was derived from. Set only when isVatLine is true, and omitted in the rare case where the source line is not part of this entry.
vatCodeIdVAT/Tax code in effect for this line. A VAT line derived within this entry stores no code of its own — the code belongs to the line it was derived from — so this reports that source line's code. A VAT line derived from a line in a different entry carries its own code and is reported directly. Absent on a line with no VAT.
descriptionPer-line memo, separate from the entry-level description
tagIdsDimension tag IDs attached to this specific line
JournalEntryWarningDetailsDto
accountIdThe account the note is about.
JournalEntryWarningDto
codeWhat the note says. Each value has an en + da translation in the web app.
JournalEntryResponse
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.
SplitEntryLine
accountIdAccount ID for this line (UUID). Cannot be a heading or total account.
typeTransaction type for this line (debit or credit)
amountAmount for this line (must be non-negative)
vatCodeIdVAT/Tax code ID for this line (UUID)
descriptionOptional per-line memo (max 500 characters). Stored on the booked ledger transaction for this line, separate from the entry-level description.
tagIdsDimension tag IDs to attach to this specific line. Per-line tagIds MUST come from single-select (dimension) categories — multi-select tags belong at the entry-level tagIds instead. Each dimension category may appear at most once per line. The booked ledger transaction is tagged with these IDs and VAT derivatives inherit automatically. Validation: a non-dimension tag rejects with JOURNAL_TAG_LINE_TAG_NOT_A_DIMENSION; a repeated category rejects with JOURNAL_TAG_DUPLICATE_LINE_DIMENSION_CATEGORY.
CreateDraftJournalEntryV2Request
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.
CreateDraftJournalEntryV2BatchRequest
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.
CreateDraftJournalEntryV2BatchResponse
totalCreatedNumber of drafts created (= entries.length on success).
Created draft journal entries, ordered to match the request entries[].
UpdateDraftJournalEntryV2Request
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.
JournalEntryAttachmentResponse
idUnique identifier of the attachment/document
filenameOriginal filename of the attachment
contentTypeMIME type of the attachment
fileSizeFile size in bytes
contentBase64-encoded file content
createdAtTimestamp when the attachment was created
DraftJournalEntryAttachmentsListResponse
draftJournalEntryIdDraft journal entry ID the attachments belong to
List of attachments
DraftJournalEntryAttachmentAddedResponse
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
UpdateJournalEntryRequest
referenceCorrected reference. For invoices this is the invoice number (the anchor is renumbered with it); for payments it is the invoice number the payment settles. Only unmatched entries of the four entity document types accept a reference correction.
externalSystemIdYour own system's id for this journal entry. Settable on any journal type regardless of match state. Not unique — several entries may carry the same id (e.g. one partner document booked as several entries); filter GET /journal-entries by externalSystemId to find all of them. null clears the value; omitting the field keeps it. reference does not accept null — it is a matching key, not clearable metadata.
UpdateJournalEntryResponse
idJournal entry ID.
referenceThe reference after the update.
externalSystemIdThe external system id after the update.
ReverseJournalEntryRequest
journalEntryIdUUID of the posted journal entry to reverse.
reversalDateDate for the reversal posting (YYYY-MM-DD). When omitted, the reversal is dated to the original entry so it lands in the same period. Must fall in an open posting period.
reasonFree-text reason appended to the reversal description for audit purposes.
ReverseJournalEntryResponse
reversalIdUnique identifier of the posted reversal journal entry.
JournalEntryCorrectionPreviewLine
accountNumberAccount number the line posts to.
accountNameAccount name.
amountLine amount, in the currency named by currency.
typeWhich side of the entry the line sits on.
currencyThe line's currency - its ledger account's own.
vatCodeNameVAT code applied to the line, when it carries one.
isChangedTrue when this line differs from the original entry. Only set on a reclassification preview.
isVatTransactionTrue when the line is a VAT leg generated from another line.
JournalEntryCorrectionPreviewEnteredAs
amountThe amount as originally keyed.
currencyThe currency it was keyed in.
exchangeRateThe rate it was converted at.
JournalEntryCorrectionPreviewEntry
descriptionDescription the entry would carry.
dateDate the entry would post on (YYYY-MM-DD).
entryTypeWhich entry of the correction this is.
isDraftTrue when this entry would be created as a draft rather than posted.
The postings the entry would carry.
totalDebitSum of the debit lines, in totalCurrency.
totalCreditSum of the credit lines, in totalCurrency.
totalCurrencyThe currency the two totals are stated in. Each line carries its own account's currency, so the totals are summed in the company's base currency and this names it - never read the currency off a line.
What the operator originally keyed, when that differs from the currency the lines are shown in. Display only.
JournalEntryCorrectionPreviewResponse
The reversal that would neutralise the original.
The entry as it stands today, for comparison. Present on a reclassification preview.
The replacement entry. Absent for reverseOnly, which posts no replacement.
BatchReverseJournalEntriesRequest
journalEntryIdsIDs of the journal entries to reverse (1–100). All reversals run in one transaction; one failure rolls back the whole batch. Duplicate IDs are de-duplicated.
reversalDateDate for every reversal posting (YYYY-MM-DD). When omitted, each reversal is dated to its own original entry so the pair lands in the same period.
reasonFree-text reason appended to every reversal description for audit purposes.
BatchReverseJournalEntriesResultItem
originalIdOriginal journal entry ID supplied in the request.
reversalIdUnique identifier of the posted reversal journal entry.
BatchReverseJournalEntriesResponse
totalReversedNumber of reversals posted. Equals the count of unique IDs in the request on success.
Result rows pairing each original ID with its newly created reversal ID.
BatchReverseJournalEntriesPreviewItem
originalIdOriginal journal entry ID supplied in the request.
originalEntryNumberEntry number of the original journal entry.
reversalDateDate the reversal would post on (YYYY-MM-DD).
BatchReverseJournalEntriesPreviewResponse
totalReversibleNumber of reversals the batch would post. Equals the count of unique IDs in the request.
Each original entry the batch would reverse, with the date its reversal would carry.
ReclassifyJournalEntryLine
ledgerTransactionIdUUID of the ledger transaction (posting line) to move. Read these from GET /api/v1/journal-entries/{id}.
newAccountIdUUID of the ledger account the line should be posted to instead.
newVatCodeIdUUID of the VAT code to apply to the line. Omit to keep the line's current code; pass null to remove VAT from the line. Changing it re-splits the line's gross amount, so the net posted to the account moves.
PreviewJournalEntryCorrectionRequest
correctionTypeWhich correction to preview.
correctionDate^\d{4}-\d{2}-\d{2}$Date the correction posts on (YYYY-MM-DD). When omitted, the correction is dated to the original entry so the pair lands in the same period. Must fall in an open posting period.
reasonFree-text reason appended to the correction description for audit purposes.
Line changes to preview (max 100). Required for reclassify, ignored by the other two types.
ReverseAndCorrectJournalEntryRequest
correctionDate^\d{4}-\d{2}-\d{2}$Date the correction posts on (YYYY-MM-DD). When omitted, the correction is dated to the original entry so the pair lands in the same period. Must fall in an open posting period.
reasonFree-text reason appended to the correction description for audit purposes.
ReverseAndCorrectJournalEntryResponse
reversalIdUnique identifier of the posted reversal journal entry.
draftIdUnique identifier of the unlocked DRAFT holding the replacement entry. Nothing is posted from it until the draft is booked - edit it via the drafts endpoints, then book it.
PreviewRecreateJournalEntryResponseDto
originalEntryIdUnique identifier of the original entry the reversal undid, which the draft rebuilds.
draftDateThe date the draft would take (YYYY-MM-DD): the document's own date for an invoice or a supplier bill, otherwise today.
RecreateJournalEntryResponseDto
draftIdUnique identifier of the unlocked DRAFT rebuilding the original. Nothing is posted until the draft is booked.
originalEntryIdUnique identifier of the original entry the reversal undid.
ReclassifyJournalEntryRequest
The lines to move (1-100). Lines not listed are copied to the replacement entry unchanged.
correctionDate^\d{4}-\d{2}-\d{2}$Date the correction posts on (YYYY-MM-DD). When omitted, the correction is dated to the original entry so the pair lands in the same period. Must fall in an open posting period.
reasonFree-text reason appended to the correction description for audit purposes.
ReclassifyJournalEntryResponse
reversalIdUnique identifier of the posted reversal of the original entry.
newEntryIdUnique identifier of the posted replacement entry carrying the new account and VAT coding.
Notes on the replacement entry, as codes. Present only when there is one: JOURNAL_ENTRY_YEAR_END_ACCOUNT_POSTED when it has a line on the company year-end account and every other line is on a balance-sheet account. A replacement with a line there and an income or expense line is refused with 400 JOURNAL_ENTRY_YEAR_END_ACCOUNT_RESULT_LINE.
ListJournalEntriesResponse
List of journal entries
totalTotal number of matching entries
limitNumber of items 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.
JournalEntryAttachmentsListResponse
journalEntryIdJournal entry ID the attachments belong to
List of attachments
JournalEntryAttachmentAddedResponse
idID of the new attachment/document. Pass it to the remove endpoint to take the document off again.
journalEntryIdJournal entry ID the attachment was added to
CreateJournalEntryV2Dto
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 entry. Leading and trailing whitespace is trimmed before storage, and a value that is only whitespace is stored as no id at all — the list filter trims what it is given too, so an untrimmed value would be stored under an id no lookup could match. It is a lookup key, not a deduplication key: LedgerBee enforces no uniqueness on it and never compares it between requests, so several entries may carry the same id and repeating a request creates another entry. Filter GET /journal-entries by externalSystemId to find what an earlier run posted. For retries that must not post twice, send x-api-idempotency-key.
originalCurrency^[A-Za-z]{3}$ISO 4217 alpha-3 code of the currency the entry is posted in; originalAmount and lines[].amount are in this currency. Omitted under both names, the entry is posted 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 entry currency, so the same body is accepted or refused identically for every tenant. Omit it and exchangeRate to have the rate resolved from the rate feed at the posting date — supplying one lets an integrator that already converted the amount itself post both legs of a settlement against the same rate. Not applied when the entry is already denominated in the company base currency, where the conversion is the identity. A read of the posted entry returns the rate under this name, and again under the deprecated exchangeRate.
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.
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 JOURNAL_ENTRY_DEPRECATED_FIELD_CONFLICT.
exchangeRateDeprecated — use originalCurrencyToBaseCurrencyExchangeRate. The same rate under its old name. Sending both with different values returns 400 JOURNAL_ENTRY_DEPRECATED_FIELD_CONFLICT.
CreateJournalEntryV2BatchRequest
Array of 1–100 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.
CreateJournalEntryV2BatchResponse
totalCreatedNumber of journal entries created (= entries.length on success).
Created journal entries, ordered to match the request entries[].
JournalCategoryResponse
idThe unique identifier of the journal category
nameName of the journal category
isDefaultWhether this is the default journal category
allowedJournalTypesJournal entry types that may be posted into this category. A category created without an explicit list carries all eleven. See the endpoint description for what each value means.
CreateJournalCategoryRequest
nameName of the journal category. Must be unique within your company.
allowedJournalTypesJournal entry types that may be posted into this category. Posting an entry of a type not listed here is rejected. Omit this field to allow every type — the same set a company’s first category is created with. An empty array is rejected: it would describe a category nothing could ever be posted into. See the endpoint description for what each value means and which entryType reaches it. Send the field or leave it out — an explicit null is rejected.
isDefaultMake this the default category. Your company always has exactly one default, so passing true moves the flag off the category that currently holds it. Defaults to false.
UpdateJournalCategoryRequest
nameNew name for the journal category. Must be unique within your company.
allowedJournalTypesReplaces the set of journal entry types that may be posted into this category. The list cannot be empty, and omitting the field here leaves the current set unchanged (unlike on create, where omitting it means every type). Entries already posted are unaffected.
isDefaultPass true to make this the default category, which moves the flag off the category that currently holds it. Passing false is only accepted when another category is already the default — to move the default, mark its successor rather than clearing the incumbent.
MeterSubscriptionProductDTO
idProduct ID
nameProduct name
productNumberProduct number
MeterSubscriptionDTO
idSubscription ID
nameSubscription name
statusSubscription status
Products in this subscription that use the meter
MeterSubscriptionsResponseDTO
meterIdMeter ID
meterNameMeter name
Subscriptions with products using this meter
PaymentMethodResponse
idUnique identifier of the payment method
customerIdCustomer ID this payment method belongs to
providerPayment provider
labelHuman-readable label for the payment method
isDefaultWhether this is the default payment method for the customer
statusCurrent status of the payment method
createdAtWhen the payment method was created
cardMaskMasked card number
cardTypeCard type as reported by the provider
expiryMonthCard expiry month
expiryYearCard expiry year
CreateCardSaveLinkRequest
providerPayment provider to use for saving the card
PaymentLinkResponse
urlURL to the payment provider window. Send this to your customer.
expiresAtWhen the payment link expires
PublicSubscriptionPlanPhaseProduct
priceIdPrice ID of the product
quantityQuantity for the product
customPriceCustom unit price override
PublicSubscriptionPlanIntervalDiscount
billingIntervalBilling interval the discount applies to
billingIntervalCountBilling interval count (e.g. 1 = monthly, 6 = every 6 months)
discountTypeDiscount type: flat (subtract amount) or period_total (set the period’s target total)
valueDiscount value (NET, excluding VAT)
descriptionOptional description shown on the invoice
PublicSubscriptionPlanPhase
idPhase ID
sequenceSequence order of the phase (1-based)
discountTypeType of discount applied during the phase
Products for this phase
namePhase name
discountValueDiscount value for the phase
durationValuePhase duration value
durationUnitPhase duration unit
Per-billing-interval (period) discounts configured for this phase
PublicSubscriptionPlanResponse
idSubscription plan ID
nameSubscription plan name
isActiveWhether the subscription plan is active
currencyCurrency code (ISO 4217)
defaultBillingDirectionDefault billing direction for new customer subscriptions
Phases configured for this plan
createdAtDate the plan was created
updatedAtDate the plan was last updated
descriptionSubscription plan description
PublicListSubscriptionPlansResponse
List of subscription plans
totalTotal number of subscription plans matching the query
pageCurrent page number (1-indexed)
limitMaximum number of items per page
totalPagesTotal number of pages available
PublicCreateSubscriptionPlanPhaseProduct
priceIdPrice ID of an existing product price to include in this phase
quantityQuantity for the product (defaults to 1)
customPriceCustom unit price override for this line (defaults to the price’s own amount)
PublicCreateSubscriptionPlanIntervalDiscount
billingIntervalBilling interval the discount applies to
billingIntervalCountBilling interval count (e.g. 1 = monthly, 6 = every 6 months)
discountTypeDiscount type: flat (subtract amount) or period_total (set the period’s target total)
valueDiscount value (NET, excluding VAT). For flat: amount to subtract; for period_total: the target total.
descriptionOptional description shown on the invoice
PublicCreateSubscriptionPlanPhase
Products included in this phase. At least one is required.
nameDisplay name for the phase
discountTypeType of discount applied across the whole phase. Defaults to none when omitted or null.
discountValueDiscount value for the phase. Percentage (0-100), fixed amount, or total target depending on discountType.
Per-billing-interval (period) discounts. Use these to discount specific cadences (e.g. a flat amount off the yearly price) independently of the phase-level discount. At most one discount per period type (billing interval + count), and each must target a period type a product in this phase bills at — so the count is bounded by the phase’s distinct product period types.
durationValueLength of the phase. Omit on the last phase to leave it open-ended.
durationUnitUnit for the phase duration
PublicCreateSubscriptionPlanRequest
nameSubscription plan name. Must be unique within your company.
Phases defining the plan’s billing structure. At least one phase is required.
descriptionSubscription plan description
currencyCurrency code (ISO 4217). Omit to bill in the company's own base currency.
defaultBillingDirectionDefault billing direction applied to new customer subscriptions created from this plan
PublicCancelSubscriptionRequest
idCustomer subscription ID to cancel
strategyCancellation strategy
effectiveDateEffective churn date (ISO 8601). Required when strategy is SPECIFIC_DATE.
refundBehaviorRefund behavior when canceling immediately
cancellationReasonOptional reason for cancelling the subscription
EntitlementRef
idEntitlement ID
nameEntitlement name
keyStable integration key
PublicSubscriptionAddon
subscriptionIdThe add-on’s own subscription id — the id to read or cancel it by.
subscriptionNameThe add-on’s current subscription name
planIdThe plan the add-on currently runs on (null for an add-on created without a plan)
statusStatus of the add-on subscription
addedOnThe date (YYYY-MM-DD) the add-on was added to this subscription.
effectiveNextBillingDateThe date the add-on’s NEXT charge is created (ISO 8601). It is billed on the parent’s invoice, so this is the parent invoice its next period rides on.
monthlyRevenueThe add-on’s own monthly revenue. The parent’s invoice carries the parent’s amount plus every add-on’s, so the parent’s full recurring amount is its own monthlyRevenue plus these. What the subscription bills per month today, as a decimal string, in currency, excluding VAT. Every billing interval is converted to one month: a quarter is divided by 3, half a year by 6, a year by 12, and weekly prices are multiplied by 52/12. Plan discounts, interval discounts and recurring surcharges are applied; one-off charges are not included. Add-ons are not included either: each add-on is its own subscription with its own monthlyRevenue, so adding up every subscription counts nothing twice, and the invoice a parent sends carries its own figure plus its add-ons’. Usage-based lines are left out, because their consumption is not known until the period closes: a metered line counts only through a prepaid commitment, or a fee its price charges at zero usage (see hasMeteredProducts, and GET /v1/subscriptions/{id}/usage for the usage recorded so far). A change scheduled for a later date shows from the day it takes effect. During a trial it is the price billing starts at. 0 for a subscription that has not started yet or has ended.
currencyCurrency code (ISO 4217). Always the parent’s currency.
PublicSubscriptionDiscount
discountIdThe discount record.
namePrinted as the reason on the e-invoice allowance.
typescopepercentagePctA percentage discount only.
amountInCurrencyA fixed or per-unit discount's amount in the subscription currency; null for a percentage.
activeFalse: the discount is switched off and takes nothing off any period.
endsAtYYYY-MM-DD. The discount applies to each billing period that starts before this day; null: no end.
targetsNoProductTrue for a line-scope discount that names none of the subscription products: it takes nothing off until one of its products is added or it is assigned to one of these.
PublicSubscriptionProduct
productIdCatalogue product id. Stays the same when the product gets a new price.
productNameThe product’s name in the catalogue today. An invoice already issued keeps the name it was billed under.
productNumberProduct number from the catalogue.
priceIdThe price this line bills from — the priceId POST /v1/subscriptions/{id}/product-changes takes for the line. GET /v1/product-prices/{priceId} returns the price as the catalogue has it today.
billingPeriodTypeHow the line is billed: recurring bills quantity every period, usage bills what was consumed in the period, one_time bills once, and surcharge is a percentage of the subscription’s other lines.
pricingModelHow the price is calculated. flat_rate is one unit price; volume, graduated and package are priced from tiers, so unitPrice is null (unless an agreed price is set) and the tiers are on GET /v1/product-prices/{priceId}.
quantityQuantity on the line. Null when the line carries no fixed quantity.
unitPriceThe unit price the line bills at, as a decimal string in the subscription’s currency, excluding VAT: customPrice when one is set, else the price fixed when the subscription’s current billing period was set up. A later catalogue price change reaches it only when the subscription changes again. Null for a tiered price with no agreed price, a surcharge, and a subscription with no billing period in effect (one that has ended).
customPriceThe unit price agreed for this subscription, as a decimal string in the subscription’s currency. Null when the line bills the catalogue price.
descriptionThe line description shown on the invoice, when one was set.
PublicCancelSubscriptionResponse
idCustomer subscription ID
customerIdCustomer ID
customerNameCustomer name
subscriptionNameSubscription name
startDateStart date (ISO 8601)
statusStatus of the customer subscription
currencyCurrency code (ISO 4217)
monthlyRevenueWhat the subscription bills per month today, as a decimal string, in currency, excluding VAT. Every billing interval is converted to one month: a quarter is divided by 3, half a year by 6, a year by 12, and weekly prices are multiplied by 52/12. Plan discounts, interval discounts and recurring surcharges are applied; one-off charges are not included. Add-ons are not included either: each add-on is its own subscription with its own monthlyRevenue, so adding up every subscription counts nothing twice, and the invoice a parent sends carries its own figure plus its add-ons’. Usage-based lines are left out, because their consumption is not known until the period closes: a metered line counts only through a prepaid commitment, or a fee its price charges at zero usage (see hasMeteredProducts, and GET /v1/subscriptions/{id}/usage for the usage recorded so far). A change scheduled for a later date shows from the day it takes effect. During a trial it is the price billing starts at. 0 for a subscription that has not started yet or has ended.
hasMeteredProductsWhether any product on the subscription is billed on a meter. When true, monthlyRevenue leaves the metered consumption out; read GET /v1/subscriptions/{id}/usage for the usage recorded so far in the current period.
billingDirectionBilling direction: ADVANCE bills at period start, ARREARS at period end
effectiveBillingDirectionEffective billing direction for the current period. Can differ from billingDirection if the direction was changed mid-period.
addonOfSubscriptionIdThe subscription this one is an add-on of, or null. An add-on bills on its parent’s invoice, inside the parent’s section, and ends when the parent is cancelled.
addonOfSubscriptionNameCurrent name of the subscription this one is an add-on of, or null when it is not an add-on.
The add-ons billed on this subscription’s invoice, inside its section. Empty when it has none, and always empty on an add-on — an add-on cannot have add-ons of its own.
The discount records the subscription references, in the order they apply, each as the record is now with the end date this subscription carries for it. Empty when it references none.
The products the subscription bills today, newest line first. A change scheduled for a later date is listed under GET /v1/subscriptions/{id}/scheduled-changes and appears here once it takes effect. An add-on’s products are on the add-on’s own subscription.
cascadedAddonSubscriptionIdsThe add-ons cancelled together with this subscription, by their subscription ids. On an immediate cancellation these ended now; on a scheduled one they are the add-ons that will end with it, as they stand when the request is made. Empty when the subscription has no add-ons, and for clear_schedule.
Entitlements currently granted by the subscription
planIdSubscription plan ID (null for ad-hoc subscriptions)
endDateEnd date (ISO 8601)
scheduledChurnDateScheduled churn date (ISO 8601). On an add-on this is its parent’s scheduled churn date: a scheduled cancellation of the parent ends every add-on with it.
trialDaysNumber of trial days granted
cancellationReasonReason provided when the subscription was cancelled
effectiveNextBillingDateThe date the NEXT invoice will be created (ISO 8601). This is an invoicing schedule marker, not a payment marker — it does not say what the customer has paid for; see paidThroughDate.
paidThroughDateThe date the subscription is paid through (ISO 8601): the first day not yet paid for. It is the end of the contiguous run of settled service periods starting at the earliest billed period, so an unpaid period caps it rather than being skipped. Null when the earliest billed period is not settled (or nothing is billed yet). Payment timing never shifts this backwards: a late payment settles exactly the period its invoice stated.
commitmentEndDateEnd date of the customer commitment period (ISO 8601)
originalStartDateOriginal start date from source system for migrated subscriptions (ISO 8601)
paymentMethodIdAssigned payment method ID
automaticBillingWhether automatic billing is enabled
allowedPaymentProvidersThe connected card provider the buyer may pay this subscription with - at most one. Empty means card payment is off. A subscription needs it before the buyer can add a first card through POST /v1/checkout/subscriptions/{id}/card-window, which otherwise answers 400 SUBSCRIPTION_MANAGE_PROVIDER_NOT_ALLOWED. It allows card payment and attaches no card: the buyer still enters the card themselves. Two providers of the same kind answer 400 INVOICE_MULTIPLE_CARD_PROVIDERS.
partnerReferenceIdYour reconciliation reference (the clientReferenceId you passed at embedded-checkout bind time), echoed back so you can match this subscription to your order. Null for any subscription not created through a partner-bound checkout.
billingGroupIdThe billing group this subscription is billed together with others on, or null when it bills on its own. A grouped subscription is billed on the group’s document and charged on the group’s card, so its own paymentMethodId is null and automaticBilling is false. A subscription that merely has other subscriptions billed as part of its own section is not grouped: it reports null and keeps its own card. So does one that IS such a section. A subscription that has joined a group but not yet reached its first shared billing date already reports the group.
PublicSubscriptionAddonRef
subscriptionIdThe add-on’s own subscription id — the id to read or cancel it by.
subscriptionNameThe add-on’s current subscription name
PublicCustomerSubscriptionListItem
idCustomer subscription ID
customerIdCustomer ID
customerNameCustomer name
subscriptionNameSubscription plan name
statusStatus of the customer subscription
startDateStart date (ISO 8601)
currencyCurrency code (ISO 4217)
monthlyRevenueWhat the subscription bills per month today, as a decimal string, in currency, excluding VAT. Every billing interval is converted to one month: a quarter is divided by 3, half a year by 6, a year by 12, and weekly prices are multiplied by 52/12. Plan discounts, interval discounts and recurring surcharges are applied; one-off charges are not included. Add-ons are not included either: each add-on is its own subscription with its own monthlyRevenue, so adding up every subscription counts nothing twice, and the invoice a parent sends carries its own figure plus its add-ons’. Usage-based lines are left out, because their consumption is not known until the period closes: a metered line counts only through a prepaid commitment, or a fee its price charges at zero usage (see hasMeteredProducts, and GET /v1/subscriptions/{id}/usage for the usage recorded so far). A change scheduled for a later date shows from the day it takes effect. During a trial it is the price billing starts at. 0 for a subscription that has not started yet or has ended.
hasMeteredProductsWhether any product on the subscription is billed on a meter. When true, monthlyRevenue leaves the metered consumption out; read GET /v1/subscriptions/{id}/usage for the usage recorded so far in the current period.
addonOfSubscriptionIdThe subscription this one is an add-on of, or null. An add-on bills on its parent’s invoice, inside the parent’s section, and ends when the parent is cancelled. Read the parent to see its add-ons.
addonOfSubscriptionNameCurrent name of the subscription this one is an add-on of, or null when it is not an add-on.
The add-ons billed on this subscription’s invoice, oldest first. Empty on an add-on and on a subscription without add-ons. Read the subscription for each add-on’s plan, status and next billing date.
The products the subscription bills today, newest line first. A change scheduled for a later date is listed under GET /v1/subscriptions/{id}/scheduled-changes and appears here once it takes effect. An add-on’s products are on the add-on’s own subscription.
customerNumberCustomer number
planIdSubscription plan ID (null for ad-hoc subscriptions)
effectiveNextBillingDateThe date the NEXT invoice will be created (ISO 8601). This is an invoicing schedule marker, not a payment marker — it does not say what the customer has paid for; see paidThroughDate.
paidThroughDateThe date the subscription is paid through (ISO 8601): the first day not yet paid for. It is the end of the contiguous run of settled service periods starting at the earliest billed period, so an unpaid period caps it rather than being skipped. Null when the earliest billed period is not settled (or nothing is billed yet). Payment timing never shifts this backwards: a late payment settles exactly the period its invoice stated.
partnerReferenceIdYour reconciliation reference (the clientReferenceId you passed at embedded-checkout bind time), echoed back so you can match this subscription to your order. Null for any subscription not created through a partner-bound checkout. Filter the list by partnerReferenceId to recover a missed webhook.
billingGroupIdThe billing group this subscription is billed together with others on, or null when it bills on its own. A subscription that has joined a group but not yet reached its first shared billing date already reports the group. A subscription that merely has other subscriptions billed as part of its own section is not grouped and reports null, and so does one that IS such a section.
PublicListCustomerSubscriptionsResponse
List of customer subscriptions
totalTotal number of customer subscriptions matching the query
limitMaximum number of items 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 (1-indexed).
totalPagesDeprecated: page with nextCursor instead. Total number of pages available.
PublicAssignSubscriptionProductOverride
priceIdPrice ID of the product to override
quantityQuantity to assign (overrides the plan template quantity). Not valid on usage-metered prices. Omit when the override only carries prepaid-commitment settings.
customPriceUnit price excluding VAT, as a decimal string, replacing the list price on this subscription. Omit to bill the list price. Valid only on flat-rate prices that are not usage-metered.
committedQuantityPrepaid usage commitment: quantity billed up front each period (usage-metered prices on advance billing only). Actual consumption is trued up at period end. Null = no commitment; 0 is a valid zero commitment.
usageCarryoverModeHow the next period derives its committed quantity from the settled period: reset (authored quantity), track_actual (last actual), ratchet_up (grow only), ratchet_down (shrink only). Null reads as reset.
underageModeWhat happens to underage (actual below committed) at settlement: forfeit (kept) or refund (credited). Null reads as forfeit.
minimumCommittedQuantityFloor for downward carryover (0 <= floor <= committedQuantity). Null = no floor.
committedUnitPriceFlat per-unit price for the committed units, replacing the price tier ladder on the commitment line only. Consumption above the commitment still walks the ladder, starting from the step the committed quantity occupies. Requires reset carryover + forfeit underage. Null = ladder-priced; 0 is a valid free commitment.
discardPreAssignmentUsageDon't bill usage events dated before this assignment for this subscription (usage-metered prices only; other subscriptions on the same meter still bill them). Persists a per-price usage window floor at the assignment date.
PublicAssignSubscriptionAddon
planIdSubscription plan ID the add-on is created from
Optional quantity and price overrides for products in the add-on’s plan
cadenceHow often the add-on bills, as <interval>-<count> (month-1, month-3, year-1). Omit to bill at the plan’s own cadence. Any other value must be one of the plan’s alternative cadences; one the plan does not offer is refused with 400 SHARED_VALIDATION_FAILED, details.reason = ADDON_CADENCE_NOT_ON_PLAN. An add-on on a shorter cadence than its parent bills its cycles on the parent’s invoice between the parent’s own billing dates.
PublicAssignSubscriptionRequest
customerIdCustomer ID to assign the subscription to
planIdSubscription plan ID
startDateStart date (ISO 8601)
endDateEnd date (ISO 8601)
billingCycleAnchorBilling cycle anchor date (ISO 8601). When the billing cycle should align to. Defaults to startDate if not provided.
prorationBehaviorHow to handle proration from startDate to billingCycleAnchor
trialDaysTrial period in days
billingDirectionBilling direction for this subscription
customerDepartmentIdCustomer department ID for invoice delivery
departmentContactOverrideIdContact override ID for department invoice delivery
Optional quantity and price overrides for products in the plan
automaticBillingWhether to enable automatic billing
allowedPaymentProvidersThe connected card provider the buyer may pay this subscription with - at most one. Empty means card payment is off. A subscription needs it before the buyer can add a first card through POST /v1/checkout/subscriptions/{id}/card-window, which otherwise answers 400 SUBSCRIPTION_MANAGE_PROVIDER_NOT_ALLOWED. It allows card payment and attaches no card: the buyer still enters the card themselves. Two providers of the same kind answer 400 INVOICE_MULTIPLE_CARD_PROVIDERS.
collectViaLeverandorserviceCollect each billing cycle via Leverandørservice (Danish direct debit) instead of a card charge. DKK-only. Requires the tenant to hold the Leverandørservice license, a configured creditor number, and a registered mandate for the customer.
joinBillingGroupIdCreate the subscription straight onto this billing group of the same customer. The group replaces billingCycleAnchor with its own billing date, and the assignment and the join commit together, so a refused join creates no subscription. startDate and prorationBehavior still decide the period up to the group's date. Cannot be combined with formBillingGroupWithSubscriptionId.
formBillingGroupWithSubscriptionIdCreate the subscription and form a NEW billing group with this existing subscription of the same customer as the lead: the lead's next billing date replaces billingCycleAnchor, and its terms are written onto the new subscription. The assignment and the formation commit together. Cannot be combined with joinBillingGroupId.
discountIdsDiscount records the subscription references, in the order they apply, by id. Each bills on every period that starts before its end: a discount that lasts a number of periods ends that many billing periods after the first one billed (after any trial), and one without a duration has no end. Each is checked when attached: it exists, a fixed or per-unit one has an amount in the subscription currency, it combines with the others, and it is not code-only. The subscription takes one use of each discount limit, however many periods it bills. Refusals: DISCOUNT_NOT_FOUND, DISCOUNT_NO_AMOUNT_IN_CURRENCY, DISCOUNT_PER_UNIT_NEEDS_LINE_SCOPE, DISCOUNT_NOT_COMBINABLE, DISCOUNT_REFERENCED_TWICE, DISCOUNT_NOT_APPLICABLE, DISCOUNT_REDEMPTION_LIMIT_REACHED, DISCOUNT_CUSTOMER_REDEMPTION_LIMIT_REACHED, DISCOUNT_DURATION_NEEDS_RECURRING_PRODUCT.
Add-ons created together with this subscription. Each becomes a subscription of its own that bills on this subscription’s invoice, inside its section, and ends when this subscription is cancelled. An add-on takes its customer, dates, billing direction and invoice details from this subscription, so it names only its plan and product overrides. The subscription and its add-ons commit together: a refused add-on creates nothing. Cannot be combined with joinBillingGroupId or formBillingGroupWithSubscriptionId (400 SHARED_VALIDATION_FAILED, details.reason = ADDONS_WITH_BILLING_GROUP_PLACEMENT). To add an add-on to an existing subscription, use POST /v1/subscriptions/{id}/addons.
discountCodeA discount code the customer gave, matched without regard to case or surrounding spaces. Its discount is attached to this subscription (not to its add-ons) and bills on every period that starts before the discount ends: a discount that lasts N periods ends N billing periods after the first one billed, which with trialDays is the first period after the trial. A code that is unknown, switched off, expired, for another customer or with no use left is refused with its DISCOUNT_* code and nothing is created. The subscription takes one use of the discount and of the code, whatever number of periods it bills.
paymentMethodIdDeprecated and non-functional. Cards are attached by the buyer with their consent (card-save link / portal checkout); any value here is rejected. Field retained only so the request is validated cleanly.
PublicCustomerSubscriptionResponse
idCustomer subscription ID
customerIdCustomer ID
customerNameCustomer name
subscriptionNameSubscription name
startDateStart date (ISO 8601)
statusStatus of the customer subscription
currencyCurrency code (ISO 4217)
monthlyRevenueWhat the subscription bills per month today, as a decimal string, in currency, excluding VAT. Every billing interval is converted to one month: a quarter is divided by 3, half a year by 6, a year by 12, and weekly prices are multiplied by 52/12. Plan discounts, interval discounts and recurring surcharges are applied; one-off charges are not included. Add-ons are not included either: each add-on is its own subscription with its own monthlyRevenue, so adding up every subscription counts nothing twice, and the invoice a parent sends carries its own figure plus its add-ons’. Usage-based lines are left out, because their consumption is not known until the period closes: a metered line counts only through a prepaid commitment, or a fee its price charges at zero usage (see hasMeteredProducts, and GET /v1/subscriptions/{id}/usage for the usage recorded so far). A change scheduled for a later date shows from the day it takes effect. During a trial it is the price billing starts at. 0 for a subscription that has not started yet or has ended.
hasMeteredProductsWhether any product on the subscription is billed on a meter. When true, monthlyRevenue leaves the metered consumption out; read GET /v1/subscriptions/{id}/usage for the usage recorded so far in the current period.
billingDirectionBilling direction: ADVANCE bills at period start, ARREARS at period end
effectiveBillingDirectionEffective billing direction for the current period. Can differ from billingDirection if the direction was changed mid-period.
addonOfSubscriptionIdThe subscription this one is an add-on of, or null. An add-on bills on its parent’s invoice, inside the parent’s section, and ends when the parent is cancelled.
addonOfSubscriptionNameCurrent name of the subscription this one is an add-on of, or null when it is not an add-on.
The add-ons billed on this subscription’s invoice, inside its section. Empty when it has none, and always empty on an add-on — an add-on cannot have add-ons of its own.
The discount records the subscription references, in the order they apply, each as the record is now with the end date this subscription carries for it. Empty when it references none.
The products the subscription bills today, newest line first. A change scheduled for a later date is listed under GET /v1/subscriptions/{id}/scheduled-changes and appears here once it takes effect. An add-on’s products are on the add-on’s own subscription.
Entitlements currently granted by the subscription
planIdSubscription plan ID (null for ad-hoc subscriptions)
endDateEnd date (ISO 8601)
scheduledChurnDateScheduled churn date (ISO 8601). On an add-on this is its parent’s scheduled churn date: a scheduled cancellation of the parent ends every add-on with it.
trialDaysNumber of trial days granted
cancellationReasonReason provided when the subscription was cancelled
effectiveNextBillingDateThe date the NEXT invoice will be created (ISO 8601). This is an invoicing schedule marker, not a payment marker — it does not say what the customer has paid for; see paidThroughDate.
paidThroughDateThe date the subscription is paid through (ISO 8601): the first day not yet paid for. It is the end of the contiguous run of settled service periods starting at the earliest billed period, so an unpaid period caps it rather than being skipped. Null when the earliest billed period is not settled (or nothing is billed yet). Payment timing never shifts this backwards: a late payment settles exactly the period its invoice stated.
commitmentEndDateEnd date of the customer commitment period (ISO 8601)
originalStartDateOriginal start date from source system for migrated subscriptions (ISO 8601)
paymentMethodIdAssigned payment method ID
automaticBillingWhether automatic billing is enabled
allowedPaymentProvidersThe connected card provider the buyer may pay this subscription with - at most one. Empty means card payment is off. A subscription needs it before the buyer can add a first card through POST /v1/checkout/subscriptions/{id}/card-window, which otherwise answers 400 SUBSCRIPTION_MANAGE_PROVIDER_NOT_ALLOWED. It allows card payment and attaches no card: the buyer still enters the card themselves. Two providers of the same kind answer 400 INVOICE_MULTIPLE_CARD_PROVIDERS.
partnerReferenceIdYour reconciliation reference (the clientReferenceId you passed at embedded-checkout bind time), echoed back so you can match this subscription to your order. Null for any subscription not created through a partner-bound checkout.
billingGroupIdThe billing group this subscription is billed together with others on, or null when it bills on its own. A grouped subscription is billed on the group’s document and charged on the group’s card, so its own paymentMethodId is null and automaticBilling is false. A subscription that merely has other subscriptions billed as part of its own section is not grouped: it reports null and keeps its own card. So does one that IS such a section. A subscription that has joined a group but not yet reached its first shared billing date already reports the group.
PublicScheduledChange
changeIdIdentifier of this queued change. Ephemeral — valid only until the change activates or is cancelled, so re-fetch rather than caching it.
kindThe kind of queued change: one of replace_plan, edit_products, change_direction, or churn.
effectiveDateThe date (YYYY-MM-DD) the change takes effect.
planIdThe plan the subscription moves to when the change activates (null for ad-hoc / non-plan changes).
subscriptionNameThe plan name the change moves to.
PublicSubscriptionUsageLine
meterIdThe meter the usage is recorded on.
meterNameThe meter’s display name.
priceIdThe price the usage is billed at. A meter sold at two prices reports one line per price.
productNameThe product name the invoice line will carry.
periodStartFirst day of the billing period the usage falls in (YYYY-MM-DD).
periodEndThe day the period closes (YYYY-MM-DD, exclusive). Its usage is invoiced on or after this date, in arrears.
quantityQuantity recorded so far in the period, after the meter’s aggregation (sum, count, maximum or last value). Usage recorded before a date the operator chose not to bill from is left out, as it is on the invoice.
amountWhat the period’s usage comes to so far, as a decimal string in currency, excluding VAT, priced exactly as the invoice will price it: the price the subscription is locked to, tiers included. For a line with a prepaid commitment it is only the settlement: the usage above what was prepaid (or, when the commitment refunds unused units, a negative amount for what was not used). The up-front commitment charge is not included. Usage already invoiced is not included. Plan and interval discounts are separate lines on the invoice and are not deducted here.
quantityIsSharedWhether another line reads the same units. Usage is recorded per customer and meter, not per subscription, so every line on the same meter (another price on this subscription, or another of the customer’s subscriptions) reports the same quantity. Amounts on such lines add up; quantities do not.
PublicSubscriptionUsage
subscriptionIdThe stable subscription id.
currencyCurrency code (ISO 4217) of every amount.
One entry per metered price and billing period that has usage not yet invoiced. A subscription behind on billing can report more than one period for a price. Empty when the subscription has no metered products.
PublicSubscriptionProductChangeLine
priceIdPrice ID of the product line.
quantityQuantity from the effective date. Omit to keep the quantity the line has today; a price the subscription does not carry yet starts at 1. Not valid on usage-metered prices.
customPriceUnit price excluding VAT, as a decimal string, replacing the list price from the effective date. Omit to keep the price the line has today; send null to bill the list price. Not valid on usage-metered prices.
descriptionText printed on the invoice line. Omit to keep the description the line has today; send null to remove it.
PublicSubscriptionDiscountEndDate
discountIdA discount the subscription references.
endsAtThe day the discount stops (YYYY-MM-DD): a period starting on or after it is billed without it.
PublicChangeSubscriptionProductsRequest
effectiveDateThe date the change takes effect (YYYY-MM-DD). A date in the future queues the change; it is listed under the subscription’s scheduled changes until then. Today or an earlier date takes effect at once; the earliest date accepted is the day the subscription’s current terms took effect.
Every product line the subscription has from the effective date. A line for a price the subscription carries today changes that line; a line for a new price adds it; a price left out of the list is removed. Each price may appear once. May be left out when the change sends discountIds or discountEndDates: the products then stay as they are.
discountIdsThe full set of discount records the subscription references from the effective date, in the order they apply. Omit to keep the ones it has; [] removes them all. A discount added is checked and takes one use of its limits; one removed gives its use back unless an invoice already applied it. The refusals are those of discountIds on POST /v1/subscriptions.
End dates for discounts the subscription references after the change, replacing the ones they have. A period that starts on or after the end date is billed without the discount; null removes the end. A discount the subscription does not reference is refused with DISCOUNT_END_DATE_NOT_REFERENCED.
prorationBehaviorHow the billing period the effective date falls inside is settled on a subscription billed in advance. The modes are described in the Proration guide. Omit for create_prorations. A subscription billed in arrears ignores it: its invoice at the end of the period bills each part of the period at the terms in force, by days.
PublicRetryPaymentResponseDTO
statusAlways "succeeded" — a failed retry returns a coded error instead.
subscriptionIdThe stable subscription id the retry ran against.
invoiceIdId of the outstanding invoice the cleared charge paid.
PublicSubscriptionAddonEligibilityRequest
subscriptionIdsExisting subscriptions you intend to attach as add-ons (0-19, each once). Omit to ask only whether this subscription can take add-ons at all.
PublicAddonRefusal
codeThe error code the attach would answer with
subscriptionIdThe subscription the refusal is about, or null when it is about the request as a whole.
The refusal’s details, as the attach would answer them.
PublicRemovedCard
subscriptionIdThe subscription whose own card is taken off: an add-on bills on its parent’s invoice, which only the parent’s card pays. Null when the card is a billing group’s.
billingGroupIdThe billing group whose card is taken off, because attaching leaves it billing one subscription, whose own invoice the group card cannot pay. Null when the card is a subscription’s.
paymentMethodIdThe saved card that stops being charged
PublicSubscriptionAddonEligibilityResponse
eligibleTrue when the attach would be accepted as asked
Every refusal the attach would answer, one per problem
The saved cards the attach would stop charging. Attaching cannot be undone, and a removed card is not put back: the buyer adds one again through a card flow if they want it.
PublicAttachSubscriptionAddonsRequest
subscriptionIdsExisting subscriptions of the same customer to turn into add-ons of this one (1-19, each once). Each keeps its own id, plan and products, and from then on bills on this subscription’s invoice.
PublicAttachSubscriptionAddonsResponse
idCustomer subscription ID
customerIdCustomer ID
customerNameCustomer name
subscriptionNameSubscription name
startDateStart date (ISO 8601)
statusStatus of the customer subscription
currencyCurrency code (ISO 4217)
monthlyRevenueWhat the subscription bills per month today, as a decimal string, in currency, excluding VAT. Every billing interval is converted to one month: a quarter is divided by 3, half a year by 6, a year by 12, and weekly prices are multiplied by 52/12. Plan discounts, interval discounts and recurring surcharges are applied; one-off charges are not included. Add-ons are not included either: each add-on is its own subscription with its own monthlyRevenue, so adding up every subscription counts nothing twice, and the invoice a parent sends carries its own figure plus its add-ons’. Usage-based lines are left out, because their consumption is not known until the period closes: a metered line counts only through a prepaid commitment, or a fee its price charges at zero usage (see hasMeteredProducts, and GET /v1/subscriptions/{id}/usage for the usage recorded so far). A change scheduled for a later date shows from the day it takes effect. During a trial it is the price billing starts at. 0 for a subscription that has not started yet or has ended.
hasMeteredProductsWhether any product on the subscription is billed on a meter. When true, monthlyRevenue leaves the metered consumption out; read GET /v1/subscriptions/{id}/usage for the usage recorded so far in the current period.
billingDirectionBilling direction: ADVANCE bills at period start, ARREARS at period end
effectiveBillingDirectionEffective billing direction for the current period. Can differ from billingDirection if the direction was changed mid-period.
addonOfSubscriptionIdThe subscription this one is an add-on of, or null. An add-on bills on its parent’s invoice, inside the parent’s section, and ends when the parent is cancelled.
addonOfSubscriptionNameCurrent name of the subscription this one is an add-on of, or null when it is not an add-on.
The add-ons billed on this subscription’s invoice, inside its section. Empty when it has none, and always empty on an add-on — an add-on cannot have add-ons of its own.
The discount records the subscription references, in the order they apply, each as the record is now with the end date this subscription carries for it. Empty when it references none.
The products the subscription bills today, newest line first. A change scheduled for a later date is listed under GET /v1/subscriptions/{id}/scheduled-changes and appears here once it takes effect. An add-on’s products are on the add-on’s own subscription.
The saved cards the attach stopped charging. Empty when none was.
Entitlements currently granted by the subscription
planIdSubscription plan ID (null for ad-hoc subscriptions)
endDateEnd date (ISO 8601)
scheduledChurnDateScheduled churn date (ISO 8601). On an add-on this is its parent’s scheduled churn date: a scheduled cancellation of the parent ends every add-on with it.
trialDaysNumber of trial days granted
cancellationReasonReason provided when the subscription was cancelled
effectiveNextBillingDateThe date the NEXT invoice will be created (ISO 8601). This is an invoicing schedule marker, not a payment marker — it does not say what the customer has paid for; see paidThroughDate.
paidThroughDateThe date the subscription is paid through (ISO 8601): the first day not yet paid for. It is the end of the contiguous run of settled service periods starting at the earliest billed period, so an unpaid period caps it rather than being skipped. Null when the earliest billed period is not settled (or nothing is billed yet). Payment timing never shifts this backwards: a late payment settles exactly the period its invoice stated.
commitmentEndDateEnd date of the customer commitment period (ISO 8601)
originalStartDateOriginal start date from source system for migrated subscriptions (ISO 8601)
paymentMethodIdAssigned payment method ID
automaticBillingWhether automatic billing is enabled
allowedPaymentProvidersThe connected card provider the buyer may pay this subscription with - at most one. Empty means card payment is off. A subscription needs it before the buyer can add a first card through POST /v1/checkout/subscriptions/{id}/card-window, which otherwise answers 400 SUBSCRIPTION_MANAGE_PROVIDER_NOT_ALLOWED. It allows card payment and attaches no card: the buyer still enters the card themselves. Two providers of the same kind answer 400 INVOICE_MULTIPLE_CARD_PROVIDERS.
partnerReferenceIdYour reconciliation reference (the clientReferenceId you passed at embedded-checkout bind time), echoed back so you can match this subscription to your order. Null for any subscription not created through a partner-bound checkout.
billingGroupIdThe billing group this subscription is billed together with others on, or null when it bills on its own. A grouped subscription is billed on the group’s document and charged on the group’s card, so its own paymentMethodId is null and automaticBilling is false. A subscription that merely has other subscriptions billed as part of its own section is not grouped: it reports null and keeps its own card. So does one that IS such a section. A subscription that has joined a group but not yet reached its first shared billing date already reports the group.
PublicCreateSubscriptionAddonRequest
planIdSubscription plan ID the add-on is created from
Optional quantity and price overrides for products in the add-on’s plan
cadenceHow often the add-on bills, as <interval>-<count> (month-1, month-3, year-1). Omit to bill at the plan’s own cadence. Any other value must be one of the plan’s alternative cadences; one the plan does not offer is refused with 400 SHARED_VALIDATION_FAILED, details.reason = ADDON_CADENCE_NOT_ON_PLAN. An add-on on a shorter cadence than its parent bills its cycles on the parent’s invoice between the parent’s own billing dates.
startDateStart date (ISO 8601) — when the customer gets the add-on. Defaults to today. The add-on bills on the parent’s invoices, on cycles that break on the parent’s billing dates walked back to this start: an add-on on the parent’s cadence that starts on one of the parent’s billing dates (today included) bills its first full period from that date.
prorationBehaviorHow to handle a partial period from startDate to the add-on’s first full cycle on the parent’s grid
PublicUpdateSubscriptionRequest
paymentMethodIdThe card linked to the subscription. Send null to remove it. You may also echo back the card already linked (a no-op, so a full-object round-trip works), but you cannot attach or change to a different card - cards are attached by the buyer with their consent, so any value other than the currently-linked card or null is rejected with a 400.
automaticBillingWhether to automatically charge the saved card during billing
allowedPaymentProvidersThe connected card provider the buyer may pay this subscription with - at most one. Empty means card payment is off. A subscription needs it before the buyer can add a first card through POST /v1/checkout/subscriptions/{id}/card-window, which otherwise answers 400 SUBSCRIPTION_MANAGE_PROVIDER_NOT_ALLOWED. It allows card payment and attaches no card: the buyer still enters the card themselves. Two providers of the same kind answer 400 INVOICE_MULTIPLE_CARD_PROVIDERS.
PublicBillingGroupEligibilityRequest
modeform asks whether leadSubscriptionId and memberSubscriptionIds could form a group; join asks whether subscriptionIds could join billingGroupId.
leadSubscriptionIdform: the subscription whose terms the group would take.
memberSubscriptionIdsform: the subscriptions that would join, 0 to 19. Omitted or empty asks whether the lead could lead a group at all.
billingGroupIdjoin: the group to join.
subscriptionIdsjoin: the subscriptions that would join, 1 to 19.
PublicBillingGroupRefusal
codeThe error code the write would answer with.
subscriptionIdThe subscription the refusal is about, or null for a refusal about the whole set (the member limit, a dissolved group).
PublicBillingGroupEligibilityResponse
eligibleTrue when the write would be accepted today.
Every refusal, at most one per subscription plus at most one about the set. Empty when eligible. A subscription refused for two reasons reports the first; the second appears once the first is fixed.
PublicFormBillingGroupRequest
leadSubscriptionIdThe subscription whose terms the group takes: its next billing date becomes the group's billing date, and its payment terms, invoice delivery and send offset are written onto every member. Not repeated in memberSubscriptionIds.
memberSubscriptionIdsThe other subscriptions of the same customer that join the group: 1 to 19, distinct, none already in a group. A group uses at most 20 slots: one for the lead, one for each member, and one for each add-on any of them brings along.
invoiceTemplateIdA consolidated document template for the shared invoice. Omitted or null uses the customer's, then your default.
includeMemberDetailsPdfAttach a zip with one detail document per member to each send. Defaults to false.
PublicBillingGroupAddon
subscriptionIdAn add-on of the member it is listed under: its own subscription, whose lines bill inside that member's section of the shared invoice. The same stable id every subscription endpoint takes.
subscriptionNameThe add-on subscription's current name.
planIdThe plan the add-on runs on, or null for an ad-hoc subscription.
addedOnThe day the add-on was attached to its member (YYYY-MM-DD).
effectiveNextBillingDateThe add-on's next billing date (YYYY-MM-DD), or null when it no longer bills. It bills on its member's invoice on that date, on its own cadence.
monthlyRevenueThe add-on's own monthly recurring revenue, as a decimal string. Not included in its member's.
currencyCurrency code (ISO 4217). The same as its member’s.
PublicBillingGroupMemberRef
subscriptionIdThe subscription, by its stable id.
The subscription's add-ons, which came into the group with it and bill inside its section. Empty when it has none.
PublicFormBillingGroupResponse
billingGroupIdThe new group.
billingActiveFromThe day the set starts billing together (YYYY-MM-DD).
leadSubscriptionIdThe subscription whose terms the group took, echoed from the request.
Every member, the lead included, each with the add-ons it brought into the group.
PublicBillingGroupMember
subscriptionIdOne of the subscriptions billed together on the group’s document — the same stable id every subscription endpoint takes.
subscriptionNameThe subscription's current name.
billingActiveFromThe day this member starts billing on the group's shared invoice (YYYY-MM-DD). Ahead of today for a member that has joined and still bills on its own until then.
monthlyRevenueThe member's own monthly recurring revenue, as a decimal string. The group has no revenue of its own; sum the members.
currencyCurrency code (ISO 4217). Every member of a group shares one.
The member's add-ons, oldest first: subscriptions whose lines bill inside this member's section of the shared invoice. Each holds one of the group’s slots. Empty when it has none.
effectiveNextBillingDateThe member's next billing date (YYYY-MM-DD), or null when it no longer bills.
PublicBillingGroup
idBilling group id
customerIdThe one customer every member belongs to.
billingActiveFromThe day the group started, or starts, billing as a set (YYYY-MM-DD).
billsTogetherTrue while two or more subscriptions hold a place in the group, including one that starts billing on it later. False once the group has dissolved or only one subscription is left in it: members is then empty, the remaining subscription bills on its own invoice, and the group answers here only because an invoice or credit note names it.
billsTogetherUntilWhen the group stopped billing its subscriptions together (ISO 8601): when it dissolved, or otherwise when the last subscription to leave it left. Null while billsTogether is true. Turning a member into another member’s add-on records no date, so a group that stopped billing together that way reports the last departure before it, or null when none left.
slotsUsedThe slots the group uses: one per member and one per add-on listed under a member. This is what maxSlots caps, so adding a subscription that carries add-ons uses one slot for it and one for each add-on. Zero when billsTogether is false.
maxSlotsThe most slots a group can use, add-ons included.
chargesByCardTrue when the next shared invoice is charged to the group's card rather than sent for bank payment. The card is the group's; members hold none of their own.
includeMemberDetailsPdfWhether each send also attaches a zip with one detail document per member.
The subscriptions billed together on the group’s document, ordered by the day they start billing on the group and then by id, each with its add-ons. Holds at least two while billsTogether is true, and is empty when it is false.
dissolvedAtWhen the group dissolved (ISO 8601), or null while the group row stands. A dissolved group keeps answering here because the invoices it issued still name it.
invoiceTemplateIdThe consolidated document template the shared invoice renders from, or null to use the customer's, then your default.
PublicAddBillingGroupMembersRequest
subscriptionIdsSubscriptions of the group's customer that join it: 1 to 19, distinct, none already in a group. The group's billing date does not move; each joiner is moved onto it.
PublicAddBillingGroupMembersResponse
billingGroupIdThe group joined.
billingActiveFromThe day the joiners start billing on the group's invoice (YYYY-MM-DD).
The subscriptions that joined, each with the add-ons it brought into the group.
PublicRemoveBillingGroupMemberResponse
billingGroupIdThe group the subscription left.
subscriptionIdThe subscription that left, by its stable id.
groupDissolvedTrue when this departure left fewer than two subscriptions billing together, so the group ended: the remaining subscription bills on its own document from its next billing date.
CheckoutReadinessStripeConnect
connectedWhether an active Stripe Connect account backs the card rail.
statusThe connected account’s status, when one exists.
settlementCurrencySettlement currency of the connected account.
allowCrossCurrencyChargesWhether cross-currency charges are enabled on your Stripe account.
chargeableCurrenciesCatalogue currencies that pass the charge predicate — a card step offered in any other currency would be refused.
CheckoutReadinessResponse
subscriptionLicenseWhether you hold the Subscription license — without it nothing is checkoutable.
publishedPlansNumber of published plans.
checkoutablePlansNumber of published plans with a sellable item — checkoutable on this surface.
generalTermsPublishedInformational, never a gate: whether published GENERAL terms exist in LedgerBee. When true, quote and session responses carry them and confirm records per-version acceptance evidence; when false, you host your own terms and confirm records your acceptance assertion.
embeddableOriginsThe configured embeddableOrigins allowlist — required for HOSTED card windows’ returnUrl.
CheckoutQuantitySelection
priceIdThe snapshot price id the quantity applies to.
quantityThe buyer-chosen quantity. Clamped to the card’s quantity rules server-side.
CheckoutAddonSelection
planIdThe add-on plan the buyer takes: one of the catalogue item’s addons[].planId. An id the item does not offer is refused with PORTAL_CHECKOUT_ADDON_NOT_OFFERED (details.reason: NOT_ON_CARD, NO_CADENCE_AT_CARD_PERIOD or CURRENCY_UNAVAILABLE; details.planId names the add-on).
Buyer-chosen quantities for the add-on’s quantity-bearing products, keyed by the add-on’s own snapshot price ids. They follow the add-on’s own quantity rules (the quote’s addonQuantityRows lists them, matched on planId) and are clamped to those rules server-side. Absent or empty → the add-on’s default quantities.
CheckoutQuoteRequest
planVersionIdThe plan version to quote (from the catalogue).
planItemIdThe pricing-card item on that version.
countryBuyer country, ISO 3166-1 alpha-2 — REQUIRED so VAT resolves exactly.
customerTypeWhether the buyer is a business or a private person.
vatNumberThe buyer’s VAT number (BUSINESS only — refused otherwise).
startDateRequested start date (YYYY-MM-DD). Defaults to today; never in the past.
currencyPresentment currency (ISO 4217). Must be in the card’s availableCurrencies; refused with PORTAL_CHECKOUT_CURRENCY_NOT_AVAILABLE otherwise. Absent → the card’s own currency.
Buyer-chosen quantities for quantity-bearing products.
Add-ons the buyer takes with the plan, each named by the catalogue item’s addons[].planId, with optional quantities. An add-on checkout sells bills at the plan’s period, on the same invoice as the plan. The same planId twice is refused with VALIDATION_FAILED. Absent or empty → the plan alone.
discountCodeA discount code the buyer typed. Priced onto the first period (quote.discount states what it takes off, until when, and whether the first period is charged to the card) and attached to the subscription for its periods. An unknown, used-up or inapplicable code is refused with its DISCOUNT_* code; each request naming a code spends one use of the API key’s code-attempt budget (429 DISCOUNT_CHECK_RATE_LIMITED).
billingDirectionWhether the subscription bills each period in advance or in arrears. advance: the first period is invoiced on firstInvoiceDate, which is at confirm for a start date of today. arrears: nothing is invoiced at confirm, and the first invoice comes when the first period ends (firstInvoiceDate). Absent → the company’s default billing direction. The session pins the direction; confirm creates the subscription in it.
languageLanguage for display texts, terms and the disclosure.
CheckoutQuoteResponse
quoteFirst-period quote — the SAME payload the hosted portal renders (display parity is structural): plan title/description + display lines, pricing (subtotal, per-rate VAT breakdown, total, currency), quantity rows, the quantity rows of every add-on the card offers (addonQuantityRows, each naming its add-on by planId; addonSubscriptionId carries the same value), terms bodies, the resolved start date, allowed payment methods and cardPaymentsEnabled. With a discountCode, discount states what the code takes off the first period before VAT (firstPeriodAmountOff), the day the regular price starts (endsAt, null when it never ends) and whether the discounted first period is charged to the card (firstPeriodChargedToCard); plan.items keep the regular price and pricing is net of the discount. Null without a code.
firstPeriodChargeableFalse when the first period nets to zero (free trial / 100% discount), when a discount code takes it below what a card can be charged while the regular price is not, or when the subscription bills in arrears (its first invoice is charged to the saved card on firstInvoiceDate). The card window still opens save-only — the card is stored for the first real charge and nothing is authorized ("no charge today"). A first invoice a discount code takes below the card minimum is then paid by bank transfer and the card is charged from the first full-price period; in arrears the first invoice is charged to the saved card on firstInvoiceDate.
billingDirectionThe direction the subscription would bill in: the request’s billingDirection, else the company’s default.
firstInvoiceDateThe day the first invoice is issued (YYYY-MM-DD). advance: today for a start date of today, or the start date less the company’s send offset for a later one. arrears: the end of the first period. The first invoice bills the first period quote.pricing states.
CheckoutBuyer
customerTypeWhether the buyer is a business or a private person.
nameCompany name (BUSINESS) or the person’s full name (PRIVATE_PERSON).
emailThe buyer’s identity email: consent evidence is recorded against it and the self-service manage link is sent to it.
customerGroupIdREQUIRED: one of your customer groups, for classifying the created customer. Discover valid groups via GET /v1/customers/groups. Unknown ids are refused with PORTAL_CHECKOUT_CUSTOMER_GROUP_INVALID.
countryBuyer country, ISO 3166-1 alpha-2 — drives VAT resolution.
vatNumberThe buyer’s VAT number (BUSINESS only — refused otherwise). Checked against the country’s published format; registry (VIES) verification is not performed.
addressBilling address line.
postalCodeBilling postal code.
cityBilling city.
billingEmailWhere invoices, receipts and payment notices are sent when it differs from the buyer’s identity email. Absent → the identity email receives them.
existingCustomerIdAn EXISTING customer this purchase belongs to, so a returning buyer keeps one record instead of accumulating duplicates. Reuse is authorized at confirm: the buyer’s email must already hold the customer (or nobody may).
CheckoutSessionRequest
planVersionIdThe plan version to check out (from the catalogue).
planItemIdThe pricing-card item on that version.
The buyer — plain request data; no tokens, no ceremony.
startDateRequested start date (YYYY-MM-DD). Defaults to today; never in the past.
currencyPresentment currency (ISO 4217); must be in the card’s availableCurrencies.
Buyer-chosen quantities.
Add-ons the buyer takes with the plan, each named by the catalogue item’s addons[].planId, with optional quantities. An add-on checkout sells bills at the plan’s period, on the same invoice as the plan. The same planId twice is refused with VALIDATION_FAILED. Absent or empty → the plan alone. The session pins the selection; confirm sells exactly what was pinned.
discountCodeA discount code the buyer typed. Priced onto the first period (quote.discount states what it takes off, until when, and whether the first period is charged to the card) and attached to the subscription for its periods. An unknown, used-up or inapplicable code is refused with its DISCOUNT_* code; each request naming a code spends one use of the API key’s code-attempt budget (429 DISCOUNT_CHECK_RATE_LIMITED).
billingDirectionWhether the subscription bills each period in advance or in arrears. advance: the first period is invoiced on firstInvoiceDate, which is at confirm for a start date of today. arrears: nothing is invoiced at confirm, and the first invoice comes when the first period ends (firstInvoiceDate). Absent → the company’s default billing direction. The session pins the direction; confirm creates the subscription in it.
expiresInMinutesSession TTL in minutes. Default 30.
referenceYour own order/cart id (Stripe client_reference_id parity) — echoed on session reads, the confirm response and every checkout.* webhook payload.
languageLanguage for display texts, terms and the disclosure.
CheckoutPinnedAddon
planIdThe add-on plan (catalogue addons[].planId).
The quantities the mint request named for this add-on. Empty → it bills at its default quantities.
CheckoutPinned
currencyPinned presentment currency (ISO 4217).
netMajorPinned first-period net, in major units.
totalGrossMajorPinned first-period total (gross where VAT resolved), in major units. Confirm re-runs the billing engine against the pinned inputs and refuses a different output with PORTAL_CHECKOUT_AUTHORIZED_AMOUNT_CHANGED.
startDatePinned start date (YYYY-MM-DD).
disclosureVersionPinned recurring-billing disclosure version.
disclosureTextThe server-rendered recurring-billing disclosure text for the pinned version — render it (or your own equivalent) before the buyer accepts recurring billing.
acceptedTermsVersionIdsThe terms version ids pinned at mint. Acceptance evidence is written against exactly these; a terms republish mid-session makes confirm refuse with a 410 — re-mint the session.
expiresInMinutesThe session TTL that was applied, in minutes.
The add-ons the session pinned, as the mint request named them, each with the quantities it was sent with. Empty when the plan is sold alone. Confirm creates exactly these, billed at the plan’s period on the plan’s invoice.
discountCodeThe discount code the session pinned, as the mint request sent it; null when none was applied. The card window and confirm judge it again: a code that ran out since the mint is refused there with its DISCOUNT_* code and nothing is created.
billingDirectionThe billing direction the session pinned: the mint request’s billingDirection, else the company’s default at mint. Confirm creates the subscription in it, whatever the company default says by then.
firstInvoiceDateThe day the first invoice is issued (YYYY-MM-DD), as the quote states it for the pinned direction. Confirm creates the subscription with the send offset this date was computed from, whatever the company setting says by then.
CheckoutSessionResponse
sessionIdThe opaque session id — your handle for every later call.
expiresAtWhen the session expires (ISO 8601). Expired sessions answer 410.
referenceYour reference, echoed.
quoteThe same first-period quote payload POST /v1/checkout/quote returns.
What the session pinned — render exactly this.
firstPeriodChargeableFalse when the pinned first period nets to zero, when a discount code takes it below what a card can be charged, or when the session bills in arrears (save-only card window).
CheckoutSessionView
sessionIdThe opaque session id.
expiresAtWhen the session expires (ISO 8601).
referenceYour reference, echoed.
planVersionIdThe pinned plan version.
planItemIdThe pinned pricing-card item.
buyerThe buyer payload the session was minted with.
firstPeriodChargeableFalse when the pinned first period nets to zero, when a discount code takes it below what a card can be charged, or when the session bills in arrears.
cardWindowOpenedWhether a card window has been opened on this session.
CheckoutCardWindowRequest
uiModeHow the buyer meets Stripe's card form: 'embedded' (default) returns a client secret you mount on your page with Stripe.js; 'hosted' returns a redirect URL to checkout.stripe.com.
returnUrlWhere Stripe sends the buyer back after a HOSTED window. REQUIRED for hosted (its origin must be on your embeddableOrigins allowlist); refused for embedded, which completes in-page.
CheckoutCardWindowResponse
modeSTRIPE_EMBEDDED → mount with clientSecret; REDIRECT → navigate the buyer to redirectUrl.
handoffTokenThe card handoff token. It outlives the session: carry it into a fresh session’s confirm after an expiry and the buyer never re-enters card details.
expiresAtWhen the provider window expires (ISO 8601).
clientSecretStripe embedded Checkout client secret (STRIPE_EMBEDDED only).
publishableKeyPublishable key for Stripe.js (STRIPE_EMBEDDED only).
stripeAccountIdThe connected Stripe account id for Stripe.js (STRIPE_EMBEDDED only).
redirectUrlThe hosted window URL to send the buyer to (REDIRECT only).
CheckoutCardDisplay
labelReady-to-render label.
cardTypeCard network/brand, if known.
cardMaskMasked card number, if known.
accountIdentifierMasked identifier for non-card methods (e.g. a Link email).
CheckoutCardStatusResponse
statusPENDING: keep polling (or listen for checkout.card_ready). CARD_READY: confirm may proceed. EXPIRED: the window lapsed — open a fresh one.
cardThe captured card (CARD_READY only).
CheckoutCardReleaseResponse
statusSAVE_ONLY: the card survives — re-quote, re-mint and confirm; the first charge is sized at billing. RECAPTURE_REQUIRED: discard the card and open a fresh window.
CheckoutConfirmRequest
sessionIdThe session to confirm. Single-use: consumed whatever the outcome.
paymentMethodThe payment rail the buyer chose.
termsAcceptedYour assertion that the buyer accepted the pinned terms on your surface. Must be true — false/absent refuses with PORTAL_CHECKOUT_CONSENT_REQUIRED.
acceptedAtWhen the buyer accepted (ISO 8601). Evidence, not authority — implausible instants (future, or older than an hour) are replaced with the server’s own clock.
recurringConsentAcceptedYour assertion that the buyer accepted recurring billing. REQUIRED true on the CARD rail.
cardHandoffTokenA card handoff token carried from an EXPIRED session (the edit-after-card loop) — the captured card survives into this confirm. Defaults to the card window this session opened.
CheckoutConfirmResponse
subscriptionIdThe created subscription.
referenceYour reference, echoed.
billingPendingTrue when the first invoice is billed asynchronously after this response (INVOICE rail, and CARD confirms whose charge is queued). Listen for subscription.billed / poll the subscription.
PublicCheckoutVouchPrefill
customerTypeBUSINESS or PRIVATE_PERSON.
companyNameCompany name, for a BUSINESS buyer.
firstNamelastNamevatNumberaddresspostalCodecitycountryCodeISO 3166-1 alpha-2.
PublicMintCheckoutVouchRequest
emailThe buyer you are vouching for. This becomes their portal login identity, so the embedded checkout pre-fills it and LOCKS it — a buyer who is not this person uses the checkout's own escape rather than typing over it, and a confirm carrying a different address is refused. Distinct from contactEmail below, which is only where the paperwork goes.
contactEmailWhere invoices and receipts should go, when that differs from the login identity above. Written to the customer's default contact. Omit and billing follows email.
customerIdA customer you already hold the LedgerBee id for - typically one whose earlier subscription ended and who is now buying again. The purchase lands on that record instead of a second one, so a returning buyer does not accumulate duplicates. The customer must exist, be active, and belong to the API key's tenant; otherwise the mint returns 404 CUSTOMER_NOT_FOUND and nothing is minted.
This does not make the checkout read-only: the Details step still shows only what you prefilled, never the stored record, and whatever the buyer submits is written over the record at confirm. Omit for a first-time buyer - creating the customer at confirm is the default.
Optional starting values for the checkout Details step. Every field stays EDITABLE — this is a convenience for the buyer, never an assertion of fact, and whatever they submit is what we persist. Anything you omit renders empty.
allowIdentityChangeWhether the buyer may reject the vouched identity and continue as an anonymous buyer (the checkout shows a "Not you?" escape). It does NOT let them type a different address - the vouch is dropped and the checkout restarts unvouched, because we cannot vouch for someone we were not told about. Defaults to true: a buyer who genuinely is not the person you named has no other way out, and stranding them is worse than showing a link. Set false when your authentication makes a wrong identity impossible.
clientReferenceIdYour own opaque reference for this order (Stripe client_reference_id parity). It rides onto the created subscription (as partnerReferenceId), into every later subscription webhook, AND onto the customer.created event — which is the only field that maps a brand-new customer back to the cart that created it. Pass it. Server-to-server only; it never reaches a client/iframe surface. Max 200 chars, [A-Za-z0-9_-] only.
discountCodeA discount code to apply for this buyer, matched without regard to case or surrounding spaces. It is checked when you mint: a code that is unknown, switched off, expired, for another customer or with no use left is refused with its DISCOUNT_* code, and spends one use of the code-attempt budget this API key shares with the cart check and code lookup (429 DISCOUNT_CHECK_RATE_LIMITED). The embedded checkout then opens with the code applied to the plan the buyer picks; the buyer can remove it. A code that does not cover that plan, or has run out by then, is left off and the regular price shown.
PublicMintCheckoutVouchResponse
checkoutVouchTokenOpaque, single-use, 60-second vouch reference. Return it from your page's fetchBindToken provider at checkout-start; the embedded checkout redeems it server-side. Mint it just-in-time — the TTL is deliberately shorter than a page's lifetime, and the provider is re-invoked per checkout.
expiresAtISO 8601 expiry of the reference above.
DefaultContactDto
nameContact name
emailContact email
phoneContact phone number
CreateCustomerRequestDto
customerTypeSpecifies whether the customer is a business or a private person
nameCustomer name
vatZoneVAT zone classification
customerGroupIdCustomer group ID
countryCodeTwo-letter country code
customerNumberUnique customer number. Omit it, or send an empty value, to have the next number assigned from the company customer sequence.
emailEmail address
phonePhone number
addressStreet address
cityCity
postalCodePostal code
vatNumberVAT registration number
eanNumberEAN/GLN number for Peppol routing
externalSystemIdExternal system identifier for tracking the customer across other systems. Unique per company.
websiteWebsite URL
notesAdditional notes
localeLocale for formatting invoice data
languageLanguage code for communications
creditLimitCredit limit
openingBalanceOpening balance in the company base currency, seeding receivables that predate LedgerBee. Signed: positive = the customer owes us, negative = a credit position. Folds into the entity balance only (not into invoiced totals or overdue ageing).
paymentTermsPayment terms in days
paymentTermTypePayment term type. Defaults to NET_DAYS.
defaultCashAccountIdDefault cash payment account ID. Only relevant for CASH payment terms. Send null to clear.
defaultCurrency^[A-Za-z]{3}$The customer's default invoicing currency, ISO 4217 alpha-3. Omit it, or send a blank one, to leave the answer to the server.
poNumberDefault purchase-order number ("PO-nr.") prefilled onto sales documents
ourReferenceDefault "Vores ref." (our-side reference) prefilled onto sales documents
invoiceDeliveryTypePreferencePreferred invoice delivery type for this customer. If set, overrides the app company default for billing.
reminderConfigIdReminder config profile ID. Send null to clear.
followsDefaultReminderConfigThe customer follows the company's default reminder profile: whichever profile is marked default when a reminder is due. A specific reminderConfigId wins over it, and setting one clears this. With neither, the customer gets no reminders.
isActiveWhether the customer is active
Default contact to create for the customer. If not provided, customer name/email/phone will be used as fallback.
invoiceTemplateIdInvoice PDF template override
creditNoteTemplateIdCredit note PDF template override
quoteTemplateIdQuote PDF template override
orderConfirmationTemplateIdOrder confirmation PDF template override
parentInvoiceTemplateIdParent single invoice PDF template override. Send null to clear.
includeChildDetailsPdfWhether to attach a zip of per-child detail PDFs when sending consolidated invoices
selfServiceDetailsEnabledWhether this customer's portal users may fill in their own billing details (VAT number, street, postal code, city), both on the portal's Company settings page and during checkout, instead of only confirming a read-only copy of the record. Country and customer type stay operator-owned either way, which is what keeps them inside the VAT regime the operator assigned.
parentCustomerIdParent customer ID. Send null to clear.
billingRelationshipBilling relationship
consolidationModeConsolidation mode. Send null to clear.
billingDayBilling day (1-28). Required for single invoice mode. Send null to clear.
Key-value metadata to attach to the customer
PublicProvisionCustomerRequest
emailEmail of the portal user to grant access to. A credential-less portal user is created if none exists.
customerIdThe customer's LedgerBee id. The customer must already exist in the API key's tenant; this endpoint never creates one from an id (a 404 CUSTOMER_NOT_FOUND is returned if it doesn't). Supply either customerId or a customer payload.
A customer to upsert, identified idempotently by its customerNumber: an existing customer of the API key's tenant with that number is reused, otherwise a new one is created with this payload. Same shape as the gated POST /customers request (so vatZone and countryCode are required here). If customer.email is omitted, the portal-user email below is used as the customer's contact email (and its auto-created default contact). Supply either this or customerId.
roleMembership role to grant. Defaults to USER; the org's first member is force-assigned OWNER regardless.
userNameDisplay name of the portal user (set on first creation).
organizationDisplayNameDisplay name for the customer organization (first-invite bootstrap).
mintHandoffWhen true, also mint a back-channel handoff reference in the same call (one round-trip "Go to portal"). Requires the API key to ALSO carry the portal-sso-mint scope, and the tenant to have back-channel handoff enabled.
subThe partner's stable, unique user identifier — required when mintHandoff is true; keys the handoff identity (with the per-tenant handoff issuer).
mintCheckoutBindTokenWhen true, also mint a one-time CHECKOUT-BIND reference in the same call — an opaque token the partner's fetchBindToken provider returns to the embed at checkout-start so the embedded checkout subscribes directly against THIS customer instead of staging an anonymous magic-link signup. Requires the API key to ALSO carry the portal-sso-mint scope. Independent of mintHandoff (login): a checkout-bind ref can never mint a login session.
clientReferenceIdYour own opaque reference for this order (Stripe client_reference_id parity), e.g. your internal order or cart id. It rides the minted checkout-bind ref onto the resulting subscription (as partnerReferenceId) and into every later subscription webhook, so you can reconcile our subscription to your record. Server-to-server only — it never reaches a client/iframe surface. Max 200 chars, [A-Za-z0-9_-] only.
PublicProvisionCustomerResponse
customerIdResolved customer id.
customerCreatedWhether a new customer was created (false = an existing one was reused).
portalUserIdResolved portal user id.
membershipIdThe active organization membership id.
roleThe granted membership role.
handoffRefOpaque, single-use, 60s handoff reference — present only when mintHandoff was requested. Null otherwise.
handoffExpiresAtISO-8601 expiry of the handoff reference, when minted. Null otherwise.
checkoutBindTokenOpaque, single-use, 60s checkout-bind reference — present only when mintCheckoutBindToken was requested. Null otherwise. The partner's fetchBindToken provider returns this to the embed at checkout-start; the embedded checkout redeems it to subscribe directly against this customer.
checkoutBindExpiresAtISO-8601 expiry of the checkout-bind reference, when minted. Null otherwise.
PublicResolvePortalPlansRequest
customerTypeBuyer customer type for gross-price resolution.
vatNumberBuyer VAT number for gross-price resolution. Accepted only with customerType: 'BUSINESS' (a coded 400 otherwise). Requires a country hint to have any effect. On the resolve read it is ignored when customerId is supplied — a customer-backed resolve stays net-only.
currencyPresentment currency for every card's pricing. Must be in each card's availableCurrencies; cards that can't resolve it render null prices. Defaults to each card's own currency.
customerIdThe buyer's LedgerBee customer id (an identity HANDLE — the server hydrates customer group / country / type from it; raw rule attributes are never accepted). The customer must exist in the API key's tenant (a 404 CUSTOMER_NOT_FOUND otherwise). When present, the server-resolved identity wins and the countryCode/customerType hints are ignored.
buyerEmailThe specific person (their email) the partner is acting on behalf of under customerId — e.g. the user currently signed in on the partner's site. Bound into the catalog token: when that token is later exchanged for a portal login handoff, THIS person is logged in (or bootstrapped credential-less under the customer's organization), instead of the customer's contact email / first member. Ignored without customerId; does not affect catalog visibility.
countryCodeISO 3166-1 alpha-2 country hint for the no-customer-yet preview (drives the country rule clause). Ignored when customerId is supplied.
planIdsResolve only these plan ids. Omit to resolve every ACTIVE plan of the tenant. Each must be a uuid.
languageLanguage the resolved cards are localized to. Defaults to en.
discountCodeA discount code a buyer typed. Each SUBSCRIPTION card then carries discount: the code priced for that card's first period exactly as the checkout quote prices it (the first invoice before VAT with the code, firstPeriodNetMinor; what the code takes off it, firstPeriodAmountOffMinor; and the day the regular price starts, endsAt). A card the code cannot price carries discount: null. A code that is unknown, used up or not for this buyer is refused with its DISCOUNT_* code. A request naming a code spends one use of the code-attempt budget this API key shares with the checkout quote, the session and the discount cart check. Without it, or with a code of spaces alone, no card carries discount. With customerId, that customer's own uses of the code count against its per-customer limit.
PublicPortalPlanItemFeature
labelTranslated label, resolved for the request language.
iconKeyOptional Lu* icon key picked by the operator; null = default check icon.
PublicPortalPricingTier
fromQuantityFirst quantity covered by this tier.
toQuantityLast quantity in this tier; null for the final unbounded tier.
unitAmountMinorPer-unit amount in minor units; null when not set for this tier.
flatFeeMinorFlat fee for the tier in minor units; null when not set.
PublicPortalPlanItemProduct
priceIdSnapshot price id — stable identity / render key.
labelProduct display name (frozen product name, falling back to the price nickname).
descriptionOperator-authored product description; null when unset.
quantityTemplate quantity bundled in the plan. Defaults to 1 when unset.
pricingModelPricing model: 'flat_rate' | 'graduated' | 'package' | 'volume'.
kind'RECURRING' for period-billed lines, 'ONE_OFF' for one-time charges, 'METERED' for usage lines. A METERED line is period-bound like a recurring one, but its priceMinor is a rate per unit consumed rather than a period amount, so it contributes nothing to a period total.
unitPriceMinorHeadline unit price in minor units (first-unit "from" price for tiered models); null when unresolvable.
currencyCurrency code for unitPriceMinor.
tieredTrue for tiered models — the card prefixes the price with a "from" marker.
Tier ladder for tiered models, resolved for the currency (minor units). Empty for flat_rate products.
billingIntervalRecurring interval (e.g. 'month'); null for one-time charges.
billingIntervalCountInterval count (e.g. 1, 3, 12); null for one-time charges.
PublicPortalPlanItemVat
resolvedWhether VAT resolved for the supplied buyer hints. false = every gross field below is null.
grossPriceMinorGross headline price (minor units) for the active cadence; null when unresolved.
Gross per cadence, mirroring cadencePrices. Empty object when unresolved.
grossOneTimeMinorGross one-time charges total (minor units), mirroring oneTimeMinor; null when unresolved.
PublicPortalPlanItemAddon
planIdThe add-on's plan id — send it back as addons[].planId on the checkout quote and session to pick the add-on.
sourceSubscriptionIdThe same value as planId, kept for compatibility. New integrations read planId.
namedescriptionpriceMinorRecurring price per period, minor units, net. Null when not flat-rate (metered / tiered).
cadenceKeyThe cadence key the price is for — the card's canonical one.
oneTimeMinorOne-time charges on the first invoice, minor units, net.
PublicPortalPlanItemDiscount
codeThe code as the company wrote it.
nameThe discount's name.
typeHow the discount is measured: a share of the price, an amount per period, or an amount per unit.
firstPeriodNetMinorThe card's first invoice with the code, before VAT, in minor units of the card's currency. One-time charges on that invoice are included.
firstPeriodAmountOffMinorWhat the code takes off that invoice, before VAT, in minor units of the card's currency. Positive; 0 when the code touches none of the card's lines.
endsAtYYYY-MM-DD: a period that starts on or after this day is billed at the regular price, for a checkout that starts today. Null when the discount has no end.
durationInPeriodsHow many billing periods the discount lasts; null when it has no end.
PublicPortalPlanItem
iditemTypeCard kind: 'SUBSCRIPTION' (priced card, CTA starts checkout) or 'CUSTOM_CTA' (subscription-less card whose CTA navigates ctaLink).
sourceSubscriptionIdSource subscription id (the chosen template, sent back on signup); null for CUSTOM_CTA items.
ctaLinkLink the CTA navigates to (https / relative / mailto: / tel:); non-null only for CUSTOM_CTA items.
ctaPresetKeyCTA preset ('contactUs' | 'bookDemo' | 'scheduleTime'); null for subscription cards or unmatched labels.
displayOrderplanNamePlan name (operator-edited title, language-resolved, falling back to the snapshot name).
descriptionShort pitch (language-resolved).
Bullet list; each entry is a plain string or a { label, iconKey } object, already resolved per language.
isMostPopularWhether to render the "recommended" treatment.
ctaLabelCTA copy; null falls back to the SPA default getStarted label.
titleColorOptional inline title color override (any CSS color).
ctaColorOptional inline CTA color override (any CSS color).
planIconKeyOperator-picked glyph key for the plan-card header icon.
planIconColorOptional inline override for the plan-card header icon color.
hidePlanIconWhen true, the card renders without the header icon.
featureIconColorOptional inline override for every feature-bullet icon color.
currencyCurrency code for priceMinor / oneTimeMinor.
availableCurrenciesCurrencies this card can be presented (and sold) in — the intersection across recurring products and allowed cadences of the currencies every price resolves for. For SUBSCRIPTION items it always contains currency; a requested checkout currency outside this set is a coded 400. CUSTOM_CTA items carry no pricing, so theirs is empty (and currency is '').
priceMinorHeadline price in minor units; null when no canonical recurring price exists.
cadenceKeyCadence key driving priceMinor (e.g. 'month-1'); null when priceMinor is null.
allowedCadencesCadences this item supports (drives the row-level cadence selector); empty when none is recoverable.
defaultCadenceCadence selected on first render; null when no cadence is recoverable for this item.
Price in minor units keyed by cadence; a present key with a null value is allowed-but-unpriced (renders as em-dash).
oneTimeMinorOne-time charges total in minor units (setup fees); null = no one-time line.
Products bundled in this tier (ACTIVE cadence). null for CUSTOM_CTA items; [] for a subscription tier with no products.
Product composition resolved per cadence, keyed by cadence; {} for CUSTOM_CTA items.
Buyer-specific VAT projection. resolved=false (all gross fields null) when the read carried no buyer hints, a rate could not be resolved, or the buyer zone is OSS-overridable — net figures stay authoritative either way.
Add-on plans a buyer may take with this card, priced at the card's canonical cadence in its presented currency. [] for CUSTOM_CTA items and cards with none.
discountThe discountCode the read named, priced for this card's first period exactly as the checkout quote prices it. Present only when the read named a code; null on a card the code cannot price (a CUSTOM_CTA card, or a discount with no amount in the card's currency).
PublicPortalComparisonCell
kindCell kind.
valueCell text; present only when kind is 'text'.
PublicPortalComparisonRow
labelOperator-authored row label (language-resolved).
Per-item presence keyed by plan item id.
PublicPortalComparisonSection
titleOperator-authored section heading (language-resolved).
PublicPortalComparison
PublicPortalPlan
idplanVersionIdPublished portal_plan_version id — the version pinned for checkout when the buyer clicked "Get started".
vanityPublic vanity slug (the /embed/
titleCustomer-facing title, language-resolved (en → da fallback); null when the operator entered none.
descriptionOperator-authored summary, same language fallback as title.
cardStyleCard style; null falls back to variant1 client-side.
displayedCadencesPlan-level cadence allow-list driving the row selector; null/empty falls back to the union of item cadences.
defaultDisplayedCadencePinned default for the row cadence selector; must be a member of displayedCadences. Null falls back to the first entry.
comparisonOperator-authored comparison matrix (columns are plan.items); null when none authored.
PublicPortalCatalogEntry
displayOrderOperator-controlled ordering inside the catalogue. Lower first.
isLegacyForVisitorTrue when the visitor holds an active subscription to this plan AND the plan is archived. Returned as false in v1.
checkoutableWhether a checkout of this plan can currently complete (its terms containers resolve to published versions). Buyer-facing projections filter on it; the tenant projection annotates without filtering, so plans needing operator attention stay visible.
PublicResolvePortalPlansDiagnostics
activePlansConsideredACTIVE plans the resolve considered (before any gate).
tenantHasNoVisibilityRulesTrue when the tenant has configured NO visibility rules at all — resolution is fail-closed (default hidden), so with no rules every plan drops. The fix is publishing a SHOW rule, not a hidden default.
droppedByVisibilityPlans dropped because no rule made them visible to this buyer.
droppedByCheckoutablePlans dropped because their terms do not currently resolve (not checkout-able).
PublicResolvePortalPlansResponse
The plans visible AND checkout-able to the resolved buyer, each carrying the full card content the partner renders. Non-public (gated) plans appear here when the buyer matches their rule.
catalogTokenOpaque, reusable, read-only load-time catalog token (43-char base64url). The partner returns it to each embed iframe via its fetchCatalogToken provider; the iframe presents it as a Bearer token to the by-id pricing-card / checkout-document reads. Scoped to the resolved buyer + the returned plans — replay yields only the same already-authorized cards. Treat it as a client secret (TLS-only, never log, never put on a URL).
expiresAtISO-8601 expiry of the catalog token.
Why plans were (or were not) returned — the "why is my catalogue empty" answer.
PublicPortalPlansListResponse
Every ACTIVE plan with a PUBLISHED version in the API key's tenant, projected as its canonical native card and ordered by display order. This is the integrator's full catalogue — NOT filtered by any per-visitor visibility rule and NOT run through the plan-routing rule engine — though a plan whose every card references a retired/archived subscription template is omitted (nothing renderable or sellable remains). Each entry carries the full card content the integrator renders.
PublicPortalPlanResponse
A single plan projected as its canonical native card. Returns 404 PORTAL_PLAN_NOT_FOUND when the plan id is unknown to the API key's tenant, has no published version, or every card on the published version references a retired/archived subscription template (nothing renderable or sellable remains) — never filtered by visibility rules or the rule engine.
PublicPortalSsoJwks
The published public JWK(s). Public key material only — never any private component.
PublicHandoffMembership
customerIdThe id of the customer (the GET /v1/customers resource) this user belongs to. The portal organization is resolved from it server-side — created automatically on first login if it doesn't exist yet — and a customer that doesn't belong to the API key's tenant is rejected.
roleRole to grant within that organization. One of OWNER, ADMIN, BILLING_ADMIN, USER. Unknown roles are rejected.
primaryMarks this membership as the organization the user is signed into for this session. When more than one membership is asserted, EXACTLY ONE must be primary (otherwise the mint is rejected with a 400). With a single membership it is the implied sign-in organization, so the flag is optional.
PublicHandoffMintRequest
emailEmail of the partner-provisioned user. Links a first-time SSO login to an existing invited customer-portal user.
subThe partner's stable, unique identifier for the user. Keyed together with the per-tenant handoff issuer to resolve the portal user across logins.
At least one customer membership to grant this user — required. The customer's portal organization (an opaque internal container) and the membership are created automatically server-side at redeem, so a prior provision call is NOT needed; you only ever reference customers, never organizations. Validated at mint: a customerId that isn't a customer of the API key's tenant, or an unknown role, is rejected with a 400 (rather than failing the user's browser redirect). A handoff with no membership can't establish a portal session, so an empty/omitted array is rejected here rather than minting a ref that would fail at redeem.
nameDisplay name of the user; used to populate the customer-portal user's name on first login.
PublicHandoffMintResponse
refOpaque, single-use, short-TTL reference. Carries NO identity — the identity lives only in server-side storage keyed by this reference until it is redeemed once at the customer portal.
expiresAtISO-8601 timestamp after which the reference can no longer be redeemed (60 seconds after minting).
PublicRevokeSessionsRequest
subThe partner's stable subject id for the user — the same sub used when minting their handoff. Every active portal session of that user is force-refreshed.
PublicRevokeSessionsResponse
revokedNumber of memberships whose sessions were force-refreshed (0 when the user has no active sessions).
VatCodeResponse
idThe unique identifier of the VAT code
vatCodeVAT code identifier
nameName/description of the VAT code
vatRateVAT rate percentage
typeWhat the code is for: which side of the VAT return it reports on and how the VAT is posted. Every type belongs to exactly one group, reported as group.
principleVAT principle - Gross (VAT included) or Net (VAT excluded)
groupThe group the type belongs to, which the VAT-code form shows above the type: output for sales, input for purchases, reverse_charge for purchases where the buyer accounts for the VAT. Membership by type — output: Output/sales, Domestic without VAT, Sales to other EU countries, Sales of services to other EU countries, Foreign sales to non-EU countries, Sales of products EU country-specific, Sales of services EU country-specific; input: Input/purchase; reverse_charge: Purchased products/abroad, Purchased services/abroad, Purchased products/domestic (reverse charge), Purchased products EU - Rubrik A, Purchased services EU - Rubrik A. The group follows from the type on every read and is not accepted on create or update: choose the type, and the group is set. Null when the stored type is one this version does not name.
countryCountry the code is specific to (ISO 3166-1 alpha-2) on the country-specific EU sales types; null on every other type
accountToBookIdThe ledger account ID to book VAT to
accountToBookNumberThe ledger account number to book VAT to
accountToBookNameThe ledger account name to book VAT to
contraAccountToBookIdThe contra account ID for VAT entries
contraAccountToBookNumberThe contra account number for VAT entries
contraAccountToBookNameThe contra account name for VAT entries
CreateVatCodeRequest
vatCodeShort code, unique within the company
nameName of the VAT code
vatRateVAT rate in percent. A rate above 0 and below 1 is refused (VAT_CODE_RATE_FRACTION), and so is 100 itself (VAT_CODE_RATE_HUNDRED).
typeWhat the code is for: which side of the VAT return it reports on and how the VAT is posted
accountToBookIdAccount the VAT amount is booked to; one of the company's accounts
principleGross when the amount on a line includes VAT, Net when VAT is added on top. Each type demands one principle (Net on the reverse-charge types, Gross on the rest); omitted, it follows the type.
contraAccountToBookIdAccount the offsetting VAT amount is booked to. Required on the reverse-charge types, which post the VAT on both sides. Null clears it.
countryCountry (ISO 3166-1 alpha-2) on the country-specific EU sales types, where it is required; refused on every other type. Null clears it.
UpdateVatCodeRequest
principleGross when the amount on a line includes VAT, Net when VAT is added on top. Each type demands one principle (Net on the reverse-charge types, Gross on the rest); omitted, it follows the type.
contraAccountToBookIdAccount the offsetting VAT amount is booked to. Required on the reverse-charge types, which post the VAT on both sides. Null clears it.
countryCountry (ISO 3166-1 alpha-2) on the country-specific EU sales types, where it is required; refused on every other type. Null clears it.
vatCodeShort code, unique within the company
nameName of the VAT code
vatRateVAT rate in percent. A rate above 0 and below 1 is refused (VAT_CODE_RATE_FRACTION), and so is 100 itself (VAT_CODE_RATE_HUNDRED) unless the code already holds that rate.
typeWhat the code is for. A new type carries its own principle unless one is stated.
accountToBookIdAccount the VAT amount is booked to; one of the company's accounts
VendorGroupResponse
idThe unique identifier of the vendor group
nameName of the vendor group
descriptionDescription of the vendor group
defaultAccountIdDefault ledger account ID
VendorDepartmentResponse
idThe unique identifier of the department
nameName of the department
isDefaultWhether this is the default department for the vendor
isActiveWhether the department is active
poNumberPurchase order number
eanNumberEAN number for e-invoicing
addressStreet address
cityCity
postalCodePostal code
countryCodeTwo-letter country code (ISO 3166-1 alpha-2)
VendorContactResponse
idThe unique identifier of the contact
nameName of the contact
isDefaultForVendorWhether this is the default contact for the vendor
emailEmail address
phonePhone number
VendorResponse
idThe unique identifier of the vendor
vendorNumberVendor number
nameName of the vendor
vendorGroupIdVendor group ID
currencyCurrency code
statusVendor status
vendorGroupNameVendor group name
emailEmail address
phonePhone number
addressStreet address
cityCity
postalCodePostal code
countryCodeTwo-letter country code (ISO 3166-1 alpha-2)
vatNumberVAT registration number
attentionAttention field
paymentTermsPayment terms in days
openingBalanceOpening balance in the company base currency (signed: positive = we owe the vendor)
Key-value metadata attached to the vendor
PublicListVendorsResponse
Vendors on this page
totalTotal vendors matching the query
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 (1-indexed).
totalPagesDeprecated: page with nextCursor instead. Total pages.
CreateVendorContactRequest
nameContact name
isDefaultWhether this is the default contact for the vendor
emailEmail address
phonePhone number
CreateVendorRequest
vendorNumberUnique vendor number
nameVendor name
vendorGroupIdVendor group ID
currency^[A-Za-z]{3}$ · requiredThe currency this vendor bills us in, ISO 4217 alpha-3.
countryCodeTwo-letter country code
Contacts for the vendor. At least one contact with isDefault: true is required.
emailEmail address
phonePhone number
addressStreet address
cityCity
postalCodePostal code
vatNumberVAT registration number
attentionAttention field
paymentTermsPayment terms in days
openingBalanceOpening balance in the company base currency, seeding payables that predate LedgerBee. Signed: positive = we owe the vendor, negative = a credit position.
defaultAccountIdDefault ledger account ID
Key-value metadata to attach to the vendor. At most 50 entries; keys up to 128 characters, string values up to 500 characters. Read it back, or filter on it, through the list endpoint.
CreateVendorResponse
idThe unique identifier of the created vendor
vendorNumberVendor number
SupplierGroupResponse
idThe unique identifier of the supplier group
nameName of the supplier group
descriptionDescription of the supplier group
defaultAccountIdDefault ledger account ID
SupplierDepartmentResponse
idThe unique identifier of the department
nameName of the department
isDefaultWhether this is the default department for the supplier
isActiveWhether the department is active
poNumberPurchase order number
eanNumberEAN number for e-invoicing
addressStreet address
cityCity
postalCodePostal code
countryCodeTwo-letter country code (ISO 3166-1 alpha-2)
SupplierContactResponse
idThe unique identifier of the contact
nameName of the contact
isDefaultForSupplierWhether this is the default contact for the supplier
emailEmail address
phonePhone number
SupplierResponse
idThe unique identifier of the supplier
supplierNumberSupplier number
nameName of the supplier
supplierGroupIdSupplier group ID
currencyCurrency code
statusSupplier status
supplierGroupNameSupplier group name
emailEmail address
phonePhone number
addressStreet address
cityCity
postalCodePostal code
countryCodeTwo-letter country code (ISO 3166-1 alpha-2)
vatNumberVAT registration number
attentionAttention field
paymentTermsPayment terms in days
openingBalanceOpening balance in the company base currency (signed: positive = we owe the supplier)
Key-value metadata attached to the supplier
PublicListSuppliersResponse
Suppliers on this page
totalTotal suppliers matching the query
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 (1-indexed).
totalPagesDeprecated: page with nextCursor instead. Total pages.
CreateSupplierContactRequest
nameContact name
isDefaultWhether this is the default contact for the supplier
emailEmail address
phonePhone number
CreateSupplierRequest
supplierNumberUnique supplier number
nameSupplier name
supplierGroupIdSupplier group ID
currency^[A-Za-z]{3}$ · requiredThe currency this supplier bills us in, ISO 4217 alpha-3.
countryCodeTwo-letter country code
Contacts for the supplier. At least one contact with isDefault: true is required.
emailEmail address
phonePhone number
addressStreet address
cityCity
postalCodePostal code
vatNumberVAT registration number
attentionAttention field
paymentTermsPayment terms in days
openingBalanceOpening balance in the company base currency, seeding payables that predate LedgerBee. Signed: positive = we owe the supplier, negative = a credit position.
defaultAccountIdDefault ledger account ID
Key-value metadata to attach to the supplier. At most 50 entries; keys up to 128 characters, string values up to 500 characters. Read it back, or filter on it, through the list endpoint.
CreateSupplierResponse
idThe unique identifier of the created supplier
supplierNumberSupplier number
CreateWebhookEndpointRequest
urlThe HTTPS URL events are delivered to. Must be a public https URL (loopback/private/link-local hosts are rejected).
enabledEventsThe events to subscribe to. Must contain at least one known event type.
Available events:
subscription.assigned— Fired when a subscription is assigned to a customer (may be future-dated / upcoming).subscription.started— Fired when a subscription becomes active — grant entitlement/access on this event, not on assigned.subscription.updated— Fired when a config property changes without a structural transition (e.g. name, payment method, billing direction).subscription.transitioned— Fired on a structural change: plan replace, product edit, billing cadence change, phase change, or realign.subscription.paused— Fired when a subscription is paused.subscription.resumed— Fired when a subscription resumes from a pause.subscription.trial_ended— Fired when a subscription trial ends. The payload outcome says whether billing begins (ACTIVE) or the subscription was held for a missing payment card (PAUSED).subscription.cancellation_scheduled— Fired when a future cancellation is scheduled for a subscription (still active until then).subscription.cancellation_cleared— Fired when a previously scheduled cancellation is cleared.subscription.churned— Fired when a subscription is cancelled/finalized — revoke entitlement on this event.subscription.billed— Fired once per subscription that billed onto an invoice — one per child on a parent-paid consolidated invoice, one per member on a billing-group invoice. amount is always the whole document total; deduplicate on invoiceId, attribute on billingGroupId, never sum amount across events.subscription.billing_held— Fired when a billing run holds an invoice instead of issuing it, because it is below the minimum invoice amount or below the smallest amount the subscription's card can be charged: nothing is invoiced or charged, and the held periods are added to the subscription's next invoice. One event per subscription with a period on the held invoice.subscription.payment_succeeded— Fired when a card charge for the subscription clears — the success pair of the charge_failed error signal. On a billing-group card charge one event fires per member, each carrying the full charged amount and the shared billingGroupId.subscription.error— Fired when a delivery/processing problem occurs for a subscription (e.g. undeliverable recipient).billing.invoice_sent— Fired when an invoice document is sent to the customer.billing.credit_note_sent— Fired when a credit note document is sent to the customer.billing.invoice_updated— Fired when an invoice is changed, in the app or through the API alike: its fields, its lines or their order, or its status. A draft scheduled or cancelled fires it, and so does an invoice reaching sent once it is delivered, beside billing.invoice_sent. A save that changes nothing fires nothing; changedFields names what moved.billing.invoice_deleted— Fired when a draft invoice is deleted, in the app or through the API alike. Only drafts can be deleted; a sent invoice is corrected with a credit note instead.billing.invoice_paid— Fired when a customer invoice becomes paid in full: by payments, by a settlement, or by a credit note applied to it. Only the invoice fires it — the credit note it was settled against does not, and neither does a reminder fee or an advance. A partial payment fires nothing. An invoice reopened (a payment reverted) and paid again fires again. Invoices brought in by an import do not fire it.customer.created— Fired when a customer is created (payload flags whether it was a portal self-signup).card.added— Fired when a card is successfully saved for a customer (provider-opaque).card.removed— Fired when a saved card is removed in-app or cancelled at the provider.card.updated— Fired when a saved card’s details change (network auto-update or refresh).card.expiring— Fired when a saved card is approaching expiry.card.expired— Fired when a saved card is observed to have expired.card.default_changed— Fired when the customer’s default card changes (explicit or auto-default).card.backup_changed— Fired when the customer’s designated backup card is set, replaced, or cleared.card.add_failed— Fired when a card-save attempt fails (decline or authentication failure).quote.sent— Fired when a quote is sent to the customer.quote.converted— Fired when a quote is converted into an order confirmation or an invoice.order_confirmation.sent— Fired when an order confirmation is sent to the customer.order_confirmation.converted— Fired when an order confirmation is converted into an invoice.checkout.card_ready— Fired when the buyer's card lands on a checkout session's card window — confirm may proceed. The card-status poll remains authoritative.checkout.card_failed— Fired when a checkout card window closes without a card (the provider window expired mid-capture) — open a fresh window to retry.checkout.session_expired— Fired when a checkout session expires unconsumed — the abandoned-checkout signal.project.created— Fired when a project is created (payload carries the owned dimension id for correlation with the dimensions API).project.updated— Fired when a project's fields are updated (payload lists the changed field names). Also fires on un-archive.project.archived— Fired when a project is archived (its dimension is deactivated; postings history is preserved).stock.balance_changed— Fired for every stock movement that changes sellable stock, carrying the position's on-hand after it — the signal a sales channel republishes availability on.shipment.dispatched— Fired when a shipment leaves the warehouse and its cost of goods sold posts.shipment.cancelled— Fired when a DISPATCHED shipment is cancelled and its posting unwound. Cancelling a draft moves nothing and fires nothing.flow.tap— Fired when a flow tap this endpoint is named on fires: once per document, carrying the tap id, the optional subject and body the tap was written with, and the object the step declares for that outcome when the tap attaches it (otherwise null). Subscribing makes the endpoint available to taps; it receives only the taps that name it.agent.message— Fired when an agent's Post block that names this endpoint posts: once per message that reaches the block, carrying the agent, the run, the post's title and text, and the message's structured content. Subscribing makes the endpoint available to Post blocks; it receives only the posts of the blocks that name it.
descriptionOptional human-facing description.
WebhookEndpointWithSecret
idUnique identifier of the webhook endpoint.
urlThe HTTPS URL events are delivered to.
enabledEventsThe events this endpoint is subscribed to. An event is delivered to every enabled endpoint subscribed to its type.
Available events:
subscription.assigned— Fired when a subscription is assigned to a customer (may be future-dated / upcoming).subscription.started— Fired when a subscription becomes active — grant entitlement/access on this event, not on assigned.subscription.updated— Fired when a config property changes without a structural transition (e.g. name, payment method, billing direction).subscription.transitioned— Fired on a structural change: plan replace, product edit, billing cadence change, phase change, or realign.subscription.paused— Fired when a subscription is paused.subscription.resumed— Fired when a subscription resumes from a pause.subscription.trial_ended— Fired when a subscription trial ends. The payload outcome says whether billing begins (ACTIVE) or the subscription was held for a missing payment card (PAUSED).subscription.cancellation_scheduled— Fired when a future cancellation is scheduled for a subscription (still active until then).subscription.cancellation_cleared— Fired when a previously scheduled cancellation is cleared.subscription.churned— Fired when a subscription is cancelled/finalized — revoke entitlement on this event.subscription.billed— Fired once per subscription that billed onto an invoice — one per child on a parent-paid consolidated invoice, one per member on a billing-group invoice. amount is always the whole document total; deduplicate on invoiceId, attribute on billingGroupId, never sum amount across events.subscription.billing_held— Fired when a billing run holds an invoice instead of issuing it, because it is below the minimum invoice amount or below the smallest amount the subscription's card can be charged: nothing is invoiced or charged, and the held periods are added to the subscription's next invoice. One event per subscription with a period on the held invoice.subscription.payment_succeeded— Fired when a card charge for the subscription clears — the success pair of the charge_failed error signal. On a billing-group card charge one event fires per member, each carrying the full charged amount and the shared billingGroupId.subscription.error— Fired when a delivery/processing problem occurs for a subscription (e.g. undeliverable recipient).billing.invoice_sent— Fired when an invoice document is sent to the customer.billing.credit_note_sent— Fired when a credit note document is sent to the customer.billing.invoice_updated— Fired when an invoice is changed, in the app or through the API alike: its fields, its lines or their order, or its status. A draft scheduled or cancelled fires it, and so does an invoice reaching sent once it is delivered, beside billing.invoice_sent. A save that changes nothing fires nothing; changedFields names what moved.billing.invoice_deleted— Fired when a draft invoice is deleted, in the app or through the API alike. Only drafts can be deleted; a sent invoice is corrected with a credit note instead.billing.invoice_paid— Fired when a customer invoice becomes paid in full: by payments, by a settlement, or by a credit note applied to it. Only the invoice fires it — the credit note it was settled against does not, and neither does a reminder fee or an advance. A partial payment fires nothing. An invoice reopened (a payment reverted) and paid again fires again. Invoices brought in by an import do not fire it.customer.created— Fired when a customer is created (payload flags whether it was a portal self-signup).card.added— Fired when a card is successfully saved for a customer (provider-opaque).card.removed— Fired when a saved card is removed in-app or cancelled at the provider.card.updated— Fired when a saved card’s details change (network auto-update or refresh).card.expiring— Fired when a saved card is approaching expiry.card.expired— Fired when a saved card is observed to have expired.card.default_changed— Fired when the customer’s default card changes (explicit or auto-default).card.backup_changed— Fired when the customer’s designated backup card is set, replaced, or cleared.card.add_failed— Fired when a card-save attempt fails (decline or authentication failure).quote.sent— Fired when a quote is sent to the customer.quote.converted— Fired when a quote is converted into an order confirmation or an invoice.order_confirmation.sent— Fired when an order confirmation is sent to the customer.order_confirmation.converted— Fired when an order confirmation is converted into an invoice.checkout.card_ready— Fired when the buyer's card lands on a checkout session's card window — confirm may proceed. The card-status poll remains authoritative.checkout.card_failed— Fired when a checkout card window closes without a card (the provider window expired mid-capture) — open a fresh window to retry.checkout.session_expired— Fired when a checkout session expires unconsumed — the abandoned-checkout signal.project.created— Fired when a project is created (payload carries the owned dimension id for correlation with the dimensions API).project.updated— Fired when a project's fields are updated (payload lists the changed field names). Also fires on un-archive.project.archived— Fired when a project is archived (its dimension is deactivated; postings history is preserved).stock.balance_changed— Fired for every stock movement that changes sellable stock, carrying the position's on-hand after it — the signal a sales channel republishes availability on.shipment.dispatched— Fired when a shipment leaves the warehouse and its cost of goods sold posts.shipment.cancelled— Fired when a DISPATCHED shipment is cancelled and its posting unwound. Cancelling a draft moves nothing and fires nothing.flow.tap— Fired when a flow tap this endpoint is named on fires: once per document, carrying the tap id, the optional subject and body the tap was written with, and the object the step declares for that outcome when the tap attaches it (otherwise null). Subscribing makes the endpoint available to taps; it receives only the taps that name it.agent.message— Fired when an agent's Post block that names this endpoint posts: once per message that reaches the block, carrying the agent, the run, the post's title and text, and the message's structured content. Subscribing makes the endpoint available to Post blocks; it receives only the posts of the blocks that name it.
statusDelivery status. disabled endpoints are retained but receive no events.
createdAtISO 8601 creation timestamp.
updatedAtISO 8601 last-update timestamp.
secretThe signing secret (shown only on create and roll-secret). Used to verify the webhook-signature header.
descriptionOptional human-facing description of what this endpoint is used for.
WebhookEndpoint
idUnique identifier of the webhook endpoint.
urlThe HTTPS URL events are delivered to.
enabledEventsThe events this endpoint is subscribed to. An event is delivered to every enabled endpoint subscribed to its type.
Available events:
subscription.assigned— Fired when a subscription is assigned to a customer (may be future-dated / upcoming).subscription.started— Fired when a subscription becomes active — grant entitlement/access on this event, not on assigned.subscription.updated— Fired when a config property changes without a structural transition (e.g. name, payment method, billing direction).subscription.transitioned— Fired on a structural change: plan replace, product edit, billing cadence change, phase change, or realign.subscription.paused— Fired when a subscription is paused.subscription.resumed— Fired when a subscription resumes from a pause.subscription.trial_ended— Fired when a subscription trial ends. The payload outcome says whether billing begins (ACTIVE) or the subscription was held for a missing payment card (PAUSED).subscription.cancellation_scheduled— Fired when a future cancellation is scheduled for a subscription (still active until then).subscription.cancellation_cleared— Fired when a previously scheduled cancellation is cleared.subscription.churned— Fired when a subscription is cancelled/finalized — revoke entitlement on this event.subscription.billed— Fired once per subscription that billed onto an invoice — one per child on a parent-paid consolidated invoice, one per member on a billing-group invoice. amount is always the whole document total; deduplicate on invoiceId, attribute on billingGroupId, never sum amount across events.subscription.billing_held— Fired when a billing run holds an invoice instead of issuing it, because it is below the minimum invoice amount or below the smallest amount the subscription's card can be charged: nothing is invoiced or charged, and the held periods are added to the subscription's next invoice. One event per subscription with a period on the held invoice.subscription.payment_succeeded— Fired when a card charge for the subscription clears — the success pair of the charge_failed error signal. On a billing-group card charge one event fires per member, each carrying the full charged amount and the shared billingGroupId.subscription.error— Fired when a delivery/processing problem occurs for a subscription (e.g. undeliverable recipient).billing.invoice_sent— Fired when an invoice document is sent to the customer.billing.credit_note_sent— Fired when a credit note document is sent to the customer.billing.invoice_updated— Fired when an invoice is changed, in the app or through the API alike: its fields, its lines or their order, or its status. A draft scheduled or cancelled fires it, and so does an invoice reaching sent once it is delivered, beside billing.invoice_sent. A save that changes nothing fires nothing; changedFields names what moved.billing.invoice_deleted— Fired when a draft invoice is deleted, in the app or through the API alike. Only drafts can be deleted; a sent invoice is corrected with a credit note instead.billing.invoice_paid— Fired when a customer invoice becomes paid in full: by payments, by a settlement, or by a credit note applied to it. Only the invoice fires it — the credit note it was settled against does not, and neither does a reminder fee or an advance. A partial payment fires nothing. An invoice reopened (a payment reverted) and paid again fires again. Invoices brought in by an import do not fire it.customer.created— Fired when a customer is created (payload flags whether it was a portal self-signup).card.added— Fired when a card is successfully saved for a customer (provider-opaque).card.removed— Fired when a saved card is removed in-app or cancelled at the provider.card.updated— Fired when a saved card’s details change (network auto-update or refresh).card.expiring— Fired when a saved card is approaching expiry.card.expired— Fired when a saved card is observed to have expired.card.default_changed— Fired when the customer’s default card changes (explicit or auto-default).card.backup_changed— Fired when the customer’s designated backup card is set, replaced, or cleared.card.add_failed— Fired when a card-save attempt fails (decline or authentication failure).quote.sent— Fired when a quote is sent to the customer.quote.converted— Fired when a quote is converted into an order confirmation or an invoice.order_confirmation.sent— Fired when an order confirmation is sent to the customer.order_confirmation.converted— Fired when an order confirmation is converted into an invoice.checkout.card_ready— Fired when the buyer's card lands on a checkout session's card window — confirm may proceed. The card-status poll remains authoritative.checkout.card_failed— Fired when a checkout card window closes without a card (the provider window expired mid-capture) — open a fresh window to retry.checkout.session_expired— Fired when a checkout session expires unconsumed — the abandoned-checkout signal.project.created— Fired when a project is created (payload carries the owned dimension id for correlation with the dimensions API).project.updated— Fired when a project's fields are updated (payload lists the changed field names). Also fires on un-archive.project.archived— Fired when a project is archived (its dimension is deactivated; postings history is preserved).stock.balance_changed— Fired for every stock movement that changes sellable stock, carrying the position's on-hand after it — the signal a sales channel republishes availability on.shipment.dispatched— Fired when a shipment leaves the warehouse and its cost of goods sold posts.shipment.cancelled— Fired when a DISPATCHED shipment is cancelled and its posting unwound. Cancelling a draft moves nothing and fires nothing.flow.tap— Fired when a flow tap this endpoint is named on fires: once per document, carrying the tap id, the optional subject and body the tap was written with, and the object the step declares for that outcome when the tap attaches it (otherwise null). Subscribing makes the endpoint available to taps; it receives only the taps that name it.agent.message— Fired when an agent's Post block that names this endpoint posts: once per message that reaches the block, carrying the agent, the run, the post's title and text, and the message's structured content. Subscribing makes the endpoint available to Post blocks; it receives only the posts of the blocks that name it.
statusDelivery status. disabled endpoints are retained but receive no events.
createdAtISO 8601 creation timestamp.
updatedAtISO 8601 last-update timestamp.
descriptionOptional human-facing description of what this endpoint is used for.
WebhookEndpointList
totalTotal number of endpoints matching the query.
pageCurrent page (1-based).
pageSizePage size.
UpdateWebhookEndpointRequest
urlNew HTTPS delivery URL.
enabledEventsReplace the full set of subscribed events.
Available events:
subscription.assigned— Fired when a subscription is assigned to a customer (may be future-dated / upcoming).subscription.started— Fired when a subscription becomes active — grant entitlement/access on this event, not on assigned.subscription.updated— Fired when a config property changes without a structural transition (e.g. name, payment method, billing direction).subscription.transitioned— Fired on a structural change: plan replace, product edit, billing cadence change, phase change, or realign.subscription.paused— Fired when a subscription is paused.subscription.resumed— Fired when a subscription resumes from a pause.subscription.trial_ended— Fired when a subscription trial ends. The payload outcome says whether billing begins (ACTIVE) or the subscription was held for a missing payment card (PAUSED).subscription.cancellation_scheduled— Fired when a future cancellation is scheduled for a subscription (still active until then).subscription.cancellation_cleared— Fired when a previously scheduled cancellation is cleared.subscription.churned— Fired when a subscription is cancelled/finalized — revoke entitlement on this event.subscription.billed— Fired once per subscription that billed onto an invoice — one per child on a parent-paid consolidated invoice, one per member on a billing-group invoice. amount is always the whole document total; deduplicate on invoiceId, attribute on billingGroupId, never sum amount across events.subscription.billing_held— Fired when a billing run holds an invoice instead of issuing it, because it is below the minimum invoice amount or below the smallest amount the subscription's card can be charged: nothing is invoiced or charged, and the held periods are added to the subscription's next invoice. One event per subscription with a period on the held invoice.subscription.payment_succeeded— Fired when a card charge for the subscription clears — the success pair of the charge_failed error signal. On a billing-group card charge one event fires per member, each carrying the full charged amount and the shared billingGroupId.subscription.error— Fired when a delivery/processing problem occurs for a subscription (e.g. undeliverable recipient).billing.invoice_sent— Fired when an invoice document is sent to the customer.billing.credit_note_sent— Fired when a credit note document is sent to the customer.billing.invoice_updated— Fired when an invoice is changed, in the app or through the API alike: its fields, its lines or their order, or its status. A draft scheduled or cancelled fires it, and so does an invoice reaching sent once it is delivered, beside billing.invoice_sent. A save that changes nothing fires nothing; changedFields names what moved.billing.invoice_deleted— Fired when a draft invoice is deleted, in the app or through the API alike. Only drafts can be deleted; a sent invoice is corrected with a credit note instead.billing.invoice_paid— Fired when a customer invoice becomes paid in full: by payments, by a settlement, or by a credit note applied to it. Only the invoice fires it — the credit note it was settled against does not, and neither does a reminder fee or an advance. A partial payment fires nothing. An invoice reopened (a payment reverted) and paid again fires again. Invoices brought in by an import do not fire it.customer.created— Fired when a customer is created (payload flags whether it was a portal self-signup).card.added— Fired when a card is successfully saved for a customer (provider-opaque).card.removed— Fired when a saved card is removed in-app or cancelled at the provider.card.updated— Fired when a saved card’s details change (network auto-update or refresh).card.expiring— Fired when a saved card is approaching expiry.card.expired— Fired when a saved card is observed to have expired.card.default_changed— Fired when the customer’s default card changes (explicit or auto-default).card.backup_changed— Fired when the customer’s designated backup card is set, replaced, or cleared.card.add_failed— Fired when a card-save attempt fails (decline or authentication failure).quote.sent— Fired when a quote is sent to the customer.quote.converted— Fired when a quote is converted into an order confirmation or an invoice.order_confirmation.sent— Fired when an order confirmation is sent to the customer.order_confirmation.converted— Fired when an order confirmation is converted into an invoice.checkout.card_ready— Fired when the buyer's card lands on a checkout session's card window — confirm may proceed. The card-status poll remains authoritative.checkout.card_failed— Fired when a checkout card window closes without a card (the provider window expired mid-capture) — open a fresh window to retry.checkout.session_expired— Fired when a checkout session expires unconsumed — the abandoned-checkout signal.project.created— Fired when a project is created (payload carries the owned dimension id for correlation with the dimensions API).project.updated— Fired when a project's fields are updated (payload lists the changed field names). Also fires on un-archive.project.archived— Fired when a project is archived (its dimension is deactivated; postings history is preserved).stock.balance_changed— Fired for every stock movement that changes sellable stock, carrying the position's on-hand after it — the signal a sales channel republishes availability on.shipment.dispatched— Fired when a shipment leaves the warehouse and its cost of goods sold posts.shipment.cancelled— Fired when a DISPATCHED shipment is cancelled and its posting unwound. Cancelling a draft moves nothing and fires nothing.flow.tap— Fired when a flow tap this endpoint is named on fires: once per document, carrying the tap id, the optional subject and body the tap was written with, and the object the step declares for that outcome when the tap attaches it (otherwise null). Subscribing makes the endpoint available to taps; it receives only the taps that name it.agent.message— Fired when an agent's Post block that names this endpoint posts: once per message that reaches the block, carrying the agent, the run, the post's title and text, and the message's structured content. Subscribing makes the endpoint available to Post blocks; it receives only the posts of the blocks that name it.
statusEnable or disable delivery without deleting the endpoint.
descriptionUpdate the description. Send null to clear it.
TestWebhookEndpointRequest
eventThe event type to simulate. Must be one of the endpoint’s subscribed events.
Available events:
subscription.assigned— Fired when a subscription is assigned to a customer (may be future-dated / upcoming).subscription.started— Fired when a subscription becomes active — grant entitlement/access on this event, not on assigned.subscription.updated— Fired when a config property changes without a structural transition (e.g. name, payment method, billing direction).subscription.transitioned— Fired on a structural change: plan replace, product edit, billing cadence change, phase change, or realign.subscription.paused— Fired when a subscription is paused.subscription.resumed— Fired when a subscription resumes from a pause.subscription.trial_ended— Fired when a subscription trial ends. The payload outcome says whether billing begins (ACTIVE) or the subscription was held for a missing payment card (PAUSED).subscription.cancellation_scheduled— Fired when a future cancellation is scheduled for a subscription (still active until then).subscription.cancellation_cleared— Fired when a previously scheduled cancellation is cleared.subscription.churned— Fired when a subscription is cancelled/finalized — revoke entitlement on this event.subscription.billed— Fired once per subscription that billed onto an invoice — one per child on a parent-paid consolidated invoice, one per member on a billing-group invoice. amount is always the whole document total; deduplicate on invoiceId, attribute on billingGroupId, never sum amount across events.subscription.billing_held— Fired when a billing run holds an invoice instead of issuing it, because it is below the minimum invoice amount or below the smallest amount the subscription's card can be charged: nothing is invoiced or charged, and the held periods are added to the subscription's next invoice. One event per subscription with a period on the held invoice.subscription.payment_succeeded— Fired when a card charge for the subscription clears — the success pair of the charge_failed error signal. On a billing-group card charge one event fires per member, each carrying the full charged amount and the shared billingGroupId.subscription.error— Fired when a delivery/processing problem occurs for a subscription (e.g. undeliverable recipient).billing.invoice_sent— Fired when an invoice document is sent to the customer.billing.credit_note_sent— Fired when a credit note document is sent to the customer.billing.invoice_updated— Fired when an invoice is changed, in the app or through the API alike: its fields, its lines or their order, or its status. A draft scheduled or cancelled fires it, and so does an invoice reaching sent once it is delivered, beside billing.invoice_sent. A save that changes nothing fires nothing; changedFields names what moved.billing.invoice_deleted— Fired when a draft invoice is deleted, in the app or through the API alike. Only drafts can be deleted; a sent invoice is corrected with a credit note instead.billing.invoice_paid— Fired when a customer invoice becomes paid in full: by payments, by a settlement, or by a credit note applied to it. Only the invoice fires it — the credit note it was settled against does not, and neither does a reminder fee or an advance. A partial payment fires nothing. An invoice reopened (a payment reverted) and paid again fires again. Invoices brought in by an import do not fire it.customer.created— Fired when a customer is created (payload flags whether it was a portal self-signup).card.added— Fired when a card is successfully saved for a customer (provider-opaque).card.removed— Fired when a saved card is removed in-app or cancelled at the provider.card.updated— Fired when a saved card’s details change (network auto-update or refresh).card.expiring— Fired when a saved card is approaching expiry.card.expired— Fired when a saved card is observed to have expired.card.default_changed— Fired when the customer’s default card changes (explicit or auto-default).card.backup_changed— Fired when the customer’s designated backup card is set, replaced, or cleared.card.add_failed— Fired when a card-save attempt fails (decline or authentication failure).quote.sent— Fired when a quote is sent to the customer.quote.converted— Fired when a quote is converted into an order confirmation or an invoice.order_confirmation.sent— Fired when an order confirmation is sent to the customer.order_confirmation.converted— Fired when an order confirmation is converted into an invoice.checkout.card_ready— Fired when the buyer's card lands on a checkout session's card window — confirm may proceed. The card-status poll remains authoritative.checkout.card_failed— Fired when a checkout card window closes without a card (the provider window expired mid-capture) — open a fresh window to retry.checkout.session_expired— Fired when a checkout session expires unconsumed — the abandoned-checkout signal.project.created— Fired when a project is created (payload carries the owned dimension id for correlation with the dimensions API).project.updated— Fired when a project's fields are updated (payload lists the changed field names). Also fires on un-archive.project.archived— Fired when a project is archived (its dimension is deactivated; postings history is preserved).stock.balance_changed— Fired for every stock movement that changes sellable stock, carrying the position's on-hand after it — the signal a sales channel republishes availability on.shipment.dispatched— Fired when a shipment leaves the warehouse and its cost of goods sold posts.shipment.cancelled— Fired when a DISPATCHED shipment is cancelled and its posting unwound. Cancelling a draft moves nothing and fires nothing.flow.tap— Fired when a flow tap this endpoint is named on fires: once per document, carrying the tap id, the optional subject and body the tap was written with, and the object the step declares for that outcome when the tap attaches it (otherwise null). Subscribing makes the endpoint available to taps; it receives only the taps that name it.agent.message— Fired when an agent's Post block that names this endpoint posts: once per message that reaches the block, carrying the agent, the run, the post's title and text, and the message's structured content. Subscribing makes the endpoint available to Post blocks; it receives only the posts of the blocks that name it.
TestWebhookEndpointResult
successWhether the endpoint responded with a 2xx status.
durationMsRound-trip time of the probe in milliseconds.
statusCodeHTTP status returned by the endpoint, or null on a transport error.
errorTransport/error message when the probe failed, otherwise null.
PublicCreateInvoiceLine
priceIdProduct price ID. Required on a billable line — the line bills this product. Omit only on a text / separator line (set lineType instead).
lineTypeSemantic type of the line. text (a description line) and separator (a blank line) bill nothing and need no price. discount and interval_discount are not accepted: a request has no field for the value a discount takes off.
descriptionCustom description for this line item
quantityQuantity. Required on a billable line; omit on a text / separator line.
unitPriceOne-time unit-price override (decimal string). Defaults to the price's current amount in the document currency when omitted. totalPrice and VAT are always computed server-side and must not be sent: totalPrice is quantity * unitPrice for a flat-rate price or an override, and what the price's tiers charge for the quantity on a volume, graduated or package price.
recognitionPeriodDaysOverride the revenue recognition period for this line (in days)
tagIdsDimension value IDs for this line (see GET /dimensions). When the account the line posts to requires a dimension (requiredDimensionIds on the account), the line must carry a value from it, here or in the invoice's own tagIds (which apply to every line), or the invoice cannot be sent: booking is refused with JOURNAL_TAG_REQUIRED_DIMENSION_MISSING.
discountIdsLine-scope discount records to apply to this line. Each id is a discount record (see GET /discounts). The order sent is the order they apply in. Each is checked for the line's product, the document's customer and the document date; a document converted from a quote is checked at the quote's date. A fixed or per-unit discount takes its amount in the document's currency: a discount with no amount in that currency is refused, never converted at an exchange rate. An update restates every line, so a line carries the ids sent with it: a line sent without discountIds has no line discounts. Refused with: DISCOUNT_NOT_APPLICABLE (no such discount in your company, inactive, not assigned to this product and customer, or outside its dates on the document date; details.reason says which), DISCOUNT_WRONG_SCOPE, DISCOUNT_REFERENCED_TWICE, DISCOUNT_NOT_COMBINABLE, DISCOUNT_NO_AMOUNT_IN_CURRENCY, DISCOUNT_LINE_WITHOUT_PRODUCT, DISCOUNT_EXCEEDS_LINE and DISCOUNT_EXCEEDS_DOCUMENT.
PublicCreateInvoice
customerIdCustomer ID this invoice is for. Required — every invoice must reference a customer (this mirrors the gated app, which also requires a customer).
dateInvoice date (ISO date, YYYY-MM-DD)
Invoice lines
customerDepartmentIdCustomer department ID (for EAN-based e-invoicing and address override)
customerContactIdCustomer contact ID (invoice recipient)
dueDateDue date for payment (ISO date). Derived from payment terms when omitted.
currencyCurrency code (ISO 4217). Defaults to the company default currency.
paymentTermsPayment terms in days
referenceReference / PO number ("PO-nr.")
ourReferenceOur reference ("Vores ref.")
descriptionInternal description for your own reference. Never printed on the PDF or shown to the customer: put text for the customer in subject and notes.
subjectHeading printed in bold on the PDF, directly above notes. The customer sees it on the document.
notesMessage printed on the PDF under subject. The customer sees it on the document.
tagIdsTag/Dimension value IDs to attach to the journal entry when this invoice is booked. A dimension value here applies to every line, and counts toward a dimension the line's account requires. Use the per-line tagIds for a dimension that differs between lines.
discountIdsDocument-scope discount records to apply once to the whole document, after every line discount, reducing the lines whose product each applies to (every line when it names no product). Each id is a discount record (see GET /discounts). The order sent is the order they apply in. Each is checked for the line's product, the document's customer and the document date; a document converted from a quote is checked at the quote's date. A fixed or per-unit discount takes its amount in the document's currency: a discount with no amount in that currency is refused, never converted at an exchange rate. One applies when it applies to the customer and to at least one line's product. Refused with: DISCOUNT_NOT_APPLICABLE (no such discount in your company, inactive, not assigned to this product and customer, or outside its dates on the document date; details.reason says which), DISCOUNT_WRONG_SCOPE, DISCOUNT_REFERENCED_TWICE, DISCOUNT_NOT_COMBINABLE, DISCOUNT_NO_AMOUNT_IN_CURRENCY, DISCOUNT_LINE_WITHOUT_PRODUCT, DISCOUNT_EXCEEDS_LINE and DISCOUNT_EXCEEDS_DOCUMENT.
discountCodesDiscount codes the customer gave, the same list sent to POST /discounts/check, matched without regard to case or surrounding spaces and applied after discountIds in the order sent. A code claims its discount, which then applies as if named by id, including one that applies only through a code: a line-scope discount lands on every line whose product it applies to, a document-scope one on the document. The code's own limit is counted when the invoice is booked, refused there with DISCOUNT_CODE_REDEMPTION_LIMIT_REACHED. A code naming a discount already named is applied once. Refused with: DISCOUNT_CODE_INVALID (empty, spaces or too long) and DISCOUNT_NOT_APPLICABLE with details.reason codeUnknown, codeInactive, codeExpired or codeCustomerMismatch and details.code, beside every refusal discountIds lists.
PublicAppliedLineDiscount
discountIdThe discount record the line referenced.
positionThe order the line applied its discounts in, from 0: the order they were sent.
nameThe discount's name when the line was priced.
typepercentagePctThe percent a percentage discount took. Null for other types.
originalDiscountAmountThe discount's amount in the document's currency: per eligible line for fixed, per unit for per unit. Null for a percentage.
originalReductionAmountWhat the discount took off the line, in the document's currency. Never negative.
codeThe code the discount was claimed through, as the code is written. Present only when a code claimed it.
PublicInvoiceLine
idLine item ID
quantityQuantity
unitPriceUnit price (decimal string)
totalPriceTotal price (decimal string)
subscriptionIdThe subscription this line was billed for. On an invoice that carries add-ons, an add-on’s lines name the add-on, not the parent the invoice is addressed to; on a billing group’s shared invoice, each line names the member it was billed for. Null on a line that belongs to no subscription, such as a line on a manually created invoice.
addonOfSubscriptionIdThe subscription this line’s subscription is an add-on of — the parent the add-on is billed with. Null on every line that is not an add-on’s.
tagIdsDimension value IDs this line carries. Empty when it carries none.
The discount records this line referenced, in the order they applied, with what each took off. Empty when it referenced none.
priceIdPrice ID this line references
descriptionCustom description for this line item
lineTypeSemantic line type
vatAmountVAT amount (decimal string)
vatRateVAT rate percentage (decimal string)
PublicAppliedDocumentDiscountVatPart
vatRatePctThe VAT rate as a percent.
taxCategoryThe tax category of the lines at this rate.
originalReductionAmountWhat the discount took off the lines at this rate, in the document's currency.
originalVatReductionAmountThe VAT that reduction took off.
PublicAppliedDocumentDiscount
discountIdThe discount record the document referenced.
positionThe order the document applied its document discounts in, from 0.
nameThe discount's name when the document was priced.
typepercentagePctThe percent a percentage discount took.
originalDiscountAmountA fixed discount's amount in the document's currency, taken once per document.
originalReductionAmountWhat the discount took off the document, in the document's currency. Never negative.
The reduction split by the VAT rate of the lines it fell on. The parts add up to the reduction.
codeThe code the discount was claimed through, as the code is written. Present only when a code claimed it.
PublicInvoice
idInvoice ID
statusInvoice status
dateInvoice date (ISO date)
isConsolidatedTrue when this invoice consolidates several subscriptions onto one document: a billing group’s shared invoice, or a parent customer’s invoice covering its child customers’ subscriptions. With both customerSubscriptionId and billingGroupId null it is the parent-paid kind.
currencyCurrency code (ISO 4217)
subtotalSubtotal before VAT (decimal string)
vatVAT amount (decimal string)
amountTotal amount including VAT (decimal string)
Invoice lines
The document-scope discount records the document referenced, in the order they applied, each applied once after every line discount. Empty when it referenced none.
totalDiscountedWhat the document's discounts took off in all, in the document's currency: each line's amount before discounts less its amount after them, plus the document discounts. A line discount typed by hand in LedgerBee counts too. Null when the document references no discount record.
createdAtCreation timestamp (ISO)
updatedAtLast update timestamp (ISO)
numberInvoice number. Null while the invoice is still a draft (allocated at booking).
dueDateDue date (ISO date)
customerIdCustomer ID
customerSubscriptionIdThe subscription this invoice bills, when it bills exactly one. Its lines may also include the subscriptions billed as part of that subscription’s section, which carry no section of their own. Null on a billing group’s shared invoice (see billingGroupId), on a parent-paid consolidated invoice (see isConsolidated) and on a manually created invoice.
billingGroupIdThe billing group this invoice is issued to, when several of one customer’s subscriptions bill onto it. Set instead of customerSubscriptionId, never alongside it. Filter the list by billingGroupId to find a group’s documents.
referenceReference / PO number
ourReferenceOur reference ("Vores ref.")
subjectHeading printed in bold on the PDF, directly above notes. The customer sees it on the document.
notesMessage printed on the PDF under subject. The customer sees it on the document.
PublicInvoiceListItem
idInvoice ID
statusInvoice status
dateInvoice date (ISO date)
isConsolidatedTrue when this invoice consolidates several subscriptions onto one document: a billing group’s shared invoice, or a parent customer’s invoice covering its child customers’ subscriptions. With both customerSubscriptionId and billingGroupId null it is the parent-paid kind.
currencyCurrency code (ISO 4217)
subtotalSubtotal before VAT (decimal string)
vatVAT amount (decimal string)
amountTotal amount including VAT (decimal string)
createdAtCreation timestamp (ISO)
updatedAtLast update timestamp (ISO)
numberInvoice number. Null while the invoice is still a draft (allocated at booking).
dueDateDue date (ISO date)
customerIdCustomer ID
customerSubscriptionIdThe subscription this invoice bills, when it bills exactly one. Its lines may also include the subscriptions billed as part of that subscription’s section, which carry no section of their own. Null on a billing group’s shared invoice (see billingGroupId), on a parent-paid consolidated invoice (see isConsolidated) and on a manually created invoice.
billingGroupIdThe billing group this invoice is issued to, when several of one customer’s subscriptions bill onto it. Set instead of customerSubscriptionId, never alongside it. Filter the list by billingGroupId to find a group’s documents.
referenceReference / PO number
ourReferenceOur reference ("Vores ref.")
subjectHeading printed in bold on the PDF, directly above notes. The customer sees it on the document.
notesMessage printed on the PDF under subject. The customer sees it on the document.
PublicListInvoicesResponse
Invoices on this page (line items omitted; GET one invoice for lines)
totalTotal invoices matching the query
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 (1-indexed).
totalPagesDeprecated: page with nextCursor instead. Total pages.
PublicUpdateInvoice
customerIdCustomer the invoice is for. Changing it requires lines in the same request, because each line's VAT is worked out from the customer's VAT zone. A change removes the department and contact unless the request states new ones, and removes any extra email recipients.
customerDepartmentIdCustomer department ID (for EAN-based e-invoicing and address override). Send null to remove the department.
customerContactIdCustomer contact ID (invoice recipient). Send null to remove the contact.
dateInvoice date (ISO date, YYYY-MM-DD). The due date follows it when the invoice has payment terms and the request states no dueDate.
dueDateDue date for payment (ISO date). Must not be before the invoice date.
currencyCurrency code (ISO 4217). Changing it requires lines in the same request, so the amounts are priced in the new currency.
paymentTermsPayment terms in days. The due date follows it when the request states no dueDate.
referenceReference / PO number ("PO-nr."). Send null to clear it.
ourReferenceOur reference ("Vores ref."). Send null to clear it.
descriptionInternal description for your own reference. Never printed on the PDF or shown to the customer: put text for the customer in subject and notes. Send null to clear it.
subjectHeading printed in bold on the PDF, directly above notes. The customer sees it on the document. Leave it out to keep the stored subject; send null to clear it.
notesMessage printed on the PDF under subject. The customer sees it on the document. Send null to clear them.
tagIdsTag/Dimension value IDs to attach to the journal entry when this invoice is booked. Replaces the stored set; send null or an empty array to remove every value. At most 100 ids.
Invoice lines, at most 1000. Replaces every stored line, so send the full intended set. Leave it out to keep the lines as they are. Refused on an invoice billed for a subscription, a self-billed invoice, an invoice a shipment refers to, and when a stored or sent line defers its revenue (recognitionPeriodDays).
discountIdsDocument-scope discount records to apply once to the whole document, after every line discount, reducing the lines whose product each applies to (every line when it names no product). Each id is a discount record (see GET /discounts). The order sent is the order they apply in. Each is checked for the line's product, the document's customer and the document date; a document converted from a quote is checked at the quote's date. A fixed or per-unit discount takes its amount in the document's currency: a discount with no amount in that currency is refused, never converted at an exchange rate. One applies when it applies to the customer and to at least one line's product. On an update, leaving it out keeps the discounts the document has; an empty array removes them. A change to them is sent with lines, which they are priced from: without the lines it is refused with DISCOUNT_REPRICE_NEEDS_LINES, and so is a change of the customer, the date or the currency of an invoice that carries discounts. Refused with: DISCOUNT_NOT_APPLICABLE (no such discount in your company, inactive, not assigned to this product and customer, or outside its dates on the document date; details.reason says which), DISCOUNT_WRONG_SCOPE, DISCOUNT_REFERENCED_TWICE, DISCOUNT_NOT_COMBINABLE, DISCOUNT_NO_AMOUNT_IN_CURRENCY, DISCOUNT_LINE_WITHOUT_PRODUCT, DISCOUNT_EXCEEDS_LINE and DISCOUNT_EXCEEDS_DOCUMENT.
discountCodesDiscount codes the customer gave, the same list sent to POST /discounts/check, matched without regard to case or surrounding spaces and applied after discountIds in the order sent. A code claims its discount, which then applies as if named by id, including one that applies only through a code: a line-scope discount lands on every line whose product it applies to, a document-scope one on the document. The code's own limit is counted when the invoice is booked, refused there with DISCOUNT_CODE_REDEMPTION_LIMIT_REACHED. A code naming a discount already named is applied once. On an update, a discount the document carries through a code keeps that code when the update names the discount again without it. Codes are sent with lines, which they are priced from; without the lines they are refused with DISCOUNT_REPRICE_NEEDS_LINES. Refused with: DISCOUNT_CODE_INVALID (empty, spaces or too long) and DISCOUNT_NOT_APPLICABLE with details.reason codeUnknown, codeInactive, codeExpired or codeCustomerMismatch and details.code, beside every refusal discountIds lists.
PublicSendInvoice
deliveryTypeDelivery channel
overrideEmailOverride recipient email for this send only
overrideEanNumberOverride EAN number for this send only
updateCustomerRecordPersist the override email / EAN onto the customer record
documentTemplateIdOverride document template for PDF generation
PublicSendInvoiceResponse
successWhether the send was accepted
deliveryTypeThe delivery channel the document was sent through
sproomDocumentIdSproom document ID when sent via e-invoicing
PublicDeliveryStatusSummary
sendCountNumber of send attempts recorded
lastDeliveryTypeChannel of the most recent send
lastRecipientEmailRecipient email of the most recent send
lastRecipientEanRecipient EAN of the most recent send
lastSentAtTimestamp of the most recent send (ISO)
PublicDeliveryLogEntry
idDelivery log entry ID
statusOutcome of the delivery attempt
deliveryTypeDelivery channel
sentAtTimestamp of the attempt (ISO)
recipientEmailRecipient email (email sends)
recipientEanRecipient EAN (e-invoice sends)
errorCodeError code when the attempt failed
PublicDeliveryStatusResponse
Aggregate send summary
Per-attempt delivery log entries
PublicCreateCreditNoteLine
priceIdProduct price ID. Required on a billable line — the line credits this product. Omit only for text / separator / discount lines (set lineType instead).
lineTypeSemantic type of the line (refund, cancellation credit, text, separator, etc.)
descriptionCustom description for this line item
quantityQuantity to credit. Required on a billable line; omit for text / separator / discount lines.
unitPriceOne-time unit-price override as a POSITIVE decimal string (the magnitude). Defaults to the price's current amount when omitted. The credit (negative) sign, totalPrice, and VAT are applied server-side and must not be sent.
tagIdsDimension value IDs for this line (see GET /dimensions). When the account the line posts to requires a dimension (requiredDimensionIds on the account), the line must carry a value from it, here or in the credit note's own tagIds (which apply to every line), or the credit note cannot be sent: booking is refused with JOURNAL_TAG_REQUIRED_DIMENSION_MISSING. A line that credits an invoice line is not judged.
discountIdsLine-scope discount records to apply to this line. Each id is a discount record (see GET /discounts). The order sent is the order they apply in. Each is checked for the line's product, the document's customer and the document date; a document converted from a quote is checked at the quote's date. A fixed or per-unit discount takes its amount in the document's currency: a discount with no amount in that currency is refused, never converted at an exchange rate. A credit note that names invoiceNumber takes none: it gives back the discounts that invoice used, and is refused with DISCOUNT_CREDIT_NOTE_FOLLOWS_INVOICE if it sends any. Refused with: DISCOUNT_NOT_APPLICABLE (no such discount in your company, inactive, not assigned to this product and customer, or outside its dates on the document date; details.reason says which), DISCOUNT_WRONG_SCOPE, DISCOUNT_REFERENCED_TWICE, DISCOUNT_NOT_COMBINABLE, DISCOUNT_NO_AMOUNT_IN_CURRENCY, DISCOUNT_LINE_WITHOUT_PRODUCT, DISCOUNT_EXCEEDS_LINE and DISCOUNT_EXCEEDS_DOCUMENT.
sourceInvoiceLineIdID of the line on the credited invoice that this line credits (lines[].id on GET /invoices/{id}). Requires invoiceNumber, and must name a line of that invoice; otherwise the request is refused with CREDIT_NOTE_SOURCE_LINE_NOT_ON_INVOICE. A linked line gives back the line discounts the invoice line was billed with, and its share of the invoice's document discounts. The amount is not checked against what remains creditable on the invoice line, exactly as for a line without a link.
PublicCreateCreditNote
customerIdCustomer ID this credit note is for
dateCredit note date (ISO date, YYYY-MM-DD)
Credit note lines
customerDepartmentIdCustomer department ID (for EAN-based e-invoicing and address override)
customerContactIdCustomer contact ID (credit note recipient)
invoiceNumberOriginal invoice number this credit note credits. When set, the referenced invoice is marked credited.
currencyCurrency code (ISO 4217). Defaults to the company default currency.
referenceReference / PO number ("PO-nr.")
ourReferenceOur reference ("Vores ref.")
descriptionInternal description for your own reference. Never printed on the PDF or shown to the customer: put text for the customer in subject and notes.
subjectHeading printed in bold on the PDF, directly above notes. The customer sees it on the document.
notesMessage printed on the PDF under subject. The customer sees it on the document.
tagIdsTag/Dimension value IDs to attach to the journal entry when this credit note is booked. Use the per-line tagIds for a dimension that differs between lines.
discountIdsDocument-scope discount records to apply once to the whole document, after every line discount, reducing the lines whose product each applies to (every line when it names no product). Each id is a discount record (see GET /discounts). The order sent is the order they apply in. Each is checked for the line's product, the document's customer and the document date; a document converted from a quote is checked at the quote's date. A fixed or per-unit discount takes its amount in the document's currency: a discount with no amount in that currency is refused, never converted at an exchange rate. One applies when it applies to the customer and to at least one line's product. A credit note that names invoiceNumber takes none: it gives back the discounts that invoice used, and is refused with DISCOUNT_CREDIT_NOTE_FOLLOWS_INVOICE if it sends any. Refused with: DISCOUNT_NOT_APPLICABLE (no such discount in your company, inactive, not assigned to this product and customer, or outside its dates on the document date; details.reason says which), DISCOUNT_WRONG_SCOPE, DISCOUNT_REFERENCED_TWICE, DISCOUNT_NOT_COMBINABLE, DISCOUNT_NO_AMOUNT_IN_CURRENCY, DISCOUNT_LINE_WITHOUT_PRODUCT, DISCOUNT_EXCEEDS_LINE and DISCOUNT_EXCEEDS_DOCUMENT.
PublicCreditNoteLine
idLine item ID
quantityQuantity
unitPriceUnit price (decimal string)
totalPriceTotal price (decimal string)
sourceInvoiceLineIdID of the line on the credited invoice that this line credits, as sent in lines[].sourceInvoiceLineId. Null on a line that names no invoice line.
subscriptionIdThe subscription this line credits. On a credit note that carries add-ons, an add-on’s lines name the add-on, not the parent the credit note is addressed to; on a billing group’s credit note, each line names the member it credits. Null on a line that belongs to no subscription, such as a line on a manually created credit note.
addonOfSubscriptionIdThe subscription this line’s subscription is an add-on of — the parent the add-on is billed with. Null on every line that is not an add-on’s.
tagIdsDimension value IDs this line carries. Empty when it carries none.
The discount records this line referenced, in the order they applied, with what each took off. Empty when it referenced none.
priceIdPrice ID this line references
descriptionCustom description for this line item
lineTypeSemantic line type
vatAmountVAT amount (decimal string)
vatRateVAT rate percentage (decimal string)
PublicCreditNote
idCredit note ID
numberCredit note number. Null until the credit note is sent; every sent credit note has one.
statusCredit note status
dateCredit note date (ISO date)
currencyCurrency code (ISO 4217)
subtotalSubtotal before VAT (decimal string)
vatVAT amount (decimal string)
amountTotal amount including VAT (decimal string)
Credit note lines
The document-scope discount records the document referenced, in the order they applied, each applied once after every line discount. Empty when it referenced none.
totalDiscountedWhat the document's discounts took off in all, in the document's currency: each line's amount before discounts less its amount after them, plus the document discounts. A line discount typed by hand in LedgerBee counts too. Null when the document references no discount record.
createdAtCreation timestamp (ISO)
updatedAtLast update timestamp (ISO)
invoiceNumberOriginal invoice number this credit note credits
customerIdCustomer ID
customerSubscriptionIdThe subscription this credit note credits, when it credits exactly one. Null on a billing group’s credit note (see billingGroupId) and on a manually created one.
billingGroupIdThe billing group this credit note is issued to, when it credits a group’s shared invoice. Set instead of customerSubscriptionId, never alongside it.
referenceReference / PO number
ourReferenceOur reference ("Vores ref.")
subjectHeading printed in bold on the PDF, directly above notes. The customer sees it on the document.
notesMessage printed on the PDF under subject. The customer sees it on the document.
PublicCreditNoteListItem
idCredit note ID
numberCredit note number. Null until the credit note is sent; every sent credit note has one.
statusCredit note status
dateCredit note date (ISO date)
currencyCurrency code (ISO 4217)
subtotalSubtotal before VAT (decimal string)
vatVAT amount (decimal string)
amountTotal amount including VAT (decimal string)
createdAtCreation timestamp (ISO)
updatedAtLast update timestamp (ISO)
invoiceNumberOriginal invoice number this credit note credits
customerIdCustomer ID
customerSubscriptionIdThe subscription this credit note credits, when it credits exactly one. Null on a billing group’s credit note (see billingGroupId) and on a manually created one.
billingGroupIdThe billing group this credit note is issued to, when it credits a group’s shared invoice. Set instead of customerSubscriptionId, never alongside it.
referenceReference / PO number
ourReferenceOur reference ("Vores ref.")
subjectHeading printed in bold on the PDF, directly above notes. The customer sees it on the document.
notesMessage printed on the PDF under subject. The customer sees it on the document.
PublicListCreditNotesResponse
Credit notes on this page (line items omitted; GET one for lines)
totalTotal credit notes matching the query
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 (1-indexed).
totalPagesDeprecated: page with nextCursor instead. Total pages.
PublicSendCreditNote
deliveryTypeDelivery channel
overrideEmailOverride recipient email for this send only
overrideEanNumberOverride EAN number for this send only
updateCustomerRecordPersist the override email / EAN onto the customer record
documentTemplateIdOverride document template for PDF generation
PublicQuoteListItem
idQuote identifier
typeAlways "quote"
statusStored lifecycle status (draft/sent/accepted/rejected)
displayStatusStatus to display. Equals status except derived states: "converted" or "expired".
dateQuote date (ISO, YYYY-MM-DD)
amountTotal amount including VAT
subtotalSubtotal excluding VAT
vatTotal VAT
currencyCurrency code
createdAtCreated timestamp (ISO)
updatedAtUpdated timestamp (ISO)
documentNumberAllocated quote number (null until sent)
validUntilValid-until date (ISO, YYYY-MM-DD)
referencePO number ("PO-nr.")
ourReferenceOur reference ("Vores ref.")
subjectHeading printed in bold on the PDF, directly above notes. The customer sees it on the document.
notesMessage printed on the PDF under subject. The customer sees it on the document.
customerIdCustomer id
sourceDocumentIdSource document id (set when this quote originated from another document)
convertedToDocumentIdId of the order confirmation this quote was converted into
convertedToInvoiceIdId of the invoice this quote was converted into
sentAtTimestamp the quote was sent (ISO)
PublicListQuotesResponse
List of quotes (line items omitted; GET one quote for lines)
totalTotal number of quotes matching the query
limitMaximum number of items 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 (1-indexed).
totalPagesDeprecated: page with nextCursor instead. Total number of pages available.
PublicQuoteLine
idLine identifier
quantityQuantity
unitPriceUnit price
totalPriceTotal price for the line
The discount records this line referenced, in the order they applied, with what each took off. Empty when it referenced none.
descriptionLine description shown on the quote
lineTypeSemantic line type
vatRateVAT rate (percentage)
vatAmountVAT amount for the line
PublicDocumentDiscountWarning
codeDISCOUNT_ENDS_BEFORE_QUOTE_EXPIRY: a referenced discount stops applying before the quote expires. The quoted price, discount included, holds until the quote expires: converting the quote checks the discount at the quote date.
discountIdThe discount the warning is about.
nameThe discount's name.
endsAtThe last day the discount applies to this quote, YYYY-MM-DD.
validUntilThe quote's expiry date, YYYY-MM-DD.
PublicQuote
idQuote identifier
typeAlways "quote"
statusStored lifecycle status (draft/sent/accepted/rejected)
displayStatusStatus to display. Equals status except derived states: "converted" or "expired".
dateQuote date (ISO, YYYY-MM-DD)
amountTotal amount including VAT
subtotalSubtotal excluding VAT
vatTotal VAT
currencyCurrency code
createdAtCreated timestamp (ISO)
updatedAtUpdated timestamp (ISO)
The document-scope discount records the document referenced, in the order they applied, each applied once after every line discount. Empty when it referenced none.
totalDiscountedWhat the document's discounts took off in all, in the document's currency: each line's amount before discounts less its amount after them, plus the document discounts. A line discount typed by hand in LedgerBee counts too. Null when the document references no discount record.
documentNumberAllocated quote number (null until sent)
validUntilValid-until date (ISO, YYYY-MM-DD)
referencePO number ("PO-nr.")
ourReferenceOur reference ("Vores ref.")
subjectHeading printed in bold on the PDF, directly above notes. The customer sees it on the document.
notesMessage printed on the PDF under subject. The customer sees it on the document.
customerIdCustomer id
sourceDocumentIdSource document id (set when this quote originated from another document)
convertedToDocumentIdId of the order confirmation this quote was converted into
convertedToInvoiceIdId of the invoice this quote was converted into
sentAtTimestamp the quote was sent (ISO)
Warnings about the save. Present on the create and update responses only, empty when there is nothing to warn about. A warning never blocks the save.
PublicCreateQuoteLine
priceIdProduct price id. Required on a billable line — the line bills this product. Omit only for text / separator / discount lines (set lineType instead).
descriptionCustom description for the line
lineTypeSemantic line type. Use text / separator / discount / interval_discount for non-billable lines; any other value marks the line billable (priceId + quantity required).
quantityQuantity. Required on a billable line; omit for text / separator / discount lines.
unitPriceOne-time unit-price override. Defaults to the price's current amount in the document currency. totalPrice and VAT are computed server-side and must not be sent.
discountIdsLine-scope discount records to apply to this line. Each id is a discount record (see GET /discounts). The order sent is the order they apply in. Each is checked for the line's product, the document's customer and the document date; a document converted from a quote is checked at the quote's date. A fixed or per-unit discount takes its amount in the document's currency: a discount with no amount in that currency is refused, never converted at an exchange rate. An update restates every line, so a line carries the ids sent with it: a line sent without discountIds has no line discounts. Refused with: DISCOUNT_NOT_APPLICABLE (no such discount in your company, inactive, not assigned to this product and customer, or outside its dates on the document date; details.reason says which), DISCOUNT_WRONG_SCOPE, DISCOUNT_REFERENCED_TWICE, DISCOUNT_NOT_COMBINABLE, DISCOUNT_NO_AMOUNT_IN_CURRENCY, DISCOUNT_LINE_WITHOUT_PRODUCT, DISCOUNT_EXCEEDS_LINE and DISCOUNT_EXCEEDS_DOCUMENT.
PublicCreateQuote
customerIdCustomer this quote is for
dateQuote date (ISO, YYYY-MM-DD)
customerDepartmentIdCustomer department id
customerContactIdCustomer contact id ("Deres ref.")
validUntilValid-until date (ISO, YYYY-MM-DD)
currencyCurrency code
referencePO number ("PO-nr.")
ourReferenceOur reference ("Vores ref.")
subjectHeading printed in bold on the PDF, directly above notes. The customer sees it on the document.
notesMessage printed on the PDF under subject. The customer sees it on the document.
discountIdsDocument-scope discount records to apply once to the whole document, after every line discount, reducing the lines whose product each applies to (every line when it names no product). Each id is a discount record (see GET /discounts). The order sent is the order they apply in. Each is checked for the line's product, the document's customer and the document date; a document converted from a quote is checked at the quote's date. A fixed or per-unit discount takes its amount in the document's currency: a discount with no amount in that currency is refused, never converted at an exchange rate. One applies when it applies to the customer and to at least one line's product. Refused with: DISCOUNT_NOT_APPLICABLE (no such discount in your company, inactive, not assigned to this product and customer, or outside its dates on the document date; details.reason says which), DISCOUNT_WRONG_SCOPE, DISCOUNT_REFERENCED_TWICE, DISCOUNT_NOT_COMBINABLE, DISCOUNT_NO_AMOUNT_IN_CURRENCY, DISCOUNT_LINE_WITHOUT_PRODUCT, DISCOUNT_EXCEEDS_LINE and DISCOUNT_EXCEEDS_DOCUMENT.
discountCodesDiscount codes the customer gave, the same list sent to POST /discounts/check, matched without regard to case or surrounding spaces and applied after discountIds in the order sent. A code claims its discount, which then applies as if named by id, including one that applies only through a code: a line-scope discount lands on every line whose product it applies to, a document-scope one on the document. Saving uses none of the code's own limit: the invoice the document converts to counts it when booked, refused there with DISCOUNT_CODE_REDEMPTION_LIMIT_REACHED. A conversion carries each code with its discount, judged at the date of the document its conversion chain starts at: the quote, or an order confirmation made without one; one converted at the quoted figures keeps its codes as they were. A code naming a discount already named is applied once. Refused with: DISCOUNT_CODE_INVALID (empty, spaces or too long) and DISCOUNT_NOT_APPLICABLE with details.reason codeUnknown, codeInactive, codeExpired or codeCustomerMismatch and details.code, beside every refusal discountIds lists.
PublicSendQuote
deliveryTypeDelivery method. Defaults to Manual. Sproom/e-invoice does not apply to quotes.
recipientEmailOverride recipient email for Email delivery
PublicConvertQuotePayload
customerIdCustomer for the converted document
dateDocument date (ISO, YYYY-MM-DD)
customerDepartmentIdCustomer department id
customerContactIdCustomer contact id
currencyCurrency code
referencePO number ("PO-nr.")
ourReferenceOur reference ("Vores ref.")
subjectHeading printed in bold on the PDF, directly above notes. The customer sees it on the document.
notesMessage printed on the PDF under subject. The customer sees it on the document.
discountIdsDocument-scope discount records to apply once to the whole document, after every line discount, reducing the lines whose product each applies to (every line when it names no product). Each id is a discount record (see GET /discounts). The order sent is the order they apply in. Each is checked for the line's product, the document's customer and the document date; a document converted from a quote is checked at the quote's date. A fixed or per-unit discount takes its amount in the document's currency: a discount with no amount in that currency is refused, never converted at an exchange rate. One applies when it applies to the customer and to at least one line's product. The converted document's own. Refused with: DISCOUNT_NOT_APPLICABLE (no such discount in your company, inactive, not assigned to this product and customer, or outside its dates on the document date; details.reason says which), DISCOUNT_WRONG_SCOPE, DISCOUNT_REFERENCED_TWICE, DISCOUNT_NOT_COMBINABLE, DISCOUNT_NO_AMOUNT_IN_CURRENCY, DISCOUNT_LINE_WITHOUT_PRODUCT, DISCOUNT_EXCEEDS_LINE and DISCOUNT_EXCEEDS_DOCUMENT.
discountCodesDiscount codes the customer gave, the same list sent to POST /discounts/check, matched without regard to case or surrounding spaces and applied after discountIds in the order sent. A code claims its discount, which then applies as if named by id, including one that applies only through a code: a line-scope discount lands on every line whose product it applies to, a document-scope one on the document. Saving uses none of the code's own limit: the invoice the document converts to counts it when booked, refused there with DISCOUNT_CODE_REDEMPTION_LIMIT_REACHED. A conversion carries each code with its discount, judged at the date of the document its conversion chain starts at: the quote, or an order confirmation made without one; one converted at the quoted figures keeps its codes as they were. A code naming a discount already named is applied once. The converted document's own, resolved as on any save; a discount the quote claimed through a code keeps that code when the payload names it. Refused with: DISCOUNT_CODE_INVALID (empty, spaces or too long) and DISCOUNT_NOT_APPLICABLE with details.reason codeUnknown, codeInactive, codeExpired or codeCustomerMismatch and details.code, beside every refusal discountIds lists.
PublicConvertQuote
targetTarget to convert into. Use "orderConfirmation" to confirm the quote, or "invoice" to convert it directly into an invoice.
Edited target document (review-before-finalize). Omit to copy the source verbatim.
discountPricingHow the discount records the source references are priced when a record was edited, switched off or moved out of its window after the source was priced. asQuoted keeps the source's saved figures. current prices the records as they are now, at the source's date, and refuses a record that no longer applies (DISCOUNT_NOT_APPLICABLE). Omitted means current; the response then lists a DISCOUNT_CHANGED_SINCE_QUOTE warning for each discount whose figures differ.
DiscountNotApplicableReason
Present only when the discount no longer applies because a code that claimed it would be refused now (switched off, expired, or for another customer). Saving the document is refused until the code is removed.
PublicDiscountChangedSinceQuoteWarning
discountIdnameThe discount's name on the source document.
scopequotedTypequotedValueThe percent or amount the source was priced with.
quotedAmountWhat the discount took off the source.
currentTypecurrentValueThe percent or amount the record holds now.
currentAmountWhat the record would take off the same lines now; null when it no longer applies.
currentApplicableWhether the record still applies at the source date. Converting at the current records refuses one that does not.
codecodeRefusedReasonPresent only when the discount no longer applies because a code that claimed it would be refused now (switched off, expired, or for another customer). Saving the document is refused until the code is removed.
discountCodeThe discount code the source claimed the discount through, as the code is written. Absent when the source named the discount by id.
PublicConvertQuoteResult
targetTypeType of document produced by the conversion ("invoice" or "orderConfirmation")
targetIdIdentifier of the produced document
One per discount whose figures differ from the source document's, when the request named no discountPricing and the conversion priced at the current records. Empty otherwise. A warning never blocks the conversion.
PublicUpdateQuote
customerIdCustomer this quote is for
dateQuote date (ISO, YYYY-MM-DD)
customerDepartmentIdCustomer department id
customerContactIdCustomer contact id ("Deres ref.")
validUntilValid-until date (ISO, YYYY-MM-DD)
currencyCurrency code
referencePO number ("PO-nr.")
ourReferenceOur reference ("Vores ref.")
subjectHeading printed in bold on the PDF, directly above notes. The customer sees it on the document. Leave it out to keep the stored subject; send null to clear it.
notesMessage printed on the PDF under subject. The customer sees it on the document.
discountIdsDocument-scope discount records to apply once to the whole document, after every line discount, reducing the lines whose product each applies to (every line when it names no product). Each id is a discount record (see GET /discounts). The order sent is the order they apply in. Each is checked for the line's product, the document's customer and the document date; a document converted from a quote is checked at the quote's date. A fixed or per-unit discount takes its amount in the document's currency: a discount with no amount in that currency is refused, never converted at an exchange rate. One applies when it applies to the customer and to at least one line's product. On an update, leaving it out keeps the discounts the document has; an empty array removes them. Refused with: DISCOUNT_NOT_APPLICABLE (no such discount in your company, inactive, not assigned to this product and customer, or outside its dates on the document date; details.reason says which), DISCOUNT_WRONG_SCOPE, DISCOUNT_REFERENCED_TWICE, DISCOUNT_NOT_COMBINABLE, DISCOUNT_NO_AMOUNT_IN_CURRENCY, DISCOUNT_LINE_WITHOUT_PRODUCT, DISCOUNT_EXCEEDS_LINE and DISCOUNT_EXCEEDS_DOCUMENT.
discountCodesDiscount codes the customer gave, the same list sent to POST /discounts/check, matched without regard to case or surrounding spaces and applied after discountIds in the order sent. A code claims its discount, which then applies as if named by id, including one that applies only through a code: a line-scope discount lands on every line whose product it applies to, a document-scope one on the document. Saving uses none of the code's own limit: the invoice the document converts to counts it when booked, refused there with DISCOUNT_CODE_REDEMPTION_LIMIT_REACHED. A conversion carries each code with its discount, judged at the date of the document its conversion chain starts at: the quote, or an order confirmation made without one; one converted at the quoted figures keeps its codes as they were. A code naming a discount already named is applied once. On an update, a discount the document carries through a code keeps that code when the update names the discount again without it. Refused with: DISCOUNT_CODE_INVALID (empty, spaces or too long) and DISCOUNT_NOT_APPLICABLE with details.reason codeUnknown, codeInactive, codeExpired or codeCustomerMismatch and details.code, beside every refusal discountIds lists.
PublicOrderConfirmationListItem
idDocument identifier
statusStored lifecycle status (draft/sent)
displayStatusStatus to display. Equals status except the derived "converted" state.
dateDocument date (ISO, YYYY-MM-DD)
amountTotal amount including VAT
subtotalSubtotal excluding VAT
vatTotal VAT
currencyCurrency code
createdAtCreated timestamp (ISO)
updatedAtUpdated timestamp (ISO)
documentNumberAllocated document number (null until sent)
referencePO number ("PO-nr.")
ourReferenceOur reference ("Vores ref.")
subjectHeading printed in bold on the PDF, directly above notes. The customer sees it on the document.
notesMessage printed on the PDF under subject. The customer sees it on the document.
customerIdCustomer id
sourceDocumentIdSource document id (the quote this order confirmation was converted from)
convertedToInvoiceIdId of the invoice this order confirmation was converted into
sentAtTimestamp the document was sent (ISO)
PublicListOrderConfirmationsResponse
List of order confirmations (line items omitted; GET one for lines)
totalTotal number of documents matching the query
limitMaximum number of items 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 (1-indexed).
totalPagesDeprecated: page with nextCursor instead. Total number of pages available.
PublicOrderConfirmationLine
idLine identifier
quantityQuantity
unitPriceUnit price
totalPriceTotal price for the line
The discount records this line referenced, in the order they applied, with what each took off. Empty when it referenced none.
descriptionLine description shown on the document
lineTypeSemantic line type
vatRateVAT rate (percentage)
vatAmountVAT amount for the line
PublicOrderConfirmation
idDocument identifier
statusStored lifecycle status (draft/sent)
displayStatusStatus to display. Equals status except the derived "converted" state.
dateDocument date (ISO, YYYY-MM-DD)
amountTotal amount including VAT
subtotalSubtotal excluding VAT
vatTotal VAT
currencyCurrency code
createdAtCreated timestamp (ISO)
updatedAtUpdated timestamp (ISO)
The document-scope discount records the document referenced, in the order they applied, each applied once after every line discount. Empty when it referenced none.
totalDiscountedWhat the document's discounts took off in all, in the document's currency: each line's amount before discounts less its amount after them, plus the document discounts. A line discount typed by hand in LedgerBee counts too. Null when the document references no discount record.
documentNumberAllocated document number (null until sent)
referencePO number ("PO-nr.")
ourReferenceOur reference ("Vores ref.")
subjectHeading printed in bold on the PDF, directly above notes. The customer sees it on the document.
notesMessage printed on the PDF under subject. The customer sees it on the document.
customerIdCustomer id
sourceDocumentIdSource document id (the quote this order confirmation was converted from)
convertedToInvoiceIdId of the invoice this order confirmation was converted into
sentAtTimestamp the document was sent (ISO)
Warnings about the save. Present on the create and update responses only, empty when there is nothing to warn about. A warning never blocks the save.
PublicCreateOrderConfirmationLine
priceIdProduct price id. Required on a billable line — the line bills this product. Omit only for text / separator / discount lines (set lineType instead).
descriptionCustom description for the line
lineTypeSemantic line type. Use text / separator / discount / interval_discount for non-billable lines; any other value marks the line billable (priceId + quantity required).
quantityQuantity. Required on a billable line; omit for text / separator / discount lines.
unitPriceOne-time unit-price override. Defaults to the price's current amount in the document currency. totalPrice and VAT are computed server-side and must not be sent.
discountIdsLine-scope discount records to apply to this line. Each id is a discount record (see GET /discounts). The order sent is the order they apply in. Each is checked for the line's product, the document's customer and the document date; a document converted from a quote is checked at the quote's date. A fixed or per-unit discount takes its amount in the document's currency: a discount with no amount in that currency is refused, never converted at an exchange rate. An update restates every line, so a line carries the ids sent with it: a line sent without discountIds has no line discounts. Refused with: DISCOUNT_NOT_APPLICABLE (no such discount in your company, inactive, not assigned to this product and customer, or outside its dates on the document date; details.reason says which), DISCOUNT_WRONG_SCOPE, DISCOUNT_REFERENCED_TWICE, DISCOUNT_NOT_COMBINABLE, DISCOUNT_NO_AMOUNT_IN_CURRENCY, DISCOUNT_LINE_WITHOUT_PRODUCT, DISCOUNT_EXCEEDS_LINE and DISCOUNT_EXCEEDS_DOCUMENT.
PublicCreateOrderConfirmation
customerIdCustomer this order confirmation is for
dateDocument date (ISO, YYYY-MM-DD)
customerDepartmentIdCustomer department id
customerContactIdCustomer contact id ("Deres ref.")
currencyCurrency code
referencePO number ("PO-nr.")
ourReferenceOur reference ("Vores ref.")
subjectHeading printed in bold on the PDF, directly above notes. The customer sees it on the document.
notesMessage printed on the PDF under subject. The customer sees it on the document.
discountIdsDocument-scope discount records to apply once to the whole document, after every line discount, reducing the lines whose product each applies to (every line when it names no product). Each id is a discount record (see GET /discounts). The order sent is the order they apply in. Each is checked for the line's product, the document's customer and the document date; a document converted from a quote is checked at the quote's date. A fixed or per-unit discount takes its amount in the document's currency: a discount with no amount in that currency is refused, never converted at an exchange rate. One applies when it applies to the customer and to at least one line's product. Refused with: DISCOUNT_NOT_APPLICABLE (no such discount in your company, inactive, not assigned to this product and customer, or outside its dates on the document date; details.reason says which), DISCOUNT_WRONG_SCOPE, DISCOUNT_REFERENCED_TWICE, DISCOUNT_NOT_COMBINABLE, DISCOUNT_NO_AMOUNT_IN_CURRENCY, DISCOUNT_LINE_WITHOUT_PRODUCT, DISCOUNT_EXCEEDS_LINE and DISCOUNT_EXCEEDS_DOCUMENT.
discountCodesDiscount codes the customer gave, the same list sent to POST /discounts/check, matched without regard to case or surrounding spaces and applied after discountIds in the order sent. A code claims its discount, which then applies as if named by id, including one that applies only through a code: a line-scope discount lands on every line whose product it applies to, a document-scope one on the document. Saving uses none of the code's own limit: the invoice the document converts to counts it when booked, refused there with DISCOUNT_CODE_REDEMPTION_LIMIT_REACHED. A conversion carries each code with its discount, judged at the date of the document its conversion chain starts at: the quote, or an order confirmation made without one; one converted at the quoted figures keeps its codes as they were. A code naming a discount already named is applied once. Refused with: DISCOUNT_CODE_INVALID (empty, spaces or too long) and DISCOUNT_NOT_APPLICABLE with details.reason codeUnknown, codeInactive, codeExpired or codeCustomerMismatch and details.code, beside every refusal discountIds lists.
PublicSendOrderConfirmation
deliveryTypeDelivery method. Defaults to Manual. Sproom/e-invoice does not apply to order confirmations.
recipientEmailOverride recipient email for Email delivery
PublicConvertOrderConfirmationPayload
customerIdCustomer for the converted document
dateDocument date (ISO, YYYY-MM-DD)
customerDepartmentIdCustomer department id
customerContactIdCustomer contact id
currencyCurrency code
referencePO number ("PO-nr.")
ourReferenceOur reference ("Vores ref.")
subjectHeading printed in bold on the PDF, directly above notes. The customer sees it on the document.
notesMessage printed on the PDF under subject. The customer sees it on the document.
discountIdsDocument-scope discount records to apply once to the whole document, after every line discount, reducing the lines whose product each applies to (every line when it names no product). Each id is a discount record (see GET /discounts). The order sent is the order they apply in. Each is checked for the line's product, the document's customer and the document date; a document converted from a quote is checked at the quote's date. A fixed or per-unit discount takes its amount in the document's currency: a discount with no amount in that currency is refused, never converted at an exchange rate. One applies when it applies to the customer and to at least one line's product. The converted invoice's own. Refused with: DISCOUNT_NOT_APPLICABLE (no such discount in your company, inactive, not assigned to this product and customer, or outside its dates on the document date; details.reason says which), DISCOUNT_WRONG_SCOPE, DISCOUNT_REFERENCED_TWICE, DISCOUNT_NOT_COMBINABLE, DISCOUNT_NO_AMOUNT_IN_CURRENCY, DISCOUNT_LINE_WITHOUT_PRODUCT, DISCOUNT_EXCEEDS_LINE and DISCOUNT_EXCEEDS_DOCUMENT.
discountCodesDiscount codes the customer gave, the same list sent to POST /discounts/check, matched without regard to case or surrounding spaces and applied after discountIds in the order sent. A code claims its discount, which then applies as if named by id, including one that applies only through a code: a line-scope discount lands on every line whose product it applies to, a document-scope one on the document. Saving uses none of the code's own limit: the invoice the document converts to counts it when booked, refused there with DISCOUNT_CODE_REDEMPTION_LIMIT_REACHED. A conversion carries each code with its discount, judged at the date of the document its conversion chain starts at: the quote, or an order confirmation made without one; one converted at the quoted figures keeps its codes as they were. A code naming a discount already named is applied once. The converted invoice's own, resolved as on any save; a discount the order confirmation claimed through a code keeps that code when the payload names it. Refused with: DISCOUNT_CODE_INVALID (empty, spaces or too long) and DISCOUNT_NOT_APPLICABLE with details.reason codeUnknown, codeInactive, codeExpired or codeCustomerMismatch and details.code, beside every refusal discountIds lists.
PublicConvertOrderConfirmation
targetTarget to convert into. An order confirmation only ever converts into an "invoice".
Edited target document (review-before-finalize). Omit to copy the source verbatim.
discountPricingHow the discount records the source references are priced when a record was edited, switched off or moved out of its window after the source was priced. asQuoted keeps the source's saved figures. current prices the records as they are now, at the source's date, and refuses a record that no longer applies (DISCOUNT_NOT_APPLICABLE). Omitted means current; the response then lists a DISCOUNT_CHANGED_SINCE_QUOTE warning for each discount whose figures differ.
PublicConvertOrderConfirmationResult
targetTypeType of document produced by the conversion (always "invoice")
targetIdIdentifier of the produced document
One per discount whose figures differ from the source document's, when the request named no discountPricing and the conversion priced at the current records. Empty otherwise. A warning never blocks the conversion.
PublicUpdateOrderConfirmation
customerIdCustomer this order confirmation is for
dateDocument date (ISO, YYYY-MM-DD)
customerDepartmentIdCustomer department id
customerContactIdCustomer contact id ("Deres ref.")
currencyCurrency code
referencePO number ("PO-nr.")
ourReferenceOur reference ("Vores ref.")
subjectHeading printed in bold on the PDF, directly above notes. The customer sees it on the document. Leave it out to keep the stored subject; send null to clear it.
notesMessage printed on the PDF under subject. The customer sees it on the document.
statusNew stored status (validated against the document type: draft/sent for order confirmations).
discountIdsDocument-scope discount records to apply once to the whole document, after every line discount, reducing the lines whose product each applies to (every line when it names no product). Each id is a discount record (see GET /discounts). The order sent is the order they apply in. Each is checked for the line's product, the document's customer and the document date; a document converted from a quote is checked at the quote's date. A fixed or per-unit discount takes its amount in the document's currency: a discount with no amount in that currency is refused, never converted at an exchange rate. One applies when it applies to the customer and to at least one line's product. On an update, leaving it out keeps the discounts the document has; an empty array removes them. Refused with: DISCOUNT_NOT_APPLICABLE (no such discount in your company, inactive, not assigned to this product and customer, or outside its dates on the document date; details.reason says which), DISCOUNT_WRONG_SCOPE, DISCOUNT_REFERENCED_TWICE, DISCOUNT_NOT_COMBINABLE, DISCOUNT_NO_AMOUNT_IN_CURRENCY, DISCOUNT_LINE_WITHOUT_PRODUCT, DISCOUNT_EXCEEDS_LINE and DISCOUNT_EXCEEDS_DOCUMENT.
discountCodesDiscount codes the customer gave, the same list sent to POST /discounts/check, matched without regard to case or surrounding spaces and applied after discountIds in the order sent. A code claims its discount, which then applies as if named by id, including one that applies only through a code: a line-scope discount lands on every line whose product it applies to, a document-scope one on the document. Saving uses none of the code's own limit: the invoice the document converts to counts it when booked, refused there with DISCOUNT_CODE_REDEMPTION_LIMIT_REACHED. A conversion carries each code with its discount, judged at the date of the document its conversion chain starts at: the quote, or an order confirmation made without one; one converted at the quoted figures keeps its codes as they were. A code naming a discount already named is applied once. On an update, a discount the document carries through a code keeps that code when the update names the discount again without it. Refused with: DISCOUNT_CODE_INVALID (empty, spaces or too long) and DISCOUNT_NOT_APPLICABLE with details.reason codeUnknown, codeInactive, codeExpired or codeCustomerMismatch and details.code, beside every refusal discountIds lists.
PublicDownloadLink
urlFetch this URL directly to download the file. It needs no API key — the URL itself is the credential.
expiresAtWhen the link stops working
ProductGroupResponse
idThe unique identifier of the product group
numberUnique product-group number within the company
nameName of the product group
domesticAccountIdLedger account ID for domestic sales
createdAtWhen the product group was created
updatedAtWhen the product group was last updated
descriptionOptional description
domesticAccountNumberDomestic account number
domesticAccountNameDomestic account name
euAccountIdLedger account ID for EU sales (Rubric B)
euAccountNumberEU account number
euAccountNameEU account name
abroadAccountIdLedger account ID for sales abroad (Rubric C)
abroadAccountNumberAbroad account number
abroadAccountNameAbroad account name
domesticWithoutVatAccountIdLedger account ID for domestic sales without VAT
domesticWithoutVatAccountNumberDomestic-without-VAT account number
domesticWithoutVatAccountNameDomestic-without-VAT account name
productCountNumber of products in this group (list responses only)
ListProductGroupsResponse
Page of product groups
totalTotal number of matching product groups
pageCurrent page number
limitItems per page
totalPagesTotal number of pages
CreateProductGroupRequest
numberUnique product-group number within the company
nameName of the product group
domesticAccountIdLedger account ID for domestic sales. Must reference an existing account that carries a VAT code valid for sales.
euAccountIdLedger account ID for EU sales (Rubric B). Must carry a sales-valid VAT code.
abroadAccountIdLedger account ID for sales abroad (Rubric C). Must carry a sales-valid VAT code.
domesticWithoutVatAccountIdLedger account ID for domestic sales without VAT.
descriptionOptional description
UpdateProductGroupRequest
numberUnique product-group number within the company
nameName of the product group
descriptionOptional description
domesticAccountIdLedger account ID for domestic sales
euAccountIdLedger account ID for EU sales (Rubric B)
abroadAccountIdLedger account ID for sales abroad (Rubric C)
domesticWithoutVatAccountIdLedger account ID for domestic sales without VAT
DiscountAmount
currency^[A-Za-z]{3}$ · requiredISO 4217 alpha-3 currency code.
amountWhat the discount takes off in this currency, in major units, as a positive decimal string. Each currency carries its own amount: a document in a currency the discount has no amount for is refused, never converted at an exchange rate.
DiscountAssignment
idThe assignment ID.
discountIdThe discount this assignment belongs to.
productIdThe product the discount applies to. Null, with no product group: every product.
productGroupIdThe product group the discount applies to: every product whose group it is, at the time a document is checked. Null: no group target. Never set together with productId.
customerIdThe customer the discount applies to. Null, with no customer group: every customer.
customerGroupIdThe customer group the discount applies to: every customer whose group it is, at the time a document is checked. Null: no group target. Never set together with customerId.
startsAtFirst calendar day the discount applies, inclusive (YYYY-MM-DD). Null: from any day.
endsAtLast calendar day the discount applies, inclusive (YYYY-MM-DD). Null: it never ends.
DiscountResponse
idThe discount ID.
namePrinted as the reason on the e-invoice allowance.
typepercentage takes a percent off; fixed takes an amount off, per eligible line for a line discount or once per document for a document discount; per_unit takes an amount off each unit on a line and takes line scope only. The type cannot change after the discount is created.
scopeline applies to each eligible line on its own. document applies once per document, after every line discount, when the customer matches and at least one line has an eligible product. A per_unit discount with document scope is refused with DISCOUNT_PER_UNIT_NEEDS_LINE_SCOPE.
percentagePctPercentage discounts only: the percent taken off, above 0 and at most 100. Null for other types.
priorityThe order the server applies discounts in when it picks them itself; lowest first.
combinableFalse: a line may not reference this discount together with another one.
activeAn inactive discount applies nowhere.
requiresCodeTrue: the discount applies only through one of its codes. A document or an applicability check that names it by its id alone is refused with the reason codeRequired, and GET /v1/discounts/applicable leaves it out.
maxRedemptionsTotal uses allowed. Null: no limit.
maxPerCustomerUses allowed per customer. Null: no limit.
durationInPeriodsHow many billing periods the discount lasts on a subscription that references it. Null: for as long as the reference stands.
Fixed and per-unit discounts: one positive amount per currency, sorted by currency. Empty for a percentage discount. A discount is applied only to a document line or document that references its id; creating or assigning it changes no document on its own.
Where the discount applies: each assignment names a product, a customer and a window of days, any of them null for "all". A discount with no assignment applies nowhere.
ListDiscountsResponse
Page of discounts, ordered by priority (lowest first), then name.
totalTotal number of matching discounts
pageCurrent page number
limitItems per page
totalPagesTotal number of pages
DiscountCodeLookupCode
idThe code ID.
discountIdThe discount the code claims.
codeThe code as it was entered, without surrounding spaces.
normalizedCodeThe code trimmed and upper-cased: the text a lookup matches on.
maxRedemptionsUses allowed through this code. Null: no limit of its own.
expiresAtLast calendar day the code may be used, inclusive (YYYY-MM-DD). Null: it never expires.
activeFalse: the code is switched off and its text may be reused by a new code.
usesUses counted through this code: booked invoices whose use no full credit note has given back.
createdAtWhen the code was created (ISO 8601).
DiscountCodeLookupDiscount
idThe discount ID.
namePrinted as the reason on the e-invoice allowance.
typepercentage takes a percent off; fixed takes an amount off, per eligible line for a line discount or once per document for a document discount; per_unit takes an amount off each unit on a line and takes line scope only. The type cannot change after the discount is created.
scopeline applies to each eligible line on its own. document applies once per document, after every line discount, when the customer matches and at least one line has an eligible product. A per_unit discount with document scope is refused with DISCOUNT_PER_UNIT_NEEDS_LINE_SCOPE.
percentagePctPercentage discounts only: the percent taken off.
combinableFalse: a line may not carry this discount together with another one.
Fixed and per-unit discounts: one amount per currency.
DiscountCodeLookupResponse
codeNull when your company has no such code.
discountThe discount the code claims. Null when your company has no such code.
applicableWhether the code applies for this customer, product and day.
reasonNull when it applies. Otherwise the first check that failed: codeUnknown (no such code in your company), then the discount's own inactive, notAssigned, notInGroup (an assignment would match, but the product or the customer is not in the group it targets), outsideWindow, maxRedemptionsReached, maxPerCustomerReached, then the code's codeInactive, codeExpired (past its last day), codeCustomerMismatch (the code is for another customer, or for a customer and none was given) and codeMaxRedemptionsReached.
remainingUses left under the discount's maxRedemptions. Null: no total limit.
remainingForCustomerUses left for this customer under the discount's maxPerCustomer. Null: no such limit, or no customer given.
remainingForCodeUses left under the code's own maxRedemptions. Null: no limit of its own.
DiscountCheckLineRequest
productIdThe product the line sells.
quantityUnits on the line. Negative for a returned item.
unitPriceThe unit price before discounts, in the cart's currency, as a decimal string.
vatRatePctThe line's VAT rate as a percent. Send it on every line to get each document discount's split by VAT rate.
DiscountCheckRequest
currency^[A-Za-z]{3}$ · requiredThe cart's currency, ISO 4217 alpha-3. A fixed or per-unit discount needs an amount in it.
dateThe calendar day the cart is priced on (YYYY-MM-DD).
1 to 200 lines.
customerIdThe customer buying. Omitted: a guest, to whom only assignments for every customer apply, a code made for one customer does not apply, and no per-customer use is counted.
codesCodes the shopper typed, at most 20, matched without regard to case or surrounding spaces. They apply after discountIds, in the order sent.
discountIdsDiscounts applied by id, at most 50, in the order sent and before the codes.
DiscountCheckLineDiscount
discountIdThe discount ID.
codeThe code it was claimed through. Null: named by id.
originalReductionAmountWhat it takes off the line, in the cart's currency. Never negative.
DiscountCheckLine
lineIndexThe index of the line in the request, from 0.
The line discounts, in the order they apply.
originalNetThe line after its line discounts and before any document discount, in the cart's currency. Negative on a returned item.
DiscountCheckVatPart
vatRatePctoriginalReductionAmountWhat the discount takes off the lines at this rate.
originalVatReductionAmountThe VAT that reduction takes off.
taxCategoryDiscountCheckDocumentDiscount
discountIdThe discount ID.
codeThe code it was claimed through. Null: named by id.
originalReductionAmountWhat it takes off the lines it covers, in the cart's currency.
vatSplitAvailableFalse when a line the discount falls on was sent without vatRatePct. vatSplit is then null.
The reduction per VAT rate, adding up to it. Null when vatSplitAvailable is false.
DiscountCheckRefusal
codeThe code, upper-cased as matched. Null for a discount sent in discountIds.
discountIdNull for a code your company does not have.
reasonWhy it was left out: an applicability reason such as codeUnknown or maxRedemptionsReached, or the error code a document would be refused with, such as DISCOUNT_NO_AMOUNT_IN_CURRENCY.
lineIndexThe line it was refused on. Null: the cart as a whole.
DiscountCheckLimit
discountIdThe discount ID.
codeThe code it was claimed through. Null: named by id.
remainingUses left under maxRedemptions. Null: no total limit.
remainingForCustomerUses left for the customer under maxPerCustomer. Null: no such limit, or a guest.
remainingForCodeUses left under the code's own maxRedemptions. Null: named by id, or the code has no limit.
DiscountCheckResponse
Every line of the request, in order.
One row per discount the cart named.
DiscountApplicabilityResponse
applicableWhether the discount applies to this customer and product on this day.
reasonNull when it applies. Otherwise the first check that failed: unknown (no such discount in your company), inactive, codeRequired (the discount applies only through a code), notAssigned (no assignment names this product and customer, or all), notInGroup (an assignment would match, but the product or the customer is not in the group it targets), outsideWindow (an assignment matches, but not on this day), maxRedemptionsReached (no use left under maxRedemptions), maxPerCustomerReached (no use left for this customer under maxPerCustomer).
remainingUses left under maxRedemptions, counted from booked invoices whose uses no full credit note has given back. Null when the discount has no total limit, or no such discount exists in your company.
remainingForCustomerUses left for this customer under maxPerCustomer. Null when the discount has no per-customer limit, or no such discount exists in your company.
CreateDiscountRequest
namePrinted as the reason on the e-invoice allowance.
typepercentage takes a percent off; fixed takes an amount off, per eligible line for a line discount or once per document for a document discount; per_unit takes an amount off each unit on a line and takes line scope only. The type cannot change after the discount is created.
scopeline applies to each eligible line on its own. document applies once per document, after every line discount, when the customer matches and at least one line has an eligible product. A per_unit discount with document scope is refused with DISCOUNT_PER_UNIT_NEEDS_LINE_SCOPE.
percentagePctRequired for a percentage discount, refused for other types: the percent off, above 0 and at most 100, with at most 4 decimals. Outside that range: DISCOUNT_INVALID_PERCENTAGE.
priorityThe order the server applies discounts in when it picks them itself; lowest first. Defaults to 0.
combinableFalse: a line may not reference this discount together with another one. Defaults to true.
activeAn inactive discount applies nowhere. Defaults to true.
requiresCodeTrue: the discount applies only through one of its codes. A document or an applicability check that names it by its id alone is refused with the reason codeRequired, and GET /v1/discounts/applicable leaves it out. Defaults to false.
maxRedemptionsTotal uses allowed. Null or omitted: no limit.
maxPerCustomerUses allowed per customer. Null or omitted: no limit.
durationInPeriodsHow many billing periods the discount lasts on a subscription that references it. Null or omitted: for as long as the reference stands.
Fixed and per-unit discounts only: one positive amount per currency, each currency at most once. Amounts are never converted between currencies. Refused on a percentage discount.
UpdateDiscountRequest
namePrinted as the reason on the e-invoice allowance.
typeAccepted only when it equals the current type. The type cannot change after creation: a different value is refused with DISCOUNT_TYPE_IMMUTABLE.
scopeline applies to each eligible line on its own. document applies once per document, after every line discount, when the customer matches and at least one line has an eligible product. A per_unit discount with document scope is refused with DISCOUNT_PER_UNIT_NEEDS_LINE_SCOPE.
percentagePctPercentage discounts only: above 0 and at most 100, with at most 4 decimals. Outside that range: DISCOUNT_INVALID_PERCENTAGE.
priorityThe order the server applies discounts in when it picks them itself.
combinableFalse: a line may not reference this discount together with another one.
activeAn inactive discount applies nowhere.
requiresCodeTrue: the discount applies only through one of its codes. A document or an applicability check that names it by its id alone is refused with the reason codeRequired, and GET /v1/discounts/applicable leaves it out.
maxRedemptionsNull removes the limit.
maxPerCustomerNull removes the limit.
durationInPeriodsNull: lasts for as long as a subscription references it.
applyToSubscriptionsTrue accepts moving the subscriptions that reference the discount onto the edited terms: each takes them from its next billing period, as a new version. Omitted or false: an edit that changes what the discount takes off (percent, amount, scope, combinable) while subscriptions reference it is refused with DISCOUNT_IN_USE_ON_SUBSCRIPTIONS and nothing is saved.
DiscountOpenDocument
idThe quote, order confirmation or invoice ID; for a subscription, the ID of its version in effect (the id GET /v1/subscriptions/customer-subscriptions/{id} takes).
kindWhat kind of document it is.
numberThe document number. Null until the document is sent, and for a subscription.
referenceThe document's reference, if it has one; a subscription's name.
statusThe stored status: draft, sent or accepted for a quote or order confirmation, draft for an invoice, the subscription's own status for a subscription.
validUntilA quote's expiry date (YYYY-MM-DD); null for other documents.
DiscountInUseOnOpenDocumentsWarning
codetotalHow many open documents reference the discount.
The open documents, newest first, at most 50, of the kinds your key may read: quotes with quotes-read, order confirmations with order-confirmations-read, invoices with invoices-read. total counts them all.
DiscountSubscriptionTermsChange
customerSubscriptionIdThe subscription version the change was applied from; when scheduled, the new version.
chainHeadIdThe id of the subscription's first version, the same on every version.
nameNull unless your key has subscriptions-read.
customerNameNull unless your key has subscriptions-read.
effectiveDateThe first day billed on the new terms (YYYY-MM-DD): the start of the next billing period.
outcomescheduled: a new version from effectiveDate bills the new terms. failed: the subscription keeps billing the old terms; errorCode says why.
errorCodeUpdateDiscountResponse
idThe discount ID.
namePrinted as the reason on the e-invoice allowance.
typepercentage takes a percent off; fixed takes an amount off, per eligible line for a line discount or once per document for a document discount; per_unit takes an amount off each unit on a line and takes line scope only. The type cannot change after the discount is created.
scopeline applies to each eligible line on its own. document applies once per document, after every line discount, when the customer matches and at least one line has an eligible product. A per_unit discount with document scope is refused with DISCOUNT_PER_UNIT_NEEDS_LINE_SCOPE.
percentagePctPercentage discounts only: the percent taken off, above 0 and at most 100. Null for other types.
priorityThe order the server applies discounts in when it picks them itself; lowest first.
combinableFalse: a line may not reference this discount together with another one.
activeAn inactive discount applies nowhere.
requiresCodeTrue: the discount applies only through one of its codes. A document or an applicability check that names it by its id alone is refused with the reason codeRequired, and GET /v1/discounts/applicable leaves it out.
maxRedemptionsTotal uses allowed. Null: no limit.
maxPerCustomerUses allowed per customer. Null: no limit.
durationInPeriodsHow many billing periods the discount lasts on a subscription that references it. Null: for as long as the reference stands.
Fixed and per-unit discounts: one positive amount per currency, sorted by currency. Empty for a percentage discount. A discount is applied only to a document line or document that references its id; creating or assigning it changes no document on its own.
Where the discount applies: each assignment names a product, a customer and a window of days, any of them null for "all". A discount with no assignment applies nowhere.
Warnings about the edit, empty when there is nothing to warn about. DISCOUNT_IN_USE_ON_OPEN_DOCUMENTS lists the open quotes (not converted, rejected or expired), order confirmations (not converted) and invoice drafts that reference the discount. The edit is saved either way. A sent quote or order confirmation keeps its discount figures until it is converted; an invoice draft takes the new value the next time it is saved. Given when the edit changed what the discount takes off or where it applies (percent, amounts, scope, active, combinable, requiresCode); a rename or a change to priority or limits gives none.
With applyToSubscriptions: true, the subscriptions whose terms the edit changed: each takes the new terms from its next billing period. Empty otherwise.
SetDiscountAmountRequest
amountThe amount in the path's currency. What the discount takes off in this currency, in major units, as a positive decimal string. Each currency carries its own amount: a document in a currency the discount has no amount for is refused, never converted at an exchange rate.
applyToSubscriptionsTrue accepts moving the subscriptions that reference the discount onto the edited terms: each takes them from its next billing period, as a new version. Omitted or false: an edit that changes what the discount takes off (percent, amount, scope, combinable) while subscriptions reference it is refused with DISCOUNT_IN_USE_ON_SUBSCRIPTIONS and nothing is saved.
CreateDiscountAssignmentRequest
productIdThe product the discount applies to. Null or omitted, with no product group: every product.
productGroupIdThe product group the discount applies to: every product in it. Set at most one of productId and productGroupId; both is refused with DISCOUNT_ASSIGNMENT_TARGET_CONFLICT.
customerIdThe customer the discount applies to. Null or omitted, with no customer group: every customer.
customerGroupIdThe customer group the discount applies to: every customer in it. Set at most one of customerId and customerGroupId; both is refused with DISCOUNT_ASSIGNMENT_TARGET_CONFLICT.
startsAtFirst calendar day it applies, inclusive (YYYY-MM-DD). Null or omitted: from any day.
endsAtLast calendar day it applies, inclusive (YYYY-MM-DD). Null or omitted: it never ends.
UpdateDiscountAssignmentResponse
idThe assignment ID.
discountIdThe discount this assignment belongs to.
productIdThe product the discount applies to. Null, with no product group: every product.
productGroupIdThe product group the discount applies to: every product whose group it is, at the time a document is checked. Null: no group target. Never set together with productId.
customerIdThe customer the discount applies to. Null, with no customer group: every customer.
customerGroupIdThe customer group the discount applies to: every customer whose group it is, at the time a document is checked. Null: no group target. Never set together with customerId.
startsAtFirst calendar day the discount applies, inclusive (YYYY-MM-DD). Null: from any day.
endsAtLast calendar day the discount applies, inclusive (YYYY-MM-DD). Null: it never ends.
Warnings about the edit, empty when there is nothing to warn about. DISCOUNT_IN_USE_ON_OPEN_DOCUMENTS lists the open quotes (not converted, rejected or expired), order confirmations (not converted) and invoice drafts that reference the discount. The edit is saved either way. A sent quote or order confirmation keeps its discount figures until it is converted; an invoice draft takes the new value the next time it is saved. Given when an assignment is added, or an edit moves its product, product group, customer, customer group or dates.
UpdateDiscountAssignmentRequest
productIdThe product the discount applies to. Null or omitted, with no product group: every product.
productGroupIdThe product group the discount applies to: every product in it. Set at most one of productId and productGroupId; both is refused with DISCOUNT_ASSIGNMENT_TARGET_CONFLICT.
customerIdThe customer the discount applies to. Null or omitted, with no customer group: every customer.
customerGroupIdThe customer group the discount applies to: every customer in it. Set at most one of customerId and customerGroupId; both is refused with DISCOUNT_ASSIGNMENT_TARGET_CONFLICT.
startsAtFirst calendar day it applies, inclusive (YYYY-MM-DD). Null or omitted: from any day.
endsAtLast calendar day it applies, inclusive (YYYY-MM-DD). Null or omitted: it never ends.
RemoveDiscountAssignmentResponse
Warnings about the edit, empty when there is nothing to warn about. DISCOUNT_IN_USE_ON_OPEN_DOCUMENTS lists the open quotes (not converted, rejected or expired), order confirmations (not converted) and invoice drafts that reference the discount. The edit is saved either way. A sent quote or order confirmation keeps its discount figures until it is converted; an invoice draft takes the new value the next time it is saved. Given whenever open documents reference the discount, since removing an assignment narrows where it applies.
DiscountCode
idThe code ID.
discountIdThe discount the code claims.
codeThe code as it was entered, without surrounding spaces.
normalizedCodeThe code trimmed and upper-cased: the text a lookup matches on.
customerIdThe one customer who may use the code. Null: any customer the discount applies to.
maxRedemptionsUses allowed through this code. Null: no limit of its own.
expiresAtLast calendar day the code may be used, inclusive (YYYY-MM-DD). Null: it never expires.
activeFalse: the code is switched off and its text may be reused by a new code.
usesUses counted through this code: booked invoices whose use no full credit note has given back.
createdAtWhen the code was created (ISO 8601).
ListDiscountCodesResponse
Page of the discount's codes, active and switched off, oldest first.
totalTotal number of codes the discount has
pageCurrent page number
limitItems per page
totalPagesTotal number of pages
CreateDiscountCodeRequest
codeThe code a customer types: 1 to 64 characters with no space inside, matched without regard to case or surrounding spaces. Otherwise DISCOUNT_CODE_INVALID; an active code of your company with the same text: DISCOUNT_CODE_TAKEN.
customerIdThe one customer who may use the code. It must be a customer the discount's assignments cover, or DISCOUNT_CODE_CUSTOMER_NOT_ASSIGNED. Null or omitted: any customer.
maxRedemptionsUses allowed through this code. Null or omitted: no limit.
expiresAtLast calendar day the code may be used, inclusive (YYYY-MM-DD). Null or omitted: never expires.
activeDefaults to true.
UpdateDiscountCodeRequest
activeFalse switches the code off. True switches it back on, refused with DISCOUNT_CODE_TAKEN if another active code now holds its text.
customerIdNull: any customer the discount applies to.
maxRedemptionsNull removes the limit.
expiresAtNull: never expires.
EntitlementResponse
idEntitlement ID
nameEntitlement name
managedExternallyTrue when the entitlement is maintained by an external system rather than created by an operator in the app. Only rows with externalSource "api" can be modified through this API.
externalSourceWhich system maintains the entitlement: "api" (created via this API), "platform" (managed by LedgerBee, read-only here), or null for operator-created rows.
createdAtWhen the entitlement was created
updatedAtWhen the entitlement was last updated
keyStable integration key
ListEntitlementsResponse
totalpagelimittotalPagesCreateEntitlementRequest
nameEntitlement name
keyStable integration key
ProductPriceTierResponse
idTier ID
fromQuantityStarting quantity (inclusive)
unitAmountPrice per unit for this tier
toQuantityEnding quantity (inclusive). Null = no upper limit.
flatFeeOptional flat fee for this tier
ProductPriceResponse
idThe unique identifier of the price (use as a line priceId)
productIdThe product this price belongs to
billingPeriodTypeBilling period type
pricingModelPricing model
currencyCurrency of the displayed unitAmount (ISO 4217)
baseCurrencyBase currency (source of truth for conversions)
statusPrice status
isDefaultWhether this is the default price for the product
isLockedWhether the price is locked (in use by a subscription/invoice)
allowFreePriceThe owning product's allowFreePrice: whether a 0 on this price is a deliberate free price rather than no price set.
vatRatesByZoneVAT rates by zone (derived from the product group), e.g. { domestic: "25", eu: "0", abroad: "0", domestic_without_vat: "0" }
nicknameOptional nickname (e.g. "Monthly")
unitAmountUnit amount for flat-rate pricing in currency
billingIntervalBilling interval (null for one-time)
billingIntervalCountBilling interval count
availableCurrenciesCurrencies with a price-history entry
meterIdMeter ID for usage-based pricing
Pricing tiers (package/volume/graduated)
ProductListItem
idThe unique identifier of the product
productNumberUnique product number within the company
nameName of the product
unitUnit of measurement
productGroupIdProduct group this product belongs to
productTypeProduct type (goods or services) for EU VAT
isActiveWhether the product is active
isArchivedWhether the product is archived
isLockedWhether the product is locked (in use, cannot be deleted)
allowFreePriceWhether a price of 0 on this product is a deliberate free price. Off, a price of 0 cannot be saved and a stored 0 reads as no price set.
createdAtWhen the product was created
updatedAtWhen the product was last updated
descriptionOptional description
Prices configured for this product
Key-value metadata attached to the product
ListProductsResponse
Page of products, each with its prices (GET one product for its entitlements)
totalTotal number of matching products
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.
ProductResponse
idThe unique identifier of the product
productNumberUnique product number within the company
nameName of the product
unitUnit of measurement
productGroupIdProduct group this product belongs to
productTypeProduct type (goods or services) for EU VAT
isActiveWhether the product is active
isArchivedWhether the product is archived
isLockedWhether the product is locked (in use, cannot be deleted)
allowFreePriceWhether a price of 0 on this product is a deliberate free price. Off, a price of 0 cannot be saved and a stored 0 reads as no price set.
createdAtWhen the product was created
updatedAtWhen the product was last updated
descriptionOptional description
Prices configured for this product
Entitlements granted by this product
Key-value metadata attached to the product
CreateProductPriceTierRequest
fromQuantityStarting quantity (inclusive)
unitAmountPrice per unit for this tier
toQuantityEnding quantity (inclusive). Omit for the open-ended top tier.
flatFeeOptional flat fee for this tier
CreateProductInitialPriceRequest
billingPeriodTypeBilling period type. RECURRING and USAGE both require a Subscription license.
pricingModelPricing model
nicknameOptional nickname (e.g. "Monthly")
unitAmountUnit amount. Required for FLAT_RATE pricing; for tiered models (PACKAGE/VOLUME/GRADUATED) the amounts live in tiers.
billingIntervalBilling interval (required unless one-time)
billingIntervalCountBilling interval count
currencyCurrency code (ISO 4217)
meterIdMeter ID (required for USAGE pricing)
Pricing tiers. Required for tiered models: PACKAGE (exactly 1), VOLUME / GRADUATED (one or more, last tier open-ended). Omit for FLAT_RATE.
CreateProductRequest
productNumberUnique product number within the company
nameName of the product
unitUnit of measurement
productGroupIdProduct group this product belongs to (must exist)
descriptionOptional description
isActiveWhether the product is active
productTypeProduct type (goods or services)
allowFreePriceWhether a price of 0 on this product is a deliberate free price. Off, a price of 0 cannot be saved.
Optional initial price. If provided it is created, activated and set as default in one transaction.
entitlementIdsExternally managed entitlement IDs to bind (max 100)
Key-value metadata to attach to the product. At most 50 entries; keys up to 128 characters, string values up to 500 characters.
UpdateProductRequest
productNumberUnique product number within the company
nameName of the product
descriptionOptional description
unitUnit of measurement
productGroupIdProduct group this product belongs to
isActiveWhether the product is active
productTypeProduct type (goods or services)
allowFreePriceWhether a price of 0 on this product is a deliberate free price. Omit to leave unchanged. Turning it off leaves stored prices as they are.
entitlementIdsExternally managed entitlement IDs to bind (max 100)
Key-value metadata. When provided, REPLACES the product metadata wholesale — send the complete desired map; an empty object clears all entries. Omit the field to leave metadata unchanged. At most 50 entries; keys up to 128 characters, string values up to 500 characters.
OnHandRowDTO
productIdproductNamewarehouseIdlocationIdqualityStatusQuality status of the stock this row counts.
quantityOn-hand at the stock ledger's own scale.
ListOnHandResponseDTO
totallimitnextCursorCursor 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.
StockMovementRowDTO
idmovementNoThe movement number, allocated when it was recorded.
productIdfromWarehouseIdNull when the stock came from outside every warehouse.
toWarehouseIdNull when the stock left for outside every warehouse.
quantityUnits moved, at the stock ledger's own scale.
occurredAtWhen the stock actually moved (ISO 8601).
accountingDateThe date the movement is accounted on (YYYY-MM-DD).
movementReasonWhy the stock moved.
sourceDocumentTypeThe kind of document that caused it, e.g. SHIPMENT.
sourceDocumentIdThat document, so you can join the movement back to it.
ListStockMovementsResponseDTO
totallimitnextCursorCursor 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.
CreateShipmentLineDTO
productIdThe product to ship.
quantityUnits ordered.
unitPricePrice per unit, in the order's currency.
CreateShipmentDTO
warehouseIdThe warehouse the goods leave from.
customerEmailThe buyer's email. Matched against your customers; created when new.
currencyISO 4217 alpha-3 currency code.
customerNameThe buyer's name, used when the customer has to be created.
customerCountryCodeISO 3166-1 alpha-2 country the goods go to. Used when the customer has to be created: outside the EU the buyer is placed abroad and billed without VAT; inside the EU, or when omitted, in your company's domestic VAT zone.
externalOrderIdYour own order reference. Quoted back on any refusal this request answers with.
orderDateOrder date (YYYY-MM-DD). Defaults to today.
taxTotalYour own tax total for the order. Compared against the draft's VAT; a difference larger than rounding is refused rather than posted.
ShipmentDTO
idshipmentNoAllocated at dispatch; null while the shipment is a draft.
statuswarehouseIdcustomerIdinvoiceIdThe draft invoice this shipment ships against.
dispatchedAtcreatedAtListShipmentsResponseDTO
totallimitnextCursorCursor 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.
DispatchShipmentDTO
accountingDateAccounting date for the cost posting (YYYY-MM-DD). Defaults to today.
trackingNumberThe carrier's tracking number for the parcel. Recorded on the shipment, and reported back to the shop when this shipment came from a sales-channel order.
PublicOpenEntry
kindWhat this row points at. Echo it back verbatim as a settlement selection — an ANCHOR and a PREPAYMENT are stored alike and are not interchangeable.
idID of the entry — the invoice anchor for ANCHOR and PREPAYMENT rows, the payment entry for PAYMENT.
typeWhat the entry is.
referenceInvoice number, payment reference, or anchor number.
datePosting date of the original entry (YYYY-MM-DD).
currencyCurrency of the original entry (3-letter ISO).
originalAmountSigned face amount in the entry’s own currency. Positive on an invoice, negative on a credit note.
remainingAmountSigned amount still open, in the entry’s own currency. This is the ceiling for amountToApply.
baseRemainingAmountThe same remaining amount converted to the company’s base currency at the entry’s booked rate.
versionConcurrency token. Pass it back on a settlement selection and the request is refused if the entry changed in the meantime.
settledWithRemainderTrue on an invoice or credit note that is recorded as paid while part of it, less than its whole amount, is still left on it. remainingAmount and baseRemainingAmount are then only that amount, and the per-currency totals include it. Such an entry settles only together with entries that cancel it exactly in the base currency, so the settlement posts nothing; any other selection that includes it is refused with SETTLEMENT_SETTLED_DOCUMENT_REQUIRES_BALANCED_MATCH.
prepaymentKindWhat the held credit is, on PREPAYMENT rows only. ADVANCE is money toward future invoices; HELD_DEPOSIT is a security deposit held and owed back; REFUNDABLE is money that bought nothing — a double payment or an overpayment the counterparty wants returned. All three settle against an invoice the same way; the kind says what the balance is for.
bookedExchangeRateThe rate that converted this entry to base currency when it was booked. Null when the entry is already in base currency.
dueDateWhen the document falls due (YYYY-MM-DD). Null on payments and on documents carrying no due date.
daysOverdueWhole days past due as of the request’s cut-off; 0 means not yet due. Null on payments and prepayments, neither of which is a claim.
journalEntryIdThe journal entry behind this row, when one exists. Null on an imported entry with no backing entry.
PublicOpenEntriesCurrencyTotal
currency3-letter ISO currency code.
remainingTotalSigned sum of the listed rows’ remaining amounts in this currency.
PublicOpenEntriesTotals
One total per currency the listed entries are denominated in.
baseCurrencyOutstandingThe counterparty’s authoritative outstanding balance in the company’s base currency. It includes the opening balance, which the rows deliberately do not carry — so summing baseRemainingAmount across the rows does NOT reproduce it. Read this figure; never derive one.
PublicOpenEntriesResponse
baseCurrencyThe company’s base currency (3-letter ISO).
asOfThe date this response answers as of. Always present — it is the requested cut-off, or today when none was given, so it does not tell you which was asked for.
The counterparty’s open entries.
PublicSettlementListItem
idID of the settlement.
postingDateAccounting date the settlement posted on (YYYY-MM-DD).
createdAtWhen the settlement was recorded.
counterpartyTypecounterpartyIdThe customer or supplier the entries belong to.
reversedWhether the settlement has been reversed. A reversed settlement contributes nothing — its entries are open again.
baseAmountSettledTotal value settled, in the company’s base currency.
reversedAtWhen it was reversed. Null while it stands.
reversalReasonWhy it was reversed. Null while it stands.
residualJournalEntryIdThe journal entry carrying the difference, when the entries did not net to zero. Null when they balanced exactly.
PublicSettlementsResponse
baseCurrencyThe company’s base currency (3-letter ISO).
PublicSettlementEntry
kindtypeidThe entry that was settled — the same id the open-entries listing reports.
referenceInvoice number, payment reference, or anchor number.
datePosting date of the entry (YYYY-MM-DD).
currencyCurrency of the entry (3-letter ISO).
originalAmountThe entry’s full signed amount in its own currency. A settlement may consume only part of it, so compare against appliedAmount.
appliedAmountSigned amount this settlement applied, in the entry’s currency.
baseAmountAppliedThe same applied amount in the company’s base currency.
journalEntryIdThe journal entry behind it, when one exists.
PublicSettlementDifferenceLeg
accountIdThe ledger account posted to.
accountNumberAccount number as it appears in the chart of accounts.
accountNameAccount name.
typeWhich side the amount posted on.
baseAmountMagnitude in base currency — always positive; the side is on type.
PublicSettlementDifference
journalEntryIdThe journal entry carrying the difference.
descriptionWhat the posting says it is — this is where an exchange difference is distinguished from a write-off.
PublicSettlement
idID of the settlement.
postingDateAccounting date the settlement posted on (YYYY-MM-DD).
createdAtWhen the settlement was recorded.
counterpartyTypecounterpartyIdThe customer or supplier the entries belong to.
reversedWhether the settlement has been reversed. A reversed settlement contributes nothing — its entries are open again.
baseCurrencyThe company’s base currency (3-letter ISO).
The entries this settlement linked, and how much of each it applied.
reversedAtWhen it was reversed. Null while it stands.
reversalReasonWhy it was reversed. Null while it stands.
differenceThe difference posting, when the entries did not net to zero. Null when they balanced exactly.
PublicSettlementEntrySelection
kindThe kind the open-entries listing reported for this entry. Echo it back unchanged.
idThe id the open-entries listing reported for this entry.
amountToApplyHow much of the entry to apply, in the entry’s own currency.
Always positive — send the absolute value. The open-entries listing reports a credit note or a
payment with a NEGATIVE remainingAmount, and passing that figure back is refused. Which direction an
entry moves the balance follows from what it is, so the sign is never yours to state: take
Math.abs(remainingAmount), and at most that.
The response signs it for you — an entry consumed reads negative, one that consumes reads positive.
versionThe version the open-entries listing reported. Supplying it refuses the settlement if the entry was
EDITED or REVERSED in between; omitting it settles against whatever the entry is now.
It does not move when another settlement applies to the same entry, so an unchanged version is not a
promise that the entry still has as much open as it did. Applying more than remains is refused on its
own, against the amount at the moment of the write rather than the one you read.
PublicSettleRequest
postingDateAccounting date to post the settlement on (YYYY-MM-DD).
The entries to settle against each other — at least two, since a settlement links something owed to something that pays it. All must belong to the named counterparty.
customerIdRead the customer’s entries. Mutually exclusive with supplierId; exactly one is required.
supplierIdRead the supplier’s entries. Mutually exclusive with customerId; exactly one is required.
idempotencyKeyYour own key for this settlement. Sending the same key with the same body returns the original settlement instead of posting a second one, so a retry after a timeout is safe.
PublicSettlementPreviewEntry
idThe entry, as named in the request.
kindappliedAmountSigned amount that would be applied, in the entry’s own currency.
baseAmountAppliedThe same amount in the company’s base currency.
exchangeRateRate used to convert it.
rateSourcestatusAfterWhat this entry’s status becomes. Null for a payment, which carries no status of its own.
fullyConsumedAfterWhether a payment is used up entirely. Null for anything that carries a status instead.
PublicSettlementDifferencePreview
kindbaseAmountThe difference in the company’s base currency, signed: it is the net of baseAmountApplied across the entries — what the applied amounts leave uncancelled. Zero when the entries balance.
labelWhat the difference is, in words — for example "Realized FX gain".
accountThe account the difference would post to. Null when there is nothing to post.
PublicSettlementPostingLine
accountIdThe ledger account posted to.
accountLabelAccount number and name.
currencyCurrency of the line (3-letter ISO).
originalAmountSigned amount in that currency.
exchangeRateRate used to convert it.
baseAmountThe same amount in the company’s base currency.
kindPublicSettlementRateGapCurrency
currencyminRateLowest rate any selected entry in this currency was booked at.
maxRateHighest rate any selected entry in this currency was booked at.
spreadHow far apart the two are, as a fraction of the higher one.
PublicSettlementPreview
baseCurrencyThe company’s base currency (3-letter ISO).
postingDateAccounting date the settlement would post on.
What each named entry would have applied to it, and what it becomes.
The lines that would post. Empty when the entries balance and nothing needs a posting.
blockersError codes that would refuse the settlement. A non-empty list means the commit fails with the first of them.
warningsCodes for things worth checking. The settlement would still post.
Which currencies’ entries disagree about the rate, widest first. Present only alongside the rate-gap warning, and null otherwise — it names the rates to check the booked ones against.
PublicSettlementCreated
idThe settlement. Read it back at GET /v1/settlements/{id}.
differenceJournalEntryIdThe journal entry carrying the difference, when the entries did not net to zero. Null when they balanced exactly.
vatReclassJournalEntryIdThe journal entry that moved a prepayment’s VAT onto the invoice it was applied to. Null unless the settlement did that.
PublicReverseSettlementReopenedEntry
kindtypeidThe entry’s id, as the open-entries listing reports it.
referenceInvoice number, payment reference or entry number.
currencyISO 4217 currency of the entry.
appliedAmountSigned amount the settlement applied to this entry, in its own currency. Undoing the settlement puts it back on the entry.
PublicReverseSettlementPreview
settlementIdThe settlement this preview is about.
alreadyReversedTrue when the settlement was already undone. Reversing it again changes nothing and answers with the earlier outcome.
reversalDateThe date the mirror entries post on: today. Its accounting period has to be open.
The entries the settlement linked. Each is open again for what the settlement applied to it.
journalEntriesMirroredJournal entries the settlement posted (its difference, VAT reclass and receivable transfer) that the reversal mirrors with a linked reversal entry. Empty when the settlement posted nothing.
PublicReverseSettlementRequest
reasonWhy the settlement is being undone. Stored on the settlement and shown in the activity feed of every entry it linked.
PublicReverseSettlementResponse
idThe settlement that was undone.
differenceReversalJournalEntryIdThe reversal of the settlement’s difference entry, or null when it posted none.
vatReclassReversalJournalEntryIdThe reversal of the settlement’s VAT reclass entry, or null when it posted none.
receivableTransferReversalJournalEntryIdThe reversal of the settlement’s receivable transfer, or null when it posted none.
PublicCreditNoteLinkPreviewRequest
creditNoteIdThe credit note: the id the open-entries listing reports for a row of type CREDIT_NOTE. A customer and a supplier credit note are both accepted; the side is read off the note.
invoiceIdThe invoice to check the credit note against: the id the open-entries listing reports for a row of type INVOICE. Named, the preview is refused whenever linking the two would be (another counterparty or currency, a settled invoice, today’s accounting period closed, a rate gap not accepted), and nothing is changed. Omit it to list the candidates only.
requireAppliedWhen true, refuse whatever unlinking the credit note would refuse: 409 CREDIT_NOTE_LINK_NOT_LINKED when it is applied to no invoice, a settlement holding it that also settled a payment, and today’s accounting period being closed.
confirmRateGapWith invoiceId, accept a gap between the two booked exchange rates, as the link call does. Without it, a pair booked at rates far apart is refused here as the link would refuse it.
PublicCreditNoteAppliedInvoice
invoiceIdThe invoice the credit note is applied to.
invoiceNumberIts invoice number, or null when it carries none.
PublicCreditNoteLinkState
creditNoteIdsidecurrencyISO 4217 currency of the credit note.
Every invoice the credit note is applied to, whether by a link or by a settlement pairing the two. Empty when it is applied to none.
unusedCreditAmountCredit not yet spoken for, as a positive magnitude in the note’s currency: what a further link to an invoice it is ALREADY on can absorb.
releasableCreditAmountThe unused credit plus what releasing its current applications would hand back, as a positive magnitude: what an invoice it is NOT yet on can absorb, since linking it there releases the others first.
PublicCreditNoteLinkCandidate
invoiceIdinvoiceNumberdateInvoice date (YYYY-MM-DD).
dueDateDue date (YYYY-MM-DD), or null.
currencyoriginalAmountThe invoice’s face amount, as a positive magnitude.
remainingAmountWhat is still owed on it, net of credits and payments, as a positive magnitude.
PublicCreditNoteLinkPreview
Open invoices of the same counterparty in the same currency the note can be linked to, closest amount first.
invoiceIsCandidateWhether invoiceId is among the candidates. Null when no invoice was named. A named invoice the credit note cannot be linked to refuses the preview itself, with the reason the link call would give.
PublicCreditNoteLinkRequest
creditNoteIdThe credit note: the id the open-entries listing reports for a row of type CREDIT_NOTE.
invoiceIdThe invoice (or supplier bill) it credits: the id the open-entries listing reports for a row of type INVOICE. Same counterparty and currency as the credit note.
confirmRateGapAccept that the two documents were booked at exchange rates further apart than the confirmation threshold. Without it such a pair is refused with CREDIT_NOTE_LINK_RATE_GAP_CONFIRMATION_REQUIRED, whose details carry both rates.
PublicCreditNoteUnlinkRequest
creditNoteIdThe credit note to detach from every invoice it is applied to.
PublicBankReconciliationRequest
bankTransactionIdsThe bank lines to reconcile, all unreconciled. Several lines may face one target (a payment that arrived in parts), or one line several targets — not several of each.
journalEntryIdsBooked journal entries the lines settle: a payment entry already posted to the bank account, or the invoice entry a payment is to be created for. Each must be live (not reversed) and unreconciled.
openEntryIdsOpen invoices, credit notes or payments the lines settle, by the id the open-entries listing reports. An invoice or credit note is matched through its newest booked, unreconciled entry, the one the reconciliation screen would pick; a payment row is its own entry.
draftJournalEntryIdA draft journal entry the lines settle, instead of booked or open entries: an editable, unreconciled, non-invoice draft that already carries the line on the bank’s account or is balanced onto it. It is matched alone, so it cannot be combined with journalEntryIds, openEntryIds or journalCategoryId (400 BANK_RECONCILE_DRAFT_TARGET_CONFLICT). An invoice draft is refused with BANK_INBOX_INVOICE_NOT_SUPPORTED: match its payment draft instead. bookPayments books the draft in the same call.
descriptionA note stored on the reconciliation.
journalCategoryIdJournal category for a payment the reconciliation creates. Omit it to let the category be chosen the way the reconciliation screen chooses it.
bookPaymentsBook the payments the reconciliation creates in the same call. Omitted or false, they are created as drafts to book separately.
PublicBankReconciliationPreviewBankLine
idbankAccountIdThe bank account the line belongs to.
signedAmountSigned: negative is money out.
currencydateYYYY-MM-DD.
autoIncludedTrue for the other side of an own-account transfer, which the reconciliation covers too.
PublicBankReconciliationPreviewLine
accountNumberaccountNametypeledgerCurrencyAmountMagnitude in the account’s own currency.
ledgerCurrencyThe account’s currency.
baseCurrencyAmountMagnitude in the company’s base currency.
PublicBankReconciliationPreviewPayment
journalTypeThe payment entry’s journal type.
datePosting date (YYYY-MM-DD).
currencyCurrency of the entry.
isOverpaymentThe line pays more than the invoice is owed.
invoiceJournalEntryIdThe invoice entry this payment settles.
invoiceReferenceappliedInvoiceAmountAmount applied to the invoice, in the invoice’s currency.
invoiceStatusAfterThe invoice’s status once the payment is booked.
PublicBankReconciliationPreviewWarning
codeseverityPublicBankReconciliationPreview
journalEntryIdsThe journal entries the lines would be reconciled against, with open entries resolved.
The payment entries the reconciliation would create, line by line. Empty when every target is already a payment.
offsetJournalEntryIdsInvoice entries that cancel each other inside the selection and settle without a bank payment.
PublicBankReconciliationCreatedPayment
journalEntryIdThe payment entry: a booked entry when bookPayments was true, a draft to book otherwise.
paymentTypeamountAmount in the bank line’s currency.
currencyinvoiceJournalEntryIdThe invoice entry it pays.
invoiceStatusPublicBankReconciliation
idThe reconciliation. Undo it with POST /v1/bank-reconciliations/{id}/unreconcile.
bankTransactionIdsjournalEntryIdsoffsetJournalEntryIdsPublicBankReconciliationBatchItem
bankTransactionIdsThe bank lines this match reconciles, as on the single reconcile call.
journalEntryIdsBooked journal entries the lines settle.
openEntryIdsOpen entries the lines settle, by the open-entries id.
draftJournalEntryIdA non-invoice draft the lines settle, matched alone, as on the single reconcile call.
descriptionA note stored on this reconciliation.
PublicBankReconciliationBatchRequest
The matches, at most 50. Each is reconciled on its own, in order; a later match naming a bank line an earlier one names is refused with BANK_RECONCILE_BATCH_LINE_REPEATED, and one naming a draft an earlier one names with BANK_RECONCILE_BATCH_DRAFT_REPEATED.
bookPaymentsBook the payments every match creates, and a matched draft, in the same call. Omitted or false, they stay drafts.
journalCategoryIdJournal category for the payments the matches create. Not applied to a match that names a draft, which keeps its own.
PublicBankReconciliationBatchResultRow
indexThe position of the match in items, from 0.
successThe match was reconciled (or, in the preview, would be).
reconciliationIdThe reconciliation the match created; undo it with POST /v1/bank-reconciliations/{id}/unreconcile. Null on a refused row and in the preview.
errorCodeWhy the match was refused: the code the single reconcile call answers with. Null on success.
The refusal’s details, as the single reconcile call reports them.
PublicBankReconciliationBatchPreview
reconcilableCountMatches the batch would reconcile.
failedCountMatches the batch would refuse.
One row per match, in order.
PublicBankReconciliationBatch
reconciledCountfailedCountOne row per match, in order.
PublicUnreconcilePreviewRequest
reversalDateWhen the reversal of each booked payment posts: on the payment’s own date (ORIGINAL, the default) or today (TODAY).
reasonIgnored here; accepted so the undo body can be previewed as it is.
confirmPaymentReversalSend false to be answered 400 BANK_UNRECONCILE_REQUIRES_CONFIRMATION if the undo would reverse booked payments, as the undo itself would without confirmation. Omitted, the preview reports them in paymentsToReverse instead.
alsoReverseJournalEntryIdsAnswered 400 BANK_UNRECONCILE_ENTRY_NOT_REVERSIBLE when one of them is not an entry the undo would leave posted (entriesStillPostedAfterUndo), as the undo itself would refuse it.
PublicUnreconcileStillPostedEntry
journalEntryIdjournalTypedateYYYY-MM-DD.
entryNumberPublicUnreconcilePreview
reconciliationIdbankTransactionCountBank lines released, across the whole cluster when it was settled as one.
journalEntryCountdraftsToDeletePayment drafts the reconciliation created, deleted by the undo.
paymentsToReverseBooked payments the reconciliation created, reversed by the undo once confirmed.
requiresConfirmationThe undo needs confirmPaymentReversal: true.
Posted entries the undo only unlinks; they stay posted unless named in alsoReverseJournalEntryIds.
PublicUnreconcileRequest
reasonWhy the reconciliation is undone. Stored for the audit trail.
confirmPaymentReversalConfirms that the payments the reconciliation booked are reversed. Required when it booked any; the preview’s paymentsToReverse lists them.
reversalDatealsoReverseJournalEntryIdsEntries the undo would otherwise leave posted (the preview’s entriesStillPostedAfterUndo) to reverse as well. Any other id refuses the undo.
PublicUnreconcileResponse
reconciliationIddeletedDraftCountreversedPaymentCountalsoReversedEntryCountPublicBankTransactionCounterparty
nameThe name the bank sent with the line. Not a link to a customer or supplier.
ibanbicaccountNumberThe account number, when the bank sent one instead of an IBAN.
PublicBankTransactionFik
typeCodeThe payment slip type, such as 71 or 75.
creditorIdThe creditor number on the payment slip.
documentIdThe payment code on the slip, which names the invoice paid.
PublicBankTransactionReconciliation
reconciliationIdThe reconciliation. Undo it with POST /v1/bank-reconciliations/{reconciliationId}/unreconcile.
journalEntryIdsThe booked journal entries the line is reconciled to.
draftJournalEntryIdsDraft journal entries the reconciliation links that are not booked yet.
openEntryIdThe invoice or bill the line settled directly, as the id the open-entries listing reports. Null when it names none.
PublicBankTransaction
idbankAccountIdThe bank account the line is on.
bookingDateThe date the bank booked the line (YYYY-MM-DD).
valueDateThe date the money moved, as the bank reports it (YYYY-MM-DD).
bankAccountAmountThe amount in the bank account's currency (bankAccountCurrency). Negative for money out, positive for money in.
bankAccountCurrencyThe bank account's currency, which bankAccountAmount is in.
originalAmountThe amount in the currency the payment was made in, when the bank reports one, such as a card purchase abroad. In originalCurrency, with the sign of bankAccountAmount; on a line whose bankAccountAmount is 0 it is the figure as the bank sent it, which may carry either sign. Null when the bank reports none.
originalCurrencyoriginalExchangeRateThe rate the bank converted at, as it reports it. Null when it reports none.
directionWhich way the money went. Null on a zero-amount line.
descriptionThe line text.
bankTextThe bank's own text for the line, when it sends one apart from description.
referencepaymentMessageThe message the payer sent with the payment.
fikThe payment slip (FIK) the line was paid with. Null when the line carries none.
statusreconciliationWhat the line is reconciled to. Null unless status is reconciled.
dismissedAtWhen the line was taken off reconciliation (ISO 8601). Null unless status is dismissed, and null on a dismissed line whose dismissal time was not recorded.
createdAtWhen the line was recorded in LedgerBee (ISO 8601).
PublicListBankTransactionsResponse
totalLines matching the query, across all pages.
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 (1-indexed).
totalPagesDeprecated: page with nextCursor instead. Total pages.
PublicBankTransactionSelectionRequest
bankTransactionIdsThe bank lines to dismiss from reconciliation, or to restore to it, at most 50.
PublicBankTransactionDismissPreviewRow
bankTransactionIdeligibleThe line would be changed.
errorCodeWhy the line would not be changed: BANK_DISMISS_TRANSACTION_NOT_FOUND, BANK_DISMISS_TRANSACTION_RECONCILED (unreconcile it first), BANK_DISMISS_TRANSACTION_ALREADY_DISMISSED, or BANK_UNDISMISS_TRANSACTION_NOT_DISMISSED. Null when eligible.
PublicBankTransactionDismissPreview
eligibleCountLines the call would change.
ineligibleCountLines the call would leave as they are.
One row per line, in request order.
PublicBankTransactionDismissRow
bankTransactionIdchangedThe line was changed.
errorCodeWhy the line was left as it was; the same codes the preview reports. Null when changed.
PublicBankTransactionDismissResponse
changedCountunchangedCountOne row per line, in request order.
CreateProductPriceRequest
productIdThe product this price belongs to
billingPeriodTypeBilling period type. RECURRING and USAGE both require a Subscription license.
pricingModelPricing model
nicknameOptional nickname (e.g. "Monthly")
statusInitial status. Defaults to active, so the price is usable immediately. Pass draft to stage it and publish it later via the activate endpoint.
unitAmountUnit amount. Required for FLAT_RATE pricing; for tiered models (PACKAGE/VOLUME/GRADUATED) the amounts live in tiers.
billingIntervalBilling interval (required unless one-time)
billingIntervalCountBilling interval count
currencyCurrency code (ISO 4217). Defaults to the company default.
meterIdMeter ID (required for USAGE pricing)
Pricing tiers. Required for tiered models: PACKAGE (exactly 1), VOLUME / GRADUATED (one or more, last tier open-ended). Omit for FLAT_RATE.
UpdateProductPriceRequest
nicknameOptional nickname
unitAmountUnit amount for flat-rate pricing. A FLAT_RATE price other than a surcharge must end up with an amount: an update that leaves it without one, or that turns a price FLAT_RATE without sending one, is refused with PRODUCT_SELLING_PRICE_REQUIRED_FOR_FLAT_RATE. A surcharge carries a percentage and no amount. A VOLUME or GRADUATED price left with no tiers is refused with PRODUCT_PRICING_TIERS_REQUIRED. Disabling or archiving is not refused for a missing amount or missing tiers.
billingPeriodTypeBilling period type
pricingModelPricing model
billingIntervalBilling interval (null for one-time)
billingIntervalCountBilling interval count
currencyCurrency code (ISO 4217)
statusPrice status
meterIdMeter ID for usage-based pricing
Pricing tiers
DocumentTemplateListItem
idThe unique identifier of the template
nameTemplate name
documentTypeDocument type this template applies to
isDefaultWhether this is the default template for its document type
createdAtWhen the template was created
updatedAtWhen the template was last updated
ListDocumentTemplatesResponse
Page of document templates
totalTotal number of matching templates
pageCurrent page number
limitItems per page
totalPagesTotal number of pages
BudgetSummary
idThe unique identifier of the budget
nameBudget name
statusBudget status. Informational — the status does not restrict reads.
accountingYearIdAccounting year the budget covers
accountingYearStartDateAccounting year start date (ISO date, YYYY-MM-DD)
accountingYearEndDateAccounting year end date (ISO date, YYYY-MM-DD)
currencyISO 4217 currency every amount on this budget is denominated in — the company's base (functional) currency.
createdAtWhen the budget was created (ISO 8601)
updatedAtWhen the budget was last updated (ISO 8601)
dimensionCategoryIdDimension category scoping this budget: lines then carry per-dimension-value buckets. null for flat budgets.
ListBudgetsResponse
Page of budgets
totalTotal number of matching budgets
pageCurrent page number
limitItems per page
totalPagesTotal number of pages
BudgetRunwayResponse
currencyISO 4217 currency every amount is denominated in — the company's base (functional) currency.
cashOnHandSum of bank-account-linked ledger balances as of asOf (decimal string)
trailing3MonthBurnTrailing average net outflow over the last 3 closed months (decimal string). Negative when the company is cash-positive.
monthsRemainingCash divided by burn; null = infinite runway (burn ≤ 0)
statusOK (≥ 6 months), WATCH (3-6), LOW (< 3), or UNKNOWN (no cash source, or no closed periods to compute burn from — see hasCashSource).
hasCashSourceWhether at least one bank account is linked to a ledger account. When false, cashOnHand is a meaningless 0.
asOfISO date the cash and burn were computed as of
feedReportedCashTotalSum of provider-reported balances over active bank accounts in the functional currency (decimal string). null when any active account is held in another currency.
unlinkedBankAccountCountActive bank accounts with no linked ledger account — invisible to cashOnHand.
BudgetLine
idThe unique identifier of the budget line
ledgerIdLedger account this line budgets
ledgerNameLedger account name
accountNumberLedger account number
accountingPeriodIdAccounting period this cell belongs to (see periods)
amountBudgeted amount in the budget's currency (decimal string). For CLOSED periods this is the book actual (the cell then carries source: ACTUALS), matching the rolling-forecast grid the app shows.
dimensionValueIdDimension value bucket. null = the Unallocated bucket; absent for flat budgets.
formulaFormula text (e.g. =baseline*1.05), or null for a plain literal cell.
inputMethodHow the cell was entered. Absent on legacy rows (treat as MANUAL).
sourceProvenance of the value: ACTUALS = closed-period book actual; SUBSCRIPTION = filled from the subscription forecast. null/absent = user-entered.
errorPer-cell formula evaluation error code, when the cell could not resolve. null/absent = resolved.
baselinePrior accounting year's realised amount for the same account and calendar month (decimal string). null unless requested with ?includeBaseline=true.
BudgetPeriod
idAccounting period id
labelPeriod label
startDatePeriod start date (ISO date, YYYY-MM-DD)
endDatePeriod end date (ISO date, YYYY-MM-DD)
periodIndexPeriod index within the accounting year (1-12)
statusOPEN or CLOSED. Lines in CLOSED periods show the book actuals (rolling forecast), not the planned amount.
BudgetDriverCell
idThe unique identifier of the driver cell
accountingPeriodIdAccounting period this cell belongs to (see periods)
valueResolved value. Drivers are quantities (headcount, ARPU, …), not money, so this is a number.
formulaFormula text, or null for a plain literal cell.
errorPer-cell formula evaluation error code, when the cell could not resolve. null/absent = resolved.
BudgetScenarioOnlyDriverMonth
scenarioOverrideIdThe scenario change that gives this month its value
accountingPeriodIdAccounting period (see periods)
valueThe scenario's value for this month
BudgetDriverRow
idThe unique identifier of the driver row
nameDisplay name
handleStable token used to reference this row in formulas
displayOrderDisplay order among the driver rows
Per-period cells
unitUnit label (e.g. "FTE", "%").
Present on a scenario grid only: the months this scenario gives a value where the budget has no driver cell. Each is a scenario change, not a driver cell, so it is not in cells.
BudgetRowOverride
ledgerIdLedger account the override applies to
isHiddenWhether the row is hidden from the editor (still counted in totals).
labelBudget-local display name overriding the account name. null = default name.
BudgetRowNumber
lineNumberStable reference number used by #N formula references
ledgerIdLedger account this number belongs to. Exactly one of ledgerId / driverRowId is set.
driverRowIdDriver row this number belongs to. Exactly one of ledgerId / driverRowId is set.
BudgetDetail
idThe unique identifier of the budget
nameBudget name
statusBudget status. Informational — the status does not restrict reads.
accountingYearIdAccounting year the budget covers
accountingYearStartDateAccounting year start date (ISO date, YYYY-MM-DD)
accountingYearEndDateAccounting year end date (ISO date, YYYY-MM-DD)
currencyISO 4217 currency every amount on this budget is denominated in — the company's base (functional) currency.
createdAtWhen the budget was created (ISO 8601)
updatedAtWhen the budget was last updated (ISO 8601)
Budget cells (one per account × period, and per dimension bucket when dimensioned)
The accounting year's periods, ordered by periodIndex
Driver rows with resolved cells (non-money quantities)
Budget-local display overrides. Only accounts carrying an override are listed.
Stable #N row numbers used by formula references. Rows never numbered in the editor may be absent.
dimensionCategoryIdDimension category scoping this budget: lines then carry per-dimension-value buckets. null for flat budgets.
BudgetExcelChange
ledgerIdThe account (ledger) id
accountNumberThe account number
accountNameThe account name
dimensionValueIdThe dimension value the figure is on. null for a budget without a dimension, or the dimension's unallocated row.
dimensionValueNameaccountingPeriodIdThe accounting period
periodStartDateFirst day of the accounting period, YYYY-MM-DD
periodLabelThe period's column header in the workbook
periodClosedThe accounting period is closed. Budget figures stay editable there.
previousAmountThe figure before, in the budget's currency (currency), decimal string
newAmountThe figure after, in the budget's currency (currency), decimal string
originFILE: typed into the workbook. RECALCULATED: a formula figure that moves because a figure it reads changed.
previousFormulaThe formula the cell carries now. A FILE change replaces it with the typed figure; a RECALCULATED change keeps it.
previousSourceThe live source the cell follows now. A FILE change detaches it.
changedSinceExportFILE only: the figure changed after the workbook was exported, and the workbook overwrites that change.
rowNumberFILE only: the workbook row, as Excel numbers it.
BudgetExcelRefusedRow
rowNumberThe workbook row, as Excel numbers it
columnThe column header the problem is in, when it is one cell
codeWhy the row is refused: BUDGET_EXCEL_UNKNOWN_ACCOUNT, BUDGET_EXCEL_ACCOUNT_NOT_BUDGETABLE, BUDGET_EXCEL_UNKNOWN_DIMENSION_VALUE, BUDGET_EXCEL_DUPLICATE_ROW or BUDGET_EXCEL_INVALID_AMOUNT.
BudgetExcelPublication
idThe upload, as the budget's upload history lists it
fileNameThe name the uploaded file carried
publishedAtWhen it was published (ISO 8601)
publishedViaHow the workbook reached the budget
fileChangeCountFigures typed into the workbook that went live
recalculatedChangeCountFormula figures that recalculated as a result
byteSizeThe workbook size in bytes
BudgetExcelUploadResponse
dryRunThe workbook was only checked; nothing was written.
budgetIdbudgetNameaccountingYearStartDateFirst day of the budget's accounting year, YYYY-MM-DD
accountingYearEndDateLast day of the budget's accounting year, YYYY-MM-DD
currencyISO 4217 currency every amount is in — the company's base currency, which the workbook states too.
fileNameThe name the uploaded file carried
exportedAtWhen the workbook was exported (ISO 8601)
rowsReadAccount rows read from the workbook
Every figure that changes, or changed: the figures typed into the workbook and the formula figures that recalculate because of them. A dry run and the publish of the same file answer the same changes.
Rows the workbook is refused for. Any refused row blocks publishing.
ignoredColumnsColumn headers that match no accounting period of the budget. Their cells change nothing.
ignoredRowNumbersRows that carry figures but no account number. They change nothing.
canPublishNo row is refused and at least one figure changes, so publishing succeeds.
previewTokenIdentifies this file against the budget as it stood when read. Pass it to the publish of the same file to have the publish refused if the budget changes in between.
publicationThe published upload, kept in the budget's upload history with its file. null on a dry run.
BudgetScenario
idThe unique identifier of the scenario
nameScenario name
isBaselineTrue for the "Base" overlay — the budget grid with no scenario assumptions applied. The Base scenario is created when the tenant first uses scenarios in the app, so a budget may not have one yet.
createdAtWhen the scenario was created (ISO 8601)
updatedAtWhen the scenario was last updated (ISO 8601)
descriptionScenario description
ListBudgetScenariosResponse
The budget's scenarios
BudgetScenarioGridResponse
currencyISO 4217 currency every amount is denominated in — the company's base (functional) currency.
All resolved budget cells under the scenario overlay
All driver rows with resolved cells under the overlay
hasCycleTrue when the overlay could not resolve because of a formula cycle — offending cells carry error: BUDGET_FORMULA_CYCLE and amounts must not be trusted.
forecastHorizonMonthLast calendar month (YYYY-MM) with a subscription-forecast projection. Cells past it that reference the subscription forecast resolve to 0. null when no subscription token is used.
BudgetComparisonSummary
totalBudgetTotal budgeted amount (decimal string)
totalActualTotal actual amount (decimal string)
totalVarianceTotal variance, budget − actual (decimal string)
totalVariancePercentTotal variance as a percentage of budget; null when the budget is 0
isOverBudgetTrue when total actual exceeds total budget
BudgetComparisonEntry
ledgerIdLedger account
ledgerNameLedger account name
accountNumberLedger account number
periodIdAccounting period (see periods)
budgetAmountBudgeted amount (decimal string)
actualAmountActual amount from the ledger (decimal string)
varianceVariance, budget − actual (decimal string)
variancePercentVariance as a percentage of budget; null when the budget is 0
isOverBudgetTrue when the variance is unfavourable: actual above budget on expense accounts, actual below budget on revenue accounts.
isRevenueAccountTrue for revenue (credit-normal) accounts; false for expense (debit-normal) accounts
dimensionValueIdDimension value bucket. null = the Unallocated bucket; absent for flat budgets.
BudgetComparisonResponse
budgetNameBudget name
currencyISO 4217 currency every amount is denominated in — the company's base (functional) currency.
Summary totals for the comparison
Comparison entries by account and period
The periods covered by the comparison
BudgetVarianceRow
ledgerIdLedger account
accountNameLedger account name
accountTypeNormal side of the account: DEBIT (expense-like) or CREDIT (revenue-like)
periodIdAccounting period
frozenBaselineAmount in the frozen baseline (decimal string)
actualActual amount from the ledger (decimal string)
varianceVariance, actual − frozen baseline (decimal string)
variancePercentVariance as a percentage of the absolute baseline; null when the baseline is 0
sentimentUnfavourable when spending exceeds the frozen plan (expense accounts) or revenue misses it (revenue accounts).
BudgetVarianceResponse
currencyISO 4217 currency every amount is denominated in — the company's base (functional) currency.
Closed-period variance rows vs the frozen baseline. Empty when the budget has no frozen baseline yet.
BudgetFrozenBaselineSummary
idThe unique identifier of the frozen baseline
labelLabel given when the baseline was frozen
frozenAtWhen the baseline was frozen (ISO 8601)
cellCountNumber of snapshot cells
scenarioIdScenario whose overlay was snapshotted. null = the base grid.
frozenByIdentity that froze the baseline
ListBudgetFrozenBaselinesResponse
The budget's frozen baselines, most recent first
BudgetFrozenBaselineCell
idThe unique identifier of the snapshot cell
ledgerIdLedger account
accountingPeriodIdAccounting period
amountFrozen resolved amount (decimal string)
dimensionValueIdDimension value bucket. null = the Unallocated bucket; absent for flat budgets.
sourceProvenance of the cell at freeze time
BudgetFrozenBaselineDetail
idThe unique identifier of the frozen baseline
labelLabel given when the baseline was frozen
frozenAtWhen the baseline was frozen (ISO 8601)
currencyISO 4217 currency every amount is denominated in — the company's base (functional) currency.
Snapshot cells
scenarioIdScenario whose overlay was snapshotted. null = the base grid.
frozenByIdentity that froze the baseline
BudgetRebaselineProposal
idThe unique identifier of the proposal
accountingPeriodIdThe closed accounting period the proposal was raised for
statusPROPOSED (open), CONFIRMED (accepted — the budget was recomputed forward), or REJECTED.
proposedAtWhen the proposal was raised (ISO 8601)
confirmedAtWhen the proposal was confirmed. null while open or rejected.
ListBudgetRebaselineProposalsResponse
The budget's re-baseline proposals
MarkVatPeriodFiledRequest
startDateFirst day of the VAT period (YYYY-MM-DD).
endDateLast day of the VAT period (YYYY-MM-DD).
reportedDateThe day the return was reported to SKAT outside LedgerBee (YYYY-MM-DD): on or after the period end, and not in the future.
VatPeriodFiledResponse
startDateFirst day of the filed period.
endDateLast day of the filed period.
reportedDateThe day the return was reported.
sourceMANUAL for a filing recorded here; APP for one sent to SKAT through LedgerBee.
hasSettleableBalancesWhether settling the period would post anything. False for a period with no VAT postings.
VatPeriodFilingPreviewResponse
startDateFirst day of the period that would be recorded as filed.
endDateLast day of the period.
reportedDateThe day the return would be recorded as reported.
VatPeriodRequest
startDateFirst day of the VAT period (YYYY-MM-DD).
endDateLast day of the VAT period (YYYY-MM-DD).
SettleVatPeriodResponse
journalEntryIdThe posted settlement journal entry.
VatSettlementPreviewLine
accountIdLedger account the line posts to.
accountNumberIts account number.
accountNameIts name.
typeWhich side the line posts on.
amountPositive amount, in the company's base currency.
rolevat_account zeroes one VAT account, settlement carries the net to the VAT settlement account, rounding the øre the rounded lines leave over.
VatSettlementPreviewResponse
startDateFirst day of the period.
endDateLast day of the period.
postingDateThe settlement posts on the last day of the period.
descriptionDescription the settlement entry would carry.
currencyThe company's base currency; every amount is in it.
settlementAmountNet VAT for the period: positive is payable to SKAT, negative is a refund from SKAT.
The lines the settlement entry would post.
ProjectSubproject
idUnique identifier of the subproject.
dimensionValueIdThe journal-tag value ID that represents this subproject in the dimensions system. Use this value when tagging ledger transactions to the subproject.
nameDisplay name of the subproject.
isDefaultWhether this is the default (catch-all) subproject for the project.
sortOrderDisplay sort order (ascending).
budgetHoursBudget in hours for this subproject. Null when no budget is set.
budgetAmountBudget amount in the project currency for this subproject. Null when no budget is set.
colorHex colour code for visual identification in the UI. Null when not set.
Project
idUnique identifier of the project.
nameDisplay name of the project.
isArchivedWhether the project has been archived. Archived projects are read-only.
currencyISO 4217 currency code used for budget amounts on this project.
dimensionIdThe shared "Projects" dimension category ID (journal-tag category) that backs every project in your company. Subproject values live as dimension values under this category, nested beneath this project's own dimension value (dimensionValueId).
defaultSubprojectIdID of the default subproject (the catch-all subproject created with the project).
All subprojects for this project, sorted by sortOrder ascending.
createdAtISO 8601 timestamp when the project was created.
updatedAtISO 8601 timestamp when the project was last updated.
customerIdID of the customer this project belongs to. Null when not linked to a customer.
budgetHoursTotal budget in hours across all subprojects. Null when not set.
budgetAmountTotal budget amount in the project currency. Null when not set.
startDateProject start date (inclusive), ISO 8601 date string. Null when not set.
endDateProject end date (inclusive), ISO 8601 date string. Null when not set.
externalReferenceYour system external reference for this project. Useful for idempotent upserts and cross-system reconciliation. Null when not set.
colorHex colour code for visual identification. Null when not set.
dimensionValueIdThe project's own dimension value (journal-tag) ID inside the shared Projects category. Subprojects are nested as dimension values beneath this value. Null only for a project in a corrupt state with no journal-tag.
UpsertProjectRequest
nameDisplay name for the project. Must be unique within your company.
customerIdID of the customer this project belongs to.
currencyISO 4217 currency code for budget amounts. Defaults to the customer's currency or the company base currency when omitted.
budgetHoursTotal budget in hours. Null clears the budget.
budgetAmountTotal budget amount in the project currency. Null clears the budget.
startDateProject start date (inclusive), ISO 8601 date string.
endDateProject end date (inclusive), ISO 8601 date string.
externalReferenceYour system external reference for this project. Must be unique within your company. The upsert finds an existing project by this value and updates it, or creates a new one.
colorHex colour code for visual identification.
CreateProjectRequest
nameDisplay name for the project. Must be unique within your company.
customerIdID of the customer this project belongs to.
currencyISO 4217 currency code for budget amounts. Defaults to the customer's currency or the company base currency when omitted.
budgetHoursTotal budget in hours. Null clears the budget.
budgetAmountTotal budget amount in the project currency. Null clears the budget.
startDateProject start date (inclusive), ISO 8601 date string.
endDateProject end date (inclusive), ISO 8601 date string.
externalReferenceYour system external reference for this project. Must be unique within your company. Can be used for idempotent upserts via PUT /.
colorHex colour code for visual identification.
ProjectProfitTotals
revenueBase-currency revenue in the date range (positive figure, sign-flipped from REVENUE ledgers).
costBase-currency cost in the date range (positive figure, EXPENSE ledgers).
profitrevenue - cost.
isOverBudgetTrue when burnPercent > 100 (over budget). False when under budget or no budget.
budgetAmountThe budget amount this burn is measured against. Null when no budget is set.
burnPercentcost / budgetAmount * 100, rounded. Null when no budget is set or budgetAmount is 0.
ProjectSubprojectProfit
revenueBase-currency revenue in the date range (positive figure, sign-flipped from REVENUE ledgers).
costBase-currency cost in the date range (positive figure, EXPENSE ledgers).
profitrevenue - cost.
isOverBudgetTrue when burnPercent > 100 (over budget). False when under budget or no budget.
subprojectIdSubproject ID.
dimensionValueIdThe dimension value ID (journal-tag ID) for this subproject.
nameDisplay name of the subproject.
isDefaultWhether this is the default (catch-all) subproject.
budgetAmountThe budget amount this burn is measured against. Null when no budget is set.
burnPercentcost / budgetAmount * 100, rounded. Null when no budget is set or budgetAmount is 0.
ProjectProfit
projectIdProject ID.
fromInclusive range start actually used (after defaulting), YYYY-MM-DD.
toInclusive range end actually used (after defaulting), YYYY-MM-DD.
currencyCompany base currency the amounts are expressed in.
Aggregate totals for the project.
Per-subproject profit breakdown.
UpdateProjectRequest
nameNew display name for the project.
customerIdCustomer ID. Null clears the customer link.
currencyISO 4217 currency code.
budgetHoursBudget in hours. Null clears the budget.
budgetAmountBudget amount in the project currency. Null clears the budget.
startDateProject start date (inclusive), ISO 8601. Null clears the date.
endDateProject end date (inclusive), ISO 8601. Null clears the date.
externalReferenceExternal reference. Null clears the value.
colorHex colour code. Null clears the value.
isArchivedArchive or un-archive the project.
CreateSubprojectRequest
nameDisplay name for the subproject.
budgetHoursBudget in hours for this subproject. Null clears the budget.
budgetAmountBudget amount in the project currency. Null clears the budget.
colorHex colour code. Null clears the value.
sortOrderSort order (ascending). Defaults to 0.
UpdateSubprojectRequest
nameNew display name for the subproject.
budgetHoursBudget in hours. Null clears the budget.
budgetAmountBudget amount in the project currency. Null clears the budget.
colorHex colour code. Null clears the value.
sortOrderSort order (ascending).
UsageReportRequestDto
valueThe numeric value of this usage event. How it is used depends on the meter's aggregation method: summed (sum) or taken as the latest value (last). For count meters the value is ignored, but a non-negative number is still required.
customerIdCustomer ID this usage is associated with.
meterIdMeter identifier. Provide meterId or meterName. Meter must be ACTIVE; usage will be rejected for archived meters.
meterNameMeter name. Provide meterId or meterName. Meter must be ACTIVE; usage will be rejected for archived meters.
timestampISO-8601 timestamp. Defaults to now.
dimensionWhat the quantity is measured PER — a seat, a device, a user. Only a meter using the max_per_dimension aggregation reads it; every other aggregation ignores it.
This is a GROUPING key, not a label: the meter bills the peak each dimension reached, added together, so the value must identify a thing that persists across reports. Put descriptive detail in metadata instead, which is never aggregated on.
A value that is unique per report defeats the aggregation, and a meter is refused new dimensions once it carries too many distinct values.
metadataAdditional metadata for the usage event (values must be string, number, or boolean)