...

Available from CRM.COM R10.0.0

Table of Contents

maxLevel	2

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

...

title	Example 1

HTTP Method: GET

Request:

Response:

...

theme	Confluence
language	javascript
linenumbers	true

...

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

maxLevel	2

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

title	Example 1

HTTP Method: GET

Request:

Response:

Code Block

language	javascript
theme	Confluence
linenumbers	true

 {
  "data": {
    "external_system_reference_number": null,
    "log_information": {
      "created_by_unit": {
        "alternative_code": "adminunit",
        "group_name": "Main Group",
        "community_name": "Community",
        "name": "Admin Unit",
        "description": "admin unit",
        "id": "1"
      },
      "updated_by_unit": {
        "alternative_code": "adminunit",
        "group_name": "Main Group",
        "community_name": "Community",
        "name": "Admin Unit",
        "description": "admin unit",
        "id": "1"
      },
      "created_date": "2016-10-07T08:59:11",
      "updated_date": "2016-10-07T08:59:26",
      "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,
    "udf_date_2": null,
    "type": "FINANCIAL_ACHIEVEMENT",
    "udf_date_1": null,
    "udf_date_4": null,
    "udf_date_3": null,
    "number": "92",
    "udf_float_3": null,
    "udf_float_4": null,
    "award_reward_transactions_set": null,
    "id": "328B8B0AF30041169B889F4A39D774B7",
    "udf_float_1": null,
    "udf_float_2": null,
    "udf_string_2": null,
    "udf_string_3": null,
    "udf_string_4": null,
    "amount": 10,
    "product": null,
    "udf_string_5": null,
    "udf_string_1": null,
    "accounts_receivable": {
      "number": "ACR0000000069",
      "name": "ACR0000000069 Polina Kestora",
      "id": "8C1E866074D743EE834E910A28C1E582",
      "life_cycle_state": "ACTIVE",
      "account_owner": {
        "company_profile": null,
        "company_name": null,
        "name": "Polina Kestora",
        "last_name": "Kestora",
        "id": "F038161F36C845B98CEE7361A8C92157",
        "life_cycle_state": "FINANCIAL",
        "middle_name": null,
        "title": null,
        "type": "PERSON",
        "first_name": "Polina",
        "demographics": {
          "name_day": {
            "month": 7,
            "day": 21
         "alternative_code": "adminunit" },
          "groupid_namenumber": "Main Group112233",
          "community_namegender": "Community"null,
        "name  "country_of_residence": "Admin Unit",{
            "descriptionalternative_code": "admin unitIRN",
            "idthree_character_code": "1"null,
      },       "updated_by_unit": {"name": "IRAN (ISLAMIC REPUBLIC OF)",
            "alternative_codeid": "adminunit231",
            "grouptwo_character_namecode": "Mainnull
Group",         "community_name": "Community", },
          "namedate_of_birth": {
"Admin Unit",            "descriptionmonth": "admin unit",3,
            "idyear": "1"1988,
      },       "created_dateday": "2016-10-07T08:59:11",4
      "updated_date": "2016-10-07T08:59:26",   },
   "updated_by_user": {         "personindustry_namesector": "MPAdministrator"null,
          "idpassport_number": "1"null,
          "usernameindustry": "MPAdministrator"null,
      },       "createdsocial_bysecurity_usernumber": {null,
          "person_nameid_issued_by_country": "MPAdministrator"null,
        "id  "passport_issued_by_country": "1",null
        "username": "MPAdministrator"}
       }
    },
    "paymentlife_mediumcycle_brandstate": null"POSTED",
    "descriptionperformed_on": null"2016-10-07T08:59:11",
    "udf_date_2classification": {
      "alternative_code": null"FA",
      "typename": "FINANCIAL_ACHIEVEMENT",Financial Achievement 1",
      "id": "39031C33C1AC4FB79140B27D1614CD6A"
    "udf_date_1": null},
    "udfprocess_date_4immediately": nullfalse,
    "udfpayment_datemedium_3type": null,
    "numberpayment_medium_identifier": "92"null,
    "udf_floatstring_36": null,
    "udf_floatstring_47": null,
    "awardperformed_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_3description": "admin nullunit",
      "udf_string_4id": null"1"
    },
    "amountudf_string_8": 10null,
    "productexternal_system": null,
  },
  "udf_string_5status": null,{
    "udf_string_1code": null"OK",
    "accounts_receivabledescription": {"",
      "numbermessage": "ACR0000000069",
        "name": "ACR0000000069 Polina Kestora",
      "id": "8C1E866074D743EE834E910A28C1E582",
      "life_cycle_state": "ACTIVE",
      "account_owner": {
        "company_profile": null,
        "company_name": null,
        "name": "Polina Kestora",
        "last_name": "Kestora",
        "id": "F038161F36C845B98CEE7361A8C92157",
        "life_cycle_state": "FINANCIAL",
        "middle_name": null,
        "title": null,
        "type": "PERSON",
        "first_name": "Polina",
        "demographics": {
          "name_day": {
            "month": 7,
            "day": 21
          },
          "id_number": "112233",
          "gender": null,
          "country_of_residence": {
            "alternative_code": "IRN",
            "three_character_code": null,
            "name": "IRAN (ISLAMIC REPUBLIC OF)",
            "id": "231",
            "two_character_code": null
          },
          "date_of_birth": {
            "month": 3,
            "year": 1988,
            "day": 4
          },
          "industry_sector": null,}
}

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

title	Example 1

HTTP Method: POST

Request:

Body:

Code Block

language	js
theme	Confluence
linenumbers	true

{
"token":"{{token}}",
"accounts_receivable_identifier":{"number":"ACR0000000069"},
"classification_identifier":{"alternative_code":"FA"}
}

Response:

Code Block

language	javascript
theme	Confluence
linenumbers	true

 {
  "data": [
    {
      "external_system_reference_number": null,
      "log_information": {
          "passportcreated_by_numberunit": null,{
          "industryalternative_code": null"adminunit",
          "socialgroup_security_numbername": "Main nullGroup",
          "id_issued_by_countrycommunity_name": null"Community",
          "passport_issued_by_countryname": null"Admin Unit",
       }   "description": "admin unit",
 }     },     "life_cycle_stateid": "POSTED1",
       "performed_on": "2016-10-07T08:59:11" },
    "classification    "updated_by_unit": {
          "alternative_code": "FAadminunit",
          "group_name": "FinancialMain Achievement 1Group",
          "idcommunity_name": "39031C33C1AC4FB79140B27D1614CD6ACommunity",
    },      "process_immediatelyname": "Admin falseUnit",
    "payment_medium_type": null      "description": "admin unit",
    "payment_medium_identifier": null,     "udf_string_6id": null,"1"
    "udf_string_7": null,   },
 "performed_by_unit": {       "alternativecreated_codedate": "adminunit2016-07-21T11:24:56",
        "groupupdated_namedate": "Main Group2016-07-21T11:24:56",
        "communityupdated_by_nameuser": "Community", {
          "person_name": "Admin UnitMPAdministrator",
          "descriptionid": "admin unit1",
          "idusername": "1MPAdministrator"
        },
        "udfcreated_string_8": null,by_user": {
          "externalperson_systemname": null"MPAdministrator",
  },   "status": {     "codeid": "OK1",
          "descriptionusername": "MPAdministrator",
    "message": ""   }
}

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

title	Example 1

HTTP Method: POST

Request:

Body:

Code Block

theme	Confluence
language	js
linenumbers	true

{
"token":"{{token}}",
"accounts_receivable_identifier":{"number":"ACR0000000069"},
"classification_identifier":{"alternative_code":"FA"}
}

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

 {
  "data": [
          },
      "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": null,
      "type": "FINANCIAL_ACHIEVEMENT",
      "udf_date_1": null,
      "udf_date_4": null,
      "udf_date_3": null,
      "number": "57",
      "udf_float_3": null,
      "udf_float_4": null,
      "award_reward_transactions_set": null,
      "id": "B8A73C74B2E7417F8B7159CF2BB036F3",
      "udf_float_1": null,
      "udf_float_2": null,
      "udf_string_2": null,
      "udf_string_3": null,
      "udf_string_4": null,
      "amount": null,
      "product": null,
      "udf_string_5": null,
      "udf_string_1": null,
      "accounts_receivable": {
      "external_system_reference_  "number": null"ACR0000000069",
        "log_informationname": {"ACR0000000069 Polina Kestora",
        "created_by_unitid": {
 "8C1E866074D743EE834E910A28C1E582",
        "alternativelife_cycle_codestate": "adminunitACTIVE",
 
        "groupaccount_nameowner": "Main Group",{
          "communitycompany_nameprofile": "Community"null,
          "company_name": "Admin Unit"null,
          "descriptionname": "adminPolina unitKestora",
          "idlast_name": "1Kestora"
,
       },         "updated_by_unit"id": {"F038161F36C845B98CEE7361A8C92157",
          "alternativelife_cycle_codestate": "adminunitFINANCIAL",
          "groupmiddle_name": "Main Group"null,
          "community_nametitle": "Community"null,
          "nametype": "Admin UnitPERSON",
          "descriptionfirst_name": "admin unitPolina",
          "iddemographics": "1"{
        },         "createdname_dateday": "2016-07-21T11:24:56",{
        "updated_date": "2016-07-21T11:24:56",     "month": 7,
  "updated_by_user": {           "person_nameday": 21
"MPAdministrator",           "id": "1", },
            "usernameid_number": "MPAdministrator112233"
,
       },     "gender":    "created_by_user": {null,
            "personcountry_of_nameresidence": "MPAdministrator", {
              "idalternative_code": "1IRN",
          "username    "three_character_code": "MPAdministrator"null,
        }       },
 "name": "IRAN (ISLAMIC REPUBLIC OF)",
    "payment_medium_brand": {         "alternative_codeid": "V231",
        "name": "VISA",         "descriptiontwo_character_code": null,
          "id": "02DEEA7F35B8413E9C017600653C1223" },
     },       "descriptiondate_of_birth": "Testing{
creation of financial achievement customer event through API",       "udf_date_2month": null3,
      "type": "FINANCIAL_ACHIEVEMENT",         "udf_date_1year": null1988,
      "udf_date_4": null,       "udf_date_3day": 4
  null,       "number": "57",  },
    "udf_float_3": null,       "udfindustry_float_4sector": null,
      "award_reward_transactions_set      "passport_number": null,
 
    "id": "B8A73C74B2E7417F8B7159CF2BB036F3",       "udf_float_1industry": null,
      "udf_float_2      "social_security_number": null,
      "udf_string_2      "id_issued_by_country": null,
            "udfpassport_issued_stringby_3country": null,
       "udf_string_4": null,   }
      "amount": null, }
     "product": null},
      "udflife_stringcycle_5state": null"POSTED",
      "udfperformed_string_1on": null"2016-06-28T15:00:00",
      "accounts_receivableclassification": {
        "numberalternative_code": "ACR0000000069FA",
        "name": "ACR0000000069Financial PolinaAchievement Kestora1",
        "id": "8C1E866074D743EE834E910A28C1E58239031C33C1AC4FB79140B27D1614CD6A",
      },
      "lifeprocess_cycle_stateimmediately": "ACTIVE"false,

       "accountpayment_medium_ownertype": {
 
        "companyalternative_profilecode": null"CC",
          "company_name": null"CREDIT CARD",
          "namedescription": "Polina Kestora"null,
          "last_nameid": "Kestora",68FAF1F833194091967F86B1AA352129"
       },
      "idpayment_medium_identifier": "F038161F36C845B98CEE7361A8C92157PI000002",

         "lifeudf_cyclestring_state6": "FINANCIAL"null,
          "middle_name"udf_string_7": null,

         "title"performed_by_unit": null,
 {
        "typealternative_code": "PERSONadminunit",
          "firstgroup_name": "PolinaMain Group",
 
        "demographicscommunity_name": {"Community",
            "name_day": {
 "Admin Unit",
            "monthdescription": 7,
    "admin unit",
         "dayid": 21
 "1"
          },
     
      "idudf_string_number8": "112233",
      null,
      "genderexternal_system": null
    },
    {
       "countryexternal_system_ofreference_residencenumber": {null,
      "log_information": {
        "alternativecreated_by_codeunit": "IRN",
   {
          "three_characteralternative_code": null"adminunit",
              "group_name": "IRAN (ISLAMIC REPUBLIC OF)Main Group",
              "id"community_name": "231Community",
              "two_character_code"name": null"Admin Unit",
           }"description": "admin unit",
          "id":  "date_of_birth": {1"
        },
        "monthupdated_by_unit": 3,
   {
          "yearalternative_code": 1988"adminunit",

             "day"group_name": 4"Main Group",
           },
"community_name": "Community",
           "industry_sectorname": null,
 "Admin Unit",
          "passport_numberdescription": "admin nullunit",
          "id":  "industry": null,1"
        },
        "socialcreated_security_numberdate": null"2016-10-07T08:59:11",
            "id_issued_by_countryupdated_date": null,
   "2016-10-07T08:59:26",
        "passport_issuedupdated_by_countryuser": null{
          }"person_name": "MPAdministrator",
        }  "id": "1",
   },       "life_cycle_stateusername": "POSTEDMPAdministrator",
       "performed_on": "2016-06-28T15:00:00" },
      "classification  "created_by_user": {
          "alternativeperson_codename": "FAMPAdministrator",
          "nameid": "Financial Achievement 1",
          "idusername": "39031C33C1AC4FB79140B27D1614CD6AMPAdministrator"
        },
      "process_immediately": false},
      "payment_medium_typebrand": {null,
        "alternative_codedescription": "CC"null,
 
      "nameudf_date_2": "CREDIT CARD"null,

       "descriptiontype": null"FINANCIAL_ACHIEVEMENT",

       "idudf_date_1": "68FAF1F833194091967F86B1AA352129"
      } null,
      "paymentudf_mediumdate_identifier4": "PI000002"null,
      "udf_stringdate_63": null,
      "udf_string_7number": null"92",
      "performedudf_byfloat_unit3": {null,
        "alternativeudf_float_code4": "adminunit"null,
 
      "group_nameaward_reward_transactions_set": "Main Group",
 null,
      "community_nameid": "Community328B8B0AF30041169B889F4A39D774B7",
        "name"udf_float_1": "Admin Unit"null,
        "description"udf_float_2": "admin unit",
 null,
      "idudf_string_2": "1"null,
       }"udf_string_3": null,
      "udf_string_84": null,
      "external_systemamount": null10,
    },  "product": null,
 {       "externaludf_systemstring_reference_number5": null,
      "logudf_string_information1": {null,
        "createdaccounts_by_unitreceivable": {
 
        "alternative_codenumber": "adminunitACR0000000069",
          "group_name": "MainACR0000000069 Polina GroupKestora",
 
        "community_nameid": "Community8C1E866074D743EE834E910A28C1E582",
          "name"life_cycle_state": "Admin UnitACTIVE",

         "descriptionaccount_owner": "admin{
unit",           "idcompany_profile": "1"null,
        },
        "updatedcompany_by_unitname": {null,
          "alternative_codename": "adminunitPolina Kestora",
          "grouplast_name": "Main GroupKestora",
          "community_nameid": "CommunityF038161F36C845B98CEE7361A8C92157",
          "namelife_cycle_state": "Admin UnitFINANCIAL",
          "descriptionmiddle_name": "admin unit"null,
          "idtitle": "1"null,
        },         "created_date"type": "2016-10-07T08:59:11PERSON",
          "updatedfirst_datename": "2016-10-07T08:59:26Polina",
        "updated_by_user  "demographics": {
            "personname_nameday": "MPAdministrator",{
              "idmonth": "1"7,
              "usernameday": "MPAdministrator"21
            },
            "createdid_by_usernumber": {"112233",
            "person_namegender": "MPAdministrator"null,
          "id  "country_of_residence": "1", {
              "usernamealternative_code": "MPAdministratorIRN",
        }       }"three_character_code": null,
      "payment_medium_brand": null,       "descriptionname": null"IRAN (ISLAMIC REPUBLIC OF)",
      "udf_date_2": null,       "typeid": "FINANCIAL_ACHIEVEMENT231",
      "udf_date_1": null,       "udftwo_datecharacter_4code": null,
         "udf_date_3": null,  },
    "number": "92",       "udfdate_floatof_3birth": null,{
              "udf_float_4month": null3,
      "award_reward_transactions_set": null,       "idyear": "328B8B0AF30041169B889F4A39D774B7"1988,
      "udf_float_1": null,       "udf_float_2day": null,4
           "udf_string_2": null, },
            "udfindustry_string_3sector": null,
      "udf_string_4      "passport_number": null,
 
    "amount": 10,       "productindustry": null,
            "udfsocial_stringsecurity_5number": null,
      "udf_string_1      "id_issued_by_country": null,
      "accounts_receivable": {         "number": "ACR0000000069","passport_issued_by_country": null
          }
"name": "ACR0000000069 Polina Kestora",     }
   "id": "8C1E866074D743EE834E910A28C1E582",  },
      "life_cycle_state": "ACTIVEPOSTED",
        "accountperformed_owneron": {
"2016-10-07T08:59:11",
         "company_profile"classification": null,{
          "companyalternative_namecode": null"FA",
          "name": "PolinaFinancial Achievement Kestora1",
 
        "last_nameid": "Kestora39031C33C1AC4FB79140B27D1614CD6A",
      },
   "id   "process_immediately": "F038161F36C845B98CEE7361A8C92157"false,
      "payment_medium_type": null,
      "lifepayment_cyclemedium_stateidentifier": "FINANCIAL"null,
      "udf_string_6": null,
      "middleudf_string_name7": null,

         "title"performed_by_unit": null,{
          "typealternative_code": "PERSONadminunit",
          "firstgroup_name": "PolinaMain Group",
          "demographicscommunity_name": {
   "Community",
        "name_day": {
 "Admin Unit",
            "monthdescription": "admin 7unit",
              "day"id": 21
  "1"
         },
     
      "idudf_string_number8": "112233"null,
      "external_system": null
    "gender": null},
    {
       "countryexternal_system_ofreference_residencenumber": {null,
      "log_information": {
        "alternativecreated_by_codeunit": "IRN",
  {
           "threealternative_character_code": null"adminunit",
              "group_name": "IRAN (ISLAMIC REPUBLIC OF)Main Group",
              "id"community_name": "231Community",
              "two_character_code"name": null "Admin Unit",
          "description": "admin }unit",
           "id": "date_of_birth": {1"
        },
        "monthupdated_by_unit": 3,{
              "year"alternative_code": 1988,
  "adminunit",
           "daygroup_name": 4"Main Group",
           }"community_name": "Community",
            "industry_sectorname": null,
 "Admin Unit",
          "passport_numberdescription": null"admin unit",
          "id":  "industry": null,1"
        },
        "socialcreated_security_numberdate": null"2016-10-07T09:12:36",
            "id_issued_by_countryupdated_date": null,
 "2016-10-07T09:12:52",
          "passportupdated_issued_by_countryuser": null{
          }"person_name": "MPAdministrator",
        }  "id": "1",
   },       "life_cycle_stateusername": "POSTEDMPAdministrator",
       "performed_on": "2016-10-07T08:59:11", },
        "classificationcreated_by_user": {
          "alternativeperson_codename": "FAMPAdministrator",
          "nameid": "Financial Achievement 1",
          "idusername": "39031C33C1AC4FB79140B27D1614CD6AMPAdministrator"
        }
      },
      "processpayment_medium_immediatelybrand": falsenull,
      "payment_medium_typedescription": null,
      "paymentudf_mediumdate_identifier2": null,
      "type": "FINANCIAL_ACHIEVEMENT",
      "udf_stringdate_61": null,
      "udf_stringdate_74": null,
      "performedudf_bydate_unit3": {null,
        "alternative_codenumber": "adminunit93",
        "groupudf_float_name3": "Main Group",
 null,
      "communityudf_float_name4": "Community"null,
        "name"award_reward_transactions_set": "Admin Unit"null,

       "descriptionid": "admin unit2DA40D40C50145FD898F73CB33F9EAE3",
 
      "idudf_float_1": "1"null,
      }"udf_float_2": null,
      "udf_string_82": null,
      "externaludf_string_system3": null
    },
    {
      "externaludf_systemstring_reference_number4": null,
      "log_informationamount": {
11.3,
       "created_by_unitproduct": {null,
          "alternative_code"udf_string_5": "adminunit"null,

         "group_name"udf_string_1": "Main Group",
 null,
        "communityaccounts_namereceivable": "Community",{
          "namenumber": "Admin UnitACR0000000069",
 
        "descriptionname": "adminACR0000000069 Polina unitKestora",
          "id": "1"
        }8C1E866074D743EE834E910A28C1E582",
        "updatedlife_bycycle_unitstate": {
 "ACTIVE",
        "alternativeaccount_codeowner": "adminunit",{
          "groupcompany_nameprofile": "Main Group"null,
          "communitycompany_name": "Community"null,
          "name": "AdminPolina UnitKestora",
          "descriptionlast_name": "admin unitKestora",
          "id": "1F038161F36C845B98CEE7361A8C92157",
        },         "createdlife_cycle_datestate": "2016-10-07T09:12:36FINANCIAL",
        "updated_date": "2016-10-07T09:12:52",
        "updatedmiddle_by_username": {null,
          "person_nametitle": "MPAdministrator"null,
          "idtype": "1PERSON",
          "usernamefirst_name": "MPAdministratorPolina",
        },         "created_by_user"demographics": {
            "personname_nameday": "MPAdministrator", {
              "idmonth": "1",7,
              "usernameday": "MPAdministrator"21
            }
,
     },       "paymentid_medium_brandnumber": null"112233",
 
    "description": null,       "udf_date_2gender": null,
      "type": "FINANCIAL_ACHIEVEMENT",
      "udfcountry_dateof_1residence": null,{
      "udf_date_4": null,       "udfalternative_date_3code": null"IRN",
      "number": "93",        "udfthree_floatcharacter_3code": null,
        "udf_float_4      "name": null"IRAN (ISLAMIC REPUBLIC OF)",
      "award_reward_transactions_set": null,       "id": "2DA40D40C50145FD898F73CB33F9EAE3231",
      "udf_float_1": null,       "udftwo_floatcharacter_2code": null,
         "udf_string_2": null,  },
    "udf_string_3": null,       "udfdate_stringof_4birth": null,{
      "amount": 11.3,       "productmonth": null3,
      "udf_string_5": null,       "udf_string_1year": null1988,
      "accounts_receivable": {         "numberday": "ACR0000000069",4
         "name": "ACR0000000069 Polina Kestora"},
        "id    "industry_sector": "8C1E866074D743EE834E910A28C1E582",null,
            "lifepassport_cycle_statenumber": "ACTIVE"null,
        "account_owner    "industry": {null,
            "companysocial_security_profilenumber": null,
            "company_nameid_issued_by_country": null,
          "name  "passport_issued_by_country": "Polinanull
Kestora",          }
"last_name": "Kestora",       }
   "id": "F038161F36C845B98CEE7361A8C92157",   },
       "life_cycle_state": "FINANCIALPOSTED",
   
      "middleperformed_nameon": null,
 "2016-10-07T09:12:36",
        "titleclassification": null,
 {
        "typealternative_code": "PERSONFA",

         "first_name": "PolinaFinancial Achievement 1",
          "demographicsid": {"39031C33C1AC4FB79140B27D1614CD6A"
      },
      "nameprocess_dayimmediately": {false,
      "payment_medium_type": null,
      "monthpayment_medium_identifier": 7null,
      "udf_string_6": null,
      "dayudf_string_7": 21null,
      "performed_by_unit": {
    },    "alternative_code": "adminunit",
        "idgroup_numbername": "112233Main Group",

           "gender"community_name": null"Community",
        "name":    "country_of_residence": {"Admin Unit",
        "description": "admin unit",
        "alternative_codeid": "IRN1",
       },
      "threeudf_characterstring_code8": null,
      "external_system": null
    }
 "name": "IRAN (ISLAMIC REPUBLIC OF)",
 ],
  "status": {
        "code": "OK",
    "iddescription": "231",
    "message": ""
  }
  }

Expand

title	Example 2

HTTP Method: POST

Request:

Body:

Code Block

language	js
theme	Confluence
linenumbers	true

{
  "two_character_codetoken": null"{{token}}",
  "accounts_receivable_identifier": {
    "number": "ACR0000000659"
  },  "fields_set": "number,performed_on",
   "submitted_after_date":"2016-10-26T00:00:12",
     "datesubmitted_ofbefore_birth": date":"2016-11-03T15:00:12"
}

Response:

Code Block

language	javascript
theme	Confluence
linenumbers	true

{
              "month"data": 3,[
       {
      "yearnumber": 1988"110",
              "day"performed_on": 4"2016-10-26T17:05:58"
    },
     {
 },     "number": "115",
      "industryperformed_sectoron": null"2016-10-26T18:00:13"
    },
     {
      "passport_number": null"109",
      "performed_on": "2016-10-26T17:01:10"
    "industry": null},
     {
      "social_security_number": null"111",
      "performed_on": "2016-10-26T15:00:00"
    "id_issued_by_country": null},
    {
       "passport_issued_by_country"number": null"108",
          }"performed_on": "2016-10-26T16:55:21"
        },
      },{
      "life_cycle_statenumber": "POSTED112",
      "performed_on": "2016-10-07T0926T17:1253:36",47"
    },
    {
      "classificationnumber": {"113",
        "alternativeperformed_codeon": "FA",
 2016-10-26T17:58:49"
    },
    {
      "namenumber": "Financial Achievement 1114",

       "idperformed_on": "39031C33C1AC4FB79140B27D1614CD6A2016-10-26T17:59:39"
    },
 },   {
      "process_immediatelynumber": false"116",
      "paymentperformed_medium_typeon": null,"2016-10-26T18:02:42"
    },
 "payment_medium_identifier": null,   {
      "udf_string_6number": null"117",
      "udfperformed_string_7on": null,"2016-10-26T18:11:18"
    },
 "performed_by_unit": {  {
      "alternative_codenumber": "adminunit118",
        "groupperformed_nameon": "Main Group","2016-10-26T18:11:43"
    },
    {
      "community_namenumber": "Community119",
        "nameperformed_on": "Admin Unit",2016-10-26T18:15:31"
    },
    {
      "descriptionnumber": "admin unit120",

       "idperformed_on": "1"2016-11-03T11:50:18"
    },
  },  {
      "udf_string_8number": null"137",
      "externalperformed_systemon": null"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)

String

The 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)

Date

The date that the customer event was actually performed

description

(optional)

String

A 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

...

Expand

title	Example 1

HTTP Method: POST

Request:

Body:

Code Block

language	javascript
theme	Confluence
language	javascript
linenumbers	true

 {
   "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",
   "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

language	javascript
theme	Confluence	language	javascript
linenumbers	true

 {
  "data": {
    "external_system_reference_number": null,
    "log_information": {
      "created_by_unit": {
        "alternative_code": "adminunit",
        "group_name": "Main Group",
        "community_name": "Community",
        "name": "Admin Unit",
        "description": "admin unit",
        "id": "1"
      },
      "updated_by_unit": {
        "alternative_code": "adminunit",
        "group_name": "Main Group",
        "community_name": "Community",
        "name": "Admin Unit",
        "description": "admin unit",
        "id": "1"
      },
      "created_date": "2016-10-07T09:20:12",
      "updated_date": "2016-10-07T09:20:12",
      "updated_by_user": {
        "person_name": "CRM COM",
        "id": "1",
        "username": "MPAdministrator"
      },
      "created_by_user": {
        "person_name": "CRM COM",
        "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": "2016-04-24T15:49:59",
    "type": "FINANCIAL_ACHIEVEMENT",
    "udf_date_1": "2016-03-24T15:49:59",
    "udf_date_4": "2016-06-24T15:49:59",
    "udf_date_3": "2016-05-24T15:49:59",
    "number": "94",
    "udf_float_3": 30,
    "udf_float_4": 40,
    "award_reward_transactions_set": null,
    "id": "79845A8FF2D3407B84BC593536BBBFBB",
    "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",
    "amount": 11.5,
    "product": {
      "code": "Bronze",
      "product_type": {
        "service_type": "TERMED",
        "used_for_provisioning": true,
        "alternative_code": "Main Packages",
        "composition_method": "FLAT",
        "name": "Main Packages",
        "description": null,
        "id": "E186E293AAAB49EE86A729540A4287FE",
        "classification": "SERVICES",
        "physical_good_type": null
      },
      "alternative_code": "B",
      "description": "Bronze",
      "id": "F50CC52934BD4F119B6E18E215A4FC55"
    },
    "udf_string_5": "udf string 5",
    "udf_string_1": "udf string 1",
    "accounts_receivable": {
      "number": "ACR0000000069",
      "name": "ACR0000000069 Polina Kestora",
      "id": "8C1E866074D743EE834E910A28C1E582",
      "life_cycle_state": "ACTIVE",
      "account_owner": {
        "company_profile": null,
        "company_name": null,
        "name": "Polina Kestora",
        "last_name": "Kestora",
        "id": "F038161F36C845B98CEE7361A8C92157",
        "life_cycle_state": "FINANCIAL",
        "middle_name": null,
        "title": null,
        "type": "PERSON",
        "first_name": "Polina",
        "demographics": {
          "name_day": {
            "month": 7,
            "day": 21
          },
          "id_number": "112233",
          "gender": null,
          "country_of_residence": {
            "alternative_code": "IRN",
            "three_character_code": null,
            "name": "IRAN (ISLAMIC REPUBLIC OF)",
            "id": "231",
            "two_character_code": null
          },
          "date_of_birth": {
            "month": 3,
            "year": 1988,
            "day": 4
          },
          "industry_sector": null,
          "passport_number": null,
          "industry": null,
          "social_security_number": null,
          "id_issued_by_country": null,
          "passport_issued_by_country": null
        }
      }
    },
    "life_cycle_state": "POSTED",
    "performed_on": "2016-10-07T15:00:00",
    "classification": {
      "alternative_code": "FA",
      "name": "Financial Achievement 1",
      "id": "39031C33C1AC4FB79140B27D1614CD6A"
    },
    "process_immediately": false,
    "payment_medium_type": {
      "alternative_code": "CC",
      "name": "CREDIT CARD",
      "description": null,
      "id": "68FAF1F833194091967F86B1AA352129"
    },
    "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",
      "id": "1"
    },
    "udf_string_8": "udf string 8",
    "external_system": null
  },
  "status": {
    "code": "OK",
    "description": "",
    "message": ""
  }
}

...

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

...

Expand

title	Example 1

HTTP Method: POST

Request:

Body:

Code Block

language	js
theme	Confluence
language	js
linenumbers	true

{
"token":"{{token}}",
"customer_event_identifier":{"id":"79845A8FF2D3407B84BC593536BBBFBB"}
}

Response:

Code Block

language	javascript
theme	Confluence	language	javascript
linenumbers	true

 {
  "data": {
    "external_system_reference_number": null,
    "log_information": {
      "created_by_unit": {
        "alternative_code": "adminunit",
        "group_name": "Main Group",
        "community_name": "Community",
        "name": "Admin Unit",
        "description": "admin unit",
        "id": "1"
      },
      "updated_by_unit": {
        "alternative_code": "adminunit",
        "group_name": "Main Group",
        "community_name": "Community",
        "name": "Admin Unit",
        "description": "admin unit",
        "id": "1"
      },
      "created_date": "2016-10-07T09:20:12",
      "updated_date": "2016-10-07T09:23:24",
      "updated_by_user": {
        "person_name": "CRM COM",
        "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": null,
    "type": "FINANCIAL_ACHIEVEMENT",
    "udf_date_1": null,
    "udf_date_4": null,
    "udf_date_3": null,
    "number": "94",
    "udf_float_3": null,
    "udf_float_4": null,
    "award_reward_transactions_set": null,
    "id": "79845A8FF2D3407B84BC593536BBBFBB",
    "udf_float_1": null,
    "udf_float_2": null,
    "udf_string_2": null,
    "udf_string_3": null,
    "udf_string_4": null,
    "amount": 11.5,
    "product": {
      "code": "Bronze",
      "alternative_code": "B",
      "description": "Bronze",
      "id": "F50CC52934BD4F119B6E18E215A4FC55"
    },
    "udf_string_5": null,
    "udf_string_1": null,
    "accounts_receivable": {
      "number": "ACR0000000069",
      "name": "ACR0000000069 Polina Kestora",
      "id": "8C1E866074D743EE834E910A28C1E582",
      "life_cycle_state": "ACTIVE",
      "account_owner": {
        "company_profile": null,
        "company_name": null,
        "name": "Polina Kestora",
        "last_name": "Kestora",
        "id": "F038161F36C845B98CEE7361A8C92157",
        "life_cycle_state": "FINANCIAL",
        "middle_name": null,
        "title": null,
        "type": "PERSON",
        "first_name": "Polina",
        "demographics": {
          "name_day": {
            "month": 7,
            "day": 21
          },
          "id_number": "112233",
          "gender": null,
          "country_of_residence": {
            "alternative_code": "IRN",
            "three_character_code": null,
            "name": "IRAN (ISLAMIC REPUBLIC OF)",
            "id": "231",
            "two_character_code": null
          },
          "date_of_birth": {
            "month": 3,
            "year": 1988,
            "day": 4
          },
          "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-10-07T15:00:00",
    "classification": {
      "alternative_code": "FA",
      "name": "Financial Achievement 1",
      "id": "39031C33C1AC4FB79140B27D1614CD6A"
    },
    "process_immediately": false,
    "payment_medium_type": {
      "alternative_code": "CC",
      "name": "CREDIT CARD",
      "description": null,
      "id": "68FAF1F833194091967F86B1AA352129"
    },
    "payment_medium_identifier": "PI000002",
    "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 24

New Version Current

Key

GET customer_events/financial_achievements/show

Resource URL

Parameters

Restrictions

Response Data

Examples

GET customer_events/financial_achievements/show

Resource URL

Parameters

Restrictions

Response Data

Examples

POST customer_events/financial_achievements/list

Resource URL

Parameters

Restrictions

Response Data

Examples

POST customer_events/financial_achievements/list

Resource URL

Parameters

Restrictions

Response Data

Examples

POST customer_events/financial_achievements/create

Resource URL

Parameters

Restrictions

POST customer_events/financial_achievements/cancel

Resource URL

Parameters

Response Data

Page Comparison

Versions Compared

Old Version 24

New Version Current

Key

GET customer_events/financial_achievements/show

Resource URL

Parameters

Restrictions

Response Data

Examples

GET customer_events/financial_achievements/show

Resource URL

Parameters

Restrictions

Response Data

Examples

POST customer_events/financial_achievements/list

Resource URL

Parameters

Restrictions

Response Data

Examples

POST customer_events/financial_achievements/list

Resource URL

Parameters

Restrictions

Response Data

Examples

POST customer_events/financial_achievements/create

Resource URL

Parameters

Restrictions

POST customer_events/financial_achievements/cancel

Resource URL

Parameters

Response Data