Import projects, proposal items and costs
This article lists the columns you can use when you import projects, proposal items, costs and the related lists 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 Projects, choose Actions, then Import. Proposal items, costs, cost options, proposal item templates and statuses cannot be imported in Kompass yet; developers can import them through the API.
How rows are matched
- Projects: a row with an
idupdates that project. Otherwise Kompass looks for a project with exactly the same name for the same organization (client_idorclient_name) and Kompass organization (org_idororg_name). A row that does not name all three always adds a new project. If more than one project matches, the row is a problem and the message lists their IDs. A row that matches nothing adds a new project. Only one project import can run at a time. - Proposal items: a row with an
idupdates that proposal item; a row without one adds a new proposal item. Kompass recalculates each affected project once the import has finished. - Proposal item work in progress: every row needs the proposal item's
idand only sets its work in progress value. - Costs: a row with an
idupdates that cost; a row without one adds a new cost. - Cost options: a row with an
idupdates that cost option. Otherwise Kompass looks for one with the same name, start date and group. - Proposal item templates: a row with an
idupdates that template. Otherwise Kompass looks for one with exactly the same template name. - Statuses: every row adds a new status record.
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.
Projects
| 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. |
abandoned |
No | No | Date the project was abandoned, such as 2026-01-31. |
abandoned_by_email |
No | No | Email address of the user who abandoned the project. Or use abandoned_by_id. |
abandoned_by_id |
No | No | Kompass ID of the user who abandoned the project. Or use abandoned_by_email. |
abandoned_notes |
No | No | Details about why the project was abandoned. |
abandoned_reason_id |
No | No | Kompass ID of the reason the project was abandoned. |
accepted |
No | No | Date the project was accepted, such as 2026-01-31. On a row without an id, with price, service_id and accepted_by_id or accepted_by_email, this also creates a quote item. |
accepted_by_email |
No | No | Email address of the contact who accepted the project. Or use accepted_by_id. |
accepted_by_id |
No | No | Kompass ID of the contact who accepted the project. Or use accepted_by_email. |
accepted_by_contact_email |
No | No | Email address of the contact who accepted the project. Or use accepted_by_contact_id. |
accepted_by_contact_id |
No | No | Kompass ID of the contact who accepted the project. Or use accepted_by_contact_email. |
access |
No | No | Access details for the project site. |
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 project address. |
address_line2 |
No | No | Second line of the project address. |
address_postal_code |
No | No | Postal or ZIP code of the project address. |
address_state |
No | No | State, province or region of the project address. |
address_town |
No | No | Town or city of the project address. |
billing_client_id |
No | No | Kompass ID of the client to invoice. Or use billing_client_name. |
billing_client_name |
No | No | Name of the client to invoice. Or use billing_client_id. |
category_id |
No | No | Kompass ID of the project category. Or use category_name. |
category_name |
No | No | Name of the project category. Or use category_id. |
checked |
No | No | Date the quality check was completed, such as 2026-01-31. |
checked_by_email |
No | No | Email address of the user who completed the quality check. Or use checked_by_id. |
checked_by_id |
No | No | Kompass ID of the user who completed the quality check. Or use checked_by_email. |
checked_notes |
No | No | Quality check notes. |
client_id |
No | Yes | Kompass ID of the client. Or use client_name. |
client_name |
No | Yes | Name of the client. Or use client_id. |
confirmation |
No | No | Kompass ID of the order confirmation. |
confirmation_details |
No | No | Details about the order confirmation. |
contact_email |
No | No | Email address of the client contact. Or use contact_id. |
contact_id |
No | No | Kompass ID of the client contact. Or use contact_email. |
created |
No | No | Date the project was created, such as 2026-01-31. Leave empty to use the earliest of requested, quoted, accepted, surveyed, processed, checked, invoiced, received and abandoned in the row, or today's date; an update by id keeps the stored date. Needs an extra permission. |
created_by_id |
No | No | Kompass ID of the user who created the project. Needs an extra permission. |
created_notes |
No | No | Notes added when the project was created. |
deadline |
No | No | Deadline for the project, such as 2026-01-31. |
delivered |
No | No | Date the project was delivered, such as 2026-01-31. |
delivered_by_email |
No | No | Email address of the user who delivered the project. Or use delivered_by_id. |
delivered_by_id |
No | No | Kompass ID of the user who delivered the project. Or use delivered_by_email. |
delivered_notes |
No | No | Delivery notes. |
details |
No | No | Details of the project. |
geometries |
No | No | Project location on the map. Copy the value from an export of this list. |
invoice_contacts_email |
No | No | Email addresses of the contacts who receive invoices, separated by commas. |
invoiced |
No | No | Date the project was fully invoiced, such as 2026-01-31. |
invoiced_by_email |
No | No | Email address of the user who recorded the invoice. Or use invoiced_by_id. |
invoiced_by_id |
No | No | Kompass ID of the user who recorded the invoice. Or use invoiced_by_email. |
invoiced_notes |
No | No | Invoice notes. |
managed_by_email |
No | No | Email address of the project manager. Or use managed_by_id. |
managed_by_id |
No | No | Kompass ID of the project manager. Or use managed_by_email. |
managed_notes |
No | No | Project manager notes. |
modified |
No | No | Date the project was last changed, such as 2026-01-31. Leave empty to use the earliest of requested, quoted, accepted, surveyed, processed, checked, invoiced, received and abandoned in the row, or today's date; an update by id uses today's date. Needs an extra permission. |
name |
No | Yes | Project name. Without an id, a project with the same client, organization and name is updated. |
notes |
No | No | Internal notes about the project. |
org_id |
No | Yes | Kompass ID of the organization. Or use org_name. |
org_name |
No | Yes | Name of the organization. Or use org_id. |
price |
No | No | Quoted price of the project. On a row without an id, with accepted, service_id and accepted_by_id or accepted_by_email, this also creates a quote item. |
probability |
No | No | Probability that the quote will be won, as a percentage. |
processed |
No | No | Date the project was processed, such as 2026-01-31. |
processed_by_email |
No | No | Email address of the user who processed the project. Or use processed_by_id. |
processed_by_id |
No | No | Kompass ID of the user who processed the project. Or use processed_by_email. |
processed_notes |
No | No | Processing notes. |
quote_deadline |
No | No | Date the quote is due, such as 2026-01-31. |
quote_decision |
No | No | Date the client is expected to decide, such as 2026-01-31. |
quoted |
No | No | Date the quote was submitted, such as 2026-01-31. |
quoted_by_email |
No | No | Email address of the estimator. Or use quoted_by_id. |
quoted_by_id |
No | No | Kompass ID of the estimator. Or use quoted_by_email. |
quoted_notes |
No | No | Quote notes. |
received |
No | No | Date the project was fully paid, such as 2026-01-31. |
received_by_email |
No | No | Email address of the user who recorded the payment. Or use received_by_id. |
received_by_id |
No | No | Kompass ID of the user who recorded the payment. Or use received_by_email. |
received_notes |
No | No | Payment notes. |
reference |
No | No | Project reference, unique in the organization. Leave empty to generate it automatically. |
requested |
No | No | Date the enquiry was received, such as 2026-01-31. |
requested_by_email |
No | No | Email address of the contact who requested the project. Or use requested_by_id. |
requested_by_id |
No | No | Kompass ID of the contact who requested the project. Or use requested_by_email. |
requested_by_contact_email |
No | No | Email address of the contact who requested the project. Or use requested_by_contact_id. |
requested_by_contact_id |
No | No | Kompass ID of the contact who requested the project. Or use requested_by_contact_email. |
requested_notes |
No | No | Enquiry notes. |
service_id |
No | No | Kompass ID of the service. Needed with price and accepted to create a quote item. |
surveyed |
No | No | Date the site was surveyed, such as 2026-01-31. |
surveyed_by_email |
No | No | Email address of the user who surveyed the site. Or use surveyed_by_id. |
surveyed_by_id |
No | No | Kompass ID of the user who surveyed the site. Or use surveyed_by_email. |
surveyed_notes |
No | No | Survey notes. |
suspended |
No | No | Date the project was suspended, such as 2026-01-31. |
suspended_by_email |
No | No | Email address of the user who suspended the project. Or use suspended_by_id. |
suspended_by_id |
No | No | Kompass ID of the user who suspended the project. Or use suspended_by_email. |
suspended_notes |
No | No | Suspension notes. |
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. |
udf_schema_id |
No | No | ID of the custom field set to use. Leave empty for the default set. |
udf |
No | No | Custom field values. Copy the format from an export of this list. Leave the column out to keep the current values. |
Quote items
| 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. |
accepted |
No | No | Date the quote item was accepted, such as 2026-01-31. |
accepted_by_email |
No | No | Email address of the contact who accepted the quote item. Or use accepted_by_id. |
accepted_by_id |
No | No | Kompass ID of the contact who accepted the quote item. Or use accepted_by_email. |
accepted_by_contact_email |
No | No | Email address of the contact who accepted the quote item. Or use accepted_by_contact_id. |
accepted_by_contact_id |
No | No | Kompass ID of the contact who accepted the quote item. Or use accepted_by_contact_email. |
details |
No | No | Details of the quote item, shown on the quote. |
name |
No | No | Quote item name. |
notes |
No | No | Internal notes about the quote item. |
optional |
No | No | Put yes to keep the item out of the project total until it is accepted. |
order |
No | No | Order of the item within its parent. |
parent_id |
No | No | Kompass ID of the quote item this one sits under. |
price |
No | No | Price of one unit of the quote item. |
project_id |
No | No | Kompass ID of the project. Required for a new quote item. Or use project_name. |
project_name |
No | No | Name of the project. Or use project_id. |
quantity |
No | No | Number of units. Used for a rate item. |
quantity_auto |
No | No | Put yes so that, on an accepted rate item, the quantity comes from the latest status by date. |
reference |
No | No | Quote item reference, unique in the project. Leave empty to number it automatically. |
service_id |
No | No | Kompass ID of the service. Required for a new quote item. |
price_type |
No | No | L for a lump sum, R for a rate. Accepted values: L, R. |
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. |
tax_category_id |
No | No | Kompass ID of the tax category. New quote items need this or vat_rate_id. |
udf |
No | No | Custom field values. Copy the format from an export of this list. 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. |
vat_rate_id |
No | No | Older alternative to tax_category_id. Ignored when tax_category_id is filled in. |
visibility |
No | No | S to show the item, E to leave it out of the client document, P to add its price to the parent item. Accepted values: S, E, P. |
Quote item work in progress
| Column | Required | Finds the record | Description |
|---|---|---|---|
id |
Yes | Yes | Kompass ID of the quote item to set the value on. |
wip |
Yes | No | Work in progress value. |
date |
Yes | No | Date the value applies from, such as 2026-01-31. |
Costs
| 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. |
quote_item_id |
No | No | Kompass ID of the quote item the cost line belongs to. |
cost_option_id |
No | No | Kompass ID of the cost option the line is based on. |
name |
No | No | Name of the cost line. |
quantity |
No | No | Quantity of the cost line. |
field_days |
No | No | Number of field days. |
field_day_cost |
No | No | Cost per field day. |
field_hours |
No | No | Number of field hours. |
field_hour_cost |
No | No | Cost per field hour. |
office_days |
No | No | Number of office days. |
office_day_cost |
No | No | Cost per office day. |
office_hours |
No | No | Number of office hours. |
office_hour_cost |
No | No | Cost per office hour. |
Quote item templates
| 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. |
details |
Yes | No | Quote item details/description. |
name |
Yes | No | Quote item name. |
notes |
No | No | Internal notes about the template. |
price |
No | No | Price of one unit of the quote item. |
price_type |
No | No | L for a lump sum, R for a rate. Accepted values: L, R. |
quantity_auto |
No | No | Put yes so that, on an accepted rate item, the quantity comes from the latest status by date. |
service_id |
No | No | Kompass ID of the service. Or use service_name. |
service_name |
No | No | Name of the service. Or use service_id. |
template_name |
Yes | Yes | Name of the template. |
template_notes |
No | No | Notes about the template. |
template_org_id |
No | No | Kompass ID of the organization. Leave empty for the current one. |
template_owner_id |
No | No | Kompass ID of the user who owns the template. |
template_shared |
No | No | OW for just you, DP for your department, OR for your organization, A for all organizations. Accepted values: OW, DP, OR, A. |
vat_rate_id |
No | No | Kompass ID of the VAT rate. |
Cost options
| 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. |
field_day_cost |
No | No | Cost per field day. |
field_days |
No | No | Number of field days. |
field_fixed |
No | No | Put yes to stop the field time values being edited on a cost line. |
field_hour_cost |
No | No | Cost per field hour. |
field_hours |
No | No | Number of field hours. |
office_day_cost |
No | No | Cost per office day. |
office_days |
No | No | Number of office days. |
office_fixed |
No | No | Put yes to stop the office time values being edited on a cost line. |
office_hour_cost |
No | No | Cost per office hour. |
office_hours |
No | No | Number of office hours. |
end |
No | No | End date when this cost option becomes inactive. |
group_id |
No | Yes | Kompass ID of the cost group. |
hours_per_day |
Yes | No | Working hours per day. |
label_text |
No | No | Text shown on the cost option label. |
label_colour |
No | No | Label color as a hex code, such as #FF5733. |
name |
No | Yes | Name of the cost option. |
name_fixed |
No | No | Put yes to stop the name being edited on a cost line. |
nominal_account_id |
No | No | Kompass ID of the nominal account the option posts to. |
quantity |
No | No | Default quantity. |
staff |
No | No | Put yes if the cost line counts towards the budgeted hours. |
start |
No | Yes | Start date when this cost option becomes active. |
time_multiplicator |
No | No | Multiplier applied to the time. |
Quote item statuses
| Column | Required | Finds the record | Description |
|---|---|---|---|
date |
Yes | No | Date this status entry applies to. |
notes |
No | No | Status notes. |
quantity |
No | No | Percentage complete for a lump sum, units completed for a rate. |
quote_item_id |
Yes | No | Kompass ID of the quote item the status applies to. |