Page Comparison

...

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

Excerpt
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": ""
  }
}

...

Versions Compared

Old Version 3

New Version Current

Key

Resource URL

Parameters

Restrictions