v1
latestOpenAPI 3.0.12026-07-261451591021.8 KBCadastro dos dados de faturamento do cliente
Faturamento - Cadastro dos Dados de Faturamento do Cliente<br/>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.<br/><br/>Requisição<br/><table><thead><tr><th>Campo</th><th>Tipo</th><th>Descrição</th><th>Obrigatoriedade</th></tr></thead><tbody><tr><td>cnpjParceiro</td><td>Texto</td><td>CNPJ do parceiro informante.</td><td>Sim</td></tr><tr><td>cnpjCedente</td><td>Texto</td><td>CNPJ do cedente (cliente).</td><td>Sim</td></tr><tr><td>dataInicioRelacionamentoParceiro</td><td>Data</td><td>Data de início da relação comercial entre parceiro e cliente.</td><td>Sim</td></tr><tr><td>clienteCompromMensalParceiro</td><td>Decimal</td><td>Comprometimento mensal do cliente com o parceiro (em reais).</td><td>Sim</td></tr><tr><td>clienteEndividamentoTotalParceiro</td><td>Decimal</td><td>Endividamento total do cliente junto ao parceiro (em reais).</td><td>Sim</td></tr><tr><td>fatClienteInformadoParceiro</td><td>Array de Objetos</td><td>Lista com os 12 últimos meses de faturamento do cliente. Cada item representa um mês.</td><td>Sim</td></tr><tr><td style='padding-left: 30px;'>fatClienteInformadoParceiro.mesFaturamento</td><td>Texto (YYYY-MM)</td><td>Mês de referência do faturamento.</td><td>Sim</td></tr><tr><td style='padding-left: 30px;'>fatClienteInformadoParceiro.faturamento</td><td>Decimal</td><td>Valor de faturamento informado para o mês.</td><td>Sim</td></tr></tbody></table><br/><br/>Resposta - Sucesso (200)<br/><table><thead><tr><th>Campo</th><th>Tipo</th><th>Descrição</th></tr></thead><tbody><tr><td>message</td><td>Texto</td><td>Mensagem de confirmação do cadastro</td></tr><tr><td>data.message</td><td>Texto</td><td>Mensagem adicional sobre o sucesso da operação</td></tr><tr><td>statusCode</td><td>Inteiro</td><td>Código HTTP da resposta</td></tr><tr><td>status</td><td>Booleano</td><td>Status lógico da operação</td></tr></tbody></table><br/><br/>Resposta - Erro de Validação (422)<br/><table><thead><tr><th>Campo</th><th>Tipo</th><th>Descrição</th></tr></thead><tbody><tr><td>message.httpCode</td><td>Inteiro</td><td>Código HTTP</td></tr><tr><td>message.errorCode</td><td>Texto</td><td>Código interno do erro</td></tr><tr><td>message.message</td><td>Texto</td><td>Mensagem de erro</td></tr><tr><td>data.meses_faltando</td><td>Objeto</td><td>Lista de meses obrigatórios que não foram enviados. Ex: { '2024-03': 'Mês ausente no envio.' }</td></tr><tr><td>data.meses_invalidos</td><td>Objeto</td><td>Lista de meses fora do período permitido. Ex: { '2025-01': 'Mês inválido (fora do período permitido).' }</td></tr><tr><td>status</td><td>Booleano</td><td>Status lógico da operação</td></tr><tr><td>statusCode</td><td>Inteiro</td><td>Código HTTP da resposta</td></tr></tbody></table>
Headers
Client ID enviado no Header
Request body
Example request
{
"cnpjParceiro": "00000000000000",
"cnpjCedente": "00000000000000",
"dataInicioRelacionamentoParceiro": "2023-05-01",
"fatClienteInformadoParceiro": [
{
"mesFaturamento": "2024-04",
"faturamento": 15000
}
]
}Response
Dados recebidos com sucesso.
Example response
{
"message": "Dados recebidos com sucesso.",
"data": {
"message": "Faturamento cadastrado com sucesso."
},
"statusCode": 200,
"status": true
}