Create Standalone Billing Schedules (POST)

You can create a billing schedule from any sObject such as WorkOrder, Cart, Order, Opportunity, and insurance policy.

The Create Standalone Billing Schedules (POST) API uses the StandaloneBillingContext context definition to hydrate the context of the transaction. The context definition includes these mappings.

• The TransactionMapping maps the fields of the transaction to the attributes of the Transaction node.
• The BSGEntitiesMapping maps the attributes of the Billing Schedule node, the Billing Schedule Group node, and Billing Schedule Group Relationship node to the fields of the corresponding Salesforce objects.

For the StandaloneBillingContext context definition to hydrate all the required data, transaction data for the mandatory context tags are required. Here are the topics that mention the mandatory and optional tags, sample transaction details, and sample payloads for various types of transactions.

• One-Time New Sale Transaction
• Term-Defined New Sale Transaction
• Evergreen New Sale Transaction
• New Sale Transaction With Bundled Products
• New Sale Transaction With Ramped Products
• New Sale Transaction With Usage Products
• Amended Transaction
• Renewal Transaction
• Early Renewal Transaction
• Canceled Transaction

Special Access Rules

This API is available with the Revenue Cloud Billing license.

Resource

/commerce/invoicing/standalone/billing-schedules/actions/create

Resource example

https://yourInstance.salesforce.com/services/data/v64.0/commerce/invoicing/standalone/billing-schedules/actions/create

Available version

64.0

HTTP methods

POST

Request body for POST

JSON example

{
  "transactionDetails": "{\"Transaction\": [{\"id\":\"801VW00000A4NoHYAV\", \"businessObjectType\": \"Order\"}]}",
  "transactionContextDetails": {
    "contextDefinitionName": "StandaloneBillingContext",
    "readContextMappingName": "OrderTransactionMapping",
    "saveContextMappingName": "BSGEntitiesMapping"
  }
}

Properties

Name	Type	Description	Required or Optional	Available Version
transaction​ContextDetails	Context-Aware Standalone Billing Schedule Metadata Input[]	Details of the context definition and its mappings that are used to hydrate the transaction data and save it in the appropriate billing schedule fields.	Required	64.0
transaction​Details	String	Input JSON data that includes the ID of the transaction record for which the billing schedule must be created and other additional transaction details.	Required	64.0

Response body for POST

Context-Aware Billing Schedule