Saltar al contenido principal

Selección de campos

Las lecturas de registros — los listados y los GET de un ítem — aceptan ?fields= para devolver solo las columnas que vas a usar:

curl -H "Authorization: Bearer $KOBANA_TOKEN" \
-H 'User-Agent: Mi Sistema (contacto@example.com)' \
-H "X-Workspace-Id: $WORKSPACE_ID" \
'https://api.finance.kobana.com.br/v1/payables?status=pending&fields=description,amount,due_date'
{
"data": [
{ "id": "8c8b4c4f-…", "description": "Alquiler", "amount": 1500.5, "due_date": "2026-11-10T00:00:00.000Z" }
],
"meta": { "next_cursor": null }
}

Reglas:

  • Nombres separados por coma, en snake_case — los mismos que trae la respuesta completa.
  • Sin el parámetro (o con él vacío), vuelven todos los campos.
  • El id siempre vuelve, aunque no se pida.
  • Solo el primer nivel: pedir un campo que es objeto (reconciliation, classification_centers) devuelve el objeto entero. No existe la sintaxis objeto.campo.
  • Un nombre que el recurso no tiene → 400 BAD_REQUEST, con details.unknown (lo que no se reconoció) y details.available (lo que existe). Un nombre equivocado nunca se ignora en silencio.
  • El meta del listado no se altera — el next_cursor sigue ahí.
  • Se combina con filtros, ordenación y paginación.

No aplica a escrituras (que devuelven el registro entero), a los totales (/aggregates, /cash-flow), al barrido de ids (/ids) ni a la descarga de adjuntos — ahí el parámetro se rechaza con 400.