masstack

V2
V3
V4
API Overview Resources Schemas

Schemas

ChangeOrderRequest

1
2
3
4
5
6
7

{
  "seller": "string",
  "workorderid": "string",
  "reason": "string",
  "parameters": "string",
  "changetype": "string"
}
Name Type Required Description
seller string true none
workorderid string true none
reason string false none
parameters string false none
changetype string true none

ChangeOrderResponse

1
2
3
4
5
6
7

{
  "errorVO": {
    "error_code": "string",
    "error_description": "string",
    "operation_date": "string"
  }
}
Name Type Required Description
errorVO ErrorVO false none

ErrorVO

1
2
3
4
5

{
  "error_code": "string",
  "error_description": "string",
  "operation_date": "string"
}
Name Type Required Description
error_code string false none
error_description string false none
operation_date string false none

ServiceStatus

1
2
3

{
  "active": true
}
Name Type Required Description
active boolean false active = True - Activate a service
active = False - Deactivate a service

BlockStatus

1
2
3
4

{
  "active": true,
  "reason": "Lo ha perdido"
}
Name Type Required Description
active boolean true active = True - Activate a service
active = False - Deactivate a service
reason string false Describes the reason to block the simcard

Service

1
2
3
4
5
6
7

{
  "id": 214748364,
  "value": "VOZ",
  "changeable": true,
  "date_last_modified": "2017-09-15T22:00:00Z",
  "active": true
}
Name Type Required Description
id integer(int64) false Id service
value string false Service Name
changeable boolean false indicates whether the service can be changed
date_last_modified string(date-time) false date last modified
active boolean false indicates whether the service is active

Block

1
2
3
4
5
6

{
  "id": 214748364,
  "value": "ROBO",
  "date_last_modified": "2017-09-15T22:00:00Z",
  "description": "A PETICION DE CLIENTE"
}
Name Type Required Description
id integer(int64) false Block identification
value string false Block Name
date_last_modified string(date-time) false date last modified
description string false description of the reason block

AccountBundlePromotion

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15

{
  "promotion_id": 0,
  "effective_date_ini": "2017-09-15T22:00:00Z",
  "effective_date_end": "2017-09-15T22:00:00Z",
  "promotion_name": "string",
  "account_bundle_id": 0,
  "promotion_benefit_type": {
    "id": 1,
    "value": 0.1
  },
  "promotion_type": {
    "id": 1,
    "value": "string"
  }
}
Name Type Required Description
promotion_id integer(int64) false promotion id
effective_date_ini string(date-time) false promotion initial effective date
effective_date_end string(date-time) false promotion end effective date
promotion_name string false promotion name
account_bundle_id integer(int64) false none
promotion_benefit_type PromotionBenefitType false none
promotion_type PromotionType false none

AccountPromotion

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14

{
  "promotion_id": 0,
  "begin_date": "2017-09-15T22:00:00Z",
  "promotion_name": "string",
  "end_date": "2017-09-15T22:00:00Z",
  "promotion_benefit_type": {
    "id": 1,
    "value": 0.1
  },
  "promotion_type": {
    "id": 1,
    "value": "string"
  }
}
Name Type Required Description
promotion_id integer(int64) false promotion id
begin_date string(date-time) false promotion activation date
promotion_name string false promotion name
end_date string(date-time) false promotion end date
promotion_benefit_type PromotionBenefitType false none
promotion_type PromotionType false none

SubscriptionPromotion

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17

{
  "subscription_id": 214748364,
  "promotion_id": 214748364,
  "promotion_code": "NTH_256",
  "promotion_name": "MM_50% DTO_CONVERGENCIA_FIDELIZACIÓN_12_MESES",
  "association_date": "2017-09-15T22:00:00Z",
  "end_date": "2017-09-15T22:00:00Z",
  "account_bundle_id": 214748364,
  "promotion_benefit_type": {
    "id": 1,
    "value": 0.1
  },
  "promotion_type": {
    "id": 1,
    "value": "string"
  }
}
Name Type Required Description
subscription_id integer(int64) false subscription id
promotion_id integer(int64) false promotion id
promotion_code string false promotion code
promotion_name string false promotion name
association_date string(date-time) false promotion association date
end_date string(date-time) false promotion end date
account_bundle_id integer(int64) false none
promotion_benefit_type PromotionBenefitType false none
promotion_type PromotionType false none

AccountTerms

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22

{
  "subscription_id": 214748364,
  "start_date": "2017-09-15T22:00:00Z",
  "end_date": "2017-09-15T22:00:00Z",
  "penalty_amount": 0,
  "terms_months": 12,
  "account_bundle_id": 214748364,
  "binding_type": {
    "id": 214748364,
    "value": "12 MESES"
  },
  "promotion": {
    "id": 0,
    "value": "string",
    "description": "PERMANENCIA TERMINAL 150E 24M"
  },
  "associated_type": "terminal",
  "associated_terminal": {
    "id": 0,
    "value": "string"
  }
}
Name Type Required Description
subscription_id integer(int64) false subscription id
start_date string(date-time) false start date
end_date string(date-time) false end date
penalty_amount number(double) false terms penalty amount
terms_months integer(int32) false terms months
account_bundle_id integer(int64) false account bundle id
binding_type BindingType false none
promotion AccountTermsPromotion false none
associated_type string false Type of permanence to which it is associated
associated_terminal AccountTermsAssociatedTerminal false none
Property Values
associated_type one of [terminal, promotion]

AccountTermsPromotion

1
2
3
4
5

{
  "id": 0,
  "value": "string",
  "description": "PERMANENCIA TERMINAL 150E 24M"
}
Name Type Required Description
anonymous BasicIdResponse false none
Name Type Required Description
anonymous object false Promotion to which the permanence is associated to
» description string false Brief description of the promotion

AccountTermsAssociatedTerminal

1
2
3
4

{
  "id": 0,
  "value": "string"
}
Name Type Required Description
anonymous BasicIdResponse false none
Name Type Required Description
anonymous object false Returned in case the associated_type has value “terminal”, with id and name of the terminal

BasicIdResponse

1
2
3
4

{
  "id": 0,
  "value": "string"
}
Name Type Required Description
id integer(int32) false Identificator
value string false Name

Bonus

1
2
3
4
5
6

{
  "id": 214748364,
  "value": "INTERNET 3GB TPILI",
  "start_date": "2017-09-15T22:00:00Z",
  "end_date": "2017-09-15T22:00:00Z"
}
Name Type Required Description
id integer(int64) false bonus identifier
value string false Bonus Name
start_date string(date-time) false bonus start date
end_date string(date-time) false bonus end date

SubscriptionDevices

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54

{
  "devices": [
    {
      "subscription_id": 214748364,
      "subscription_terminal_id": 214748364,
      "status": {
        "id": 214748364,
        "value": "ACTIVO"
      },
      "request_detail": {
        "created_date": "2017-09-15T22:00:00Z",
        "request_id": 214748364,
        "request_type": "captacion",
        "user_profile_role": "Generic"
      },
      "device_info": {
        "terminal_id": 214748364,
        "serial_number": 0,
        "device_name": "Honor 90 Smart 5G",
        "device_model": "128GB Midnight Black",
        "financed_by": "XFERA",
        "is_financed": false,
        "value_due_today": 120,
        "reservation_id": "e528d8ec-831f-40e9-8414-8ef7cc99c4e4",
        "paid": false,
        "terminal_code": "PV00000",
        "terminal_category_type": "SMARTPHONE"
      },
      "fees": {
        "upfront_fee": 0,
        "installment_plan": {
          "last_installment_fee": 0,
          "monthly_fee": 6,
          "duration": 0,
          "unpaid_installments": 10,
          "financed_by": "XFERA"
        },
        "final_installment_plan": {
          "last_installment_fee": 0,
          "monthly_fee": 6,
          "duration": 0,
          "unpaid_installments": 10,
          "financed_by": "XFERA"
        }
      },
      "permanences": {
        "duration_months": 24,
        "current_duration_days": 120,
        "penalty_amount": 120.5,
        "current_penalty_amount": 120.5
      }
    }
  ]
}
Name Type Required Description
devices [DeviceResponse] false none

RequestDetail

1
2
3
4
5
6

{
  "created_date": "2017-09-15T22:00:00Z",
  "request_id": 214748364,
  "request_type": "captacion",
  "user_profile_role": "Generic"
}
Name Type Required Description
created_date string(date-time) false created date
request_id integer(int64) false request id
request_type string false request type
user_profile_role string false user profile role

DeviceInfo

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13

{
  "terminal_id": 214748364,
  "serial_number": 0,
  "device_name": "Honor 90 Smart 5G",
  "device_model": "128GB Midnight Black",
  "financed_by": "XFERA",
  "is_financed": false,
  "value_due_today": 120,
  "reservation_id": "e528d8ec-831f-40e9-8414-8ef7cc99c4e4",
  "paid": false,
  "terminal_code": "PV00000",
  "terminal_category_type": "SMARTPHONE"
}
Name Type Required Description
terminal_id integer(int32) false terminal id
serial_number string false serial number
device_name string false device name
device_model string false device model
financed_by string false financed by. Current operational financial, taking into account the number of pending installments
is_financed boolean false is financed
value_due_today number(double) false value due today
reservation_id string false reservation id
paid boolean false paid
terminal_code string false Catalog terminal code
terminal_category_type string false Catalog terminal category type

Fees

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17

{
  "upfront_fee": 0,
  "installment_plan": {
    "last_installment_fee": 0,
    "monthly_fee": 6,
    "duration": 0,
    "unpaid_installments": 10,
    "financed_by": "XFERA"
  },
  "final_installment_plan": {
    "last_installment_fee": 0,
    "monthly_fee": 6,
    "duration": 0,
    "unpaid_installments": 10,
    "financed_by": "XFERA"
  }
}
Name Type Required Description
upfront_fee number(double) false upfront fee (initial payment)
installment_plan InstallmentPlan false request detail
final_installment_plan InstallmentPlan false request detail

InstallmentPlan

1
2
3
4
5
6
7

{
  "last_installment_fee": 0,
  "monthly_fee": 6,
  "duration": 0,
  "unpaid_installments": 10,
  "financed_by": "XFERA"
}
Name Type Required Description
last_installment_fee number(double) false final payment
monthly_fee number(double) false monthly fee
duration integer(int32) false duration (total permanence)
unpaid_installments integer(int32) false pending fees
financed_by string false financed by

Permanence

1
2
3
4
5
6

{
  "duration_months": 24,
  "current_duration_days": 120,
  "penalty_amount": 120.5,
  "current_penalty_amount": 120.5
}
Name Type Required Description
duration_months integer(int32) false duration months configured
current_duration_days number(int32) false duration months in days, calculated from the current date until the end of the permanence
penalty_amount number(double) false amount of the penalty configured
current_penalty_amount number(double) false amount of the penalty calculated from the current date until the end of the permanence

DeviceResponse

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50

{
  "subscription_id": 214748364,
  "subscription_terminal_id": 214748364,
  "status": {
    "id": 214748364,
    "value": "ACTIVO"
  },
  "request_detail": {
    "created_date": "2017-09-15T22:00:00Z",
    "request_id": 214748364,
    "request_type": "captacion",
    "user_profile_role": "Generic"
  },
  "device_info": {
    "terminal_id": 214748364,
    "serial_number": 0,
    "device_name": "Honor 90 Smart 5G",
    "device_model": "128GB Midnight Black",
    "financed_by": "XFERA",
    "is_financed": false,
    "value_due_today": 120,
    "reservation_id": "e528d8ec-831f-40e9-8414-8ef7cc99c4e4",
    "paid": false,
    "terminal_code": "PV00000",
    "terminal_category_type": "SMARTPHONE"
  },
  "fees": {
    "upfront_fee": 0,
    "installment_plan": {
      "last_installment_fee": 0,
      "monthly_fee": 6,
      "duration": 0,
      "unpaid_installments": 10,
      "financed_by": "XFERA"
    },
    "final_installment_plan": {
      "last_installment_fee": 0,
      "monthly_fee": 6,
      "duration": 0,
      "unpaid_installments": 10,
      "financed_by": "XFERA"
    }
  },
  "permanences": {
    "duration_months": 24,
    "current_duration_days": 120,
    "penalty_amount": 120.5,
    "current_penalty_amount": 120.5
  }
}
Name Type Required Description
subscription_id integer(int64) false identification subscription
subscription_terminal_id integer(int64) false subscription terminal id
status StatusDevices false status device
request_detail RequestDetail false request detail
device_info DeviceInfo false device info
fees Fees false device info
permanences Permanence false permanence info

InvoiceInfoList

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

{
  "account_id": 0,
  "period_date": {
    "start_date": "2020-05-01",
    "end_date": "2020-05-27"
  },
  "invoices": [
    {
      "value": 47.89,
      "value_total": 55.19,
      "delivery_mode": "yosoymas",
      "date": "2017-09-15T22:00:00Z",
      "pay_date": "2017-09-15T22:00:00Z",
      "number": "MM12123445",
      "path": "/path/to/invoices/20120716/XYZ_AB12345.pdf",
      "status": {
        "id": 2,
        "value": "PAGADO"
      },
      "cycle": {
        "start_date": "2030-01-01T12:13:11Z",
        "end_date": "2030-01-17T12:13:11Z"
      }
    }
  ]
}
Name Type Required Description
account_id integer(int64) true account identifier
period_date PeriodDate true none
invoices [InvoiceInfoDetail] true none

InvoiceInfoDetail

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17

{
  "value": 47.89,
  "value_total": 55.19,
  "delivery_mode": "yosoymas",
  "date": "2017-09-15T22:00:00Z",
  "pay_date": "2017-09-15T22:00:00Z",
  "number": "MM12123445",
  "path": "/path/to/invoices/20120716/XYZ_AB12345.pdf",
  "status": {
    "id": 2,
    "value": "PAGADO"
  },
  "cycle": {
    "start_date": "2030-01-01T12:13:11Z",
    "end_date": "2030-01-17T12:13:11Z"
  }
}
Name Type Required Description
value number(double) true invoice value
value_total number(double) false invoice total pay or invoice total value
delivery_mode string true invoice delivery mode
date string(date-time) true invoice date
pay_date string(date-time) false Payment date
number string false invoice identifier number
path string false invoice PDF file path
status object false Invoice status
» id integer(int32) false none
» value string false none
cycle object false none
» start_date string(date-time) false start date of the period. Format yyyy-MM-dd
» end_date string(date-time) false end date of the period. Format yyyy-MM-dd
Property Values
delivery_mode one of [yosoymas, paper, email]

AccountInfo

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31

{
  "id": 214748364,
  "customer_id": 214748364,
  "account_number": "MM-5338507",
  "work_order_id": "FOO_XYZ",
  "work_orders": [
    {
      "work_order_id": "FOO_XYZ",
      "work_order_type": {
        "id": 1,
        "value": "ALTA"
      },
      "status": {
        "id": 32,
        "value": "PENDIENTE CREAR OT"
      },
      "created_date": "2019-12-09T09:58:34Z"
    }
  ],
  "activation_date": "2019-12-09T09:58:34Z",
  "billing_type": {
    "id": 1,
    "value": "POSPAGO"
  },
  "status": {
    "id": 3,
    "value": "ACTIVO"
  },
  "path": "string",
  "filename": "string"
}
Name Type Required Description
id integer(int64) false id de la cuenta
customer_id integer(int64) false id del cliente
account_number string false numero de contrato
work_order_id string false work order identifier. DEPRECATED, this info is in work_orders list
work_orders [WorkOrder] false list of ot associated to a package
activation_date string(date-time) false account activation date
billing_type BillingType false none
status AccountStatus false none
path string false none
filename string false none

WorkOrder

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

{
  "work_order_id": "FOO_XYZ",
  "work_order_type": {
    "id": 1,
    "value": "ALTA"
  },
  "status": {
    "id": 32,
    "value": "PENDIENTE CREAR OT"
  },
  "created_date": "2019-12-09T09:58:34Z"
}
Name Type Required Description
work_order_id string true identification work order
work_order_type WorkOrderType true none
status WorkOrderStatus true none
created_date string(date-time) false work order create date

WorkOrderType

1
2
3
4

{
  "id": 1,
  "value": "ALTA"
}
Name Type Required Description
id integer(int32) false identification work order type
value string false Subscription status value
Property Values
id one of [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21]
value one of [ALTA, BAJA, CAMBIO VELOCIDAD, SUSPENSIÓN, RECONEXIÓN, CANCELACION, ALTA SVA, BAJA SVA, CAMBIO TECNOLOGIA, FTTH->ADSL, CANCELACION PARCIAL, SVA VENTA, SVA BUSINESS, ALTA MIFIJO, BAJA MIFIJO, CANCELACION MIFIJO, CAMBIO DOMICILIO, CANCELACION CAMBIO DOMICILIO, CANCELACION CAMBIO TECNOLOGIA, BAJA CAMBIO DOMICILIO, BAJA CAMBIO TECNOLOGIA]

WorkOrderStatus

1
2
3
4

{
  "id": 32,
  "value": "PENDIENTE CREAR OT"
}
Name Type Required Description
id integer(int32) true identification work order status
value string true Subscription status value
Property Values
id one of [32, 33, 34, 36, 37, 38, 44, 48, 51, 58, 69]
value one of [PENDIENTE CREAR OT, ENVIADA, CANCELADA, CERRADA, CONFIRMADA, INFORMACION ERRONEA, PENDIENTE CREAR OT BY SELL, CERRADO EN BUS, OT PENDING SEND BY FRAUD, SUSPENCION TECNICA, EN PROGRESO]

TaxAccountInfo

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18

{
  "id": 0,
  "tax_value": 21,
  "tax_terminal_value": 21,
  "state_id": 28,
  "description": "IVA",
  "start_date": "1970-01-01T00:00:00Z",
  "historical_changes": [
    {
      "tax_value": 21,
      "tax_terminal_value": 21,
      "state_id": 28,
      "description": "IVA",
      "start_date": "1970-01-01T00:00:00Z",
      "end_date": "1970-01-01T00:00:00Z"
    }
  ]
}
Name Type Required Description
id integer(int64) true account id
tax_value integer(int32) true value tax
tax_terminal_value integer(int32) false value terminal tax
state_id integer(int32) true ID of the state
description string false description of the type tax (IVA, IGIC, etc..)
start_date string(date-time) false Date when the customer moved into the current state
historical_changes [TaxAccountInfoHistoricalChange] false none

TaxAccountInfoHistoricalChange

1
2
3
4
5
6
7
8

{
  "tax_value": 21,
  "tax_terminal_value": 21,
  "state_id": 28,
  "description": "IVA",
  "start_date": "1970-01-01T00:00:00Z",
  "end_date": "1970-01-01T00:00:00Z"
}
Name Type Required Description
tax_value integer(int32) true value tax
tax_terminal_value integer(int32) false value terminal tax
state_id integer(int32) true ID of the state
description string false description of the type tax (IVA, IGIC, etc..)
start_date string(date-time) true init of the period that the account has this state
end_date string(date-time) true end of the period that the account has this state

UsersAccount

1
2
3
4
5
6
7

{
  "account_id": 0,
  "status": {
    "id": 3,
    "value": "ACTIVO"
  }
}
Name Type Required Description
account_id integer(int64) false id de la cuenta
status AccountStatus false none

Subscription

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35

{
  "id": 214748364,
  "subscription_status": {
    "id": 1,
    "value": "INSTALADO"
  },
  "sell_date": "2017-09-15T22:00:00Z",
  "activated_date": "2017-09-15T22:00:00Z",
  "end_date": "2017-09-15T22:00:00Z",
  "subscription_type": {
    "id": 1,
    "value": "PRE-PAGO"
  },
  "origin": {
    "id": 214748364,
    "value": "NUEVA"
  },
  "historical_status": [
    {
      "subscription_status": {
        "id": 1,
        "value": "INSTALADO"
      },
      "date": "2017-09-15T22:00:00Z",
      "modified_by": "somebody"
    }
  ],
  "dealer_id": "string",
  "shop_id": "string",
  "path": "string",
  "filename": "string",
  "identification_nr": 12345,
  "imsi": 214035453370793,
  "iccid": 8934011411551283000
}
Name Type Required Description
id integer(int64) false ID of subscription to return
subscription_status Status false none
sell_date string(date-time) false none
activated_date string(date-time) false none
end_date string(date-time) false none
subscription_type SubscriptionType false none
origin Origin false to get origin use in url object query with include = origin. /subscriptions/{id}?query={“include”:[“origin”]}
historical_status [HistoricalStatus] false none
dealer_id string¦null false Dealer id (in some cases this field can be null)
shop_id string¦null false Shop id (in some cases this field can be null)
path string¦null false Contract path (in some cases this field can be null)
filename string¦null false Contract filename (in some cases this field can be null)
identification_nr integer(int32) false Phone number associated to subscription
imsi integer(int64)¦null false IMSI associated to mobile subscription (in some cases this field can be null)
iccid string¦null false Mobile online icc id (in some cases this field can be null)

HistoricalStatus

1
2
3
4
5
6
7
8

{
  "subscription_status": {
    "id": 1,
    "value": "INSTALADO"
  },
  "date": "2017-09-15T22:00:00Z",
  "modified_by": "somebody"
}
Name Type Required Description
subscription_status Status false none
date string(date-time) false none
modified_by string false none

PromotionBenefitType

1
2
3
4

{
  "id": 1,
  "value": 0.1
}
Name Type Required Description
id integer(int32) false Promotion Benefit Type Id
value number(double) false none
Property Values
id one of [1, 2]

BindingType

1
2
3
4

{
  "id": 214748364,
  "value": "12 MESES"
}
Name Type Required Description
id integer(int32) false none
value string false none

MovementType

1
2
3
4
5

{
  "id": 214748364,
  "value": "PENALIZACION CANCELACION",
  "description": "FIBRA CUOTA PENALIZACIÓN"
}
Name Type Required Description
id integer(int32) false none
value string false Reason of movement
description string false Brief description of reason

RechargeOrigin

1
2
3
4

{
  "id": 214748364,
  "value": "TPV"
}
Name Type Required Description
id number(int32) false none
value string false none

PromotionType

1
2
3
4

{
  "id": 1,
  "value": "string"
}
Name Type Required Description
id integer(int32) false none
value string false M2M, OCU, EMPRESAS, OTRAS, PAQUETE
Property Values
id one of [1, 2, 3, 4, 5]

BillingType

1
2
3
4

{
  "id": 1,
  "value": "POSPAGO"
}
Name Type Required Description
id integer(int32) false Identification billing type
value string false description billing type
Property Values
id one of [1, 2, 3]
value one of [POSPAGO, PREPAGO CLASICO, RECARGA AUTOMATICA]

PaymentInfo

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16

{
  "payment_method": "BANK_ACCOUNT",
  "bank_account": {
    "entity": "string",
    "subsidiary": "string",
    "control_digit": "string",
    "number": "string",
    "iban": "string"
  },
  "credit_card": {
    "reference": "string",
    "type_id": 0,
    "number": "string",
    "validity_date": "string"
  }
}
Name Type Required Description
payment_method PaymentMethod false none
bank_account BankAccount false none
credit_card CreditCard false none

PaymentMethod

1

"BANK_ACCOUNT"
Name Type Required Description
anonymous string false none
Property Values
anonymous one of [BANK_ACCOUNT, BANK_TRANSFER, CREDIT_CARD, ECI, RECURRING_CREDIT_CARD]

BankAccount

1
2
3
4
5
6
7

{
  "entity": "string",
  "subsidiary": "string",
  "control_digit": "string",
  "number": "string",
  "iban": "string"
}
Name Type Required Description
entity string false Bank entity
subsidiary string false Subsidiary
control_digit string false Control digit
number string false Bank account number
iban string false Account iban

CreditCard

1
2
3
4
5
6

{
  "reference": "string",
  "type_id": 0,
  "number": "string",
  "validity_date": "string"
}
Name Type Required Description
reference string false none
type_id number(int32) false none
number string false none
validity_date string false none

LanguageType

1
2
3
4

{
  "id": 90,
  "value": "Castellano"
}
Name Type Required Description
anonymous any false none
Name Type Required Description
» anonymous LanguageTypeId false none
Name Type Required Description
» anonymous LanguageTypeIso false none
Name Type Required Description
anonymous object false Value
» value string false language value
Property Values
value one of [Castellano, Catalan, Galego, Vasco, Ingles, Portugues]

LanguageTypeId

1
2
3

{
  "id": 90
}
Name Type Required Description
id integer(int32) true language identification
Property Values
id one of [90, 91, 92, 93, 96, 97]

LanguageTypeIso

1
2
3

{
  "iso": "es"
}
Name Type Required Description
iso string true language iso code
Property Values
iso one of [es, ca, gl, eu, en, pt]

SubscriptionType

1
2
3
4

{
  "id": 1,
  "value": "PRE-PAGO"
}
Name Type Required Description
id integer(int32) true identification subscription type
value string true Subscription type name
Property Values
id one of [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13]
value one of [PRE-PAGO, POST-PAGO, FIJO ANALOGICO, FIJO DIGITAL, INTERNET ADSL, INTERNET FTTH, AGILE TV, SECURITY, DATA_SHARING, MULTISIM, DEVICEINSURANCE, NETFLIX, APPLEWATCH]

SubscriptionProduct

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59

{
  "id": 214748364,
  "product": {
    "id": 214748364,
    "value": "TARIFA MAS 10GB CONV",
    "historic_date": "2020-05-05T12:29:22Z",
    "compatibilities": [
      {
        "id": 214748364,
        "value": "TARIFA MAS 10GB CONV",
        "historic_date": "2020-05-05T12:29:22Z",
        "compatibilities": [],
        "scheduled": {
          "request_date": "2020-05-05T12:29:22Z",
          "process_date": "2020-05-06T12:29:22Z",
          "scheduled_date": "2020-05-06T12:29:22Z",
          "destination_product": {
            "id": 214748364,
            "value": "TARIFA MAS 10GB CONV",
            "historic_date": "2020-05-05T12:29:22Z",
            "compatibilities": [],
            "scheduled": {}
          }
        }
      }
    ],
    "scheduled": {
      "request_date": "2020-05-05T12:29:22Z",
      "process_date": "2020-05-06T12:29:22Z",
      "scheduled_date": "2020-05-06T12:29:22Z",
      "destination_product": {
        "id": 214748364,
        "value": "TARIFA MAS 10GB CONV",
        "historic_date": "2020-05-05T12:29:22Z",
        "compatibilities": [
          {
            "id": 214748364,
            "value": "TARIFA MAS 10GB CONV",
            "historic_date": "2020-05-05T12:29:22Z",
            "compatibilities": [],
            "scheduled": {}
          }
        ],
        "scheduled": {}
      }
    }
  },
  "bundle": {
    "id": 214748364,
    "value": "FIBRA 600Mb INDIRECTA + TARIFA MÁS 10GB"
  },
  "historical_changes": [
    {
      "id": 214748364,
      "value": "TARIFA MAS 10GB CONV",
      "historic_date": "2020-05-05T12:29:22Z"
    }
  ]
}
Name Type Required Description
id integer(int64) true identification subscription
product Product true none
bundle Bundle false none
historical_changes [HistoricalProduct] false Tariff change history, ordered by datetime in descending order. The current tariff is always included at the top of the list.

ChangeAccountPaymentInfoRequest

1
2
3
4
5
6

{
  "entity": "1111",
  "subsidiary": "1111",
  "control_digit": "30",
  "number": "1111111111"
}
Name Type Required Description
entity string true bank entity
subsidiary string true bank subsidiary
control_digit string true control digit
number string true account number

ChangeSubscriptionProductRequest

1
2
3
4

{
  "productId": 214748364,
  "scheduled_date": "2019-08-24"
}
Name Type Required Description
productId integer(int64) true target product identifier
scheduled_date string(date) false Desired date to execute operation

SubscriptionBonusesRequest

1
2
3
4

{
  "bonusId": 214748364,
  "scheduled_date": "2019-08-24"
}
Name Type Required Description
bonusId integer(int64) true bonus ID to add
scheduled_date string(date) false Desired date to execute operation

HistoricalProduct

1
2
3
4
5

{
  "id": 214748364,
  "value": "TARIFA MAS 10GB CONV",
  "historic_date": "2020-05-05T12:29:22Z"
}
Name Type Required Description
id integer(int32) false identification product
value string false name product
historic_date string(date-time) false Last date change of rate.

Product

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45

{
  "id": 214748364,
  "value": "TARIFA MAS 10GB CONV",
  "historic_date": "2020-05-05T12:29:22Z",
  "compatibilities": [
    {
      "id": 214748364,
      "value": "TARIFA MAS 10GB CONV",
      "historic_date": "2020-05-05T12:29:22Z",
      "compatibilities": [],
      "scheduled": {
        "request_date": "2020-05-05T12:29:22Z",
        "process_date": "2020-05-06T12:29:22Z",
        "scheduled_date": "2020-05-06T12:29:22Z",
        "destination_product": {
          "id": 214748364,
          "value": "TARIFA MAS 10GB CONV",
          "historic_date": "2020-05-05T12:29:22Z",
          "compatibilities": [],
          "scheduled": {}
        }
      }
    }
  ],
  "scheduled": {
    "request_date": "2020-05-05T12:29:22Z",
    "process_date": "2020-05-06T12:29:22Z",
    "scheduled_date": "2020-05-06T12:29:22Z",
    "destination_product": {
      "id": 214748364,
      "value": "TARIFA MAS 10GB CONV",
      "historic_date": "2020-05-05T12:29:22Z",
      "compatibilities": [
        {
          "id": 214748364,
          "value": "TARIFA MAS 10GB CONV",
          "historic_date": "2020-05-05T12:29:22Z",
          "compatibilities": [],
          "scheduled": {}
        }
      ],
      "scheduled": {}
    }
  }
}
Name Type Required Description
anonymous HistoricalProduct false none
Name Type Required Description
anonymous object false none
» compatibilities [Product] false Rates compatibles.
» scheduled ScheduledProduct false Scheduled product change date, return this item only if you have a rate change scheduled

ScheduledProduct

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50

{
  "request_date": "2020-05-05T12:29:22Z",
  "process_date": "2020-05-06T12:29:22Z",
  "scheduled_date": "2020-05-06T12:29:22Z",
  "destination_product": {
    "id": 214748364,
    "value": "TARIFA MAS 10GB CONV",
    "historic_date": "2020-05-05T12:29:22Z",
    "compatibilities": [
      {
        "id": 214748364,
        "value": "TARIFA MAS 10GB CONV",
        "historic_date": "2020-05-05T12:29:22Z",
        "compatibilities": [],
        "scheduled": {
          "request_date": "2020-05-05T12:29:22Z",
          "process_date": "2020-05-06T12:29:22Z",
          "scheduled_date": "2020-05-06T12:29:22Z",
          "destination_product": {
            "id": 214748364,
            "value": "TARIFA MAS 10GB CONV",
            "historic_date": "2020-05-05T12:29:22Z",
            "compatibilities": [],
            "scheduled": {}
          }
        }
      }
    ],
    "scheduled": {
      "request_date": "2020-05-05T12:29:22Z",
      "process_date": "2020-05-06T12:29:22Z",
      "scheduled_date": "2020-05-06T12:29:22Z",
      "destination_product": {
        "id": 214748364,
        "value": "TARIFA MAS 10GB CONV",
        "historic_date": "2020-05-05T12:29:22Z",
        "compatibilities": [
          {
            "id": 214748364,
            "value": "TARIFA MAS 10GB CONV",
            "historic_date": "2020-05-05T12:29:22Z",
            "compatibilities": [],
            "scheduled": {}
          }
        ],
        "scheduled": {}
      }
    }
  }
}
Name Type Required Description
request_date string(date-time) false none
process_date string(date-time) false none
scheduled_date string(date-time) false none
destination_product Product false none

Bundle

1
2
3
4

{
  "id": 214748364,
  "value": "FIBRA 600Mb INDIRECTA + TARIFA MÁS 10GB"
}
Name Type Required Description
id integer(int32) false identification bundle
value string false name bundle

AccountStatus

1
2
3
4

{
  "id": 3,
  "value": "ACTIVO"
}
Name Type Required Description
id integer(int32) false account status
value string false name of account status
Property Values
id one of [3, 6, 7, 11, 13]
value one of [ACTIVO, TERMINADO, BLOQUEO TEMPORAL, PENDIENTE DE REVISIÓN, PENDIENTE DE ACEPTACION]

Status

1
2
3
4

{
  "id": 1,
  "value": "INSTALADO"
}
Name Type Required Description
id integer(int32) true identification subscription status
value string true Subscription status value
Property Values
id one of [1, 2, 3, 4, 6, 7, 9, 10, 12, 39, 40, 46, 50, 82, 99]
value one of [INSTALADO, PRE-ACTIVADO, ACTIVO, BLOQUEO POR SALDO, TERMINADO, BLOQUEO TEMPORAL, PENDIENTE TERMINACION, BLOQUEO LIMITE CONSUMO, BLOQUEO POR IMPAGO, SUSPENSION PENDIENTE, RECONEXION PENDIENTE, OK, PENDIENTE BLOQUEO TEMPORAL, PENDIENTE A DESACTIVAR, BLOQUEO POR RIESGO]

StatusDevices

1
2
3
4

{
  "id": 214748364,
  "value": "ACTIVO"
}
Name Type Required Description
id integer(int32) true identification device status
value string true Device status value

Origin

1
2
3
4

{
  "id": 214748364,
  "value": "NUEVA"
}
Name Type Required Description
id integer(int32) false identification origin
value string false name of origin
Property Values
id one of [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]
value one of [NUEVA, PORTABILIDAD, CENTRO DE ATENCION AL CLIENTE, MIGRACION CONTRATO, REEMPLAZO, YOSOYMAS, PORTAL DE DISTRIBUICION, CANAL ONLINE (AFILIADO), MARCA BLANCA (MAYORISTA), PORTABILIDAD MARCAS]

Promotions

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54

{
  "subscription_promotions": [
    {
      "subscription_id": 214748364,
      "promotion_id": 214748364,
      "promotion_code": "NTH_256",
      "promotion_name": "MM_50% DTO_CONVERGENCIA_FIDELIZACIÓN_12_MESES",
      "association_date": "2017-09-15T22:00:00Z",
      "end_date": "2017-09-15T22:00:00Z",
      "account_bundle_id": 214748364,
      "promotion_benefit_type": {
        "id": 1,
        "value": 0.1
      },
      "promotion_type": {
        "id": 1,
        "value": "string"
      }
    }
  ],
  "account_promotions": [
    {
      "promotion_id": 0,
      "begin_date": "2017-09-15T22:00:00Z",
      "promotion_name": "string",
      "end_date": "2017-09-15T22:00:00Z",
      "promotion_benefit_type": {
        "id": 1,
        "value": 0.1
      },
      "promotion_type": {
        "id": 1,
        "value": "string"
      }
    }
  ],
  "account_bundle_promotions": [
    {
      "promotion_id": 0,
      "effective_date_ini": "2017-09-15T22:00:00Z",
      "effective_date_end": "2017-09-15T22:00:00Z",
      "promotion_name": "string",
      "account_bundle_id": 0,
      "promotion_benefit_type": {
        "id": 1,
        "value": 0.1
      },
      "promotion_type": {
        "id": 1,
        "value": "string"
      }
    }
  ]
}
Name Type Required Description
subscription_promotions [SubscriptionPromotion] false none
account_promotions [AccountPromotion] false none
account_bundle_promotions [AccountBundlePromotion] false none

SubscriptionBonus

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

{
  "id": 214748364,
  "items": [
    {
      "id": 214748364,
      "value": "INTERNET 3GB TPILI",
      "start_date": "2017-09-15T22:00:00Z",
      "end_date": "2017-09-15T22:00:00Z"
    }
  ]
}
Name Type Required Description
id integer(int64) false identification subscription
items [Bonus] false none

SubscriptionServices

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

{
  "subscription_id": 0,
  "items": [
    {
      "id": 214748364,
      "value": "VOZ",
      "changeable": true,
      "date_last_modified": "2017-09-15T22:00:00Z",
      "active": true
    }
  ]
}
Name Type Required Description
subscription_id integer(int64) false identification subscription
items [Service] false none

SubscriptionBlocks

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

{
  "subscription_id": 0,
  "items": [
    {
      "id": 214748364,
      "value": "ROBO",
      "date_last_modified": "2017-09-15T22:00:00Z",
      "description": "A PETICION DE CLIENTE"
    }
  ]
}
Name Type Required Description
subscription_id integer(int64) false identification subscription
items [Block] false none

PeriodDate

1
2
3
4

{
  "start_date": "2020-05-01",
  "end_date": "2020-05-27"
}
Name Type Required Description
start_date string(date) false start date of the period. Format yyyy-MM-dd
end_date string(date) false end date of the period. Format yyyy-MM-dd

SubscriptionDetailRecharge

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17

{
  "subscription_id": 214748364,
  "identification_nr": 12345,
  "period_date": {
    "start_date": "2020-05-01",
    "end_date": "2020-05-27"
  },
  "recharges": [
    {
      "recharge_id": 214748364,
      "date": "2020-05-17T12:13:11Z",
      "movement_type_id": 214748364,
      "origin_id": 214748364,
      "amount": 0
    }
  ]
}
Name Type Required Description
subscription_id integer(int64) false identification subscription
identification_nr integer(int32) false number of identification
period_date PeriodDate false none
recharges [DetailRechargeEvent] false [recharge detail record]

DetailRechargeEvent

1
2
3
4
5
6
7

{
  "recharge_id": 214748364,
  "date": "2020-05-17T12:13:11Z",
  "movement_type_id": 214748364,
  "origin_id": 214748364,
  "amount": 0
}
Name Type Required Description
recharge_id integer(int64) false unique identification for recharge
date string(date-time) false recharge date
movement_type_id integer(int32) false movement type identifier
origin_id integer(int32) false recharge origin identifier
amount number(double) false recharge value for current msisdn and date

User

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62

{
  "id": 214748364,
  "customer_id": 214748364,
  "language": {
    "id": 90,
    "value": "Castellano"
  },
  "document_type": {
    "id": 1,
    "value": "NUMERO IDENTIFICACION FISCAL"
  },
  "document_value": "11111111A",
  "sector": {
    "id": 1,
    "value": "RESIDENCIAL"
  },
  "type": {
    "id": 1,
    "value": "PARTICULAR"
  },
  "nationality": {
    "id": 214748364,
    "value": "ESPAÑA"
  },
  "personal": {
    "first_name": "John",
    "middle_name": "Nicholas",
    "last_name": "Doe",
    "gender": "M",
    "birthdate": "2019-08-24",
    "other_phone": 12345,
    "email": "john.doe@example.com"
  },
  "business": {
    "company": "SPACEX",
    "created_date": "2019-08-24",
    "other_phone": 12345,
    "email": "john.doe@example.com",
    "responsable": {
      "id": 214748364,
      "name": "John",
      "middlename": "Nicholas",
      "lastname": "Doe",
      "document_type_id": 1,
      "document_value": "11111111A",
      "nationality_id": 214748364,
      "nationality_iso": "ES",
      "nationality_value": "España"
    }
  },
  "address_info": {
    "state_id": 214748364,
    "address": "CALLE EMILIO FERRARI",
    "state": "MADRID",
    "zip_code": "28017",
    "locality": "MADRID"
  },
  "special_treatment": {
    "id": 42,
    "value": "Influencer"
  }
}
Name Type Required Description
id integer(int64) true none
customer_id integer(int64) false none
language LanguageType false none
document_type DocumentType true none
document_value string true none
sector UserSector false none
type UserType true none
nationality Nationality false none
personal Personal false none
business Business false none
address_info UserAddress false none
special_treatment SpecialTreatment false possible values can be retrieved in mas-customers v4 api /orgs/{org_id}/special-treatment

Users-user

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

{
  "id": 214748364,
  "customer_id": 214748364,
  "customer_uuid": "123e4567-e89b-12d3-a456-556642440000",
  "accounts": [
    {
      "id": 214748364,
      "owner_id": 214748364,
      "subscriptions": [
        {
          "id": 214748364,
          "subscription_type": {
            "id": 1,
            "value": "PRE-PAGO"
          },
          "status": {
            "id": 1,
            "value": "INSTALADO"
          },
          "user_id": 214748364,
          "identification_nr": 12345,
          "expedition_user_id": 214748364,
          "bundle_id": 214748364,
          "mobile_line_type": "mobile"
        }
      ]
    }
  ]
}
Name Type Required Description
id integer(int64) true User id
customer_id integer(int64) true Customer id
customer_uuid string(uuid) false Customer UUID from customers API V4
accounts [Users-account] false Accounts associated to user

Users-account

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22

{
  "id": 214748364,
  "owner_id": 214748364,
  "subscriptions": [
    {
      "id": 214748364,
      "subscription_type": {
        "id": 1,
        "value": "PRE-PAGO"
      },
      "status": {
        "id": 1,
        "value": "INSTALADO"
      },
      "user_id": 214748364,
      "identification_nr": 12345,
      "expedition_user_id": 214748364,
      "bundle_id": 214748364,
      "mobile_line_type": "mobile"
    }
  ]
}
Name Type Required Description
id integer(int64) true Account id
owner_id integer(int64) true User id owner of the account
subscriptions [Users-subscription] false Subscriptions associated to account

Users-subscription

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16

{
  "id": 214748364,
  "subscription_type": {
    "id": 1,
    "value": "PRE-PAGO"
  },
  "status": {
    "id": 1,
    "value": "INSTALADO"
  },
  "user_id": 214748364,
  "identification_nr": 12345,
  "expedition_user_id": 214748364,
  "bundle_id": 214748364,
  "mobile_line_type": "mobile"
}
Name Type Required Description
id integer(int64) true Subscription id
subscription_type SubscriptionType true none
status Status true none
user_id integer(int64) true User id owner of the subscription
identification_nr integer(int64) true Number of identification
expedition_user_id integer(int64) false none
bundle_id integer(int64) false Bundle in which subscription is included, if so
mobile_line_type string false Type of line, only applicable to mobile subscriptions. In case the line does not belong to a bundled account, then its value will be always mobile. Otherwise, main, extra and additional refers to the type of each mobile line in the bundled account.
Property Values
mobile_line_type one of [mobile, main, extra, additional]

Personal

1
2
3
4
5
6
7
8
9

{
  "first_name": "John",
  "middle_name": "Nicholas",
  "last_name": "Doe",
  "gender": "M",
  "birthdate": "2019-08-24",
  "other_phone": 12345,
  "email": "john.doe@example.com"
}
Name Type Required Description
first_name string¦null true Person’s name
middle_name string¦null false Person’s middle name
last_name string¦null false Person’s last name
gender string¦null false Male or female
birthdate string(date)¦null false Birthdate
other_phone string¦null false Additional phone of contact
email string¦null false Email of contact
Property Values
gender one of [M, F]

Business

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17

{
  "company": "SPACEX",
  "created_date": "2019-08-24",
  "other_phone": 12345,
  "email": "john.doe@example.com",
  "responsable": {
    "id": 214748364,
    "name": "John",
    "middlename": "Nicholas",
    "lastname": "Doe",
    "document_type_id": 1,
    "document_value": "11111111A",
    "nationality_id": 214748364,
    "nationality_iso": "ES",
    "nationality_value": "España"
  }
}
Name Type Required Description
company string¦null true Name of the company
created_date string(date)¦null false Date of creation of the company
other_phone string¦null false Additional phone of contact
email string¦null false Email of contact
responsable UserBusinessResponsable false Person assigned as responsable of the company

UserBusinessResponsable

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

{
  "id": 214748364,
  "name": "John",
  "middlename": "Nicholas",
  "lastname": "Doe",
  "document_type_id": 1,
  "document_value": "11111111A",
  "nationality_id": 214748364,
  "nationality_iso": "ES",
  "nationality_value": "España"
}
Name Type Required Description
id integer(int64) false Responsable id
name string false none
middlename string false none
lastname string false none
document_type_id integer(int32) false none
document_value string false none
nationality_id number(int32) false none
nationality_iso string false none
nationality_value string false none
Property Values
document_type_id one of [1, 3, 4, 5]

DocumentType

1
2
3
4

{
  "id": 1,
  "value": "NUMERO IDENTIFICACION FISCAL"
}
Name Type Required Description
id integer(int64) true document type id
value string false document type value
Property Values
id one of [1, 2, 3, 4, 5]
value one of [NUMERO IDENTIFICACION FISCAL, DNI, TARJETA RESIDENCIA, PASAPORTE, CODIGO IDENTIFICACION FISCAL]

UserSector

1
2
3
4

{
  "id": 1,
  "value": "RESIDENCIAL"
}
Name Type Required Description
id integer(int32) true Sector id
value string true Sector value
Property Values
id one of [1, 2, 3, 4]
value one of [RESIDENCIAL, EMPRESA, AUTONOMO, HORECA]

UserType

1
2
3
4

{
  "id": 1,
  "value": "PARTICULAR"
}
Name Type Required Description
id integer(int64) true User type id
value string true User type value
Property Values
id one of [1, 2]
value one of [PARTICULAR, EMPRESA]

Nationality

1
2
3
4

{
  "id": 214748364,
  "value": "ESPAÑA"
}
Name Type Required Description
anonymous any false none
Name Type Required Description
» anonymous NationalityId false none
Name Type Required Description
» anonymous NationalityIso false none
Name Type Required Description
anonymous object false Value
» value string false nationality name

NationalityId

1
2
3

{
  "id": 214748364
}
Name Type Required Description
id integer(int64) true nationality id

NationalityIso

1
2
3

{
  "iso": "ES"
}
Name Type Required Description
iso string true nationality iso

SpecialTreatment

1
2
3
4

{
  "id": 42,
  "value": "Influencer"
}
Name Type Required Description
id integer(int64) true special treatment id
value string false special treatment value

UserAddress

1
2
3
4
5
6
7

{
  "state_id": 214748364,
  "address": "CALLE EMILIO FERRARI",
  "state": "MADRID",
  "zip_code": "28017",
  "locality": "MADRID"
}
Name Type Required Description
anonymous any false none
Name Type Required Description
» anonymous UserAddressStateId false none
Name Type Required Description
» anonymous UserAddressStateIso false none
Name Type Required Description
anonymous object false none
» address string¦null false Name of the address
» state string false Name of the state
» zip_code string true Zip/Postal code
» locality string¦null false Name of the locality

UserAddressStateId

1
2
3

{
  "state_id": 214748364
}
Name Type Required Description
state_id integer(int32) true ID of the state

UserAddressStateIso

1
2
3

{
  "state_iso": "ES-LU"
}
Name Type Required Description
state_iso string true ISO of the state

ErrorMessage

1
2
3
4
5
6

{
  "code": 0,
  "status": "string",
  "message": "string",
  "detailMsg": "string"
}
Name Type Required Description
code integer(int32) false Custom error code
status string false Status
message string false Status message
detailMsg string false Detailed description of the error

Query

1
2
3
4
5
6
7
8

{
  "filter": [
    "string"
  ],
  "include": [
    "string"
  ]
}
Name Type Required Description
filter [string] false none
include [string] false none

UserTreeSearch

1
2
3
4

{
  "document_type": "NIF",
  "document": "string"
}
Name Type Required Description
anonymous UserDocumentSearch false document type and value for user search
Name Type Required Description
anonymous UserNumberSearch false user number (MSISDN)
Name Type Required Description
anonymous UserEmailSearch false user email

UserDocumentSearch

1
2
3
4

{
  "document_type": "NIF",
  "document": "string"
}
Name Type Required Description
document_type DocumentTypeSearch true document type value
document string true none

UserNumberSearch

1
2
3

{
  "number": "string"
}
Name Type Required Description
number string true none

UserEmailSearch

1
2
3

{
  "email": "string"
}
Name Type Required Description
email string true none

DocumentTypeSearch

1

"NIF"
Name Type Required Description
anonymous string false document type value
Property Values
anonymous one of [NIF, DNI, TR, PASS, CIF]

SimReplacement

1
2
3
4
5
6

{
  "dealer_id": "string",
  "shop_id": "string",
  "logistic": true,
  "new_icc": "string"
}
Name Type Required Description
dealer_id string true Dealer ID
shop_id string false Shop ID
logistic boolean true Online/offline operation
new_icc string false New icc

SimcardInfoResponse

1
2
3
4
5
6
7
8
9

{
  "simcard_status_id": 0,
  "origin_id": 0,
  "create_date": "2019-08-24",
  "last_status_date": "2019-08-24",
  "promotion_code": "NTH_256",
  "society_id": "string",
  "initial_balance": 0.1
}
Name Type Required Description
simcard_status_id number(int32) false Simcard status id
origin_id number(int32) false Origin id
create_date string(date) false Date of creation
last_status_date string(date) false Last status date
promotion_code string false Promotion code
society_id string false Last status date
initial_balance number(double) false Initial balance

PatchAgileTvSubscriptionRequest

1
2
3
4
5

{
  "old_email": "old_email@example.com",
  "new_email": "new_email@example.com",
  "document_number": "11111111A"
}
Name Type Required Description
old_email string true none
new_email string true none
document_number string true none

ActivateSim

1
2
3
4

{
  "msisdn": "string",
  "activation_type": 0
}
Name Type Required Description
msisdn string true Phone number
activation_type number(int32) false none

SignupsRequest

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516

{
  "sales_type": "telecomunications",
  "sales_info": {
    "channel": "dealer",
    "dealer_id": "string",
    "shop_id": "string",
    "agent_id": "string",
    "logistic": true,
    "signature_process_id": 0,
    "signature_type": "PAPER",
    "channel_id": 0
  },
  "clients": {
    "sector_id": 1,
    "attributes": [
      {
        "type": "existing",
        "document_type_id": 1,
        "document_value": "11111111A",
        "document_expiration_date": "1999-01-31",
        "employment": {
          "activity_country_code": "st",
          "company": "string",
          "income": 9999999999999.99,
          "income_source": {
            "id": 999999999,
            "observations": "string"
          },
          "profession": 999999999,
          "professional_area": 999999999,
          "professional_use": true
        }
      }
    ]
  },
  "payment": {
    "billing_type_id": 1,
    "scoring": {
      "scoring_value": 0,
      "id_value": 0,
      "forced_value": 0,
      "up_front": 0.1,
      "credit_limit": 0.1,
      "credit_limit_available": 0.1,
      "app_id": 0
    },
    "info": {
      "bank_account": "string",
      "swift_bic": "string"
    },
    "tpv_response": {
      "amount": "string",
      "card_number": "000000******0000",
      "expiry_date": "0121",
      "transaction_id": "1563B44RPR2",
      "reference_id": "string",
      "platform": "PAYMENTS",
      "payment_link": "string",
      "tax": 21
    },
    "account_number": "string"
  },
  "products": {
    "mobile_line": {
      "existing_number": false,
      "type": "mobile",
      "product_id": 214748364,
      "portability_info": {
        "scheduled_date": "2020-04-20",
        "iccid": "string",
        "operator_id": "string",
        "operation_type": 1,
        "initial_date_operation": "1999-01-31",
        "donor_line_type": "C",
        "donor_user": {
          "type": "existing",
          "document_type_id": 1,
          "document_value": "11111111A"
        },
        "internal_portability": true,
        "installation_required": true
      },
      "msisdn": "string",
      "iccid": "string",
      "fabrication_type_sim_id": 214748364,
      "initial_balance": 0.1,
      "bonuses": [
        {
          "id": 0
        }
      ],
      "promotions": [
        {
          "id": 0,
          "value": "string"
        }
      ],
      "terminals": [
        {
          "id": 0,
          "financed": true,
          "imei": "string",
          "serial_number": "string"
        }
      ],
      "wants_communications": true,
      "expedition_info": {
        "language_id": 214748364,
        "nationality_id": 214748364,
        "name": "John",
        "middlename": "Nicholas",
        "lastname": "Doe",
        "document_type_id": 1,
        "document_value": "11111111A",
        "email": "john.doe@example.com",
        "birthdate": "1999-01-31",
        "contact_phone": "string",
        "gender": "M",
        "address": {
          "street_name": "string",
          "state_id": 0,
          "locality": "string",
          "postal_code": "string",
          "country": "string",
          "number": "string",
          "value": "Castellano"
        }
      },
      "delivery_info": {
        "contact": {
          "name": "string",
          "middlename": "string",
          "lastname": "string",
          "phone": "string",
          "email": "string",
          "document_type_id": 0,
          "document_value": "string"
        },
        "address": {
          "street_type_id": 0,
          "street_name": "string",
          "number": "string",
          "supplement": "string",
          "state_id": 0,
          "locality": "string",
          "postal_code": "string",
          "observation": "string"
        },
        "delivery_shop_id": "0025",
        "delivery_type": "LOGISTIC"
      },
      "devices": [
        {
          "device_details": {
            "id": 0,
            "model_id": "string",
            "cession_price": 999999999.99,
            "imei": "string",
            "pending_imei": true,
            "insured_amount": 0.01,
            "category": "string",
            "logistic_required": true,
            "catalogue_id": "string",
            "amount": 0.01
          },
          "fees": {
            "upfront_fee": 999999999.99,
            "installment_plan": {
              "commission": 999999999.99,
              "tae": 999999999.99,
              "tin": 999999999.99,
              "duration": 1,
              "monthly_fee": 999999999.99,
              "last_installment_fee": 999999999.99,
              "discount_final_payment_value": 999999999.99,
              "is_promotional_renew": true
            }
          },
          "financial_details": {
            "pre_booking": {
              "order_id": "string",
              "authorization_id": "string",
              "financial_entity": "string",
              "status": "Accepted",
              "granted_amount": 999999999,
              "credit_line_amount": 999999999,
              "total_client_financed_value": 999999999.99
            },
            "consents": {
              "commercial": true,
              "gdpr": true
            }
          },
          "campaign_id": 0,
          "terms": {
            "penalty_value": 999999999.99,
            "commitment_duration": 9999
          },
          "reservation_id": "string",
          "signature_process_id": 0,
          "signature_type": "PAPER",
          "old_subscription_terminal_id": 0
        }
      ]
    },
    "bundle": {
      "bundle_id": 0,
      "territory_owner": "string",
      "promotions": [
        {
          "id": 0,
          "value": "string"
        }
      ],
      "installation_info": {
        "contact": {
          "name": "string",
          "middlename": "string",
          "lastname": "string",
          "phone": "string",
          "email": "string",
          "document_type_id": 0,
          "document_value": "string"
        },
        "address": {
          "street_type_id": 0,
          "street_name": "string",
          "number": "string",
          "supplement": "string",
          "state_id": 0,
          "locality": "string",
          "postal_code": "string",
          "gescal": "stringstringstrin",
          "pair_vacancy": true,
          "address_id": "string"
        }
      },
      "delivery_info": {
        "contact": {
          "name": "string",
          "middlename": "string",
          "lastname": "string",
          "phone": "string",
          "email": "string",
          "document_type_id": 0,
          "document_value": "string"
        },
        "address": {
          "street_type_id": 0,
          "street_name": "string",
          "number": "string",
          "supplement": "string",
          "state_id": 0,
          "locality": "string",
          "postal_code": "string",
          "observation": "string"
        },
        "delivery_shop_id": "0025",
        "delivery_type": "LOGISTIC"
      },
      "landline": {
        "product_id": 0,
        "portability_info": {
          "scheduled_date": "2020-04-20",
          "iccid": "string",
          "operator_id": "string",
          "operation_type": 1,
          "initial_date_operation": "1999-01-31",
          "donor_line_type": "C",
          "donor_user": {
            "type": "existing",
            "document_type_id": 1,
            "document_value": "11111111A"
          },
          "internal_portability": true,
          "installation_required": true
        },
        "number": "string",
        "bonuses": [
          {
            "id": 0
          }
        ],
        "promotions": [
          {
            "id": 0,
            "value": "string"
          }
        ],
        "services": [
          {
            "id": 0
          }
        ],
        "wants_communications": true
      },
      "ftth": {
        "product_id": 0,
        "promotions": [
          {
            "id": 0,
            "value": "string"
          }
        ],
        "connection_type": "string",
        "installer": "string",
        "iua": "string",
        "terminals": [
          {
            "id": 0,
            "financed": true,
            "imei": "string",
            "serial_number": "string"
          }
        ],
        "wants_communications": true,
        "access_reuse": "Interno",
        "access_reuse_choice": true,
        "services": [
          {
            "id": 0
          }
        ]
      },
      "adsl": {
        "product_id": 0,
        "promotions": [
          {
            "id": 0,
            "value": "string"
          }
        ],
        "wants_communications": true,
        "install_tech_support": true,
        "tech_support_billiable": true
      },
      "mobile_lines": [
        {
          "existing_number": false,
          "type": "mobile",
          "product_id": 214748364,
          "portability_info": {
            "scheduled_date": "2020-04-20",
            "iccid": "string",
            "operator_id": "string",
            "operation_type": 1,
            "initial_date_operation": "1999-01-31",
            "donor_line_type": "C",
            "donor_user": {
              "type": "existing",
              "document_type_id": 1,
              "document_value": "11111111A"
            },
            "internal_portability": true,
            "installation_required": true
          },
          "msisdn": "string",
          "iccid": "string",
          "fabrication_type_sim_id": 214748364,
          "initial_balance": 0.1,
          "bonuses": [
            {
              "id": 0
            }
          ],
          "promotions": [
            {
              "id": 0,
              "value": "string"
            }
          ],
          "terminals": [
            {
              "id": 0,
              "financed": true,
              "imei": "string",
              "serial_number": "string"
            }
          ],
          "wants_communications": true,
          "expedition_info": {
            "language_id": 214748364,
            "nationality_id": 214748364,
            "name": "John",
            "middlename": "Nicholas",
            "lastname": "Doe",
            "document_type_id": 1,
            "document_value": "11111111A",
            "email": "john.doe@example.com",
            "birthdate": "1999-01-31",
            "contact_phone": "string",
            "gender": "M",
            "address": {
              "street_name": "string",
              "state_id": 0,
              "locality": "string",
              "postal_code": "string",
              "country": "string",
              "number": "string",
              "value": "Castellano"
            }
          },
          "delivery_info": {
            "contact": {
              "name": "string",
              "middlename": "string",
              "lastname": "string",
              "phone": "string",
              "email": "string",
              "document_type_id": 0,
              "document_value": "string"
            },
            "address": {
              "street_type_id": 0,
              "street_name": "string",
              "number": "string",
              "supplement": "string",
              "state_id": 0,
              "locality": "string",
              "postal_code": "string",
              "observation": "string"
            },
            "delivery_shop_id": "0025",
            "delivery_type": "LOGISTIC"
          },
          "devices": [
            {
              "device_details": {
                "id": 0,
                "model_id": "string",
                "cession_price": 999999999.99,
                "imei": "string",
                "pending_imei": true,
                "insured_amount": 0.01,
                "category": "string",
                "logistic_required": true,
                "catalogue_id": "string",
                "amount": 0.01
              },
              "fees": {
                "upfront_fee": 999999999.99,
                "installment_plan": {
                  "commission": 999999999.99,
                  "tae": 999999999.99,
                  "tin": 999999999.99,
                  "duration": 1,
                  "monthly_fee": 999999999.99,
                  "last_installment_fee": 999999999.99,
                  "discount_final_payment_value": 999999999.99,
                  "is_promotional_renew": true
                }
              },
              "financial_details": {
                "pre_booking": {
                  "order_id": "string",
                  "authorization_id": "string",
                  "financial_entity": "string",
                  "status": "Accepted",
                  "granted_amount": 999999999,
                  "credit_line_amount": 999999999,
                  "total_client_financed_value": 999999999.99
                },
                "consents": {
                  "commercial": true,
                  "gdpr": true
                }
              },
              "campaign_id": 0,
              "terms": {
                "penalty_value": 999999999.99,
                "commitment_duration": 9999
              },
              "reservation_id": "string",
              "signature_process_id": 0,
              "signature_type": "PAPER",
              "old_subscription_terminal_id": 0
            }
          ]
        }
      ],
      "tv": {
        "product_id": 0,
        "number_associated": "string",
        "registration_email": "string",
        "contact_phone": "string",
        "install_tech_support": true,
        "promotions": [
          {
            "id": 0,
            "value": "string"
          }
        ],
        "terminals": [
          {
            "id": 0,
            "financed": true,
            "imei": "string",
            "serial_number": "string"
          }
        ]
      },
      "ott": [
        {
          "product_id": 0,
          "email": "string",
          "promotions": [
            {
              "id": 0,
              "value": "string"
            }
          ]
        }
      ]
    }
  }
}
Name Type Required Description
sales_type string true none
sales_info SalesInfo true none
clients SignupClients true none
payment SignupsPayment true none
products Products true none
Property Values
sales_type one of [telecomunications]

Products

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453

{
  "mobile_line": {
    "existing_number": false,
    "type": "mobile",
    "product_id": 214748364,
    "portability_info": {
      "scheduled_date": "2020-04-20",
      "iccid": "string",
      "operator_id": "string",
      "operation_type": 1,
      "initial_date_operation": "1999-01-31",
      "donor_line_type": "C",
      "donor_user": {
        "type": "existing",
        "document_type_id": 1,
        "document_value": "11111111A"
      },
      "internal_portability": true,
      "installation_required": true
    },
    "msisdn": "string",
    "iccid": "string",
    "fabrication_type_sim_id": 214748364,
    "initial_balance": 0.1,
    "bonuses": [
      {
        "id": 0
      }
    ],
    "promotions": [
      {
        "id": 0,
        "value": "string"
      }
    ],
    "terminals": [
      {
        "id": 0,
        "financed": true,
        "imei": "string",
        "serial_number": "string"
      }
    ],
    "wants_communications": true,
    "expedition_info": {
      "language_id": 214748364,
      "nationality_id": 214748364,
      "name": "John",
      "middlename": "Nicholas",
      "lastname": "Doe",
      "document_type_id": 1,
      "document_value": "11111111A",
      "email": "john.doe@example.com",
      "birthdate": "1999-01-31",
      "contact_phone": "string",
      "gender": "M",
      "address": {
        "street_name": "string",
        "state_id": 0,
        "locality": "string",
        "postal_code": "string",
        "country": "string",
        "number": "string",
        "value": "Castellano"
      }
    },
    "delivery_info": {
      "contact": {
        "name": "string",
        "middlename": "string",
        "lastname": "string",
        "phone": "string",
        "email": "string",
        "document_type_id": 0,
        "document_value": "string"
      },
      "address": {
        "street_type_id": 0,
        "street_name": "string",
        "number": "string",
        "supplement": "string",
        "state_id": 0,
        "locality": "string",
        "postal_code": "string",
        "observation": "string"
      },
      "delivery_shop_id": "0025",
      "delivery_type": "LOGISTIC"
    },
    "devices": [
      {
        "device_details": {
          "id": 0,
          "model_id": "string",
          "cession_price": 999999999.99,
          "imei": "string",
          "pending_imei": true,
          "insured_amount": 0.01,
          "category": "string",
          "logistic_required": true,
          "catalogue_id": "string",
          "amount": 0.01
        },
        "fees": {
          "upfront_fee": 999999999.99,
          "installment_plan": {
            "commission": 999999999.99,
            "tae": 999999999.99,
            "tin": 999999999.99,
            "duration": 1,
            "monthly_fee": 999999999.99,
            "last_installment_fee": 999999999.99,
            "discount_final_payment_value": 999999999.99,
            "is_promotional_renew": true
          }
        },
        "financial_details": {
          "pre_booking": {
            "order_id": "string",
            "authorization_id": "string",
            "financial_entity": "string",
            "status": "Accepted",
            "granted_amount": 999999999,
            "credit_line_amount": 999999999,
            "total_client_financed_value": 999999999.99
          },
          "consents": {
            "commercial": true,
            "gdpr": true
          }
        },
        "campaign_id": 0,
        "terms": {
          "penalty_value": 999999999.99,
          "commitment_duration": 9999
        },
        "reservation_id": "string",
        "signature_process_id": 0,
        "signature_type": "PAPER",
        "old_subscription_terminal_id": 0
      }
    ]
  },
  "bundle": {
    "bundle_id": 0,
    "territory_owner": "string",
    "promotions": [
      {
        "id": 0,
        "value": "string"
      }
    ],
    "installation_info": {
      "contact": {
        "name": "string",
        "middlename": "string",
        "lastname": "string",
        "phone": "string",
        "email": "string",
        "document_type_id": 0,
        "document_value": "string"
      },
      "address": {
        "street_type_id": 0,
        "street_name": "string",
        "number": "string",
        "supplement": "string",
        "state_id": 0,
        "locality": "string",
        "postal_code": "string",
        "gescal": "stringstringstrin",
        "pair_vacancy": true,
        "address_id": "string"
      }
    },
    "delivery_info": {
      "contact": {
        "name": "string",
        "middlename": "string",
        "lastname": "string",
        "phone": "string",
        "email": "string",
        "document_type_id": 0,
        "document_value": "string"
      },
      "address": {
        "street_type_id": 0,
        "street_name": "string",
        "number": "string",
        "supplement": "string",
        "state_id": 0,
        "locality": "string",
        "postal_code": "string",
        "observation": "string"
      },
      "delivery_shop_id": "0025",
      "delivery_type": "LOGISTIC"
    },
    "landline": {
      "product_id": 0,
      "portability_info": {
        "scheduled_date": "2020-04-20",
        "iccid": "string",
        "operator_id": "string",
        "operation_type": 1,
        "initial_date_operation": "1999-01-31",
        "donor_line_type": "C",
        "donor_user": {
          "type": "existing",
          "document_type_id": 1,
          "document_value": "11111111A"
        },
        "internal_portability": true,
        "installation_required": true
      },
      "number": "string",
      "bonuses": [
        {
          "id": 0
        }
      ],
      "promotions": [
        {
          "id": 0,
          "value": "string"
        }
      ],
      "services": [
        {
          "id": 0
        }
      ],
      "wants_communications": true
    },
    "ftth": {
      "product_id": 0,
      "promotions": [
        {
          "id": 0,
          "value": "string"
        }
      ],
      "connection_type": "string",
      "installer": "string",
      "iua": "string",
      "terminals": [
        {
          "id": 0,
          "financed": true,
          "imei": "string",
          "serial_number": "string"
        }
      ],
      "wants_communications": true,
      "access_reuse": "Interno",
      "access_reuse_choice": true,
      "services": [
        {
          "id": 0
        }
      ]
    },
    "adsl": {
      "product_id": 0,
      "promotions": [
        {
          "id": 0,
          "value": "string"
        }
      ],
      "wants_communications": true,
      "install_tech_support": true,
      "tech_support_billiable": true
    },
    "mobile_lines": [
      {
        "existing_number": false,
        "type": "mobile",
        "product_id": 214748364,
        "portability_info": {
          "scheduled_date": "2020-04-20",
          "iccid": "string",
          "operator_id": "string",
          "operation_type": 1,
          "initial_date_operation": "1999-01-31",
          "donor_line_type": "C",
          "donor_user": {
            "type": "existing",
            "document_type_id": 1,
            "document_value": "11111111A"
          },
          "internal_portability": true,
          "installation_required": true
        },
        "msisdn": "string",
        "iccid": "string",
        "fabrication_type_sim_id": 214748364,
        "initial_balance": 0.1,
        "bonuses": [
          {
            "id": 0
          }
        ],
        "promotions": [
          {
            "id": 0,
            "value": "string"
          }
        ],
        "terminals": [
          {
            "id": 0,
            "financed": true,
            "imei": "string",
            "serial_number": "string"
          }
        ],
        "wants_communications": true,
        "expedition_info": {
          "language_id": 214748364,
          "nationality_id": 214748364,
          "name": "John",
          "middlename": "Nicholas",
          "lastname": "Doe",
          "document_type_id": 1,
          "document_value": "11111111A",
          "email": "john.doe@example.com",
          "birthdate": "1999-01-31",
          "contact_phone": "string",
          "gender": "M",
          "address": {
            "street_name": "string",
            "state_id": 0,
            "locality": "string",
            "postal_code": "string",
            "country": "string",
            "number": "string",
            "value": "Castellano"
          }
        },
        "delivery_info": {
          "contact": {
            "name": "string",
            "middlename": "string",
            "lastname": "string",
            "phone": "string",
            "email": "string",
            "document_type_id": 0,
            "document_value": "string"
          },
          "address": {
            "street_type_id": 0,
            "street_name": "string",
            "number": "string",
            "supplement": "string",
            "state_id": 0,
            "locality": "string",
            "postal_code": "string",
            "observation": "string"
          },
          "delivery_shop_id": "0025",
          "delivery_type": "LOGISTIC"
        },
        "devices": [
          {
            "device_details": {
              "id": 0,
              "model_id": "string",
              "cession_price": 999999999.99,
              "imei": "string",
              "pending_imei": true,
              "insured_amount": 0.01,
              "category": "string",
              "logistic_required": true,
              "catalogue_id": "string",
              "amount": 0.01
            },
            "fees": {
              "upfront_fee": 999999999.99,
              "installment_plan": {
                "commission": 999999999.99,
                "tae": 999999999.99,
                "tin": 999999999.99,
                "duration": 1,
                "monthly_fee": 999999999.99,
                "last_installment_fee": 999999999.99,
                "discount_final_payment_value": 999999999.99,
                "is_promotional_renew": true
              }
            },
            "financial_details": {
              "pre_booking": {
                "order_id": "string",
                "authorization_id": "string",
                "financial_entity": "string",
                "status": "Accepted",
                "granted_amount": 999999999,
                "credit_line_amount": 999999999,
                "total_client_financed_value": 999999999.99
              },
              "consents": {
                "commercial": true,
                "gdpr": true
              }
            },
            "campaign_id": 0,
            "terms": {
              "penalty_value": 999999999.99,
              "commitment_duration": 9999
            },
            "reservation_id": "string",
            "signature_process_id": 0,
            "signature_type": "PAPER",
            "old_subscription_terminal_id": 0
          }
        ]
      }
    ],
    "tv": {
      "product_id": 0,
      "number_associated": "string",
      "registration_email": "string",
      "contact_phone": "string",
      "install_tech_support": true,
      "promotions": [
        {
          "id": 0,
          "value": "string"
        }
      ],
      "terminals": [
        {
          "id": 0,
          "financed": true,
          "imei": "string",
          "serial_number": "string"
        }
      ]
    },
    "ott": [
      {
        "product_id": 0,
        "email": "string",
        "promotions": [
          {
            "id": 0,
            "value": "string"
          }
        ]
      }
    ]
  }
}
Name Type Required Description
mobile_line MobileLine false Object to signups products of mobile
bundle SignupsBundle false Object to signups for bundle products

MobileLine

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142

{
  "existing_number": false,
  "type": "mobile",
  "product_id": 214748364,
  "portability_info": {
    "scheduled_date": "2020-04-20",
    "iccid": "string",
    "operator_id": "string",
    "operation_type": 1,
    "initial_date_operation": "1999-01-31",
    "donor_line_type": "C",
    "donor_user": {
      "type": "existing",
      "document_type_id": 1,
      "document_value": "11111111A"
    },
    "internal_portability": true,
    "installation_required": true
  },
  "msisdn": "string",
  "iccid": "string",
  "fabrication_type_sim_id": 214748364,
  "initial_balance": 0.1,
  "bonuses": [
    {
      "id": 0
    }
  ],
  "promotions": [
    {
      "id": 0,
      "value": "string"
    }
  ],
  "terminals": [
    {
      "id": 0,
      "financed": true,
      "imei": "string",
      "serial_number": "string"
    }
  ],
  "wants_communications": true,
  "expedition_info": {
    "language_id": 214748364,
    "nationality_id": 214748364,
    "name": "John",
    "middlename": "Nicholas",
    "lastname": "Doe",
    "document_type_id": 1,
    "document_value": "11111111A",
    "email": "john.doe@example.com",
    "birthdate": "1999-01-31",
    "contact_phone": "string",
    "gender": "M",
    "address": {
      "street_name": "string",
      "state_id": 0,
      "locality": "string",
      "postal_code": "string",
      "country": "string",
      "number": "string",
      "value": "Castellano"
    }
  },
  "delivery_info": {
    "contact": {
      "name": "string",
      "middlename": "string",
      "lastname": "string",
      "phone": "string",
      "email": "string",
      "document_type_id": 0,
      "document_value": "string"
    },
    "address": {
      "street_type_id": 0,
      "street_name": "string",
      "number": "string",
      "supplement": "string",
      "state_id": 0,
      "locality": "string",
      "postal_code": "string",
      "observation": "string"
    },
    "delivery_shop_id": "0025",
    "delivery_type": "LOGISTIC"
  },
  "devices": [
    {
      "device_details": {
        "id": 0,
        "model_id": "string",
        "cession_price": 999999999.99,
        "imei": "string",
        "pending_imei": true,
        "insured_amount": 0.01,
        "category": "string",
        "logistic_required": true,
        "catalogue_id": "string",
        "amount": 0.01
      },
      "fees": {
        "upfront_fee": 999999999.99,
        "installment_plan": {
          "commission": 999999999.99,
          "tae": 999999999.99,
          "tin": 999999999.99,
          "duration": 1,
          "monthly_fee": 999999999.99,
          "last_installment_fee": 999999999.99,
          "discount_final_payment_value": 999999999.99,
          "is_promotional_renew": true
        }
      },
      "financial_details": {
        "pre_booking": {
          "order_id": "string",
          "authorization_id": "string",
          "financial_entity": "string",
          "status": "Accepted",
          "granted_amount": 999999999,
          "credit_line_amount": 999999999,
          "total_client_financed_value": 999999999.99
        },
        "consents": {
          "commercial": true,
          "gdpr": true
        }
      },
      "campaign_id": 0,
      "terms": {
        "penalty_value": 999999999.99,
        "commitment_duration": 9999
      },
      "reservation_id": "string",
      "signature_process_id": 0,
      "signature_type": "PAPER",
      "old_subscription_terminal_id": 0
    }
  ]
}
Name Type Required Description
existing_number boolean false True if the number already has an active subscription
type string true mobile type is required
product_id number(int32) true none
portability_info PortabilityInfo false none
msisdn string true Mobile Station International Subscriber Directory Number. In case of portability, it will be the number for portability
iccid string false Integrated Circuit Card ID of the donor operator to signups.
fabrication_type_sim_id integer(int32) false none
initial_balance number(double) false initial solde for prepaid
bonuses [Bonuses] false none
promotions [SignupsPromotions] false [If this object is informed, it´s a promotion. If not, it´s a campaign]
terminals [Terminal] false none
wants_communications boolean true none
expedition_info ClientExpedition false Information needed by logistics to send SIM cards
delivery_info DeliveryInfo false Delivery info for the device
devices [Device] false none
Property Values
type one of [mobile, main, extra, additional]

Bonuses

1
2
3

{
  "id": 0
}
Name Type Required Description
id number(int32) false none

SignupsPromotions

1
2
3
4

{
  "id": 0,
  "value": "string"
}
Name Type Required Description
id number(int32) false none
value string false none

Terminal

1
2
3
4
5
6

{
  "id": 0,
  "financed": true,
  "imei": "string",
  "serial_number": "string"
}
Name Type Required Description
id number(int32) true none
financed boolean false none
imei string false none
serial_number string false none

PortabilityInfo

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15

{
  "scheduled_date": "2020-04-20",
  "iccid": "string",
  "operator_id": "string",
  "operation_type": 1,
  "initial_date_operation": "1999-01-31",
  "donor_line_type": "C",
  "donor_user": {
    "type": "existing",
    "document_type_id": 1,
    "document_value": "11111111A"
  },
  "internal_portability": true,
  "installation_required": true
}
Name Type Required Description
scheduled_date string(date) false scheduled date. Format yyyy-MM-dd
iccid string false Integrated Circuit Card ID of the donor operator, required in case it is not postpaid in that operator
operator_id string true id donor operator.
operation_type integer(int32) true 1 -> instant, 2 -> scheduled
initial_date_operation string(date) false date schedule for start portability.
donor_line_type string true Line type in actual operator (postpaid or prepaid)
donor_user Client false User with “client” type is used if donor_user is not present
internal_portability boolean¦null false none
installation_required boolean¦null false none
Property Values
operation_type one of [1, 2]
donor_line_type one of [C, P]

ClientPersonalBase

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13

{
  "language_id": 214748364,
  "nationality_id": 214748364,
  "name": "John",
  "middlename": "Nicholas",
  "lastname": "Doe",
  "document_type_id": 1,
  "document_value": "11111111A",
  "email": "john.doe@example.com",
  "birthdate": "1999-01-31",
  "contact_phone": "string",
  "gender": "M"
}
Name Type Required Description
anonymous any false none
Name Type Required Description
» anonymous ClientPersonalBaseId false required if sector is not business
Name Type Required Description
» anonymous ClientPersonalBaseIso false required if sector is not business
Name Type Required Description
anonymous object false Value
» name string true none
» middlename string true none
» lastname string false none
» document_type_id integer(int32) true none
» document_value string true none
» email string true none
» birthdate string(date) true none
» contact_phone string true none
» gender string true Male or female
Property Values
document_type_id one of [1, 3, 4, 5]
gender one of [M, F]

ClientPersonalBaseId

1
2
3
4

{
  "language_id": 214748364,
  "nationality_id": 214748364
}
Name Type Required Description
language_id number(int32) true none
nationality_id number(int32) true none

ClientPersonalBaseIso

1
2
3
4

{
  "nationality_iso": "ES",
  "language_iso": "es"
}
Name Type Required Description
nationality_iso string true none
language_iso string true none

ClientBusinessBase

1
2
3
4
5

{
  "company_name": "Pole Group Recordings",
  "document_type_id": 1,
  "document_value": "11111111A"
}
Name Type Required Description
company_name string true none
document_type_id integer(int32) true none
document_value string false none
Property Values
document_type_id one of [1, 3, 4, 5]

SignupsBundle

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309

{
  "bundle_id": 0,
  "territory_owner": "string",
  "promotions": [
    {
      "id": 0,
      "value": "string"
    }
  ],
  "installation_info": {
    "contact": {
      "name": "string",
      "middlename": "string",
      "lastname": "string",
      "phone": "string",
      "email": "string",
      "document_type_id": 0,
      "document_value": "string"
    },
    "address": {
      "street_type_id": 0,
      "street_name": "string",
      "number": "string",
      "supplement": "string",
      "state_id": 0,
      "locality": "string",
      "postal_code": "string",
      "gescal": "stringstringstrin",
      "pair_vacancy": true,
      "address_id": "string"
    }
  },
  "delivery_info": {
    "contact": {
      "name": "string",
      "middlename": "string",
      "lastname": "string",
      "phone": "string",
      "email": "string",
      "document_type_id": 0,
      "document_value": "string"
    },
    "address": {
      "street_type_id": 0,
      "street_name": "string",
      "number": "string",
      "supplement": "string",
      "state_id": 0,
      "locality": "string",
      "postal_code": "string",
      "observation": "string"
    },
    "delivery_shop_id": "0025",
    "delivery_type": "LOGISTIC"
  },
  "landline": {
    "product_id": 0,
    "portability_info": {
      "scheduled_date": "2020-04-20",
      "iccid": "string",
      "operator_id": "string",
      "operation_type": 1,
      "initial_date_operation": "1999-01-31",
      "donor_line_type": "C",
      "donor_user": {
        "type": "existing",
        "document_type_id": 1,
        "document_value": "11111111A"
      },
      "internal_portability": true,
      "installation_required": true
    },
    "number": "string",
    "bonuses": [
      {
        "id": 0
      }
    ],
    "promotions": [
      {
        "id": 0,
        "value": "string"
      }
    ],
    "services": [
      {
        "id": 0
      }
    ],
    "wants_communications": true
  },
  "ftth": {
    "product_id": 0,
    "promotions": [
      {
        "id": 0,
        "value": "string"
      }
    ],
    "connection_type": "string",
    "installer": "string",
    "iua": "string",
    "terminals": [
      {
        "id": 0,
        "financed": true,
        "imei": "string",
        "serial_number": "string"
      }
    ],
    "wants_communications": true,
    "access_reuse": "Interno",
    "access_reuse_choice": true,
    "services": [
      {
        "id": 0
      }
    ]
  },
  "adsl": {
    "product_id": 0,
    "promotions": [
      {
        "id": 0,
        "value": "string"
      }
    ],
    "wants_communications": true,
    "install_tech_support": true,
    "tech_support_billiable": true
  },
  "mobile_lines": [
    {
      "existing_number": false,
      "type": "mobile",
      "product_id": 214748364,
      "portability_info": {
        "scheduled_date": "2020-04-20",
        "iccid": "string",
        "operator_id": "string",
        "operation_type": 1,
        "initial_date_operation": "1999-01-31",
        "donor_line_type": "C",
        "donor_user": {
          "type": "existing",
          "document_type_id": 1,
          "document_value": "11111111A"
        },
        "internal_portability": true,
        "installation_required": true
      },
      "msisdn": "string",
      "iccid": "string",
      "fabrication_type_sim_id": 214748364,
      "initial_balance": 0.1,
      "bonuses": [
        {
          "id": 0
        }
      ],
      "promotions": [
        {
          "id": 0,
          "value": "string"
        }
      ],
      "terminals": [
        {
          "id": 0,
          "financed": true,
          "imei": "string",
          "serial_number": "string"
        }
      ],
      "wants_communications": true,
      "expedition_info": {
        "language_id": 214748364,
        "nationality_id": 214748364,
        "name": "John",
        "middlename": "Nicholas",
        "lastname": "Doe",
        "document_type_id": 1,
        "document_value": "11111111A",
        "email": "john.doe@example.com",
        "birthdate": "1999-01-31",
        "contact_phone": "string",
        "gender": "M",
        "address": {
          "street_name": "string",
          "state_id": 0,
          "locality": "string",
          "postal_code": "string",
          "country": "string",
          "number": "string",
          "value": "Castellano"
        }
      },
      "delivery_info": {
        "contact": {
          "name": "string",
          "middlename": "string",
          "lastname": "string",
          "phone": "string",
          "email": "string",
          "document_type_id": 0,
          "document_value": "string"
        },
        "address": {
          "street_type_id": 0,
          "street_name": "string",
          "number": "string",
          "supplement": "string",
          "state_id": 0,
          "locality": "string",
          "postal_code": "string",
          "observation": "string"
        },
        "delivery_shop_id": "0025",
        "delivery_type": "LOGISTIC"
      },
      "devices": [
        {
          "device_details": {
            "id": 0,
            "model_id": "string",
            "cession_price": 999999999.99,
            "imei": "string",
            "pending_imei": true,
            "insured_amount": 0.01,
            "category": "string",
            "logistic_required": true,
            "catalogue_id": "string",
            "amount": 0.01
          },
          "fees": {
            "upfront_fee": 999999999.99,
            "installment_plan": {
              "commission": 999999999.99,
              "tae": 999999999.99,
              "tin": 999999999.99,
              "duration": 1,
              "monthly_fee": 999999999.99,
              "last_installment_fee": 999999999.99,
              "discount_final_payment_value": 999999999.99,
              "is_promotional_renew": true
            }
          },
          "financial_details": {
            "pre_booking": {
              "order_id": "string",
              "authorization_id": "string",
              "financial_entity": "string",
              "status": "Accepted",
              "granted_amount": 999999999,
              "credit_line_amount": 999999999,
              "total_client_financed_value": 999999999.99
            },
            "consents": {
              "commercial": true,
              "gdpr": true
            }
          },
          "campaign_id": 0,
          "terms": {
            "penalty_value": 999999999.99,
            "commitment_duration": 9999
          },
          "reservation_id": "string",
          "signature_process_id": 0,
          "signature_type": "PAPER",
          "old_subscription_terminal_id": 0
        }
      ]
    }
  ],
  "tv": {
    "product_id": 0,
    "number_associated": "string",
    "registration_email": "string",
    "contact_phone": "string",
    "install_tech_support": true,
    "promotions": [
      {
        "id": 0,
        "value": "string"
      }
    ],
    "terminals": [
      {
        "id": 0,
        "financed": true,
        "imei": "string",
        "serial_number": "string"
      }
    ]
  },
  "ott": [
    {
      "product_id": 0,
      "email": "string",
      "promotions": [
        {
          "id": 0,
          "value": "string"
        }
      ]
    }
  ]
}
Name Type Required Description
bundle_id number(int32) true identification bundle
territory_owner string false Territory owner. Only required in broadband signups
promotions [SignupsPromotions] false [If this object is informed, it´s a promotion. If not, it´s a campaign]
installation_info InstallationInfo false Installation info. Only required for broadband signups
delivery_info DeliveryInfo true none
landline Landline false none
ftth Ftth false none
adsl Adsl false none
mobile_lines [MobileLine] false [Object to signups products of mobile]
tv Tv false none
ott [Ott] false none

InstallationInfo

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

{
  "contact": {
    "name": "string",
    "middlename": "string",
    "lastname": "string",
    "phone": "string",
    "email": "string",
    "document_type_id": 0,
    "document_value": "string"
  },
  "address": {
    "street_type_id": 0,
    "street_name": "string",
    "number": "string",
    "supplement": "string",
    "state_id": 0,
    "locality": "string",
    "postal_code": "string",
    "gescal": "stringstringstrin",
    "pair_vacancy": true,
    "address_id": "string"
  }
}
Name Type Required Description
contact Contact true none
address InstallationAddress true none

DeliveryInfo

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

{
  "contact": {
    "name": "string",
    "middlename": "string",
    "lastname": "string",
    "phone": "string",
    "email": "string",
    "document_type_id": 0,
    "document_value": "string"
  },
  "address": {
    "street_type_id": 0,
    "street_name": "string",
    "number": "string",
    "supplement": "string",
    "state_id": 0,
    "locality": "string",
    "postal_code": "string",
    "observation": "string"
  },
  "delivery_shop_id": "0025",
  "delivery_type": "LOGISTIC"
}
Name Type Required Description
contact Contact true none
address DeliveryAddress true none
delivery_shop_id string¦null false Shop identifier where the pickup (if that’s the case) will occur
delivery_type string¦null false how a device will be delivered to a customer
Property Values
delivery_type one of [LOGISTIC, IN_PERSON, STORE_DELIVERY]

ExpeditionInfo

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

{
  "language_id": 214748364,
  "nationality_id": 214748364,
  "name": "John",
  "middlename": "Nicholas",
  "lastname": "Doe",
  "document_type_id": 1,
  "document_value": "11111111A",
  "email": "john.doe@example.com",
  "birthdate": "1999-01-31",
  "contact_phone": "string",
  "gender": "M",
  "address": {
    "street_name": "string",
    "state_id": 0,
    "locality": "string",
    "postal_code": "string",
    "country": "string",
    "number": "string",
    "value": "Castellano"
  },
  "delivery_shop_id": "0025",
  "delivery_type": "LOGISTIC"
}
Name Type Required Description
anonymous ClientExpedition false Information needed by logistics to send SIM cards
Name Type Required Description
anonymous object false none
» delivery_shop_id string¦null false Shop identifier where the pickup (if that’s the case) will occur
» delivery_type string¦null false how a device will be delivered to a customer
Property Values
delivery_type one of [LOGISTIC, IN_PERSON, STORE_DELIVERY]

Contact

1
2
3
4
5
6
7
8
9

{
  "name": "string",
  "middlename": "string",
  "lastname": "string",
  "phone": "string",
  "email": "string",
  "document_type_id": 0,
  "document_value": "string"
}
Name Type Required Description
name string true none
middlename string¦null false none
lastname string¦null false none
phone string true none
email string true none
document_type_id number(int32) true none
document_value string true none

NormalizedAddress

1
2
3
4
5
6
7
8
9

{
  "street_type_id": 0,
  "street_name": "string",
  "number": "string",
  "supplement": "string",
  "state_id": 0,
  "locality": "string",
  "postal_code": "string"
}
Name Type Required Description
street_type_id number(int32) true none
street_name string true none
number string true none
supplement string false none
state_id number(int32) true none
locality string true none
postal_code string true none

InstallationAddress

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

{
  "street_type_id": 0,
  "street_name": "string",
  "number": "string",
  "supplement": "string",
  "state_id": 0,
  "locality": "string",
  "postal_code": "string",
  "gescal": "stringstringstrin",
  "pair_vacancy": true,
  "address_id": "string"
}
Name Type Required Description
anonymous NormalizedAddress false none
Name Type Required Description
anonymous object false none
» gescal string true none
» pair_vacancy boolean true none
» address_id string true none

DeliveryAddress

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

{
  "street_type_id": 0,
  "street_name": "string",
  "number": "string",
  "supplement": "string",
  "state_id": 0,
  "locality": "string",
  "postal_code": "string",
  "observation": "string"
}
Name Type Required Description
anonymous NormalizedAddress false none
Name Type Required Description
anonymous object false none
» observation string false none

Ftth

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

{
  "product_id": 0,
  "promotions": [
    {
      "id": 0,
      "value": "string"
    }
  ],
  "connection_type": "string",
  "installer": "string",
  "iua": "string",
  "terminals": [
    {
      "id": 0,
      "financed": true,
      "imei": "string",
      "serial_number": "string"
    }
  ],
  "wants_communications": true,
  "access_reuse": "Interno",
  "access_reuse_choice": true,
  "services": [
    {
      "id": 0
    }
  ]
}
Name Type Required Description
product_id number(int32) true none
promotions [SignupsPromotions] false [If this object is informed, it´s a promotion. If not, it´s a campaign]
connection_type string false none
installer string false none
iua string false none
terminals [Terminal] false none
wants_communications boolean true none
access_reuse string¦null false Current possible values are ‘Interno’ and ‘Orange’.
access_reuse_choice boolean¦null false Client consents for ftth origin access. For portabilities is not mandatory. If it is not informed, it will be considered as null. Otherwise is mandatory to inform it.
services [SignupsServices] false none

Adsl

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

{
  "product_id": 0,
  "promotions": [
    {
      "id": 0,
      "value": "string"
    }
  ],
  "wants_communications": true,
  "install_tech_support": true,
  "tech_support_billiable": true
}
Name Type Required Description
product_id number(int32) true none
promotions [SignupsPromotions] false [If this object is informed, it´s a promotion. If not, it´s a campaign]
wants_communications boolean true none
install_tech_support boolean true none
tech_support_billiable boolean true none

Landline

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36

{
  "product_id": 0,
  "portability_info": {
    "scheduled_date": "2020-04-20",
    "iccid": "string",
    "operator_id": "string",
    "operation_type": 1,
    "initial_date_operation": "1999-01-31",
    "donor_line_type": "C",
    "donor_user": {
      "type": "existing",
      "document_type_id": 1,
      "document_value": "11111111A"
    },
    "internal_portability": true,
    "installation_required": true
  },
  "number": "string",
  "bonuses": [
    {
      "id": 0
    }
  ],
  "promotions": [
    {
      "id": 0,
      "value": "string"
    }
  ],
  "services": [
    {
      "id": 0
    }
  ],
  "wants_communications": true
}
Name Type Required Description
product_id number(int32) true none
portability_info PortabilityInfo false none
number string true none
bonuses [Bonuses] false none
promotions [SignupsPromotions] false [If this object is informed, it´s a promotion. If not, it´s a campaign]
services [SignupsServices] false none
wants_communications boolean true none

SignupsServices

1
2
3

{
  "id": 0
}
Name Type Required Description
id number(int32) true none

Tv

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21

{
  "product_id": 0,
  "number_associated": "string",
  "registration_email": "string",
  "contact_phone": "string",
  "install_tech_support": true,
  "promotions": [
    {
      "id": 0,
      "value": "string"
    }
  ],
  "terminals": [
    {
      "id": 0,
      "financed": true,
      "imei": "string",
      "serial_number": "string"
    }
  ]
}
Name Type Required Description
product_id number(int32) true none
number_associated string true none
registration_email string true none
contact_phone string true none
install_tech_support boolean true none
promotions [SignupsPromotions] false [If this object is informed, it´s a promotion. If not, it´s a campaign]
terminals [Terminal] false none

Ott

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

{
  "product_id": 0,
  "email": "string",
  "promotions": [
    {
      "id": 0,
      "value": "string"
    }
  ]
}
Name Type Required Description
product_id number(int32) true none
email string false none
promotions [SignupsPromotions] false [If this object is informed, it´s a promotion. If not, it´s a campaign]

SignupsPayment

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27

{
  "billing_type_id": 1,
  "scoring": {
    "scoring_value": 0,
    "id_value": 0,
    "forced_value": 0,
    "up_front": 0.1,
    "credit_limit": 0.1,
    "credit_limit_available": 0.1,
    "app_id": 0
  },
  "info": {
    "bank_account": "string",
    "swift_bic": "string"
  },
  "tpv_response": {
    "amount": "string",
    "card_number": "000000******0000",
    "expiry_date": "0121",
    "transaction_id": "1563B44RPR2",
    "reference_id": "string",
    "platform": "PAYMENTS",
    "payment_link": "string",
    "tax": 21
  },
  "account_number": "string"
}
Name Type Required Description
billing_type_id integer(int32) false none
scoring SignupsScoring false none
info SignupsPaymentInfo false none
tpv_response SignupsTpvResponse false none
account_number string false Existing account number. Do not fill when doing signups. Fill this field only when doing addSubscriptionToAccount endpoint.
Property Values
billing_type_id one of [1, 2, 3]

SignupsPaymentInfo

1
2
3
4

{
  "bank_account": "string",
  "swift_bic": "string"
}
Name Type Required Description
bank_account string false none
swift_bic string false none

SignupsTpvResponse

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

{
  "amount": "string",
  "card_number": "000000******0000",
  "expiry_date": "0121",
  "transaction_id": "1563B44RPR2",
  "reference_id": "string",
  "platform": "PAYMENTS",
  "payment_link": "string",
  "tax": 21
}
Name Type Required Description
amount string true none
card_number string true none
expiry_date string true none
transaction_id string¦null false none
reference_id string¦null false none
platform string false none
payment_link string¦null false none
tax number(double)¦null false If not sent, 21.0 will apply
Property Values
platform one of [PAYMENTS, ADYEN, REDSYS]

SignupsScoring

1
2
3
4
5
6
7
8
9

{
  "scoring_value": 0,
  "id_value": 0,
  "forced_value": 0,
  "up_front": 0.1,
  "credit_limit": 0.1,
  "credit_limit_available": 0.1,
  "app_id": 0
}
Name Type Required Description
scoring_value number(int64) true none
id_value number(int64) true none
forced_value number(int32) true none
up_front number(double) true none
credit_limit number(double)¦null false none
credit_limit_available number(double)¦null false This value should be calculated by you. The service does not calculate the value.
app_id number(int64)¦null false none

SignupClients

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

{
  "sector_id": 1,
  "attributes": [
    {
      "type": "existing",
      "document_type_id": 1,
      "document_value": "11111111A",
      "document_expiration_date": "1999-01-31",
      "employment": {
        "activity_country_code": "st",
        "company": "string",
        "income": 9999999999999.99,
        "income_source": {
          "id": 999999999,
          "observations": "string"
        },
        "profession": 999999999,
        "professional_area": 999999999,
        "professional_use": true
      }
    }
  ]
}
Name Type Required Description
sector_id integer(int32) true none
attributes [SignupClient] true none
Property Values
sector_id one of [1, 2, 3, 4]

Client

1
2
3
4
5

{
  "type": "existing",
  "document_type_id": 1,
  "document_value": "11111111A"
}
Name Type Required Description
anonymous ExistingClient false none
Name Type Required Description
anonymous ClientPersonal false none
Name Type Required Description
anonymous ClientBusiness false none

SignupClient

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18

{
  "type": "existing",
  "document_type_id": 1,
  "document_value": "11111111A",
  "document_expiration_date": "1999-01-31",
  "employment": {
    "activity_country_code": "st",
    "company": "string",
    "income": 9999999999999.99,
    "income_source": {
      "id": 999999999,
      "observations": "string"
    },
    "profession": 999999999,
    "professional_area": 999999999,
    "professional_use": true
  }
}
Name Type Required Description
anonymous SignupExistingClient false none
Name Type Required Description
anonymous SignupClientPersonal false none
Name Type Required Description
anonymous SignupClientBusiness false none

ClientBusiness

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27

{
  "company_name": "Pole Group Recordings",
  "document_type_id": 1,
  "document_value": "11111111A",
  "type": "client",
  "nationality_id": 214748364,
  "language_id": 214748364,
  "email": "john.doe@example.com",
  "contact_phone": "string",
  "address": {
    "street_name": "string",
    "state_id": 0,
    "locality": "string",
    "postal_code": "string",
    "country": "string",
    "number": "string",
    "value": "Castellano"
  },
  "responsable": {
    "name": "John",
    "middlename": "Nicholas",
    "lastname": "Doe",
    "document_type_id": 1,
    "document_value": "11111111A",
    "nationality_id": 214748364
  }
}
Name Type Required Description
anonymous ClientBusinessBase false required if sector is business
Name Type Required Description
anonymous object false required if sector is business
» type string true client type is required
» nationality_id number(int32) true none
» language_id number(int32) true none
» email string false none
» contact_phone string false none
» address ClientAddress true none
» responsable ClientBusinessResponsable false Person assigned as responsable of the company
Property Values
type one of [client, account, send]

SignupClientBusiness

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40

{
  "company_name": "Pole Group Recordings",
  "document_type_id": 1,
  "document_value": "11111111A",
  "type": "client",
  "nationality_id": 214748364,
  "language_id": 214748364,
  "email": "john.doe@example.com",
  "contact_phone": "string",
  "address": {
    "street_name": "string",
    "state_id": 0,
    "locality": "string",
    "postal_code": "string",
    "country": "string",
    "number": "string",
    "value": "Castellano"
  },
  "responsable": {
    "name": "John",
    "middlename": "Nicholas",
    "lastname": "Doe",
    "document_type_id": 1,
    "document_value": "11111111A",
    "nationality_id": 214748364,
    "document_expiration_date": "1999-01-31",
    "employment": {
      "activity_country_code": "st",
      "company": "string",
      "income": 9999999999999.99,
      "income_source": {
        "id": 999999999,
        "observations": "string"
      },
      "profession": 999999999,
      "professional_area": 999999999,
      "professional_use": true
    }
  }
}
Name Type Required Description
anonymous ClientBusiness false none
Name Type Required Description
anonymous object false none
» responsable SignupClientBusinessResponsable false none

SignupClientBusinessResponsable

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21

{
  "name": "John",
  "middlename": "Nicholas",
  "lastname": "Doe",
  "document_type_id": 1,
  "document_value": "11111111A",
  "nationality_id": 214748364,
  "document_expiration_date": "1999-01-31",
  "employment": {
    "activity_country_code": "st",
    "company": "string",
    "income": 9999999999999.99,
    "income_source": {
      "id": 999999999,
      "observations": "string"
    },
    "profession": 999999999,
    "professional_area": 999999999,
    "professional_use": true
  }
}
Name Type Required Description
anonymous ClientBusinessResponsable false Person assigned as responsable of the company
Name Type Required Description
anonymous object false none
» document_expiration_date string(date) false none
» employment Employment false none

ClientPersonal

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

{
  "language_id": 214748364,
  "nationality_id": 214748364,
  "name": "John",
  "middlename": "Nicholas",
  "lastname": "Doe",
  "document_type_id": 1,
  "document_value": "11111111A",
  "email": "john.doe@example.com",
  "birthdate": "1999-01-31",
  "contact_phone": "string",
  "gender": "M",
  "type": "client",
  "address": {
    "street_name": "string",
    "state_id": 0,
    "locality": "string",
    "postal_code": "string",
    "country": "string",
    "number": "string",
    "value": "Castellano"
  }
}
Name Type Required Description
anonymous ClientPersonalBase false none
Name Type Required Description
anonymous object false required if sector is not business
» type string true account -> Payment and contract holder. if it is not indicated, by default it takes client data
send -> Shipping holder. if it is not indicated, by default it takes client data
» address ClientAddress true none
Property Values
type one of [client, account, send]

SignupClientPersonal

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36

{
  "language_id": 214748364,
  "nationality_id": 214748364,
  "name": "John",
  "middlename": "Nicholas",
  "lastname": "Doe",
  "document_type_id": 1,
  "document_value": "11111111A",
  "email": "john.doe@example.com",
  "birthdate": "1999-01-31",
  "contact_phone": "string",
  "gender": "M",
  "type": "client",
  "address": {
    "street_name": "string",
    "state_id": 0,
    "locality": "string",
    "postal_code": "string",
    "country": "string",
    "number": "string",
    "value": "Castellano"
  },
  "document_expiration_date": "1999-01-31",
  "employment": {
    "activity_country_code": "st",
    "company": "string",
    "income": 9999999999999.99,
    "income_source": {
      "id": 999999999,
      "observations": "string"
    },
    "profession": 999999999,
    "professional_area": 999999999,
    "professional_use": true
  }
}
Name Type Required Description
anonymous ClientPersonal false none
Name Type Required Description
anonymous object false none
» document_expiration_date string(date) false none
» employment Employment false none

ClientAddress

1
2
3
4
5
6
7
8
9

{
  "street_name": "string",
  "state_id": 0,
  "locality": "string",
  "postal_code": "string",
  "country": "string",
  "number": "string",
  "value": "Castellano"
}
Name Type Required Description
anonymous any false none
Name Type Required Description
» anonymous ClientAddressId false client address
Name Type Required Description
» anonymous ClientAddressIso false client address
Name Type Required Description
anonymous object false Value
» value string false language value
Property Values
value one of [Castellano, Catalan, Galego, Vasco, Ingles, Portugues]

ClientAddressId

1
2
3
4
5
6
7
8

{
  "street_name": "string",
  "state_id": 0,
  "locality": "string",
  "postal_code": "string",
  "country": "string",
  "number": "string"
}
Name Type Required Description
street_name string false none
state_id number(int32) true none
locality string false none
postal_code string false none
country string false none
number string¦null false none

ClientAddressIso

1
2
3
4
5
6
7
8

{
  "street_name": "string",
  "state_iso": "string",
  "locality": "string",
  "postal_code": "string",
  "country": "string",
  "number": "string"
}
Name Type Required Description
street_name string false none
state_iso string true none
locality string false none
postal_code string false none
country string false none
number string¦null false none

ClientExpedition

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22

{
  "language_id": 214748364,
  "nationality_id": 214748364,
  "name": "John",
  "middlename": "Nicholas",
  "lastname": "Doe",
  "document_type_id": 1,
  "document_value": "11111111A",
  "email": "john.doe@example.com",
  "birthdate": "1999-01-31",
  "contact_phone": "string",
  "gender": "M",
  "address": {
    "street_name": "string",
    "state_id": 0,
    "locality": "string",
    "postal_code": "string",
    "country": "string",
    "number": "string",
    "value": "Castellano"
  }
}
Name Type Required Description
anonymous any false none
Name Type Required Description
» anonymous ClientPersonalBase false none
Name Type Required Description
» anonymous object false none
Name Type Required Description
»» anonymous ClientBusinessBase false required if sector is business
Name Type Required Description
»» anonymous object false none
»»» responsable ClientBusinessResponsable false Person assigned as responsable of the company
Name Type Required Description
anonymous object false Location
» address ClientAddress false none

ClientBusinessResponsable

1
2
3
4
5
6
7
8

{
  "name": "John",
  "middlename": "Nicholas",
  "lastname": "Doe",
  "document_type_id": 1,
  "document_value": "11111111A",
  "nationality_id": 214748364
}
Name Type Required Description
name string true none
middlename string true none
lastname string true none
document_type_id integer(int32) true none
document_value string true none
nationality_id number(int32) true none
Property Values
document_type_id one of [1, 3, 4, 5]

SalesInfo

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

{
  "channel": "dealer",
  "dealer_id": "string",
  "shop_id": "string",
  "agent_id": "string",
  "logistic": true,
  "signature_process_id": 0,
  "signature_type": "PAPER",
  "channel_id": 0
}
Name Type Required Description
channel string false none
dealer_id string true none
shop_id string false none
agent_id string false none
logistic boolean true none
signature_process_id number(int64) false none
signature_type string¦null false none
channel_id number(int64)¦null false none
Property Values
channel one of [dealer, call_center]
signature_type one of [PAPER, OTP, BIOMETRIC, UNKNOWN]

SignupsResponse

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22

{
  "sell_id": 0,
  "customer_id": 0,
  "work_order_id": "FOO_XYZ",
  "account_info": {
    "account_id": 0,
    "account_number": "string",
    "bundle_id": 0,
    "subscriptions": [
      {
        "type": 0,
        "subscription_id": 0,
        "user_info_id": 0,
        "msisdn": "string",
        "fixed_number": "string",
        "associated_number": "string",
        "subscription_terminal_id": 0
      }
    ]
  },
  "risk_decision": "string"
}
Name Type Required Description
sell_id number(int64) false none
customer_id number(int64) false none
work_order_id string false identification work order
account_info AccountInfoResponse false none
risk_decision string false none

AddLineToBundleResponse

1
2
3

{
  "risk_decision": "string"
}
Name Type Required Description
risk_decision string false none

BundleMigrationResponse

1
2
3

{
  "risk_decision": "string"
}
Name Type Required Description
risk_decision string false none

AccountInfoResponse

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16

{
  "account_id": 0,
  "account_number": "string",
  "bundle_id": 0,
  "subscriptions": [
    {
      "type": 0,
      "subscription_id": 0,
      "user_info_id": 0,
      "msisdn": "string",
      "fixed_number": "string",
      "associated_number": "string",
      "subscription_terminal_id": 0
    }
  ]
}
Name Type Required Description
account_id number(int64) false none
account_number string false none
bundle_id integer(int64) false none
subscriptions [SubscriptionResponse] false none

SubscriptionResponse

1
2
3
4
5
6
7
8
9

{
  "type": 0,
  "subscription_id": 0,
  "user_info_id": 0,
  "msisdn": "string",
  "fixed_number": "string",
  "associated_number": "string",
  "subscription_terminal_id": 0
}
Name Type Required Description
type number(int32) true tipos de suscripción:
  • 2 postpago mobile
  • 4 digital
  • 5 adsl
  • 6 ftth
  • 7 TV
subscription_id number(int64) true none
user_info_id number(int64) true none
msisdn string false none
fixed_number string false none
associated_number string false none
subscription_terminal_id number(int64) false none

SignupsMasterData

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102

{
  "states": [
    {
      "id": 0,
      "value": "Lugo",
      "iso": "ES-LU"
    }
  ],
  "document_types": [
    {
      "id": 0,
      "value": "nif",
      "description": ""
    }
  ],
  "nationalities": [
    {
      "id": 0,
      "value": "España",
      "iso": "ES"
    }
  ],
  "languages": [
    {
      "id": 0,
      "value": "Castellano",
      "iso": "es"
    }
  ],
  "balances": [
    0.1
  ],
  "mobile_operators": [
    {
      "code": "string",
      "name": "string"
    }
  ],
  "cli_operators": [
    {
      "code": "string",
      "name": "string"
    }
  ],
  "sectors": [
    {
      "id": 0,
      "value": "RESIDENCIAL"
    }
  ],
  "billing_types": [
    {
      "id": 1,
      "value": "POSPAGO"
    }
  ],
  "fabrication_types": [
    {
      "id": 0,
      "value": "string"
    }
  ],
  "deactivation_motives": {
    "termination_motives": [
      {
        "id": 214748364,
        "value": "LOGISTICA"
      }
    ],
    "cancellation_motives": [
      {
        "id": 214748364,
        "value": "CONTRAOFERTA"
      }
    ]
  },
  "movement_types": [
    {
      "id": 214748364,
      "value": "PENALIZACION CANCELACION",
      "description": "FIBRA CUOTA PENALIZACIÓN"
    }
  ],
  "recharge_origins": [
    {
      "id": 214748364,
      "value": "TPV"
    }
  ],
  "occupations": [
    {
      "id": 0,
      "value": "Empresario"
    }
  ],
  "occupation_sectors": [
    {
      "id": 0,
      "value": "Armas y energía nuclear"
    }
  ]
}
Name Type Required Description
states [States] false none
document_types [SignupsDocumentType] false none
nationalities [Nationalities] false none
languages [Languages] false none
balances [number] false none
mobile_operators [Operator] false none
cli_operators [Operator] false none
sectors [Sector] false none
billing_types [BillingType] false none
fabrication_types [FabricationType] false none
deactivation_motives DeactivationMotives false none
movement_types [MovementType] false none
recharge_origins [RechargeOrigin] false [recharge origin]
occupations [Occupations] false none
occupation_sectors [OccupationSectors] false none

Occupations

1
2
3
4

{
  "id": 0,
  "value": "Empresario"
}
Name Type Required Description
id number(int32) false none
value string false none

OccupationSectors

1
2
3
4

{
  "id": 0,
  "value": "Armas y energía nuclear"
}
Name Type Required Description
id number(int32) false none
value string false none

States

1
2
3
4
5

{
  "id": 0,
  "value": "Lugo",
  "iso": "ES-LU"
}
Name Type Required Description
id number(int32) false none
value string false none
iso string false none

Nationalities

1
2
3
4
5

{
  "id": 0,
  "value": "España",
  "iso": "ES"
}
Name Type Required Description
id number(int32) false none
value string false none
iso string false none

Languages

1
2
3
4
5

{
  "id": 0,
  "value": "Castellano",
  "iso": "es"
}
Name Type Required Description
id number(int32) false none
value string false none
iso string false none

SignupsDocumentType

1
2
3
4
5

{
  "id": 0,
  "value": "nif",
  "description": ""
}
Name Type Required Description
id number(int32) false none
value string false none
description string false none

Operator

1
2
3
4

{
  "code": "string",
  "name": "string"
}
Name Type Required Description
code string false none
name string false none

FabricationType

1
2
3
4

{
  "id": 0,
  "value": "string"
}
Name Type Required Description
id number(int32) false none
value string false none

Sector

1
2
3
4

{
  "id": 0,
  "value": "RESIDENCIAL"
}
Name Type Required Description
id number(int32) false none
value string false none

AvailableMsisdns

1
2
3
4
5
6

{
  "host_cfg_id": 0,
  "available_msisdns": [
    "string"
  ]
}
Name Type Required Description
host_cfg_id number(int32) false this endpoint only support YOIGO network
available_msisdns [string] false none

DeactivationMotives

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14

{
  "termination_motives": [
    {
      "id": 214748364,
      "value": "LOGISTICA"
    }
  ],
  "cancellation_motives": [
    {
      "id": 214748364,
      "value": "CONTRAOFERTA"
    }
  ]
}
Name Type Required Description
termination_motives [TerminationMotive] false none
cancellation_motives [CancellationMotive] false none

TerminationMotive

1
2
3
4

{
  "id": 214748364,
  "value": "LOGISTICA"
}
Name Type Required Description
id number(int32) false none
value string false none

CancellationMotive

1
2
3
4

{
  "id": 214748364,
  "value": "CONTRAOFERTA"
}
Name Type Required Description
id number(int32) false none
value string false none

AddLineToBundleRequest

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183

{
  "client": {
    "attributes": {
      "document_expiration_date": "1999-01-31",
      "employment": {
        "activity_country_code": "st",
        "company": "string",
        "income": 9999999999999.99,
        "income_source": {
          "id": 999999999,
          "observations": "string"
        },
        "profession": 999999999,
        "professional_area": 999999999,
        "professional_use": true
      }
    }
  },
  "sales_info": {
    "channel": "dealer",
    "dealer_id": "string",
    "shop_id": "string",
    "agent_id": "string",
    "logistic": true,
    "signature_process_id": 0,
    "signature_type": "PAPER",
    "channel_id": 0
  },
  "account": {
    "account_id": 0,
    "subscriptions": {
      "mobile_lines": [
        {
          "type": "additional",
          "product_id": 0,
          "msisdn": 12345,
          "iccid": "8934042419120320845",
          "fabrication_type_sim_id": 214748364,
          "portability_info": {
            "iccid": "8934042419120320845",
            "operator_id": 214748364,
            "operation_type": 1,
            "initial_date_operation": "1999-01-31",
            "donor_line_type": "C",
            "internal_portability": true,
            "installation_required": true,
            "donor_user": {
              "type": "existing",
              "document_type_id": 1,
              "document_value": "11111111A"
            }
          },
          "bonuses": [
            {
              "id": 0
            }
          ],
          "promotions": [
            {
              "id": 0,
              "value": "string"
            }
          ],
          "terminals": [
            {
              "id": 0,
              "financed": true,
              "imei": "string",
              "serial_number": "string"
            }
          ],
          "devices": [
            {
              "device_details": {
                "id": 0,
                "model_id": "string",
                "cession_price": 999999999.99,
                "imei": "string",
                "pending_imei": true,
                "insured_amount": 0.01,
                "category": "string",
                "logistic_required": true,
                "catalogue_id": "string",
                "amount": 0.01
              },
              "fees": {
                "upfront_fee": 999999999.99,
                "installment_plan": {
                  "commission": 999999999.99,
                  "tae": 999999999.99,
                  "tin": 999999999.99,
                  "duration": 1,
                  "monthly_fee": 999999999.99,
                  "last_installment_fee": 999999999.99,
                  "discount_final_payment_value": 999999999.99,
                  "is_promotional_renew": true
                }
              },
              "financial_details": {
                "pre_booking": {
                  "order_id": "string",
                  "authorization_id": "string",
                  "financial_entity": "string",
                  "status": "Accepted",
                  "granted_amount": 999999999,
                  "credit_line_amount": 999999999,
                  "total_client_financed_value": 999999999.99
                },
                "consents": {
                  "commercial": true,
                  "gdpr": true
                }
              },
              "campaign_id": 0,
              "terms": {
                "penalty_value": 999999999.99,
                "commitment_duration": 9999
              },
              "reservation_id": "string",
              "signature_process_id": 0,
              "signature_type": "PAPER",
              "old_subscription_terminal_id": 0
            }
          ],
          "expedition_info": {
            "language_id": 214748364,
            "nationality_id": 214748364,
            "name": "John",
            "middlename": "Nicholas",
            "lastname": "Doe",
            "document_type_id": 1,
            "document_value": "11111111A",
            "email": "john.doe@example.com",
            "birthdate": "1999-01-31",
            "contact_phone": "string",
            "gender": "M",
            "address": {
              "street_name": "string",
              "state_id": 0,
              "locality": "string",
              "postal_code": "string",
              "country": "string",
              "number": "string",
              "value": "Castellano"
            },
            "delivery_shop_id": "0025",
            "delivery_type": "LOGISTIC"
          }
        }
      ],
      "tv": {
        "product_id": 0,
        "number_associated": 12345,
        "registration_email": "string",
        "contact_phone": 12345,
        "promotions": [
          {
            "id": 0,
            "value": "string"
          }
        ],
        "terminals": [
          {
            "id": 0,
            "financed": true,
            "imei": "string",
            "serial_number": "string"
          }
        ]
      }
    }
  },
  "tpv_response": {
    "amount": "string",
    "card_number": "000000******0000",
    "expiry_date": "0121",
    "transaction_id": "1563B44RPR2",
    "reference_id": "string",
    "platform": "PAYMENTS",
    "payment_link": "string",
    "tax": 21
  }
}
Name Type Required Description
client AddLineToBundleClient false none
sales_info SalesInfo false none
account AddLineToBundleAccount true none
tpv_response SignupsTpvResponse false none

AddLineToBundleClient

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17

{
  "attributes": {
    "document_expiration_date": "1999-01-31",
    "employment": {
      "activity_country_code": "st",
      "company": "string",
      "income": 9999999999999.99,
      "income_source": {
        "id": 999999999,
        "observations": "string"
      },
      "profession": 999999999,
      "professional_area": 999999999,
      "professional_use": true
    }
  }
}
Name Type Required Description
attributes AddLineToBundleClientAttributes false none

AddLineToBundleClientAttributes

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15

{
  "document_expiration_date": "1999-01-31",
  "employment": {
    "activity_country_code": "st",
    "company": "string",
    "income": 9999999999999.99,
    "income_source": {
      "id": 999999999,
      "observations": "string"
    },
    "profession": 999999999,
    "professional_area": 999999999,
    "professional_use": true
  }
}
Name Type Required Description
document_expiration_date string(date) false none
employment Employment false none

AddLineToBundleAccount

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144

{
  "account_id": 0,
  "subscriptions": {
    "mobile_lines": [
      {
        "type": "additional",
        "product_id": 0,
        "msisdn": 12345,
        "iccid": "8934042419120320845",
        "fabrication_type_sim_id": 214748364,
        "portability_info": {
          "iccid": "8934042419120320845",
          "operator_id": 214748364,
          "operation_type": 1,
          "initial_date_operation": "1999-01-31",
          "donor_line_type": "C",
          "internal_portability": true,
          "installation_required": true,
          "donor_user": {
            "type": "existing",
            "document_type_id": 1,
            "document_value": "11111111A"
          }
        },
        "bonuses": [
          {
            "id": 0
          }
        ],
        "promotions": [
          {
            "id": 0,
            "value": "string"
          }
        ],
        "terminals": [
          {
            "id": 0,
            "financed": true,
            "imei": "string",
            "serial_number": "string"
          }
        ],
        "devices": [
          {
            "device_details": {
              "id": 0,
              "model_id": "string",
              "cession_price": 999999999.99,
              "imei": "string",
              "pending_imei": true,
              "insured_amount": 0.01,
              "category": "string",
              "logistic_required": true,
              "catalogue_id": "string",
              "amount": 0.01
            },
            "fees": {
              "upfront_fee": 999999999.99,
              "installment_plan": {
                "commission": 999999999.99,
                "tae": 999999999.99,
                "tin": 999999999.99,
                "duration": 1,
                "monthly_fee": 999999999.99,
                "last_installment_fee": 999999999.99,
                "discount_final_payment_value": 999999999.99,
                "is_promotional_renew": true
              }
            },
            "financial_details": {
              "pre_booking": {
                "order_id": "string",
                "authorization_id": "string",
                "financial_entity": "string",
                "status": "Accepted",
                "granted_amount": 999999999,
                "credit_line_amount": 999999999,
                "total_client_financed_value": 999999999.99
              },
              "consents": {
                "commercial": true,
                "gdpr": true
              }
            },
            "campaign_id": 0,
            "terms": {
              "penalty_value": 999999999.99,
              "commitment_duration": 9999
            },
            "reservation_id": "string",
            "signature_process_id": 0,
            "signature_type": "PAPER",
            "old_subscription_terminal_id": 0
          }
        ],
        "expedition_info": {
          "language_id": 214748364,
          "nationality_id": 214748364,
          "name": "John",
          "middlename": "Nicholas",
          "lastname": "Doe",
          "document_type_id": 1,
          "document_value": "11111111A",
          "email": "john.doe@example.com",
          "birthdate": "1999-01-31",
          "contact_phone": "string",
          "gender": "M",
          "address": {
            "street_name": "string",
            "state_id": 0,
            "locality": "string",
            "postal_code": "string",
            "country": "string",
            "number": "string",
            "value": "Castellano"
          },
          "delivery_shop_id": "0025",
          "delivery_type": "LOGISTIC"
        }
      }
    ],
    "tv": {
      "product_id": 0,
      "number_associated": 12345,
      "registration_email": "string",
      "contact_phone": 12345,
      "promotions": [
        {
          "id": 0,
          "value": "string"
        }
      ],
      "terminals": [
        {
          "id": 0,
          "financed": true,
          "imei": "string",
          "serial_number": "string"
        }
      ]
    }
  }
}
Name Type Required Description
account_id integer(int32) true Account ID
subscriptions AddLineToBundleSubscriptions true none

AddLineToBundleSubscriptions

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141

{
  "mobile_lines": [
    {
      "type": "additional",
      "product_id": 0,
      "msisdn": 12345,
      "iccid": "8934042419120320845",
      "fabrication_type_sim_id": 214748364,
      "portability_info": {
        "iccid": "8934042419120320845",
        "operator_id": 214748364,
        "operation_type": 1,
        "initial_date_operation": "1999-01-31",
        "donor_line_type": "C",
        "internal_portability": true,
        "installation_required": true,
        "donor_user": {
          "type": "existing",
          "document_type_id": 1,
          "document_value": "11111111A"
        }
      },
      "bonuses": [
        {
          "id": 0
        }
      ],
      "promotions": [
        {
          "id": 0,
          "value": "string"
        }
      ],
      "terminals": [
        {
          "id": 0,
          "financed": true,
          "imei": "string",
          "serial_number": "string"
        }
      ],
      "devices": [
        {
          "device_details": {
            "id": 0,
            "model_id": "string",
            "cession_price": 999999999.99,
            "imei": "string",
            "pending_imei": true,
            "insured_amount": 0.01,
            "category": "string",
            "logistic_required": true,
            "catalogue_id": "string",
            "amount": 0.01
          },
          "fees": {
            "upfront_fee": 999999999.99,
            "installment_plan": {
              "commission": 999999999.99,
              "tae": 999999999.99,
              "tin": 999999999.99,
              "duration": 1,
              "monthly_fee": 999999999.99,
              "last_installment_fee": 999999999.99,
              "discount_final_payment_value": 999999999.99,
              "is_promotional_renew": true
            }
          },
          "financial_details": {
            "pre_booking": {
              "order_id": "string",
              "authorization_id": "string",
              "financial_entity": "string",
              "status": "Accepted",
              "granted_amount": 999999999,
              "credit_line_amount": 999999999,
              "total_client_financed_value": 999999999.99
            },
            "consents": {
              "commercial": true,
              "gdpr": true
            }
          },
          "campaign_id": 0,
          "terms": {
            "penalty_value": 999999999.99,
            "commitment_duration": 9999
          },
          "reservation_id": "string",
          "signature_process_id": 0,
          "signature_type": "PAPER",
          "old_subscription_terminal_id": 0
        }
      ],
      "expedition_info": {
        "language_id": 214748364,
        "nationality_id": 214748364,
        "name": "John",
        "middlename": "Nicholas",
        "lastname": "Doe",
        "document_type_id": 1,
        "document_value": "11111111A",
        "email": "john.doe@example.com",
        "birthdate": "1999-01-31",
        "contact_phone": "string",
        "gender": "M",
        "address": {
          "street_name": "string",
          "state_id": 0,
          "locality": "string",
          "postal_code": "string",
          "country": "string",
          "number": "string",
          "value": "Castellano"
        },
        "delivery_shop_id": "0025",
        "delivery_type": "LOGISTIC"
      }
    }
  ],
  "tv": {
    "product_id": 0,
    "number_associated": 12345,
    "registration_email": "string",
    "contact_phone": 12345,
    "promotions": [
      {
        "id": 0,
        "value": "string"
      }
    ],
    "terminals": [
      {
        "id": 0,
        "financed": true,
        "imei": "string",
        "serial_number": "string"
      }
    ]
  }
}
Name Type Required Description
mobile_lines [AddLineToBundleMobileLine] false Mobile lines subscriptions
tv BundleChangesTv false none

BundleMigrationRequest

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199

{
  "client": {
    "attributes": {
      "document_expiration_date": "1999-01-31",
      "employment": {
        "activity_country_code": "st",
        "company": "string",
        "income": 9999999999999.99,
        "income_source": {
          "id": 999999999,
          "observations": "string"
        },
        "profession": 999999999,
        "professional_area": 999999999,
        "professional_use": true
      }
    }
  },
  "sales_info": {
    "shop_id": "string",
    "logistic": true,
    "signature_process_id": 0
  },
  "account": {
    "new_bundle_id": 0,
    "account_id": 0,
    "territory_owner": "string",
    "subscriptions": {
      "mobile_lines": [
        {
          "subscription_id": 0,
          "type": "additional",
          "product_id": 0,
          "msisdn": 12345,
          "iccid": "8934042419120320845",
          "fabrication_type_sim_id": 214748364,
          "portability_info": {
            "iccid": "8934042419120320845",
            "operator_id": 214748364,
            "operation_type": 1,
            "initial_date_operation": "1999-01-31",
            "donor_line_type": "C",
            "internal_portability": true,
            "installation_required": true,
            "donor_user": {
              "type": "existing",
              "document_type_id": 1,
              "document_value": "11111111A"
            }
          },
          "bonuses": [
            {
              "id": 0
            }
          ],
          "promotions": [
            {
              "id": 0,
              "value": "string"
            }
          ],
          "terminals": [
            {
              "id": 0,
              "financed": true,
              "imei": "string",
              "serial_number": "string"
            }
          ],
          "devices": [
            {
              "device_details": {
                "id": 0,
                "model_id": "string",
                "cession_price": 999999999.99,
                "imei": "string",
                "pending_imei": true,
                "insured_amount": 0.01,
                "category": "string",
                "logistic_required": true,
                "catalogue_id": "string",
                "amount": 0.01
              },
              "fees": {
                "upfront_fee": 999999999.99,
                "installment_plan": {
                  "commission": 999999999.99,
                  "tae": 999999999.99,
                  "tin": 999999999.99,
                  "duration": 1,
                  "monthly_fee": 999999999.99,
                  "last_installment_fee": 999999999.99,
                  "discount_final_payment_value": 999999999.99,
                  "is_promotional_renew": true
                }
              },
              "financial_details": {
                "pre_booking": {
                  "order_id": "string",
                  "authorization_id": "string",
                  "financial_entity": "string",
                  "status": "Accepted",
                  "granted_amount": 999999999,
                  "credit_line_amount": 999999999,
                  "total_client_financed_value": 999999999.99
                },
                "consents": {
                  "commercial": true,
                  "gdpr": true
                }
              },
              "campaign_id": 0,
              "terms": {
                "penalty_value": 999999999.99,
                "commitment_duration": 9999
              },
              "reservation_id": "string",
              "signature_process_id": 0,
              "signature_type": "PAPER",
              "old_subscription_terminal_id": 0
            }
          ]
        }
      ],
      "tv": {
        "product_id": 0,
        "number_associated": 12345,
        "registration_email": "string",
        "contact_phone": 12345,
        "promotions": [
          {
            "id": 0,
            "value": "string"
          }
        ],
        "terminals": [
          {
            "id": 0,
            "financed": true,
            "imei": "string",
            "serial_number": "string"
          }
        ]
      },
      "ftth": {
        "product_id": 0,
        "promotions": [
          {
            "id": 0,
            "value": "string"
          }
        ],
        "terminals": [
          {
            "id": 0,
            "financed": true,
            "imei": "string",
            "serial_number": "string"
          }
        ]
      },
      "adsl": {
        "product_id": 0,
        "promotions": [
          {
            "id": 0,
            "value": "string"
          }
        ],
        "terminals": [
          {
            "id": 0,
            "financed": true,
            "imei": "string",
            "serial_number": "string"
          }
        ]
      },
      "ott": [
        {
          "product_id": 0,
          "email": "string",
          "promotions": [
            {
              "id": 0,
              "value": "string"
            }
          ]
        }
      ]
    },
    "promotions": [
      {
        "id": 0,
        "value": "string"
      }
    ]
  }
}
Name Type Required Description
client BundleMigrationClient false none
sales_info BundleMigrationSalesInfo false none
account BundleMigrationAccount true none

BundleMigrationClient

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17

{
  "attributes": {
    "document_expiration_date": "1999-01-31",
    "employment": {
      "activity_country_code": "st",
      "company": "string",
      "income": 9999999999999.99,
      "income_source": {
        "id": 999999999,
        "observations": "string"
      },
      "profession": 999999999,
      "professional_area": 999999999,
      "professional_use": true
    }
  }
}
Name Type Required Description
attributes BundleMigrationClientAttributes false none

BundleMigrationClientAttributes

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15

{
  "document_expiration_date": "1999-01-31",
  "employment": {
    "activity_country_code": "st",
    "company": "string",
    "income": 9999999999999.99,
    "income_source": {
      "id": 999999999,
      "observations": "string"
    },
    "profession": 999999999,
    "professional_area": 999999999,
    "professional_use": true
  }
}
Name Type Required Description
document_expiration_date string(date) false none
employment Employment false none

BundleMigrationAccount

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175

{
  "new_bundle_id": 0,
  "account_id": 0,
  "territory_owner": "string",
  "subscriptions": {
    "mobile_lines": [
      {
        "subscription_id": 0,
        "type": "additional",
        "product_id": 0,
        "msisdn": 12345,
        "iccid": "8934042419120320845",
        "fabrication_type_sim_id": 214748364,
        "portability_info": {
          "iccid": "8934042419120320845",
          "operator_id": 214748364,
          "operation_type": 1,
          "initial_date_operation": "1999-01-31",
          "donor_line_type": "C",
          "internal_portability": true,
          "installation_required": true,
          "donor_user": {
            "type": "existing",
            "document_type_id": 1,
            "document_value": "11111111A"
          }
        },
        "bonuses": [
          {
            "id": 0
          }
        ],
        "promotions": [
          {
            "id": 0,
            "value": "string"
          }
        ],
        "terminals": [
          {
            "id": 0,
            "financed": true,
            "imei": "string",
            "serial_number": "string"
          }
        ],
        "devices": [
          {
            "device_details": {
              "id": 0,
              "model_id": "string",
              "cession_price": 999999999.99,
              "imei": "string",
              "pending_imei": true,
              "insured_amount": 0.01,
              "category": "string",
              "logistic_required": true,
              "catalogue_id": "string",
              "amount": 0.01
            },
            "fees": {
              "upfront_fee": 999999999.99,
              "installment_plan": {
                "commission": 999999999.99,
                "tae": 999999999.99,
                "tin": 999999999.99,
                "duration": 1,
                "monthly_fee": 999999999.99,
                "last_installment_fee": 999999999.99,
                "discount_final_payment_value": 999999999.99,
                "is_promotional_renew": true
              }
            },
            "financial_details": {
              "pre_booking": {
                "order_id": "string",
                "authorization_id": "string",
                "financial_entity": "string",
                "status": "Accepted",
                "granted_amount": 999999999,
                "credit_line_amount": 999999999,
                "total_client_financed_value": 999999999.99
              },
              "consents": {
                "commercial": true,
                "gdpr": true
              }
            },
            "campaign_id": 0,
            "terms": {
              "penalty_value": 999999999.99,
              "commitment_duration": 9999
            },
            "reservation_id": "string",
            "signature_process_id": 0,
            "signature_type": "PAPER",
            "old_subscription_terminal_id": 0
          }
        ]
      }
    ],
    "tv": {
      "product_id": 0,
      "number_associated": 12345,
      "registration_email": "string",
      "contact_phone": 12345,
      "promotions": [
        {
          "id": 0,
          "value": "string"
        }
      ],
      "terminals": [
        {
          "id": 0,
          "financed": true,
          "imei": "string",
          "serial_number": "string"
        }
      ]
    },
    "ftth": {
      "product_id": 0,
      "promotions": [
        {
          "id": 0,
          "value": "string"
        }
      ],
      "terminals": [
        {
          "id": 0,
          "financed": true,
          "imei": "string",
          "serial_number": "string"
        }
      ]
    },
    "adsl": {
      "product_id": 0,
      "promotions": [
        {
          "id": 0,
          "value": "string"
        }
      ],
      "terminals": [
        {
          "id": 0,
          "financed": true,
          "imei": "string",
          "serial_number": "string"
        }
      ]
    },
    "ott": [
      {
        "product_id": 0,
        "email": "string",
        "promotions": [
          {
            "id": 0,
            "value": "string"
          }
        ]
      }
    ]
  },
  "promotions": [
    {
      "id": 0,
      "value": "string"
    }
  ]
}
Name Type Required Description
new_bundle_id integer(int32) true New bundle id to migrate to
account_id integer(int32) true Account ID
territory_owner string false none
subscriptions BundleMigrationSubscriptions false none
promotions [SignupsPromotions] false [If this object is informed, it´s a promotion. If not, it´s a campaign]

BundleMigrationSubscriptions

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164

{
  "mobile_lines": [
    {
      "subscription_id": 0,
      "type": "additional",
      "product_id": 0,
      "msisdn": 12345,
      "iccid": "8934042419120320845",
      "fabrication_type_sim_id": 214748364,
      "portability_info": {
        "iccid": "8934042419120320845",
        "operator_id": 214748364,
        "operation_type": 1,
        "initial_date_operation": "1999-01-31",
        "donor_line_type": "C",
        "internal_portability": true,
        "installation_required": true,
        "donor_user": {
          "type": "existing",
          "document_type_id": 1,
          "document_value": "11111111A"
        }
      },
      "bonuses": [
        {
          "id": 0
        }
      ],
      "promotions": [
        {
          "id": 0,
          "value": "string"
        }
      ],
      "terminals": [
        {
          "id": 0,
          "financed": true,
          "imei": "string",
          "serial_number": "string"
        }
      ],
      "devices": [
        {
          "device_details": {
            "id": 0,
            "model_id": "string",
            "cession_price": 999999999.99,
            "imei": "string",
            "pending_imei": true,
            "insured_amount": 0.01,
            "category": "string",
            "logistic_required": true,
            "catalogue_id": "string",
            "amount": 0.01
          },
          "fees": {
            "upfront_fee": 999999999.99,
            "installment_plan": {
              "commission": 999999999.99,
              "tae": 999999999.99,
              "tin": 999999999.99,
              "duration": 1,
              "monthly_fee": 999999999.99,
              "last_installment_fee": 999999999.99,
              "discount_final_payment_value": 999999999.99,
              "is_promotional_renew": true
            }
          },
          "financial_details": {
            "pre_booking": {
              "order_id": "string",
              "authorization_id": "string",
              "financial_entity": "string",
              "status": "Accepted",
              "granted_amount": 999999999,
              "credit_line_amount": 999999999,
              "total_client_financed_value": 999999999.99
            },
            "consents": {
              "commercial": true,
              "gdpr": true
            }
          },
          "campaign_id": 0,
          "terms": {
            "penalty_value": 999999999.99,
            "commitment_duration": 9999
          },
          "reservation_id": "string",
          "signature_process_id": 0,
          "signature_type": "PAPER",
          "old_subscription_terminal_id": 0
        }
      ]
    }
  ],
  "tv": {
    "product_id": 0,
    "number_associated": 12345,
    "registration_email": "string",
    "contact_phone": 12345,
    "promotions": [
      {
        "id": 0,
        "value": "string"
      }
    ],
    "terminals": [
      {
        "id": 0,
        "financed": true,
        "imei": "string",
        "serial_number": "string"
      }
    ]
  },
  "ftth": {
    "product_id": 0,
    "promotions": [
      {
        "id": 0,
        "value": "string"
      }
    ],
    "terminals": [
      {
        "id": 0,
        "financed": true,
        "imei": "string",
        "serial_number": "string"
      }
    ]
  },
  "adsl": {
    "product_id": 0,
    "promotions": [
      {
        "id": 0,
        "value": "string"
      }
    ],
    "terminals": [
      {
        "id": 0,
        "financed": true,
        "imei": "string",
        "serial_number": "string"
      }
    ]
  },
  "ott": [
    {
      "product_id": 0,
      "email": "string",
      "promotions": [
        {
          "id": 0,
          "value": "string"
        }
      ]
    }
  ]
}
Name Type Required Description
mobile_lines [BundleMigrationMobileLine] false none
tv BundleChangesTv false none
ftth BundleChangesFtth false none
adsl BundleChangesAdsl false none
ott [BundleChangesOtt] false none

BundleChangesOtt

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

{
  "product_id": 0,
  "email": "string",
  "promotions": [
    {
      "id": 0,
      "value": "string"
    }
  ]
}
Name Type Required Description
product_id number(int32) true none
email string false none
promotions [SignupsPromotions] false [If this object is informed, it´s a promotion. If not, it´s a campaign]

AddLineToBundleMobileLine

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117

{
  "type": "additional",
  "product_id": 0,
  "msisdn": 12345,
  "iccid": "8934042419120320845",
  "fabrication_type_sim_id": 214748364,
  "portability_info": {
    "iccid": "8934042419120320845",
    "operator_id": 214748364,
    "operation_type": 1,
    "initial_date_operation": "1999-01-31",
    "donor_line_type": "C",
    "internal_portability": true,
    "installation_required": true,
    "donor_user": {
      "type": "existing",
      "document_type_id": 1,
      "document_value": "11111111A"
    }
  },
  "bonuses": [
    {
      "id": 0
    }
  ],
  "promotions": [
    {
      "id": 0,
      "value": "string"
    }
  ],
  "terminals": [
    {
      "id": 0,
      "financed": true,
      "imei": "string",
      "serial_number": "string"
    }
  ],
  "devices": [
    {
      "device_details": {
        "id": 0,
        "model_id": "string",
        "cession_price": 999999999.99,
        "imei": "string",
        "pending_imei": true,
        "insured_amount": 0.01,
        "category": "string",
        "logistic_required": true,
        "catalogue_id": "string",
        "amount": 0.01
      },
      "fees": {
        "upfront_fee": 999999999.99,
        "installment_plan": {
          "commission": 999999999.99,
          "tae": 999999999.99,
          "tin": 999999999.99,
          "duration": 1,
          "monthly_fee": 999999999.99,
          "last_installment_fee": 999999999.99,
          "discount_final_payment_value": 999999999.99,
          "is_promotional_renew": true
        }
      },
      "financial_details": {
        "pre_booking": {
          "order_id": "string",
          "authorization_id": "string",
          "financial_entity": "string",
          "status": "Accepted",
          "granted_amount": 999999999,
          "credit_line_amount": 999999999,
          "total_client_financed_value": 999999999.99
        },
        "consents": {
          "commercial": true,
          "gdpr": true
        }
      },
      "campaign_id": 0,
      "terms": {
        "penalty_value": 999999999.99,
        "commitment_duration": 9999
      },
      "reservation_id": "string",
      "signature_process_id": 0,
      "signature_type": "PAPER",
      "old_subscription_terminal_id": 0
    }
  ],
  "expedition_info": {
    "language_id": 214748364,
    "nationality_id": 214748364,
    "name": "John",
    "middlename": "Nicholas",
    "lastname": "Doe",
    "document_type_id": 1,
    "document_value": "11111111A",
    "email": "john.doe@example.com",
    "birthdate": "1999-01-31",
    "contact_phone": "string",
    "gender": "M",
    "address": {
      "street_name": "string",
      "state_id": 0,
      "locality": "string",
      "postal_code": "string",
      "country": "string",
      "number": "string",
      "value": "Castellano"
    },
    "delivery_shop_id": "0025",
    "delivery_type": "LOGISTIC"
  }
}
Name Type Required Description
type string true Type of mobile line
product_id integer(int32) true Destination product ID
msisdn string true Mobile Station International Subscriber Directory Number
iccid string false New Integrated Circuit Card ID
fabrication_type_sim_id integer(int32) false Fabrication type, according to data returned from master-data
portability_info BundleChangesPortabilityInfo false none
bonuses [Bonuses] false Bonuses added to subscription
promotions [SignupsPromotions] false Promotions added to subscription
terminals [Terminal] false Terminals purchased along with subscription
devices [Device] false none
expedition_info ExpeditionInfo false none
Property Values
type one of [extra, additional]

BundleChangesPortabilityInfo

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14

{
  "iccid": "8934042419120320845",
  "operator_id": 214748364,
  "operation_type": 1,
  "initial_date_operation": "1999-01-31",
  "donor_line_type": "C",
  "internal_portability": true,
  "installation_required": true,
  "donor_user": {
    "type": "existing",
    "document_type_id": 1,
    "document_value": "11111111A"
  }
}
Name Type Required Description
iccid string false Integrated Circuit Card ID of the donor operator
operator_id string true Donor operator ID
operation_type integer(int32) true 1 -> instantaneous
initial_date_operation string(date) false date schedule for start portability.
donor_line_type string true Line type in current operator (postpaid or prepaid)
internal_portability boolean¦null false none
installation_required boolean¦null false none
donor_user Client false User with “client” type is used if donor_user is not present
Property Values
operation_type one of [1]
donor_line_type one of [C, P]

BundleChangesTv

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20

{
  "product_id": 0,
  "number_associated": 12345,
  "registration_email": "string",
  "contact_phone": 12345,
  "promotions": [
    {
      "id": 0,
      "value": "string"
    }
  ],
  "terminals": [
    {
      "id": 0,
      "financed": true,
      "imei": "string",
      "serial_number": "string"
    }
  ]
}
Name Type Required Description
product_id integer(int32) true Product ID
number_associated string true Number associated to TV subscription
registration_email string false none
contact_phone string true Contact phone
promotions [SignupsPromotions] false Promotions associated to TV subscription
terminals [Terminal] true Terminals purchased along with TV subscription

BundleMigrationMobileLine

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94

{
  "subscription_id": 0,
  "type": "additional",
  "product_id": 0,
  "msisdn": 12345,
  "iccid": "8934042419120320845",
  "fabrication_type_sim_id": 214748364,
  "portability_info": {
    "iccid": "8934042419120320845",
    "operator_id": 214748364,
    "operation_type": 1,
    "initial_date_operation": "1999-01-31",
    "donor_line_type": "C",
    "internal_portability": true,
    "installation_required": true,
    "donor_user": {
      "type": "existing",
      "document_type_id": 1,
      "document_value": "11111111A"
    }
  },
  "bonuses": [
    {
      "id": 0
    }
  ],
  "promotions": [
    {
      "id": 0,
      "value": "string"
    }
  ],
  "terminals": [
    {
      "id": 0,
      "financed": true,
      "imei": "string",
      "serial_number": "string"
    }
  ],
  "devices": [
    {
      "device_details": {
        "id": 0,
        "model_id": "string",
        "cession_price": 999999999.99,
        "imei": "string",
        "pending_imei": true,
        "insured_amount": 0.01,
        "category": "string",
        "logistic_required": true,
        "catalogue_id": "string",
        "amount": 0.01
      },
      "fees": {
        "upfront_fee": 999999999.99,
        "installment_plan": {
          "commission": 999999999.99,
          "tae": 999999999.99,
          "tin": 999999999.99,
          "duration": 1,
          "monthly_fee": 999999999.99,
          "last_installment_fee": 999999999.99,
          "discount_final_payment_value": 999999999.99,
          "is_promotional_renew": true
        }
      },
      "financial_details": {
        "pre_booking": {
          "order_id": "string",
          "authorization_id": "string",
          "financial_entity": "string",
          "status": "Accepted",
          "granted_amount": 999999999,
          "credit_line_amount": 999999999,
          "total_client_financed_value": 999999999.99
        },
        "consents": {
          "commercial": true,
          "gdpr": true
        }
      },
      "campaign_id": 0,
      "terms": {
        "penalty_value": 999999999.99,
        "commitment_duration": 9999
      },
      "reservation_id": "string",
      "signature_process_id": 0,
      "signature_type": "PAPER",
      "old_subscription_terminal_id": 0
    }
  ]
}
Name Type Required Description
subscription_id integer(int64) false Active mobile line subscription id
type string true Type of mobile line
product_id integer(int32) true Destination product ID
msisdn string true Mobile Station International Subscriber Directory Number
iccid string false New Integrated Circuit Card ID
fabrication_type_sim_id integer(int32) false Fabrication type, according to data returned from master-data
portability_info BundleChangesPortabilityInfo false none
bonuses [Bonuses] false Bonuses added to subscription
promotions [SignupsPromotions] false Promotions added to subscription
terminals [Terminal] false Terminals purchased along with subscription
devices [Device] false none
Property Values
type one of [main, extra, additional]

BundleChangesFtth

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17

{
  "product_id": 0,
  "promotions": [
    {
      "id": 0,
      "value": "string"
    }
  ],
  "terminals": [
    {
      "id": 0,
      "financed": true,
      "imei": "string",
      "serial_number": "string"
    }
  ]
}
Name Type Required Description
product_id number(int32) true none
promotions [SignupsPromotions] false [If this object is informed, it´s a promotion. If not, it´s a campaign]
terminals [Terminal] false none

BundleChangesAdsl

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17

{
  "product_id": 0,
  "promotions": [
    {
      "id": 0,
      "value": "string"
    }
  ],
  "terminals": [
    {
      "id": 0,
      "financed": true,
      "imei": "string",
      "serial_number": "string"
    }
  ]
}
Name Type Required Description
product_id number(int32) true none
promotions [SignupsPromotions] false [If this object is informed, it´s a promotion. If not, it´s a campaign]
terminals [Terminal] false none

BundleMigrationSalesInfo

1
2
3
4
5

{
  "shop_id": "string",
  "logistic": true,
  "signature_process_id": 0
}
Name Type Required Description
shop_id string false none
logistic boolean true none
signature_process_id number(int64) false none

ExistingClient

1
2
3
4
5

{
  "type": "existing",
  "document_type_id": 1,
  "document_value": "11111111A"
}
Name Type Required Description
type string true Field is only available with the following values to avoid confusion with ClientPersonal and ClientBusiness
document_type_id integer(int32) true none
document_value string true none
Property Values
type one of [existing]
document_type_id one of [1, 3, 4, 5]

SignupExistingClient

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18

{
  "type": "existing",
  "document_type_id": 1,
  "document_value": "11111111A",
  "document_expiration_date": "1999-01-31",
  "employment": {
    "activity_country_code": "st",
    "company": "string",
    "income": 9999999999999.99,
    "income_source": {
      "id": 999999999,
      "observations": "string"
    },
    "profession": 999999999,
    "professional_area": 999999999,
    "professional_use": true
  }
}
Name Type Required Description
anonymous ExistingClient false none
Name Type Required Description
anonymous object false none
» document_expiration_date string(date) false none
» employment Employment false none

ComputedPenalties

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

[
  {
    "computed_penalty_id": 0,
    "mobile_operator_id": 0,
    "penalties": [
      {
        "id": 0,
        "value": 0,
        "description": "string",
        "subscription_id": 0,
        "subscription_uuid": "1d315b44-b5ed-49fd-a63a-f8129c5d76c8",
        "commitment_uuid": "95dc5373-5574-42d8-bd89-b4b6f7b62faa",
        "subscrition_promotion_id": 0,
        "promotion_id": 0,
        "start_date": "1999-01-31",
        "end_date": "1999-01-31",
        "mandatory": true,
        "type": "ADMCOSTCANCELCOST",
        "subscription_terminal_id": 0
      }
    ]
  }
]
Name Type Required Description
anonymous [ComputedPenalty] false none

ComputedPenalty

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21

{
  "computed_penalty_id": 0,
  "mobile_operator_id": 0,
  "penalties": [
    {
      "id": 0,
      "value": 0,
      "description": "string",
      "subscription_id": 0,
      "subscription_uuid": "1d315b44-b5ed-49fd-a63a-f8129c5d76c8",
      "commitment_uuid": "95dc5373-5574-42d8-bd89-b4b6f7b62faa",
      "subscrition_promotion_id": 0,
      "promotion_id": 0,
      "start_date": "1999-01-31",
      "end_date": "1999-01-31",
      "mandatory": true,
      "type": "ADMCOSTCANCELCOST",
      "subscription_terminal_id": 0
    }
  ]
}
Name Type Required Description
computed_penalty_id number false none
mobile_operator_id number false none
penalties [Penalty] false none

Penalty

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15

{
  "id": 0,
  "value": 0,
  "description": "string",
  "subscription_id": 0,
  "subscription_uuid": "1d315b44-b5ed-49fd-a63a-f8129c5d76c8",
  "commitment_uuid": "95dc5373-5574-42d8-bd89-b4b6f7b62faa",
  "subscrition_promotion_id": 0,
  "promotion_id": 0,
  "start_date": "1999-01-31",
  "end_date": "1999-01-31",
  "mandatory": true,
  "type": "ADMCOSTCANCELCOST",
  "subscription_terminal_id": 0
}
Name Type Required Description
id integer(int64) false none
value number false none
description string false none
subscription_id integer(int64) false none
subscription_uuid string(uuid) false none
commitment_uuid string(uuid) false none
subscrition_promotion_id integer(int64) false none
promotion_id integer(int64) false none
start_date string(date) false none
end_date string(date) false none
mandatory boolean false none
type string false none
subscription_terminal_id integer(int64) false none

AccountPenaltiesReason

1

"unsubscribe"
Name Type Required Description
anonymous string false none
Property Values
anonymous one of [unsubscribe, cancel]

SubscriptionPenaltiesReason

1

"broadband_subscription"
Name Type Required Description
anonymous string false none
Property Values
anonymous one of [broadband_subscription, device, mobile]

AddDeviceToSubscriptionRequest

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126

{
  "delivery_info": {
    "shipping_price": 999999999.99,
    "pay_in_return": true,
    "contact": {
      "name": "string",
      "phone": "string"
    },
    "address": {
      "address_id": "string",
      "description": "string",
      "street_type": "ACCESS",
      "street_name": "string",
      "number": "string",
      "block": "string",
      "bis": "str",
      "floor": "string",
      "stair": "string",
      "door": "string",
      "letter": "string",
      "hand1": "string",
      "hand2": "string",
      "postal_code": "string",
      "town": "string",
      "province_id": "28",
      "technical_id": "string"
    },
    "delivery_shop_id": "0025",
    "delivery_type": "LOGISTIC"
  },
  "sell": {
    "dealer_id": "C00002",
    "shop_id": "0025",
    "channel_id": 0,
    "category": "Generic",
    "payment": {
      "id": 999999999,
      "credit_card_reference": "string",
      "transaction_id": "9651BHUZ2A3",
      "reference_id": "string",
      "scoring": {
        "scoring_value": 0,
        "id_value": 0,
        "forced_value": 0,
        "up_front": 0.1,
        "credit_limit": 0.1,
        "credit_limit_available": 0.1,
        "app_id": 0
      },
      "platform": "PAYMENTS",
      "payment_link": "string",
      "tax": 21
    }
  },
  "client": {
    "customer_id": "string",
    "account_id": "string",
    "attributes": {
      "document_expiration_date": "1999-01-31",
      "employment": {
        "activity_country_code": "st",
        "company": "string",
        "income": 9999999999999.99,
        "income_source": {
          "id": 999999999,
          "observations": "string"
        },
        "profession": 999999999,
        "professional_area": 999999999,
        "professional_use": true
      }
    }
  },
  "device": {
    "device_details": {
      "id": 0,
      "model_id": "string",
      "cession_price": 999999999.99,
      "imei": "string",
      "pending_imei": true,
      "insured_amount": 0.01,
      "category": "string",
      "logistic_required": true,
      "catalogue_id": "string",
      "amount": 0.01
    },
    "fees": {
      "upfront_fee": 999999999.99,
      "installment_plan": {
        "commission": 999999999.99,
        "tae": 999999999.99,
        "tin": 999999999.99,
        "duration": 1,
        "monthly_fee": 999999999.99,
        "last_installment_fee": 999999999.99,
        "discount_final_payment_value": 999999999.99,
        "is_promotional_renew": true
      }
    },
    "financial_details": {
      "pre_booking": {
        "order_id": "string",
        "authorization_id": "string",
        "financial_entity": "string",
        "status": "Accepted",
        "granted_amount": 999999999,
        "credit_line_amount": 999999999,
        "total_client_financed_value": 999999999.99
      },
      "consents": {
        "commercial": true,
        "gdpr": true
      }
    },
    "campaign_id": 0,
    "terms": {
      "penalty_value": 999999999.99,
      "commitment_duration": 9999
    },
    "reservation_id": "string",
    "signature_process_id": 0,
    "signature_type": "PAPER",
    "old_subscription_terminal_id": 0
  },
  "subscription_offer_segment": "string"
}
Name Type Required Description
delivery_info DeviceDeliveryInfo false none
sell Sell true none
client DeviceClient true none
device Device true none
subscription_offer_segment string true none

DeviceDeliveryInfo

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

{
  "shipping_price": 999999999.99,
  "pay_in_return": true,
  "contact": {
    "name": "string",
    "phone": "string"
  },
  "address": {
    "address_id": "string",
    "description": "string",
    "street_type": "ACCESS",
    "street_name": "string",
    "number": "string",
    "block": "string",
    "bis": "str",
    "floor": "string",
    "stair": "string",
    "door": "string",
    "letter": "string",
    "hand1": "string",
    "hand2": "string",
    "postal_code": "string",
    "town": "string",
    "province_id": "28",
    "technical_id": "string"
  },
  "delivery_shop_id": "0025",
  "delivery_type": "LOGISTIC"
}
Name Type Required Description
shipping_price number(double) false none
pay_in_return boolean false none
contact DeviceContact true none
address DeviceNormalizedAddress true none
delivery_shop_id string¦null false Shop identifier where the pickup (if that’s the case) will occur
delivery_type string¦null false how a device will be delivered to a customer
Property Values
delivery_type one of [LOGISTIC, IN_PERSON, STORE_DELIVERY]

DeviceContact

1
2
3
4

{
  "name": "string",
  "phone": "string"
}
Name Type Required Description
name string true none
phone string true none

DeviceNormalizedAddress

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19

{
  "address_id": "string",
  "description": "string",
  "street_type": "ACCESS",
  "street_name": "string",
  "number": "string",
  "block": "string",
  "bis": "str",
  "floor": "string",
  "stair": "string",
  "door": "string",
  "letter": "string",
  "hand1": "string",
  "hand2": "string",
  "postal_code": "string",
  "town": "string",
  "province_id": "28",
  "technical_id": "string"
}
Name Type Required Description
address_id string false none
description string false none
street_type string true Street type, default value is UNKNOWN
street_name string true none
number string true none
block string false none
bis string false none
floor string false none
stair string false none
door string false none
letter string false none
hand1 string false none
hand2 string false none
postal_code string true none
town string true none
province_id string true Numeric province id from 01 to 52
technical_id string false Gescal 37
Property Values
street_type one of [ACCESS, AVENUE, BOULEVARD, BUILDING, COLONY, COMPLEX, CORE, COURTYARD, CROSSING, DISSEMINATED, DITCH, ENTRY, EXTENSION, FARM_HOUSE, FARMHOUSE, GROUP, GROUPING, HALLWAY, HIGHWAY, HOUSE, ITEM, NEIGHBORHOOD, OUTSKIRT, PARK, PARCEL, PASSAGE, PLACE, POLYGON, RAVINE, RESIDENCE, ROAD, ROUND, ROUNDABOUT, SET, SIDE_STREET, SIDEWALK, SLOPE, SLUM, SMALL_SQUARE, SQUARE, STREET, SUBURB, TOWN, TRAIL, UNKNOWN, URBANIZATION, VIA, WAY, ZONE]

Sell

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

{
  "dealer_id": "C00002",
  "shop_id": "0025",
  "channel_id": 0,
  "category": "Generic",
  "payment": {
    "id": 999999999,
    "credit_card_reference": "string",
    "transaction_id": "9651BHUZ2A3",
    "reference_id": "string",
    "scoring": {
      "scoring_value": 0,
      "id_value": 0,
      "forced_value": 0,
      "up_front": 0.1,
      "credit_limit": 0.1,
      "credit_limit_available": 0.1,
      "app_id": 0
    },
    "platform": "PAYMENTS",
    "payment_link": "string",
    "tax": 21
  }
}
Name Type Required Description
dealer_id string false Dealer id
shop_id string false Shop id
channel_id integer false none
category string true Role of the sale
payment SellPayment false none
Property Values
category one of [Generic, Loyalty, Retention]

SellPayment

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18

{
  "id": 999999999,
  "credit_card_reference": "string",
  "transaction_id": "9651BHUZ2A3",
  "reference_id": "string",
  "scoring": {
    "scoring_value": 0,
    "id_value": 0,
    "forced_value": 0,
    "up_front": 0.1,
    "credit_limit": 0.1,
    "credit_limit_available": 0.1,
    "app_id": 0
  },
  "platform": "PAYMENTS",
  "payment_link": "string",
  "tax": 21
}
Name Type Required Description
id number(int64) false none
credit_card_reference string false none
transaction_id string false none
reference_id string false none
scoring SignupsScoring false none
platform string false none
payment_link string¦null false none
tax number(double)¦null false If not sent, 21.0 will apply
Property Values
platform one of [PAYMENTS, ADYEN, REDSYS]

DeviceClient

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19

{
  "customer_id": "string",
  "account_id": "string",
  "attributes": {
    "document_expiration_date": "1999-01-31",
    "employment": {
      "activity_country_code": "st",
      "company": "string",
      "income": 9999999999999.99,
      "income_source": {
        "id": 999999999,
        "observations": "string"
      },
      "profession": 999999999,
      "professional_area": 999999999,
      "professional_use": true
    }
  }
}
Name Type Required Description
customer_id string false none
account_id string false none
attributes object false none
» document_expiration_date string(date) false none
» employment Employment false none

Employment

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

{
  "activity_country_code": "st",
  "company": "string",
  "income": 9999999999999.99,
  "income_source": {
    "id": 999999999,
    "observations": "string"
  },
  "profession": 999999999,
  "professional_area": 999999999,
  "professional_use": true
}
Name Type Required Description
activity_country_code string false none
company string false none
income number(double) false none
income_source object false none
» id integer false none
» observations string false none
profession integer false none
professional_area integer false none
professional_use boolean false none

Device

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51

{
  "device_details": {
    "id": 0,
    "model_id": "string",
    "cession_price": 999999999.99,
    "imei": "string",
    "pending_imei": true,
    "insured_amount": 0.01,
    "category": "string",
    "logistic_required": true,
    "catalogue_id": "string",
    "amount": 0.01
  },
  "fees": {
    "upfront_fee": 999999999.99,
    "installment_plan": {
      "commission": 999999999.99,
      "tae": 999999999.99,
      "tin": 999999999.99,
      "duration": 1,
      "monthly_fee": 999999999.99,
      "last_installment_fee": 999999999.99,
      "discount_final_payment_value": 999999999.99,
      "is_promotional_renew": true
    }
  },
  "financial_details": {
    "pre_booking": {
      "order_id": "string",
      "authorization_id": "string",
      "financial_entity": "string",
      "status": "Accepted",
      "granted_amount": 999999999,
      "credit_line_amount": 999999999,
      "total_client_financed_value": 999999999.99
    },
    "consents": {
      "commercial": true,
      "gdpr": true
    }
  },
  "campaign_id": 0,
  "terms": {
    "penalty_value": 999999999.99,
    "commitment_duration": 9999
  },
  "reservation_id": "string",
  "signature_process_id": 0,
  "signature_type": "PAPER",
  "old_subscription_terminal_id": 0
}
Name Type Required Description
device_details object true none
» id integer true Catalogue instance id
» model_id string true Catalogue device id
» cession_price number(double) false none
» imei string false none
» pending_imei boolean false none
» insured_amount number(double)¦null false none
» category string¦null false none
» logistic_required boolean¦null false none
» catalogue_id string¦null false none
» amount number(double)¦null false none
fees object true none
» upfront_fee number(double) true none
» installment_plan object false none
»» commission number(double) false none
»» tae number(double) false none
»» tin number(double) false none
»» duration integer false none
»» monthly_fee number(double) false none
»» last_installment_fee number(double) false none
»» discount_final_payment_value number(double)¦null false none
»» is_promotional_renew boolean¦null false none
financial_details object false none
» pre_booking object false none
»» order_id string false none
»» authorization_id string false none
»» financial_entity string false none
»» status string false none
»» granted_amount integer(int64) false none
»» credit_line_amount integer(int64) false none
»» total_client_financed_value number(double) false none
» consents object false none
»» commercial boolean false none
»» gdpr boolean false none
campaign_id integer false none
terms object false none
» penalty_value number(double) false none
» commitment_duration integer false none
reservation_id string true none
signature_process_id number(int64) false none
signature_type string¦null false none
old_subscription_terminal_id integer(int64)¦null false none
Property Values
status one of [Accepted, Rejected]
signature_type one of [PAPER, OTP, BIOMETRIC, UNKNOWN]

AddDeviceToSubscriptionResponse

1
2
3
4

{
  "risk_decision": "string",
  "subscription_terminal_id": 0
}
Name Type Required Description
risk_decision string false none
subscription_terminal_id number(int64) false none

ChangeSubscriptionProductResponse

1
2
3

{
  "risk_decision": "string"
}
Name Type Required Description
risk_decision string false none

SimReplacementResponse

1
2
3

{
  "risk_decision": "string"
}
Name Type Required Description
risk_decision string false none

GetAccountContractsResponse

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20

{
  "contracts": [
    {
      "account_bundle_id": 214748364,
      "account_id": 0,
      "pdf_file_name": "string",
      "document_id": "string",
      "digital_signature_origin_id": "string",
      "ineid": "string",
      "iccid": "string",
      "ccggid": "string",
      "subscription_id": 214748364,
      "subscription_terminal_id": 214748364,
      "process_id": "string",
      "status": "string",
      "signed_document_id": "string",
      "contract_id": "9aafc1a8-e497-46c9-ba0b-bd5b03c353e4"
    }
  ]
}
Name Type Required Description
contracts [object] false none
» account_bundle_id integer(int64) false none
» account_id integer(int64) false none
» pdf_file_name string false none
» document_id string false none
» digital_signature_origin_id string false none
» ineid string false none
» iccid string false none
» ccggid string false none
» subscription_id integer(int64) false none
» subscription_terminal_id integer(int64) false none
» process_id string false none
» status string false none
» signed_document_id string false none
» contract_id string(uuid) false none
Schemas