AT&T DevEx

DevEx

Wireless eBonding

Wireless eBonding

eBonding Reporting Tutorial

This tutorial presents the Wireless eBonding Reports and shows how to Generate and Retrieve the reports.

Wireless Inventory Report

1

Generate - Wireless Inventory Report

The Wireless Inventory Report provides details of Wireless Users at a FAN or BAN level. This includes: (Subscriber Name. Mobile Number, Rate Plan, IMEI, ICCID, Billing Labels (if applicable), etc.

A successful response will indicate that the Report Generation is In-Progress.

Generate Report Request

1
2
3
4
5
6
7
8
{
    "generateReportRequest": {
        "accountGroupId": "a98765432109",
        "accountType": "FAN",
        "accountLevelValue": "12345678",
        "reportType": "wirelessInventory"
    }
}

Generate Report Response

1
2
3
4
5
{"generateReportResponse": {
   "reportCode": "SC_REPORTS_1001",
   "reportDescription": "Generating Reports is in process."
}
}
2

Retrieve - Wireless Inventory Report

After the Wireless Inventory Report is generated, you then make a Request to retrieve it. The report is returned in the "fileContent" field of the Response, in Base 64 format.

Retrieve Report Request

1
2
3
4
5
6
7
8
9
{
    "retrieveReportRequest": {
        "accountGroupId": "a98765432109",
        "accountType": "FAN",
        "accountLevelValue": "12345678",
        "reportType": "wirelessInventory"
    }
}

Retrieve Report Response

1
2
3
4
5
6
7
8
{"retrieveReportResponse": {
   "fileContent": "Report content in BASE 64 format",
   "fileName": "expandedWirelessInventoryReport_2025-26-07.zip",
   "fileDescription": "expandedWirelessInventoryReport_2025-26-07",
   "fileSize": "447340",
   "fileType": "cXML"
}}

This is a sample report in Excel format:

expanded wireless report

These are the report fields:

expanded wireless fields

Upgrade Eligibility Report

1

Generate - Upgrade Eligibility Report

The Upgrade Eligibility Report provides details of the Wireless Users' Upgrade Eligibility. This report is at the BAN level only.

A successful response will indicate that the Report Generation is In-Progress.

Generate Report Request

1
2
3
4
5
6
7
8
9
{
    "generateReportRequest": {
        "accountGroupId": "a98765432109",
        "accountType": "BAN",
        "accountLevelValue": "12345678",
        "reportType": "upgradeEligibility"

    }
}

Generate Report Response

1
2
3
4
5
{"generateReportResponse": {
   "reportCode": "SC_REPORTS_1001",
   "reportDescription": "Generating Reports is in process."
}
}
2

Retrieve - Upgrade Eligibility Report

After the Upgrade Eligibility Report is generated, you then make a Request to retrieve it. The report is returned in the "fileContent" field of the Response, in Base 64 format.

Retrieve Report Request

1
2
3
4
5
6
7
8
{
    "retrieveReportRequest": {
        "accountGroupId": "a98765432109",
        "accountType": "BAN",
        "accountLevelValue": "12345678",
        "reportType": "upgradeEligibility"
    }
}

Retrieve Report Response

1
2
3
4
5
6
7
8
{"retrieveReportResponse": {
   "fileContent": "Report content in BASE 64 format",
   "fileName": "upgradeEligibilityReport_2025-28-07.zip",
   "fileDescription": "upgradeEligibilityReport_2025-28-07",
   "fileSize": "47342",
   "fileType": "cXML"
   }
}

This is a sample report in Excel format:

upgrade eligibility report

These are the report fields:

upgrade eligibility fields

Rate Plan Summary Report

1

Generate - Rate Plan Summary Report

The Rate Plan Summary Report provides a list of the users' active Rate Plans. The report can be requested at the FAN or BAN level.

A successful response will indicate that the Report Generation is In-Progress.

Generate Report Request

1
2
3
4
5
6
7
8
{
    "generateReportRequest": {
        "accountGroupId": "a98765432109",
        "accountType": "FAN",
        "accountLevelValue": "12345678",
        "reportType": "ratePlan"
    }
}

Generate Report Response

1
2
3
4
5
6
{"generateReportResponse": {
   "reportCode": "SC_REPORTS_1001",
   "reportDescription": "Generating Reports is in process."
}
}
2

Retrieve - Rate Plan Summary Report

After the Rate Plan Summary Report is generated, you then make a Request to retrieve it. The report is returned in the "fileContent" field of the Response, in Base 64 format.

Retrieve Report Request

1
2
3
4
5
6
7
8
{
       "retrieveReportRequest": {
        "accountGroupId": "a98765432109",
        "accountType": "FAN",
        "accountLevelValue": "12345678",
        "reportType": "ratePlan"
    }
}

Retrieve Report Response

1
2
3
4
5
6
7
8
{"retrieveReportResponse": {
   "fileContent": "Report content in BASE 64 format",
   "fileName": "ratePlanSummary_08-04-2025.zip",
   "fileDescription": "ratePlanSummary_2025-08-04",
   "fileSize": "47123",
   "fileType": "cXML"
   }
}

This is a sample report in Excel format:

rate plan report

These are the report fields:

reate plan fields

Order History Report

1

Generate - Order History Report

The Order History Report provides all orders processed via eBonding, in a (csv) file format. A Date Range for the orders may be specified. The report does not include orders created in the Premier Portal.

A successful response will indicate that the Report Generation is In-Progress.

Generate Report Request

1
2
3
4
5
6
7
8
9
10
11
12
{
    "generateReportRequest": {
        "accountGroupId": "a98765432109",
        "accountType": "FAN",
        "accountLevelValue": "12345678",
        "reportType": "orderHistory",
        "dateRange": {
            "startDate": "2024-07-01T09:30:48-05:00",
            "endDate": "2024-07-21T09:30:48-05:00"
        }
    }
}

Generate Report Response

1
2
3
4
5
6
{
   "generateReportResponse": {
      "reportCode": "SC_REPORTS_1001",
      "reportDescription": "Generating Reports is in process."
   }
}
2

Retrieve - Order History Report

After the Order History Report is generated, you then make a Request to retrieve it. The report is returned in the "fileContent" field of the Response, in Base 64 format.

Retrieve Report Request

1
2
3
4
5
6
7
8
9
10
11
12
13
{
    "retrieveReportRequest": {
        "accountGroupId": "a98765432109",
        "accountType": "FAN",
        "accountLevelValue": "12345678",
        "reportType": "orderHistory",
        "dateRange": {
            "startDate": "2024-07-01T09:30:48-05:00",
            "endDate": "2024-07-21T09:30:48-05:00"
        }
    }
}

Retrieve Report Response

1
2
3
4
5
6
7
8
{"retrieveReportResponse": {
   "fileContent": "Report content in BASE 64 format",
   "fileName": "retrieveReportRequest_2024-07-22.zip",
   "fileDescription": "retrieveReportRequest_2024-07-22",
   "fileSize": "647312",
   "fileType": "cXML"
   }
}

This is a sample report in Excel format:

order history report

These are the report fields:

order history fields

Current Usage Report

1

Generate/Retrieve - Current Usage Report

The Current Usage Report provides summary level real time usage for a single Mobile Number (CTN). (International usage is delayed).

Pull Report Request

1
2
3
4
5
{
  "currentUsageReportRequest": {
    "ctn": "1234567890"
  }
}

Sync Response

1
2
3
4
5
{"currentUsageReportResponse": {
   "fileContent": "Report content in BASE 64 format",
   "fileName": "currentUsage_2025-02-07-14-32-332",
   "fileExtension": "csv"
}}