GET api/v1/ptotransactions/{staffId}/{startDate}

Retrieve PTO balance

Request Information

URI Parameters

NameDescriptionTypeAdditional information
staffId

integer

Required

startDate

date

Required

Body Parameters

None.

Response Information

Resource Description

ApiResponseModelOfPtoBalanceReturnModel
NameDescriptionTypeAdditional information
Data

ApiResponseDataModelOfPtoBalanceReturnModel

None.

Errors

Collection of string

None.

Warnings

Collection of string

None.

Response Formats

application/json, text/json

Sample:
{
  "Data": {
    "PageSize": 1,
    "Page": 2,
    "TotalPages": 3,
    "TotalResults": 4,
    "Results": {
      "staffId": 1,
      "FacilityId": 2,
      "DepartmentId": 3,
      "PtoBalance": 4.1,
      "PayPeriodAccrual": 5.1,
      "PtoBalanceAccrualModel": [
        {
          "PayPeriodEndDate": "2026-01-02T21:50:08.8580553-06:00",
          "IsHighlightedDate": true,
          "PtoBalance": 3.1,
          "LessFSApprovalPTO": 4.1,
          "EstPTOHours": 5.1
        },
        {
          "PayPeriodEndDate": "2026-01-02T21:50:08.8580553-06:00",
          "IsHighlightedDate": true,
          "PtoBalance": 3.1,
          "LessFSApprovalPTO": 4.1,
          "EstPTOHours": 5.1
        }
      ]
    }
  },
  "Errors": [
    "sample string 1",
    "sample string 2"
  ],
  "Warnings": [
    "sample string 1",
    "sample string 2"
  ]
}