Accounting | Ledger Lines

Get a single ledger line by ID. The posting ID is required because ledger lines are partitioned by posting in storage.

get/api/Accounting/Postings/{postingId}/Lines/{id}

Request

  • Base URL: https://api.omnium.no (the document declares no server; this is the origin it was published from)
  • URL: https://api.omnium.no/api/Accounting/Postings/{postingId}/Lines/{id}
  • Auth: API key in header Authorization

Path parameters

postingIdstring nullable required

ID of the parent posting

idstring nullable required

Ledger line ID

Response

Ledger line found and returned

idstring nullable

Unique ledger line ID. Set by Omnium.

postingIdstring nullable

ID of the parent posting this line belongs to.

lineSequenceinteger

Order within the parent posting. Stable; used for sorting and hash determinism.

postingDatestring date-time nullable

Accounting period date, denormalised from the parent posting.

registerIdstring nullable

Register that produced this line, when applicable (POS).

storeIdstring nullable

Store this line is booked to.

accountingCompanyCodestring nullable

Accounting company code (when configured per store/market).

accountNumberstring nullable

Account number this entry is booked to.

accountNamestring nullable

Human-readable account name.

category'Sales' | 'OutputVat' | 'PaymentMethod' | 'Shipping' | 'Discount' | 'Rounding' | 'RefundPaymentMethod' | 'InternalTransferOut' | 'InternalTransferIn' | 'Receivable' | 'GiftCardLiability' | 'PaymentProviderFee' | 'Other' | 'CashFloat' | 'CashInTransit' | 'OverShort' | 'Tip' | 'DepositLiability'

Category classifying what kind of accounting entry a ledger line represents.

debitnumber

Debit amount in posting currency.

creditnumber

Credit amount in posting currency.

currencyCodestring nullable

ISO currency code for the amount (e.g. NOK, SEK, EUR).

vatCodestring nullable

VAT code (when applicable, on VAT-related lines).

vatRatenumber nullable

VAT rate as a percentage (e.g. 25 for 25%).

vatAmountnumber nullable

VAT amount in posting currency.

taxGroupCodestring nullable

Tax-group code (from line-level snapshot).

descriptionstring nullable

Free-text description for the line.

customerNumberstring nullable

Customer number (when applicable, e.g. for receivables).

invoiceNumberstring nullable

Invoice number (when applicable).

creditNoteNumberstring nullable

Credit note number (when applicable).

invoiceDatestring date-time nullable

Invoice date (when applicable).

dueDatestring date-time nullable

Due date (when applicable).

kidNumberstring nullable

KID / payment-reference number (when applicable).

dimensionsobject nullable

Free-form dimensions / cost centres carried on the line.

Changes

No recorded changes to this operation across all 1 revision of this API.