Views:
Last updated: 12/3/2024 3:52:50 AM
Note
Note
Business role: Distributor (T1), ISP (T1), and MSP (T2)
This API is used to retrieve the details 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
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/v2/reports/billing/details

Parameters

Request Body

{
   "report_id":"c6d991c2-1637-4ffc-903c-XXXXXXXXXXXX",  
   "language_code":"en-US",
   "time_zone":"Pacific Standard Time"
}
Name
Type
Description
Validation
Required Parameters
report_id
string
The unique identifier of the billing report.
You can retrieve this data from the Report :: Billing :: Summary API.
GUID format
Optional Parameters
language_code
string
The preferred language code.
If no value is provided, the language code defaults to "en-US."
Valid language code (e.g. "en-US")
time_zone
string
The preferred time zone.
If no value is provided, the time zone defaults to "UTC."
Valid time zone (e.g. "Pacific Standard Time")

Response

Response

If successful, this method returns an HTTP 200 OK status code and a response body with the following structure:
{  
                "report_id":"c6d991c2-1637-4ffc-903c-XXXXXXXXXXXX",               
                "root_partner_id":"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
                "partner_id":"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
                "partner_company_name":"XXX",
                "start_date":"2017-07-01",
                "end_date":"2017-07-31",
                "report_status":"Rejected",
                "under_review_status":"Automatically submitted without penalty",
                "currency":"N/A",
                "po_number":"N/A",
                "aggregator_name":"N/A"
                "submit_time":"2018-05-28",
            },
   report_details:[
                    {                      
                       "product_display_name":"Worry-Free Business Security",
                       "provisioned_units":"400",
                       "charged_units":"300",
                       "credits":"11400",
                       "used_units":"290",                      
                       "price_type":null,
                       "usage_line_comments":"For some note",
                       "sku":"N/A",
                       "unit_price":"N/A",
                       "total_price":"N/A",
                       "channel_margin":"N/A",
                       "bid_desk_number":"N/A",
                       "violation_rule_list":[
                                               "violation_rule":"The provisioned units should not be 10% higher than the chargeable units.",
                                               "value":10
                                             ],
                                             [
                                                "violation_rule":"The chargeable units for June are 480 lower than the last report cycle.",
                                                "value":480
                                             ],
                                             [
                                                "violation_rule":"You cannot input 0 in Chargeable Units field",
                                                "value":null
                                             ]
                    }
            ]
}
Name
Type
Description
Length
report_id
string
The unique identifier of the billing report.
GUID format
root_partner_id
string
The unique identifier of the upstream partner.
If the API caller is an ISP or Distributor, the value of this field represents the API caller.
GUID format
partner_id
string
The unique identifier of the API caller.
If the API caller is an ISP or Distributor, the value of this field represents the API caller.
GUID format
partner_company_name
string
The display name of the partner company.
1-128 characters
start_date
date
The start date of the billing cycle for the current report.
ISO 8601 standard with format "YYYY-MM-DD"
end_date
date
The end date of the billing cycle for the current report.
ISO 8601 standard with format "YYYY-MM-DD"
report_status
string
The status of the current billing report.
Possible values include:
  • MSP Preparing
  • Under Review
  • Approved
  • Rejected
  • 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.
1-50 characters
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.
1-100 characters
currency
string
The currency code.
Note
Note
This field is limited to EU Distributors, and displays as "N/A" in other regions.
0-3 characters
po_number
string
The usage report PO number, provided by the partner.
Note
Note
This field is limited to EU Distributors, and displays as "N/A" in other regions.
0-50 characters
aggregator_name
string
The name of the broker between the Distributor and the downstream MSP of the Distributor.
Note
Note
This field is limited to EU Distributors, and displays as "N/A" in other regions.
1-150 characters
submit_time
date
The submission date of the usage report.
Note
Note
The value of this field varies based on the time zone specified in the API request.
ISO 8601 standard with format "YYYY-MM-DD"
report_details Array
details[].product_display_name
string
The display name of the product or service.
Note
Note
The value of this field varies based on the time zone specified in the API request.
1-150 characters
details[].provisioned_units
integer
The number of seats provisioned for the licenses of the product or service.
Positive integer
details[].charged_units
integer
The number of seats charged for during the current billing cycle.
Positive integer
details[].credits
integer
The number of credits charged during the current billing cycle.
Positive integer (null for undefined products)
details[].used_units
integer
The number of provisioned seats used during the current billing cycle.
Positive integer
details[].price_type
string
The unit of the product or service.
Note
Note
The value of this field varies based on the time zone specified in the API request.
1-33 characters
details[].usage_line_comments
string
Any comments on each usage report, provided by the ISP or MSP.
0-255 characters
details[].billing_line_comments
string
Any comments on each usage report, provided by the Distributor.
Note
Note
This field is under development, and currently returns an empty string.
0-255 characters
details[].sku
string
The Stock Keeping Unit (SKU) of the Trend Micro product with the service identification code and price.
Note
Note
This field is limited to EU Distributors, and displays as "N/A" in other regions.
0-10 characters
details[].unit_price
string
The unit price of the product or service specified in the current billing report.
Note
Note
This field is limited to EU Distributors, and displays as "N/A" in other regions.
Price (rounded to 2 decimal places)
details[].total_price
integer
The total price of the product or service specified in the current billing report.
Note
Note
This field is limited to EU Distributors, and displays as "N/A" in other regions.
Price (rounded to 2 decimal places)
details[].channel_margin
integer
The discount on the product or service specified in the current billing report.
Note
Note
This field is limited to EU Distributors, and displays as "N/A" in other regions.
Price (rounded to 2 decimal places)
details[].bid_desk_number
string
The Bid Desk Number for the product or service.
The Distributor can input a valid Bid Desk Number to obtain a special discount on a license.
Note
Note
This field is limited to EU Distributors, and displays as "N/A" in other regions.
0-20 characters
violation_rule_list Array
details[].violation_rule_list[].violation_rule
string
The reason for the rule violation, if the usage report violates an existing rule.
Possible violations include:
  • Provisioned units exceed chargeable units by a percentage greater than or equal to the threshold specified in the details[].violation_rule_list[].value field below.
  • The chargeable units for the specified month are fewer than the previous report cycle, with a difference greater than or equal to the previous number of chargeable units specified in the details[].violation_rule_list[].value field below.
  • The value of the chargeable units field is "0."
1-255 characters
details[].violation_rule_list[].value
string
The degree of rule violation, if the usage report violates an existing rule.
Possible violation threshold types include:
  • The percentage by which provisioned units exceed chargeable units.
  • The difference between chargeable units for the specified month and chargeable units in the previous report cycle.
Positive integer