Versions Compared

Old Version 2

changes.mady.by.user p_demou (Deactivated)

Saved on

compared with

New Version Current

changes.mady.by.user Antonis Papageorgiou

Saved on

Key

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

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

From CRM.COM R14.0.0 and onwards

Excerpt

This method allows purchasing a voucher of classification Electronic Voucher. Single voucher is purchased by each call

Resource URL

Parameters

...

Name

...

Type

...

Description

...

token

...

String

...

The token retrieved from the login method

...

voucher_type

(mandatory)

...

The identifier of the voucher type to be purchased. The allowed voucher type identifier fields are the following:

...

sold_by_unit_identifier

(mandatory)

...

The identifier of the unit that will be selling the eVoucher. The allowed unit identifier fields are the following:

...

purchased_by_identifier

(mandatory)

...

The identifier of the accounts receivable of the customer purchasing the eVoucher. If the voucher type's usage method is "Personal" then the customer purchasing the eVoucher will also use it. The allowed accounts receivable identifier fields are the following:

...

accounts_receivable_identifier

(mandatory on conditions)

...

The identifier of the accounts receivable of the customer that will use the eVoucher. Defaults to the accounts receivable of the customer who purchases the eVoucher except if the eVoucher type's usage method is "Shareable" and a different customer's accounts receivable can be provided. The allowed accounts receivable identifier fields are the following:

...

voucher_value

(mandatory on conditions)

...

payment_method_identifier

(mandatory)

...

The payment method of the payment that will be generated after purchasing the eVoucher. The allowed payment method identifier fields are the following:

...

card_identifier

(mandatory on conditions)

...

The card that will be charged for the amount specified on the payment, by the related payment gateway provider. The allowed payment gateway card identifier fields are the following:

...

The card is applicable and mandatory if the specified payment method is linked with a payment gateway system. Note that the retrieved cards are filtered based on the cards owned by the specified accounts receivable who is purchasing the eVoucher

...

accounts_receivable_payment_preference_identifier

(mandatory on conditions)

...

The accounts receivable payment preferences that will be used by generic payment gateways to process the payment. The specified accounts receivable payment preferences should belong to the specified accounts receivable that is purchasing the eVoucher. This information is applicable and mandatory only if the payment will be processed by a generic payment gateway, as denoted by the selected payment method. The allowed accounts receivable payment preference identifier fields are the following:

...

fields_set

(optional)

...

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

Restrictions

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

Response Data

...

Examples

...

titleExample 1

HTTP Method: POST

 

Request:

Body

Code Block
themeConfluence
languagejs
linenumberstrue
 

Response:

Code Block
themeConfluence
languagejs
linenumberstrue
 

 

...



Tip

From CRM.COM R14.0.0 and onwards


Excerpt

This method allows purchasing a voucher of classification Electronic Voucher from the organisation. A single voucher is purchased by each call

Resource URL

http://host_name/crmapi/rest/$version/vouchers/purchase_evoucher

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

type_identifier

(mandatory)

Voucher type identifier

The identifier of the voucher type to be purchased. Only voucher types of "Electronic Payment Voucher" can be selected. The allowed voucher type identifier fields are the following:

Include Page
V4:voucher_type_identifier
V4:voucher_type_identifier

sold_by_unit_identifier

(optional)

Unit Identifier

The identifier of the unit that will be selling the eVoucher. The allowed unit identifier fields are the following:

Include Page
V4:unit_identifier
V4:unit_identifier

Tip

Deprecated from CRM.COM R18.0.0


sold_by_business_unit_identifier

(optional)

Business Unit Identifier

The identifier of the business unit that will be selling the eVoucher. The allowed business unit identifier fields are the following:

Include Page
V4:business_unit_identifier
V4:business_unit_identifier

Tip

Available from CRM.COM R18.0.0


use_funds_from

(mandatory)

Enum

Defines the funding method. The allowed options are:

  • ACCOUNTS_RECEIVABLE
  • WALLET
Tip

Available from CRM.COM R17.0.0


wallet_identifier
(semi-optional)

Wallet identifier

The identifier of the wallet from which the funds will be used to purchase the voucher. The allowed wallets identifier fields are the following:

Include Page
V4:wallet_identifier
V4:wallet_identifier

Tip

Available from CRM.COM R17.0.0 and applicable only if the use_funds_from is set to WALLET


rewards_participant_identifier

(semi-optional)

Rewards Participant Identifier

The identifier of the rewards participant who will purchase the voucher using the related wallet's funds. The allowed rewards participant identifier fields are the following:

Include Page
V4:rewards_participants_identifier_post
V4:rewards_participants_identifier_post

Tip

Available from CRM.COM R17.0.0 and applicable only if the use_funds_from is set to WALLET

Deprecated from CRM.COM R17.0.0


purchased_by_identifier

(semi-optional)

Accounts Receivable Identifier

The identifier of the accounts receivable of the customer purchasing the eVoucher. If the voucher type's usage method is "Personal" then the customer purchasing the eVoucher will also use it. The allowed accounts receivable identifier fields are the following:

Include Page
V4:accounts_receivable_identifier
V4:accounts_receivable_identifier

Tip

From CRM.COM R17.0.0 the parameter is set as semi-optional.

  • If used_funds_from is WALLET then the effective wallet of the provided accounts receivable will be used
  • Else, the Accounts Receivable will be used


accounts_receivable_identifier

(semi-optional on conditions)

Accounts Receivable Identifier

The identifier of the accounts receivable of the customer that will use the eVoucher. If the voucher's usage method is "Personal", then this accounts receivable defaults to the account owner who purchased voucher. If the voucher's usage method is "Shareable", if not specified then the accounts receivable remains empty as it can be used by any account owner. The allowed accounts receivable identifier fields are the following:

Include Page
V4:accounts_receivable_identifier_post
V4:accounts_receivable_identifier_post

Tip

For releases prior CRM.COM R17.0.0, this parameter was optional

From CRM.COM R17.0.0, this parameter is applicable also if the use_funds_from is set to WALLET

From CRM.COM R17.0.0, the access token identifier is available


voucher_value

(mandatory on conditions)

NumberThe eVoucher's value. Applicable and available only if voucher type's value options is "Variable"

payment_type_identifier

(optional)

Financial transaction type identifier

The type of the payment. If not specified, the default Payment Type of Financial Transactions Definition is used. The allowed payment type identifier fields are the following:

Include Page
V4:financial_transaction_type_identifier
V4:financial_transaction_type_identifier

Tip

From CRM.COM R17.0.0 the parameter is available if the use_funds_from is set to ACCOUNTS_RECEIVABLE


payment_category_identifier

(optional)

Financial transaction category identifier

The category of the payment. The allowed payment category identifier fields are the following:

Include Page
V4:financial_transaction_category_identifier
V4:financial_transaction_category_identifier

Tip

From CRM.COM R17.0.0 the parameter is available if the use_funds_from is set to ACCOUNTS_RECEIVABLE


payment_method_identifier

(optional)

Payment method identifier

The payment method of the payment that will be generated after purchasing the eVoucher. Only payment methods included in the payment type's allowed payment methods are allowed to be specified. If not specified, then the financial transaction type's default payment method is automatically set. The allowed payment method identifier fields are the following:

Include Page
V4:payment_method_identifier
V4:payment_method_identifier

Tip

From CRM.COM R16.0.0 and onwards this parameter is optional.


Tip

From CRM.COM R17.0.0 the parameter is available if the use_funds_from is set to ACCOUNTS_RECEIVABLE


card_identifier

(mandatory on conditions)

Payment Gateway Card Identifier

The card that will be charged for the amount specified on the payment, by the related payment gateway provider. The allowed payment gateway card identifier fields are the following:

Include Page
V4:payment_gateway_card_identifier
V4:payment_gateway_card_identifier

The card is applicable and mandatory if the specified payment method is linked with a payment gateway system. Note that the retrieved cards are filtered based on the cards owned by the specified accounts receivable who is purchasing the eVoucher

Tip

From CRM.COM R17.0.0 the parameter is available if the use_funds_from is set to ACCOUNTS_RECEIVABLE


accounts_receivable_payment_preference_identifier

(mandatory on conditions)

Accounts Receivable Payment Preference Identifier

The accounts receivable payment preferences that will be used by generic payment gateways to process the payment. The specified accounts receivable payment preferences should belong to the specified accounts receivable that is purchasing the eVoucher. This information is applicable and mandatory only if the payment will be processed by a generic payment gateway, as denoted by the selected payment method. The allowed accounts receivable payment preference identifier fields are the following:

Include Page
V4:accounts_receivable_payment_preference_identifier
V4:accounts_receivable_payment_preference_identifier

Tip

From CRM.COM R17.0.0 the parameter is available if the use_funds_from is set to ACCOUNTS_RECEIVABLE


payment_notes

(optional)

StringShared notes for the payment

back_office_code

(optional)

StringA back office code for the payment. If specified then it should be unique

description

(optional)

StringThe description of the eVoucher to be purchased

udf_string_1

(optional)

StringUser Defined Field of type String

udf_string_2

(optional)

StringUser Defined Field of type String

udf_string_3

(optional)

StringUser Defined Field of type String

udf_string_4

(optional)

StringUser Defined Field of type String

udf_string_5

(optional)

StringUser Defined Field of type String

udf_string_6

(optional)

StringUser Defined Field of type String

udf_string_7

(optional)

StringUser Defined Field of type String

udf_string_8

(optional)

StringUser 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

evoucher_products_set

(optional)

Set of Products and Product Types item objectsVoucher products are a set of products (services and physical goods) or product types that can consume the amount of money that was paid through the eVoucher.

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


Anchor
purchase evoucher referred parameters
purchase evoucher referred parameters
Referred Parameter Objects

Include Page
V4:evoucher_products_parameters
V4:evoucher_products_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:voucher_complete
V4:voucher_complete

Examples

Expand
titleExample 1

HTTP Method: POST


Request:

Body

Code Block
languagejs
themeConfluence
linenumberstrue
 {
    "token":"{{token}}",
    "type_identifier":{"name":"Shareable eVoucher"},
    "description":"eVoucher created through API",
    "sold_by_unit_identifier":{"name":"Secondary Unit"},
    "purchased_by_identifier":{"number":"ACR0000012236"},
    "accounts_receivable_identifier":{"name":"S. Petrou"},
    "voucher_value":"28",
    "payment_type_identifier":{"name":"Cash Payment"},
    "payment_method_identifier":{"name":"Cash Payment"},
    "payment_category_identifier":{"name":"Payment Categories"},
    "payment_notes":"Payment created through API",
    "back_office_code":"6012",
    "evoucher_products_set":
    	[
    		{
    			"product_identifier":{"code":"Serendipity"}
    		},
    		{
    			"product_identifier":{"code":"Tax Add-on"}
    		}
    	]
}


Response:

Code Block
languagejs
themeConfluence
linenumberstrue
 {
    "data": {
        "allowed_organisational_units_set": [
            {
                "alternative_code": "adminunit",
                "group_name": null,
                "community_name": null,
                "name": "Admin Unit",
                "description": "admin unit",
                "id": "E532346131444885A2928D67295D0D54"
            },
            {
                "alternative_code": "C_2",
                "group_name": null,
                "community_name": "CommunityB",
                "name": null,
                "description": null,
                "id": "9596D3A93F4C44D3973D98B6823C84EA"
            }
        ],
        "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": "2017-09-18T13:34:34",
            "updated_date": "2017-09-18T13:34:34",
            "updated_by_user": {
                "person_name": "CRM COM",
                "id": "1",
                "email": "dev@crm.com",
                "username": "MPAdministrator"
            },
            "created_by_user": {
                "person_name": "CRM COM",
                "id": "1",
                "email": "dev@crm.com",
                "username": "MPAdministrator"
            }
        },
        "purchased_by": {
            "number": "ACR0000012236",
            "name": "ACR0000012236 Marios Ioan.",
            "id": "7453A591D366478F9A11177E32D367DF",
            "life_cycle_state": "ACTIVE",
            "account_owner": {
                "company_profile": null,
                "company_name": null,
                "name": null,
                "last_name": "Ioannides",
                "id": "B227C528F0834C648486604FBEAB89EA",
                "life_cycle_state": "FINANCIAL",
                "middle_name": null,
                "title": "Mr",
                "type": "PERSON",
                "first_name": "Marios",
                "demographics": {
                    "name_day": {
                        "month": 11,
                        "day": 21
                    },
                    "id_number": "4545",
                    "gender": null,
                    "country_of_residence": {
                        "alternative_code": "CYP",
                        "three_character_code": "CYP",
                        "name": "CYPRUS",
                        "id": "181",
                        "two_character_code": "CY"
                    },
                    "date_of_birth": {
                        "month": null,
                        "year": null,
                        "day": null
                    },
                    "industry_sector": null,
                    "passport_number": null,
                    "industry": null,
                    "social_security_number": null,
                    "id_issued_by_country": null,
                    "passport_issued_by_country": null
                }
            }
        },
        "description": "eVoucher created through API",
        "extra_added_value": 2,
        "expiration_date": "2018-02-18T13:34:34",
        "udf_date_2": null,
        "type": {
            "alternative_code": "J",
            "value_options": "VARIABLE",
            "name": "Shareable eVoucher",
            "description": null,
            "id": "7C1A3D41F4FE450AA1B10D25ED3AA3C1",
            "classification": "ELECTRONIC_PAYMENT_VOUCHER"
        },
        "udf_date_1": null,
        "udf_date_4": null,
        "products_set": [
            {
                "product": {
                    "code": "Tax Add-on",
                    "product_type": {
                        "service_type": "TERMED",
                        "used_for_provisioning": true,
                        "alternative_code": "AS",
                        "udr_type": null,
                        "composition_method": "FLAT",
                        "name": "Additional Services",
                        "description": null,
                        "id": "C8321F0BCA8A4051857BC35CEEE41555",
                        "classification": "SERVICES",
                        "physical_good_type": null
                    },
                    "alternative_code": "TA",
                    "description": "Tax Main",
                    "id": "7D8030A1909A4E01A201A93159E4EAE7",
                    "priority_level": null
                },
                "product_type": null,
                "id": "D8A0A1EA9B73451C9F0223A62EEBC731"
            },
            {
                "product": {
                    "code": "Serendipity",
                    "product_type": {
                        "service_type": "USAGE",
                        "used_for_provisioning": true,
                        "alternative_code": "V",
                        "udr_type": {
                            "unit_of_measurement": {
                                "alternative_code": "A",
                                "name": "Amount",
                                "description": null,
                                "id": "0F24D08950AA4B5DB5C5F52FA5A4A7D1"
                            },
                            "alternative_code": "V",
                            "name": "VOD",
                            "description": null,
                            "id": "B3CFC986221548279752B1ABC6F4C480"
                        },
                        "composition_method": "FLAT",
                        "name": "Usage Services",
                        "description": "Used for VOD , PPV, TELEPHONE CALLS ETC",
                        "id": "751C638AA3534B768408AAC4D73CF516",
                        "classification": "SERVICES",
                        "physical_good_type": null
                    },
                    "alternative_code": "S_1",
                    "description": "VOD: Serendipity ",
                    "id": "BD3ACEE7D6244DCAA375D0744DA75540",
                    "priority_level": null
                },
                "product_type": null,
                "id": "E0F45846F7874B80BB4E325667544DF7"
            }
        ],
        "udf_date_3": null,
        "number": "V00201324",
        "udf_float_3": null,
        "udf_float_4": null,
        "sold_by": {
            "alternative_code": "G2U",
            "group_name": "Secondary Group",
            "community_name": "CommunityA",
            "name": "Secondary Unit",
            "description": null,
            "id": "3BC92704833C4285B49734CE916D055E"
        },
        "effective_date": "2017-09-18T13:34:34",
        "purchased_for": {
            "number": "ACR0000000489",
            "name": "S. Petrou",
            "id": "7904180094C64BDCB88C5B31CAE0B684",
            "life_cycle_state": "ACTIVE",
            "account_owner": {
                "company_profile": null,
                "company_name": null,
                "name": null,
                "last_name": "Petrou",
                "id": "57ADCEBB666344D09F1E7C035368785E",
                "life_cycle_state": "FINANCIAL",
                "middle_name": null,
                "title": null,
                "type": "PERSON",
                "first_name": "Savvas",
                "demographics": {
                    "name_day": {
                        "month": 12,
                        "day": 5
                    },
                    "id_number": null,
                    "gender": "FEMALE",
                    "country_of_residence": {
                        "alternative_code": "CYP",
                        "three_character_code": "CYP",
                        "name": "CYPRUS",
                        "id": "181",
                        "two_character_code": "CY"
                    },
                    "date_of_birth": {
                        "month": null,
                        "year": null,
                        "day": null
                    },
                    "industry_sector": null,
                    "passport_number": null,
                    "industry": null,
                    "social_security_number": null,
                    "id_issued_by_country": null,
                    "passport_issued_by_country": null
                }
            }
        },
        "payment": null,
        "id": "479268C45AB8491697C700BA749267E5",
        "udf_float_1": null,
        "value": 28,
        "udf_float_2": null,
        "udf_string_2": null,
        "udf_string_3": null,
        "udf_string_4": null,
        "udf_string_5": null,
        "udf_string_1": null,
        "life_cycle_state": "ACTIVATED",
        "cancellation_reason": null,
        "udf_string_6": null,
        "udf_string_7": null,
        "udf_string_8": null
    },
    "status": {
        "code": "OK",
        "description": "",
        "message": ""
    }
}