Page Comparison

...

Tip
From CRM.COM R14R13.1.0 and onwards

Tip
Deprecated from CRM.COM R17.0.0 and onwards

Excerpt
This method cancels a voucher of classification Electronic Voucher. Single voucher is used cancelled by each call

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

voucher_identifier

(mandatory)

Voucher identifier

The identifier of the voucher that should be cancelled. The allowed vouchers identifier fields are the following:

Include Page

	V4:voucher_identifier
	V4:voucher_identifier

cancelltion

cancellation_reason
(mandatory)

String

The cancellation reason of cancelling the voucher. Available and applicable values are:

CANCEL_DUE_TO

VOUCHER_RETURN

CANCEL_DUE

VOUCHER_

TO_

LOSS

CANCEL_DUE

VOUCHER_

TO_

FRAUD

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

Restrictions

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

...

Expand

title	Example 1

HTTP Method: POST

Request:

Body

Code Block

language	js
theme	Confluence	language	js
linenumbers	true

 {
    "token":"{{token}}",
    "voucher_identifier":{"number":"V00201314"},
    "cancellation_reason":"VOUCHER_RETURN"
}

Response:

Code Block

language	js
theme	Confluence
language	js
linenumbers	true

...


linenumbers	true

 {
    "data": {
        "allowed_organisational_units_set": [
            {
                "alternative_code": "C_2",
                "group_name": null,
                "community_name": "CommunityB",
                "name": null,
                "description": null,
                "id": "6675EA5E025341E0A692D9FEEF9CC626"
            },
            {
                "alternative_code": "adminunit",
                "group_name": null,
                "community_name": null,
                "name": "Admin Unit",
                "description": "admin unit",
                "id": "312DE215AB7B44D3B09974166DD23F59"
            }
        ],
        "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-18T10:03:16",
            "updated_date": "2017-09-18T10:34:21",
            "updated_by_user": {
                "person_name": "CRM COM",
                "id": "1",
                "email": "dev@crm.com",
                "username": "MPAdministrator"
            },
            "created_by_user": {
                "person_name": "MPAdministrator",
                "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": null,
        "extra_added_value": 2,
        "expiration_date": "2018-02-18T10:03:20",
        "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": null,
                "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
                },
                "id": "AC1DD16CD7584285A1FE83E37043A8A0"
            }
        ],
        "udf_date_3": null,
        "number": "V00201314",
        "udf_float_3": null,
        "udf_float_4": null,
        "sold_by": null,
        "effective_date": "2017-09-18T10:03:20",
        "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": "BB158F68E173498B8C2167C2C3C9CFC9",
        "udf_float_1": null,
        "value": 26,
        "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": "CANCELLED",
        "cancellation_reason": "VOUCHER_RETURN",
        "udf_string_6": null,
        "udf_string_7": null,
        "udf_string_8": null
    },
    "status": {
        "code": "OK",
        "description": "",
        "message": ""
    }
}

Versions Compared

Old Version 4

New Version Current

Key

Resource URL

Parameters

Restrictions