API: Terminate Action

Termination action endpoints are used to terminate or remove the termination from billing schedule lines.

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 terminating or removing the termination from billing schedule lines.

Only the POST method is available for this API. To view whether a billing schedule line is terminated, retrieve the corresponding billing schedule line record and look at the Status for the record.

The following pages are affected by this resource: 

• SBS ARCB Billing Schedule Termination
• SBS ARCB Billing Terminate Remove

Terminate Specific Lines in a Billing Schedule

Terminates specific lines for a billing schedule. This endpoint is equivalent to the Terminate action on the Schedule Lines FastTab of the SBS ARCB Billing Schedule Card page.

Request: 

• POST /BssiTerminateScheduleLines

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)/BssiTerminateScheduleLines

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)

{
    "BssiArcbBillingScheduleNo": "BIL000010",
    "BssiLineNo": 20000,
    "BssiTerminationDate": "2020-08-31",
    "BssiTerminationType": "Billing Remaining",
    "BssiReasonCode": "SMOKE TESTING",
    "BssiReasonCodeValues": "BY DANIEL",
    "BssiTerminationNote": "From API Testrunner",
    "BssiProrateDaily": false
    "BssiIssueCredit": true
    "BssiInvoiceDate": "2023-05-31"
    "BssiDeferralAdjustment": "Entire Schedule"
}

Remove Termination from Billing Schedule Lines

Removes the termination from specific lines entire billing schedule. This endpoint is equivalent to the Reverse Terminate action on the Schedule Lines FastTab of the SBS ARCB Billing Schedule Card page.

Request:

• POST /BssiRemoveTerminationScheduleLines

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)/BssiRemoveTerminationScheduleLines

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)

{
    "BssiArcbBillingScheduleNo": "BIL000009",
    "BssiLineNo": 10000,
}