Get

[POST] .../v1/accountoperationcategory/get

Returns income and expense category information. Use this method to retrieve income or expense categories for payment documents, reporting filters and finance reference lists. The request must provide positive as a filters field to choose income (true) or expense (false) and the response returns paged AccountOperationCategory records with next_offset and total while supporting filters, sort_orders, search, limit and offset. The caller must have account operation category select permission; missing body, missing positive, denied access, invalid filters or sorting and persistent storage errors are returned as HTTP 200 ErrorResult business errors.

Request Parameters

Name Type Required Description
child_count Int64 Optional Number of nested child income or expense categories.
filters Array of Filter Optional Optional filters by fields available for this API method.
limit Int32 Optional Number of result items returned by the request.
offset Int32 Optional Offset from the beginning of the result set.
search String Optional Search by name.
sort_orders Array of AccountOperationCategory_SortOrder Optional Output parameter sorting.

Filterable Fields

Field Type Description
id int Income and expense category IDs.
last_update int
name string
parent_id int Parent group IDs.
positive bool Category type: true - income category, false - expense category. Can be provided through filters.

Sortable Fields

Field
ChildCount
Id
LastUpdate
Name
ParentId
Positive

Request Example

{
  "child_count": 1,
  "filters": [
    {
      "Field": "id",
      "Operator": "Equal",
      "Value": "string"
    }
  ],
  "limit": 1,
  "offset": 1,
  "search": "string",
  "sort_orders": [
    {
      "column": "Id",
      "direction": "ASC"
    }
  ]
}

Response Parameters

Name Type Description
next_offset Int32 Offset for the next data page.
ok Boolean Indicates whether the request completed successfully.
result Array of AccountOperationCategory Result array.
total Int64 Total number of result items.

Response Example

{
  "next_offset": 1,
  "ok": true,
  "result": [
    {
      "child_count": 1,
      "id": 1,
      "last_update": 1,
      "name": "string",
      "parent_id": 1,
      "positive": true
    }
  ],
  "total": 1
}