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.

id

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

Show child attributes

address.city

string

required

Cidade ou distrito.

Example:

"São Paulo"

address.state

string

required

Estado, município, província ou região.

Example:

"São Paulo"

address.country

string

required

Código de país de duas letras (ISO 3166-1 alpha-2).

Example:

"BR"

address.line1

string

required

Linha de endereço 1 (por exemplo, rua, caixa postal).

Example:

"Av Paulista"

address.number

string

required

Número do endereço.

Example:

"123"

address.postalCode

string

required

CEP ou Código postal.

Example:

"12123123"

address.neighborhood

string

required

Bairro.

Example:

"Bela Vista"

address.line2

string

Linha de endereço 2 (por exemplo, apartamento, suíte, unidade ou prédio).

Example:

"Sala 404"

creditPolicies

object[]

Show child attributes

creditPolicies.id

string

Example:

"cpol_63ss07b6c39f5d3d917009b631"

settings

object

Show child attributes

settings.steps

object

Configurações do modo passo a passo

Show child attributes

settings.steps.title

string

Título identificador do passo.

settings.steps.type

enum<string>

Tipo identificador do passo.

Available options:

signature,

disburse,

document_verification,

pass,

valid_employment,

custom_request,

attachments_to_request

settings.steps.methodData

object

Objeto que contém dados específicos para o tipo de etapa. Por exemplo, se a etapa for do tipo signature, este objeto conterá os dados necessários para a assinatura do documento.

Show child attributes

settings.steps.methodData.schema

object

Configuração do responsável pela assinatura.

• signature
• document_verification
• valid_employment
• custom_request
• unico
• attachments_to_request

Show child attributes

settings.steps.methodData.schema.type

enum<string>

Tipo responsável pela assinatura.

Available options:

operator,

customer

settings.steps.methodData.schema.role

enum<string>

Papel assumido.

Available options:

approver,

financial,

administrator,

backoffice

Example:

"approver"

settings.steps.needs

string[]

Array de dependência (slugs) entre os passos necessarios para que esse seja executado.

Slug do passo (step) dependente.

settings.steps.slug

string

Identificador único do passo.

settings.steps.hooks

object

Definição de hooks da esteira.

Show child attributes

settings.steps.hooks.onFailure

enum<string>[]

Lista de ações que serão executadas se um passo da esteira falhar.

Available options:

void_loan,

cancel_loan

Example:

["void_loan"]

settings.steps.onStart

enum<string>[]

Lista de ações que serão executadas ao iniciar um passo da esteira.

Available options:

mark_loan_as_pending

Example:

["mark_loan_as_pending"]

settings.loans

object

Configurações de empréstimos

Show child attributes

settings.loans.concurrency

object[]

Configurações referentes às limitações na criação de loans simultâneos.

Show child attributes

settings.loans.concurrency.quantityAllowed

number

Número de empréstimos permitidos.

settings.loans.concurrency.status

enum<string>[]

Status a ser considerado na limitação da criação dos empréstimos.

Available options:

open,

disbursed,

disbursing,

repaid,

void,

canceled,

expired,

pending

settings.loans.conditions

object[]

Termos e Condições do empréstimo.

Show child attributes

settings.loans.conditions.title

string

Texto identificador da condição de empréstimos.

settings.loans.conditions.content

string

Conteúdo da condição.

settings.invoices

object

Configurações de faturas

Show child attributes

settings.invoices.payOff

object

Configurações de quitação.

Show child attributes

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.

Show child attributes

settings.invoices.payOff.fine.amount

number

Valor da multa representado em base decimal. A Multa é cobrada uma única vez independente do número de dias de vencimento. O valor máximo para multa é de 2% (0.02).

Example:

0.02

settings.invoices.payOff.fine.daysToStart

integer

Quantidade de dias após o vencimento que a multa começará a incidir.

Example:

1

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.

Show child attributes

settings.invoices.payOff.interest.amount

number

Valor de juros representado em base decimal e ao mês. O valor máximo permitido é 1% (0.01). Os Juros são definidos ao mês, mas calculo para o pagamento após o vencimento converte para juros ao dia e aplica a quantidade de dias em atraso.

Example:

0.01

settings.invoices.payOff.interest.daysToStart

integer

Quantidade de dias após o vencimento que juro começará a incidir.

Example:

1

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.

Show child attributes

settings.invoices.payOff.daysUntilDue.type

enum<string>

Tipo de dias. Absoluto representa uma composição de um determinado dia somado ao valor definido em amount. O resultado dessa soma será considerado a data para fechamento da fatura. Exemplo: dia 5 + amount (3) 08/mês/ano.

Available options:

absolute

Example:

"absolute"

settings.invoices.payOff.daysUntilDue.amount

number

Dia exato ou a quantidade de dias.

Example:

1

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.

Show child attributes

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.

Show child attributes

settings.invoices.companyRecurring.fine.amount

number

Valor da multa representado em base decimal. A Multa é cobrada uma única vez independente do número de dias de vencimento. O valor máximo para multa é de 2% (0.02).

Example:

0.02

settings.invoices.companyRecurring.fine.daysToStart

integer

Quantidade de dias após o vencimento que a multa começará a incidir.

Example:

1

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.

Show child attributes

settings.invoices.companyRecurring.interest.amount

number

Valor de juros representado em base decimal e ao mês. O valor máximo permitido é 1% (0.01). Os Juros são definidos ao mês, mas calculo para o pagamento após o vencimento converte para juros ao dia e aplica a quantidade de dias em atraso.

Example:

0.01

settings.invoices.companyRecurring.interest.daysToStart

integer

Quantidade de dias após o vencimento que juro começará a incidir.

Example:

1

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.

Show child attributes

settings.invoices.companyRecurring.daysUntilDue.type

enum<string>

Tipo de dias usado no fechamento da fatura. Representa o dia do mês (1 até 28) para fechamento da fatura.

Available options:

static

Example:

"static"

settings.invoices.companyRecurring.daysUntilDue.amount

number

Dia do mês para fechamento da fatura.

Example:

10

settings.invoices.companyRecurring.create

object

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

Show child attributes

settings.invoices.companyRecurring.create.cutoffDay

number

Example:

25

settings.invoices.companyRecurring.create.autoCreate

boolean

Define se a fatura deve ser criada automaticamente.

Example:

true

settings.invoices.companyRecurring.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:

false

settings.employments

object

Configurações de vínculos empregatícios

Show child attributes

settings.employments.expireInDays

integer

Quantidade de dias para expirar o vínculo empregatício.

Example:

30

settings.employments.canUpdateEmploymentData

boolean

Se o customer pode atualizar o salário caso o employment esteja expirado.

Example:

true

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