Versions Compared

Old Version 23

changes.mady.by.user Former user

Saved on

compared with

New Version 24

changes.mady.by.user Former user

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

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 financial achievement 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. Only financial achievement classifications are allowed to be specified. The allowed customer event classification identifier fields are the following:

Include Page
V4:customer_event_classification_identifier
V4:customer_event_classification_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

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

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

classification_identifier

(mandatory)

Customer Event Classification IdentifierThe classification of the customer event. Only financial achievement classifications are allowed to be specified. The allowed customer event classification identifier fields are the following:

Include Page
V4:customer_event_classification_identifier
V4:customer_event_classification_identifier

product_identifier

(optional)

Product Identifier

The product of the customer event. Any type of products can be specified. The allowed product identifier fields are the following:

Include Page
V4:product_identifier
V4:product_identifier

payment_medium_type_identifier

(optional)

Payment Medium Type Identifier

The payment medium type of the customer event. Only payment medium types which are allowed in the related accounts receivable can be specified. The allowed payment medium type identifier fields are the following:

Include Page
V4:payment_medium_type_identifier
V4:payment_medium_type_identifier

payment_medium_brand_identifier

(optional)

Payment Medium Brand Identifier

The payment medium brand of the customer event. Only payment medium brands which are allowed in the related accounts receivable can be specified. The allowed payment medium brand identifier fields are the following:

Include Page
V4:payment_medium_brand_identifier
V4:payment_medium_brand_identifier

payment_medium_identifier

(optional)

StringThe payment medium identifier of the customer event.

amount

(optional)

Number

The financial achievement customer event's amount

Tip

Available from CRM.COM R11.0.0

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

external_system

(optional)

String

Defines the third party system that generated the customer event

 

external_system_reference_number

(optional)

String

Defines the unique reference number of the 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

 

...

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 financial achievement 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

...

Expand
titleExample 1

HTTP Method: POST

 

Request:


Body:

Code Block
themeConfluence
languagejs
linenumberstrue
{
	"token":"{{token}}",
	"customer_event_identifier":{"id":"4E761E7C445E4BEFAEC826B88A6BDCAB79845A8FF2D3407B84BC593536BBBFBB"}
}


Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
 {
  "statusdata": {
    "messageexternal_system_reference_number": ""null,
    "descriptionlog_information": {
 "",     "codecreated_by_unit": "OK"
  },{
  "data": {     "udfalternative_float_1code": null"adminunit",
     "udf_float_2": null,   "group_name": "Main Group",
        "udfcommunity_float_3name": null"Community",
 
  "udf_float_4": null,     "numbername": "5Admin Unit",
        "payment_medium_typedescription": {"admin unit",
        "id": "0EC912D6358341B4BAE55CFA70FE0F2D1",
      "name": "Credit Card"},
      "descriptionupdated_by_unit": "Payment{
Medium Type 1: Credit Card",
      "alternative_code": "CCadminunit",
    },     "udfgroup_string_1name": "Main nullGroup",
        "udfcommunity_string_2name": null"Community",
      "udf_string_3  "name": null,"Admin Unit",
        "udf_string_4description": null,
 "admin unit",
  "udf_string_5": null,     "udf_string_6id": "1"
null,     "udf_string_7": null, },
      "udfcreated_string_8date": null,"2016-10-07T09:20:12",
      "accountsupdated_receivabledate": {"2016-10-07T09:23:24",
      "accountupdated_by_owneruser": {
        "lastperson_name": "MercerCRM COM",
        "middle_nameid": "1111111111",
        "life_cycle_stateusername": "FINANCIALMPAdministrator",
      },
   "company_profile   "created_by_user": null,{
        "titleperson_name": "MrMPAdministrator",
        "first_nameid": "Ben11 omonoia1",
        "typeusername": "PERSON",MPAdministrator"
      }
    },
    "idpayment_medium_brand": "475904FB959FE8D3DDAEB22FBFEC5FFB",{
        "namealternative_code": "Mercer Ben11 omonoiaV",
 
      "company_name": null"VISA",
 
      "demographicsdescription": {
   null,
      "genderid": "MALE02DEEA7F35B8413E9C017600653C1223",
     },
    "passport_issued_by_countrydescription": {"Testing creation of financial achievement customer event through API",
    "threeudf_characterdate_code2": "AND"null,
      "type": "FINANCIAL_ACHIEVEMENT",
     "twoudf_characterdate_code1": "AD"null,
    "udf_date_4": null,
      "id"udf_date_3": "132",
  null,
         "namenumber": "ANDORRA94",
    "udf_float_3": null,
      "alternativeudf_float_code4": null,
          }"award_reward_transactions_set": null,
    "id": "79845A8FF2D3407B84BC593536BBBFBB",
    "socialudf_securityfloat_number1": null,
    "udf_float_2": null,
    "passportudf_string_number2": null,
    "udf_string_3": null,
    "industryudf_string_sector4": null,
    "amount": 11.5,
    "country_of_residenceproduct": {
            "three_character_code": "USABronze",
 
          "two_character"alternative_code": "USB",
      "description": "Bronze",
      "id": "127F50CC52934BD4F119B6E18E215A4FC55",
    },
       "name"udf_string_5": "UNITED STATES"null,
      "udf_string_1": null,
     "alternativeaccounts_codereceivable": null{
          }"number": "ACR0000000069",
          "name_day": {"ACR0000000069     Polina Kestora",
       "monthid": 6"8C1E866074D743EE834E910A28C1E582",
            "day"life_cycle_state": 14"ACTIVE",
      "account_owner": {
  },           "datecompany_of_birthprofile": {
   null,
        "monthcompany_name": 11null,

           "dayname": "Polina 9Kestora",
            "year"last_name": 1963"Kestora",
          },
"id": "F038161F36C845B98CEE7361A8C92157",
         "idlife_cycle_numberstate": "1212125FINANCIAL",

         "industrymiddle_name": {null,
            "idtitle": "31BC2070C79EAE5455BFAD41599C5190"null,
            "nametype": "Marketing1PERSON",
   
        "codefirst_name": "MKPolina",
        "demographics": {
},
          "id_issued_by_countryname_day": {
            "three_character_codemonth": "DZA"7,
            "two_character_code": "DZ",
 "day": 21
          },
          "id_number": "130112233",

           "namegender": "ALGERIA"null,
 
          "alternativecountry_of_coderesidence": {
null           } "alternative_code": "IRN",
      }       },"three_character_code": null,
          "life_cycle_state  "name": "ACTIVEIRAN (ISLAMIC REPUBLIC OF)",
      "number": "163",
      "id": "DF7E2D0361CB10EAD23E9678D13C6649231",
          "name  "two_character_code": "Ben Mercer 2"null
          },
    "payment_medium_brand      "date_of_birth": {
        "id    "month": "A01DB55EE5624E80ADA3CD7AF166AF30",3,
            "nameyear": "AMERICAN EXPRESS"1988,
      "description": "Payment Medium Brand 2: American Express"day",: 4
     "alternative_code": "AE"     },
    "id": "4E761E7C445E4BEFAEC826B88A6BDCAB",     "award_reward_transactions_setindustry_sector": null,
    "classification": {       "idpassport_number": "13B057EB15D94D7FBB22D4AF5882211D",null,
          "nameindustry": "PK Fin. Ach. Customer Event Classification",null,
          "alternativesocial_security_codenumber": "PFACEC"null,
     },     "udfid_issued_dateby_1country": null,
    "udf_date_2": null,     "udfpassport_date_3": null,
    "udf_date_4issued_by_country": null,
    "performed_by_unit": {     }
 "community_name": "Internal Community",   }
   "id": "48305F8849E3C18B227C5BE3A27BA6DF" },
      "name"life_cycle_state": "Admin UnitCANCELLED",
 
    "groupperformed_nameon": "Main Group",
      "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
 2016-10-07T15:00:00",
    "alternative_code": "MG"
    },
    "process_immediately": 0,
    "product": null,
    "log_information": {
      "updated_date": "2016-06-28T17:03:56",
      "created_date": "2016-06-28T16:57:57",
      "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.",
 classification": {
      "alternative_code": "MGFA",
      }"name": "Financial Achievement 1",
      "updated_by_unitid": {"39031C33C1AC4FB79140B27D1614CD6A"
    },
    "communityprocess_nameimmediately": false,
"Internal Community",
     "payment_medium_type": {
      "idalternative_code": "48305F8849E3C18B227C5BE3A27BA6DFCC",

       "name": "AdminCREDIT UnitCARD",
 
      "group_namedescription": "Main Group"null,
        "descriptionid": "68FAF1F833194091967F86B1AA352129"r1
Test Description for resource },
request tab.Test Description for resource  request tab. "payment_medium_identifier": "PI000002",
        "alternative_code"udf_string_6": "MG"null,
      }"udf_string_7": null,
      "createdperformed_by_userunit": {

       "personalternative_namecode": "MPAdministratoradminunit",
 
      "usernamegroup_name": "MPAdministratorMain Group",
        "idcommunity_name": "1"
      },
      "updated_by_user": {
 Community",
       "person_name": "MariosAdmin LannisterUnit",
 
      "usernamedescription": "MPAdministratoradmin unit",
 
      "id": "1"
    },
 }     }"udf_string_8": null,
    "lifeexternal_cycle_statesystem": null
"CANCELLED",  },
  "payment_medium_identifierstatus": null,{
    "typecode": "FINANCIAL_ACHIEVEMENTOK",
    "description": null"",
    "performed_onmessage": "2016-06-28T16:57:57"
  }
}