Page Comparison

Tip
Available from CRM.COM R6.0.0
Table of Contents
maxLevel	2
...
Name
Type
Description
token
String
The token retrieved from the login method
group_identifier
(optional)
Group Identifier
The identifier of the group that will be providing vouchers of this type. The group is filtered against the voucher types' allowed organisational units. The allowed group identifier fields are the following:
Include Page
	V4:group_identifier
	V4:group_identifier
unit_identifier
(optional)
Unit Identifier
The identifier of the unit that will be providing vouchers of this type. The unit is filtered against the voucher types' allowed organisational units. The allowed unit identifier fields are the following:
Include Page
	V4:unit_identifier
	V4:unit_identifier
fields_set
(optional)
List of Strings, comma separated
A list of fields that should be included in the results. If not specified then all the available fields will be returned
...
Expand
title	Example 1
HTTP Method: GET
Request:
Response:
Code Block
theme	Confluence
language	javascript
linenumbers	true
 {
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    [
        {
            "extra_added_value": 30,
            "value_option": "FIXED",
            "udf_float_1": null,
            "products_set":
            [
            ],
            "udf_float_2": null,
            "udf_float_3": null,
            "udf_float_4": null,
            "udf_string_1": null,
            "name": "All Services",
            "udf_string_2": null,
            "udf_string_3": null,
            "secret_number_length": 30,
            "udf_string_4": null,
            "udf_string_5": null,
            "udf_string_6": null,
            "default_payment_type":
            {
                "classification": "PAYMENT",
                "name": "Voucher Payment",
                "id": "52D551A10EC4D35DD79A9AAAF37A1C99",
                "description": null,
                "alternative_code": "VP"
            },
            "udf_string_7": null,
            "udf_string_8": null,
            "id": "0676431B43CF9936490CCE91E961A5E0",
            "udf_date_1": null,
            "udf_date_2": null,
            "udf_date_3": null,
            "udf_date_4": null,
            "value": 30,
            "log_information":
            {
                "updated_date": "2014-08-19T10:16:48",
                "created_by_unit":
                {
                    "name": "Admin Unit",
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "description": "r1",
                    "alternative_code": "MG"
                },
                "created_date": "2014-08-19T10:16:11",
                "updated_by_unit":
                {
                    "name": "Admin Unit",
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "description": "r1",
                    "alternative_code": "MG"
                },
                "created_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1"
                },
                "updated_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1"
                }
            },
            "description": null,
            "alternative_code": "AS"
        },
        {
            "value_option": "VARIABLE",
            "udf_float_1": null,
            "udf_float_2": null,
            "products_set":
            [
            ],
            "udf_float_3": null,
            "udf_float_4": null,
            "udf_string_1": null,
            "name": "All Services - No Value",
            "udf_string_2": null,
            "udf_string_3": null,
            "secret_number_length": null,
            "udf_string_4": null,
            "udf_string_5": null,
            "udf_string_6": null,
            "default_payment_type":
            {
                "classification": "PAYMENT",
                "name": "Voucher Payment",
                "id": "52D551A10EC4D35DD79A9AAAF37A1C99",
                "description": null,
                "alternative_code": "VP"
            },
            "udf_string_7": null,
            "udf_string_8": null,
            "id": "66165C1D847811FF1C2BF2839D7000CA",
            "udf_date_1": null,
            "udf_date_2": null,
            "udf_date_3": null,
            "udf_date_4": null,
            "log_information":
            {
                "updated_date": "2014-08-19T10:17:21",
                "created_by_unit":
                {
                    "name": "Admin Unit",
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "description": "r1",
                    "alternative_code": "MG"
                },
                "created_date": "2014-08-19T10:16:55",
                "updated_by_unit":
                {
                    "name": "Admin Unit",
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "description": "r1",
                    "alternative_code": "MG"
                },
                "created_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1"
                },
                "updated_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1"
                }
            },
            "description": null,
            "alternative_code": "AS-NV"
        },
        {
            "extra_added_value": 50,
            "value_option": "FIXED",
            "udf_float_1": null,
            "products_set":
            [
                {
                    "id": "6397067066F08C426BBDEC93CB8C69D0",
                    "product":
                    {
                        "product_type":
                        {
                            "physical_good_type": null,
                            "service_type": "TERMED",
                            "used_for_provisioning": true,
                            "composition_method": "FLAT",
                            "classification": "SERVICES",
                            "name": "Subscription Packages",
                            "id": "BC954969D3172372D498D3BB2BA590A0",
                            "description": "Subscription main packages",
                            "alternative_code": "SP"
                        },
                        "id": "17540C21EAB9C50D0945F12313B79875",
                        "description": "Silver Basic Package",
                        "code": "Silver",
                        "alternative_code": "SBP"
                    }
                },
                {
                    "id": "79BAEE8DA8A6A3F5D8309A80E31C1EA3",
                    "product":
                    {
                        "product_type":
                        {
                            "physical_good_type": null,
                            "service_type": "TERMED",
                            "used_for_provisioning": true,
                            "composition_method": "FLAT",
                            "classification": "SERVICES",
                            "name": "Subscription Packages",
                            "id": "BC954969D3172372D498D3BB2BA590A0",
                            "description": "Subscription main packages",
                            "alternative_code": "SP"
                        },
                        "id": "6DF884D00A643D9E5E3E95A5ABCCFDF8",
                        "description": "Gold Premium Package",
                        "code": "Gold",
                        "alternative_code": "GPP"
                    }
                },
                {
                    "id": "3011771D23933EAC425EE324DFE924FC",
                    "product":
                    {
                        "product_type":
                        {
                            "physical_good_type": null,
                            "service_type": "TERMED",
                            "used_for_provisioning": true,
                            "composition_method": "FLAT",
                            "classification": "SERVICES",
                            "name": "Subscription Packages",
                            "id": "BC954969D3172372D498D3BB2BA590A0",
                            "description": "Subscription main packages",
                            "alternative_code": "SP"
                        },
                        "id": "2C0E72A735F71582FFC765F3421CE6A5",
                        "description": "Platinum Packages",
                        "code": "Platinum",
                        "alternative_code": "PS"
                    }
                }
            ],
            "udf_float_2": null,
            "udf_float_3": null,
            "udf_float_4": null,
            "udf_string_1": null,
            "name": "Premium Services",
            "udf_string_2": null,
            "udf_string_3": null,
            "secret_number_length": 50,
            "udf_string_4": null,
            "udf_string_5": null,
            "udf_string_6": null,
            "default_payment_type":
            {
                "classification": "PAYMENT",
                "name": "Voucher Payment",
                "id": "52D551A10EC4D35DD79A9AAAF37A1C99",
                "description": null,
                "alternative_code": "VP"
            },
            "udf_string_7": null,
            "udf_string_8": null,
            "id": "DAEC7C38AF21B8E435FAFFA567D8B82C",
            "udf_date_1": null,
            "udf_date_2": null,
            "udf_date_3": null,
            "udf_date_4": null,
            "value": 50,
            "log_information":
            {
                "updated_date": "2014-08-19T10:18:39",
                "created_by_unit":
                {
                    "name": "Admin Unit",
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "description": "r1",
                    "alternative_code": "MG"
                },
                "created_date": "2014-08-19T10:17:34",
                "updated_by_unit":
                {
                    "name": "Admin Unit",
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "description": "r1",
                    "alternative_code": "MG"
                },
                "created_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1"
                },
                "updated_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1"
                }
            },
            "description": null,
            "alternative_code": "PS"
        },
        {
            "extra_added_value": 50,
            "value_option": "FIXED",
            "udf_float_1": null,
            "products_set":
            [
                {
                    "id": "9C28231978F2620EC564FBE927982324",
                    "product":
                    {
                        "product_type":
                        {
                            "physical_good_type": null,
                            "service_type": "TERMED",
                            "used_for_provisioning": true,
                            "composition_method": "FLAT",
                            "classification": "SERVICES",
                            "name": "Subscription Packages",
                            "id": "BC954969D3172372D498D3BB2BA590A0",
                            "description": "Subscription main packages",
                            "alternative_code": "SP"
                        },
                        "id": "17540C21EAB9C50D0945F12313B79875",
                        "description": "Silver Basic Package",
                        "code": "Silver",
                        "alternative_code": "SBP"
                    }
                },
                {
                    "id": "FDB189D1AA56F8303B1A1C82A836942A",
                    "product":
                    {
                        "product_type":
                        {
                            "physical_good_type": null,
                            "service_type": "TERMED",
                            "used_for_provisioning": true,
                            "composition_method": "FLAT",
                            "classification": "SERVICES",
                            "name": "Subscription Packages",
                            "id": "BC954969D3172372D498D3BB2BA590A0",
                            "description": "Subscription main packages",
                            "alternative_code": "SP"
                        },
                        "id": "6DF884D00A643D9E5E3E95A5ABCCFDF8",
                        "description": "Gold Premium Package",
                        "code": "Gold",
                        "alternative_code": "GPP"
                    }
                },
                {
                    "id": "A9B0992C2E82C6974D2C4EFC41A7A9F3",
                    "product":
                    {
                        "product_type":
                        {
                            "physical_good_type": null,
                            "service_type": "TERMED",
                            "used_for_provisioning": true,
                            "composition_method": "FLAT",
                            "classification": "SERVICES",
                            "name": "Subscription Packages",
                            "id": "BC954969D3172372D498D3BB2BA590A0",
                            "description": "Subscription main packages",
                            "alternative_code": "SP"
                        },
                        "id": "2C0E72A735F71582FFC765F3421CE6A5",
                        "description": "Platinum Packages",
                        "code": "Platinum",
                        "alternative_code": "PS"
                    }
                }
            ],
            "udf_float_2": null,
            "udf_float_3": null,
            "udf_float_4": null,
            "udf_string_1": null,
            "name": "Premium Services -10 euros free offer",
            "udf_string_2": null,
            "udf_string_3": null,
            "secret_number_length": 50,
            "udf_string_4": null,
            "udf_string_5": null,
            "udf_string_6": null,
            "default_payment_type":
            {
                "classification": "PAYMENT",
                "name": "Voucher Payment",
                "id": "52D551A10EC4D35DD79A9AAAF37A1C99",
                "description": null,
                "alternative_code": "VP"
            },
            "udf_string_7": null,
            "udf_string_8": null,
            "id": "CF4E5614BFB0BA55C8ECE3034CBF51FF",
            "udf_date_1": null,
            "udf_date_2": null,
            "udf_date_3": null,
            "udf_date_4": null,
            "value": 50,
            "log_information":
            {
                "updated_date": "2014-08-19T10:22:39",
                "created_by_unit":
                {
                    "name": "Admin Unit",
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "description": "r1",
                    "alternative_code": "MG"
                },
                "created_date": "2014-08-19T10:19:29",
                "updated_by_unit":
                {
                    "name": "Admin Unit",
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "description": "r1",
                    "alternative_code": "MG"
                },
                "created_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1"
                },
                "updated_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1"
                }
            },
            "description": null,
            "alternative_code": "PS-10E"
        },
        {
            "value_option": "VARIABLE",
            "udf_float_1": null,
            "udf_float_2": null,
            "products_set":
            [
                {
                    "id": "23CFDC7094E36389FA76F6C5ADBF8660",
                    "product":
                    {
                        "product_type":
                        {
                            "physical_good_type": null,
                            "service_type": "USAGE",
                            "used_for_provisioning": true,
                            "composition_method": "FLAT",
                            "classification": "SERVICES",
                            "name": "3Play ",
                            "id": "92F0AFC840E91633C5212162303BE8DF",
                            "description": "3Play Packages (Gold, Silver etc)",
                            "alternative_code": "3PLAY"
                        },
                        "id": "F43EBDCE48CAADEC32CB26F59904ECCD",
                        "description": "Smart Card",
                        "code": "Smart Card",
                        "alternative_code": null
                    }
                },
                {
                    "id": "6F65E0D8AEEC137F0BF3F208D9673EF1",
                    "product":
                    {
                        "product_type":
                        {
                            "physical_good_type": null,
                            "service_type": "USAGE",
                            "used_for_provisioning": true,
                            "composition_method": "FLAT",
                            "classification": "SERVICES",
                            "name": "3Play ",
                            "id": "92F0AFC840E91633C5212162303BE8DF",
                            "description": "3Play Packages (Gold, Silver etc)",
                            "alternative_code": "3PLAY"
                        },
                        "id": "F4C4D0B88F3770588AE9A7587C5314A8",
                        "description": "Set Top Box",
                        "code": "Set Top Box",
                        "alternative_code": null
                    }
                }
            ],
            "udf_float_3": null,
            "udf_float_4": null,
            "udf_string_1": null,
            "name": "Variable Voucher Type",
            "udf_string_2": null,
            "udf_string_3": null,
            "secret_number_length": null,
            "udf_string_4": null,
            "udf_string_5": null,
            "udf_string_6": null,
            "default_payment_type":
            {
                "classification": "PAYMENT",
                "name": "Payment 1",
                "id": "84C4E6996B0DC91307D0D9DBBE7D325E",
                "description": "Payment 1",
                "alternative_code": "P1"
            },
            "udf_string_7": null,
            "udf_string_8": null,
            "id": "98E333F3122CCFCB2B36747EF58FE925",
            "udf_date_1": null,
            "udf_date_2": null,
            "udf_date_3": null,
            "udf_date_4": null,
            "log_information":
            {
                "updated_date": "2014-08-21T12:36:37",
                "created_by_unit":
                {
                    "name": "Admin Unit",
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "description": "r1",
                    "alternative_code": "MG"
                },
                "created_date": "2014-08-06T15:22:23",
                "updated_by_unit":
                {
                    "name": "Admin Unit",
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "description": "r1",
                    "alternative_code": "MG"
                },
                "created_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1"
                },
                "updated_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1"
                }
            },
            "description": "Variable Voucher Type",
            "alternative_code": "VVT"
        },
        {
            "extra_added_value": 12,
            "value_option": "FIXED",
            "udf_float_1": null,
            "products_set":
            [
                {
                    "id": "7D84D555852C905267856032C76393AA",
                    "product":
                    {
                        "product_type":
                        {
                            "physical_good_type": null,
                            "service_type": "USAGE",
                            "used_for_provisioning": true,
                            "composition_method": "FLAT",
                            "classification": "SERVICES",
                            "name": "Subscription",
                            "id": "2B0EC029035C637200648C9B2D6A2FFB",
                            "description": "Subscription channels",
                            "alternative_code": "SUBSCRIPTION"
                        },
                        "id": "CA05E389D3874A44278047A6109AC975",
                        "description": "International",
                        "code": "International",
                        "alternative_code": null
                    }
                },
                {
                    "id": "7F6901A65F356E0E0C2A9E1E8C1829B8",
                    "product":
                    {
                        "product_type":
                        {
                            "physical_good_type": null,
                            "service_type": "USAGE",
                            "used_for_provisioning": true,
                            "composition_method": "FLAT",
                            "classification": "SERVICES",
                            "name": "Subscription",
                            "id": "2B0EC029035C637200648C9B2D6A2FFB",
                            "description": "Subscription channels",
                            "alternative_code": "SUBSCRIPTION"
                        },
                        "id": "DE37CF1696E3CD4E8EF89F522019D385",
                        "description": "Documentaries",
                        "code": "Documentaries",
                        "alternative_code": null
                    }
                },
                {
                    "id": "D2AEB74FD6FC8F09CD477DE4B99DB536",
                    "product":
                    {
                        "product_type":
                        {
                            "physical_good_type": null,
                            "service_type": "USAGE",
                            "used_for_provisioning": true,
                            "composition_method": "FLAT",
                            "classification": "SERVICES",
                            "name": "Subscription",
                            "id": "2B0EC029035C637200648C9B2D6A2FFB",
                            "description": "Subscription channels",
                            "alternative_code": "SUBSCRIPTION"
                        },
                        "id": "E7558FAB3E126741558578B6471C07C9",
                        "description": "Sports ",
                        "code": "Sports ",
                        "alternative_code": null
                    }
                }
            ],
            "udf_float_2": null,
            "udf_float_3": null,
            "udf_float_4": null,
            "udf_string_1": null,
            "name": "Fixed Voucher Type",
            "udf_string_2": null,
            "udf_string_3": null,
            "secret_number_length": 12,
            "udf_string_4": null,
            "udf_string_5": null,
            "udf_string_6": null,
            "default_payment_type":
            {
                "classification": "PAYMENT",
                "name": "Invoices Balance Payment",
                "id": "9CC46F8C0A203CCA7A40B58825E74704",
                "description": null,
                "alternative_code": "INVBALPAY"
            },
            "udf_string_7": null,
            "udf_string_8": null,
            "id": "3F1F84F4195B7804483B0C6823A90AD3",
            "udf_date_1": null,
            "udf_date_2": null,
            "udf_date_3": null,
            "udf_date_4": null,
            "value": 12,
            "log_information":
            {
                "updated_date": "2014-08-21T11:36:52",
                "created_by_unit":
                {
                    "name": "Admin Unit",
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "description": "r1",
                    "alternative_code": "MG"
                },
                "created_date": "2014-08-07T16:37:41",
                "updated_by_unit":
                {
                    "name": "Admin Unit",
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "description": "r1",
                    "alternative_code": "MG"
                },
                "created_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1"
                },
                "updated_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1"
                }
            },
            "description": "Fixed Voucher Type",
            "alternative_code": "FVT"
        },
        {
            "extra_added_value": 30,
            "value_option": "FIXED",
            "udf_float_1": null,
            "products_set":
            [
            ],
            "udf_float_2": null,
            "udf_float_3": null,
            "udf_float_4": null,
            "udf_string_1": null,
            "name": "VoucherTypeA",
            "udf_string_2": null,
            "udf_string_3": null,
            "secret_number_length": 30,
            "udf_string_4": null,
            "udf_string_5": null,
            "udf_string_6": null,
            "default_payment_type": null,
            "udf_string_7": null,
            "udf_string_8": null,
            "id": "F53D95A6AE009D82451A2A445A9B4084",
            "udf_date_1": null,
            "udf_date_2": null,
            "udf_date_3": null,
            "udf_date_4": null,
            "value": 30,
            "log_information":
            {
                "updated_date": "2013-02-12T11:18:59",
                "created_by_unit": null,
                "created_date": "2013-02-12T10:43:19",
                "updated_by_unit": null,
                "created_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1"
                },
                "updated_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1"
                }
            },
            "description": "Test data",
            "alternative_code": "TD"
        }
    ]
}
Versions Compared

Old Version 4

New Version 5

Key
