Skip to main content

CrewSheetUserProperties

Details of the user the row describes. These are properties of the user, not of any one sheet, so they are returned whether or not the user has sheets in the period.

The entry screen name fields (time_gui_pname and friends) and the approval plan name fields are only returned when a matching column is configured on the Crew Entry screen, because each one costs an extra lookup. Configure columns through the Screen settings endpoints.

fullnamestring

The user's full name.

Example: Alice Dev
user_loginstring

The user's sign-in name.

Example: alice
default_timezonestring

The user's preferred time zone as an IANA name, or an empty string when the user has not set one, in which case the server's zone applies. Use this when displaying punch times from the user's sheets.

Example: America/New_York
time_approvals_pnamestring

The name of the approval plan that governs the user's time sheets, or an empty string when none applies. Only returned when the id_user_properties.time_approvals_pname column is configured on the Crew Entry screen.

Example: Weekly Manager Approval
expense_approvals_pnamestring

The name of the approval plan that governs the user's expense sheets, or an empty string when none applies. Only returned when the id_user_properties.expense_approvals_pname column is configured on the Crew Entry screen.

Example: Expense Review
custom_approvals_pnamestring

The name of the approval plan that governs the user's custom entry sheets, or an empty string when none applies. Only returned when the id_user_properties.custom_approvals_pname column is configured on the Crew Entry screen.

Example: Mileage Review
time_gui_idstring

The ID of the time entry screen assigned to the user. Only returned when the id_user_properties.time_gui_pname column is configured on the Crew Entry screen.

Example: 4C1D9F0A78B94E1C8E5B2D6F3A70C915
time_gui_pnamestring

The name of the time entry screen assigned to the user. Only returned when this column is configured on the Crew Entry screen.

Example: Standard Weekly Time
expense_gui_idstring

The ID of the expense entry screen assigned to the user. Only returned when the id_user_properties.expense_gui_pname column is configured on the Crew Entry screen.

Example: 9E2F4B7C15D8402A93C6E1B84F70D3A2
expense_gui_pnamestring

The name of the expense entry screen assigned to the user. Only returned when this column is configured on the Crew Entry screen.

Example: Standard Expense
custom_gui_idstring

The ID of the custom entry screen assigned to the user. Only returned when the id_user_properties.custom_gui_pname column is configured on the Crew Entry screen.

Example: B7D3169E4A0C42F5810B9C2E7D45A836
custom_gui_pnamestring

The name of the custom entry screen assigned to the user. Only returned when this column is configured on the Crew Entry screen.

Example: Standard Mileage
CrewSheetUserProperties
{
  "fullname": "Alice Dev",
  "user_login": "alice",
  "default_timezone": "America/New_York",
  "time_approvals_pname": "Weekly Manager Approval",
  "expense_approvals_pname": "Expense Review",
  "custom_approvals_pname": "Mileage Review",
  "time_gui_id": "4C1D9F0A78B94E1C8E5B2D6F3A70C915",
  "time_gui_pname": "Standard Weekly Time",
  "expense_gui_id": "9E2F4B7C15D8402A93C6E1B84F70D3A2",
  "expense_gui_pname": "Standard Expense",
  "custom_gui_id": "B7D3169E4A0C42F5810B9C2E7D45A836",
  "custom_gui_pname": "Standard Mileage"
}