AMAGE
Introduction
The documentation describes the data formats used in the data import/export procedures using flat files. The documentation describes the data and formats necessary for the correct execution of the operation. The integration mechanism is outside the scope of this documentation
Orders/Delivery
Orders (CSV)
Line item definition format. A single order is a single file/data delivered to the system. Files named order.csv are generated via Web interfaces or sent via data integration interfaces.
Basic data
| name | value | description |
|---|---|---|
format |
CSV |
Text format, flat |
separator |
Semicolon |
|
first row |
Yes |
column description, ignore |
coding |
UTF-8 |
text and string encoding |
Date format: yyyy-MM-dd. The first row with a text description of the columns.
Number format: The decimal place and its treatment depend on the language of the instance, user and export format. If the record separator is a comma, then decimal numbers are written with a dot as a separator, e.g. 123.45. If the record separator is a different character, e.g. a semicolon, the data export depends on the interface language. If the user selected Polish, the export will save the number as 123.45. If the interface is English then 123.45. By default, when working in the backend (server machines), the default language is English.
Data fields
| name | sample value | description |
|---|---|---|
ORDER_NUMBER |
ZAM/12/2020 |
Order number |
ORDER_DATE |
2020-06-04 |
date of order |
ACCOUNT |
11587 |
Billing account with the provider |
WORK_ORDER |
MK-1 - load-bearing element |
The name of the work item/job |
CONTRACT_SCOPE |
MK-1 |
The object/scope of the contract |
CONTRACT_NAME |
AW-12 Krakow contract |
Contract name |
CONTRACT_NUMBER |
5X340 |
Contract number |
ITEM_NAME |
ADJUSTABLE BUCKLE 200 MK |
name of the element |
ITEM_ORDER_NUMBER |
P199120 |
Item ordering number |
ITEM_UNIT |
PIECE |
Conversion unit |
ITEM_UNIT_PRICE |
100.00 |
unit price |
ITEM_COUNT |
5.00 |
Quantity |
ITEM_PRICE |
500.00 |
Value |
Deliveries (CSV)
Delivery/return items definition format. A single delivery/return is a single file/data delivered/returned to the system. Files named <delivery/return number>.csv are generated via Web interfaces or sent via data integration interfaces.
Basic data
| name | value | description |
|---|---|---|
format |
CSV |
Text format, flat |
separator |
Semicolon |
|
first row |
Yes |
column description, ignore |
coding |
UTF-8 |
text and string encoding |
Date format: yyyy-MM-dd. The first row with a text description of the columns.
Number format: The decimal place and its treatment depend on the language of the instance, user and export format. If the record separator is a comma, then decimal numbers are written with a dot as a separator, e.g. 123.45. If the record separator is a different character, e.g. a semicolon, the data export depends on the interface language. If the user selected Polish, the export will save the number as 123.45. If the interface is English then 123.45. By default, when working in the backend (server machines), the default language is English.
Data fields
| name | sample value | description |
|---|---|---|
DELIVERY_NUMBER |
D/12/2020 |
Delivery/return number |
DELIVERY_DATE |
2020-06-04 |
date of order |
LOADING_DATE |
2020-06-05 |
Delivery/return loading date |
ORDER_NUMBER |
ZAM/123/45/2021 |
Related order number |
ACCOUNT |
11587 |
Billing account with the provider |
WORK_ORDER |
MK-1 - load-bearing element |
The name of the work item/job |
CONTRACT_SCOPE |
MK-1 |
The object/scope of the contract |
CONTRACT_NAME |
AW-12 Krakow contract |
Contract name |
CONTRACT_NUMBER |
5X340 |
Contract number |
ITEM_NAME |
ADJUSTABLE BUCKLE 200 MK |
name of the element |
ITEM_ORDER_NUMBER |
P199120 |
Item ordering number |
ITEM_UNIT |
PIECE |
Conversion unit |
ITEM_UNIT_PRICE |
100.00 |
unit price |
ITEM_COUNT |
5.00 |
Quantity |
ITEM_PRICE |
500.00 |
Value |
CHECKED_COUNT |
4.00 |
Quantity after delivery/return check (if available) |
Complaints (CSV)
Delivery/return claim item definition format. A single complaint is a single file/structure. Files named <complaint number>.csv are generated via Web interfaces or sent via data integration interfaces.
Basic data
| name | value | description |
|---|---|---|
format |
CSV |
Text format, flat |
separator |
Semicolon |
|
first row |
Yes |
column description, ignore |
coding |
UTF-8 |
text and string encoding |
Date format: yyyy-MM-dd. The first row with a text description of the columns.
Number format: The decimal place and its treatment depend on the language of the instance, user and export format. If the record separator is a comma, then decimal numbers are written with a dot as a separator, e.g. 123.45. If the record separator is a different character, e.g. a semicolon, the data export depends on the interface language. If the user selected Polish, the export will save the number as 123.45. If the interface is English then 123.45. By default, when working in the backend (server machines), the default language is English.
Data fields
| name | sample value | description |
|---|---|---|
COMPLAINT_NUMBER |
REKL/12/2020 |
Complaint number |
COMPLAINT_DATE |
2020-06-04 |
Complaint creation date |
DELIVERY_NUMBER |
DOST/123/45/2021 |
Associated delivery/return number |
ACCOUNT |
11587 |
Billing account with the provider |
WORK_ORDER |
MK-1 - load-bearing element |
The name of the work item/work order |
CONTRACT_SCOPE |
MK-1 |
The object/scope of the contract |
CONTRACT_NAME |
AW-12 Krakow contract |
Contract name |
CONTRACT_NUMBER |
5X340 |
Contract number |
ITEM_NAME |
ADJUSTABLE BUCKLE 200 MK |
name of the element |
ITEM_ORDER_NUMBER |
P199120 |
Item ordering number |
ITEM_UNIT |
PIECE |
Conversion unit |
ITEM_UNIT_PRICE |
100.00 |
unit price |
ITEM_COUNT |
5.00 |
Quantity |
ITEM_PRICE |
500.00 |
Value |
ITEM_QUALITY_COUNT |
1 |
Quantity advertised versus quality |
ITEM_QUANTITY_COUNT |
3 |
Quantity reported (no items) |
Delivery - Formwork
Delivery item definition format for small equipment deliveries. A single delivery is a single file/data delivered to the system. Files named WZ-XXXX.csv denoting the issue from the supplier’s warehouse.
Basic data
| name | value | description |
|---|---|---|
format |
CSV |
Text format, flat |
separator |
Semicolon |
|
first row |
Yes |
column description, ignore |
coding |
ISO-8859-2 |
text and string encoding |
Variable-width text data is padded to full length with spaces. For numeric values, the first item can be an apostrophe (') similar to Excel data. Date format: DD.MM.YY. The first row with a text description of the columns.
Number format: The decimal place and its treatment depend on the language of the instance, user and export format. If the record separator is a comma, then decimal numbers are written with a dot as a separator, e.g. 123.45. If the record separator is a different character, e.g. a semicolon, the data export depends on the interface language. If the user selected Polish, the export will save the number as 123.45. If the interface is English then 123.45. By default, when working in the backend (server machines), the default language is English.
Data fields
| name | sample value | description |
|---|---|---|
Contract |
3407 |
Contract number |
customer ID |
KB0004 |
Client ID |
Customer name |
COMPANY X |
Customer name |
Construction |
2411 |
Structural member account ID |
Construction Name |
S33 SUB SECTION X |
The text name of the structural element |
Date |
05/17/18 |
Document date |
Document type |
W-Z CAKE |
Document type - WZ (External Issue → for construction) |
Stock documents |
52992 |
Stock document number |
Article |
2124907 |
Article ordering number |
Article description |
SCREW STICK 1.0 B/D |
The text name of the article |
Wear type |
Use |
Text type of wear |
Category |
AND |
Wear category A - new element, B/C/D - degrees of wear |
Quantity |
40 |
Quantity in delivery |
Libra |
396 |
Delivery weight |
unit price |
207.65 |
Unit price of the assortment |
Value |
8306.0 |
The value in the accounting currency |
The key values necessary to identify the target cost center are:
-
Contract - Contract number
-
Construction - Structural element account ID
Key values necessary to identify the article:
-
Article - article number
Delivery - Small appliances
Delivery item definition format for small equipment deliveries. A single delivery is a single file/data delivered to the system. Files named WZ-XXXX.csv denoting the issue from the supplier’s warehouse.
Basic data
| name | value | description |
|---|---|---|
format |
CSV |
Text format, flat |
separator |
Semicolon |
|
first row |
Yes |
column description, ignore |
coding |
UTF-8 |
text and string encoding |
Date format: DD-MM-YYYY. The first row with a text description of the columns.
Number format: The decimal place and its treatment depend on the language of the instance, user and export format. If the record separator is a comma, then decimal numbers are written with a dot as a separator, e.g. 123.45. If the record separator is a different character, e.g. a semicolon, the data export depends on the interface language. If the user selected Polish, the export will save the number as 123.45. If the interface is English then 123.45. By default, when working in the backend (server machines), the default language is English.
Data fields
| name | sample value | description |
|---|---|---|
Contract |
3407 |
Contract number |
customer ID |
KB0004 |
Client ID |
Customer name |
COMPANY X |
Customer name |
Construction |
2411 |
Construction ID |
Construction Name |
S33 SUB SECTION X |
The text name of the build |
Date |
17-05-2018 |
Document date |
Document type |
W-Z CAKE |
Document type - WZ (External Issue → for construction) |
Stock documents |
52992 |
Stock document number |
Article |
12345 |
Article ordering number |
Article description |
POWER GENERATOR 40 KVA 230/400 V |
The text name of the article |
Quantity |
2 |
Quantity in delivery |
Libra |
5 |
Delivery weight |
Serial number |
123/23/2010 | 800/5/2016 |
Serial numbers separated by | pipe |
The key values necessary to identify the target cost center are:
-
Contract - Contract number
-
Construction - Structural element/object account ID
Key values necessary to identify the article:
-
Article - article number
Warehouses
Warehouse documents
The format of the definition of elements of the warehouse document. There can be many warehouse documents in a single file. Files named <doc.no. >.csv files are generated via Web interfaces or sent via data integration interfaces.
Basic data
| name | value | description |
|---|---|---|
format |
CSV |
Text format, flat |
separator |
Semicolon |
|
first row |
Yes |
column description, ignore |
coding |
UTF-8 |
text and string encoding |
Date format: yyyy-MM-dd. The first row with a text description of the columns.
Number format: The decimal place and its treatment depend on the language of the instance, user and export format. If the record separator is a comma, then decimal numbers are written with a dot as a separator, e.g. 123.45. If the record separator is a different character, e.g. a semicolon, the data export depends on the interface language. If the user selected Polish, the export will save the number as 123.45. If the interface is English then 123.45. By default, when working in the backend (server machines), the default language is English.
Data fields
| name | sample value | description |
|---|---|---|
DOCUMENT_NUMBER |
PZ/123/2020 |
Stock document number |
DOCUMENT_DATE |
2020-01-31 |
Date of the warehouse document |
TYPE |
RELEASE |
Warehouse document type |
WAREHOUSE |
MG-1 |
The name of the source/destination store |
SALARIES |
MG-1-A/2 |
The name of the storage location in the warehouse |
ACCOUNT |
A2345 |
Billing account number |
WORK_ORDER |
MK-1 - load-bearing element |
The name of the work item/job |
CONTRACT_SCOPE |
MK-1 |
The object/scope of the contract |
CONTRACT_NAME |
AW-12 Krakow contract |
Contract name |
CONTRACT_NUMBER |
5X340 |
Contract number |
ITEM_MANUFACTURER |
Company X |
The name of the item’s manufacturer |
ITEM_NAME |
ADJUSTABLE BUCKLE 200 MK |
name of the element |
ITEM_ORDER_NUMBER |
P199120 |
Item ordering number |
ITEM_UNIT |
PIECE |
Conversion unit |
ITEM_UNIT_PRICE |
100.00 |
The unit price of the item |
ITEM_COUNT |
5.00 |
Quantity |
ITEM_PRICE |
500.00 |
Value |