v1

latestOpenAPI 3.1.02026-07-241642423.7 KB

Get a pay schedule

Returns the specified pay schedule.

get/pay_schedules/{pay_schedule}

Path parameters

pay_schedulestring required

Response

200

idstring

companystring

namestring

pay_frequencystring

first_paydaystring

second_paydaystring

first_period_endstring

metadataobject

Example response

{
  "id": "psc_ARONfuK7dWUk1xFlQM77",
  "company": "com_fOBk0fGUbJ76z3hF6hc6",
  "name": "Pay schedule 2",
  "pay_frequency": "semimonthly",
  "first_payday": "2023-04-23",
  "second_payday": "2023-05-09",
  "first_period_end": "2023-04-15"
}