Tax rebate suppressions prevent tax rebates from being applied to an employee's pay for a specified period and reason, such as for pension payrolls or late payments
Create an employment tax rebate suppression
Creates a new tax rebate suppression for a specific employment. Tax rebate suppressions are used to prevent tax rebates from being applied to an employee's pay for a specified period and reason.
SecuritybearerAuth
Request
path Parameters
Request Body schema: application/vnd.api+json
Employment tax rebate suppression to be added. startDate and reason are required.
Business Rules:
- The employment must exist
- The start date is required
- The end date, if provided, must be on or after the start date
- The reason must be one of the predefined values: "Pension Payroll", "Late Payment", "Trade Dispute", or "Casual NOT Paid"
- Duplicate suppressions (same employment, reason, and start date) are not allowed
object |
Responses
201
Successfully created employment tax rebate suppression
400
Bad Request
401
Unauthorized - Authorization Required
403
Forbidden - Insufficient Permissions
404
Not Found
422
Unprocessable Entity
default
General Error
post/employments/{employmentId}/tax-rebate-suppression
Request samples
- Payload
- curl
- C#
- Java
- PHP
application/vnd.api+json
{- "data": {
- "type": "employmentTaxRebateSuppressions",
- "attributes": {
- "startDate": "2024-01-01",
- "endDate": "2024-12-31",
- "reason": "Pension Payroll"
}
}
}Response samples
- 201
- 400
- 401
- 403
- 404
- 422
- default
application/vnd.api+json
{- "data": {
- "type": "employmentTaxRebateSuppressions",
- "id": "123",
- "attributes": {
- "employmentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
- "startDate": "2024-01-01",
- "endDate": "2024-12-31",
- "reason": "Pension Payroll"
}, - "relationships": {
- "employment": {
- "links": {
}, - "data": {
- "type": "employments",
- "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
}
},
},
}