API: Usage Action

The usage action endpoint is used to update the details for a usage item.

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/$metadata

When to Use

As a best practice, use these endpoints for updating usage items for specific billing schedule lines.

Only the POST method is available for this API. To view the usage details for a billing schedule line, retrieve the details for the billing schedule line record.

The following pages are affected by this resource: 

• SBS ARCB Billing Schedule Card
• SBS ARCB Billing Detail List

Update Usage Item

Provide one line for the request description. The heading should describe what the request with the endpoint and method does.

Request: 

• POST /BssiUsageItems

Expand for detailed examples.

Request Examples

API example:

POST https://api.businesscentral.dynamics.com/v2.0/e9db614c-882a-401b-8f75-51dbfae511a7/sandbox/api/binarystream/arcb/beta/companies(c9f29336-daea-eb11-bb6e-000d3a220cdc)/BssiUsageItems?tenant=default

View example request body.

Copy

Request (json)

{
    "BssiArcbBillingScheduleNumber": "CONT000008",
    "ItemNo": "1896-S",
    "UsageIdentifier": "test123",
    "UsageOption": "Reading",
    "CurrentReadingORQuantity": 5.05,
    "BillingStartDate": "2021-01-01",
    "Comments": "Testing the usage endpoint for reading item"
}

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)

{
    "@odata.context": "https://api.businesscentral.dynamics.com/v2.0/dd24e63d-2131-4bd0-bdd5-570c473ba440/api/binarystream/arcb/beta/$metadata#companies(ad9b1e9b-f714-ec11-bb7e-000d3abcd65f)/BssiUsageItems/$entity",
    "@odata.etag": "W/\"JzQ0O21nSlJ1MnZEbS92Z2MyVW44aG1SaTk4S1BsT0VtMjJsTXg4MXhhb0JHQ2c9MTswMDsn\"",
    "BssiArcbBillingScheduleNumber": "CONT000008",
    "ItemNo": "1896-S",
    "UsageIdentifier": "test123",
    "UsageOption": "Reading",
    "CurrentReadingORQuantity": 5.05,
    "BillingStartDate": "2021-01-01",
    "Comments": "Testing usage"
}