Get Eligible Program Rebate Types

Retrieve the eligible program rebate types for a mapped object.

For more information about how to use the getEligibleProgramRebateTypes action in Flow Builder, see Configure the Output Parameter for the Get Eligible Program Rebate Types Flow Action in Flow Builder in Salesforce Help.

This object is available in API version 52.0 and later.

URI: /services/data/vXX.X/actions/standard/getEligibleProgramRebateTypes

Where XX.X is the latest API version.

Formats: JSON

HTTP Methods: POST

Authentication: Authorization: Bearer TOKEN

Where TOKEN is a variable.

Input	Type	Description
`appliedRebateTypesLimit`	integer	The maximum number of search results to be returned for the applied rebate types. The input value is passed through to the output parameter. This field is available in API version 54.0 and later.
`appliedRebateTypesOffsetInput`	integer	The input offset for the applied rebate types search results plus the number of applied rebates types processed. Used to process applied rebate types in a loop. When all applied rebate types have been processed, zero is returned. This field is available in API version 54.0 and later.
`limit`	integer	The maximum number of search results to be returned for the eligible rebate types.
`measureTypeFilter`	array	Filters the eligible rebate types by the specified measure type.
`offset`	integer	The offset for the eligible rebate types search results. The offset parameter specifies the end of the last batch retrieved. For example, to retrieve 100 rebate types at a time: Request the first 100 with an offset of 0. Request the second 100 with an offset of 100. Request the third 100 with an offset of 200.
`queryOnlyIntegrableProgramRebateTypes`	boolean	Indicates whether only integrable program rebate types must be queried.
`referenceObjectIds`	array	Required. The list of IDs of the mapped object for which to get the eligible rebate types.
`searchByRebateTypeName`	string	Searches the eligible rebate types by the specified name.

Output	Type	Description
`resultantRebateTypes`	string	The list of eligible and applied rebate type IDs for the mapped object. Use with API calls.
`resultantRebateTypesForFlow`	string	The list of eligible and applied rebate type IDs for the mapped object. Use with Flow Builder. This field is available in API version 54.0 and later.

JSON Sample Request

JSON Sample Response