Views:
Last updated: 12/3/2024 4:10:12 PM
Note
Note
Business role: Distributor (T1), ISP (T1), and MSP (T2)
This API is used to retrieve a customer's summary report.
The Customer Summary Report shows each customer's number of provisioned and used license units for a specific product or service during the report cycle.
To retrieve more information on the transaction record and any license updates, you can use the Report :: Customer :: Transaction API.
Note
Note
Report data is only retained for two years. You cannot retrieve data from earlier than the last two years.

Request

HTTP Request

[POST] /LMPI/v2/reports/summary

Parameters

Request Body

{
    "report_cycle_year":"2018",
    "report_cycle_month":"07",
    "language_code":"ja-JP",
    "partner_id":"1067E742-FA93-4337-8386-CE7701D42B25",
    "product_id":"c6d991c2-1637-4ffc-903c-43cbdc7daa68"
}
Name
Type
Description
Validation
Required Parameters
report_cycle_year
string
The year of the queried report.
Note
Note
You can only retrieve report data from within the last two years.
ISO 8601 standard with format "YYYY"
report_cycle_month
string
The month of the queried report.
ISO 8601 standard with format "MM"
Optional Parameters
partner_id
string
The unique identifier of the partner company.
If no value is provided, the API returns a report of all partners under API caller's company.
GUID format
product_id
string
The unique identifier of the product.
If no value is provided, the API returns a report of all products. Product IDs can be retrieved from the Partners :: Product :: List API.
GUID format
language_code
string
The preferred language code.
Note
Note
If no value is provided, the language code defaults to "en-US."
Valid language code (e.g. en-US)

Response

Response

If successful, this method returns an HTTP 200 OK status code and a response body with the following structure:
{
   "summary": [{
           "customer": "---",
           "city": "US",
           "state": "US",
           "owned_by_vendor": "ODSTestUSMSP01",
           "created_by_vendor": "ODSTestUSMSP01",
           "product_name": "TM-WFBS-Svc-Display-Name",
           "service_plan": "WFBSS-Full",
           "provisioned": 10,
           "unit": "金物",
           "rm_provisioned": 10,
           "rm_unit": "シート"
          }]
}
Name
Type
Description
Length
summary[].customer
string
The name of the customer company.
If the API caller's identity is ISP (T1) or Distributor (T1), but the customer is owned by an MSP (T2), this data is hidden and replaced with ---.
1-128 characters
summary[].city
string
The city where the customer company is located.
1-64 characters
summary[].state
string
The state where the customer company is located.
1-64 characters
summary[].owned_by_vendor
string
The owner of the customer company.
1-128 characters
summary[].created_by_vendor
string
The creator of the customer company.
1-128 characters
summary[].product_name
string
The display name of the product or service.
1-100 characters
summary[].service_plan
string
The display name of the service plan.
1-150 characters
summary[].provisioned
integer
The number of seats provisioned for the license of the product or service.
This field displays only the maximum number of provisioned seats for each customer during the report cycle.
Positive integer
summary[].unit
string
The unit of the license for the product or service.
Common values include:
  • Seats
  • Units
1-100 characters
summary[].rm_provisioned
integer
The number of seats provisioned for the Remote Manager license.
Note
Note
This field is limited to partners in Japan.
Positive integer
summary[].rm_unit
string
The number of units of the Remote Manager service.
Note
Note
This field is limited to partners in Japan.
1-100 characters
summary[].used
integer
The number of provisioned seats used during the report cycle.
This field displays only the maximum number of provisioned seats for each customer during the report cycle.
Note
Note
This field is unsupported in Japan.
Positive integer