# FurloughBalanceMutation

A furlough balance mutation: one signed ledger entry against an employee's leave balance for a `year` and a leave `type`. A negative `minutes` consumes balance and is a leave request over the period from `start` to `end`; a positive `minutes` grants balance and is an adjustment a manager posts. `is_approved` is three-state and the `null` is semantic: `null` means pending approval, `true` approved, `false` denied. The balance counts the pending and the approved alike, never the denied, so a pending request already reduces what is left.

## Used by
- GET /api/v2/furlough-balance-mutations: List furlough balance mutations (FurloughBalanceMutationList)
- POST /api/v2/furlough-balance-mutations: Create a furlough balance mutation (FurloughBalanceMutation)
- GET /api/v2/furlough-balance-mutations/{furlough_balance_mutation}: Read a furlough balance mutation (FurloughBalanceMutation)
- PATCH /api/v2/furlough-balance-mutations/{furlough_balance_mutation}: Update a furlough balance mutation (FurloughBalanceMutation)

## FurloughBalanceMutation fields
- id (integer, required): Unique identifier.
- user_id (integer, required, server-assigned): The employee this mutation belongs to. Always the authenticated user on create and not writable.
- acceptor_id (integer or null, required, server-assigned): The user who approved this mutation, set by the server when the mutation resolves to approved. Null while it is pending, and left `null` by a denial. Resolve the name through `GET /api/v2/users/{user}`.
- year (integer, required): The balance year this mutation counts against. It is not derived from `start`: every balance sum counts by this year, so a mutation whose period moves into another year keeps counting against the year sent here until `year` is sent too.
- type (string, required): Which leave balance this mutation moves. Regular and special leave are separate balances and never offset one another.
- minutes (integer, required): The signed balance delta in minutes. Negative consumes balance (a leave request); positive grants it (a manager's adjustment, which requires the `furlough::manage` permission to write). The API never computes this from the employee's working week or the organisation's free days: send the exact number of minutes you mean.
- start (timestamp (YYYY-MM-DDThh:mm:ssZ), required): Start of the period this mutation covers, in UTC. Equal to `end` on a manual balance adjustment, which covers no period at all.
- end (timestamp (YYYY-MM-DDThh:mm:ssZ), required): End of the period this mutation covers, in UTC. Never before `start`, and equal to it on a manual balance adjustment.
- description (string, required, multiline): The employee's or manager's own words for this mutation: the reason for the leave, or what the adjustment is for. The only field `?q=` searches.
- is_approved (boolean or null, required): Approval state, in three values: `null` means pending approval, `true` approved, `false` denied. The balance counts pending and approved mutations alike and ignores denied ones. Writing this field at all requires the `furlough::manage` permission.
- user (Ref or UserSummary, required): The employee this mutation belongs to. Expanding it with `?include=user` additionally requires the `users::read` permission and a token scope covering the users prefix.
- created_at (timestamp (YYYY-MM-DDThh:mm:ssZ), required): Creation timestamp.
- updated_at (timestamp (YYYY-MM-DDThh:mm:ssZ), required): Last-write timestamp; use for incremental sync.
- links (FurloughBalanceMutationLinks, required)
  - self (url, required): The canonical URI of this record.

## Variants

### FurloughBalanceMutationList

What a collection returns, and what `?view=summary` returns on a single record.

14 fields.
Identical to the detail object above.

### FurloughBalanceMutationSummary

The embedded form: what you get when another resource carries this one and you did not `include` it.

3 fields.
Omits: user_id, acceptor_id, type, start, end, description, is_approved, user, created_at, updated_at, links

### FurloughBalanceMutationLinks

The `links` object on this resource.

Keys: self

## Example
```json
{
  "id": 1,
  "user_id": 1,
  "acceptor_id": 1,
  "year": 2026,
  "type": "regular",
  "minutes": -960,
  "start": "2026-07-06T00:00:00Z",
  "end": "2026-07-07T23:59:59Z",
  "description": "Long weekend",
  "is_approved": false,
  "user": {
    "id": 1
  },
  "created_at": "2026-03-04T09:15:00Z",
  "updated_at": "2026-03-04T09:15:00Z",
  "links": {
    "self": "https://<your-url>/api/v2/work-items/1"
  }
}
```