Get journal posts filtered and paged

paging.pageSize

integer, 1 to 1000, nullable

Optional

The maximum number of results to return per page. Defaults to 100 when not given. If more results exist than the given pageSize, the remainder are dropped from that page, based on reference.

paging.pageNumber

integer, 1 to 9999, nullable

Optional

The page number to retrieve.

sorting.columnName

string, nullable

Optional

The data field to sort results by, for example "financialYear".

sorting.order

integer (enum), nullable

Optional

The sort direction applied to columnName. Allowed values: 0 = Ascending, 1 = Descending.

filter.reference

string, nullable

Optional

Filters on the journal post's internal identifier (Reference/Code).

filter.ownerReference

string, nullable

Optional

Filters on the owner whose financial administration the journal post belongs to.

filter.journalCode

string, nullable

Optional

Filters on the code of the journal the entry is recorded in, indicating the category or type of transaction.

filter.outputAllWorkflowStates

boolean

Optional

When true, includes journal posts across all workflowState values in the result.

filter.financialYear

integer, nullable

Optional

Filters on the financial year the journal post belongs to.

filter.financialPeriodIndex

integer, nullable

Optional

Filters on the financial period the transaction is recorded in.

filter.createdAt.from

string (date-time), nullable

Optional

Inclusive lower bound for filtering on the journal post's creation date, formatted as ISO 8601. If omitted, there is no lower bound.

filter.createdAt.to

string (date-time), nullable

Optional

Inclusive upper bound for filtering on the journal post's creation date, formatted as ISO 8601. If omitted, there is no upper bound.

filter.lastModified.from

string (date-time), nullable

Optional

Inclusive lower bound for filtering on when the journal post was last modified, formatted as ISO 8601. If omitted, there is no lower bound.

filter.lastModified.to

string (date-time), nullable

Optional

Inclusive upper bound for filtering on when the journal post was last modified, formatted as ISO 8601. If omitted, there is no upper bound.

paging.pageSize

integer, 1 to 1000, nullable

Optional

The page size used to produce this result set.

paging.pageNumber

integer, 1 to 9999, nullable

Optional

The page number returned in this result set.

sorting.columnName

string, nullable

Optional

The field the results are sorted by.

sorting.order

integer (enum), nullable

Optional

The sort direction applied. Allowed values: 0 = Ascending, 1 = Descending.

journalPosts

array of objects, nullable

Optional

The list of journal posts matching the filter for this page. See sub-fields below.

journalPosts.reference

string, nullable

Optional

The internal identifier (Reference/Code) of the journal post. This reference can be used to retrieve further detail via Get a Journal Post.

journalPosts.ownerReference

string, nullable

Optional

The internal identifier of the owner whose financial administration the journal post belongs to.

journalPosts.journalCode

string, nullable

Optional

The code of the journal this entry is recorded in.

journalPosts.workflowState

integer (enum)

Optional

The workflow state of this journal post. See Get a Journal Post for the meaning of each value.

journalPosts.financialYear

integer

Optional

The financial year this journal post belongs to.

journalPosts.financialPeriodIndex

integer

Optional

The financial period this journal post is recorded in.

journalPosts.createdAt

string (date-time)

Optional

The date and time this journal post was created, formatted as ISO 8601.

journalPosts.lastModified

string (date-time)

Optional

The date and time this journal post was last modified, formatted as ISO 8601.