API Reference

List journals

get
https://api.smoothpos.net/journals.json

Returns your journals with their entries, 50 at a time by default. Page through them with the X-Next-Page header.

Heads up: this is a GET request, but it changes data. Don't call it just to look something up, and keep it away from link prefetchers and caches.

Required permission (any one of these):

GroupPermission
FinanceList and view journals
FinanceCreate and reverse journals (includes view)
Query Params
integer
1 to 250
Defaults to 50

How many records to return per page. Defaults to 50, maximum 250.

string

Opaque paging cursor. Don't build this yourself: follow the path in the X-Next-Page or X-Prev-Page response header.

integer

Only return journals with an ID greater than or equal to this one. Note that this one is inclusive: the record with this ID is returned too.

string

Comma-separated list of journal IDs to fetch, e.g. 48612,48613.

date-time

Only return journals dated on or after this date (ISO 8601).

string

Only return journals with this tag. If nothing matches you get a 404 no journals found instead of an empty array.

string

Partial match on name; Partial match on name; Partial match on name; Partial match on name.

string

Comma-separated list matched against number; Comma-separated list matched against number; Comma-separated list matched against number; Comma-separated list matched against number.

string

From (including) the number; From (including) the number; From (including) the number; From (including) the number.

string

Less than (not including) the number; Less than (not including) the number; Less than (not including) the number; Less than (not including) the number.

date-time

Less than (not including) the date; Less than (not including) the date; Less than (not including) the date; Less than (not including) the date.

string

Comma-separated list matched against account_id; Comma-separated list matched against account_id.

string

Exact match on account_id; Exact match on account_id.

string

Comma-separated list matched against cost_centre_id; Comma-separated list matched against cost_centre_id.

string

Tagged tags; tagged tags.

date-time

From (including) the amount; From (including) the amount.

date-time

Up to (including) the amount; Up to (including) the amount.

string

Exact match on reversed; Exact match on reversed.

Responses

Updated 8 days ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 8 days ago

Did this page help you?