Customer and Supplier Master Data

Master data for identifying customers or suppliers. For order confirmations (OC) and invoices, the business partner is usually treated as a customer; for delivery notes, they may appear as either a customer or a supplier depending on the use case. The output typically only returns the client_id1. The other information helps the AI identify the correct customer or supplier.

A list of this type can also serve as the receiver list in a channel (field Receiver Lookup ID). Workist uses it to recognise the buyer or receiver on order confirmations and delivery notes. Which document type uses which list is described under Which document type uses which list.

Column Description

Required: Workist cannot use the record without this column. Recommended: significantly improves recognition. The import itself does not check columns: if a column is missing, the field stays empty.

#	Field Name	Status	Description
1	client_id1	Required	Primary customer or supplier number. Workist returns this number in the output.
2	client_id2	Optional	Secondary customer or supplier number
3	client_id3	Optional	Tertiary customer or supplier number
4	company_name	Recommended	Name of the customer or supplier
5	address1	Recommended	Street and house number in one column (e.g. Musterstraße 1)
6	street_name	Optional	Street name, if street and house number are separate. Alternative to address1.
7	street_number	Optional	House number, if separate from street_name
8	address2	Optional	Additional address line
9	zip_code	Recommended	Postal code
10	city	Recommended	City
11	country_subdivision	Optional	State or region
12	country	Recommended	Country. Workist converts country names and three- or one-letter country codes to the two-letter ISO code (e.g. Germany → DE). Values it does not recognise are left empty.
13	po_box	Optional	PO box
14	misc	Optional	Additional information about the address
15	client_type	Optional	Category or type of the customer or supplier
16	client_contact_person1	Optional	Contact person as a single text field. If customers have several contacts, provide a separate contact list instead.
17	domain	Optional	The customer's internet domain, e.g. example.com. Workist lowercases it and drops free-mail domains such as gmail.com during the import.
18	iln	Optional	Global location number (GLN/ILN)
19	vat	Optional	VAT identification number
20	iban	Optional	IBAN of the customer or supplier
21	swift	Optional	BIC of the customer or supplier
22	locale_numeric	Optional	Number format on this customer's documents: de (1.234,56) or en (1,234.56). Helps Workist read quantities and prices correctly.
23	locale	Optional	Language and region of this customer's documents, e.g. de_DE. Workist uses it to read dates, and as the number format if locale_numeric is empty.
24	internal_note	Optional	Internal comments or notes
25	partition_id	Optional	Usually left empty in the customer list.
26	extra_data	Optional	Additional information as a JSON object, e.g. {"Brand": "Sample"}. Workist stores it with the record and shows it in the data explorer. By default, Workist does not use it for recognition.

Format

Columns that are not needed can be omitted from the data export.

Example file name: client_list.csv

client_id1;client_id2;company_name;address1;zip_code;city;country
K001;10001;Muster GmbH;Musterstraße 1;12345;Berlin;DE
K002;10002;Beispiel AG;Beispielweg 5;20099;Hamburg;DE
K003;;Test & Co. KG;Testplatz 3;80331;München;DE

The example uses ; as delimiter. Set the delimiter in the import configuration; without a setting, Workist expects a comma.

Via the API you send the same columns as a CSV file or as JSON. Endpoint: Swagger, basics: Using the Master Data API.