Ferramentas do usuário

Ferramentas do site


enduser:erp:developer:integracao:integracaowebservice:telemarketing:adiciona

POST - Adiciona Novo Contribuinte

Este método cria um novo contribuinte no cadastro de associados ERP Prosyst.

api/telemarketing/contribuintes

Exemplo URL

<IP do Serviço>:<Porta liberada para o serviço>api/telemarketing/contribuintes

Parâmetros do Header

authToken adquirido no Login__ .

Parâmetros (Body)

NomeTipoTamanhoDescriçãoObrigatório?
nome String80Nome da pessoa ou empresa associado.Sim
dddInteiro5Código de área do telefone.Sim
telefoneInteiro15Número do telefone de contato (sem DDD).Sim
cpfCnpjString15Documento de identificação (CPF ou CNPJ).Sim
cepInteiro8Código de endereçamento postal.Sim
tipoLogradouroString10Tipo de logradouro, como Rua, Avenida, etc.Sim
numeroString10Número do imóvel no endereço.Sim
complementoString40Informação complementar do endereço (ex: bloco, sala).Não
bairroString40Nome do bairro.Sim
cidadeString40Nome da cidade.Sim
estadoString2Sigla do estado (UF).Sim
unidadeConsumidoraInteiro13Código da unidade de consumo (energia).Sim
valorAtualDecimal13Valor da cobrança ou contribuição atual.Sim
logradouroString80Nome logradouro para cobrança.Sim
numeroMesesContribuicaoInteiro5Quantidade de meses com contribuição registrada.Sim
EmailString250E-mail do contribuinteNão

Exemplo de Body

    {
      "nome": "TesteProsyst88",
      "dDD": 47,
      "telefone": 34550959,
      "cpfCnpj": "07858280000112",
      "cEP": 00000001,
      "tipoLogradouro": "Rua",
      "numero": "474",
      "complemento": "CSA",
      "bairro": "Bucarein",
      "cidade": "Joinville",
      "estado": "SC",
      "unidadeConsumidora": 25881,
      "valorAtual": 35.00,
      "logradouro": "Teste Logradouro",
      "numeroMesesContribuicao":5
    }

Exemplos de Retorno

Sucesso

{
  "bemSucedido": true,
  "mensagemFalha": null,
  "novoCodigo": null,
  "dados": {
    "CodigoContribuinte": "17898"
  }
}

Falha

{
  "bemSucedido": false,
  "mensagemFalha": "Algumas validações para inclusão de um novo contribuinte não foram bem-sucedidas. Consulte os detalhes para mais informações.",
  "novoCodigo": null,
  "dados": []
}

{
  "bemSucedido": false,
  "mensagemFalha": "Erro ao adicionar novo contribuintes.",
  "novoCodigo": null,
  "dados": []
}
enduser/erp/developer/integracao/integracaowebservice/telemarketing/adiciona.txt · Última modificação: por 127.0.0.1

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki