Invoke Rating Service Action

Invoke the rating service to rate the usage records.

The Invoke Rating Service action acts as a connector between batch management and the rating service. This action is available in API version 62.0 and later.

Special Access Rules

The Invoke Rating Service action is available in Enterprise, Unlimited, and Developer Editions where Rate Management is enabled.

Supported REST HTTP Methods

URI: /services/data/v68.0/actions/standard/invokeRatingService

Formats: JSON, XML

HTTP Methods: POST

Authentication: Authorization: Bearer TOKEN

Where TOKEN is a placeholder for your OAuth access token.

Inputs

Input	Type	Description
`attributeRateCardID`	string	ID of the rate card that’s used to define adjustments based on the attributes that impact the rate.
`baseRateCardID`	string	ID of the rate card that includes the base rate for the resource to be rated, based on its consumption.
`contextDefinitionId`	string	Required. ID of the context definition that’s used to create the context instance.
`contextMappingID`	string	ID of the context mapping that maps a standard object, context definition object, or any other input data source to the node that’s defined in the context definition.
`isSkipWaterfall`	boolean	Indicates whether to skip the generation of price waterfall data (`true`) or not (`false`).
`procedureName`	string	Name of the rating procedure that’s used to calculate the rates.
`recordID`	reference	Required. ID of the usage ratable summary record to be rated.
`tierRateCardID`	string	ID of the rate card that’s used to define adjustments for different tiers of a resource.

Outputs

None

Example

POST

This example shows a sample request for the Invoke Rating Service action.

1{
2  "inputs": [
3    {
4      "recordIDs": "56jSB000002Bn12CXC",
5      "contextMappingId": "11jSB000002Bn13YAC",
6      "contextDefinitionId": "11OSB0000000WSv2AM",
7      "procedureName": "Invoke Rate",
8      "isSkipWaterfall": false,
9      "baseRateCardID": "11jSB000002Bn13YAC",
10      "tierRateCardID": "fgjjSB0sdf987dsf",
11      "attributeRateCardID": "asdfgh563034lk"
12    }
13  ]
14}

This example shows a sample response for the Invoke Rating Service action.

1[
2    {
3        "actionName": "invokeRatingService",
4        "errors": null,
5        "isSuccess": true,
6        "outputValues": {}
7    }
8]