Retrieves charge split settings for a specific vendor
Use this endpoint to view the charge split cost categories configured for a specific vendor.
Vendor-level settings apply to all accounts under that vendor unless an account-level override exists.
Returns null/empty if no vendor-level rule has been configured.
Request Headers
| Header | Value | Required | Description |
|---|---|---|---|
| ECI-ApiKey | string | Yes | Your API key. See Authentication. |
| Content-Type | application/json | Yes | All requests must specify JSON content type. |
Path Parameters
| Name | Description | Type | Required |
|---|---|---|---|
| vendorId | The unique numeric identifier of the vendor whose charge split settings are being retrieved | integer (int32) | Required |
Responses
200
OK
The request succeeded and the response body contains the requested data.
Response Body Parameters
VendorBillAccountChargeSplitSettingsResponse
| Property | Description | Type | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| costCategories | Split account charges with a bill line type assigned the cost categories | CostCategoryResponseV202405[] | |||||||||
|
CostCategoryResponseV202405 properties
|
|||||||||||
| vendorCode | The vendor code that the caption maps to | string | |||||||||
| vendorId | The vendor identifier | integer (int32) | |||||||||
| vendorInfo | The vendor info that the caption maps to | string | |||||||||
Example Response
{ "costCategories": [
{ "costCategoryId": 1, "costCategoryInfo": "string"
}
], "vendorCode": "string", "vendorId": 1, "vendorInfo": "string"
}