An Expense Category represents the type of expense that is being reported. Expense categories have no attributes and consist of just their name as a string. They can be changed by Account Administrators.
Fetching a list of Expense Categories
This endpoint returns structured Expense Category objects.
As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results array
and will be indexed by ID in the expense_categories top-level JSON key.
Please see our Response Format section for more information.
query Parameters
- curl
- Ruby
- JavaScript
- Python
- C#
- Go
- 200
- 400
- 401
- 403
- 404
- 422
- 503
{- "count": 0,
- "meta": {
- "count": 0,
- "page_count": 0,
- "page_number": 0,
- "page_size": 0
}, - "results": [
- {
- "key": "string",
- "id": "string"
}
], - "expense_categories": {
- "property1": {
- "deleted_at": "2019-08-24T14:15:22Z",
- "name": "string"
}, - "property2": {
- "deleted_at": "2019-08-24T14:15:22Z",
- "name": "string"
}
}
}Creating a new Expense Category
This endpoint returns structured Expense Category objects.
As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results array
and will be indexed by ID in the expense_categories top-level JSON key.
Please see our Response Format section for more information.
- Payload
- curl
- Ruby
- JavaScript
- Python
- C#
- Go
{- "expense_category": {
- "name": "string"
}
}- 200
- 400
- 401
- 403
- 404
- 422
- 503
{- "count": 0,
- "meta": {
- "count": 0,
- "page_count": 0,
- "page_number": 0,
- "page_size": 0
}, - "results": [
- {
- "key": "string",
- "id": "string"
}
], - "expense_categories": {
- "property1": {
- "deleted_at": "2019-08-24T14:15:22Z",
- "name": "string"
}, - "property2": {
- "deleted_at": "2019-08-24T14:15:22Z",
- "name": "string"
}
}
}Updating an existing Expense Category
This endpoint returns structured Expense Category objects.
As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results array
and will be indexed by ID in the expense_categories top-level JSON key.
Please see our Response Format section for more information.
- Payload
- curl
- Ruby
- JavaScript
- Python
- C#
- Go
{- "expense_category": {
- "name": "string"
}
}- 200
- 400
- 401
- 403
- 404
- 422
- 503
{- "count": 0,
- "meta": {
- "count": 0,
- "page_count": 0,
- "page_number": 0,
- "page_size": 0
}, - "results": [
- {
- "key": "string",
- "id": "string"
}
], - "expense_categories": {
- "property1": {
- "deleted_at": "2019-08-24T14:15:22Z",
- "name": "string"
}, - "property2": {
- "deleted_at": "2019-08-24T14:15:22Z",
- "name": "string"
}
}
}Deleting an existing Expense Category
Deleting an expense category updates the deleted_at attribute to the current time. Deleted
expense categories are not included by default in the index action and can be retrieved by setting
only_active filter as false.
The response will contain no content and an HTTP 204 status code if the request was successful, or a standard Kantata OX error message explaining why the object could not be deleted.
Expense Category has been deleted.
Bad Request
Unauthorized request
Forbidden request
Page Not Found
Unprocessable Entity
Service is unavailable
- curl
- Ruby
- JavaScript
- Python
- C#
- Go
- 400
- 401
- 403
- 404
- 422
- 503
{- "errors": [
- {
- "type": "string",
- "message": "string"
}
]
}