You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 10
Next »
Name | Type | Description |
|---|
id | String | The ID of the retrieved voucher |
number | String | The number of the retrieved voucher |
| description | String | The description of the retrieved voucher |
| value | Number | The value of the retrieved voucher |
| extra_added_value | Number | The extra added value of the retrieved voucher |
| effective_date | Date | The date that the voucher becomes effective |
| expiration_date | Date | The date that the voucher expires |
life_cycle_state | String | The life cycle state of the retrieved voucher which can be DRAFT, ACCEPTED_FOR_ACTIVATION, NOT_ACCEPTED_FOR_ACTIVATION, ACTIVATED, USED, CANCELLED, PURGED |
udf_string_1 | String | User Defined Field of type String |
udf_string_2 | String | User Defined Field of type String |
udf_string_3 | String | User Defined Field of type String |
udf_string_4 | String | User Defined Field of type String |
udf_string_5 | String | User Defined Field of type String |
udf_string_6 | String | User Defined Field of type String |
udf_string_7 | String | User Defined Field of type String |
udf_string_8 | String | User Defined Field of type String |
udf_float_1 | Float | User Defined Field of type Float |
udf_float_2 | Float | User Defined Field of type Float |
udf_float_3 | Float | User Defined Field of type Float |
udf_float_4 | Float | User Defined Field of type Float |
udf_date_1 | Date | User Defined Field of type Date |
udf_date_2 | Date | User Defined Field of type Date |
udf_date_3 | Date | User Defined Field of type Date |
udf_date_4 | Date | User Defined Field of type Date |
| type | Voucher Type object | The type information of the retrieved voucher |
| lot | Vouchers Lot Object | The lot of the retrieved voucher |
| payment | Payment Object | The payment that was created and posted as a result of using the voucher. This information becomes available only if the voucher is used. |
| log_information | Log Information Object | The log information of the retrieved voucher |
| products_set | Set of Voucher Products Objects | The voucher products that can consume the amount of money that was paid through the voucher |
| allowed_organisational_units_set | Set of unit Objects | The organisational units that can use the specific voucher type |
Referred Objects Response Data
voucher_type response data object
| Name | Type | Description |
|---|
| Id | String | The ID of the retrieved voucher type |
| name | String | The Name of the retrieved voucher type |
| alternative_code | String | The Alternative Code of the retrieved voucher type |
| value_options | String | Defines if the value should be fixed, as defined in the voucher type, or a variable, as defined during the creation of the vouchers. The supported options are FIXED and VARIABLE |
| classification | String | The Classification of the retrieved voucher type |
| description | String | The Description of the retrieved voucher type |
lot response data object
| Name | Type | Description |
|---|
| Id | String | The ID of the retrieved lot |
| number | String | The number of the retrieved lot |
| alternative_code | String | The alternative code of the retrieved lot |
| description | String | The description of the retrieved lot |
payment object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved payment |
number | String | The number of the retrieved payment |
reference_number | String | The reference number of the retrieved payment |
life_cycle_state | String | The life cycle state of the payment. One of the following values is returned: DRAFT, REJECTED, POSTED, CANCELLED, PENDING_VERIFICATION |
| issued_on | Date | The date that the payment was issued |
| posted_on | Date | The date that the payment was posted |
| payment_amount | Number | The total amount of the payment |
| processed_by_payment_gateway | String | The payment gateway that processed the payment. This information becomes available only if the selected payment method is included in the payment gateway provider as a linked payment method, or if the payment is already posted and the information was already completed |
| payment_gateway_reference_number | String | A reference to the number of the payment that was created on the payment gateway. This information becomes available only if the selected payment method is included in the payment gateway provider as a linked payment method, or if the payment is already posted and the information was already completed |
| currency_rate_period | Currency Rate Period | The currency rate period based on which the refund was created |
Referred Objects Response Data
currency rate period object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved currency rate period |
| rate | Number | The exchange rate of the currency rate period |
| inverse_rate | Number | The inverse exchange rate of the currency rate period |
| from_date | Date | The date from which the exchange rate is valid |
| to_date | Date | The date until which the exchange rate is valid |
| currency | Currency Object | The Currency with which the returned exchange rate information refers to |
Referred Objects Response Data
currency object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved currency |
| code | String | The code of the retrieved currency |
| prefix_symbol | String | The prefix symbol for the specified currency |
suffix_symbol | String | The suffix symbol for the specified currency |
| life_cycle_state | String | The life cycle state for the specified currency, which can be EFFECTIVE or NOT EFFECTIVE |
| integer_part_name | String | The integer part name for the specified currency |
| decimal_part_name | String | The decimal part name for the specified currency |
log_information object response data
Name | Type | Description |
created_date | Date | The date that the retrieved record was created |
updated_date | Date | The last date that the retrieved record was updated |
created_by_unit | Unit Object | The unit that created the retrieved record |
created_by_business_unit | Unit Object | The unit that created the retrieved record |
created_by_user | User Object | The user that created the retrieved record |
updated_by_unit | Unit Object | The last unit that updated the retrieved record |
updated_by_business_unit | Unit Object | The last unit that updated the retrieved record |
updated_by_user | User Object | The last user that updated the retrieved record |
Referred Objects Response Data
unit object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved unit |
name | String | The name of the retrieved unit |
group_name | String | The name of the group that the retrieved unit belongs to |
community_name | String | The name of the community that the retrieved unit belongs to |
alternative_code | String | The alternative code of the retrieved unit |
description | String | The description of the retrieved unit |
business unit object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved business unit |
name | String | The name of the retrieved business unit |
| code | String | The code of the retrieved business unit |
| unified_code | String | The unified code of the retrieved business unit |
description | String | The description of the retrieved business unit |
| parent_business_unit_name | String | The name of the parent business unit that the retrieved business unit belongs to |
user object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved user |
username | String | The user name of the retrieved user |
person_name | String | The full name of the retrieved user |
email | String | The email of the retrieved user |
voucher_product object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved voucher product |
| product | Product object | The actual voucher product |
| product_type | Product Type object | The actual voucher product type |
Referred Objects Response Data
product object response data
| | |
|---|
| Id | String | The ID of the product |
| code | String | The code of product |
alternative_code | String | The alternative code of product |
description | String | The description of product |
| priority_level | Integer | The priority level of the product |
| global_rate | Global Rate Object | The global rate of the retrieved product |
| product_type | Product type object | The type of the product |
Referred Objects Response Data
product_type object data response
| Name | Type | Description |
|---|
| Id | String | The ID of the retrieved product type |
| name | String | The Name of the retrieved product type |
| alternative_code | String | The Alternative Code of the retrieved product type |
| description | String | The Description of the retrieved product type |
| classification | String | The Classification of the retrieved product type which can be SERVICES or PHYSICALGOODS |
| service_type | String | The Service Type of the retrieved product type which can be TERMED, USAGE, ONETIME or EXPENSE |
| physical_good_type | String | The physical Good Type of the retrieved product type which can be TRACEABLE or NONTRACEABLE |
| composition_method | String | The Composition Method of the retrieved product type which can be FLAT, FLEXIBLEBUNDLE or FIXEDBUNDLE |
| used_for_provisioning | Boolean | The flag shows if the retrieved product type is used for provisioning |
| udr_type | Usage Detail Record Type | The UDR type related with the product type. This is applicable only if the product type is classified as SERVICES and the service type is set to USAGE |
| meter_reading_type | Meter Reading Type | The Meter Reading type related with the product type. This is applicable only for traceable physical goods |
Referred Objects Response Data
usage_detail_record_type object data response
| Name | Type | Description |
|---|
| Id | String | The ID of the retrieved usage detail record type |
| name | String | The Name of the retrieved usage detail record type |
| alternative_code | String | The Alternative Code of the retrieved usage detail record type |
| description | String | The Description of the retrieved usage detail record type |
| unit_of_measurement | String | The Unit of measurement of the retrieved usage detail record type |
Referred Objects Response Data
unit_of_measurement object response data
Name | Type | Description |
| id | String | The identifier of the Unit of measurement |
name | String | The name of the Unit of measurement |
description | String | The description of the Unit of measurement |
| alternative_code | String | The alternative code of the Unit of measurement |
meter_reading_type object data response
| Name | Type | Description |
|---|
| Id | String | The ID of the retrieved meter reading type |
| name | String | The Name of the retrieved meter reading type |
| alternative_code | String | The Alternative Code of the retrieved meter reading type |
| classification | String | The Classification of the retrieved meter reading type |
| description | String | The Description of the retrieved meter reading type |
| unit_of_measurement | String | The Unit of measurement of the retrieved meter reading type |
Referred Objects Response Data
unit_of_measurement object response data
Name | Type | Description |
| id | String | The identifier of the Unit of measurement |
name | String | The name of the Unit of measurement |
description | String | The description of the Unit of measurement |
| alternative_code | String | The alternative code of the Unit of measurement |
global rate object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved rate |
| rate_model | String | The price plan rate model which can be one of the following: - QUANTITYBASED
- QUANTITYANDPERIODBASED
- BILLABLEPERIODBASED
- DURATIONBASED
- FLATFEEBASED
- USAGEBASED
|
| global_base_amount | Number | The base price of the product in the Global Price Plan |
| base_rate_applied_per | String | The value for 'Base Rate Applied per' Available when the rate model is 'Quantity & Quantity Based' and it is a selection between |
| uot | String | The 'UOT' applicable for the rate
- Seconds
- Minute
- Hour
- Day
- Week
- Month
- Year
Available for one-time services |
| time_period | Time Period Object | The period and unit of time for which the base amount is applicable for. This is available only on termed services rates. |
| uom | String | The 'UOM' applicable for the rate Available when the product type is of Usage Service Classification |
Referred Objects Response Data
period object response data
Name | Type | Description |
|---|
| time_period_value | Number | The time period value |
time_period_uot | String | The time period unit of time. The supported values are the following: MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS |
product_type object data response
| Name | Type | Description |
|---|
| Id | String | The ID of the retrieved product type |
| name | String | The Name of the retrieved product type |
| alternative_code | String | The Alternative Code of the retrieved product type |
| description | String | The Description of the retrieved product type |
| classification | String | The Classification of the retrieved product type which can be SERVICES or PHYSICALGOODS |
| service_type | String | The Service Type of the retrieved product type which can be TERMED, USAGE, ONETIME or EXPENSE |
| physical_good_type | String | The physical Good Type of the retrieved product type which can be TRACEABLE or NONTRACEABLE |
| composition_method | String | The Composition Method of the retrieved product type which can be FLAT, FLEXIBLEBUNDLE or FIXEDBUNDLE |
| used_for_provisioning | Boolean | The flag shows if the retrieved product type is used for provisioning |
| udr_type | Usage Detail Record Type | The UDR type related with the product type. This is applicable only if the product type is classified as SERVICES and the service type is set to USAGE |
| meter_reading_type | Meter Reading Type | The Meter Reading type related with the product type. This is applicable only for traceable physical goods |
Referred Objects Response Data
usage_detail_record_type object data response
| Name | Type | Description |
|---|
| Id | String | The ID of the retrieved usage detail record type |
| name | String | The Name of the retrieved usage detail record type |
| alternative_code | String | The Alternative Code of the retrieved usage detail record type |
| description | String | The Description of the retrieved usage detail record type |
| unit_of_measurement | String | The Unit of measurement of the retrieved usage detail record type |
Referred Objects Response Data
unit_of_measurement object response data
Name | Type | Description |
| id | String | The identifier of the Unit of measurement |
name | String | The name of the Unit of measurement |
description | String | The description of the Unit of measurement |
| alternative_code | String | The alternative code of the Unit of measurement |
meter_reading_type object data response
| Name | Type | Description |
|---|
| Id | String | The ID of the retrieved meter reading type |
| name | String | The Name of the retrieved meter reading type |
| alternative_code | String | The Alternative Code of the retrieved meter reading type |
| classification | String | The Classification of the retrieved meter reading type |
| description | String | The Description of the retrieved meter reading type |
| unit_of_measurement | String | The Unit of measurement of the retrieved meter reading type |
Referred Objects Response Data
unit_of_measurement object response data
Name | Type | Description |
| id | String | The identifier of the Unit of measurement |
name | String | The name of the Unit of measurement |
description | String | The description of the Unit of measurement |
| alternative_code | String | The alternative code of the Unit of measurement |
unit object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved unit |
name | String | The name of the retrieved unit |
group_name | String | The name of the group that the retrieved unit belongs to |
community_name | String | The name of the community that the retrieved unit belongs to |
alternative_code | String | The alternative code of the retrieved unit |
description | String | The description of the retrieved unit |