Get compactions filtered and paged

Post

/api/v1/finance/compactions/filter

Get a paged list of existing compactions, optionally filtered to the given parameters.

Get Compactions Filtered and Paged (POST)

Retrieves a paged, optionally filtered list of existing compactions.

A developer calls this endpoint to search for compactions matching one or more criteria (for example by code or name), or to retrieve the full set of compactions in manageable pages when no filter is needed, such as building the full reporting hierarchy that ledger accounts are grouped into.

Request Fields

Field	Type	Required	Description
paging.pageSize	integer, 1 to 1000, nullable	Optional	The maximum number of results to return per page. Defaults to 100 when not given.
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.
sorting.order	integer (enum), nullable	Optional	The sort direction applied to columnName. Allowed values: 0 = Ascending, 1 = Descending.
filter.code	string, nullable	Optional	Filters on the compaction's internal identifier (code).
filter.name	string, nullable	Optional	Filters on the compaction's name.
filter.lastModified.from	string (date-time), nullable	Optional	Inclusive lower bound for filtering on when the compaction 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 compaction was last modified, formatted as ISO 8601. If omitted, there is no upper bound.

Response Fields

Field	Type	Required	Description
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.
compactions	array of objects, nullable	Optional	The list of compactions matching the filter for this page. See sub-fields below.
compactions.code	string, nullable	Optional	The internal identifier (code) of the compaction.
compactions.name	string, nullable	Optional	The name of the compaction.
compactions.lastModified	string (date-time)	Optional	The date and time the compaction was last modified, formatted as ISO 8601.

Security

Body parameters

Expand All

object

paging

object (PagingInfo)

pageSize

integer (int32) | null

Minimum1

Maximum1000

pageNumber

integer (int32) | null

Minimum1

Maximum9999

sorting

object (SortingInfo)

columnName

string | null

order

integer (int32)

Ascending = 0 Descending = 1

filter

object (CompactionSearchRequestFilter)

code

string | null

name

string | null

lastModified

object (CompareFilterModelDateTime)

from

string (date-time) | null

Responses

200

Expand All

object

paging

object (PagingInfo)

pageSize

integer (int32) | null

Minimum1

Maximum1000

pageNumber

integer (int32) | null

Minimum1

Maximum9999

sorting

object (SortingInfo)

columnName

string | null

order

integer (int32)

Ascending = 0 Descending = 1

compactions

Array of object (CompactionSearchResultFilter) | null

object

code

string | null

name

string | null

lastModified

string (date-time)