Cost Centres
Retrieve available cost centre definitions. Cost centres are used for financial tracking and reporting on charges.
Endpoints Overview
| Method | Endpoint | Description |
|---|---|---|
GET |
/v1/cost-centres |
Get a page of cost centres |
Get Cost Centres Page
Retrieve a paginated list of cost centres.
Endpoint: GET /v1/cost-centres
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
PageIndex |
integer | No | Page number (default: 1) |
PageSize |
integer | No | Items per page (default: 25, max: 500) |
SearchText |
string | No | Filter by cost centre name or code |
Request Example
curl -X GET "https://api.consignlyhq.com/v1/cost-centres?PageIndex=1&PageSize=50" \
-H "Authorization: Bearer ACCESS_TOKEN"
Response Example
{
"index": 1,
"total": 8,
"costCentres": [
{
"id": "550e8400-e29b-41d4-a716-446655449100",
"code": "WH-AKL",
"name": "Warehouse Auckland"
},
{
"id": "550e8400-e29b-41d4-a716-446655449101",
"code": "WH-WLG",
"name": "Warehouse Wellington"
},
{
"id": "550e8400-e29b-41d4-a716-446655449102",
"code": "TRANSPORT",
"name": "Transport Division"
}
]
}
Response Fields
| Field | Type | Description |
|---|---|---|
id |
uuid | Cost centre ID |
code |
string | Cost centre code |
name |
string | Cost centre name |
Using Cost Centre IDs
Cost centre IDs are used when creating adhoc charges:
{
"particulars": "Special handling fee",
"costCentreId": "550e8400-e29b-41d4-a716-446655449100",
"chargeApplication": 2,
"chargeRateExclTax": 45.00,
"taxRateId": "..."
}
Related Endpoints
- Consignment Charges - Create charges with cost centres
- Revenue Accounts - Revenue account lookup