Payroll Payments

GET /accounting/payroll-payments

Group: Accounting › Payroll Payments · Operation ID: payrollPayments

Returns a list of payroll payments. Each entry is the payment header. Read one payment with its applications from GET accounting/payroll-payments/:id or POST accounting/payroll-payments/search.

Open in the interactive reference

Parameters

Name	In	Type	Required	Description
`Api-Version`	header	`"v1"`	yes	The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version `v1`.

Query surface

id — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
payrollPaymentNumber — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
paymentDate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
paymentCurrency — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
paymentType — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
status — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
approvalStatus — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
externalId — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
lastModifiedDate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
Orderable: id, payrollPaymentNumber, paymentDate, paymentCurrency, paymentType, status, totalPaid, lastModifiedDate
Selectable: id, payrollPaymentNumber, paymentDate, paymentCurrency, paymentType, status, approvalStatus, description, totalPaid, externalId, paymentAccountName, entityName, lastModifiedDate

Response

200 Success

Under data, an array of payrollPaymentsRow:

Field	Type	Required	Description
`id`	string	no	The unique identifier for the payroll payment.
`payrollPaymentNumber`	string or null	no	The payment number. Absent until a number has been assigned.
`paymentDate`	string (date)	no	The date the payment is made. Format YYYY-MM-DD.
`paymentCurrency`	string	no	The currency the payment is made in. Format ISO 4217, for example 'USD'. Governs totalPaid.
`paymentType`	string	no	How the payment was made: the instrument, not the origin. Values include 'manual' and 'bank'.
`status`	string	no	The status of the payment. Values include 'successful', 'rejected', 'cancelled', 'processing', 'partiallySuccessful', 'unknown', 'unsigned', 'manuallyRecorded', 'scheduled' and 'voided'.
`approvalStatus`	string or null	no	The approval status of the payment.
`description`	string or null	no	A description recorded on the payment.
`totalPaid`	string (decimal) or null	no	The total amount paid, in paymentCurrency.
`externalId`	string or null	no	The identifier this payment has in the upstream system that produced it. It is not unique.
`paymentAccountName`	string or null	no	The name of the GL account the payment is booked against.
`entityName`	string or null	no	The name of the legal entity that made the payment.
`lastModifiedDate`	string (date-time) or null	no	The date and time the payroll payment last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.

Statuses

400 — Invalid request or business failure
401 — Missing or invalid access token
403 — Not authorized
404 — Not found
429 — Too many requests
500 — Internal server error