Pular para o conteúdo principal

Fund

Este objeto representa um fundo.

idstring

Identificador exclusivo para o objeto.

Example: fund_5f92f01728e009f403d8502e
statusstring

Status do fundo

Possible values: [active, inactive]

Example: active
namestring

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
documentstring

Documento do fundo. No Brasil, use o CNPJ.

address object

A especificação de um endereço

citystringrequired

Cidade ou distrito.

Example: São Paulo
statestringrequired

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

Example: SP
countrystringrequired

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

Example: BR
line1stringrequired

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

Example: Av Paulista
line2string

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

Example: Sala 404
numberstringrequired

Número do endereço.

Example: 123
postalCodestringrequired

CEP ou Código postal.

Example: 12123123
neighborhoodstringrequired

Bairro.

Example: Bela Vista
settings
payments object

Configurações de pagamento

bankAccount object
typestringrequired

Tipo da conta bancária

Possible values: [checking, savings, salary, payment]

Example: checking
bankCodestringrequired

Código do banco

Example: 001
bankNamestring

Nome do banco

Example: Banco do Brasil
branchstringrequired

Agência

Example: 1234
numberstringrequired

Número da conta

Example: 1234567
digitstring

Dígito da conta

Example: 8
boleto object
providerstringrequired

Provedor utilizado para os boletos

Possible values: [kobana, default, test_only]

Example: kobana
config objectnullable

Objeto para definir a configuração para utilização do provedor de boletos

anyOf
flags object

Configurações das flags do fundo.

allowRefinancingboolean

Permitir refinanciamento.

Example: true
allowAcquittanceboolean

Permitir quitação.

Example: true
metadataobject

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.

createdAtdate-time

Data de criação do objeto

Example: 2023-08-25T22:38:41.134Z
updatedAtdate-time

Data de alteração do objeto

Example: 2023-08-25T22:38:41.134Z
deletedboolean

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

Default value: false
Example: false
createdBy object
clientIdstring

Identificador do cliente que criou a assinatura.

Example: client_identifier
externalClientIdstring

Chave de identificação do cliente externo. Utilizada para identificar o cliente que está realizando a requisição. Populado pelo campo enviado no header base39-external-client-id.

appstring

Nome da aplicação que criou a assinatura.

Example: backoffice
updatedBy object
clientIdstring

Identificador do cliente que criou a assinatura.

Example: client_identifier
externalClientIdstring

Chave de identificação do cliente externo. Utilizada para identificar o cliente que está realizando a requisição. Populado pelo campo enviado no header base39-external-client-id.

appstring

Nome da aplicação que criou a assinatura.

Example: backoffice
Fund
{
  "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"
  }
}