Page Comparison

...

Tip
Deprecated from CRM.COM R17.0.0

Excerpt
This method returns information related with a spend request customer event. A single spend request customer event is returned by each call

...

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

...

Include Page

	V4:spend_request_customer_event_complete
	V4:spend_request_customer_event_complete

Examples

Expand

title	Example 1

HTTP Method: GET

Request:

Response:

Code Block

language	javascript
theme	Confluence	language	javascript
linenumbers	true

 
      {
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    {
        "purchase_customer_event":
        {
            "number": "4",
            "performed_by_unit":
            {
                "community_name": "Main Community",
                "group_name": "Developers Group",
                "name": "Developers Unit",
                "id": "C4370788B2630BC8A99E8C7397406C09",
                "description": null,
                "alternative_code": null
            },
            "vat_amount": 10,
            "process_immediately": 1,
            "log_information":
            {
                "updated_date": "2014-11-13T18:12:09",
                "created_by_unit":
                {
                    "group_name": null,
                    "name": "Admin Unit",
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "description": "r1",
                    "alternative_code": "MG"
                },
                "created_date": "2014-10-09T11:55:44",
                "updated_by_unit":
                {
                    "group_name": null,
                    "name": "Admin Unit",
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "description": "r1",
                    "alternative_code": "MG"
                },
                "created_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1",
                    "email": null
                },
                "updated_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1",
                    "email": null
                }
            },
            "total_amount": 110,
            "accounts_receivable":
            {
                "account_owner":
                {
                    "last_name": "Marios",
                    "life_cycle_state": "FINANCIAL",
                    "middle_name": null,
                    "company_profile": null,
                    "title": null,
                    "type": "PERSON",
                    "first_name": "Ioannou",
                    "name": "Ioannou Marios",
                    "id": "B8C601694611DE7ECC29B232AB38D80A",
                    "company_name": null,
                    "demographics":
                    {
                        "gender": "MALE",
                        "passport_issued_by_country": null,
                        "passport_number": null,
                        "social_security_number": null,
                        "country_of_residence": null,
                        "industry_sector": null,
                        "date_of_birth":
                        {
                            "month": null,
                            "day": null,
                            "year": null
                        },
                        "name_day":
                        {
                            "month": null,
                            "day": null
                        },
                        "id_number": null,
                        "id_issued_by_country": null,
                        "industry": null
                    }
                },
                "life_cycle_state": "ACTIVE",
                "number": "000001",
                "name": "Photos Panayi",
                "id": "23E6B215D4ED39080314212774711C95"
            },
            "life_cycle_state": "POSTED",
            "net_amount": 100,
            "type": "PURCHASE",
            "id": "76C1B6CACE378DC1425687E63845DEA3",
            "description": null,
            "reference_number": "3",
            "performed_on": "2014-10-12T11:56:08"
        },
        "number": "1",
        "id": "9E086B77A29B3F2CD51DF071DA8B953B"
    }
}

...

Expand

title	Example 2

HTTP Method: GET

Request:

Response:

Code Block

language	javascript
theme	Confluence
language	javascript
linenumbers	true

 {
  "status": {
    "message": "",
    "description": "",
    "code": "OK"
  },
  "data": {
    "instant_spend": 0,
    "purchase_customer_event": {
      "award_reward_transactions_set": null,
      "classification": {
        "id": "437DED6938054AD5BEC61BB6AF2B1F65",
        "name": "Purchase Classification",
        "alternative_code": "PC"
      },
      "number": "29",
      "payment_medium_type": null,
      "performed_by_unit": {
        "community_name": "Community",
        "id": "1",
        "name": "Admin Unit",
        "group_name": "Main Group",
        "description": "admin unit",
        "alternative_code": "adminunit"
      },
      "process_immediately": 1,
      "vat_amount": 25,
      "instant_spend_request": null,
      "log_information": {
        "updated_date": "2016-03-24T13:41:57",
        "created_date": "2016-03-24T13:41:57",
        "created_by_unit": {
          "community_name": "Community",
          "id": "1",
          "name": "Admin Unit",
          "group_name": "Main Group",
          "description": "admin unit",
          "alternative_code": "adminunit"
        },
        "updated_by_unit": {
          "community_name": "Community",
          "id": "1",
          "name": "Admin Unit",
          "group_name": "Main Group",
          "description": "admin unit",
          "alternative_code": "adminunit"
        },
        "created_by_user": {
          "person_name": "p_kestora",
          "username": "p_kestora",
          "id": "3BF7083426A7443CA7960041E5846F1E"
        },
        "updated_by_user": {
          "person_name": "p_kestora",
          "username": "p_kestora",
          "id": "3BF7083426A7443CA7960041E5846F1E"
        }
      },
      "total_amount": 235,
      "accounts_receivable": {
        "account_owner": {
          "last_name": "Kestora",
          "middle_name": null,
          "life_cycle_state": "FINANCIAL",
          "company_profile": null,
          "title": null,
          "first_name": "Polina",
          "type": "PERSON",
          "id": "F038161F36C845B98CEE7361A8C92157",
          "name": "Polina Kestora",
          "company_name": null,
          "demographics": {
            "gender": "FEMALE",
            "passport_issued_by_country": null,
            "social_security_number": null,
            "passport_number": null,
            "industry_sector": null,
            "country_of_residence": {
              "three_character_code": null,
              "two_character_code": null,
              "id": "231",
              "name": "IRAN (ISLAMIC REPUBLIC OF)",
              "alternative_code": "IRN"
            },
            "name_day": {
              "month": null,
              "day": null
            },
            "date_of_birth": {
              "month": 3,
              "day": 4,
              "year": 1988
            },
            "id_number": "112233",
            "industry": null,
            "id_issued_by_country": null
          }
        },
        "life_cycle_state": "ACTIVE",
        "number": "ACR0000000069",
        "id": "8C1E866074D743EE834E910A28C1E582",
        "name": "ACR0000000069 Polina Kestora"
      },
      "life_cycle_state": "POSTED",
      "payment_medium_brand": null,
      "net_amount": 210,
      "payment_medium_identifier": null,
      "type": "PURCHASE",
      "id": "F84B2BFB3DB341DB9D7D5DE60399BBC5",
      "description": "Testing creation of purchase event",
      "reference_number": "RF001",
      "performed_on": "2016-03-24T15:00:00"
    },
    "number": "15",
    "id": "62CB7B63C3B7428AA2D7BC421CF3D56E"
  }
}

...

Expand

title	Example 3

HTTP Method: GET

Request:

Response:

Code Block

language	javascript
theme	Confluence	language	javascript
linenumbers	true

{
  "data": {
    "external_system_reference_number": 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-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"
      }
    },
    "spend_amount": 1,
    "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": "140",
      "vat_amount": 0,
      "total_amount": 0.84,
      "id": "86C91E68B6AD472388C80E2875CC0135",
      "net_amount": 0.84,
      "life_cycle_state": "POSTED",
      "rewards_participant": {
        "number": "RP0000000177",
        "accounts_receivable": {
          "number": "ACR0000000505",
          "name": "ACR0000000505 Harrison  James",
          "id": "268861F901364A1CA23F74F644547DD9",
          "life_cycle_state": "ACTIVE",
          "account_owner": {
            "company_profile": null,
            "company_name": null,
            "name": "Harrison  James",
            "last_name": "James",
            "id": "BD701A7A56AB4A079578E6BF66B265BD",
            "life_cycle_state": "FINANCIAL",
            "middle_name": null,
            "title": null,
            "type": "PERSON",
            "first_name": "Harrison ",
            "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": "FD25D1C0917F4A7493366DCAEA81E46E"
      }
    },
    "number": "157",
    "udf_float_3": null,
    "udf_float_4": null,
    "currency": {
      "suffix_symbol": "N/A",
      "prefix_symbol": "£",
      "decimal_part_name": "pence",
      "code": "GBP",
      "integer_part_name": "pound",
      "id": "9"
    },
    "id": "0359BDC6ED8246C59E410464785BD559",
    "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": "ACR0000000505",
      "name": "ACR0000000505 Harrison  James",
      "id": "268861F901364A1CA23F74F644547DD9",
      "life_cycle_state": "ACTIVE",
      "account_owner": {
        "company_profile": null,
        "company_name": null,
        "name": "Harrison  James",
        "last_name": "James",
        "id": "BD701A7A56AB4A079578E6BF66B265BD",
        "life_cycle_state": "FINANCIAL",
        "middle_name": null,
        "title": null,
        "type": "PERSON",
        "first_name": "Harrison ",
        "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",
    "performed_on": "2016-07-29T13:25:04",
    "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-29T13:25:04",
        "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"
        }
      },
      "payment_medium_brand": null,
      "description": null,
      "accounts_receivable": {
        "number": "ACR0000000505",
        "name": "ACR0000000505 Harrison  James",
        "id": "268861F901364A1CA23F74F644547DD9",
        "life_cycle_state": "ACTIVE",
        "account_owner": {
          "company_profile": null,
          "company_name": null,
          "name": "Harrison  James",
          "last_name": "James",
          "id": "BD701A7A56AB4A079578E6BF66B265BD",
          "life_cycle_state": "FINANCIAL",
          "middle_name": null,
          "title": null,
          "type": "PERSON",
          "first_name": "Harrison ",
          "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": "PURCHASE",
      "classification": null,
      "performed_on": "2016-07-29T13:25:04",
      "reference_number": "3123123123",
      "process_immediately": true,
      "number": "625",
      "payment_medium_type": null,
      "payment_medium_identifier": null,
      "vat_amount": 0,
      "award_reward_transactions_set": null,
      "total_amount": 10,
      "instant_spend_request": {
        "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-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"
          }
        },
        "spend_amount": 1,
        "description": null,
        "accounts_receivable": {
          "number": "ACR0000000505",
          "name": "ACR0000000505 Harrison  James",
          "id": "268861F901364A1CA23F74F644547DD9",
          "life_cycle_state": "ACTIVE",
          "account_owner": {
            "company_profile": null,
            "company_name": null,
            "name": null,
            "last_name": "James",
            "id": "BD701A7A56AB4A079578E6BF66B265BD",
            "life_cycle_state": "FINANCIAL",
            "middle_name": null,
            "title": null,
            "type": "PERSON",
            "first_name": "Harrison ",
            "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
            }
          }
        },
        "life_cycle_state": "POSTED",
        "type": "SPEND_REQUEST",
        "performed_on": "2016-07-29T13:25:04",
        "classification": null,
        "process_immediately": true,
        "spend_reward_transaction": {
          "number": "140",
          "vat_amount": 0,
          "total_amount": 0.84,
          "id": "86C91E68B6AD472388C80E2875CC0135",
          "net_amount": 0.84,
          "life_cycle_state": "POSTED",
          "rewards_participant": {
            "number": "RP0000000177",
            "accounts_receivable": {
              "number": "ACR0000000505",
              "name": "ACR0000000505 Harrison  James",
              "id": "268861F901364A1CA23F74F644547DD9",
              "life_cycle_state": "ACTIVE",
              "account_owner": {
                "company_profile": null,
                "company_name": null,
                "name": "Harrison  James",
                "last_name": "James",
                "id": "BD701A7A56AB4A079578E6BF66B265BD",
                "life_cycle_state": "FINANCIAL",
                "middle_name": null,
                "title": null,
                "type": "PERSON",
                "first_name": "Harrison ",
                "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": "FD25D1C0917F4A7493366DCAEA81E46E"
          }
        },
        "number": "157",
        "currency": {
          "suffix_symbol": "N/A",
          "prefix_symbol": "£",
          "decimal_part_name": "pence",
          "code": "GBP",
          "integer_part_name": "pound",
          "id": "9"
        },
        "id": "0359BDC6ED8246C59E410464785BD559",
        "performed_by_unit": {
          "alternative_code": "adminunit",
          "name": "Admin Unit",
          "description": "admin unit",
          "id": "1"
        }
      },
      "currency": {
        "suffix_symbol": "N/A",
        "prefix_symbol": "£",
        "decimal_part_name": "pence",
        "code": "GBP",
        "integer_part_name": "pound",
        "id": "9"
      },
      "id": "A1322219555F4B138B8474675BB30B50",
      "net_amount": 10,
      "performed_by_unit": {
        "alternative_code": "adminunit",
        "group_name": "Main Group",
        "community_name": "Community",
        "name": "Admin Unit",
        "description": "admin unit",
        "id": "1"
      }
    },
    "process_immediately": true,
    "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"
    },
    "instant_spend": true,
    "udf_string_8": null,
    "external_system": null
  },
  "status": {
    "code": "OK",
    "description": "",
    "message": ""
  }
}

...

Versions Compared

Old Version 2

New Version Current

Key

Examples