Listar Campos de Contas

Lista as definições de campos personalizados com escopo de conta bancária e os valores por conta.

Endpoint

Método e URL:

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

Parâmetros da URL:

companyId (uuid, obrigatório): Identificador da empresa

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?enabled=true" \
  -H "Authorization: Bearer oak_368ba506f7b2_9f2c..."

Resposta

{
  "status": "success",
  "data": {
    "fields": [
      {
        "id": "7a1b2c3d-4e5f-4a6b-8c7d-9e0f1a2b3c4d",
        "name": "Gestora",
        "key": "gestora",
        "type": "string",
        "origin": "bankAccount",
        "enabled": true,
        "scopes": ["banking.bank_accounts"]
      }
    ],
    "valuesByAccount": {
      "6f1c2b3a-8d4e-4a5b-9c0d-1e2f3a4b5c6d": {
        "7a1b2c3d-4e5f-4a6b-8c7d-9e0f1a2b3c4d": "Gestora Alfa"
      }
    }
  }
}

type: string, number, boolean, date, dateRange ou state
origin: bankAccount (criado para contas) ou classifier (derivado de classificador)
valuesByAccount: mapa { bankAccountId: { fieldId: valor } } — os valores são sempre strings, inclusive para campos boolean ("true" / "false") e number; contas sem nenhum valor preenchido não aparecem no mapa

Endpoint

Exemplo

Resposta

On this page