AMAGE
Wstęp
Dokumentacja opisuje formaty danych wykorzystywane w procedurach importu/eksportu danych za pomocą plików płaskich ("flat file"). Dokumentacje opisuję dane i formaty niezbędne do prawidłowego wykonania operacji. Mechanizm integracji nie jest zakresem tej dokumentacji
Zamówienia/Dostawy
Zamówienia (CSV)
Format definicji elementów zamówienia. Pojedyncze zamówienie to pojedynczy plik/dane dostarczane do systemu. Pliki o nazwie order.csv generowane są poprzez interfejsy Web lub przesyłane przez interfejsy integracji danych.
Dane podstawowe
| nazwa | wartość | opis |
|---|---|---|
format |
CSV |
Format tekstowy, płaski |
separator |
Średnik |
|
pierwszy rząd |
tak |
opis kolumn, ignorować |
kodowanie |
UTF-8 |
kodowanie tekstu i ciągów znaków |
Format daty: yyyy-MM-dd. Pierwszy rząd z opisem tekstowym kolumn.
Format liczb: Miejsce przecinkowe i jego traktowanie zależne jest od języka aktualnego dla danej instancji, użytkownika oraz formatu eksportu. Jeśli separatorem rekordów jest przecinek to liczby dziesiętne zapisywane są z kropką jako separatorem np. 123.45. Jeśli separatorem rekordów jest inny znak np. średnik to eksport danych zależy od języka interfejsu. Jeśli użytkownik wybrał język polski to eksport zapisze liczbę jako 123,45. Jeśli interfejs jest angielski to 123.45. Domyślnie w pracy w backend (automaty serwerowe) językiem domyślnym jest język angielski.
Pola danych
| nazwa | przykładowa wartość | opis |
|---|---|---|
ORDER_NUMBER |
ZAM/12/2020 |
Numer zamówienia |
ORDER_DATE |
2020-06-04 |
Data zamówienia |
ACCOUNT |
11587 |
Konto rozliczeniowe z dostawcą |
WORK_ORDER |
MK-1 - element nośny |
Nazwa elementu konstrukcyjnego/zlecenia |
CONTRACT_SCOPE |
MK-1 |
Obiekt/zakres kontraktu |
CONTRACT_NAME |
AW-12 Kontrakt Kraków |
Nazwa kontraktu |
CONTRACT_NUMBER |
5X340 |
Numer kontraktu |
ITEM_NAME |
KLAMRA REG. 200 MK |
Nazwa elementu |
ITEM_ORDER_NUMBER |
P199120 |
Numer zamówieniowy elementu |
ITEM_UNIT |
PIECE |
Jednostka przeliczeniowa |
ITEM_UNIT_PRICE |
100.00 |
Cena jednostkowa |
ITEM_COUNT |
5.00 |
Ilość |
ITEM_PRICE |
500.00 |
Wartość |
Dostawy (CSV)
Format definicji elementów dostawy/zwrotu. Pojedyncza dostawa/zwrot to pojedynczy plik/dane dostarczane/zwracane do systemu. Pliki o nazwie <nr dostawy/zwrotu>.csv generowane są poprzez interfejsy Web lub przesyłane przez interfejsy integracji danych.
Dane podstawowe
| nazwa | wartość | opis |
|---|---|---|
format |
CSV |
Format tekstowy, płaski |
separator |
Średnik |
|
pierwszy rząd |
tak |
opis kolumn, ignorować |
kodowanie |
UTF-8 |
kodowanie tekstu i ciągów znaków |
Format daty: yyyy-MM-dd. Pierwszy rząd z opisem tekstowym kolumn.
Format liczb: Miejsce przecinkowe i jego traktowanie zależne jest od języka aktualnego dla danej instancji, użytkownika oraz formatu eksportu. Jeśli separatorem rekordów jest przecinek to liczby dziesiętne zapisywane są z kropką jako separatorem np. 123.45. Jeśli separatorem rekordów jest inny znak np. średnik to eksport danych zależy od języka interfejsu. Jeśli użytkownik wybrał język polski to eksport zapisze liczbę jako 123,45. Jeśli interfejs jest angielski to 123.45. Domyślnie w pracy w backend (automaty serwerowe) językiem domyślnym jest język angielski.
Pola danych
| nazwa | przykładowa wartość | opis |
|---|---|---|
DELIVERY_NUMBER |
D/12/2020 |
Numer dostawy/zwrotu |
DELIVERY_DATE |
2020-06-04 |
Data zamówienia |
LOADING_DATE |
2020-06-05 |
Data załadunku dostawy/zwrotu |
ORDER_NUMBER |
ZAM/123/45/2021 |
Numer powiązanego zamówienia |
ACCOUNT |
11587 |
Konto rozliczeniowe z dostawcą |
WORK_ORDER |
MK-1 - element nośny |
Nazwa elementu konstrukcyjnego/zlecenia |
CONTRACT_SCOPE |
MK-1 |
Obiekt/zakres kontraktu |
CONTRACT_NAME |
AW-12 Kontrakt Kraków |
Nazwa kontraktu |
CONTRACT_NUMBER |
5X340 |
Numer kontraktu |
ITEM_NAME |
KLAMRA REG. 200 MK |
Nazwa elementu |
ITEM_ORDER_NUMBER |
P199120 |
Numer zamówieniowy elementu |
ITEM_UNIT |
PIECE |
Jednostka przeliczeniowa |
ITEM_UNIT_PRICE |
100.00 |
Cena jednostkowa |
ITEM_COUNT |
5.00 |
Ilość |
ITEM_PRICE |
500.00 |
Wartość |
CHECKED_COUNT |
4.00 |
Ilość po sprawdzeniu dostawy/zwrotu (jeśli dostępne) |
Reklamacje (CSV)
Format definicji elementów reklamacji dotyczącej dostawy/zwrotu. Pojedyncze reklamacja to pojedynczy plik/struktura. Pliki o nazwie <numer reklamacji>.csv generowane są poprzez interfejsy Web lub przesyłane przez interfejsy integracji danych.
Dane podstawowe
| nazwa | wartość | opis |
|---|---|---|
format |
CSV |
Format tekstowy, płaski |
separator |
Średnik |
|
pierwszy rząd |
tak |
opis kolumn, ignorować |
kodowanie |
UTF-8 |
kodowanie tekstu i ciągów znaków |
Format daty: yyyy-MM-dd. Pierwszy rząd z opisem tekstowym kolumn.
Format liczb: Miejsce przecinkowe i jego traktowanie zależne jest od języka aktualnego dla danej instancji, użytkownika oraz formatu eksportu. Jeśli separatorem rekordów jest przecinek to liczby dziesiętne zapisywane są z kropką jako separatorem np. 123.45. Jeśli separatorem rekordów jest inny znak np. średnik to eksport danych zależy od języka interfejsu. Jeśli użytkownik wybrał język polski to eksport zapisze liczbę jako 123,45. Jeśli interfejs jest angielski to 123.45. Domyślnie w pracy w backend (automaty serwerowe) językiem domyślnym jest język angielski.
Pola danych
| nazwa | przykładowa wartość | opis |
|---|---|---|
COMPLAINT_NUMBER |
REKL/12/2020 |
Numer reklamacji |
COMPLAINT_DATE |
2020-06-04 |
Data utworzenia reklamacji |
DELIVERY_NUMBER |
DOST/123/45/2021 |
Numer powiązanej dostawy/zwrotu |
ACCOUNT |
11587 |
Konto rozliczeniowe z dostawcą |
WORK_ORDER |
MK-1 - element nośny |
Nazwa elementu konstrukcyjnego/zlecenia pracy |
CONTRACT_SCOPE |
MK-1 |
Obiekt/zakres kontraktu |
CONTRACT_NAME |
AW-12 Kontrakt Kraków |
Nazwa kontraktu |
CONTRACT_NUMBER |
5X340 |
Numer kontraktu |
ITEM_NAME |
KLAMRA REG. 200 MK |
Nazwa elementu |
ITEM_ORDER_NUMBER |
P199120 |
Numer zamówieniowy elementu |
ITEM_UNIT |
PIECE |
Jednostka przeliczeniowa |
ITEM_UNIT_PRICE |
100.00 |
Cena jednostkowa |
ITEM_COUNT |
5.00 |
Ilość |
ITEM_PRICE |
500.00 |
Wartość |
ITEM_QUALITY_COUNT |
1 |
Ilość reklamowana względem jakości |
ITEM_QUANTITY_COUNT |
3 |
Ilość reklamowana (brak elementów) |
Dostawa - Szalunki
Format definicji elementów dostawy dla systemów szalunkowych. Pojedyncza dostawa to pojedynczy plik/dane dostarczane do systemu. Pliki o nazwie WZ-XXXX.csv oznaczające wydanie z magazynu dostawcy.
Dane podstawowe
| nazwa | wartość | opis |
|---|---|---|
format |
CSV |
Format tekstowy, płaski |
separator |
Średnik |
|
pierwszy rząd |
tak |
opis kolumn, ignorować |
kodowanie |
ISO-8859-2 |
kodowanie tekstu i ciągów znaków |
Dane tekstowe o zmiennej szerokości uzupełniane są w pełnej długości za pomocą spacji. W przypadku wartości liczbowych pierwszym elementem może być apostrof (') podobnie jak w przypadku danych dla aplikacji Excel. Format daty: DD.MM.YY. Pierwszy rząd z opisem tekstowym kolumn.
Format liczb: Miejsce przecinkowe i jego traktowanie zależne jest od języka aktualnego dla danej instancji, użytkownika oraz formatu eksportu. Jeśli separatorem rekordów jest przecinek to liczby dziesiętne zapisywane są z kropką jako separatorem np. 123.45. Jeśli separatorem rekordów jest inny znak np. średnik to eksport danych zależy od języka interfejsu. Jeśli użytkownik wybrał język polski to eksport zapisze liczbę jako 123,45. Jeśli interfejs jest angielski to 123.45. Domyślnie w pracy w backend (automaty serwerowe) językiem domyślnym jest język angielski.
Pola danych
| nazwa | przykładowa wartość | opis |
|---|---|---|
Kontrakt |
3407 |
Numer kontraktu |
ID klienta |
KB0004 |
Identyfikator klienta |
Nazwa klienta |
FIRMA X |
Nazwa klienta |
Budowa |
2411 |
Identyfikator konta elementu konstrukcyjnego |
Budowa Nazwa |
S33 PODODCINEK X |
Nazwa tekstowa elementu konstrukcyjnego |
Data |
17.05.18 |
Data dokumentu |
Typ dokumentu |
WZ |
Typ dokumentu - WZ (Wydanie Zewnętrzne → na budowę) |
Dokument magazynowy |
52992 |
Numer dokumentu magazynowego |
Artykuł |
2124907 |
Numer zamówieniowy artykułu |
Opis artykułu |
PODSTAWKA ŚRUBOWA 1.0 B/D |
Nazwa tekstowa artykułu |
Typ zużycia |
Używ. |
Tekstowo typ zużycia |
Kategoria |
A |
Kategoria zużycia A - element nowy, B/C/D - stopnie zużycia |
Ilość |
40 |
Ilość w dostawie |
Waga |
396 |
Waga w dostawie |
Cena Jednostkowa |
207,65 |
Cena jednostkowa asortymentu |
Wartość |
8306,0 |
Wartość w walucie rozliczeniowej |
Kluczowe wartości niezbędne do identyfikacji docelowego centrum kosztów to:
-
Kontrakt - Numer kontraktu
-
Budowa - Identyfikator konta elementu konstrukcyjnego
Kluczowe wartości niezbędne do identyfikacji artykułu:
-
Artykuł - numer zamówieniowy artykułu
Dostawa - Urządzenia drobne
Format definicji elementów dostawy dla dostaw urządzeń drobnych. Pojedyncza dostawa to pojedynczy plik/dane dostarczane do systemu. Pliki o nazwie WZ-XXXX.csv oznaczające wydanie z magazynu dostawcy.
Dane podstawowe
| nazwa | wartość | opis |
|---|---|---|
format |
CSV |
Format tekstowy, płaski |
separator |
Średnik |
|
pierwszy rząd |
tak |
opis kolumn, ignorować |
kodowanie |
UTF-8 |
kodowanie tekstu i ciągów znaków |
Format daty: DD-MM-YYYY. Pierwszy rząd z opisem tekstowym kolumn.
Format liczb: Miejsce przecinkowe i jego traktowanie zależne jest od języka aktualnego dla danej instancji, użytkownika oraz formatu eksportu. Jeśli separatorem rekordów jest przecinek to liczby dziesiętne zapisywane są z kropką jako separatorem np. 123.45. Jeśli separatorem rekordów jest inny znak np. średnik to eksport danych zależy od języka interfejsu. Jeśli użytkownik wybrał język polski to eksport zapisze liczbę jako 123,45. Jeśli interfejs jest angielski to 123.45. Domyślnie w pracy w backend (automaty serwerowe) językiem domyślnym jest język angielski.
Pola danych
| nazwa | przykładowa wartość | opis |
|---|---|---|
Kontrakt |
3407 |
Numer kontraktu |
ID klienta |
KB0004 |
Identyfikator klienta |
Nazwa klienta |
FIRMA X |
Nazwa klienta |
Budowa |
2411 |
Identyfikator budowy |
Budowa Nazwa |
S33 PODODCINEK X |
Nazwa tekstowa budowy |
Data |
17-05-2018 |
Data dokumentu |
Typ dokumentu |
WZ |
Typ dokumentu - WZ (Wydanie Zewnętrzne → na budowę) |
Dokument magazynowy |
52992 |
Numer dokumentu magazynowego |
Artykuł |
12345 |
Numer zamówieniowy artykułu |
Opis artykułu |
AGREGAT PRĄDOTWÓRCZY 40 KVA 230/400 V |
Nazwa tekstowa artykułu |
Ilość |
2 |
Ilość w dostawie |
Waga |
5 |
Waga w dostawie |
Numer seryjny |
123/23/2010 | 800/5/2016 |
Numery seryjne separowane za pomocą znaku | pipe |
Kluczowe wartości niezbędne do identyfikacji docelowego centrum kosztów to:
-
Kontrakt - Numer kontraktu
-
Budowa - Identyfikator konta elementu konstrukcyjnego/obiektu
Kluczowe wartości niezbędne do identyfikacji artykułu:
-
Artykuł - numer zamówieniowy artykułu
Magazyny
Dokumenty magazynowe
Format definicji elementów dokumentu magazynowego. W pojedynczym pliku może znajdować się wiele dokumentów magazynowych. Pliki o nazwie <nr dok. magazynowego>.csv generowane są poprzez interfejsy Web lub przesyłane przez interfejsy integracji danych.
Dane podstawowe
| nazwa | wartość | opis |
|---|---|---|
format |
CSV |
Format tekstowy, płaski |
separator |
Średnik |
|
pierwszy rząd |
tak |
opis kolumn, ignorować |
kodowanie |
UTF-8 |
kodowanie tekstu i ciągów znaków |
Format daty: yyyy-MM-dd. Pierwszy rząd z opisem tekstowym kolumn.
Format liczb: Miejsce przecinkowe i jego traktowanie zależne jest od języka aktualnego dla danej instancji, użytkownika oraz formatu eksportu. Jeśli separatorem rekordów jest przecinek to liczby dziesiętne zapisywane są z kropką jako separatorem np. 123.45. Jeśli separatorem rekordów jest inny znak np. średnik to eksport danych zależy od języka interfejsu. Jeśli użytkownik wybrał język polski to eksport zapisze liczbę jako 123,45. Jeśli interfejs jest angielski to 123.45. Domyślnie w pracy w backend (automaty serwerowe) językiem domyślnym jest język angielski.
Pola danych
| nazwa | przykładowa wartość | opis |
|---|---|---|
DOCUMENT_NUMBER |
PZ/123/2020 |
Numer dokumentu magazynowego |
DOCUMENT_DATE |
2020-01-31 |
Data dokumentu magazynowego |
TYPE |
RELEASE |
Typ dokumentu magazynowego |
WAREHOUSE |
MG-1 |
Nazwa magazynu źródłowego/docelowego |
PLACE |
MG-1-A/2 |
Nazwa miejsca składowania na magazynie |
ACCOUNT |
A2345 |
Numer konta rozliczeniowego |
WORK_ORDER |
MK-1 - element nośny |
Nazwa elementu konstrukcyjnego/zlecenia |
CONTRACT_SCOPE |
MK-1 |
Obiekt/zakres kontraktu |
CONTRACT_NAME |
AW-12 Kontrakt Kraków |
Nazwa kontraktu |
CONTRACT_NUMBER |
5X340 |
Numer kontraktu |
ITEM_MANUFACTURER |
Firma X |
Nazwa producenta elementu |
ITEM_NAME |
KLAMRA REG. 200 MK |
Nazwa elementu |
ITEM_ORDER_NUMBER |
P199120 |
Numer zamówieniowy elementu |
ITEM_UNIT |
PIECE |
Jednostka przeliczeniowa |
ITEM_UNIT_PRICE |
100.00 |
Cena jednostkowa elementu |
ITEM_COUNT |
5.00 |
Ilość |
ITEM_PRICE |
500.00 |
Wartość |