Funds

Uma lista de Fundos.

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 fundos

Este objeto representa um fundo.

data.id

string

Identificador exclusivo para o objeto.

Example:

"fund_5f92f01728e009f403d8502e"

data.status

enum<string>

Status do fundo

Available options:

active,

inactive

Example:

"active"

data.name

string

Nome do fundo. Pode ser exibido na CCB e nos itens relacionados a cobrança e pagamento. No Brasil, use a razão social.

Example:

"FIDIC 01"

data.document

string

Documento do fundo. No Brasil, use o CNPJ.

data.address

object

A especificação de um endereço

data.settings

object

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

Fund Event

{
  "hasMore": true,
  "data": [
    {
      "id": "fund_5f92f01728e009f403d8502e",
      "status": "active",
      "name": "FIDIC 01",
      "document": "<string>",
      "address": {
        "city": "São Paulo",
        "state": "SP",
        "country": "BR",
        "line1": "Av Paulista",
        "line2": "Sala 404",
        "number": "123",
        "postalCode": "12123123",
        "neighborhood": "Bela Vista"
      },
      "settings": {
        "payments": {
          "bankAccount": {
            "type": "checking",
            "bankCode": "001",
            "bankName": "Banco do Brasil",
            "branch": "1234",
            "number": "1234567",
            "digit": "8"
          },
          "boleto": {
            "provider": "kobana",
            "config": {
              "token": "<string>",
              "host": "<string>",
              "account": "<string>"
            }
          }
        },
        "flags": {
          "allowRefinancing": true,
          "allowAcquittance": 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