Creates or updates a car travel record.
Request Information
URI Parameters :
None.
Body Parameters :
car_travel| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Primary Key |
globally unique identifier | |
| user_id |
Foreign key of User |
globally unique identifier |
Required |
| car_id |
Foreign key of Car |
globally unique identifier |
Required |
| from_db_address_id |
the FROM info are filled with the latest travel of this car |
globally unique identifier | |
| from_db_table_id |
Identifier of the database table that belongs to, when the departure point is linked to another record (e.g. a job). |
globally unique identifier | |
| from_id_in_table |
Primary key of the linked departure record in the table identified by . |
globally unique identifier | |
| from_travel_type_code |
Kind of departure point (e.g. home, office, previous job). |
string | |
| from_db_address_other |
Free-text departure address, used when the departure point isn't one of the standard linked records. |
string |
Max length: 255 |
| to_db_address_id |
The address used on navigation |
globally unique identifier | |
| to_db_table_id |
TO=> if navigate to a JOBS, to_db_table_id and to_in_table is filled with the jobs info |
globally unique identifier | |
| to_in_in_table |
Primary key of the linked destination record in the table identified by . |
globally unique identifier | |
| to_travel_type_code |
Kind of travel. Can be |
string |
Required |
| to_db_address_other |
Free-text destination address, used when the destination isn't one of the standard linked records. |
string |
Max length: 255 |
| hour_type_id |
Foreign key of the hour type |
globally unique identifier |
Required |
| date_from |
Local date+time when the travel started |
date | |
| date_from_rounded |
rounded to the nearest configured interval, used for billing/display. |
date |
Required |
| date_to |
local date+time when the travel finished |
date | |
| date_to_rounded |
rounded to the nearest configured interval, used for billing/display. |
date |
Required |
| notes |
Additional notes field |
string |
Max length: 4000 |
| km |
2019-04-01: Old field not use it anymore (FSA-986) the Mileage of the car after the travel,* Be aware, value should be always bigger than the last one |
integer | |
| km_before |
Auto filled when a new record is added |
integer | |
| km_after |
the Mileage of the car after the travel,* Be aware, value should be always bigger than the last one |
integer | |
| km_private |
A value the user indicates that contains the total number of km for Private use. |
integer | |
| km_distance |
Distance traveled, in kilometers, computed as minus . |
integer | |
| is_time_for_money |
Indicates this travel time is billable ("time for money") rather than purely informational. |
boolean | |
| is_start_stop |
Indicates this entry was recorded via a start/stop timer rather than manually keyed in. |
boolean | |
| property_1_checked |
Checked state of the hour type's configurable custom property #1 (see ) for this entry. |
boolean | |
| property_2_checked |
Checked state of the hour type's configurable custom property #2 for this entry. |
boolean | |
| property_3_checked |
Checked state of the hour type's configurable custom property #3 for this entry. |
boolean | |
| property_4_checked |
Checked state of the hour type's configurable custom property #4 for this entry. |
boolean | |
| property_5_checked |
Checked state of the hour type's configurable custom property #5 for this entry. |
boolean | |
| start_latitude_decimal |
Latitude of the user's location when the travel was started. |
decimal number | |
| start_longitude_decimal |
Longitude of the user's location when the travel was started. |
decimal number | |
| end_latitude_decimal |
Latitude of the user's location when the travel ended. |
decimal number | |
| end_longitude_decimal |
Longitude of the user's location when the travel ended. |
decimal number | |
| added_dateutc |
Readonly system field: UTC date and time this travel record was added. |
date | |
| is_approved |
is_approved flag |
boolean | |
| is_confirmed |
offline field: is_confirmed flag |
boolean | |
| modified_dateutc |
Readonly system field managed by database, filled with GetUtcDate when adding,updating |
date |
Request Formats :
application/json, text/json
{
"id": "98adf5b8-1b04-4f56-8241-72bb33fbc01e",
"user_id": "1b738d6f-8e4f-4ef0-80f3-e10a8877ac26",
"car_id": "95027950-a248-4dbb-af01-ba03c5ac3f82",
"from_db_address_id": "4cddc34f-e0fe-46f0-8b83-f7da86af3cff",
"from_db_table_id": "22dfe531-00ed-40b6-a2b8-7594dbc69dc8",
"from_id_in_table": "b05ee7ee-dc08-4277-a7b1-2769b3e39311",
"from_travel_type_code": "sample string 7",
"from_db_address_other": "sample string 8",
"to_db_address_id": "7e8fdd0b-8803-4a93-a90d-f4fe1ad7a7f2",
"to_db_table_id": "32e1a535-cdfe-4208-8f4d-fc3ecb2c268f",
"to_in_in_table": "dbd36730-156d-4e8e-9ed5-eb99c94f37e0",
"to_travel_type_code": "sample string 12",
"to_db_address_other": "sample string 13",
"hour_type_id": "c1a0edf6-c27a-4d47-9536-c6f3c6972d3e",
"date_from": "2026-11-12T14:29:03.9792479+00:00",
"date_from_rounded": "2026-11-12T14:29:03.9792479+00:00",
"date_to": "2026-11-12T14:29:03.9792479+00:00",
"date_to_rounded": "2026-11-12T14:29:03.9792479+00:00",
"notes": "sample string 19",
"km": 20,
"km_before": 21,
"km_after": 22,
"km_private": 23,
"km_distance": 24,
"is_time_for_money": true,
"is_start_stop": true,
"property_1_checked": true,
"property_2_checked": true,
"property_3_checked": true,
"property_4_checked": true,
"property_5_checked": true,
"start_latitude_decimal": 32.0,
"start_longitude_decimal": 33.0,
"end_latitude_decimal": 34.0,
"end_longitude_decimal": 35.0,
"added_dateutc": "2026-11-12T14:29:03.9792479+00:00",
"is_approved": true,
"is_confirmed": true,
"modified_dateutc": "2026-11-12T14:29:03.9792479+00:00"
}
application/xml, text/xml
<car_travel xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <added_dateutc>2026-11-12T14:29:03.979Z</added_dateutc> <car_id>95027950-a248-4dbb-af01-ba03c5ac3f82</car_id> <date_from>2026-11-12T14:29:03.979Z</date_from> <date_from_rounded>2026-11-12T14:29:03.979Z</date_from_rounded> <date_to>2026-11-12T14:29:03.979Z</date_to> <date_to_rounded>2026-11-12T14:29:03.979Z</date_to_rounded> <end_latitude_decimal>34</end_latitude_decimal> <end_longitude_decimal>35</end_longitude_decimal> <from_db_address_id>4cddc34f-e0fe-46f0-8b83-f7da86af3cff</from_db_address_id> <from_db_address_other>sample string 8</from_db_address_other> <from_db_table_id>22dfe531-00ed-40b6-a2b8-7594dbc69dc8</from_db_table_id> <from_id_in_table>b05ee7ee-dc08-4277-a7b1-2769b3e39311</from_id_in_table> <from_travel_type_code>sample string 7</from_travel_type_code> <hour_type_id>c1a0edf6-c27a-4d47-9536-c6f3c6972d3e</hour_type_id> <id>98adf5b8-1b04-4f56-8241-72bb33fbc01e</id> <is_approved>true</is_approved> <is_confirmed>true</is_confirmed> <is_start_stop>true</is_start_stop> <is_time_for_money>true</is_time_for_money> <km>20</km> <km_after>22</km_after> <km_before>21</km_before> <km_distance>24</km_distance> <km_private>23</km_private> <modified_dateutc>2026-11-12T14:29:03.979Z</modified_dateutc> <notes>sample string 19</notes> <property_1_checked>true</property_1_checked> <property_2_checked>true</property_2_checked> <property_3_checked>true</property_3_checked> <property_4_checked>true</property_4_checked> <property_5_checked>true</property_5_checked> <start_latitude_decimal>32</start_latitude_decimal> <start_longitude_decimal>33</start_longitude_decimal> <to_db_address_id>7e8fdd0b-8803-4a93-a90d-f4fe1ad7a7f2</to_db_address_id> <to_db_address_other>sample string 13</to_db_address_other> <to_db_table_id>32e1a535-cdfe-4208-8f4d-fc3ecb2c268f</to_db_table_id> <to_in_in_table>dbd36730-156d-4e8e-9ed5-eb99c94f37e0</to_in_in_table> <to_travel_type_code>sample string 12</to_travel_type_code> <user_id>1b738d6f-8e4f-4ef0-80f3-e10a8877ac26</user_id> </car_travel>
Response Information
Resource Description :
IHttpActionResult containing the saved car travel record.
car_travel| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Primary Key |
globally unique identifier | |
| user_id |
Foreign key of User |
globally unique identifier |
Required |
| car_id |
Foreign key of Car |
globally unique identifier |
Required |
| from_db_address_id |
the FROM info are filled with the latest travel of this car |
globally unique identifier | |
| from_db_table_id |
Identifier of the database table that belongs to, when the departure point is linked to another record (e.g. a job). |
globally unique identifier | |
| from_id_in_table |
Primary key of the linked departure record in the table identified by . |
globally unique identifier | |
| from_travel_type_code |
Kind of departure point (e.g. home, office, previous job). |
string | |
| from_db_address_other |
Free-text departure address, used when the departure point isn't one of the standard linked records. |
string |
Max length: 255 |
| to_db_address_id |
The address used on navigation |
globally unique identifier | |
| to_db_table_id |
TO=> if navigate to a JOBS, to_db_table_id and to_in_table is filled with the jobs info |
globally unique identifier | |
| to_in_in_table |
Primary key of the linked destination record in the table identified by . |
globally unique identifier | |
| to_travel_type_code |
Kind of travel. Can be |
string |
Required |
| to_db_address_other |
Free-text destination address, used when the destination isn't one of the standard linked records. |
string |
Max length: 255 |
| hour_type_id |
Foreign key of the hour type |
globally unique identifier |
Required |
| date_from |
Local date+time when the travel started |
date | |
| date_from_rounded |
rounded to the nearest configured interval, used for billing/display. |
date |
Required |
| date_to |
local date+time when the travel finished |
date | |
| date_to_rounded |
rounded to the nearest configured interval, used for billing/display. |
date |
Required |
| notes |
Additional notes field |
string |
Max length: 4000 |
| km |
2019-04-01: Old field not use it anymore (FSA-986) the Mileage of the car after the travel,* Be aware, value should be always bigger than the last one |
integer | |
| km_before |
Auto filled when a new record is added |
integer | |
| km_after |
the Mileage of the car after the travel,* Be aware, value should be always bigger than the last one |
integer | |
| km_private |
A value the user indicates that contains the total number of km for Private use. |
integer | |
| km_distance |
Distance traveled, in kilometers, computed as minus . |
integer | |
| is_time_for_money |
Indicates this travel time is billable ("time for money") rather than purely informational. |
boolean | |
| is_start_stop |
Indicates this entry was recorded via a start/stop timer rather than manually keyed in. |
boolean | |
| property_1_checked |
Checked state of the hour type's configurable custom property #1 (see ) for this entry. |
boolean | |
| property_2_checked |
Checked state of the hour type's configurable custom property #2 for this entry. |
boolean | |
| property_3_checked |
Checked state of the hour type's configurable custom property #3 for this entry. |
boolean | |
| property_4_checked |
Checked state of the hour type's configurable custom property #4 for this entry. |
boolean | |
| property_5_checked |
Checked state of the hour type's configurable custom property #5 for this entry. |
boolean | |
| start_latitude_decimal |
Latitude of the user's location when the travel was started. |
decimal number | |
| start_longitude_decimal |
Longitude of the user's location when the travel was started. |
decimal number | |
| end_latitude_decimal |
Latitude of the user's location when the travel ended. |
decimal number | |
| end_longitude_decimal |
Longitude of the user's location when the travel ended. |
decimal number | |
| added_dateutc |
Readonly system field: UTC date and time this travel record was added. |
date | |
| is_approved |
is_approved flag |
boolean | |
| is_confirmed |
offline field: is_confirmed flag |
boolean | |
| modified_dateutc |
Readonly system field managed by database, filled with GetUtcDate when adding,updating |
date |
Response Formats
application/json, text/json
{
"id": "ddae86b7-ebeb-4c2c-9384-a47218da5894",
"user_id": "13f02fa1-5d6c-4c77-9a89-f275b020ea90",
"car_id": "90205ae7-122a-44b5-a040-424b6b043a29",
"from_db_address_id": "fc2295dc-7064-433f-9a84-4c508e6a030d",
"from_db_table_id": "224e03d3-1133-43de-b9a8-c73b3f7c0873",
"from_id_in_table": "3244e5a5-45d4-4254-bcf5-16adf496ca0c",
"from_travel_type_code": "sample string 7",
"from_db_address_other": "sample string 8",
"to_db_address_id": "d2ea939c-dabd-47be-b78f-b810423464c0",
"to_db_table_id": "dc6c6e25-4927-4fca-9253-bcb9906a839f",
"to_in_in_table": "5b2a8291-c724-4a87-8902-77c2662ea478",
"to_travel_type_code": "sample string 12",
"to_db_address_other": "sample string 13",
"hour_type_id": "5254c20f-bf5b-475e-a4fc-28da3872e9a0",
"date_from": "2026-11-12T14:29:03.9792479+00:00",
"date_from_rounded": "2026-11-12T14:29:03.9792479+00:00",
"date_to": "2026-11-12T14:29:03.9792479+00:00",
"date_to_rounded": "2026-11-12T14:29:03.9792479+00:00",
"notes": "sample string 19",
"km": 20,
"km_before": 21,
"km_after": 22,
"km_private": 23,
"km_distance": 24,
"is_time_for_money": true,
"is_start_stop": true,
"property_1_checked": true,
"property_2_checked": true,
"property_3_checked": true,
"property_4_checked": true,
"property_5_checked": true,
"start_latitude_decimal": 32.0,
"start_longitude_decimal": 33.0,
"end_latitude_decimal": 34.0,
"end_longitude_decimal": 35.0,
"added_dateutc": "2026-11-12T14:29:03.9792479+00:00",
"is_approved": true,
"is_confirmed": true,
"modified_dateutc": "2026-11-12T14:29:03.9792479+00:00"
}
application/xml, text/xml
<car_travel xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <added_dateutc>2026-11-12T14:29:03.979Z</added_dateutc> <car_id>90205ae7-122a-44b5-a040-424b6b043a29</car_id> <date_from>2026-11-12T14:29:03.979Z</date_from> <date_from_rounded>2026-11-12T14:29:03.979Z</date_from_rounded> <date_to>2026-11-12T14:29:03.979Z</date_to> <date_to_rounded>2026-11-12T14:29:03.979Z</date_to_rounded> <end_latitude_decimal>34</end_latitude_decimal> <end_longitude_decimal>35</end_longitude_decimal> <from_db_address_id>fc2295dc-7064-433f-9a84-4c508e6a030d</from_db_address_id> <from_db_address_other>sample string 8</from_db_address_other> <from_db_table_id>224e03d3-1133-43de-b9a8-c73b3f7c0873</from_db_table_id> <from_id_in_table>3244e5a5-45d4-4254-bcf5-16adf496ca0c</from_id_in_table> <from_travel_type_code>sample string 7</from_travel_type_code> <hour_type_id>5254c20f-bf5b-475e-a4fc-28da3872e9a0</hour_type_id> <id>ddae86b7-ebeb-4c2c-9384-a47218da5894</id> <is_approved>true</is_approved> <is_confirmed>true</is_confirmed> <is_start_stop>true</is_start_stop> <is_time_for_money>true</is_time_for_money> <km>20</km> <km_after>22</km_after> <km_before>21</km_before> <km_distance>24</km_distance> <km_private>23</km_private> <modified_dateutc>2026-11-12T14:29:03.979Z</modified_dateutc> <notes>sample string 19</notes> <property_1_checked>true</property_1_checked> <property_2_checked>true</property_2_checked> <property_3_checked>true</property_3_checked> <property_4_checked>true</property_4_checked> <property_5_checked>true</property_5_checked> <start_latitude_decimal>32</start_latitude_decimal> <start_longitude_decimal>33</start_longitude_decimal> <to_db_address_id>d2ea939c-dabd-47be-b78f-b810423464c0</to_db_address_id> <to_db_address_other>sample string 13</to_db_address_other> <to_db_table_id>dc6c6e25-4927-4fca-9253-bcb9906a839f</to_db_table_id> <to_in_in_table>5b2a8291-c724-4a87-8902-77c2662ea478</to_in_in_table> <to_travel_type_code>sample string 12</to_travel_type_code> <user_id>13f02fa1-5d6c-4c77-9a89-f275b020ea90</user_id> </car_travel>