Skip to navigation

Staff Permissions

Staff with the Custom role can only do what their permissions allow. These are the same permissions an admin ticks in the SalaryBox app’s role grid.

List Available Permissions (GET /customer/v1/staff/permissions) returns this list live, with each permission’s section and what it also needs. Integrations should read it instead of hard-coding the table below.

Use these names with (shared rules for all write endpoints are on Writing Data):

  • Set Staff Permissions (PUT /customer/v1/staff/{salarybox_id}/permissions) to give a Custom-role staff member exactly this set.
  • Set Staff Role (PUT /customer/v1/staff/{salarybox_id}/role) to give a staff member the Custom role first.
  • Fetch Single Staff (GET /customer/v1/staff/fetch-employee), whose permissions field shows the set a Custom-role staff member has now.

Rules

  • Names are case-sensitive and must be written exactly as below. Any other name is refused with Unknown permission 'x'.
  • An :edit permission needs its :view permission in the same request, and reimbursement_request:approve needs reimbursement_request:view. Otherwise the request is refused, e.g. 'staff_details:edit' also needs 'staff_details:view'.
  • Setting permissions replaces the whole set, so send every permission the staff member should keep.

All permissions (36)

AreaSection in the appPermissionAlso needs
Attendance DataStaff Attendance Recordsattendance_record:view
Attendance DataStaff Attendance Recordsattendance_record:editattendance_record:view
Attendance DataAttendance Reportsattendance_report:view
Attendance DataAttendance Reportsattendance_report:editattendance_report:view
Attendance SettingsWork Timings & Rosterwork_schedule:view
Attendance SettingsWork Timings & Rosterwork_schedule:editwork_schedule:view
Attendance SettingsAttendance Modesattendance_mode:view
Attendance SettingsAttendance Modesattendance_mode:editattendance_mode:view
Attendance SettingsAutomation Rulesattendance_automation_rule:view
Attendance SettingsAutomation Rulesattendance_automation_rule:editattendance_automation_rule:view
Leave ManagementLeave Requestsleave_request:approve
Leave ManagementBalances & Policiesleave_balance_policy:view
Leave ManagementBalances & Policiesleave_balance_policy:editleave_balance_policy:view
Reimbursement ManagementReimbursement Requestsreimbursement_request:view
Reimbursement ManagementReimbursement Requestsreimbursement_request:editreimbursement_request:view
Reimbursement ManagementReimbursement Requestsreimbursement_request:approvereimbursement_request:view
Staff ManagementStaff Detailsstaff_details:view
Staff ManagementStaff Detailsstaff_details:editstaff_details:view
Staff ManagementDocumentsstaff_documents:view
Staff ManagementDocumentsstaff_documents:editstaff_documents:view
Staff ManagementAdditional Settingsadditional_settings:view
Staff ManagementAdditional Settingsadditional_settings:editadditional_settings:view
Staff ManagementEnrol Faceface_enrolment:view
Staff ManagementEnrol Faceface_enrolment:editface_enrolment:view
Salary DetailsCTC Detailsstaff_salary:view
Salary DetailsCTC Detailsstaff_salary:editstaff_salary:view
Salary DetailsPenalty & Overtimepenalty_overtime:view
Salary DetailsPenalty & Overtimepenalty_overtime:editpenalty_overtime:view
Salary DetailsTax Declarationstax_declaration:view
Salary DetailsTax Declarationstax_declaration:edittax_declaration:view
Salary DetailsBank Accountbank_account:view
Salary DetailsBank Accountbank_account:editbank_account:view
Approval FlowsLeave Approval Flowsleave_approval_flow:view
Approval FlowsLeave Approval Flowsleave_approval_flow:editleave_approval_flow:view
Approval FlowsReimbursement Approval Flowsreimbursement_approval_flow:view
Approval FlowsReimbursement Approval Flowsreimbursement_approval_flow:editreimbursement_approval_flow:view