Pular para o conteúdo principal

Fundos

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

  • Array [

    • id string

    Identificador exclusivo para o objeto.

    Example: fund_5f92f01728e009f403d8502e
    status string

    Status do fundo

    Possible values: [active, inactive]

    Example: active
    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
    document string

    Documento do fundo. No Brasil, use o CNPJ.

    address

    object

    A especificação de um endereço

    city stringrequired

    Cidade ou distrito.

    Example: São Paulo
    state stringrequired

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

    Example: SP
    country stringrequired

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

    Example: BR
    line1 stringrequired

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

    Example: Av Paulista
    line2 string

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

    Example: Sala 404
    number stringrequired

    Número do endereço.

    Example: 123
    postalCode stringrequired

    CEP ou Código postal.

    Example: 12123123
    neighborhood stringrequired

    Bairro.

    Example: Bela Vista

    settings

    payments

    object

    Configurações de pagamento

    bankAccount

    object

    type stringrequired

    Tipo da conta bancária

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

    Example: checking
    bankCode stringrequired

    Código do banco

    Example: 001
    bankName string

    Nome do banco

    Example: Banco do Brasil
    branch stringrequired

    Agência

    Example: 1234
    number stringrequired

    Número da conta

    Example: 1234567
    digit string

    Dígito da conta

    Example: 8

    boleto

    object

    provider stringrequired

    Provedor utilizado para os boletos

    Possible values: [kobana, default, test_only]

    Example: kobana

    config

    object

    nullable

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

    anyOf

    Configuração para o provedor Kobana

    token stringrequired

    Token para realizar requisições ao provedor

    host stringrequired

    Nome do host ou endereço IP ao qual se conectar

    account stringrequired

    ID da carteira de cobrança

    flags

    object

    Configurações das flags do fundo.

    allowRefinancing boolean

    Permitir refinanciamento.

    Example: true
    allowAcquittance boolean

    Permitir quitação.

    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 date-time

    Data de criação do objeto

    Example: 2023-08-25T22:38:41.134Z
    updatedAt date-time

    Data de alteração do objeto

    Example: 2023-08-25T22:38:41.134Z
    deleted boolean

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

    Default value: false
    Example: false

    createdBy

    object

    clientId string

    Identificador do cliente que criou a assinatura.

    Example: client_identifier
    externalClientId string

    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.

    app string

    Nome da aplicação que criou a assinatura.

    Example: backoffice

    updatedBy

    object

    clientId string

    Identificador do cliente que criou a assinatura.

    Example: client_identifier
    externalClientId string

    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.

    app string

    Nome da aplicação que criou a assinatura.

    Example: backoffice

  • ]