Payroll Instructions
Payroll Instructions are dated records that tell PayrollKit which tax, National Insurance, loan, director or pension treatment applies to an Employment. Supply confirmed instructions when creating the Employment or add them later using these endpoints. Add a later supported notice as a new instruction.
PayrollKit:
- Keeps every accepted record.
- Selects the applicable record when it captures a Snapshot; the most recently added record does not automatically win.
- Treats a new idempotency key as a separate instruction even when its values match an earlier record, so reuse the original key when retrying.
If an accepted record was entered incorrectly, contact PayrollKit support rather than adding a conflicting replacement.
Payroll Instructions Operations
- get/employers/{employerId}/employments/{employmentId}/instructions
- get/employers/{employerId}/employments/{employmentId}/instructions/{instructionId}
- post/employers/{employerId}/employments/{employmentId}/instructions/tax
- post/employers/{employerId}/employments/{employmentId}/instructions/national-insurance
- post/employers/{employerId}/employments/{employmentId}/instructions/director-ni-method
- post/employers/{employerId}/employments/{employmentId}/instructions/student-loans
- post/employers/{employerId}/employments/{employmentId}/instructions/postgraduate-loans
- post/employers/{employerId}/employments/{employmentId}/instructions/pension-membership