Adds earnings lines to the specified pay run.

Request

POST https://keypay.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 Description
earningsLines object Dictionary
earningsLines.<key> map of array List
earningsLines.<key>.earnings double Decimal
earningsLines.<key>.employeeExternalId string String
earningsLines.<key>.employeeId string String
earningsLines.<key>.employeeName string String
earningsLines.<key>.externalId string String
earningsLines.<key>.help double Decimal
earningsLines.<key>.id int32 Int32
earningsLines.<key>.locationId string String
earningsLines.<key>.locationName string String
earningsLines.<key>.lumpSumNumberOfPayPeriods double Decimal
earningsLines.<key>.notes string String
earningsLines.<key>.payCategoryId string String
earningsLines.<key>.payCategoryName string String
earningsLines.<key>.payg double Decimal
earningsLines.<key>.rate double Nullable
earningsLines.<key>.sfss double Decimal
earningsLines.<key>.super double Decimal
earningsLines.<key>.timesheetLineId int32 Nullable
earningsLines.<key>.units double Decimal
employeeIdType string IdType

Possible values are:

  • Standard
  • External
locationIdType string IdType

Possible values are:

  • Standard
  • External
payCategoryIdType string IdType

Possible values are:

  • Standard
  • External
payRunId int32 Int32
replaceExisting boolean Boolean
suppressCalculations boolean Boolean

Response

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

Status code Description Resource
200 OK

OK