Adds earnings lines to the specified pay run.

Request

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

Path parameters

Parameter name Value Description Additional
payRunId int32 Required
businessId string Required

Request body

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

{
    "earningsLines": {
        "<key>": "array"
    },
    "employeeIdType": "string",
    "locationIdType": "string",
    "payCategoryIdType": "string",
    "payRunId": "int32",
    "replaceExisting": "boolean",
    "suppressCalculations": "boolean"
}

Properties

Name Type
earningsLines object
earningsLines.<key> map of array
earningsLines.<key>.earnings double
earningsLines.<key>.employeeId string
earningsLines.<key>.employeeName string
earningsLines.<key>.externalId string
earningsLines.<key>.help double
earningsLines.<key>.locationId string
earningsLines.<key>.locationName string
earningsLines.<key>.lumpSumNumberOfPayPeriods double
earningsLines.<key>.notes string
earningsLines.<key>.payCategoryId string
earningsLines.<key>.payCategoryName string
earningsLines.<key>.payg double
earningsLines.<key>.rate double
earningsLines.<key>.sfss double
earningsLines.<key>.super double
earningsLines.<key>.timesheetLineId int32
earningsLines.<key>.units double
employeeIdType string
locationIdType string
payCategoryIdType 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