Sign in
Budget

Get a balance group

Returns a single balance group by id, with its computed totals, embedded manager, and bound vendor_cards.

Readable by admin / budgets_manage users and by the group's own manager. A group outside the caller's scope returns 404 Not Found.

get/v1/budgets/{id}

Path parameters

idstring uuid required

The UUID of the balance group (budget).

Parameters

#/paths/~1v1~1bills/get/parameters/0 — unresolved $ref

Response

The requested balance group.

idstring uuid required
company_idstring uuid required
namestring required
descriptionstring nullable
currencystring required
allocated_amount_centsinteger required

Funds reserved into this group's pool from the company's global pool.

manager_idstring nullable

User id of the group's manager ("Encargado").

committable_centsinteger

Manager-facing "what's left to commit/spend": nets out funds already loaded onto prepaid (PLH) cards, so it matches what new charges and card loads will actually allow. Added via serializer method.

available_centsinteger

Company-reservation view of what's left in the pool (allocated + consumed_balance). Added via serializer method.

consumed_balance_centsinteger

Net amount consumed from the pool (<= 0 for net spend), summed from the balance-affecting ledger. Added via serializer method.

dissolved_atstring date-time nullable

When the group was soft-deleted ("deshacer"). null for active groups; a timestamp for dissolved ones. Active listings only return active groups, but the field is present on the record.

created_atstring date-time
updated_atstring date-time

Example response

{
  "name": "Marketing",
  "description": "Presupuesto del equipo de marketing",
  "currency": "CLP",
  "allocated_amount_cents": 5000000,
  "committable_cents": 3200000,
  "available_cents": 3500000,
  "consumed_balance_cents": -1500000,
  "vendor_cards": [
    {
      "last4": "4242",
      "limit_currency": "CLP"
    }
  ]
}

Changes