...
...
...
...
...
| Tip |
|---|
Available from CRM.COM R4.0.0 |
| Excerpt |
This method returns information related with a voucher. Single voucher is returned by each call |
Resource URL
http://host_name/crmapi/rest/$version/vouchers/show
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 returned as a result. The allowed vouchers identifier fields are the following:
| ||||||
fields_set (optional) | List of Strings, comma separated | A list of fields that should be included in the results. If not specified then all the available fields will be returned |
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
...
| Expand | ||||||
|---|---|---|---|---|---|---|
| ||||||
HTTP Method: GET
Request: Response: Code Block | | |||||
| theme | Confluence | language | js
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"status":
{
"message": "",
"description": "",
"code": "OK"
},
"data":
{
"extra_added_value": 20,
"payment":
{
"payment_amount": 10,
"issued_on": "2015-09-23T12:28:48",
"life_cycle_state": "POSTED",
"number": "290",
"id": "DFB1C885EE9F4161867E4E5342C4C9C0",
"reference_number": "318",
"posted_on": "2015-09-23T12:29:35"
},
"effective_date": "2015-09-23T11:58:51",
"udf_float_1": null,
"products_set":
[
{
"product_type":
{
"service_type": null,
"physical_good_type": "NONTRACEABLE",
"used_for_provisioning": false,
"classification": "PHYSICALGOODS",
"composition_method": "FLAT",
"id": "0F94B51F175F06A475EB2948B4030074",
"name": "Accessories",
"description": "A type which is used for accessories physical goods",
"alternative_code": "005"
},
"id": "6DE4DD83F5424E2EAE22F457A0700315",
"product": null
},
{
"product_type": null,
"id": "6B669397A8DD4427B99B568B40CC2DCD",
"product":
{
"product_type":
{
"service_type": null,
"physical_good_type": "TRACEABLE",
"used_for_provisioning": false,
"classification": "PHYSICALGOODS",
"composition_method": "FLAT",
"id": "6173FC99331504AD1ACB5D697D54DA8C",
"name": "Smartcards",
"description": "Smartcards",
"alternative_code": "SC"
},
"id": "EAC7A30429364176616CFEF5DF709941",
"description": "Smartcard 1",
"code": "Smartcard 1",
"alternative_code": "SC1"
}
},
{
"product_type":
{
"service_type": "TERMED",
"physical_good_type": null,
"used_for_provisioning": true,
"classification": "SERVICES",
"composition_method": "FLAT",
"id": "87CCEDE0A717DC5863EAA01625BD8727",
"name": "Add-ons",
"description": "Additional products",
"alternative_code": "AO"
},
"id": "ADC336F40F674E00886E925118D5F267",
"product": null
},
{
"product_type": null,
"id": "847ED5B04D7A46A3A52B08673875C3B9",
"product":
{
"product_type":
{
"service_type": null,
"physical_good_type": "NONTRACEABLE",
"used_for_provisioning": false,
"classification": "PHYSICALGOODS",
"composition_method": "FLAT",
"id": "1FFC6C62DABA4C7BAA3536C24104E58A",
"name": "Software Product",
"description": null,
"alternative_code": "SP_1"
},
"id": "6F5CCD94E04D1CCBF8F2A090588280C9",
"description": "Basic: Local + Documentaries
Used for API unit testing, please do not modify.",
"code": "Product A",
"alternative_code": "P"
}
}
],
"udf_float_2": null,
"udf_float_3": null,
"number": "1946",
"udf_float_4": null,
"udf_string_1": null,
"udf_string_2": null,
"udf_string_3": null,
"udf_string_4": null,
"allowed_organisational_units_set":
[
{
"community_name": null,
"id": "3610DD6044854DEBBB6E7DF8427222A0",
"name": null,
"group_name": "Finance Group",
"description": null,
"alternative_code": null
},
{
"community_name": null,
"id": "89758E0D06FB4803A6716B8A914BF676",
"name": "Team Leaders SB2",
"group_name": null,
"description": null,
"alternative_code": null
}
],
"udf_string_5": null,
"udf_string_6": null,
"lot":
{
"number": "55",
"id": "756B505F1E9646799F68EC422A367E0A",
"description": "Test Voucher Product - Type",
"alternative_code": "Test Voucher Product - Type"
},
"udf_string_7": null,
"udf_string_8": null,
"id": "2087CAD625A748BC9572843129E6909E",
"udf_date_1": null,
"udf_date_2": null,
"udf_date_3": null,
"udf_date_4": null,
"log_information":
{
"updated_date": "2015-09-23T12:30:37",
"created_date": "2015-09-23T11:59:53",
"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": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": "sakkascy1986@hotmail.com"
},
"updated_by_user":
{
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": "sakkascy1986@hotmail.com"
}
},
"value": 10,
"life_cycle_state": "USED",
"type":
{
"value_options": "VARIABLE",
"id": "03624A0BF6FEFA560C8886B8A429D316",
"name": "All Services - No Value",
"description": null,
"alternative_code": "ASNV"
},
"description": null,
"expiration_date": "2015-10-31T00:00:00"
}
} |
| Expand | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: GET Request: Response:
|