Companies - Base39

Uma lista de empresas.

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 empresas

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.

data.id

string

Identificador exclusivo para o objeto.

Example:

"comp_5f92f01728e009f403d8502e"

data.status

enum<string>

default:active

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

Available options:

active,

inactive

Example:

"active"

data.document

string

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

Example:

"12123123000112"

data.name

string

Razão social

Example:

"Big Corporation SA"

data.friendlyName

string

Nome fantasia

Example:

"Big Corp"

data.group

string

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

Example:

"cgrp_5f92f01728e009f403d8502e"

data.address

object

A especificação de um endereço

data.creditPolicies

object[]

data.settings

object

data.settings.steps

object

Configurações do modo passo a passo

data.settings.steps.title

string

Título identificador do passo.

data.settings.steps.type

enum<string>

Tipo identificador do passo.

Available options:

signature,

disburse,

document_verification,

pass,

valid_employment,

custom_request,

create_documents,

attachments_to_request,

unico,

unico_check

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

data.settings.steps.needs

string[]

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

Slug do passo (step) dependente.

data.settings.steps.slug

string

Identificador único do passo.

data.settings.steps.hooks

object

Definição de hooks da esteira.

data.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"]

data.settings.loans

object

Configurações de empréstimos

data.settings.invoices

object

Configurações de faturas

data.settings.invoices.payOff

object

Configurações de quitação.

data.settings.invoices.companyRecurring

object

Configuração de recorrência de fatura.

data.settings.employments

object

Configurações de vínculos empregatícios

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

Company CompanyGroup

{
  "hasMore": true,
  "data": [
    {
      "id": "comp_5f92f01728e009f403d8502e",
      "status": "active",
      "document": "12123123000112",
      "name": "Big Corporation SA",
      "friendlyName": "Big Corp",
      "group": "cgrp_5f92f01728e009f403d8502e",
      "address": {
        "city": "São Paulo",
        "state": "São Paulo",
        "country": "BR",
        "line1": "Av Paulista",
        "line2": "Sala 404",
        "number": "123",
        "postalCode": "12123123",
        "neighborhood": "Bela Vista"
      },
      "creditPolicies": [
        {
          "id": "cpol_63ss07b6c39f5d3d917009b631"
        }
      ],
      "settings": {
        "steps": {
          "title": "<string>",
          "type": "signature",
          "methodData": {
            "schema": {
              "type": "operator",
              "role": "approver"
            }
          },
          "needs": [
            "<string>"
          ],
          "slug": "<string>",
          "hooks": {
            "onFailure": [
              "void_loan"
            ]
          },
          "onStart": [
            "mark_loan_as_pending"
          ]
        },
        "loans": {
          "concurrency": [
            {
              "quantityAllowed": 123,
              "status": [
                "open"
              ]
            }
          ],
          "conditions": [
            {
              "title": "<string>",
              "content": "<string>"
            }
          ]
        },
        "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
    }
  ]
}

Referências