Cost Locations: get cost locations
cost_locations_listRetrieves cost locations for a customer account to identify available cost centres for cost_location fields in posting tools. Read-only; returns up to 1,000 rows.
Instructions
🟢 READ-ONLY: Fetches data. Makes no changes to the accounting records.
get cost locations
Get cost locations for a specified customer account. The response includes the number of returned rows and an array of cost locations data. NOTE: Each request is limited to 1000 cost locations!
Use to list the cost centres available for the cost_location fields on the posting tools.
Endpoint: POST /cost-locations/get
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "cost_locations_list"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| code | No | The code of one specific cost location. If provided, only the cost location with this code will be returned. | |
| limit | No | Set a limit of returned postings. NOTE: the maximum limit is 1000! | |
| offset | No | Set an offset for the returned postings. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| data | No | An array of cost locations data | |
| rows | No | Number of returned rows | |
| message | No | blank | |
| success | Yes | Success boolean |