Skip to main content

ApprovalQueueItem

This represents an individual sheet waiting in the approval queue.

amountnumber

The total amount (hours or currency) of the sheet.

Example: 40
attachments_countinteger

The number of attachments on the sheet.

Example: 2
create_timestampnumber<float>

The timestamp when the object was created, in Unix epoch format.

Example: 1696021987.01375
creatorstring

The user ID who created the sheet. This is not necessarily the nominal owner of the sheet.

Example: 75B23EADB8BC4171AA052B37A297D29B
end_datestring

The end date of the sheet in YYYYMMDD format.

Example: 20231231
end_date_epochnumber<float>

The end date of the sheet in Unix epoch format.

Example: 1696032000
end_date_isostring

The end date of the sheet in ISO 8601 format.

Example: 2023-12-31
end_date_longstring

The long-formatted end date of the sheet. The format is determined by the "Long Date" system setting.

Example: Saturday, September 30, 2023
end_date_shortstring

The short-formatted end date of the sheet. The format is determined by the "Short Date" system setting.

Example: 09/30/2023
history_note_countinteger

The number of history notes on the sheet.

Example: 3
history_urlstring

The URL to view the history of the sheet.

Example: /jtcgi/approveprojects.pyc?history=F554B5C8A0AC4982BFF6EBBF47E0FC86&nav_key=sheet_history
i_am_group_approverboolean

Indicates whether the user is a group approver for the sheet.

Example: true
id_approverstring

The user ID of the designated or next approver for the sheet.

Example: 75B23EADB8BC4171AA052B37A297D29B
id_approver_propertiesobject

The User properties of the designated or next approver for the sheet.

id_domainstring

The domain ID of the sheet.

Example: install_root_dom
id_sheetstring

The Entry Sheet ID. You will need to submit this ID to approve or reject the sheet.

Example: F554B5C8A0AC4982BFF6EBBF47E0FC86
id_timesheetstring

The Time Period ID of the Entry Sheet. This points to the definition of how many days the user's sheets should span.

id_userstring

The user ID of the sheet owner.

Example: F0C5C7F8DE3D48A2824AEE584F077E58
id_user_propertiesobject

The User properties of the sheet owner

is_approvedboolean

Indicates whether the sheet has been approved at any level. This doesn't necessarily indicate full approval at all approval levels.

Example: false
is_fully_approvedboolean

Indicates whether the sheet has been fully approved at all approval levels.

Example: false
is_fully_openboolean

Indicates whether the sheet has never been approved or rejected. A sheet is "fully open" if it's in the "Open" state and not the "Rejected". In both states, the sheet is editable by the user.

Example: true
is_openboolean

Indicates whether the sheet is open for editing. This includes both the "Open" and "Rejected" states.

Example: true
is_rejectedboolean

Indicates whether the sheet is currently in the rejected state. Note that if a sheet was once rejected, but then re-submitted for approval, it will not be considered in the "rejected" state.

Example: false
is_submittedboolean

Indicates whether the sheet is currently being submitted for approval. When it is in this state, no approvals or rejections have occurred.

Example: true
is_virtualboolean

Indicates whether the sheet is a virtual sheet. A virtual sheet is the submission of only a portion of a sheet for approval rather than the full sheet.

Example: false
levelinteger

The current approval level of the sheet. This is the level at which the sheet is currently being approved. A sheet at level 1 has been submitted to the first level of approvers.

modifierstring

The user ID who last modified the sheet.

Example: 75B23EADB8BC4171AA052B37A297D29B
modify_timestampnumber<float>

The timestamp when the object was most recently modified, in Unix epoch format.

Example: 1696021987.01375
pnamestring

An auto-generated string which identifies the sheet's time period.

Example: 09/24/2023 - 09/30/2023
sheettypestring

The Sheet Type code. The value mileage is used for what the system calls "Custom Entry" sheets.

Possible values: [time, expense, mileage]

sheettype_labelstring

The human-readable label for the sheet type.

Example: Time
start_datestring

The start date of the sheet in YYYYMMDD format.

Example: 20231231
start_date_epochnumber<float>

The start date of the sheet in Unix epoch format.

Example: 1696032000
start_date_isostring

The start date of the sheet in ISO 8601 format.

Example: 2023-12-31
start_date_longstring

The long-formatted start date of the sheet. The format is determined by the "Long Date" system setting.

Example: Saturday, September 30, 2023
start_date_shortstring

The short-formatted start date of the sheet. The format is determined by the "Short Date" system setting.

Example: 09/30/2023
stateinteger

The current state of the sheet using internal state codes.

  • 0 - OPEN - "fully open" for entry
  • 1 - SUBMITTED - submitted for approval
  • 2 - APPROVED - approved
  • 3 - REJECTED - rejected (but open for entry)

Possible values: [0, 1, 2, 3]

state_shortstring

The human-readable short-format label for the sheet state.

Example: Open
state_strstring

The human-readable label for the sheet state.

Example: Submitted to Jayne Smith for Approval
submitted_datestring

The submitted date of the sheet in YYYYMMDD format.

Example: 20231231
submitted_date_epochnumber<float>

The submitted date of the sheet in Unix epoch format.

Example: 1696032000
submitted_date_isostring

The submitted date of the sheet in ISO 8601 format.

Example: 2023-12-31
submitted_date_longstring

The long-formatted submitted date of the sheet. The format is determined by the "Long Date" system setting.

Example: Saturday, September 30, 2023
submitted_date_shortstring

The short-formatted submitted date of the sheet. The format is determined by the "Short Date" system setting.

Example: 09/30/2023
ApprovalQueueItem
{
  "amount": 40,
  "attachments_count": 2,
  "create_timestamp": 1696021987.01375,
  "creator": "75B23EADB8BC4171AA052B37A297D29B",
  "end_date": "20231231",
  "end_date_epoch": 1696032000,
  "end_date_iso": "2023-12-31",
  "end_date_long": "Saturday, September 30, 2023",
  "end_date_short": "09/30/2023",
  "history_note_count": 3,
  "history_url": "/jtcgi/approveprojects.pyc?history=F554B5C8A0AC4982BFF6EBBF47E0FC86&nav_key=sheet_history",
  "i_am_group_approver": true,
  "id_approver": "75B23EADB8BC4171AA052B37A297D29B",
  "id_approver_properties": {},
  "id_domain": "install_root_dom",
  "id_sheet": "F554B5C8A0AC4982BFF6EBBF47E0FC86",
  "id_timesheet": "string",
  "id_user": "F0C5C7F8DE3D48A2824AEE584F077E58",
  "id_user_properties": {},
  "is_approved": false,
  "is_fully_approved": false,
  "is_fully_open": true,
  "is_open": true,
  "is_rejected": false,
  "is_submitted": true,
  "is_virtual": false,
  "level": 0,
  "modifier": "75B23EADB8BC4171AA052B37A297D29B",
  "modify_timestamp": 1696021987.01375,
  "pname": "09/24/2023 - 09/30/2023",
  "sheettype": "time",
  "sheettype_label": "Time",
  "start_date": "20231231",
  "start_date_epoch": 1696032000,
  "start_date_iso": "2023-12-31",
  "start_date_long": "Saturday, September 30, 2023",
  "start_date_short": "09/30/2023",
  "state": 0,
  "state_short": "Open",
  "state_str": "Submitted to Jayne Smith for Approval",
  "submitted_date": "20231231",
  "submitted_date_epoch": 1696032000,
  "submitted_date_iso": "2023-12-31",
  "submitted_date_long": "Saturday, September 30, 2023",
  "submitted_date_short": "09/30/2023"
}