v1

latestOpenAPI 3.0.12026-07-24192492466.5 KB

PayCycles

Get all Batch Payments

Gets all payments for the specified pay group Id and pay cycle Id and pay batch Id / specified pay group id and pay cycle Id and pay batch Id and payment status filter

get/payroll/paygroups/paycycles/paybatches/payments

Query parameters

payGroupIdstring uuid

The Pay Group Id

payCycleIdstring uuid

The Pay cycle Id

payBatchIdstring uuid

The Pay Batch Id

statusstring

Comma separated list of one or more payment Status you'd like to filter on, allowed values are UnPaid, Paid.

pageNumberinteger

pageSizeinteger

Represents how many results you'd like to retrieve per request (page). Default is 100. Max is 200

Response

succeededboolean

Gets or sets a value indicating whether this Keka.API.Web.Core.Response`1 is succeeded.

messagestring nullable

Gets or sets the message.

errorsstring[] nullable

Gets or sets the errors.

pageNumberinteger

Gets or sets the page number.

pageSizeinteger

Gets or sets the size of the page.

firstPagestring uri nullable

Gets or sets the first page.

lastPagestring uri nullable

Gets or sets the last page.

totalPagesinteger

Gets or sets the total pages.

totalRecordsinteger

Gets or sets the total records.

nextPagestring uri nullable

Gets or sets the next page.

previousPagestring uri nullable

Gets or sets the previous page.