Select
Schemas
CommercialProductSimple
|
|
Name | Type | Required | Description |
---|---|---|---|
id | string | false | none |
name | string | false | none |
marketing_name | string | false | none |
digital_channels_name | string | false | name used within digital channels |
invoice_name | string | false | none |
invoice_description | string | false | none |
in_catalogue_since | string(date-time) | false | none |
in_catalogue_until | string(date-time) | false | none |
mysim_commercial_product_id | string | false | internal id used within MySim |
data_sharing_compatible | boolean | false | none |
penalty_reference | number(double) | false | it is the reference price of the fee to take in account when a penalty is applied to the terminal |
max_devices | integer | false | Maximum number of STBs that can be purchased associated with an TV tariff. |
max_concurrent_views | integer | false | Maximum number of concurrent views allowed for the TV tariff. |
getCPByComProfile_Response
|
|
Name | Type | Required | Description |
---|---|---|---|
anonymous | CommercialProductSimple | false | none |
Name | Type | Required | Description |
---|---|---|---|
anonymous | object | false | none |
» from | string(date-time) | false | date when the commercial product starts to be included within the commercial profile |
» to | string(date-time) | false | date when the commercial product starts to be included within the commercial profile |
CommercialProductBasic
|
|
Name | Type | Required | Description |
---|---|---|---|
anonymous | CommercialProductSimple | false | none |
Name | Type | Required | Description |
---|---|---|---|
anonymous | object | false | none |
» billing_type | CommercialProductBasic_billing_type | false | none |
» subs_type | SubsTypeName_Response | false | none |
» fees | [Fee_Response] | false | none |
CommercialProduct_Response
|
|
Name | Type | Required | Description |
---|---|---|---|
anonymous | CommercialProductSimple | false | none |
Name | Type | Required | Description |
---|---|---|---|
anonymous | object | false | none |
» free_units_packages | [FreeUnitsPackage_Response] | false | none |
» promotions | [PromotionDetail_Response] | false | none |
» commercial_profiles | [CommercialProfile_Response] | false | none |
» fees | [Fee_Response] | false | none |
CommercialProduct_SubsTypeName_Response
|
|
Name | Type | Required | Description |
---|---|---|---|
anonymous | CommercialProduct_Response | false | none |
Name | Type | Required | Description |
---|---|---|---|
anonymous | object | false | none |
» subs_type | SubsTypeName_Response | false | none |
» fees | [Fee_Response] | false | none |
SwitchCommercialProduct_Response
|
|
Name | Type | Required | Description |
---|---|---|---|
anonymous | CommercialProduct_Response | false | none |
Name | Type | Required | Description |
---|---|---|---|
anonymous | object | false | none |
» used_for_automatic_orphan_subscription_change | boolean | false | indicates if the change is supposed to be used for automatic commercial product changes triggered when a subscription within a package becomes orphan (i.e after partial deactivation of fixed and broadband within a 3P package, the mobile subscription becomes orphan) |
CommercialProductBasic_billing_type
|
|
Name | Type | Required | Description |
---|---|---|---|
id | string | false | none |
name | string | false | none |
description | string | false | none |
BundledProduct_Response
|
|
Name | Type | Required | Description |
---|---|---|---|
id | string | false | none |
name | string | false | none |
marketing_name | string | false | none |
digital_channels_name | string | false | name used within digital channels |
bundled_segment | BundledSegment_Response | false | none |
invoice_name | string | false | none |
invoice_description | string | false | none |
in_catalogue_since | string(date-time) | false | none |
in_catalogue_until | string(date-time) | false | none |
category | BundleCategory_Response | false | none |
category_id | string | false | none |
bundled_type | BundledType_Response | false | none |
download_speed | string | false | real provisioning download speed, used for filtering purpose within API consumers, fo bundled product with category (‘Fixed+Broadband' or ‘Fixed+Broadband+Mobile’ or ‘Fixed+Broadband+Mobile+TV’) and with technology = 2 (FTTH). Null for bundled products with category ((‘Fixed+Broadband' or ‘Fixed+Broadband+Mobile’ or ‘Fixed+Broadband+Mobile+TV’) and with technology = 1 (ADSL)) or bundled products with category ‘Fixed+Mobile’ |
upload_speed | string | false | real provisioning upload speed, used for filtering purpose within API consumers, fo bundled product with category (‘Fixed+Broadband' or ‘Fixed+Broadband+Mobile’ or ‘Fixed+Broadband+Mobile+TV’) and with technology = 2 (FTTH). Null for bundled products with category ((‘Fixed+Broadband' or ‘Fixed+Broadband+Mobile’ or ‘Fixed+Broadband+Mobile+TV’) and with technology = 1 (ADSL)) or bundled products with category ‘Fixed+Mobile’ |
internet_speed | string | false | commercial speed to be shown to client, could be different than the down and upload provisioning speed, used for filtering purpose within API consumers, fo bundled product with category (‘Fixed+Broadband' or ‘Fixed+Broadband+Mobile’ or ‘Fixed+Broadband+Mobile+TV’) and with technology = 2 (FTTH). Null for bundled products with category ((‘Fixed+Broadband' or ‘Fixed+Broadband+Mobile’ or ‘Fixed+Broadband+Mobile+TV’) and with technology = 1 (ADSL)) or bundled products with category ‘Fixed+Mobile’ |
fees | [Fee_Response] | false | none |
bundled_product_subs_types | [BundledProductSubsType] | false | array of subscription types included within the bundled products |
promotions | [PromotionDetail_Response] | false | array of promotions compatible with the bundled product |
commercial_profiles | [CommercialProfile_Response] | false | none |
SwitchBundledProduct_Response
|
|
Name | Type | Required | Description |
---|---|---|---|
id | string | false | none |
name | string | false | none |
marketing_name | string | false | none |
digital_channels_name | string | false | name used within digital channels |
bundled_segment | BundledSegment_Response | false | none |
category | BundleCategory_Response | false | none |
category_id | string | false | none |
bundled_type | BundledType_Response | false | none |
download_speed | string | false | used for filtering purpose within API consumers, fo bundled product with category (‘Fixed+Broadband' or ‘Fixed+Broadband+Mobile’ or ‘Fixed+Broadband+Mobile+TV’) and with technology = 2 (FTTH). Null for bundled products with category ((‘Fixed+Broadband' or ‘Fixed+Broadband+Mobile’ or ‘Fixed+Broadband+Mobile+TV’) and with technology = 1 (ADSL)) or bundled products with category ‘Fixed+Mobile’ |
upload_speed | string | false | used for filtering purpose within API consumers, fo bundled product with category (‘Fixed+Broadband' or ‘Fixed+Broadband+Mobile’ or ‘Fixed+Broadband+Mobile+TV’) and with technology = 2 (FTTH). Null for bundled products with category ((‘Fixed+Broadband' or ‘Fixed+Broadband+Mobile’ or ‘Fixed+Broadband+Mobile+TV’) and with technology = 1 (ADSL)) or bundled products with category ‘Fixed+Mobile’ |
bundled_product_subs_types | [BundledProductSubsType] | false | array of subscription types included within the bundled products |
promotions | [PromotionDetail_Response] | false | array of promotions compatible with the bundled product |
is_downsell | boolean | false | indicates if the switch involves a 3P to 2P change or a 4P to 3P/2P change |
used_for_automatic_changes | boolean | false | indicates if the bundled product change is supposed to be used for changes that don’t require manual agent/customer intervention (i,e partial deactivations due to mobile portability processes) |
involve_speed_change | boolean | false | indicates if the switch involves a speed change |
subs_removed | string | false | bundled product subscription type id removed in the automatic change. Null if used_for_automatic_changes = false |
commercial_profiles | [CommercialProfile_Response] | false | none |
BundledProductBasic_Response
|
|
Name | Type | Required | Description |
---|---|---|---|
id | string | false | none |
name | string | false | none |
marketing_name | string | false | none |
external_id | string | false | identifies the product in external systems, so it is only informed in bundled with third party interactions, for example Netflix |
digital_channels_name | string | false | name used within digital channels |
bundled_segment | BundledSegment_Response | false | none |
invoice_name | string | false | none |
invoice_description | string | false | none |
in_catalogue_since | string(date-time) | false | none |
in_catalogue_until | string(date-time) | false | none |
category | BundleCategory_Response | false | none |
category_id | string | false | none |
bundled_type | BundledType_Response | false | none |
download_speed | string | false | used for filtering purpose within API consumers, fo bundled product with category (‘Fixed+Broadband' or ‘Fixed+Broadband+Mobile’ or ‘Fixed+Broadband+Mobile+TV’) and with technology = 2 (FTTH). Null for bundled products with category ((‘Fixed+Broadband' or ‘Fixed+Broadband+Mobile’ or ‘Fixed+Broadband+Mobile+TV’) and with technology = 1 (ADSL)) or bundled products with category ‘Fixed+Mobile’ |
upload_speed | string | false | used for filtering purpose within API consumers, fo bundled product with category (‘Fixed+Broadband' or ‘Fixed+Broadband+Mobile’ or ‘Fixed+Broadband+Mobile+TV’) and with technology = 2 (FTTH). Null for bundled products with category ((‘Fixed+Broadband' or ‘Fixed+Broadband+Mobile’ or ‘Fixed+Broadband+Mobile+TV’) and with technology = 1 (ADSL)) or bundled products with category ‘Fixed+Mobile’ |
internet_speed | string | false | commercial speed to be shown to client, could be different than the down and upload provisioning speed, used for filtering purpose within API consumers, fo bundled product with category (‘Fixed+Broadband' or ‘Fixed+Broadband+Mobile’ or ‘Fixed+Broadband+Mobile+TV’) and with technology = 2 (FTTH). Null for bundled products with category ((‘Fixed+Broadband' or ‘Fixed+Broadband+Mobile’ or ‘Fixed+Broadband+Mobile+TV’) and with technology = 1 (ADSL)) or bundled products with category ‘Fixed+Mobile’ |
technology | BundledProductBasic_technology | false | none |
territory_owners | [TerritoryOwnerDetail] | false | array of territory owners where the bundled product services can be provisioned and the bundled product product can be purchased |
fees | [Fee_Response] | false | none |
bundled_product_subs_types | [BundledProductSubsTypeDetail] | false | array of subscription types included within the bundled products |
getBPByComProfile_Response
|
|
Name | Type | Required | Description |
---|---|---|---|
id | string | false | none |
name | string | false | none |
marketing_name | string | false | none |
digital_channels_name | string | false | name used within digital channels |
bundled_segment | BundledSegment_Response | false | none |
invoice_name | string | false | none |
invoice_description | string | false | none |
in_catalogue_since | string(date-time) | false | none |
in_catalogue_until | string(date-time) | false | none |
category | BundleCategory_Response | false | none |
category_id | string | false | none |
download_speed | string | false | used for filtering purpose within API consumers, fo bundled product with category (‘Fixed+Broadband' or ‘Fixed+Broadband+Mobile’ or ‘Fixed+Broadband+Mobile+TV’) and with technology = 2 (FTTH). Null for bundled products with category ((‘Fixed+Broadband' or ‘Fixed+Broadband+Mobile’ or ‘Fixed+Broadband+Mobile+TV’) and with technology = 1 (ADSL)) or bundled products with category ‘Fixed+Mobile’ |
upload_speed | string | false | used for filtering purpose within API consumers, fo bundled product with category (‘Fixed+Broadband' or ‘Fixed+Broadband+Mobile’ or ‘Fixed+Broadband+Mobile+TV’) and with technology = 2 (FTTH). Null for bundled products with category ((‘Fixed+Broadband' or ‘Fixed+Broadband+Mobile’ or ‘Fixed+Broadband+Mobile+TV’) and with technology = 1 (ADSL)) or bundled products with category ‘Fixed+Mobile’ |
from | string(date-time) | false | date when the promotion starts to be included within the commercial profile |
to | string(date-time) | false | date when the promotion starts to be included within the commercial profile |
BundledProductSubsTypeBasic
|
|
Name | Type | Required | Description |
---|---|---|---|
id | string | false | none |
from | string(date-time) | false | none |
to | string(date-time) | false | none |
min_quantity | number(int32) | false | number of minimum subscriptions that must be included within the bundled product for the correspondent subscription type |
max_quantity | number(int32) | false | number of maximum subscriptions that can be included within the bundled product for the correspondent subscription type |
is_mandatory | boolean | false | indicates if the correspondent subscription type is mandatory within the bundled product |
used_for_automatic_orphan_subscription_change | boolean | false | boolean to indicate if the bundled commercial product change is available for manual or automatic changes. |
subs_type | SubsTypeName_Response | false | none |
BundledProductSubsType
|
|
Name | Type | Required | Description |
---|---|---|---|
anonymous | BundledProductSubsTypeBasic | false | none |
Name | Type | Required | Description |
---|---|---|---|
anonymous | object | false | none |
» bundled_commercial_products | [BundledCommercialProduct] | false | array of bundled commercial produts included within the bundled product subscription type |
BundledProductSubsTypeDetail
|
|
Name | Type | Required | Description |
---|---|---|---|
anonymous | BundledProductSubsTypeBasic | false | none |
Name | Type | Required | Description |
---|---|---|---|
anonymous | object | false | none |
» bundled_commercial_products | [BundledCommercialProductDetail] | false | array of bundled commercial produts included within the bundled product subscription type |
BundledCommercialProductBasic
|
|
Name | Type | Required | Description |
---|---|---|---|
id | string | false | none |
from | string(date-time) | false | none |
to | string(date-time) | false | none |
is_mandatory | boolean | false | indicates if the bundled commercial product is mandatory within the bundled product subscription type |
is_main_line | boolean | false | indicates if the bundled commercial product must be handled as main line within the bundled product |
is_extra | boolean | false | indicates if the bundled commercial product must be handed as an extra line within the bundled product |
is_additional | boolean | false | indicates if the bundled commercial product must be handed as an additional line within the bundled product |
is_bundled | boolean | false | indicates if the bundled commercial product must be ‘bundled’ in invoice, contract and pre-contractual info. |
duo_type | DuoType_Response | false | none |
max_quantity | number(int32) | false | max quantity of the correspondent bundled commercial product allowed for the specific bundled product subscription type |
invoice_name | string | false | none |
BundledCommercialProductDetail
|
|
Name | Type | Required | Description |
---|---|---|---|
anonymous | BundledCommercialProductBasic | false | none |
Name | Type | Required | Description |
---|---|---|---|
anonymous | object | false | none |
» commercial_product | CommercialProductSimple | false | none |
» fees | [Fee_Response] | false | none |
BundledCommercialProduct
|
|
Name | Type | Required | Description |
---|---|---|---|
anonymous | BundledCommercialProductBasic | false | none |
Name | Type | Required | Description |
---|---|---|---|
anonymous | object | false | none |
» commercial_product | CommercialProduct_Response | false | none |
» fees | [Fee_Response] | false | none |
» commercial_profiles | [CommercialProfile_Response] | false | none |
BundledCommercialProductCanSwitch
|
|
Name | Type | Required | Description |
---|---|---|---|
anonymous | BundledCommercialProduct | false | none |
Name | Type | Required | Description |
---|---|---|---|
anonymous | object | false | none |
» used_for_automatic_orphan_subscription_change | boolean | false | boolean to indicate if the bundled commercial product change is available for manual or automatic changes. |
getBCPbyBPCanMigrate
|
|
Name | Type | Required | Description |
---|---|---|---|
origin_bundled_commercial_product | string | false | none |
destination_bundled_commercial_product | string | false | none |
FreeUnitsPackage_Response
|
|
Name | Type | Required | Description |
---|---|---|---|
anonymous | FreeUnitsPackageDetailBySP | false | none |
Name | Type | Required | Description |
---|---|---|---|
anonymous | object | false | none |
» from | string(date-time) | false | date when the free units package starts to be included within the commercial product |
» to | string(date-time) | false | date when the free units package is no longer included within the commercial product |
» is_mandatory | boolean | false | indicates if the free units package is mandatory with the commercial product |
» is_mandatory_optional | boolean | false | indicates if the free units package is one of those that require at least one package to be selected with the commercial product |
» is_mandatory_for_sale | boolean | false | indicates if the free units package is mandatory with the commercial product during sale, but not for migration (commercial product change) |
FreeUnitsPackageDetailBySP
|
|
Name | Type | Required | Description |
---|---|---|---|
id | string | false | none |
name | string | false | none |
marketing_name | string | false | none |
digital_channels_name | string | false | name used within digital channels |
invoice_name | string | false | none |
invoice_description | string | false | none |
in_catalogue_since | string(date-time) | false | none |
in_catalogue_until | string(date-time) | false | none |
mysim_free_units_package_id | string | false | internal id used within Mysim, null for ‘dummy’ unlimited voice free units packages |
unit_amount | number(int64) | false | amount of units granted within the package.Currently, the unit type is always the same depending on the event type. VOZ (secs), DATOS (bytes), SMS (SMS) |
volume_home_sl0 | number(int64) | false | Data volume in bytes navigable at maximum speed |
volume_home_sl1 | number(int64) | false | Data volume in bytes navigable at intermediate speed level (3 Mbps) |
volume_rlah_sl0 | number(int64) | false | Data volume in bytes navigable at maximum speed with roaming like at home |
volume_rlah_sl1 | number(int64) | false | Data volume in bytes navigable at intermediate speed level (3 Mbps) with roaming like at home |
volume_nr_sl0 | number(int64) | false | Data volume in bytes navigable at maximum speed with national roaming |
volume_nr_sl1 | number(int64) | false | Data volume in bytes navigable at intermediate speed level (3 Mbps) with national roaming |
event_type | string | false | none |
unlimited | boolean | false | indicates if the free units is sold as an unlimited package |
max_grants | number(int32) | false | maximum number of grants before the free units package expires (the maxGrants value never includes the first grant period. This means that a free units package with NRTIMES = 11 that is activated on 15/01/2020 will be active until 31/12/2020). Zero for recurring packages with no limit. In this case the package will expire when being explicitly deactivated. Null for one time packages |
is_recurring_package | boolean | false | indicates if the free units package is a periodical package. Currently, if it is periodical, monthly schedule will be assigned |
applicability_priority | number(int32) | false | priority of the free units package when consuming |
used_for_policy_rule_change | boolean | false | indicates if the free units package is used for policy rules changes (for changing the download speed when limits are reached) |
category | string | false | none |
sharing_compatible | boolean | false | none |
free_units_package_template | FreeUnitsPackage_free_units_package_template_Response | false | none |
fees | [Fee_Response] | false | none |
promotions | [PromotionDetail_Response] | false | none |
base_profiles | [FreeUnitsPackageDetail_base_profiles] | false | none |
commercial_profiles | [CommercialProfile_Response] | false | none |
getFUPByComProfile_Response
|
|
Name | Type | Required | Description |
---|---|---|---|
id | string | false | none |
name | string | false | none |
marketing_name | string | false | none |
digital_channels_name | string | false | name used within digital channels |
invoice_name | string | false | none |
invoice_description | string | false | none |
in_catalogue_since | string(date-time) | false | none |
in_catalogue_until | string(date-time) | false | none |
mysim_free_units_package_id | string | false | internal id used within Mysim, null for ‘dummy’ unlimited voice free units packages |
unit_amount | number(int64) | false | amount of units granted within the package. Currently, the unit type is always the same depending on the event type. VOZ (secs), DATOS (bytes), SMS (SMS) |
volume_home_sl0 | number(int64) | false | Data volume in bytes navigable at maximum speed |
volume_home_sl1 | number(int64) | false | Data volume in bytes navigable at intermediate speed level (3 Mbps) |
volume_rlah_sl0 | number(int64) | false | Data volume in bytes navigable at maximum speed with roaming like at home |
volume_rlah_sl1 | number(int64) | false | Data volume in bytes navigable at intermediate speed level (3 Mbps) with roaming like at home |
volume_nr_sl0 | number(int64) | false | Data volume in bytes navigable at maximum speed with national roaming |
volume_nr_sl1 | number(int64) | false | Data volume in bytes navigable at intermediate speed level (3 Mbps) with national roaming |
unlimited | boolean | false | indicates if the free units is sold as an unlimited package |
max_grants | number(int32) | false | maximum number of grants before the free units package expires (the maxGrants value never includes the first grant period. This means that a free units package with NRTIMES = 11 that is activated on 15/01/2020 will be active until 31/12/2020). Zero for recurring packages with no limit. In this case the package will expire when being explicitly deactivated. Null for one time packages |
is_recurring_package | boolean | false | indicates if the free units package is a periodical package. Currently, if it is periodical, monthly schedule will be assigned |
applicability_priority | number(int32) | false | priority of the free units package when consuming |
used_for_policy_rule_change | boolean | false | indicates if the free units package is used for policy rules changes (for changing the download speed when limits are reached) |
sharing_compatible | boolean | false | none |
from | string(date-time) | false | date when the free units package starts to be included within the commercial profile |
to | string(date-time) | false | date when the free units package starts to be included within the commercial profile |
FreeUnitsPackage_free_units_package_template_Response
|
|
Name | Type | Required | Description |
---|---|---|---|
id | string | false | none |
event_type | string | false | none |
applicability_rule | string | false | applicability rule for the free units package. Defines when the free units of the package can be consumed. Currently, this is always based on the packageType. Therefore, the only value allowed for now will be ‘ByEventTypeOriginDestination’ |
getPromoByComProfile_Response
|
|
Name | Type | Required | Description |
---|---|---|---|
id | string | false | none |
name | string | false | none |
marketing_name | string | false | none |
digital_channels_name | string | false | name used within digital channels |
invoice_name | string | false | none |
invoice_description | string | false | none |
in_catalogue_since | string(date-time) | false | none |
in_catalogue_until | string(date-time) | false | none |
need_promotion_code | boolean | false | boolean to indicate if the promotion requires capturing a code for being applied |
need_existent_MSISDN | boolean | false | boolean to indicate if the promotion requires an existent MSISDN (i,e for M2M campaign) |
applicability_model | string | false | it defines how the promotion is applied in terms of calculation phase and application model. FeeGeneraton (for promotions that should be applied when generating one time or recurring fees), Billing (for promotions that should be applied during billing phase), |
restrictions_applicability_rule | string | false | rule used for obtaining the discount value (% value or fixed value) or top-up amount to be applied. Not used currently because the discount value (% value or fixed value) is fixed, not dependent on restrictions |
target_applicability_rule | string | false | rule used for determining the charges on which the discount is applied. PreviousInvoiceTotalAmount (used for Billing discounts that must be applied to the previous invoice total amount), CurrentInvoiceTotalAmount (used for Billing discounts that must be applied to the current invoice total amount), FeeSubtype (discounts that must be applied to fees with specific subtype) |
fee_subtypes | string | false | used for promotions with targetApplicabilityRule = FeeSubType, for indicating fee subtypes to which the promotion must be applied |
calculation_model | string | false | used for obtaining the discount % value/fixed value/top-up amount to be applied. Flat (fixed %/fixed discount value/top-up amount), Bulk (%/fixed discount value/top-up amount depends on the total amount of restrictions. Currently not used) |
discount_type | string | false | it defines if the discount value is a % or a fixed amount |
duration | number(int32) | false | promotion duration indicated in number of months |
keep_on_upgrade | boolean | false | used to indicate if the campaign is maintained when it is currently active and there is a product/bundled product migration to a product/bundled product which is also compatible with the promotion and which has a higher cost |
keep_on_downgrade | boolean | false | used to indicate if the campaign is maintained when it is currently active and there is a product/bundled product migration to a product/bundled product which is also compatible with the promotion and which has a lower cost |
priority | number(int32) | false | promotion applicability priority (lower value = higher priority). Currently always 1 |
is_mandatory | boolean | false | none |
xsell_permit | boolean | false | none |
reduced_fee_amount | boolean | false | none |
value | number(double) | false | none |
currency | string | false | null for values associated to promotion with discountTYpe=percentage. euro for rest |
from | string(date-time) | false | date when the promotion starts to be included within the commercial profile |
to | string(date-time) | false | date when the promotion starts to be included within the commercial profile |
skip_first_period | boolean | false | it indicates if the first period of billing is skipped |
reduce_penalty_threshold | boolean | false | it indicates if the reference value has to be decreased |
category_name | string | false | name to define the promotion category |
type_name | string | false | name to define the promotion type |
PromotionDetail_Response
|
|
Name | Type | Required | Description |
---|---|---|---|
anonymous | getPromoByComProfile_Response | false | none |
Name | Type | Required | Description |
---|---|---|---|
anonymous | object | false | none |
» terms | [TermsPromotion_Response] | false | none |
» transaction_type | TransactionType | false | none |
» commercial_profiles | [CommercialProfile_Response] | false | none |
PromotionCanSwitchPromotion
|
|
Name | Type | Required | Description |
---|---|---|---|
compatibility_id | string | false | none |
compatibility_name | string | false | none |
origin_category | PromotionCategories | false | none |
dest_category | PromotionCategories | false | none |
from | string(date-time) | false | none |
to | string(date-time) | false | none |
PromotionIncompatibility
|
|
Name | Type | Required | Description |
---|---|---|---|
promotion_id | string | true | Id of the incompatible promotion |
promotion_marketing_name | string | false | Marketing name of the incompatible promotion |
promotion_type | string | false | PromotionType name of the incompatible promotion (useful to identify bundle promotions) |
from | string(date-time) | false | Date-time that marks the start of the incompatibility between this promotion and the given one |
to | string(date-time) | false | Date-time that marks the end of the incompatibility between this promotion and the given one |
PromotionIncompatibilityPaginatedList
|
|
Name | Type | Required | Description |
---|---|---|---|
items | [PromotionIncompatibility] | true | none |
pagination | Pagination | true | none |
CommercialDeviceSimple
|
|
Name | Type | Required | Description |
---|---|---|---|
id | string | false | none |
terminal_id | string | false | terminalId within legacy MySim, required to be sent within legacy Mysim socket request |
campaign_id | string | false | optional field, mysim campaign for handling permanency associated to the commercial device |
renewal_category | RenewalCategory_Response | false | optional field, only informed for ‘Cartera’ subscriptions to inform the commercial profile |
cession_price | number(double) | false | optional field, only informed for ‘Cartera’ subscriptions to inform the cession price |
retail_price | number(double) | false | optional field, only informed in non-mandatory commercial devices. is the price the end user pays for the device. |
discount | number(double) | false | optional field, only informed in non-mandatory commercial devices. is the discount made by the service provider for the device. |
insured_amount | number(double) | false | field with the amount that can be insured in a particular device, if there is no insurance option a -1.00 value is returned |
payment_type | PaymentType_Response | false | field that indicates if is financed or single payment |
numeration_types | [NumerationType] | false | optional field that indicates the numeration origin. |
donor_numeration_types | [DonorNumerationType_Response] | false | optional field that indicates the numeration type in case of portability (numeration type is not Nuevo numero) |
sale_types | [SaleTypeName_Response] | false | optional field that indicates if it is a new sale or an action over an existing subscription |
device | CommercialDevice_device_Response | false | none |
fees | [CommercialDevice_fees_Response] | false | none |
installment_plans | [CommercialDevice_installment_plan] | false | none |
commercial_profiles | [CommercialProfileForCommercialDevice_Response] | false | none |
installation_type | InstallationType_Response | false | none |
CommercialDeviceAlone
|
|
Name | Type | Required | Description |
---|---|---|---|
anonymous | CommercialDeviceSimple | false | none |
Name | Type | Required | Description |
---|---|---|---|
anonymous | object | false | none |
» promotions | [PromotionDetail_Response] | false | none |
CommercialDevice
|
|
Name | Type | Required | Description |
---|---|---|---|
anonymous | CommercialDeviceSimple | false | none |
Name | Type | Required | Description |
---|---|---|---|
anonymous | object | false | none |
» digital_channels_name | string | false | name to be shown within digital channels |
» from | string(date-time) | false | date when the commercial device starts to be applicable for a commercial product/bundled commercial product/value added service |
» to | string(date-time) | false | date when the commercial device is no longer applicable for a commercial product/bundled commercial product/value added service |
» is_mandatory | boolean | false | if the commercial device is mandatory when purchasing the correspondent commercial product/bundled commercial product/value added service |
RatePlan
|
|
Name | Type | Required | Description |
---|---|---|---|
id | string | false | none |
in_catalogue_since | string(date-time) | false | none |
in_catalogue_until | string(date-time) | false | none |
getBaseProfiles_Response
|
|
Name | Type | Required | Description |
---|---|---|---|
id | string | false | none |
name | string | false | none |
in_catalogue_since | string(date-time) | false | none |
in_catalogue_until | string(date-time) | false | none |
network_id | string | false | network that can be used for provisioning the services encapsulated within the base profile |
network_provisioning_id | string | false | id used for provisioning the commercial product within the correspondent network |
service_class | string | false | additional value required for provisioning within Yoigo network (networkId=2). Not used for networkId=1 |
offer_id | string | false | additional value required for provisioning prepaid tariffs within Yoigo network (networkId=2). Not used for networkId=1 |
charging_id | string | false | additional value required for provisioning prepaid tariffs within Yoigo network (networkId=2). Not used for networkId=1 |
manual_renewal | boolean | false | boolean additional value required for provisioning prepaid tariffs within Yoigo network (networkId=2). Not used for networkId=1 |
download_speed | string | false | download speed for broadband base profiles, used for provisioning purpose |
internet_speed | string | false | commercial speed to be shown to client, could be different than the down and upload provisioning speed |
upload_speed | string | false | upload speed for broadband base profiles, used for provisioning purpose |
BaseProfile
|
|
Name | Type | Required | Description |
---|---|---|---|
anonymous | getBaseProfiles_Response | false | none |
Name | Type | Required | Description |
---|---|---|---|
anonymous | object | false | none |
» services | [BaseProfile_services] | false | none |
BaseProfile_services
|
|
Name | Type | Required | Description |
---|---|---|---|
id | string | false | none |
name | string | false | none |
description | string | false | none |
in_catalogue_since | string(date-time) | false | none |
in_catalogue_until | string(date-time) | false | none |
from | string(date-time) | false | none |
to | string(date-time) | false | none |
network_code | string | false | parameter used by network to identify the service |
is_changeable | boolean | false | means if the surrent service status can be changed |
activate_on_network_provisioning | boolean | false | indicates if the service is automatically activated when the technical profile is provisioned |
language | string | false | characteristic used for serviceId = 2. Not used for other services |
speed | string | false | characteristic used for serviceId = 16. Not used for other services |
available_networks | string | false | characteristic used for serviceId = 30. Not used for other services |
FreeUnitsPackageDetail_base_profiles
|
|
Name | Type | Required | Description |
---|---|---|---|
id | string | false | none |
name | string | false | none |
in_catalogue_since | string(date-time) | false | none |
in_catalogue_until | string(date-time) | false | none |
network_id | string | false | network that can be used for provisioning the free units package (decision on which network to be used is out of catalogue domain, catalogue configuration will consider all possible networks) |
network_provisioning_id | string | false | id used for provisioning the free units package within the correspondent network |
offer_id | string | false | additional value required for provisioning prepaid free units packages within Yoigo network (networkId=2). Not used for networkId=1 |
charging_id | string | false | additional value required for provisioning prepaid free units packages within Yoigo network (networkId=2). Not used for networkId=1 |
expire_with_tariff | boolean | false | boolean additional value required for provisioning prepaid free units packages within Yoigo network (networkId=2). Not used for networkId=1 |
ValueAddedServiceDetail
|
|
Name | Type | Required | Description |
---|---|---|---|
id | string | false | none |
mysim_id | string | false | none |
marketing_name | string | false | none |
in_catalogue_since | string(date-time) | false | none |
in_catalogue_until | string(date-time) | false | none |
digital_channels_name | string | false | none |
invoice_name | string | false | none |
invoice_description | string | false | none |
from | string(date-time) | false | none |
to | string(date-time) | false | none |
fees | [Fee_Response] | false | none |
ValueAddedService
|
|
Name | Type | Required | Description |
---|---|---|---|
anonymous | ValueAddedServiceDetail | false | none |
Name | Type | Required | Description |
---|---|---|---|
anonymous | object | false | none |
» is_mandatory | boolean | false | none |
» max_cardinality | string | false | Represents the same as max_quantity but typed as string. Deprecated in favor of max_quantity. |
» max_quantity | integer | false | Maximum number of instances of this value_added_service that can be hired with a [bundled_]commercial_product. |
» related_bundled_product_id | string | false | Id of the bundled_product for which the value_added_service is configured. It is null when value_added_services are requested for a commercial_product instead of bundled_commercial_product. |
» value_added_services | [ValueAddedServiceDetail] | false | Required value_added_services that need to be hired with the parent value_added_service. |
ProvisioningProfile
|
|
Name | Type | Required | Description |
---|---|---|---|
id | string | false | none |
name | string | false | none |
in_catalogue_since | string(date-time) | false | none |
in_catalogue_until | string(date-time) | false | none |
activation_work_order_type_id | string | false | work order type id used for provisioning an activation order for the correspondent bundled product |
deactivation_work_order_type_id | string | false | work order type id used for provisioning a deactivation order for the correspondent bundled product |
suspension_work_order_type_id | string | false | work order type id used for provisioning a suspension order for the correspondent bundled product |
resume_work_order_type_id | string | false | work order type id used for provisioning a resume order for the correspondent bundled product |
cancellation_work_order_type_id | string | false | work order type id used for provisioning a cancellation order for the correspondent bundled product |
partial_cancellation_work_order_type_id | string | false | work order type id used for provisioning a partial cancellation order for the correspondent bundled product |
territory_owners | string | false | array of territory owners to which the correspondent ProvisioningProfile is restricted. null for ProvisioningProfiles that will be used for the rest of territory owners for which there is no specific profile |
Service
|
|
Name | Type | Required | Description |
---|---|---|---|
id | string | false | none |
name | string | false | none |
digital_channels_name | string | false | none |
description | string | false | none |
in_catalogue_since | string(date-time) | false | none |
in_catalogue_until | string(date-time) | false | none |
from | string(date-time) | false | none |
to | string(date-time) | false | none |
activation_work_order_type_id | string | false | work order type id used for provisioning an activation order for the correspondent value added service |
deactivation_work_order_type_id | string | false | work order type id used for provisioning a deactivation order for the correspondent value added service |
CommercialInfo
|
|
Name | Type | Required | Description |
---|---|---|---|
id | string | false | none |
commercial_description | string | false | none |
language | string | false | none |
invoice_name | string | false | none |
invoice_description | string | false | none |
TransactionType
|
|
Name | Type | Required | Description |
---|---|---|---|
id | string | false | none |
name | string | false | none |
description | string | false | none |
is_active | boolean | false | none |
is_external | boolean | false | indicates if the fee/term/promotion value is own (MM) or external (third-party) |
tax_rate | string | false | indicates the tax applied to the fee/term/promotion value |
transaction_type | string | false | none |
refound_transaction_type_id | string | false | id of the transaction type used for refound transactions |
CommercialDevice_device_Response
|
|
Name | Type | Required | Description |
---|---|---|---|
id | string | false | none |
generic_code | string | false | none |
brand | string | false | none |
model | string | false | none |
name | string | false | none |
description | string | false | none |
category | string | false | none |
colour | string | false | none |
is_available | boolean | false | based on this attribute we know if a device is active or not |
in_catalogue_since | string(date-time) | false | none |
in_catalogue_until | string(date-time) | false | none |
include_preinstalled_sim | boolean | false | if the device has a built-in sim card |
image_url | string(url)¦null | false | url to device image |
model_web | string | false | none |
Device_Response
|
|
Name | Type | Required | Description |
---|---|---|---|
id | string | false | none |
generic_code | string | false | none |
brand | string | false | none |
model | string | false | none |
name | string | false | none |
description | string | false | none |
category | string | false | none |
colour | string | false | none |
is_available | boolean | false | based on this attribute we know if a device is active or not |
include_preinstalled_sim | boolean | false | if the device has a built-in sim card |
image_url | string(url)¦null | false | url to device image |
category_web | string | false | none |
model_web | string | false | none |
colour_name | string | false | none |
hexadecimal_colour | string | false | none |
brand_colour | boolean | false | none |
specifications | string | false | none |
control_app | boolean | false | none |
battery | string | false | none |
bluetooth_version | string | false | none |
frontal_camera | string | false | none |
back_camera | string | false | none |
storage | string | false | none |
wireless_charging | boolean | false | none |
fast_charge | boolean | false | none |
fast_charge_speed | string | false | none |
box_content | string | false | none |
telecare_compatible | boolean | false | none |
connectivity | string | false | none |
control_voice_assitant | boolean | false | none |
dimensions | string | false | none |
hard_drive | string | false | none |
dual_sim | boolean | false | none |
battery_duration | string | false | none |
esim | boolean | false | none |
flash | boolean | false | none |
functions | string | false | none |
touch_id | boolean | false | none |
max_speed | string | false | none |
memory | string | false | none |
memory_expandable_to | string | false | none |
ram_memory | string | false | none |
microphone | boolean | false | none |
nfc | boolean | false | none |
user_number | string | false | none |
mapping_allowed | boolean | false | none |
weight | string | false | none |
power | string | false | none |
gaming_capabilities | string | false | none |
processor | string | false | none |
ports | string | false | none |
weight_range | string | false | none |
network | string | false | none |
system_requirements | string | false | none |
water_resistant | boolean | false | none |
resolution | string | false | none |
output | string | false | none |
noise_cancelling | boolean | false | none |
sensors | string | false | none |
digital_tuner | string | false | none |
os | string | false | none |
sound | string | false | none |
size | string | false | none |
screen_size | string | false | none |
technology | string | false | none |
battery_charge_time | string | false | none |
hard_drive_type | string | false | none |
sim_type | string | false | none |
download_speed | string | false | none |
wifi | string | false | none |
comments | string | false | none |
promotional_info | PromotionalInfo | false | none |
PromotionalInfo
|
|
Name | Type | Required | Description |
---|---|---|---|
trade_in_description | string | false | Description of the trade in |
trade_in_value | number | false | none |
additional_info | string | false | Additional info of the promotional info |
CommercialProfileForCommercialDevice_Response
|
|
Name | Type | Required | Description |
---|---|---|---|
anonymous | CommercialProfile_Response | false | none |
Name | Type | Required | Description |
---|---|---|---|
anonymous | object | false | none |
» logistic_required | boolean | false | optional property (only informed in not mandatory CommercialDevices), by default ‘false’ value, this property indicates if the device needs logistic or not based on the commercial profile definition. |
» store_delivery_allowed | boolean | false | this property indicates if a device with logistics shipping can be delivered to a store or not |
CommercialProfile_Response
|
|
Name | Type | Required | Description |
---|---|---|---|
anonymous | getCommercialProfileBasic_Response | false | none |
Name | Type | Required | Description |
---|---|---|---|
anonymous | object | false | none |
» from | string(date-time) | false | none |
» to | string(date-time) | false | none |
getCommercialProfileBasic_Response
|
|
Name | Type | Required | Description |
---|---|---|---|
id | string | false | none |
name | string | false | none |
visibility_type | string | false | none |
TerritoryOwnerAlone
|
|
Name | Type | Required | Description |
---|---|---|---|
id | string | false | none |
name | string | false | none |
in_catalogue_since | string(date-time) | false | none |
in_catalogue_until | string(date-time) | false | none |
TerritoryOwnerDetail
|
|
Name | Type | Required | Description |
---|---|---|---|
anonymous | TerritoryOwnerAlone | false | none |
Name | Type | Required | Description |
---|---|---|---|
anonymous | object | false | none |
» from | string(date-time) | false | none |
» to | string(date-time) | false | none |
Fee_Response
|
|
Name | Type | Required | Description |
---|---|---|---|
id | string | false | none |
description | string | false | none |
type | string | false | RecurringCharge value is used for charges that must be applied on a recurring basis. OneTimeFee value is used for charges that only need to be applied once |
subtype | string | false | none |
recurrence_scheme | string | false | recurrence scheme for fees. BoundToBillCycle (used for recurring fees that are applied on a recurring basis, according to the correspondent billing cycle (i.e free units packages used for postpaid subscriptions or automatic top-up prepaid subscriptions), NonBoundToBillCycle (used for recurring fees that are applied on a recurring basis (i.e weekly, monthly, BoundToActivation…) not bounded to any bill cycle ). Null for one time fees. |
recurrence_interval_type | string | false | interval type for NonBounToBill recurring fees. ‘Weekly’ (every Monday), ‘Daily' (every day), ‘Monthly’ (every 1st of month), BoundToActivation (every N days since activation) |
recurrence_interval | number(int32) | false | recurrence interval for NonBoundToBill recurring charges. 0 for BoundToBillCycle recurring charges. Null for non-recurring charges |
paid_in_advance | boolean | false | indicates if a recurring charge is paid in advance or in arrears. Not applicable for non recurring charges |
prorated_on_activation | boolean | false | indicates if the recurring charge is prorated on activation or not. Not applicable for non recurring charges |
prorated_on_deactivation | boolean | false | indicates if the recurring charge is prorated on deactivation or not. Not applicable for non recurring charges |
is_external | boolean | false | indicates if the fee is MM internal or third party company |
from | string(date-time) | false | none |
to | string(date-time) | false | none |
value | number(double) | false | none |
currency | string | false | null for values associated to promotion with discountTYpe=percentage. euro for rest |
terms | [Terms_Response] | false | none |
transaction_type | TransactionType | false | none |
FeeInstallmentPlan_Response
|
|
None
FeeInstallmentPlan_refinance_Response
|
|
Name | Type | Required | Description |
---|---|---|---|
id | string | false | none |
description | string | false | none |
type | string | false | RecurringCharge value is used for charges that must be applied on a recurring basis. OneTimeFee value is used for charges that only need to be applied once |
subtype | string | false | none |
recurrence_scheme | string | false | recurrence scheme for fees. BoundToBillCycle (used for recurring fees that are applied on a recurring basis, according to the correspondent billing cycle (i.e free units packages used for postpaid subscriptions or automatic top-up prepaid subscriptions), NonBoundToBillCycle (used for recurring fees that are applied on a recurring basis (i.e weekly, monthly, BoundToActivation…) not bounded to any bill cycle ). Null for one time fees. |
recurrence_interval_type | string | false | interval type for NonBoundToBill recurring fees. ‘Weekly’ (every Monday), ‘Daily' (every day), ‘Monthly’ (every 1st of month), BoundToActivation (every N days since activation) |
recurrence_interval | number(int32) | false | recurrence interval for NonBoundToBill recurring charges. 0 for BoundToBillCycle recurring charges. Null for non-recurring charges |
paid_in_advance | boolean | false | indicates if a recurring charge is paid in advance or in arrears. Not applicable for non recurring charges |
prorated_on_activation | boolean | false | indicates if the recurring charge is prorated on activation or not. Not applicable for non recurring charges |
prorated_on_deactivation | boolean | false | indicates if the recurring charge is prorated on deactivation or not. Not applicable for non recurring charges |
from | string(date-time) | false | none |
to | string(date-time) | false | none |
is_external | boolean | false | indicates if the fee/term/promotion value is own (MM) or external (third-party) |
value | number(double) | false | none |
currency | string | false | null for values associated to promotion with discountTYpe=percentage. euro for rest |
transaction_type | TransactionType | false | none |
CommercialDevice_fees_Response
|
|
Name | Type | Required | Description |
---|---|---|---|
id | string | false | none |
description | string | false | none |
type | string | false | RecurringCharge type is used for charges applied on a recurring basis, OneTimeFee type is used for charged that are applied only once |
subtype | string | false | none |
from | string(date-time) | false | date when the fee starts to be applicable for the commercial device |
to | string(date-time) | false | date when the fee is no longer applicable for the commercial device |
recurrence_scheme | string | false | BoundToBillCycle scheme is used for recurring charges that are applied bound to the correspondent bill cycle (for postpaid or automatic top-up prepaid). NonBoundToBillCycle scheme is used for recurring charges that are not bound to a bill cycle |
recurrence_interval_type | string | false | recurrence interval type for NonBoundToBill fees. Weekly (Every Monday), Daily (Every day), Monthly (Every 1st month), BoundToActivation ()Every N days since activation) |
recurrence_interval | number(int32) | false | Recurrence interval for NonBoundToBill recurring charges. Currently always 30 days for MM brand, 28 days for rest of brands |
paid_in_advance | boolean | false | indicates if the recurring charge is paid in advance or in arrears. Currently always true for recurring charges with subtype ‘ServiceFee’ associated to mobile commercial products for classic prepaid and automatic top-up prepaid models |
prorated_on_activation | boolean | false | indicates if the recurring charge is prorated on activation or not. Not applicable for non recurring charges |
prorated_on_deactivation | boolean | false | indicates if the recurring charge is prorated on deactivation or not. Not applicable for non recurring charges |
is_external | boolean | false | indicates if the fee is own (MM) or external (third-party) |
value | number(double) | false | none |
currency | string | false | null for values associated to promotion with discountTYpe=percentage. euro for rest |
transaction_type | TransactionType | false | none |
terms | [Terms_Response] | false | none |
Terms_alone_Response
|
|
Name | Type | Required | Description |
---|---|---|---|
id | string | false | none |
name | string | false | none |
type | string | false | PermanenceContract (contract used when a minimum permanency is set), ActivationCommitment (terms type used when service activation is committed. For instance, the installation cost is subsidized only in case the service is finally activated. If the order is cancelled before activating the service but after performing installation, the installation cost could be charged to the customer through an ActivationCommitment terms), ReturnCommitment (terms type used for enabling the commitment of returning a subsidized item after the service deactivation. For instance, when the service provider delivers a device to the customer that it is actually owned buy the service provider, the customer will be typically forced to return the transferred device after service deactivation. This term type is used for enabling this type of commitment) |
commitment_duration | number(int32) | false | duration of a PermanenceContract in months |
penalty_prorated | boolean | false | indicates if the applicable penalty amount is prorated or not based on number of days already passed between activation and the end of the commitment period |
value | number(double) | false | none |
currency | string | false | null for values associated to promotion with discountTYpe=percentage. euro for rest |
permanence_type | string | false | Field to categorize device permanences according to the multi-financing business rules MAIN: Penalties that apply to header lines and non-OXF segments. You can only have 1 at a time NOT_MAIN: Permanences that apply to devices on additional lines, OXF segments. You can have more than 1 at a time NOT_APPLY: The penalty is not a permanence, or if it is, it is not for a device |
transaction_type | TransactionType | false | none |
TermsPromotion_Response
|
|
Name | Type | Required | Description |
---|---|---|---|
anonymous | Terms_alone_Response | false | none |
Name | Type | Required | Description |
---|---|---|---|
anonymous | object | false | none |
» binding_type_id | string | false | none |
Terms_Response
|
|
Name | Type | Required | Description |
---|---|---|---|
anonymous | Terms_alone_Response | false | none |
Name | Type | Required | Description |
---|---|---|---|
anonymous | object | false | none |
» from | string(date-time) | false | none |
» to | string(date-time) | false | none |
CommercialDevicesTerms_Response
|
|
Name | Type | Required | Description |
---|---|---|---|
campaign_id | string | false | none |
term | Terms_alone_Response | false | none |
CommercialDevice_installment_plan
|
|
Name | Type | Required | Description |
---|---|---|---|
id | string | false | none |
name | string | false | none |
from | string(date-time) | false | date when the term starts to be applicable for the commercial device |
to | string(date-time) | false | date when the term is no longer applicable for the commercial device |
duration | number(int32) | false | duration of the installment plan indicated in number of months |
tin | string | false | only informed in case of financed offer_id |
tae | string | false | only informed in case of financed offer_id |
commission | string | false | only informed in case of financed, amunt of the commission applied |
commission_percentage | string | false | only informed in case of financed, percentage of the commission applied |
fees | [FeeInstallmentPlan_Response] | false | none |
terms | [Terms_Response] | false | none |
CommercialDevice_installment_plan_refinance
|
|
Name | Type | Required | Description |
---|---|---|---|
anonymous | CommercialDevice_installment_plan | false | none |
Name | Type | Required | Description |
---|---|---|---|
anonymous | object | false | none |
» fees | [FeeInstallmentPlan_refinance_Response] | false | none |
PaymentType
|
|
Name | Type | Required | Description |
---|---|---|---|
anonymous | string | false | field that indicates if is financed or single payment |
Property | Values |
---|---|
anonymous | one of [SINGLE_PAYMENT, FINANCED_PAYMENT] |
PaymentType_Response
|
|
Name | Type | Required | Description |
---|---|---|---|
anonymous | string | false | field that indicates if is financed or single payment |
SubsTypeName
|
|
Name | Type | Required | Description |
---|---|---|---|
anonymous | string | false | none |
Property | Values |
---|---|
anonymous | one of [PRE-PAGO, POST-PAGO, INTERNET FTTH, FIJO ANALOGICO, FIJO DIGITAL, INTERNET ADSL, AGILE TV, ENERGY, SECURITY, DATA_SHARING, MULTISIM, HEALTH, DEVICEINSURANCE, NETFLIX, APPLEWATCH, AMAZONPRIME, MAX, TV, ORANGE_TV_LIBRE] |
SubsTypeName_Response
|
|
Name | Type | Required | Description |
---|---|---|---|
name | string | false | subscription type name |
description | string | false | subscription type description |
id | string | false | subscription type id |
DonorNumerationType
|
|
Name | Type | Required | Description |
---|---|---|---|
anonymous | string | false | none |
Property | Values |
---|---|
anonymous | one of [Pospago, Prepago] |
DonorNumerationType_Response
|
|
Name | Type | Required | Description |
---|---|---|---|
id | string | false | none |
name | string | false | none |
description | string | false | none |
from | string(date-time) | false | none |
to | string(date-time) | false | none |
SaleTypeName
|
|
Name | Type | Required | Description |
---|---|---|---|
anonymous | string | false | none |
Property | Values |
---|---|
anonymous | one of [Venta, Migración, Añadir Línea, Cross Sell, Cartera] |
SaleTypeName_Response
|
|
Name | Type | Required | Description |
---|---|---|---|
id | string | false | none |
name | string | false | none |
description | string | false | none |
from | string(date-time) | false | none |
to | string(date-time) | false | none |
BundledProductBasic_technology
|
|
Name | Type | Required | Description |
---|---|---|---|
id | string | false | none |
name | string | false | it can be FIBRA or ADSL |
TechnologyName
|
|
Name | Type | Required | Description |
---|---|---|---|
anonymous | string | false | none |
Property | Values |
---|---|
anonymous | one of [ADSL, FIBRA] |
VisibilityType
|
|
Name | Type | Required | Description |
---|---|---|---|
anonymous | string | false | none |
DeviceCategory
|
|
Name | Type | Required | Description |
---|---|---|---|
anonymous | string | false | optional field to filter by device category |
Property | Values |
---|---|
anonymous | one of [SMARTPHONE, SMARTWATCH, OTROS, ROUTER, TABLET, STB, WIFI_EXTENDER] |
DuoType_Response
|
|
Name | Type | Required | Description |
---|---|---|---|
anonymous | string | false | none |
BundledSegment_Response
|
|
Name | Type | Required | Description |
---|---|---|---|
anonymous | string | false | none |
InstallationType_Response
|
|
Name | Type | Required | Description |
---|---|---|---|
id | string | false | none |
description | string | false | none |
PromotionCategories
|
|
Name | Type | Required | Description |
---|---|---|---|
anonymous | string | false | none |
RenewalCategory
|
|
Name | Type | Required | Description |
---|---|---|---|
anonymous | string | false | none |
Property | Values |
---|---|
anonymous | one of [Generic, Loyalty, Retention] |
RenewalCategory_Response
|
|
Name | Type | Required | Description |
---|---|---|---|
anonymous | string | false | optional field, only informed for ‘Cartera’ subscriptions to inform the commercial profile |
BundleCategory
|
|
Name | Type | Required | Description |
---|---|---|---|
anonymous | string | false | none |
Property | Values |
---|---|
anonymous | one of [Mobile, TV, Fixed+Broadband, Fixed+Mobile, Fixed+Broadband+Mobile, Fixed+Broadband+TV, Fixed+Broadband+Mobile+Netflix, Fixed+Broadband+Mobile+TV] |
BundleCategory_Response
|
|
Name | Type | Required | Description |
---|---|---|---|
anonymous | string | false | none |
BundledType_Response
|
|
Name | Type | Required | Description |
---|---|---|---|
anonymous | string | false | none |
BillingTypeName
|
|
Name | Type | Required | Description |
---|---|---|---|
anonymous | string | false | none |
Property | Values |
---|---|
anonymous | one of [POSPAGO, PREPAGO CLASICO, RECARGA AUTOMATICA] |
CustomerTypeName
|
|
Name | Type | Required | Description |
---|---|---|---|
anonymous | string | false | none |
Property | Values |
---|---|
anonymous | one of [Nuevo, Existente] |
CommercialSegmentName
|
|
Name | Type | Required | Description |
---|---|---|---|
anonymous | string | false | none |
Property | Values |
---|---|
anonymous | one of [SME, Consumer] |
CustomerSegmentName
|
|
Name | Type | Required | Description |
---|---|---|---|
anonymous | string | false | none |
Property | Values |
---|---|
anonymous | one of [RESIDENCIAL, EMPRESA, AUTONOMO, HORECA] |
NumerationType
|
|
Name | Type | Required | Description |
---|---|---|---|
id | string | false | none |
name | string | false | none |
description | string | false | none |
from | string(date-time) | false | none |
to | string(date-time) | false | none |
NumerationTypeName
|
|
Name | Type | Required | Description |
---|---|---|---|
anonymous | string | false | none |
Property | Values |
---|---|
anonymous | one of [Nuevo numero, Numero portado, Numero entre marcas] |
CommercialDeviceList
|
|
Name | Type | Required | Description |
---|---|---|---|
items | [CommercialDeviceAlone] | true | none |
pagination | Pagination | true | none |
Pagination
|
|
Name | Type | Required | Description |
---|---|---|---|
total | integer(int32) | true | none |
offset | integer(int32) | true | none |
limit | integer(int32) | true | none |
healthCheck
|
|
Name | Type | Required | Description |
---|---|---|---|
status | string | false | none |
KOGenericResponse
|
|
Name | Type | Required | Description |
---|---|---|---|
error | string | false | none |
message | string | false | none |
code | string | false | none |