Versions Compared

Old Version 63

changes.mady.by.user Ekaterini Tzirtzipi

Saved on

compared with

New Version 64

changes.mady.by.user Ekaterini Tzirtzipi

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Tip

Available from CRM.COM R10.0.0

Table of Contents
maxLevel2

...

Name

Type

Description

token

String

The token retrieved from the login method

reward_award_transaction_identifier

(semi-optional)

String

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

Include Page
V4:award_reward_transaction_identifier
V4:award_reward_transaction_identifier

Tip

For releases prior to CRM.COM R10.1.0 this information is mandatory

wallet_transaction_identifier

(semi-optional)

Wallet Transaction identifier

The identifier of the wallet transaction related with the reward award transaction that should be returned as a result. The allowed wallet transaction identifier fields are the following:

Include Page
V4:wallet_transaction_identifier
V4:wallet_transaction_identifier

Tip

Available from CRM.COM R10.1.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

...

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:

Include Page
V4:rewards_participants_identifier
V4:rewards_participants_identifier

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:

Include Page
V4:accounts_receivable_identifier
V4:accounts_receivable_identifier

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:

Include Page
V4:wallet_identifier
V4:wallet_identifier

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:

Include Page
V4:customer_event_identifier
V4:customer_event_identifier

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:

Include Page
V4:customer_event_identifier
V4:customer_event_identifier

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:

Include Page
V4:customer_event_identifier
V4:customer_event_identifier

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:

Include Page
V4:customer_event_identifier
V4:customer_event_identifier

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:

Include Page
V4:customer_event_identifier
V4:customer_event_identifier

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:

Include Page
V4:customer_event_identifier
V4:customer_event_identifier

Tip

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

Tip

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

Tip

Available from CRM.COM R12.2.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

...

GET reward_transactions/awards/get_allocated_spends

Tip

Available from CRM.COM R10.1.0

This method returns information related with the spend reward transactions that were allocated against a specific award reward transaction. Multiple spend reward transactions are retrieved by each call.

...

Name

Type

Description

token

String

The token retrieved from the login method

reward_award_transaction_identifier

(semi-optional)

Award Reward Transaction Identifier

The identifier of the award reward transaction that should be retrieved. The allowed award reward transaction identifier fields are the following:

Include Page
V4:award_reward_transaction_identifier
V4:award_reward_transaction_identifier

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

...

Name

Type

Description

token

String

The token retrieved from the login method

reward_spend_transaction_identifier

(semi-optional)

String

The identifier of the reward spend transaction that should be returned as a result. The allowed reward spend transaction identifier fields are the following:

Include Page
V4:spend_reward_transaction_identifier
V4:spend_reward_transaction_identifier

Tip

For releases prior to CRM.COM R10.1.0 this information is mandatory

wallet_transaction_identifier

(semi-optional)

Wallet Transaction identifier

The identifier of the wallet transaction related with the reward spend transaction that should be returned as a result. The allowed wallet transaction identifier fields are the following:

Include Page
V4:wallet_transaction_identifier
V4:wallet_transaction_identifier

Tip

Available from CRM.COM R10.1.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

...

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 spend transactions should be returned as a results. The allowed rewards participant identifier fields are the following:

Include Page
V4:rewards_participants_identifier
V4:rewards_participants_identifier

accounts_receivable_identifier

(semi-optional)

Accounts Receivable identifier  

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

Include Page
V4:accounts_receivable_identifier
V4:accounts_receivable_identifier

wallet_identifier

(semi-optional)

Wallet identifier  

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

Include Page
V4:wallet_identifier
V4:wallet_identifier

customer_event_identifier

(semi-optional)

Customer Event identifier

The identifier of the customer event that triggered the creation of the reward spend transaction that should be returned as a result. Only Spend Request Customer Events are allowed to be specified. The allowed customer event identifier fields are the following:

Include Page
V4:customer_event_identifier
V4:customer_event_identifier

submitted_after_date

(optional)

Date

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

Tip

Available from CRM.COM R12.2.0

submitted_before_date

(optional)

Date

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

Tip

Available from CRM.COM R12.2.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

...

Expand
titleExample 2

HTTP Method: POST

 

Request:


Body:

Code Block
themeConfluence
languagejs
linenumberstrue
{
  "token":"{{token}}",
  "rewards_participant_identifier":{"number":"RP0000000049"}
}


Response:

Code Block
languagejs
{
  "data": [
    {
      "date": "2016-06-27T09:50:23",
      "number": "33",
      "amount": 10,
      "unit": {
        "alternative_code": "adminunit",
        "group_name": "Main Group",
        "community_name": "Community",
        "name": "Admin Unit",
        "description": "admin unit",
        "id": "1"
      },
      "items_set": [
        {
          "product": {
            "code": "Bronze",
            "product_type": {
              "service_type": "TERMED",
              "used_for_provisioning": true,
              "alternative_code": "Main Packages",
              "composition_method": "FLAT",
              "name": "Main Packages",
              "description": null,
              "id": "E186E293AAAB49EE86A729540A4287FE",
              "classification": "SERVICES",
              "physical_good_type": null
            },
            "alternative_code": "B",
            "description": null,
            "id": "F50CC52934BD4F119B6E18E215A4FC55"
          },
          "total_amount": 10,
          "id": "4926E9DF1C2A4FB690EA51994452752F"
        }
      ],
      "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-06-27T09:50:35",
        "updated_date": "2016-06-27T09:50:35",
        "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"
        }
      },
      "currency_rate_period": {
        "from_date": "0EEE31A81A064D97A9873F5676D2F4D9",
        "to_date": 0.25,
        "rate": 0.25,
        "inverse_rate": 4,
        "currency": {
          "suffix_symbol": null,
          "prefix_symbol": null,
          "decimal_part_name": null,
          "code": "FJD",
          "integer_part_name": null,
          "id": "93"
        },
        "id": "0EEE31A81A064D97A9873F5676D2F4D9"
      },
      "id": "E06C24BF43BD40FCBC25E17117371421",
      "life_cycle_state": "POSTED",
      "spend_request_customer_event": {
        "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-06-27T09:50:23",
          "updated_date": "2016-06-27T09:50:35",
          "updated_by_user": {
            "person_name": "MPAdministrator",
            "id": "1",
            "username": "MPAdministrator"
          },
          "created_by_user": {
            "person_name": "MPAdministrator",
            "id": "1",
            "username": "MPAdministrator"
          }
        },
        "spend_amount": 10,
        "description": null,
        "accounts_receivable": {
          "number": "ACR0000000264",
          "name": "ACR0000000264 Alternative Currency",
          "id": "4820A781EFF243DF96DD44487EBA5C74",
          "life_cycle_state": "ACTIVE",
          "account_owner": {
            "company_profile": null,
            "company_name": null,
            "name": "Alternative Currency",
            "last_name": "Currency",
            "id": "E6E1240F3C8C48CE83159DB9AF89284B",
            "life_cycle_state": "FINANCIAL",
            "middle_name": null,
            "title": null,
            "type": "PERSON",
            "first_name": "Alternative",
            "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
            }
          }
        },
        "life_cycle_state": "POSTED",
        "type": "SPEND_REQUEST",
        "performed_on": "2016-06-27T09:50:23",
        "classification": null,
        "process_immediately": 1,
        "spend_reward_transaction": {
          "number": "33",
          "vat_amount": 0,
          "total_amount": 10,
          "id": "E06C24BF43BD40FCBC25E17117371421",
          "net_amount": 10,
          "life_cycle_state": "POSTED",
          "rewards_participant": {
            "number": "RP0000000049",
            "accounts_receivable": {
              "number": "ACR0000000264",
              "name": "ACR0000000264 Alternative Currency",
              "id": "4820A781EFF243DF96DD44487EBA5C74",
              "life_cycle_state": "ACTIVE",
              "account_owner": {
                "company_profile": null,
                "company_name": null,
                "name": "Alternative Currency",
                "last_name": "Currency",
                "id": "E6E1240F3C8C48CE83159DB9AF89284B",
                "life_cycle_state": "FINANCIAL",
                "middle_name": null,
                "title": null,
                "type": "PERSON",
                "first_name": "Alternative",
                "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": "A1A759EB9A344F8A95D20567F9362296"
          }
        },
        "number": "46",
        "id": "D4440626D1C94AAE975DBB62D0AF4EFF",
        "performed_by_unit": {
          "alternative_code": "adminunit",
          "group_name": "Main Group",
          "community_name": "Community",
          "name": "Admin Unit",
          "description": "admin unit",
          "id": "1"
        }
      },
      "wallet_transactions_set": [
        {
          "number": "464",
          "amount": 10,
          "notes": null,
          "wallet": {
            "number": "W0000000230",
            "accounts_receivable": {
              "number": "ACR0000000264",
              "name": "ACR0000000264 Alternative Currency",
              "id": "4820A781EFF243DF96DD44487EBA5C74",
              "life_cycle_state": "ACTIVE",
              "account_owner": {
                "company_profile": null,
                "company_name": null,
                "name": null,
                "last_name": "Currency",
                "id": "E6E1240F3C8C48CE83159DB9AF89284B",
                "life_cycle_state": "FINANCIAL",
                "middle_name": null,
                "title": null,
                "type": "PERSON",
                "first_name": "Alternative",
                "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": "C25BB91D35E04332849FD83B94FCF5AE",
            "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-06-27T09:50:35",
            "updated_date": "2016-06-27T09:50:35",
            "updated_by_user": {
              "person_name": "MPAdministrator",
              "id": "1",
              "username": "MPAdministrator"
            },
            "created_by_user": {
              "person_name": "MPAdministrator",
              "id": "1",
              "username": "MPAdministrator"
            }
          },
          "id": "ACE6C032A41244B18E9DAE7BEBBC3115",
          "life_cycle_state": "EFFECTIVE",
          "extra_added_amount": null,
          "type": {
            "alternative_code": "WD",
            "name": "Wallet Debit",
            "description": "Wallet Debit",
            "id": "486825E44D9452107C8EE6AAC6C57884",
            "classification": "DEBIT"
          }
        }
      ],
      "rewards_participant": {
        "number": "RP0000000049",
        "accounts_receivable": {
          "number": "ACR0000000264",
          "name": "ACR0000000264 Alternative Currency",
          "id": "4820A781EFF243DF96DD44487EBA5C74",
          "life_cycle_state": "ACTIVE",
          "account_owner": {
            "company_profile": null,
            "company_name": null,
            "name": null,
            "last_name": "Currency",
            "id": "E6E1240F3C8C48CE83159DB9AF89284B",
            "life_cycle_state": "FINANCIAL",
            "middle_name": null,
            "title": null,
            "type": "PERSON",
            "first_name": "Alternative",
            "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": "A1A759EB9A344F8A95D20567F9362296"
      }
    }
  ],
  "status": {
    "code": "OK",
    "description": "",
    "message": ""
  }
}
Expand
titleExample 23

HTTP Method: POST

 

Request:


Body:

Code Block
themeConfluence
languagejs
linenumberstrue
{
  "token":"{{token}}",
  "rewards_participant_identifier":{"number":"RP0000000304"},
  "submitted_after_date":"2016-09-14T18:00:12",
  "submitted_before_date":"2016-11-03T15:00:12",
        "fields_set": "number,date"
}


Response:

Code Block
languagejs
{
  "data": [
    {
      "date": "2016-09-15T17:54:16",
      "number": "196"
    },
    {
      "date": "2016-09-20T15:29:25",
      "number": "200"
    },
    {
      "date": "2016-09-15T17:49:28",
      "number": "194"
    },
    {
      "date": "2016-09-15T17:54:48",
      "number": "197"
    },
    {
      "date": "2016-09-15T17:51:32",
      "number": "195"
    }
  ],
  "status": {
    "code": "OK",
    "description": "",
    "message": ""
  }
}

GET reward_transactions/spend/get_allocated_awards

Tip

Available from CRM.COM R10.1.0

This method returns information related with the award reward transactions that were allocated against a specific spend reward transaction. Multiple award reward transactions are retrieved by each call.

...

Name

Type

Description

token

String

The token retrieved from the login method

reward_spend_transaction_identifier

(semi-optional)

Spend Reward Transaction Identifier

The identifier of the spend reward transaction that should be retrieved. The allowed spend reward transaction identifier fields are the following:

Include Page
V4:spend_reward_transaction_identifier
V4:spend_reward_transaction_identifier

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

...

Name

Type

Description

token

String

The token retrieved from the login method

reward_award_expiration_transaction_identifier

(semi-optional)

String

The identifier of the reward award expiration transaction that should be returned as a result. The allowed reward award expiration transaction identifier fields are the following:

Include Page
V4:award_reward_transaction_identifier
V4:award_reward_transaction_identifier

Tip

For releases prior to CRM.COM R10.1.0 this information is mandatory

wallet_transaction_identifier

(semi-optional)

Wallet Transaction identifier

The identifier of the wallet transaction related with the reward award expiration transaction that should be returned as a result. The allowed wallet transaction identifier fields are the following:

Include Page
V4:wallet_transaction_identifier
V4:wallet_transaction_identifier

Tip

Available from CRM.COM R10.1.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

...

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 expiration transactions should be returned as a results. The allowed rewards participant identifier fields are the following:

Include Page
V4:rewards_participants_identifier
V4:rewards_participants_identifier

accounts_receivable_identifier

(semi-optional)

Accounts Receivable identifier  

The identifier of the accounts receivable related with the rewards participant whose reward award expiration transactions should be returned as a result. The allowed accounts receivable identifier fields are the following:

Include Page
V4:accounts_receivable_identifier
V4:accounts_receivable_identifier

wallet_identifier

(semi-optional)

Wallet identifier  

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

Include Page
V4:wallet_identifier
V4:wallet_identifier

award_reward_transaction_identifier

(semi-optional)

Award Reward Transaction identifier

The identifier of the reward award transaction which was expired by the reward award expiration transaction that should be returned as a result. The allowed award reward transaction identifier fields are the following:

Include Page
V4:award_reward_transaction_identifier
V4:award_reward_transaction_identifier

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

...