Page Comparison

token

String

The token retrieved from the login method

rewards_participant_identifier

(semi-optional)

(semi-optional)

Accounts Receivable Identifier  

The identifier of the accounts receivable related with to the customer events that should be retrieved. The allowed accounts receivable identifier fields are the following:

(semi-optional)

The identifier of the classification related with to the customer events that should be retrieved. The allowed customer event classification identifier fields are the following:

spend_requests_applied

(optional)

Determines whether the retrieved information related with to the purchase customer events should have any spend request customer events submitted against them. The following options are available:

• True - Retrieved purchase customer events should have at least one spend request customer event submitted against them
• False - Retrieved purchase customer events should not have any spend request customer events submitted against them
• Not Specified - Any purchase customer event should be retrieved

eligible_for_spending

(optional)

Determines whether the retrieved information related with to the purchase customer events are eligible to have a spend request customer event submitted against them, based on:

• The time period that the purchase customer event was performed on does not exceed the maximum period of time that a potential spend request can be submitted (performed on) against it as of today
• The purchase customer event should not have another spend request against it (other than cancelled canceled or Instant)

The following options are available:

• True - Retrieved purchase customer events should be validated successfully against both rules
• False - Retrieve the purchase customer events that are not eligible for spending
• Not Specified - Any purchase customer event should be retrieved

submitted_after_date

(optional)

If specified then information related with to the purchase customer events that was were submitted after the specified date should be retrieved

submitted_before_date

(optional)

If specified then information related with to the purchase customer events that was were submitted before the specified date should be retrieved

number_of_results

(optional)

The number of results that can be retrieved through each call

offset

(optional)

Defines the number of entities that should be skipped from the results. If it is set to 0 then none results should be skipped, otherwise, the results will begin from the provided offset number

fields_set

(optional)

List of Strings, comma separated 

A list of fields that should be included in the results. If not specified then all the available fields will be returned