Skip to content

List journal entries
Alpha

Request

List the company's journal entries whose business event falls inside a time window. Both ends are required: from is inclusive and to is exclusive.

Security
OAuth2(Required scopes: accounting.read)
Query
fromstring, (date-time)required

Return entries whose business event occurred at or after this time.

tostring, (date-time)required

Return entries whose business event occurred strictly before this time.

kindArray of strings

Restrict the result to entries of these kinds. Omit to return every kind.

sortstring

Field to define the sort order. To indicate sorting direction, fields may be prefixed with + (ascending) or - (descending).

Ensure to URL escape the value as + can otherwise be interpreted as a space.

Only the field occurred_at is supported.

Default:"+occurred_at"
cursorstring

Pagination cursor for fetching the next page of results. Omit or pass an empty string to start from the beginning of the list.

limitinteger, (int32), [ 1 .. 1000 ]

Maximum number of items to return per page. Defaults to 100, maximum 1000.

Default:100
curl -i -X GET \
  'https://api.understory.io/v1/accounting-journal-entries?from=2019-08-24T14%3A15%3A22Z&to=2019-08-24T14%3A15%3A22Z&kind=SALE&sort=%2Boccurred_at&cursor=string&limit=100' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
nextstring

Cursor for the next page of results. An empty string or absent value indicates the end of the list.

itemsArray of any(JournalEntry)

The list of journal entries on the current page.

Response
{
  "next": "string",
  "items": [
    { … }
  ]
}