Versions Compared

Key

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

This method returns information related with an ad hoc discount. A single ad hoc discount is returned by each call

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

ad_hoc_discount_identifier

(mandatory)

Ad hoc discount identifier  

The identifier of the ad hoc discount that should be returned as a result. The allowed ad hoc discount identifier fields are the following:

Include Page
V4:ad_hoc_discount_identifier
V4:ad_hoc_discount_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
titleExample 1

HTTP Method: GET

 

Request:


Response:

 

Code Block
{
 "data": {
 "log_information": {
 "created_by_unit": {
 "alternative_code": "adminunit",
 "group_name": null,
 "community_name": null,
 "name": "Admin Unit",
 "description": "admin unit",
 "id": "1"
 },
 "updated_by_unit": {
 "alternative_code": "adminunit",
 "group_name": null,
 "community_name": null,
 "name": "Admin Unit",
 "description": "admin unit",
 "id": "1"
 },
 "created_date": "2018-05-22T16:03:32",
 "updated_date": "2018-05-22T16:03:43",
 "updated_by_user": {
 "person_name": null,
 "id": "1",
 "email": null,
 "username": "MPAdministrator"
 },
 "created_by_user": {
 "person_name": null,
 "id": "1",
 "email": null,
 "username": "MPAdministrator"
 }
 },
 "applied": false,
 "discount_amount": null,
 "for": null,
 "currency_rate_period": null,
 "approved_on": "2018-05-22T16:03:43",
 "discount_percentage": 25,
 "subscription": {
 "number": "S0000009445",
 "first_activated_date": "2018-05-22T16:01:53",
 "rating_state": "PENDING",
 "accounts_receivable": {
 "number": "ACR0000008693",
 "name": "Pricing sb13",
 "id": "F4596868402B497798D2670167DD48EB",
 "life_cycle_state": "ACTIVE",
 "account_owner": {
 "company_profile": {
 "tax_reference_number": null,
 "registered_in_country": null,
 "number_of_employees": null,
 "annual_turnover": null,
 "profile_year": null,
 "registration_number": null,
 "vat_registration_number": null,
 "industry_sector": null,
 "industry": null,
 "established_date": null,
 "vat_registered_by": null,
 "vat_registration_date": null
 },
 "company_name": "Pricing sb13",
 "name": "Pricing sb13",
 "last_name": null,
 "id": "995A38E92EA84AE196DBB2AFE34D77D3",
 "life_cycle_state": "FINANCIAL",
 "middle_name": null,
 "title": null,
 "type": "COMPANY",
 "first_name": null,
 "demographics": null
 }
 },
 "id": "675F495B6D9D4D72976245681124062E",
 "life_cycle_state": "EFFECTIVE",
 "type": {
 "alternative_code": "normalsub",
 "name": "Normal",
 "description": null,
 "id": "D1BAE6454A2248189EBCD7ADD3B4B65F",
 "classification": "FLEXIBLE"
 }
 },
 "expiration_date": null,
 "udf_date_2": null,
 "udf_date_1": null,
 "udf_date_4": null,
 "products_set": [
 {
 "product": {
 "code": "Bronze",
 "product_type": {
 "meter_reading_type": null,
 "service_type": "TERMED",
 "used_for_provisioning": true,
 "alternative_code": "Main Packages",
 "udr_type": null,
 "composition_method": "FLAT",
 "name": "Main Packages",
 "description": null,
 "id": "E186E293AAAB49EE86A729540A4287FE",
 "classification": "SERVICES",
 "physical_good_type": null
 },
 "alternative_code": "B",
 "description": "Bronze",
 "id": "F50CC52934BD4F119B6E18E215A4FC55",
 "priority_level": null
 },
 "id": "883B600A33D24AE28E903DDD1B9D71F5"
 }
 ],
 "udf_date_3": null,
 "number": "12",
 "udf_float_3": null,
 "udf_float_4": null,
 "effective_date": null,
 "id": "72084FE2E47E4C90836B099AFBAFF9B9",
 "udf_float_1": null,
 "approval_method": "AUTOMATIC",
 "udf_float_2": null,
 "udf_string_2": null,
 "udf_string_3": null,
 "udf_string_4": null,
 "udf_string_5": null,
 "cancelled_by": null,
 "udf_string_1": null,
 "additive_discount_definition": {
 "alternative_code": "PS2",
 "name": "Pricing SB 21",
 "id": "9F0CFA4CDCBB47578FB2651D561BC233",
 "life_cycle_state": "EFFECTIVE",
 "classification": "SUBSCRIPTIONS",
 "type": "AD_HOC"
 },
 "life_cycle_state": "APPROVED",
 "cancelled_on": null,
 "provided_on": "2018-05-22T16:03:43",
 "approved_by": {
 "person_name": null,
 "id": "1",
 "email": null,
 "username": "MPAdministrator"
 },
 "applied_on": null,
 "provided_by": {
 "person_name": null,
 "id": "1",
 "email": null,
 "username": "MPAdministrator"
 },
 "renew": null,
 "udf_string_6": null,
 "job": null,
 "udf_string_7": null,
 "discount_free_usage": null,
 "udf_string_8": null
 },
 "status": {
 "code": "OK",
 "description": "",
 "message": ""
 }
}