Example
Suppose you have configured a recurring order line item with the following details:
|
Order No |
Order Line No |
Product |
Price Type |
Billing Frequency |
Start Date |
End Date |
Quantity |
Per Unit price |
Net Price |
Selling Term |
|---|---|---|---|---|---|---|---|---|---|---|
|
O-001 |
1 |
Service |
Recurring |
Monthly |
01 Jan 2024 |
31 Dec 2024 |
1 |
USD 1200.00 |
USD 1200.00 |
1.000 |
- Call the Initiate Billing API.
Method
POST
Endpoint
/initiatebilling
Request URL
https://<URL_of_the_Instance>/api/billing/v1/billingschedule/initiatebilling
Request
Pass the order line item ID generated by calling the Create Order Line API.
Request
{ "OrderLineItemIds": [ "d7b0ae91-8178-42c0-8b19-d2aa61eeff85" ], "ReadyForBillingDate": "2023-08-03T11:47:09.555" } Response
The API returns the Billing Header ID.
Response
[ { "OrderLineItemId": "d7b0ae91-8178-42c0-8b19-d2aa61eeff85", "BillingHeaderId": "e9a6f8c1-83a2-4dae-8847-f0ebeee6b969", "IsSuccess": true, "ErrorMessage": null } ] - Pass the Billing Header ID as a payload to Get the Billing Schedule Record API.
Method
Get
Endpoint
NA
Request URL
https://<URL_of_the_Instance>/api/billing/v1/billingschedule/6397d730-5a78-4c91-b380-dd5845e09453
Request
NA
Response
The API generates the billing header, billing schedule records and billing schedule details
Response
{ "BillingHeader": { "Contracted": true, "Status": "Active", "Message": "Success", "CurrentOrderLineItem": { "Id": "d7b0ae91-8178-42c0-8b19-d2aa61eeff85", "Name": "Test_122" }, "CurrentOrderNumber": { "Id": "8614eae4-d778-42be-ad66-12fe743211c7", "Name": "Order-AutoQuoteService_Name_0" }, "ProductName": "Test_Standalone_D", "PriceType": "Recurring", "PricingSource": "Order Line Item", "BillTo": { "Id": "e3bc1cb9-40e1-4a9e-bfed-8ac7df9de653", "Name": "MS_Test_Acct" }, "BillingStartDate": "2023-01-01T11:47:09.555", "BillingEndDate": "2023-12-31T11:47:09.555", "BillingFrequency": "Monthly", "BillingRule": "Bill In Arrears", "BillingPreference": { "Id": "5d1d70c4-208c-4807-b4d1-ae319e6f4b39", "Name": "MRS_BillPref_3600" }, "Quantity": 1.00000, "SellingTerm": 1.00000000, "Currency": "USD", "NetUnitPrice": { "Value": 1200, "DisplayValue": 1200, "CurrencyCode": "USD", "CurrencySymbol": "$" }, "CurrentUnbilledAmount": { "Value": 1200, "DisplayValue": 1200, "CurrencyCode": "USD", "CurrencySymbol": "$" }, "PendingInvoiceAmount": { "Value": 1200, "DisplayValue": 1200, "CurrencyCode": "USD", "CurrencySymbol": "$" }, "ProrationComputationMethod": "Calendar Days of First Month", "Id": "e9a6f8c1-83a2-4dae-8847-f0ebeee6b969", "Name": "BH-8614eae4-d778-42be-ad66-12fe743211c7", "CreatedBy": { "Id": "72d0d16b-470c-4db7-ae9d-9645fa9c4ea0", "Name": "Contacts user" }, "CreatedDate": "2023-09-28T10:14:41.249", "ModifiedBy": { "Id": "72d0d16b-470c-4db7-ae9d-9645fa9c4ea0", "Name": "Contacts user" }, "ModifiedDate": "2023-09-28T10:14:41.249", "ExternalId": null, "ETag": "e49d6345-b69c-4aee-9913-396f5afd1636" }, "BillingScheduleRecords": [ { "BillingScheduleRecord": { "BillingHeader": { "Id": "e9a6f8c1-83a2-4dae-8847-f0ebeee6b969", "Name": "BH-8614eae4-d778-42be-ad66-12fe743211c7" }, "PeriodStartDate": "2023-01-01T00:00:00", "PeriodEndDate": "2023-01-31T00:00:00", "Currency": "USD", "ActualFeeAmount": { "Value": 100, "DisplayValue": 100, "CurrencyCode": "USD", "CurrencySymbol": "$" }, "Status": "Pending Billing", "PaymentTerm": null, "ReadyForInvoiceDate": "2023-08-03T00:00:00", "Id": "7c3e5df8-9f7f-46b4-acdc-4b84a19b6dc3", "Name": "BSR-1_8614eae4-d778-42be-ad66-12fe743211c7", "CreatedBy": { "Id": "72d0d16b-470c-4db7-ae9d-9645fa9c4ea0", "Name": "Contacts user" }, "CreatedDate": "2023-09-28T10:14:41.389", "ModifiedBy": { "Id": "72d0d16b-470c-4db7-ae9d-9645fa9c4ea0", "Name": "Contacts user" }, "ModifiedDate": "2023-09-28T10:14:41.389", "ExternalId": null, "ETag": "a2fee235-04a8-4131-8194-b58cc843cc98" }, "BillingScheduleDetails": [ { "BillingScheduleRecord": { "Id": "7c3e5df8-9f7f-46b4-acdc-4b84a19b6dc3", "Name": "BSR-1_8614eae4-d778-42be-ad66-12fe743211c7" }, "RecordType": "Regular", "PeriodStartDate": "2023-01-01T00:00:00", "PeriodEndDate": "2023-01-31T00:00:00", "Category": "Fee", "ActualFeeAmount": { "Value": 100, "DisplayValue": 100, "CurrencyCode": "USD", "CurrencySymbol": "$" }, "Id": "1637cc7f-b7fc-47c5-8f55-2ce55246b260", "Name": "BSD-1_8614eae4-d778-42be-ad66-12fe743211c7", "CreatedBy": { "Id": "72d0d16b-470c-4db7-ae9d-9645fa9c4ea0", "Name": "Contacts user" }, "CreatedDate": "2023-09-28T10:14:41.711", "ModifiedBy": { "Id": "72d0d16b-470c-4db7-ae9d-9645fa9c4ea0", "Name": "Contacts user" }, "ModifiedDate": "2023-09-28T10:14:41.711", "ExternalId": null, "ETag": "a840a283-561e-4182-b22e-70f1722e50cf", "Currency": "USD" } ] }, { "BillingScheduleRecord": { "BillingHeader": { "Id": "e9a6f8c1-83a2-4dae-8847-f0ebeee6b969", "Name": "BH-8614eae4-d778-42be-ad66-12fe743211c7" }, "PeriodStartDate": "2023-02-01T00:00:00", "PeriodEndDate": "2023-02-28T00:00:00", "Currency": "USD", "ActualFeeAmount": { "Value": 100, "DisplayValue": 100, "CurrencyCode": "USD", "CurrencySymbol": "$" }, "Status": "Pending Billing", "PaymentTerm": null, "ReadyForInvoiceDate": "2023-08-03T00:00:00", "Id": "d7e4b947-8080-4401-b944-b38edade0be4", "Name": "BSR-2_8614eae4-d778-42be-ad66-12fe743211c7", "CreatedBy": { "Id": "72d0d16b-470c-4db7-ae9d-9645fa9c4ea0", "Name": "Contacts user" }, "CreatedDate": "2023-09-28T10:14:41.389", "ModifiedBy": { "Id": "72d0d16b-470c-4db7-ae9d-9645fa9c4ea0", "Name": "Contacts user" }, "ModifiedDate": "2023-09-28T10:14:41.389", "ExternalId": null, "ETag": "6bc134fe-2f1e-4566-b8f9-c6d5ef2bb988" }, "BillingScheduleDetails": [ { "BillingScheduleRecord": { "Id": "d7e4b947-8080-4401-b944-b38edade0be4", "Name": "BSR-2_8614eae4-d778-42be-ad66-12fe743211c7" }, "RecordType": "Regular", "PeriodStartDate": "2023-02-01T00:00:00", "PeriodEndDate": "2023-02-28T00:00:00", "Category": "Fee", "ActualFeeAmount": { "Value": 100, "DisplayValue": 100, "CurrencyCode": "USD", "CurrencySymbol": "$" }, "Id": "b883feb6-4625-4fb1-8dee-a6906b13be39", "Name": "BSD-2_8614eae4-d778-42be-ad66-12fe743211c7", "CreatedBy": { "Id": "72d0d16b-470c-4db7-ae9d-9645fa9c4ea0", "Name": "Contacts user" }, "CreatedDate": "2023-09-28T10:14:41.711", "ModifiedBy": { "Id": "72d0d16b-470c-4db7-ae9d-9645fa9c4ea0", "Name": "Contacts user" }, "ModifiedDate": "2023-09-28T10:14:41.711", "ExternalId": null, "ETag": "58d2659f-7eac-4725-852d-4b52e12f2cdb", "Currency": "USD" } ] }, { "BillingScheduleRecord": { "BillingHeader": { "Id": "e9a6f8c1-83a2-4dae-8847-f0ebeee6b969", "Name": "BH-8614eae4-d778-42be-ad66-12fe743211c7" }, "PeriodStartDate": "2023-03-01T00:00:00", "PeriodEndDate": "2023-03-31T00:00:00", "Currency": "USD", "ActualFeeAmount": { "Value": 100, "DisplayValue": 100, "CurrencyCode": "USD", "CurrencySymbol": "$" }, "Status": "Pending Billing", "PaymentTerm": null, "ReadyForInvoiceDate": "2023-08-03T00:00:00", "Id": "42494d77-0e62-4988-a9e0-ddc2e33919ec", "Name": "BSR-3_8614eae4-d778-42be-ad66-12fe743211c7", "CreatedBy": { "Id": "72d0d16b-470c-4db7-ae9d-9645fa9c4ea0", "Name": "Contacts user" }, "CreatedDate": "2023-09-28T10:14:41.389", "ModifiedBy": { "Id": "72d0d16b-470c-4db7-ae9d-9645fa9c4ea0", "Name": "Contacts user" }, "ModifiedDate": "2023-09-28T10:14:41.389", "ExternalId": null, "ETag": "7cfaeabf-288b-4b79-9207-7e8dbba58a97" }, "BillingScheduleDetails": [ { "BillingScheduleRecord": { "Id": "42494d77-0e62-4988-a9e0-ddc2e33919ec", "Name": "BSR-3_8614eae4-d778-42be-ad66-12fe743211c7" }, "RecordType": "Regular", "PeriodStartDate": "2023-03-01T00:00:00", "PeriodEndDate": "2023-03-31T00:00:00", "Category": "Fee", "ActualFeeAmount": { "Value": 100, "DisplayValue": 100, "CurrencyCode": "USD", "CurrencySymbol": "$" }, "Id": "253e49ef-c3a2-43b9-8ca5-39d3d6b770c7", "Name": "BSD-3_8614eae4-d778-42be-ad66-12fe743211c7", "CreatedBy": { "Id": "72d0d16b-470c-4db7-ae9d-9645fa9c4ea0", "Name": "Contacts user" }, "CreatedDate": "2023-09-28T10:14:41.711", "ModifiedBy": { "Id": "72d0d16b-470c-4db7-ae9d-9645fa9c4ea0", "Name": "Contacts user" }, "ModifiedDate": "2023-09-28T10:14:41.711", "ExternalId": null, "ETag": "1f1fe696-7870-4af9-aeb5-a0c1097e83a6", "Currency": "USD" } ] }, { "BillingScheduleRecord": { "BillingHeader": { "Id": "e9a6f8c1-83a2-4dae-8847-f0ebeee6b969", "Name": "BH-8614eae4-d778-42be-ad66-12fe743211c7" }, "PeriodStartDate": "2023-04-01T00:00:00", "PeriodEndDate": "2023-04-30T00:00:00", "Currency": "USD", "ActualFeeAmount": { "Value": 100, "DisplayValue": 100, "CurrencyCode": "USD", "CurrencySymbol": "$" }, "Status": "Pending Billing", "PaymentTerm": null, "ReadyForInvoiceDate": "2023-08-03T00:00:00", "Id": "9169f687-bcb0-42b0-9040-fc4e28c2d77b", "Name": "BSR-4_8614eae4-d778-42be-ad66-12fe743211c7", "CreatedBy": { "Id": "72d0d16b-470c-4db7-ae9d-9645fa9c4ea0", "Name": "Contacts user" }, "CreatedDate": "2023-09-28T10:14:41.389", "ModifiedBy": { "Id": "72d0d16b-470c-4db7-ae9d-9645fa9c4ea0", "Name": "Contacts user" }, "ModifiedDate": "2023-09-28T10:14:41.389", "ExternalId": null, "ETag": "9835fb27-2dcd-456c-ad06-c9fec2f1e642" }, "BillingScheduleDetails": [ { "BillingScheduleRecord": { "Id": "9169f687-bcb0-42b0-9040-fc4e28c2d77b", "Name": "BSR-4_8614eae4-d778-42be-ad66-12fe743211c7" }, "RecordType": "Regular", "PeriodStartDate": "2023-04-01T00:00:00", "PeriodEndDate": "2023-04-30T00:00:00", "Category": "Fee", "ActualFeeAmount": { "Value": 100, "DisplayValue": 100, "CurrencyCode": "USD", "CurrencySymbol": "$" }, "Id": "4aea065c-7a27-4106-9639-e964257fec2a", "Name": "BSD-4_8614eae4-d778-42be-ad66-12fe743211c7", "CreatedBy": { "Id": "72d0d16b-470c-4db7-ae9d-9645fa9c4ea0", "Name": "Contacts user" }, "CreatedDate": "2023-09-28T10:14:41.711", "ModifiedBy": { "Id": "72d0d16b-470c-4db7-ae9d-9645fa9c4ea0", "Name": "Contacts user" }, "ModifiedDate": "2023-09-28T10:14:41.711", "ExternalId": null, "ETag": "e7fd94e7-7508-4f7c-baf2-0d7082a94bb4", "Currency": "USD" } ] }, { "BillingScheduleRecord": { "BillingHeader": { "Id": "e9a6f8c1-83a2-4dae-8847-f0ebeee6b969", "Name": "BH-8614eae4-d778-42be-ad66-12fe743211c7" }, "PeriodStartDate": "2023-05-01T00:00:00", "PeriodEndDate": "2023-05-31T00:00:00", "Currency": "USD", "ActualFeeAmount": { "Value": 100, "DisplayValue": 100, "CurrencyCode": "USD", "CurrencySymbol": "$" }, "Status": "Pending Billing", "PaymentTerm": null, "ReadyForInvoiceDate": "2023-08-03T00:00:00", "Id": "28fdd569-2016-4252-b2ad-23f9f57f75ab", "Name": "BSR-5_8614eae4-d778-42be-ad66-12fe743211c7", "CreatedBy": { "Id": "72d0d16b-470c-4db7-ae9d-9645fa9c4ea0", "Name": "Contacts user" }, "CreatedDate": "2023-09-28T10:14:41.389", "ModifiedBy": { "Id": "72d0d16b-470c-4db7-ae9d-9645fa9c4ea0", "Name": "Contacts user" }, "ModifiedDate": "2023-09-28T10:14:41.389", "ExternalId": null, "ETag": "b576a6b8-4f7c-4da3-97d5-62fd6f464340" }, "BillingScheduleDetails": [ { "BillingScheduleRecord": { "Id": "28fdd569-2016-4252-b2ad-23f9f57f75ab", "Name": "BSR-5_8614eae4-d778-42be-ad66-12fe743211c7" }, "RecordType": "Regular", "PeriodStartDate": "2023-05-01T00:00:00", "PeriodEndDate": "2023-05-31T00:00:00", "Category": "Fee", "ActualFeeAmount": { "Value": 100, "DisplayValue": 100, "CurrencyCode": "USD", "CurrencySymbol": "$" }, "Id": "b5e346bc-6ddf-4336-8094-00abf8308c51", "Name": "BSD-5_8614eae4-d778-42be-ad66-12fe743211c7", "CreatedBy": { "Id": "72d0d16b-470c-4db7-ae9d-9645fa9c4ea0", "Name": "Contacts user" }, "CreatedDate": "2023-09-28T10:14:41.711", "ModifiedBy": { "Id": "72d0d16b-470c-4db7-ae9d-9645fa9c4ea0", "Name": "Contacts user" }, "ModifiedDate": "2023-09-28T10:14:41.711", "ExternalId": null, "ETag": "f41a2700-ec0a-4b53-b007-536940cf5dda", "Currency": "USD" } ] }, { "BillingScheduleRecord": { "BillingHeader": { "Id": "e9a6f8c1-83a2-4dae-8847-f0ebeee6b969", "Name": "BH-8614eae4-d778-42be-ad66-12fe743211c7" }, "PeriodStartDate": "2023-06-01T00:00:00", "PeriodEndDate": "2023-06-30T00:00:00", "Currency": "USD", "ActualFeeAmount": { "Value": 100, "DisplayValue": 100, "CurrencyCode": "USD", "CurrencySymbol": "$" }, "Status": "Pending Billing", "PaymentTerm": null, "ReadyForInvoiceDate": "2023-08-03T00:00:00", "Id": "9d3e91d2-1009-4c0c-b802-cc0ddfdcb52d", "Name": "BSR-6_8614eae4-d778-42be-ad66-12fe743211c7", "CreatedBy": { "Id": "72d0d16b-470c-4db7-ae9d-9645fa9c4ea0", "Name": "Contacts user" }, "CreatedDate": "2023-09-28T10:14:41.389", "ModifiedBy": { "Id": "72d0d16b-470c-4db7-ae9d-9645fa9c4ea0", "Name": "Contacts user" }, "ModifiedDate": "2023-09-28T10:14:41.389", "ExternalId": null, "ETag": "a4fc6b4e-8bc8-4037-bddf-e77229043151" }, "BillingScheduleDetails": [ { "BillingScheduleRecord": { "Id": "9d3e91d2-1009-4c0c-b802-cc0ddfdcb52d", "Name": "BSR-6_8614eae4-d778-42be-ad66-12fe743211c7" }, "RecordType": "Regular", "PeriodStartDate": "2023-06-01T00:00:00", "PeriodEndDate": "2023-06-30T00:00:00", "Category": "Fee", "ActualFeeAmount": { "Value": 100, "DisplayValue": 100, "CurrencyCode": "USD", "CurrencySymbol": "$" }, "Id": "b83638c9-ab52-4c2f-8e01-921941daa914", "Name": "BSD-6_8614eae4-d778-42be-ad66-12fe743211c7", "CreatedBy": { "Id": "72d0d16b-470c-4db7-ae9d-9645fa9c4ea0", "Name": "Contacts user" }, "CreatedDate": "2023-09-28T10:14:41.711", "ModifiedBy": { "Id": "72d0d16b-470c-4db7-ae9d-9645fa9c4ea0", "Name": "Contacts user" }, "ModifiedDate": "2023-09-28T10:14:41.711", "ExternalId": null, "ETag": "05fa31ac-9b79-40cb-b243-69f78d4bc8dc", "Currency": "USD" } ] }, { "BillingScheduleRecord": { "BillingHeader": { "Id": "e9a6f8c1-83a2-4dae-8847-f0ebeee6b969", "Name": "BH-8614eae4-d778-42be-ad66-12fe743211c7" }, "PeriodStartDate": "2023-07-01T00:00:00", "PeriodEndDate": "2023-07-31T00:00:00", "Currency": "USD", "ActualFeeAmount": { "Value": 100, "DisplayValue": 100, "CurrencyCode": "USD", "CurrencySymbol": "$" }, "Status": "Pending Billing", "PaymentTerm": null, "ReadyForInvoiceDate": "2023-08-03T00:00:00", "Id": "67b4fa08-2b60-4c37-abe8-f91747ddbb42", "Name": "BSR-7_8614eae4-d778-42be-ad66-12fe743211c7", "CreatedBy": { "Id": "72d0d16b-470c-4db7-ae9d-9645fa9c4ea0", "Name": "Contacts user" }, "CreatedDate": "2023-09-28T10:14:41.389", "ModifiedBy": { "Id": "72d0d16b-470c-4db7-ae9d-9645fa9c4ea0", "Name": "Contacts user" }, "ModifiedDate": "2023-09-28T10:14:41.389", "ExternalId": null, "ETag": "c403e7d1-15ea-4a74-9339-243ce5332a40" }, "BillingScheduleDetails": [ { "BillingScheduleRecord": { "Id": "67b4fa08-2b60-4c37-abe8-f91747ddbb42", "Name": "BSR-7_8614eae4-d778-42be-ad66-12fe743211c7" }, "RecordType": "Regular", "PeriodStartDate": "2023-07-01T00:00:00", "PeriodEndDate": "2023-07-31T00:00:00", "Category": "Fee", "ActualFeeAmount": { "Value": 100, "DisplayValue": 100, "CurrencyCode": "USD", "CurrencySymbol": "$" }, "Id": "6ad5a14b-8e6e-46c3-8140-a14b3a48dda2", "Name": "BSD-7_8614eae4-d778-42be-ad66-12fe743211c7", "CreatedBy": { "Id": "72d0d16b-470c-4db7-ae9d-9645fa9c4ea0", "Name": "Contacts user" }, "CreatedDate": "2023-09-28T10:14:41.711", "ModifiedBy": { "Id": "72d0d16b-470c-4db7-ae9d-9645fa9c4ea0", "Name": "Contacts user" }, "ModifiedDate": "2023-09-28T10:14:41.711", "ExternalId": null, "ETag": "e41fbbcd-1c25-4f5c-a3c2-bfb2058435b0", "Currency": "USD" } ] }, { "BillingScheduleRecord": { "BillingHeader": { "Id": "e9a6f8c1-83a2-4dae-8847-f0ebeee6b969", "Name": "BH-8614eae4-d778-42be-ad66-12fe743211c7" }, "PeriodStartDate": "2023-08-01T00:00:00", "PeriodEndDate": "2023-08-31T00:00:00", "Currency": "USD", "ActualFeeAmount": { "Value": 100, "DisplayValue": 100, "CurrencyCode": "USD", "CurrencySymbol": "$" }, "Status": "Pending Billing", "PaymentTerm": null, "ReadyForInvoiceDate": "2023-09-01T00:00:00", "Id": "0e9ba21c-0f7e-472c-82ff-19485f080589", "Name": "BSR-8_8614eae4-d778-42be-ad66-12fe743211c7", "CreatedBy": { "Id": "72d0d16b-470c-4db7-ae9d-9645fa9c4ea0", "Name": "Contacts user" }, "CreatedDate": "2023-09-28T10:14:41.392", "ModifiedBy": { "Id": "72d0d16b-470c-4db7-ae9d-9645fa9c4ea0", "Name": "Contacts user" }, "ModifiedDate": "2023-09-28T10:14:41.392", "ExternalId": null, "ETag": "cbd7c07d-ab47-48ae-9a2e-036c37d813c4" }, "BillingScheduleDetails": [ { "BillingScheduleRecord": { "Id": "0e9ba21c-0f7e-472c-82ff-19485f080589", "Name": "BSR-8_8614eae4-d778-42be-ad66-12fe743211c7" }, "RecordType": "Regular", "PeriodStartDate": "2023-08-01T00:00:00", "PeriodEndDate": "2023-08-31T00:00:00", "Category": "Fee", "ActualFeeAmount": { "Value": 100, "DisplayValue": 100, "CurrencyCode": "USD", "CurrencySymbol": "$" }, "Id": "873230fd-3e70-4d8a-a2f9-56cc1c381cd1", "Name": "BSD-8_8614eae4-d778-42be-ad66-12fe743211c7", "CreatedBy": { "Id": "72d0d16b-470c-4db7-ae9d-9645fa9c4ea0", "Name": "Contacts user" }, "CreatedDate": "2023-09-28T10:14:41.711", "ModifiedBy": { "Id": "72d0d16b-470c-4db7-ae9d-9645fa9c4ea0", "Name": "Contacts user" }, "ModifiedDate": "2023-09-28T10:14:41.711", "ExternalId": null, "ETag": "8e327385-2ab7-4676-be35-4f32cb48e5cc", "Currency": "USD" } ] }, { "BillingScheduleRecord": { "BillingHeader": { "Id": "e9a6f8c1-83a2-4dae-8847-f0ebeee6b969", "Name": "BH-8614eae4-d778-42be-ad66-12fe743211c7" }, "PeriodStartDate": "2023-09-01T00:00:00", "PeriodEndDate": "2023-09-30T00:00:00", "Currency": "USD", "ActualFeeAmount": { "Value": 100, "DisplayValue": 100, "CurrencyCode": "USD", "CurrencySymbol": "$" }, "Status": "Pending Billing", "PaymentTerm": null, "ReadyForInvoiceDate": "2023-10-01T00:00:00", "Id": "6e1767c7-1de0-419c-a832-4812ff811160", "Name": "BSR-9_8614eae4-d778-42be-ad66-12fe743211c7", "CreatedBy": { "Id": "72d0d16b-470c-4db7-ae9d-9645fa9c4ea0", "Name": "Contacts user" }, "CreatedDate": "2023-09-28T10:14:41.39", "ModifiedBy": { "Id": "72d0d16b-470c-4db7-ae9d-9645fa9c4ea0", "Name": "Contacts user" }, "ModifiedDate": "2023-09-28T10:14:41.39", "ExternalId": null, "ETag": "d4e0537c-3f64-4805-823e-91c36201fb5e" }, "BillingScheduleDetails": [ { "BillingScheduleRecord": { "Id": "6e1767c7-1de0-419c-a832-4812ff811160", "Name": "BSR-9_8614eae4-d778-42be-ad66-12fe743211c7" }, "RecordType": "Regular", "PeriodStartDate": "2023-09-01T00:00:00", "PeriodEndDate": "2023-09-30T00:00:00", "Category": "Fee", "ActualFeeAmount": { "Value": 100, "DisplayValue": 100, "CurrencyCode": "USD", "CurrencySymbol": "$" }, "Id": "0691eebb-4dd1-47be-9ae7-0735e7720d25", "Name": "BSD-9_8614eae4-d778-42be-ad66-12fe743211c7", "CreatedBy": { "Id": "72d0d16b-470c-4db7-ae9d-9645fa9c4ea0", "Name": "Contacts user" }, "CreatedDate": "2023-09-28T10:14:41.716", "ModifiedBy": { "Id": "72d0d16b-470c-4db7-ae9d-9645fa9c4ea0", "Name": "Contacts user" }, "ModifiedDate": "2023-09-28T10:14:41.716", "ExternalId": null, "ETag": "07855853-4b18-4c9e-93c2-612e4104961d", "Currency": "USD" } ] }, { "BillingScheduleRecord": { "BillingHeader": { "Id": "e9a6f8c1-83a2-4dae-8847-f0ebeee6b969", "Name": "BH-8614eae4-d778-42be-ad66-12fe743211c7" }, "PeriodStartDate": "2023-10-01T00:00:00", "PeriodEndDate": "2023-10-31T00:00:00", "Currency": "USD", "ActualFeeAmount": { "Value": 100, "DisplayValue": 100, "CurrencyCode": "USD", "CurrencySymbol": "$" }, "Status": "Pending Billing", "PaymentTerm": null, "ReadyForInvoiceDate": "2023-11-01T00:00:00", "Id": "492dac35-0a8a-4b99-b7b1-267d0f7fb98c", "Name": "BSR-10_8614eae4-d778-42be-ad66-12fe743211c7", "CreatedBy": { "Id": "72d0d16b-470c-4db7-ae9d-9645fa9c4ea0", "Name": "Contacts user" }, "CreatedDate": "2023-09-28T10:14:41.39", "ModifiedBy": { "Id": "72d0d16b-470c-4db7-ae9d-9645fa9c4ea0", "Name": "Contacts user" }, "ModifiedDate": "2023-09-28T10:14:41.39", "ExternalId": null, "ETag": "4e9843cc-86fc-4ed6-b419-52e4f8f3d991" }, "BillingScheduleDetails": [ { "BillingScheduleRecord": { "Id": "492dac35-0a8a-4b99-b7b1-267d0f7fb98c", "Name": "BSR-10_8614eae4-d778-42be-ad66-12fe743211c7" }, "RecordType": "Regular", "PeriodStartDate": "2023-10-01T00:00:00", "PeriodEndDate": "2023-10-31T00:00:00", "Category": "Fee", "ActualFeeAmount": { "Value": 100, "DisplayValue": 100, "CurrencyCode": "USD", "CurrencySymbol": "$" }, "Id": "6d0a114d-d712-4142-b54d-3af4426c5f25", "Name": "BSD-10_8614eae4-d778-42be-ad66-12fe743211c7", "CreatedBy": { "Id": "72d0d16b-470c-4db7-ae9d-9645fa9c4ea0", "Name": "Contacts user" }, "CreatedDate": "2023-09-28T10:14:41.712", "ModifiedBy": { "Id": "72d0d16b-470c-4db7-ae9d-9645fa9c4ea0", "Name": "Contacts user" }, "ModifiedDate": "2023-09-28T10:14:41.712", "ExternalId": null, "ETag": "618fa254-ae72-4270-83c1-ef4660998a55", "Currency": "USD" } ] }, { "BillingScheduleRecord": { "BillingHeader": { "Id": "e9a6f8c1-83a2-4dae-8847-f0ebeee6b969", "Name": "BH-8614eae4-d778-42be-ad66-12fe743211c7" }, "PeriodStartDate": "2023-11-01T00:00:00", "PeriodEndDate": "2023-11-30T00:00:00", "Currency": "USD", "ActualFeeAmount": { "Value": 100, "DisplayValue": 100, "CurrencyCode": "USD", "CurrencySymbol": "$" }, "Status": "Pending Billing", "PaymentTerm": null, "ReadyForInvoiceDate": "2023-12-01T00:00:00", "Id": "3ed350fa-e046-4d2a-ba9c-807ead1c8f38", "Name": "BSR-11_8614eae4-d778-42be-ad66-12fe743211c7", "CreatedBy": { "Id": "72d0d16b-470c-4db7-ae9d-9645fa9c4ea0", "Name": "Contacts user" }, "CreatedDate": "2023-09-28T10:14:41.39", "ModifiedBy": { "Id": "72d0d16b-470c-4db7-ae9d-9645fa9c4ea0", "Name": "Contacts user" }, "ModifiedDate": "2023-09-28T10:14:41.39", "ExternalId": null, "ETag": "1860ab02-c822-44f2-a7b7-c2f027c57212" }, "BillingScheduleDetails": [ { "BillingScheduleRecord": { "Id": "3ed350fa-e046-4d2a-ba9c-807ead1c8f38", "Name": "BSR-11_8614eae4-d778-42be-ad66-12fe743211c7" }, "RecordType": "Regular", "PeriodStartDate": "2023-11-01T00:00:00", "PeriodEndDate": "2023-11-30T00:00:00", "Category": "Fee", "ActualFeeAmount": { "Value": 100, "DisplayValue": 100, "CurrencyCode": "USD", "CurrencySymbol": "$" }, "Id": "ab630ec2-937c-4197-b345-d4b3de9745e7", "Name": "BSD-11_8614eae4-d778-42be-ad66-12fe743211c7", "CreatedBy": { "Id": "72d0d16b-470c-4db7-ae9d-9645fa9c4ea0", "Name": "Contacts user" }, "CreatedDate": "2023-09-28T10:14:41.712", "ModifiedBy": { "Id": "72d0d16b-470c-4db7-ae9d-9645fa9c4ea0", "Name": "Contacts user" }, "ModifiedDate": "2023-09-28T10:14:41.712", "ExternalId": null, "ETag": "5e89c4e1-e492-467e-a337-1a783d877a65", "Currency": "USD" } ] }, { "BillingScheduleRecord": { "BillingHeader": { "Id": "e9a6f8c1-83a2-4dae-8847-f0ebeee6b969", "Name": "BH-8614eae4-d778-42be-ad66-12fe743211c7" }, "PeriodStartDate": "2023-12-01T00:00:00", "PeriodEndDate": "2023-12-31T00:00:00", "Currency": "USD", "ActualFeeAmount": { "Value": 100, "DisplayValue": 100, "CurrencyCode": "USD", "CurrencySymbol": "$" }, "Status": "Pending Billing", "PaymentTerm": null, "ReadyForInvoiceDate": "2024-01-01T00:00:00", "Id": "c838d570-1e3d-4576-b5a3-d701f7658dbf", "Name": "BSR-12_8614eae4-d778-42be-ad66-12fe743211c7", "CreatedBy": { "Id": "72d0d16b-470c-4db7-ae9d-9645fa9c4ea0", "Name": "Contacts user" }, "CreatedDate": "2023-09-28T10:14:41.39", "ModifiedBy": { "Id": "72d0d16b-470c-4db7-ae9d-9645fa9c4ea0", "Name": "Contacts user" }, "ModifiedDate": "2023-09-28T10:14:41.39", "ExternalId": null, "ETag": "7d2f44f4-a514-4cfa-9e3e-c9332e39a6e7" }, "BillingScheduleDetails": [ { "BillingScheduleRecord": { "Id": "c838d570-1e3d-4576-b5a3-d701f7658dbf", "Name": "BSR-12_8614eae4-d778-42be-ad66-12fe743211c7" }, "RecordType": "Regular", "PeriodStartDate": "2023-12-01T00:00:00", "PeriodEndDate": "2023-12-31T00:00:00", "Category": "Fee", "ActualFeeAmount": { "Value": 100, "DisplayValue": 100, "CurrencyCode": "USD", "CurrencySymbol": "$" }, "Id": "8d4e33c0-2029-4967-b7d0-af6ad67c6c7e", "Name": "BSD-12_8614eae4-d778-42be-ad66-12fe743211c7", "CreatedBy": { "Id": "72d0d16b-470c-4db7-ae9d-9645fa9c4ea0", "Name": "Contacts user" }, "CreatedDate": "2023-09-28T10:14:41.712", "ModifiedBy": { "Id": "72d0d16b-470c-4db7-ae9d-9645fa9c4ea0", "Name": "Contacts user" }, "ModifiedDate": "2023-09-28T10:14:41.712", "ExternalId": null, "ETag": "4e96a3a3-bc5d-4595-ae66-acc4698453b0", "Currency": "USD" } ] } ] } The billing header uses the information from the order line item and contains the following data. Depending upon the information given for the pricing source, It will pick up the pricing information from the order line item or the asset line item. The Billing Header shows:
Billing Header ID
Order No
Order Line No
Product
Price Type
Billing Frequency
Billing Rule
Start Date
End Date
Quantity
Net Unit Price
Selling Term
Bill To
Pricing Source
Billing Preference
BH-001
O-001
1
Service
Recurring
Monthly
Bill In Advance
01 Jan 2024
31 Dec 2024
1
USD 1200.00
1.000
ABC Corporation
OLI
Billing Preference
Twelve Billing Schedule Records are generated showing the following output:
Billing Schedule Record No
Billing Header ID
Period Start Date
Period End Date
Currency
Actual Fee Amount
Ready for Invoice Date
Status
BSR-001
BH-001
01 Jan 2024
31 Jan 2024
USD
USD 100.00
01 Jan 2024
Pending Billing
BSR-002
BH-001
01 Feb 2024
29 Feb 2024
USD
USD 100.00
01 Feb 2024
Pending Billing
BSR-003
BH-001
01 Mar 2024
31 Mar 2024
USD
USD 100.00
01 Mar 2024
Pending Billing
BSR-004
BH-001
01 Apr 2024
30 Apr 2024
USD
USD 100.00
01 Apr 2024
Pending Billing
BSR-005
BH-001
01 May 2024
31 May 2024
USD
USD 100.00
01 May 2024
Pending Billing
BSR-006
BH-001
01 Jun 2024
30 Jun 2024
USD
USD 100.00
01 Jun 2024
Pending Billing
BSR-007
BH-001
01 Jul 2024
31 Jul 2024
USD
USD 100.00
01 Jul 2024
Pending Billing
BSR-008
BH-001
01 Aug 2024
31 Aug 2024
USD
USD 100.00
01 Aug 2024
Pending Billing
BSR-009
BH-001
01 Sep 2024
30 Sep 2024
USD
USD 100.00
01 Sep 2024
Pending Billing
BSR-010
BH-001
01 Oct 2024
31 Oct 2024
USD
USD 100.00
01 Oct 2024
Pending Billing
BSR-011
BH-001
01 Nov 2024
30 Nov 2024
USD
USD 100.00
01 Nov 2024
Pending Billing
BSR-012
BH-001
01 Dec 2024
31 Dec 2024
USD
USD 100.00
01 Dec 2024
Pending Billing
Note: The Actual Fee Amount shown in the billing schedule record is the amount that is billed to the customer.Billing Schedule Details show the following information:
Billing Schedule Detail No
Billing Schedule Record No
Record Type
Period Start Date
Period End Date
Category
Actual Fee Amount
BSD-001
BSR-001
Regular
01 Jan 2024
31 Jan 2024
Fee
USD 100.00
BSD-002
BSR-002
Regular
01 Feb 2024
29 Feb 2024
Fee
USD 100.00
BSD-003
BSR-003
Regular
01 Mar 2024
31 Mar 2024
Fee
USD 100.00
BSD-004
BSR-004
Regular
01 Apr 2024
30 Apr 2024
Fee
USD 100.00
BSD-005
BSR-005
Regular
01 May 2024
31 May 2024
Fee
USD 100.00
BSD-006
BSR-006
Regular
01 Jun 2024
30 Jun 2024
Fee
USD 100.00
BSD-007
BSR-007
Regular
01 Jul 2024
31 Jul 2024
Fee
USD 100.00
BSD-008
BSR-008
Regular
01 Aug 2024
31 Aug 2024
Fee
USD 100.00
BSD-009
BSR-009
Regular
01 Sep 2024
30 Sep 2024
Fee
USD 100.00
BSD-010
BSR-010
Regular
01 Oct 2024
31 Oct 2024
Fee
USD 100.00
BSD-011
BSR-011
Regular
01 Nov 2024
30 Nov 2024
Fee
USD 100.00
BSD-012
BSR-012
Regular
01 Dec 2024
31 Dec 2024
Fee
USD 100.00
