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çãoObrigatoriedadecnpjParceiroTextoCNPJ do parceiro informante.SimcnpjCedenteTextoCNPJ do cedente (cliente).SimdataInicioRelacionamentoParceiroDataData de início da relação comercial entre parceiro e cliente.SimclienteCompromMensalParceiroDecimalComprometimento mensal do cliente com o parceiro (em reais).SimclienteEndividamentoTotalParceiroDecimalEndividamento total do cliente junto ao parceiro (em reais).SimfatClienteInformadoParceiroArray de ObjetosLista com os 12 últimos meses de faturamento do cliente. Cada item representa um mês.SimfatClienteInformadoParceiro.mesFaturamentoTexto (YYYY-MM)Mês de referência do faturamento.SimfatClienteInformadoParceiro.faturamentoDecimalValor de faturamento informado para o mês.Sim
Resposta - Sucesso (200)
CampoTipoDescriçãomessageTextoMensagem de confirmação do cadastrodata.messageTextoMensagem adicional sobre o sucesso da operaçãostatusCodeInteiroCódigo HTTP da respostastatusBooleanoStatus lógico da operação
Resposta - Erro de Validação (422)
CampoTipoDescriçãomessage.httpCodeInteiroCódigo HTTPmessage.errorCodeTextoCódigo interno do erromessage.messageTextoMensagem de errodata.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çãostatusCodeInteiroCódigo HTTP da resposta
Recent Requests
Log in to see full request history
Time
Status
User Agent
Retrieving recent requests…
Loading…
Responses
401
Invalid client data.
403
Invalid token.
Updated 2 months ago
Did this page help you?
Language
Credentials
Bearer
JWT
URL
Loading…
Response
Click Try It! to start a request and see the response here! Or choose an example: