Webservice (Comercial Contratos - Alterar forma de cobrança para fatura digital): mudanças entre as edições

De Adapter
Ir para navegação Ir para pesquisar
VisualWikitexto
 
Sem resumo de edição
 
Linha 1: Linha 1:


'''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:'''
{| class="wikitable"
|'''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:'''<syntaxhighlight lang="json" line="1">
 
{
 
  "usuario":"12312312312",
 
  "senha":"12312312312"
 
}
 
</syntaxhighlight>
 
* '''Retorno:'''
 
** '''Sucesso:'''<syntaxhighlight lang="json" line="1">
 
{
 
  "Status":"OK",
 
  "Contratos":[
 
      355568,
 
      355589
 
  ],
 
  "Mensagem":"Foi alterado para Fatura Digital!"
 
}
 
</syntaxhighlight>
 
** '''Erro:'''
*** Não foi possível alterar a forma de cobrança.<syntaxhighlight lang="json">
{
  "Status":"NOT_MODIFIED",
  "Mensagem":"Não foi possivel alterar para Fatura Digital!"
}
</syntaxhighlight>
*** Erro interno.<syntaxhighlight lang="json" line="1">
{
  "Status":"INTERNAL_SERVER_ERROR",
  "Erro":"Mensagem informado o tipo do Erro",
  "Mensagem":"Não foi possível alterar para Fatura Digital!"
}
</syntaxhighlight>


[[Webservice (Comercial Contratos)|Voltar ao menu Webservice Comercial Contratos]]
[[Webservice (Comercial Contratos)|Voltar ao menu Webservice Comercial Contratos]]

Edição atual tal como às 15h01min de 19 de maio de 2023

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

Disponível em “http://192.168.0.28:80/wiki/index.php?title=Webservice_(Comercial_Contratos_-_Alterar_forma_de_cobrança_para_fatura_digital)&oldid=1637”