Guides

Returns a list of bank payments that need to be made to employees as a result of a Payrun.
You can optionally provide a PaymentDate and only payments for that date will be returned.

Store values

Parameters

employerId string

payPeriod string

periodNumber integer

taxYear string

paymentDate string

(optional)

bankHoliday string

Specifies the region whose bank holidays are to be considered in the operation. (optional)

ordinal integer

(optional)

incPensions

boolean

Set to true and we'll include any payment due to Pension Providers (optional)

incHmrc

boolean

Set to true and we'll include any payment due to HMRC (optional)

incAeos

boolean

Set to true and we'll include any payment due as a result of AttachmentOrders (optional)

incDeductions

boolean

Set to true and we'll include any payment due to Deductions that are set to be paid to a Payee (optional)

version integer

Will indicate what version of the payrun will be shown. If left empty, will show full pay run. (optional)

Try it Accept:

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	`BankPaymentInstructionReportResponse`	application/json