Informaes Bsicas

Sistema

NG

Operao
Descrio funcional

consultaDadosCliente

Nome Funcional

Descrio

Operao disponibilizada pelo NG para consultar os dados de um cliente dado o nmero do contrato, ou o CPF/CNPJ ou o nmero de telefone
Tipo

Tamanho Domnio

Obrigatrio

Campos de Entrada
Nmero contrato
CPF/CNPJ
Nmero Telefone

Nmero do contrato

No

Numrico

CPF/CNPJ do titular do contrato j validado pelo algoritmo padro, sem mscara e

sem formatao (apenas os nmeros)
DDD (dois dgitos) + nmero do telefone (8 ou 9 dgitos). Somente os nmeros,
sem espaos

Alfanumrico

15

Alfanumrico

11

No
No
Campos de Sada

Codigo do retorno

Indica se a consulta foi realizada com sucesso/insucesso

Alfanumrico

Descrio do Retorno

Descrio do retorno da operao

Alfanumrico

Sim
Sim

Detalhe do retorno

Detalhe do erro/sucesso da operao

Alfanumrico

No

CPF/CNPJ

CPF/CNPJ do titular do contrato

Alfanumrico

15

Nmero Contrato

Nmero do contrato

Status Contrato

Cdigo do status do contrato

Adimplente

Se o contrato est ou no adimplente

Tipo cliente

Tipo do cliente PF ou PJ

Contrato

No
Sim

Numrico
Alfanumrico

Sim
A, AA, AC, AE, AF, AH, AI, AX, AZ, C, CE, CI, CR, CX, D, DE, DP, DS, DX, EC, ED, EH, ES, FR, H, HA, HD, HP, OS, P, PA, PR, RT, RV, S, SC, SF, SP, TR

Sim

Boolean

Sim

Alfanumrico

Sim

Cidade de instalao Cidade do endereo de instalao do contrato

Alfanumrico

Sim

CEP de instalao

CEP do endereo de instalao do contrato

Alfanumrico

Sim

Data adeso

Data da venda do contrato

Data

Sim

Primeiro atendimentoSe existe um registro de atendimento para o contrato

Boolean

Sim

Email

Email do dono do contrato

Alfanumrico

No

Celular envio SMS

DDD + Nmero do telefone celular marcado para envio de SMS

Alfanumrico

No

Plano[@]

Sim

Plano contratado Nome do plano contratado pelo contrato

Alfanumrico

Cdigos Retorno
Codigo do retorno

0
1
2
3

Descrio do Retorno

Detalhe do retorno

SUCESSO
ERRO
Consulta retornou mais de um registro
Consulta no retornou nenhum registro

Erro genrico: descrio funcional do erro, ou erro inesperado

Foi encontrado mais de um registro para a consulta
No foi encontrado nenhum registro para a consulta

Sim

Informaes Bsicas
Sistema

NG

Operao
Descrio funcional

geraProtocoloAtendimento

Nome Funcional

Descrio

Operao disponibilizada pelo NG para gerar um registro de atendimento com nmero de protocolo para o contrato
Tipo

Tamanho Domnio Obrigatrio

Campos de Entrada
Nmero Contrato

Nmero do contrato

CPF/CNPJ

CPF/CNPJ do titular do contrato

Alfanumrico

Numrico
15

No
No

Nmero Telefone

Telefone cadastrado no contrato. DDD (dois dgitos) + nmero do

telefone (8 ou 9 dgitos). Somente os nmeros, sem espaos

Alfanumrico

11

No

Sim

Campos de Sada
Codigo do retorno

Indica se a operao foi realizada com sucesso/insucesso

Alfanumrico

Descrio do Retorno

Descrio do retorno da operao

Alfanumrico

Sim

Detalhe do retorno

Detalhe do erro/sucesso da operao

Alfanumrico

No

Nmero Protocolo

Nmero do Protocolo gerado

Alfanumrico

No

Cdigos Retorno
Codigo do retorno

0
1

Descrio do Retorno

Detalhe do retorno

SUCESSO
ERRO

Erro genrico: descrio funcional do erro, ou erro inesperado

Informaes Bsicas
Sistema
Operao
Descrio funcional

NG

Nome Funcional

Descrio

consultaIndisponibilidadeDeServico
Operao disponibilizada pelo NG para consultar se o contrato possui alguma indisponibilidade de servio
Tipo

Tamanho Domnio Obrigatrio

Campos de Entrada
Nmero Contrato

Nmero do contrato

Numrico

Sim

Campos de Sada
Codigo do retorno

Indica se a operao foi realizada com sucesso/insucesso

Alfanumrico

Descrio do Retorno

Descrio do retorno da operao

Alfanumrico

Sim

Detalhe do retorno

Detalhe do erro/sucesso da operao

Alfanumrico

No

Indisponibilidade[@]
Previso soluo

Sim

No
Data prevista para a resoluo do problema

Data

Sim

Cdigos Retorno
Codigo do retorno

0
1

Descrio do Retorno

Detalhe do retorno

SUCESSO
ERRO

Erro genrico: descrio funcional do erro, ou erro inesperado

Informaes Bsicas
Sistema

NG

Operao

consultaVisitaTecnicaEmAberto

Descrio funcional

Operao disponibilizada pelo NG para consultar se o contrato possui uma visita tcnica em aberto

Nome Funcional

Descrio

Tipo

Tamanho Domnio

Obrigatrio

Campos de Entrada
Nmero Contrato

Nmero do contrato

Numrico

Sim

Campos de Sada
Codigo do retorno

Indica se a operao foi realizada com sucesso/insucesso

Alfanumrico

Descrio do Retorno

Descrio do retorno da operao

Alfanumrico

Sim
Sim

Detalhe do retorno

Detalhe do erro/sucesso da operao

Alfanumrico

No

Visita[@]

No

Nmero Visita

Nmero da OS Externa

Numrico

Ocorrncia Visita

Nmero da ocorrncia OS Externa

Numrico

Status Visita

Cdigo do status da OS Externa

Alfanumrico

Motivo Visita

Motivo da OS Externa

Alfanumrico

Sim

Data

No

Data agendamentoData para a qual a OS foi agendada

Sim
Sim
AA, AE, AG, AI, AO, BN, BP, BT, C, EE, EF, EX, ND

Cdigos Retorno
Codigo do retorno

0
1

Descrio do Retorno

Detalhe do retorno

SUCESSO
ERRO

Erro genrico: descrio funcional do erro, ou erro inesperado

Sim

Informaes Bsicas
Sistema

NG

Operao
Descrio funcional

confirmaAgendamentoVisitaTecnica

Nome Funcional

Descrio

Operao disponibilizada pelo NG para confirmar a data para a qual a visita est agendada. Gera um registro de atendimento
para a operao, associado ao nmero de protocolo passado
Tipo

Tamanho Domnio Obrigatrio

Campos de Entrada
Nmero Visita

Nmero da OS Externa

Ocorrncia Visita

Nmero da ocorrncia OS Externa

Nmero Protocolo

Nmero do protocolo

Numrico

Sim

Numrico

Sim

Alfanumrico

Sim

Campos de Sada
Codigo do retorno

Indica se a operao foi realizada com sucesso/insucesso

Alfanumrico

Sim

Descrio do Retorno

Descrio do retorno da operao

Alfanumrico

Sim

Detalhe do retorno

Detalhe do erro/sucesso da operao

Alfanumrico

No

Cdigos Retorno
Codigo do retorno

0
1

Descrio do Retorno

Detalhe do retorno

SUCESSO
ERRO

Erro genrico: descrio funcional do erro, ou erro inesperado

Informaes Bsicas
Sistema

NG

Operao
Descrio funcional

cancelaVisitaTecnica

Nome Funcional

Descrio

Operao disponibilizada pelo NG para cancelar uma visita tcnica. Gera um registro de atendimento para a operao,
associado ao nmero de protocolo passado
Tipo

Tamanho Domnio Obrigatrio

Campos de Entrada
Nmero Visita

Nmero da OS Externa

Ocorrncia Visita

Nmero da ocorrncia OS Externa

Nmero Protocolo

Nmero do protocolo

Numrico

Sim

Numrico

Sim

Alfanumrico

Sim

Campos de Sada
Codigo do retorno

Indica se a operao foi realizada com sucesso/insucesso

Alfanumrico

Sim

Descrio do Retorno

Descrio do retorno da operao

Alfanumrico

Sim

Detalhe do retorno

Detalhe do erro/sucesso da operao

Alfanumrico

No

Cdigos Retorno
Codigo do retorno

0
1

Descrio do Retorno

Detalhe do retorno

SUCESSO
ERRO

Erro genrico: descrio funcional do erro, ou erro inesperado

Informaes Bsicas
Sistema

NG

Operao
Descrio funcional

consultaDescontoPorIndisponibilidadeDeServico

Nome Funcional

Descrio

Operao disponibilizada pelo NG para consultar se o contrato possui algum desconto por indisponibilidade de servio a ser
concedido na prxima fatura
Tipo

Tamanho Domnio Obrigatrio

Campos de Entrada
Nmero Contrato

Nmero do contrato

Numrico

Sim

Campos de Sada
Codigo do retorno

Indica se a operao foi realizada com sucesso/insucesso

Alfanumrico

Sim

Descrio do Retorno

Descrio do retorno da operao

Alfanumrico

Sim

Detalhe do retorno

Detalhe do erro/sucesso da operao

Alfanumrico

No

Valor Total Desconto

Soma dos valores de todos os descontos por indisponibilidade

Numrico

Sim

Cdigos Retorno
Codigo do retorno

0
1

Descrio do Retorno

Detalhe do retorno

SUCESSO
ERRO

Erro genrico: descrio funcional do erro, ou erro inesperado

Informaes Bsicas
Sistema

NG

Operao
Descrio funcional

consultaPromocoesPrestesAExpirar

Nome Funcional

Descrio

Operao disponibilizada pelo NG para consultar os descontos de promoes prestes a expirar de um contrato
Tipo

Tamanho Domnio Obrigatrio

Campos de Entrada
Nmero Contrato

Nmero do contrato

Numrico

No

Campos de Sada
Codigo do retorno

Indica se a operao foi realizada com sucesso/insucesso

Alfanumrico

Sim

Descrio do Retorno

Descrio do retorno da operao

Alfanumrico

Sim

Detalhe do retorno

Detalhe do erro/sucesso da operao

Alfanumrico

No

Promoo[@]
Data fim

No
Data fim do desconto da promoo

Data

Sim

Cdigos Retorno
Codigo do retorno

0
1

Descrio do Retorno

Detalhe do retorno

SUCESSO
ERRO

Erro genrico: descrio funcional do erro, ou erro inesperado

Sistema
Operao

NG

Descrio funcional

Operao disponibilizada pelo NG para consultar a ltima fatura de um contrato. Gera um registro de atendimento para a
operao, associado ao nmero de protocolo passado

Nome Funcional

Descrio

consultaUltimaFatura

Tipo

Tamanho Domnio Obrigatrio

Campos de Entrada
Nmero Contrato

Nmero do Contrato

Nmero Protocolo

Nmero do protocolo

Numrico

Sim

Alfanumrico

Sim

Campos de Sada
Codigo do retorno

Indica se a consulta foi realizada com sucesso/insucesso

Alfanumrico

Sim

Descrio do Retorno

Descrio do retorno da operao

Alfanumrico

Sim

Detalhe do retorno

Detalhe do erro/sucesso da operao

Alfanumrico

No

Extrato

Nmero
Data
Extrato
venciment
Valor
o
Data
Extrato
Pagament
o

No
Nmero do extrato
Data de vencimento do extrato
Valor do extrato
Data de pagamento do extrato

Numrico

Sim

Data

Sim

Numrico

Sim

Data

No

Cdigos Retorno
Codigo do retorno

0
1

Descrio do Retorno

Detalhe do retorno

SUCESSO
ERRO

Erro genrico: descrio funcional do erro, ou erro inesperado

Informaes Bsicas
Sistema
Operao

NG

Descrio funcional

Operao disponibilizada pelo NG para solicitar a segunda via da ltima fatura em aberto de um contrato. Gera um registro de
atendimento para a operao, associado ao nmero de protocolo passado

Nome Funcional

Descrio

solicitaSegundaViaUltimaFaturaEmAberto

Tipo

Tamanho Domnio

Obrigatrio

Campos de Entrada
Nmero Contrato

Nmero do Contrato

Numrico

Sim

Nmero Protocolo

Nmero do Protocolo

Alfanumrico

Sim

Forma Envio

Indica se a fatura ser enviado pelo cliente por email ou SMS

Alfanumrico

Email; SMS

Sim

Campos de Sada
Codigo do retorno

Indica se a consulta foi realizada com sucesso/insucesso

Alfanumrico

Sim

Descrio do Retorno

Descrio do retorno da operao

Alfanumrico

Sim

Detalhe do retorno

Detalhe do erro/sucesso da operao

Alfanumrico

No

Cdigos Retorno
Codigo do retorno

0
1

Descrio do Retorno

Detalhe do retorno

SUCESSO
ERRO

Erro genrico: descrio funcional do erro, ou erro inesperado

Informaes Bsicas
Sistema

NG

Operao
Descrio funcional

solicitaLinhaDigitavelUltimaFaturaEmAberto

Nome Funcional

Descrio

Operao disponibilizada pelo NG para solicitar a linha digitvel da ltima fatura em aberto de um contrato. Gera um registro de
atendimento para a operao, associado ao nmero de protocolo passado
Tipo

Tamanho Domnio Obrigatrio

Campos de Entrada
Nmero Contrato

Nmero do Contrato

Numrico

Sim

Nmero Protocolo

Nmero do Protocolo

Alfanumrico

Sim

Campos de Sada
Codigo do retorno

Indica se a consulta foi realizada com sucesso/insucesso

Alfanumrico

Sim

Descrio do Retorno

Descrio do retorno da operao

Alfanumrico

Sim

Detalhe do retorno

Detalhe do erro/sucesso da operao

Alfanumrico

No

Linha digitvel

Numerao do cdigo de barras da fatura

Alfanumrico

No

Cdigos Retorno
Codigo do retorno

0
1

Descrio do Retorno

Detalhe do retorno

SUCESSO
ERRO

Erro genrico: descrio funcional do erro, ou erro inesperado

Informaes Bsicas
Sistema

NG

Operao
Descrio funcional

consultaConsumoCota

Nome Funcional

Descrio

Operao disponibilizada pelo NG para consultar o consumo de cota de um contrato. Retorna os consumos de cada ponto
instalado e no finalizado do contrato. O consumo ser informado em gigabytes, com preciso de uma casa decimal. Gera um
registro de atendimento para a operao, associado ao nmero de protocolo passado
Tipo

Tamanho Domnio Obrigatrio

Campos de Entrada
Nmero Contrato

Nmero do contrato

Nmero Protocolo

Nmero do Protocolo

Numrico

Sim

Alfanumrico

Sim

Campos de Sada
Codigo do retorno

Indica se a operao foi realizada com sucesso/insucesso

Alfanumrico

Sim

Descrio do Retorno

Descrio do retorno da operao

Alfanumrico

Sim

Detalhe do retorno

Detalhe do erro/sucesso da operao

Alfanumrico

No

Consumo[@]

No

Id Ponto

Nmero identificador do ponto

Numrico

Sim

Plano

Identificador do plano do ponto

Numrico

Sim

Cota Total

Cota mensal total do plano contratado

Numrico

Sim

Cota Consumida

Cota consumida at o momento, desde o incio do ms

Numrico

Sim

Cota Restante

Cota que resta para consumir

Numrico

Sim

Cdigos Retorno
Codigo do retorno

0
1

Descrio do Retorno

Detalhe do retorno

SUCESSO
ERRO

Erro genrico: descrio funcional do erro, ou erro inesperado

Informaes Bsicas
Sistema

NG

Operao
Descrio funcional

consultaCotasExtrasDisponiveisParaContrato

Nome Funcional

Descrio

Operao disponibilizada pelo NG para consultar as cotas extras disponveis para o contrato. Somente sero retornados
produtos se o contrato possuir apenas um ponto habilitado
Tipo

Tamanho Domnio Obrigatrio

Campos de Entrada
Nmero Contrato

Nmero do Contrato

Numrico

Sim

Campos de Sada
Codigo do retorno

Indica se a consulta foi realizada com sucesso/insucesso

Alfanumrico

Descrio do Retorno

Descrio do retorno da operao

Alfanumrico

Sim

Detalhe do retorno

Detalhe do erro/sucesso da operao

Alfanumrico

No

Produto[@]

Identificad
Nmero identificador da Cota Extra
or
Nome
Nome da Cota Extra
Valor

Preo da Cota Extra

Sim

No
Numrico
Alfanumrico
Numrico

Sim
-

Sim
Sim

Cdigos Retorno
Codigo do retorno

0
1

Descrio do Retorno

Detalhe do retorno

SUCESSO
ERRO

Erro genrico: descrio funcional do erro, ou erro inesperado

Informaes Bsicas
Sistema

NG

Operao
Descrio funcional

geraEEnviaSenhaAutorizacaoCompraAutomtica

Nome Funcional

Descrio

Operao disponibilizada pelo NG para gerar uma senha para autorizao de compra automtica de cota extra, e enviar a
senha por SMS para o celular cadastrado do cliente, marcado para envio de SMS
Tipo

Tamanho Domnio Obrigatrio

Campos de Entrada
Nmero Contrato

Nmero do contrato

Numrico

Sim

Campos de Sada
Codigo do retorno

Indica se a operao foi realizada com sucesso/insucesso

Alfanumrico

Descrio do Retorno

Descrio do retorno da operao

Alfanumrico

Sim
Sim

Detalhe do retorno

Detalhe do erro/sucesso da operao

Alfanumrico

No

Cdigos Retorno
Codigo do retorno

0
1

Descrio do Retorno

Detalhe do retorno

SUCESSO
ERRO

Erro genrico: descrio funcional do erro, ou erro inesperado

Informaes Bsicas
Sistema

NG

Operao
Descrio funcional

validaSenhaAutorizacaoCompraAutomtica

Nome Funcional

Descrio

Operao disponibilizada pelo NG para validar a senha informada de autorizao de compra automtica de cota extra
Tipo

Tamanho Domnio Obrigatrio

Campos de Entrada
Nmero Contrato

Nmero do contrato

Numrico

Sim

Senha

Senha

Numrico

Sim

Campos de Sada
Codigo do retorno

Indica se a operao foi realizada com sucesso/insucesso

Alfanumrico

Descrio do Retorno

Descrio do retorno da operao

Alfanumrico

Sim
Sim

Detalhe do retorno

Detalhe do erro/sucesso da operao

Alfanumrico

No

Cdigos Retorno
Codigo do retorno

0
1
2

Descrio do Retorno

Detalhe do retorno

SUCESSO
ERRO
Senha incorreta

Erro genrico: descrio funcional do erro, ou erro inesperado

Senha informada no corresponde esperada pelo sistema

Informaes Bsicas
Sistema
Operao
Descrio funcional

NG

Nome Funcional

Descrio

compraCotaExtraParaContrato
Operao disponibilizada pelo NG para comprar uma cota extra para o contrato. Somente ser efetuada a compra se o
contrato possuir apenas um ponto habilitado. Gera um registro de atendimento para a operao, associado ao nmero de
protocolo passado
Tipo

Tamanho Domnio Obrigatrio

Campos de Entrada
Nmero Contrato

Nmero do Contrato

Numrico

Identificador Produto

Nmero identificador da Cota Extra

Numrico

Sim
Sim

Nmero Protocolo

Nmero do Protocolo

Alfanumrico

No

Campos de Sada
Codigo do retorno

Indica se a consulta foi realizada com sucesso/insucesso

Alfanumrico

Descrio do Retorno

Descrio do retorno da operao

Alfanumrico

Sim
Sim

Detalhe do retorno

Detalhe do erro/sucesso da operao

Alfanumrico

No

Cdigos Retorno
Codigo do retorno

0
1

Descrio do Retorno

Detalhe do retorno

SUCESSO
ERRO

Erro genrico: descrio funcional do erro, ou erro inesperado

Informaes Bsicas
Sistema

NG

Operao
Descrio funcional

consultaMultaCompromissoPermanencia

Nome Funcional

Descrio

Operao disponibilizada pelo NG para consultar a multa por quebra de compromisso de permanncia gerada em caso do
cancelamento do contrato
Tipo

Tamanho Domnio Obrigatrio

Campos de Entrada
Nmero Contrato

Nmero do Contrato

Numrico

Sim

Campos de Sada
Codigo do retorno

Indica se a consulta foi realizada com sucesso/insucesso

Alfanumrico

Sim

Descrio do Retorno

Descrio do retorno da operao

Alfanumrico

Sim

Detalhe do retorno

Detalhe do erro/sucesso da operao

Alfanumrico

No

Valor Total Multa

Soma dos valores de todas as multas

Numrico

Sim

Multa[@]

No
Tipo Multa Tipo da multa gerada
Descrio
Descrio da multa
Multa
Valor
Valor da multa
Multa

Alfanumrico
Alfanumrico
Numrico

Sim
-

Sim
Sim

Cdigos Retorno
Codigo do retorno

0
1

Descrio do Retorno

Detalhe do retorno

SUCESSO
ERRO

Erro genrico: descrio funcional do erro, ou erro inesperado

Informaes Bsicas
Sistema

NG

Operao
Descrio funcional

solicitaCancelamentoContrato

Nome Funcional

Descrio

Operao disponibilizada pelo NG para solicitar o cancelamento de um contrato. Gera um registro de atendimento para a
operao, associado ao nmero de protocolo passado
Tipo

Tamanho Domnio Obrigatrio

Campos de Entrada
Nmero Contrato

Nmero do Contrato

Numrico

Sim

Nmero Protocolo

Nmero do Protocolo

Numrico

Sim

Campos de Sada
Codigo do retorno

Indica se a consulta foi realizada com sucesso/insucesso

Alfanumrico

Descrio do Retorno

Descrio do retorno da operao

Alfanumrico

Sim
Sim

Detalhe do retorno

Detalhe do erro/sucesso da operao

Alfanumrico

No

Cdigos Retorno
Codigo do retorno

0
1

Descrio do Retorno

Detalhe do retorno

SUCESSO
ERRO

Erro genrico: descrio funcional do erro, ou erro inesperado

Informaes Bsicas
Sistema

NG

Operao
Descrio funcional

finalizaAtendimento

Nome Funcional

Descrio

Operao disponibilizada pelo NG para finalizar o atendimento associado ao protocolo enviado

Tipo

Tamanho Domnio Obrigatrio

Campos de Entrada
Nmero Protocolo

Nmero do Protocolo

Alfanumrico

Sim

Campos de Sada
Codigo do retorno

Indica se a consulta foi realizada com sucesso/insucesso

Alfanumrico

Sim

Descrio do Retorno

Descrio do retorno da operao

Alfanumrico

Sim

Detalhe do retorno

Detalhe do erro/sucesso da operao

Alfanumrico

No

Cdigos Retorno
Codigo do retorno

0
1

Descrio do Retorno

Detalhe do retorno

SUCESSO
ERRO

Erro genrico: descrio funcional do erro, ou erro inesperado

Informaes Bsicas
Sistema
Status de Contrato

NG

Sigla

Descrio
A

Ativado

AA

Aguardando Ativao

AC

Em Anlise de Crdito

AE

Aguardando Conferncia Endereo

AF

Em Anlise de Fraude

AH

Aguard. Habilitao

AI

Aguardando Instalao

AX

Aguardando Liberao CRM Externo

AZ

Aguardando Aceite

Cancelado Espontaneamente

CE

Cancelado por Inadimplncia com Equipamento

CI

Cancelado por Inadimplncia

CR

Crdito Reprovado

CX

Cancelado Por Inadimplncia CRM Externo

Desabilitado

DE

Em Desistncia

DP

Desabilitado Parcialmente

DS

Desistente

DX

Desabilitado CRM Externo

EC

Em Cancelamento

ED

Em Desabilitao

EH

Em Reabilitao

ES

Em Suspenso

FR

Fraude

Habilitado

HA

Habilitado Cobrana Avulsa

HD

Habilitado Temporariamente

HP

Habilitado Parcialmente

OS

Proposta Suspensa

Proposta

PA

Pendente Aprovisionamento

PR

Proposta Recusada

RT

Em Retirada de Equipamento

RV

Em Reverso

Suspenso

SC

Sem Crdito

SF

Suspeito de Fraude

SP

Suspenso Parcialmente

TR

Em Transferncia Endereo

Informaes Bsicas
NG
Sistema
Status de OS
Externa
Sigla

Descrio
AA

A Agendar

AE

A Executar

AG

Agendada

AI

Aguardando Infra

AO

Aguardando OS

BN

Baixada No Executada

BP

Baixada Parcialmente

BT

Baixada Totalmente

Cancelada

EE

Em Execuo

EF

Em FollowUp

EX

Executada

ND

Indisponvel p/ Agendamento