CreditPolicy

Este objeto representa uma política de crédito.

string

Identificador exclusivo para o objeto.

Example:

"crpl_5f92f01728e009f403d8502e"

status

enum<string>

Available options:

active,

inactive

name

string

Nome da política de crédito.

Example:

"Consignado"

model

enum<string>

Available options:

EMPLOYMENT_LENGTH_SALARY_MULTIPLIER

Example:

"EMPLOYMENT_LENGTH_SALARY_MULTIPLIER"

product

string

Id do produto associado a política de crédito.

Example:

"prod_5f92f01728e009f403d8502e"

options

object

Modelo que aplica uma taxa de juros em faixas baseado no tempo de casa em meses.

options.interestType

enum<string>

required

Tipo de juros aplicado na dívida.

Available options:

pre_price_days

Example:

"pre_price_days"

options.creditOperationType

enum<string>

required

Tipo de operação de crédito

Available options:

ccb

Example:

"ccb"

options.rebates

object[]

required

Detalhes das taxas de um empréstimo.

options.fine

object

required

options.rules

object[]

required

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.

createdAt

string

Data de criação do objeto

Example:

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

updatedAt

string

Data de alteração do objeto

Example:

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

deleted

boolean

default:false

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

Example:

false

createdBy

object

updatedBy

object

CompanyGroups CreditPolicies

Copy
{
  "id": "crpl_5f92f01728e009f403d8502e",
  "status": "active",
  "name": "Consignado",
  "model": "EMPLOYMENT_LENGTH_SALARY_MULTIPLIER",
  "product": "prod_5f92f01728e009f403d8502e",
  "options": {
    "interestType": "pre_price_days",
    "creditOperationType": "ccb",
    "rebates": [
      {
        "feeType": "first_loan",
        "amountType": "percentage",
        "amount": 0.2,
        "description": "Tarifa de cadastro",
        "minAmount": 200,
        "maxAmount": 2000
      }
    ],
    "fine": {
      "fineRate": 0.02,
      "interestBase": "calendar_days",
      "monthlyRate": 0.02
    },
    "rules": [
      {
        "workingMonthsRangeStart": 6,
        "workingMonthsRangeEnd": 12,
        "salaryMultiples": 2,
        "minimumDisbursementAmount": 200,
        "maximumDisbursementAmount": 2000,
        "fund": "fund_5f92f01728e009f403d8502e",
        "monthlyFee": [
          {
            "installmentsRangeStart": 12,
            "installmentsRangeEnd": 36,
            "amount": 0.02,
            "insurance": {
              "fee": 123,
              "type": "uninsured",
              "number": "<string>",
              "insurer": "<string>"
            }
          }
        ]
      }
    ]
  },
  "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