Campos de uma Conta

Retorna os campos personalizados e valores de uma conta bancária específica.

Endpoint

Método e URL:

GET /api/v1/companies/:companyId/custom-fields/bank-accounts/:bankAccountId

Parâmetros da URL:

companyId (uuid, obrigatório): Identificador da empresa
bankAccountId (uuid, obrigatório): Identificador da conta bancária

Parâmetros de query:

enabled (boolean, opcional): Se true, retorna apenas campos habilitados

Exemplo

curl "https://api-business.openi.com.br/api/v1/companies/{companyId}/custom-fields/bank-accounts/6f1c2b3a-8d4e-4a5b-9c0d-1e2f3a4b5c6d" \
  -H "Authorization: Bearer oak_368ba506f7b2_9f2c..."

Resposta

{
  "status": "success",
  "data": {
    "fields": [
      {
        "field": {
          "id": "7a1b2c3d-4e5f-4a6b-8c7d-9e0f1a2b3c4d",
          "name": "Gestora",
          "key": "gestora",
          "type": "string",
          "origin": "bankAccount",
          "enabled": true,
          "scopes": ["banking.bank_accounts"]
        },
        "value": "Gestora Alfa"
      }
    ]
  }
}

value é null quando o campo não está preenchido para a conta. Retorna 404 se a conta não pertencer à empresa.

Endpoint

Exemplo

Resposta

On this page