Category Service
getAllCategories
Retrieve a list of Categories
get/category/v1/getAllCategories
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.
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
Example response
[
{
"categoryDetailDetails": [
{
"categoryName": "CTEST-CAT",
"glDescription": "test GL",
"microcategoryName": "CTEST-MICRO",
"subcategoryName": "CTEST-SUB"
}
]
}
]