Import sales orders

This article lists the columns you can use when you import sales orders and their allocations 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 Sales Orders, choose Actions, then Import for sales orders or Import Allocations for their lines.

How rows are matched

  • Sales orders: a row with an id updates that sales order. A row without one adds a new sales order.
  • Sales order allocations: a row with an id updates that allocation; a row without one adds an allocation. Put 1 or yes in the delete column to remove an allocation.

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.

Sales orders

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.
amount_net Yes No Authorized value of the order, net of tax.
client_id No No Kompass ID of the client the order is for.
client_reference Yes No The client's own purchase order number.
date Yes No Date of the order, such as 2026-01-31.
notes No No Free-text notes about the order.
project_id No No Kompass ID of the project the order is for.
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.

Sales order allocations

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.
amount_net Yes No Net amount of the line, before tax.
nominal_account_id Yes No Kompass ID of the nominal account the line posts to.
quote_item_id Yes No Kompass ID of the quote item the line is for.
sales_order_id Yes No Kompass ID of the sales order. It must already exist.
delete No No Put 1 or yes to delete the matching record.
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