Webservice (Comercial Contratos - Alterar forma de cobrança para fatura digital)

De Adapter
Ir para navegação Ir para pesquisar

Descrição: Alterar a forma de cobrança do cliente.

URL: https://[URL]/ws/comercial/cliente/{idCliente}/alterar/fatura_digital

Método: POST

Entrada: Pelo PathParam passar o código do cliente, JSON contendo usuário e senha.

Saída: "OK" se for alterado algum contrato do cliente para a nova forma de cobrança, nesse caso o cliente receberá um email informando que a alteração para fatura digital foi feita com sucesso. Caso não aconteça alteração em nenhum contrato (por não ter nenhum habilitado que não seja débito e nem isento ou por não ter forma de cobrança do tipo fatura digital ativa) a resposta será "NOT_MODIFIED".

Campos JSON de entrada:

Tag Tipo Parâmetro Tipo Obrigatório Observação
idCliente Path Param String SIM
usuario body String SIM
senha body String SIM

Exemplo:

  • Envio:
    • https://[URL]/ws/comercial/cliente/{idCliente}/alterar/fatura_digital
      • Parâmetros adicionais:
        {
           "usuario":"12312312312",
           "senha":"12312312312"
        }
        
  • Retorno:
    • Sucesso:
      {
         "Status":"OK",
         "Contratos":[
            355568,
            355589
         ],
         "Mensagem":"Foi alterado para Fatura Digital!"
      }
      
    • Erro:
      • Não foi possível alterar a forma de cobrança.
        {
           "Status":"NOT_MODIFIED",
           "Mensagem":"Não foi possivel alterar para Fatura Digital!"
        }
        
      • Erro interno.
        {
           "Status":"INTERNAL_SERVER_ERROR",
           "Erro":"Mensagem informado o tipo do Erro",
           "Mensagem":"Não foi possível alterar para Fatura Digital!"
        }
        

Voltar ao menu Webservice Comercial Contratos