Allows you to categorize based on business requirements and get a contextual view of your expenses.
Fetch details of a Cost category for the given Cost category ID.
Bad Request
Internal server error
Returns a Cost category object with all the cost and shared buckets, returns null if no Cost category exists for that particular identifier
{- "status": "SUCCESS",
- "code": "DEFAULT_ERROR_CODE",
- "message": "string",
- "correlationId": "string",
- "errors": [
- {
- "fieldId": "string",
- "error": "string"
}
]
}
Delete a Cost category for the given Cost category ID.
Bad Request
Internal server error
A string text message whether the delete was successful or not. If the cost category is used in the perspective, the deletion will fail and it will send you the IDs of all the linked perspectives
{- "status": "SUCCESS",
- "code": "DEFAULT_ERROR_CODE",
- "message": "string",
- "correlationId": "string",
- "errors": [
- {
- "fieldId": "string",
- "error": "string"
}
]
}
Return details of all the Cost categories for the given account ID.
Bad Request
Internal server error
Returns a List of Cost Categories
{- "status": "SUCCESS",
- "code": "DEFAULT_ERROR_CODE",
- "message": "string",
- "correlationId": "string",
- "errors": [
- {
- "fieldId": "string",
- "error": "string"
}
]
}
Update a Cost category. It accepts a BusinessMapping object and upserts it using the uuid mentioned in the definition.
Bad Request
Internal server error
Successfully updated the Business Mapping
{- "uuid": "string",
- "name": "string",
- "accountId": "string",
- "costTargets": [
- {
- "name": "string",
- "rules": [
- {
- "viewConditions": [
- {
- "type": "string"
}
]
}
]
}
], - "sharedCosts": [
- {
- "name": "string",
- "rules": [
- {
- "viewConditions": [
- {
- "type": "string"
}
]
}
], - "strategy": "EQUAL",
- "splits": [
- {
- "costTargetName": "string",
- "percentageContribution": 0
}
]
}
], - "unallocatedCost": {
- "strategy": "DISPLAY_NAME",
- "label": "string",
- "sharingStrategy": "EQUAL",
- "splits": [
- {
- "costTargetName": "string",
- "percentageContribution": 0
}
]
}, - "dataSources": [
- "CLUSTER"
], - "createdAt": 0,
- "lastUpdatedAt": 0,
- "createdBy": {
- "uuid": "string",
- "name": "string",
- "email": "string",
- "externalUserId": "string"
}, - "lastUpdatedBy": {
- "uuid": "string",
- "name": "string",
- "email": "string",
- "externalUserId": "string"
}
}
{- "status": "SUCCESS",
- "code": "DEFAULT_ERROR_CODE",
- "message": "string",
- "correlationId": "string",
- "errors": [
- {
- "fieldId": "string",
- "error": "string"
}
]
}
Create Cost category that allows you to categorize based on business requirements and get a contextual view of your expenses
Bad Request
Internal server error
Returns a created Cost category object with all the cost and shared buckets
{- "uuid": "string",
- "name": "string",
- "accountId": "string",
- "costTargets": [
- {
- "name": "string",
- "rules": [
- {
- "viewConditions": [
- {
- "type": "string"
}
]
}
]
}
], - "sharedCosts": [
- {
- "name": "string",
- "rules": [
- {
- "viewConditions": [
- {
- "type": "string"
}
]
}
], - "strategy": "EQUAL",
- "splits": [
- {
- "costTargetName": "string",
- "percentageContribution": 0
}
]
}
], - "unallocatedCost": {
- "strategy": "DISPLAY_NAME",
- "label": "string",
- "sharingStrategy": "EQUAL",
- "splits": [
- {
- "costTargetName": "string",
- "percentageContribution": 0
}
]
}, - "dataSources": [
- "CLUSTER"
], - "createdAt": 0,
- "lastUpdatedAt": 0,
- "createdBy": {
- "uuid": "string",
- "name": "string",
- "email": "string",
- "externalUserId": "string"
}, - "lastUpdatedBy": {
- "uuid": "string",
- "name": "string",
- "email": "string",
- "externalUserId": "string"
}
}
{- "status": "SUCCESS",
- "code": "DEFAULT_ERROR_CODE",
- "message": "string",
- "correlationId": "string",
- "errors": [
- {
- "fieldId": "string",
- "error": "string"
}
]
}