Comodato
| API | Description |
|---|---|
| POST api/Comodato/DevolucaoComodato |
Permite efetuar a devolução de itens do comodato do cliente |
| POST api/Comodato/VendaComodato |
Transforma os itens do comodato em venda (apenas itens em comodato). |
| GET api/Comodato/ListaVendasNaoEquitadas/{idcadastro} |
Lista de vendas de comodato do cliente, não quitadas |
| POST api/Comodato/DevolverProdutoVendaComodato/{nrtitulo}/{idproduto}/{quantidade} |
Permite remover um produto ou reduzir sua quantidade, da venda comodato (não quitada), com redução do valor do título |
| GET api/Comodato/RelatorioDevolucoes/{idequipe}/{data_inicial}/{data_final} |
Relatório de devolução de comodato no período |
| GET api/comodato/ResumoDevolucaoComodato/{idequipe}/{data_inicial}/{data_final} |
Resumo das devoluções de comotado no período |
Mensagem
| API | Description |
|---|---|
| POST api/Mensagem/SMS |
Envio de mensagem SMS. Token Bearer |
| POST api/Mensagem/PUSH |
Envio de mensagem PUSH. Token Bearer |
ServiceDesk
| API | Description |
|---|---|
| GET api/ServiceDesk/getMotivosAtendimento |
Lista de motivos para atendimento ao cliente |
| POST api/ServiceDesk/IniciarAtendimento/{idcadastro} |
Inicia o atendimento ao cliente |
| POST api/ServiceDesk/ConcluiAtendimento/{idatendimento} |
Conclui o atendimento ao cliente |
| GET api/ServiceDesk/MeusAtendimentosHoje |
Lista de atendimentos do colaborador atualmente logado |
| POST api/ServiceDesk/DesconectarUsuario/{username} |
Desconecta a internet do cliente |
| POST api/ServiceDesk/LimparMac/{idcadastro} |
Remove o MAC da conexão do cliente e desconecta a internet |
| GET api/ServiceDesk/ClientesMesmaCTO?idcadastro={idcadastro}&idcto={idcto} |
Lista de clientes na mesma Cto. Informe o código do cliente ou código da Cto. Caso informe o código do cliente, informe idcto = 0 e vice-versa. |
| POST api/ServiceDesk/BandaTesteDefinir/{idcadastro} |
Define uma banda/plano para o cliente testar por dois dias. Após dois dias a banda de deste será removida automaticamente. |
| POST api/ServiceDesk/BandaTesteRemover/{idcadastro} |
Remove a banda de teste do cliente indicado |
| GET api/ServiceDesk/MeusAtendimentosPendentes |
Lista de atendimentos em andamento do colaborador logado (ainda não fechado) |
NotaFiscal
| API | Description |
|---|---|
| GET api/NotaFiscal/Listagem |
Lista de notas fiscais (SCM) do cliente indicado |
| GET api/NotaFiscal/Campos |
Retorna os campos da NF |
Cidades
| API | Description |
|---|---|
| GET api/cidades/pesquisa?uf={uf}&pesquisa={pesquisa} |
Pesquisa cidade conforme UF e Cidade a ser pesquisada |
| GET api/cidades/{idcidade}/pesquisacondominio?pesquisa={pesquisa} |
Obtém a lista de condomínios da cidade indicada |
| GET api/cidades/{idcidade}/pesquisabairro?pesquisa={pesquisa} |
Pesquisa de bairro conforme código da cidade |
| GET api/Cidades |
Lista todas as cidades com loja Net Barretos |
| GET api/Cidades/{id} |
Traz informações da cidade conforme seu código informado |
Cadastro
Dados cadastrais do cliente
| API | Description |
|---|---|
| GET api/cadastro/pesquisa |
Pesquisa de cliente |
| GET api/cadastro/{idcadastro}/faturas?tipo={tipo}&is_vendas={is_vendas} |
Obtém os dados da cobrança do cliente, mensalidades, taxas e vendas |
| GET api/cadastro/{idcadastro}/getConexaoCobranca |
Obtém os dados da conexão e cobrança |
| PUT api/cadastro/{idcadastro}/putConexaoCobranca |
Salva as informações de conexão e cobrança |
| GET api/cadastro/{idcadastro}/getCallCenter?count={count} |
Obtém os últimos chamados atendidos pelo callcenter |
| GET api/cadastro/{idcadastro}/getHelpDesk/{count} |
Obtém os últimos chamados atendidos pelo helpdesk |
| GET api/cadastro/{idcadastro}/getOrdemServico/{count} |
Retorna uma lista das últimas ordens de serviço abertas para o cliente |
| GET api/cadastro/getKitEquipamento |
Retorna a lista dos tipos de equipamento para instalação no cliente |
| GET api/cadastro/getComoNosConheceu |
Lista de opções de como nos conheceu |
| GET api/cadastro/getTodosPlanos?idcidade={idcidade} |
Planos de internet |
| GET api/cadastro/{idcadastro}/getConexaoDetalhes |
Obtém alguns detalhes da conexão atual do cliente |
| GET api/cadastro/{idcadastro}/LiberarConexao24h |
Libera a conexão do cliente por 24h, inclusive dos cadastros vinculados que houverem |
| GET api/cadastro/{idcadastro}/LiberarConexaoExtendida/{dias} |
Libera a conexão por X dias (de 1 a 15), inclusive dos cadastros vinculados que houverem. |
| GET api/cadastro/HistoricoLiberacao24h/{idcadastro}/{count} |
Histórico de liberações por 24h do cliente informado |
| GET api/cadastro/{idcadastro}/getComodato |
Retorna a lista de produtos em comodato instalados no cliente |
| GET api/cadastro/{idcadastro}/getAtendimentoEspera?count={count}&last_id={last_id} |
Retorna a lista de atendimentos em espera do cliente |
| GET api/cadastro/getAtendimentoEsperaPendentesOperador |
Retorna uma lista de atendimentos em espera pendentes, destinadas ao colaborador atual logado |
| GET api/cadastro/getDebitoNoEndereco_cabo_lancado |
Retorna informações indicando se há algum cadastro (ou do cpf indicado) com débito no endereço dado e se já tem cabo de fibra no endereço. |
| POST api/cadastro/{idcadastro}/AtendimentoEspera |
Cadastramento de atendimento em espera alteração |
| POST api/cadastro/FechaAtendimentoEspera/{idatendimento} |
Fecha o atendimento em espera |
| GET api/cadastro/{idcadastro}/TermoAdesao |
Retorna PDF do termo de adesão |
| GET api/cadastro/{idcadastro}/CamposTermoAdesao |
Retorna os campos do termo de adesão |
| GET api/cadastro/getMotivosCancelamento |
Lista de motivos para indicar no cancelamento do cadastro do cliente |
| PUT api/cadastro/{idcadastro}/Encerrar |
Encerra o cadastro indicado |
| PUT api/cadastro/{idcadastro}/Reativar |
Reativar um cadastro encerrado |
| POST api/cadastro/TransfereTitularidade |
Efetua a transferência de titularidade da internet entre cadastros. O cadastro de origem não será encerrado automaticamente para não ficar sem conexão. Isso deverá ser feito manualmente após as alterações na ONU com os dados do novo usuário. |
| POST api/Cadastro/EnviaBoletoEmail?idcadastro={idcadastro}&titulo={titulo} |
Envia um link do boleto para o e-mail do cliente |
| POST api/Cadastro/AlteraDataContrato |
Permite alterar a data do contrato (refidelização) |
| GET api/Cadastro/ListagemBoletoEmail/{idcadastro} |
Lista de e-mail para envio de boleto e nota fiscal modelo 21 |
| POST api/Cadastro/CadastrarBoletoEmail |
Cadastra/substitui a lista de e-mail do cliente para envio de boleto/nf21 |
| GET api/Cadastro/LogAlteracoes/{idcadastro}/{qdeRegistros} |
Traz uma lista de alterações no cadastro |
| GET api/Cadastro/StatusCadastros |
Retorna o status dos cadastros da lista |
| POST api/cadastro/SuspenderConexao/Ativar |
Cadastra a suspensão da conexão de internet no período informado |
| POST api/cadastro/SuspenderConexao/Cancelar |
Cancela a suspensão da conexão da internet |
| POST api/cadastro/DebitoCartao/{idcadastro} |
Permite cadastrar/alterar ou remover os dados para débito de fatura no cartão de crédito ou débito. Se as informações do cartão vierem em branco, será removido os dados do cartão atualmente cadastrado. |
| GET api/cadastro/ListaParaRefidelizacao/{idplano} |
Lista de clientes cujo contrato de fidelização já venceu |
| GET api/Cadastro/{id} |
Obtém os dados do cadastro indicado pelo id |
| POST api/Cadastro |
Permite criar um novo cadastro |
| PUT api/Cadastro/{id} |
Permite alterar dados do cadastro indicado |
Titulos
| API | Description |
|---|---|
| GET api/Titulos/Pendentes |
Retorna a lista de títulos não pagos ou informações do título informado. |
| GET api/Titulos/EnderecoCobranca |
Retorna dados do cliente com endereço de cobrança para montagem do boleto |
| GET api/Titulos/NumeroCartaoRecorrente?idcadastro={idcadastro}&token={token} |
Retorna dados do cartão do pagamento recorrente |
| GET api/Titulos/ListaTitulosVencidos/{vencimento} |
Lista de títulos não pagos, com vencimento na data indicada Informar o token no authorization: Bearer token |
| GET api/Titulos/ListaTitulosComRetirada/{data_fechamento} |
Lista de títulos não pagos, com o.s. de retirada fechada na data indicada e cadastro encerrado Informar o token no authorization: Bearer token |
| GET api/Titulos/ListaTitulosValorAlterado/{data_pesquisa}/{titulo} |
Lista de títulos com valor alterado na data indicada. Informar o token no authorization: Bearer token |
| GET api/Titulos/ListaTitulosPagosPeriodo/{dtinicial}/{dtfinal} |
Lista de títulos pagos no período indicado Informar o token no authorization: Bearer token |
| GET api/Titulos/ListaTitulosRenegociadosPagos/{dtinicial}/{dtfinal} |
Lista de títulos renegociados cujo título da renegociação foi pago Informar o token no authorization como: Bearer token |
| GET api/Titulos/EncerramentoSimulado/{idcadastro}/{data_operacao}/{emitir_proporcionais} |
Traz informações da cobrança de multa rescisória e mensalidades pendentes com juros/desconto, simulando o encerramento do cadastro na data de operação informada. Informar o token no authorization: Bearer token |
| GET api/Titulos/EncerramentoSimulado/{idcadastro}/{data_operacao} |
Traz informações da cobrança de multa rescisória e mensalidades pendentes com juros/desconto, simulando o encerramento do cadastro na data de operação informada. Informar o token no authorization: Bearer token |
Estoque
| API | Description |
|---|---|
| GET api/Estoque/ListaONU |
Lista de ONU |
| GET api/Estoque/ListaRoteadores?idplano={idplano} |
Lista de roteadores por plano e todos os roteadores dos planos |
CallCenter
| API | Description |
|---|---|
| GET api/CallCenter/getMotivosAtendimento |
Lista de motivos para atendimento ao cliente |
| POST api/CallCenter/IniciarAtendimento/{idcadastro} |
Inicia um atendimento ao cliente |
| POST api/CallCenter/ConcluiAtendimento/{idatendimento} |
Conclui o atendimento ao cliente |
| GET api/CallCenter/MeusAtendimentosHoje |
Lista de atendimentos fechados, do colaborador atualmente logado |
| GET api/CallCenter/MeusAtendimentosPendentes |
Lista de atendimentos em andamento do colaborador logado (ainda não fechado) |
Caixa
| API | Description |
|---|---|
| GET api/caixa/CaixasLivres |
Lista de caixas livres e disponíveis para abertura |
| GET api/caixa/AbrirCaixa/{caixa_id} |
Permite abrir o caixa indicado |
| GET api/caixa/FecharCaixa?valorMalote={valorMalote} |
Permite fechar o caixa do operador |
| GET api/caixa/PreFechamento |
Obtém saldo do caixa como informação para o fechamento do caixa |
| GET api/caixa/listagem?count={count}&last_id={last_id}&tipo={tipo}&pesquisa={pesquisa} |
Listagem dos lançamento do caixa do operador atual |
| GET api/caixa/debito/fontes |
No caso de débito, obtém a lista de empresas (FONTE) |
| GET api/caixa/debito/contas |
No caso de débito, obtém a lista de contas (CONTA) |
| GET api/caixa/debito/subcontas/{idconta} |
No caso de débito, obtém a lista de sub-contas da conta indicada (SUB-CONTA) |
| GET api/caixa/debito/cheques_deposito |
Retorna uma lista de cheques à vista para depósito |
| GET api/caixa/lancar |
Efetua lançamentos no caixa, crédito ou débito |
| GET api/caixa/maquinetas |
Retorna a lista de maquinetas para uso com o recebimento via cartão de crédito |
| GET api/caixa/recebimento/pegainformacoes?idcadastro={idcadastro}&nr_titulo={nr_titulo} |
Obtém informações do cliente e dos títulos em aberto, para pagamento. Informe o código do cliente ou o número do título. Se informar o código do cliente, no campo nr_titulo informe 0, e vice-versa |
| GET api/caixa/recebimento/concluir |
Conclui o recebimento da mensalidade do cliente |
ServicosOnline
| API | Description |
|---|---|
| GET api/servicosonline/contratacao/pesquisar?tipoCadastro={tipoCadastro}&pagina_nr={pagina_nr}&count={count}&pesquisa={pesquisa}&cidade={cidade}&PagosViaUOL={PagosViaUOL}&dt1={dt1}&dt2={dt2} |
Pesquisa de cadastros de contratação do serviço de internet |
| GET api/servicosonline/contratacao/reenviaemail?id={id}&email={email} |
Reenvia o e-mail para o cliente confirmar sua contratação |
| GET api/servicosonline/contratacao/{id} |
Obtém os dados do cadastro do pedido de contratação |
| GET api/servicosonline/contratacao/deletar?id={id}&EfetivadoNaLoja={EfetivadoNaLoja} |
Permite marcar o cadastro como excluído |
| GET api/servicosonline/contratacao/restaurardeletado?id={id} |
Restaura um cadastro marcado como deletado |
Operador
Informações do operador/colaborador
| API | Description |
|---|---|
| GET api/colaborador/getColaboradores/{idsetor} |
Retorna a lista de colaboradores ativos. |
| GET api/colaborador/getSetores |
Retorna a lista de setores para operadores/colaboradores |
| GET api/colaborador/Permissoes |
Retorna as permissões do colaborador no PgpNet |
| GET api/colaborador/foto |
Retorna a foto do colaborador logado no formato string Base64 |
PowerBI
Dados para alimentar o PowerBI
| API | Description |
|---|---|
| GET api/PowerBI/ListagemEntradasSaidas?token={token}&data_inicial={data_inicial}&data_final={data_final}&idcidade={idcidade} |
Listagem de entradas, re-entradas e saídas no período |
| GET api/PowerBI/CrescimentoDaBase?token={token}&data_inicial={data_inicial}&data_final={data_final}&idcidade={idcidade} |
Evolução no crescimento da base de clientes |
| GET api/PowerBI/EstoqueConsumoONU?token={token} |
Consulta estoque de ONU no CD, Almoxarifados, equipes e transferidas para o comodato (últimos 30 dias) |
| GET api/PowerBI/EstoqueConsumoRoteador?token={token} |
Consulta estoque de ROTEADOR no CD, Almoxarifados, equipes e transferidas para o comodato (últimos 30 dias) Token de acesso |
Lojas
| API | Description |
|---|---|
| GET api/Lojas/LojasEquipe |
Lista de equipes para as lojas, para retirada/recebimento de comodato do cliente |
| GET api/Lojas |
Retorna a lista de lojas/cidades, não requer autenticação. |
CelulaAtiva
| API | Description |
|---|---|
| GET api/CelulaAtiva/ConsultaFidelizacao?idcidade={idcidade}&data={data}&token={token} |
Lista de cliente com fidelidade vencida e refidelizados |
| GET api/CelulaAtiva/ConsultaCancelamentos?idcidade={idcidade}&data={data}&token={token} |
Lista de clientes cancelados |
| GET api/CelulaAtiva/ConsultaNovasContratacoes?idcidade={idcidade}&data={data}&token={token} |
Lista de novos clientes |
OrdemServico
Controle de ordens de serviço
| API | Description |
|---|---|
| GET api/OrdemServico/getTiposServicos |
Retorna a lista dos tipos de ordem de serviço |
| POST api/OrdemServico/Alterar?idos={idos} |
Altera os dados da ordem de serviço (alternativa ao PUT) |
| GET api/OrdemServico/Agendamento/ServicosPendentes?idcidade={idcidade}&naoefetuados={naoefetuados} |
Lista de serviços a serem executados |
| GET api/OrdemServico/Agendamento/ServicoClientes |
Traz a lista de clientes conforme os dados da pesquisa |
| GET api/OrdemServico/Agendamento/ServicoEquipesDisponiveis?idservico={idservico}&idcidade={idcidade} |
Traz a lista de equipes disponíveis de acordo com o tipo de serviço informado |
| GET api/OrdemServico/Agendamento/AgendamentosEquipe?idequipe={idequipe}&data={data}&operacao={operacao} |
Traz a lista de o.s. agendadas para a equipe indicada |
| POST api/OrdemServico/Agendamento/Agendar |
Efetua o agendamento do serviço para a equipe indicada |
| POST api/OrdemServico/{idos}/Excluir |
Permite excluir a ordem de serviço, desde que ainda esteja em aberto. |
| GET api/OrdemServico/ListaOSFechadas/{data} |
Lista de ordens de serviço fechadas na data indicada |
| GET api/OrdemServico/{id} |
Obtém informações da ordem de serviço |
| POST api/OrdemServico |
Cadastro de nova ordem de serviço |
| PUT api/OrdemServico?idos={idos} |
Altera os dados da ordem de serviço |
Movel
Telefonia Móvel
| API | Description |
|---|---|
| GET api/Movel/Contratos/{idcadastro} |
Dados do combo e todos as contratos do cliente |
| GET api/Movel/ConsultarContrato/{nrcontrato} |
Consulta o contrato indicado |
| GET api/Movel/Combos |
Lista de combos disponíveis para contratação |
| GET api/Movel/Produtos |
Lista de planos de dados que podem ser contratados fora das especificações do combo. |
| GET api/Movel/GigaAdicional |
Planos para compra de giga adicional (dados), se estiver precisando de mais dados para internet. |
| GET api/Movel/DadosComprados?idcadastro={idcadastro} |
Consulta de dados comprados no corrente mês e ano |
| POST api/Movel/FecharChamadoSuporte/{nrcontrato}/{protocolo} |
Permite encerrar o chamado de suporte do contrato informado |
| GET api/Movel/LogAlteracoes/{idcadastro}/{nrcontrato} |
Lista de alterações no contrato |
| GET api/Movel/LinhasReservadas |
Retorna a lista de linhas reservadas, sem chip vinculado |
| POST api/Movel/TransfereContratos |
Transfere contratos de telefonia móvel de um cadastro do Pgp para outro, sem alterações na Americanet. |
Notificacao
| API | Description |
|---|---|
| GET api/notificacao/pagamento/{titulo} |
Confere o pagamento via APP, efetua a baixa e desbloqueia a conexão |
| POST api/notificacao/PagamentoParcial/{titulo}/{valor} |
Registra um pagamento parcial, sem efetua a baixa. Caso queira registrar pagamento total, use a api: api/notificacao/pagamento/{titulo} |
Extrato
Obtém o extrato de conexão do cliente nos últimos 30 dias
| API | Description |
|---|---|
| GET api/Extrato/{id} |
Obtém o extrato de conexão do cliente indicado (últimos 30 dias) |
Token
Retorna o token JWT para uso nas chamada à api. Nas próximas chamadas o token deve estar no header (authorization: Bearer TOKEN)
| API | Description |
|---|---|
| GET api/Token |
Token JWT |
| POST api/Token |
Token JWT |