Schemas

Download schema

CompanyFiscalYear

startDate

string · required

First day of the fiscal year, inclusive (YYYY-MM-DD)

Example: 2026-01-01

endDate

string · required

Last day of the fiscal year, inclusive (YYYY-MM-DD)

Example: 2026-12-31

status

string · enum · required

Whether the year is still open for posting

Enum values:

OPEN

CLOSED

Example: OPEN

CompanyAccounting

baseCurrency

string · required

The company's base (functional) currency, ISO 4217. Every figure a report labels a base-currency total is denominated in this.

Example: DKK

currentFiscalYear

object | null · required

The 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

id

string · required

Unique identifier for the company, uuidv7 based

Example: 01234567-89AB-CDEF-0123-456789ABCDEF

name

string · required

Company name

Example: Acme Corporation

email

string · required

Primary email address

Example: contact@acme.com

address

string · required

Street address

Example: 123 Main Street

object · required

The company's accounting configuration: base currency and the fiscal year covering today.

vat

string

VAT / company registration number, as registered

Example: 12345678

billingEmail

string

Billing email address

Example: billing@acme.com

city

string

City

Example: Copenhagen

postalCode

string

Postal code

Example: 2100

countryCode

string

Country code (ISO 3166-1 alpha-2)

Example: DK

phone

string

Phone number

Example: +45 12 34 56 78

preferredLanguage

string

Preferred language code

Example: en

contactPersonFirstName

string

Contact person first name

Example: John

contactPersonLastName

string

Contact person last name

Example: Doe

RateLimitTierResponse

name

string · required

Name of the rate limit tier

Example: short

ttl

number · required

Time-to-live in milliseconds for this rate limit tier (0 means no time limit)

Example: 1000

limit

number · required

Maximum number of requests allowed within the TTL window (-1 means unlimited)

Example: 3

ApiKeyInfoResponse

RateLimitTierResponse[] · required

Available rate limit tiers for this API key

expiresAt

string

Expiration date and time of the API key

Example: 2024-12-31T23:59:59.000Z

ipWhitelist

string[]

List of IP addresses allowed to use this API key

Example: ["192.168.1.1","10.0.0.1"]

scopes

string[]

List of scopes granted to this API key

Example: ["accounts-read","journal-entries-write"]

AccountResponse

id

string · required

The unique identifier of the account

Example: 550e8400-e29b-41d4-a716-446655440000

name

string · required

Name of the account

Example: Skyldig AM-bidrag

accountNumber

number · required

Account type number

Example: 1000

publicAccountId

number · required

Public account id that the account maps to

Example: 1000

ledgerType

string · enum · required

Type of ledger account. Only BALANCE_SHEET and PROFIT_AND_LOSS accounts can be used in journal entries.

Enum values:

BALANCE_SHEET

HEADING_BREAK

HEADING

PROFIT_AND_LOSS

TOTAL_FROM

TOTAL_INTERVALS

Example: BALANCE_SHEET

accountClassification

string | null · enum

Account classification (ASSET, LIABILITY, EQUITY, REVENUE, EXPENSE)

Enum values:

ASSET

LIABILITY

EQUITY

REVENUE

EXPENSE

Example: ASSET

controlAccountType

string | null · enum

Control account type. ACCOUNTS_RECEIVABLE requires customerId on journal entries, ACCOUNTS_PAYABLE requires vendorId. Null for regular accounts.

Enum values:

ACCOUNTS_RECEIVABLE

ACCOUNTS_PAYABLE

Example: null

PublicAuthorityExtractIngestRequest

object[] · required

The extract items — one object per extract (momsindberetning, erhvervsselvangivelse, udbytteindberetning, e-indkomst, skattekonto, lønsum, …). Each item is stored as received.

sender

string · maxLength: 64

The delivering system, e.g. 'revibot'.

Example: revibot

batchId

string · maxLength: 128

The 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.

Example: 2026-09-01-run-1

PublicAuthorityExtractIngestResponse

totalCreated

number · required

Number of extract items stored.

CustomerGroupResponse

id

string · required

The unique identifier of the customer group

Example: 550e8400-e29b-41d4-a716-446655440000

number

string · required

Customer group number

Example: 1

name

string · required

Name of the customer group

Example: Domestic Customers

accountId

string

The ledger account ID associated with this customer group. Present with the customers-read scope; omitted for checkout-only keys.

Example: 550e8400-e29b-41d4-a716-446655440001

accountNumber

number

The ledger account number associated with this customer group

Example: 1100

accountName

string

The ledger account name associated with this customer group

Example: Trade Debtors

object

Key-value metadata attached to the customer group

Example: {"segment":"enterprise"}

CustomerDepartmentResponse

id

string · required

The unique identifier of the department

Example: 550e8400-e29b-41d4-a716-446655440000

name

string · required

Name of the department

Example: Headquarters

isDefault

boolean · required

Whether this is the default department for the customer

Example: true

isActive

boolean · required

Whether the department is active

Example: true

poNumber

string

Purchase order number

Example: PO-12345

eanNumber

string

EAN number for e-invoicing

Example: 5790000000000

address

string

Street address

Example: 123 Main Street

city

string

City

Example: Copenhagen

postalCode

string

Postal code

Example: 2100

countryCode

string

Two-letter country code (ISO 3166-1 alpha-2)

Example: DK

CustomerContactResponse

id

string · required

The unique identifier of the contact

Example: 550e8400-e29b-41d4-a716-446655440000

name

string · required

Name of the contact

Example: John Doe

isDefaultForCustomer

boolean · required

Whether this is the default contact for the customer

Example: true

email

string

Email address

Example: john.doe@acme.com

phone

string

Phone number

Example: +45 12345678

CustomerResponse

id

string · required

The unique identifier of the customer

Example: 550e8400-e29b-41d4-a716-446655440000

customerNumber

string · required

Customer number

Example: C001

customerType

string · enum · required

Customer type

Enum values:

BUSINESS

PRIVATE_PERSON

Example: BUSINESS

name

string · required

Name of the customer

Example: Acme Corporation

vatZone

string · enum · required

VAT zone classification

Enum values:

domestic

abroad

domestic_without_vat

eu_at

eu_be

eu_bg

eu_cy

Example: domestic

customerGroupId

string · required

Customer group ID

Example: 550e8400-e29b-41d4-a716-446655440001

isActive

boolean · required

Whether the customer is active

Example: true

billingRelationship

string · enum · required

Billing relationship. self = this customer is billed directly. parent_pays = the parent customer (set via parentCustomerId) is billed instead.

Enum values:

self

parent_pays

Example: self

includeChildDetailsPdf

boolean · required

Whether to attach a zip of per-child detail PDFs when sending consolidated invoices. Only relevant for parent customers in single_invoice mode.

Example: false

selfServiceDetailsEnabled

boolean · required

Whether 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.

Example: false

customerGroupNumber

string

Customer group number

Example: 1

customerGroupName

string

Customer group name

Example: Domestic Customers

email

string

Email address

Example: contact@acme.com

phone

string

Phone number

Example: +45 12345678

address

string

Street address

Example: 123 Main Street

city

string

City

Example: Copenhagen

postalCode

string

Postal code

Example: 2100

countryCode

string

Two-letter country code (ISO 3166-1 alpha-2)

Example: DK

vatNumber

string

VAT registration number

Example: DK12345678

website

string

Website URL

Example: https://acme.com

externalSystemId

string

External system identifier for tracking the customer across other systems

Example: crm-12345

creditLimit

number

Credit limit

Example: 50000

openingBalance

number

Opening balance in the company base currency (signed: positive = the customer owes us)

Example: 1000

paymentTerms

number

Payment terms in days

Example: 30

paymentTermType

string · enum

Payment term type

Enum values:

NET_DAYS

CASH

RUNNING_MONTH_PLUS_DAYS

Example: NET_DAYS

defaultCurrency

string

Default currency code

Example: DKK

parentCustomerId

string | null

Parent 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.

Example: 550e8400-e29b-41d4-a716-446655440000

consolidationMode

string | null · enum

Consolidation 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.

Enum values:

single_invoice

per_child_invoice

billingDay

number | null

Day of month (1-28) when the parent consolidated invoice is generated. Required for single_invoice consolidation mode.

Example: 1

parentInvoiceTemplateId

string | null

Parent single invoice PDF template override

object

Key-value metadata attached to the customer

Example: {"crmSegment":"enterprise","accountOwner":"jane"}

CreateCustomerRequest

customerType

string · enum · required

Specifies whether the customer is a business or a private person

Enum values:

BUSINESS

PRIVATE_PERSON

Example: BUSINESS

Default: BUSINESS

name

string · required

Customer name

Example: Acme Corporation

vatZone

string · enum · required

VAT zone classification

Enum values:

domestic

abroad

domestic_without_vat

eu_at

eu_be

eu_bg

eu_cy

Example: domestic

customerGroupId

string · required

Customer group ID

Example: 550e8400-e29b-41d4-a716-446655440001

countryCode

string · required

Two-letter country code

Example: DK

defaultCurrency

string · pattern: ^[A-Za-z]{3}$ · required

The currency this customer is invoiced in, ISO 4217 alpha-3.

Example: DKK

customerNumber

string

Unique 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.

Example: 1042

email

string

Email address

Example: contact@acme.com

phone

string

Phone number

Example: +45 12345678

address

string · maxLength: 510

Street address

Example: 123 Main Street

city

string

City

Example: Copenhagen

postalCode

string

Postal code

Example: 2100

vatNumber

string

VAT registration number

Example: DK12345678

website

string

Website URL

Example: https://acme.com

externalSystemId

string

External system identifier for tracking the customer across other systems

Example: crm-12345

notes

string

Additional notes

Example: Key account customer

creditLimit

number · min: 0

Credit limit

Example: 50000

openingBalance

number

Opening balance in the company base currency, seeding receivables that predate LedgerBee. Signed: positive = the customer owes us, negative = a credit position.

Example: 1000

paymentTerms

number · min: 0

Payment terms in days

Example: 30

paymentTermType

string · enum

Payment term type

Enum values:

NET_DAYS

CASH

RUNNING_MONTH_PLUS_DAYS

Example: NET_DAYS

isActive

boolean

Whether the customer is active

Example: true

Default: true

parentCustomerId

string | null

Parent 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.

Example: 550e8400-e29b-41d4-a716-446655440000

billingRelationship

string · enum

Billing relationship. self (default) = this customer is billed directly. parent_pays = the parent customer (set via parentCustomerId) is billed instead.

Enum values:

self

parent_pays

consolidationMode

string | null · enum

Consolidation mode (parent customers only). single_invoice = all child subscriptions consolidated onto one invoice on billingDay. per_child_invoice = each child receives its own invoice.

Enum values:

single_invoice

per_child_invoice

billingDay

number | null

Day of month (1-28) for the parent consolidated invoice. Required for single_invoice consolidation.

Example: 1

includeChildDetailsPdf

boolean

Whether to attach a zip of per-child detail PDFs when sending consolidated invoices

selfServiceDetailsEnabled

boolean

Example: false

parentInvoiceTemplateId

string | null

Parent single invoice PDF template override. Send null to clear.

object

Key-value metadata to attach to the customer. At most 50 entries; keys up to 128 characters, string values up to 500 characters.

Example: {"crmSegment":"enterprise"}

CreateCustomerResponse

id

string · required

The unique identifier of the created customer

Example: 550e8400-e29b-41d4-a716-446655440000

customerNumber

string · required

Customer number

Example: C001

SubscriptionTransitionItem

customerSubscriptionId

string · required

The subscription to move onto the new billing arrangement: the id GET /v1/subscriptions returns, the same stable id every subscription endpoint takes.

Example: 550e8400-e29b-41d4-a716-446655440000

UpdateCustomerRequest

customerType

string · enum

Customer type

Enum values:

BUSINESS

PRIVATE_PERSON

Example: BUSINESS

customerNumber

string

Unique customer number

Example: C001

name

string

Customer name

Example: Acme Corporation

vatZone

string · enum

VAT zone classification

Enum values:

domestic

abroad

domestic_without_vat

eu_at

eu_be

eu_bg

eu_cy

Example: domestic

customerGroupId

string

Customer group ID

Example: 550e8400-e29b-41d4-a716-446655440001

email

string | null

Email address. Send null or empty string to clear.

Example: contact@acme.com

phone

string

Phone number

Example: +45 12345678

address

string · maxLength: 510

Street address

Example: 123 Main Street

city

string

City

Example: Copenhagen

postalCode

string

Postal code

Example: 2100

countryCode

string

Two-letter country code

Example: DK

vatNumber

string

VAT registration number

Example: DK12345678

website

string

Website URL

Example: https://acme.com

externalSystemId

string

External system identifier for tracking the customer across other systems

Example: crm-12345

notes

string

Additional notes

Example: Key account customer

creditLimit

number · min: 0

Credit limit

Example: 50000

openingBalance

number

Opening balance in the company base currency, seeding receivables that predate LedgerBee. Signed: positive = the customer owes us, negative = a credit position.

Example: 1000

paymentTerms

number · min: 0

Payment terms in days

Example: 30

paymentTermType

string · enum

Payment term type

Enum values:

NET_DAYS

CASH

RUNNING_MONTH_PLUS_DAYS

Example: NET_DAYS

defaultCurrency

string · pattern: ^[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.

Example: DKK

isActive

boolean

Whether the customer is active

Example: true

parentCustomerId

string | null

Parent 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.

Example: 550e8400-e29b-41d4-a716-446655440000

billingRelationship

string · enum

Billing relationship. Change to parent_pays together with parentCustomerId to route billing to the parent.

Enum values:

self

parent_pays

consolidationMode

string | null · enum

Consolidation mode (parent customers only). Send null to clear.

Enum values:

single_invoice

per_child_invoice

billingDay

number | null

Day of month (1-28) for the parent consolidated invoice. Send null to clear.

Example: 1

includeChildDetailsPdf

boolean

Whether to attach a zip of per-child detail PDFs when sending consolidated invoices

selfServiceDetailsEnabled

boolean

Example: false

parentInvoiceTemplateId

string | null

Parent single invoice PDF template override. Send null to clear.

SubscriptionTransitionItem[]

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.

object

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.

Example: {"crmSegment":"enterprise"}

DimensionValue

id

string · required

Unique identifier of the dimension value

Example: 550e8400-e29b-41d4-a716-446655440000

name

string · minLength: 2 · maxLength: 255 · required

Display name of the dimension value

Example: Marketing

parentId

string | null

Parent dimension value ID for hierarchical structures. Null for root-level values. Use this to create nested structures like "Sales > Europe > Denmark".

Example: 550e8400-e29b-41d4-a716-446655440001

DimensionValue[]

Child dimension values (nested structure). Only populated in list responses.

Dimension

id

string · required

Unique identifier of the dimension category

Example: 550e8400-e29b-41d4-a716-446655440000

name

string · minLength: 2 · maxLength: 255 · required

Display name of the dimension category

Example: Department

isUnique

boolean · required

When 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.

Example: true

DimensionValue[] · required

Available dimension values within this category, organized as a hierarchical tree. Root values have parentId as null, nested values reference their parent.

PublicDimensionValueListItem

id

string · required

Unique identifier of the dimension value

name

string · required

Name of the value

Example: Marketing

parentId

string

Parent value id for hierarchical dimensions. Absent on root values. Rebuild the tree client-side.

PublicListDimensionValuesResponse

PublicDimensionValueListItem[] · required

Dimension values as a FLAT page ordered by name; use parentId to rebuild hierarchy

total

number · required

Total number of values in this dimension

Example: 240

page

number · required

Current page number (1-indexed)

Example: 1

limit

number · required

Maximum number of items per page

Example: 100

totalPages

number · required

Total number of pages available

Example: 3

PublicDistributionKeyAllocation

valueId

string · required

The dimension value this share is allocated to

valueName

string · required

Name of the target dimension value

Example: Marketing

percentage

number · required

Share of the amount, in percent with up to six decimal places. All shares sum to exactly 100.

Example: 66.666667

sortOrder

number · required

Display order of the allocation row (0-based)

Example: 0

PublicDistributionKey

id

string · required

Unique identifier of the distribution key

name

string · required

Display name

Example: 70/30 Sales split

isAdHoc

boolean · required

True 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.

isActive

boolean · required

False once the key is archived (a posted ad-hoc key archives automatically)

PublicDistributionKeyAllocation[] · required

The allocations, in display order. Percentages sum to exactly 100.

PublicListDistributionKeysResponse

PublicDistributionKey[] · required

Distribution keys, ordered by name

total

number · required

Total number of keys matching the query

Example: 3

page

number · required

Current page number (1-indexed)

Example: 1

limit

number · required

Maximum number of items per page

Example: 25

totalPages

number · required

Total number of pages available

Example: 1

PublicCreateDistributionKeyAllocation

valueId

string · required

The dimension value to allocate to. Must belong to this dimension.

percentage

number · min: 0.000001 · max: 100 · required

Share in percent, up to six decimal places. All allocations must sum to exactly 100.

Example: 33.333333

sortOrder

number · required

Display order of the allocation row (0-based)

Example: 0

PublicCreateDistributionKey

PublicCreateDistributionKeyAllocation[] · required

Allocations that must sum to exactly 100%. Between 2 and 100 entries.

name

string · maxLength: 120

Display name. Required for a reusable key; omit it on an ad-hoc key, which names itself from its allocations server-side.

Example: 70/30 Sales split

isAdHoc

boolean

True 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.

Default: false

CreateDimensionRequest

name

string · minLength: 2 · maxLength: 255 · required

Display name for the dimension category. Must be unique within your company. Choose a descriptive name that clearly indicates the categorization purpose.

Example: Cost Center

isUnique

boolean · required

Whether 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.

Example: true

DimensionResponse

id

string · required

Unique identifier of the created/updated dimension category

Example: 550e8400-e29b-41d4-a716-446655440000

name

string · required

Display name of the dimension category

Example: Department

isUnique

boolean · required

Whether only one value from this dimension can be assigned per journal entry

Example: true

UpdateDimensionRequest

name

string · minLength: 2 · maxLength: 255

New display name for the dimension category. Must be unique within your company. Changing the name does not affect existing dimension value assignments.

Example: Business Unit

isUnique

boolean

Update the uniqueness constraint for this dimension category. Changing from false to true will fail if any journal entries currently have multiple values assigned from this category. Plan this change carefully as it affects data validation.

Example: false

CreateDimensionValueRequest

dimensionId

string · required

ID of the dimension category this value belongs to. The category must exist and belong to your company.

Example: 550e8400-e29b-41d4-a716-446655440000

name

string · minLength: 2 · maxLength: 255 · required

Display 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.

Example: Marketing

parentId

string | null

Parent 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.

Example: 550e8400-e29b-41d4-a716-446655440001

DimensionValueResponse

id

string · required

Unique identifier of the created/updated dimension value

Example: 550e8400-e29b-41d4-a716-446655440000

name

string · required

Display name of the dimension value

Example: Marketing

dimensionId

string · required

ID of the dimension category this value belongs to

Example: 550e8400-e29b-41d4-a716-446655440001

dimensionName

string · required

Name of the dimension category this value belongs to

Example: Department

dimensionIsUnique

boolean · required

Whether the parent category enforces single selection

Example: true

parentId

string | null

Parent dimension value ID, if this is a nested value

Example: 550e8400-e29b-41d4-a716-446655440002

UpdateDimensionValueRequest

name

string · minLength: 2 · maxLength: 255

New display name for the dimension value. Must be unique within the dimension category. Changing the name does not affect existing journal entry assignments.

Example: Digital Marketing

parentId

string | null

New 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).

Example: 550e8400-e29b-41d4-a716-446655440001

AttachmentRequest

filename

string · maxLength: 255 · required

Filename with extension

Example: invoice.pdf

content

string · required

Base64-encoded file content. Note: Base64 encoding adds ~33% overhead. Individual files should not exceed 10MB before encoding.

Example: JVBERi0xLjQKJeLjz9MKMyAwIG9iago8PC...

mimeType

string · enum · required

MIME type of the file

Enum values:

application/pdf

image/jpeg

image/png

image/heic

image/heif

image/bmp

image/tiff

application/zip

Example: application/pdf

DraftSplitEntryLine

type

string · enum · required

Transaction type for this line (debit or credit)

Enum values:

debit

credit

Example: debit

amount

number · required

Amount for this line (must be non-negative)

Example: 500

accountId

string

Account 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.

Example: 550e8400-e29b-41d4-a716-446655440000

vatCodeId

string

VAT/Tax code ID for this line (UUID)

Example: 550e8400-e29b-41d4-a716-446655440000

description

string · maxLength: 500

Optional per-line memo (max 500 characters). Persisted on the draft line and carried onto the booked ledger transaction when the draft is booked.

Example: Consulting hours — March

tagIds

string[]

Dimension 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.

Example: ["550e8400-e29b-41d4-a716-446655440003"]

CreateDraftJournalEntryRequest

accountId

string · required

Primary account ID (UUID). Cannot be a heading or total account. For typed entries (supplier_invoice, customer_invoice, etc.), must have appropriate account classification.

Example: 550e8400-e29b-41d4-a716-446655440000

date

string · required

Date of the journal entry in YYYY-MM-DD format

Example: 2026-01-15

amount

number · required

Amount of the transaction (must be positive)

Example: 1000

contraAccountId

string

Contra 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.

Example: 550e8400-e29b-41d4-a716-446655440001

entryType

string · enum

Entry 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.

Enum values:

journal

invoice

payment

supplier_invoice

supplier_payment

customer_invoice

customer_payment

Example: supplier_invoice

Default: journal

type

string · enum

Transaction type (debit or credit)

Enum values:

debit

credit

Example: debit

Default: debit

description

string · maxLength: 2000

Description of the journal entry

Example: Office supplies purchase

reference

string

Reference number or identifier

Example: REF-2026-001

currency

string | null · minLength: 3 · maxLength: 3 · pattern: ^[A-Za-z]{3}$

ISO 4217 alpha-3 currency code.

Example: DKK

customerId

string

Customer ID (UUID) for customer-related entries

Example: 550e8400-e29b-41d4-a716-446655440002

supplierId

string

Supplier ID (UUID). Required for supplier_invoice / supplier_payment entry types, and for any posting that touches an accounts-payable control account.

Example: 550e8400-e29b-41d4-a716-446655440003

tagIds

string[]

Tag/Dimension IDs to attach to the journal entry

Example: ["550e8400-e29b-41d4-a716-446655440003"]

vatCodeId

string

VAT/Tax code ID (UUID). Applied to the primary account unless split entries are used.

Example: 550e8400-e29b-41d4-a716-446655440000

AttachmentRequest[] · maxItems: 10

File attachments (base64-encoded). Maximum 10 attachments per entry. Total request size limit is 15MB.

DraftSplitEntryLine[] · minItems: 2 · maxItems: 50

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.

externalSystemId

string · maxLength: 255

Your 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.

Example: erp-7f3a2c91

CreateDraftJournalEntryBatchRequest

CreateDraftJournalEntryRequest[] · minItems: 1 · maxItems: 100 · required

Array of draft journal entries to create (1-100 entries per batch)

DraftJournalEntryLine

type

string · enum · required

Which side of the entry this line sits on

Enum values:

debit

credit

Example: debit

accountId

string

Account 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.

Example: 550e8400-e29b-41d4-a716-446655440000

amount

number

Amount for this line in transaction currency. 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.

Example: 500

vatCodeId

string

VAT/Tax code ID

Example: 550e8400-e29b-41d4-a716-446655440000

description

string

Per-line memo

Example: Consulting hours - March

tagIds

string[]

Tag/Dimension IDs attached to this line. Per-line dimensions override the entry-level tagIds on this specific ledger transaction.

DraftSplitEntryLineResponse

accountId

string · required

Account ID

Example: 550e8400-e29b-41d4-a716-446655440000

type

string · required

Transaction type (debit or credit)

Example: debit

amount

number · required

Amount for this line in transaction currency

Example: 500

vatCodeId

string

VAT/Tax code ID

Example: 550e8400-e29b-41d4-a716-446655440000

description

string

Per-line memo

Example: Consulting hours — March

tagIds

string[]

Tag/Dimension IDs attached to this line. Per-line dimensions override the entry-level tagIds on this specific ledger transaction.

DraftJournalEntryResponse

id

string · required

Draft journal entry ID

Example: 550e8400-e29b-41d4-a716-446655440000

date

string · required

Date in YYYY-MM-DD format

Example: 2026-01-15

amount

number · required

How 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 together with currency. That field names the currency the draft was entered in (EUR in the example), while this number is in DKK, so the pair reads as EUR 7,450 — about seven times what the draft is actually for. originalAmount is the figure that belongs beside currency.

Reads 0 on a draft that holds no figure in this currency. The minAmount and maxAmount filters on the list endpoint run on this field, so a draft reading 0 here is excluded whenever either filter is applied.

The deprecated 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 — the request field and this one are in different currencies under one name.

Example: 7450

originalAmount

number · required

How large this draft is, in the currency it was entered in — the currency currency 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 currency. amount is the same draft in your company base currency: on that EUR draft this field reads 1000 and amount reads 7450. Reads 0 on a draft that carries no amount yet.

Example: 1000

currency

string · required

The currency this draft was entered in — EUR for a supplier invoice received in EUR. This is not the currency amount is in; originalAmount is the figure in this currency.

Example: EUR

journalType

string · required

Journal type

Example: JOURNAL_ENTRY

DraftJournalEntryLine[] · required

Every line of the draft — the field to read. 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 v2 draft reads back through the field it was written with. The deprecated v1 create still takes splitEntries, so a v1 client sends these lines back under that name.

status

string · required

Always "DRAFT" for draft journal entries

Example: DRAFT

createdAt

string · required

Creation timestamp

Example: 2026-01-15T10:30:00.000Z

updatedAt

string · required

Last update timestamp

Example: 2026-01-15T10:30:00.000Z

documentDate

string

Document date (date on the invoice/voucher). Null when not set.

Example: 2026-01-15

description

string

Description

Example: Office supplies purchase

reference

string

Reference number

Example: REF-2026-001

externalSystemId

string | null

Your own system's id for this draft, when set. Not unique. null when unset or cleared.

Example: erp-7f3a2c91

type

string

Transaction type (debit or credit)

Example: debit

accountId

string

Primary account ID

Example: 550e8400-e29b-41d4-a716-446655440000

contraAccountId

string

Contra account ID

Example: 550e8400-e29b-41d4-a716-446655440001

customerId

string

Customer ID

Example: 550e8400-e29b-41d4-a716-446655440002

supplierId

string

Supplier ID

Example: 550e8400-e29b-41d4-a716-446655440003

vatCodeId

string

VAT/Tax code ID

Example: 550e8400-e29b-41d4-a716-446655440000

tagIds

string[]

Tag/Dimension IDs

documentRefs

string[]

Document IDs attached to the draft

exchangeRate

number | null

What one unit of currency 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. amount 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.

Example: 7.45

exchangeRateDate

string | null

Date the exchangeRate was captured for. Null whenever exchangeRate is.

Example: 2026-01-15

CreateDraftJournalEntryBatchResponse

totalCreated

number · required

Number of draft entries successfully created

Example: 5

DraftJournalEntryResponse[] · required

Details of all created draft journal entries

ListDraftJournalEntriesResponse

DraftJournalEntryResponse[] · required

List of draft journal entries

total

number · required

Total number of matching drafts

Example: 42

page

number · required

Current page number

Example: 1

limit

number · required

Items per page

Example: 25

totalPages

number · required

Total number of pages

Example: 2

JournalEntryLine

accountId

string · required

Account this line posts to

Example: 550e8400-e29b-41d4-a716-446655440000

type

string · enum · required

Which side of the entry this line sits on

Enum values:

debit

credit

Example: debit

accountAmount

number · required

Amount posted to the account, in that account's own currency (accountCurrency). For an account operating in the company base currency this equals functionalAmount.

Example: 500

accountCurrency

string · required

The account's operating currency — the currency accountAmount is denominated in.

Example: DKK

functionalAmount

number · required

Amount 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.

Example: 500

isVatLine

boolean · required

True 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.

Example: false

originalAmount

number | null

This 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.

Example: 200

vatSourceLineIndex

number

Index 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.

Example: 0

vatCodeId

string

VAT/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.

Example: 550e8400-e29b-41d4-a716-446655440000

description

string

Per-line memo, separate from the entry-level description

Example: Consulting hours — March

tagIds

string[]

Dimension tag IDs attached to this specific line

JournalEntryResponse

id

string · required

Unique identifier of the created journal entry

Example: 550e8400-e29b-41d4-a716-446655440000

entryNumber

string · required

Entry number assigned to the journal entry

Example: JE-00001

date

string · required

Date of the journal entry

Example: 2026-01-15

amount

number · required

Amount 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.

Example: 1000

currency

string · required

Currency amount is denominated in — the operating currency of that first line's account.

Example: DKK

journalType

string · required

Journal type

Example: JOURNAL_ENTRY

type

string · required

Transaction type

Example: debit

status

string · required

Status of the journal entry

Example: POSTED

accountId

string · required

One 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.

Example: 550e8400-e29b-41d4-a716-446655440000

createdAt

string · required

Timestamp when the entry was created

Example: 2026-01-15T10:30:00.000Z

documentDate

string

Document date (date on the invoice/voucher). Null for legacy entries.

Example: 2026-01-15

originalAmount

number | null

What 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.

Example: 200

originalCurrency

string | null

The currency the entry was posted in: what originalAmount is denominated in, and what exchangeRate 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.

Example: EUR

exchangeRate

number | null

Rate 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 * exchangeRate 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.

Example: 7.45

exchangeRateDate

string | null

Date the exchangeRate was captured for. Null whenever exchangeRate is.

Example: 2026-01-15

description

string

Description of the journal entry

Example: Office supplies purchase

reference

string

Reference number

Example: REF-2026-001

externalSystemId

string

Your own system's id for this entry, when set. Not unique — several entries may share one id.

Example: erp-7f3a2c91

contraAccountId

string

The 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.

Example: 550e8400-e29b-41d4-a716-446655440001

JournalEntryLine[]

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.

customerId

string

Customer ID if applicable

Example: 550e8400-e29b-41d4-a716-446655440002

supplierId

string

Supplier ID if applicable

Example: 550e8400-e29b-41d4-a716-446655440003

vatCodeId

string

VAT/Tax code on the line accountId names, if it has one. Lines can carry different codes — read lines[].vatCodeId for the per-line codes.

Example: 550e8400-e29b-41d4-a716-446655440000

tagIds

string[]

Tag IDs attached to the entry as a whole. Per-line dimensions are on lines[].tagIds.

documentRefs

string[]

Document IDs attached to the entry

SplitEntryLine

accountId

string · required

Account ID for this line (UUID). Cannot be a heading or total account.

Example: 550e8400-e29b-41d4-a716-446655440000

type

string · enum · required

Transaction type for this line (debit or credit)

Enum values:

debit

credit

Example: debit

amount

number · required

Amount for this line (must be non-negative)

Example: 500

vatCodeId

string

VAT/Tax code ID for this line (UUID)

Example: 550e8400-e29b-41d4-a716-446655440000

description

string · maxLength: 500

Optional per-line memo (max 500 characters). Stored on the booked ledger transaction for this line, separate from the entry-level description.

Example: Consulting hours — March

tagIds

string[]

Dimension 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.

Example: ["550e8400-e29b-41d4-a716-446655440003"]

CreateDraftJournalEntryV2Request

entryType

string · enum · required

Journal type. For CUSTOMER_INVOICE / CUSTOMER_PAYMENT / SUPPLIER_INVOICE / SUPPLIER_PAYMENT the AR/AP leg is appended automatically; do not include it in lines.

Enum values:

journal

invoice

payment

supplier_invoice

supplier_payment

customer_invoice

customer_payment

date

string · required

Posting date (YYYY-MM-DD).

originalAmount

number · required

Face 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.

SplitEntryLine[] · minItems: 1 · maxItems: 1000 · required

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.

customerId

string

Customer reference. Required for CUSTOMER_* types.

supplierId

string

Supplier reference. Required for SUPPLIER_* types.

description

string · maxLength: 2000

Optional human-readable description.

reference

string

Invoice number / external reference.

externalSystemId

string · maxLength: 255

Your 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.

Example: erp-7f3a2c91

currency

string | null · minLength: 3 · maxLength: 3 · pattern: ^[A-Za-z]{3}$

ISO 4217 alpha-3 currency code.

Example: DKK

exchangeRate

number

Exchange rate from currency to the 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 the field 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.

Example: 7.4612

tagIds

string[]

Tag IDs applied at the entry level.

journalCategoryId

string

Journal 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.

AttachmentRequest[] · maxItems: 10

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.

CreateDraftJournalEntryV2BatchRequest

CreateDraftJournalEntryV2Request[] · minItems: 1 · maxItems: 100 · required

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

totalCreated

number · required

Number of drafts created (= entries.length on success).

DraftJournalEntryResponse[] · required

Created draft journal entries, ordered to match the request entries[].

UpdateDraftJournalEntryV2Request

date

string

Posting date (YYYY-MM-DD).

originalAmount

number

customerId

string | null · uuid

Customer 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).

supplierId

string | null · uuid

Supplier 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).

description

string · maxLength: 2000

Optional human-readable description.

reference

string

Invoice number / external reference.

externalSystemId

string | null · maxLength: 255

Your own system's id. null clears the value; omitting the field keeps it.

Example: erp-7f3a2c91

currency

string | null · minLength: 3 · maxLength: 3 · pattern: ^[A-Za-z]{3}$

ISO 4217 alpha-3 currency code.

Example: DKK

exchangeRate

number

Example: 7.4612

SplitEntryLine[] · minItems: 1 · maxItems: 1000

tagIds

string[]

Tag IDs applied at the entry level.

journalCategoryId

string

UpdateJournalEntryRequest

reference

string · maxLength: 255

Corrected 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.

Example: INV-1042

externalSystemId

string | null · maxLength: 255

Your 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.

Example: erp-7f3a2c91

UpdateJournalEntryResponse

id

string · required

Journal entry ID.

Example: 550e8400-e29b-41d4-a716-446655440000

reference

string | null · required

The reference after the update.

Example: INV-1042

externalSystemId

string | null · required

The external system id after the update.

Example: erp-7f3a2c91

ReverseJournalEntryRequest

journalEntryId

string · required

UUID of the posted journal entry to reverse.

Example: 550e8400-e29b-41d4-a716-446655440000

reversalDate

string

Date 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.

Example: 2026-06-01

reason

string · maxLength: 500

Free-text reason appended to the reversal description for audit purposes.

Example: Vendor invoice was duplicated

ReverseJournalEntryResponse

reversalId

string · required

Unique identifier of the posted reversal journal entry.

Example: 550e8400-e29b-41d4-a716-446655440000

BatchReverseJournalEntriesRequest

journalEntryIds

string[] · minItems: 1 · maxItems: 100 · required

IDs 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.

Example: ["550e8400-e29b-41d4-a716-446655440000","550e8400-e29b-41d4-a716-446655440001"]

reversalDate

string

Date 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.

Example: 2026-06-01

reason

string · maxLength: 500

Free-text reason appended to every reversal description for audit purposes.

Example: Bulk reversal of misclassified subscription invoices

BatchReverseJournalEntriesResultItem

originalId

string · required

Original journal entry ID supplied in the request.

Example: 550e8400-e29b-41d4-a716-446655440000

reversalId

string · required

Unique identifier of the posted reversal journal entry.

Example: 550e8400-e29b-41d4-a716-446655440010

BatchReverseJournalEntriesResponse

totalReversed

number · required

Number of reversals posted. Equals the count of unique IDs in the request on success.

Example: 2

BatchReverseJournalEntriesResultItem[] · required

Result rows pairing each original ID with its newly created reversal ID.

ReclassifyJournalEntryLine

ledgerTransactionId

string · required

UUID of the ledger transaction (posting line) to move. Read these from GET /api/v1/journal-entries/{id}.

Example: 550e8400-e29b-41d4-a716-446655440000

newAccountId

string · required

UUID of the ledger account the line should be posted to instead.

Example: 550e8400-e29b-41d4-a716-446655440001

newVatCodeId

string | null

UUID 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.

Example: 550e8400-e29b-41d4-a716-446655440002

PreviewJournalEntryCorrectionRequest

correctionType

string · enum · required

Which correction to preview.

Enum values:

reverseOnly

reverseAndCorrect

reclassify

Example: reclassify

correctionDate

string · pattern: ^\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.

Example: 2026-06-01

reason

string · maxLength: 1700

Free-text reason appended to the correction description for audit purposes.

Example: Booked with 0% VAT instead of 25%

ReclassifyJournalEntryLine[] · maxItems: 100

Line changes to preview (max 100). Required for reclassify, ignored by the other two types.

JournalEntryCorrectionPreviewLine

accountNumber

string · required

Account number the line posts to.

Example: 6200

accountName

string · required

Account name.

Example: Brændstof

amount

number · required

Line amount, in the currency named by currency.

Example: 5000

type

string · enum · required

Which side of the entry the line sits on.

Enum values:

debit

credit

currency

string · required

The line's currency - its ledger account's own.

Example: DKK

vatCodeName

string

VAT code applied to the line, when it carries one.

Example: I25

isChanged

boolean

True when this line differs from the original entry. Only set on a reclassification preview.

isVatTransaction

boolean

True when the line is a VAT leg generated from another line.

JournalEntryCorrectionPreviewEnteredAs

amount

number · required

The amount as originally keyed.

Example: 1000

currency

string · required

The currency it was keyed in.

Example: EUR

exchangeRate

number · required

The rate it was converted at.

Example: 7.45

JournalEntryCorrectionPreviewEntry

description

string · required

Description the entry would carry.

Example: Correction of INV-1042

date

string · required

Date the entry would post on (YYYY-MM-DD).

Example: 2026-06-01

entryType

string · enum · required

Which entry of the correction this is.

Enum values:

reversal

correction_draft

reclassification

original

isDraft

boolean · required

True when this entry would be created as a draft rather than posted.

JournalEntryCorrectionPreviewLine[] · required

The postings the entry would carry.

totalDebit

number · required

Sum of the debit lines, in totalCurrency.

Example: 5000

totalCredit

number · required

Sum of the credit lines, in totalCurrency.

Example: 5000

totalCurrency

string · required

The 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.

Example: DKK

object

What the operator originally keyed, when that differs from the currency the lines are shown in. Display only.

JournalEntryCorrectionPreviewResponse

object · required

The reversal that would neutralise the original.

object

The entry as it stands today, for comparison. Present on a reclassification preview.

object

The replacement entry. Absent for reverseOnly, which posts no replacement.

ReverseAndCorrectJournalEntryRequest

correctionDate

string · pattern: ^\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.

Example: 2026-06-01

reason

string · maxLength: 1700

Free-text reason appended to the correction description for audit purposes.

Example: Booked with 0% VAT instead of 25%

ReverseAndCorrectJournalEntryResponse

reversalId

string · required

Unique identifier of the posted reversal journal entry.

Example: 550e8400-e29b-41d4-a716-446655440000

draftId

string · required

Unique 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.

Example: 550e8400-e29b-41d4-a716-446655440010

ReclassifyJournalEntryRequest

ReclassifyJournalEntryLine[] · minItems: 1 · maxItems: 100 · required

The lines to move (1-100). Lines not listed are copied to the replacement entry unchanged.

correctionDate

string · pattern: ^\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.

Example: 2026-06-01

reason

string · maxLength: 1700

Free-text reason appended to the correction description for audit purposes.

Example: Booked with 0% VAT instead of 25%

ReclassifyJournalEntryResponse

reversalId

string · required

Unique identifier of the posted reversal of the original entry.

Example: 550e8400-e29b-41d4-a716-446655440000

newEntryId

string · required

Unique identifier of the posted replacement entry carrying the new account and VAT coding.

Example: 550e8400-e29b-41d4-a716-446655440010

ListJournalEntriesResponse

JournalEntryResponse[] · required

List of journal entries

total

number · required

Total number of matching entries

Example: 150

page

number · required

Current page number

Example: 1

limit

number · required

Number of items per page

Example: 25

totalPages

number · required

Total number of pages

Example: 6

JournalEntryAttachmentResponse

id

string · required

Unique identifier of the attachment/document

Example: 550e8400-e29b-41d4-a716-446655440000

filename

string · required

Original filename of the attachment

Example: invoice.pdf

contentType

string · required

MIME type of the attachment

Example: application/pdf

fileSize

number · required

File size in bytes

Example: 102400

content

string · required

Base64-encoded file content

Example: JVBERi0xLjQKJeLjz9MKMyAwIG9iago8PC...

createdAt

string · required

Timestamp when the attachment was created

Example: 2026-01-15T10:30:00.000Z

JournalEntryAttachmentsListResponse

journalEntryId

string · required

Journal entry ID the attachments belong to

Example: 550e8400-e29b-41d4-a716-446655440000

JournalEntryAttachmentResponse[] · required

List of attachments

CreateJournalEntryV2Dto

entryType

string · enum · required

Journal type. For CUSTOMER_INVOICE / CUSTOMER_PAYMENT / SUPPLIER_INVOICE / SUPPLIER_PAYMENT the AR/AP leg is appended automatically; do not include it in lines.

Enum values:

journal

invoice

payment

supplier_invoice

supplier_payment

customer_invoice

customer_payment

date

string · required

Posting date (YYYY-MM-DD).

originalAmount

number · required

SplitEntryLine[] · minItems: 1 · maxItems: 1000 · required

customerId

string

Customer reference. Required for CUSTOMER_* types.

supplierId

string

Supplier reference. Required for SUPPLIER_* types.

description

string · maxLength: 2000

Optional human-readable description.

reference

string

Invoice number / external reference.

externalSystemId

string · maxLength: 255

Your 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.

Example: erp-7f3a2c91

currency

string | null · minLength: 3 · maxLength: 3 · pattern: ^[A-Za-z]{3}$

ISO 4217 alpha-3 currency code.

Example: DKK

exchangeRate

number

Example: 7.4612

tagIds

string[]

Tag IDs applied at the entry level.

journalCategoryId

string

AttachmentRequest[] · maxItems: 10

CreateJournalEntryV2BatchRequest

CreateJournalEntryV2Dto[] · minItems: 1 · maxItems: 100 · required

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

totalCreated

number · required

Number of journal entries created (= entries.length on success).

JournalEntryResponse[] · required

Created journal entries, ordered to match the request entries[].

JournalCategoryResponse

id

string · required

The unique identifier of the journal category

Example: 550e8400-e29b-41d4-a716-446655440000

name

string · required

Name of the journal category

Example: General Journal

isDefault

boolean · required

Whether this is the default journal category

Example: true

allowedJournalTypes

array[] · required

Journal 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.

Example: ["JOURNAL_ENTRY","SUPPLIER_INVOICE","SUPPLIER_PAYMENT","CUSTOMER_INVOICE","CUSTOMER_PAYMENT"]

CreateJournalCategoryRequest

name

string · minLength: 2 · maxLength: 100 · required

Name of the journal category. Must be unique within your company.

Example: Sales

allowedJournalTypes

string[]

Journal 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.

Enum values:

JOURNAL_ENTRY

SUPPLIER_INVOICE

SUPPLIER_PAYMENT

CUSTOMER_INVOICE

CUSTOMER_PAYMENT

CUSTOMER_REMINDER

CURRENCY_REVALUATION

VAT_SETTLEMENT

Example: ["CUSTOMER_INVOICE","CUSTOMER_PAYMENT"]

isDefault

boolean

Make 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.

Example: false

UpdateJournalCategoryRequest

name

string · minLength: 2 · maxLength: 100

New name for the journal category. Must be unique within your company.

Example: Sales and refunds

allowedJournalTypes

string[]

Replaces 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.

Enum values:

JOURNAL_ENTRY

SUPPLIER_INVOICE

SUPPLIER_PAYMENT

CUSTOMER_INVOICE

CUSTOMER_PAYMENT

CUSTOMER_REMINDER

CURRENCY_REVALUATION

VAT_SETTLEMENT

Example: ["CUSTOMER_INVOICE","CUSTOMER_PAYMENT"]

isDefault

boolean

Pass 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.

Example: true

MeterSubscriptionProductDTO

id

string · required

Product ID

Example: 550e8400-e29b-41d4-a716-446655440000

name

string · required

Product name

Example: API Calls Package

productNumber

string · required

Product number

Example: PROD-001

MeterSubscriptionDTO

id

string · required

Subscription ID

Example: 550e8400-e29b-41d4-a716-446655440000

name

string · required

Subscription name

Example: Enterprise Plan

status

string · required

Subscription status

Example: active

MeterSubscriptionProductDTO[] · required

Products in this subscription that use the meter

MeterSubscriptionsResponseDTO

meterId

string · required

Meter ID

Example: 550e8400-e29b-41d4-a716-446655440000

meterName

string · required

Meter name

Example: api_calls

MeterSubscriptionDTO[] · required

Subscriptions with products using this meter

PaymentMethodResponse

id

string · required

Unique identifier of the payment method

Example: 019D1234-ABCD-7000-8000-123456789ABC

customerId

string · required

Customer ID this payment method belongs to

Example: 019CBD16-4BFF-766B-BAD7-2F7C36DC3377

provider

string · enum · required

Payment provider

Enum values:

ONPAY

STRIPE

Example: ONPAY

label

string · required

Human-readable label for the payment method

Example: Dankort •••• 1234

isDefault

boolean · required

Whether this is the default payment method for the customer

Example: false

status

string · enum · required

Current status of the payment method

Enum values:

ACTIVE

EXPIRED

CANCELLED

Example: ACTIVE

createdAt

string · required

When the payment method was created

Example: 2026-03-25T10:30:00.000Z

cardMask

string

Masked card number

Example: 457199XXXXXX1234

cardType

string

Card type as reported by the provider

Example: dankort

expiryMonth

number

Card expiry month

Example: 12

expiryYear

number

Card expiry year

Example: 2029

CreateCardSaveLinkRequest

provider

string · enum · required

Payment provider to use for saving the card

Enum values:

ONPAY

STRIPE

Example: ONPAY

PaymentLinkResponse

url

string · required

URL to the payment provider window. Send this to your customer.

Example: https://onpay.io/window/v3/ce8490fa-282e-11f1-a569-11b5d69909e2?k=FFtXYUNXxkh

expiresAt

string · required

When the payment link expires

Example: 2026-03-25T11:30:00.000Z

PublicSubscriptionPlanPhaseProduct

priceId

string · required

Price ID of the product

Example: 550e8400-e29b-41d4-a716-446655440000

quantity

number

Quantity for the product

Example: 1

customPrice

string

Custom unit price override

Example: 89.99

PublicSubscriptionPlanIntervalDiscount

billingInterval

string · enum · required

Billing interval the discount applies to

Enum values:

day

week

month

year

Example: month

billingIntervalCount

number · required

Billing interval count (e.g. 1 = monthly, 6 = every 6 months)

Example: 1

discountType

string · enum · required

Discount type: flat (subtract amount) or period_total (set the period’s target total)

Enum values:

flat

period_total

Example: flat

value

string · required

Discount value (NET, excluding VAT)

Example: 50.00

description

string

Optional description shown on the invoice

Example: Negotiated rate discount

PublicSubscriptionPlanPhase

id

string · required

Phase ID

Example: 550e8400-e29b-41d4-a716-446655440000

sequence

number · required

Sequence order of the phase (1-based)

Example: 1

discountType

string · enum · required

Type of discount applied during the phase

Enum values:

none

percentage

Example: percentage

PublicSubscriptionPlanPhaseProduct[] · required

Products for this phase

name

string

Phase name

Example: Intro promo

discountValue

string

Discount value for the phase

Example: 10.00

durationValue

number

Phase duration value

Example: 3

durationUnit

string · enum

Phase duration unit

Enum values:

day

week

month

year

Example: month

PublicSubscriptionPlanIntervalDiscount[]

Per-billing-interval (period) discounts configured for this phase

PublicSubscriptionPlanResponse

id

string · required

Subscription plan ID

Example: 550e8400-e29b-41d4-a716-446655440000

name

string · required

Subscription plan name

Example: Premium Plan

isActive

boolean · required

Whether the subscription plan is active

Example: true

currency

string · required

Currency code (ISO 4217)

Example: DKK

defaultBillingDirection

string · enum · required

Default billing direction for new customer subscriptions

Enum values:

advance

arrears

Example: advance

PublicSubscriptionPlanPhase[] · required

Phases configured for this plan

createdAt

string · required

Date the plan was created

Example: 2024-01-01T00:00:00.000Z

updatedAt

string · required

Date the plan was last updated

Example: 2024-01-01T00:00:00.000Z

description

string

Subscription plan description

Example: Our premium subscription plan with all features

PublicListSubscriptionPlansResponse

PublicSubscriptionPlanResponse[] · required

List of subscription plans

total

number · required

Total number of subscription plans matching the query

Example: 42

page

number · required

Current page number (1-indexed)

Example: 1

limit

number · required

Maximum number of items per page

Example: 25

totalPages

number · required

Total number of pages available

Example: 2

PublicCreateSubscriptionPlanPhaseProduct

priceId

string · required

Price ID of an existing product price to include in this phase

Example: 550e8400-e29b-41d4-a716-446655440000

quantity

number

Quantity for the product (defaults to 1)

Example: 1

customPrice

string

Custom unit price override for this line (defaults to the price’s own amount)

Example: 89.99

PublicCreateSubscriptionPlanIntervalDiscount

billingInterval

string · enum · required

Billing interval the discount applies to

Enum values:

day

week

month

year

Example: month

billingIntervalCount

number · min: 1 · required

Billing interval count (e.g. 1 = monthly, 6 = every 6 months)

Example: 1

discountType

string · enum · required

Discount type: flat (subtract amount) or period_total (set the period’s target total)

Enum values:

flat

period_total

Example: flat

value

string · required

Discount value (NET, excluding VAT). For flat: amount to subtract; for period_total: the target total.

Example: 50.00

description

string

Optional description shown on the invoice

Example: Negotiated rate discount

PublicCreateSubscriptionPlanPhase

PublicCreateSubscriptionPlanPhaseProduct[] · maxItems: 200 · required

Products included in this phase. At least one is required.

name

string

Display name for the phase

Example: Intro promo

discountType

string | null · enum

Type of discount applied across the whole phase. Defaults to none when omitted or null.

Enum values:

none

percentage

Example: none

discountValue

string

Discount value for the phase. Percentage (0-100), fixed amount, or total target depending on discountType.

Example: 10.00

PublicCreateSubscriptionPlanIntervalDiscount[]

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.

durationValue

number · min: 1

Length of the phase. Omit on the last phase to leave it open-ended.

Example: 3

durationUnit

string · enum

Unit for the phase duration

Enum values:

day

week

month

year

Example: month

PublicCreateSubscriptionPlanRequest

name

string · required

Subscription plan name. Must be unique within your company.

Example: Premium Plan

PublicCreateSubscriptionPlanPhase[] · maxItems: 50 · required

Phases defining the plan’s billing structure. At least one phase is required.

description

string

Subscription plan description

Example: Our premium subscription plan with all features

currency

string · minLength: 3 · maxLength: 3

Currency code (ISO 4217). Omit to bill in the company's own base currency.

Example: DKK

defaultBillingDirection

string · enum

Default billing direction applied to new customer subscriptions created from this plan

Enum values:

advance

arrears

Example: advance

PublicCancelSubscriptionRequest

id

string · required

Customer subscription ID to cancel

Example: 550e8400-e29b-41d4-a716-446655440000

strategy

string · enum · required

Cancellation strategy

Enum values:

immediately

end_of_cycle

specific_date

clear_schedule

Example: end_of_cycle

effectiveDate

string

Effective churn date (ISO 8601). Required when strategy is SPECIFIC_DATE.

Example: 2024-06-30

refundBehavior

string · enum

Refund behavior when canceling immediately

Enum values:

none

last_invoice

prorated

Example: none

Default: none

cancellationReason

string

Optional reason for cancelling the subscription

Example: Customer requested downgrade

EntitlementRef

id

string · required

Entitlement ID

name

string · required

Entitlement name

Example: Advanced reporting

key

string | null

Stable integration key

Example: advanced_reporting

PublicCustomerSubscriptionResponse

id

string · required

Customer subscription ID

Example: 550e8400-e29b-41d4-a716-446655440000

customerId

string · required

Customer ID

Example: 550e8400-e29b-41d4-a716-446655440000

customerName

string · required

Customer name

Example: Acme Corporation

subscriptionName

string · required

Subscription name

Example: Premium Plan

startDate

string · required

Start date (ISO 8601)

Example: 2024-01-01

status

string · enum · required

Status of the customer subscription

Enum values:

scheduled

trial

awaiting_payment

active

pending_cancellation

paused

cancelled

expired

Example: active

currency

string · required

Currency code (ISO 4217)

Example: DKK

billingDirection

string · enum · required

Billing direction: ADVANCE bills at period start, ARREARS at period end

Enum values:

advance

arrears

Example: advance

effectiveBillingDirection

string · enum · required

Effective billing direction for the current period. Can differ from billingDirection if the direction was changed mid-period.

Enum values:

advance

arrears

Example: advance

EntitlementRef[]

Entitlements currently granted by the subscription

planId

string

Subscription plan ID (null for ad-hoc subscriptions)

Example: 550e8400-e29b-41d4-a716-446655440000

endDate

string

End date (ISO 8601)

Example: 2025-01-01

scheduledChurnDate

string

Scheduled churn date (ISO 8601)

Example: 2024-07-15

trialDays

number

Number of trial days granted

Example: 14

cancellationReason

string

Reason provided when the subscription was cancelled

Example: Customer requested downgrade

effectiveNextBillingDate

string

The 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.

Example: 2024-02-01

paidThroughDate

string | null

The 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.

Example: 2024-02-01

commitmentEndDate

string

End date of the customer commitment period (ISO 8601)

Example: 2025-12-31

originalStartDate

string

Original start date from source system for migrated subscriptions (ISO 8601)

Example: 2023-01-01

paymentMethodId

string | null

Assigned payment method ID

Example: 550e8400-e29b-41d4-a716-446655440000

automaticBilling

boolean

Whether automatic billing is enabled

Example: true

partnerReferenceId

string | null

Your 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.

Example: order_7f3a9c21

billingGroupId

string | null

The billing group this subscription bills on, or null when it bills on its own. A grouped subscription is charged on the group’s card, so its own paymentMethodId is null and automaticBilling is false. A subscription that has joined a group but not yet reached its first shared billing date already reports the group.

Example: 0197A943-2325-7829-B835-B6C71A293065

PublicCustomerSubscriptionListItem

id

string · required

Customer subscription ID

Example: 550e8400-e29b-41d4-a716-446655440000

customerId

string · required

Customer ID

Example: 550e8400-e29b-41d4-a716-446655440000

customerName

string · required

Customer name

Example: Acme Corporation

subscriptionName

string · required

Subscription plan name

Example: Premium Plan

status

string · enum · required

Status of the customer subscription

Enum values:

scheduled

trial

awaiting_payment

active

pending_cancellation

paused

cancelled

expired

Example: active

startDate

string · required

Start date (ISO 8601)

Example: 2024-01-01

currency

string · required

Currency code (ISO 4217)

Example: DKK

customerNumber

string

Customer number

Example: C001

planId

string

Subscription plan ID (null for ad-hoc subscriptions)

Example: 550e8400-e29b-41d4-a716-446655440000

effectiveNextBillingDate

string

The 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.

Example: 2024-02-01

paidThroughDate

string | null

Example: 2024-02-01

partnerReferenceId

string | null

Example: order_7f3a9c21

billingGroupId

string | null

The billing group this subscription bills 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.

Example: 0197A943-2325-7829-B835-B6C71A293065

PublicListCustomerSubscriptionsResponse

PublicCustomerSubscriptionListItem[] · required

List of customer subscriptions

total

number · required

Total number of customer subscriptions matching the query

Example: 42

page

number · required

Current page number (1-indexed)

Example: 1

limit

number · required

Maximum number of items per page

Example: 25

totalPages

number · required

Total number of pages available

Example: 2

PublicAssignSubscriptionProductOverride

priceId

string · required

Price ID of the product to override

Example: 550e8400-e29b-41d4-a716-446655440000

quantity

number

Quantity to assign (overrides the plan template quantity). Not valid on usage-metered prices. Omit when the override only carries prepaid-commitment settings.

Example: 25

committedQuantity

number | null

Prepaid 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.

Example: 100

usageCarryoverMode

string | null · enum

How 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.

Enum values:

reset

track_actual

ratchet_up

ratchet_down

underageMode

string | null · enum

What happens to underage (actual below committed) at settlement: forfeit (kept) or refund (credited). Null reads as forfeit.

Enum values:

forfeit

refund

minimumCommittedQuantity

number | null

Floor for downward carryover (0 <= floor <= committedQuantity). Null = no floor.

committedUnitPrice

number | null

Flat 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.

Example: 8

discardPreAssignmentUsage

boolean

Don'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.

Example: true

PublicAssignSubscriptionRequest

customerId

string · required

Customer ID to assign the subscription to

Example: 550e8400-e29b-41d4-a716-446655440000

planId

string · required

Subscription plan ID

Example: 550e8400-e29b-41d4-a716-446655440000

startDate

string · required

Start date (ISO 8601)

Example: 2024-01-01

endDate

string

End date (ISO 8601)

Example: 2025-01-01

billingCycleAnchor

string

Billing cycle anchor date (ISO 8601). When the billing cycle should align to. Defaults to startDate if not provided.

Example: 2024-02-01

prorationBehavior

string · enum

How to handle proration from startDate to billingCycleAnchor

Enum values:

create_prorations

always_invoice

none

Example: none

Default: none

trialDays

number · min: 0 · max: 365

Trial period in days

Example: 14

billingDirection

string · enum

Billing direction for this subscription

Enum values:

advance

arrears

Example: advance

customerDepartmentId

string

Customer department ID for invoice delivery

Example: 550e8400-e29b-41d4-a716-446655440000

departmentContactOverrideId

string

Contact override ID for department invoice delivery

Example: 550e8400-e29b-41d4-a716-446655440000

PublicAssignSubscriptionProductOverride[]

Optional quantity overrides for products in the plan

automaticBilling

boolean

Whether to enable automatic billing

Example: false

collectViaLeverandorservice

boolean

Collect 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.

Example: false

joinBillingGroupId

string

Create 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.

Example: 0197A943-2325-7829-B835-B6C71A293065

formBillingGroupWithSubscriptionId

string

Create 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.

Example: 0197A943-2325-7829-B835-B6C71A293065

PublicScheduledChange

changeId

string · required

Identifier of this queued change. Ephemeral — valid only until the change activates or is cancelled, so re-fetch rather than caching it.

Example: 550e8400-e29b-41d4-a716-446655440000

kind

string · required

The kind of queued change: one of replace_plan, edit_products, change_direction, or churn.

Example: replace_plan

effectiveDate

string · required

The date (YYYY-MM-DD) the change takes effect.

Example: 2024-07-01

planId

string | null · required

The plan the subscription moves to when the change activates (null for ad-hoc / non-plan changes).

Example: 550e8400-e29b-41d4-a716-446655440000

subscriptionName

string · required

The plan name the change moves to.

Example: Pro (annual)

PublicRetryPaymentResponseDTO

status

string · required

Always "succeeded" — a failed retry returns a coded error instead.

Example: succeeded

subscriptionId

string · required

The stable subscription id the retry ran against.

Example: 01890a5d-ac96-774b-b9aa-9d0f8f6c3b45

invoiceId

string · required

Id of the outstanding invoice the cleared charge paid.

Example: 01890a5d-ac96-774b-b9aa-9d0f8f6c3b46

PublicUpdateSubscriptionRequest

paymentMethodId

string | null

The 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.

Example: null

automaticBilling

boolean

Whether to automatically charge the saved card during billing

Example: true

PublicBillingGroupEligibilityRequest

mode

string · enum · required

form asks whether leadSubscriptionId and memberSubscriptionIds could form a group; join asks whether subscriptionIds could join billingGroupId.

Enum values:

form

join

Example: form

leadSubscriptionId

string

form: the subscription whose terms the group would take.

memberSubscriptionIds

string[]

form: the subscriptions that would join, 0 to 19. Omitted or empty asks whether the lead could lead a group at all.

billingGroupId

string

join: the group to join.

subscriptionIds

string[]

join: the subscriptions that would join, 1 to 19.

PublicBillingGroupRefusal

code

string · required

The error code the write would answer with.

Example: SUBSCRIPTION_BILLING_GROUP_CURRENCY_MISMATCH

subscriptionId

string | null

The subscription the refusal is about, or null for a refusal about the whole set (the member limit, a dissolved group).

Example: 0197A943-2325-7829-B835-B6C71A293065

PublicBillingGroupEligibilityResponse

eligible

boolean · required

True when the write would be accepted today.

Example: true

PublicBillingGroupRefusal[] · required

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

leadSubscriptionId

string · required

The 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.

Example: 0197A943-2325-7829-B835-B6C71A293065

memberSubscriptionIds

string[] · required

The other subscriptions of the same customer that join the group: 1 to 19, distinct, none already in a group. A group holds at most 20 members including the lead.

invoiceTemplateId

string | null

A consolidated document template for the shared invoice. Omitted or null uses the customer's, then your default.

Example: null

includeMemberDetailsPdf

boolean

Attach a zip with one detail document per member to each send. Defaults to false.

Example: false

PublicBillingGroupMemberRef

subscriptionId

string · required

The subscription, by its stable id.

Example: 0197A943-2325-7829-B835-B6C71A293065

PublicFormBillingGroupResponse

billingGroupId

string · required

The new group.

Example: 0197A943-2325-7829-B835-B6C71A293065

billingActiveFrom

string · required

The day the set starts billing together (YYYY-MM-DD).

Example: 2026-10-01

leadSubscriptionId

string · required

The subscription whose terms the group took, echoed from the request.

Example: 0197A943-2325-7829-B835-B6C71A293065

PublicBillingGroupMemberRef[] · required

Every member, the lead included.

PublicBillingGroupMember

subscriptionId

string · required

The member subscription — the same stable id every subscription endpoint takes.

Example: 0197A943-2325-7829-B835-B6C71A293065

subscriptionName

string · required

The subscription's current name.

Example: Pro plan

billingActiveFrom

string · required

The 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.

Example: 2026-10-01

monthlyRevenue

string · required

The member's own monthly recurring revenue, as a decimal string. The group has no revenue of its own; sum the members.

Example: 499.00

currency

string · required

Currency code (ISO 4217). Every member of a group shares one.

Example: DKK

effectiveNextBillingDate

string | null

The member's next billing date (YYYY-MM-DD), or null when it no longer bills.

Example: 2026-10-01

PublicBillingGroup

id

string · required

Billing group id

Example: 0197A943-2325-7829-B835-B6C71A293065

customerId

string · required

The one customer every member belongs to.

Example: 0197A943-2325-7829-B835-B6C71A293065

billingActiveFrom

string · required

The day the group started, or starts, billing as a set (YYYY-MM-DD).

Example: 2026-10-01

chargesByCard

boolean · required

True 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.

Example: false

includeMemberDetailsPdf

boolean · required

Whether each send also attaches a zip with one detail document per member.

Example: false

PublicBillingGroupMember[] · required

The current members, ordered by the day they start billing on the group and then by id. Empty once the group has dissolved.

dissolvedAt

string | null

When the group dissolved (ISO 8601), or null while it bills as a set. A dissolved group keeps answering here because the invoices it issued still name it.

Example: null

invoiceTemplateId

string | null

The consolidated document template the shared invoice renders from, or null to use the customer's, then your default.

Example: null

PublicAddBillingGroupMembersRequest

subscriptionIds

string[] · required

Subscriptions 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

billingGroupId

string · required

The group joined.

Example: 0197A943-2325-7829-B835-B6C71A293065

billingActiveFrom

string · required

The day the joiners start billing on the group's invoice (YYYY-MM-DD).

Example: 2026-10-01

PublicBillingGroupMemberRef[] · required

The subscriptions that joined.

PublicRemoveBillingGroupMemberResponse

billingGroupId

string · required

The group the subscription left.

Example: 0197A943-2325-7829-B835-B6C71A293065

subscriptionId

string · required

The subscription that left, by its stable id.

Example: 0197A943-2325-7829-B835-B6C71A293065

groupDissolved

boolean · required

True when this departure left fewer than two members and the whole group dissolved: the remaining member bills on its own from its next billing date.

Example: false

CheckoutReadinessStripeConnect

connected

boolean · required

Whether an active Stripe Connect account backs the card rail.

status

string | null · required

The connected account’s status, when one exists.

settlementCurrency

string | null · required

Settlement currency of the connected account.

allowCrossCurrencyCharges

boolean · required

Whether cross-currency charges are enabled on your Stripe account.

chargeableCurrencies

string[] · required

Catalogue currencies that pass the charge predicate — a card step offered in any other currency would be refused.

CheckoutReadinessResponse

subscriptionLicense

boolean · required

Whether you hold the Subscription license — without it nothing is checkoutable.

publishedPlans

number · required

Number of published plans.

checkoutablePlans

number · required

Number of published plans with a sellable item — checkoutable on this surface.

generalTermsPublished

boolean · required

Informational, 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.

CheckoutReadinessStripeConnect · required

embeddableOrigins

string[] · required

The configured embeddableOrigins allowlist — required for HOSTED card windows’ returnUrl.

CheckoutQuantitySelection

priceId

string · uuid · required

The snapshot price id the quantity applies to.

quantity

number · required

The buyer-chosen quantity. Clamped to the card’s quantity rules server-side.

CheckoutQuoteRequest

planVersionId

string · uuid · required

The plan version to quote (from the catalogue).

planItemId

string · uuid · required

The pricing-card item on that version.

country

string · required

Buyer country, ISO 3166-1 alpha-2 — REQUIRED so VAT resolves exactly.

Example: DK

customerType

string · enum · required

Whether the buyer is a business or a private person.

Enum values:

BUSINESS

PRIVATE_PERSON

vatNumber

string

The buyer’s VAT number (BUSINESS only — refused otherwise).

startDate

string

Requested start date (YYYY-MM-DD). Defaults to today; never in the past.

currency

string

Presentment currency (ISO 4217). Must be in the card’s availableCurrencies; refused with PORTAL_CHECKOUT_CURRENCY_NOT_AVAILABLE otherwise. Absent → the card’s own currency.

Example: DKK

CheckoutQuantitySelection[]

Buyer-chosen quantities for quantity-bearing products.

language

string · enum

Language for display texts, terms and the disclosure.

Enum values:

CheckoutQuoteResponse

quote

object · required

First-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, terms bodies, the resolved start date, allowed payment methods and cardPaymentsEnabled.

firstPeriodChargeable

boolean · required

False when the first period nets to zero (free trial / 100% discount). The card window still opens save-only — the card is stored for the first real charge and nothing is authorized ("no charge today").

CheckoutBuyer

customerType

string · enum · required

Whether the buyer is a business or a private person.

Enum values:

BUSINESS

PRIVATE_PERSON

name

string · required

Company name (BUSINESS) or the person’s full name (PRIVATE_PERSON).

Example: Acme ApS

email

string · required

The buyer’s identity email: consent evidence is recorded against it and the self-service manage link is sent to it.

Example: buyer@example.com

customerGroupId

string · uuid · required

REQUIRED: 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.

country

string · required

Buyer country, ISO 3166-1 alpha-2 — drives VAT resolution.

Example: DK

vatNumber

string

The buyer’s VAT number (BUSINESS only — refused otherwise). Checked against the country’s published format; registry (VIES) verification is not performed.

Example: DK12345678

address

string

Billing address line.

postalCode

string

Billing postal code.

city

string

Billing city.

billingEmail

string

Where invoices, receipts and payment notices are sent when it differs from the buyer’s identity email. Absent → the identity email receives them.

Example: billing@example.com

existingCustomerId

string · uuid

An 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

planVersionId

string · uuid · required

The plan version to check out (from the catalogue).

planItemId

string · uuid · required

The pricing-card item on that version.

object · required

The buyer — plain request data; no tokens, no ceremony.

startDate

string

Requested start date (YYYY-MM-DD). Defaults to today; never in the past.

currency

string

Presentment currency (ISO 4217); must be in the card’s availableCurrencies.

CheckoutQuantitySelection[]

Buyer-chosen quantities.

expiresInMinutes

number · min: 5 · max: 1440

Session TTL in minutes. Default 30.

reference

string

Your own order/cart id (Stripe client_reference_id parity) — echoed on session reads, the confirm response and every checkout.* webhook payload.

language

string · enum

Language for display texts, terms and the disclosure.

Enum values:

CheckoutPinned

currency

string · required

Pinned presentment currency (ISO 4217).

Example: DKK

netMajor

number · required

Pinned first-period net, in major units.

totalGrossMajor

number · required

Pinned 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.

startDate

string · required

Pinned start date (YYYY-MM-DD).

disclosureVersion

string · required

Pinned recurring-billing disclosure version.

disclosureText

string · required

The server-rendered recurring-billing disclosure text for the pinned version — render it (or your own equivalent) before the buyer accepts recurring billing.

acceptedTermsVersionIds

string[] · required

The 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.

expiresInMinutes

number · required

The session TTL that was applied, in minutes.

CheckoutSessionResponse

sessionId

string · required

The opaque session id — your handle for every later call.

expiresAt

string · required

When the session expires (ISO 8601). Expired sessions answer 410.

reference

string | null · required

Your reference, echoed.

quote

object · required

The same first-period quote payload POST /v1/checkout/quote returns.

object · required

What the session pinned — render exactly this.

firstPeriodChargeable

boolean · required

False when the pinned first period nets to zero (save-only card window).

CheckoutSessionView

sessionId

string · required

The opaque session id.

expiresAt

string · required

When the session expires (ISO 8601).

reference

string | null · required

Your reference, echoed.

planVersionId

string · uuid · required

The pinned plan version.

planItemId

string · uuid · required

The pinned pricing-card item.

buyer

object · required

The buyer payload the session was minted with.

CheckoutPinned · required

firstPeriodChargeable

boolean · required

False when the pinned first period nets to zero.

cardWindowOpened

boolean · required

Whether a card window has been opened on this session.

CheckoutCardWindowRequest

uiMode

string · enum

How 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.

Enum values:

embedded

hosted

returnUrl

string

Where 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

mode

string · enum · required

STRIPE_EMBEDDED → mount with clientSecret; REDIRECT → navigate the buyer to redirectUrl.

Enum values:

STRIPE_EMBEDDED

REDIRECT

handoffToken

string · required

The 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.

expiresAt

string · required

When the provider window expires (ISO 8601).

clientSecret

string

Stripe embedded Checkout client secret (STRIPE_EMBEDDED only).

publishableKey

string

Publishable key for Stripe.js (STRIPE_EMBEDDED only).

stripeAccountId

string

The connected Stripe account id for Stripe.js (STRIPE_EMBEDDED only).

redirectUrl

string

The hosted window URL to send the buyer to (REDIRECT only).

CheckoutCardDisplay

label

string · required

Ready-to-render label.

Example: Visa •••• 4242

cardType

string | null · required

Card network/brand, if known.

cardMask

string | null · required

Masked card number, if known.

accountIdentifier

string | null · required

Masked identifier for non-card methods (e.g. a Link email).

CheckoutCardStatusResponse

status

string · enum · required

PENDING: keep polling (or listen for checkout.card_ready). CARD_READY: confirm may proceed. EXPIRED: the window lapsed — open a fresh one.

Enum values:

PENDING

CARD_READY

EXPIRED

card

object | null

The captured card (CARD_READY only).

CheckoutCardReleaseResponse

status

string · enum · required

SAVE_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.

Enum values:

SAVE_ONLY

RECAPTURE_REQUIRED

CheckoutConfirmRequest

sessionId

string · required

The session to confirm. Single-use: consumed whatever the outcome.

paymentMethod

string · enum · required

The payment rail the buyer chose.

Enum values:

CARD

INVOICE

termsAccepted

boolean · required

Your assertion that the buyer accepted the pinned terms on your surface. Must be true — false/absent refuses with PORTAL_CHECKOUT_CONSENT_REQUIRED.

acceptedAt

string · required

When the buyer accepted (ISO 8601). Evidence, not authority — implausible instants (future, or older than an hour) are replaced with the server’s own clock.

recurringConsentAccepted

boolean

Your assertion that the buyer accepted recurring billing. REQUIRED true on the CARD rail.

cardHandoffToken

string

A 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

subscriptionId

string · uuid · required

The created subscription.

reference

string | null · required

Your reference, echoed.

billingPending

boolean · required

True 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

customerType

string

BUSINESS or PRIVATE_PERSON.

Example: BUSINESS

companyName

string

Company name, for a BUSINESS buyer.

Example: Acme ApS

firstName

string

lastName

string

vatNumber

string

address

string

postalCode

string

city

string

countryCode

string

ISO 3166-1 alpha-2.

Example: DK

PublicMintCheckoutVouchRequest

email

string · required

The 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.

Example: alice@acme.example

contactEmail

string

Where 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.

Example: billing@acme.example

customerId

string

A 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.

Example: 550e8400-e29b-41d4-a716-446655440010

object

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.

allowIdentityChange

boolean

Whether 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.

Example: true

Default: true

clientReferenceId

string

Your 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.

Example: order_7f3a9c21

PublicMintCheckoutVouchResponse

checkoutVouchToken

string · required

Opaque, 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.

Example: k7Fq2mZ8x1vN4pQ...

expiresAt

string · required

ISO 8601 expiry of the reference above.

Example: 2026-08-07T12:01:00.000Z

DefaultContactDto

name

string · required

Contact name

Example: John Doe

email

string

Contact email

Example: john@acme.com

phone

string

Contact phone number

Example: +45 12345678

CreateCustomerRequestDto

customerType

string · enum · required

Specifies whether the customer is a business or a private person

Enum values:

BUSINESS

PRIVATE_PERSON

Example: BUSINESS

Default: BUSINESS

name

string · required

Customer name

Example: Acme Corporation

vatZone

string · enum · required

VAT zone classification

Enum values:

domestic

abroad

domestic_without_vat

eu_at

eu_be

eu_bg

eu_cy

Example: domestic

customerGroupId

string · required

Customer group ID

Example: 01HQ3Y1234567890ABCDEFGHIJ

countryCode

string · required

Two-letter country code

Example: DK

customerNumber

string

Unique customer number. Omit it, or send an empty value, to have the next number assigned from the company customer sequence.

Example: 1042

email

string

Email address

Example: contact@acme.com

phone

string

Phone number

Example: +45 12345678

address

string

Street address

Example: 123 Main Street

city

string

City

Example: Copenhagen

postalCode

string

Postal code

Example: 2100

vatNumber

string

VAT registration number

Example: DK12345678

eanNumber

string

EAN/GLN number for Peppol routing

Example: 5790000000001

externalSystemId

string

External system identifier for tracking the customer across other systems. Unique per company.

Example: crm-12345

website

string

Website URL

Example: https://acme.com

notes

string · maxLength: 2000

Additional notes

Example: Key account customer

locale

string

Locale for formatting invoice data

Example: da-DK

language

string

Language code for communications

Example: da

creditLimit

object · min: 0

Credit limit

Example: 50000

openingBalance

object

Opening 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).

Example: 1000

paymentTerms

number · min: 0

Payment terms in days

Example: 30

paymentTermType

string · enum

Payment term type. Defaults to NET_DAYS.

Enum values:

NET_DAYS

CASH

RUNNING_MONTH_PLUS_DAYS

Default: NET_DAYS

defaultCashAccountId

string | null

Default cash payment account ID. Only relevant for CASH payment terms. Send null to clear.

defaultCurrency

string · pattern: ^[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.

Example: DKK

poNumber

string

Default purchase-order number ("PO-nr.") prefilled onto sales documents

Example: PO-12345

ourReference

string

Default "Vores ref." (our-side reference) prefilled onto sales documents

Example: Jane Doe

invoiceDeliveryTypePreference

string | null · enum

Preferred invoice delivery type for this customer. If set, overrides the app company default for billing.

Enum values:

Sproom

reminderConfigId

string | null

Reminder config profile ID. Send null to clear.

isActive

boolean

Whether the customer is active

Example: true

Default: true

object

Default contact to create for the customer. If not provided, customer name/email/phone will be used as fallback.

invoiceTemplateId

string

Invoice PDF template override

creditNoteTemplateId

string

Credit note PDF template override

quoteTemplateId

string

Quote PDF template override

orderConfirmationTemplateId

string

Order confirmation PDF template override

parentInvoiceTemplateId

string | null

Parent single invoice PDF template override. Send null to clear.

includeChildDetailsPdf

boolean

Whether to attach a zip of per-child detail PDFs when sending consolidated invoices

selfServiceDetailsEnabled

boolean

parentCustomerId

string | null

Parent customer ID. Send null to clear.

billingRelationship

string · enum

Billing relationship

Enum values:

self

parent_pays

consolidationMode

string | null · enum

Consolidation mode. Send null to clear.

Enum values:

single_invoice

per_child_invoice

billingDay

number | null

Billing day (1-28). Required for single invoice mode. Send null to clear.

object

Key-value metadata to attach to the customer

PublicProvisionCustomerRequest

email

string · required

Email of the portal user to grant access to. A credential-less portal user is created if none exists.

Example: jane.doe@acme.example

customerId

string

The 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.

Example: 550e8400-e29b-41d4-a716-446655440010

object

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.

role

string · enum

Membership role to grant. Defaults to USER; the org's first member is force-assigned OWNER regardless.

Enum values:

OWNER

ADMIN

BILLING_ADMIN

USER

Example: USER

userName

string

Display name of the portal user (set on first creation).

Example: Jane Doe

organizationDisplayName

string

Display name for the customer organization (first-invite bootstrap).

mintHandoff

boolean

When 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.

Example: false

sub

string

The partner's stable, unique user identifier — required when mintHandoff is true; keys the handoff identity (with the per-tenant handoff issuer).

Example: partner-user-7f3a9c21

mintCheckoutBindToken

boolean

When 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.

Example: false

clientReferenceId

string

Your 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.

Example: order_7f3a9c21

PublicProvisionCustomerResponse

customerId

string · required

Resolved customer id.

Example: 550e8400-e29b-41d4-a716-446655440010

customerCreated

boolean · required

Whether a new customer was created (false = an existing one was reused).

Example: true

portalUserId

string · required

Resolved portal user id.

Example: 550e8400-e29b-41d4-a716-446655440020

membershipId

string · required

The active organization membership id.

Example: 550e8400-e29b-41d4-a716-446655440030

role

string · enum · required

The granted membership role.

Enum values:

OWNER

ADMIN

BILLING_ADMIN

USER

Example: OWNER

handoffRef

string | null

Opaque, single-use, 60s handoff reference — present only when mintHandoff was requested. Null otherwise.

Example: Yk3pQ9sV2nR7tW1xZ4cB8mL6dF0aH5jE2gN9uK3pQ7s

handoffExpiresAt

string | null

ISO-8601 expiry of the handoff reference, when minted. Null otherwise.

Example: 2026-06-04T12:34:56.000Z

checkoutBindToken

string | null

Opaque, 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.

Example: Yk3pQ9sV2nR7tW1xZ4cB8mL6dF0aH5jE2gN9uK3pQ7s

checkoutBindExpiresAt

string | null

ISO-8601 expiry of the checkout-bind reference, when minted. Null otherwise.

Example: 2026-06-04T12:34:56.000Z

PublicResolvePortalPlansRequest

customerType

string · enum

Buyer customer type for gross-price resolution.

Enum values:

BUSINESS

PRIVATE_PERSON

Example: BUSINESS

vatNumber

string

Buyer 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.

Example: DK12345678

currency

string

Presentment 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.

Example: EUR

customerId

string

The 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.

Example: 550e8400-e29b-41d4-a716-446655440010

buyerEmail

string

The 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.

Example: buyer@partner.example

countryCode

string

ISO 3166-1 alpha-2 country hint for the no-customer-yet preview (drives the country rule clause). Ignored when customerId is supplied.

Example: DK

planIds

string[]

Resolve only these plan ids. Omit to resolve every ACTIVE plan of the tenant. Each must be a uuid.

Example: ["550e8400-e29b-41d4-a716-446655440100"]

language

string · enum

Language the resolved cards are localized to. Defaults to en.

Enum values:

Example: en

PublicPortalPlanItemFeature

label

string · required

Translated label, resolved for the request language.

iconKey

string | null · required

Optional Lu* icon key picked by the operator; null = default check icon.

Example: null

PublicPortalPricingTier

fromQuantity

number · required

First quantity covered by this tier.

Example: 0

toQuantity

number | null · required

Last quantity in this tier; null for the final unbounded tier.

Example: 100

unitAmountMinor

number | null · required

Per-unit amount in minor units; null when not set for this tier.

Example: 1000

flatFeeMinor

number | null · required

Flat fee for the tier in minor units; null when not set.

Example: null

PublicPortalPlanItemProduct

priceId

string · required

Snapshot price id — stable identity / render key.

label

string · required

Product display name (frozen product name, falling back to the price nickname).

description

string | null · required

Operator-authored product description; null when unset.

Example: null

quantity

number · required

Template quantity bundled in the plan. Defaults to 1 when unset.

Example: 1

pricingModel

string · required

Pricing model: 'flat_rate' | 'graduated' | 'package' | 'volume'.

Example: flat_rate

kind

string · enum · required

'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.

Enum values:

RECURRING

ONE_OFF

METERED

unitPriceMinor

number | null · required

Headline unit price in minor units (first-unit "from" price for tiered models); null when unresolvable.

Example: 1000

currency

string · required

Currency code for unitPriceMinor.

Example: DKK

tiered

boolean · required

True for tiered models — the card prefixes the price with a "from" marker.

PublicPortalPricingTier[] · required

Tier ladder for tiered models, resolved for the currency (minor units). Empty for flat_rate products.

billingInterval

string | null · required

Recurring interval (e.g. 'month'); null for one-time charges.

Example: month

billingIntervalCount

number | null · required

Interval count (e.g. 1, 3, 12); null for one-time charges.

Example: 1

PublicPortalPlanItemVat

resolved

boolean · required

Whether VAT resolved for the supplied buyer hints. false = every gross field below is null.

grossPriceMinor

number | null · required

Gross headline price (minor units) for the active cadence; null when unresolved.

Example: 12375

object · required

Gross per cadence, mirroring cadencePrices. Empty object when unresolved.

Example: {"month-1":12375,"year-1":123750}

grossOneTimeMinor

number | null · required

Gross one-time charges total (minor units), mirroring oneTimeMinor; null when unresolved.

PublicPortalPlanItem

id

string · required

itemType

string · enum · required

Card kind: 'SUBSCRIPTION' (priced card, CTA starts checkout) or 'CUSTOM_CTA' (subscription-less card whose CTA navigates ctaLink).

Enum values:

SUBSCRIPTION

CUSTOM_CTA

sourceSubscriptionId

string | null · required

Source subscription id (the chosen template, sent back on signup); null for CUSTOM_CTA items.

ctaLink

string | null · required

Link the CTA navigates to (https / relative / mailto: / tel:); non-null only for CUSTOM_CTA items.

ctaPresetKey

string | null · required

CTA preset ('contactUs' | 'bookDemo' | 'scheduleTime'); null for subscription cards or unmatched labels.

displayOrder

number · required

planName

string · required

Plan name (operator-edited title, language-resolved, falling back to the snapshot name).

description

string | null · required

Short pitch (language-resolved).

array · required

Bullet list; each entry is a plain string or a { label, iconKey } object, already resolved per language.

isMostPopular

boolean · required

Whether to render the "recommended" treatment.

ctaLabel

string | null · required

CTA copy; null falls back to the SPA default getStarted label.

titleColor

string | null · required

Optional inline title color override (any CSS color).

ctaColor

string | null · required

Optional inline CTA color override (any CSS color).

planIconKey

string | null · required

Operator-picked glyph key for the plan-card header icon.

planIconColor

string | null · required

Optional inline override for the plan-card header icon color.

hidePlanIcon

boolean · required

When true, the card renders without the header icon.

featureIconColor

string | null · required

Optional inline override for every feature-bullet icon color.

currency

string · required

Currency code for priceMinor / oneTimeMinor.

Example: DKK

availableCurrencies

string[] · required

Currencies 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 '').

Example: ["DKK","EUR"]

priceMinor

number | null · required

Headline price in minor units; null when no canonical recurring price exists.

Example: 9900

cadenceKey

string | null · required

Cadence key driving priceMinor (e.g. 'month-1'); null when priceMinor is null.

Example: month-1

allowedCadences

string[] · required

Cadences this item supports (drives the row-level cadence selector); empty when none is recoverable.

Example: ["month-1","year-1"]

defaultCadence

string | null · required

Cadence selected on first render; null when no cadence is recoverable for this item.

Example: month-1

object · required

Price in minor units keyed by cadence; a present key with a null value is allowed-but-unpriced (renders as em-dash).

Example: {"month-1":9900,"year-1":99000}

oneTimeMinor

number | null · required

One-time charges total in minor units (setup fees); null = no one-time line.

array | null · required

Products bundled in this tier (ACTIVE cadence). null for CUSTOM_CTA items; [] for a subscription tier with no products.

object · required

Product composition resolved per cadence, keyed by cadence; {} for CUSTOM_CTA items.

object · required

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.

PublicPortalComparisonCell

kind

string · enum · required

Cell kind.

Enum values:

empty

check

cross

text

value

string

Cell text; present only when kind is 'text'.

PublicPortalComparisonRow

label

string · required

Operator-authored row label (language-resolved).

object · required

Per-item presence keyed by plan item id.

PublicPortalComparisonSection

title

string · required

Operator-authored section heading (language-resolved).

PublicPortalComparisonRow[] · required

PublicPortalComparison

PublicPortalComparisonSection[] · required

PublicPortalPlan

id

string · required

planVersionId

string · required

Published portal_plan_version id — the version pinned for checkout when the buyer clicked "Get started".

vanity

string | null · required

Public vanity slug (the /embed/ key); non-null only for PUBLIC plans, null for gated plans.

title

string | null · required

Customer-facing title, language-resolved (en → da fallback); null when the operator entered none.

description

string | null · required

Operator-authored summary, same language fallback as title.

cardStyle

string | null · enum · required

Card style; null falls back to variant1 client-side.

Enum values:

variant1

variant2

displayedCadences

array | null · required

Plan-level cadence allow-list driving the row selector; null/empty falls back to the union of item cadences.

Example: ["month-1","year-1"]

defaultDisplayedCadence

string | null · required

Pinned default for the row cadence selector; must be a member of displayedCadences. Null falls back to the first entry.

PublicPortalPlanItem[] · required

comparison

object | null · required

Operator-authored comparison matrix (columns are plan.items); null when none authored.

PublicPortalCatalogEntry

PublicPortalPlan · required

displayOrder

number · required

Operator-controlled ordering inside the catalogue. Lower first.

isLegacyForVisitor

boolean · required

True when the visitor holds an active subscription to this plan AND the plan is archived. Returned as false in v1.

checkoutable

boolean · required

Whether 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

activePlansConsidered

number · required

ACTIVE plans the resolve considered (before any gate).

tenantHasNoVisibilityRules

boolean · required

True 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.

droppedByVisibility

number · required

Plans dropped because no rule made them visible to this buyer.

droppedByCheckoutable

number · required

Plans dropped because their terms do not currently resolve (not checkout-able).

PublicResolvePortalPlansResponse

PublicPortalCatalogEntry[] · required

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.

catalogToken

string · required

Opaque, 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).

Example: Yk3pQ9sV2nR7tW1xZ4cB8mL6dF0aH5jE2gN9uK3pQ7s

expiresAt

string · required

ISO-8601 expiry of the catalog token.

Example: 2026-06-06T12:34:56.000Z

object · required

Why plans were (or were not) returned — the "why is my catalogue empty" answer.

PublicPortalPlansListResponse

PublicPortalCatalogEntry[] · required

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

object · required

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

object[] · required

The published public JWK(s). Public key material only — never any private component.

Example: [{"kty":"RSA","use":"sig","alg":"RS256","kid":"abc123","n":"…","e":"AQAB"}]

PublicHandoffMembership

customerId

string · required

The 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.

Example: 550e8400-e29b-41d4-a716-446655440010

role

string · required

Role to grant within that organization. One of OWNER, ADMIN, BILLING_ADMIN, USER. Unknown roles are rejected.

Example: OWNER

primary

boolean

Marks 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.

Example: true

PublicHandoffMintRequest

email

string · required

Email of the partner-provisioned user. Links a first-time SSO login to an existing invited customer-portal user.

Example: jane.doe@partner-customer.com

sub

string · required

The partner's stable, unique identifier for the user. Keyed together with the per-tenant handoff issuer to resolve the portal user across logins.

Example: partner-user-7f3a9c21

PublicHandoffMembership[] · required

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.

Example: [{"customerId":"550e8400-e29b-41d4-a716-446655440010","role":"OWNER"}]

name

string

Display name of the user; used to populate the customer-portal user's name on first login.

Example: Jane Doe

PublicHandoffMintResponse

ref

string · required

Opaque, 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.

Example: Yk3pQ9sV2nR7tW1xZ4cB8mL6dF0aH5jE2gN9uK3pQ7s

expiresAt

string · required

ISO-8601 timestamp after which the reference can no longer be redeemed (60 seconds after minting).

Example: 2026-06-03T12:34:56.000Z

PublicRevokeSessionsRequest

sub

string · required

The 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.

Example: partner-user-7f3a9c21

PublicRevokeSessionsResponse

revoked

number · required

Number of memberships whose sessions were force-refreshed (0 when the user has no active sessions).

Example: 2

VatCodeResponse

id

string · required

The unique identifier of the VAT code

Example: 550e8400-e29b-41d4-a716-446655440000

vatCode

string · required

VAT code identifier

Example: VAT25

name

string · required

Name/description of the VAT code

Example: 25% Standard VAT

vatRate

number · required

VAT rate percentage

Example: 25

type

string · required

VAT type

Example: Output/sales

principle

string · required

VAT principle - Gross (VAT included) or Net (VAT excluded)

Example: gross

accountToBookId

string

The ledger account ID to book VAT to

Example: 550e8400-e29b-41d4-a716-446655440001

accountToBookNumber

number

The ledger account number to book VAT to

Example: 6910

accountToBookName

string

The ledger account name to book VAT to

Example: Output VAT

contraAccountToBookId

string

The contra account ID for VAT entries

Example: 550e8400-e29b-41d4-a716-446655440002

contraAccountToBookNumber

number

The contra account number for VAT entries

Example: 6920

contraAccountToBookName

string

The contra account name for VAT entries

Example: Input VAT

VendorGroupResponse

id

string · required

The unique identifier of the vendor group

Example: 550e8400-e29b-41d4-a716-446655440000

name

string · required

Name of the vendor group

Example: Domestic Vendors

description

string

Description of the vendor group

Example: All domestic vendor accounts

defaultAccountId

string

Default ledger account ID

Example: 550e8400-e29b-41d4-a716-446655440001

VendorDepartmentResponse

id

string · required

The unique identifier of the department

Example: 550e8400-e29b-41d4-a716-446655440000

name

string · required

Name of the department

Example: Headquarters

isDefault

boolean · required

Whether this is the default department for the vendor

Example: true

isActive

boolean · required

Whether the department is active

Example: true

poNumber

string

Purchase order number

Example: PO-12345

eanNumber

string

EAN number for e-invoicing

Example: 5790000000000

address

string

Street address

Example: 123 Main Street

city

string

City

Example: Copenhagen

postalCode

string

Postal code

Example: 2100

countryCode

string

Two-letter country code (ISO 3166-1 alpha-2)

Example: DK

VendorContactResponse

id

string · required

The unique identifier of the contact

Example: 550e8400-e29b-41d4-a716-446655440000

name

string · required

Name of the contact

Example: John Doe

isDefaultForVendor

boolean · required

Whether this is the default contact for the vendor

Example: true

email

string

Email address

Example: john.doe@acme-supplies.com

phone

string

Phone number

Example: +45 12345678

VendorResponse

id

string · required

The unique identifier of the vendor

Example: 550e8400-e29b-41d4-a716-446655440000

vendorNumber

string · required

Vendor number

Example: V001

name

string · required

Name of the vendor

Example: Acme Supplies

vendorGroupId

string · required

Vendor group ID

Example: 550e8400-e29b-41d4-a716-446655440001

currency

string · required

Currency code

Example: DKK

status

string · enum · required

Vendor status

Enum values:

active

inactive

archived

Example: active

vendorGroupName

string

Vendor group name

Example: Domestic Vendors

email

string

Email address

Example: contact@acme-supplies.com

phone

string

Phone number

Example: +45 12345678

address

string

Street address

Example: 123 Main Street

city

string

City

Example: Copenhagen

postalCode

string

Postal code

Example: 2100

countryCode

string

Two-letter country code (ISO 3166-1 alpha-2)

Example: DK

vatNumber

string

VAT registration number

Example: DK12345678

attention

string

Attention field

Example: Accounts Payable

paymentTerms

number

Payment terms in days

Example: 30

openingBalance

number

Opening balance in the company base currency (signed: positive = we owe the vendor)

Example: 1000

CreateVendorContactRequest

name

string · required

Contact name

Example: John Doe

isDefault

boolean · required

Whether this is the default contact for the vendor

Example: true

email

string

Email address

Example: john.doe@acme-supplies.com

phone

string

Phone number

Example: +45 12345678

CreateVendorRequest

vendorNumber

string · required

Unique vendor number

Example: V001

name

string · required

Vendor name

Example: Acme Supplies

vendorGroupId

string · required

Vendor group ID

Example: 550e8400-e29b-41d4-a716-446655440001

currency

string · pattern: ^[A-Za-z]{3}$ · required

The currency this vendor bills us in, ISO 4217 alpha-3.

Example: DKK

countryCode

string · required

Two-letter country code

Example: DK

CreateVendorContactRequest[] · minItems: 1 · maxItems: 50 · required

Contacts for the vendor. At least one contact with isDefault: true is required.

email

string

Email address

Example: contact@acme-supplies.com

phone

string

Phone number

Example: +45 12345678

address

string · maxLength: 255

Street address

Example: 123 Main Street

city

string

City

Example: Copenhagen

postalCode

string

Postal code

Example: 2100

vatNumber

string

VAT registration number

Example: DK12345678

attention

string

Attention field

Example: Accounts Payable

paymentTerms

number · min: 0

Payment terms in days

Example: 30

openingBalance

number

Opening balance in the company base currency, seeding payables that predate LedgerBee. Signed: positive = we owe the vendor, negative = a credit position.

Example: 1000

defaultAccountId

string

Default ledger account ID

Example: 550e8400-e29b-41d4-a716-446655440002

CreateVendorResponse

id

string · required

The unique identifier of the created vendor

Example: 550e8400-e29b-41d4-a716-446655440000

vendorNumber

string · required

Vendor number

Example: V001

SupplierGroupResponse

id

string · required

The unique identifier of the supplier group

Example: 550e8400-e29b-41d4-a716-446655440000

name

string · required

Name of the supplier group

Example: Domestic Suppliers

description

string

Description of the supplier group

Example: All domestic supplier accounts

defaultAccountId

string

Default ledger account ID

Example: 550e8400-e29b-41d4-a716-446655440001

SupplierDepartmentResponse

id

string · required

The unique identifier of the department

Example: 550e8400-e29b-41d4-a716-446655440000

name

string · required

Name of the department

Example: Headquarters

isDefault

boolean · required

Whether this is the default department for the supplier

Example: true

isActive

boolean · required

Whether the department is active

Example: true

poNumber

string

Purchase order number

Example: PO-12345

eanNumber

string

EAN number for e-invoicing

Example: 5790000000000

address

string

Street address

Example: 123 Main Street

city

string

City

Example: Copenhagen

postalCode

string

Postal code

Example: 2100

countryCode

string

Two-letter country code (ISO 3166-1 alpha-2)

Example: DK

SupplierContactResponse

id

string · required

The unique identifier of the contact

Example: 550e8400-e29b-41d4-a716-446655440000

name

string · required

Name of the contact

Example: John Doe

isDefaultForSupplier

boolean · required

Whether this is the default contact for the supplier

Example: true

email

string

Email address

Example: john.doe@acme-supplies.com

phone

string

Phone number

Example: +45 12345678

SupplierResponse

id

string · required

The unique identifier of the supplier

Example: 550e8400-e29b-41d4-a716-446655440000

supplierNumber

string · required

Supplier number

Example: V001

name

string · required

Name of the supplier

Example: Acme Supplies

supplierGroupId

string · required

Supplier group ID

Example: 550e8400-e29b-41d4-a716-446655440001

currency

string · required

Currency code

Example: DKK

status

string · enum · required

Supplier status

Enum values:

active

inactive

archived

Example: active

supplierGroupName

string

Supplier group name

Example: Domestic Suppliers

email

string

Email address

Example: contact@acme-supplies.com

phone

string

Phone number

Example: +45 12345678

address

string

Street address

Example: 123 Main Street

city

string

City

Example: Copenhagen

postalCode

string

Postal code

Example: 2100

countryCode

string

Two-letter country code (ISO 3166-1 alpha-2)

Example: DK

vatNumber

string

VAT registration number

Example: DK12345678

attention

string

Attention field

Example: Accounts Payable

paymentTerms

number

Payment terms in days

Example: 30

openingBalance

number

Opening balance in the company base currency (signed: positive = we owe the supplier)

Example: 1000

CreateSupplierContactRequest

name

string · required

Contact name

Example: John Doe

isDefault

boolean · required

Whether this is the default contact for the supplier

Example: true

email

string

Email address

Example: john.doe@acme-supplies.com

phone

string

Phone number

Example: +45 12345678

CreateSupplierRequest

supplierNumber

string · required

Unique supplier number

Example: V001

name

string · required

Supplier name

Example: Acme Supplies

supplierGroupId

string · required

Supplier group ID

Example: 550e8400-e29b-41d4-a716-446655440001

currency

string · pattern: ^[A-Za-z]{3}$ · required

The currency this supplier bills us in, ISO 4217 alpha-3.

Example: DKK

countryCode

string · required

Two-letter country code

Example: DK

CreateSupplierContactRequest[] · minItems: 1 · maxItems: 50 · required

Contacts for the supplier. At least one contact with isDefault: true is required.

email

string

Email address

Example: contact@acme-supplies.com

phone

string

Phone number

Example: +45 12345678

address

string · maxLength: 255

Street address

Example: 123 Main Street

city

string

City

Example: Copenhagen

postalCode

string

Postal code

Example: 2100

vatNumber

string

VAT registration number

Example: DK12345678

attention

string

Attention field

Example: Accounts Payable

paymentTerms

number · min: 0

Payment terms in days

Example: 30

openingBalance

number

Opening balance in the company base currency, seeding payables that predate LedgerBee. Signed: positive = we owe the supplier, negative = a credit position.

Example: 1000

defaultAccountId

string

Default ledger account ID

Example: 550e8400-e29b-41d4-a716-446655440002

CreateSupplierResponse

id

string · required

The unique identifier of the created supplier

Example: 550e8400-e29b-41d4-a716-446655440000

supplierNumber

string · required

Supplier number

Example: V001

CreateWebhookEndpointRequest

url

string · required

The HTTPS URL events are delivered to. Must be a public https URL (loopback/private/link-local hosts are rejected).

Example: https://example.com/webhooks/ledgerbee

enabledEvents

string[] · required

The 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.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.
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).

Enum values:

subscription.assigned

subscription.started

subscription.updated

subscription.transitioned

subscription.paused

subscription.resumed

subscription.trial_ended

subscription.cancellation_scheduled

Example: ["subscription.assigned"]

description

string · maxLength: 512

Optional human-facing description.

Example: Production billing sync

WebhookEndpointWithSecret

id

string · required

Unique identifier of the webhook endpoint.

Example: 0192f3a1-...

url

string · required

The HTTPS URL events are delivered to.

Example: https://example.com/webhooks/ledgerbee

enabledEvents

string[] · required

The 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.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.
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).

Enum values:

subscription.assigned

subscription.started

subscription.updated

subscription.transitioned

subscription.paused

subscription.resumed

subscription.trial_ended

subscription.cancellation_scheduled

Example: ["subscription.assigned"]

status

string · enum · required

Delivery status. disabled endpoints are retained but receive no events.

Enum values:

enabled

disabled

Example: enabled

createdAt

string · required

ISO 8601 creation timestamp.

Example: 2026-05-29T10:00:00.000Z

updatedAt

string · required

ISO 8601 last-update timestamp.

Example: 2026-05-29T10:00:00.000Z

secret

string · required

The signing secret (shown only on create and roll-secret). Used to verify the webhook-signature header.

Example: whsec_...

description

string | null

Optional human-facing description of what this endpoint is used for.

Example: Production billing sync

WebhookEndpoint

id

string · required

Unique identifier of the webhook endpoint.

Example: 0192f3a1-...

url

string · required

The HTTPS URL events are delivered to.

Example: https://example.com/webhooks/ledgerbee

enabledEvents

string[] · required

The 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.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.
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).

Enum values:

subscription.assigned

subscription.started

subscription.updated

subscription.transitioned

subscription.paused

subscription.resumed

subscription.trial_ended

subscription.cancellation_scheduled

Example: ["subscription.assigned"]

status

string · enum · required

Delivery status. disabled endpoints are retained but receive no events.

Enum values:

enabled

disabled

Example: enabled

createdAt

string · required

ISO 8601 creation timestamp.

Example: 2026-05-29T10:00:00.000Z

updatedAt

string · required

ISO 8601 last-update timestamp.

Example: 2026-05-29T10:00:00.000Z

description

string | null

Optional human-facing description of what this endpoint is used for.

Example: Production billing sync

WebhookEndpointList

WebhookEndpoint[] · required

total

number · required

Total number of endpoints matching the query.

Example: 3

page

number · required

Current page (1-based).

Example: 1

pageSize

number · required

Page size.

Example: 25

UpdateWebhookEndpointRequest

url

string

New HTTPS delivery URL.

Example: https://example.com/webhooks/v2

enabledEvents

string[]

Replace 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.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.
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).

Enum values:

subscription.assigned

subscription.started

subscription.updated

subscription.transitioned

subscription.paused

subscription.resumed

subscription.trial_ended

subscription.cancellation_scheduled

Example: ["subscription.assigned"]

status

string · enum

Enable or disable delivery without deleting the endpoint.

Enum values:

enabled

disabled

description

string | null · maxLength: 512

Update the description. Send null to clear it.

Example: Updated description

TestWebhookEndpointRequest

event

string · enum · required

The 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.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.
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).

Enum values:

subscription.assigned

subscription.started

subscription.updated

subscription.transitioned

subscription.paused

subscription.resumed

subscription.trial_ended

subscription.cancellation_scheduled

Example: subscription.assigned

TestWebhookEndpointResult

success

boolean · required

Whether the endpoint responded with a 2xx status.

Example: true

durationMs

number · required

Round-trip time of the probe in milliseconds.

Example: 142

statusCode

number | null

HTTP status returned by the endpoint, or null on a transport error.

Example: 200

error

string | null

Transport/error message when the probe failed, otherwise null.

Example: null

PublicCreateInvoiceLine

priceId

string

Product price ID. Required on a billable line — the line bills this product. Omit only for text / separator / discount lines (set lineType instead).

Example: 0197A943-2325-7829-B835-B6C71A293065

lineType

string · enum

Semantic type of the line (subscription, usage, discount, text, separator, etc.)

Enum values:

subscription

usage

proration_initial

proration_post_trial

proration_credit

proration_charge

proration_adjustment

proration_phase_transition

description

string

Custom description for this line item

Example: Premium widget - Blue color

quantity

number

Quantity. Required on a billable line; omit for text / separator / discount lines.

Example: 2

unitPrice

string

One-time unit-price override (decimal string). Defaults to the price's current amount in the document currency when omitted. totalPrice (= quantity * unitPrice) and VAT are always computed server-side and must not be sent.

Example: 1083.32

recognitionPeriodDays

number

Override the revenue recognition period for this line (in days)

Example: 365

PublicCreateInvoice

customerId

string · required

Customer ID this invoice is for. Required — every invoice must reference a customer (this mirrors the gated app, which also requires a customer).

Example: 0197A943-2325-7829-B835-B6C71A293065

date

string · required

Invoice date (ISO date, YYYY-MM-DD)

Example: 2024-01-15

PublicCreateInvoiceLine[] · required

Invoice lines

customerDepartmentId

string

Customer department ID (for EAN-based e-invoicing and address override)

Example: 0197A943-2325-7829-B835-B6C71A293065

customerContactId

string

Customer contact ID (invoice recipient)

Example: 0197A943-2325-7829-B835-B6C71A293065

dueDate

string

Due date for payment (ISO date). Derived from payment terms when omitted.

Example: 2024-02-15

currency

string · minLength: 3 · maxLength: 3

Currency code (ISO 4217). Defaults to the company default currency.

Example: DKK

paymentTerms

number

Payment terms in days

Example: 30

reference

string

Reference / PO number ("PO-nr.")

Example: PO-12345

ourReference

string

Our reference ("Vores ref.")

Example: Jane Doe

description

string

Optional description of the invoice

Example: Monthly service invoice

notes

string

Additional notes or comments

Example: Thank you for your business!

PublicInvoiceLine

id

string · required

Line item ID

Example: 0197A943-2325-7829-B835-B6C71A293065

quantity

number · required

Quantity

Example: 2

unitPrice

string · required

Unit price (decimal string)

Example: 1083.32

totalPrice

string · required

Total price (decimal string)

Example: 2166.65

priceId

string | null

Price ID this line references

description

string | null

Custom description for this line item

lineType

string | null · enum

Semantic line type

Enum values:

subscription

usage

proration_initial

proration_post_trial

proration_credit

proration_charge

proration_adjustment

proration_phase_transition

vatAmount

string | null

VAT amount (decimal string)

vatRate

string | null

VAT rate percentage (decimal string)

PublicInvoice

id

string · required

Invoice ID

Example: 0197A943-2325-7829-B835-B6C71A293065

status

string · enum · required

Invoice status

Enum values:

draft

scheduled

sending

sent

paid

partially_paid

cancelled

uncollectible

Example: sent

date

string · required

Invoice date (ISO date)

Example: 2024-01-15

isConsolidated

boolean · required

True 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.

Example: false

currency

string · required

Currency code (ISO 4217)

Example: DKK

subtotal

string · required

Subtotal before VAT (decimal string)

Example: 2166.65

vat

string · required

VAT amount (decimal string)

Example: 541.66

amount

string · required

Total amount including VAT (decimal string)

Example: 2708.31

PublicInvoiceLine[] · required

Invoice lines

createdAt

string · required

Creation timestamp (ISO)

Example: 2024-01-15T10:30:00.000Z

updatedAt

string · required

Last update timestamp (ISO)

Example: 2024-01-15T10:30:00.000Z

number

string | null

Invoice number. Null while the invoice is still a draft (allocated at booking).

dueDate

string | null

Due date (ISO date)

customerId

string | null

Customer ID

customerSubscriptionId

string | null

The subscription this invoice bills, when it bills exactly one. Null on a billing group’s shared invoice (see billingGroupId), on a parent-paid consolidated invoice (see isConsolidated) and on a manually created invoice.

Example: 0197A943-2325-7829-B835-B6C71A293065

billingGroupId

string | null

The 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.

Example: 0197A943-2325-7829-B835-B6C71A293065

reference

string | null

Reference / PO number

ourReference

string | null

Our reference ("Vores ref.")

notes

string | null

Additional notes

PublicInvoiceListItem

id

string · required

Invoice ID

Example: 0197A943-2325-7829-B835-B6C71A293065

status

string · enum · required

Invoice status

Enum values:

draft

scheduled

sending

sent

paid

partially_paid

cancelled

uncollectible

Example: sent

date

string · required

Invoice date (ISO date)

Example: 2024-01-15

isConsolidated

boolean · required

Example: false

currency

string · required

Currency code (ISO 4217)

Example: DKK

subtotal

string · required

Subtotal before VAT (decimal string)

Example: 2166.65

vat

string · required

VAT amount (decimal string)

Example: 541.66

amount

string · required

Total amount including VAT (decimal string)

Example: 2708.31

createdAt

string · required

Creation timestamp (ISO)

Example: 2024-01-15T10:30:00.000Z

updatedAt

string · required

Last update timestamp (ISO)

Example: 2024-01-15T10:30:00.000Z

number

string | null

Invoice number. Null while the invoice is still a draft (allocated at booking).

dueDate

string | null

Due date (ISO date)

customerId

string | null

Customer ID

customerSubscriptionId

string | null

Example: 0197A943-2325-7829-B835-B6C71A293065

billingGroupId

string | null

Example: 0197A943-2325-7829-B835-B6C71A293065

reference

string | null

Reference / PO number

ourReference

string | null

Our reference ("Vores ref.")

notes

string | null

Additional notes

PublicListInvoicesResponse

PublicInvoiceListItem[] · required

Invoices on this page (line items omitted; GET one invoice for lines)

total

number · required

Total invoices matching the query

Example: 42

page

number · required

Current page (1-indexed)

Example: 1

limit

number · required

Items per page

Example: 25

totalPages

number · required

Total pages

Example: 2

PublicSendInvoice

deliveryType

string · enum · required

Delivery channel

Enum values:

Sproom

Manual

Leverandorservice

Example: Email

overrideEmail

string

Override recipient email for this send only

overrideEanNumber

string

Override EAN number for this send only

updateCustomerRecord

boolean

Persist the override email / EAN onto the customer record

Default: false

documentTemplateId

string

Override document template for PDF generation

PublicSendInvoiceResponse

success

boolean · required

Whether the send was accepted

Example: true

deliveryType

string · enum · required

The delivery channel the document was sent through

Enum values:

Sproom

Manual

Leverandorservice

Example: Email

sproomDocumentId

string | null

Sproom document ID when sent via e-invoicing

PublicDeliveryStatusSummary

sendCount

number · required

Number of send attempts recorded

Example: 2

lastDeliveryType

string | null · enum

Channel of the most recent send

Enum values:

Sproom

Manual

Leverandorservice

lastRecipientEmail

string | null

Recipient email of the most recent send

lastRecipientEan

string | null

Recipient EAN of the most recent send

lastSentAt

string | null

Timestamp of the most recent send (ISO)

PublicDeliveryLogEntry

id

string · required

Delivery log entry ID

status

string · enum · required

Outcome of the delivery attempt

Enum values:

success

failed

deliveryType

string · enum · required

Delivery channel

Enum values:

Sproom

Manual

Leverandorservice

sentAt

string · required

Timestamp of the attempt (ISO)

Example: 2024-01-15T10:30:00.000Z

recipientEmail

string | null

Recipient email (email sends)

recipientEan

string | null

Recipient EAN (e-invoice sends)

errorCode

string | null

Error code when the attempt failed

PublicDeliveryStatusResponse

object · required

Aggregate send summary

PublicDeliveryLogEntry[] · required

Per-attempt delivery log entries

PublicCreateCreditNoteLine

priceId

string

Product price ID. Required on a billable line — the line credits this product. Omit only for text / separator / discount lines (set lineType instead).

Example: 0197A943-2325-7829-B835-B6C71A293065

lineType

string · enum

Semantic type of the line (refund, cancellation credit, text, separator, etc.)

Enum values:

subscription

usage

proration_initial

proration_post_trial

proration_credit

proration_charge

proration_adjustment

proration_phase_transition

description

string

Custom description for this line item

Example: Premium widget - Blue color - Return

quantity

number

Quantity to credit. Required on a billable line; omit for text / separator / discount lines.

Example: 2

unitPrice

string

One-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.

Example: 1083.32

PublicCreateCreditNote

customerId

string · required

Customer ID this credit note is for

Example: 0197A943-2325-7829-B835-B6C71A293065

date

string · required

Credit note date (ISO date, YYYY-MM-DD)

Example: 2024-01-15

PublicCreateCreditNoteLine[] · required

Credit note lines

customerDepartmentId

string

Customer department ID (for EAN-based e-invoicing and address override)

Example: 0197A943-2325-7829-B835-B6C71A293065

customerContactId

string

Customer contact ID (credit note recipient)

Example: 0197A943-2325-7829-B835-B6C71A293065

invoiceNumber

string

Original invoice number this credit note credits. When set, the referenced invoice is marked credited.

Example: 1

currency

string · minLength: 3 · maxLength: 3

Currency code (ISO 4217). Defaults to the company default currency.

Example: DKK

reference

string

Reference / PO number ("PO-nr.")

Example: PO-12345

ourReference

string

Our reference ("Vores ref.")

Example: Jane Doe

description

string

Optional description of the credit note

Example: Credit for returned items

notes

string

Additional notes or comments

Example: Credit issued due to product defect

PublicCreditNoteLine

id

string · required

Line item ID

Example: 0197A943-2325-7829-B835-B6C71A293065

quantity

number · required

Quantity

Example: 2

unitPrice

string · required

Unit price (decimal string)

Example: 1083.32

totalPrice

string · required

Total price (decimal string)

Example: 2166.65

priceId

string | null

Price ID this line references

description

string | null

Custom description for this line item

lineType

string | null · enum

Semantic line type

Enum values:

subscription

usage

proration_initial

proration_post_trial

proration_credit

proration_charge

proration_adjustment

proration_phase_transition

vatAmount

string | null

VAT amount (decimal string)

vatRate

string | null

VAT rate percentage (decimal string)

PublicCreditNote

id

string · required

Credit note ID

Example: 0197A943-2325-7829-B835-B6C71A293065

number

string · required

Credit note number

Example: 1

status

string · enum · required

Credit note status

Enum values:

draft

scheduled

sending

sent

Example: sent

date

string · required

Credit note date (ISO date)

Example: 2024-01-15

currency

string · required

Currency code (ISO 4217)

Example: DKK

subtotal

string · required

Subtotal before VAT (decimal string)

Example: 2166.65

vat

string · required

VAT amount (decimal string)

Example: 541.66

amount

string · required

Total amount including VAT (decimal string)

Example: 2708.31

PublicCreditNoteLine[] · required

Credit note lines

createdAt

string · required

Creation timestamp (ISO)

Example: 2024-01-15T10:30:00.000Z

updatedAt

string · required

Last update timestamp (ISO)

Example: 2024-01-15T10:30:00.000Z

invoiceNumber

string | null

Original invoice number this credit note credits

customerId

string | null

Customer ID

customerSubscriptionId

string | null

The 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.

Example: 0197A943-2325-7829-B835-B6C71A293065

billingGroupId

string | null

The billing group this credit note is issued to, when it credits a group’s shared invoice. Set instead of customerSubscriptionId, never alongside it.

Example: 0197A943-2325-7829-B835-B6C71A293065

reference

string | null

Reference / PO number

ourReference

string | null

Our reference ("Vores ref.")

notes

string | null

Additional notes

PublicCreditNoteListItem

id

string · required

Credit note ID

Example: 0197A943-2325-7829-B835-B6C71A293065

number

string · required

Credit note number

Example: 1

status

string · enum · required

Credit note status

Enum values:

draft

scheduled

sending

sent

Example: sent

date

string · required

Credit note date (ISO date)

Example: 2024-01-15

currency

string · required

Currency code (ISO 4217)

Example: DKK

subtotal

string · required

Subtotal before VAT (decimal string)

Example: 2166.65

vat

string · required

VAT amount (decimal string)

Example: 541.66

amount

string · required

Total amount including VAT (decimal string)

Example: 2708.31

createdAt

string · required

Creation timestamp (ISO)

Example: 2024-01-15T10:30:00.000Z

updatedAt

string · required

Last update timestamp (ISO)

Example: 2024-01-15T10:30:00.000Z

invoiceNumber

string | null

Original invoice number this credit note credits

customerId

string | null

Customer ID

customerSubscriptionId

string | null

The 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.

Example: 0197A943-2325-7829-B835-B6C71A293065

billingGroupId

string | null

The billing group this credit note is issued to, when it credits a group’s shared invoice. Set instead of customerSubscriptionId, never alongside it.

Example: 0197A943-2325-7829-B835-B6C71A293065

reference

string | null

Reference / PO number

ourReference

string | null

Our reference ("Vores ref.")

notes

string | null

Additional notes

PublicListCreditNotesResponse

PublicCreditNoteListItem[] · required

Credit notes on this page (line items omitted; GET one for lines)

total

number · required

Total credit notes matching the query

Example: 42

page

number · required

Current page (1-indexed)

Example: 1

limit

number · required

Items per page

Example: 25

totalPages

number · required

Total pages

Example: 2

PublicSendCreditNote

deliveryType

string · enum · required

Delivery channel

Enum values:

Sproom

Manual

Leverandorservice

Example: Email

overrideEmail

string

Override recipient email for this send only

overrideEanNumber

string

Override EAN number for this send only

updateCustomerRecord

boolean

Persist the override email / EAN onto the customer record

Default: false

documentTemplateId

string

Override document template for PDF generation

PublicQuoteListItem

id

string · required

Quote identifier

type

string · enum · required

Always "quote"

Enum values:

quote

orderConfirmation

status

object · required

Stored lifecycle status (draft/sent/accepted/rejected)

displayStatus

object · required

Status to display. Equals status except derived states: "converted" or "expired".

date

string · required

Quote date (ISO, YYYY-MM-DD)

Example: 2026-06-11

amount

string · required

Total amount including VAT

subtotal

string · required

Subtotal excluding VAT

vat

string · required

Total VAT

currency

string · required

Currency code

Example: DKK

createdAt

string · required

Created timestamp (ISO)

updatedAt

string · required

Updated timestamp (ISO)

documentNumber

string

Allocated quote number (null until sent)

validUntil

string

Valid-until date (ISO, YYYY-MM-DD)

Example: 2026-07-11

reference

string

PO number ("PO-nr.")

ourReference

string

Our reference ("Vores ref.")

notes

string

Notes

customerId

string

Customer id

sourceDocumentId

string

Source document id (set when this quote originated from another document)

convertedToDocumentId

string

Id of the order confirmation this quote was converted into

convertedToInvoiceId

string

Id of the invoice this quote was converted into

sentAt

string

Timestamp the quote was sent (ISO)

PublicListQuotesResponse

PublicQuoteListItem[] · required

List of quotes (line items omitted; GET one quote for lines)

total

number · required

Total number of quotes matching the query

Example: 42

page

number · required

Current page number (1-indexed)

Example: 1

limit

number · required

Maximum number of items per page

Example: 25

totalPages

number · required

Total number of pages available

Example: 2

PublicQuoteLine

id

string · required

Line identifier

quantity

number · required

Quantity

Example: 2

unitPrice

string · required

Unit price

Example: 1000.00

totalPrice

string · required

Total price for the line

Example: 2000.00

description

string

Line description shown on the quote

lineType

string

Semantic line type

vatRate

string

VAT rate (percentage)

Example: 25

vatAmount

string

VAT amount for the line

PublicQuote

id

string · required

Quote identifier

type

string · enum · required

Always "quote"

Enum values:

quote

orderConfirmation

status

object · required

Stored lifecycle status (draft/sent/accepted/rejected)

displayStatus

object · required

Status to display. Equals status except derived states: "converted" or "expired".

date

string · required

Quote date (ISO, YYYY-MM-DD)

Example: 2026-06-11

amount

string · required

Total amount including VAT

subtotal

string · required

Subtotal excluding VAT

vat

string · required

Total VAT

currency

string · required

Currency code

Example: DKK

createdAt

string · required

Created timestamp (ISO)

updatedAt

string · required

Updated timestamp (ISO)

PublicQuoteLine[] · required

documentNumber

string

Allocated quote number (null until sent)

validUntil

string

Valid-until date (ISO, YYYY-MM-DD)

Example: 2026-07-11

reference

string

PO number ("PO-nr.")

ourReference

string

Our reference ("Vores ref.")

notes

string

Notes

customerId

string

Customer id

sourceDocumentId

string

Source document id (set when this quote originated from another document)

convertedToDocumentId

string

Id of the order confirmation this quote was converted into

convertedToInvoiceId

string

Id of the invoice this quote was converted into

sentAt

string

Timestamp the quote was sent (ISO)

PublicCreateQuoteLine

priceId

string

Product price id. Required on a billable line — the line bills this product. Omit only for text / separator / discount lines (set lineType instead).

description

string

Custom description for the line

lineType

string · enum

Semantic line type. Use text / separator / discount / interval_discount for non-billable lines; any other value marks the line billable (priceId + quantity required).

Enum values:

subscription

usage

proration_initial

proration_post_trial

proration_credit

proration_charge

proration_adjustment

proration_phase_transition

quantity

number

Quantity. Required on a billable line; omit for text / separator / discount lines.

Example: 2

unitPrice

string

One-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.

Example: 1000.00

PublicCreateQuote

customerId

string · required

Customer this quote is for

date

string · required

Quote date (ISO, YYYY-MM-DD)

Example: 2026-06-11

PublicCreateQuoteLine[] · required

customerDepartmentId

string

Customer department id

customerContactId

string

Customer contact id ("Deres ref.")

validUntil

string

Valid-until date (ISO, YYYY-MM-DD)

Example: 2026-07-11

currency

string

Currency code

Example: DKK

reference

string

PO number ("PO-nr.")

ourReference

string

Our reference ("Vores ref.")

notes

string

Notes shown on the quote

PublicSendQuote

deliveryType

string · enum

Delivery method. Defaults to Manual. Sproom/e-invoice does not apply to quotes.

Enum values:

Manual

recipientEmail

string

Override recipient email for Email delivery

PublicConvertQuotePayload

customerId

string · required

Customer for the converted document

date

string · required

Document date (ISO, YYYY-MM-DD)

Example: 2026-06-11

PublicCreateQuoteLine[] · required

customerDepartmentId

string

Customer department id

customerContactId

string

Customer contact id

currency

string

Currency code

reference

string

PO number ("PO-nr.")

ourReference

string

Our reference ("Vores ref.")

notes

string

Notes

PublicConvertQuote

target

string · enum · required

Target to convert into. Use "orderConfirmation" to confirm the quote, or "invoice" to convert it directly into an invoice.

Enum values:

orderConfirmation

invoice

object

Edited target document (review-before-finalize). Omit to copy the source verbatim.

PublicConvertQuoteResult

targetType

string · required

Type of document produced by the conversion ("invoice" or "orderConfirmation")

Example: orderConfirmation

targetId

string · required

Identifier of the produced document

PublicUpdateQuote

customerId

string · required

Customer this quote is for

date

string · required

Quote date (ISO, YYYY-MM-DD)

Example: 2026-06-11

PublicCreateQuoteLine[] · required

customerDepartmentId

string

Customer department id

customerContactId

string

Customer contact id ("Deres ref.")

validUntil

string

Valid-until date (ISO, YYYY-MM-DD)

Example: 2026-07-11

currency

string

Currency code

Example: DKK

reference

string

PO number ("PO-nr.")

ourReference

string

Our reference ("Vores ref.")

notes

string

Notes shown on the quote

PublicOrderConfirmationListItem

id

string · required

Document identifier

status

object · required

Stored lifecycle status (draft/sent)

displayStatus

object · required

Status to display. Equals status except the derived "converted" state.

date

string · required

Document date (ISO, YYYY-MM-DD)

Example: 2026-06-11

amount

string · required

Total amount including VAT

subtotal

string · required

Subtotal excluding VAT

vat

string · required

Total VAT

currency

string · required

Currency code

Example: DKK

createdAt

string · required

Created timestamp (ISO)

updatedAt

string · required

Updated timestamp (ISO)

documentNumber

string

Allocated document number (null until sent)

reference

string

PO number ("PO-nr.")

ourReference

string

Our reference ("Vores ref.")

notes

string

Notes

customerId

string

Customer id

sourceDocumentId

string

Source document id (the quote this order confirmation was converted from)

convertedToInvoiceId

string

Id of the invoice this order confirmation was converted into

sentAt

string

Timestamp the document was sent (ISO)

PublicListOrderConfirmationsResponse

PublicOrderConfirmationListItem[] · required

List of order confirmations (line items omitted; GET one for lines)

total

number · required

Total number of documents matching the query

Example: 42

page

number · required

Current page number (1-indexed)

Example: 1

limit

number · required

Maximum number of items per page

Example: 25

totalPages

number · required

Total number of pages available

Example: 2

PublicOrderConfirmationLine

id

string · required

Line identifier

quantity

number · required

Quantity

Example: 2

unitPrice

string · required

Unit price

Example: 1000.00

totalPrice

string · required

Total price for the line

Example: 2000.00

description

string

Line description shown on the document

lineType

string

Semantic line type

vatRate

string

VAT rate (percentage)

Example: 25

vatAmount

string

VAT amount for the line

PublicOrderConfirmation

id

string · required

Document identifier

status

object · required

Stored lifecycle status (draft/sent)

displayStatus

object · required

Status to display. Equals status except the derived "converted" state.

date

string · required

Document date (ISO, YYYY-MM-DD)

Example: 2026-06-11

amount

string · required

Total amount including VAT

subtotal

string · required

Subtotal excluding VAT

vat

string · required

Total VAT

currency

string · required

Currency code

Example: DKK

createdAt

string · required

Created timestamp (ISO)

updatedAt

string · required

Updated timestamp (ISO)

PublicOrderConfirmationLine[] · required

documentNumber

string

Allocated document number (null until sent)

reference

string

PO number ("PO-nr.")

ourReference

string

Our reference ("Vores ref.")

notes

string

Notes

customerId

string

Customer id

sourceDocumentId

string

Source document id (the quote this order confirmation was converted from)

convertedToInvoiceId

string

Id of the invoice this order confirmation was converted into

sentAt

string

Timestamp the document was sent (ISO)

PublicCreateOrderConfirmationLine

priceId

string

Product price id. Required on a billable line — the line bills this product. Omit only for text / separator / discount lines (set lineType instead).

description

string

Custom description for the line

lineType

string · enum

Semantic line type. Use text / separator / discount / interval_discount for non-billable lines; any other value marks the line billable (priceId + quantity required).

Enum values:

subscription

usage

proration_initial

proration_post_trial

proration_credit

proration_charge

proration_adjustment

proration_phase_transition

quantity

number

Quantity. Required on a billable line; omit for text / separator / discount lines.

Example: 2

unitPrice

string

One-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.

Example: 1000.00

PublicCreateOrderConfirmation

customerId

string · required

Customer this order confirmation is for

date

string · required

Document date (ISO, YYYY-MM-DD)

Example: 2026-06-11

PublicCreateOrderConfirmationLine[] · required

customerDepartmentId

string

Customer department id

customerContactId

string

Customer contact id ("Deres ref.")

currency

string

Currency code

Example: DKK

reference

string

PO number ("PO-nr.")

ourReference

string

Our reference ("Vores ref.")

notes

string

Notes shown on the document

PublicSendOrderConfirmation

deliveryType

string · enum

Delivery method. Defaults to Manual. Sproom/e-invoice does not apply to order confirmations.

Enum values:

Manual

recipientEmail

string

Override recipient email for Email delivery

PublicConvertOrderConfirmationPayload

customerId

string · required

Customer for the converted document

date

string · required

Document date (ISO, YYYY-MM-DD)

Example: 2026-06-11

PublicCreateOrderConfirmationLine[] · required

customerDepartmentId

string

Customer department id

customerContactId

string

Customer contact id

currency

string

Currency code

reference

string

PO number ("PO-nr.")

ourReference

string

Our reference ("Vores ref.")

notes

string

Notes

PublicConvertOrderConfirmation

target

string · enum · required

Target to convert into. An order confirmation only ever converts into an "invoice".

Enum values:

invoice

object

Edited target document (review-before-finalize). Omit to copy the source verbatim.

PublicConvertOrderConfirmationResult

targetType

string · required

Type of document produced by the conversion (always "invoice")

Example: invoice

targetId

string · required

Identifier of the produced document

PublicUpdateOrderConfirmation

customerId

string · required

Customer this order confirmation is for

date

string · required

Document date (ISO, YYYY-MM-DD)

Example: 2026-06-11

PublicCreateOrderConfirmationLine[] · required

customerDepartmentId

string

Customer department id

customerContactId

string

Customer contact id ("Deres ref.")

currency

string

Currency code

Example: DKK

reference

string

PO number ("PO-nr.")

ourReference

string

Our reference ("Vores ref.")

notes

string

Notes shown on the document

status

string

New stored status (validated against the document type: draft/sent for order confirmations).

PublicDownloadLink

url

string · required

Fetch this URL directly to download the PDF. It needs no API key — the URL itself is the credential.

expiresAt

string · date-time · required

When the link stops working

ProductGroupResponse

id

string · required

The unique identifier of the product group

Example: 550e8400-e29b-41d4-a716-446655440000

number

string · required

Unique product-group number within the company

Example: PG001

name

string · required

Name of the product group

Example: Office Supplies

domesticAccountId

string · required

Ledger account ID for domestic sales

Example: 550e8400-e29b-41d4-a716-446655440000

createdAt

string · date-time · required

When the product group was created

Example: 2024-01-15T10:30:00Z

updatedAt

string · date-time · required

When the product group was last updated

Example: 2024-01-15T10:30:00Z

description

string | null

Optional description

Example: Products for office use

domesticAccountNumber

number | null

Domestic account number

Example: 1010

domesticAccountName

string | null

Domestic account name

Example: Sales — domestic

euAccountId

string | null

Ledger account ID for EU sales (Rubric B)

euAccountNumber

number | null

EU account number

euAccountName

string | null

EU account name

abroadAccountId

string | null

Ledger account ID for sales abroad (Rubric C)

abroadAccountNumber

number | null

Abroad account number

abroadAccountName

string | null

Abroad account name

domesticWithoutVatAccountId

string | null

Ledger account ID for domestic sales without VAT

domesticWithoutVatAccountNumber

number | null

Domestic-without-VAT account number

domesticWithoutVatAccountName

string | null

Domestic-without-VAT account name

productCount

number

Number of products in this group (list responses only)

Example: 12

ListProductGroupsResponse

ProductGroupResponse[] · required

Page of product groups

total

number · required

Total number of matching product groups

Example: 42

page

number · required

Current page number

Example: 1

limit

number · required

Items per page

Example: 25

totalPages

number · required

Total number of pages

Example: 2

CreateProductGroupRequest

number

string · required

Unique product-group number within the company

Example: PG001

name

string · required

Name of the product group

Example: Office Supplies

domesticAccountId

string · required

Ledger account ID for domestic sales. Must reference an existing account that carries a VAT code valid for sales.

Example: 550e8400-e29b-41d4-a716-446655440000

euAccountId

string · required

Ledger account ID for EU sales (Rubric B). Must carry a sales-valid VAT code.

abroadAccountId

string · required

Ledger account ID for sales abroad (Rubric C). Must carry a sales-valid VAT code.

domesticWithoutVatAccountId

string · required

Ledger account ID for domestic sales without VAT.

description

string

Optional description

Example: Products for office use

UpdateProductGroupRequest

number

string

Unique product-group number within the company

Example: PG001

name

string

Name of the product group

Example: Office Supplies

description

string

Optional description

Example: Products for office use

domesticAccountId

string

Ledger account ID for domestic sales

euAccountId

string

Ledger account ID for EU sales (Rubric B)

abroadAccountId

string

Ledger account ID for sales abroad (Rubric C)

domesticWithoutVatAccountId

string

Ledger account ID for domestic sales without VAT

EntitlementResponse

id

string · required

Entitlement ID

name

string · required

Entitlement name

Example: Advanced reporting

managedExternally

boolean · required

True 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.

Example: false

externalSource

string | null · enum · required

Which system maintains the entitlement: "api" (created via this API), "platform" (managed by LedgerBee, read-only here), or null for operator-created rows.

Enum values:

api

platform

Example: api

createdAt

string · date-time · required

When the entitlement was created

updatedAt

string · date-time · required

When the entitlement was last updated

key

string | null

Stable integration key

Example: advanced_reporting

ListEntitlementsResponse

EntitlementResponse[] · required

total

number · required

page

number · required

limit

number · required

totalPages

number · required

CreateEntitlementRequest

name

string · required

Entitlement name

Example: Advanced reporting

key

string | null

Stable integration key

Example: advanced_reporting

UpdateEntitlementRequest

name

string

Entitlement name

key

string | null

Stable integration key

ProductListItem

id

string · required

The unique identifier of the product

Example: 550e8400-e29b-41d4-a716-446655440000

productNumber

string · required

Unique product number within the company

Example: P001

name

string · required

Name of the product

Example: Web Hosting

unit

string · required

Unit of measurement

Example: pcs

productGroupId

string · required

Product group this product belongs to

productType

string · enum · required

Product type (goods or services) for EU VAT

Enum values:

goods

services

isActive

boolean · required

Whether the product is active

Example: true

isArchived

boolean · required

Whether the product is archived

Example: false

isLocked

boolean · required

Whether the product is locked (in use, cannot be deleted)

Example: false

createdAt

string · date-time · required

When the product was created

Example: 2024-01-15T10:30:00Z

updatedAt

string · date-time · required

When the product was last updated

Example: 2024-01-15T10:30:00Z

description

string | null

Optional description

ListProductsResponse

ProductListItem[] · required

Page of products (prices omitted; GET one product for its prices)

total

number · required

Total number of matching products

Example: 42

page

number · required

Current page number

Example: 1

limit

number · required

Items per page

Example: 25

totalPages

number · required

Total number of pages

Example: 2

ProductPriceTierResponse

id

string · required

Tier ID

Example: 550e8400-e29b-41d4-a716-446655440000

fromQuantity

number · required

Starting quantity (inclusive)

Example: 1

unitAmount

string · required

Price per unit for this tier

Example: 99.99

toQuantity

number | null

Ending quantity (inclusive). Null = no upper limit.

Example: 10

flatFee

string | null

Optional flat fee for this tier

Example: 10.00

ProductPriceResponse

id

string · required

The unique identifier of the price (use as a line priceId)

Example: 550e8400-e29b-41d4-a716-446655440000

productId

string · required

The product this price belongs to

billingPeriodType

string · enum · required

Billing period type

Enum values:

recurring

usage

one_time

surcharge

pricingModel

string · enum · required

Pricing model

Enum values:

flat_rate

package

volume

graduated

currency

string · required

Currency of the displayed unitAmount (ISO 4217)

Example: DKK

baseCurrency

string · required

Base currency (source of truth for conversions)

Example: DKK

status

string · enum · required

Price status

Enum values:

draft

active

inactive

archived

isDefault

boolean · required

Whether this is the default price for the product

Example: false

isLocked

boolean · required

Whether the price is locked (in use by a subscription/invoice)

Example: false

vatRatesByZone

object · required

VAT rates by zone (derived from the product group), e.g. { domestic: "25", eu: "0", abroad: "0", domestic_without_vat: "0" }

nickname

string | null

Optional nickname (e.g. "Monthly")

unitAmount

string | null

Unit amount for flat-rate pricing in currency

Example: 99.99

billingInterval

string | null · enum

Billing interval (null for one-time)

Enum values:

day

week

month

year

billingIntervalCount

number | null

Billing interval count

Example: 1

availableCurrencies

string[]

Currencies with a price-history entry

meterId

string | null

Meter ID for usage-based pricing

ProductPriceTierResponse[]

Pricing tiers (package/volume/graduated)

ProductResponse

id

string · required

The unique identifier of the product

Example: 550e8400-e29b-41d4-a716-446655440000

productNumber

string · required

Unique product number within the company

Example: P001

name

string · required

Name of the product

Example: Web Hosting

unit

string · required

Unit of measurement

Example: pcs

productGroupId

string · required

Product group this product belongs to

productType

string · enum · required

Product type (goods or services) for EU VAT

Enum values:

goods

services

isActive

boolean · required

Whether the product is active

Example: true

isArchived

boolean · required

Whether the product is archived

Example: false

isLocked

boolean · required

Whether the product is locked (in use, cannot be deleted)

Example: false

createdAt

string · date-time · required

When the product was created

Example: 2024-01-15T10:30:00Z

updatedAt

string · date-time · required

When the product was last updated

Example: 2024-01-15T10:30:00Z

description

string | null

Optional description

ProductPriceResponse[]

Prices configured for this product

EntitlementRef[]

Entitlements granted by this product

CreateProductPriceTierRequest

fromQuantity

number · required

Starting quantity (inclusive)

Example: 1

unitAmount

string · required

Price per unit for this tier

Example: 99.99

toQuantity

number

Ending quantity (inclusive). Omit for the open-ended top tier.

Example: 10

flatFee

string

Optional flat fee for this tier

Example: 10.00

CreateProductInitialPriceRequest

billingPeriodType

string · enum · required

Billing period type. RECURRING and USAGE both require a Subscription license.

Enum values:

recurring

usage

one_time

surcharge

pricingModel

string · enum · required

Pricing model

Enum values:

flat_rate

package

volume

graduated

nickname

string

Optional nickname (e.g. "Monthly")

Example: Monthly

unitAmount

string

Unit amount. Required for FLAT_RATE pricing; for tiered models (PACKAGE/VOLUME/GRADUATED) the amounts live in tiers.

Example: 99.99

billingInterval

string · enum

Billing interval (required unless one-time)

Enum values:

day

week

month

year

billingIntervalCount

number

Billing interval count

Example: 1

currency

string · minLength: 3 · maxLength: 3

Currency code (ISO 4217)

Example: DKK

meterId

string

Meter ID (required for USAGE pricing)

CreateProductPriceTierRequest[]

Pricing tiers. Required for tiered models: PACKAGE (exactly 1), VOLUME / GRADUATED (one or more, last tier open-ended). Omit for FLAT_RATE.

CreateProductRequest

productNumber

string · required

Unique product number within the company

Example: P001

name

string · maxLength: 300 · required

Name of the product

Example: Web Hosting

unit

string · maxLength: 255 · required

Unit of measurement

Example: pcs

productGroupId

string · required

Product group this product belongs to (must exist)

Example: 550e8400-e29b-41d4-a716-446655440000

description

string · maxLength: 1000

Optional description

isActive

boolean

Whether the product is active

Default: true

productType

string · enum

Product type (goods or services)

Enum values:

goods

services

Default: services

object

Optional initial price. If provided it is created, activated and set as default in one transaction.

entitlementIds

array | null · maxItems: 100

Externally managed entitlement IDs to bind (max 100)

UpdateProductRequest

productNumber

string

Unique product number within the company

Example: P001

name

string · maxLength: 300

Name of the product

Example: Web Hosting

description

string · maxLength: 1000

Optional description

unit

string · maxLength: 255

Unit of measurement

Example: pcs

productGroupId

string

Product group this product belongs to

isActive

boolean

Whether the product is active

productType

string · enum

Product type (goods or services)

Enum values:

goods

services

entitlementIds

array | null · maxItems: 100

Externally managed entitlement IDs to bind (max 100)

PublicOpenEntry

kind

string · enum · required

What this row points at. Echo it back verbatim as a settlement selection — an ANCHOR and a PREPAYMENT are stored alike and are not interchangeable.

Enum values:

ANCHOR

PAYMENT

PREPAYMENT

id

string · required

ID of the entry — the invoice anchor for ANCHOR and PREPAYMENT rows, the payment entry for PAYMENT.

Example: 0197A943-2325-7829-B835-B6C71A293065

type

string · enum · required

What the entry is.

Enum values:

INVOICE

REMINDER

CREDIT_NOTE

PAYMENT

PREPAYMENT

reference

string · required

Invoice number, payment reference, or anchor number.

Example: INV-1043

date

string · required

Posting date of the original entry (YYYY-MM-DD).

Example: 2026-08-14

currency

string · required

Currency of the original entry (3-letter ISO).

Example: EUR

originalAmount

number · required

Signed face amount in the entry’s own currency. Positive on an invoice, negative on a credit note.

Example: 1250

remainingAmount

number · required

Signed amount still open, in the entry’s own currency. This is the ceiling for amountToApply.

Example: 400

baseRemainingAmount

number · required

The same remaining amount converted to the company’s base currency at the entry’s booked rate.

Example: 2980

version

string · required

Concurrency token. Pass it back on a settlement selection and the request is refused if the entry changed in the meantime.

Example: 2026-08-14T09:31:07.000Z

prepaymentKind

string · enum

What 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.

Enum values:

ADVANCE

HELD_DEPOSIT

REFUNDABLE

bookedExchangeRate

number | null

The rate that converted this entry to base currency when it was booked. Null when the entry is already in base currency.

Example: 7.45

dueDate

string | null

When the document falls due (YYYY-MM-DD). Null on payments and on documents carrying no due date.

Example: 2026-09-13

daysOverdue

number | null

Whole 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.

Example: 17

journalEntryId

string | null

The journal entry behind this row, when one exists. Null on an imported entry with no backing entry.

Example: 0197A943-2325-7829-B835-B6C71A293066

PublicOpenEntriesCurrencyTotal

currency

string · required

3-letter ISO currency code.

Example: EUR

remainingTotal

number · required

Signed sum of the listed rows’ remaining amounts in this currency.

Example: 400

PublicOpenEntriesTotals

PublicOpenEntriesCurrencyTotal[] · required

One total per currency the listed entries are denominated in.

baseCurrencyOutstanding

number · required

The 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.

Example: 2980

PublicOpenEntriesResponse

baseCurrency

string · required

The company’s base currency (3-letter ISO).

Example: DKK

asOf

string · required

The 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.

Example: 2026-09-30

PublicOpenEntry[] · required

The counterparty’s open entries.

PublicOpenEntriesTotals · required

PublicSettlementListItem

id

string · required

ID of the settlement.

Example: 0197A943-2325-7829-B835-B6C71A293070

postingDate

string · required

Accounting date the settlement posted on (YYYY-MM-DD).

Example: 2026-09-01

createdAt

string · required

When the settlement was recorded.

Example: 2026-09-01T11:04:22.000Z

counterpartyType

string · enum · required

Enum values:

CUSTOMER

SUPPLIER

counterpartyId

string · required

The customer or supplier the entries belong to.

reversed

boolean · required

Whether the settlement has been reversed. A reversed settlement contributes nothing — its entries are open again.

Example: false

baseAmountSettled

number · required

Total value settled, in the company’s base currency.

Example: 2980

reversedAt

string | null

When it was reversed. Null while it stands.

reversalReason

string | null

Why it was reversed. Null while it stands.

residualJournalEntryId

string | null

The journal entry carrying the difference, when the entries did not net to zero. Null when they balanced exactly.

PublicSettlementsResponse

baseCurrency

string · required

The company’s base currency (3-letter ISO).

Example: DKK

PublicSettlementListItem[] · required

PublicSettlementEntry

kind

string · enum · required

Enum values:

ANCHOR

PAYMENT

PREPAYMENT

type

string · enum · required

Enum values:

INVOICE

REMINDER

CREDIT_NOTE

PAYMENT

PREPAYMENT

id

string · required

The entry that was settled — the same id the open-entries listing reports.

reference

string · required

Invoice number, payment reference, or anchor number.

Example: INV-1043

date

string · required

Posting date of the entry (YYYY-MM-DD).

Example: 2026-08-14

currency

string · required

Currency of the entry (3-letter ISO).

Example: EUR

originalAmount

number · required

The entry’s full signed amount in its own currency. A settlement may consume only part of it, so compare against appliedAmount.

Example: 1250

appliedAmount

number · required

Signed amount this settlement applied, in the entry’s currency.

Example: -400

baseAmountApplied

number · required

The same applied amount in the company’s base currency.

Example: -2980

journalEntryId

string | null

The journal entry behind it, when one exists.

PublicSettlementDifferenceLeg

accountId

string · required

The ledger account posted to.

accountNumber

number · required

Account number as it appears in the chart of accounts.

Example: 6210

accountName

string · required

Account name.

Example: Exchange rate differences

type

string · enum · required

Which side the amount posted on.

Enum values:

DEBIT

CREDIT

baseAmount

number · required

Magnitude in base currency — always positive; the side is on type.

Example: 12.5

PublicSettlementDifference

journalEntryId

string · required

The journal entry carrying the difference.

description

string · required

What the posting says it is — this is where an exchange difference is distinguished from a write-off.

Example: Exchange rate difference on settlement

PublicSettlementDifferenceLeg[] · required

PublicSettlement

id

string · required

ID of the settlement.

Example: 0197A943-2325-7829-B835-B6C71A293070

postingDate

string · required

Accounting date the settlement posted on (YYYY-MM-DD).

Example: 2026-09-01

createdAt

string · required

When the settlement was recorded.

Example: 2026-09-01T11:04:22.000Z

counterpartyType

string · enum · required

Enum values:

CUSTOMER

SUPPLIER

counterpartyId

string · required

The customer or supplier the entries belong to.

reversed

boolean · required

Whether the settlement has been reversed. A reversed settlement contributes nothing — its entries are open again.

Example: false

baseCurrency

string · required

The company’s base currency (3-letter ISO).

Example: DKK

PublicSettlementEntry[] · required

The entries this settlement linked, and how much of each it applied.

reversedAt

string | null

When it was reversed. Null while it stands.

reversalReason

string | null

Why it was reversed. Null while it stands.

difference

object | null

The difference posting, when the entries did not net to zero. Null when they balanced exactly.

PublicSettlementEntrySelection

kind

string · enum · required

The kind the open-entries listing reported for this entry. Echo it back unchanged.

Enum values:

ANCHOR

PAYMENT

PREPAYMENT

id

string · required

The id the open-entries listing reported for this entry.

Example: 0197A943-2325-7829-B835-B6C71A293070

amountToApply

number · min: 0 · required

How 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.

Example: 400

version

string

The 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.

Example: 2026-08-14T09:12:44.000Z

PublicSettleRequest

postingDate

string · required

Accounting date to post the settlement on (YYYY-MM-DD).

Example: 2026-09-01

PublicSettlementEntrySelection[] · required

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.

customerId

string

Read the customer’s entries. Mutually exclusive with supplierId; exactly one is required.

Example: 0197A943-2325-7829-B835-B6C71A293065

supplierId

string

Read the supplier’s entries. Mutually exclusive with customerId; exactly one is required.

Example: 0197A943-2325-7829-B835-B6C71A293066

idempotencyKey

string

Your 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.

Example: settle-2026-09-01-invoice-1043

PublicSettlementPreviewEntry

id

string · required

The entry, as named in the request.

kind

string · enum · required

Enum values:

ANCHOR

PAYMENT

PREPAYMENT

appliedAmount

number · required

Signed amount that would be applied, in the entry’s own currency.

Example: -400

baseAmountApplied

number · required

The same amount in the company’s base currency.

Example: -2980

exchangeRate

number · required

Rate used to convert it.

Example: 7.45

rateSource

string · enum · required

Enum values:

OVERRIDE

SPOT

BOOKED

statusAfter

string | null · enum

What this entry’s status becomes. Null for a payment, which carries no status of its own.

Enum values:

PAID

PARTIALLY_PAID

OPEN

fullyConsumedAfter

boolean | null

Whether a payment is used up entirely. Null for anything that carries a status instead.

PublicSettlementDifferencePreview

kind

string · enum · required

Enum values:

BALANCED

WRITEOFF

baseAmount

number · required

The 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.

Example: -12.5

label

string · required

What the difference is, in words — for example "Realized FX gain".

Example: Realized FX gain

account

object | null

The account the difference would post to. Null when there is nothing to post.

PublicSettlementPostingLine

accountId

string · required

The ledger account posted to.

accountLabel

string · required

Account number and name.

Example: 5600 Debtors

currency

string · required

Currency of the line (3-letter ISO).

Example: EUR

originalAmount

number · required

Signed amount in that currency.

Example: -400

exchangeRate

number · required

Rate used to convert it.

Example: 7.45

baseAmount

number · required

The same amount in the company’s base currency.

Example: -2980

kind

string · enum · required

Enum values:

APPLIED

DIFFERENCE

VAT

PublicSettlementRateGapCurrency

currency

string · required

minRate

number · required

Lowest rate any selected entry in this currency was booked at.

Example: 7.41

maxRate

number · required

Highest rate any selected entry in this currency was booked at.

Example: 7.49

spread

number · required

How far apart the two are, as a fraction of the higher one.

Example: 0.0107

PublicSettlementPreview

baseCurrency

string · required

The company’s base currency (3-letter ISO).

Example: DKK

postingDate

string · required

Accounting date the settlement would post on.

Example: 2026-09-01

PublicSettlementPreviewEntry[] · required

What each named entry would have applied to it, and what it becomes.

PublicSettlementDifferencePreview · required

PublicSettlementPostingLine[] · required

The lines that would post. Empty when the entries balance and nothing needs a posting.

blockers

string[] · required

Error codes that would refuse the settlement. A non-empty list means the commit fails with the first of them.

Example: []

warnings

string[] · required

Codes for things worth checking. The settlement would still post.

Example: ["SETTLEMENT_FX_RATE_GAP_UNUSUALLY_LARGE"]

array | null

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

id

string · required

The settlement. Read it back at GET /v1/settlements/{id}.

Example: 0197A943-2325-7829-B835-B6C71A293070

differenceJournalEntryId

string | null

The journal entry carrying the difference, when the entries did not net to zero. Null when they balanced exactly.

vatReclassJournalEntryId

string | null

The journal entry that moved a prepayment’s VAT onto the invoice it was applied to. Null unless the settlement did that.

CreateProductPriceRequest

productId

string · required

The product this price belongs to

Example: 550e8400-e29b-41d4-a716-446655440000

billingPeriodType

string · enum · required

Billing period type. RECURRING and USAGE both require a Subscription license.

Enum values:

recurring

usage

one_time

surcharge

pricingModel

string · enum · required

Pricing model

Enum values:

flat_rate

package

volume

graduated

nickname

string

Optional nickname (e.g. "Monthly")

Example: Monthly

status

string · enum

Initial status. Defaults to active, so the price is usable immediately. Pass draft to stage it and publish it later via the activate endpoint.

Enum values:

active

draft

Default: active

unitAmount

string

Unit amount. Required for FLAT_RATE pricing; for tiered models (PACKAGE/VOLUME/GRADUATED) the amounts live in tiers.

Example: 99.99

billingInterval

string · enum

Billing interval (required unless one-time)

Enum values:

day

week

month

year

billingIntervalCount

number

Billing interval count

Example: 1

currency

string · minLength: 3 · maxLength: 3

Currency code (ISO 4217). Defaults to the company default.

Example: DKK

meterId

string

Meter ID (required for USAGE pricing)

CreateProductPriceTierRequest[]

Pricing tiers. Required for tiered models: PACKAGE (exactly 1), VOLUME / GRADUATED (one or more, last tier open-ended). Omit for FLAT_RATE.

UpdateProductPriceRequest

nickname

string

Optional nickname

Example: Monthly

unitAmount

string

Unit amount for flat-rate pricing

Example: 99.99

billingPeriodType

string · enum

Billing period type

Enum values:

recurring

usage

one_time

surcharge

pricingModel

string · enum

Pricing model

Enum values:

flat_rate

package

volume

graduated

billingInterval

string | null · enum

Billing interval (null for one-time)

Enum values:

day

week

month

year

billingIntervalCount

number

Billing interval count

Example: 1

currency

string · minLength: 3 · maxLength: 3

Currency code (ISO 4217)

Example: DKK

status

string · enum

Price status

Enum values:

draft

active

inactive

archived

meterId

string

Meter ID for usage-based pricing

CreateProductPriceTierRequest[]

Pricing tiers

DocumentTemplateListItem

id

string · required

The unique identifier of the template

Example: 550e8400-e29b-41d4-a716-446655440000

name

string · required

Template name

Example: Premium Invoice

documentType

string · enum · required

Document type this template applies to

Enum values:

invoice-template

credit-note-template

quote-template

order-confirmation-template

isDefault

boolean · required

Whether this is the default template for its document type

Example: false

createdAt

string · date-time · required

When the template was created

Example: 2024-01-15T10:30:00Z

updatedAt

string · date-time · required

When the template was last updated

Example: 2024-01-15T10:30:00Z

ListDocumentTemplatesResponse

DocumentTemplateListItem[] · required

Page of document templates

total

number · required

Total number of matching templates

Example: 7

page

number · required

Current page number

Example: 1

limit

number · required

Items per page

Example: 25

totalPages

number · required

Total number of pages

Example: 1

BudgetSummary

id

string · uuid · required

The unique identifier of the budget

name

string · required

Budget name

Example: Budget 2026

status

string · enum · required

Budget status. Informational — the status does not restrict reads.

Enum values:

DRAFT

ACTIVE

ARCHIVED

accountingYearId

string · uuid · required

Accounting year the budget covers

accountingYearStartDate

string · required

Accounting year start date (ISO date, YYYY-MM-DD)

Example: 2026-01-01

accountingYearEndDate

string · required

Accounting year end date (ISO date, YYYY-MM-DD)

Example: 2026-12-31

currency

string · required

ISO 4217 currency every amount on this budget is denominated in — the company's base (functional) currency.

Example: DKK

createdAt

string · required

When the budget was created (ISO 8601)

Example: 2026-01-15T10:30:00.000Z

updatedAt

string · required

When the budget was last updated (ISO 8601)

Example: 2026-01-15T10:30:00.000Z

dimensionCategoryId

string | null · uuid

Dimension category scoping this budget: lines then carry per-dimension-value buckets. null for flat budgets.

ListBudgetsResponse

BudgetSummary[] · required

Page of budgets

total

number · required

Total number of matching budgets

Example: 3

page

number · required

Current page number

Example: 1

limit

number · required

Items per page

Example: 25

totalPages

number · required

Total number of pages

Example: 1

BudgetRunwayResponse

currency

string · required

ISO 4217 currency every amount is denominated in — the company's base (functional) currency.

Example: DKK

cashOnHand

string · required

Sum of bank-account-linked ledger balances as of asOf (decimal string)

Example: 2051260.11

trailing3MonthBurn

string · required

Trailing average net outflow over the last 3 closed months (decimal string). Negative when the company is cash-positive.

Example: 296121.14

monthsRemaining

number | null · required

Cash divided by burn; null = infinite runway (burn ≤ 0)

Example: 6.9

status

string · enum · required

OK (≥ 6 months), WATCH (3-6), LOW (< 3), or UNKNOWN (no cash source, or no closed periods to compute burn from — see hasCashSource).

Enum values:

WATCH

LOW

UNKNOWN

hasCashSource

boolean · required

Whether at least one bank account is linked to a ledger account. When false, cashOnHand is a meaningless 0.

asOf

string · required

ISO date the cash and burn were computed as of

Example: 2026-08-25

feedReportedCashTotal

string | null · required

Sum of provider-reported balances over active bank accounts in the functional currency (decimal string). null when any active account is held in another currency.

Example: 2051260.11

unlinkedBankAccountCount

number · required

Active bank accounts with no linked ledger account — invisible to cashOnHand.

Example: 0

BudgetLine

id

string · uuid · required

The unique identifier of the budget line

ledgerId

string · uuid · required

Ledger account this line budgets

ledgerName

string · required

Ledger account name

Example: Salg af varer/ydelser m/moms

accountNumber

number · required

Ledger account number

Example: 1010

accountingPeriodId

string · uuid · required

Accounting period this cell belongs to (see periods)

amount

string · required

Budgeted 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.

Example: 160000.00

dimensionValueId

string | null · uuid

Dimension value bucket. null = the Unallocated bucket; absent for flat budgets.

formula

string | null

Formula text (e.g. =baseline*1.05), or null for a plain literal cell.

inputMethod

string · enum

How the cell was entered. Absent on legacy rows (treat as MANUAL).

Enum values:

MANUAL

FORMULA

SUBSCRIPTION_LINK

source

string | null · enum

Provenance of the value: ACTUALS = closed-period book actual; SUBSCRIPTION = filled from the subscription forecast. null/absent = user-entered.

Enum values:

ACTUALS

SUBSCRIPTION

error

string | null

Per-cell formula evaluation error code, when the cell could not resolve. null/absent = resolved.

baseline

string | null

Prior accounting year's realised amount for the same account and calendar month (decimal string). null unless requested with ?includeBaseline=true.

Example: 150000.00

BudgetPeriod

id

string · uuid · required

Accounting period id

label

string · required

Period label

Example: Jan 2026

startDate

string · required

Period start date (ISO date, YYYY-MM-DD)

Example: 2026-01-01

endDate

string · required

Period end date (ISO date, YYYY-MM-DD)

Example: 2026-01-31

periodIndex

number · required

Period index within the accounting year (1-12)

Example: 1

status

string · enum · required

OPEN or CLOSED. Lines in CLOSED periods show the book actuals (rolling forecast), not the planned amount.

Enum values:

OPEN

CLOSED

BudgetDriverCell

id

string · uuid · required

The unique identifier of the driver cell

accountingPeriodId

string · uuid · required

Accounting period this cell belongs to (see periods)

value

number · required

Resolved value. Drivers are quantities (headcount, ARPU, …), not money, so this is a number.

Example: 12

formula

string | null

Formula text, or null for a plain literal cell.

error

string | null

Per-cell formula evaluation error code, when the cell could not resolve. null/absent = resolved.

BudgetDriverRow

id

string · uuid · required

The unique identifier of the driver row

name

string · required

Display name

Example: Headcount

handle

string · required

Stable token used to reference this row in formulas

Example: headcount

displayOrder

number · required

Display order among the driver rows

Example: 1

BudgetDriverCell[] · required

Per-period cells

unit

string | null

Unit label (e.g. "FTE", "%").

BudgetRowOverride

ledgerId

string · uuid · required

Ledger account the override applies to

isHidden

boolean · required

Whether the row is hidden from the editor (still counted in totals).

label

string | null

Budget-local display name overriding the account name. null = default name.

BudgetRowNumber

lineNumber

number · required

Stable reference number used by #N formula references

Example: 2

ledgerId

string | null · uuid

Ledger account this number belongs to. Exactly one of ledgerId / driverRowId is set.

driverRowId

string | null · uuid

Driver row this number belongs to. Exactly one of ledgerId / driverRowId is set.

BudgetDetail

id

string · uuid · required

The unique identifier of the budget

name

string · required

Budget name

Example: Budget 2026

status

string · enum · required

Budget status. Informational — the status does not restrict reads.

Enum values:

DRAFT

ACTIVE

ARCHIVED

accountingYearId

string · uuid · required

Accounting year the budget covers

accountingYearStartDate

string · required

Accounting year start date (ISO date, YYYY-MM-DD)

Example: 2026-01-01

accountingYearEndDate

string · required

Accounting year end date (ISO date, YYYY-MM-DD)

Example: 2026-12-31

currency

string · required

ISO 4217 currency every amount on this budget is denominated in — the company's base (functional) currency.

Example: DKK

createdAt

string · required

When the budget was created (ISO 8601)

Example: 2026-01-15T10:30:00.000Z

updatedAt

string · required

When the budget was last updated (ISO 8601)

Example: 2026-01-15T10:30:00.000Z

BudgetLine[] · required

Budget cells (one per account × period, and per dimension bucket when dimensioned)

BudgetPeriod[] · required

The accounting year's periods, ordered by periodIndex

BudgetDriverRow[] · required

Driver rows with resolved cells (non-money quantities)

BudgetRowOverride[] · required

Budget-local display overrides. Only accounts carrying an override are listed.

BudgetRowNumber[] · required

Stable #N row numbers used by formula references. Rows never numbered in the editor may be absent.

dimensionCategoryId

string | null · uuid

Dimension category scoping this budget: lines then carry per-dimension-value buckets. null for flat budgets.

BudgetScenario

id

string · uuid · required

The unique identifier of the scenario

name

string · required

Scenario name

Example: Aggressive hiring

isBaseline

boolean · required

True 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.

createdAt

string · required

When the scenario was created (ISO 8601)

Example: 2026-01-15T10:30:00.000Z

updatedAt

string · required

When the scenario was last updated (ISO 8601)

Example: 2026-01-15T10:30:00.000Z

description

string | null

Scenario description

ListBudgetScenariosResponse

BudgetScenario[] · required

The budget's scenarios

BudgetScenarioGridResponse

currency

string · required

ISO 4217 currency every amount is denominated in — the company's base (functional) currency.

Example: DKK

BudgetLine[] · required

All resolved budget cells under the scenario overlay

BudgetDriverRow[] · required

All driver rows with resolved cells under the overlay

hasCycle

boolean · required

True when the overlay could not resolve because of a formula cycle — offending cells carry error: BUDGET_FORMULA_CYCLE and amounts must not be trusted.

forecastHorizonMonth

string | null

Last 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.

Example: 2026-12

BudgetComparisonSummary

totalBudget

string · required

Total budgeted amount (decimal string)

Example: 3251000.00

totalActual

string · required

Total actual amount (decimal string)

Example: 3100000.00

totalVariance

string · required

Total variance, budget − actual (decimal string)

Example: 151000.00

totalVariancePercent

number | null · required

Total variance as a percentage of budget; null when the budget is 0

isOverBudget

boolean · required

True when total actual exceeds total budget

BudgetComparisonEntry

ledgerId

string · uuid · required

Ledger account

ledgerName

string · required

Ledger account name

Example: Salg af varer/ydelser m/moms

accountNumber

number · required

Ledger account number

Example: 1010

periodId

string · uuid · required

Accounting period (see periods)

budgetAmount

string · required

Budgeted amount (decimal string)

Example: 160000.00

actualAmount

string · required

Actual amount from the ledger (decimal string)

Example: 154321.12

variance

string · required

Variance, budget − actual (decimal string)

Example: 5678.88

variancePercent

number | null · required

Variance as a percentage of budget; null when the budget is 0

isOverBudget

boolean · required

True when the variance is unfavourable: actual above budget on expense accounts, actual below budget on revenue accounts.

isRevenueAccount

boolean · required

True for revenue (credit-normal) accounts; false for expense (debit-normal) accounts

dimensionValueId

string | null · uuid

Dimension value bucket. null = the Unallocated bucket; absent for flat budgets.

BudgetComparisonResponse

budgetName

string · required

Budget name

Example: Budget 2026

currency

string · required

ISO 4217 currency every amount is denominated in — the company's base (functional) currency.

Example: DKK

object · required

Summary totals for the comparison

BudgetComparisonEntry[] · required

Comparison entries by account and period

BudgetPeriod[] · required

The periods covered by the comparison

BudgetVarianceRow

ledgerId

string · uuid · required

Ledger account

accountName

string · required

Ledger account name

Example: Salg af varer/ydelser m/moms

accountType

string · enum · required

Normal side of the account: DEBIT (expense-like) or CREDIT (revenue-like)

Enum values:

DEBIT

CREDIT

periodId

string · uuid · required

Accounting period

frozenBaseline

string · required

Amount in the frozen baseline (decimal string)

Example: 160000.00

actual

string · required

Actual amount from the ledger (decimal string)

Example: 170000.00

variance

string · required

Variance, actual − frozen baseline (decimal string)

Example: 10000.00

variancePercent

number | null · required

Variance as a percentage of the absolute baseline; null when the baseline is 0

sentiment

string · enum · required

Unfavourable when spending exceeds the frozen plan (expense accounts) or revenue misses it (revenue accounts).

Enum values:

favourable

unfavourable

BudgetVarianceResponse

currency

string · required

ISO 4217 currency every amount is denominated in — the company's base (functional) currency.

Example: DKK

BudgetVarianceRow[] · required

Closed-period variance rows vs the frozen baseline. Empty when the budget has no frozen baseline yet.

BudgetFrozenBaselineSummary

id

string · uuid · required

The unique identifier of the frozen baseline

label

string · required

Label given when the baseline was frozen

Example: Board-approved plan

frozenAt

string · required

When the baseline was frozen (ISO 8601)

Example: 2026-01-15T10:30:00.000Z

cellCount

number · required

Number of snapshot cells

Example: 288

scenarioId

string | null · uuid

Scenario whose overlay was snapshotted. null = the base grid.

frozenBy

string | null

Identity that froze the baseline

ListBudgetFrozenBaselinesResponse

BudgetFrozenBaselineSummary[] · required

The budget's frozen baselines, most recent first

BudgetFrozenBaselineCell

id

string · uuid · required

The unique identifier of the snapshot cell

ledgerId

string · uuid · required

Ledger account

accountingPeriodId

string · uuid · required

Accounting period

amount

string · required

Frozen resolved amount (decimal string)

Example: 160000.00

dimensionValueId

string | null · uuid

Dimension value bucket. null = the Unallocated bucket; absent for flat budgets.

source

string | null · enum

Provenance of the cell at freeze time

Enum values:

ACTUALS

SUBSCRIPTION

BudgetFrozenBaselineDetail

id

string · uuid · required

The unique identifier of the frozen baseline

label

string · required

Label given when the baseline was frozen

Example: Board-approved plan

frozenAt

string · required

When the baseline was frozen (ISO 8601)

Example: 2026-01-15T10:30:00.000Z

currency

string · required

ISO 4217 currency every amount is denominated in — the company's base (functional) currency.

Example: DKK

BudgetFrozenBaselineCell[] · required

Snapshot cells

scenarioId

string | null · uuid

Scenario whose overlay was snapshotted. null = the base grid.

frozenBy

string | null

Identity that froze the baseline

BudgetRebaselineProposal

id

string · uuid · required

The unique identifier of the proposal

accountingPeriodId

string · uuid · required

The closed accounting period the proposal was raised for

status

string · enum · required

PROPOSED (open), CONFIRMED (accepted — the budget was recomputed forward), or REJECTED.

Enum values:

PROPOSED

CONFIRMED

REJECTED

proposedAt

string · required

When the proposal was raised (ISO 8601)

Example: 2026-02-01T02:00:00.000Z

confirmedAt

string | null

When the proposal was confirmed. null while open or rejected.

ListBudgetRebaselineProposalsResponse

BudgetRebaselineProposal[] · required

The budget's re-baseline proposals

ProjectSubproject

id

string · required

Unique identifier of the subproject.

Example: 550e8400-e29b-41d4-a716-446655440010

dimensionValueId

string · required

The journal-tag value ID that represents this subproject in the dimensions system. Use this value when tagging ledger transactions to the subproject.

Example: 550e8400-e29b-41d4-a716-446655440011

name

string · required

Display name of the subproject.

Example: Phase 1

isDefault

boolean · required

Whether this is the default (catch-all) subproject for the project.

Example: false

sortOrder

number · required

Display sort order (ascending).

Example: 1

budgetHours

number | null

Budget in hours for this subproject. Null when no budget is set.

Example: 120

budgetAmount

number | null

Budget amount in the project currency for this subproject. Null when no budget is set.

Example: 15000

color

string | null

Hex colour code for visual identification in the UI. Null when not set.

Example: #4A90E2

Project

id

string · required

Unique identifier of the project.

Example: 550e8400-e29b-41d4-a716-446655440000

name

string · required

Display name of the project.

Example: Website Redesign 2025

isArchived

boolean · required

Whether the project has been archived. Archived projects are read-only.

Example: false

currency

string · required

ISO 4217 currency code used for budget amounts on this project.

Example: DKK

dimensionId

string · required

The 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).

Example: 550e8400-e29b-41d4-a716-446655440002

defaultSubprojectId

string · required

ID of the default subproject (the catch-all subproject created with the project).

Example: 550e8400-e29b-41d4-a716-446655440010

ProjectSubproject[] · required

All subprojects for this project, sorted by sortOrder ascending.

createdAt

string · required

ISO 8601 timestamp when the project was created.

Example: 2025-01-15T10:00:00.000Z

updatedAt

string · required

ISO 8601 timestamp when the project was last updated.

Example: 2025-06-01T14:30:00.000Z

customerId

string | null

ID of the customer this project belongs to. Null when not linked to a customer.

Example: 550e8400-e29b-41d4-a716-446655440001

budgetHours

number | null

Total budget in hours across all subprojects. Null when not set.

Example: 500

budgetAmount

number | null

Total budget amount in the project currency. Null when not set.

Example: 100000

startDate

string | null

Project start date (inclusive), ISO 8601 date string. Null when not set.

Example: 2025-01-01

endDate

string | null

Project end date (inclusive), ISO 8601 date string. Null when not set.

Example: 2025-12-31

externalReference

string | null

Your system external reference for this project. Useful for idempotent upserts and cross-system reconciliation. Null when not set.

Example: proj-external-123

color

string | null

Hex colour code for visual identification. Null when not set.

Example: #FF5733

dimensionValueId

string | null

The 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.

Example: 550e8400-e29b-41d4-a716-446655440003

UpsertProjectRequest

name

string · minLength: 1 · maxLength: 120 · required

Display name for the project. Must be unique within your company.

Example: Website Redesign 2025

customerId

string | null

ID of the customer this project belongs to.

Example: 550e8400-e29b-41d4-a716-446655440001

currency

string · minLength: 3 · maxLength: 3

ISO 4217 currency code for budget amounts. Defaults to the customer's currency or the company base currency when omitted.

Example: DKK

budgetHours

number | null

Total budget in hours. Null clears the budget.

Example: 500

budgetAmount

number | null

Total budget amount in the project currency. Null clears the budget.

Example: 100000

startDate

string | null

Project start date (inclusive), ISO 8601 date string.

Example: 2025-01-01

endDate

string | null

Project end date (inclusive), ISO 8601 date string.

Example: 2025-12-31

externalReference

string | null · minLength: 1 · maxLength: 255

Your 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.

Example: proj-external-123

color

string | null · maxLength: 16

Hex colour code for visual identification.

Example: #FF5733

CreateProjectRequest

name

string · minLength: 1 · maxLength: 120 · required

Display name for the project. Must be unique within your company.

Example: Website Redesign 2025

customerId

string | null

ID of the customer this project belongs to.

Example: 550e8400-e29b-41d4-a716-446655440001

currency

string · minLength: 3 · maxLength: 3

ISO 4217 currency code for budget amounts. Defaults to the customer's currency or the company base currency when omitted.

Example: DKK

budgetHours

number | null

Total budget in hours. Null clears the budget.

Example: 500

budgetAmount

number | null

Total budget amount in the project currency. Null clears the budget.

Example: 100000

startDate

string | null

Project start date (inclusive), ISO 8601 date string.

Example: 2025-01-01

endDate

string | null

Project end date (inclusive), ISO 8601 date string.

Example: 2025-12-31

externalReference

string | null · minLength: 1 · maxLength: 255

Your system external reference for this project. Must be unique within your company. Can be used for idempotent upserts via PUT /.

Example: proj-external-123

color

string | null · maxLength: 16

Hex colour code for visual identification.

Example: #FF5733

ProjectProfitTotals

revenue

number · required

Base-currency revenue in the date range (positive figure, sign-flipped from REVENUE ledgers).

Example: 80000

cost

number · required

Base-currency cost in the date range (positive figure, EXPENSE ledgers).

Example: 60000

profit

number · required

revenue - cost.

Example: 20000

isOverBudget

boolean · required

True when burnPercent > 100 (over budget). False when under budget or no budget.

Example: false

budgetAmount

number | null

The budget amount this burn is measured against. Null when no budget is set.

Example: 100000

burnPercent

number | null

cost / budgetAmount * 100, rounded. Null when no budget is set or budgetAmount is 0.

Example: 60

ProjectSubprojectProfit

revenue

number · required

Base-currency revenue in the date range (positive figure, sign-flipped from REVENUE ledgers).

Example: 80000

cost

number · required

Base-currency cost in the date range (positive figure, EXPENSE ledgers).

Example: 60000

profit

number · required

revenue - cost.

Example: 20000

isOverBudget

boolean · required

True when burnPercent > 100 (over budget). False when under budget or no budget.

Example: false

subprojectId

string · required

Subproject ID.

Example: 550e8400-e29b-41d4-a716-446655440010

dimensionValueId

string · required

The dimension value ID (journal-tag ID) for this subproject.

Example: 550e8400-e29b-41d4-a716-446655440011

name

string · required

Display name of the subproject.

Example: Phase 1

isDefault

boolean · required

Whether this is the default (catch-all) subproject.

Example: false

budgetAmount

number | null

The budget amount this burn is measured against. Null when no budget is set.

Example: 100000

burnPercent

number | null

cost / budgetAmount * 100, rounded. Null when no budget is set or budgetAmount is 0.

Example: 60

ProjectProfit

projectId

string · required

Project ID.

Example: 550e8400-e29b-41d4-a716-446655440000

from

string · required

Inclusive range start actually used (after defaulting), YYYY-MM-DD.

Example: 2025-01-01

to

string · required

Inclusive range end actually used (after defaulting), YYYY-MM-DD.

Example: 2025-12-31

currency

string · required

Company base currency the amounts are expressed in.

Example: DKK

object · required

Aggregate totals for the project.

ProjectSubprojectProfit[] · required

Per-subproject profit breakdown.

UpdateProjectRequest

name

string · minLength: 1 · maxLength: 120

New display name for the project.

Example: Website Redesign 2026

customerId

string | null

Customer ID. Null clears the customer link.

Example: 550e8400-e29b-41d4-a716-446655440001

currency

string · minLength: 3 · maxLength: 3

ISO 4217 currency code.

Example: EUR

budgetHours

number | null

Budget in hours. Null clears the budget.

Example: 600

budgetAmount

number | null

Budget amount in the project currency. Null clears the budget.

Example: 120000

startDate

string | null

Project start date (inclusive), ISO 8601. Null clears the date.

Example: 2025-01-01

endDate

string | null

Project end date (inclusive), ISO 8601. Null clears the date.

Example: 2025-12-31

externalReference

string | null · maxLength: 255

External reference. Null clears the value.

Example: proj-external-123

color

string | null · maxLength: 16

Hex colour code. Null clears the value.

Example: #FF5733

isArchived

boolean

Archive or un-archive the project.

Example: false

CreateSubprojectRequest

name

string · minLength: 1 · maxLength: 120 · required

Display name for the subproject.

Example: Phase 1

budgetHours

number | null

Budget in hours for this subproject. Null clears the budget.

Example: 120

budgetAmount

number | null

Budget amount in the project currency. Null clears the budget.

Example: 15000

color

string | null · maxLength: 16

Hex colour code. Null clears the value.

Example: #4A90E2

sortOrder

number

Sort order (ascending). Defaults to 0.

Example: 1

UpdateSubprojectRequest

name

string · minLength: 1 · maxLength: 120

New display name for the subproject.

Example: Phase 2

budgetHours

number | null

Budget in hours. Null clears the budget.

Example: 200

budgetAmount

number | null

Budget amount in the project currency. Null clears the budget.

Example: 25000

color

string | null · maxLength: 16

Hex colour code. Null clears the value.

Example: #4A90E2

sortOrder

number

Sort order (ascending).

Example: 2

UsageReportRequestDto

value

number · required

The 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.

Example: 100

customerId

string · required

Customer ID this usage is associated with.

Example: 550e8400-e29b-41d4-a716-446655440000

meterId

string

Meter identifier. Provide meterId or meterName. Meter must be ACTIVE; usage will be rejected for archived meters.

Example: 550e8400-e29b-41d4-a716-446655440000

meterName

string

Meter name. Provide meterId or meterName. Meter must be ACTIVE; usage will be rejected for archived meters.

Example: api_calls

timestamp

string

ISO-8601 timestamp. Defaults to now.

Example: 2024-01-15T10:30:00Z

dimension

string · maxLength: 100

What 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.

Example: seat-4f21

metadata

object

Additional metadata for the usage event (values must be string, number, or boolean)

Example: {"region":"us-east-1","feature":"api-calls"}