Add deductions to the specified pay run.

Request

POST https://api.yourpayroll.com.au/api/v2/business/{businessId}/payrun/{payRunId}/deductions

Path parameters

Parameter name Value Description Additional
payRunId int32 Required
businessId string Required

Request body

The request body takes a complete SubmitPayRunDeductionRequest resource, containing the following writable properties:

{
    "deductionCategoryIdType": "string",
    "deductions": {
        "<key>": "array"
    },
    "employeeIdType": "string",
    "payRunId": "int32",
    "replaceExisting": "boolean",
    "suppressCalculations": "boolean"
}

Properties

Name Type
deductionCategoryIdType string
deductions object
deductions.<key> map of array
deductions.<key>.amount double
deductions.<key>.deductionCategoryId string
deductions.<key>.deductionCategoryName string
deductions.<key>.employeeId string
deductions.<key>.employeeName string
deductions.<key>.externalId string
deductions.<key>.locationId string
deductions.<key>.locationName string
deductions.<key>.note string
deductions.<key>.notes string
deductions.<key>.payTo string
deductions.<key>.payToBankAccountBSB string
deductions.<key>.payToBankAccountNumber string
deductions.<key>.payToSuperFundMemberNumber string
deductions.<key>.payToSuperFundName string
deductions.<key>.paymentReference string
employeeIdType string
payRunId int32
replaceExisting boolean
suppressCalculations boolean

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code Description Resource
200 OK

OK