Company

Este objeto representa uma empresa do seu negócio. Ele permite que você crie vínculos empregatícios e rastreie contratos que pertencem a mesma empresa.

string

Identificador exclusivo para o objeto.

Example:

"comp_5f92f01728e009f403d8502e"

status

enum<string>

default:active

Identifica se a empresa está ativa para receber novos empréstimos.

Available options:

active,

inactive

Example:

"active"

document

string

Documento de identificação da empresa. Deve ser o CNPJ.

Example:

"12123123000112"

name

string

Razão social

Example:

"Big Corporation SA"

friendlyName

string

Nome fantasia

Example:

"Big Corp"

group

string

Grupo empresarial que a empresa faz parte. [Expansível]

Example:

"cgrp_5f92f01728e009f403d8502e"

address

object

A especificação de um endereço

creditPolicies

object[]

settings

object

settings.steps

object

settings.loans

object

Configurações de empréstimos

settings.invoices

object

Configurações de faturas

settings.invoices.payOff

object

Configurações de quitação.

settings.invoices.payOff.fine

object

Definição de incidência de multas. Campo reservado para instruções específicas do boleto. Não se aplica a cálculos.

settings.invoices.payOff.interest

object

Definição de incidência de juros. Campo reservado para instruções específicas do boleto. Não se aplica a cálculos.

settings.invoices.payOff.allowOverduePayment

boolean

Permite pagamento da fatura após o vencimento.

Example:

true

settings.invoices.payOff.daysUntilDue

object

Definição de regras para o fechamento da fatura.

settings.invoices.payOff.updateInvoiceItemOnInsert

boolean

Define se no ato de criar o item de fatura será calculado automaticamente descontos/multa para a fatura em contexto. Os valores base usados nesse cálculos são originados de payOff, customerRecurring ou companyRecurring.

Example:

true

settings.invoices.companyRecurring

object

Configuração de recorrência de fatura.

settings.invoices.companyRecurring.fine

object

Definição de incidência de multas. Campo reservado para instruções específicas do boleto. Não se aplica a cálculos.

settings.invoices.companyRecurring.interest

object

Definição de incidência de juros. Campo reservado para instruções específicas do boleto. Não se aplica a cálculos.

settings.invoices.companyRecurring.allowOverduePayment

boolean

Permite pagamento da fatura após o vencimento.

Example:

true

settings.invoices.companyRecurring.daysUntilDue

object

Definição de regras para o fechamento da fatura.

settings.invoices.companyRecurring.create

object

Definição de regras para geração de fatura.

settings.invoices.companyRecurring.updateInvoiceItemOnInsert

boolean

Example:

false

settings.employments

object

Configurações de vínculos empregatícios

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

PaymentIntents Companies

{
  "id": "comp_5f92f01728e009f403d8502e",
  "status": "active",
  "document": "12123123000112",
  "name": "Big Corporation SA",
  "friendlyName": "Big Corp",
  "group": "cgrp_5f92f01728e009f403d8502e",
  "address": {
    "city": "São Paulo",
    "state": "SP",
    "country": "BR",
    "line1": "Av Paulista",
    "line2": "Sala 404",
    "number": "123",
    "postalCode": "12123123",
    "neighborhood": "Bela Vista"
  },
  "creditPolicies": [
    {
      "id": "cpol_63ss07b6c39f5d3d917009b631"
    }
  ],
  "settings": {
    "steps": {},
    "loans": {
      "concurrency": [
        {
          "quantityAllowed": 123,
          "status": [
            "open"
          ]
        }
      ],
      "conditions": [
        {
          "title": "<string>",
          "content": "<string>"
        }
      ],
      "refin": {
        "minDays": 123
      },
      "expireInDays": 123
    },
    "invoices": {
      "payOff": {
        "fine": {
          "amount": 0.02,
          "daysToStart": 1
        },
        "interest": {
          "amount": 0.01,
          "daysToStart": 1
        },
        "allowOverduePayment": true,
        "daysUntilDue": {
          "type": "absolute",
          "amount": 1
        },
        "updateInvoiceItemOnInsert": true
      },
      "companyRecurring": {
        "fine": {
          "amount": 0.02,
          "daysToStart": 1
        },
        "interest": {
          "amount": 0.01,
          "daysToStart": 1
        },
        "allowOverduePayment": true,
        "daysUntilDue": {
          "type": "static",
          "amount": 10
        },
        "create": {
          "cutoffDay": 25,
          "autoCreate": true
        },
        "updateInvoiceItemOnInsert": false
      }
    },
    "employments": {
      "expireInDays": 30,
      "canUpdateEmploymentData": true
    }
  },
  "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