Retrieve Billable Services

This endpoint returns a detailed list of available billable services and clients for a given contract and timeframe.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

📘

If the response only returns account data without a billable services or clients array, the contract ID or timeframe submitted may be invalid.

📘

This endpoint is for use by Direct and Indirect customers

This endpoint serves the purpose of retrieving a full list of clients and services relevant to the current contract.

Sample response

{
    "AccountName": "Best MSP",
    "BpAccountId": 123467,
    "Cid": "789012",
    "ContractNumber": "123678-USD-01",
    "ContractStatus": "ACTIVE",
    "Created": "2024-02-09T15:04:06",
    "SfdcAccountId": "001H234578asdfIAS",
    "TimeFrame": 202409,
    "Updated": "2024-11-28T01:25:30",
    "Billable Services": [
        {
            "BillingServiceName": "Cove Data Protection | Additional Capacity",
            "ProductFeatureName": "0100_ADDITIONAL_CAPACITY",
            "Sku": "MSPUK-BU-AC",
            "Uom": "GB"
        },
        {...}
    ],
    "Clients": [
        {
            "ClientId": "",
            "Name": ""
        },
        {...}
    ]
}
Path Params
string
required

Unique identifier for the contract.

string
required

The billing period in YYYYMM format.

string
required

Salesforce account ID for the requesting MSP.

Headers
string

API key retrieved from developer portal. Required for authorisation.

string
required

Identifies the client application making the request. When scripting or calling this API programmatically, specify a custom User-Agent, as default User-Agents (e.g. those set automatically by HTTP libraries or tools like curl) may be blocked for security purposes.

integer
required

The size of the request body, in bytes.

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*/*