Loans
Uma lista de empréstimos.
Informa se existem mais itens. Os próximos itens podem ser obtidos informando o ID do último item no startingAfter.
truedata object[]
Uma lista de empréstimos
Identificador exclusivo para o objeto.
loan_5f92f01728e009f403d8502eStatus do empréstimo
Possible values: [open, disbursed, disbursing, repaid, void, canceled, expired, pending, draft]
draftdraft4eeb7525-40c6-45fe-8236-2b731d740fadId do vinculo empregatício ou um objeto com os dados do vinculo empregatício nas operações de leitura quando usado o modo expand.
Id do cliente ou um objeto com os dados do cliente nas operações de leitura quando usado o modo expand.
Id da empresa ou um objeto com os dados da empresa nas operações de leitura quando usado o modo expand.
Número do contrato
AB123456789cashout object[]
- CashoutTransfer
- CashoutBoleto
- CashoutInvoice
- CashoutLoan
payment_methodLinha digitável do boleto.
Data de vencimento do boleto.
beneficiary objectrequired
Documento de identificação da empresa. Deve ser o CNPJ.
Possible values: Value must match regular expression ^[0-9]+
boletoinvoiceloanoffer object
- Offer
- MOD2
Identificador exclusivo para o objeto.
offr_5f92f01728e009f403d8502eIdentificador do cliente.
cust_5f92f01728e009f403d8502eIdentificador do funcionário.
empl_5f92f01728e009f403d8502eIdentificador da empresa.
comp_5f92f01728e009f403d8502eValor solicitado
Valor da parcela.
Valor total da dívida. Inclui tarifas, impostos, valor desembolsado, IOF, taxas e juros.
Valor total dos Juros.
Valor total do IOF (Imposto sobre Operações Financeiras).
Valor da taxa única da [alíquota adicional do IOF (Imposto sobre Operações Financeiras) (decreto 6.339/08).
Custo efetivo total ao mês. O valor deve ser definido em base decimal, por exemplo, defina 0.02 para representar 2% a.m.
0.02Custo efetivo total ao ano. O valor deve ser definido em base decimal, por exemplo, defina 0.12 para representar 12% a.a.
0.12Taxa mensal. O valor deve ser definido em base decimal, por exemplo, defina 0.02 para representar 2% a.m.
0.02Taxa anual. O valor deve ser definido em base decimal, por exemplo, defina 0.12 para representar 12% a.m.
0.12insurance object
Definição do seguro vinculado a oferta de empréstimo.
Taxa. O valor deve ser definido em base decimal, por exemplo, defina 0.02 para representar 2%.
0.02Possible values: [required, optional, uninsured]
Tipo de juros aplicado na dívida.
Tipo de operação de crédito
Data de desembolso no padrão ISO 8601
Data do primeiro vencimento
Identificador que faz referência a um fundo.
fund_637b85aaa8e91c82fd053aacIdentificador do produto no qual este empréstimo foi criado.
prod_637cf14e316408250c0bd067rebates object[]
Tipo da tarifa.
all_loans: utilizado para indicar tarifas ou taxas de manutenção em cada contratação.
first_loan: utilizado para representar taxas de cadastro ou Taxa de Contratação (TC).
except_first_loan: utilizado para representar taxas de manutenção em cada contratação, exceto a primeira.
insurance_premium: utilizado para representar tarifas de seguro.
Possible values: [all_loans, first_loan, except_first_loan, insurance_premium]
first_loanTipo do valor a ser cobrado.
Possible values: [absolute]
absolutePorcentagem da tarifa a ser cobrado sobre o valor do empréstimo.
0.2Descrição para a tarifa.
Tarifa de cadastrofine object
Definição de multa.
Valor percentual fixo da multa. O valor deve ser definido em base decimal, por exemplo, defina 0.02 para representar 2%.
0.02Contagem do tempo para multa (calendar para dias corridos)
Possible values: [calendar_days]
Valor percentual mensal da multa. O valor deve ser definido em base decimal, por exemplo, defina 0.02 para representar 2%.
0.02cashout object[]
- CashoutTransfer
- CashoutBoleto
- CashoutInvoice
- CashoutLoan
payment_methodLinha digitável do boleto.
Data de vencimento do boleto.
beneficiary objectrequired
Documento de identificação da empresa. Deve ser o CNPJ.
Possible values: Value must match regular expression ^[0-9]+
boletoinvoiceloanPolítica de crédito utilizada para a oferta
crpl_637b85aaa8e91c82fd053aacConjunto de pares de valores-chave que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado.
Data de criação do objeto
2023-08-25T22:38:41.134ZIdentificador da oferta.
offr_5f92f01728e009f403d8502etransactions object[]
attachments object[]
file_6307b6c39f5d3d917009b631context object
Informação do contexto da operação. Usado para segurança e formalização. IP, Headers, Fingerprint, and Geolocation
history undefined[]
Status do empréstimo
Possible values: [open, disbursed, disbursing, repaid, void, canceled, expired, pending, draft]
draftdraftConjunto de pares de valores-chave que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado.
Data de criação do objeto
2023-08-25T22:38:41.134Zsignatures object[]
Signatário do empréstimo. Pode ser um customer ou operator.
context
Identificador exclusivo para o objeto.
sign_5f92f01728e009f403d8502eConjunto de pares de valores-chave que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado.
context object
Informação do contexto da operação. Usado para segurança e formalização. IP, Headers, Fingerprint, and Geolocation
insurance object
Identificador da proposta do seguro.
Identificador da venda do seguro.
Identificador do cancelamento do seguro.
Valor restante para pagamento, será apresentado caso seja informado o parâmetro payment_for.
1500Valor para pagamento, será apresentado caso seja informado o parâmetro payment_for.
1487.9Este campo informa se o empréstimo é um refinanciamento. Ele é preenchido automaticamente, levando em conta os dados do campo cashout, e não pode ser preenchido de forma manual.
falseConjunto de pares de valores-chave que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado.
Data de criação do objeto
2023-08-25T22:38:41.134ZData de alteração do objeto
2023-08-25T22:38:41.134ZIdentifica se o objeto foi excluído. Se verdadeiro, o objeto foi excluído.
falsefalsecreatedBy object
Identificador do cliente que criou a assinatura.
client_identifierChave de identificação do cliente externo. Utilizada para identificar o cliente que está realizando a requisição. Populado pelo campo enviado no header base39-external-client-id.
Nome da aplicação que criou a assinatura.
backofficeupdatedBy object
Identificador do cliente que criou a assinatura.
client_identifierChave de identificação do cliente externo. Utilizada para identificar o cliente que está realizando a requisição. Populado pelo campo enviado no header base39-external-client-id.
Nome da aplicação que criou a assinatura.
backoffice{
"hasMore": true,
"data": [
{
"id": "loan_5f92f01728e009f403d8502e",
"status": "draft",
"externalId": "4eeb7525-40c6-45fe-8236-2b731d740fad",
"employment": "string",
"customer": "string",
"company": "string",
"contractNumber": "AB123456789",
"cashout": [
{
"amount": 0,
"paymentMethod": "string",
"type": "payment_method"
},
{
"amount": 0,
"typeableLine": "string",
"dueDate": "2024-07-29",
"beneficiary": {
"name": "string",
"document": "string"
},
"type": "boleto"
},
{
"amount": 0,
"invoice": "string",
"type": "invoice"
},
{
"amount": 0,
"loan": "string",
"type": "loan",
"dueDate": "2024-07-29",
"invoice": "string"
}
],
"offer": {
"id": "offr_5f92f01728e009f403d8502e",
"customer": "cust_5f92f01728e009f403d8502e",
"employment": "empl_5f92f01728e009f403d8502e",
"company": "comp_5f92f01728e009f403d8502e",
"disbursementAmount": 0,
"installmentAmount": 0,
"totalAmount": 0,
"interestAmount": 0,
"iofAmount": 0,
"iofAdditionalAmount": 0,
"monthlyCET": 0.02,
"yearlyCET": 0.12,
"monthlyFee": 0.02,
"yearlyFee": 0.12,
"insurance": {
"amount": 0,
"fee": 0.02,
"type": "required",
"number": "string",
"insurer": "string"
},
"interestType": "string",
"creditOperationType": "string",
"expectedDisbursementDate": "2024-07-29",
"interestGracePeriod": 0,
"principalGracePeriod": 0,
"numberOfInstallments": 0,
"firstDueDate": "2024-07-29",
"fund": "fund_637b85aaa8e91c82fd053aac",
"product": "prod_637cf14e316408250c0bd067",
"description": "string",
"rebates": [
{
"feeType": "first_loan",
"amountType": "absolute",
"amount": 0.2,
"description": "Tarifa de cadastro"
}
],
"fine": {
"fineRate": 0.02,
"interestBase": "calendar_days",
"monthlyRate": 0.02
},
"cashout": [
{
"amount": 0,
"paymentMethod": "string",
"type": "payment_method"
},
{
"amount": 0,
"typeableLine": "string",
"dueDate": "2024-07-29",
"beneficiary": {
"name": "string",
"document": "string"
},
"type": "boleto"
},
{
"amount": 0,
"invoice": "string",
"type": "invoice"
},
{
"amount": 0,
"loan": "string",
"type": "loan",
"dueDate": "2024-07-29",
"invoice": "string"
}
],
"creditPolicy": "crpl_637b85aaa8e91c82fd053aac",
"metadata": {},
"createdAt": "2023-08-25T22:38:41.134Z"
},
"transactions": [
{
"amount": 0,
"description": "string",
"createdAt": "2024-07-29"
}
],
"attachments": [
{
"file": "file_6307b6c39f5d3d917009b631",
"linkedAt": "2024-07-29T15:51:28.071Z"
}
],
"context": {
"ip": "string",
"headers": {},
"fingerprint": "string",
"geolocation": [
"string"
]
},
"history": [
{
"description": "string",
"status": "draft",
"metadata": {},
"createdAt": "2023-08-25T22:38:41.134Z"
}
],
"signatures": [
{
"signer": "string",
"context": {
"id": "sign_5f92f01728e009f403d8502e",
"signedAt": "2024-07-29",
"metadata": {},
"context": {
"ip": "string",
"headers": {},
"fingerprint": "string",
"geolocation": [
"string"
]
}
}
}
],
"insurance": {
"proposalId": "string",
"saleId": "string",
"cancellationId": "string"
},
"amountRemaining": 1500,
"amountForPayment": 1487.9,
"isRefinancing": false,
"metadata": {},
"createdAt": "2023-08-25T22:38:41.134Z",
"updatedAt": "2023-08-25T22:38:41.134Z",
"deleted": false,
"createdBy": {
"clientId": "client_identifier",
"externalClientId": "string",
"app": "backoffice"
},
"updatedBy": {
"clientId": "client_identifier",
"externalClientId": "string",
"app": "backoffice"
}
}
]
}