Import Row-Based Payments Asynchronously (Beta)

Post
/employers/{employerId}/import/payments/row-based/async

This endpoint is currently being beta tested and subject to unannounced breaking changes.
Allows the import of row-based payments asynchronously from a CSV file. If using a CSV
import file without headers, you can use generic column names that follow the pattern
'Column A', 'Column B', etc. to reference columns in the CSV file.
If values are not provideded for payrollCodeColumnName,
payAmountColumnName, payAmountMultiplierColumnName,
payCodeColumnName or descriptionColumnName; the following
default column names will be inserted respectively: 'Code', 'Amount', 'Qty', 'Pay Code'
and 'Description'.

Store values

Parameters

string
The employer id.
string
The pay period.
integer
The ordinal.
string
The behaviour of this payment import.
string
The payment basis.
boolean
Check this if the CSV file has a header row. (optional)
boolean
Check this if the CSV file has payline costings included. (optional)
string
The payroll code source column name. Default values will be used if not supplied. (optional)
string
The pay amount source column name. Default values will be used if not supplied. (optional)
string
The pay amount multiplier (hours, weeks, etc.) source column name. Default values will be used if not supplied. (optional)
string
The pay code source column name. Default values will be used if not supplied. (optional)
string
The description source column name. Default values will be used if not supplied. (optional)
string
The department source column name. Default values will be used if not supplied. (optional)
string
The cost centre source column name. Default values will be used if not supplied. (optional)
Try it

Possible Responses

202 Accepted Contract.JobResponse application/json
400 Bad Request