Import tasks and diary entries

This article lists the columns you can use when you import tasks and diary entries from a CSV file, and how Kompass decides whether a row updates an existing record or adds a new one. For how the Import dialog works, see Import records from a CSV file. Developers using the API can find the same columns in the API reference.

Where to import

Open the Diary, choose Actions, then Import. Tasks cannot be imported in Kompass yet; developers can import them through the API.

How rows are matched

  • Tasks: a row with an id updates that task. Otherwise Kompass looks for a task on the same proposal item (or, when you give only the project, on any proposal item of that project) with the same name, start date, end date and task type. A row that matches nothing adds a new task. The user columns set the task's assignees exactly: users not listed are removed.
  • Diary entries: a row with an id updates that entry; a row without one adds a new entry. Kompass recalculates the actual hours of each affected project once the import has finished.

Reading the column tables

Required marks a column a new record needs. A row that updates an existing record only changes the columns in your file, so you can leave the others out. Finds the record marks a column Kompass uses to find the existing record a row updates. Column names must match exactly, including underscores. Where a column only takes certain values, the description lists them. A column marked Needs an extra permission is only accepted from users who have that permission; for anyone else the import reports it as an unknown column. The Download template button in the Import dialog gives you the header row for your own permissions.

Diary entries

Column Required Finds the record Description
id No Yes Kompass ID of the record to update. When empty, the row adds a new record unless its other columns match an existing one.
user_id No No Kompass ID of the user the entry belongs to. Or use user_email or user_name.
user_email No No Email address of the user the entry belongs to. Or use user_id or user_name.
user_name No No Full name of the user, such as Alex Smith. Or use user_id or user_email.
task_id No No Kompass ID of the task the entry is booked against. Or use project_reference and task_type.
project_reference No No Reference of the project whose task the entry is booked against. Needs task_type. Or use task_id.
task_type No No Type of task on the project: 1 for field, 2 for office. Needs project_reference. Accepted values: 1, 2.
details No No Details of the work done.
date No No Date of the entry, such as 2026-01-31.
start_time No No Time the entry started, such as 08:30. When you use hours instead, leave this column out of the file (or the cell empty on a new entry).
end_time No No Time the entry ended, such as 17:00. When you use hours instead, leave this column out of the file (or the cell empty on a new entry).
hours No No Number of hours worked, such as 7.5. Used instead of start_time and end_time; the entry then starts at 08:00.
breaks No No Break time in minutes.
timezone No No Time zone of the entry.
travel No No Travel time in minutes.
mileage No No Mileage recorded for this entry.
status No No Leave empty for draft, S for submitted, A for approved, R for rejected. Accepted values: S, A, R.
decided No No Date the entry was approved or rejected, such as 2026-01-31.
decided_by_email No No Email address of the user who approved or rejected the entry. Or use decided_by_id.
decided_by_id No No Kompass ID of the user who approved or rejected the entry. Or use decided_by_email.
decided_notes No No Notes added when the entry was approved or rejected.

Tasks

Column Required Finds the record Description
id No Yes Kompass ID of the record to update. When empty, the row adds a new record unless its other columns match an existing one.
address_country No No Two-letter country code, such as GB or US, or the country name.
address_line1 No No First line of the task address.
address_line2 No No Second line of the task address.
address_postal_code No No Postal or ZIP code of the task address.
address_state No No State or province of the task address.
address_town No No Town or city of the task address.
days No No Number of days planned for the task.
details No No Details of the task.
end No Yes Last day of the task, such as 2026-01-31.
geometries No No Task location on the map, in the same format as the geometries column of a project export.
hours No No Number of hours planned for the task.
name Yes Yes Task name.
project_id No Yes Kompass ID of the project. Used to find or set the quote item. Or use project_name.
project_name No Yes Name of the project. Or use project_id.
quote_item_id No Yes Kompass ID of the quote item the task belongs to. Or use quote_item_name.
quote_item_name No Yes Name of the quote item. Or use quote_item_id.
start No Yes First day of the task, such as 2026-01-31.
tags No No Tag names separated by commas, or a list in square brackets such as ["Design, Build"] for a name that contains a comma. The record gets exactly these tags; an empty cell removes them all.
type_id No Yes Kompass ID of the task type. Or use type_name.
type_name No Yes Name of the task type. Or use type_id.
udf No No Custom field values, such as {"region": "North"}. Leave the column out to keep the current values.
udf_schema_id No No ID of the custom field set to use. Leave empty for the default set.
user_emails No No Email addresses of the users assigned to the task, separated by commas. Or use user_ids.
user_ids No No Kompass IDs of the users assigned to the task, separated by commas. Or use user_emails.
weekend_work No No Put yes if work can be scheduled on weekends.
Did this answer your question? Thanks for the feedback There was a problem submitting your feedback. Please try again later.

Still need help? Contact Us Contact Us