Page Comparison

...

This method is used to create a purchase 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:

...

Tip
From CRM.COM R15.0.0, access_token_identifier is supported

...

rewards_participant_identifier

(semi-optional)

...

classification_identifier

(optional)

...

performed_by_unit_identifier

(mandatory)

...

performed_on

(mandatory)

...

description

(optional)

...

process_immediately

(optional)

...

Defines if the customer event was processed immediately by various business processes or not

...

Excerpt
This method is used to create a purchase customer event in a posted life cycle state

Resource URL

Parameters

...

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

Request:

Body:

...

theme	Confluence
language	javascript
linenumbers	true

...

Name

Type

Description

token

String

The token retrieved from the login method

accounts_receivable_identifier

(mandatory)

Accounts receivable Identifier

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

Include Page

	V4:accounts_receivable_identifier_post
	V4:accounts_receivable_identifier_post

Tip
From CRM.COM R15.0.0

reference_number

(mandatory)

StringThe reference number of the retrieved purchase customer event

payment_medium_brand_identifier

(optional)

Payment Medium Brand IdentifierThe identifier of the payment medium brand with which the purchase customer event has been made. The allowed payment medium brand identifier fields are the following:

, access_token_identifier is supported

For releases prior CRM.COM R17.0.0, this field was semi-optional

rewards_participant_identifier

(semi-optional)

Rewards Participant Identifier

The related rewards participant. The allowed fields are the following

Include Page

	V4:

payment

rewards_

medium

participants_

brand

identifier_

identifier

post
	V4:

payment

rewards_

medium

participants_

brand

identifier_

identifier

post

Tip

Available

Deprecated from CRM.COM

R10

R17.0.0

payment_medium_type

classification_identifier

(optional)

Payment Medium Type

Customer Event Classification Identifier

The

payment medium type with which the purchase

classification of the customer event

has been made

. The allowed

payment medium type

identifier fields are the following

:

Include Page

	V4:

payment

customer_

medium

event_

type

classification_identifier
	V4:

payment

customer_

medium

event_

typepayment_medium

classification_identifier

Tip
Available from CRM.COM R10.0.0

performed_by_business_unit_identifier

(semi-optional)

String

Business Unit Identifier

The

payment medium identifier with which the purchase customer event has been made

business unit that initiated the customer event. The allowed identifier fields are the following

Include Page

	V4:business_unit_identifier
	V4:business_unit_identifier

Tip
Available from CRM.COM

R10

R18.0.0

external_system Include PageV4:access_token_identifierV4:access_token

performed_by_unit_identifier

(semi-optional)

String

Defines the third party system that generates the purchase customer event

Tip
Available from CRM.COM R10.0.0

external_system_reference_number

(optional)

String

Defines the reference number that uniquely identifies the purchase customer event in the external system

Tip
Available from CRM.COM R10.1.0

authorized_by_access_token_identifier

(optional)

Access Token Identifier

The access token that was used to identify and authorized the customer. This information will be overridden if the customer was identified via an access token through this Web API call. The allowed access token identifier fields are the following:

Unit Identifier

The unit that initiated the customer event. The allowed identifier fields are the following

Include Page

	V4:unit_identifier
	V4:unit_identifier

Tip

For releases prior CRM.COM R17.0.0, this attribute was mandatory

From CRM.COM R17.0.0, this attribute will be set automatically if the performed_by_tap_identifier is specified

Deprecated from CRM.COM R18.0.0

performed_by_tap_identifier

(semi-optional)

Transaction Acquiring Point Identifier

The unit's transaction acquiring point that initiated the customer event. The allowed identifier fields are the following

Include Page

	V4:transaction_acquiring_point_identifier
	V4:transaction_acquiring_point_identifier

Tip
Available from CRM.COM

R15

promo_code

(optional)

String

The effective, not expired promo code that can be used on the customer event. The promo code is validated against its related promotion campaign's settings in order to be provided.

Tip
Available from CRM.COM R15.0.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_string_9

(optional)

StringUser Defined Field of type String

R17.0.0

invoice_identifier

(optional)

Invoice IdentifierThe CRM.COM invoice related with the purchase. The allowed invoice identifier fields are the following:
Include PageV4:invoice_identifierV4:invoice_identifier

intended_currency_identifier

(optional)

Currency Identifier

The currency that the user was intended to use for the customer event. If specified then it is validated against the currency of the related performed by unit (i.e. the default currency) and if they don't match then an error is throw. Note that the intended currency is not saved within CRM.COM; it is just used for validation purposes. The allowed currency identifier fields are the following:

Include PageV4:currency_identifierV4:currency_identifier

Tip
Available from CRM.COM R11.0.0

From CRM.COM R17.0.0, this attribute will be set automatically if the performed_by_unit_identifier is specified

From CRM.COM R18.0.0, this attribute will be set automatically if the performed_by_business_unit_identifier is specified

performed_on

(mandatory)

Date

The date that the customer event was actually performed

description

(optional)

String

A description of the customer event

process_immediately

(optional)

Boolean

Defines if the customer event was processed immediately by various business processes or not

Tip
Deprecated from CRM.COM R15.0.0

reference_number

(mandatory)

String

The reference number of the retrieved purchase customer event

payment_medium_brand_identifier

(optional)

Payment Medium Brand Identifier

The identifier of the payment medium brand with which the purchase customer event has been made.

If this parameter is not specified and accounts receivable identified is made against an access token of a credit card authentication code, then this attribute will be set as the default medium brand as specified in the related access token classification

The allowed payment medium brand identifier fields are the following:

Include Page

	V4:payment_medium_brand_identifier
	V4:payment_medium_brand_identifier

Tip
Available from CRM.COM R10.0.0

payment_medium_type_identifier

(optional)

Payment Medium Type Identifier

The payment medium type with which the purchase customer event has been made.

If this parameter is not specified and accounts receivable identified is made against an access token of a credit card authentication code, then this attribute will be set as the default medium type as specified in the related access token classification

The allowed payment medium type identifier fields are the following:

Include Page

	V4:payment_medium_type_identifier
	V4:payment_medium_type_identifier

Tip
Available from CRM.COM R10.

1

0.0

udf

payment_

string

medium_

10

identifier

(optional)

String

User Defined Field of type String

The payment medium identifier with which the purchase customer event has been made

Tip
Available from CRM.COM R10.

1

0.0

udf

external_

string_11

system

(optional)

String

User Defined Field of type String

Defines the third party system that generates the purchase customer event

Tip
Available from CRM.COM R10.

1

0.0

udf

external_system_

string

reference_

12

number

(optional)

String

User Defined Field of type String

Defines the reference number that uniquely identifies the purchase customer event in the external system

Tip
Available from CRM.COM R10.1.0

udf_string_13

authorized_by_access_token_identifier

(optional)

String

User Defined Field of type String

Access Token Identifier

The access token that was used to identify and authorized the customer. This information will be overridden if the customer was identified via an access token through this Web API call. The allowed access token identifier fields are the following:

Include Page

	V4:access_token_identifier
	V4:access_token_identifier

Tip
Available from CRM.COM

R10

R15.

1

User Defined Field of type String

TipAvailable from CRM.COM R10.1

0.0

udf_string_14

(optional)

String

Deprecated from CRM.COM R18.0.0

udf

invoice_

string_15

User Defined Field of type String

TipAvailable from

identifier

(optional)

String

Invoice Identifier

The CRM.COM

R10.1.0

udf_string_16

(optional)

String

User Defined Field of type String

Tip
Available from CRM.COM R10.1.0

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

invoice related with the purchase. The allowed invoice identifier fields are the following:

Include Page

	V4:invoice_identifier
	V4:invoice_identifier

intended_currency_identifier

(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

products_set

(mandatory)

Set of Purchase Product ObjectsThe purchased products, along with the total amount, net amount and VAT amount for each product

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.0

...

Currency Identifier

The currency that the user was intended to use for the customer event. If specified then it is validated against the currency of the related performed by unit (i.e. the default currency) and if they don't match then an error is thrown. Note that the intended currency is not saved within CRM.COM; it is just used for validation purposes. The allowed currency identifier fields are the following:

Include Page

	V4:currency_identifier
	V4:currency_identifier

Tip
Available from CRM.COM R11.0.0

promo_code

(optional)

String

The effective, not expired promo code that can be used on the customer event. The promo code is validated against its related promotion campaign's settings in order to be provided.

Tip
Available from CRM.COM R15.0.0

disable_instant_spend

(optional)

Boolean

It determines if instant spend offers should be disabled (i.e. not applied) or not. By default all instant spend offers are applied if their conditions are met.

Tip
Available from CRM.COM R14.4.0

terminal_identifier

(optional)

String

An identifier of the terminal that submitted the purchase customer event

Tip
Available from CRM.COM R15.1.0

total_discount_amount

(optional)

Number

The total discount amount on the purchase customer event

Tip
Available from CRM.COM R16.10.0 and CRM.COM R17.9.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_string_9

(optional)

String

User Defined Field of type String

Tip
Available from CRM.COM R10.1.0

udf_string_10

(optional)

String

User Defined Field of type String

Tip
Available from CRM.COM R10.1.0

udf_string_11

(optional)

String

User Defined Field of type String

Tip
Available from CRM.COM R10.1.0

udf_string_12

(optional)

String

User Defined Field of type String

Tip
Available from CRM.COM R10.1.0

udf_string_13

(optional)

String

User Defined Field of type String

Tip
Available from CRM.COM R10.1.0

udf_string_14

(optional)

String

User Defined Field of type String

Tip
Available from CRM.COM R10.1.0

udf_string_15

(optional)

String

User Defined Field of type String

Tip
Available from CRM.COM R10.1.0

udf_string_16

(optional)

String

User Defined Field of type String

Tip
Available from CRM.COM R10.1.0

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

spend_request

(optional)

Spend Request Object

Information related with the spend request that should be created as part of the purchase customer event

Tip
Available from CRM.COM R17.0.0

products_set

(mandatory)

Set of Purchase Product Objects

The purchased products, along with the total amount, net amount and VAT amount for each product

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.0

Anchor
create purchase customer event referred parameters
create purchase customer event referred parameters
Referred Parameter Objects

Include Page

	V4:purchase_customer_event_spend_request_parameters
	V4:purchase_customer_event_spend_request_parameters

Include Page

	V4:purchase_customer_event_product_parameters
	V4:purchase_customer_event_product_parameters

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

Examples

Expand

title	Example 1

HTTP Method: POST

Request:

Body:

Code Block

language	javascript
theme	Confluence
linenumbers	true

{
   "token":"{{token}}",
   "accounts_receivable_identifier":{"number":"162"},
   "classification_identifier":{"name":"Purchase"},
   "performed_by_unit_identifier":{"name":"Admin Unit"},
   "performed_on":"2016-06-22T15:00:00",
   "description":"Testing creation of purchase event",
   "process_immediately":1,
   "reference_number":"RF000001",
   "total_amount":235,
   "net_amount":210,
   "vat_amount":25,
   "invoice_identifier":{"number":"I00000278"},
   "payment_medium_brand_identifier":{"name":"VISA"},
   "payment_medium_type_identifier":{"alternative_code":"CC"},
   "payment_medium_identifier":"PI000001",
   "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",
   "products_set":
   [
     {
       "product_identifier":{"code":"Serendipity"},
       "total_amount":60,
       "net_amount":50,
       "vat_amount":10
     },
     {
       "product_identifier":{"code":"Bronze"},
       "total_amount":180,
       "net_amount":160,
       "vat_amount":20
     }
   ]
 }

Response:

Code Block

language	javascript
theme	Confluence
linenumbers	true

{
  "status": {
    "message": "",
    "description": "",
    "code": "OK"
  },
  "data": {
    "udf_float_1": 10,
    "products_set": [
      {
        "total_amount": 180,
        "net_amount": 160,
        "id": "BAA0402F670744E5AD3C65C59052F318",
        "quantity": 1,
        "vat_amount": 20,
        "product": {
          "product_type": {
            "service_type": "TERMED",
            "physical_good_type": null,
            "used_for_provisioning": true,
            "classification": "SERVICES",
            "composition_method": "FLAT",
            "id": "B18BD7B80DEF66E61ED3FBE4523F5383",
            "name": "Termed  - Flat",
            "description": "Termed - Flat",
            "alternative_code": "TS"
          },
          "id": "CAD1E31269B76D7A65ACCE45B2E68DFD",
          "description": "Bronze Premium Package",
          "code": "Bronze",
          "alternative_code": "BP"
        }
      },
      {
        "total_amount": 60,
        "net_amount": 50,
        "id": "BE28ECA140834D92B8E9038DE8A95FE8",
        "quantity": 1,
        "vat_amount": 10,
        "product": {
          "product_type": {
            "service_type": "USAGE",
            "physical_good_type": "NONTRACEABLE",
            "used_for_provisioning": true,
            "classification": "SERVICES",
            "composition_method": "FLAT",
            "id": "78F758444F6B8437F1A27F61D1BE84A5",
            "name": "VOD",
            "description": "Video on Demand Movies",
            "alternative_code": "VOD"
          },
          "id": "02192DC60AF606C2124118AABCBFAAAA",
          "description": "Serendipity",
          "code": "Serendipity",
          "alternative_code": "SRDP"
        }
      }
    ],
    "udf_float_2": 20,
    "udf_float_3": 30,
    "udf_float_4": 40,
    "number": "849",
    "payment_medium_type": {
      "id": "0EC912D6358341B4BAE55CFA70FE0F2D",
      "name": "Credit Card",
      "description": "Payment Medium Type 1: Credit Card",
      "alternative_code": "CC"
    },
    "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",
    "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,
            "day": 14
          },
          "date_of_birth": {
            "month": 11,
            "day": 9,
            "year": 1963
          },
          "id_number": "1212125",
          "industry": {
            "id": "31BC2070C79EAE5455BFAD41599C5190",
            "name": "Marketing1",
            "code": "MK"
          },
          "id_issued_by_country": {
            "three_character_code": "DZA",
            "two_character_code": "DZ",
            "id": "130",
            "name": "ALGERIA",
            "alternative_code": null
          }
        }
      },
      "life_cycle_state": "ACTIVE",
      "number": "162",
      "id": "3C66BD54CCDB6BC1096C23F6D8899752",
      "name": "Ben Mercer 1"
    },
    "payment_medium_brand": {
      "id": "F7B18DE5D55E452C81AF6F1EAD3E934C",
      "name": "VISA",
      "description": "Payment Medium Brand 1: Visa",
      "alternative_code": "V"
    },
    "id": "01B0FD5A49814677BBF15662482C39FE",
    "award_reward_transactions_set": [],
    "classification": {
      "id": "2164EF87DBAB4225ACC81CE90712933A",
      "name": "Purchase",
      "alternative_code": "P"
    },
    "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",
    "invoice": {
      "issued_on": "2014-10-24T16:15:15",
      "total_amount": 133,
      "life_cycle_state": "POSTED",
      "unsettled_amount": 0,
      "number": "I00000278",
      "due_on": "2014-11-03T16:15:15",
      "id": "470154904D2B2E0107F58A0330609D63",
      "reference_number": "325",
      "outstanding_amount": 0,
      "posted_on": "2014-10-24T16:15:15"
    },
    "performed_by_unit": {
      "community_name": "Internal Community",
      "id": "48305F8849E3C18B227C5BE3A27BA6DF",
      "name": "Admin Unit",
      "group_name": "Main Group",
      "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
      "alternative_code": "MG"
    },
    "vat_amount": 30,
    "process_immediately": 1,
    "log_information": {
      "updated_date": "2016-06-22T15:37:00",
      "created_date": "2016-06-22T15:37:00",
      "created_by_unit": {
        "community_name": "Internal Community",
        "id": "48305F8849E3C18B227C5BE3A27BA6DF",
        "name": "Admin Unit",
        "group_name": "Main Group",
        "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
        "alternative_code": "MG"
      },
      "updated_by_unit": {
        "community_name": "Internal Community",
        "id": "48305F8849E3C18B227C5BE3A27BA6DF",
        "name": "Admin Unit",
        "group_name": "Main Group",
        "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
        "alternative_code": "MG"
      },
      "created_by_user": {
        "person_name": "Marios Lannister",
        "username": "MPAdministrator",
        "id": "1",
        "email": "sakkascy1986@hotmail.com"
      },
      "updated_by_user": {
        "person_name": "Marios Lannister",
        "username": "MPAdministrator",
        "id": "1",
        "email": "sakkascy1986@hotmail.com"
      }
    },
    "total_amount": 240,
    "life_cycle_state": "POSTED",
    "net_amount": 210,
    "payment_medium_identifier": "PI000001",
    "type": "PURCHASE",
    "description": "Testing creation of purchase event",
    "reference_number": "RF000001",
    "performed_on": "2016-06-22T15:00:00"
  }
}

Expand

title	Example 3

HTTP Method: POST

Request:

Body:

Code Block

language	javascript
theme	Confluence
linenumbers	true

{
   "token":"{{token}}",
   "rewards_participant_identifier":{"number":"RP0000000019"},
   "performed_by_unit_identifier":{"name":"Admin Unit"},
   "performed_on":"2017-07-12T15:00:00",
   "description":"Applying Interactive Reward Offers, considering the Spend Method",
   "process_immediately":1,
   "reference_number":"RF000001",
   "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":"2014-05-05T15:49:59",
   "udf_date_2":"2014-06-05T15:49:59",
   "udf_date_3":"2014-07-05T15:49:59",
   "udf_date_4":"2014-08-05T15:49:59",
   "products_set":
   [
     {
       "product_identifier":{"code":"PK_SmartCard"},
       "total_amount":11,
       "net_amount":11,
       "vat_amount":0
     }
   ]
 }

Response:

Code Block

language	javascript
theme	Confluence
linenumbers	true

{
  "status": {
    "message": "",
    "description": "",
    "code": "OK"
  },
  "data": {
    "udf_float_1": 10,
    "products_set": [
      {
        "total_amount": 11,
        "net_amount": 11,
        "id": "8230752E72814A48A886806228FBB61D",
        "quantity": 1,
        "vat_amount": 0,
        "product": {
          "product_type": {
            "service_type": null,
            "physical_good_type": "TRACEABLE",
            "used_for_provisioning": false,
            "classification": "PHYSICALGOODS",
            "composition_method": "FLAT",
            "id": "7FC0F87C40C74ABCA19F1CA870E51687",
            "name": "PK_Product Type_SB3",
            "description": null,
            "alternative_code": "PT_2"
          },
          "id": "2ED97CB3DC0141C5B8316525B9D54AB7",
          "description": "PK_SmartCard",
          "code": "PK_SmartCard",
          "alternative_code": "P_8"
        }
      }
    ],
    "udf_float_2": 20,
    "udf_float_3": 30,
    "udf_float_4": 40,
    "number": "336",
    "payment_medium_type": null,
    "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",
    "instant_spend_request": {
      "classification": null,
      "number": "72",
      "performed_by_unit": {
        "id": "1",
        "name": "Admin Unit",
        "description": "admin unit",
        "alternative_code": "adminunit"
      },
      "process_immediately": 1,
      "spend_reward_transaction": {
        "total_amount": 5,
        "life_cycle_state": "POSTED",
        "rewards_participant": {
          "accounts_receivable": {
            "account_owner": {
              "last_name": "Kestora",
              "middle_name": null,
              "life_cycle_state": "FINANCIAL",
              "company_profile": null,
              "title": null,
              "first_name": "Polina",
              "type": "PERSON",
              "id": "F038161F36C845B98CEE7361A8C92157",
              "name": "Polina Kestora",
              "company_name": null,
              "demographics": {
                "gender": "FEMALE",
                "passport_issued_by_country": null,
                "social_security_number": null,
                "passport_number": null,
                "industry_sector": null,
                "country_of_residence": {
                  "three_character_code": null,
                  "two_character_code": null,
                  "id": "231",
                  "name": "IRAN (ISLAMIC REPUBLIC OF)",
                  "alternative_code": "IRN"
                },
                "name_day": {
                  "month": null,
                  "day": null
                },
                "date_of_birth": {
                  "month": 3,
                  "day": 4,
                  "year": 1988
                },
                "id_number": "112233",
                "industry": null,
                "id_issued_by_country": null
              }
            },
            "life_cycle_state": "ACTIVE",
            "number": "ACR0000000164",
            "id": "C6CBAC948E53498F83FF52E6CD8B7221",
            "name": "ACR0000000164 Polina Kestora"
          },
          "number": "RP0000000019",
          "id": "EA95AA28BE1F4C8B9C983487278210D3"
        },
        "number": "57",
        "net_amount": 5,
        "id": "A3CB8C42085B43BB9F98C50D4580E961",
        "vat_amount": 0
      },
      "log_information": {
        "updated_date": "2016-07-14T09:38:54",
        "created_date": "2016-07-14T09:38:54",
        "created_by_unit": {
          "id": "1",
          "name": "Admin Unit",
          "description": "admin unit",
          "alternative_code": "adminunit"
        },
        "updated_by_unit": {
          "id": "1",
          "name": "Admin Unit",
          "description": "admin unit",
          "alternative_code": "adminunit"
        },
        "created_by_user": {
          "person_name": "MPAdministrator",
          "username": "MPAdministrator",
          "id": "1"
        },
        "updated_by_user": {
          "person_name": "MPAdministrator",
          "username": "MPAdministrator",
          "id": "1"
        }
      },
      "life_cycle_state": "POSTED",
      "accounts_receivable": {
        "account_owner": {
          "last_name": "Kestora",
          "middle_name": null,
          "life_cycle_state": "FINANCIAL",
          "company_profile": null,
          "title": null,
          "first_name": "Polina",
          "type": "PERSON",
          "id": "F038161F36C845B98CEE7361A8C92157",
          "name": null,
          "company_name": null,
          "demographics": {
            "gender": "FEMALE",
            "passport_issued_by_country": null,
            "social_security_number": null,
            "passport_number": null,
            "industry_sector": null,
            "name_day": {
              "month": null,
              "day": null
            },
            "date_of_birth": {
              "month": 3,
              "day": 4,
              "year": 1988
            },
            "id_number": "112233",
            "industry": null,
            "id_issued_by_country": null
          }
        },
        "life_cycle_state": "ACTIVE",
        "number": "ACR0000000164",
        "id": "C6CBAC948E53498F83FF52E6CD8B7221",
        "name": "ACR0000000164 Polina Kestora"
      },
      "spend_amount": 5,
      "type": "SPEND_REQUEST",
      "id": "B49F7C337870455C9931C067DF6B3E80",
      "description": null,
      "performed_on": "2016-07-14T09:38:54"
    },
    "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,
    "udfaccounts_float_5receivable":50, {
      "udfaccount_float_6owner":60, {
        "udflast_float_7name":70, "Kestora",
        "udfmiddle_float_8name":80 null,
        "udflife_datecycle_1state":"2016-03-24T15:49:59", "FINANCIAL",
        "udfcompany_date_2":"2016-04-24T15:49:59"profile": null,
   "udf_date_3":"2016-05-24T15:49:59"     "title": null,
        "udf_date_4":"2016-06-24T15:49:59",
   "products_set":first_name": "Polina",
   [      {"type": "PERSON",
        "product_identifierid":{ "codeF038161F36C845B98CEE7361A8C92157":"Serendipity"},
        "total_amountname":60 "Polina Kestora",
        "netcompany_amountname":50 null,
        "vat_amountdemographics":10 {
     },      {"gender": "FEMALE",
          "product_identifier":{"code":"Bronze"},passport_issued_by_country": null,
          "totalsocial_security_amountnumber":180 null,
          "netpassport_amountnumber":160 null,
          "vatindustry_amountsector":20 null,
    }    ]
 }

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
  "status": {  "country_of_residence": {
            "messagethree_character_code": ""null,
      "description": "",     "two_character_code": null,
"OK"   },   "data": {     "udf_float_1id": 10,"231",
         "products_set   "name": ["IRAN (ISLAMIC REPUBLIC OF)",
   {         "totalalternative_amountcode": 180,"IRN"
         "net_amount": 160, },
          "idname_day": "BAA0402F670744E5AD3C65C59052F318",{
            "quantitymonth": 1null,
            "vat_amountday": 20,null
         "product": { },
          "productdate_of_typebirth": {
            "service_type": "TERMED"month": 3,
            "physical_good_typeday": null4,
            "used_for_provisioningyear": true,1988
            "classification": "SERVICES"},
            "compositionid_methodnumber": "FLAT112233",
            "idindustry": "B18BD7B80DEF66E61ED3FBE4523F5383"null,
            "name": "Termed  - Flat","id_issued_by_country": null
        }
      },
      "descriptionlife_cycle_state": "ACTIVE"Termed,
- Flat",     "number": "ACR0000000164",
      "alternative_codeid": "TSC6CBAC948E53498F83FF52E6CD8B7221",
      "name": "ACR0000000164 Polina Kestora"
    },
    "payment_medium_brand": null,
    "id": "CAD1E31269B76D7A65ACCE45B2E68DFDAC062E7AD94A401B8D8153F1CD28FB58",
    "award_reward_transactions_set": [
    "description": "Bronze Premium Package",  {
        "codelife_cycle_state": "BronzePOSTED",
          "alternative_codeamount": "BP" 5,
        "rewards_participant": {
}        },  "accounts_receivable": {
   {         "totalaccount_amountowner": 60,{
        "net_amount": 50,         "idlast_name": "BE28ECA140834D92B8E9038DE8A95FE8Kestora",
        "quantity": 1,         "vatmiddle_amountname": 10null,
        "product": {           "product_type": {"life_cycle_state": "FINANCIAL",
              "servicecompany_typeprofile": "USAGE"null,
              "physical_good_typetitle": "NONTRACEABLE"null,
              "usedfirst_for_provisioningname": true"Polina",
              "classificationtype": "SERVICESPERSON",
              "composition_methodid": "FLATF038161F36C845B98CEE7361A8C92157",
              "idname": "78F758444F6B8437F1A27F61D1BE84A5"null,
              "company_name": "VOD"null,
              "descriptiondemographics": "Video{
 on Demand Movies",             "alternative_codegender": "VODFEMALE",
           },     "passport_issued_by_country": null,
    "id": "02192DC60AF606C2124118AABCBFAAAA",           "descriptionsocial_security_number": "Serendipity"null,
          "code      "passport_number": "Serendipity"null,
          "alternative_code": "SRDP"     "industry_sector": null,
  }       }     ],     "udfname_float_2day": {
20,      "udf_float_3": 30,     "udf_float_4": 40,     "numbermonth": "849"null,
    "payment_medium_type": {       "id": "0EC912D6358341B4BAE55CFA70FE0F2D",       "nameday": "Credit Card",null
          "description": "Payment Medium Type 1: Credit Card"},

     "alternative_code": "CC"     },     "udfdate_stringof_1birth": "udf string 1", {
          "udf_string_2": "udf string 2",     "udf_string_3month": "udf string 3",3,
          "udf_string_4": "udf string 4",     "udf_string_5day": "udf string 5", 4,
          "udf_string_6": "udf string 6",     "udf_string_7year": 1988
"udf string 7",     "udf_string_8": "udf string 8",     "accounts_receivable": { },
      "account_owner": {         "lastid_namenumber": "Mercer112233",
           "middle_name     "industry": "111111111",null,
                "lifeid_issued_cycleby_statecountry": null
"FINANCIAL",         "company_profile": null,    }
    "title": "Mr",       },
 "first_name": "Ben11 omonoia",         "typelife_cycle_state": "PERSONACTIVE",
            "idnumber": "475904FB959FE8D3DDAEB22FBFEC5FFBACR0000000164",
            "nameid": "C6CBAC948E53498F83FF52E6CD8B7221"Mercer,
  Ben11 omonoia",         "company_name": null,name": "ACR0000000164 Polina Kestora"
         "demographics": { },
          "gendernumber": "MALERP0000000019",
          "passport_issued_by_countryid": {"EA95AA28BE1F4C8B9C983487278210D3"
        },
     "three_character_code   "number": "AND1178",

           "two_character_code"id": "AD9C0A9B29A07B42CDBFA0279B6D4FAB37",
      }
     "id": "132"],
       "classification": null,
    "nameudf_date_1": "ANDORRA2014-05-05T15:49:59",
       "udf_date_2": "2014-06-05T15:49:59",
    "alternativeudf_date_code3": null"2014-07-05T15:49:59",
          }"udf_date_4": "2014-08-05T15:49:59",
    "invoice": null,
    "socialperformed_securityby_numberunit": null,
   {
      "passportcommunity_numbername": null"Community",
          "industry_sector"id": null"1",
          "country_of_residence"name": {
   "Admin Unit",
        "threegroup_character_codename": "USAMain Group",
      "description": "admin unit",
      "twoalternative_character_code": "USadminunit",
    },
       "id"vat_amount": "127",
       0,
    "nameprocess_immediately": "UNITED STATES"1,
    "log_information": {
      "alternativeupdated_codedate": null
  "2016-07-14T09:38:54",
       },
 "created_date": "2016-07-14T09:38:54",
        "namecreated_by_dayunit": {
            "month"community_name": 6,
   "Community",
        "dayid": 14"1",
        "name": "Admin }Unit",
 
        "dategroup_of_birthname": {
   "Main Group",
        "monthdescription": "admin 11unit",
            "day": 9,"alternative_code": "adminunit"
      },
      "yearupdated_by_unit": 1963
          },{
           "idcommunity_numbername": "1212125Community",
 
        "industryid": {"1",
            "idname": "31BC2070C79EAE5455BFAD41599C5190Admin Unit",
   
        "group_name": "Marketing1Main Group",
            "codedescription": "MK"admin unit",
        "alternative_code": "adminunit"
  },    },
      "id_issuedcreated_by_countryuser": {
   
        "threeperson_character_codename": "DZACRM COM",
   
        "two_character_codeusername": "DZMPAdministrator",
            "id": "1301",
            "nameemail": "ALGERIAdev@crm.com",
      },
      "alternativeupdated_by_codeuser": null{
        "person_name":  }
        }
   "CRM COM",
  },       "life_cycle_stateusername": "ACTIVEMPAdministrator",
        "numberid": "1621",
        "idemail": "3C66BD54CCDB6BC1096C23F6D8899752dev@crm.com",
      "name": "Ben Mercer 1"}
    },
    "paymenttotal_medium_brandamount": {11,
      "id"life_cycle_state": "F7B18DE5D55E452C81AF6F1EAD3E934CPOSTED",
      "namenet_amount": "VISA"11,
 
    "descriptionpayment_medium_identifier": "Payment Medium Brand 1: Visanull,
    "type": "PURCHASE",
      "alternative_codedescription": "V"Applying Interactive Reward Offers, considering the Spend }Method",
    "idreference_number": "01B0FD5A49814677BBF15662482C39FERF000001",
    "award_reward_transactions_setperformed_on": [],"2017-07-12T15:00:00"
    "classification": {
      "id": "2164EF87DBAB4225ACC81CE90712933A",
      "name": "Purchase",
      "alternative_code": "P"
    },
    "udf_date_1": "2016-03-24T15}
}

Expand

title	Example 2

HTTP Method: POST

Request:

Body:

Code Block

language	javascript
theme	Confluence
linenumbers	true

{
"token":"{{token}}",
"accounts_receivable_identifier":{"number":"162"},
"performed_by_unit_identifier":{"name":"Admin Unit"},
"performed_on":"2014-05-05T15:49:59",
"description":"first purchase event",
 "udfprocess_date_2immediately":0,
"2016-04-24T15:49:59"reference_number":"RF001",
"total_amount":235,
   "udf_date_3": "2016-05-24T15:49:59",
 "net_amount":210,
"vat_amount":25,
"invoice_identifier":{"number":"I00000882"},
  "udfproducts_date_4set":
"2016-06-24T15:49:59",   [
    "invoice": {
       "issuedproduct_onidentifier": "2014-10-24T16:15:15"{"code":"Decoders 1"},
       "total_amount":60,
133,       "lifenet_cycle_stateamount":50,
 "POSTED",      "vat_amount":10,
       "unsettled_amountquantity": 0,2
     },
     {
       "number"product_identifier":{"code":"Smartcard 1"I00000278"},
       "duetotal_onamount":180,
  "2014-11-03T16:15:15"     "net_amount":160,
       "idvat_amount": "470154904D2B2E0107F58A0330609D63",20
     }
   ],
"referencefields_set":"number,id,performed_by_unit,classification,invoice,products_set,accounts_receivable"
}

Response:

Code Block

language	javascript
theme	Confluence
linenumbers	true

{
  "325data",:  {
    "outstandinglog_amountinformation": 0,{
      "postedcreated_by_onunit": "2014-10-24T16:15:15"{
    },     "performedalternative_by_unitcode": "adminunit",
{        "communitygroup_name": "InternalMain CommunityGroup",
        "idcommunity_name": "48305F8849E3C18B227C5BE3A27BA6DFCommunity",
        "name": "Admin Unit",
        "group_namedescription": "Mainadmin Groupunit",
        "descriptionid": "r1 Test1"
Description for resource  request tab.Test Description for resource  request tab." },
      "alternativeupdated_by_codeunit": "MG"{
    },     "vatalternative_amountcode": 30,"adminunit",
        "processgroup_immediatelyname": 1,"Main Group",
        "logcommunity_informationname": {"Community",
        "updated_datename": "2016-06-22T15:37:00Admin Unit",
        "created_datedescription": "2016-06-22T15:37:00admin unit",
      "created_by_unit": {  "id": "1"
      },
      "communitycreated_namedate": "Internal Community2016-07-05T13:33:24",
        "idupdated_date": "48305F8849E3C18B227C5BE3A27BA6DF2016-07-05T13:33:25",
 
      "nameupdated_by_user": "Admin Unit",
{
        "groupperson_name": "MainCRM GroupCOM",
        "descriptionid": "r11",
Test Description for resource  request tab.Test Description for resource  request tab."email": "dev@crm.com",
        "alternative_codeusername": "MGMPAdministrator"
      },
      "updatedcreated_by_unituser": {
        "communityperson_name": "InternalCRM CommunityCOM",
        "id": "48305F8849E3C18B227C5BE3A27BA6DF1",
        "nameemail": "Admin Unitdev@crm.com",
        "group_nameusername": "Main GroupMPAdministrator",
        "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab."}
    },
        "alternative_code"description": "MG"first       }purchase event",
      "createdcurrency_byrate_userperiod": {
   null,
    "personudf_date_name2": "Marios Lannister",
  null,
      "usernametype": "MPAdministratorPURCHASE",
    "udf_date_1": null,
    "idudf_date_4": "1"null,
        "email"products_set": "sakkascy1986@hotmail.com" [
      {
 },       "updated_by_userproduct": {
          "person_namecode": "Marios LannisterSmartcard",
          "usernameproduct_type": "MPAdministrator", {
            "idservice_type": "1"null,
        "email": "sakkascy1986@hotmail.com"   "used_for_provisioning": true,
  }     },     "totalalternative_amountcode": 240"S",
      "life_cycle_state      "composition_method": "POSTEDFLAT",
    "net_amount": 210,        "payment_medium_identifiername": "PI000001SMARTCARD",
     "type": "PURCHASE",       "description": "Testing creation of purchase event",SMARTCARD",
            "reference_numberid": "RF000001D6BE0209EC0149989A89972CE889DF8B",
            "performed_onclassification": "2016-06-22T15:00:00"PHYSICALGOODS",
  }
}

Expand

title	Example 3

HTTP Method: POST

Request:

Body:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{      "token":"{{token}}",    "rewardsphysical_participantgood_identifiertype":{ "number":"RP0000000019"TRACEABLE"
          },
   "performed_by_unit_identifier":{"name":"Admin Unit"},       "performedalternative_oncode":"2017-07-12T15:00:00", "S",
          "description":"Applying null,
Interactive Reward Offers, considering the Spend Method",    "process_immediately":1,id": "4F656ED5DAC44168B0805227881202CD"
        },
     "reference_number":"RF000001"   "quantity": 2,
        "udfvat_string_1amount":"udf string 1", 10,
        "udftotal_string_2amount":"udf string 2", 60,
        "udf_string_3id":"udf string 3", "8D0E61A56B8B4987B04ED9446681EF26",
        "udfnet_string_4amount":"udf 50
 string 4",    "udf_string_5":"udf string 5"}
    ],
    "udf_stringdate_63":"udf stringnull,
6",    "udf_string_7number": "udf string 7106",
    "udf_stringfloat_83":"udf stringnull,
8",    "udf_float_14":10 null,
    "udfvat_float_2amount":20 10,
    "udfaward_reward_floattransactions_3set":30 null,
    "udf_float_4id":40 "3FD06F2BCE834444A3FD65A7ED6DEB85",
    "udf_float_51":50 null,
    "udf_float_62":60 null,
    "udf_floatstring_72":70 null,
    "udf_floatstring_83":80 null,
    "udf_datestring_14":"2014-05-05T15:49:59" null,
    "udf_datestring_25":"2014-06-05T15:49:59", null,
    "udf_datestring_31":"2014-07-05T15:49:59", null,
    "udfaccounts_date_4receivable":"2014-08-05T15:49:59 {
      "number": "ACR0000000050",
   "products_set   "name": "ACR0000000050 Ekaterini Tzirtzipi",
[      {
"id": "1B61E3A9DB864363A1502829952DF3CD",
      "productlife_cycle_identifierstate":{ "code":"PK_SmartCard"},ACTIVE",
      "account_owner": {
        "totalcompany_amountprofile":11 null,
        "netcompany_amountname":11 null,
        "vat_amountname":0 "Ekaterini Tzirtzipi",
   }    ]
 }

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
  "status": { "last_name": "Tzirtzipi",
        "messageid": "3236797A43C746F8AD9F4A91A4035735",
    "description    "life_cycle_state": "FINANCIAL",
    "code    "middle_name": "OK" null,
     },   "datatitle": {null,
        "udf_float_1type": 10"PERSON",
        "productsfirst_setname": "Ekaterini",
  [      "demographics": {
          "totalname_amountday": 11,{
            "net_amountmonth": 11null,
            "idday": "8230752E72814A48A886806228FBB61D",null
         "quantity": 1},
          "vatid_amountnumber": 0"343434",
          "productgender": {null,
          "productcountry_of_typeresidence": {
            "servicealternative_typecode": null"CYP",
            "physicalthree_goodcharacter_typecode": "TRACEABLECYP",
            "used_for_provisioningname": false"CYPRUS",
            "classificationid": "PHYSICALGOODS181",
            "compositiontwo_character_methodcode": "FLAT",CY"
          },
          "iddate_of_birth": "7FC0F87C40C74ABCA19F1CA870E51687",{
            "namemonth": "PK_Product Type_SB3"null,
            "descriptionyear": null,
            "alternative_codeday": "PT_2"null
          },
          "idindustry_sector": "2ED97CB3DC0141C5B8316525B9D54AB7"null,
          "descriptionpassport_number": "PK_SmartCard"null,
          "codeindustry": "PK_SmartCard"null,
          "alternativesocial_security_codenumber": "P_8"null,
        }  "id_issued_by_country": null,
   }     ],     "udfpassport_issued_floatby_2": 20,country": null
        }
    "udf_float_3": 30, }
   "udf_float_4": 40 },
    "numberlife_cycle_state": "336POSTED",
    "paymentperformed_medium_typeon": null"2016-05-05T15:49:59",
    "udf_string_1classification": "udf string 1"null,
    "udfreference_string_2number": "udf string 2RF001",
    "udfprocess_string_3immediately": "udf string 3"0,
    "udftotal_string_4amount": "udf string 4"60,
    "udfnet_string_5amount": "udf string 5"50,
    "instant_spend_requestinvoice": {
      "classificationposted_on": null"2016-06-23T09:55:50",
      "number": "72I00000599",
      "performedtotal_by_unitamount": {
  38.15,
      "idunsettled_amount": "1"0,
        "nameissued_on": "Admin Unit2016-06-23T09:55:50",
        "descriptionid": "admin unit13A2AE71163C4ED3994F14396F6173D9",

       "alternativelife_cycle_codestate": "adminunitPOSTED",
      }"outstanding_amount": 0,
      "processreference_immediatelynumber": 1"75",
      "spend_reward_transaction": {due_on": "2016-06-25T09:55:50"
    },
    "totaludf_string_amount6": 5null,

       "lifeudf_cyclestring_state7": "POSTED"null,
        "rewards_participant"performed_by_unit": {

         "accountsalternative_receivablecode": {
     "adminunit",
      "accountgroup_ownername": {
       "Main Group",
      "lastcommunity_name": "KestoraCommunity",
              "middle_name": "Admin nullUnit",
      "description": "admin unit",
      "life_cycle_stateid": "FINANCIAL1",
    },
         "company_profile"udf_string_8": null
  },
  "status": {
    "code": "OK",
    "titledescription": null"",
    "message": ""
  }
}

Expand

title	Example 4

HTTP Method: POST

Request:

Body:

Code Block

language	javascript
theme	Confluence
linenumbers	true

{
"token":"{{token}}",
"accounts_receivable_identifier":{"name":"0000000001 Eleni  M"},
"first_performed_by_unit_identifier":{"name":"Merchant A unit"Polina",
              "type": "PERSON",
              "id": "F038161F36C845B98CEE7361A8C92157",
              "name": "Polina Kestora",
              "company_name": null,
              "demographics": {
  },
"performed_on":"2018-09-07T13:09:00",
"description":"purchase event",
"process_immediately":true,
"reference_number":"PCE1API32",
"disable_instant_spend":true,
"total_amount":3,
"net_amount":3,
"vat_amount":0,
  "products_set":
   [
     {
       "genderproduct_identifier":{"code": "FEMALESerendipity"},
      "total_amount":3,
		"net_amount":3,
		"vat_amount":0,
       "passport_issued_by_countryquantity":1
null,     }
   ]
}

Response:

Code Block

language	javascript
theme	Confluence
linenumbers	true

{
      "social_security_number"data": {
   null,     "log_information": {
            "passportcreated_by_numberunit": null,{
                "industryalternative_sectorcode": null"adminunit",
                "countrygroup_of_residencename": {"Main Group",
                 "threecommunity_character_codename": null"Community",
                  "two_character_code"name": null"Admin Unit",
                  "iddescription": "231admin unit",

                 "nameid": "IRAN (ISLAMIC REPUBLIC OF)","1"
            },
            "alternativeupdated_by_codeunit": "IRN"{
                 }"alternative_code": "adminunit",
                "group_name_day": {"Main Group",
                 "monthcommunity_name": null"Community",
                "name": "Admin Unit"day":,
 null               "description": "admin }unit",
                "date_of_birthid": {"1"
            },
      "month": 3,     "created_date": "2018-09-07T13:15:28",
            "dayupdated_date": 4,
   "2018-09-07T13:15:32",
              "year"updated_by_user": 1988{
                "person_name": "CRM }COM",
                "id_number": "1122331",
                "industryemail": null"test@crm.com",
                "id_issued_by_countryusername": null"MPAdministrator"
            },
    }        "created_by_user": {
   },             "lifeperson_cycle_statename": "ACTIVECRM COM",
                "numberid": "ACR00000001641",
                "idemail": "C6CBAC948E53498F83FF52E6CD8B7221test@crm.com",
                "nameusername": "ACR0000000164MPAdministrator"
Polina Kestora"           },
        },
        "numberspend_requests_set": "RP0000000019",
 [],
        "idpayment_medium_brand": "EA95AA28BE1F4C8B9C983487278210D3"null,
         }"type": "PURCHASE",
        "numberproducts_set": [
"57",         "net_amount": 5,  {
      "id": "A3CB8C42085B43BB9F98C50D4580E961",         "vat_amountproduct": 0{
      },       "log_information": {         "updated_datecode": "2016-07-14T09:38:54Serendipity",
          "created_date": "2016-07-14T09:38:54",         "createdproduct_by_unittype": {
          "id": "1",              "namemeter_reading_type": "Admin Unit",null,
           "description": "admin unit",           "alternativeservice_codetype": "adminunitUSAGE",
        },                "updatedused_byfor_unitprovisioning": {true,
            "id": "1",           "namealternative_code": "Admin UnitV",
          "description": "admin unit",              "alternativeudr_codetype": "adminunit"{
        },         "created_by_user": {           "personunit_of_namemeasurement": "MPAdministrator"null,
          "username": "MPAdministrator",                  "idalternative_code": "1V",
        },         "updated_by_user": {           "person_name": "MPAdministratorVOD",
          "username": "MPAdministrator",           "id": "1"         }  "description": null,
   },       "life_cycle_state": "POSTED",       "accounts_receivable": {         "account_ownerid": {"B3CFC986221548279752B1ABC6F4C480"
          "last_name": "Kestora",             "middle_name": null },
          "life_cycle_state": "FINANCIAL",              "companycomposition_profilemethod": null"FLAT",
          "title": null,              "first_name": "PolinaUsage Services",
          "type": "PERSON",              "iddescription": "F038161F36C845B98CEE7361A8C92157Used for VOD , PPV, TELEPHONE CALLS ETC",
            "name": null,           "company_nameid": null"751C638AA3534B768408AAC4D73CF516",
          "demographics": {             "genderclassification": "FEMALESERVICES",
             "passport_issued_by_country           "physical_good_type": null,
             "social_security_number": null,      },
      "passport_number": null,             "industryalternative_sectorcode": null"S_1",
            "name_day": {       "description": "VOD: Serendipity ",
    "month": null,               "dayid": null"BD3ACEE7D6244DCAA375D0744DA75540",
            },             "datepriority_of_birthlevel": null
{               "month": 3},
                "dayquantity": 41,
                "yearvat_amount": 1988
        0,
   },             "idtotal_numberamount": "112233"3,
                "industryid": null,"8D907F5DF2DE4AC2A4D9AD23A61F1CB2",
                "id_issued_by_countrynet_amount": null3
            }
        }],
        "life_cycle_statenumber": "ACTIVE1607",
        "numbertotal_automatic_spend_amount": "ACR0000000164"0,
        "id": "C6CBAC948E53498F83FF52E6CD8B7221656539A4B48E409699179497FC9C04B8",
        "nametotal_awarded_amount": "ACR0000000164 Polina Kestora"0.75,
         }"udf_string_2": null,
        "spendudf_string_amount3": 5null,
      "type  "udf_string_4": "SPEND_REQUEST"null,
      "id  "udf_string_5": "B49F7C337870455C9931C067DF6B3E80"null,
      "description  "udf_string_1": null,
        "performed_ontotal_instant_spend_amount": "2016-07-14T09:38:54"0,
    },     "udflife_stringcycle_6state": "udfPOSTED",
  string 6",     "udf_string_7classification": "udf string 7",null,
        "udfreference_string_8number": "PCE1API32"udf,
  string 8",     "accountstotal_receivableamount": 3,
{        "accountautomatic_spend_ownerrequest": {null,
        "lastudf_string_name6": "Kestora"null,
        "middleudf_string_name7": null,
        "lifeudf_cyclestring_state8": "FINANCIAL"null,
        "companyudf_string_profile9": null,
        "titleexternal_system_reference_number": null,
        "first_namedescription": "Polinapurchase event",
        "typeudf_date_2": "PERSON"null,
        "idudf_date_1": "F038161F36C845B98CEE7361A8C92157"null,
        "nameudf_date_4": "Polina Kestora"null,
        "companyudf_date_name3": null,
        "demographicsudf_float_3": {null,
          "gender"udf_float_4": "FEMALE"null,
          "passport_issued_by_countryvat_amount": null0,
 
        "socialaward_reward_securitytransactions_numberset": null,[
          "passport_number": null,  {
        "industry_sector": null,       "number": "3730",
  "country_of_residence": {             "three_character_codeamount": null0.75,
                "twocurrency_characterrate_codeperiod": null,{
            "id": "231",       "from_date": "2018-08-07 00:00:00.0",
   "name": "IRAN (ISLAMIC REPUBLIC OF)",             "alternativeto_codedate": "IRN"null,
          },           "name_dayrate": { 5,
                    "monthinverse_rate": null0.2,
            "day": null       "currency": null,
  },           "date_of_birth": {      "id": "71996F27996C44DC9E2FD4C2F05AE563"
     "month": 3,          },
  "day": 4,             "yearid": 1988"553D5ED7FD5D4EE9923DB96D012ADC47",
          },           "id_number"life_cycle_state": "112233POSTED",
             "industry   "contribution_percentage": null,
                "id_issued_by_countryrewards_participant": null{
        }       },       "life_cycle_state"number": "ACTIVE1",
      "number": "ACR0000000164",       "id": "C6CBAC948E53498F83FF52E6CD8B7221",       "nameaccounts_receivable": "ACR0000000164{
 Polina Kestora"     },     "payment_medium_brand": null,     "id": "AC062E7AD94A401B8D8153F1CD28FB58",     "award_reward_transactions_setnumber": ["0000000001",
      {         "life_cycle_state": "POSTED",         "amountname": 5"0000000001 Eleni M",
        "rewards_participant": {           "accounts_receivable": {   "id": "8DDDA5F17D9641FC97A32FEAEE1F8AC6",
        "account_owner": {               "lastlife_cycle_namestate": "KestoraACTIVE",
                        "middleaccount_nameowner": null,{
              "life_cycle_state": "FINANCIAL",               "company_profile": null,
              "title": null,               "firstcompany_name": "Polina"null,
              "type": "PERSON",               "idname": "F038161F36C845B98CEE7361A8C92157Eleni Mich",
 
            "name": null,               "companylast_name": null"Mich",
              "demographics": {                 "genderid": "FEMALEEE15F92F5AD9487692DA4DD34D35CA09",
                "passport_issued_by_country": null,                 "sociallife_securitycycle_numberstate": null,
      "FINANCIAL",
          "passport_number": null,                 "industrymiddle_sectorname": null,
                  "name_day": {         "title": null,
        "month": null,                   "daytype": null"PERSON",
                },            "first_name": "Eleni",
   "date_of_birth": {                   "month": 3,    "demographics":  {
            "day": 4,                   "yearid_number": 1988
"451232",
               },                 "id_numbergender": "112233"null,
                "industry": null,                 "idcountry_issuedof_by_countryresidence": null{
              }             },             "lifealternative_cycle_statecode": "ACTIVEIRN",
            "number": "ACR0000000164",             "id": "C6CBAC948E53498F83FF52E6CD8B7221",             "namethree_character_code": "ACR0000000164null,
 Polina Kestora"           },           "number": "RP0000000019",           "idname": "EA95AA28BE1F4C8B9C983487278210D3"IRAN (ISLAMIC        }REPUBLIC OF)",
        "number": "1178",         "id": "9C0A9B29A07B42CDBFA0279B6D4FAB37"       }     ],     "classificationid": null"231",
    "udf_date_1": "2014-05-05T15:49:59",        "udf_date_2": "2014-06-05T15:49:59",     "udf_date_3": "2014-07-05T15:49:59",     "udf_date_4": "2014-08-05T15:49:59",     "invoice": null,     "performedtwo_bycharacter_unitcode": {null
           "community_name": "Community",       "id": "1",       "name": "Admin Unit",   },
   "group_name": "Main Group",       "description": "admin unit",       "alternative_code": "adminunit"     },     "vatdate_of_amountbirth": 0,{
      "process_immediately": 1,     "log_information": {       "updated_date": "2016-07-14T09:38:54",       "created_date": "2016-07-14T09:38:54",       "created_by_unitmonth": {
 null,
      "community_name": "Community",         "id": "1",         "name": "Admin Unit",         "group_nameyear": "Main Group",null,
          "description": "admin unit",         "alternative_code": "adminunit"       },       "updated_by_unitday": {null
          "community_name": "Community",         "id": "1",         "name": "Admin Unit"},
        "group_name": "Main Group",             "description": "admin unit",         "alternativeindustry_codesector": "adminunit"null,
      },       "created_by_user": {         "person_name": "CRM COM",          "usernameindustry": "MPAdministrator"null,
        "id": "1",
        "email": "dev@crm.com"       },       "updatedname_by_userday": {
                  "person_name": "CRM COM",                  "usernamemonth": "MPAdministrator"5,
        "id": "1",         "email": "dev@crm.com"       }     },     "total_amountday": 11,21
    "life_cycle_state": "POSTED",     "net_amount": 11,     "payment_medium_identifier": null,     "type": "PURCHASE",     "description": "Applying Interactive Reward Offers},
considering    the Spend Method",     "reference_number": "RF000001",     "performed_on": "2017-07-12T15:00:00"   } }

Expand

title	Example 2

HTTP Method: POST

Request:

Body:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{ "token":"{{token}}", "accounts_receivable_identifier":{"number":"162"}, "performed_by_unit_identifier":{"name":"Admin Unit"}, "performed_on":"2014-05-05T15:49:59", "description":"first purchase event", "process_immediately":0, "referencepassport_number_expiration_date":"RF001",
"total_amount":235,
"net_amount":210,
"vat_amount":25,
"invoice_identifier":{"number":"I00000882"},
  "products_set": null,
                  [      {        "product_identifier":{"code":"Decoders 1"},id_number_expiration_date": null,
                "total_amount":60,        "net_amount":50,        "vatpassport_amountnumber":10 null,
         "quantity":2         },      {        "productsocial_security_identifier":{"code":"Smartcard 1"},number": null,
                "total_amount":180,        "net_amount":160,        "vat_amount":20id_issued_by_country": null,
         }    ], "fields_set":"number,id,performed_by_unit,classification,invoice,products_set,accounts_receivable" }

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{   "data": {     "log_information": {       "createdpassport_issued_by_unitcountry": null
    {         "alternative_code": "adminunit",         "group_name": "Main Group",   }
     "community_name": "Community",         "name": "Admin Unit",       }
 "description": "admin unit",         "id": "1"       },
         "updated_by_unit": {           "alternative_codeid": "adminunit57A9AC82559149019061B743F13CD39B",
        "group_name": "Main Group",            "communitylife_cycle_namestate": "CommunityEFFECTIVE",
        "name": "Admin Unit",      }
  "description": "admin unit",        }
"id": "1"       }],
        "createdudf_string_date15": "2016-07-05T13:33:24",null,
        "updatedudf_string_date16": "2016-07-05T13:33:25",null,
        "updatedudf_bystring_user13": {null,
        "personudf_string_name14": "CRM COM"null,
        "idudf_string_11": "1"null,
        "emailudf_string_12": "dev@crm.com"null,
        "usernamecurrency": "MPAdministrator"{
      },       "createdsuffix_by_usersymbol": { "N/A",
            "personprefix_namesymbol": "CRM COM€",
            "iddecimal_part_name": "1cents",
            "emailcode": "dev@crm.comEUR",
          "username  "integer_part_name": "MPAdministratoreuro"
  ,
   }     },     "descriptionid": "first2",
purchase event",     "currency_rate_period": null,     "udflife_datecycle_2state": null,"EFFECTIVE"
     "type": "PURCHASE",  },
  "udf_date_1": null,     "udf_datestring_410": null,
        "productsudf_float_set1": [
      {null,
        "productudf_float_2": {null,
          "code"total_additional_spend_amount": "Smartcard"0,
          "productaccounts_typereceivable": {
            "service_typenumber": null"0000000001",
            "used_for_provisioningname": true"0000000001 Eleni M",
            "alternative_codeid": "S8DDDA5F17D9641FC97A32FEAEE1F8AC6",
            "compositionlife_cycle_methodstate": "FLATACTIVE",
            "nameaccount_owner": "SMARTCARD", {
                "descriptioncompany_profile": "SMARTCARD",null,
                "idcompany_name": "D6BE0209EC0149989A89972CE889DF8B"null,
                "classificationname": "PHYSICALGOODSEleni Mich",
                "physicallast_good_typename": "TRACEABLEMich",
          },           "alternative_codeid": "SEE15F92F5AD9487692DA4DD34D35CA09",
          "description": null,           "idlife_cycle_state": "4F656ED5DAC44168B0805227881202CDFINANCIAL",
        },         "quantitymiddle_name": 2null,
 
      "vat_amount": 10,         "total_amounttitle": 60null,
        "id": "8D0E61A56B8B4987B04ED9446681EF26",         "net_amounttype": 50"PERSON",
      }     ],     "udffirst_date_3name": null"Eleni",
    "number": "106",     "udf_float_3": null,     "udf_float_4demographics": {
   null,     "vat_amount": 10,     "award_reward_transactions_set": null,     "id_number": "3FD06F2BCE834444A3FD65A7ED6DEB85451232",
    "udf_float_1": null,     "udf_float_2": null,     "udf_string_2": null,     "udf_string_3gender": null,
    "udf_string_4": null,     "udf_string_5": null,     "udf_string_1": null,     "accountscountry_of_receivableresidence": {
      "number": "ACR0000000050",       "name": "ACR0000000050 Ekaterini Tzirtzipi",       "idalternative_code": "1B61E3A9DB864363A1502829952DF3CDIRN",
      "life_cycle_state": "ACTIVE",       "account_owner": {         "companythree_character_profilecode": null,
              "company_name": null,         "name": "Ekaterini TzirtzipiIRAN (ISLAMIC REPUBLIC OF)",
          "last_name": "Tzirtzipi",              "id": "3236797A43C746F8AD9F4A91A4035735231",
           "life_cycle_state": "FINANCIAL",             "middletwo_character_namecode": null,
         "title": null,         "type": "PERSON", },
         "first_name": "Ekaterini",           "demographicsdate_of_birth": {
          "name_day": {             "month": null,
            "day":  null          "year": }null,
            "id_number": "343434",           "genderday": null,
             "country_of_residence": {      },
      "alternative_code": "CYP",             "threeindustry_character_codesector": "CYP"null,
            "name": "CYPRUS",        "industry": null,
      "id": "181",             "twoname_character_codeday": "CY"{
             },           "date_of_birthmonth": {5,
            "month": null,             "yearday": null,
21
           "day": null           },
          "industry_sector": null,           "passport_number_expiration_date": null,
          "industry": null,           "socialid_number_securityexpiration_numberdate": null,
          "id_issued_by_country": null,           "passport_issued_by_countrynumber": null,
        }       }     },"social_security_number": null,
        "life_cycle_state": "POSTED",     "performed_on": "2016-05-05T15:49:59",     "classificationid_issued_by_country": null,
    "reference_number": "RF001",     "process_immediately": 0,     "total_amount": 60,     "net_amountpassport_issued_by_country": null
50,     "invoice": {       "posted_on": "2016-06-23T09:55:50",  }
    "number": "I00000599",       "total_amount": 38.15,}
       "unsettled_amount": 0, },
        "issuedperformed_on": "20162018-0609-23T0907T13:5509:5000",
        "idprocess_immediately": "13A2AE71163C4ED3994F14396F6173D9"true,
        "lifepayment_cyclemedium_statetype": "POSTED"null,
        "outstandingpayment_medium_amountidentifier": 0null,
        "referenceinstant_spend_numberrequest": "75"null,
        "duedisable_instant_onspend": "2016-06-25T09:55:50"true,
    },     "udfnet_string_6amount": null3,
    "udf_string_7    "invoice": null,
        "performed_by_unit": {
            "alternative_code": "adminunitMRAU",
            "group_name": "MainMerchant GroupABCD",
            "community_name": "CommunityCommunityB",
            "name": "AdminMerchant A Unitunit",
            "description": "admin unit", null,
            "id": "1AB18F69E3CA84413BABEF07713D410CB"
        },
    "udf_string_8    "total_spend_amount": 0,
        "external_system": null
    },
    "status": {
        "code": "OK",
        "description": "",
        "message": ""
    }
}

Versions Compared

Old Version 8

New Version Current

Key

Resource URL

Parameters

Resource URL

Parameters

Restrictions

Response Data

Examples

Anchor
create purchase customer event referred parameters
create purchase customer event referred parameters
Referred Parameter Objects

Restrictions

Response Data

Examples

Page Comparison

Versions Compared

Old Version 8

New Version Current

Key

Resource URL

Parameters

Resource URL

Parameters

Restrictions

Response Data

Examples

Anchorcreate purchase customer event referred parameterscreate purchase customer event referred parametersReferred Parameter Objects

Restrictions

Response Data

Examples

Anchor
create purchase customer event referred parameters
create purchase customer event referred parameters
Referred Parameter Objects