In this article

API: Billing Schedule Order/Invoice Creator Action

This endpoint is used to run the SBS ARCB Billing Schedule Order/Invoice Creator, which creates invoices for billing schedules.

Tip: For the most current and complete API information in Subscription Billing, run the following GET command.

Copy
GET Metadata for Subscription Billing
Update the GET command to get the metadata for the product you want. Make a snippet from it and add it to all API pages 
GET https://api.businesscentral.dynamics.com/v2.0/dd24e63d-2131-4bd0-bdd5-570c473ba440/api/binarystream/arcb/beta/$metadata

When to Use

Provide information on when to use the endpoints. 

API Setup information
 
Object ID: 23065999
Collection: BssiAPIScheduleInvoiceCreator

The following pages are affected by this resource: 

Create Invoices

Runs the invoice creator process.

Request: 

  • POST /BssiSchInvoiceCreator
Request Examples
API example: 

POSThttps://api.businesscentral.dynamics.com/v2.0/e9db614c-882a-401b-8f75-51dbfae511a7/sandbox/api/binarystream/arcb/beta/companies(c9f29336-daea-eb11-bb6e-000d3a220cdc)/BssiSchInvoiceCreator

When using this endpoint, remember the following notes for the request body: 

  • Only the BssiPostingOption and BssiAsOfDate require values.
  • If BssiInvoiceDate is not included, the default value is the same as the BssiAsOfDate value.
  • If BssiScheduleNumber is included, invoice for only the specified billing schedule are created.
    This execution is similar to when the SBS ARCB Billing Schedule Order/Invoice Creator is opened from the SBS ARCB Billing Schedule Card header action.
  • Possible values for BssiPostingOption are:
    • " Create Order(s)/Invoice(s)"
    • "Post Order(s)/Invoice(s)"
    • "Post & Send"
  • Possible values for BssiOptTransactionTypeFilter are: 
    • "Both"
    • "Sales Invoice Only"
    • "Sales Order Only"

Select Copy to copy the sample to the clipboard.

Note icon. 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

Request (json)

{ 
    "BssiPostingOption": "Create Order(s)/Invoice(s)",
    "BssiAsOfDate": "2020-11-30",
    "BssiExcludePriorUnbilled": false,
    "BssiConsolidateByCustomer": true,
    "BssiConsolidateByItem": true,
    "BssiConsolidateByItemExcldingStartEndDate": false,
    "BssiConsolidateByBillToCust": false,
    "BssiConsolidateByEndUser": false,
    "BssiInvoiceDate": "2020-11-30",
    "BssiScheduleNumber": "CONT000999",
    "BssiOptTransactionTypeFilter": "Both"
    "BssiIncludeZeroConsumption": "true".
}