In this article

API: Billing Schedule

Billing schedule endpoints are used to retrieve, create, modify, or delete billing schedules and billing schedule lines.

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

Copy
GET Metadata for Billing Schedules
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 creating billing schedules and their associated lines. While it's possible to publish the base pages through web services, some functionality might be missed.

Never integrate the billing schedule details directly. Instead, update the lines to ensure the details are recalculated. Usage details are updated through a separate API endpoint.

API Setup information
SBS ARCB Billing Schedule API
Object ID: 23065865
Collection: BillingSchedules
SBS ARCB Billing Schedule Lines API
Object ID: 23065866
Collection: bssiBillingSchlines
SBS ARCB Billing Schedule Lines with Deferral API
Object ID: 23065969
Collection: BillingSchedulesLineWithDeferral

The following pages are affected by this resource:

List All Billing Schedules

Displays the header information from multiple billing schedules.

  • Use the $expand URL parameter to also display line information.
  • Use the $filter URL parameter to add a query to the request.

Request: 

  • GET /BillingSchedules
  • GET /BillingSchedules?$expand=bssiBillingSchlines
  • GET /BillingSchedules?$filter=BssiStatus eq 'Active'
Request Examples
API example: 

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

GEThttps://api.businesscentral.dynamics.com/v2.0/e9db614c-882a-401b-8f75-51dbfae511a7/Sandbox/ODataV4/Company('CRONUS%20Canada%2C%20Inc.')/{ServiceName}

  • where {ServiceName} is the web service setup for SBS ARCB Billing Schedule API (Page 23065865)

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

Response (json)

{
    "@odata.context": "https://api.businesscentral.dynamics.com/v2.0/binarystream.com/Sandbox/api/binarystream/Arcb/beta/$metadata#companies(9abd98b5-b93c-44c1-bb8c-3bccd73d4bb0)/BillingSchedules",
    "value": [
    {
        "@odata.etag": "W/\"JzQ0O3FvOUNZZDVxempONFlBTnhjeHV5ZDN4ZmFybEttWmZkQ1F3S1NhVjdScjQ9MTswMDsn\"",
        "BillingScheduleNumber": "CONT000001",
        "BillingScheduleGroup": "DEFAULT",
        "BssiStatus": "Active",
        "BssiSellToCustomerNo": "40000",
        "EndUser": "",
        "BillingStartDate": "2021-07-01",
        "BillingEndDate": "2022-06-30",
        "BillingFrequency": " Monthly",
        "NumberofPeriods": 12,
        "Interval": 1,
        "AutoRenewal": false,
        "Description": "",
        "NoticeDays": 0,
        "RenewInAdvance": 0,
        "CurrencyCode": "",
        "LocationCode": "",
        "SalepersonCode": "JO",
        "ResponsibilityCenter": "",
        "PaymentTermscode": "1M(8D)",
        "BillToCustomerNo": "40000",
        "BillToName": "Alpine Ski House",
        "BillToAddress": "10 Deerfield Road",
        "BillToAddress2": "",
        "BillToCIty": "Atlanta",
        "ShipToCode": "",
        "ShipToName": "Alpine Ski House",
        "ShipToAddress": "10 Deerfield Road",
        "ShipToAddress2": "",
        "ShipToCity": "Atlanta",
        "BssiArcbDetailInvAmt": 0,
        "BillToPostalcode": "31772",
        "BillToCountry": "GA",
        "ShipToPostalCode": "31772",
        "ShipToCountry": "",
        "SellToCustomerName": "Alpine Ski House",
        "SellToAddress": "10 Deerfield Road",
        "SellToAddress2": "",
        "SellToCity": "Atlanta",
        "SellToContact": "Ian Deberry",
        "SellToPostalCode": "31772",
        "SellToCountry": "GA",
        "AlignToMonth": false,
        "ProratePartialPeriod": false,
        "ShipmentMethodcode": "",
        "PkgTrackingNO": "",
        "ShippingAgentServiceCode": "",
        "ShippingAgentCode": "",
        "ShipToPostcode": "31772",
        "ShipToCountryRegn": "US",
        "ShipToContact": "Ian Deberry",
        "SellToContactNo": "",
        "SellToCountryRegion": "US",
        "SellToCustomerName2": "",
        "YourRef": "",
        "ExternalDocNo": "",
        "BillToContact": "Ian Deberry",
        "BillToContactNo": "",
        "BillToCountryRegion": "US",
        "InvoiceSearately": false,
        "BssiAlignmentDate": "0001-01-01",
        "TaxLiable": false,
        "TaxAreaCode": "N.ATL., GA",
        "EstimatedQty": 0,
        "BssiUDFH1": "",
        "BssiUDFH2": "",
        "BssiUDFH3": "",
        "BssiUDFH4": "",
        "BssiUDFH5": "",
        "BssiUDFH6": "0001-01-01",
        "BssiUDFH7": 0,
        "BssiUDFH8": false,
        "BssiUDFH9": "",
        "BssiUDFH10": "",
        "BssiUDFH11": "",
        "BssiUDFH12": "",
        "BssiUDFH13": "",
        "BssiShortcutDimension1Code": "SALES",
        "BssiShortcutDimension2Code": "SMALL",
        "bssiShortcutDimension3": "",
        "bssiShortcutDimension4": "",
        "bssiShortcutDimension5": "",
        "bssiShortcutDimension6": "",
        "bssiShortcutDimension7": "",
        "bssiShortcutDimension8": ""
        },
        {
        "@odata.etag": "W/\"JzQ0O3VWbkRUbUlCN0hZdmFxMTVKeklQc09aaGhKenh6cjViTXdNMk9qSFlvN0k9MTswMDsn\"",
        "BillingScheduleNumber": "CONT000002",
        "BillingScheduleGroup": "DEFAULT",
        "BssiStatus": "Active",
        "BssiSellToCustomerNo": "40000",
        "EndUser": "",
        "BillingStartDate": "2022-07-01",
        "BillingEndDate": "2023-06-30",
        "BillingFrequency": " Monthly",
        "NumberofPeriods": 12,
        "Interval": 1,
        "AutoRenewal": false,
        "Description": "",
        "NoticeDays": 0,
        "RenewInAdvance": 0,
        "CurrencyCode": "",
        "LocationCode": "",
        "SalepersonCode": "JO",
        "ResponsibilityCenter": "",
        "PaymentTermscode": "1M(8D)",
        "BillToCustomerNo": "40000",
        "BillToName": "Alpine Ski House",
        "BillToAddress": "10 Deerfield Road",
        "BillToAddress2": "",
        "BillToCIty": "Atlanta",
        "ShipToCode": "",
        "ShipToName": "Alpine Ski House",
        "ShipToAddress": "10 Deerfield Road",
        "ShipToAddress2": "",
        "ShipToCity": "Atlanta",
        "BssiArcbDetailInvAmt": 0,
        "BillToPostalcode": "31772",
        "BillToCountry": "GA",
        "ShipToPostalCode": "31772",
        "ShipToCountry": "",
        "SellToCustomerName": "Alpine Ski House",
        "SellToAddress": "10 Deerfield Road",
        "SellToAddress2": "",
        "SellToCity": "Atlanta",
        "SellToContact": "Ian Deberry",
        "SellToPostalCode": "31772",
        "SellToCountry": "GA",
        "AlignToMonth": false,
        "ProratePartialPeriod": false,
        "ShipmentMethodcode": "",
        "PkgTrackingNO": "",
        "ShippingAgentServiceCode": "",
        "ShippingAgentCode": "",
        "ShipToPostcode": "31772",
        "ShipToCountryRegn": "US",
        "ShipToContact": "Ian Deberry",
        "SellToContactNo": "",
        "SellToCountryRegion": "US",
        "SellToCustomerName2": "",
        "YourRef": "",
        "ExternalDocNo": "",
        "BillToContact": "Ian Deberry",
        "BillToContactNo": "",
        "BillToCountryRegion": "US",
        "InvoiceSearately": false,
        "BssiAlignmentDate": "0001-01-01",
        "TaxLiable": false,
        "TaxAreaCode": "N.ATL., GA",
        "EstimatedQty": 0,
        "BssiUDFH1": "",
        "BssiUDFH2": "",
        "BssiUDFH3": "",
        "BssiUDFH4": "",
        "BssiUDFH5": "",
        "BssiUDFH6": "0001-01-01",
        "BssiUDFH7": 0,
        "BssiUDFH8": false,
        "BssiUDFH9": "",
        "BssiUDFH10": "",
        "BssiUDFH11": "",
        "BssiUDFH12": "",
        "BssiUDFH13": "",
        "BssiShortcutDimension1Code": "SALES",
        "BssiShortcutDimension2Code": "SMALL",
        "bssiShortcutDimension3": "",
        "bssiShortcutDimension4": "",
        "bssiShortcutDimension5": "",
        "bssiShortcutDimension6": "",
        "bssiShortcutDimension7": "",
        "bssiShortcutDimension8": ""
        }
    ]
}

 

Display Specific Billing Schedule Information

Displays the header information for a specific billing schedule.

  • Use the $expand URL parameter to also display line information for that schedule.

Request: 

  • GET /BillingSchedules('{BillingScheduleNumber}')
  • GET /BillingSchedules('{BillingScheduleNumber}')?$expand=bssiBillingSchlines

    • where {BillingScheduleNumber} is the identifier of a specific billing schedule

Request Examples
API example: 

GET https://api.businesscentral.dynamics.com/v2.0/e9db614c-882a-401b-8f75-51dbfae511a7/sandbox/api/binarystream/arcb/beta/companies(c9f29336-daea-eb11-bb6e-000d3a220cdc)/BillingSchedules('CONT000001')?$expand=bssiBillingSchlines
ODATA V4 example:

GET https://api.businesscentral.dynamics.com/v2.0/e9db614c-882a-401b-8f75-51dbfae511a7/Sandbox/ODataV4/Company('CRONUS%20Canada%2C%20Inc.')/{ServiceName} ('CONT000001')

  • where {ServiceName} is the Web Service setup for SBS ARCB Billing Schedule API (Page 23065865)
  • The $expand URL parameter is not available for OData. Publish another web service for SBS ARCB Billing Schedule Lines API (Page 23065866) to access the collection of billing schedule line records.

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

Response (json)

{
    "@odata.context": "https://api.businesscentral.dynamics.com/v2.0/binarystream.com/Sandbox/api/binarystream/Arcb/beta/$metadata#companies(9abd98b5-b93c-44c1-bb8c-3bccd73d4bb0)/BillingSchedules/$entity",
    "@odata.etag": "W/\"JzQ0O3FvOUNZZDVxempONFlBTnhjeHV5ZDN4ZmFybEttWmZkQ1F3S1NhVjdScjQ9MTswMDsn\"",
    "BillingScheduleNumber": "CONT000001",
    "BillingScheduleGroup": "DEFAULT",
    "BssiStatus": "Active",
    "BssiSellToCustomerNo": "40000",
    "EndUser": "",
    "BillingStartDate": "2021-07-01",
    "BillingEndDate": "2022-06-30",
    "BillingFrequency": " Monthly",
    "NumberofPeriods": 12,
    "Interval": 1,
    "AutoRenewal": false,
    "Description": "",
    "NoticeDays": 0,
    "RenewInAdvance": 0,
    "CurrencyCode": "",
    "LocationCode": "",
    "SalepersonCode": "JO",
    "ResponsibilityCenter": "",
    "PaymentTermscode": "1M(8D)",
    "BillToCustomerNo": "40000",
    "BillToName": "Alpine Ski House",
    "BillToAddress": "10 Deerfield Road",
    "BillToAddress2": "",
    "BillToCIty": "Atlanta",
    "ShipToCode": "",
    "ShipToName": "Alpine Ski House",
    "ShipToAddress": "10 Deerfield Road",
    "ShipToAddress2": "",
    "ShipToCity": "Atlanta",
    "BssiArcbDetailInvAmt": 0,
    "BillToPostalcode": "31772",
    "BillToCountry": "GA",
    "ShipToPostalCode": "31772",
    "ShipToCountry": "",
    "SellToCustomerName": "Alpine Ski House",
    "SellToAddress": "10 Deerfield Road",
    "SellToAddress2": "",
    "SellToCity": "Atlanta",
    "SellToContact": "Ian Deberry",
    "SellToPostalCode": "31772",
    "SellToCountry": "GA",
    "AlignToMonth": false,
    "ProratePartialPeriod": false,
    "ShipmentMethodcode": "",
    "PkgTrackingNO": "",
    "ShippingAgentServiceCode": "",
    "ShippingAgentCode": "",
    "ShipToPostcode": "31772",
    "ShipToCountryRegn": "US",
    "ShipToContact": "Ian Deberry",
    "SellToContactNo": "",
    "SellToCountryRegion": "US",
    "SellToCustomerName2": "",
    "YourRef": "",
    "ExternalDocNo": "",
    "BillToContact": "Ian Deberry",
    "BillToContactNo": "",
    "BillToCountryRegion": "US",
    "InvoiceSearately": false,
    "BssiAlignmentDate": "0001-01-01",
    "TaxLiable": false,
    "TaxAreaCode": "N.ATL., GA",
    "EstimatedQty": 0,
    "BssiUDFH1": "",
    "BssiUDFH2": "",
    "BssiUDFH3": "",
    "BssiUDFH4": "",
    "BssiUDFH5": "",
    "BssiUDFH6": "0001-01-01",
    "BssiUDFH7": 0,
    "BssiUDFH8": false,
    "BssiUDFH9": "",
    "BssiUDFH10": "",
    "BssiUDFH11": "",
    "BssiUDFH12": "",
    "BssiUDFH13": "",
    "BssiShortcutDimension1Code": "SALES",
    "BssiShortcutDimension2Code": "SMALL",
    "bssiShortcutDimension3": "",
    "bssiShortcutDimension4": "",
    "bssiShortcutDimension5": "",
    "bssiShortcutDimension6": "",
    "bssiShortcutDimension7": "",
    "bssiShortcutDimension8": "",
    "bssiBillingSchlines": [
        {
            "@odata.etag": "W/\"JzQ0O0ZmaGtxckV1VWxqZVZnMmN6MnJwaXhnRG41R0JXVXVXd21OUGV1N2lzd1E9MTswMDsn\"",
            "bssiArcbBillingScheduleNumber": "CONT000001",
            "LineNo": 10000,
            "Type_": "Item",
            "ItemNo": "1896-S",
            "Description": "ATHENS Desk",
            "BillingType": "Standard",
            "LocationCode": "",
            "UnitMeasureCode": "PCS",
            "Price": 1000.8,
            "Qty": 1,
            "Amount": 1000.8,
            "BillingFrequency": " Monthly",
            "BillingStartDate": "2021-07-01",
            "BillingEndDate": "2022-06-30",
            "Interval": 1,
            "TaxGroupCode": "FURNITURE",
            "TaxLiable": false,
            "TaxAreadCode": "N.ATL., GA",
            "AutoRenewed": false,
            "UsageOption": "Reading",
            "PricingMethod": "Standard",
            "UsageIdentifier": "",
            "InitialReading": 0,
            "RenewalLines": 1,
            "RevenueSplit": false,
            "ParentAmount": 0,
            "BssiCalculationMethod": "X Days Before Start Date",
            "BssiDayofInvoiceDate": 15,
            "BssiNumofPeriod": 12,
            "BssiAlignmentDate": "0001-01-01",
            "BssiEstimatedQty": 0,
            "BssiStatus": "Active",
            "Bssi_UDF_L1": "",
            "Bssi_UDF_L2": "",
            "Bssi_UDF_L3": "",
            "Bssi_UDF_L4": "",
            "Bssi_UDF_L5": "",
            "Bssi_UDF_L6": "0001-01-01",
            "Bssi_UDF_L7": 0,
            "Bssi_UDF_L8": false,
            "Bssi_UDF_L9": "",
            "Bssi_UDF_L10": "",
            "Bssi_UDF_L11": "",
            "Bssi_UDF_L12": "",
            "Bssi_UDF_L13": "",
            "BssiAccumulateImport": false,
            "Shortcut_Dimension_1_Code": "SALES",
            "Shortcut_Dimension_2_Code": "SMALL",
            "bssiShortcutDimension3": "",
            "bssiShortcutDimension4": "",
            "bssiShortcutDimension5": "",
            "bssiShortcutDimension6": "",
            "bssiShortcutDimension7": "",
            "bssiShortcutDimension8": ""
        },
        {
            "@odata.etag": "W/\"JzQ0O3puSVZCQytRMzFsSnBsakg0NXFZajMrSTl6SUR1U0RyaDdaUzFiTUw3aFE9MTswMDsn\"",
            "bssiArcbBillingScheduleNumber": "CONT000001",
            "LineNo": 20000,
            "Type_": "Item",
            "ItemNo": "1900-S",
            "Description": "PARIS Guest Chair, black",
            "BillingType": "Standard",
            "LocationCode": "",
            "UnitMeasureCode": "PCS",
            "Price": 192.8,
            "Qty": 1,
            "Amount": 192.8,
            "BillingFrequency": " Monthly",
            "BillingStartDate": "2021-07-01",
            "BillingEndDate": "2022-06-30",
            "Interval": 1,
            "TaxGroupCode": "FURNITURE",
            "TaxLiable": false,
            "TaxAreadCode": "N.ATL., GA",
            "AutoRenewed": false,
            "UsageOption": "Reading",
            "PricingMethod": "Standard",
            "UsageIdentifier": "",
            "InitialReading": 0,
            "RenewalLines": 1,
            "RevenueSplit": false,
            "ParentAmount": 0,
            "BssiCalculationMethod": "X Days Before Start Date",
            "BssiDayofInvoiceDate": 15,
            "BssiNumofPeriod": 12,
            "BssiAlignmentDate": "0001-01-01",
            "BssiEstimatedQty": 0,
            "BssiStatus": "Active",
            "Bssi_UDF_L1": "",
            "Bssi_UDF_L2": "",
            "Bssi_UDF_L3": "",
            "Bssi_UDF_L4": "",
            "Bssi_UDF_L5": "",
            "Bssi_UDF_L6": "0001-01-01",
            "Bssi_UDF_L7": 0,
            "Bssi_UDF_L8": false,
            "Bssi_UDF_L9": "",
            "Bssi_UDF_L10": "",
            "Bssi_UDF_L11": "",
            "Bssi_UDF_L12": "",
            "Bssi_UDF_L13": "",
            "BssiAccumulateImport": false,
            "Shortcut_Dimension_1_Code": "SALES",
            "Shortcut_Dimension_2_Code": "SMALL",
            "bssiShortcutDimension3": "",
            "bssiShortcutDimension4": "",
            "bssiShortcutDimension5": "",
            "bssiShortcutDimension6": "",
            "bssiShortcutDimension7": "",
            "bssiShortcutDimension8": ""
        }
    ]
}

Create Billing Schedule

Creates a billing schedule header. Lines can be included in the request by using the bssiBillingSchlines collection in the request body. Lines can also be attached separately with another API request. When using the Odata endpoint, the schedule number must be specified because web services does not support automatic numbering.

Request: 

  • POST /BillingSchedules
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)/BillingSchedules
ODATA V4 example:

POST https://api.businesscentral.dynamics.com/v2.0/e9db614c-882a-401b-8f75-51dbfae511a7/Sandbox/ODataV4/Company('CRONUS%20Canada%2C%20Inc.')/{ServiceName}

  • where {ServiceName} is the web service setup for SBS ARCB Billing Schedule API (Page 23065865)

Lines must be attached separately when using the OData endpoint.

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)

{
    "BillingScheduleGroup": "DEFAULT",
    "BssiSellToCustomerNo": "20000",
    "BillingStartDate": "2021-01-01",
    "bssiBillingSchlines": [
        {
            "Type_": "Item",
            "ItemNo": "1896-S",
            "Qty": 1
        }
    ]
}

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

Response (json)

{
    "@odata.context": "http://evo-default:7048/BC/ODataV4/$metadata#Company('CRONUS%20USA%2C%20Inc.')/BillingScheduleLine/$entity",
    "@odata.etag": "W/\"JzE4OzgyNDk4MTU3MDE4MTc5MDgwMjE7MDA7Jw==\"",
    "BssiArcbBillingScheduleNumber": "CONT072",
    "LineNo": 90002,
    "Type_": "Item",
    "ItemNo": "1928-S",
    "Description": "AMSTERDAM Lamp",
    "BillingType": "Standard",
    "LocationCode": "",
    "UnitMeasureCode": "PCS",
    "Price": 54.9,
    "Qty": 1,
    "Amount": 54.9,
    "BillingFrequency": " Monthly",
    "BillingStartDate": "2023-01-01",
    "BillingEndDate": "2023-12-31",
    "Interval": 1,
    "TaxGroupCode": "FURNITURE",
    "TaxLiable": true,
    "TaxAreadCode": "CHICAGO, IL",
    "AutoRenewed": true,
    "UsageOption": "Reading",
    "PricingMethod": "Standard",
    "UsageIdentifier": "",
    "InitialReading": 0,
    "RenewalLines": 1,
    "RevenueSplit": false,
    "ParentAmount": 0,
    "BssiCalculationMethod": "X Days Before Start Date",
    "BssiDayofInvoiceDate": 0,
    "BssiNumofPeriod": 12,
    "BssiAlignmentDate": "0001-01-01",
    "BssiEstimatedQty": 0,
    "BssiStatus": "Active",
    "Bssi_UDF_L1": "",
    "Bssi_UDF_L2": "",
    "Bssi_UDF_L3": "",
    "Bssi_UDF_L4": "",
    "Bssi_UDF_L5": "",
    "Bssi_UDF_L6": "0001-01-01",
    "Bssi_UDF_L7": 0,
    "Bssi_UDF_L8": false,
    "Bssi_UDF_L9": "",
    "Bssi_UDF_L10": "",
    "Bssi_UDF_L11": "",
    "Bssi_UDF_L12": "",
    "Bssi_UDF_L13": "",
    "Bssi_UDF_L14": "0001-01-01",
    "Bssi_UDF_L15": "0001-01-01",
    "Bssi_UDF_L16": "0001-01-01",
    "Bssi_UDF_L17": "0001-01-01",
    "Bssi_UDF_L18": 0,
    "Bssi_UDF_L19": false,
    "Shortcut_Dimension_1_Code": "SALES",
    "Shortcut_Dimension_2_Code": "MEDIUM",
    "bssiShortcutDimension3": "",
    "bssiShortcutDimension4": "",
    "bssiShortcutDimension5": "",
    "bssiShortcutDimension6": "",
    "bssiShortcutDimension7": "",
    "bssiShortcutDimension8": "",
    "BssiAccumulateImport": false,
    "BssiVATBusPostingGroup": "",
    "BssiVATProdPostingGroup": "",
    "BssiArcbProRatePartialPeriod": true
}

The line is created in the request, even though it is not in the response object.

Attach a New Billing Schedule Line to a Specific Billing Schedule

Creates a billing schedule line on a specific billing schedule. When using the OData endpoint, you must specify both the BillingScheduleNumber and LineNo fields in the body because web services does not support automatic number series.

Request: 

  • POST /BillingSchedules('{BillingScheduleNumber}')/bssiBillingSchlines
    • where {BillingScheduleNumber} is the identifier of a specific billing schedule
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)/BillingSchedules('CONT000003')/bssiBillingSchlines
ODATA V4 example:

POST https://api.businesscentral.dynamics.com/v2.0/e9db614c-882a-401b-8f75-51dbfae511a7/Sandbox/ODataV4/Company('CRONUS%20Canada%2C%20Inc.')/{ServiceName}

  • where {ServiceName} is the web service setup for SBS ARCB Billing Schedule Line API (Page 23065866).

The primary key must be fully identified in the request body.

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)

{
    "Type_": "Item",
    "ItemNo": "1896-S",
    "Qty": 10
}

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

Response (json)

{
    "@odata.context": "https://api.businesscentral.dynamics.com/v2.0/binarystream.com/Sandbox/api/binarystream/Arcb/beta/$metadata#companies(9abd98b5-b93c-44c1-bb8c-3bccd73d4bb0)/BillingSchedules('CONT000003')/bssiBillingSchlines/$entity",
    "@odata.etag": "W/\"JzQ0O0pFRGxTcW9VUDlhWFFqS2NhRzhDanlYL015Vk1tY3paTE9ITTdGelN6ZEU9MTswMDsn\"",
    "bssiArcbBillingScheduleNumber": "CONT000003",
    "LineNo": 30000,
    "Type_": "Item",
    "ItemNo": "1896-S",
    "Description": "ATHENS Desk",
    "BillingType": "Standard",
    "LocationCode": "",
    "UnitMeasureCode": "PCS",
    "Price": 1000.8,
    "Qty": 10,
    "Amount": 10008.0,
    "BillingFrequency": " Monthly",
    "BillingStartDate": "2021-01-01",
    "BillingEndDate": "2021-12-31",
    "Interval": 1,
    "TaxGroupCode": "FURNITURE",
    "TaxLiable": false,
    "TaxAreadCode": "CHICAGO, IL",
    "AutoRenewed": false,
    "UsageOption": "Reading",
    "PricingMethod": "Standard",
    "UsageIdentifier": "",
    "InitialReading": 0,
    "RenewalLines": 1,
    "RevenueSplit": false,
    "ParentAmount": 0,
    "BssiCalculationMethod": "X Days Before Start Date",
    "BssiDayofInvoiceDate": 0,
    "BssiNumofPeriod": 0,
    "BssiAlignmentDate": "0001-01-01",
    "BssiEstimatedQty": 0,
    "BssiStatus": "Active",
    "Bssi_UDF_L1": "",
    "Bssi_UDF_L2": "",
    "Bssi_UDF_L3": "",
    "Bssi_UDF_L4": "",
    "Bssi_UDF_L5": "",
    "Bssi_UDF_L6": "0001-01-01",
    "Bssi_UDF_L7": 0,
    "Bssi_UDF_L8": false,
    "Bssi_UDF_L9": "",
    "Bssi_UDF_L10": "",
    "Bssi_UDF_L11": "",
    "Bssi_UDF_L12": "",
    "Bssi_UDF_L13": "",
    "BssiAccumulateImport": false,
    "Shortcut_Dimension_1_Code": "SALES",
    "Shortcut_Dimension_2_Code": "MEDIUM",
    "bssiShortcutDimension3": "",
    "bssiShortcutDimension4": "",
    "bssiShortcutDimension5": "",
    "bssiShortcutDimension6": "",
    "bssiShortcutDimension7": "",
    "bssiShortcutDimension8": ""
    "BssiPriceGroupId": "TEST"
}

Modify a Billing Schedule Header

Modifies one or more fields on a specific billing schedule header.

Request: 

  • PATCH /BillingSchedules('{BillingScheduleNumber}')
    • where {BillingScheduleNumber} is the identifier of a specific billing schedule
    • when modifying a record, you must first retrieve the record to use the "@odata.etag" value in the If-Match header
Request Examples
API example: 

PATCH https://api.businesscentral.dynamics.com/v2.0/e9db614c-882a-401b-8f75-51dbfae511a7/sandbox/api/binarystream/arcb/beta/companies(c9f29336-daea-eb11-bb6e-000d3a220cdc)/BillingSchedules('CONT000003')
ODATA V4 example:

PATCH https://api.businesscentral.dynamics.com/v2.0/e9db614c-882a-401b-8f75-51dbfae511a7/Sandbox/ODataV4/Company('CRONUS%20Canada%2C%20Inc.')/{ServiceName}('CONT000003')

  • where {ServiceName} is the web service setup for SBS ARCB Billing Schedule API (Page 23065865)

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)

{
    "BssiShortcutDimension1Code": "ADM",
    "BssiShortcutDimension2Code": "SMALL"
}

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

Response (json)

{
    "@odata.context": "https://api.businesscentral.dynamics.com/v2.0/binarystream.com/Sandbox/api/binarystream/Arcb/beta/$metadata#companies(9abd98b5-b93c-44c1-bb8c-3bccd73d4bb0)/BillingSchedules/$entity",
    "@odata.etag": "W/\"JzQ0O3N6ZXJjdE5CMnRvYVM0c290dDcrQnZqUUxmOXZCVzk3MVFQVHZSN0I1VEU9MTswMDsn\"",
    "BillingScheduleNumber": "CONT000003",
    "BillingScheduleGroup": "DEFAULT",
    "BssiStatus": "Active",
    "BssiSellToCustomerNo": "20000",
    "EndUser": "",
    "BillingStartDate": "2021-01-01",
    "BillingEndDate": "2021-12-31",
    "BillingFrequency": " Monthly",
    "NumberofPeriods": 12,
    "Interval": 1,
    "AutoRenewal": false,
    "Description": "",
    "NoticeDays": 0,
    "RenewInAdvance": 0,
    "CurrencyCode": "",
    "LocationCode": "",
    "SalepersonCode": "JO",
    "ResponsibilityCenter": "",
    "PaymentTermscode": "14 DAYS",
    "BillToCustomerNo": "20000",
    "BillToName": "Trey Research",
    "BillToAddress": "153 Thomas Drive",
    "BillToAddress2": "",
    "BillToCIty": "Chicago",
    "ShipToCode": "",
    "ShipToName": "Trey Research",
    "ShipToAddress": "153 Thomas Drive",
    "ShipToAddress2": "",
    "ShipToCity": "Chicago",
    "BssiArcbDetailInvAmt": 0,
    "BillToPostalcode": "61236",
    "BillToCountry": "IL",
    "ShipToPostalCode": "61236",
    "ShipToCountry": "",
    "SellToCustomerName": "Trey Research",
    "SellToAddress": "153 Thomas Drive",
    "SellToAddress2": "",
    "SellToCity": "Chicago",
    "SellToContact": "Helen Ray",
    "SellToPostalCode": "61236",
    "SellToCountry": "IL",
    "AlignToMonth": false,
    "ProratePartialPeriod": false,
    "ShipmentMethodcode": "",
    "PkgTrackingNO": "",
    "ShippingAgentServiceCode": "",
    "ShippingAgentCode": "",
    "ShipToPostcode": "61236",
    "ShipToCountryRegn": "US",
    "ShipToContact": "Helen Ray",
    "SellToContactNo": "",
    "SellToCountryRegion": "US",
    "SellToCustomerName2": "",
    "YourRef": "",
    "ExternalDocNo": "",
    "BillToContact": "Helen Ray",
    "BillToContactNo": "",
    "BillToCountryRegion": "US",
    "InvoiceSearately": false,
    "BssiAlignmentDate": "0001-01-01",
    "TaxLiable": false,
    "TaxAreaCode": "CHICAGO, IL",
    "EstimatedQty": 0,
    "BssiUDFH1": "",
    "BssiUDFH2": "",
    "BssiUDFH3": "",
    "BssiUDFH4": "",
    "BssiUDFH5": "",
    "BssiUDFH6": "0001-01-01",
    "BssiUDFH7": 0,
    "BssiUDFH8": false,
    "BssiUDFH9": "",
    "BssiUDFH10": "",
    "BssiUDFH11": "",
    "BssiUDFH12": "",
    "BssiUDFH13": "",
    "BssiShortcutDimension1Code": "ADM",
    "BssiShortcutDimension2Code": "SMALL",
    "bssiShortcutDimension3": "",
    "bssiShortcutDimension4": "",
    "bssiShortcutDimension5": "",
    "bssiShortcutDimension6": "",
    "bssiShortcutDimension7": "",
    "bssiShortcutDimension8": ""
}

Modify a Billing Schedule Line

Modifies one or more fields on a specific billing schedule line.

Request: 

  • PATCH /BillingSchedules('{BillingScheduleNumber}')/bssiBillingSchlines({LineNo})
    • where {BillingScheduleNumber} is the identifier of a specific billing schedule
    • where {LineNo} is the identifier of a specific line on the selected billing schedule
    • when modifying a record, you must first retrieve the record to use the "@odata.etag" value in the If-Match header
Request Examples
API example: 

PATCH https://api.businesscentral.dynamics.com/v2.0/e9db614c-882a-401b-8f75-51dbfae511a7/sandbox/api/binarystream/arcb/beta/companies(c9f29336-daea-eb11-bb6e-000d3a220cdc)/BillingSchedules('CONT000003')/bssiBillingSchlines(30000)
ODATA V4 example:

PATCH https://api.businesscentral.dynamics.com/v2.0/e9db614c-882a-401b-8f75-51dbfae511a7/Sandbox/ODataV4/Company('CRONUS%20Canada%2C%20Inc.')/{ServiceName} ('CONT000003', 30000)

  • where {ServiceName} is the web service setup for SBS ARCB Billing Schedule Line API (Page 23065866)

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)

{
    "ItemNo": "1906-S",
}

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

Response (json)

{
    "@odata.context": "http://evo-default:7048/BC/ODataV4/$metadata#Company('CRONUS%20USA%2C%20Inc.')/BillingScheduleLine/$entity",
    "@odata.etag": "W/\"JzE4OzgyNDk4MTU3MDE4MTc5MDgwMjE7MDA7Jw==\"",
    "BssiArcbBillingScheduleNumber": "CONT072",
    "LineNo": 90002,
    "Type_": "Item",
    "ItemNo": "1928-S",
    "Description": "AMSTERDAM Lamp",
    "BillingType": "Standard",
    "LocationCode": "",
    "UnitMeasureCode": "PCS",
    "Price": 54.9,
    "Qty": 1,
    "Amount": 54.9,
    "BillingFrequency": " Monthly",
    "BillingStartDate": "2023-01-01",
    "BillingEndDate": "2023-12-31",
    "Interval": 1,
    "TaxGroupCode": "FURNITURE",
    "TaxLiable": true,
    "TaxAreadCode": "CHICAGO, IL",
    "AutoRenewed": true,
    "UsageOption": "Reading",
    "PricingMethod": "Standard",
    "UsageIdentifier": "",
    "InitialReading": 0,
    "RenewalLines": 1,
    "RevenueSplit": false,
    "ParentAmount": 0,
    "BssiCalculationMethod": "X Days Before Start Date",
    "BssiDayofInvoiceDate": 0,
    "BssiNumofPeriod": 12,
    "BssiAlignmentDate": "0001-01-01",
    "BssiEstimatedQty": 0,
    "BssiStatus": "Active",
    "Bssi_UDF_L1": "",
    "Bssi_UDF_L2": "",
    "Bssi_UDF_L3": "",
    "Bssi_UDF_L4": "",
    "Bssi_UDF_L5": "",
    "Bssi_UDF_L6": "0001-01-01",
    "Bssi_UDF_L7": 0,
    "Bssi_UDF_L8": false,
    "Bssi_UDF_L9": "",
    "Bssi_UDF_L10": "",
    "Bssi_UDF_L11": "",
    "Bssi_UDF_L12": "",
    "Bssi_UDF_L13": "",
    "Bssi_UDF_L14": "0001-01-01",
    "Bssi_UDF_L15": "0001-01-01",
    "Bssi_UDF_L16": "0001-01-01",
    "Bssi_UDF_L17": "0001-01-01",
    "Bssi_UDF_L18": 0,
    "Bssi_UDF_L19": false,
    "Shortcut_Dimension_1_Code": "SALES",
    "Shortcut_Dimension_2_Code": "MEDIUM",
    "bssiShortcutDimension3": "",
    "bssiShortcutDimension4": "",
    "bssiShortcutDimension5": "",
    "bssiShortcutDimension6": "",
    "bssiShortcutDimension7": "",
    "bssiShortcutDimension8": "",
    "BssiAccumulateImport": false,
    "BssiVATBusPostingGroup": "",
    "BssiVATProdPostingGroup": "",
    "BssiArcbProRatePartialPeriod": true
}

Note: A new field called BssiArcbProRatePartialPeriod has been added to the Billing Schedule Line APIs. If this field is used during an Insert request, then Its value will be set from the API otherwise It will be defaulted from Billing Schedule Header.

 

Delete a Billing Schedule

Removes a specific billing schedule (header and lines).

Request: 

  • DELETE /BillingSchedules('{BillingScheduleNumber}')
    • where {BillingScheduleNumber} is the identifier of a specific billing schedule
    • when deleting a record, you must first retrieve the record to use the "@odata.etag" value in the If-Match header
Request Examples
API example: 

DELETE https://api.businesscentral.dynamics.com/v2.0/e9db614c-882a-401b-8f75-51dbfae511a7/sandbox/api/binarystream/arcb/beta/companies(c9f29336-daea-eb11-bb6e-000d3a220cdc)/BillingSchedules('CONT000001'
ODATA V4 example:

DELETE https://api.businesscentral.dynamics.com/v2.0/e9db614c-882a-401b-8f75-51dbfae511a7/Sandbox/ODataV4/Company('CRONUS%20Canada%2C%20Inc.')/{ServiceName}('CONT000001')

  • where {ServiceName} is the web service setup for SBS ARCB Billing Schedule API (Page 23065865)

Delete a Billing Schedule Line

Removes a specific billing schedule line.

Request: 

  • `DELETE /BillingSchedules('{BillingScheduleNumber}')/bssiBillingSchlines({LineNo})`
    • where {BillingScheduleNumber} is the identifier of a specific billing schedule
    • where {LineNo} is the identifier of a specific line on the selected billing schedule
    • when deleting a record, you must first retrieve the record to use the "@odata.etag" value in the If-Match header
Request Examples
API example: 
DELETE https://api.businesscentral.dynamics.com/v2.0/e9db614c-882a-401b-8f75-51dbfae511a7/sandbox/api/binarystream/arcb/beta/companies(c9f29336-daea-eb11-bb6e-000d3a220cdc)/BillingSchedules('CONT000001')/bssiBillingSchlines(10000)
ODATA V4 example:

DELETE https://api.businesscentral.dynamics.com/v2.0/e9db614c-882a-401b-8f75-51dbfae511a7/Sandbox/ODataV4/Company('CRONUS%20Canada%2C%20Inc.')/{ServiceName}('CONT000001', 10000)

  • where {ServiceName} is the web service setup for SBS ARCB Billing Schedule Line API (Page 23065866)