Create a furlough balance mutation

POSThttps://<your-url>/api/v2/furlough-balance-mutations

MCP id furlough-balance-mutations.storeAlso on this path: GET List furlough balance mutations

Creates one mutation for the authenticated user and returns it with a Location header.

Token scope: api:write:furlough
Without it: 403 insufficient-token-scope.
Permission: furlough::create_for_yourself
Without it: 403 insufficient-permission.
Rate cost: 1 unit, write bucket. A write costs the same whatever view you ask for.
Also: Accepts Idempotency-Key. 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: Request two days of regular leave

curl -X POST \
  'https://<your-url>/api/v2/furlough-balance-mutations' \
  -H 'Authorization: Bearer <token>' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: <key>' \
  -d '{
    "year": 2026,
    "minutes": -960,
    "start": "2026-07-06T00:00:00Z",
    "end": "2026-07-07T23:59:59Z",
    "description": "Long weekend"
  }'

const response = await fetch('https://<your-url>/api/v2/furlough-balance-mutations', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer <token>',
    'Accept': 'application/json',
    'Content-Type': 'application/json',
    'Idempotency-Key': '<key>',
  },
  body: JSON.stringify({
    "year": 2026,
    "minutes": -960,
    "start": "2026-07-06T00:00:00Z",
    "end": "2026-07-07T23:59:59Z",
    "description": "Long weekend"
  }),
});

use Illuminate\Support\Facades\Http;

$response = Http::withToken('<token>')
    ->acceptJson()
    ->withHeader('Idempotency-Key', '<key>')
    ->post('https://<your-url>/api/v2/furlough-balance-mutations', [
        'year' => 2026,
        'minutes' => -960,
        'start' => '2026-07-06T00:00:00Z',
        'end' => '2026-07-07T23:59:59Z',
        'description' => 'Long weekend',
    ]);

import requests
response = requests.request(
    'POST',
    'https://<your-url>/api/v2/furlough-balance-mutations',
    headers={'Authorization': 'Bearer <token>', 'Accept': 'application/json', 'Content-Type': 'application/json', 'Idempotency-Key': '<key>'},
    json={'year': 2026, 'minutes': -960, 'start': '2026-07-06T00:00:00Z', 'end': '2026-07-07T23:59:59Z', 'description': 'Long weekend'},
)

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": 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"
    }
  }
}

{
  "type": "https://developers.plnnrly.com/api/v2/problems/idempotency-key-in-flight",
  "title": "Idempotency key in flight",
  "status": 409,
  "detail": "The original request for this Idempotency-Key is still being processed. Retry shortly.",
  "instance": "/api/v2/worklogs",
  "request_id": "01K4B7Q9YV3PZ2N8T1E6M0XR4S"
}

{
  "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."
    }
  ]
}

user_id is always the caller: this resource carries no on-behalf-of field, so a manager cannot post a mutation for another employee through the API even though the balance screen in plnnrly can. A negative minutes is a leave request over the period; a positive minutes grants balance and requires furlough::manage. is_approved is not accepted: the mutation is always the caller's own, so every mutation is created pending and is approved or denied by someone else through PATCH. A special-leave request that would take the special-leave balance for the year below zero is rejected with 422. Creating a pending mutation notifies every furlough::manage holder by e-mail.

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.

Idempotency-Keystring≤ 255

A caller-chosen key that makes this POST safe to retry. Replaying it returns the original response with Idempotency-Replayed: true.

Request body

Unknown keys are refused with 422, naming the key.

yearinteger1970 to 2200Required

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.

minutesintegerRequired

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)Required

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

endtimestamp (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.

Must be on or after start.

descriptionstringRequired

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.

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.

Response 201

Returns a FurloughBalanceMutation in the detail view.

Headers

ETag: A strong validator of exactly this representation.
Idempotency-Replayed: true when this response was replayed from a stored Idempotency-Key rather than produced by a new write.
Location: The absolute URL of the created or queued resource.
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

typestring

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

regularspecial

New values may be added.

minutesinteger

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.

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.

descriptionstringMultiline

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.

userRef or UserSummary

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.