Cadastro dos dados de faturamento do cliente

Faturamento - Cadastro dos Dados de Faturamento do Cliente
Permite que parceiros informem os dados de faturamento mensal de um cliente com quem possuem relacionamento comercial. A informação enviada deve conter 12 registros, um para cada mês anterior ao mês atual. Essa captura é essencial para análises de crédito, acompanhamento financeiro e avaliação do comportamento do cliente ao longo do tempo.

Requisição

CampoTipoDescriçãoObrigatoriedade
cnpjParceiroTextoCNPJ do parceiro informante.Sim
cnpjCedenteTextoCNPJ do cedente (cliente).Sim
dataInicioRelacionamentoParceiroDataData de início da relação comercial entre parceiro e cliente.Sim
clienteCompromMensalParceiroDecimalComprometimento mensal do cliente com o parceiro (em reais).Sim
clienteEndividamentoTotalParceiroDecimalEndividamento total do cliente junto ao parceiro (em reais).Sim
fatClienteInformadoParceiroArray de ObjetosLista com os 12 últimos meses de faturamento do cliente. Cada item representa um mês.Sim
fatClienteInformadoParceiro.mesFaturamentoTexto (YYYY-MM)Mês de referência do faturamento.Sim
fatClienteInformadoParceiro.faturamentoDecimalValor de faturamento informado para o mês.Sim


Resposta - Sucesso (200)
CampoTipoDescrição
messageTextoMensagem de confirmação do cadastro
data.messageTextoMensagem adicional sobre o sucesso da operação
statusCodeInteiroCódigo HTTP da resposta
statusBooleanoStatus lógico da operação


Resposta - Erro de Validação (422)
CampoTipoDescrição
message.httpCodeInteiroCódigo HTTP
message.errorCodeTextoCódigo interno do erro
message.messageTextoMensagem de erro
data.meses_faltandoObjetoLista de meses obrigatórios que não foram enviados. Ex: { '2024-03': 'Mês ausente no envio.' }
data.meses_invalidosObjetoLista de meses fora do período permitido. Ex: { '2025-01': 'Mês inválido (fora do período permitido).' }
statusBooleanoStatus lógico da operação
statusCodeInteiroCódigo HTTP da resposta

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
string
date
float
float
fatClienteInformadoParceiro
array of objects
fatClienteInformadoParceiro
Headers
uuid
required

Client ID enviado no Header

Responses

401

Invalid client data.

403

Invalid token.

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json