Skip to end of banner
Go to start of banner

POST reward_transactions/awards/list

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Next »

Available from CRM.COM R10.0.0

This method returns information related with reward award transactions. Multiple reward award transactions are returned by each call

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

rewards_participant_identifier

(semi-optional)

Rewards Participant identifier

The identifier of the rewards participant whose reward award transactions should be returned as a results. The allowed rewards participant identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the rewards participant

number

(semi-optional)

String

The number of the rewards participant

accounts_receivable_identifier

(semi-optional)

Accounts Receivable identifier  

The identifier of the accounts receivable related with the rewards participant that should be returned as a result. The allowed accounts receivable identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the accounts receivable

number

(semi-optional)

String

The number of the accounts receivable

name

(semi-optional)

String

The name of the accounts receivable

access_token_identifier

(semi-optional)

Access Token Identifier

The identifier of the access token which is related with the accounts receivable. Only effective access tokens can be used to identify an accounts receivable. The allowed access token identifier fields are the following

Name

Type

Description

authentication_code

(semi-optional)

String

The authentication code of the access token

identifier

(semi-optional)

StringThe identifier of the access token. If the identifier is specified then it will be validated against the specified pass code

pass_code

(mandatory on conditions)

StringThe pass code of the access token, which is applicable and mandatory if the identifier is specified

one_time_password

(semi-optional)

Integer

The one-time password (OTP) of the access token

Available from CRM.COM R13.0.0

Available from CRM.COM R8.0.0

Deprecated from CRM.COM R18.0.0

wallet_identifier

(semi-optional)

Wallet identifier  

The identifier of the reward participant's wallet which was affected by the reward award transactions that should be returned as a result. The allowed wallet identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the wallet

number

(semi-optional)

String

The number of the wallet

purchase_customer_event_identifier

(semi-optional)

Purchase Customer Event identifier

The identifier of the purchase customer event that triggered the creation of the reward award transaction that should be returned as a result. The allowed customer event identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the customer event

number

(semi-optional)

String

The number of the customer event

external_system_reference_number

(semi-optional)

String

The external system's unique reference number for the customer event

Available from CRM.COM R10.1.0

referral_customer_event_identifier

(semi-optional)

Referral Customer Event identifier

The identifier of the referral customer event that triggered the creation of the reward award transaction that should be returned as a result. The allowed customer event identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the customer event

number

(semi-optional)

String

The number of the customer event

external_system_reference_number

(semi-optional)

String

The external system's unique reference number for the customer event

Available from CRM.COM R10.1.0

social_media_customer_event_identifier

(semi-optional)

Social Media Customer Event identifier

The identifier of the social media customer event that triggered the creation of the reward award transaction that should be returned as a result. The allowed customer event identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the customer event

number

(semi-optional)

String

The number of the customer event

external_system_reference_number

(semi-optional)

String

The external system's unique reference number for the customer event

Available from CRM.COM R10.1.0

web_customer_event_identifier

(semi-optional)

Web Customer Event identifier

The identifier of the web purchase customer event that triggered the creation of the reward award transaction that should be returned as a result. The allowed customer event identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the customer event

number

(semi-optional)

String

The number of the customer event

external_system_reference_number

(semi-optional)

String

The external system's unique reference number for the customer event

Available from CRM.COM R10.1.0

achievement_customer_event_identifier

(semi-optional)

Achievement Customer Event identifier

The identifier of the achievement customer event that triggered the creation of the reward award transaction that should be returned as a result. The allowed customer event identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the customer event

number

(semi-optional)

String

The number of the customer event

external_system_reference_number

(semi-optional)

String

The external system's unique reference number for the customer event

Available from CRM.COM R10.1.0

financial_achievement_customer_event_identifier

(semi-optional)

Financial Achievement Customer Event identifier

The identifier of the financial achievement customer event that triggered the creation of the reward award transaction that should be returned as a result. The allowed customer event identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the customer event

number

(semi-optional)

String

The number of the customer event

external_system_reference_number

(semi-optional)

String

The external system's unique reference number for the customer event

Available from CRM.COM R10.1.0

Available from CRM.COM R10.0.0

submitted_after_date

(optional)

Date

If specified then reward award transactions that were submitted after the specified date should be retrieved

Available from CRM.COM R12.2.0

submitted_before_date

(optional)

Date

If specified then reward award transactions that were submitted before the specified date should be retrieved

Available from CRM.COM R12.2.0

created_after_date

(semi-optional)

Date

If specified then reward award transactions that were created after the specified date should be retrieved

Available from CRM.COM R15.1.0

created_before_date

(optional)

Date

If specified then reward award transactions that were created before the specified date should be retrieved

Available from CRM.COM R15.1.0

number_of_results

(optional)

Number

The number of results that can be retrieved through each call

Available from CRM.COM R13.0.0

offset

(optional)

Number

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

Available from CRM.COM R13.0.0

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

Restrictions

  • It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.

Response Data

Name

Type

Description

id

String

The ID of the retrieved reward award transaction

number

String

The number of the retrieved reward award transaction

life_cycle_stateStringThe life cycle state of the retrieved reward  award transaction. The available values are POSTED and CANCELLED
amountNumberThe amount of the retrieved reward award transaction in system currency
alternative_amountNumber

The amount of the retrieved reward award transaction in the alternative currency.

Available from CRM.COM R14.2.0

expiration_dateDateThe expiration date of the retrieved reward award transaction
contribution_percentageNumber

The rewards participating merchant's contribution percentage for the retrieved reward award transaction

Available from CRM.COM R10.1.0

spend_methodString

Defines how the awarded amount can be spent

Supported values

  • SPEND_ONE_REQUEST
  • SPEND_AUTOMATICALLY
  • SPEND_INSTANTLY
  • SPEND_INSTANTLY_THROUGH_VOUCHER

Available from CRM.COM R17.9.0

accounts_receivableAccounts Receivable Object

The accounts receivable who was awarded by the retrieved reward award transaction

Available from CRM.COM R17.0.0

rewards_participantRewards Participant Object

The rewards participant who was awarded by the retrieved reward award transaction

Deprecated from CRM.COM R17.0.0

reward_offerReward Offer ObjectThe reward offer based on which the reward award transaction was created
wallet_transactionWallet Transaction ObjectThe credit wallet transaction that was generated by the award reward transaction
award_expiration_transactionAward Expiration ObjectThe award expiration transaction which was generated because of the award transaction's expiration
voucherVoucher Object

The voucher that was issued when an awarded amount was spent

Available from CRM.COM R14.2.0

log_information

Log Information Object

The log information related with the retrieved job

initiated_currencyCurrency Object

The currency based on which the award transaction was initiated in which can either be the wallet currency or the wallet's alternative currency

Available from CRM.COM R14.2.0

currency_rate_periodCurrency Rate Period Object

The currency rate period of the award transaction

Available from CRM.COM R10.0.0

customer_events_setSet of Customer Events ObjectsA list of customer events based on which the reward award transaction was generated.

Referred Objects Response Data

 accounts_receivable object response data

Name

Type

Description

id

String

The ID of the retrieved accounts receivable

number

String

The number of the retrieved accounts receivable

nameStringThe name of the retrieved accounts receivable

life_cycle_state

String

The life cycle state of the accounts receivable. One of the following values is returned:

ACTIVE, SUSPENDED, TERMINATED

account_ownerContact information objectThe contact information owning the accounts receivable

Referred Objects Response Data

 contact_information object response data

Name

Type

Description

id

String

The ID of the retrieved contact information

type

String

The type of the retrieved contact information which can be PERSON or COMPANY

life_cycle_state

String

The lifecycle state of the retrieved contact information which can be MARKETING or FINANCIAL

name

String

The full name of the retrieved contact information

first_name

String

The first name of the retrieved contact information

middle_name

String

The middle name of the retrieved contact information

last_name

String

The last name of the retrieved contact information

title

String

The title of the retrieved contact information

company_nameSting

The company name of the retrieved contact information

demographics

Demographics Object

The demographics information of the retrieved contact information

company_profile

Company profile object

The company profile of the retrieve contact information

Referred Objects Response Data

 demographics object response data

Name

Type

Description

gender

String

The gender of the retrieved contact information which can be MALE or FEMALE

id_number

String

The ID number of the retrieved contact information

id_number_expiration_dateDate

The ID number's expiration date of the retrieved contact information

Available from CRM.COM R14.0.0

passport_number

String

The passport number of the retrieved contact information

passport_number_expiration_dateDate

The passport's expiration date of the retrieved contact information

Available from CRM.COM R14.0.0

social_security_number

String

The social security number of the retrieved contact information

date_of_birth

Date of Birth Object

The date of birth of the retrieved contact information

name_day

Name Day Object

The name day of the retrieved contact information

country_of_residence

Country Object

The country of residence of the retrieved contact information

id_issued_by_country

Country Object

The ID issued country of retrieved contact information

passport_issued_by_country

Country Object

The passport  issued country of retrieved contact information

industry

Industry Object

The industry of retrieved contact information

industry_sector

Industry sector Object

The sector of retrieved contact information

Referred Objects Response Data

 date_of_birth object response data

Name

Type

Description

day

Integer

The day of the retrieved date of birth

month

Integer

The month of the retrieved date of birth

year

Integer

The year of the retrieved date of birth

 name_day object response data

Name

Type

Description

day

Integer

The day of the retrieved name day

month

Integer

The month of the retrieved name day

 country object response data

Name

Type

Description

id

String

The id of the retrieved country

name

String

The name of the retrieved country

alternative_codeString

The alternative code of the retrieved country

dialing_codeString

The dialing code of the retrieved country

Available from CRM.COM R15.1.0

two_character_codeString

The two character code of the retrieved country

three_character_codeString

The three character code of the retrieved country

country_flagImage Object

The flag of the retrieved country

Available from CRM.COM R15.1.0

Referred Objects Response Data

 country_flag object response data

Name

Type

Description

id

String

The ID of the retrieved country flag

fileFile ObjectThe information of the attached file

Referred Objects Response Data

 file object response data

 

Name

Type

Description

file_nameStringThe name of the file
file_content_urlStringThe url that can be used to access the actual content of the file
file_mime_typeStringThe mime type of the attached file

 industry object response data

Name

Type

Description

id

String

The id of the retrieved industry

name

String

The name of the retrieved industry

code

String

The code of the retrieved industry

 industry sector object response data

Name

Type

Description

id

String

The id of the retrieved industry sector

name

String

The name of the retrieved industry sector

alternative_code

String

The alternative code of the retrieved industry sector

 company profile object response data

Name

Type

Description

profile_year

Number

The profile year of the retrieved contact information

annual_turnover

Number

The annual turnover of the retrieved contact information

established_date

Date

The established date of the retrieved contact information

number_of_employeesNumber

The number of employees of the retrieved contact information

registration_number

String

The registration number of the retrieved contact information

vat_registration_numberString

The vat registration number of the retrieved contact information

vat_registered_byString

The vat registration by of the retrieved contact information

vat_registration_date

Date

The vat registration date of the retrieved contact information

tax_reference_numberString

The tax referenece number of the retrieved contact information

registered_in_country

Country Object

The country of residence of the retrieved contact information

industry

Industry Object

The industry of retrieved contact information

industry_sector

Industry sector Object

The sector of retrieved contact information

Referred Objects Response Data

 country object response data

Name

Type

Description

id

String

The id of the retrieved country

name

String

The name of the retrieved country

alternative_codeString

The alternative code of the retrieved country

dialing_codeString

The dialing code of the retrieved country

Available from CRM.COM R15.1.0

two_character_codeString

The two character code of the retrieved country

three_character_codeString

The three character code of the retrieved country

country_flagImage Object

The flag of the retrieved country

Available from CRM.COM R15.1.0

Referred Objects Response Data

 country_flag object response data

Name

Type

Description

id

String

The ID of the retrieved country flag

fileFile ObjectThe information of the attached file

Referred Objects Response Data

 file object response data

 

Name

Type

Description

file_nameStringThe name of the file
file_content_urlStringThe url that can be used to access the actual content of the file
file_mime_typeStringThe mime type of the attached file

 industry object response data

Name

Type

Description

id

String

The id of the retrieved industry

name

String

The name of the retrieved industry

code

String

The code of the retrieved industry

 industry sector object response data

Name

Type

Description

id

String

The id of the retrieved industry sector

name

String

The name of the retrieved industry sector

alternative_code

String

The alternative code of the retrieved industry sector

 rewards participant object response data

Name

Type

Description

id

String

The ID of the retrieved reward participant

number

String

The number of the retrieved reward participant

life_cycle_stateString

The life cycle state of the rewards participant. Available values are EFFECTIVE and TERMINATED.

Available from CRM.COM R12.0.0

accounts_receivableAccounts receivable objectThe accounts receivable owned by the reward participant

Referred Objects Response Data

 accounts_receivable object response data

Name

Type

Description

id

String

The ID of the retrieved accounts receivable

number

String

The number of the retrieved accounts receivable

nameStringThe name of the retrieved accounts receivable

life_cycle_state

String

The life cycle state of the accounts receivable. One of the following values is returned:

ACTIVE, SUSPENDED, TERMINATED

account_ownerContact information objectThe contact information owning the accounts receivable

Referred Objects Response Data

 contact_information object response data

Name

Type

Description

id

String

The ID of the retrieved contact information

type

String

The type of the retrieved contact information which can be PERSON or COMPANY

life_cycle_state

String

The lifecycle state of the retrieved contact information which can be MARKETING or FINANCIAL

name

String

The full name of the retrieved contact information

first_name

String

The first name of the retrieved contact information

middle_name

String

The middle name of the retrieved contact information

last_name

String

The last name of the retrieved contact information

title

String

The title of the retrieved contact information

company_nameSting

The company name of the retrieved contact information

demographics

Demographics Object

The demographics information of the retrieved contact information

company_profile

Company profile object

The company profile of the retrieve contact information

Referred Objects Response Data

 demographics object response data

Name

Type

Description

gender

String

The gender of the retrieved contact information which can be MALE or FEMALE

id_number

String

The ID number of the retrieved contact information

id_number_expiration_dateDate

The ID number's expiration date of the retrieved contact information

Available from CRM.COM R14.0.0

passport_number

String

The passport number of the retrieved contact information

passport_number_expiration_dateDate

The passport's expiration date of the retrieved contact information

Available from CRM.COM R14.0.0

social_security_number

String

The social security number of the retrieved contact information

date_of_birth

Date of Birth Object

The date of birth of the retrieved contact information

name_day

Name Day Object

The name day of the retrieved contact information

country_of_residence

Country Object

The country of residence of the retrieved contact information

id_issued_by_country

Country Object

The ID issued country of retrieved contact information

passport_issued_by_country

Country Object

The passport  issued country of retrieved contact information

industry

Industry Object

The industry of retrieved contact information

industry_sector

Industry sector Object

The sector of retrieved contact information

Referred Objects Response Data

 date_of_birth object response data

Name

Type

Description

day

Integer

The day of the retrieved date of birth

month

Integer

The month of the retrieved date of birth

year

Integer

The year of the retrieved date of birth

 name_day object response data

Name

Type

Description

day

Integer

The day of the retrieved name day

month

Integer

The month of the retrieved name day

 country object response data

Name

Type

Description

id

String

The id of the retrieved country

name

String

The name of the retrieved country

alternative_codeString

The alternative code of the retrieved country

dialing_codeString

The dialing code of the retrieved country

Available from CRM.COM R15.1.0

two_character_codeString

The two character code of the retrieved country

three_character_codeString

The three character code of the retrieved country

country_flagImage Object

The flag of the retrieved country

Available from CRM.COM R15.1.0

Referred Objects Response Data

 country_flag object response data

Name

Type

Description

id

String

The ID of the retrieved country flag

fileFile ObjectThe information of the attached file

Referred Objects Response Data

 file object response data

 

Name

Type

Description

file_nameStringThe name of the file
file_content_urlStringThe url that can be used to access the actual content of the file
file_mime_typeStringThe mime type of the attached file

 industry object response data

Name

Type

Description

id

String

The id of the retrieved industry

name

String

The name of the retrieved industry

code

String

The code of the retrieved industry

 industry sector object response data

Name

Type

Description

id

String

The id of the retrieved industry sector

name

String

The name of the retrieved industry sector

alternative_code

String

The alternative code of the retrieved industry sector

 company profile object response data

Name

Type

Description

profile_year

Number

The profile year of the retrieved contact information

annual_turnover

Number

The annual turnover of the retrieved contact information

established_date

Date

The established date of the retrieved contact information

number_of_employeesNumber

The number of employees of the retrieved contact information

registration_number

String

The registration number of the retrieved contact information

vat_registration_numberString

The vat registration number of the retrieved contact information

vat_registered_byString

The vat registration by of the retrieved contact information

vat_registration_date

Date

The vat registration date of the retrieved contact information

tax_reference_numberString

The tax referenece number of the retrieved contact information

registered_in_country

Country Object

The country of residence of the retrieved contact information

industry

Industry Object

The industry of retrieved contact information

industry_sector

Industry sector Object

The sector of retrieved contact information

Referred Objects Response Data

 country object response data

Name

Type

Description

id

String

The id of the retrieved country

name

String

The name of the retrieved country

alternative_codeString

The alternative code of the retrieved country

dialing_codeString

The dialing code of the retrieved country

Available from CRM.COM R15.1.0

two_character_codeString

The two character code of the retrieved country

three_character_codeString

The three character code of the retrieved country

country_flagImage Object

The flag of the retrieved country

Available from CRM.COM R15.1.0

Referred Objects Response Data

 country_flag object response data

Name

Type

Description

id

String

The ID of the retrieved country flag

fileFile ObjectThe information of the attached file

Referred Objects Response Data

 file object response data

 

Name

Type

Description

file_nameStringThe name of the file
file_content_urlStringThe url that can be used to access the actual content of the file
file_mime_typeStringThe mime type of the attached file

 industry object response data

Name

Type

Description

id

String

The id of the retrieved industry

name

String

The name of the retrieved industry

code

String

The code of the retrieved industry

 industry sector object response data

Name

Type

Description

id

String

The id of the retrieved industry sector

name

String

The name of the retrieved industry sector

alternative_code

String

The alternative code of the retrieved industry sector

 reward offer object response data

Name

Type

Description

id

String

The ID of the retrieved reward offer

number

String

The number of the retrieved reward offer

name

String

The name of the retrieved reward offer

alternative_code

String

The alternative code of the retrieved reward offer

descriptionStringA description of the retrieved reward offer
life_cycle_stateStringThe life cycle state of the reward offer which can be EFFECTIVE or NOT_EFFECTIVE
marketing_information_short_descriptionString

The offer's short description

Available from CRM.COM R12.2.0

reward_schemeReward Scheme Object

The reward scheme that the reward offer belongs to

Available from CRM.COM R11.0.0

Referred Objects Response Data

 reward scheme object response data

Name

Type

Description

id

String

The ID of the retrieved reward scheme

name

String

The name of the retrieved reward scheme

alternative_code

String

The alternative code of the retrieved reward scheme

descriptionStringA description of the retrieved reward scheme
life_cycle_stateStringThe life cycle state of the reward scheme which can be EFFECTIVE or NOT_EFFECTIVE

 wallet_transaction response data object

Name

Type

Description

id

String

The ID of the retrieved wallet transaction

number

String

The number of the retrieved wallet transaction

amountNumberThe total amount of the wallet transaction in wallet's currency
alternative_amountNumber

The total amount of the wallet transaction in the wallet's alternative currency

Available from CRM.COM R14.2.0


extra_added_amountNumberAn extra added amount that will only affect the wallet balance on crediting the wallet.
extra_added_alternative_amountNumber

An extra added amount in the alternative currency that will only affect the wallet balance on crediting the wallet.

Available from CRM.COM R14.2.0


life_cycle_stateStringThe life cycle state of the retrieved wallet transaction. Supported values are EFFECTIVE and VOIDED
caused_by_entityString

The name of the entity that caused the creation of the wallet transaction. The supported values are the following:

  • PREPAIDBILLINGRUN 
  • RATEDBILLINGITEMS
  • REWARDAWARDTRANSACTIONS 
  • AWARDEXPIRATIONTRANSACTIONS 
  • REWARDSPENDTRANSACTIONS 
  • PAYMENTS 
  • CREDITNOTES

Available from CRM.COM R10.1.0


caused_by_entity_idString

The id of the entity that caused the creation of the wallet transaction.

Available from CRM.COM R10.1.0

typeWallet Transaction Type ObjectThe type of the retrieved wallet transaction
walletWallet Object

The wallet related with the retrieved wallet transaction

initiated_currencyCurrency Object

The currency in which the wallet transaction was initiated in

Available from CRM.COM R14.2.0

currency_rate_periodCurrency Rate Period

The currency rate period of the wallet transaction

Available from CRM.COM R10.1.0

log_informationLog Information ObjectThe log information of the retrieved wallet transaction


Referred Objects Response Data

 wallet_transaction_type response data object
NameType Description
IdStringThe ID of the retrieved wallet transaction type
nameStringThe Name of the retrieved wallet transaction type
alternative_codeStringThe Alternative Code of the retrieved wallet transaction type
classificationString

The Classification of the retrieved wallet transaction type. The supported classifications are CREDIT, DEBIT, REIMBURSE, VOID, TRANSFER

TRANSFER classification available from CRM.COM R9.0.0

descriptionStringThe Description of the retrieved wallet transaction type

 wallet response data object

Name

Type

Description

id

String

The ID of the retrieved wallet

number

String

The number of the retrieved wallet

life_cycle_stateStringThe life cycle state of the retrieved wallet. Supported values are EFFECTIVE and CANCELLED
accounts_receivableAccounts Receivable ObjectThe account receivable related with the retrieved wallet

 

Referred Objects Response Data

 accounts_receivable object response data

Name

Type

Description

id

String

The ID of the retrieved accounts receivable

number

String

The number of the retrieved accounts receivable

nameStringThe name of the retrieved accounts receivable

life_cycle_state

String

The life cycle state of the accounts receivable. One of the following values is returned:

ACTIVE, SUSPENDED, TERMINATED

account_ownerContact information objectThe contact information owning the accounts receivable

Referred Objects Response Data

 contact_information object response data

Name

Type

Description

id

String

The ID of the retrieved contact information

type

String

The type of the retrieved contact information which can be PERSON or COMPANY

life_cycle_state

String

The lifecycle state of the retrieved contact information which can be MARKETING or FINANCIAL

name

String

The full name of the retrieved contact information

first_name

String

The first name of the retrieved contact information

middle_name

String

The middle name of the retrieved contact information

last_name

String

The last name of the retrieved contact information

title

String

The title of the retrieved contact information

company_nameSting

The company name of the retrieved contact information

demographics

Demographics Object

The demographics information of the retrieved contact information

company_profile

Company profile object

The company profile of the retrieve contact information

Referred Objects Response Data

 demographics object response data

Name

Type

Description

gender

String

The gender of the retrieved contact information which can be MALE or FEMALE

id_number

String

The ID number of the retrieved contact information

id_number_expiration_dateDate

The ID number's expiration date of the retrieved contact information

Available from CRM.COM R14.0.0

passport_number

String

The passport number of the retrieved contact information

passport_number_expiration_dateDate

The passport's expiration date of the retrieved contact information

Available from CRM.COM R14.0.0

social_security_number

String

The social security number of the retrieved contact information

date_of_birth

Date of Birth Object

The date of birth of the retrieved contact information

name_day

Name Day Object

The name day of the retrieved contact information

country_of_residence

Country Object

The country of residence of the retrieved contact information

id_issued_by_country

Country Object

The ID issued country of retrieved contact information

passport_issued_by_country

Country Object

The passport  issued country of retrieved contact information

industry

Industry Object

The industry of retrieved contact information

industry_sector

Industry sector Object

The sector of retrieved contact information

Referred Objects Response Data

 date_of_birth object response data

Name

Type

Description

day

Integer

The day of the retrieved date of birth

month

Integer

The month of the retrieved date of birth

year

Integer

The year of the retrieved date of birth

 name_day object response data

Name

Type

Description

day

Integer

The day of the retrieved name day

month

Integer

The month of the retrieved name day

 country object response data

Name

Type

Description

id

String

The id of the retrieved country

name

String

The name of the retrieved country

alternative_codeString

The alternative code of the retrieved country

dialing_codeString

The dialing code of the retrieved country

Available from CRM.COM R15.1.0

two_character_codeString

The two character code of the retrieved country

three_character_codeString

The three character code of the retrieved country

country_flagImage Object

The flag of the retrieved country

Available from CRM.COM R15.1.0

Referred Objects Response Data

 country_flag object response data

Name

Type

Description

id

String

The ID of the retrieved country flag

fileFile ObjectThe information of the attached file

Referred Objects Response Data

 file object response data

 

Name

Type

Description

file_nameStringThe name of the file
file_content_urlStringThe url that can be used to access the actual content of the file
file_mime_typeStringThe mime type of the attached file

 industry object response data

Name

Type

Description

id

String

The id of the retrieved industry

name

String

The name of the retrieved industry

code

String

The code of the retrieved industry

 industry sector object response data

Name

Type

Description

id

String

The id of the retrieved industry sector

name

String

The name of the retrieved industry sector

alternative_code

String

The alternative code of the retrieved industry sector

 company profile object response data

Name

Type

Description

profile_year

Number

The profile year of the retrieved contact information

annual_turnover

Number

The annual turnover of the retrieved contact information

established_date

Date

The established date of the retrieved contact information

number_of_employeesNumber

The number of employees of the retrieved contact information

registration_number

String

The registration number of the retrieved contact information

vat_registration_numberString

The vat registration number of the retrieved contact information

vat_registered_byString

The vat registration by of the retrieved contact information

vat_registration_date

Date

The vat registration date of the retrieved contact information

tax_reference_numberString

The tax referenece number of the retrieved contact information

registered_in_country

Country Object

The country of residence of the retrieved contact information

industry

Industry Object

The industry of retrieved contact information

industry_sector

Industry sector Object

The sector of retrieved contact information

Referred Objects Response Data

 country object response data

Name

Type

Description

id

String

The id of the retrieved country

name

String

The name of the retrieved country

alternative_codeString

The alternative code of the retrieved country

dialing_codeString

The dialing code of the retrieved country

Available from CRM.COM R15.1.0

two_character_codeString

The two character code of the retrieved country

three_character_codeString

The three character code of the retrieved country

country_flagImage Object

The flag of the retrieved country

Available from CRM.COM R15.1.0

Referred Objects Response Data

 country_flag object response data

Name

Type

Description

id

String

The ID of the retrieved country flag

fileFile ObjectThe information of the attached file

Referred Objects Response Data

 file object response data

 

Name

Type

Description

file_nameStringThe name of the file
file_content_urlStringThe url that can be used to access the actual content of the file
file_mime_typeStringThe mime type of the attached file

 industry object response data

Name

Type

Description

id

String

The id of the retrieved industry

name

String

The name of the retrieved industry

code

String

The code of the retrieved industry

 industry sector object response data

Name

Type

Description

id

String

The id of the retrieved industry sector

name

String

The name of the retrieved industry sector

alternative_code

String

The alternative code of the retrieved industry sector

 currency object response data

Name

Type

Description

id

String

The ID of the retrieved currency

code

String

The code of the retrieved currency

prefix_symbolStringThe prefix symbol for the specified currency

suffix_symbol

StringThe suffix symbol for the specified currency
life_cycle_stateString

The life cycle state for the specified currency, which can be EFFECTIVE or NOT EFFECTIVE

Available from CRM.COM R14.0.0

integer_part_nameStringThe integer part name for the specified currency
decimal_part_nameStringThe decimal part name for the specified currency

 currency rate period object response data

Name

Type

Description

id

String

The ID of the retrieved currency rate period

rateNumberThe exchange rate of the currency rate period
inverse_rateNumberThe inverse exchange rate of the currency rate period
from_dateDateThe date from which the exchange rate is valid
to_dateDateThe date until which the exchange rate is valid
currencyCurrency ObjectThe Currency with which the returned exchange rate information refers to

Referred Objects Response Data

 currency object response data

Name

Type

Description

id

String

The ID of the retrieved currency

code

String

The code of the retrieved currency

prefix_symbolStringThe prefix symbol for the specified currency

suffix_symbol

StringThe suffix symbol for the specified currency
life_cycle_stateString

The life cycle state for the specified currency, which can be EFFECTIVE or NOT EFFECTIVE

Available from CRM.COM R14.0.0

integer_part_nameStringThe integer part name for the specified currency
decimal_part_nameStringThe decimal part name for the specified currency

 log_information object response data

Name

Type

Description

created_date

Date

The date that the retrieved record was created

updated_date

Date

The last date that the retrieved record was updated

created_by_unit

Unit Object

The unit that created the retrieved record

From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled

Deprecated from CRM.COM R18.0.0

created_by_business_unit

Unit Object

The unit that created the retrieved record

From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled

Available from CRM.COM R18.0.0

created_by_user

User Object

The user that created the retrieved record

From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled

updated_by_unit

Unit Object

The last unit that updated the retrieved record

From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled

Deprecated from CRM.COM R18.0.0

updated_by_business_unit

Unit Object

The last unit that updated the retrieved record

Available from CRM.COM R18.0.0

updated_by_user

User Object

The last user that updated the retrieved record

From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled

Referred Objects Response Data

 unit object response data

Name

Type

Description

id

String

The ID of the retrieved unit

name

String

The name of the retrieved unit

group_name

String

The name of the group that the retrieved unit belongs to

community_name

String

The name of the community that the retrieved unit belongs to

alternative_code

String

The alternative code of the retrieved unit

description

String

The description of the retrieved unit

 business unit object response data

Name

Type

Description

id

String

The ID of the retrieved business unit

name

String

The name of the retrieved business unit

codeStringThe code of the retrieved business unit
unified_codeString

The unified code of the retrieved business unit

description

String

The description of the retrieved business unit

parent_business_unit_nameStringThe name of the parent business unit that the retrieved business unit belongs to

 user object response data

Name

Type

Description

id

String

The ID of the retrieved user

username

String

The user name of the retrieved user

person_name

String

The full name of the retrieved user

email

String

The email of the retrieved user

 award expiration transaction object response data

Name

Type

Description

id

String

The ID of the retrieved award expiration transaction

number

String

The number of the retrieved award expiration transaction

amountNumberThe awarded amount in rewards participant's currency that was expired by the retrieved award expiration transaction
alternative_amountNumber

The awarded amount in rewards participant's alternative currency that was expired by the retrieved award expiration transaction

Available from CRM.COM R14.2.0


life_cycle_stateStringThe life cycle state of the retrieved award expiration transaction which can be POSTED or CANCELLED
initiated_currencyCurrency Object

The currency base don which the reward transaction was initiated

Available from CRM.COM R14.2.0

accounts_receivableAccounts Receivable Object

The accounts receivable related with the retrieved award expiration transaction

Available from CRM.COM R17.0.0

rewards_participantReward Participant ObjectThe rewards participant related with the retrieved award expiration transaction

Referred Objects Response Data

 currency object response data

Name

Type

Description

id

String

The ID of the retrieved currency

code

String

The code of the retrieved currency

prefix_symbolStringThe prefix symbol for the specified currency

suffix_symbol

StringThe suffix symbol for the specified currency
life_cycle_stateString

The life cycle state for the specified currency, which can be EFFECTIVE or NOT EFFECTIVE

Available from CRM.COM R14.0.0

integer_part_nameStringThe integer part name for the specified currency
decimal_part_nameStringThe decimal part name for the specified currency

 accounts_receivable object response data

Name

Type

Description

id

String

The ID of the retrieved accounts receivable

number

String

The number of the retrieved accounts receivable

nameStringThe name of the retrieved accounts receivable

life_cycle_state

String

The life cycle state of the accounts receivable. One of the following values is returned:

ACTIVE, SUSPENDED, TERMINATED

account_ownerContact information objectThe contact information owning the accounts receivable

Referred Objects Response Data

 contact_information object response data

Name

Type

Description

id

String

The ID of the retrieved contact information

type

String

The type of the retrieved contact information which can be PERSON or COMPANY

life_cycle_state

String

The lifecycle state of the retrieved contact information which can be MARKETING or FINANCIAL

name

String

The full name of the retrieved contact information

first_name

String

The first name of the retrieved contact information

middle_name

String

The middle name of the retrieved contact information

last_name

String

The last name of the retrieved contact information

title

String

The title of the retrieved contact information

company_nameSting

The company name of the retrieved contact information

demographics

Demographics Object

The demographics information of the retrieved contact information

company_profile

Company profile object

The company profile of the retrieve contact information

Referred Objects Response Data

 demographics object response data

Name

Type

Description

gender

String

The gender of the retrieved contact information which can be MALE or FEMALE

id_number

String

The ID number of the retrieved contact information

id_number_expiration_dateDate

The ID number's expiration date of the retrieved contact information

Available from CRM.COM R14.0.0

passport_number

String

The passport number of the retrieved contact information

passport_number_expiration_dateDate

The passport's expiration date of the retrieved contact information

Available from CRM.COM R14.0.0

social_security_number

String

The social security number of the retrieved contact information

date_of_birth

Date of Birth Object

The date of birth of the retrieved contact information

name_day

Name Day Object

The name day of the retrieved contact information

country_of_residence

Country Object

The country of residence of the retrieved contact information

id_issued_by_country

Country Object

The ID issued country of retrieved contact information

passport_issued_by_country

Country Object

The passport  issued country of retrieved contact information

industry

Industry Object

The industry of retrieved contact information

industry_sector

Industry sector Object

The sector of retrieved contact information

Referred Objects Response Data

 date_of_birth object response data

Name

Type

Description

day

Integer

The day of the retrieved date of birth

month

Integer

The month of the retrieved date of birth

year

Integer

The year of the retrieved date of birth

 name_day object response data

Name

Type

Description

day

Integer

The day of the retrieved name day

month

Integer

The month of the retrieved name day

 country object response data

Name

Type

Description

id

String

The id of the retrieved country

name

String

The name of the retrieved country

alternative_codeString

The alternative code of the retrieved country

dialing_codeString

The dialing code of the retrieved country

Available from CRM.COM R15.1.0

two_character_codeString

The two character code of the retrieved country

three_character_codeString

The three character code of the retrieved country

country_flagImage Object

The flag of the retrieved country

Available from CRM.COM R15.1.0

Referred Objects Response Data

 country_flag object response data

Name

Type

Description

id

String

The ID of the retrieved country flag

fileFile ObjectThe information of the attached file

Referred Objects Response Data

 file object response data

 

Name

Type

Description

file_nameStringThe name of the file
file_content_urlStringThe url that can be used to access the actual content of the file
file_mime_typeStringThe mime type of the attached file

 industry object response data

Name

Type

Description

id

String

The id of the retrieved industry

name

String

The name of the retrieved industry

code

String

The code of the retrieved industry

 industry sector object response data

Name

Type

Description

id

String

The id of the retrieved industry sector

name

String

The name of the retrieved industry sector

alternative_code

String

The alternative code of the retrieved industry sector

 company profile object response data

Name

Type

Description

profile_year

Number

The profile year of the retrieved contact information

annual_turnover

Number

The annual turnover of the retrieved contact information

established_date

Date

The established date of the retrieved contact information

number_of_employeesNumber

The number of employees of the retrieved contact information

registration_number

String

The registration number of the retrieved contact information

vat_registration_numberString

The vat registration number of the retrieved contact information

vat_registered_byString

The vat registration by of the retrieved contact information

vat_registration_date

Date

The vat registration date of the retrieved contact information

tax_reference_numberString

The tax referenece number of the retrieved contact information

registered_in_country

Country Object

The country of residence of the retrieved contact information

industry

Industry Object

The industry of retrieved contact information

industry_sector

Industry sector Object

The sector of retrieved contact information

Referred Objects Response Data

 country object response data

Name

Type

Description

id

String

The id of the retrieved country

name

String

The name of the retrieved country

alternative_codeString

The alternative code of the retrieved country

dialing_codeString

The dialing code of the retrieved country

Available from CRM.COM R15.1.0

two_character_codeString

The two character code of the retrieved country

three_character_codeString

The three character code of the retrieved country

country_flagImage Object

The flag of the retrieved country

Available from CRM.COM R15.1.0

Referred Objects Response Data

 country_flag object response data

Name

Type

Description

id

String

The ID of the retrieved country flag

fileFile ObjectThe information of the attached file

Referred Objects Response Data

 file object response data

 

Name

Type

Description

file_nameStringThe name of the file
file_content_urlStringThe url that can be used to access the actual content of the file
file_mime_typeStringThe mime type of the attached file

 industry object response data

Name

Type

Description

id

String

The id of the retrieved industry

name

String

The name of the retrieved industry

code

String

The code of the retrieved industry

 industry sector object response data

Name

Type

Description

id

String

The id of the retrieved industry sector

name

String

The name of the retrieved industry sector

alternative_code

String

The alternative code of the retrieved industry sector

 rewards participant object response data

Name

Type

Description

id

String

The ID of the retrieved reward participant

number

String

The number of the retrieved reward participant

life_cycle_stateString

The life cycle state of the rewards participant. Available values are EFFECTIVE and TERMINATED.

Available from CRM.COM R12.0.0

accounts_receivableAccounts receivable objectThe accounts receivable owned by the reward participant

Referred Objects Response Data

 accounts_receivable object response data

Name

Type

Description

id

String

The ID of the retrieved accounts receivable

number

String

The number of the retrieved accounts receivable

nameStringThe name of the retrieved accounts receivable

life_cycle_state

String

The life cycle state of the accounts receivable. One of the following values is returned:

ACTIVE, SUSPENDED, TERMINATED

account_ownerContact information objectThe contact information owning the accounts receivable

Referred Objects Response Data

 contact_information object response data

Name

Type

Description

id

String

The ID of the retrieved contact information

type

String

The type of the retrieved contact information which can be PERSON or COMPANY

life_cycle_state

String

The lifecycle state of the retrieved contact information which can be MARKETING or FINANCIAL

name

String

The full name of the retrieved contact information

first_name

String

The first name of the retrieved contact information

middle_name

String

The middle name of the retrieved contact information

last_name

String

The last name of the retrieved contact information

title

String

The title of the retrieved contact information

company_nameSting

The company name of the retrieved contact information

demographics

Demographics Object

The demographics information of the retrieved contact information

company_profile

Company profile object

The company profile of the retrieve contact information

Referred Objects Response Data

 demographics object response data

Name

Type

Description

gender

String

The gender of the retrieved contact information which can be MALE or FEMALE

id_number

String

The ID number of the retrieved contact information

id_number_expiration_dateDate

The ID number's expiration date of the retrieved contact information

Available from CRM.COM R14.0.0

passport_number

String

The passport number of the retrieved contact information

passport_number_expiration_dateDate

The passport's expiration date of the retrieved contact information

Available from CRM.COM R14.0.0

social_security_number

String

The social security number of the retrieved contact information

date_of_birth

Date of Birth Object

The date of birth of the retrieved contact information

name_day

Name Day Object

The name day of the retrieved contact information

country_of_residence

Country Object

The country of residence of the retrieved contact information

id_issued_by_country

Country Object

The ID issued country of retrieved contact information

passport_issued_by_country

Country Object

The passport  issued country of retrieved contact information

industry

Industry Object

The industry of retrieved contact information

industry_sector

Industry sector Object

The sector of retrieved contact information

Referred Objects Response Data

 date_of_birth object response data

Name

Type

Description

day

Integer

The day of the retrieved date of birth

month

Integer

The month of the retrieved date of birth

year

Integer

The year of the retrieved date of birth

 name_day object response data

Name

Type

Description

day

Integer

The day of the retrieved name day

month

Integer

The month of the retrieved name day

 country object response data

Name

Type

Description

id

String

The id of the retrieved country

name

String

The name of the retrieved country

alternative_codeString

The alternative code of the retrieved country

dialing_codeString

The dialing code of the retrieved country

Available from CRM.COM R15.1.0

two_character_codeString

The two character code of the retrieved country

three_character_codeString

The three character code of the retrieved country

country_flagImage Object

The flag of the retrieved country

Available from CRM.COM R15.1.0

Referred Objects Response Data

 country_flag object response data

Name

Type

Description

id

String

The ID of the retrieved country flag

fileFile ObjectThe information of the attached file

Referred Objects Response Data

 file object response data

 

Name

Type

Description

file_nameStringThe name of the file
file_content_urlStringThe url that can be used to access the actual content of the file
file_mime_typeStringThe mime type of the attached file

 industry object response data

Name

Type

Description

id

String

The id of the retrieved industry

name

String

The name of the retrieved industry

code

String

The code of the retrieved industry

 industry sector object response data

Name

Type

Description

id

String

The id of the retrieved industry sector

name

String

The name of the retrieved industry sector

alternative_code

String

The alternative code of the retrieved industry sector

 company profile object response data

Name

Type

Description

profile_year

Number

The profile year of the retrieved contact information

annual_turnover

Number

The annual turnover of the retrieved contact information

established_date

Date

The established date of the retrieved contact information

number_of_employeesNumber

The number of employees of the retrieved contact information

registration_number

String

The registration number of the retrieved contact information

vat_registration_numberString

The vat registration number of the retrieved contact information

vat_registered_byString

The vat registration by of the retrieved contact information

vat_registration_date

Date

The vat registration date of the retrieved contact information

tax_reference_numberString

The tax referenece number of the retrieved contact information

registered_in_country

Country Object

The country of residence of the retrieved contact information

industry

Industry Object

The industry of retrieved contact information

industry_sector

Industry sector Object

The sector of retrieved contact information

Referred Objects Response Data

 country object response data

Name

Type

Description

id

String

The id of the retrieved country

name

String

The name of the retrieved country

alternative_codeString

The alternative code of the retrieved country

dialing_codeString

The dialing code of the retrieved country

Available from CRM.COM R15.1.0

two_character_codeString

The two character code of the retrieved country

three_character_codeString

The three character code of the retrieved country

country_flagImage Object

The flag of the retrieved country

Available from CRM.COM R15.1.0

Referred Objects Response Data

 country_flag object response data

Name

Type

Description

id

String

The ID of the retrieved country flag

fileFile ObjectThe information of the attached file

Referred Objects Response Data

 file object response data

 

Name

Type

Description

file_nameStringThe name of the file
file_content_urlStringThe url that can be used to access the actual content of the file
file_mime_typeStringThe mime type of the attached file

 industry object response data

Name

Type

Description

id

String

The id of the retrieved industry

name

String

The name of the retrieved industry

code

String

The code of the retrieved industry

 industry sector object response data

Name

Type

Description

id

String

The id of the retrieved industry sector

name

String

The name of the retrieved industry sector

alternative_code

String

The alternative code of the retrieved industry sector

 voucher response data object

Name

Type

Description

id

String

The ID of the retrieved voucher

number

String

The number of the retrieved voucher

valueNumberThe value of the retrieved voucher
extra_added_valueNumber

The extra added value of the retrieved voucher

From CRM.COM R14.0.0 and onwards this information is only available if the voucher type classification is "Payment Voucher"

life_cycle_state

String

The life cycle state of the retrieved voucher which can be DRAFT, ACCEPTED_FOR_ACTIVATION, NOT_ACCEPTED_FOR_ACTIVATION, ACTIVATED, USED, CANCELLED, PURGED

From CRM.COM R14.0.0 and onwards the applicable life cycle state of the retrieved voucher of type with classification "Refund Voucher" can be ACTIVATED, USED, PURGED

typeVoucher Type objectThe type information of the retrieved voucher
lotVouchers Lot Object

The lot of the retrieved voucher

From CRM.COM R14.0.0 and onwards this information is available only if the voucher type classification is "Payment Voucher"

 

Referred Objects Response Data

 voucher_type response data object
NameType Description
IdStringThe ID of the retrieved voucher type
nameStringThe Name of the retrieved voucher type
alternative_codeStringThe Alternative Code of the retrieved voucher type
value_optionsString

Defines if the value should be fixed, as defined in the voucher type, or a variable, as defined during the creation of the vouchers. The supported options are FIXED and VARIABLE

From CRM.COM R13.1.0 and onwards for voucher types of classification equal to "Electronic Voucher" the supported option is VARIABLE

From CRM.COM R14.0.0 and onwards for voucher types of classification equal to "Refund Voucher" the supported option is VARIABLE

classificationString

The Classification of the retrieved voucher type

Available from CRM.COM R13.1.0

descriptionStringThe Description of the retrieved voucher type

 lot response data object
NameType Description
IdStringThe ID of the retrieved lot
numberStringThe number of the retrieved lot
alternative_codeStringThe alternative code of the retrieved lot
descriptionStringThe description of the retrieved lot

 log_information object response data

Name

Type

Description

created_date

Date

The date that the retrieved record was created

updated_date

Date

The last date that the retrieved record was updated

created_by_unit

Unit Object

The unit that created the retrieved record

From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled

Deprecated from CRM.COM R18.0.0

created_by_business_unit

Unit Object

The unit that created the retrieved record

From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled

Available from CRM.COM R18.0.0

created_by_user

User Object

The user that created the retrieved record

From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled

updated_by_unit

Unit Object

The last unit that updated the retrieved record

From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled

Deprecated from CRM.COM R18.0.0

updated_by_business_unit

Unit Object

The last unit that updated the retrieved record

Available from CRM.COM R18.0.0

updated_by_user

User Object

The last user that updated the retrieved record

From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled

Referred Objects Response Data

 unit object response data

Name

Type

Description

id

String

The ID of the retrieved unit

name

String

The name of the retrieved unit

group_name

String

The name of the group that the retrieved unit belongs to

community_name

String

The name of the community that the retrieved unit belongs to

alternative_code

String

The alternative code of the retrieved unit

description

String

The description of the retrieved unit

 business unit object response data

Name

Type

Description

id

String

The ID of the retrieved business unit

name

String

The name of the retrieved business unit

codeStringThe code of the retrieved business unit
unified_codeString

The unified code of the retrieved business unit

description

String

The description of the retrieved business unit

parent_business_unit_nameStringThe name of the parent business unit that the retrieved business unit belongs to

 user object response data

Name

Type

Description

id

String

The ID of the retrieved user

username

String

The user name of the retrieved user

person_name

String

The full name of the retrieved user

email

String

The email of the retrieved user

 currency object response data

Name

Type

Description

id

String

The ID of the retrieved currency

code

String

The code of the retrieved currency

prefix_symbolStringThe prefix symbol for the specified currency

suffix_symbol

StringThe suffix symbol for the specified currency
life_cycle_stateString

The life cycle state for the specified currency, which can be EFFECTIVE or NOT EFFECTIVE

Available from CRM.COM R14.0.0

integer_part_nameStringThe integer part name for the specified currency
decimal_part_nameStringThe decimal part name for the specified currency

 currency rate period object response data

Name

Type

Description

id

String

The ID of the retrieved currency rate period

rateNumberThe exchange rate of the currency rate period
inverse_rateNumberThe inverse exchange rate of the currency rate period
from_dateDateThe date from which the exchange rate is valid
to_dateDateThe date until which the exchange rate is valid
currencyCurrency ObjectThe Currency with which the returned exchange rate information refers to

Referred Objects Response Data

 currency object response data

Name

Type

Description

id

String

The ID of the retrieved currency

code

String

The code of the retrieved currency

prefix_symbolStringThe prefix symbol for the specified currency

suffix_symbol

StringThe suffix symbol for the specified currency
life_cycle_stateString

The life cycle state for the specified currency, which can be EFFECTIVE or NOT EFFECTIVE

Available from CRM.COM R14.0.0

integer_part_nameStringThe integer part name for the specified currency
decimal_part_nameStringThe decimal part name for the specified currency

 customer event object response data

Name

Type

Description

id

String

The id of the retrieved customer event

number

String

The number of the retrieved customer event

life_cycle_state

String

The life cycle state of the retrieved customer event which can either be POSTED or CANCELLED

typeString

The type of the retrieved customer event which can be one of the following:

  • REFERRALS
  • ACHIEVEMENT
  • PURCHASE
  • WEB
  • SOCIAL_MEDIA
  • FINANCIAL_ACHIEVEMENT

FINANCIAL_ACHIEVEMENT type is available from CRM.COM R10.0.0

external_system_preference_numberString

The unique reference number of the customer event in the external system

Available from CRM.COM R10.1.0

classificationStringThe classification of the retrieved customer event
performed_by_unitUnit Object

The unit that initiated the customer event

Available from CRM.COM R10.1.0

Deprecated from CRM.COM R18.0.0

performed_by_business_unitBusiness Unit Object

The business unit that initiated the customer event

Available from CRM.COM R18.0.0

Referred Objects Response Data

 customer event classification object response data

Name

Type

Description

id

String

The id of the retrieved customer event classification

name

String

The name of the retrieved customer event classification

alternative_code

String

The alternative code of the retrieved customer event classification

 unit object response data

Name

Type

Description

id

String

The ID of the retrieved unit

name

String

The name of the retrieved unit

group_name

String

The name of the group that the retrieved unit belongs to

community_name

String

The name of the community that the retrieved unit belongs to

alternative_code

String

The alternative code of the retrieved unit

description

String

The description of the retrieved unit

 business unit object response data

Name

Type

Description

id

String

The ID of the retrieved business unit

name

String

The name of the retrieved business unit

codeStringThe code of the retrieved business unit
unified_codeString

The unified code of the retrieved business unit

description

String

The description of the retrieved business unit

parent_business_unit_nameStringThe name of the parent business unit that the retrieved business unit belongs to

Examples

 Example 1

HTTP Method: POST

 

Request:

Body:

{
  "token":"33B153AE3857406CA7C9971CAC0BDD7C",
  "rewards_participant_identifier":{"number":"20"}
}


Response:

 {
  "status": {
    "message": "",
    "description": "",
    "code": "OK"
  },
  "data": [
    {
      "award_expiration_transaction": null,
      "log_information": {
        "updated_date": "2015-01-21T14:58:59",
        "created_date": "2015-01-21T14:58:59",
        "created_by_unit": {
          "community_name": "Internal Community",
          "id": "48305F8849E3C18B227C5BE3A27BA6DF",
          "name": "Admin Unit",
          "group_name": "Main Group",
          "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
          "alternative_code": "MG"
        },
        "updated_by_unit": {
          "community_name": "Internal Community",
          "id": "48305F8849E3C18B227C5BE3A27BA6DF",
          "name": "Admin Unit",
          "group_name": "Main Group",
          "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
          "alternative_code": "MG"
        },
        "created_by_user": {
          "person_name": "MPAdministrator",
          "username": "MPAdministrator",
          "id": "1",
          "email": "sakkascy1986@hotmail.com"
        },
        "updated_by_user": {
          "person_name": "MPAdministrator",
          "username": "MPAdministrator",
          "id": "1",
          "email": "sakkascy1986@hotmail.com"
        }
      },
      "life_cycle_state": "POSTED",
      "amount": 5,
      "rewards_participant": {
        "accounts_receivable": {
          "account_owner": {
            "last_name": "Kalvaris",
            "middle_name": null,
            "life_cycle_state": "FINANCIAL",
            "company_profile": null,
            "title": null,
            "first_name": "Myrias",
            "type": "PERSON",
            "id": "145037EE049032288366448D8FC1919B",
            "name": "Kalvaris Myrias",
            "company_name": null,
            "demographics": {
              "gender": null,
              "passport_issued_by_country": null,
              "social_security_number": null,
              "passport_number": null,
              "industry_sector": null,
              "country_of_residence": {
                "three_character_code": "CYP",
                "two_character_code": "CY",
                "id": "181",
                "name": "CYPRUS",
                "alternative_code": null
              },
              "name_day": {
                "month": null,
                "day": null
              },
              "date_of_birth": {
                "month": null,
                "day": null,
                "year": null
              },
              "id_number": "123456789",
              "industry": null,
              "id_issued_by_country": null
            }
          },
          "life_cycle_state": "ACTIVE",
          "number": "ACR000401",
          "id": "068B2E25D66A8D1572B8E1C039D501C8",
          "name": "Myria Kalvari Rewards"
        },
        "number": "20",
        "id": "1A400E0ED18344882D821125CB6FCFBD"
      },
      "wallet_transaction": 
        {
          "notes": null,
          "life_cycle_state": "EFFECTIVE",
          "extra_added_amount": null,
          "amount": 5,
          "number": "WT000712",
          "wallet": {
            "life_cycle_state": "EFFECTIVE",
            "accounts_receivable": {
              "account_owner": {
                "last_name": "Kalvaris",
                "middle_name": null,
                "life_cycle_state": "FINANCIAL",
                "company_profile": null,
                "title": null,
                "first_name": "Myrias",
                "type": "PERSON",
                "id": "145037EE049032288366448D8FC1919B",
                "name": null,
                "company_name": null,
                "demographics": {
                  "gender": null,
                  "passport_issued_by_country": null,
                  "social_security_number": null,
                  "passport_number": null,
                  "industry_sector": null,
                  "name_day": {
                    "month": null,
                    "day": null
                  },
                  "date_of_birth": {
                    "month": null,
                    "day": null,
                    "year": null
                  },
                  "id_number": "123456789",
                  "industry": null,
                  "id_issued_by_country": null
                }
              },
              "life_cycle_state": "ACTIVE",
              "number": "ACR000401",
              "id": "068B2E25D66A8D1572B8E1C039D501C8",
              "name": "Myria Kalvari Rewards"
            },
            "number": "WLT000112",
            "id": "31C7907B0190A65ECBA99CDED647C1C1"
          },
          "type": {
            "classification": "CREDIT",
            "id": "A1F81D0299D4FB0ADFAD83536B94BF5C",
            "name": "Normal Credit 2",
            "description": "Normal Credit for Wallets (Testing TC3)",
            "alternative_code": "NC2"
          },
          "id": "20AE6201443EDCC92D777D82782FB5C7"
        },
      "number": "66",
      "id": "8A755C6DFA3CC11434971BFEB575EA84",
      "reward_offer": {
        "life_cycle_state": "NOT_EFFECTIVE",
        "number": "18",
        "id": "46D23E5CC75C580F38344528AF67556C",
        "name": "5 Euros for New Customers",
        "description": "5 Euros for New Customers",
        "alternative_code": "5EFNC"
      },
      "customer_events_set": [],
      "expiration_date": null
    },
    {
      "award_expiration_transaction": null,
      "log_information": {
        "updated_date": "2015-02-18T11:47:25",
        "created_date": "2015-02-18T11:47:25",
        "created_by_unit": {
          "community_name": "Internal Community",
          "id": "48305F8849E3C18B227C5BE3A27BA6DF",
          "name": "Admin Unit",
          "group_name": "Main Group",
          "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
          "alternative_code": "MG"
        },
        "updated_by_unit": {
          "community_name": "Internal Community",
          "id": "48305F8849E3C18B227C5BE3A27BA6DF",
          "name": "Admin Unit",
          "group_name": "Main Group",
          "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
          "alternative_code": "MG"
        },
        "created_by_user": {
          "person_name": "MPAdministrator",
          "username": "MPAdministrator",
          "id": "1",
          "email": "sakkascy1986@hotmail.com"
        },
        "updated_by_user": {
          "person_name": "MPAdministrator",
          "username": "MPAdministrator",
          "id": "1",
          "email": "sakkascy1986@hotmail.com"
        }
      },
      "life_cycle_state": "POSTED",
      "amount": 5,
      "rewards_participant": {
        "accounts_receivable": {
          "account_owner": {
            "last_name": "Kalvaris",
            "middle_name": null,
            "life_cycle_state": "FINANCIAL",
            "company_profile": null,
            "title": null,
            "first_name": "Myrias",
            "type": "PERSON",
            "id": "145037EE049032288366448D8FC1919B",
            "name": "Kalvaris Myrias",
            "company_name": null,
            "demographics": {
              "gender": null,
              "passport_issued_by_country": null,
              "social_security_number": null,
              "passport_number": null,
              "industry_sector": null,
              "country_of_residence": {
                "three_character_code": "CYP",
                "two_character_code": "CY",
                "id": "181",
                "name": "CYPRUS",
                "alternative_code": null
              },
              "name_day": {
                "month": null,
                "day": null
              },
              "date_of_birth": {
                "month": null,
                "day": null,
                "year": null
              },
              "id_number": "123456789",
              "industry": null,
              "id_issued_by_country": null
            }
          },
          "life_cycle_state": "ACTIVE",
          "number": "ACR000401",
          "id": "068B2E25D66A8D1572B8E1C039D501C8",
          "name": "Myria Kalvari Rewards"
        },
        "number": "20",
        "id": "1A400E0ED18344882D821125CB6FCFBD"
      },
      "wallet_transaction": 
        {
          "notes": null,
          "life_cycle_state": "EFFECTIVE",
          "extra_added_amount": null,
          "amount": 5,
          "number": "WT000847",
          "wallet": {
            "life_cycle_state": "EFFECTIVE",
            "accounts_receivable": {
              "account_owner": {
                "last_name": "Kalvaris",
                "middle_name": null,
                "life_cycle_state": "FINANCIAL",
                "company_profile": null,
                "title": null,
                "first_name": "Myrias",
                "type": "PERSON",
                "id": "145037EE049032288366448D8FC1919B",
                "name": null,
                "company_name": null,
                "demographics": {
                  "gender": null,
                  "passport_issued_by_country": null,
                  "social_security_number": null,
                  "passport_number": null,
                  "industry_sector": null,
                  "name_day": {
                    "month": null,
                    "day": null
                  },
                  "date_of_birth": {
                    "month": null,
                    "day": null,
                    "year": null
                  },
                  "id_number": "123456789",
                  "industry": null,
                  "id_issued_by_country": null
                }
              },
              "life_cycle_state": "ACTIVE",
              "number": "ACR000401",
              "id": "068B2E25D66A8D1572B8E1C039D501C8",
              "name": "Myria Kalvari Rewards"
            },
            "number": "WLT000112",
            "id": "31C7907B0190A65ECBA99CDED647C1C1"
          },
          "type": {
            "classification": "CREDIT",
            "id": "A1F81D0299D4FB0ADFAD83536B94BF5C",
            "name": "Normal Credit 2",
            "description": "Normal Credit for Wallets (Testing TC3)",
            "alternative_code": "NC2"
          },
          "id": "87F3EEAC25F24CC4BD7C63553163D4AF"
        },
      "number": "164",
      "id": "BDEF543CAFDA4CBAB6FD197DE18D0744",
      "reward_offer": {
        "life_cycle_state": "NOT_EFFECTIVE",
        "number": "26",
        "id": "A121DC8DD4B24A019E7ACEA56A8D960A",
        "name": "5 euros on customers with complete email and phone",
        "description": "5 euros on customers with complete email and phone",
        "alternative_code": "5EOCWCEAP"
      },
      "customer_events_set": [],
      "expiration_date": null
    },
    {
      "award_expiration_transaction": null,
      "log_information": {
        "updated_date": "2015-09-29T14:51:40",
        "created_date": "2015-09-29T14:51:40",
        "created_by_unit": {
          "community_name": "Internal Community",
          "id": "48305F8849E3C18B227C5BE3A27BA6DF",
          "name": "Admin Unit",
          "group_name": "Main Group",
          "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
          "alternative_code": "MG"
        },
        "updated_by_unit": {
          "community_name": "Internal Community",
          "id": "48305F8849E3C18B227C5BE3A27BA6DF",
          "name": "Admin Unit",
          "group_name": "Main Group",
          "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
          "alternative_code": "MG"
        },
        "created_by_user": {
          "person_name": "MPAdministrator",
          "username": "MPAdministrator",
          "id": "1",
          "email": "sakkascy1986@hotmail.com"
        },
        "updated_by_user": {
          "person_name": "MPAdministrator",
          "username": "MPAdministrator",
          "id": "1",
          "email": "sakkascy1986@hotmail.com"
        }
      },
      "life_cycle_state": "POSTED",
      "amount": 5,
      "rewards_participant": {
        "accounts_receivable": {
          "account_owner": {
            "last_name": "Kalvaris",
            "middle_name": null,
            "life_cycle_state": "FINANCIAL",
            "company_profile": null,
            "title": null,
            "first_name": "Myrias",
            "type": "PERSON",
            "id": "145037EE049032288366448D8FC1919B",
            "name": "Kalvaris Myrias",
            "company_name": null,
            "demographics": {
              "gender": null,
              "passport_issued_by_country": null,
              "social_security_number": null,
              "passport_number": null,
              "industry_sector": null,
              "country_of_residence": {
                "three_character_code": "CYP",
                "two_character_code": "CY",
                "id": "181",
                "name": "CYPRUS",
                "alternative_code": null
              },
              "name_day": {
                "month": null,
                "day": null
              },
              "date_of_birth": {
                "month": null,
                "day": null,
                "year": null
              },
              "id_number": "123456789",
              "industry": null,
              "id_issued_by_country": null
            }
          },
          "life_cycle_state": "ACTIVE",
          "number": "ACR000401",
          "id": "068B2E25D66A8D1572B8E1C039D501C8",
          "name": "Myria Kalvari Rewards"
        },
        "number": "20",
        "id": "1A400E0ED18344882D821125CB6FCFBD"
      },
      "wallet_transaction": 
        {
          "notes": null,
          "life_cycle_state": "EFFECTIVE",
          "extra_added_amount": null,
          "amount": 5,
          "number": "WT001121",
          "wallet": {
            "life_cycle_state": "EFFECTIVE",
            "accounts_receivable": {
              "account_owner": {
                "last_name": "Kalvaris",
                "middle_name": null,
                "life_cycle_state": "FINANCIAL",
                "company_profile": null,
                "title": null,
                "first_name": "Myrias",
                "type": "PERSON",
                "id": "145037EE049032288366448D8FC1919B",
                "name": null,
                "company_name": null,
                "demographics": {
                  "gender": null,
                  "passport_issued_by_country": null,
                  "social_security_number": null,
                  "passport_number": null,
                  "industry_sector": null,
                  "name_day": {
                    "month": null,
                    "day": null
                  },
                  "date_of_birth": {
                    "month": null,
                    "day": null,
                    "year": null
                  },
                  "id_number": "123456789",
                  "industry": null,
                  "id_issued_by_country": null
                }
              },
              "life_cycle_state": "ACTIVE",
              "number": "ACR000401",
              "id": "068B2E25D66A8D1572B8E1C039D501C8",
              "name": "Myria Kalvari Rewards"
            },
            "number": "WLT000112",
            "id": "31C7907B0190A65ECBA99CDED647C1C1"
          },
          "type": {
            "classification": "CREDIT",
            "id": "A1F81D0299D4FB0ADFAD83536B94BF5C",
            "name": "Normal Credit 2",
            "description": "Normal Credit for Wallets (Testing TC3)",
            "alternative_code": "NC2"
          },
          "id": "1400F6DAD76B405A89161204B1C737F0"
        },
      "number": "189",
      "id": "E47D2E5E8BDE4F1DA0DCE53790455FC0",
      "reward_offer": {
        "life_cycle_state": "NOT_EFFECTIVE",
        "number": "17",
        "id": "446896EA2FE3EFB226596EEA9603366F",
        "name": "5 Euros on customers that had any customer event during December",
        "description": "5 Euros on customers that had any customer event during December TC23",
        "alternative_code": "5EOCTHACEDD"
      },
      "customer_events_set": [],
      "expiration_date": null
    },
    {
      "award_expiration_transaction": null,
      "log_information": {
        "updated_date": "2015-12-19T12:59:20",
        "created_date": "2015-12-07T12:53:47",
        "created_by_unit": {
          "community_name": "Internal Community",
          "id": "48305F8849E3C18B227C5BE3A27BA6DF",
          "name": "Admin Unit",
          "group_name": "Main Group",
          "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
          "alternative_code": "MG"
        },
        "updated_by_unit": {
          "community_name": "Internal Community",
          "id": "48305F8849E3C18B227C5BE3A27BA6DF",
          "name": "Admin Unit",
          "group_name": "Main Group",
          "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
          "alternative_code": "MG"
        },
        "created_by_user": {
          "person_name": "MPAdministrator",
          "username": "MPAdministrator",
          "id": "1",
          "email": "sakkascy1986@hotmail.com"
        },
        "updated_by_user": {
          "person_name": "MPAdministrator",
          "username": "MPAdministrator",
          "id": "1",
          "email": "sakkascy1986@hotmail.com"
        }
      },
      "life_cycle_state": "POSTED",
      "amount": 651,
      "rewards_participant": {
        "accounts_receivable": {
          "account_owner": {
            "last_name": "Kalvaris",
            "middle_name": null,
            "life_cycle_state": "FINANCIAL",
            "company_profile": null,
            "title": null,
            "first_name": "Myrias",
            "type": "PERSON",
            "id": "145037EE049032288366448D8FC1919B",
            "name": "Kalvaris Myrias",
            "company_name": null,
            "demographics": {
              "gender": null,
              "passport_issued_by_country": null,
              "social_security_number": null,
              "passport_number": null,
              "industry_sector": null,
              "country_of_residence": {
                "three_character_code": "CYP",
                "two_character_code": "CY",
                "id": "181",
                "name": "CYPRUS",
                "alternative_code": null
              },
              "name_day": {
                "month": null,
                "day": null
              },
              "date_of_birth": {
                "month": null,
                "day": null,
                "year": null
              },
              "id_number": "123456789",
              "industry": null,
              "id_issued_by_country": null
            }
          },
          "life_cycle_state": "ACTIVE",
          "number": "ACR000401",
          "id": "068B2E25D66A8D1572B8E1C039D501C8",
          "name": "Myria Kalvari Rewards"
        },
        "number": "20",
        "id": "1A400E0ED18344882D821125CB6FCFBD"
      },
      "wallet_transaction": 
        {
          "notes": null,
          "life_cycle_state": "EFFECTIVE",
          "extra_added_amount": null,
          "amount": 651,
          "number": "WT001206",
          "wallet": {
            "life_cycle_state": "EFFECTIVE",
            "accounts_receivable": {
              "account_owner": {
                "last_name": "Kalvaris",
                "middle_name": null,
                "life_cycle_state": "FINANCIAL",
                "company_profile": null,
                "title": null,
                "first_name": "Myrias",
                "type": "PERSON",
                "id": "145037EE049032288366448D8FC1919B",
                "name": null,
                "company_name": null,
                "demographics": {
                  "gender": null,
                  "passport_issued_by_country": null,
                  "social_security_number": null,
                  "passport_number": null,
                  "industry_sector": null,
                  "name_day": {
                    "month": null,
                    "day": null
                  },
                  "date_of_birth": {
                    "month": null,
                    "day": null,
                    "year": null
                  },
                  "id_number": "123456789",
                  "industry": null,
                  "id_issued_by_country": null
                }
              },
              "life_cycle_state": "ACTIVE",
              "number": "ACR000401",
              "id": "068B2E25D66A8D1572B8E1C039D501C8",
              "name": "Myria Kalvari Rewards"
            },
            "number": "WLT000112",
            "id": "31C7907B0190A65ECBA99CDED647C1C1"
          },
          "type": {
            "classification": "CREDIT",
            "id": "981E56423160D488A58635847A84CAA3",
            "name": "Normal Credit",
            "description": "normal credit for wallets",
            "alternative_code": "NC"
          },
          "id": "3155E7430BCB4F9D9B41C76407828CFB"
        },
      "number": "265",
      "id": "86E153AA7E914ADB8528B3E31875AF30",
      "reward_offer": {
        "life_cycle_state": "NOT_EFFECTIVE",
        "number": "42",
        "id": "B89D5DC72E344F05B685C73D82C2E426",
        "name": "Utilise Free Capacity",
        "description": null,
        "alternative_code": "UFC"
      },
      "customer_events_set": [
        {
          "life_cycle_state": "POSTED",
          "classification": null,
          "number": "296",
          "type": "PURCHASE",
          "id": "6E32C7570EC440A791AEA97A213CAD0D"
        }
      ],
      "expiration_date": null
    },
    {
      "award_expiration_transaction": {
        "life_cycle_state": "POSTED",
        "amount": 66,
        "rewards_participant": {
          "accounts_receivable": {
            "life_cycle_state": "ACTIVE",
            "number": "ACR000401",
            "id": "068B2E25D66A8D1572B8E1C039D501C8",
            "name": "Myria Kalvari Rewards"
          },
          "number": "20",
          "id": "1A400E0ED18344882D821125CB6FCFBD"
        },
        "number": "13",
        "id": "9883732F10654831BB0233A00ED2662F"
      },
      "log_information": {
        "updated_date": "2015-12-19T12:59:19",
        "created_date": "2015-12-07T15:43:45",
        "created_by_unit": {
          "community_name": "Internal Community",
          "id": "48305F8849E3C18B227C5BE3A27BA6DF",
          "name": "Admin Unit",
          "group_name": "Main Group",
          "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
          "alternative_code": "MG"
        },
        "updated_by_unit": {
          "community_name": "Internal Community",
          "id": "48305F8849E3C18B227C5BE3A27BA6DF",
          "name": "Admin Unit",
          "group_name": "Main Group",
          "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
          "alternative_code": "MG"
        },
        "created_by_user": {
          "person_name": "MPAdministrator",
          "username": "MPAdministrator",
          "id": "1",
          "email": "sakkascy1986@hotmail.com"
        },
        "updated_by_user": {
          "person_name": "MPAdministrator",
          "username": "MPAdministrator",
          "id": "1",
          "email": "sakkascy1986@hotmail.com"
        }
      },
      "life_cycle_state": "POSTED",
      "amount": 66,
      "rewards_participant": {
        "accounts_receivable": {
          "account_owner": {
            "last_name": "Kalvaris",
            "middle_name": null,
            "life_cycle_state": "FINANCIAL",
            "company_profile": null,
            "title": null,
            "first_name": "Myrias",
            "type": "PERSON",
            "id": "145037EE049032288366448D8FC1919B",
            "name": "Kalvaris Myrias",
            "company_name": null,
            "demographics": {
              "gender": null,
              "passport_issued_by_country": null,
              "social_security_number": null,
              "passport_number": null,
              "industry_sector": null,
              "country_of_residence": {
                "three_character_code": "CYP",
                "two_character_code": "CY",
                "id": "181",
                "name": "CYPRUS",
                "alternative_code": null
              },
              "name_day": {
                "month": null,
                "day": null
              },
              "date_of_birth": {
                "month": null,
                "day": null,
                "year": null
              },
              "id_number": "123456789",
              "industry": null,
              "id_issued_by_country": null
            }
          },
          "life_cycle_state": "ACTIVE",
          "number": "ACR000401",
          "id": "068B2E25D66A8D1572B8E1C039D501C8",
          "name": "Myria Kalvari Rewards"
        },
        "number": "20",
        "id": "1A400E0ED18344882D821125CB6FCFBD"
      },
      "wallet_transaction": 
        {
          "notes": null,
          "life_cycle_state": "EFFECTIVE",
          "extra_added_amount": null,
          "amount": 66,
          "number": "WT001292",
          "wallet": {
            "life_cycle_state": "EFFECTIVE",
            "accounts_receivable": {
              "account_owner": {
                "last_name": "Kalvaris",
                "middle_name": null,
                "life_cycle_state": "FINANCIAL",
                "company_profile": null,
                "title": null,
                "first_name": "Myrias",
                "type": "PERSON",
                "id": "145037EE049032288366448D8FC1919B",
                "name": null,
                "company_name": null,
                "demographics": {
                  "gender": null,
                  "passport_issued_by_country": null,
                  "social_security_number": null,
                  "passport_number": null,
                  "industry_sector": null,
                  "name_day": {
                    "month": null,
                    "day": null
                  },
                  "date_of_birth": {
                    "month": null,
                    "day": null,
                    "year": null
                  },
                  "id_number": "123456789",
                  "industry": null,
                  "id_issued_by_country": null
                }
              },
              "life_cycle_state": "ACTIVE",
              "number": "ACR000401",
              "id": "068B2E25D66A8D1572B8E1C039D501C8",
              "name": "Myria Kalvari Rewards"
            },
            "number": "WLT000112",
            "id": "31C7907B0190A65ECBA99CDED647C1C1"
          },
          "type": {
            "classification": "VOID",
            "id": "1EE27DC8528083BAF4887DF632D240FA",
            "name": "Normal Void",
            "description": "Normal Void for Wallets",
            "alternative_code": "NV"
          },
          "id": "29A8CE08ACB44AD399D096BA75AF83FA"
        },
        {
          "notes": null,
          "life_cycle_state": "VOIDED",
          "extra_added_amount": null,
          "amount": 66,
          "number": "WT001209",
          "wallet": {
            "life_cycle_state": "EFFECTIVE",
            "accounts_receivable": {
              "account_owner": {
                "last_name": "Kalvaris",
                "middle_name": null,
                "life_cycle_state": "FINANCIAL",
                "company_profile": null,
                "title": null,
                "first_name": "Myrias",
                "type": "PERSON",
                "id": "145037EE049032288366448D8FC1919B",
                "name": null,
                "company_name": null,
                "demographics": {
                  "gender": null,
                  "passport_issued_by_country": null,
                  "social_security_number": null,
                  "passport_number": null,
                  "industry_sector": null,
                  "name_day": {
                    "month": null,
                    "day": null
                  },
                  "date_of_birth": {
                    "month": null,
                    "day": null,
                    "year": null
                  },
                  "id_number": "123456789",
                  "industry": null,
                  "id_issued_by_country": null
                }
              },
              "life_cycle_state": "ACTIVE",
              "number": "ACR000401",
              "id": "068B2E25D66A8D1572B8E1C039D501C8",
              "name": "Myria Kalvari Rewards"
            },
            "number": "WLT000112",
            "id": "31C7907B0190A65ECBA99CDED647C1C1"
          },
          "type": {
            "classification": "CREDIT",
            "id": "981E56423160D488A58635847A84CAA3",
            "name": "Normal Credit",
            "description": "normal credit for wallets",
            "alternative_code": "NC"
          },
          "id": "A926B7A79FC04F99823B90F43959522D"
        },
      "number": "268",
      "id": "2E8007A6FECC40708CCB3ABF8F52B99D",
      "reward_offer": {
        "life_cycle_state": "NOT_EFFECTIVE",
        "number": "42",
        "id": "B89D5DC72E344F05B685C73D82C2E426",
        "name": "Utilise Free Capacity",
        "description": null,
        "alternative_code": "UFC"
      },
      "customer_events_set": [
        {
          "life_cycle_state": "POSTED",
          "classification": null,
          "number": "299",
          "type": "PURCHASE",
          "id": "950A796BE089436EADCE3AD9E840E015"
        }
      ],
      "expiration_date": "2015-12-06T00:00:00"
    },
    {
      "award_expiration_transaction": null,
      "log_information": {
        "updated_date": "2015-12-19T12:59:20",
        "created_date": "2015-12-17T14:06:36",
        "created_by_unit": {
          "community_name": "Internal Community",
          "id": "48305F8849E3C18B227C5BE3A27BA6DF",
          "name": "Admin Unit",
          "group_name": "Main Group",
          "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
          "alternative_code": "MG"
        },
        "updated_by_unit": {
          "community_name": "Internal Community",
          "id": "48305F8849E3C18B227C5BE3A27BA6DF",
          "name": "Admin Unit",
          "group_name": "Main Group",
          "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
          "alternative_code": "MG"
        },
        "created_by_user": {
          "person_name": "MPAdministrator",
          "username": "MPAdministrator",
          "id": "1",
          "email": "sakkascy1986@hotmail.com"
        },
        "updated_by_user": {
          "person_name": "MPAdministrator",
          "username": "MPAdministrator",
          "id": "1",
          "email": "sakkascy1986@hotmail.com"
        }
      },
      "life_cycle_state": "POSTED",
      "amount": 10,
      "rewards_participant": {
        "accounts_receivable": {
          "account_owner": {
            "last_name": "Kalvaris",
            "middle_name": null,
            "life_cycle_state": "FINANCIAL",
            "company_profile": null,
            "title": null,
            "first_name": "Myrias",
            "type": "PERSON",
            "id": "145037EE049032288366448D8FC1919B",
            "name": "Kalvaris Myrias",
            "company_name": null,
            "demographics": {
              "gender": null,
              "passport_issued_by_country": null,
              "social_security_number": null,
              "passport_number": null,
              "industry_sector": null,
              "country_of_residence": {
                "three_character_code": "CYP",
                "two_character_code": "CY",
                "id": "181",
                "name": "CYPRUS",
                "alternative_code": null
              },
              "name_day": {
                "month": null,
                "day": null
              },
              "date_of_birth": {
                "month": null,
                "day": null,
                "year": null
              },
              "id_number": "123456789",
              "industry": null,
              "id_issued_by_country": null
            }
          },
          "life_cycle_state": "ACTIVE",
          "number": "ACR000401",
          "id": "068B2E25D66A8D1572B8E1C039D501C8",
          "name": "Myria Kalvari Rewards"
        },
        "number": "20",
        "id": "1A400E0ED18344882D821125CB6FCFBD"
      },
      "wallet_transaction": {},
      "number": "291",
      "id": "5ACE8A3D025742F999A8AA7E9211AA4A",
      "reward_offer": {
        "life_cycle_state": "NOT_EFFECTIVE",
        "number": "43",
        "id": "86339F52CAC84A6EBF3DA9BA6B8A7403",
        "name": "Increase Revenue Product Based",
        "description": null,
        "alternative_code": "IRPB"
      },
      "customer_events_set": [
        {
          "life_cycle_state": "POSTED",
          "classification": null,
          "number": "337",
          "type": "PURCHASE",
          "id": "92A03198F6BE41229D2E14F1E2F638D2"
        }
      ],
      "expiration_date": "2016-01-17T14:06:36"
    },
    {
      "award_expiration_transaction": null,
      "log_information": {
        "updated_date": "2015-12-19T12:59:20",
        "created_date": "2015-12-17T14:06:36",
        "created_by_unit": {
          "community_name": "Internal Community",
          "id": "48305F8849E3C18B227C5BE3A27BA6DF",
          "name": "Admin Unit",
          "group_name": "Main Group",
          "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
          "alternative_code": "MG"
        },
        "updated_by_unit": {
          "community_name": "Internal Community",
          "id": "48305F8849E3C18B227C5BE3A27BA6DF",
          "name": "Admin Unit",
          "group_name": "Main Group",
          "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
          "alternative_code": "MG"
        },
        "created_by_user": {
          "person_name": "MPAdministrator",
          "username": "MPAdministrator",
          "id": "1",
          "email": "sakkascy1986@hotmail.com"
        },
        "updated_by_user": {
          "person_name": "MPAdministrator",
          "username": "MPAdministrator",
          "id": "1",
          "email": "sakkascy1986@hotmail.com"
        }
      },
      "life_cycle_state": "POSTED",
      "amount": 110,
      "rewards_participant": {
        "accounts_receivable": {
          "account_owner": {
            "last_name": "Kalvaris",
            "middle_name": null,
            "life_cycle_state": "FINANCIAL",
            "company_profile": null,
            "title": null,
            "first_name": "Myrias",
            "type": "PERSON",
            "id": "145037EE049032288366448D8FC1919B",
            "name": "Kalvaris Myrias",
            "company_name": null,
            "demographics": {
              "gender": null,
              "passport_issued_by_country": null,
              "social_security_number": null,
              "passport_number": null,
              "industry_sector": null,
              "country_of_residence": {
                "three_character_code": "CYP",
                "two_character_code": "CY",
                "id": "181",
                "name": "CYPRUS",
                "alternative_code": null
              },
              "name_day": {
                "month": null,
                "day": null
              },
              "date_of_birth": {
                "month": null,
                "day": null,
                "year": null
              },
              "id_number": "123456789",
              "industry": null,
              "id_issued_by_country": null
            }
          },
          "life_cycle_state": "ACTIVE",
          "number": "ACR000401",
          "id": "068B2E25D66A8D1572B8E1C039D501C8",
          "name": "Myria Kalvari Rewards"
        },
        "number": "20",
        "id": "1A400E0ED18344882D821125CB6FCFBD"
      },
      "wallet_transaction": {},
      "number": "292",
      "id": "B9E972CE40B44128BBF3DC5B8D8BFB5F",
      "reward_offer": {
        "life_cycle_state": "NOT_EFFECTIVE",
        "number": "42",
        "id": "B89D5DC72E344F05B685C73D82C2E426",
        "name": "Utilise Free Capacity",
        "description": null,
        "alternative_code": "UFC"
      },
      "customer_events_set": [
        {
          "life_cycle_state": "POSTED",
          "classification": null,
          "number": "337",
          "type": "PURCHASE",
          "id": "33888D18582C4B9CB5BCF88E7674D3A9"
        }
      ],
      "expiration_date": "2015-12-06T00:00:00"
    },
    {
      "award_expiration_transaction": null,
      "log_information": {
        "updated_date": "2015-12-19T12:59:20",
        "created_date": "2015-12-17T14:18:20",
        "created_by_unit": {
          "community_name": "Internal Community",
          "id": "48305F8849E3C18B227C5BE3A27BA6DF",
          "name": "Admin Unit",
          "group_name": "Main Group",
          "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
          "alternative_code": "MG"
        },
        "updated_by_unit": {
          "community_name": "Internal Community",
          "id": "48305F8849E3C18B227C5BE3A27BA6DF",
          "name": "Admin Unit",
          "group_name": "Main Group",
          "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
          "alternative_code": "MG"
        },
        "created_by_user": {
          "person_name": "MPAdministrator",
          "username": "MPAdministrator",
          "id": "1",
          "email": "sakkascy1986@hotmail.com"
        },
        "updated_by_user": {
          "person_name": "MPAdministrator",
          "username": "MPAdministrator",
          "id": "1",
          "email": "sakkascy1986@hotmail.com"
        }
      },
      "life_cycle_state": "POSTED",
      "amount": 10,
      "rewards_participant": {
        "accounts_receivable": {
          "account_owner": {
            "last_name": "Kalvaris",
            "middle_name": null,
            "life_cycle_state": "FINANCIAL",
            "company_profile": null,
            "title": null,
            "first_name": "Myrias",
            "type": "PERSON",
            "id": "145037EE049032288366448D8FC1919B",
            "name": "Kalvaris Myrias",
            "company_name": null,
            "demographics": {
              "gender": null,
              "passport_issued_by_country": null,
              "social_security_number": null,
              "passport_number": null,
              "industry_sector": null,
              "country_of_residence": {
                "three_character_code": "CYP",
                "two_character_code": "CY",
                "id": "181",
                "name": "CYPRUS",
                "alternative_code": null
              },
              "name_day": {
                "month": null,
                "day": null
              },
              "date_of_birth": {
                "month": null,
                "day": null,
                "year": null
              },
              "id_number": "123456789",
              "industry": null,
              "id_issued_by_country": null
            }
          },
          "life_cycle_state": "ACTIVE",
          "number": "ACR000401",
          "id": "068B2E25D66A8D1572B8E1C039D501C8",
          "name": "Myria Kalvari Rewards"
        },
        "number": "20",
        "id": "1A400E0ED18344882D821125CB6FCFBD"
      },
      "wallet_transaction": 
        {
          "notes": null,
          "life_cycle_state": "EFFECTIVE",
          "extra_added_amount": null,
          "amount": 10,
          "number": "WT001231",
          "wallet": {
            "life_cycle_state": "EFFECTIVE",
            "accounts_receivable": {
              "account_owner": {
                "last_name": "Kalvaris",
                "middle_name": null,
                "life_cycle_state": "FINANCIAL",
                "company_profile": null,
                "title": null,
                "first_name": "Myrias",
                "type": "PERSON",
                "id": "145037EE049032288366448D8FC1919B",
                "name": null,
                "company_name": null,
                "demographics": {
                  "gender": null,
                  "passport_issued_by_country": null,
                  "social_security_number": null,
                  "passport_number": null,
                  "industry_sector": null,
                  "name_day": {
                    "month": null,
                    "day": null
                  },
                  "date_of_birth": {
                    "month": null,
                    "day": null,
                    "year": null
                  },
                  "id_number": "123456789",
                  "industry": null,
                  "id_issued_by_country": null
                }
              },
              "life_cycle_state": "ACTIVE",
              "number": "ACR000401",
              "id": "068B2E25D66A8D1572B8E1C039D501C8",
              "name": "Myria Kalvari Rewards"
            },
            "number": "WLT000112",
            "id": "31C7907B0190A65ECBA99CDED647C1C1"
          },
          "type": {
            "classification": "CREDIT",
            "id": "84739C8796344652B9EBEBFA0B4D9255",
            "name": "New Credit Type",
            "description": null,
            "alternative_code": "NCT"
          },
          "id": "4556E9F6EFBE45D4AFEF0BE996C56248"
        },
      "number": "293",
      "id": "9C72B8FC428F4D7ABF237D545AA858BB",
      "reward_offer": {
        "life_cycle_state": "NOT_EFFECTIVE",
        "number": "43",
        "id": "86339F52CAC84A6EBF3DA9BA6B8A7403",
        "name": "Increase Revenue Product Based",
        "description": null,
        "alternative_code": "IRPB"
      },
      "customer_events_set": [
        {
          "life_cycle_state": "POSTED",
          "classification": null,
          "number": "338",
          "type": "PURCHASE",
          "id": "D3ECAC3DA6B4486F9F3154232CEE7EB3"
        }
      ],
      "expiration_date": "2016-01-17T14:18:20"
    },
    {
      "award_expiration_transaction": null,
      "log_information": {
        "updated_date": "2015-12-19T12:59:20",
        "created_date": "2015-12-17T14:18:20",
        "created_by_unit": {
          "community_name": "Internal Community",
          "id": "48305F8849E3C18B227C5BE3A27BA6DF",
          "name": "Admin Unit",
          "group_name": "Main Group",
          "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
          "alternative_code": "MG"
        },
        "updated_by_unit": {
          "community_name": "Internal Community",
          "id": "48305F8849E3C18B227C5BE3A27BA6DF",
          "name": "Admin Unit",
          "group_name": "Main Group",
          "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
          "alternative_code": "MG"
        },
        "created_by_user": {
          "person_name": "MPAdministrator",
          "username": "MPAdministrator",
          "id": "1",
          "email": "sakkascy1986@hotmail.com"
        },
        "updated_by_user": {
          "person_name": "MPAdministrator",
          "username": "MPAdministrator",
          "id": "1",
          "email": "sakkascy1986@hotmail.com"
        }
      },
      "life_cycle_state": "POSTED",
      "amount": 165,
      "rewards_participant": {
        "accounts_receivable": {
          "account_owner": {
            "last_name": "Kalvaris",
            "middle_name": null,
            "life_cycle_state": "FINANCIAL",
            "company_profile": null,
            "title": null,
            "first_name": "Myrias",
            "type": "PERSON",
            "id": "145037EE049032288366448D8FC1919B",
            "name": "Kalvaris Myrias",
            "company_name": null,
            "demographics": {
              "gender": null,
              "passport_issued_by_country": null,
              "social_security_number": null,
              "passport_number": null,
              "industry_sector": null,
              "country_of_residence": {
                "three_character_code": "CYP",
                "two_character_code": "CY",
                "id": "181",
                "name": "CYPRUS",
                "alternative_code": null
              },
              "name_day": {
                "month": null,
                "day": null
              },
              "date_of_birth": {
                "month": null,
                "day": null,
                "year": null
              },
              "id_number": "123456789",
              "industry": null,
              "id_issued_by_country": null
            }
          },
          "life_cycle_state": "ACTIVE",
          "number": "ACR000401",
          "id": "068B2E25D66A8D1572B8E1C039D501C8",
          "name": "Myria Kalvari Rewards"
        },
        "number": "20",
        "id": "1A400E0ED18344882D821125CB6FCFBD"
      },
      "wallet_transaction": 
        {
          "notes": null,
          "life_cycle_state": "EFFECTIVE",
          "extra_added_amount": null,
          "amount": 165,
          "number": "WT001232",
          "wallet": {
            "life_cycle_state": "EFFECTIVE",
            "accounts_receivable": {
              "account_owner": {
                "last_name": "Kalvaris",
                "middle_name": null,
                "life_cycle_state": "FINANCIAL",
                "company_profile": null,
                "title": null,
                "first_name": "Myrias",
                "type": "PERSON",
                "id": "145037EE049032288366448D8FC1919B",
                "name": null,
                "company_name": null,
                "demographics": {
                  "gender": null,
                  "passport_issued_by_country": null,
                  "social_security_number": null,
                  "passport_number": null,
                  "industry_sector": null,
                  "name_day": {
                    "month": null,
                    "day": null
                  },
                  "date_of_birth": {
                    "month": null,
                    "day": null,
                    "year": null
                  },
                  "id_number": "123456789",
                  "industry": null,
                  "id_issued_by_country": null
                }
              },
              "life_cycle_state": "ACTIVE",
              "number": "ACR000401",
              "id": "068B2E25D66A8D1572B8E1C039D501C8",
              "name": "Myria Kalvari Rewards"
            },
            "number": "WLT000112",
            "id": "31C7907B0190A65ECBA99CDED647C1C1"
          },
          "type": {
            "classification": "CREDIT",
            "id": "84739C8796344652B9EBEBFA0B4D9255",
            "name": "New Credit Type",
            "description": null,
            "alternative_code": "NCT"
          },
          "id": "2B6B2EB6374E44FD9A8E36085C686AB6"
        },
      "number": "294",
      "id": "556E78DFEC0645A6B599B87F11633708",
      "reward_offer": {
        "life_cycle_state": "NOT_EFFECTIVE",
        "number": "42",
        "id": "B89D5DC72E344F05B685C73D82C2E426",
        "name": "Utilise Free Capacity",
        "description": null,
        "alternative_code": "UFC"
      },
      "customer_events_set": [
        {
          "life_cycle_state": "POSTED",
          "classification": null,
          "number": "338",
          "type": "PURCHASE",
          "id": "B1F48AF6325A4A09B52F1F9288ED1C7E"
        }
      ],
      "expiration_date": "2015-12-06T00:00:00"
    }
  ]
}
 Example 2

HTTP Method: POST

 

Request:

Body:

{
    "token":"{{token}}",
    "rewards_participant_identifier":{"number":"RP0000000057"}
}


Response:

{
  "data": [
    {
      "number": "1066",
      "amount": 10,
      "log_information": {
        "created_by_unit": {
          "alternative_code": "adminunit",
          "group_name": "Main Group",
          "community_name": "Community",
          "name": "Admin Unit",
          "description": "admin unit",
          "id": "1"
        },
        "updated_by_unit": {
          "alternative_code": "adminunit",
          "group_name": "Main Group",
          "community_name": "Community",
          "name": "Admin Unit",
          "description": "admin unit",
          "id": "1"
        },
        "created_date": "2016-07-13T14:03:25",
        "updated_date": "2016-07-13T14:03:25",
        "updated_by_user": {
          "person_name": "MPAdministrator",
          "id": "1",
          "email": "dev@crm.com",
          "username": "MPAdministrator"
        },
        "created_by_user": {
          "person_name": "MPAdministrator",
          "id": "1",
          "email": "dev@crm.com",
          "username": "MPAdministrator"
        }
      },
      "award_expiration_transaction": null,
      "reward_offer": {
        "number": "22",
        "name": "10 Euro award",
        "description": null,
        "id": "3DE813A206804C1FA1B923750378CA91",
        "life_cycle_state": "EFFECTIVE"
      },
      "currency_rate_period": {
        "from_date": "C7D7ED57F21B47028144967E015DCBE5",
        "to_date": 2.3,
        "rate": 2.3,
        "inverse_rate": 0.23000000417232513,
        "currency": {
          "suffix_symbol": null,
          "prefix_symbol": "£",
          "decimal_part_name": null,
          "code": "GBP",
          "integer_part_name": null,
          "id": "9"
        },
        "id": "C7D7ED57F21B47028144967E015DCBE5"
      },
      "id": "73B1C352F6B54C368296E1E2ED13C125",
      "life_cycle_state": "POSTED",
      "expiration_date": null,
      "wallet_transaction": 
        {
          "number": "1459",
          "amount": 10,
          "notes": null,
          "wallet": {
            "number": "W0000000255",
            "accounts_receivable": {
              "number": "ACR0000000288",
              "name": "ACR0000000288 Katerina  Nicolaou-Included address area/city",
              "id": "3E3FADF2632C41E7987032CFDFF404DC",
              "life_cycle_state": "ACTIVE",
              "account_owner": {
                "company_profile": null,
                "company_name": null,
                "name": null,
                "last_name": "Nicolaou-Included address area/city",
                "id": "BB1345CC41AD4ECAB3EE01E2E5FD651A",
                "life_cycle_state": "FINANCIAL",
                "middle_name": null,
                "title": null,
                "type": "PERSON",
                "first_name": "Katerina ",
                "demographics": {
                  "name_day": {
                    "month": null,
                    "day": null
                  },
                  "id_number": null,
                  "gender": null,
                  "date_of_birth": {
                    "month": null,
                    "year": null,
                    "day": null
                  },
                  "industry_sector": null,
                  "passport_number": null,
                  "industry": null,
                  "social_security_number": null,
                  "id_issued_by_country": null,
                  "passport_issued_by_country": null
                }
              }
            },
            "id": "C9414A525E8645CFAC622524ACA1CF4E",
            "life_cycle_state": "EFFECTIVE"
          },
          "log_information": {
            "created_by_unit": {
              "alternative_code": "adminunit",
              "name": "Admin Unit",
              "description": "admin unit",
              "id": "1"
            },
            "updated_by_unit": {
              "alternative_code": "adminunit",
              "name": "Admin Unit",
              "description": "admin unit",
              "id": "1"
            },
            "created_date": "2016-07-13T14:03:25",
            "updated_date": "2016-07-13T14:03:25",
            "updated_by_user": {
              "person_name": "MPAdministrator",
              "id": "1",
              "username": "MPAdministrator"
            },
            "created_by_user": {
              "person_name": "MPAdministrator",
              "id": "1",
              "username": "MPAdministrator"
            }
          },
          "id": "A0663AB39A6248FBBC65B5FF8C113D6D",
          "life_cycle_state": "EFFECTIVE",
          "extra_added_amount": null,
          "type": {
            "alternative_code": "WC",
            "name": "Wallet Credit",
            "description": "Wallet Credit",
            "id": "CA1B3E67E5A6F899512CEFE24E40875B",
            "classification": "CREDIT"
          }
        },
      "customer_events_set": [],
      "rewards_participant": {
        "number": "RP0000000057",
        "accounts_receivable": {
          "number": "ACR0000000288",
          "name": "ACR0000000288 Katerina  Nicolaou-Included address area/city",
          "id": "3E3FADF2632C41E7987032CFDFF404DC",
          "life_cycle_state": "ACTIVE",
          "account_owner": {
            "company_profile": null,
            "company_name": null,
            "name": "Katerina  Nicolaou-Included address area/city",
            "last_name": "Nicolaou-Included address area/city",
            "id": "BB1345CC41AD4ECAB3EE01E2E5FD651A",
            "life_cycle_state": "FINANCIAL",
            "middle_name": null,
            "title": null,
            "type": "PERSON",
            "first_name": "Katerina ",
            "demographics": {
              "name_day": {
                "month": null,
                "day": null
              },
              "id_number": null,
              "gender": null,
              "country_of_residence": {
                "alternative_code": "CYP",
                "three_character_code": "CYP",
                "name": "CYPRUS",
                "id": "181",
                "two_character_code": "CY"
              },
              "date_of_birth": {
                "month": null,
                "year": null,
                "day": null
              },
              "industry_sector": null,
              "passport_number": null,
              "industry": null,
              "social_security_number": null,
              "id_issued_by_country": null,
              "passport_issued_by_country": null
            }
          }
        },
        "id": "58AF4E5C1B0F41C59BA3820F5454A768"
      }
    },
    {
      "number": "1073",
      "amount": 65,
      "log_information": {
        "created_by_unit": {
          "alternative_code": "adminunit",
          "group_name": "Main Group",
          "community_name": "Community",
          "name": "Admin Unit",
          "description": "admin unit",
          "id": "1"
        },
        "updated_by_unit": {
          "alternative_code": "adminunit",
          "group_name": "Main Group",
          "community_name": "Community",
          "name": "Admin Unit",
          "description": "admin unit",
          "id": "1"
        },
        "created_date": "2016-07-13T14:03:49",
        "updated_date": "2016-07-13T14:03:49",
        "updated_by_user": {
          "person_name": "MPAdministrator",
          "id": "1",
          "email": "dev@crm.com",
          "username": "MPAdministrator"
        },
        "created_by_user": {
          "person_name": "MPAdministrator",
          "id": "1",
          "email": "dev@crm.com",
          "username": "MPAdministrator"
        }
      },
      "award_expiration_transaction": null,
      "reward_offer": {
        "number": "58",
        "name": "ET Just Money",
        "description": null,
        "id": "E8E5733EA0F34804BEE8B823D6C61611",
        "life_cycle_state": "EFFECTIVE"
      },
      "currency_rate_period": null,
      "id": "385E17501A7840E3ABA96FEAEA67B1A5",
      "life_cycle_state": "POSTED",
      "expiration_date": null,
      "wallet_transaction": 
        {
          "number": "1467",
          "amount": 65,
          "notes": null,
          "wallet": {
            "number": "W0000000255",
            "accounts_receivable": {
              "number": "ACR0000000288",
              "name": "ACR0000000288 Katerina  Nicolaou-Included address area/city",
              "id": "3E3FADF2632C41E7987032CFDFF404DC",
              "life_cycle_state": "ACTIVE",
              "account_owner": {
                "company_profile": null,
                "company_name": null,
                "name": null,
                "last_name": "Nicolaou-Included address area/city",
                "id": "BB1345CC41AD4ECAB3EE01E2E5FD651A",
                "life_cycle_state": "FINANCIAL",
                "middle_name": null,
                "title": null,
                "type": "PERSON",
                "first_name": "Katerina ",
                "demographics": {
                  "name_day": {
                    "month": null,
                    "day": null
                  },
                  "id_number": null,
                  "gender": null,
                  "date_of_birth": {
                    "month": null,
                    "year": null,
                    "day": null
                  },
                  "industry_sector": null,
                  "passport_number": null,
                  "industry": null,
                  "social_security_number": null,
                  "id_issued_by_country": null,
                  "passport_issued_by_country": null
                }
              }
            },
            "id": "C9414A525E8645CFAC622524ACA1CF4E",
            "life_cycle_state": "EFFECTIVE"
          },
          "log_information": {
            "created_by_unit": {
              "alternative_code": "adminunit",
              "name": "Admin Unit",
              "description": "admin unit",
              "id": "1"
            },
            "updated_by_unit": {
              "alternative_code": "adminunit",
              "name": "Admin Unit",
              "description": "admin unit",
              "id": "1"
            },
            "created_date": "2016-07-13T14:03:49",
            "updated_date": "2016-07-13T14:03:49",
            "updated_by_user": {
              "person_name": "MPAdministrator",
              "id": "1",
              "username": "MPAdministrator"
            },
            "created_by_user": {
              "person_name": "MPAdministrator",
              "id": "1",
              "username": "MPAdministrator"
            }
          },
          "id": "D43A4FB22A8E4401A07B1F644F98D081",
          "life_cycle_state": "EFFECTIVE",
          "extra_added_amount": null,
          "type": {
            "alternative_code": "WC",
            "name": "Wallet Credit",
            "description": "Wallet Credit",
            "id": "CA1B3E67E5A6F899512CEFE24E40875B",
            "classification": "CREDIT"
          }
        },
      "customer_events_set": [],
      "rewards_participant": {
        "number": "RP0000000057",
        "accounts_receivable": {
          "number": "ACR0000000288",
          "name": "ACR0000000288 Katerina  Nicolaou-Included address area/city",
          "id": "3E3FADF2632C41E7987032CFDFF404DC",
          "life_cycle_state": "ACTIVE",
          "account_owner": {
            "company_profile": null,
            "company_name": null,
            "name": "Katerina  Nicolaou-Included address area/city",
            "last_name": "Nicolaou-Included address area/city",
            "id": "BB1345CC41AD4ECAB3EE01E2E5FD651A",
            "life_cycle_state": "FINANCIAL",
            "middle_name": null,
            "title": null,
            "type": "PERSON",
            "first_name": "Katerina ",
            "demographics": {
              "name_day": {
                "month": null,
                "day": null
              },
              "id_number": null,
              "gender": null,
              "country_of_residence": {
                "alternative_code": "CYP",
                "three_character_code": "CYP",
                "name": "CYPRUS",
                "id": "181",
                "two_character_code": "CY"
              },
              "date_of_birth": {
                "month": null,
                "year": null,
                "day": null
              },
              "industry_sector": null,
              "passport_number": null,
              "industry": null,
              "social_security_number": null,
              "id_issued_by_country": null,
              "passport_issued_by_country": null
            }
          }
        },
        "id": "58AF4E5C1B0F41C59BA3820F5454A768"
      }
    },
    {
      "number": "1160",
      "amount": 8.8,
      "log_information": {
        "created_by_unit": {
          "alternative_code": "adminunit",
          "group_name": "Main Group",
          "community_name": "Community",
          "name": "Admin Unit",
          "description": "admin unit",
          "id": "1"
        },
        "updated_by_unit": {
          "alternative_code": "adminunit",
          "group_name": "Main Group",
          "community_name": "Community",
          "name": "Admin Unit",
          "description": "admin unit",
          "id": "1"
        },
        "created_date": "2016-07-13T14:53:34",
        "updated_date": "2016-07-13T14:53:34",
        "updated_by_user": {
          "person_name": "MPAdministrator",
          "id": "1",
          "email": "dev@crm.com",
          "username": "MPAdministrator"
        },
        "created_by_user": {
          "person_name": "MPAdministrator",
          "id": "1",
          "email": "dev@crm.com",
          "username": "MPAdministrator"
        }
      },
      "award_expiration_transaction": null,
      "reward_offer": {
        "number": "55",
        "name": "ET  Reward Loyalty Transaction Amount Based",
        "description": null,
        "id": "5F9F3B3FBF2C45DCB33A5719FB859A42",
        "life_cycle_state": "EFFECTIVE"
      },
      "currency_rate_period": null,
      "id": "70BC70010C31418C9379651BA6A9CFA4",
      "life_cycle_state": "POSTED",
      "expiration_date": null,
      "wallet_transaction": 
        {
          "number": "1554",
          "amount": 8.8,
          "notes": null,
          "wallet": {
            "number": "W0000000255",
            "accounts_receivable": {
              "number": "ACR0000000288",
              "name": "ACR0000000288 Katerina  Nicolaou-Included address area/city",
              "id": "3E3FADF2632C41E7987032CFDFF404DC",
              "life_cycle_state": "ACTIVE",
              "account_owner": {
                "company_profile": null,
                "company_name": null,
                "name": null,
                "last_name": "Nicolaou-Included address area/city",
                "id": "BB1345CC41AD4ECAB3EE01E2E5FD651A",
                "life_cycle_state": "FINANCIAL",
                "middle_name": null,
                "title": null,
                "type": "PERSON",
                "first_name": "Katerina ",
                "demographics": {
                  "name_day": {
                    "month": null,
                    "day": null
                  },
                  "id_number": null,
                  "gender": null,
                  "date_of_birth": {
                    "month": null,
                    "year": null,
                    "day": null
                  },
                  "industry_sector": null,
                  "passport_number": null,
                  "industry": null,
                  "social_security_number": null,
                  "id_issued_by_country": null,
                  "passport_issued_by_country": null
                }
              }
            },
            "id": "C9414A525E8645CFAC622524ACA1CF4E",
            "life_cycle_state": "EFFECTIVE"
          },
          "log_information": {
            "created_by_unit": {
              "alternative_code": "adminunit",
              "name": "Admin Unit",
              "description": "admin unit",
              "id": "1"
            },
            "updated_by_unit": {
              "alternative_code": "adminunit",
              "name": "Admin Unit",
              "description": "admin unit",
              "id": "1"
            },
            "created_date": "2016-07-13T14:53:34",
            "updated_date": "2016-07-13T14:53:34",
            "updated_by_user": {
              "person_name": "MPAdministrator",
              "id": "1",
              "username": "MPAdministrator"
            },
            "created_by_user": {
              "person_name": "MPAdministrator",
              "id": "1",
              "username": "MPAdministrator"
            }
          },
          "id": "9B135689DA6E41AD9B1D60A0C53DBEEB",
          "life_cycle_state": "EFFECTIVE",
          "extra_added_amount": null,
          "type": {
            "alternative_code": "WC",
            "name": "Wallet Credit",
            "description": "Wallet Credit",
            "id": "CA1B3E67E5A6F899512CEFE24E40875B",
            "classification": "CREDIT"
          }
        },
      "customer_events_set": [
        {
          "number": "334",
          "id": "BE6F5F432B454FC3AE5875CAC8B9A607",
          "life_cycle_state": "POSTED",
          "type": "PURCHASE",
          "classification": null
        },
        {
          "number": "317",
          "id": "0E86F1145E8246D0B4CB135278A80D4D",
          "life_cycle_state": "POSTED",
          "type": "PURCHASE",
          "classification": null
        },
        {
          "number": "303",
          "id": "78C0B3EBC52E49928C819B2124C0F3BF",
          "life_cycle_state": "POSTED",
          "type": "PURCHASE",
          "classification": null
        },
        {
          "number": "304",
          "id": "9123EA66215848819D68E9F98333799E",
          "life_cycle_state": "POSTED",
          "type": "PURCHASE",
          "classification": null
        },
        {
          "number": "330",
          "id": "4FEE7A2717A244C198050F440EBEA95B",
          "life_cycle_state": "POSTED",
          "type": "PURCHASE",
          "classification": null
        },
        {
          "number": "293",
          "id": "4A7A09DE8F714BC2883E8D1F23B2F2FE",
          "life_cycle_state": "POSTED",
          "type": "PURCHASE",
          "classification": null
        },
        {
          "number": "313",
          "id": "101FB5257FB44DB5A854E344CD37C6F3",
          "life_cycle_state": "POSTED",
          "type": "PURCHASE",
          "classification": null
        },
        {
          "number": "287",
          "id": "1E0FF86A413B480E83DAB9FAE8FA5760",
          "life_cycle_state": "POSTED",
          "type": "PURCHASE",
          "classification": null
        },
        {
          "number": "298",
          "id": "0002659C0634476B988046C42EA86D50",
          "life_cycle_state": "POSTED",
          "type": "PURCHASE",
          "classification": null
        },
        {
          "number": "309",
          "id": "B5A7826093DF4938A01F309C8DF32122",
          "life_cycle_state": "POSTED",
          "type": "PURCHASE",
          "classification": null
        }
      ],
      "rewards_participant": {
        "number": "RP0000000057",
        "accounts_receivable": {
          "number": "ACR0000000288",
          "name": "ACR0000000288 Katerina  Nicolaou-Included address area/city",
          "id": "3E3FADF2632C41E7987032CFDFF404DC",
          "life_cycle_state": "ACTIVE",
          "account_owner": {
            "company_profile": null,
            "company_name": null,
            "name": "Katerina  Nicolaou-Included address area/city",
            "last_name": "Nicolaou-Included address area/city",
            "id": "BB1345CC41AD4ECAB3EE01E2E5FD651A",
            "life_cycle_state": "FINANCIAL",
            "middle_name": null,
            "title": null,
            "type": "PERSON",
            "first_name": "Katerina ",
            "demographics": {
              "name_day": {
                "month": null,
                "day": null
              },
              "id_number": null,
              "gender": null,
              "country_of_residence": {
                "alternative_code": "CYP",
                "three_character_code": "CYP",
                "name": "CYPRUS",
                "id": "181",
                "two_character_code": "CY"
              },
              "date_of_birth": {
                "month": null,
                "year": null,
                "day": null
              },
              "industry_sector": null,
              "passport_number": null,
              "industry": null,
              "social_security_number": null,
              "id_issued_by_country": null,
              "passport_issued_by_country": null
            }
          }
        },
        "id": "58AF4E5C1B0F41C59BA3820F5454A768"
      }
    }
  ],
  "status": {
    "code": "OK",
    "description": "",
    "message": ""
  }
}




 Example 3

HTTP Method: POST

 

Request:

Body:

{
    "token":"{{token}}",
    "accounts_receivable_identifier":{"id":"268861F901364A1CA23F74F644547DD9"},
  "submitted_after_date":"2016-07-01T09:00:12",
  "submitted_before_date":"2016-08-01T15:00:12",
            "fields_set": "number,log_information"
}


Response:

{
  "data": [
    {
      "number": "998",
      "log_information": {
        "created_by_unit": {
          "alternative_code": "adminunit",
          "group_name": "Main Group",
          "community_name": "Community",
          "name": "Admin Unit",
          "description": "admin unit",
          "id": "1"
        },
        "updated_by_unit": {
          "alternative_code": "adminunit",
          "group_name": "Main Group",
          "community_name": "Community",
          "name": "Admin Unit",
          "description": "admin unit",
          "id": "1"
        },
        "created_date": "2016-07-29T13:25:26",
        "updated_date": "2016-07-29T13:25:26",
        "updated_by_user": {
          "person_name": "MPAdministrator",
          "id": "1",
          "email": null,
          "username": "MPAdministrator"
        },
        "created_by_user": {
          "person_name": "MPAdministrator",
          "id": "1",
          "email": null,
          "username": "MPAdministrator"
        }
      }
    },
    {
      "number": "1001",
      "log_information": {
        "created_by_unit": {
          "alternative_code": "adminunit",
          "group_name": "Main Group",
          "community_name": "Community",
          "name": "Admin Unit",
          "description": "admin unit",
          "id": "1"
        },
        "updated_by_unit": {
          "alternative_code": "adminunit",
          "group_name": "Main Group",
          "community_name": "Community",
          "name": "Admin Unit",
          "description": "admin unit",
          "id": "1"
        },
        "created_date": "2016-08-01T09:55:02",
        "updated_date": "2016-08-01T09:55:02",
        "updated_by_user": {
          "person_name": "MPAdministrator",
          "id": "1",
          "email": null,
          "username": "MPAdministrator"
        },
        "created_by_user": {
          "person_name": "MPAdministrator",
          "id": "1",
          "email": null,
          "username": "MPAdministrator"
        }
      }
    }
  ],
  "status": {
    "code": "OK",
    "description": "",
    "message": ""
  }
}
  • No labels