Pular para o conteúdo principal

Seleção de campos

As leituras de registro — as listagens e os GET de um item — aceitam ?fields= para devolver só as colunas que você vai usar:

curl -H "Authorization: Bearer $KOBANA_TOKEN" \
-H 'User-Agent: Meu Sistema (contato@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": "Aluguel", "amount": 1500.5, "due_date": "2026-11-10T00:00:00.000Z" }
],
"meta": { "next_cursor": null }
}

Regras:

  • Nomes separados por vírgula, em snake_case — os mesmos que a resposta completa traz.
  • Sem o parâmetro (ou com ele vazio), voltam todos os campos.
  • O id sempre volta, mesmo que não seja pedido.
  • Só o primeiro nível: pedir um campo que é objeto (reconciliation, classification_centers) devolve o objeto inteiro. Não há sintaxe objeto.campo.
  • Um nome que o recurso não tem → 400 BAD_REQUEST, com details.unknown (o que não foi reconhecido) e details.available (o que existe). Um nome errado nunca é ignorado em silêncio.
  • O meta da listagem não é afetado — o next_cursor continua lá.
  • Combina com filtros, ordenação e paginação.

Não se aplica a escritas (que devolvem o registro inteiro), aos totais (/aggregates, /cash-flow), à varredura de ids (/ids) nem ao download de anexo — nesses o parâmetro é recusado com 400.