Webservice (Comercial Contratos - Verificar se o cliente pode alterar para fatura digital): mudanças entre as edições

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


'''Descrição:''' Faz a verificação se o cliente pode alterar a forma da Fatura para Fatura digital.


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


'''Método:''' POST


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


'''Saída:''' String informando se pode ou não alterar para fatura digital.


'''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}/verificar/fatura_digital
 
*** '''Parâmetros adicionais:'''<syntaxhighlight lang="json" line="1">
 
{
 
  "usuario":"12312312312",
 
  "senha":"12312312312"
 
}
 
</syntaxhighlight>
 
* '''Retorno:'''
 
** '''Sucesso:''' Caso a resposta seja "NOT_ACCEPTABLE", a alteração não poderá ser feita. Caso seja "ACCEPTED", está permitida a alteração.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 




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

Edição atual tal como às 14h42min de 19 de maio de 2023

Descrição: Faz a verificação se o cliente pode alterar a forma da Fatura para Fatura digital.

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

Método: POST

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

Saída: String informando se pode ou não alterar para fatura digital.

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}/verificar/fatura_digital
      • Parâmetros adicionais:
        {
           "usuario":"12312312312",
           "senha":"12312312312"
        }
        
  • Retorno:
    • Sucesso: Caso a resposta seja "NOT_ACCEPTABLE", a alteração não poderá ser feita. Caso seja "ACCEPTED", está permitida a alteração.


Voltar ao menu Webservice Comercial Contratos