Get the Account status types configured

GET /cs-close-api/account-categories

This API is a system interface that retrieves account status type configured within the system.

By default, it specifically returns account status types with an 'ACTIVE' status, but this behavior can be modified using the status parameter, which accepts values from an enumeration ('ENUM') including 'ACTIVE,' 'INACTIVE,' and 'DISABLED'.

Query parameters

  • page integer(int32)

    The page define the current page number. It should be positive integer number and should start with minimum value 1.

    Minimum value is 1.

  • size integer(int32)

    The size define number of records on each page. It should be positive integer number between 1 to 10000.

    Minimum value is 1, maximum value is 10000.

  • sort array[string]

    The sort parameter accepts an array of strings, allowing for multiple sorting criteria. By default, sorting order is ascending.

  • name string

    The name parameter is an optional filter that allows you to narrow down the results based on specific name content.

  • status string

    The status to include, by default only ACTIVE sytem values are included.

Responses

  • 200 application/json

    OK

    Hide response attributes Show response attributes object
    • result array[object]
      Hide result attributes Show result attributes object
    • metadata object

      Paging metadata dto.

      Hide metadata attributes Show metadata attributes object
      • totalElements integer(int64)

        The total number of rows in the result set.

      • totalPages integer(int32)

        The total number of pages in the result set, should = totalElements / size

      • first boolean

        True if this is the first page.

      • last boolean

        True if this is the last page.

      • empty boolean

        True if the result is empty.

      • numberOfElements integer(int32)

        The number of results in this page. Will be <= size.

      • size integer(int32)

        The page size.

      • sorted boolean

        True if the results are sorted.
GET /cs-close-api/account-categories 
curl \
 --request GET 'http://close-service:8082/cs-close-api/account-categories'
Response examples (200) 
{
  "result": [
    {
      "id": 42,
      "systemValueGroupId": 42,
      "name": "string",
      "shortName": "string",
      "exportValue": "string",
      "order": 42,
      "status": "ACTIVE"
    }
  ],
  "metadata": {
    "totalElements": 42,
    "totalPages": 42,
    "first": true,
    "last": true,
    "empty": true,
    "numberOfElements": 42,
    "size": 42,
    "sorted": true
  }
}