Retrieves all the hour_type objects

Request Information

URI Parameters :

None.

Body Parameters :

None.

Response Information

Resource Description :

IHttpActionResult

hour_type
NameDescriptionTypeAdditional information
id

Primary Key

globally unique identifier
code

Code of Hour (will be used for job_non_part_usage.line_code). Field also used for Embedded entity (store there your ERP PK)

string

Max length: 50

commercial_description

Commercial description of the hour type. (Will be used for job_non_part_usage.description)

string

Required

Max length: 255

archived

Archive this hour_type to be sure no new user_timesheet/car_travel will be created with this hour_type

boolean
allow_in_job

If set to true, this hour_type will be available inside a JobDetails to add new timesheet.Default=true

boolean
is_travel

This hour_type is for travel

boolean
allow_time_for_money

boolean
force_range

is hour type range is forced

boolean
color

Color of the hour type

string
hour_type_group_id

Foreign key to hour_type_group, to group hour_type together

globally unique identifier

Optionally required : hour_type_group_id, hour_type_group_code or hour_type_group must be provided

convert_as_invoicable

Convert as invoicable.If true, timesheet/car travel of this type will be generated to job_non_part_usage.Default=true

boolean
property_1_is_enabled

CF Properties of HourType.Enable or not for this hour_type the property 1

boolean
property_1_auto_checked

User_timesheet+car_travel property_1_checked will be filled with this value

boolean
property_2_is_enabled

CF Properties of HourType.Enable or not for this hour_type the property 2

boolean
property_2_auto_checked

User_timesheet+car_travel property_2_checked will be filled with this value

boolean
property_3_is_enabled

CF Properties of HourType.Enable or not for this hour_type the property 3

boolean
property_3_auto_checked

User_timesheet+car_travel property_3_checked will be filled with this value

boolean
property_4_is_enabled

CF Properties of HourType.Enable or not for this hour_type the property 4

boolean
property_4_auto_checked

User_timesheet+car_travel property_4_checked will be filled with this value

boolean
property_5_is_enabled

CF Properties of HourType.Enable or not for this hour_type the property 5

boolean
property_5_auto_checked

User_timesheet+car_travel property_5_checked will be filled with this value

boolean
sales_organization_id

FK of sales_organization. Filled if specific of one SO, empty if can be used by all

globally unique identifier
property_1_convert_as_invoicable_if_checked

boolean
property_2_convert_as_invoicable_if_checked

boolean
property_3_convert_as_invoicable_if_checked

boolean
property_4_convert_as_invoicable_if_checked

boolean
property_5_convert_as_invoicable_if_checked

boolean
is_default

boolean
is_other

boolean
description

string
is_billing_hour

boolean
convert_to_hour_type_id

globally unique identifier
article_id

globally unique identifier
modified_dateutc

Readonly system field managed by database, filled with GetUtcDate when adding,updating

date

Response Formats

application/json, text/json

Sample:
{
  "id": "37dc7f52-c375-469f-89ba-f43e13dab583",
  "code": "sample string 2",
  "commercial_description": "sample string 3",
  "archived": true,
  "allow_in_job": true,
  "is_travel": true,
  "allow_time_for_money": true,
  "force_range": true,
  "color": "sample string 9",
  "hour_type_group_id": "a0551d2e-c311-4ecc-97d9-60c083efc025",
  "convert_as_invoicable": true,
  "property_1_is_enabled": true,
  "property_1_auto_checked": true,
  "property_2_is_enabled": true,
  "property_2_auto_checked": true,
  "property_3_is_enabled": true,
  "property_3_auto_checked": true,
  "property_4_is_enabled": true,
  "property_4_auto_checked": true,
  "property_5_is_enabled": true,
  "property_5_auto_checked": true,
  "sales_organization_id": "db756122-3738-4c13-9415-c8340353bfce",
  "property_1_convert_as_invoicable_if_checked": true,
  "property_2_convert_as_invoicable_if_checked": true,
  "property_3_convert_as_invoicable_if_checked": true,
  "property_4_convert_as_invoicable_if_checked": true,
  "property_5_convert_as_invoicable_if_checked": true,
  "is_default": true,
  "is_other": true,
  "description": "sample string 30",
  "is_billing_hour": true,
  "convert_to_hour_type_id": "aea4509e-b936-4717-9416-118fe97e528f",
  "article_id": "cbfb25fe-0769-4073-b173-fc9f1fe8c411",
  "modified_dateutc": "2026-01-11T20:59:36.75007+00:00"
}

application/xml, text/xml

Sample:
<hour_type xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <allow_in_job>true</allow_in_job>
  <allow_time_for_money>true</allow_time_for_money>
  <archived>true</archived>
  <article_id>cbfb25fe-0769-4073-b173-fc9f1fe8c411</article_id>
  <code>sample string 2</code>
  <color>sample string 9</color>
  <commercial_description>sample string 3</commercial_description>
  <convert_as_invoicable>true</convert_as_invoicable>
  <convert_to_hour_type_id>aea4509e-b936-4717-9416-118fe97e528f</convert_to_hour_type_id>
  <description>sample string 30</description>
  <force_range>true</force_range>
  <hour_type_group_id>a0551d2e-c311-4ecc-97d9-60c083efc025</hour_type_group_id>
  <id>37dc7f52-c375-469f-89ba-f43e13dab583</id>
  <is_billing_hour>true</is_billing_hour>
  <is_default>true</is_default>
  <is_other>true</is_other>
  <is_travel>true</is_travel>
  <modified_dateutc>2026-01-11T20:59:36.750Z</modified_dateutc>
  <property_1_auto_checked>true</property_1_auto_checked>
  <property_1_convert_as_invoicable_if_checked>true</property_1_convert_as_invoicable_if_checked>
  <property_1_is_enabled>true</property_1_is_enabled>
  <property_2_auto_checked>true</property_2_auto_checked>
  <property_2_convert_as_invoicable_if_checked>true</property_2_convert_as_invoicable_if_checked>
  <property_2_is_enabled>true</property_2_is_enabled>
  <property_3_auto_checked>true</property_3_auto_checked>
  <property_3_convert_as_invoicable_if_checked>true</property_3_convert_as_invoicable_if_checked>
  <property_3_is_enabled>true</property_3_is_enabled>
  <property_4_auto_checked>true</property_4_auto_checked>
  <property_4_convert_as_invoicable_if_checked>true</property_4_convert_as_invoicable_if_checked>
  <property_4_is_enabled>true</property_4_is_enabled>
  <property_5_auto_checked>true</property_5_auto_checked>
  <property_5_convert_as_invoicable_if_checked>true</property_5_convert_as_invoicable_if_checked>
  <property_5_is_enabled>true</property_5_is_enabled>
  <sales_organization_id>db756122-3738-4c13-9415-c8340353bfce</sales_organization_id>
</hour_type>