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": "4da42699-ed0d-4300-af85-c53d5700bcc7",
"user_id": "80cb0e74-5b91-4756-ab24-faa0ee8f188b",
"car_id": "aa753d90-60ec-423c-8839-3a5d9ba4e515",
"from_db_address_id": "2ca0cd0a-bddc-461f-a2a9-0ba667947402",
"from_db_table_id": "0eea7b41-0820-499b-a40c-a53bc7e859e6",
"from_id_in_table": "a4e18a21-5aca-4c26-81d4-dac7860f73fd",
"from_travel_type_code": "sample string 7",
"from_db_address_other": "sample string 8",
"to_db_address_id": "a32fb078-9d82-4c45-8314-d0499342c10f",
"to_db_table_id": "e8f8417f-836c-40b4-8d93-0ba7d126d4bd",
"to_in_in_table": "c59328f9-de2a-4eee-bc0e-a0fd2545ca99",
"to_travel_type_code": "sample string 12",
"to_db_address_other": "sample string 13",
"hour_type_id": "c509aee9-89b8-47de-962b-bf1835bc07b7",
"date_from": "2026-09-16T09:24:58.5128821+00:00",
"date_from_rounded": "2026-09-16T09:24:58.5128821+00:00",
"date_to": "2026-09-16T09:24:58.5128821+00:00",
"date_to_rounded": "2026-09-16T09:24:58.5128821+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-09-16T09:24:58.5128821+00:00",
"is_approved": true,
"is_confirmed": true,
"modified_dateutc": "2026-09-16T09:24:58.5128821+00:00"
}
application/xml, text/xml
<car_travel xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <added_dateutc>2026-09-16T09:24:58.512Z</added_dateutc> <car_id>aa753d90-60ec-423c-8839-3a5d9ba4e515</car_id> <date_from>2026-09-16T09:24:58.512Z</date_from> <date_from_rounded>2026-09-16T09:24:58.512Z</date_from_rounded> <date_to>2026-09-16T09:24:58.512Z</date_to> <date_to_rounded>2026-09-16T09:24:58.512Z</date_to_rounded> <end_latitude_decimal>34</end_latitude_decimal> <end_longitude_decimal>35</end_longitude_decimal> <from_db_address_id>2ca0cd0a-bddc-461f-a2a9-0ba667947402</from_db_address_id> <from_db_address_other>sample string 8</from_db_address_other> <from_db_table_id>0eea7b41-0820-499b-a40c-a53bc7e859e6</from_db_table_id> <from_id_in_table>a4e18a21-5aca-4c26-81d4-dac7860f73fd</from_id_in_table> <from_travel_type_code>sample string 7</from_travel_type_code> <hour_type_id>c509aee9-89b8-47de-962b-bf1835bc07b7</hour_type_id> <id>4da42699-ed0d-4300-af85-c53d5700bcc7</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-09-16T09:24:58.512Z</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>a32fb078-9d82-4c45-8314-d0499342c10f</to_db_address_id> <to_db_address_other>sample string 13</to_db_address_other> <to_db_table_id>e8f8417f-836c-40b4-8d93-0ba7d126d4bd</to_db_table_id> <to_in_in_table>c59328f9-de2a-4eee-bc0e-a0fd2545ca99</to_in_in_table> <to_travel_type_code>sample string 12</to_travel_type_code> <user_id>80cb0e74-5b91-4756-ab24-faa0ee8f188b</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": "f627fb79-ba14-4242-a6b2-34cf3f9253ba",
"user_id": "27990fcd-c747-4857-bf24-aec1debbf026",
"car_id": "3d0fc260-f591-4d8f-8e94-077a884ae322",
"from_db_address_id": "02779518-a9da-4815-9bdf-7a6caa7fc66d",
"from_db_table_id": "5469a7b0-d97d-4500-b67e-c310231c483b",
"from_id_in_table": "9de23e27-b643-4cd5-971d-fd3a717746d3",
"from_travel_type_code": "sample string 7",
"from_db_address_other": "sample string 8",
"to_db_address_id": "690e3fb8-4a20-45e2-bd20-ba66955f2320",
"to_db_table_id": "0903bbf8-4a19-47e8-b6e2-07096c540d70",
"to_in_in_table": "ace01881-ce1c-4976-a101-d3188e31da01",
"to_travel_type_code": "sample string 12",
"to_db_address_other": "sample string 13",
"hour_type_id": "517cd2fb-4d76-491f-8f06-b1f4574d1bd7",
"date_from": "2026-09-16T09:24:58.6095974+00:00",
"date_from_rounded": "2026-09-16T09:24:58.6095974+00:00",
"date_to": "2026-09-16T09:24:58.6095974+00:00",
"date_to_rounded": "2026-09-16T09:24:58.6095974+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-09-16T09:24:58.6095974+00:00",
"is_approved": true,
"is_confirmed": true,
"modified_dateutc": "2026-09-16T09:24:58.6095974+00:00"
}
application/xml, text/xml
<car_travel xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <added_dateutc>2026-09-16T09:24:58.609Z</added_dateutc> <car_id>3d0fc260-f591-4d8f-8e94-077a884ae322</car_id> <date_from>2026-09-16T09:24:58.609Z</date_from> <date_from_rounded>2026-09-16T09:24:58.609Z</date_from_rounded> <date_to>2026-09-16T09:24:58.609Z</date_to> <date_to_rounded>2026-09-16T09:24:58.609Z</date_to_rounded> <end_latitude_decimal>34</end_latitude_decimal> <end_longitude_decimal>35</end_longitude_decimal> <from_db_address_id>02779518-a9da-4815-9bdf-7a6caa7fc66d</from_db_address_id> <from_db_address_other>sample string 8</from_db_address_other> <from_db_table_id>5469a7b0-d97d-4500-b67e-c310231c483b</from_db_table_id> <from_id_in_table>9de23e27-b643-4cd5-971d-fd3a717746d3</from_id_in_table> <from_travel_type_code>sample string 7</from_travel_type_code> <hour_type_id>517cd2fb-4d76-491f-8f06-b1f4574d1bd7</hour_type_id> <id>f627fb79-ba14-4242-a6b2-34cf3f9253ba</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-09-16T09:24:58.609Z</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>690e3fb8-4a20-45e2-bd20-ba66955f2320</to_db_address_id> <to_db_address_other>sample string 13</to_db_address_other> <to_db_table_id>0903bbf8-4a19-47e8-b6e2-07096c540d70</to_db_table_id> <to_in_in_table>ace01881-ce1c-4976-a101-d3188e31da01</to_in_in_table> <to_travel_type_code>sample string 12</to_travel_type_code> <user_id>27990fcd-c747-4857-bf24-aec1debbf026</user_id> </car_travel>