GET api/cadastro/{idcadastro}/getConexaoCobranca
Obtém os dados da conexão e cobrança
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
idcadastro |
Código do cliente |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
CadastroConexaoName | Description | Type | Additional information |
---|---|---|---|
cadastro_encerrado |
(*) True indica que o cadastro está encerrado |
boolean |
Required |
cadastro_encerrado_data |
Data de encerramento do cadastro ou em branco se não estiver encerrado |
string |
Required |
bloqueado |
True indica que a conexão está bloqueada |
boolean |
Required |
bloqueado_data |
Data de bloqueio da conexão ou em branco |
string |
Required |
username |
(*) Username para conexão |
string |
Required |
senha |
(*) Senha para conexão |
string |
Required |
ipfixo |
IP Fixo para conexão (IPv4) |
string |
Required |
mac |
Endereço MAC do cliente (ONU/Equipamento de rádio) |
string |
Required |
rota |
Rota adicional enviada para o cliente (p/ empresa) |
string |
Required |
dslam_codigo |
Código do DSLAM (Digital Subscriber Line Access Multiplexe) |
integer |
Required |
dslam_nome |
Nome do DSLAM |
string |
Required |
dslam_porta |
Porta do DSLAM utilizada pelo cliente |
string |
Required |
servidor_nas |
Servidor em que o cliente está conectado |
string |
None. |
equipamento_codigo |
(*) Código do tipo de equipamento instalado no cliente |
integer |
Required |
equipamento_nome |
(*) Nome do tipo de equipamento instalado no cliente (getKitEquipamento) |
string |
Required |
plano_codigo |
(*) Código do plano contratado |
integer |
Required |
plano_nome |
(*) Nome do plano |
string |
Required |
plano_valor |
Valor do plano |
decimal number |
None. |
fibra_cto_codigo |
Código da CTO |
integer |
None. |
fibra_cto_nome |
Nome da CTO |
string |
None. |
fibra_cto_porta |
Porta da CTO |
string |
None. |
fibra_olt_codigo |
Código da OLT |
integer |
None. |
fibra_olt_nome |
Nome da OLT |
string |
None. |
fibra_olt_porta |
Porta da OLT |
string |
None. |
fibra_olt_slot |
Slot da OLT |
string |
None. |
fibra_olt_posicao |
Posição na OLT |
string |
None. |
fibra_onu_ip |
Endereço IP da ONU |
string |
None. |
fibra_onu_serial |
Serial da ONU |
string |
None. |
is_gratuito |
True indica que o cliente não paga pelo serviço |
boolean |
Required |
is_permuta |
True indica que o cliente possui permuta |
boolean |
Required |
is_carne_interno |
True indica que a cobrança é por carnê interno |
boolean |
Required |
is_cobranca_interna |
True indica que o cliente pagará nas lojas do provedor |
boolean |
Required |
dia_vencimento |
(*) Dia do vencimento da cobrança: 5, 10, 15, 20, 25 |
integer |
Required |
banco_cobranca |
Banco de cobrança da mensalidade. Padrão: 237 |
integer |
Required |
valor_mensal |
Valor mensal a ser cobrado por um determinado período (de 1 até 6 meses) |
decimal number |
Required |
valor_mensal_meses |
Indica por quantos meses será cobrado o valor mensal (0=mensal, 1=por um mês, 2=por dois meses, ..., 6=por seis meses) |
integer |
Required |
valor_ip_fixo |
Valor do IP fixo (IPv4) |
decimal number |
Required |
is_boleto_via_email |
True indica que o boleto também será enviado via e-mail |
boolean |
Required |
is_fatura_online |
True indica que o boleto será somente online, não será entregue pelos correios |
boolean |
Required |
fonte_pagadora_codigo |
Código do Pgp que receberá a cobrança deste cliente |
integer |
Required |
fonte_pagadora_nome |
Nome do cliente que receberá a cobrança deste cliente |
string |
Required |
conexao_suspensa |
True indica que a conexão está suspensa por um determinado período (não gera cobrança) |
boolean |
Required |
conexao_suspensa_datainicial |
Data inicial da suspensão da conexão |
string |
Required |
conexao_suspensa_datafinal |
Data final da suspensão da conexão |
string |
Required |
pagrec_numero_cartao |
Número do cartão (crédito ou débito) para pagamento da mensalidade |
string |
None. |
pagrec_vencimento |
Data de vencimento do cartão, mês com dois dígitos e ano com dois dígitos (mmyy) |
string |
None. |
pagrec_nome_titular |
Nome do titular do cartão |
string |
None. |
pagrec_tipo_titular |
0=Em branco, 1=O Próprio, 2=Terceiro |
integer |
None. |
pagrec_cpf_titular |
Cpf do titular do cartão |
string |
None. |
valores_subtotal |
Subtotal da mensalidade (mensalidade + ip fixo) |
decimal number |
None. |
valores_wifi |
Valor cobrado pelo uso de roteador wifi |
decimal number |
None. |
valores_dependentes |
Valor dos cadastros dependentes deste cliente (fonte pagadora) |
decimal number |
None. |
valores_dependentes_qde |
Quantidade de cadastros dependentes |
integer |
None. |
valores_totalmensal |
Valor total da mensalidade (subtotal + wifi + dependentes) |
decimal number |
None. |
pode_desbloquear |
Indica se o operador pode desbloquear a conexão |
boolean |
None. |
pode_alterar_plano |
Indica se o operador pode alterar o plano/banda |
boolean |
None. |
pode_gravar |
Indica se o operador pode gravar/alterar os dados |
boolean |
None. |
idcombo |
Código do combo |
integer |
None. |
Response Formats
application/json, text/json
{ "cadastro_encerrado": true, "cadastro_encerrado_data": "sample string 2", "bloqueado": true, "bloqueado_data": "sample string 4", "username": "sample string 5", "senha": "sample string 6", "ipfixo": "sample string 7", "mac": "sample string 8", "rota": "sample string 9", "dslam_codigo": 10, "dslam_nome": "sample string 11", "dslam_porta": "sample string 12", "servidor_nas": "sample string 13", "equipamento_codigo": 14, "equipamento_nome": "sample string 15", "plano_codigo": 16, "plano_nome": "sample string 17", "plano_valor": 18.0, "fibra_cto_codigo": 19, "fibra_cto_nome": "sample string 20", "fibra_cto_porta": "sample string 21", "fibra_olt_codigo": 22, "fibra_olt_nome": "sample string 23", "fibra_olt_porta": "sample string 24", "fibra_olt_slot": "sample string 25", "fibra_olt_posicao": "sample string 26", "fibra_onu_ip": "sample string 27", "fibra_onu_serial": "sample string 28", "is_gratuito": true, "is_permuta": true, "is_carne_interno": true, "is_cobranca_interna": true, "dia_vencimento": 33, "banco_cobranca": 34, "valor_mensal": 35.0, "valor_mensal_meses": 36, "valor_ip_fixo": 37.0, "is_boleto_via_email": true, "is_fatura_online": true, "fonte_pagadora_codigo": 40, "fonte_pagadora_nome": "sample string 41", "conexao_suspensa": true, "conexao_suspensa_datainicial": "sample string 43", "conexao_suspensa_datafinal": "sample string 44", "pagrec_numero_cartao": "sample string 45", "pagrec_vencimento": "sample string 46", "pagrec_nome_titular": "sample string 47", "pagrec_tipo_titular": 48, "pagrec_cpf_titular": "sample string 49", "valores_subtotal": 50.0, "valores_wifi": 51.0, "valores_dependentes": 52.0, "valores_dependentes_qde": 53, "valores_totalmensal": 54.0, "pode_desbloquear": true, "pode_alterar_plano": true, "pode_gravar": true, "idcombo": 58 }
application/xml, text/xml
<CadastroConexao xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/api_pgp"> <banco_cobranca>34</banco_cobranca> <bloqueado>true</bloqueado> <bloqueado_data>sample string 4</bloqueado_data> <cadastro_encerrado>true</cadastro_encerrado> <cadastro_encerrado_data>sample string 2</cadastro_encerrado_data> <conexao_suspensa>true</conexao_suspensa> <conexao_suspensa_datafinal>sample string 44</conexao_suspensa_datafinal> <conexao_suspensa_datainicial>sample string 43</conexao_suspensa_datainicial> <dia_vencimento>33</dia_vencimento> <dslam_codigo>10</dslam_codigo> <dslam_nome>sample string 11</dslam_nome> <dslam_porta>sample string 12</dslam_porta> <equipamento_codigo>14</equipamento_codigo> <equipamento_nome>sample string 15</equipamento_nome> <fibra_cto_codigo>19</fibra_cto_codigo> <fibra_cto_nome>sample string 20</fibra_cto_nome> <fibra_cto_porta>sample string 21</fibra_cto_porta> <fibra_olt_codigo>22</fibra_olt_codigo> <fibra_olt_nome>sample string 23</fibra_olt_nome> <fibra_olt_porta>sample string 24</fibra_olt_porta> <fibra_olt_posicao>sample string 26</fibra_olt_posicao> <fibra_olt_slot>sample string 25</fibra_olt_slot> <fibra_onu_ip>sample string 27</fibra_onu_ip> <fibra_onu_serial>sample string 28</fibra_onu_serial> <fonte_pagadora_codigo>40</fonte_pagadora_codigo> <fonte_pagadora_nome>sample string 41</fonte_pagadora_nome> <idcombo>58</idcombo> <ipfixo>sample string 7</ipfixo> <is_boleto_via_email>true</is_boleto_via_email> <is_carne_interno>true</is_carne_interno> <is_cobranca_interna>true</is_cobranca_interna> <is_fatura_online>true</is_fatura_online> <is_gratuito>true</is_gratuito> <is_permuta>true</is_permuta> <mac>sample string 8</mac> <pagrec_cpf_titular>sample string 49</pagrec_cpf_titular> <pagrec_nome_titular>sample string 47</pagrec_nome_titular> <pagrec_numero_cartao>sample string 45</pagrec_numero_cartao> <pagrec_tipo_titular>48</pagrec_tipo_titular> <pagrec_vencimento>sample string 46</pagrec_vencimento> <plano_codigo>16</plano_codigo> <plano_nome>sample string 17</plano_nome> <plano_valor>18</plano_valor> <pode_alterar_plano>true</pode_alterar_plano> <pode_desbloquear>true</pode_desbloquear> <pode_gravar>true</pode_gravar> <rota>sample string 9</rota> <senha>sample string 6</senha> <servidor_nas>sample string 13</servidor_nas> <username>sample string 5</username> <valor_ip_fixo>37</valor_ip_fixo> <valor_mensal>35</valor_mensal> <valor_mensal_meses>36</valor_mensal_meses> <valores_dependentes>52</valores_dependentes> <valores_dependentes_qde>53</valores_dependentes_qde> <valores_subtotal>50</valores_subtotal> <valores_totalmensal>54</valores_totalmensal> <valores_wifi>51</valores_wifi> </CadastroConexao>