In this article
API: Power BI
Power BI endpoints are used for generating reports for all billing schedule records. To ensure that the most current data is updated for this API, execute the Refresh API Data action from the SBS ARCB Billing Schedule List as part of a job queue that is scheduled at a frequency (e.g., hourly, daily, or weekly) suitable for your business needs.
Tip: For the most current and complete API information in Subscription Billing, run the following GET command.
GET https://api.businesscentral.dynamics.com/v2.0/dd24e63d-2131-4bd0-bdd5-570c473ba440/api/binarystream/arcb/beta/$metadataWhen to Use
As a best practice, use these endpoints for generating forecast, detail, or summary reports for all billing schedule data.
| API Setup information | |
| SBS ARCB Schedule New Sales PBI API | |
| Object ID: | 23065882 |
| Collection: | BssiARCBSchedNewSales |
| SBS ARCB Schedule Termination Details PBI API | |
| Object ID: | 23065881 |
| Collection: | BssiARCBSchedTerminationDetails |
| SBS ARCB Schedule Total Value Details PBI API | |
| Object ID: | 23065880 |
| Collection: | BssiARCBSchedTotalValueDetails |
| SBS ARCB Total Contract Revenue PBI API | |
| Object ID: | 23065877 |
| Collection: | BssiARCBTotalContractRevs |
| SBS ARCB MRR Report Details PBI API | |
| Object ID: | 23065874 |
| Collection: | BssiAPIMRRReportDetails |
| SBS ARCB MRR Report PBI API | |
| Object ID: | 23065873 |
| Collection: | BssiAPIMRRReports |
The following pages are affected by this resource:
Generate Report for New Contract Sales
Generates a report that shows all new contract sales.
Request:
- GET /BssiARCBSchedNewSales
Expand for detailed examples.
View example response body.
Select Copy to copy the sample to the clipboard.
Note: Use the FireFox web browser when selecting Copy to ensure that the tab spaces in the code are copied correctly. With other web browsers, the tab spaces are copied as non-breaking spaces, which can cause the code to fail.
Response (json)
{
"BssiArcbBillingScheduleNumber": "GR1_0002",
"BssiSellToCustomerName": "Trey Research",
"BssiArcbScheduleStartDate": "2019-11-18",
"BssiArcbScheduleEndDate": "2020-11-17",
"BssiArcbDetailTotalAmt": 12009.6,
"BssiRenewInAdvance": 0,
"BssiEndUserName": "",
"BssiArcbDescription": "",
"BssiCustAccount": "20000",
"BssiTerminationDate": "0001-01-01",
"BssiSalePersonName": "Peter Saddow",
"BssiMonthlyMMR": 1001
}Generate Detailed Report for Terminated Billing Schedule Lines
Generates the termination line details reports.
Request:
- GET /BssiARCBSchedTerminationDetails
Expand for detailed examples.
View example response body.
Select Copy to copy the sample to the clipboard.
Note: Use the FireFox web browser when selecting Copy to ensure that the tab spaces in the code are copied correctly. With other web browsers, the tab spaces are copied as non-breaking spaces, which can cause the code to fail.
Response (json)
{
"BssiArcbBillSchedNo": "GR1_0002",
"BssiLineNo": 10000,
"BssiType": "Item",
"BssiUnitofMeasure": "Piece",
"BssiUnitPrice": 1000.8,
"BssiQuantity": 1,
"BssiAmount": 1000.8,
"BssiArcbBillingFrequency": " Monthly",
"BssiQuantityToInvoice": 1,
"BssiArcbInterval": 1,
"BssiStatus": " Terminated",
"BssiTaxGroupCode": "FURNITURE",
"BssiTaxLiable": false,
"BssiTaxAreaCode": "CHICAGO, IL",
"BssiLastInvoiceAmount": 1000.8,
"BssiTotalInvoiceAmount": 12009.6,
"BssiAnnuInvoicedAmount": 12009.6,
"BssiArcbAutoRenewed": true,
"BssiUsageOption": "Reading",
"BssiPricingMethod": "Standard",
"BssiUsageIdentifier": "",
"BssiInitialReading": 0,
"BssiRenewalLines": 1,
"BssiTotalActiveAmount": 0,
"BssiIsMilestoneItem": 0,
"BssiMilestoneLineNo": 0,
"BssiSuppRenewal": false,
"BssiVariantCode": "",
"BssiUnitofMeasureCode": "PCS",
"BssiShortcutDimension1Code": "",
"BssiShortcutDimension2Code": "",
"BssiDimensionSetID": 0,
"BssiRevenueSplit": false,
"BssiParentAmount": 0,
"BssiParentLineNo": 0,
"BssiAllocationMethod": "Variable Amount",
"BssiIndentLine": 0,
"BssiPaymentTerm": "14 DAYS",
"BssiDirectDebitMandateID": "",
"BssiPaymentMethodCode": "BANK",
"BssiArcbHeaderDescription": "",
"BssiSelltoCustomerName": "Trey Research",
"BssiArcbDetailTotalAmt": 0,
"BssiArcbDetailInvAmt": 0,
"BssiEndUser": "",
"BssiArcbBillingType": "Standard",
"BssiCustAccount": "20000",
"BssiEndUserName": "",
"BssiItemNo": "1896-S",
"BssiDescription": "ATHENS Desk",
"BssiBillingStartDate": "2019-11-18",
"BssiBillingEndDate": "2050-11-17",
"BssiLocationCode": "",
"BssiTerminationDate": "2030-11-30",
"BssiTerminationReason": "test1",
"BssiMonthlyMMR": 0,
"BssiAnnualRevenu": 0,
"BssiTotalContractValue": 12009.6,
"BssiUDFH1": "",
"BssiUDFH2": "",
"BssiUDFH3": "",
"BssiUDFH4": "",
"BssiUDFH5": "",
"BssiUDFH6": "0001-01-01",
"BssiUDFH7": 0,
"BssiUDFH8": false,
"BssiUDFL1": "",
"BssiUDFL2": "",
"BssiUDFL3": "",
"BssiUDFL4": "",
"BssiUDFL5": "",
"BssiUDFL6": "0001-01-01",
"BssiUDFL7": 0,
"BssiUDFL8": false
} Generate Report for the Total Value Details of the Billing Schedules
Displays the total value details of a billing schedule.
Request:
- GET /BssiARCBSchedTotalValueDetails
Expand for detailed examples.
View example response body.
Select Copy to copy the sample to the clipboard.
Note: Use the FireFox web browser when selecting Copy to ensure that the tab spaces in the code are copied correctly. With other web browsers, the tab spaces are copied as non-breaking spaces, which can cause the code to fail.
Response (json)
{
"BssiArcbBillSchedNo": "GR1_0002",
"BssiLineNo": 10000,
"BssiType": "Item",
"BssiUnitofMeasure": "Piece",
"BssiUnitPrice": 1000.8,
"BssiQuantity": 1,
"BssiAmount": 1000.8,
"BssiArcbBillingFrequency": " Monthly",
"BssiQuantityToInvoice": 1,
"BssiArcbInterval": 1,
"BssiStatus": " Terminated",
"BssiTaxGroupCode": "FURNITURE",
"BssiTaxLiable": false,
"BssiTaxAreaCode": "CHICAGO, IL",
"BssiAnnuInvoicedAmount": 12009.6,
"BssiUsageOption": "Reading",
"BssiPricingMethod": "Standard",
"BssiUsageIdentifier": "",
"BssiInitialReading": 0,
"BssiRenewalLines": 1,
"BssiTotalActiveAmount": 0,
"BssiIsMilestoneItem": 0,
"BssiMilestoneLineNo": 0,
"BssiSuppRenewal": false,
"BssiVariantCode": "",
"BssiUnitofMeasureCode": "PCS",
"BssiShortcutDimension1Code": "",
"BssiShortcutDimension2Code": "",
"BssiDimensionSetID": 0,
"BssiRevenueSplit": false,
"BssiParentAmount": 0,
"BssiParentLineNo": 0,
"BssiAllocationMethod": "Variable Amount",
"BssiIndentLine": 0,
"BssiPaymentTerm": "14 DAYS",
"BssiDirectDebitMandateID": "",
"BssiPaymentMethodCode": "BANK",
"BssiArcbHeaderDescription": "",
"BssiSelltoCustomerName": "Trey Research",
"BssiArcbDetailTotalAmt": 12009.6,
"BssiArcbDetailInvAmt": 12009.6,
"BssiEndUser": "",
"BssiCustAccount": "20000",
"BssiArcbAutoRenewed": true,
"BssiEndUserName": "",
"BssitSalePersonName": "Peter Saddow",
"BssiItemNo": "1896-S",
"BssiDescription": "ATHENS Desk",
"BillingStartDate": "2019-11-18",
"BillingEndDate": "2050-11-17",
"BssiLocationCode": "",
"BssiLastInvoiceAmount": 1000.8,
"BssiTotalInvoiceAmount": 12009.6,
"BssiTotalContractValue": 12009.6,
"BssiUDFH1": "",
"BssiUDFH2": "",
"BssiUDFH3": "",
"BssiUDFH4": "",
"BssiUDFH5": "",
"BssiUDFH6": "0001-01-01",
"BssiUDFH7": 0,
"BssiUDFH8": false,
"BssiUDFL1": "",
"BssiUDFL2": "",
"BssiUDFL3": "",
"BssiUDFL4": "",
"BssiUDFL5": "",
"BssiUDFL6": "0001-01-01",
"BssiUDFL7": 0,
"BssiUDFL8": false
}Generate Report for Total Contract Revenue of the Billing Schedules
Generates a report that shows all the total contract amounts for all billing schedules.
Request:
- GET /BssiARCBTotalContractRevs
Expand for detailed examples.
View example response body.
Select Copy to copy the sample to the clipboard.
Note: Use the FireFox web browser when selecting Copy to ensure that the tab spaces in the code are copied correctly. With other web browsers, the tab spaces are copied as non-breaking spaces, which can cause the code to fail.
Response (json)
{
"BssiArcbBillingScheduleNumber": "CONT000017",
"BssiSellToCustomerName": "Trey Research",
"BssiArcbScheduleStartDate": "2019-11-13",
"BssiArcbScheduleEndDate": "2020-11-12",
"BssiArcbDetailTotalAmt": 2313.6,
"BssiArcbDetailInvAmt": 2313.6,
"BssiEndUserName": "",
"BssiDeferredAmount": 0,
"BssiNonDeferredAmount": 2313.6,
"BssiDeferredRecognizedAmount": 0,
"BssiDeferredNonRecognizedAmount": 0
}Generate Detailed Report Monthly Recurring Revenue
Generates a detailed report for the monthly recurring revenue (MRR).
Request:
- GET /BssiAPIMRRReportDetails
Expand for detailed examples.
View example response body.
Select Copy to copy the sample to the clipboard.
Note: Use the FireFox web browser when selecting Copy to ensure that the tab spaces in the code are copied correctly. With other web browsers, the tab spaces are copied as non-breaking spaces, which can cause the code to fail.
Response (json)
"value": [
{
"entryNo": 1,
"CustAccount": "30000",
"BssiArcbBilingScheduleNumber": "CONT000001",
"ItemId": "1906-S",
"ItemGroup": "NULL",
"LineNo": 10000,
"BssiArcbYear": 2019,
"BssiArcbMonth": 1,
"BssiArcbMRRType": 1,
"SaleLineAmount": 1000,
"ItemDescription": "ATHENS Mobile Pedestal",
"BssiEndUser": ""
},
{
"entryNo": 2,
"CustAccount": "30000",
"BssiArcbBilingScheduleNumber": "CONT000001",
"ItemId": "1906-S",
"ItemGroup": "NULL",
"LineNo": 10000,
"BssiArcbYear": 2019,
"BssiArcbMonth": 1,
"BssiArcbMRRType": 5,
"SaleLineAmount": 1000,
"ItemDescription": "ATHENS Mobile Pedestal",
"BssiEndUser": ""
}
]Generate Summary Report for Monthly Recurring Revenue
Generates a summary report for the monthly recurring revenue (MRR).
Request:
- GET /BssiAPIMRRReports
Expand for detailed examples.
View example response body.
Select Copy to copy the sample to the clipboard.
Note: Use the FireFox web browser when selecting Copy to ensure that the tab spaces in the code are copied correctly. With other web browsers, the tab spaces are copied as non-breaking spaces, which can cause the code to fail.
Response (json)
"value": [
{
"entryNo": 1429,
"BssiArcbMonth": 1,
"BssiArcbBeginMRR": 0,
"BssiArcbNewSale": 1000,
"BssiArcbRenewal": 0,
"BssiArcbUpdowngrade": 0,
"BssiArcbchurn": 0,
"BssiArcbEndMRR": 1000,
"BssiArcbYear": 2019,
"AppTenentId": "common"
},
{
"entryNo": 1430,
"BssiArcbMonth": 2,
"BssiArcbBeginMRR": 1000,
"BssiArcbNewSale": 0,
"BssiArcbRenewal": 0,
"BssiArcbUpdowngrade": 0,
"BssiArcbchurn": 0,
"BssiArcbEndMRR": 1000,
"BssiArcbYear": 2019,
"AppTenentId": "common"
},
{
"entryNo": 1431,
"BssiArcbMonth": 3,
"BssiArcbBeginMRR": 1000,
"BssiArcbNewSale": 0,
"BssiArcbRenewal": 0,
"BssiArcbUpdowngrade": 0,
"BssiArcbchurn": 0,
"BssiArcbEndMRR": 1000,
"BssiArcbYear": 2019,
"AppTenentId": "common"
}
]