pfx-api:fetchRebateAgreementItemList

pfx-api:fetchRebateAgreementItemList

Fetch rebate agreement items from Pricefx. Retrieves the list of line items associated with a Rebate Agreement.


URI Format

pfx-api:fetchRebateAgreementItemList?typedId=123.RBA

Parameters

Parameter

Type

Required

Default

Description

typedId

String

Yes

--

The typedId of the Rebate Agreement (e.g., 123.RBA).

filter

String

No

--

Optional filter bean to restrict the returned items.

startRow

Integer

No

--

Start row for pagination.

endRow

Integer

No

--

End row for pagination.

Applicable Object Type: RBA (Rebate Agreement)


XML Route Examples

Fetch all items of a Rebate Agreement:

XML
<route>
    <from uri="direct:fetchRebateItems"/>
    <to uri="pfx-api:fetchRebateAgreementItemList?typedId=123.RBA"/>
</route>

Fetch rebate agreement items with a filter:

XML
<route>
    <from uri="direct:fetchFilteredRebateItems"/>
    <to uri="pfx-api:fetchRebateAgreementItemList?typedId=456.RBA&amp;filter=rebateItemFilter"/>
</route>

Common Pitfalls

  • The typedId must point to a valid Rebate Agreement. If the agreement does not exist, the call returns an empty result or an error.

  • For large rebate agreements with many items, consider using pagination (startRow/endRow) to avoid timeouts.