Base de Conhecimento de Gestão Comercial de Saneamento

A maior base de documentação de GSAN do mercado mantida pela Consenso Tecnologia

Ferramentas do usuário

Ferramentas do site


integracoes:web-services-obter-valores-cobrados-contas-emitidas

WebService Obter Valores Cobrados Contas Emitidas

O WebService recebe apenas requisições do tipo POST, não é necessário passar parâmetros.

Exemplo de requisição para o sistema

Com as seguintes informações:

IP192.168.64.111


A Requisição Seria

Retorno em Caso de Sucesso

{
    "body": {
        "referencia": (String) Mês/Ano utilizado na consulta,
        "valorTotal": (String) Valor total das contas selecionadas,
        "dataAtual": (String) Data de emissão da conta mais recente selecionada,
        "valorDataAtual": (String) Valor total das contas na data atual acima,
    }
}


Exemplo:

{
    "body": {
        "referencia": "202109",
        "valorTotal": "5.006,38",
        "dataAtual": "02/11/2021",
        "valorDataAtual": "132,40"
    }
}

Retorno em Caso de erro

{
  "error": (Integer) Código de erro da requisição,
  "msg": (String) Mensagem indicando o que houve, ou vazio em caso de erro 500,
  "qtd": (Integer) sempre valor 0
}
{	
	"error": {
			"erroInformado": (String) Código de erro da requisição,
			"detailMessage": (String) Mensagem indicando o que houve, ou vazio em caso de erro 500
		},
	"message": (String) Mensagem indicando o que houve, ou vazio em caso de erro 500
}

Exemplo:

{ "error":{
  		"erroInformado":"ERRO_TRATADO",
		"detailMessage":"Consulta sem resultados."
	  },
  "message":"Consulta sem resultados."
 }

Possíveis Códigos de Retorno

CódigoMensagem
404“Consulta sem resultados.”
500“”


Clique AQUI para acessar outros serviços com os detalhes técnicos das integrações.

integracoes/web-services-obter-valores-cobrados-contas-emitidas.txt · Última modificação: 24/11/2021 14:04 por hiroshi.goncalves