Import Pay

Post

/employers/{employerId}/payrun/{payPeriod}/importpay

Takes a list PayOptionsImport and updates the currently open payrun to use the amounts given.
You must have an open payrun for the PayPeriod specified and all payroll codes submitted must match an employee on the payrun.
Any lines imported for a PayRunEntry will replace existing lines for that PayRunEntry.

Store values

Parameters

employerId string

payPeriod string

body
sample value
Content Type PayOptionsImport[]

ordinal integer

(optional)

linesOnly

boolean

If set to true then only lines will be imported. Changes to regular pay will be ignored. Defaults to false. (optional)

append

boolean

If set to true then the lines submitted will be appended to existing lines rather than replace them. Defaults to false. (optional)

updateExisting

boolean

If set to true then any submitted lines that match the pay code of one (and only one) existing line will be used to update the value of that lines. Any unmatched lines will be appended to existing lines. (optional)

validateOnly

boolean

If set to true, the import will only be validated for data correctness. If false, the import is validated and then imported. (optional)

Try it

OAuth Token

Api Key

Response Code

Response Body

Response Headers

The API Key you provided may not be valid.
Please check it or use the OAuth Token.

Possible Responses

200	Success
400	Bad Request