CustomCostType

Returns cost categories

This call returns a list of cost categories for a business unit.

Securitybearer
Request
path Parameters
businessUnitId
required
string <uuid>

The business unit id.

query Parameters
includeDeleted
boolean
Default: false

If deleted cost types for the business unit should also be returned

Responses
get/api/v1/businessUnits/{businessUnitId}/costCategories
Request samples
Response samples
application/json
[
  • {
    }
]

Creates cost category

This call creates a cost category on a business unit.

Securitybearer
Request
path Parameters
businessUnitId
required
string <uuid>

The business unit id.

Request Body schema:
required

The cost category to create.

code
required
string non-empty

The cost category (custom-cost-type) code.

description
required
string non-empty

The description.

Responses
post/api/v1/businessUnits/{businessUnitId}/costCategories
Request samples
{
  • "code": "Code1",
  • "description": ""
}
Response samples
application/json
{
  • "id": "e058a64f-df50-4fcf-a88a-027df074d496",
  • "businessUnitId": "8ee17115-1ead-4a47-8f96-4377e505f3cc",
  • "costTypeId": "7f23623b-e127-469d-a613-f9942d24e112",
  • "isDeleted": false,
  • "code": "CostCategory1",
  • "description": "Cost category 1 description"
}