Atributos dos Lançamentos

Lista os atributos filtráveis dos lançamentos contábeis — inclui os campos personalizados com escopo de lançamento e os valores já observados, útil para montar filtros do endpoint de lançamentos.

Endpoint

Método e URL:

GET /api/v1/companies/:companyId/accounting/bank-accounts/attributes

Parâmetros da URL:

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

Exemplo

curl "https://api-business.openi.com.br/api/v1/companies/{companyId}/accounting/bank-accounts/attributes" \
  -H "Authorization: Bearer oak_368ba506f7b2_9f2c..."

Resposta

{
  "status": "success",
  "data": {
    "attributes": {
      "0d9e1f2a-3b4c-4d5e-6f7a-8b9c0d1e2f3a": {
        "label": "Filial",
        "values": ["Filial RJ", "Filial SP"]
      },
      "4b5c6d7e-8f9a-4b0c-1d2e-3f4a5b6c7d8e": {
        "label": "Centro de Custo",
        "values": ["Comercial", "Operações"]
      }
    }
  }
}

Cada chave é o id de um campo personalizado — use-o como id em filters ou sort no endpoint de lançamentos — veja Campos personalizados. values lista os valores já observados nos lançamentos da empresa. Retorna {} quando não há campos.

Endpoint

Exemplo

Resposta

On this page