Sign in

v3

latestSwagger 2.02026-08-067506752.0 MB
Time off ledger

Get a time off ledger entry by ID

get/v1/org/{orgId}/timeoff-ledger/{entryId}

Path parameters

orgIdstring required

Org identifier (either id or slug)

entryIdstring required

Ledger entry id

Response

successful operation

idstring required

Globally unique id of this ledger entry

orgIdstring required

org that the time off belongs to

personIdstring required

person taking the time off

timeOffPolicyIdstring

Time off policy to which this entry pertains.

entryType'EXPIRATION' | 'BALANCE_RESET' | 'CARRYOVER' | 'UPFRONT_BALANCE' | 'ACCRUAL' | 'ADJUSTMENT' | 'TIME_OFF' required

Ledger entry type

externalIdstring

external identifier, if this entry exists in an external system

fromDatestring date

For time off, from date of time off, inclusive

fromDatePartialDaynumber

For time off, portion of the from date to take

fromDatePartialDayPeriod'AM' | 'PM'

Portion of the from day requested (e.g. AM or PM)

untilDatestring date

For time off, until date of time off, exclusive

endDatePartialDaynumber

For time off, portion of the end date (day before the until date) to take

endDatePartialDayPeriod'AM' | 'PM'

Portion of the end day requested (e.g. AM or PM)

datestring date required

date on which this entry appears in the ledger

daysnumber

Change to the balance made by this ledger entry. This value is always nonnegative; it is interpreted in the context of entryAction.

hoursnumber

For time off, number of hours taken

entryAction'SET' | 'MIN' | 'EXPIRE' | 'CARRYOVER' | 'ADD' | 'ADD_CLAMP' | 'SUBTRACT' required

Action this entry takes on the balance.

typeDescriptionstring

type of time off

notestring

notes on the time off

approval'APPROVED' | 'PENDING' | 'CANCELLED' | 'REJECTED' | 'SUPERSEDED'

approval status of the time off

approvalAtstring

timestamp of approval

approvalUserIdstring

user who either is the next one requesting approval, or the user who did the final approval or rejection

createIdstring

created by user id

createBehalfIdstring

created on behalf of user id

createAtstring

created timestamp

deleteIdstring

deleted by user id

deleteBehalfIdstring

deleted on behalf of user id

deleteAtstring

deleted timestamp

requestAtstring

requested at timestamp -- often the same as createAt

balancenumber

Balance after this ledger entry.

changeFromPreviousnumber

Balance change from previous entry.

Example response

{
  "id": "588f7ee98f138b19220041a7",
  "orgId": "588f7ee98f138b19220041a7",
  "personId": "588f7ee98f138b19220041a7",
  "timeOffPolicyId": "588f7ee98f138b19220041a7",
  "approvalAt": "2017-01-24T13:57:52Z",
  "approvalUserId": "588f7ee98f138b19220041a7",
  "createId": "588f7ee98f138b19220041a7",
  "createBehalfId": "588f7ee98f138b19220041a7",
  "createAttribution": {
    "principalUserId": "588f7ee98f138b19220041a7",
    "agentUserIds": [
      "588f7ee98f138b19220041a7"
    ],
    "eventId": "588f7ee98f138b19220041a7",
    "aiChatId": "588f7ee98f138b19220041a7"
  },
  "createAt": "2017-01-24T13:57:52Z",
  "deleteId": "588f7ee98f138b19220041a7",
  "deleteBehalfId": "588f7ee98f138b19220041a7",
  "deleteAttribution": {
    "principalUserId": "588f7ee98f138b19220041a7",
    "agentUserIds": [
      "588f7ee98f138b19220041a7"
    ],
    "eventId": "588f7ee98f138b19220041a7",
    "aiChatId": "588f7ee98f138b19220041a7"
  },
  "deleteAt": "2017-01-24T13:57:52Z",
  "requestAt": "2017-01-24T13:57:52Z"
}