Get employee last pay statement based on the passed employee identifier.

post https://{hostname}/payroll/v1/employees/pay-statement/last

This method allows you to retrieve an individual pay statement by providing an employee identifier. This is helpful if you are designing an application that is aware of the employees to retrieve.
If no pagination parameters specified, the default is applied. Permissions - UKG Pro service account must have "View" role for the "Employee Pay Statements" Web Service. Headers - US-Customer-Api-Key, US-Client-id, Authorization ({username}:{password})

Responses

Response body

object

accruals

array of objects

accruals

object

amountcurrent

float

amounttype

string

balance

float

plancode

string

plandescription

string

addressline1

string

addressline2

string

city

string

companyaddresscity

string

companyaddresscountry

string

companyaddresscounty

string

companyaddressline1

string

companyaddressline2

string

companyaddresspostalcode

string

companyaddressstateorprovince

string

companyname

string

companyphone

string

companyphoneext

string

country

string

deductions

array of objects

deductions

object

basisamount

float

deductioncode

string

deductiondescription

string

employeeamount

float

employeeamountytd

float

employeramount

float

employeramountytd

float

pretax

boolean

deductionscurrent

float

deductionsytd

float

document

string

earnings

array of objects

earnings

object

amount

float

amountytd

float

hours

float

hoursytd

float

paycode

string

paydescription

string

payrate

float

periodend

date-time

periodstart

date-time

piececount

float

piecepayrate

float

employeeidentifier

object

identificationtype

string

companyidentifier

string

employeeidentifier

string

employeenumber

string

federaladditionalamountWithheld

float

federalallowancesclaimed

int32

federalfilingstatus

string

federaltaxablewagescurrent

float

federaltaxablewagesytd

float

fullname

string

grosswagescurrent

float

grosswagesytd

float

job

string

location

string

netpay

array of objects

netpay

object

accountnumber

string

accounttype

string

amount

float

netpaycurrent

float

netpayytd

float

orglevel1

string

orglevel2

string

orglevel3

string

orglevel4

string

paydate

date-time

payperiodfrequency

string

paygroup

string

payidentifier

string

payrate

float

periodenddate

date-time

periodstartdate

date-time

postalcode

string

residentstateallowancesclaimed

int32

residentstatefilingstatus

string

ssn

string

stateorprovince

string

taxes

array of objects

taxes

object

amount

float

amountytd

float

basisamount

float

taxdescription

string

taxcode

string

taxescurrent

float

taxesytd

float

workstateallowancesclaimed

int32

workstatefilingstatus

string

400

BadRequest

404

NotFound

500

InternalServerError

Language

Credentials

Basic

base64

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url https://hostname/payroll/v1/employees/pay-statement/last \
3
     --header 'accept: application/json' \
4
     --header 'content-type: text/json'

Choose an example:

application/json

text/json

application/problem+json

200OK