Retrieve Invoices

This endpoint allows you to fetch available, finalised invoices for a specific timeframe.

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

📘

Depending on the number of active contracts and contract types associated, multiple invoices may be returned in a single response.

📘

This endpoint is for use by Direct customers only

Sample response

The response includes a ContractID for each invoice. This ContractID is essential for further actions, such as retrieving the list of services associated with the invoice and obtaining detailed usage data for individual devices. Use this ID with the relevant endpoints to explore services and usage details tied to the invoice.

{
   "InvoicesReady":[
      {
         "ActivityStartDate":"2024-11-01",
         "InvoiceID":"348888",
         "AccountID":"238888",
         "BillingProfileID":"1234",
         "ApprovalStatus":"APPROVED",
         "FileName":"efile_12351245.csv",
         "EFileID":"12351245",
         "InvoiceDate":"December  01, 2024",
         "Name":"Best MSP",
         "Status":"CLOSED",
         "Contracts":[
            {
               "ContractID":"238877",
               "ContractNumber":"MSP-888878-04",
               "AccountName":"Best MSP",
               "Name":"Cove Data Protection | DPP | MSP | Monthly | Selected Size"
            }
         ]
      }
   ]
}
Path Params
string
required

Salesforce account ID for the requesting MSP. Example: '00v99902zVlGFFIAS'.

string
required

The billing period in YYYYMM format. Example: '202401'.

Headers
string

API key retrieved from developer portal. Required for authorisation.

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
*/*