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 ARED Deferral Schedules 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.
Copy
GET Metadata for Deferral Schedules
GET https://api.businesscentral.dynamics.com/v2.0/dd24e63d-2131-4bd0-bdd5-570c473ba440/api/binarystream/ared/beta/$metadataWhen to Use
As a best practice, use these endpoints for generating forecast, detail, or summary reports for all deferral schedule data.
| API Setup information | |
| Deferral Balance Detail PBI API | |
| Object ID: | 23066453 |
| Collection: | BssiAREDDefBalDtls |
| Decline Balance PBI API | |
| Object ID: | 23066457 |
| Collection: | BssiAREDDeclineBalances |
| Deferral Revenue Waterfall PBI API | |
| Object ID: | 23066458 |
| Collection: | BssiAREDDefRevWaterfalls |
The following pages are affected by this resource:
Generate a Deferral Balance Detailed Report
Generates the deferral balance detailed report
Request:
- GET /BssiAREDDefBalDtls
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.
Copy
Response (json)
"value": [
{
"BssiEntryNo": 0,
"BssiAredUserId": "TEST2",
"BssiScheduleNumber": "DEF0000000",
"BssiDeferralAccount": "10100",
"BssiDeferralAccountDesc": "Checking account",
"BssiRecogAccount": "",
"BssiDefDiscountAccount": "10300",
"BssiDeferralDiscAccDesc": "Petty Cash",
"BssiDefCOGSAccount": "10200",
"BssiDeferralCOGSAccDesc": "Saving account",
"BssiItemNo": "ATHENS Desk",
"BssiCustomerVendor": "Adatum Corporation",
"BssiStartDate": "0001-01-01",
"BssiEndDate": "0001-01-01",
"BssiExpriationDate": "0001-01-01",
"BssiAmount": 9377.8,
"BssiStubbed": false,
"BssiRecognized": false,
"BssilineNo": 0,
"BssiTransactionType": "Sales Invoice",
"BssiInvoiceNo": "",
"BssiDescription": "",
"BssiRecognizedAmount": 157.55,
"BssiBalanceAmount": 9220.25,
"BssiGroupingField": "",
"BssiMonthNo": 0,
"Bssiyear": 0,
"BssiDateCtr": 0,
"BssiItemName": "",
"BssiCustomerVendorName": "",
"BssiCustomerVendorNo": "",
"BssiShortcutDimension1Code": "0000",
"BssiShortcutDimension2Code": "",
"BssiDefDiscountAmount": 0,
"BssiDefCOGSAmount": -368.71,
"BssiScheduleStatus": "Active",
"BssiUDFH1": "",
"BssiUDFH2": "",
"BssiUDFH3": "",
"BssiUDFH4": "",
"BssiUDFH5": "",
"BssiUDFH6": "0001-01-01",
"BssiUDFH7": 0,
"BssiUDFH8": false
},
{
"BssiEntryNo": 1,
"BssiAredUserId": "TEST2",
"BssiScheduleNumber": "DEF0000001",
"BssiDeferralAccount": "10100",
"BssiDeferralAccountDesc": "Checking account",
"BssiRecogAccount": "",
"BssiDefDiscountAccount": "10300",
"BssiDeferralDiscAccDesc": "Petty Cash",
"BssiDefCOGSAccount": "10200",
"BssiDeferralCOGSAccDesc": "Saving account",
"BssiItemNo": "ATHENS Mobile Pedestal",
"BssiCustomerVendor": "Trey Research",
"BssiStartDate": "0001-01-01",
"BssiEndDate": "0001-01-01",
"BssiExpriationDate": "0001-01-01",
"BssiAmount": 2000,
"BssiStubbed": false,
"BssiRecognized": false,
"BssilineNo": 0,
"BssiTransactionType": "Sales Invoice",
"BssiInvoiceNo": "",
"BssiDescription": "",
"BssiRecognizedAmount": 2000,
"BssiBalanceAmount": 0,
"BssiGroupingField": "",
"BssiMonthNo": 0,
"Bssiyear": 0,
"BssiDateCtr": 0,
"BssiItemName": "",
"BssiCustomerVendorName": "",
"BssiCustomerVendorNo": "",
"BssiShortcutDimension1Code": "PROD",
"BssiShortcutDimension2Code": "",
"BssiDefDiscountAmount": 0,
"BssiDefCOGSAmount": -2029.2,
"BssiScheduleStatus": "Active",
"BssiUDFH1": "",
"BssiUDFH2": "",
"BssiUDFH3": "",
"BssiUDFH4": "",
"BssiUDFH5": "",
"BssiUDFH6": "0001-01-01",
"BssiUDFH7": 0,
"BssiUDFH8": false
}
]Generate a Deferred Revenue Declining Balance Report
Generates the deferred revenue declining balance report
Request:
- GET /BssiAREDDeclineBalances
Expand for detailed examples.
| Request Examples |
| API example: |
| GET Coming soon. |
| ODATA V4 example: |
| GET Coming soon. |
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.
Copy
Response (json)
"value": [
{
"BssiEntryNo": 1429,
"BssiAredUserId": "TEST2",
"BssiScheduleNumber": "DEF0000000",
"BssiDeferralAccount": "10100",
"BssiDeferralAccountDesc": "Checking account",
"BssiRecogAccount": "",
"BssiDefDiscountAccount": "10300",
"BssiDeferralDiscAccDesc": "Petty Cash",
"BssiDefCOGSAccount": "10200",
"BssiDeferralCOGSAccDesc": "Saving account",
"BssiItemNo": "ATHENS Desk",
"BssiCustomerVendor": "Adatum Corporation",
"BssiStartDate": "0001-01-01",
"BssiEndDate": "0001-01-01",
"BssiExpriationDate": "0001-01-01",
"BssiAmount": 0,
"BssiStubbed": false,
"BssiRecognized": false,
"BssilineNo": 0,
"BssiTransactionType": "Sales Invoice",
"BssiInvoiceNo": "",
"BssiDescription": "",
"BssiRecognizedAmount": 0,
"BssiBalanceAmount": 0,
"BssiGroupingField": "",
"BssiMonthNo": 1,
"Bssiyear": 2019,
"BssiDateCtr": 1429,
"BssiItemName": "",
"BssiCustomerVendorName": "",
"BssiCustomerVendorNo": "",
"BssiShortcutDimension1Code": "",
"BssiShortcutDimension2Code": "",
"BssiDefDiscountAmount": 0,
"BssiDefCOGSAmount": 0,
"BssiScheduleStatus": "Active",
"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
},
{
"BssiEntryNo": 1430,
"BssiAredUserId": "TEST2",
"BssiScheduleNumber": "DEF0000000",
"BssiDeferralAccount": "10100",
"BssiDeferralAccountDesc": "Checking account",
"BssiRecogAccount": "",
"BssiDefDiscountAccount": "10300",
"BssiDeferralDiscAccDesc": "Petty Cash",
"BssiDefCOGSAccount": "10200",
"BssiDeferralCOGSAccDesc": "Saving account",
"BssiItemNo": "ATHENS Desk",
"BssiCustomerVendor": "Adatum Corporation",
"BssiStartDate": "0001-01-01",
"BssiEndDate": "0001-01-01",
"BssiExpriationDate": "0001-01-01",
"BssiAmount": 0,
"BssiStubbed": false,
"BssiRecognized": false,
"BssilineNo": 0,
"BssiTransactionType": "Sales Invoice",
"BssiInvoiceNo": "",
"BssiDescription": "",
"BssiRecognizedAmount": 0,
"BssiBalanceAmount": 0,
"BssiGroupingField": "",
"BssiMonthNo": 2,
"Bssiyear": 2019,
"BssiDateCtr": 1430,
"BssiItemName": "",
"BssiCustomerVendorName": "",
"BssiCustomerVendorNo": "",
"BssiShortcutDimension1Code": "",
"BssiShortcutDimension2Code": "",
"BssiDefDiscountAmount": 0,
"BssiDefCOGSAmount": 0,
"BssiScheduleStatus": "Active",
"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 a Deferred Revenue Waterfall Report
Generates the deferred revenue waterfall report
Request:
- GET /BssiAREDDefRevWaterfalls
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.
Copy
Response (json)
"value": [
{
"BssiEntryNo": 1,
"BssiAredUserId": "TEST2",
"BssiScheduleNumber": "DEF0000000",
"BssiDeferralAccount": "10100",
"BssiRecogAccount": "40200",
"BssiItemNo": "ATHENS Desk",
"BssiCustomerVendor": "Adatum Corporation",
"BssiStartDate": "0001-01-01",
"BssiEndDate": "0001-01-01",
"BssiExpriationDate": "0001-01-01",
"BssiAmount": 0,
"BssiStubbed": false,
"BssiRecognized": false,
"BssilineNo": 0,
"BssiTransactionType": "Sales Invoice",
"BssiInvoiceNo": "",
"BssiDescription": "",
"BssiRecognizedAmount": 157.55,
"BssiBalanceAmount": 0,
"BssiUnrecogAmount": -157.55,
"BssiGroupingField": "",
"BssiMonthNo": 4,
"Bssiyear": 2019,
"BssiDateCtr": 1,
"BssiItemName": "",
"BssiCustomerVendorName": "",
"BssiCustomerVendorNo": "",
"BssiShortcutDimension1Code": "0000",
"BssiShortcutDimension2Code": "",
"BssiDefDiscountAccount": "10300",
"BssiDefCOGSAccount": "10200",
"BssiDefDiscountAmount": 0,
"BssiDefCOGSAmount": 0,
"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
},
{
"BssiEntryNo": 2,
"BssiAredUserId": "TEST2",
"BssiScheduleNumber": "DEF0000000",
"BssiDeferralAccount": "10100",
"BssiRecogAccount": "40200",
"BssiItemNo": "ATHENS Desk",
"BssiCustomerVendor": "Adatum Corporation",
"BssiStartDate": "0001-01-01",
"BssiEndDate": "0001-01-01",
"BssiExpriationDate": "0001-01-01",
"BssiAmount": 0,
"BssiStubbed": false,
"BssiRecognized": false,
"BssilineNo": 0,
"BssiTransactionType": "Sales Invoice",
"BssiInvoiceNo": "",
"BssiDescription": "",
"BssiRecognizedAmount": 0,
"BssiBalanceAmount": 0,
"BssiUnrecogAmount": 0,
"BssiGroupingField": "",
"BssiMonthNo": 5,
"Bssiyear": 2019,
"BssiDateCtr": 2,
"BssiItemName": "",
"BssiCustomerVendorName": "",
"BssiCustomerVendorNo": "",
"BssiShortcutDimension1Code": "0000",
"BssiShortcutDimension2Code": "",
"BssiDefDiscountAccount": "10300",
"BssiDefCOGSAccount": "10200",
"BssiDefDiscountAmount": 0,
"BssiDefCOGSAmount": 0,
"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
}
]