Loans

Uma lista de empréstimos.

hasMore

boolean

Informa se existem mais itens. Os próximos itens podem ser obtidos informando o ID do último item no startingAfter.

Example:

true

data

object[]

Uma lista de empréstimos

Este objeto representa um empréstimo.

data.id

string

Identificador exclusivo para o objeto.

Example:

"loan_5f92f01728e009f403d8502e"

data.status

string

default:draft

Status do empréstimo

Example:

"draft"

data.externalId

string

Example:

"4eeb7525-40c6-45fe-8236-2b731d740fad"

data.employment

string

Id do vinculo empregatício ou um objeto com os dados do vinculo empregatício nas operações de leitura quando usado o modo expand.

data.customer

string

Id do cliente ou um objeto com os dados do cliente nas operações de leitura quando usado o modo expand.

data.company

string

Id da empresa ou um objeto com os dados da empresa nas operações de leitura quando usado o modo expand.

data.contractNumber

string

Número do contrato

Example:

"AB123456789"

data.cashout

object[]

Especificação para desembolso em conta bancária

data.offer

Este objeto representa uma oferta de um empréstimo.

data.offer.employment

string

required

Identificador do funcionário.

Example:

"empl_5f92f01728e009f403d8502e"

data.offer.company

string

required

Identificador da empresa.

Example:

"comp_5f92f01728e009f403d8502e"

data.offer.disbursementAmount

number

required

Valor solicitado

data.offer.totalAmount

number

required

Valor total da dívida. Inclui tarifas, impostos, valor desembolsado, IOF, taxas e juros.

data.offer.numberOfInstallments

integer

required

data.offer.firstDueDate

string

required

Data do primeiro vencimento

data.offer.fund

string

required

Identificador que faz referência a um fundo.

Example:

"fund_637b85aaa8e91c82fd053aac"

data.offer.product

string

required

Identificador do produto no qual este empréstimo foi criado.

Example:

"prod_637cf14e316408250c0bd067"

data.offer.id

string

Identificador exclusivo para o objeto.

Example:

"offr_5f92f01728e009f403d8502e"

data.offer.customer

string

Identificador do cliente.

Example:

"cust_5f92f01728e009f403d8502e"

data.offer.installmentAmount

number

Valor da parcela.

data.offer.interestAmount

number

Valor total dos Juros.

data.offer.iofAmount

number

Valor total do IOF (Imposto sobre Operações Financeiras).

data.offer.iofAdditionalAmount

number

Valor da taxa única da [alíquota adicional do IOF (Imposto sobre Operações Financeiras) (decreto 6.339/08).

data.offer.monthlyCET

number

Custo efetivo total ao mês. O valor deve ser definido em base decimal, por exemplo, defina 0.02 para representar 2% a.m.

Example:

0.02

data.offer.yearlyCET

number

Custo efetivo total ao ano. O valor deve ser definido em base decimal, por exemplo, defina 0.12 para representar 12% a.a.

Example:

0.12

data.offer.monthlyFee

number

Taxa mensal. O valor deve ser definido em base decimal, por exemplo, defina 0.02 para representar 2% a.m.

Example:

0.02

data.offer.yearlyFee

number

Taxa anual. O valor deve ser definido em base decimal, por exemplo, defina 0.12 para representar 12% a.m.

Example:

0.12

data.offer.insurance

object

Definição do seguro vinculado a oferta de empréstimo.

data.offer.interestType

string

Tipo de juros aplicado na dívida.

data.offer.creditOperationType

string

Tipo de operação de crédito

data.offer.expectedDisbursementDate

string

Data de desembolso no padrão ISO 8601

data.offer.interestGracePeriod

integer

data.offer.principalGracePeriod

integer

data.offer.description

string

data.offer.rebates

object[]

data.offer.fine

object

Definição de multa.

data.offer.cashout

object[]

Especificação para desembolso em conta bancária

data.offer.creditPolicy

string

Política de crédito utilizada para a oferta

Example:

"crpl_637b85aaa8e91c82fd053aac"

data.offer.metadata

object

Conjunto 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.offer.createdAt

string

Data de criação do objeto

Example:

"2023-08-25T22:38:41.134Z"

data.transactions

object[]

A especificação de um endereço

data.attachments

object[]

data.context

object

Informação do contexto da operação. Usado para segurança e formalização. IP, Headers, Fingerprint, and Geolocation

data.history

object[]

data.signatures

object[]

data.insurance

object

data.amountRemaining

number

Valor restante para pagamento, será apresentado caso seja informado o parâmetro payment_for.

Example:

1500

data.amountForPayment

number

Valor para pagamento, será apresentado caso seja informado o parâmetro payment_for.

Example:

1487.9

data.isRefinancing

string

Este 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.

Example:

false

data.metadata

object

Conjunto 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.createdAt

string

Data de criação do objeto

Example:

"2023-08-25T22:38:41.134Z"

data.updatedAt

string

Data de alteração do objeto

Example:

"2023-08-25T22:38:41.134Z"

data.deleted

boolean

default:false

Identifica se o objeto foi excluído. Se verdadeiro, o objeto foi excluído.

Example:

false

data.createdBy

object

data.updatedBy

object

Loan Offer

{
  "hasMore": true,
  "data": [
    {
      "id": "loan_5f92f01728e009f403d8502e",
      "status": "draft",
      "externalId": "4eeb7525-40c6-45fe-8236-2b731d740fad",
      "employment": "<string>",
      "customer": "<string>",
      "company": "<string>",
      "contractNumber": "AB123456789",
      "cashout": [
        {
          "amount": 123,
          "paymentMethod": "<string>",
          "type": "payment_method"
        }
      ],
      "offer": {
        "id": "offr_5f92f01728e009f403d8502e",
        "customer": "cust_5f92f01728e009f403d8502e",
        "employment": "empl_5f92f01728e009f403d8502e",
        "company": "comp_5f92f01728e009f403d8502e",
        "disbursementAmount": 123,
        "installmentAmount": 123,
        "totalAmount": 123,
        "interestAmount": 123,
        "iofAmount": 123,
        "iofAdditionalAmount": 123,
        "monthlyCET": 0.02,
        "yearlyCET": 0.12,
        "monthlyFee": 0.02,
        "yearlyFee": 0.12,
        "insurance": {
          "amount": 123,
          "fee": 0.02,
          "type": "required",
          "number": "<string>",
          "insurer": "<string>"
        },
        "interestType": "<string>",
        "creditOperationType": "<string>",
        "expectedDisbursementDate": "2023-12-25",
        "interestGracePeriod": 123,
        "principalGracePeriod": 123,
        "numberOfInstallments": 123,
        "firstDueDate": "2023-12-25",
        "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": 123,
            "paymentMethod": "<string>",
            "type": "<string>"
          }
        ],
        "creditPolicy": "crpl_637b85aaa8e91c82fd053aac",
        "metadata": {},
        "createdAt": "2023-08-25T22:38:41.134Z"
      },
      "transactions": [
        {
          "amount": 123,
          "description": "<string>",
          "createdAt": "2023-12-25"
        }
      ],
      "attachments": [
        {
          "file": "file_6307b6c39f5d3d917009b631",
          "linkedAt": "2023-11-07T05:31:56Z"
        }
      ],
      "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": "2023-12-25",
            "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"
      }
    }
  ]
}

Empréstimos

Empresas

Clientes

Fundos

Eventos

Cobrança

Arquivos

Configurações

Entidades

Automações

Modelos