Framework Agreements
Master data for validating framework agreement numbers. Workist can recognise framework agreement numbers and validate them against the provided master data. Workist uses framework agreements for RFQs and orders.
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 | partition_id | Required | client_id1 of the customer the contract belongs to. Needed so that only this customer's framework agreements can be selected. If the field is empty, Workist offers the contract for every customer. |
| 2 | client_id | Optional | Alternative customer number if the contract belongs to a parent customer. Only relevant if the customer number of the contract in the output can differ from the customer recognised on the document. |
| 3 | client_name | Optional | Name of the customer |
| 4 | contract_id1 | Required | Contract number to be found on the document, or the one that Workist includes in the output |
| 5 | contract_id2 | Optional | Alternative contract number |
| 6 | contract_name | Recommended | Name of the contract used for display purposes |
| 7 | 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: framework_contract_list.csv
partition_id;contract_id1;contract_id2;contract_name
K001;RV-2024-001;FW001;Jahresvertrag Muster GmbH 2024
K002;RV-2024-002;;Rahmenvertrag Beispiel AG 2024
K001;RV-2024-003;;Sonderkonditionen Muster GmbH
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.