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 transaction report.
The Customer Transaction Report shows all transaction information of the specified customer for a specified product or service.
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/v3/reports/transactions

Parameters

Request Body

{  
  "transaction_type":"New Purchase",
  "report_cycle_year":"2018",
  "report_cycle_month":"07",
  "product_id":"3e80d3c6-9cb4-4d73-90a9-e4e04c298797",
  "language_code":"en-US",
  "time_zone":"Pacific Standard Time"
}
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
transaction_type
string
The type of transaction.
If no value is provided, the API returns all transaction types.
Possible values include:
  • New Purchase
  • License Change
  • License Convert
12-15 characters
product_id
string
The unique identifier of the product.
If no value is provided, the API returns transaction data of all products.
Note
Note
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)
time_zone
string
The preferred time zone.
Note
Note
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:
{
  "transaction":[{
       "type":"New Purchase",
       "vendor_company_name":"ODSTestUSMSP01",
       "created_by":"ODSTestUSMSP01",
       "customer_company":"---",
       "product_name":"HES-Trend",
       "version":"Full",
       "previous_units_allocated":"0",
       "units_allocated":"10",
       "change_units":"10",
       "unit":"unit(s)",
       "previous_start_charge _date":"",
       "new_start_charge_date":"2016-11-09",
       "previous_license_period":"",
       "new_license_period":"2016-11-09~2016-12-08",
       "license_period_change_months":"10",
       "validity":"True",
       "date":"2016-11-09 11:35:32 PM",
       "user_role":"Super admin"
     }]
}
Name
Type
Description
Length
transaction[].type
string
The transaction type.
Possible values include:
  • New Purchase
  • License Change
  • License Convert
12-15 characters
transaction[].vendor_company_name
string
The name of the vendor company in the transaction.
1-128 characters
transaction[].created_by
string
The creator of the specified transaction record.
1-128 characters
transaction[].customer_company
string
The name of the customer company in the transaction.
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
transaction[].product_name
string
The display name of the product or service.
1-100 characters
transaction[].version
string
The license type of the transaction.
Possible values include:
  • Trial
  • Full
4-5 characters
transaction[].previous_units_allocated
integer
The number of seats provisioned for the license in the previous report cycle.
Positive integer
transaction[].units_allocated
integer
The number of provisioned seats actually used during the current report cycle.
Positive integer
transaction[].change_units
integer
The change in the number of provisioned seats for the license from the previous report cycle to the current cycle.
If number of seats is unchanged, this value defaults to 0.
Positive integer
transaction[].unit
string
The unit of the license for the product or service.
Common values include:
  • Seats
  • Units
1-100 characters
transaction[].previous_start_charge_date
date
The charge date of the previous report cycle of the license.
If no value is provided, this value defaults to ~.
ISO 8601 standard with format "YYYY-MM-DD"
transaction[].new_start_charge_date
date
The new charge date of the current report cycle of the license.
ISO 8601 standard with format "YYYY-MM-DD"
transaction[].previous_license_period
string
The previous license period as of the specified month of the report.
If no value is provided, this value defaults to ~.
1-21 characters
transaction[].new_license_period
string
The new license period as of the specified month of the report.
1-21 characters
transaction[].license_period_change_months
integer
The change in the license period as of the specified month of the report.
If the duration of the license period is unchanged, this value defaults to 0.
Positive integer
transaction[].validity
boolean
The validity status of the license activation code.
Possible values include:
  • true: The activation code is valid
  • false: The activation code is invalid
true/false
transaction[].date
date
The exact date and time of the specified transaction record execution.
ISO 8601 standard with format "YYYY-MM-DD"
transaction[].user_role
string
The role of the creator of the specified transaction record, defined by Licensing Management Platform.
If the queried transaction is executed by Licensing Management Platform or an integrated system, the value of the field is System.
6-24 characters