Adds earnings lines to the specified pay run.
POST https://api.yourpayroll.com.au/api/v2/business/{businessId}/payrun/{payRunId}/earningslines
Parameter name | Value | Description | Additional |
---|---|---|---|
payRunId | int32 | Required | |
businessId | string | Required |
The request body takes a complete AuSubmitPayRunEarningsLineRequest resource, containing the following writable properties:
{
"earningsLines": {
"<key>": "array"
},
"employeeIdType": "string",
"locationIdType": "string",
"payCategoryIdType": "string",
"payRunId": "int32",
"replaceExisting": "boolean",
"suppressCalculations": "boolean"
}
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 | int64 | Int64 |
earningsLines.<key>.locationId | string | String |
earningsLines.<key>.locationName | string | String |
earningsLines.<key>.lumpSumCalculationMethod | string |
Nullable Possible values are:
|
earningsLines.<key>.lumpSumEFinancialYear | int32 |
Nullable |
earningsLines.<key>.lumpSumNumberOfPayPeriods | double | Decimal |
earningsLines.<key>.netPayment | 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>.reportingDimensionValueIds[] | array of int32 |
Nullable Note: Only applicable to businesses where the Dimensions feature is enabled. Specify an array of dimension value ids (normally only one-per dimension) eg [1,3,7]. If you prefer to specify dimension values by name, use the ReportingDimensionValueNames field instead. If this field is used, ReportingDimensionValueNames will be ignored (the Ids take precedence) |
earningsLines.<key>.reportingDimensionValueNames | object |
Nullable Note: Only applicable to businesses where the Dimensions feature is enabled. Specify an object with dimension names and for each one, specify an array of associated value names (normally one-per dimension) eg { "Department": ["Accounting"], "Job Code": ["JC1"] }. If you prefer to specify dimension values directly by Id, use the ReportingDimensionValueIds field instead. If ReportingDimensionValueIds is used, ReportingDimensionValueNames will be ignored (the Ids take precedence) |
earningsLines.<key>.reportingDimensionValueNames.<key>[] | array of string | |
earningsLines.<key>.sfss | double | Decimal |
earningsLines.<key>.super | double | Decimal |
earningsLines.<key>.timesheetLineExternalId | string | String |
earningsLines.<key>.timesheetLineId | int32 |
Nullable |
earningsLines.<key>.units | double | Decimal |
employeeIdType | string |
IdType
Possible values are:
|
locationIdType | string |
IdType
Possible values are:
|
payCategoryIdType | string |
IdType
Possible values are:
|
payRunId | int32 | Int32 |
replaceExisting | boolean | Boolean |
suppressCalculations | boolean | Boolean |
The following HTTP status codes may be returned, optionally with a response resource.
Status code | Description | Resource |
---|---|---|
200 | OK OK |
Powered by DapperDox