Generate contract-level transaction details for a group benefits contract over a
specified date range. The API groups existing policy transactions into InsuranceContractTrxn
(header) and InsuranceContractTrxnDetail (line item) records. This API runs asynchronously and
returns a job ID to track the job status.
Resource
{contractId} is a placeholder.
/connect/insurance/contracts/{contractId}/actions/generate-transactions
Resource Example
Replace {yourInstance} with the My Domain name of your Salesforce org.
https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/contracts/800xx0000004C92AAE/actions/generate-transactions
Available Version
68.0
HTTP Methods
POST
Path Parameter for POST
| Parameter Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| contractId | String | ID of the insurance contract. | Required | 68.0 |
Request Body for POST
JSON Example
{
"name": "Q1-2026-Transactions",
"fromDate": "2026-01-01",
"toDate": "2026-03-31"
}
Properties
| Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| fromDate | String | Start date of the time period for which you want to generate contract transactions, in YYYY-MM-DD format. | Required | 68.0 |
| name | String | Name of the transaction generation job. Use a descriptive name so that you can identify the job later. | Optional | 68.0 |
| toDate | String | End date of the time period for which to generate contract transactions, in YYYY-MM-DD format. Must be on or after the fromDate. | Required | 68.0 |