Versions Compared

Old Version 25

changes.mady.by.user Ekaterini Tzirtzipi

Saved on

compared with

New Version 26

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 R5.0.0

Table of Contents
maxLevel2

...

Name

Type

Description

token

String

The token retrieved from the login method

customer_event_identifier

(mandatory)

Customer Event identifier  

The identifier of the customer event that should be returned as a result. Only customer events of type spend request can be specified. The allowed customer event identifier fields are the following:

Include Page
V4:customer_event_identifier
V4:customer_event_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

rewards_participant_identifier

(semi-optional)

Rewards Participant IdentifierThe identifier of the rewards participant related with the customer events that should be retrieved. 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 customer events that should be retrieved. The allowed accounts receivable identifier fields are the following:

Include Page
V4:accounts_receivable_identifier
V4:accounts_receivable_identifier

classification_identifier

(semi-optional)

Customer Event Classification Identifier

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

Include Page
V4:customer_event_classification_identifier
V4:customer_event_classification_identifier

submitted_after_date

(optional)

Date

if specified then information related with spend requests customer events that was submitted after the specified date should be retrieved

Tip

Available from CRM.COM R12.2.0

submitted_before_date

(optional)

Date

if specified then information related with spend requests customer events that was 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 3

HTTP Method: POST

 

Request:


Body:

Code Block
themeConfluence
languagejs
linenumberstrue
{
    "token":"{{token}}",
    "accounts_receivable_identifier":{"number":"ACR0000000050"}
}

 

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
 {
  "data": [
    {
      "currency_period": null,
      "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-05T13:38:48",
        "updated_date": "2016-07-05T13:38:48",
        "updated_by_user": {
          "person_name": "MPAdministrator",
          "id": "1",
          "username": "MPAdministrator"
        },
        "created_by_user": {
          "person_name": "MPAdministrator",
          "id": "1",
          "username": "MPAdministrator"
        }
      },
      "spend_amount": 88,
      "description": null,
      "udf_date_2": null,
      "type": "SPEND_REQUEST",
      "udf_date_1": null,
      "udf_date_4": null,
      "udf_date_3": null,
      "spend_reward_transaction": {
        "number": "38",
        "vat_amount": 8,
        "total_amount": 88,
        "id": "042574A4D9544035846DAD21D589DE7D",
        "net_amount": 80,
        "life_cycle_state": "POSTED",
        "rewards_participant": {
          "number": "RP0000000040",
          "accounts_receivable": {
            "number": "ACR0000000050",
            "name": "ACR0000000050 Ekaterini Tzirtzipi",
            "id": "1B61E3A9DB864363A1502829952DF3CD",
            "life_cycle_state": "ACTIVE",
            "account_owner": {
              "company_profile": null,
              "company_name": null,
              "name": "Ekaterini Tzirtzipi",
              "last_name": "Tzirtzipi",
              "id": "3236797A43C746F8AD9F4A91A4035735",
              "life_cycle_state": "FINANCIAL",
              "middle_name": null,
              "title": null,
              "type": "PERSON",
              "first_name": "Ekaterini",
              "demographics": {
                "name_day": {
                  "month": null,
                  "day": null
                },
                "id_number": "343434",
                "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": "F4DBD2BA358545D3BBFD183D4651D5F2"
        }
      },
      "number": "49",
      "udf_float_3": null,
      "udf_float_4": null,
      "id": "0E34FFC02BD44668ACEB6764D1B2697B",
      "udf_float_1": null,
      "udf_float_2": null,
      "udf_string_2": null,
      "udf_string_3": null,
      "udf_string_4": null,
      "udf_string_5": null,
      "udf_string_1": null,
      "accounts_receivable": {
        "number": "ACR0000000050",
        "name": "ACR0000000050 Ekaterini Tzirtzipi",
        "id": "1B61E3A9DB864363A1502829952DF3CD",
        "life_cycle_state": "ACTIVE",
        "account_owner": {
          "company_profile": null,
          "company_name": null,
          "name": "Ekaterini Tzirtzipi",
          "last_name": "Tzirtzipi",
          "id": "3236797A43C746F8AD9F4A91A4035735",
          "life_cycle_state": "FINANCIAL",
          "middle_name": null,
          "title": null,
          "type": "PERSON",
          "first_name": "Ekaterini",
          "demographics": {
            "name_day": {
              "month": null,
              "day": null
            },
            "id_number": "343434",
            "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",
      "performed_on": "2016-06-22T15:00:00",
      "classification": null,
      "purchase_customer_event": {
        "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-05T13:38:48",
          "updated_date": "2016-07-05T13:38:48",
          "updated_by_user": {
            "person_name": "MPAdministrator",
            "id": "1",
            "username": "MPAdministrator"
          },
          "created_by_user": {
            "person_name": "MPAdministrator",
            "id": "1",
            "username": "MPAdministrator"
          }
        },
        "payment_medium_brand": null,
        "description": null,
        "accounts_receivable": {
          "number": "ACR0000000050",
          "name": "ACR0000000050 Ekaterini Tzirtzipi",
          "id": "1B61E3A9DB864363A1502829952DF3CD",
          "life_cycle_state": "ACTIVE",
          "account_owner": {
            "company_profile": null,
            "company_name": null,
            "name": "Ekaterini Tzirtzipi",
            "last_name": "Tzirtzipi",
            "id": "3236797A43C746F8AD9F4A91A4035735",
            "life_cycle_state": "FINANCIAL",
            "middle_name": null,
            "title": null,
            "type": "PERSON",
            "first_name": "Ekaterini",
            "demographics": {
              "name_day": {
                "month": null,
                "day": null
              },
              "id_number": "343434",
              "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": "PURCHASE",
        "classification": null,
        "performed_on": "2016-06-22T15:00:00",
        "reference_number": "106",
        "process_immediately": 1,
        "number": "107",
        "payment_medium_type": null,
        "payment_medium_identifier": null,
        "vat_amount": 8,
        "award_reward_transactions_set": null,
        "total_amount": 88,
        "id": "C4C48B61176D4E9EB0BECBB5DFC031E5",
        "net_amount": 80,
        "performed_by_unit": {
          "alternative_code": "adminunit",
          "group_name": "Main Group",
          "community_name": "Community",
          "name": "Admin Unit",
          "description": "admin unit",
          "id": "1"
        }
      },
      "process_immediately": 1,
      "udf_string_6": null,
      "udf_string_7": null,
      "performed_by_unit": {
        "alternative_code": "adminunit",
        "group_name": "Main Group",
        "community_name": "Community",
        "name": "Admin Unit",
        "description": "admin unit",
        "id": "1"
      },
      "udf_string_8": null,
      "external_system": null
    },
    {
      "currency_period": null,
      "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-03-21T09:02:00",
        "updated_date": "2016-03-21T09:02:09",
        "updated_by_user": {
          "person_name": "MPAdministrator",
          "id": "1",
          "username": "MPAdministrator"
        },
        "created_by_user": {
          "person_name": "MPAdministrator",
          "id": "1",
          "username": "MPAdministrator"
        }
      },
      "spend_amount": null,
      "description": "first purchase event",
      "udf_date_2": "2014-06-05T15:49:59",
      "type": "SPEND_REQUEST",
      "udf_date_1": "2014-05-05T15:49:59",
      "udf_date_4": "2014-08-05T15:49:59",
      "udf_date_3": "2014-07-05T15:49:59",
      "spend_reward_transaction": null,
      "number": "8",
      "udf_float_3": 30,
      "udf_float_4": 40,
      "id": "E27B9CEDF9F44355A105144200EC0F57",
      "udf_float_1": 10,
      "udf_float_2": 20,
      "udf_string_2": "udf string 2",
      "udf_string_3": "udf string 3",
      "udf_string_4": "udf string 4",
      "udf_string_5": "udf string 5",
      "udf_string_1": "udf string 1",
      "accounts_receivable": {
        "number": "ACR0000000050",
        "name": "ACR0000000050 Ekaterini Tzirtzipi",
        "id": "1B61E3A9DB864363A1502829952DF3CD",
        "life_cycle_state": "ACTIVE",
        "account_owner": {
          "company_profile": null,
          "company_name": null,
          "name": "Ekaterini Tzirtzipi",
          "last_name": "Tzirtzipi",
          "id": "3236797A43C746F8AD9F4A91A4035735",
          "life_cycle_state": "FINANCIAL",
          "middle_name": null,
          "title": null,
          "type": "PERSON",
          "first_name": "Ekaterini",
          "demographics": {
            "name_day": {
              "month": null,
              "day": null
            },
            "id_number": "343434",
            "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",
      "performed_on": "2016-03-21T09:30:58",
      "classification": {
        "alternative_code": "SRC",
        "name": "Spend Request",
        "id": "7F6B89D7437E4A64AC7C4B38CBFC575E"
      },
      "purchase_customer_event": null,
      "process_immediately": 1,
      "udf_string_6": "udf string 6",
      "udf_string_7": "udf string 7",
      "performed_by_unit": {
        "alternative_code": "adminunit",
        "group_name": "Main Group",
        "community_name": "Community",
        "name": "Admin Unit",
        "description": "admin unit",
        "id": "1"
      },
      "udf_string_8": "udf string 8",
      "external_system": null
    },
    {
      "currency_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"
      },
      "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-03-21T08:46:31",
        "updated_date": "2016-03-21T08:47:02",
        "updated_by_user": {
          "person_name": "MPAdministrator",
          "id": "1",
          "username": "MPAdministrator"
        },
        "created_by_user": {
          "person_name": "MPAdministrator",
          "id": "1",
          "username": "MPAdministrator"
        }
      },
      "spend_amount": null,
      "description": "first purchase event",
      "udf_date_2": "2014-06-05T15:49:59",
      "type": "SPEND_REQUEST",
      "udf_date_1": "2014-05-05T15:49:59",
      "udf_date_4": "2014-08-05T15:49:59",
      "udf_date_3": "2014-07-05T15:49:59",
      "spend_reward_transaction": null,
      "number": "4",
      "udf_float_3": 30,
      "udf_float_4": 40,
      "id": "0788B43780024E3793E72D9A0B824E87",
      "udf_float_1": 10,
      "udf_float_2": 20,
      "udf_string_2": "udf string 2",
      "udf_string_3": "udf string 3",
      "udf_string_4": "udf string 4",
      "udf_string_5": "udf string 5",
      "udf_string_1": "udf string 1",
      "accounts_receivable": {
        "number": "ACR0000000050",
        "name": "ACR0000000050 Ekaterini Tzirtzipi",
        "id": "1B61E3A9DB864363A1502829952DF3CD",
        "life_cycle_state": "ACTIVE",
        "account_owner": {
          "company_profile": null,
          "company_name": null,
          "name": "Ekaterini Tzirtzipi",
          "last_name": "Tzirtzipi",
          "id": "3236797A43C746F8AD9F4A91A4035735",
          "life_cycle_state": "FINANCIAL",
          "middle_name": null,
          "title": null,
          "type": "PERSON",
          "first_name": "Ekaterini",
          "demographics": {
            "name_day": {
              "month": null,
              "day": null
            },
            "id_number": "343434",
            "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",
      "performed_on": "2016-03-21T09:30:58",
      "classification": {
        "alternative_code": "SRC",
        "name": "Spend Request",
        "id": "7F6B89D7437E4A64AC7C4B38CBFC575E"
      },
      "purchase_customer_event": null,
      "process_immediately": 1,
      "udf_string_6": "udf string 6",
      "udf_string_7": "udf string 7",
      "performed_by_unit": {
        "alternative_code": "adminunit",
        "group_name": "Main Group",
        "community_name": "Community",
        "name": "Admin Unit",
        "description": "admin unit",
        "id": "1"
      },
      "udf_string_8": "udf string 8",
      "external_system": null
    },
    {
      "currency_period": null,
      "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-05T13:08:14",
        "updated_date": "2016-07-05T13:08:14",
        "updated_by_user": {
          "person_name": "MPAdministrator",
          "id": "1",
          "username": "MPAdministrator"
        },
        "created_by_user": {
          "person_name": "MPAdministrator",
          "id": "1",
          "username": "MPAdministrator"
        }
      },
      "spend_amount": null,
      "description": "first purchase event",
      "udf_date_2": "2014-06-05T15:49:59",
      "type": "SPEND_REQUEST",
      "udf_date_1": "2014-05-05T15:49:59",
      "udf_date_4": "2014-08-05T15:49:59",
      "udf_date_3": "2014-07-05T15:49:59",
      "spend_reward_transaction": {
        "number": "34",
        "vat_amount": 0,
        "total_amount": 12,
        "id": "4B63EC94751D4FD1BCA8DA6DEABC1C0A",
        "net_amount": 12,
        "life_cycle_state": "POSTED",
        "rewards_participant": {
          "number": "RP0000000040",
          "accounts_receivable": {
            "number": "ACR0000000050",
            "name": "ACR0000000050 Ekaterini Tzirtzipi",
            "id": "1B61E3A9DB864363A1502829952DF3CD",
            "life_cycle_state": "ACTIVE",
            "account_owner": {
              "company_profile": null,
              "company_name": null,
              "name": "Ekaterini Tzirtzipi",
              "last_name": "Tzirtzipi",
              "id": "3236797A43C746F8AD9F4A91A4035735",
              "life_cycle_state": "FINANCIAL",
              "middle_name": null,
              "title": null,
              "type": "PERSON",
              "first_name": "Ekaterini",
              "demographics": {
                "name_day": {
                  "month": null,
                  "day": null
                },
                "id_number": "343434",
                "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": "F4DBD2BA358545D3BBFD183D4651D5F2"
        }
      },
      "number": "47",
      "udf_float_3": 30,
      "udf_float_4": 40,
      "id": "2A6AA3EB01644714993FA644C089DDB5",
      "udf_float_1": 10,
      "udf_float_2": 20,
      "udf_string_2": "udf string 2",
      "udf_string_3": "udf string 3",
      "udf_string_4": "udf string 4",
      "udf_string_5": "udf string 5",
      "udf_string_1": "udf string 1",
      "accounts_receivable": {
        "number": "ACR0000000050",
        "name": "ACR0000000050 Ekaterini Tzirtzipi",
        "id": "1B61E3A9DB864363A1502829952DF3CD",
        "life_cycle_state": "ACTIVE",
        "account_owner": {
          "company_profile": null,
          "company_name": null,
          "name": "Ekaterini Tzirtzipi",
          "last_name": "Tzirtzipi",
          "id": "3236797A43C746F8AD9F4A91A4035735",
          "life_cycle_state": "FINANCIAL",
          "middle_name": null,
          "title": null,
          "type": "PERSON",
          "first_name": "Ekaterini",
          "demographics": {
            "name_day": {
              "month": null,
              "day": null
            },
            "id_number": "343434",
            "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",
      "performed_on": "2016-07-02T08:49:59",
      "classification": {
        "alternative_code": "SRC",
        "name": "Spend Request",
        "id": "7F6B89D7437E4A64AC7C4B38CBFC575E"
      },
      "purchase_customer_event": null,
      "process_immediately": 1,
      "udf_string_6": "udf string 6",
      "udf_string_7": "udf string 7",
      "performed_by_unit": {
        "alternative_code": "adminunit",
        "group_name": "Main Group",
        "community_name": "Community",
        "name": "Admin Unit",
        "description": "admin unit",
        "id": "1"
      },
      "udf_string_8": "udf string 8",
      "external_system": null
    },
    {
      "currency_period": null,
      "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-18T08:37:03",
        "updated_date": "2016-07-18T08:37:03",
        "updated_by_user": {
          "person_name": "MPAdministrator",
          "id": "1",
          "username": "MPAdministrator"
        },
        "created_by_user": {
          "person_name": "MPAdministrator",
          "id": "1",
          "username": "MPAdministrator"
        }
      },
      "spend_amount": 88,
      "description": "first purchase event",
      "udf_date_2": "2014-06-05T15:49:59",
      "type": "SPEND_REQUEST",
      "udf_date_1": "2014-05-05T15:49:59",
      "udf_date_4": "2014-08-05T15:49:59",
      "udf_date_3": "2014-07-05T15:49:59",
      "spend_reward_transaction": {
        "number": "73",
        "vat_amount": 8,
        "total_amount": 88,
        "id": "EF642C642DF2498586502A7B19588C44",
        "net_amount": 80,
        "life_cycle_state": "POSTED",
        "rewards_participant": {
          "number": "RP0000000040",
          "accounts_receivable": {
            "number": "ACR0000000050",
            "name": "ACR0000000050 Ekaterini Tzirtzipi",
            "id": "1B61E3A9DB864363A1502829952DF3CD",
            "life_cycle_state": "ACTIVE",
            "account_owner": {
              "company_profile": null,
              "company_name": null,
              "name": "Ekaterini Tzirtzipi",
              "last_name": "Tzirtzipi",
              "id": "3236797A43C746F8AD9F4A91A4035735",
              "life_cycle_state": "FINANCIAL",
              "middle_name": null,
              "title": null,
              "type": "PERSON",
              "first_name": "Ekaterini",
              "demographics": {
                "name_day": {
                  "month": null,
                  "day": null
                },
                "id_number": "343434",
                "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": "F4DBD2BA358545D3BBFD183D4651D5F2"
        }
      },
      "number": "92",
      "udf_float_3": 30,
      "udf_float_4": 40,
      "id": "D8177679AB5C478BBB5B892BFD61235F",
      "udf_float_1": 10,
      "udf_float_2": 20,
      "udf_string_2": "udf string 2",
      "udf_string_3": "udf string 3",
      "udf_string_4": "udf string 4",
      "udf_string_5": "udf string 5",
      "udf_string_1": "udf string 1",
      "accounts_receivable": {
        "number": "ACR0000000050",
        "name": "ACR0000000050 Ekaterini Tzirtzipi",
        "id": "1B61E3A9DB864363A1502829952DF3CD",
        "life_cycle_state": "ACTIVE",
        "account_owner": {
          "company_profile": null,
          "company_name": null,
          "name": "Ekaterini Tzirtzipi",
          "last_name": "Tzirtzipi",
          "id": "3236797A43C746F8AD9F4A91A4035735",
          "life_cycle_state": "FINANCIAL",
          "middle_name": null,
          "title": null,
          "type": "PERSON",
          "first_name": "Ekaterini",
          "demographics": {
            "name_day": {
              "month": null,
              "day": null
            },
            "id_number": "343434",
            "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",
      "performed_on": "2016-07-02T08:49:59",
      "classification": {
        "alternative_code": "SRC",
        "name": "Spend Request",
        "id": "7F6B89D7437E4A64AC7C4B38CBFC575E"
      },
      "purchase_customer_event": {
        "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-05T13:38:48",
          "updated_date": "2016-07-05T13:38:48",
          "updated_by_user": {
            "person_name": "MPAdministrator",
            "id": "1",
            "username": "MPAdministrator"
          },
          "created_by_user": {
            "person_name": "MPAdministrator",
            "id": "1",
            "username": "MPAdministrator"
          }
        },
        "payment_medium_brand": null,
        "description": null,
        "accounts_receivable": {
          "number": "ACR0000000050",
          "name": "ACR0000000050 Ekaterini Tzirtzipi",
          "id": "1B61E3A9DB864363A1502829952DF3CD",
          "life_cycle_state": "ACTIVE",
          "account_owner": {
            "company_profile": null,
            "company_name": null,
            "name": "Ekaterini Tzirtzipi",
            "last_name": "Tzirtzipi",
            "id": "3236797A43C746F8AD9F4A91A4035735",
            "life_cycle_state": "FINANCIAL",
            "middle_name": null,
            "title": null,
            "type": "PERSON",
            "first_name": "Ekaterini",
            "demographics": {
              "name_day": {
                "month": null,
                "day": null
              },
              "id_number": "343434",
              "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": "PURCHASE",
        "classification": null,
        "performed_on": "2016-06-22T15:00:00",
        "reference_number": "106",
        "process_immediately": 1,
        "number": "107",
        "payment_medium_type": null,
        "payment_medium_identifier": null,
        "vat_amount": 8,
        "award_reward_transactions_set": null,
        "total_amount": 88,
        "id": "C4C48B61176D4E9EB0BECBB5DFC031E5",
        "net_amount": 80,
        "performed_by_unit": {
          "alternative_code": "adminunit",
          "group_name": "Main Group",
          "community_name": "Community",
          "name": "Admin Unit",
          "description": "admin unit",
          "id": "1"
        }
      },
      "process_immediately": 1,
      "udf_string_6": "udf string 6",
      "udf_string_7": "udf string 7",
      "performed_by_unit": {
        "alternative_code": "adminunit",
        "group_name": "Main Group",
        "community_name": "Community",
        "name": "Admin Unit",
        "description": "admin unit",
        "id": "1"
      },
      "udf_string_8": "udf string 8",
      "external_system": null
    }
  ],
  "status": {
    "code": "OK",
    "description": "",
    "message": ""
  }
}
Expand
titleExample 24

HTTP Method: POST

 

Request:


Body:

Code Block
themeConfluence
languagejs
linenumberstrue
{
    "token":"{{token}}",
    "accounts_receivable_identifier":{"number":"ACR0000000391"},
              "fields_set": "number,performed_on",
  "submitted_before_date":"2016-11-03T15:00:12"
}

 

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
  "data": [
    {
      "number": "86",
      "performed_on": "2016-07-21T11:20:59"
    },
    {
      "number": "87",
      "performed_on": "2016-07-21T11:20:59"
    },
    {
      "number": "108",
      "performed_on": "2016-07-22T10:50:12"
    },
    {
      "number": "109",
      "performed_on": "2016-07-22T09:21:59"
    }
  ],
  "status": {
    "code": "OK",
    "description": "",
    "message": ""
  }
}

...

Name

Type

Description

token

String

The token retrieved from the login method

accounts_receivable_identifier

(semi-optional)

Accounts receivable Identifier

The related accounts receivable. The allowed accounts receivable identifier fields are the following:

Include Page
V4:accounts_receivable_identifier
V4:accounts_receivable_identifier

Tip

Available from CRM.COM R8.0.0

rewards_participant_identifier

(semi-optional)

Rewards Participant IdentifierThe related rewards participant. The allowed rewards participant identifier fields are the following:

Include Page
V4:rewards_participants_identifier
V4:rewards_participants_identifier

Tip

Available from CRM.COM R8.0.0

classification_identifier

(optional)

Customer Event Classification IdentifierThe classification of the customer event. The allowed customer event classification identifier fields are the following:

Include Page
V4:customer_event_classification_identifier
V4:customer_event_classification_identifier

performed_by_unit_identifier

(mandatory)

Unit IdentifierThe unit that initiated the customer event. The allowed unit identifier fields are the following:

Include Page
V4:unit_identifier
V4:unit_identifier

performed_on

(mandatory)

DateThe date that the customer event was actually performed

description

(optional)

StringA description of the customer event

process_immediately

(optional)

booleanDefines if the customer event was processed immediately by various business processes or not

purchase_customer_request_identifier

(mandatory)

Customer Event identifier  

The purchase customer event which is requested to be settled by the specified spend request. Only customer events of type purchase can be specified. The allowed customer event identifier fields are the following:

Include Page
V4:customer_event_identifier
V4:customer_event_identifier

Tip

Starting from CRM.COM R8.0.0 the purchase customer event should belong to the account specified through the accounts_receivable_identifier or to the account related with the rewards participant specified through the rewards_participnat_identifier

spend_amount

(optional)

Float

The amount to be spend by the specified spend request. This is applicable depending on the classification of the spend request and only if it is allowed by a spend request customer event rule, as defined through the active customer event definition

Tip

Available from CRM.COM R9.0.0

intended_currency_identifier

(optional)

Currency Identifier

The currency that the user was intended to use for the customer event. If specified then it is validated against the currency of the related performed by unit (i.e. the default currency) and if they don't match then an error is throw. Note that the intended currency is not saved within CRM.COM; it is just used for validation purposes. The allowed currency identifier fields are the following:

Include Page
V4:currency_identifier
V4:currency_identifier

Tip

Available from CRM.COM R11.0.0

external_system

(optional)

String

Defines the third party system that generates the spend request customer event

Tip

Available from CRM.COM R10.0.0

external_system_reference_number

(optional)

String

Defines the unique reference number of the spend request customer event in the external system

Tip

Available from CRM.COM R10.1.0

udf_string_1

(optional)

String

User Defined Field of type String

udf_string_2

(optional)

String

User Defined Field of type String

udf_string_3

(optional)

String

User Defined Field of type String

udf_string_4

(optional)

String

User Defined Field of type String

udf_string_5

(optional)

String

User Defined Field of type String

udf_string_6

(optional)

String

User Defined Field of type String

udf_string_7

(optional)

String

User Defined Field of type String

udf_string_8

(optional)

String

User Defined Field of type String

udf_float_1

(optional)

Float

User Defined Field of type Float

udf_float_2

(optional)

Float

User Defined Field of type Float

udf_float_3

(optional)

Float

User Defined Field of type Float

udf_float_4

(optional)

Float

User Defined Field of type Float

udf_date_1

(optional)

Date

User Defined Field of type Date

udf_date_2

(optional)

Date

User Defined Field of type Date

udf_date_3

(optional)

Date

User Defined Field of type Date

udf_date_4

(optional)

Date

User Defined Field of type Date

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

Tip

Available from CRM.COM R10.0.0

 

Restrictions

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

...

This method is used in order to cancel a posted spend request customer event. This method can be applied only on posted spend request customer events.  A single spend request customer event can be cancelled by each call

Tip

Available from CRM.COM R9.0.0

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

customer_event_identifier

(mandatory)

Customer Event identifier  

The identifier of the customer event that should be cancelled. Only customer events of type spend request which are posted can be specified. The allowed customer event identifier fields are the following:

Include Page
V4:customer_event_identifier
V4:customer_event_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

Tip

Available from CRM.COM R10.0.0

Response Data

Include Page
V4:spend_request_customer_event_complete
V4:spend_request_customer_event_complete

...