Update a furlough balance mutation

PATCHhttps://<your-url>/api/v2/furlough-balance-mutations/{furlough_balance_mutation}

MCP id furlough-balance-mutations.updateAlso on this path: GET Read a furlough balance mutation, DELETE Delete a furlough balance mutation

View as Markdown openapi.json

Partially updates a mutation: absent keys are untouched, an empty body is rejected, and an unknown key is a 422.

Token scope: api:write:furlough
Without it: 403 insufficient-token-scope.
Permission: furlough::manage
Without it: 403 insufficient-permission.
Rate cost: 1 unit, write bucket. A write costs the same whatever view you ask for.
Also: Accepts If-Match. Never cached: private, no-store. Unknown body keys are refused, never dropped.

Both are checked, scope first. A token never does more than its user. How access is checked

Request

Example: Approve a pending leave request

curl -X PATCH \
  'https://<your-url>/api/v2/furlough-balance-mutations/1' \
  -H 'Authorization: Bearer <token>' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'If-Match: *' \
  -d '{
    "is_approved": true
  }'

const response = await fetch('https://<your-url>/api/v2/furlough-balance-mutations/1', {
  method: 'PATCH',
  headers: {
    'Authorization': 'Bearer <token>',
    'Accept': 'application/json',
    'Content-Type': 'application/json',
    'If-Match': '*',
  },
  body: JSON.stringify({
    "is_approved": true
  }),
});

use Illuminate\Support\Facades\Http;

$response = Http::withToken('<token>')
    ->acceptJson()
    ->withHeader('If-Match', '*')
    ->patch('https://<your-url>/api/v2/furlough-balance-mutations/1', [
        'is_approved' => true,
    ]);

import requests
response = requests.request(
    'PATCH',
    'https://<your-url>/api/v2/furlough-balance-mutations/1',
    headers={'Authorization': 'Bearer <token>', 'Accept': 'application/json', 'Content-Type': 'application/json', 'If-Match': '*'},
    json={'is_approved': True},
)

Response

The shape of the response, with sample values.

{
  "data": {
    "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": true,
    "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"
    }
  }
}

{
  "type": "https://developers.plnnrly.com/api/v2/problems/precondition-failed",
  "title": "Precondition failed",
  "status": 412,
  "detail": "The record changed since the version named in If-Match. Re-read it and retry.",
  "instance": "/api/v2/work-items/812",
  "request_id": "01K4B7Q9YV3PZ2N8T1E6M0XR4S",
  "current_version": 12
}

{
  "type": "https://developers.plnnrly.com/api/v2/problems/validation-failed",
  "title": "Validation failed",
  "status": 422,
  "detail": "3 fields failed validation.",
  "instance": "/api/v2/worklogs",
  "request_id": "01K4B7Q9YV3PZ2N8T1E6M0XR4S",
  "errors": [
    {
      "pointer": "/date",
      "code": "date_format",
      "detail": "The date does not match the format Y-m-d."
    },
    {
      "pointer": "/minutes",
      "code": "min",
      "detail": "The minutes must be at least 1."
    },
    {
      "pointer": "/description",
      "code": "required",
      "detail": "The description field is required."
    }
  ]
}

This is the API's only approval surface: {"is_approved": true} approves, {"is_approved": false} denies, and either needs furlough::manage, which is also this operation's own permission, so a plain employee cannot edit even their own pending request here although plnnrly lets them while it is still in the future. A manager deciding on their own mutation answers 403 forbidden-by-policy. ⚠ An approval through this endpoint is a plain field write: unlike the approval screen in plnnrly it does not split a request that spans two balance years into one mutation per year, and it sends the employee no e-mail. ⚠ start and end move as a pair (send both or neither), and neither rewrites year, so a period moved into another year keeps counting against the old balance year until year is sent too. Send If-Match with the ETag from your last read to detect a concurrent edit, which answers 412. Treat it as best-effort only: this resource carries no concurrency token, and updated_at is second-precision, so two writes inside the same second are indistinguishable.

Path parameters

furlough_balance_mutationintegerRequired

The FurloughBalanceMutation's numeric id.

Query parameters

Unknown parameters are refused with 400, naming the parameter.

viewstring

Which field set to render.

summarydetaildefault

Request headers

X-Request-Idstringpattern

A correlation id of your own. It is recorded in our logs next to the server's request id but never returned: the response header always carries the server's id. A value that does not match the pattern is discarded silently, never rejected.

If-Matchstring

The ETag a write is conditional on. A stale validator is 412 precondition-failed.

Request body

Unknown keys are refused with 422, naming the key.

yearinteger1970 to 2200

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.

typestring

Which leave balance this mutation moves. Regular and special leave are separate balances and never offset one another.

regular: Ordinary paid leave, drawn from the employee's regular annual balance.
special: Special leave: a separate balance granted for a specific entitlement, never offset against regular leave.

New values may be added.

minutesinteger

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.

A positive value grants balance and requires the furlough::manage permission; a caller with only furlough::create_for_yourself may write a negative value (a leave request) or zero. On a special mutation, the resulting special-leave balance for the year may not go negative.

starttimestamp (YYYY-MM-DDThh:mm:ssZ)

Start of the period this mutation covers, in UTC. Equal to end on a manual balance adjustment, which covers no period at all.

Required when end is present.

endtimestamp (YYYY-MM-DDThh:mm:ssZ)

End of the period this mutation covers, in UTC. Never before start, and equal to it on a manual balance adjustment.

Required when start is present. Must be on or after start.

descriptionstring

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_approvedboolean or null

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.

Response 200

Returns a FurloughBalanceMutation in the detail view.

Headers

ETag: A strong validator of exactly this representation.
RateLimit: The IETF httpapi-ratelimit-headers form of your remaining allowance on the tightest bucket this request touched.
RateLimit-Policy: The ceiling and window of that bucket, as <limit>;w=<seconds>.
X-Request-Id: The server-generated ULID correlating this response with our logs.

Every response also carries Cache-Control, Vary, X-Content-Type-Options, X-Plnnrly-Api-Version, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset. Headers and versioning

idinteger

Unique identifier.

user_idintegerServer-assigned

The employee this mutation belongs to. Always the authenticated user on create and not writable.

acceptor_idinteger or nullServer-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}.

yearinteger