Skip to main content

EntryPeriod

An Entry Period is the definition of the time-span to use in individual Entry Sheets, such as weekly, bi-weekly, or monthly. Entry Periods are assigned via the Entry Screen configuration.

idstring

The internal ID of the resource or object. This is a 32-character hexadecimal string (UUID without hyphens).

In general, the id field is the primary key of the object and cannot be changed or updated.

Example: 64BBA147B9AC41D9978062300826C89F
uristring<uri-reference>

The URI associated with this resource. This is usually a relative URL that can be used to access the resource. Typically it incorporates the Unique ID of the resource.

Example: /api/v1/objects/64BBA147B9AC41D9978062300826C89F
tablenamestring

The name of the internal database table associated with this resource.

Example: users
table_labelstring

The user-visible label of the database table associated with this object.

Example: time_sheets
creatorstring

The internal User ID of the user who created the object.

Example: 64BBA147B9AC41D9978062300826C89F
create_timestampnumber<float>

The timestamp when the object was created, in Unix epoch format. This is the number of seconds since 1970-01-01T00:00:00Z.

Example: 1696021987.01375
modifierstring

The internal User ID of the user who most recently modified the object.

Example: 64BBA147B9AC41D9978062300826C89F
modify_timestampnumber<float>

The timestamp when the object was most recently modified, in Unix epoch format. This is the number of seconds since 1970-01-01T00:00:00Z.

Example: 1696021987.01375
id_domainstring

The internal Domain ID of the resource or object. In general, this field is deprecated and not in use and can be ignored.

Example: install_root_dom
anchorstring

The anchor date for the Entry Period in YYYYMMDD format. This is the date that the Entry Period starts on, at least for period calculation purposes. This does not affect any actual time entry data.

Example: 20230301
bidate_daystringnullable

Only used in "Custom Semi-Monthly" period types and null otherwise. This defines the division date between the first and second half of the month.

Example: null
id_timesheetstring

The internal ID of the Entry Period. Same as the id field. This is what is attached to the Entry Screen configuration as the way to define the screen's entry period.

Example: 759F5CF8F68349DCB0A5BF93323445A6
periodstring

The "Period Type" of the entry period. These are the options:

  • week - a weekly period
  • biweek - a bi-weekly period (every two weeks)
  • semimonth - a semi-monthly period (twice a month)
  • month - a monthly period
  • day - a daily period
  • bidate - a custom semi-monthly period; twice a month, but with a custom division date.

Possible values: [week, biweek, semimonth, month, day, bidate]

Example: week
pnamestring

The name of the Entry Period. This is what is displayed to the user in the Entry Screen configuration.

Example: Weekly
reserved1stringnullable

Reserved for future use.

Example: null
reserved2stringnullable

Reserved for future use.

Example: null
reserved3stringnullable

Reserved for future use.

Example: null
EntryPeriod
{
  "anchor": "20230301",
  "bidate_day": null,
  "id_timesheet": "759F5CF8F68349DCB0A5BF93323445A6",
  "period": "week",
  "pname": "Weekly",
  "reserved1": null,
  "reserved2": null,
  "reserved3": null,
  "table_label": "time_sheets",
  "id": "64BBA147B9AC41D9978062300826C89F",
  "uri": "/api/v1/objects/64BBA147B9AC41D9978062300826C89F",
  "tablename": "users",
  "creator": "64BBA147B9AC41D9978062300826C89F",
  "create_timestamp": 1696021987.01375,
  "modifier": "64BBA147B9AC41D9978062300826C89F",
  "modify_timestamp": 1696021987.01375,
  "id_domain": "install_root_dom"
}