Histórico de um Campo

Retorna o histórico de alterações do valor de um campo personalizado em uma conta bancária.

Endpoint

Método e URL:

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

Parâmetros da URL:

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

Exemplo

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

Resposta

{
  "status": "success",
  "data": {
    "history": [
      {
        "value": "Gestora Beta",
        "source": "manual",
        "updatedBy": { "id": "3c4d5e6f-7a8b-4c9d-0e1f-2a3b4c5d6e7f", "name": "Maria Souza" },
        "updatedAt": "2026-07-20T18:45:00.000Z"
      },
      {
        "value": null,
        "source": "system",
        "updatedBy": null,
        "updatedAt": "2026-06-01T10:00:00.000Z"
      }
    ]
  }
}

Cada item registra o valor definido naquela alteração, ordenado da mais recente para a mais antiga.

source: manual, rule, batch ou system
updatedBy: usuário responsável, ou null para alterações automáticas

Endpoint

Exemplo

Resposta

On this page