Tip
Available from CRM.COM R10.0.0

Table of Contents

maxLevel	2

...

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

...

Expand

title	Example 1

HTTP Method: GET

Request:

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

 {
  "statusdata": {
    "messageexternal_system_reference_number": ""null,
    "descriptionlog_information": "",{
      "codecreated_by_unit": "OK"
  },{
  "data": {     "udfalternative_float_1code": null"adminunit",
    "udf_float_2": null,     "udfgroup_float_3name": null"Main Group",

   "udf_float_4": null,     "numbercommunity_name": "2Community",
    "payment_medium_type": {       "idname": "0EC912D6358341B4BAE55CFA70FE0F2DAdmin Unit",
        "namedescription": "Creditadmin Cardunit",
      "description": "Payment Medium Type 1: Credit Card",
      "alternative_code": "CC"
    },
    "udf_string_1": null,"id": "1"
     "udf_string_2": null,
    "udf_string_3": null,
    "udf_string_4": null, },
      "udfupdated_string_5": null,
    "udf_string_6": null,
    "udf_string_7": null,
    "udf_string_8": null,
    "accounts_receivable": {
      "account_owner": {
        "last_name": "Mercer",
        "middle_name": "111111111",
        "life_cycle_state": "FINANCIAL",
        "company_profile": null,
        "title": "Mr",
        "first_name": "Ben11 omonoia",
        "type": "PERSON",
        "id": "475904FB959FE8D3DDAEB22FBFEC5FFB",
        "name": "Mercer Ben11 omonoia",
        "company_name": null,
        "demographics": {
          "gender": "MALE",
          "passport_issued_by_country": {
            "three_character_code": "AND",
            "two_character_code": "AD",
            "id": "132",
            "name": "ANDORRA",
            "alternative_code": null
          },
          "social_security_number": null,
          "passport_number": null,
          "industry_sector": null,
          "country_of_residence": {
            "three_character_code": "USA",
            "two_character_code": "US",
            "id": "127",
            "name": "UNITED STATES",
            "alternative_code": null
          },
          "name_day": {
            "month": 6,
 by_unit": {
          "dayalternative_code": 14"adminunit",
        "group_name": "Main }Group",
 
        "datecommunity_of_birthname": {
  "Community",
         "monthname": "Admin 11Unit",

           "daydescription": 9,
   "admin unit",
        "yearid": 1963"1"
      },
   },   "created_date": "2016-10-07T08:59:11",
      "idupdated_numberdate": "12121252016-10-07T08:59:26",
          "industry"updated_by_user": {

           "id"person_name": "31BC2070C79EAE5455BFAD41599C5190MPAdministrator",

           "nameid": "Marketing11",
            "codeusername": "MKMPAdministrator"
          },
          "id_issued"created_by_countryuser": {
   
        "threeperson_character_codename": "DZAMPAdministrator",
  
         "two_character_codeid": "DZ1",

           "idusername": "130",MPAdministrator"
      }
    },
    "namepayment_medium_brand": "ALGERIA"null,
    "description": null,
      "alternativeudf_date_code2": null,
    "type": "FINANCIAL_ACHIEVEMENT",
     }"udf_date_1": null,
    "udf_date_4": null,
  }  "udf_date_3": null,
   }, "number": "92",
    "lifeudf_cyclefloat_state3": null,
    "ACTIVE",
 udf_float_4": null,
    "numberaward_reward_transactions_set": "162"null,
 
    "id": "3C66BD54CCDB6BC1096C23F6D8899752328B8B0AF30041169B889F4A39D774B7",
 
    "nameudf_float_1": "Bennull,
Mercer 1"     }"udf_float_2": null,
    "paymentudf_mediumstring_brand2": {
 null,
    "idudf_string_3": "A01DB55EE5624E80ADA3CD7AF166AF30"null,
      "name"udf_string_4": "AMERICAN EXPRESS"null,

     "descriptionamount": "Payment Medium Brand 2: American Express",
10,
     "alternative_codeproduct": "AE"
    }null,
    "idudf_string_5": "82D51001E9FF458E896D486897AAAD94"null,
    "awardudf_rewardstring_transactions_set1": null,
    "classificationaccounts_receivable": {
      "idnumber": "7CC02035F12448258ECFD3F9E22C23DDACR0000000069",
      "name": "FinancialACR0000000069 Polina AchievementKestora",
      "alternative_codeid": "FA"
    },
    "udf_date_1": null,8C1E866074D743EE834E910A28C1E582",
      "udflife_datecycle_2state": null"ACTIVE",
      "udfaccount_date_3owner": null, {
        "udfcompany_date_4profile": null,
        "performedcompany_by_unitname": null,
 {       "community_name": "InternalPolina CommunityKestora",
        "idlast_name": "48305F8849E3C18B227C5BE3A27BA6DFKestora",
        "nameid": "Admin UnitF038161F36C845B98CEE7361A8C92157",
        "grouplife_cycle_namestate": "Main GroupFINANCIAL",
        "descriptionmiddle_name": "r1null,
Test Description for resource  request tab.Test Description for resource  request tab.","title": null,
        "alternative_codetype": "MGPERSON",
    },     "processfirst_immediatelyname": 0"Polina",
        "productdemographics": {
          "productname_type": {day": {
            "service_typemonth": null7,
            "physical_good_typeday": "NONTRACEABLE",21
         "used_for_provisioning": false },
          "classificationid_number": "PHYSICALGOODS112233",
          "composition_methodgender": "FLAT"null,
          "idcountry_of_residence": "1FFC6C62DABA4C7BAA3536C24104E58A", {
            "namealternative_code": "Software ProductIRN",
          "description  "three_character_code": null,
            "alternative_codename": "SP_1"IRAN (ISLAMIC REPUBLIC OF)",
      },       "id": "6F5CCD94E04D1CCBF8F2A090588280C9231",
            "descriptiontwo_character_code": "Basic: Local + Documentaries\r\n\r\nUsed for API unit testing, please do not modify.", null
          },
          "codedate_of_birth": "Product{
A",       "alternative_code": "P"    "month": }3,
    "log_information": {       "updated_dateyear": "2016-06-28T11:10:08"1988,
      "created_date": "2016-06-28T11:09:30",       "created_by_unit"day": {4
        "community_name": "Internal Community"},
          "idindustry_sector": "48305F8849E3C18B227C5BE3A27BA6DF"null,
          "namepassport_number": "Admin Unit",null,
          "group_nameindustry": "Main Group",null,
          "descriptionsocial_security_number": null,
"r1  Test Description for resource  request tab.Test Description for resource  request tab.", "id_issued_by_country": null,
          "alternative_codepassport_issued_by_country": "MG"null
        },
      "updated_by_unit": {}
    },
    "communitylife_cycle_namestate": "Internal CommunityPOSTED",
  
     "idperformed_on": "48305F8849E3C18B227C5BE3A27BA6DF2016-10-07T08:59:11",
    "classification": {
  "name    "alternative_code": "Admin UnitFA",
 
      "group_name": "MainFinancial Achievement Group1",
 
      "descriptionid": "r139031C33C1AC4FB79140B27D1614CD6A"
Test Description for resource },
request tab.Test Description for resource  request tab.",
    "process_immediately": false,
    "payment_medium_type": null,
    "alternativepayment_medium_codeidentifier": "MG" null,
        },
"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": "MPAdministratorAdmin Unit",
 
      "usernamedescription": "MPAdministratoradmin unit",
        "id": "1"
    },
 }     }"udf_string_8": null,
    "lifeexternal_cycle_statesystem": "POSTED",null
  },
  "payment_medium_identifierstatus": "PI_0001",{
    "typecode": "FINANCIAL_ACHIEVEMENTOK",
    "description": "New Financial Achiemenet C.E.",
    "performed_onmessage": "2016-06-28T11:09:30"
  }
}

POST customer_events/financial_achievements/list

...

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
	V4:rewards_participants_identifier

accounts_receivable_identifier

(semi-optional)

Accounts Receivable Identifier

The identifier of the accounts receivable related with the customer events that should be retrieved. The allowed accounts receivable identifier fields are the following:

Include Page

	V4:accounts_receivable_identifier
	V4:accounts_receivable_identifier

classification_identifier

(semi-optional)

Customer Event Classification Identifier

The identifier of the classification related with the customer events that should be retrieved. Only financial achievement classifications are allowed to be specified. The allowed customer event classification identifier fields are the following:

Include Page

	V4:customer_event_classification_identifier
	V4:customer_event_classification_identifier

fields_set

(optional)

List of Strings, comma separated

A list of fields that should be included in the results. If not specified then all the available fields will be returned

...

Name

Type

Description

token

String

The token retrieved from the login method

accounts_receivable_identifier

(semi-optional)

Accounts receivable Identifier

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

Include Page

	V4:accounts_receivable_identifier
	V4:accounts_receivable_identifier

rewards_participant_identifier

(semi-optional)

Rewards Participant Identifier

The related rewards participant. The allowed rewards participant identifier fields are the following:

Include Page

	V4:rewards_participants_identifier
	V4:rewards_participants_identifier

classification_identifier

(mandatory)

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