- Documentação Corbee Gestão
- Autenticação
- Proposta
- Cadastra Proposta FGTSPOST
- Digitar Proposta no BancoPOST
- Cadastrar PropostaPOST
- Enviar Documentos da PropostaPOST
- Corretor Inserir ObservaçãoPOST
- Buscar PropostaGET
- Log PropostaGET
- Status Propostas - ListagemGET
- Status Banco - ListagemGET
- Atualizar status da propostaPUT
- Atualizar status bancoPUT
- Alterar a PMT da PropostaPUT
- Remover PMT da PropostaPUT
- Observações do Corretor na PropostaGET
- Saldo PortabilidadePUT
- Tipos de CancelamentoGET
- Corretores
- Produtos
- Pendências
- Financeiro
- Usuário
- Configurações
- Financeiro
- Comissionamento
- Operações
- Notificações
- Relatorios
- Status APIGET
- Get BancosGET
- Get Banco IdGET
- Get ConveniosGET
- Get Convenio IdGET
- ClienteGET
- Lista EstadosGET
- Estado IdGET
- Lista CidadesGET
- Cidades IdGET
- Estado Civil - ListagemGET
- Lista Tipos de Recebimento ClienteGET
- Listar Arquivos da PropostaGET
- LojasGET
Cadastra Proposta FGTS
POST
/api/v2/proposal/register
Requisição
Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.Exemplo:
Authorization: Bearer ********************
Parâmetros Bodyapplication/json
Corretor
string
requerido
Cliente
array [object {20}]
requerido
CPF
string
opcional
Nome
string
opcional
DtNascimento
string
opcional
RG
string
opcional
OrgExp
string
opcional
DtEmissao
string
opcional
email
string
opcional
NomeMae
string
opcional
NomePai
string
opcional
End
string
opcional
Numero
string
opcional
Complemento
string
opcional
Bairro
string
opcional
Cidade
string
opcional
UF
string
opcional
CEP
string
opcional
Tel
string
opcional
RepresentanteCpf
string
opcional
RepresentanteNome
string
opcional
DadosBancarios
array [object {6}]
opcional
Operacao
array [object {4}]
requerido
Banco
integer
opcional
Convenio
integer
opcional
Produto
integer
opcional
QtdeParcelas
integer
opcional
Proposta
array [object {9}]
requerido
CodPropostaBanco
string
opcional
DataProposta
string
opcional
formalizacao
string
opcional
statusfisico
string
opcional
ValorBruto
string
opcional
ValorLiquido
string
opcional
ValorParcela
string
opcional
midia
string
opcional
SaquesFGTS
array [object {3}]
opcional
Exemplo
{
"Corretor": "8",
"Cliente": [
{
"CPF": "67132173030",
"Nome": "MARTA RODRIGUES DA SILVA",
"DtNascimento": "1995-06-30",
"RG": "21375642",
"OrgExp": "Detran",
"DtEmissao": "2019-01-10",
"email": "marta_rodrigues@hotmail.com",
"NomeMae": "MARCELA RODRIGUES DA SILVA",
"NomePai": "ROBERTO PAIVA DA SILVA",
"End": "Rua Peixoto Gomide",
"Numero": "281",
"Complemento": "AP 47",
"Bairro": "Jardim Paulista",
"Cidade": "São Paulo",
"UF": "SP",
"CEP": "01409001",
"Tel": "(1)99241-4032",
"RepresentanteCpf": "41814469803",
"RepresentanteNome": "NOME DO REPRESENTANTE",
"DadosBancarios": [
{
"TipoRecebimento": "OP",
"BancoRecebimento": "241",
"AgenciaRecebimento": "04815",
"ContaRecebimento": "50611",
"ContaDigito": "8",
"AgenciaDigito": "2"
}
]
}
],
"Operacao": [
{
"Banco": 14,
"Convenio": 2,
"Produto": 26,
"QtdeParcelas": 6
}
],
"Proposta": [
{
"CodPropostaBanco": "",
"DataProposta": "2021-08-30",
"formalizacao": "eletronico",
"statusfisico": "PM",
"ValorBruto": "1000.00",
"ValorLiquido": "500.00",
"ValorParcela": "50.00",
"midia": "Ads",
"SaquesFGTS": [
{
"valor": 7156,
"data": "01/06/2022",
"valor_maximo": 7156
},
{
"valor": 2365,
"data": "01/06/2023",
"valor_maximo": 2365
}
]
}
]
}
Exemplos de Requisição
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://demo.corbee.com.br/api/v2/proposal/register' \
--header 'Content-Type: application/json' \
--data-raw '{
"Corretor": "8",
"Cliente": [
{
"CPF": "67132173030",
"Nome": "MARTA RODRIGUES DA SILVA",
"DtNascimento": "1995-06-30",
"RG": "21375642",
"OrgExp": "Detran",
"DtEmissao": "2019-01-10",
"email": "marta_rodrigues@hotmail.com",
"NomeMae": "MARCELA RODRIGUES DA SILVA",
"NomePai": "ROBERTO PAIVA DA SILVA",
"End": "Rua Peixoto Gomide",
"Numero": "281",
"Complemento": "AP 47",
"Bairro": "Jardim Paulista",
"Cidade": "São Paulo",
"UF": "SP",
"CEP": "01409001",
"Tel": "(1)99241-4032",
"RepresentanteCpf": "41814469803",
"RepresentanteNome": "NOME DO REPRESENTANTE",
"DadosBancarios": [
{
"TipoRecebimento": "OP",
"BancoRecebimento": "241",
"AgenciaRecebimento": "04815",
"ContaRecebimento": "50611",
"ContaDigito": "8",
"AgenciaDigito": "2"
}
]
}
],
"Operacao": [
{
"Banco": 14,
"Convenio": 2,
"Produto": 26,
"QtdeParcelas": 6
}
],
"Proposta": [
{
"CodPropostaBanco": "",
"DataProposta": "2021-08-30",
"formalizacao": "eletronico",
"statusfisico": "PM",
"ValorBruto": "1000.00",
"ValorLiquido": "500.00",
"ValorParcela": "50.00",
"midia": "Ads",
"SaquesFGTS": [
{
"valor": 7156,
"data": "01/06/2022",
"valor_maximo": 7156
},
{
"valor": 2365,
"data": "01/06/2023",
"valor_maximo": 2365
}
]
}
]
}'
Respostas
🟢200Success
application/json
Body
object {0}
Exemplo
{}