Page Comparison

...

Tip

Available from CRM.COM R9.0.0

Deprecated from CRM.COM R17.0.0

Excerpt
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

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

...

Expand

title	Example 1

HTTP Method: POST

Request:

Body:

Code Block

language

language	js
theme	Confluence
js	linenumbers	true

 {
"token":"8868DA44EBC44E81A841911932DCF561",
"customer_event_identifier":{"number":"10"}
}

Response:

Code Block

language

language	javascript
theme	Confluence
javascript	linenumbers	true

     {
        "status":
        {
            "message": "",
            "description": "",
            "code": "OK"
        },
        "data":
        {
            "udf_float_1": null,
            "udf_float_2": null,
            "udf_float_3": null,
            "udf_float_4": null,
            "number": "10",
            "udf_string_1": null,
            "udf_string_2": null,
            "udf_string_3": null,
            "udf_string_4": null,
            "spend_reward_transaction": null,
            "udf_string_5": null,
            "udf_string_6": null,
            "udf_string_7": null,
            "udf_string_8": null,
            "accounts_receivable":
            {
                "account_owner":
                {
                    "last_name": "Rewards",
                    "middle_name": null,
                    "life_cycle_state": "FINANCIAL",
                    "company_profile": null,
                    "title": null,
                    "first_name": "Jessica",
                    "type": "PERSON",
                    "id": "79B02448A3F3A9890FCFA899A94D6D72",
                    "name": "Rewards Jessica",
                    "company_name": null,
                    "demographics":
                    {
                        "gender": "FEMALE",
                        "passport_issued_by_country": null,
                        "social_security_number": "867583",
                        "passport_number": "867583",
                        "industry_sector": null,
                        "country_of_residence":
                        {
                            "three_character_code": "USA",
                            "two_character_code": "US",
                            "id": "127",
                            "name": "UNITED STATES",
                            "alternative_code": null
                        },
                        "name_day":
                        {
                            "month": null,
                            "day": null
                        },
                        "date_of_birth":
                        {
                            "month": null,
                            "day": null,
                            "year": null
                        },
                        "id_number": "867582",
                        "industry": null,
                        "id_issued_by_country": null
                    }
                },
                "life_cycle_state": "ACTIVE",
                "number": "ACR000331",
                "id": "1F695BE767C2EC001433CA9E1C0F47BA",
                "name": "Jessica Rewards"
            },
            "id": "020A9ED52DB0DD6676358D3AEF054751",
            "classification":
            {
                "id": "602130E6B9F01FA657C5EC0891E93CD0",
                "name": "3rd Party System Initiated",
                "alternative_code": "3PSI"
            },
            "udf_date_1": null,
            "udf_date_2": null,
            "udf_date_3": null,
            "udf_date_4": null,
            "performed_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"
            },
            "process_immediately": 1,
            "log_information":
            {
                "updated_date": "2016-02-24T17:43:34",
                "created_date": "2015-01-22T11:29:58",
                "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"
                },
                "updated_by_user":
                {
                    "person_name": "Marios Lannister",
                    "username": "MPAdministrator",
                    "id": "1"
                }
            },
            "life_cycle_state": "CANCELLED",
            "purchase_customer_event":
            {
                "award_reward_transactions_set": null,
                "classification":
                {
                    "id": "602130E6B9F01FA657C5EC0891E93CD0",
                    "name": "3rd Party System Initiated",
                    "alternative_code": "3PSI"
                },
                "number": "10",
                "performed_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"
                },
                "process_immediately": 1,
                "vat_amount": 20,
                "log_information":
                {
                    "updated_date": "2015-01-15T15:41:27",
                    "created_date": "2015-01-15T15:41:27",
                    "created_by_unit":
                    {
                        "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":
                    {
                        "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"
                    },
                    "updated_by_user":
                    {
                        "person_name": "MPAdministrator",
                        "username": "MPAdministrator",
                        "id": "1"
                    }
                },
                "total_amount": 220,
                "life_cycle_state": "POSTED",
                "accounts_receivable":
                {
                    "account_owner":
                    {
                        "last_name": "Rewards",
                        "middle_name": null,
                        "life_cycle_state": "FINANCIAL",
                        "company_profile": null,
                        "title": null,
                        "first_name": "Jessica",
                        "type": "PERSON",
                        "id": "79B02448A3F3A9890FCFA899A94D6D72",
                        "name": "Rewards Jessica",
                        "company_name": null,
                        "demographics":
                        {
                            "gender": "FEMALE",
                            "passport_issued_by_country": null,
                            "social_security_number": "867583",
                            "passport_number": "867583",
                            "industry_sector": null,
                            "country_of_residence":
                            {
                                "three_character_code": "USA",
                                "two_character_code": "US",
                                "id": "127",
                                "name": "UNITED STATES",
                                "alternative_code": null
                            },
                            "name_day":
                            {
                                "month": null,
                                "day": null
                            },
                            "date_of_birth":
                            {
                                "month": null,
                                "day": null,
                                "year": null
                            },
                            "id_number": "867582",
                            "industry": null,
                            "id_issued_by_country": null
                        }
                    },
                    "life_cycle_state": "ACTIVE",
                    "number": "ACR000331",
                    "id": "1F695BE767C2EC001433CA9E1C0F47BA",
                    "name": "Jessica Rewards"
                },
                "type": "PURCHASE",
                "net_amount": 200,
                "id": "DF28CCF333183905E2AF793151D710E0",
                "description": "TEST API CREATE",
                "reference_number": "RF334",
                "performed_on": "2015-01-15T15:49:59"
            },
            "type": "SPEND_REQUEST",
            "description": "first purchase event",
            "performed_on": "2015-01-22T21:49:59"
        }
    }

...

Expand

title	Example 2

HTTP Method: POST

Request:

Body:

Code Block

language	js
theme	Confluence
language	js
linenumbers	true

{
    "token":"{{token}}",
   "customer_event_identifier":{"number":"48"}
 }

Response:

Code Block

language	javascript
theme	Confluence	language	javascript
linenumbers	true

{
  "data": {
    "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:15:35",
      "updated_date": "2016-07-05T13:17:13",
      "updated_by_user": {
        "person_name": "CRM COM",
        "id": "1",
        "username": "MPAdministrator"
      },
      "created_by_user": {
        "person_name": "MPAdministrator",
        "id": "1",
        "username": "MPAdministrator"
      }
    },
    "spend_amount": 12,
    "description": "first purchase event",
    "currency_rate_period": null,
    "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": "48",
    "udf_float_3": 30,
    "udf_float_4": 40,
    "id": "858625C259344A4A9019C9835FEB3DD2",
    "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": "CANCELLED",
    "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": "2015-03-21T08:59:47",
        "updated_date": "2016-03-21T09:00:30",
        "updated_by_user": {
          "person_name": "MPAdministrator",
          "id": "1",
          "username": "MPAdministrator"
        },
        "created_by_user": {
          "person_name": "MPAdministrator",
          "id": "1",
          "username": "MPAdministrator"
        }
      },
      "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": {
        "alternative_code": "PC",
        "name": "Purchase Classification",
        "id": "437DED6938054AD5BEC61BB6AF2B1F65"
      },
      "performed_on": "2015-03-21T08:59:47",
      "reference_number": "15",
      "process_immediately": 1,
      "number": "13",
      "vat_amount": 0,
      "award_reward_transactions_set": null,
      "total_amount": 12,
      "id": "67EFD04703264C63BCD106A3165B383F",
      "net_amount": 12,
      "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"
  },
  "status": {
    "code": "OK",
    "description": "",
    "message": ""
  }
}

...

Expand

title	Example 3

HTTP Method: POST

Request:

Body:

Code Block

language

language	js
theme	Confluence
js	linenumbers	true

{
    "token":"{{token}}",
   "customer_event_identifier":{"number":"104"}
 }

Response:

Code Block

language	javascript
theme	Confluence	language	javascript
linenumbers	true

 {
  "data": {
    "currency_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"
    },
    "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-19T09:30:09",
      "updated_date": "2016-07-19T09:34:09",
      "updated_by_user": {
        "person_name": "CRM COM",
        "id": "1",
        "email": "dev@crm.com",
        "username": "MPAdministrator"
      },
      "created_by_user": {
        "person_name": "MPAdministrator",
        "id": "1",
        "username": "MPAdministrator"
      }
    },
    "spend_amount": 3,
    "description": "first purchase event",
    "udf_date_2": null,
    "type": "SPEND_REQUEST",
    "udf_date_1": null,
    "udf_date_4": "2014-08-05T15:49:59",
    "udf_date_3": null,
    "spend_reward_transaction": null,
    "number": "104",
    "udf_float_3": null,
    "udf_float_4": null,
    "id": "72D41C952ED14D85BF2128FE6FFA09AB",
    "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": "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": "CANCELLED",
    "performed_on": "2016-07-02T08:49:59",
    "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-19T09:13:27",
        "updated_date": "2016-07-19T09:13:46",
        "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-07-19T09:13:27",
      "reference_number": "5454",
      "process_immediately": 0,
      "number": "369",
      "payment_medium_type": null,
      "payment_medium_identifier": null,
      "vat_amount": 0,
      "award_reward_transactions_set": null,
      "total_amount": 3,
      "id": "35B09C4C72404651BA80CF08C6B4ECA1",
      "net_amount": 3,
      "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
  },
  "status": {
    "code": "OK",
    "description": "",
    "message": ""
  }
}

...

Versions Compared

Old Version 2

New Version Current

Key

Resource URL

Parameters

Response Data