Criar Cedente¶
| Método | URL |
|---|---|
https://BASE_URL/api/cedentes |
Cria o cadastro de uma nova empresa cedente com todos os dados necessários.
Request Body
{
"cnpj": "12345678000199",
"nome": "Empresa Exemplo LTDA",
"razaoSocial": "Empresa Exemplo Sociedade Limitada",
"email": "financeiro@empresaexemplo.com.br",
"telefone": {
"ddi": "+55",
"ddd": "47",
"numero": "33221100"
},
"tipoPessoa": 2,
"inscricaoEstadual": "123456789",
"isentoInscricaoEstadual": false,
"inscricaoMunicipal": "987654",
"endereco": {
"logradouro": "Rua XV de Novembro",
"numero": "1500",
"complemento": "Sala 201",
"bairro": "Centro",
"cep": "89010-001",
"cidade": "Blumenau",
"uf": "SC",
"pais": "BRA"
},
"codigoCnae": "6499-9/99",
"naturezaJuridica": "206-2",
"objetoSocial": "Prestação de serviços financeiros e cessão de créditos.",
"dataConstituicao": "2015-03-20",
"faturamento": 5000000.00,
"porte": 4,
"integranteSnf": false,
"ramoAtividade": "SERVICOS",
"tipoSociedade": "LTDA",
"classificacaoRisco": 2,
"autorizacaoCessao": "SIM",
"codigoCoobrigacaoCedente": "A",
"siteCorporativo": "https://empresaexemplo.com.br"
}
Response Body
{
"idEmpresa": 123,
"cnpj": "12345678000199",
"nome": "Empresa Exemplo LTDA",
"status": "Cadastro criado com sucesso."
}
Modelo de Dados¶
Requisição¶
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
cnpj | Texto (14) | ✅ | CNPJ da empresa (somente números) |
nome | Texto (200) | ✅ | Nome fantasia da empresa |
razaoSocial | Texto (200) | ✅ | Razão social |
email | Texto (200) | ✅ | E-mail corporativo principal |
telefone | Telefone | ✅ | Telefone corporativo |
tipoPessoa | Número | ✅ | Tipo de pessoa. Ver Tipo de Pessoa |
inscricaoEstadual | Texto (20) | Opcional | Inscrição estadual |
isentoInscricaoEstadual | Booleano | Opcional | Indica se isento de inscrição estadual. Default: false |
inscricaoMunicipal | Texto (20) | Opcional | Inscrição municipal |
endereco | Endereço | ✅ | Endereço completo da sede |
codigoCnae | Texto (20) | ✅ | Código CNAE da atividade principal |
naturezaJuridica | Texto (20) | Opcional | Código da natureza jurídica (CONCLA) |
objetoSocial | Texto | Opcional | Descrição do objeto social da empresa |
dataConstituicao | Data | ✅ | Data de constituição da empresa (YYYY-MM-DD) |
faturamento | Decimal | Opcional | Faturamento mensal/anual estimado |
porte | Número | Opcional | Porte da empresa. Ver Porte da Empresa |
integranteSnf | Booleano | Opcional | Integrante do Sistema Financeiro Nacional. Default: false |
ramoAtividade | Texto | Opcional | Ramo de atividade. Ver Ramo de Atividade |
tipoSociedade | Texto | Opcional | Tipo de sociedade. Ver Tipo de Sociedade |
classificacaoRisco | Número | Opcional | Classificação de risco. Ver Classificação de Risco |
autorizacaoCessao | Texto | Opcional | Autorização de cessão. Ver Autorização de Cessão. Default: NAO |
codigoCoobrigacaoCedente | Texto (1) | Opcional | Código de coobrigação. Ver Código de Coobrigação |
siteCorporativo | Texto (200) | Opcional | URL do site corporativo |
dataContrato | Data | Opcional | Data do contrato com o fundo |
Telefone¶
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
ddi | Texto (5) | Opcional | DDI do telefone. Default: +55 |
ddd | Texto (3) | ✅ | DDD do telefone |
numero | Texto (15) | ✅ | Número do telefone |
Endereço¶
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
logradouro | Texto (200) | ✅ | Logradouro (rua, avenida, etc.) |
numero | Texto (50) | ✅ | Número |
complemento | Texto (100) | Opcional | Complemento (sala, andar, bloco) |
bairro | Texto (80) | ✅ | Bairro |
cep | Texto (9) | ✅ | CEP (com ou sem máscara) |
cidade | Texto (100) | ✅ | Cidade |
uf | Texto (2) | ✅ | Unidade Federativa. Ver UF |
pais | Texto (3) | Opcional | País (ISO 3166-1 alpha-3). Default: BRA |
Retorno¶
| Campo | Tipo | Descrição |
|---|---|---|
idEmpresa | Número | ID da empresa criada |
cnpj | Texto | CNPJ da empresa |
nome | Texto | Nome da empresa |
status | Texto | Mensagem de status da operação |
Consultar Cedente¶
| Método | URL |
|---|---|
https://BASE_URL/api/cedentes/{idEmpresa} |
Retorna o cadastro completo do cedente, incluindo pessoas vinculadas, contas, contatos e documentos.
Response Body
{
"idEmpresa": 123,
"empresa": {
"cnpj": "12345678000199",
"nome": "Empresa Exemplo LTDA",
"razaoSocial": "Empresa Exemplo Sociedade Limitada",
"email": "financeiro@empresaexemplo.com.br",
"telefone": {
"ddi": "+55",
"ddd": "47",
"numero": "33221100"
},
"tipoPessoa": 2,
"inscricaoEstadual": "123456789",
"isentoInscricaoEstadual": false,
"inscricaoMunicipal": "987654",
"endereco": {
"logradouro": "Rua XV de Novembro",
"numero": "1500",
"complemento": "Sala 201",
"bairro": "Centro",
"cep": "89010-001",
"cidade": "Blumenau",
"uf": "SC",
"pais": "BRA"
},
"codigoCnae": "6499-9/99",
"naturezaJuridica": "206-2",
"objetoSocial": "Prestação de serviços financeiros e cessão de créditos.",
"dataConstituicao": "2015-03-20",
"faturamento": 5000000.00,
"porte": 4,
"integranteSnf": false,
"ramoAtividade": "SERVICOS",
"tipoSociedade": "LTDA",
"classificacaoRisco": 2,
"autorizacaoCessao": "SIM",
"codigoCoobrigacaoCedente": "A",
"siteCorporativo": "https://empresaexemplo.com.br"
},
"pessoas": [
{
"idPessoa": 1,
"nome": "João Silva",
"cpfCnpj": "12345678901",
"papelSocio": true,
"papelRepresentante": true,
"papelAvalista": false,
"participacao": 50.00,
"tipoParteRelacionada": 2
}
],
"contasCorrentes": [
{
"idConta": 1,
"codigoBanco": "341",
"agencia": "1234",
"conta": "56789",
"digito": "0",
"tipoConta": 1
}
],
"contatos": [
{
"idContato": 1,
"nome": "Maria Financeiro",
"email": "maria@empresaexemplo.com.br",
"telefone": "47999887766"
}
],
"documentos": [
{
"idDocumento": 1,
"arquivoNome": "contrato_social.pdf",
"tipoDocumentoIntegracao": "social_contract",
"statusDocumento": "created"
}
]
}
Atualizar Cedente¶
| Método | URL |
|---|---|
https://BASE_URL/api/cedentes/{idEmpresa} |
Atualiza os dados cadastrais da empresa cedente. O payload possui a mesma estrutura da criação, sendo que todos os campos são opcionais — somente os campos enviados serão atualizados.
Request Body
{
"email": "novo-email@empresaexemplo.com.br",
"telefone": {
"ddi": "+55",
"ddd": "47",
"numero": "33224455"
},
"classificacaoRisco": 1
}
Response Body
{
"idEmpresa": 123,
"status": "Cadastro atualizado com sucesso."
}