Versions Compared

Key

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

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

Available from CRM.COM R10.0.0

Table of Contents
maxLevel2

GET customer_events/financial_achievements/show

This method returns information related with a financial achievement customer event.  A single financial achievement customer event is returned by each call

Resource URL

Parameters

...

Name

...

Type

...

Description

...

token

...

String

...

The token retrieved from the login method

...

(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:

...

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

Restrictions

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

Response Data

...

Examples

...

titleExample 1

HTTP Method: GET

 

Request:

Response:

...

themeConfluence
languagejavascript
linenumberstrue

...


Tip

Available from CRM.COM R10.0.0

Deprecated from CRM.COM R15.0.0 onwards. This functionality will be provided through achievement customer events

Table of Contents
maxLevel2

GET customer_events/financial_achievements/show

This method returns information related with a financial achievement customer event.  A single financial achievement customer event is returned 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 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

Restrictions

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

Response Data

Include Page
V4:financial_achievement_customer_event_complete
V4:financial_achievement_customer_event_complete

Examples

Expand
titleExample 1

HTTP Method: GET


Request:

Response:

Code Block
languagejavascript
themeConfluence
linenumberstrue
 {
  "data": {
    "external_system_reference_number": null,
    "log_information": {
        "personcreated_by_nameunit": "MPAdministrator",{
        "idalternative_code": "1adminunit",
        "usernamegroup_name": "MPAdministratorMain Group",
      },       "createdcommunity_by_username": {"Community",
        "person_name": "MPAdministratorAdmin Unit",
        "iddescription": "1admin unit",
        "usernameid": "MPAdministrator1"
      },
    },     "paymentupdated_mediumby_brandunit": null,{
    "description": null,     "udfalternative_date_2code": null,"adminunit",
        "typegroup_name": "FINANCIAL_ACHIEVEMENTMain Group",
        "udfcommunity_date_1name": null,"Community",
        "udf_date_4name": null"Admin Unit",
    "udf_date_3": null,     "numberdescription": "92admin unit",
        "udf_float_3id": null,"1"
     "udf_float_4": null, },
      "award_reward_transactions_setcreated_date": null"2016-10-07T08:59:11",
      "idupdated_date": "328B8B0AF30041169B889F4A39D774B72016-10-07T08:59:26",
      "udfupdated_floatby_1user": null,
 {
  "udf_float_2": null,     "udfperson_string_2name": null"MPAdministrator",
    "udf_string_3": null,      "udf_string_4"id": null"1",
    "amount": 10,
    "productusername": null,     "udf_string_5": null,"MPAdministrator"
     "udf_string_1": null, },
      "accountscreated_by_receivableuser": {
      "number": "ACR0000000069",
      "person_name": "ACR0000000069MPAdministrator",
Polina Kestora",       "id": "8C1E866074D743EE834E910A28C1E5821",
      "life_cycle_state  "username": "ACTIVEMPAdministrator",
      "account_owner": {}
    },
    "companypayment_medium_profilebrand": null,
    "description": null,
    "companyudf_date_name2": null,
        "name": "Polina Kestora",
   "type": "FINANCIAL_ACHIEVEMENT",
    "udf_date_1": null,
    "lastudf_date_name4": "Kestora"null,
    "udf_date_3": null,
    "idnumber": "F038161F36C845B98CEE7361A8C9215792",
        "lifeudf_cyclefloat_state3": "FINANCIAL",
   null,
    "middleudf_float_name4": null,
        "title"award_reward_transactions_set": null,
 
      "typeid": "PERSON328B8B0AF30041169B889F4A39D774B7",
        "first_name"udf_float_1": "Polina"null,
        "demographics"udf_float_2": {null,
    "udf_string_2": null,
    "nameudf_string_day3": {null,
    "udf_string_4": null,
      "monthamount": 710,
    "product": null,
      "day"udf_string_5": 21null,
    "udf_string_1": null,
    },
"accounts_receivable": {
         "id_number": "112233ACR0000000069",
      "name": "ACR0000000069 Polina Kestora",
      "genderid": null"8C1E866074D743EE834E910A28C1E582",
      "life_cycle_state": "ACTIVE",
      "countryaccount_of_residenceowner": {

           "alternativecompany_codeprofile": "IRN",
   null,
        "threecompany_character_codename": null,
            "name": "IRAN (ISLAMIC REPUBLIC OF)Polina Kestora",
        "last_name": "Kestora",
        "id": "231F038161F36C845B98CEE7361A8C92157",
        "life_cycle_state": "FINANCIAL",
        "twomiddle_character_codename": null,
        "title": null,
   },     "type": "PERSON",
        "datefirst_of_birthname": "Polina",
  {      "demographics": {
       "month   "name_day": 3,{
            "yearmonth": 19887,
            "day": 421
          },
          "industryid_sectornumber": null"112233",
          "passport_numbergender": null,
          "industrycountry_of_residence": {
null,            "socialalternative_security_numbercode": null"IRN",
            "idthree_issuedcharacter_by_countrycode": null,
            "passport_issued_by_countryname": null"IRAN (ISLAMIC REPUBLIC OF)",
         }   "id": "231",
  }     },     "lifetwo_cyclecharacter_statecode": "POSTED",null
          },
          "performeddate_of_onbirth": "2016-10-07T08:59:11",{
    "classification": {       "alternative_codemonth": "FA"3,
            "nameyear": "Financial Achievement 1", 1988,
            "idday": "39031C33C1AC4FB79140B27D1614CD6A"4
    },     "process_immediately": false },
    "payment_medium_type": null,     "paymentindustry_medium_identifiersector": null,
    "udf_string_6": null,     "udfpassport_string_7number": null,
 
  "performed_by_unit": {       "alternative_codeindustry": "adminunit"null,
       "group_name   "social_security_number": "Main Group",null,
          "community_nameid_issued_by_country": "Community"null,
      "name    "passport_issued_by_country": "Adminnull
Unit",       "description": "admin unit", }
       "id": "1"
}
    },
    "udflife_stringcycle_8state": null"POSTED",
    "externalperformed_systemon": null
"2016-10-07T08:59:11",
 },   "statusclassification": {
      "alternative_code": "OKFA",
      "descriptionname": "Financial Achievement 1",
      "messageid": "39031C33C1AC4FB79140B27D1614CD6A"
    }
}

POST customer_events/financial_achievements/list

This method returns information related with financial achievements customer events. Multiple financial achievements customer events are returned by each call

Resource URL

Parameters

...

Name

...

Type

...

Description

...

token

...

String

...

The token retrieved from the login method

...

rewards_participant_identifier

(semi-optional)

...

(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:

...

(semi-optional)

...

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:

...

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

Restrictions

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

Response Data

...

Examples

Expand
titleExample 1

HTTP Method: POST

 

Request:

Body:

Code Block
themeConfluence
languagejs
linenumberstrue
{
"token":"{{token}}",
"accounts_receivable_identifier":{"number":"ACR0000000069"},
"classification_identifier":{"alternative_code":"FA"}
}

 

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
 {
  "data": [
    {
      "external_system_reference_number,
    "process_immediately": false,
    "payment_medium_type": null,
    "payment_medium_identifier": null,
    "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,
      "logexternal_informationsystem": {null
    },
   "created_by_unitstatus": {
 
        "alternative_code": "adminunitOK",
          "group_name"description": "Main Group",
     
    "community_namemessage": "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-21T11:24:56",
        "updated_date": "2016-07-21T11:24:56",
        "updated_by_user": {
          "person_name": "MPAdministrator",
          "id": "1",
          "username": "MPAdministrator"
        },
        "created_by_user": {
          "person_name": "MPAdministrator",
          "id": "1",
          "username": "MPAdministrator"
        }
      },
      "payment_medium_brand": {
        "alternative_code": "V",
        "name": "VISA",
        "description": null,
        "id": "02DEEA7F35B8413E9C017600653C1223"
      },
      "description": "Testing creation of financial achievement customer event through API",
      "udf_date_2}
}


POST customer_events/financial_achievements/list

This method returns information related with financial achievements customer events. Multiple financial achievements customer events are returned by each call

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

rewards_participant_identifier

(semi-optional)

Rewards Participant Identifier
The identifier of the rewards participant related with the customer events that should be retrieved. The allowed rewards participant identifier fields are the following:

Include Page
V4:rewards_participants_identifier_post
V4:rewards_participants_identifier_post

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

submitted_after_date

(optional)

Date

if specified then information related with financial achievements 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 financial achievements customer events that was submitted before the specified date should be retrieved

Tip

Available from CRM.COM R12.2.0


number_of_results

(optional)

Number

The number of results that can be retrieved through each call

Tip

Available from CRM.COM R13.0.0


offset

(optional)

Number

Defines the number of entities that should be skipped from the results. If it is set to 0 then none results should be skipped, otherwise the results will begin from the provided offset number

Tip

Available from CRM.COM R13.0.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

Restrictions

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

Response Data

Include Page
V4:financial_achievement_customer_event_complete
V4:financial_achievement_customer_event_complete

Examples

Expand
titleExample 1

HTTP Method: POST


Request:


Body:

Code Block
languagejs
themeConfluence
linenumberstrue
{
"token":"{{token}}",
"accounts_receivable_identifier":{"number":"ACR0000000069"},
"classification_identifier":{"alternative_code":"FA"}
}


Response:

Code Block
languagejavascript
themeConfluence
linenumberstrue
 {
  "data": [
    {
      "external_system_reference_number": null,
      "typelog_information": "FINANCIAL_ACHIEVEMENT", {
        "udfcreated_dateby_1unit": null,{
          "udfalternative_date_4code": null,"adminunit",
          "udfgroup_date_3name": null"Main Group",
      "number    "community_name": "57Community",
      "udf_float_3": null,   "name": "Admin Unit",
 "udf_float_4": null,         "award_reward_transactions_setdescription": null,"admin unit",
          "id": "B8A73C74B2E7417F8B7159CF2BB036F31",
       "udf_float_1": null },
        "udfupdated_floatby_2unit": null,{
          "udfalternative_string_2code": null"adminunit",
          "udfgroup_string_3name": null"Main Group",
          "udfcommunity_string_4name": null"Community",
          "amountname": null"Admin Unit",
          "productdescription": "admin nullunit",
      "udf_string_5": null,    "id":   "udf_string_1":
null,       "accounts_receivable": { },
        "numbercreated_date": "ACR00000000692016-07-21T11:24:56",
        "nameupdated_date": "ACR0000000069 Polina Kestora2016-07-21T11:24:56",
        "idupdated_by_user": "8C1E866074D743EE834E910A28C1E582",{
          "lifeperson_cycle_statename": "ACTIVEMPAdministrator",
          "account_ownerid": {"1",
          "company_profileusername": null,"MPAdministrator"
          "company_name": null},
          "name"created_by_user": "Polina Kestora",{
          "lastperson_name": "KestoraMPAdministrator",
          "id": "F038161F36C845B98CEE7361A8C921571",
          "life_cycle_stateusername": "FINANCIALMPAdministrator",
        }
   "middle_name": null,    },
      "titlepayment_medium_brand": null,{
          "typealternative_code": "PERSONV",
          "first_name": "PolinaVISA",
 
        "demographicsdescription": {
   null,
        "name_dayid": {"02DEEA7F35B8413E9C017600653C1223"
      },
       "monthdescription": 7,"Testing creation of financial achievement customer event through API",
      "dayudf_date_2": 21null,
      "type": "FINANCIAL_ACHIEVEMENT",
    },     "udf_date_1": null,
       "idudf_date_number4": "112233",
     null,
      "genderudf_date_3": null,
      "number": "57",
      "countryudf_offloat_residence3": {null,
      "udf_float_4": null,
      "alternative_codeaward_reward_transactions_set": "IRN"null,
      "id": "B8A73C74B2E7417F8B7159CF2BB036F3",
      "threeudf_characterfloat_code1": null,
      "udf_float_2": null,
      "nameudf_string_2": "IRAN (ISLAMIC REPUBLIC OF)"null,
      "udf_string_3": null,
      "idudf_string_4": "231"null,
      "amount": null,
      "two_character_codeproduct": null,
      "udf_string_5": null,
    },  "udf_string_1": null,
         "dateaccounts_of_birthreceivable": {
        "number": "ACR0000000069",
    "month": 3,   "name": "ACR0000000069 Polina Kestora",
        "yearid": 1988"8C1E866074D743EE834E910A28C1E582",
              "day"life_cycle_state": 4"ACTIVE",
          "account_owner": {
 },             "industrycompany_sectorprofile": null,
            "passportcompany_numbername": null,
 
          "industryname": null,
 "Polina Kestora",
          "sociallast_security_numbername": null"Kestora",
            "id_issued_by_country": null"F038161F36C845B98CEE7361A8C92157",
 
          "passportlife_issuedcycle_by_countrystate": null"FINANCIAL",
           }"middle_name": null,
        }  "title": null,
   },       "life_cycle_state""type": "POSTEDPERSON",
          "performedfirst_onname": "2016-06-28T15:00:00Polina",
          "classificationdemographics": {
            "alternativename_codeday": "FA",{
        "name": "Financial Achievement 1",         "id"month": "39031C33C1AC4FB79140B27D1614CD6A"7,
       },       "process_immediatelyday": false,21
      "payment_medium_type": {     },
   "alternative_code": "CC",         "nameid_number": "CREDIT CARD112233",
            "descriptiongender": null,
         "id   "country_of_residence": {
"68FAF1F833194091967F86B1AA352129"       },       "paymentalternative_medium_identifiercode": "PI000002IRN",
       "udf_string_6": null,       "udfthree_stringcharacter_7code": null,
      "performed_by_unit": {         "alternative_codename": "adminunitIRAN (ISLAMIC REPUBLIC OF)",
              "group_nameid": "Main Group231",
        "community_name": "Community",      "two_character_code": null
          "name": "Admin Unit"},
        "description    "date_of_birth": "admin unit",{
              "idmonth": "1"3,
       },       "udf_string_8year": null1988,
       "external_system": null     }, "day": 4
  {       "external_system_reference_number": null,  },
    "log_information": {         "createdindustry_by_unitsector": null,
 {           "alternativepassport_codenumber": "adminunit"null,
            "group_nameindustry": "Main Group",null,
            "communitysocial_security_namenumber": "Community"null,
            "nameid_issued_by_country": "Admin Unit",null,
            "descriptionpassport_issued_by_country": "adminnull
unit",          }
"id": "1"         },
        "updated_by_unit": {
},
         "alternative_code"life_cycle_state": "adminunitPOSTED",
   
      "groupperformed_nameon": "Main Group2016-06-28T15:00:00",
 
        "community_nameclassification": "Community",
 {
        "namealternative_code": "Admin UnitFA",
          "descriptionname": "adminFinancial Achievement unit1",
          "id": "139031C33C1AC4FB79140B27D1614CD6A"
        },
        "createdprocess_dateimmediately": "2016-10-07T08:59:11"false,
        "updatedpayment_medium_datetype": "2016-10-07T08:59:26",{
        "updatedalternative_by_usercode": {"CC",
          "person_name": "MPAdministratorCREDIT CARD",

         "iddescription": "1"null,
 
        "usernameid": "MPAdministrator68FAF1F833194091967F86B1AA352129"
        },
 
      "createdpayment_bymedium_useridentifier": {"PI000002",
      "udf_string_6": null,
      "personudf_string_name7": "MPAdministrator"null,
          "id"performed_by_unit": "1",
 {
        "usernamealternative_code": "MPAdministratoradminunit",
        }
 "group_name": "Main Group",
    },
      "paymentcommunity_medium_brandname": null"Community",
        "descriptionname": null"Admin Unit",
      "udf_date_2  "description": null,"admin unit",
        "typeid": "FINANCIAL_ACHIEVEMENT1",
      "udf_date_1": null},
      "udf_datestring_48": null,
      "udfexternal_date_3system": null
    },
    {
 "number": "92",
      "udfexternal_system_floatreference_3number": null,
      "udflog_float_4information": {
null,        "awardcreated_rewardby_transactions_setunit": null,{
          "idalternative_code": "328B8B0AF30041169B889F4A39D774B7adminunit",
          "udfgroup_float_1name": null,"Main Group",
          "udfcommunity_float_2name": null"Community",
      "udf_string_2    "name": null"Admin Unit",
      "udf_string_3    "description": null"admin unit",
       "udf_string_4   "id": null,"1"
       "amount": 10},
        "product": null,updated_by_unit": {
          "udfalternative_string_5code": null"adminunit",
          "udfgroup_string_1name": "Main nullGroup",
          "accountscommunity_receivablename": {"Community",
          "numbername": "ACR0000000069Admin Unit",
          "namedescription": "ACR0000000069admin Polina Kestoraunit",
          "id": "8C1E866074D743EE834E910A28C1E582"1"
        },
        "lifecreated_cycle_statedate": "ACTIVE2016-10-07T08:59:11",
        "accountupdated_ownerdate": {
 "2016-10-07T08:59:26",
        "companyupdated_by_profileuser": null,{
          "companyperson_name": null"MPAdministrator",
          "nameid": "Polina Kestora1",
          "last_nameusername": "KestoraMPAdministrator",
          "id": "F038161F36C845B98CEE7361A8C92157"},
          "lifecreated_cycleby_stateuser": "FINANCIAL",{
          "middleperson_name": null"MPAdministrator",
          "titleid": null"1",
          "typeusername": "PERSONMPAdministrator",
        }
 "first_name": "Polina",    },
      "demographicspayment_medium_brand": null,
{      "description": null,
      "nameudf_date_day2": {null,
      "type": "FINANCIAL_ACHIEVEMENT",
      "monthudf_date_1": 7null,
      "udf_date_4": null,
      "dayudf_date_3": 21null,
            }"number": "92",
            "id_number"udf_float_3": "112233"null,

           "gender"udf_float_4": null,
     
      "countryaward_reward_oftransactions_residenceset": {null,
      "id": "328B8B0AF30041169B889F4A39D774B7",
      "alternativeudf_float_code1": "IRN"null,
      "udf_float_2": null,
      "threeudf_characterstring_code2": null,
      "udf_string_3": null,
      "nameudf_string_4": "IRAN (ISLAMIC REPUBLIC OF)"null,
      "amount": 10,
      "idproduct": "231"null,
      "udf_string_5": null,
      "twoudf_characterstring_code1": null,
        "accounts_receivable": {
   },     "number": "ACR0000000069",
        "date_of_birthname": {"ACR0000000069      Polina Kestora",
        "monthid": 3"8C1E866074D743EE834E910A28C1E582",
        "life_cycle_state": "ACTIVE",
    "year": 1988,   "account_owner": {
          "daycompany_profile": 4null,
            }"company_name": null,
            "industry_sectorname": null"Polina Kestora",
            "passportlast_numbername": null"Kestora",

           "industryid": null"F038161F36C845B98CEE7361A8C92157",
 
          "sociallife_securitycycle_numberstate": null"FINANCIAL",
            "id_issued_by_countrymiddle_name": null,
          "title": null,
"passport_issued_by_country          "type": null"PERSON",
          "first_name": "Polina",
 }         }"demographics": {
     },       "lifename_cycle_stateday": "POSTED",{
      "performed_on": "2016-10-07T08:59:11",       "classificationmonth": { 7,
              "alternative_codeday": "FA",21
         "name": "Financial Achievement 1"},
            "id_number": "39031C33C1AC4FB79140B27D1614CD6A112233",
      },
      "process_immediatelygender": falsenull,
      "payment_medium_type": null,      "country_of_residence": {
       "payment_medium_identifier       "alternative_code": null"IRN",
      "udf_string_6": null,       "udfthree_stringcharacter_7code": null,
 
    "performed_by_unit": {         "alternative_codename": "adminunitIRAN (ISLAMIC REPUBLIC OF)",
        "group_name      "id": "Main Group231",
        "community_name      "two_character_code": "Community",null
          "name": "Admin Unit",},
            "descriptiondate_of_birth": "admin unit",{
              "idmonth": "1"3,
       },       "udf_string_8year": null1988,
      "external_system": null     },  "day": 4
 {       "external_system_reference_number": null,    },
  "log_information": {         "createdindustry_by_unitsector": null,
{            "alternativepassport_codenumber": "adminunit"null,
            "group_nameindustry": "Main Group",null,
            "communitysocial_security_namenumber": "Community"null,
          "name  "id_issued_by_country": "Admin Unit",null,
            "descriptionpassport_issued_by_country": "admin unit",null
          }
     "id": "1"  }
      },
        "updatedlife_bycycle_unitstate": {"POSTED",
          "alternativeperformed_codeon": "adminunit2016-10-07T08:59:11",
          "group_name"classification": "Main Group",
 {
        "communityalternative_namecode": "CommunityFA",
 
        "name": "AdminFinancial Achievement Unit1",
          "descriptionid": "admin unit",39031C33C1AC4FB79140B27D1614CD6A"
      },
      "idprocess_immediately": "1"false,
        }"payment_medium_type": null,
        "createdpayment_medium_dateidentifier": "2016-10-07T09:12:36",
null,
       "updatedudf_string_date6": "2016-10-07T09:12:52"null,
        "updatedudf_bystring_user7": {
   null,
      "personperformed_by_nameunit": "MPAdministrator",{
          "idalternative_code": "1adminunit",
          "usernamegroup_name": "MPAdministratorMain Group",
         }"community_name": "Community",
        "created_by_username": {"Admin Unit",
         "person_namedescription": "MPAdministratoradmin unit",
          "id": "1",
      },
      "usernameudf_string_8": "MPAdministrator"null,
      "external_system": null
 }   },
   }, {
      "paymentexternal_system_mediumreference_brandnumber": null,
      "descriptionlog_information": null,{
        "udfcreated_dateby_2unit": {
   null,       "typealternative_code": "FINANCIAL_ACHIEVEMENTadminunit",
          "udfgroup_date_1name": null"Main Group",
          "udfcommunity_date_4name": null"Community",
        "udf_date_3  "name": "Admin null,Unit",
          "numberdescription": "93admin unit",
        "udf_float_3  "id": null,"1"
       "udf_float_4": null, },
        "awardupdated_rewardby_transactions_setunit": null, {
          "idalternative_code": "2DA40D40C50145FD898F73CB33F9EAE3adminunit",
          "udfgroup_float_1name": null,"Main Group",
          "udfcommunity_float_2name": null"Community",
      "udf_string_2": null,   "name": "Admin Unit",
  "udf_string_3": null,       "udf_string_4description": null,"admin unit",
          "amountid": 11.3,"1"
       "product": null},
        "udfcreated_string_5date": null"2016-10-07T09:12:36",
        "udfupdated_string_1date": null"2016-10-07T09:12:52",
        "accountsupdated_by_receivableuser": {
          "numberperson_name": "ACR0000000069MPAdministrator",
          "nameid": "1"ACR0000000069,
Polina Kestora",         "idusername": "8C1E866074D743EE834E910A28C1E582MPAdministrator",
        "life_cycle_state": "ACTIVE"},
        "accountcreated_by_owneruser": {
          "companyperson_profilename": null,
          "company_name": null"MPAdministrator",
          "nameid": "Polina Kestora1",
          "last_nameusername": "KestoraMPAdministrator",
        }
 "id": "F038161F36C845B98CEE7361A8C92157",    },
      "lifepayment_cyclemedium_statebrand": "FINANCIAL",
   null,
      "middle_namedescription": null,
          "title"udf_date_2": null,
          "type": "PERSONFINANCIAL_ACHIEVEMENT",
          "first_name"udf_date_1": "Polina"null,

         "demographics"udf_date_4": {
     null,
      "nameudf_date_day3": {null,
      "number": "93",
      "monthudf_float_3": 7null,
      "udf_float_4": null,
      "dayaward_reward_transactions_set": 21null,
      "id": "2DA40D40C50145FD898F73CB33F9EAE3",
    },  "udf_float_1": null,
         "id_number"udf_float_2": "112233"null,
      "udf_string_2": null,
    "gender  "udf_string_3": null,
            "country_of_residence"udf_string_4": {null,
      "amount": 11.3,
      "alternative_codeproduct": "IRN"null,
      "udf_string_5": null,
      "threeudf_characterstring_code1": null,
      "accounts_receivable": {
        "namenumber": "IRANACR0000000069",
(ISLAMIC REPUBLIC OF)",      "name": "ACR0000000069 Polina Kestora",
        "id": "2318C1E866074D743EE834E910A28C1E582",
        "life_cycle_state": "ACTIVE",
        "twoaccount_character_codeowner": null{
            }"company_profile": null,
            "datecompany_of_birthname": {null,
              "monthname": 3"Polina Kestora",
              "year"last_name": 1988"Kestora",
              "dayid": 4"F038161F36C845B98CEE7361A8C92157",
            },
 "life_cycle_state": "FINANCIAL",
          "industrymiddle_sectorname": null,
            "passport_numbertitle": null,

           "industrytype": null"PERSON",

           "socialfirst_security_numbername": null"Polina",
            "id_issued_by_country"demographics": null,{
            "passport_issued_by_countryname_day": null{
          }    "month": 7,
   }       },       "life_cycle_stateday": "POSTED",21
       "performed_on": "2016-10-07T09:12:36",    },
  "classification": {         "alternativeid_codenumber": "FA112233",
            "namegender": "Financial Achievement 1",null,
            "idcountry_of_residence": {
"39031C33C1AC4FB79140B27D1614CD6A"       },       "processalternative_immediatelycode": false"IRN",
      "payment_medium_type": null,       "paymentthree_mediumcharacter_identifiercode": null,
      "udf_string_6": null,       "udf_string_7name": null,"IRAN (ISLAMIC REPUBLIC OF)",
    "performed_by_unit": {         "alternative_codeid": "adminunit231",
        "group_name      "two_character_code": "Mainnull
Group",         "community_name": "Community",  },
      "name": "Admin Unit",    "date_of_birth": {
   "description": "admin unit",         "idmonth": "1"3,
       },       "udf_string_8year": null1988,

     "external_system": null     }   ],
  "statusday": {4
    "code": "OK"        },
            "industry_sector": null,
            "passport_number": null,
    "description        "industry": null,
            "social_security_number": null,
    "message": ""
  }
}

POST customer_events/financial_achievements/create

This method is used to create a financial achievement customer event in a posted life cycle state

Resource URL

Parameters

...

Name

...

Type

...

Description

...

token

...

String

...

The token retrieved from the login method

...

accounts_receivable_identifier

(semi-optional)

...

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

...

rewards_participant_identifier

(semi-optional)

...

classification_identifier

(mandatory)

...

product_identifier

(optional)

...

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

...

payment_medium_type_identifier

(optional)

...

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:

...

payment_medium_brand_identifier

(optional)

...

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:

...

payment_medium_identifier

(optional)

...

amount

(optional)

...

The financial achievement customer event's amount

Tip

Available from CRM.COM R11.0.0

...

performed_by_unit_identifier

(mandatory)

...

performed_on

(mandatory)

...

description

(optional)

...

external_system

(optional)

...

Defines the third party system that generated the customer event

 

...

external_system_reference_number

(optional)

...

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)

...

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

 

Restrictions

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

Response Data

...

Examples

Expand
titleExample 1

HTTP Method: POST

 

Request:

Body:

Code Block
themeConfluence
languagejavascript
linenumberstrue
 {
   "token":"{{token}}",
   "accounts_receivable_identifier":{"number":"162"},
   "classification_identifier":{"name":"Financial Achievement"},
   "performed_by_unit_identifier":{"name":"Admin Unit"},
   "performed_on":"2016-06-28T15:00:00",
   "description":"Testing creation of financial achievement customer event through API",
   "payment_medium_brand_identifier":{"name":"VISA"},
   "payment_medium_type_identifier":{"alternative_code":"CC"},
   "payment_medium_identifier":"PI000002",
   "product_identifier":{"code":"Standard"},
   "udf_string_1":"udf string 1",
   "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_6":"udf string 6",
   "udf_string_7":"udf string 7",
   "udf_string_8":"udf string 8",
   "udf_float_1":10,
   "udf_float_2":20,
   "udf_float_3":30,
   "udf_float_4":40,
   "udf_float_5":50,
   "udf_float_6":60,
   "udf_float_7":70,
   "udf_float_8":80,
   "udf_date_1":"2016-03-24T15:49:59",
   "udf_date_2":"2016-04-24T15:49:59",
   "udf_date_3":"2016-05-24T15:49:59",
   "udf_date_4":"2016-06-24T15:49:59"
 } 

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
 {
  "status": {
    "message": "",
    "description": "",
    "code": "OK"
  },
  "data": {
    "udf_float_1": 10,
    "udf_float_2": 20,
    "udf_float_3": 30,
    "udf_float_4": 40,
    "number": "6",
    "payment_medium_type": {
      "id": "0EC912D6358341B4BAE55CFA70FE0F2D",
      "name": "Credit Card",
      "description": "Payment Medium Type 1: Credit Card",
      "alternative_code": "CC"
    },
    "udf_string_1":         "id_issued_by_country": null,
            "passport_issued_by_country": null
          }
        }
      },
      "life_cycle_state": "POSTED",
      "performed_on": "2016-10-07T09:12:36",
      "classification": {
        "alternative_code": "FA",
        "name": "Financial Achievement 1",
        "id": "39031C33C1AC4FB79140B27D1614CD6A"
      },
      "process_immediately": false,
      "payment_medium_type": null,
      "payment_medium_identifier": null,
      "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": ""
  }
}



Expand
titleExample 2

HTTP Method: POST


Request:


Body:

Code Block
languagejs
themeConfluence
linenumberstrue
{
  "token": "{{token}}",
  "accounts_receivable_identifier": {
    "number": "ACR0000000659"
  },  "fields_set": "number,performed_on",
  "submitted_after_date":"2016-10-26T00:00:12",
  "submitted_before_date":"2016-11-03T15:00:12"
}


Response:

Code Block
languagejavascript
themeConfluence
linenumberstrue
{
  "data": [
    {
      "number": "110",
      "performed_on": "2016-10-26T17:05:58"
    },
    {
      "number": "115",
      "performed_on": "2016-10-26T18:00:13"
    },
    {
      "number": "109",
      "performed_on": "2016-10-26T17:01:10"
    },
    {
      "number": "111",
      "performed_on": "2016-10-26T15:00:00"
    },
    {
      "number": "108",
      "performed_on": "2016-10-26T16:55:21"
    },
    {
      "number": "112",
      "performed_on": "2016-10-26T17:53:47"
    },
    {
      "number": "113",
      "performed_on": "2016-10-26T17:58:49"
    },
    {
      "number": "114",
      "performed_on": "2016-10-26T17:59:39"
    },
    {
      "number": "116",
      "performed_on": "2016-10-26T18:02:42"
    },
    {
      "number": "117",
      "performed_on": "2016-10-26T18:11:18"
    },
    {
      "number": "118",
      "performed_on": "2016-10-26T18:11:43"
    },
    {
      "number": "119",
      "performed_on": "2016-10-26T18:15:31"
    },
    {
      "number": "120",
      "performed_on": "2016-11-03T11:50:18"
    },
    {
      "number": "137",
      "performed_on": "2016-10-26T15:00:00"
    }
  ],
  "status": {
    "code": "OK",
    "description": "",
    "message": ""
  }
}
  


POST customer_events/financial_achievements/create

This method is used to create a financial achievement customer event in a posted life cycle state

Resource URL

Parameters

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 Identifier
The related rewards participant. The allowed rewards participant identifier fields are the following:

Include Page
V4:rewards_participants_identifier_post
V4:rewards_participants_identifier_post

classification_identifier

(mandatory)

Customer Event Classification Identifier
The 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 Identifier
The 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


Restrictions

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

Response Data

Include Page
V4:financial_achievement_customer_event_complete
V4:financial_achievement_customer_event_complete

Examples

Expand
titleExample 1

HTTP Method: POST


Request:

Body:

Code Block
languagejavascript
themeConfluence
linenumberstrue
 {
   "token":"{{token}}",
   "accounts_receivable_identifier":{"number":"ACR0000000069"},
   "classification_identifier":{"name":"Financial Achievement 1"},
   "performed_by_unit_identifier":{"name":"Admin Unit"},
   "performed_on":"2016-10-07T15:00:00",
   "description":"Testing creation of financial achievement customer event through API",
   "payment_medium_brand_identifier":{"name":"VISA"},
   "payment_medium_type_identifier":{"alternative_code":"CC"},
   "payment_medium_identifier":"PI000002",
   "product_identifier":{"code":"Bronze"},
   "amount":"11.50",
   "udf_string_1":"udf string 1",
    "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_6": "udf string 6",

   "udf_string_7": "udf string 7",

   "udf_string_8": "udf string 8",
    "accountsudf_float_receivable1":10,
{       "account_owner": {
        "last_name": "Mercer",
  udf_float_2":20,
     "middleudf_float_name3": "111111111"30,
        "lifeudf_cyclefloat_state4": "FINANCIAL"40,
        "company_profile": null"udf_float_5":50,
        "title": "Mr""udf_float_6":60,
   "udf_float_7":70,
    "firstudf_float_name8": "Ben11 omonoia",
 80,
      "type"udf_date_1": "PERSON"2016-03-24T15:49:59",
        "id"udf_date_2": "475904FB959FE8D3DDAEB22FBFEC5FFB"2016-04-24T15:49:59",

       "name"udf_date_3": "Mercer Ben11 omonoia",
 "2016-05-24T15:49:59",
      "company_name": null,
        "demographics": {
   "udf_date_4":"2016-06-24T15:49:59"
 } 


Response:

Code Block
languagejavascript
themeConfluence
linenumberstrue
 {
  "data": {
      "gender"external_system_reference_number": "MALE"null,
 
        "passport_issued_by_countrylog_information": {
     
      "threecreated_characterby_codeunit": "AND",{
            "twoalternative_character_code": "ADadminunit",
   
        "idgroup_name": "132Main Group",
  
         "community_name": "ANDORRACommunity",
 
          "alternative_codename": null
          }"Admin Unit",
          "social_security_number"description": null,
          "passport_number": null"admin unit",
        "id":  "industry_sector1":
null,      },
      "countryupdated_ofby_residenceunit": {
            "three_character"alternative_code": "USAadminunit",
   
        "twogroup_character_codename": "USMain Group",
            "id"community_name": "127Community",
            "name": "UNITEDAdmin STATESUnit",
   
        "alternative_codedescription": null
          }"admin unit",
        "id":  "name_day1":
{      },
      "monthcreated_date": 6,
     "2016-10-07T09:20:12",
      "dayupdated_date": 14
 "2016-10-07T09:20:12",
      "updated_by_user": {
},           "dateperson_of_birthname": {
   "CRM COM",
        "monthid": 11"1",
           "username": "dayMPAdministrator":
9,      },
      "yearcreated_by_user": 1963{
        "person_name": "CRM }COM",
          "id_number": "12121251",
 
        "industryusername": {"MPAdministrator"
      }
     "id": "31BC2070C79EAE5455BFAD41599C5190"},
    "payment_medium_brand": {
      "namealternative_code": "Marketing1V",
      "name": "VISA",
      "codedescription": "MK"null,
          },"id": "02DEEA7F35B8413E9C017600653C1223"
    },
     "id_issued_by_country"description": {"Testing creation of financial achievement customer event through API",
    "threeudf_characterdate_code2": "DZA2016-04-24T15:49:59",
      "type": "FINANCIAL_ACHIEVEMENT",
     "twoudf_characterdate_code1": "DZ2016-03-24T15:49:59",
    "udf_date_4": "2016-06-24T15:49:59",
      "id"udf_date_3": "1302016-05-24T15:49:59",
       "number": "94",
    "nameudf_float_3": "ALGERIA"30,
       "udf_float_4": 40,
    "alternative_codeaward_reward_transactions_set": null,
    "id": "79845A8FF2D3407B84BC593536BBBFBB",
    }
"udf_float_1": 10,
    "udf_float_2": 20,
 }   "udf_string_2": "udf string  }2",
      "lifeudf_cyclestring_state3": "ACTIVEudf string 3",

     "numberudf_string_4": "162udf string 4",
      "idamount": "3C66BD54CCDB6BC1096C23F6D8899752"11.5,
      "nameproduct": "Ben Mercer 1"{
     },     "payment_medium_brand"code": {"Bronze",
      "idproduct_type": "F7B18DE5D55E452C81AF6F1EAD3E934C",{
        "nameservice_type": "VISATERMED",
        "descriptionused_for_provisioning": "Paymenttrue,
Medium Brand 1: Visa",       "alternative_code": "VMain Packages"
,
   },     "idcomposition_method": "467D7CECAABF4EFBA560B9CA352A4FDBFLAT",
       "award_reward_transactions_set "name": null"Main Packages",
        "classificationdescription": {null,
        "id": "7CC02035F12448258ECFD3F9E22C23DDE186E293AAAB49EE86A729540A4287FE",
        "nameclassification": "Financial AchievementSERVICES",
        "alternativephysical_good_codetype": "FA"null
      },
      "udfalternative_date_1code": "2016-03-24T15:49:59B",
    "udf_date_2  "description": "2016-04-24T15:49:59Bronze",
      "udf_date_3id": "2016-05-24T15:49:59"F50CC52934BD4F119B6E18E215A4FC55"
    },
    "udf_datestring_45": "2016-06-24T15:49:59udf string 5",
    "performedudf_bystring_unit1": {"udf string 1",
    "communityaccounts_namereceivable": "Internal{
Community",       "idnumber": "48305F8849E3C18B227C5BE3A27BA6DFACR0000000069",
      "name": "AdminACR0000000069 Polina UnitKestora",
      "group_nameid": "Main Group8C1E866074D743EE834E910A28C1E582",
      "descriptionlife_cycle_state": "r1ACTIVE",
Test Description for resource  request tab.Test Description for resource  request tab.",
   "account_owner": {
        "alternativecompany_codeprofile": "MG"null,
    },     "processcompany_immediatelyname": 0null,

   "product": {       "product_type"name": { "Polina Kestora",
        "servicelast_typename": "TERMEDKestora",
        "physical_good_typeid": null"F038161F36C845B98CEE7361A8C92157",
        "usedlife_forcycle_provisioningstate": true"FINANCIAL",
        "classificationmiddle_name": "SERVICES"null,
        "composition_methodtitle": "FLAT"null,
        "idtype": "BC954969D3172372D498D3BB2BA590A0PERSON",
        "first_name": "Subscription PackagesPolina",
        "descriptiondemographics": "Subscription{
main packages",         "alternativename_codeday": "SP"{
      },       "idmonth": "A15149563AC0E7D3613F3C1B6E2EE4F5"7,
      "description": "Standard Premium Package\r\n",
      "codeday": "Standard",21
      "alternative_code": "S"     },
 
  "log_information": {       "updatedid_date": "2016-06-28T17:30:30number": "112233",
      "created_date    "gender": "2016-06-28T17:30:29",null,
          "createdcountry_byof_unitresidence": {
            "communityalternative_namecode": "Internal CommunityIRN",
        "id    "three_character_code": "48305F8849E3C18B227C5BE3A27BA6DF"null,
            "name": "Admin UnitIRAN (ISLAMIC REPUBLIC OF)",
        "group_name    "id": "Main Group231",
         "description   "two_character_code": "r1null
Test Description for resource  request tab.Test Description for resource },
request tab.",         "alternativedate_of_codebirth": "MG"
{
            "month": 3,
     },       "updated_by_unityear": {1988,
            "community_nameday": "Internal4
Community",         "id": "48305F8849E3C18B227C5BE3A27BA6DF" },
          "nameindustry_sector": null,
"Admin Unit",         "grouppassport_namenumber": "Main Group",null,
          "descriptionindustry": null,
"r1 Test Description for resource  request tab.Test Description for resource  request tab.", "social_security_number": null,
          "alternative_codeid_issued_by_country": "MG"null,
      },       "created"passport_issued_by_usercountry": { null
        }
    "person_name": "Marios Lannister",  }
    },
    "usernamelife_cycle_state": "MPAdministratorPOSTED",
        "id"performed_on": "1"
      }2016-10-07T15:00:00",
      "updated_by_user"classification": {
        "personalternative_namecode": "Marios LannisterFA",
        "usernamename": "MPAdministratorFinancial Achievement 1",
 
      "id": "139031C33C1AC4FB79140B27D1614CD6A"
      }
    },
    "lifeprocess_cycle_stateimmediately": "POSTED"false,
    "payment_medium_identifiertype": "PI000002",{
      "typealternative_code": "FINANCIAL_ACHIEVEMENTCC",
      "descriptionname": "TestingCREDIT creationCARD",
of financial achievement customer event through API"description": null,
    "performed_on":  "2016-06-28T15:00:00"id": "68FAF1F833194091967F86B1AA352129"
    }
}

 

POST customer_events/financial_achievements/cancel

This method is used in order to cancel a posted financial achievement customer event. This method can be applied only on posted financial achievement customer events.  A single financial achievement 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 financial achievement which are posted can be specified. The allowed customer event identifier fields are the following:

...

Response Data

...

Examples

Expand
titleExample 1

HTTP Method: POST

 

Request:

Body:

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

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
  "status": {
    "message": ",
    "payment_medium_identifier": "PI000002",
    "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",
      "codeid": "OK1"
    },
    "dataudf_string_8": { "udf string 8",
    "udfexternal_float_1system": null,
  },
  "udf_float_2status": null,{
    "udf_float_3code": null"OK",
    "udf_float_4description": null"",
    "numbermessage": "5",
  }
 "payment_medium_type": {
      "id": "0EC912D6358341B4BAE55CFA70FE0F2D",
      "name": "Credit Card",
      "description": "Payment Medium Type 1: Credit Card",
      "alternative_code": "CC"
    },
    "udf_string_1": null,
    "udf_string_2": null,
    "udf_string_3": null,
    "udf_string_4": null,
    "udf_string_5": null,
    "udf_string_6": null,
    "udf_string_7": null,
    "udf_string_8}



POST customer_events/financial_achievements/cancel

This method is used in order to cancel a posted financial achievement customer event. This method can be applied only on posted financial achievement customer events.  A single financial achievement 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 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

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


Response Data

Include Page
V4:financial_achievement_customer_event_complete
V4:financial_achievement_customer_event_complete

Examples

Expand
titleExample 1

HTTP Method: POST


Request:


Body:

Code Block
languagejs
themeConfluence
linenumberstrue
{
"token":"{{token}}",
"customer_event_identifier":{"id":"79845A8FF2D3407B84BC593536BBBFBB"}
}


Response:

Code Block
languagejavascript
themeConfluence
linenumberstrue
 {
  "data": {
    "external_system_reference_number": null,
    "accountslog_receivableinformation": {
      "accountcreated_by_ownerunit": {
        "lastalternative_namecode": "Merceradminunit",
        "middlegroup_name": "111111111",
        "life_cycle_state": "FINANCIAL"Main Group",
        "companycommunity_profilename": null,
        "title": "Mr""Community",
        "first_name": "Ben11Admin omonoiaUnit",
        "typedescription": "PERSONadmin unit",
        "id": "475904FB959FE8D3DDAEB22FBFEC5FFB1",
        "name": "Mercer Ben11 omonoia",
 },
      "companyupdated_by_nameunit": null,{
        "demographicsalternative_code": {"adminunit",
          "gendergroup_name": "MALEMain Group",
 
        "passport_issued_by_countrycommunity_name": {
"Community",
           "three_character_code"name": "ANDAdmin Unit",
            "two_character_code"description": "ADadmin unit",
            "id": "1321",
      },
      "namecreated_date": "ANDORRA2016-10-07T09:20:12",
            "alternative_code"updated_date": null"2016-10-07T09:23:24",
        "updated_by_user": {
 },           "social_security_number"person_name": null,
 "CRM COM",
        "passport_numberid": null"1",
        "username":  "industry_sector": null,MPAdministrator"
      },
      "countrycreated_ofby_residenceuser": {
   
        "threeperson_character_codename": "USAMPAdministrator",
            "two_character_code"id": "US1",
   
        "idusername": "127MPAdministrator",
      }
     "name": "UNITED STATES"},
    "payment_medium_brand": {
      "alternative_code": null"V",
      "name": "VISA",
  },    "description": null,
      "name_dayid": {"02DEEA7F35B8413E9C017600653C1223"
    },
       "monthdescription": 6,"Testing creation of financial achievement customer event through API",
    "dayudf_date_2": 14null,
    "type": "FINANCIAL_ACHIEVEMENT",
    } "udf_date_1": null,
    "udf_date_4": null,
    "udf_date_of_birth3": {null,
       "number": "94",
    "monthudf_float_3": 11null,
    "udf_float_4": null,
      "day"award_reward_transactions_set": 9null,
    "id": "79845A8FF2D3407B84BC593536BBBFBB",
      "year"udf_float_1": 1963null,
    "udf_float_2": null,
    },
    "udf_string_2": null,
     "idudf_string_number3": "1212125"null,
    "udf_string_4": null,
    "industryamount": {11.5,
    "product": {
      "idcode": "31BC2070C79EAE5455BFAD41599C5190Bronze",
      "alternative_code": "B",
      "namedescription": "Marketing1Bronze",
            "code"id": "MKF50CC52934BD4F119B6E18E215A4FC55"
   
      },
    "udf_string_5": null,
    "idudf_issuedstring_by_country1": {null,
    "accounts_receivable": {
      "three_character_codenumber": "DZAACR0000000069",
            "two_character_code"name": "DZACR0000000069 Polina Kestora",
            "id": "1308C1E866074D743EE834E910A28C1E582",
     
      "namelife_cycle_state": "ALGERIAACTIVE",
      "account_owner": {
        "alternativecompany_codeprofile": null,
        "company_name": null,
}         }
 "name": "Polina Kestora",
    },       "lifelast_cycle_statename": "ACTIVEKestora",
        "numberid": "163F038161F36C845B98CEE7361A8C92157",
        "idlife_cycle_state": "DF7E2D0361CB10EAD23E9678D13C6649FINANCIAL",
        "middle_name": "Ben Mercer 2"
 null,
        "title": null,
   },     "payment_medium_brandtype": {"PERSON",
        "idfirst_name": "A01DB55EE5624E80ADA3CD7AF166AF30Polina",
        "namedemographics": {
 "AMERICAN  EXPRESS",       "descriptionname_day": {
"Payment Medium Brand 2: American Express",       "alternative_codemonth": "AE"7,
       },     "idday": "4E761E7C445E4BEFAEC826B88A6BDCAB",21
       "award_reward_transactions_set": null,  },
  "classification": {       "id_number": "13B057EB15D94D7FBB22D4AF5882211D112233",
          "namegender": "PKnull,
Fin. Ach. Customer Event Classification",       "alternativecountry_of_coderesidence": "PFACEC" {
       },     "udfalternative_date_1code": null"IRN",
      "udf_date_2": null,     "udfthree_datecharacter_3code": null,
      "udf_date_4": null,     "performed_by_unitname": {"IRAN (ISLAMIC REPUBLIC OF)",
   "community_name": "Internal Community",       "id": "48305F8849E3C18B227C5BE3A27BA6DF231",
      "name      "two_character_code": null
"Admin Unit",       "group_name": "Main Group"},
      "description    "date_of_birth": "r1{
Test Description for resource  request tab.Test Description for resource  request tab.""month": 3,
      "alternative_code      "year": "MG"1988,
       },     "process_immediatelyday": 0,4
       "product": null,  },
  "log_information": {       "updated_date": "2016-06-28T17:03:56",industry_sector": null,
          "createdpassport_datenumber": "2016-06-28T16:57:57"null,
      "created_by_unit    "industry": {null,
          "communitysocial_security_namenumber": "Internal Community",null,
          "id_issued_by_country": "48305F8849E3C18B227C5BE3A27BA6DF"null,
          "namepassport_issued_by_country": "Admin Unit", null
        }
     "group_name": "Main Group", }
    },
    "descriptionlife_cycle_state": "r1CANCELLED",
Test Description for resource  request tab.Test Description for resource  request tab.",
"performed_on": "2016-10-07T15:00:00",
    "classification": {
       "alternative_code": "MGFA",
      }"name": "Financial Achievement 1",
      "updated_by_unitid": "39031C33C1AC4FB79140B27D1614CD6A"
{    },
    "communityprocess_nameimmediately": "Internal Community"false,

       "id"payment_medium_type": "48305F8849E3C18B227C5BE3A27BA6DF",
 {
      "namealternative_code": "Admin UnitCC",
 
      "group_name": "MainCREDIT GroupCARD",
        "description": "r1null,
Test Description for resource  request tab.Test Description for resource  request tab." "id": "68FAF1F833194091967F86B1AA352129"
    },
        "alternative_code"payment_medium_identifier": "MGPI000002",
      },
 "udf_string_6": null,
    "createdudf_bystring_user7": {
null,
       "person_name"performed_by_unit": "MPAdministrator",
 {
      "usernamealternative_code": "MPAdministratoradminunit",
 
      "idgroup_name": "1"
      }Main Group",
      "updatedcommunity_by_username": {"Community",
        "person_name": "MariosAdmin LannisterUnit",
        "usernamedescription": "MPAdministratoradmin unit",
 
      "id": "1"
    },
 }     }"udf_string_8": null,
    "lifeexternal_cycle_statesystem": "CANCELLED",null
  },
  "payment_medium_identifierstatus": null,{
    "typecode": "FINANCIAL_ACHIEVEMENTOK",
    "description": null"",
    "performed_onmessage": "2016-06-28T16:57:57"
  }
}