Post Payments

post
/employers/{employerId}/external-data/{id}/{taxYear}/{payPeriod}/{periodNumber}/payments

Post Payments for a payrun to the ExternalDataProvider
A 200 response does not mean the payments were necessarily successfully posted.
The BankPaymentInstruction is returned (without the payments) so that you can inspect the status to determine success

Store values

Parameters

string
string
string
To identify the PayRun
integer
To identify the PayRun
string
To identify the PayRun
boolean
Include payments for employees (optional)
boolean
Include payments for HMRC (if any) (optional)
boolean
Include payments for Pension Providers (if any) (optional)
boolean
Set to true if you want to force the payments to be posted even if it already has been (optional)
string
Optional. If a value is provided then it'll be used in place of the payment date for the payment. (optional)
Try it

Possible Responses

200 Success BankPaymentInstruction application/json