Views:
Last updated: 12/3/2024 3:41:11 PM
Note
Note
Business role: Distributor (T1), ISP (T1), and MSP (T2)
This API is used to retrieve summary data of a billing report.
Billing report APIs are only available to the following business roles:
  • ISP (Internet Service Provider)
  • Distributor
  • MSP (Managed Service Provider), under Distributor only
You can retrieve details of each billing report from the Report :: Billing :: Details API.
Note
Note
Billing report data is only retained for two years. The API cannot retrieve data from earlier than the last two years.

Request

HTTP Request

[POST] /LMPI/v3/reports/billing

Parameters

Request Body

{
   "report_cycle_year":"2018",
   "report_cycle_month":"08",
   "report_status":["0","1"]
}
Name
Type
Description
Validation
Optional 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"
report_status
integer array
The status of the queried report.
If no value is provided, the API returns report data for all statuses.
Possible values include:
  • 0: MSP Preparing
  • 1: Under Review
  • 2: Approved
  • 3: Rejected
  • 4: Completed
The descriptions of each status (with the MSP) are as follows:
  • MSP Preparing: The report is being edited by the MSP and waiting for submission.
  • Under Review: The MSP submitted the usage report to an upstream ISP or Distributor, and the report is being reviewed.
  • Approved: The ISP/Distributor approved the usage report from the MSP and submitted report to Trend Micro.
  • Rejected: The ISP/Distributor rejected the usage report from the MSP.
  • Completed: All processes are complete.
The descriptions of each status (without an MSP) are as follows:
  • MSP Preparing: The report is being edited by the ISP/Distributor and waiting for submission.
  • Under Review: The ISP/Distributor submitted the usage report to upstream Trend Micro, and the report is being reviewed.
  • Approved: Trend Micro approved the usage report from the ISP/Distributor.
  • Rejected: Trend Micro rejected the usage report from the ISP/Distributor.
  • Completed: All processes are complete.
Positive integer

Response

Response

If successful, this method returns an HTTP 200 OK status code and a response body with the following structure:
{ 
  "reports":[
              {
                "id": "b82c2bdf-7f34-43d7-90ee-4d6b20cXXXXX",
                "partner_company_name": "XXRTEXX",
                "start_date": "2018-08-01",
                "end_date": "2018-08-31",
                "status": "Msp Preparing",
                "under_review_status": null
              },
              {
                "id":"93493856-53f2-4609-a7a1-ea75663XXXXX",
                "partner_company_name":"XXXdtXXX XXXsultXXX",
                "start_date":"2018-08-01",
                "end_date":"2018-08-31",
                "status":"Under Review",
                "under_review_status":"Manually submitted by MSP"                                       
              }
            ]
}
Name
Type
Description
Length
reports[].id
string
The unique identifier of the current report.
GUID format
reports[].partner_company_name
string
This display name of the partner company.
1-128 characters
reports[].start_date
date
The start date of the billing cycle for the current report.
ISO 8601 standard with format "YYYY-MM-DD"
reports[].end_date
date
The end date of the billing cycle for the current report.
ISO 8601 standard with format "YYYY-MM-DD"
reports[].status
string
The status of the current report.
Possible values include:
  • MSP Preparing
  • Under Review
  • Approved
  • Rejected
  • Completed
Note
Note
See report_status in the API request parameters for descriptions of each status with and without an MSP.
8-13 characters
reports[].under_review_status
string
The handling method of a report with "Under Review" status.
Note
Note
This field is limited to Distributor roles.
Possible values include:
  • Automatically submitted with penalty
  • Automatically submitted without penalty
  • Manually submitted by MSP
  • Rejected by Trend
The descriptions of each method are as follows:
  • Automatically submitted with penalty: The usage report was submitted automatically by Trend Micro, but contains violation without explanatory comment.
  • Automatically submitted without penalty: The usage report was submitted automatically by Trend Micro, and contains violation with explanatory comment.
  • Manually submitted by MSP: The usage report was submitted manually by the MSP, ISP, or Distributor.
  • Rejected by Trend: The usage report was rejected by Trend Micro after review.
For billing reports with a status other than "Under Review," you can leave this field empty.
17-39 characters