Accounting | Ledger Lines

Search accounting ledger lines.

post/api/Accounting/LedgerLines/Search

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/LedgerLines/Search
  • Auth: API key in header Authorization

Request body

takeinteger

Number of items to return per page. Maximum 1000.

pageinteger

Page (Fetches from [Page * Take] to [(Page + 1) * Take]).

postingIdstring nullable

Filter to lines belonging to a specific posting.

postingDateFromstring date-time nullable

Filter lines whose posting date is on or after this date (inclusive).

postingDateTostring date-time nullable

Filter lines whose posting date is on or before this date (inclusive).

storeIdstring nullable

Filter by store ID. Mutually exclusive with Omnium.Public.Accounting.Models.OmniumAccountingLedgerLineSearchRequest.StoreGroupId.

storeGroupIdstring nullable

Filter to lines from any store in the given store group. The API resolves this to the set of store IDs that belong to the group. Mutually exclusive with Omnium.Public.Accounting.Models.OmniumAccountingLedgerLineSearchRequest.StoreId.

registerIdstring nullable

Filter by register ID.

accountNumberstring nullable

Single account number; takes precedence over AccountNumbers if both are set.

accountNumbersstring[] nullable

Filter to lines on any of the given account numbers.

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.

taxGroupCodestring nullable

Filter by tax-group code.

vatCodestring nullable

Filter by VAT code.

currencyCodestring nullable

Filter by currency code.

source'PosZReport' | 'WebFulfillment'

Discriminator for the source that produced an accounting posting.

includeSupersededboolean

When true, include lines whose parent posting has status Superseded. Default false.

sortBystring nullable

Sort field — "PostingDate" (default), "AccountNumber", or "PostingId".

sortDescendingboolean

When true, sort in descending order.

Response

Search results returned

totalHitsinteger

Total number of hits

scrollIdstring nullable

The Scroll ID is used when fetching large amounts of data. Whenever the search results yields a ContinuationToken, the Scroll endpoints should be used to continue fetching documents

isValidboolean

Deprecated

Changes

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