v1

latestOpenAPI 3.0.0Apache License Version 2.02026-07-24163274903.6 KB
Category Service

getCategoriesByPage

Retrieve a list of Categories by page number

get/category/v1/getCategoriesByPage

Query parameters

categoryNamestring

This is the Category Name in Enterprise Manager. Use 3 or more characters.

glDescriptionstring

This is General Ledger Description. Use 3 or more characters.

glNumberstring

This is General Ledger Number.

includeNullboolean

Specify 'true' to output null data elements.

microcategoryNamestring

This is Micro Category Name associated with the Sub Category. Use 3 or more characters.

minutesSinceUpdateinteger

The number of minutes since a category record was last updated. Use to set how far back to search.

pageNumberinteger

Provide the page number to retrieve Application Users on a particular page. Default is 1 when no 'pageNumber' value provided.

pageSizeinteger

pageSize

subcategoryNamestring

This is Sub Category Name associated with the Category. Use 3 or more characters.

Headers

authenticationtokenstring required

Secure token for API authentication.

passwordstring required

Password for the Crunchtime Application User.

sitenamestring required

Crunchtime site identifier. (test or production)

useridstring required

User ID for the Crunchtime Application User.

X-B3-TraceIdstring

Optional trace identifier for troubleshooting.

Response

Success

hasNextboolean

has Next

totalPagesinteger

Total Pages

Example response

{
  "categoryDetails": [
    {
      "categoryDetailDetails": [
        {
          "categoryName": "CTEST-CAT",
          "glDescription": "test GL",
          "microcategoryName": "CTEST-MICRO",
          "subcategoryName": "CTEST-SUB"
        }
      ]
    }
  ],
  "hasNext": true,
  "totalPages": 10
}