List Monthly Salary
Returns one staff member’s payroll month by month, as last computed and stored by SalaryBox (the finalized one when the month is finalized). Requires Payroll Pro. Inactive staff can be fetched. Not paginated.
- This never computes payroll. A month nobody computed has
is_computedfalseand its figures arenull. - Months are listed oldest first, one for every month in the range.
total_deductionsincludes pay cuts, as on the payslip.- For every staff member’s net pay, amount paid or amount due, use List Payroll History.
Authentication
AuthorizationApi-Key
Format: “Api-Key {api-key}”
Query parameters
salarybox_id
The staff member to return.
from_month
First month to include, YYYY-MM.
to_month
Last month to include, YYYY-MM. Cannot be in the future. The range can cover at most 6 months.
Response
The staff member's identity and one entry per month.
message
status
data
Identity fields shared by per-employee payroll responses.
Errors
400
Bad Request Error
403
Forbidden Error
404
Not Found Error