Request Report Use Cases
The generateRepoertRequest API enables the client to request reports including Wireless Inventory, Rate Plan, Catalog Extract, Upgrade Eligibility, and Order History.
The currentUsageReportRequest API, requests Current Usage information.
Use Cases
Wireless Inventory
Suppose your company administrator would like to request a report that details the Wireless Inventory assets with AT&T. This report provides details about wireless users on a Billing Account Number (BAN) or Foundation Account Number (FAN) level. It includes information about Customer Telephone Numbers (CTNs), Devices, SIM Cards, Rate Plans, and Data Plans. To use the generateReportRequest API to request a Wireless Inventory Report, set ReportType to "wirelessInventory".
Rate Plan Summary
Suppose your company administrator would like to obtain information about Rate Plans including CTNs and average usage. To use the generateReportRequest API to request a Rate Plan Summary Report set ReportType to "ratePlan".
Catalog Extract
Suppose your company administrator would like to request a Catalog of AT&T Products and Services specific to their account. The Catalog Extract Report will include SKUs for Products and Services, and compatibility information about Devices, Accessories, Rate Plans, Data Plans, and Features. To use the generateReportRequest API to request a Catalog Extract Report, set ReportType to "catalogExtract".
Upgrade Eligibility
Suppose your company administrator would like to obtain a report that shows which Devices, under a specific Billing Account Number (BAN), are eligible for an Upgrade. To use the generateReportRequest API to request the Upgrade Eligibility Report, set ReportType to "upgradeEligibility".
Order History
Suppose your company administrator would like to obtain a report that shows up to 90 days of Order History information across all Store Order and Care Order transactions. To use the generateReportRequest API to request the Order History Report, set ReportType to "orderHistory".
Current Usage
Suppose your company administrator would like to obtain a report about Unbilled Voice and Data Usage for a given Customer Telephone Number (CTN). You would use the synchronous currentUsageReportRequest API.