iotoms Docs

List journal entries

GET
/api/v1/accounting/journal-entries

Returns journal entries filtered by status, dateFrom/dateTo, accountId and sourceSystem. Paginated with 0-based page and size (default 20).

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Query Parameters

status?string

Only entries in this state: DRAFT, POSTED or REVERSED.

Value in"DRAFT""POSTED""REVERSED"
dateFrom?string

Only entries with an effective date on or after this date (YYYY-MM-DD).

Formatdate
dateTo?string

Only entries with an effective date on or before this date (YYYY-MM-DD).

Formatdate
accountId?string

Only entries with at least one line on this ledger account, from List ledger accounts.

Formatuuid
sourceSystem?string

Only entries from this source system, for example MANUAL.

page?integer

Page number, starting at 0. See Paging.

Formatint32
Default0
size?integer

Number of records per page.

Formatint32
Default20

Header Parameters

X-TenantID*string

Your merchant's tenant code — the value typed in the Domain field on the iotoms login screen. See Concepts.

Response Body

OK

*/*
  1. response
status*string

Outcome of the call: SUCCESS when it worked, ERROR when it failed.

message*string

Short human-readable message describing the outcome, for example "Vendor created". Do not parse it.

data?

One page of journal entries plus paging totals.

Example Request
curl -X GET 'https://beta.iotoms.com/api/v1/accounting/journal-entries' \  -H 'X-TenantID: your-tenant-code'
Example Response
{  "status": "string",  "message": "string",  "data": {    "content": [      {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "externalId": "string",        "sourceSystem": "string",        "eventType": "string",        "effectiveAt": "2019-08-24",        "postedAt": "2019-08-24T14:15:22Z",        "periodId": "7cc85576-6d6b-4609-a8e6-020187b27a09",        "status": "DRAFT",        "currency": "string",        "memo": "string",        "reversalOfId": "91205805-6131-4e22-87c1-99e3bbb30d9b",        "correlationId": "string",        "metadata": "string",        "createdAt": "2019-08-24T14:15:22Z",        "lines": [          {            "id": 0,            "accountId": "3d07c219-0a88-45be-9cfc-91e9d095a1e9",            "accountCode": "string",            "accountName": "string",            "direction": "DEBIT",            "amountMinor": 0,            "currency": "string"          }        ]      }    ],    "page": 0,    "size": 0,    "totalElements": 0,    "totalPages": 0  }}