FurloughBalanceMutation
A furlough balance mutation: one signed ledger entry against an employee's leave balance for a year and a leave type.
- Summary view
- FurloughBalanceMutationList, 14 fields. What a list returns by default.
- Detail view
- FurloughBalanceMutation, 14 fields. The default for a single read and for every write.
- Read with
- api:
read: furlough - Write with
- api:
write: andfurlough::furlough create_for_yourself
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
/furlough-balance-mutations/{furlough_balance_mutation}FurloughBalanceMutation/furlough-balance-mutations/{furlough_balance_mutation}FurloughBalanceMutationFields
- Detail only
- Only in the detail view.
- Only with include
- Only when you ask for it with include.
- Server-assigned
- Set by plnnrly, never by a request.
The employee this mutation belongs to. Always the authenticated user on create and not writable.
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}.
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.
Which leave balance this mutation moves. Regular and special leave are separate balances and never offset one another.
regularspecial
New values may be added.
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 of the period this mutation covers, in UTC. Equal to end on a manual balance adjustment, which covers no period at all.
End of the period this mutation covers, in UTC. Never before start, and equal to it on a manual balance adjustment.
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.
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.
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.
Variants
FurloughBalanceMutationList 14 fields
What a collection returns, and what ?view=summary returns on a single record.
The same fields as the detail object.
FurloughBalanceMutationSummary 3 fields
The embedded form: what you get when another resource carries this one and you did not include it.
Leaves out: user_id, acceptor_id, type, start, end, description, is_approved, user, created_at, updated_at, links
FurloughBalanceMutationLinks 1 field
The links object on this resource.
Keys: self
Something wrong or missing on this page? Tell us