Retrieve billable services

Response structure

Parameter	Description	Supported values
PSA Billable services	A group pf parameters related to the PSA Billing services	PSA Billable services (has child objects of its own see the PSA Billable services child objects table below)

PSA Billable Services child objects

Parameter	Description	Supported values
AccountName	The name of the account	<std::string>
BpAccountId	The unique identifier for the Bp Account	<int> Integer
Cid	CID, part of the contract number	<int> Integer
ContractNumber	The number of the contract	<std::string>
ContractStatus	The status of the contract	<std::string>
Created	Record creation date	<datetime>
SfdcAccountId	Salesforce Account ID for the requesting MSP	<std::string>
TenantId	The ID of the tenant	<int> Integer
TimeFrame	The billing period in YYYYMM format	<std::string>
Updated	Last update date	<datetime>
BillingServiceName	The name of the Billing service	Billing Services (has child objects of its own see the Billing services child objects table below)

Billing services child objects

Parameter	Description	Supported values
ProductFeatureName	The feature name of the product	<std::string>
Sku	Stock keeping unit	<std::string>
Uom	Units of measurement	<std::string>
Clients	The client parameters	Clients (has child objects of its own see the Clients child objects table below)

Clients child objects

Parameter	Description	Supported values
ClientId	The unique identifier for the client	<int> Integer
Name	The name of the client	<std::string>

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": ""
        },
        {...}
    ]
}

Possible errors

{
    "message": "Unauthorized",
    "http_status_code": 401
}

🚧
The above error is 401 unauthorized: Check that you have entered your MSPID and API key correctly.

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