«Електронна товарно-транспортна накладна» (е-ТТН) - об’єкт UAECMR
JSON:
Приклад тимчасово відсутній
Таблиця 1 - Опис параметрів об’єкта UAECMR
Параметр |
Тип 1 |
Формат |
Опис |
---|---|---|---|
M |
Об’єкт UAECMR |
||
ecmr |
M |
об’єкт; зміст документа |
|
signatureStorage |
M |
об’єкт; підписи |
Таблиця 2 - Опис параметрів об’єкта Ecmr
Параметр |
Тип 1 |
Формат |
Опис |
---|---|---|---|
Об’єкт Ecmr |
|||
documentContext |
M |
об’єкт; технічні дані |
|
exchangedDocument |
M |
об’єкт; реквізити ТТН |
|
specifiedSupplyChainConsignment |
M |
об’єкт; інформація про перевезення |
Таблиця 3 - Опис параметрів об’єкта SignatureStorage
Параметр |
Тип 1 |
Формат |
Опис |
---|---|---|---|
M |
Об’єкт SignatureStorage |
||
signatures |
M |
List<Signature> |
масив об’єктів; підписи |
Таблиця 4 - Опис параметрів об’єкта DocumentContext
Параметр |
Тип 1 |
Формат |
Опис |
---|---|---|---|
Об’єкт DocumentContext |
|||
transactionID |
M |
string |
Номер версії документа (транзакції) в ланцюгу підписання документів |
documentCode |
M |
об’єкт; параметр контексту документа, визначений бізнес-процесом |
|
documentSubCode |
M |
об’єкт; параметр контексту визначеного документа |
Таблиця 5 - Опис параметрів об’єкта ExchangedDocument
Параметр |
Тип 1 |
Формат |
Опис |
---|---|---|---|
Об’єкт ExchangedDocument |
|||
id |
M |
string |
порядковий номер (серія) документа |
issueDateTime |
M |
об’єкт; Дата і час складання документа |
|
remarks |
O |
string |
Ремарки |
includedNote |
M/O |
List<IncludedNote> |
масив об’єктів; Додані записи. Поле обов’язкове для е-ТТН документа |
issueLogisticsLocation |
M |
об’єкт; Місце складання документа |
Таблиця 6 - Опис параметрів об’єкта SpecifiedSupplyChainConsignment
Параметр |
Тип 1 |
Формат |
Опис |
---|---|---|---|
M |
Об’єкт SpecifiedSupplyChainConsignment |
||
grossWeightMeasure |
M |
Загальна вага перевезення (маса брутто) в кг |
|
associatedInvoiceAmount |
O |
Усього відпущено на загальну суму, грн |
|
consignmentItemQuantity |
M |
decimal |
Загальна кількість місць вантажу (контейнерів) |
consignor |
M |
Вантажовідправник |
|
consignee |
M |
Вантажоодержувач |
|
carrier |
M |
Перевізник |
|
notifiedTradeParties |
M/O |
List<TradeParty> |
масив об’єктів; інформація (ЄДРПОУ / РНОКПП) про учасників перевезення. Детальніше в специфікації відповідного документа. |
carrierAcceptanceLogisticsLocation |
M |
об’єкт; Пункт навантаження |
|
consigneeReceiptLogisticsLocation |
M |
об’єкт; Пункт розвантаження |
|
associatedReferencedDocuments |
O |
List<ReferencedDocument> |
масив об’єктів; Супровідні документи на вантаж |
deliveryTransportEvent |
O |
об’єкт; Розвантажувальні роботи |
|
pickUpTransportEvent |
O/M |
об’єкт; Навантажувальні роботи |
|
includedSupplyChainConsignmentItems |
M |
масив об’єктів; Відомості про вантаж |
|
utilizedLogisticsTransportEquipments |
O/M |
масив об’єктів; Запис про автомобіль в перевезенні. Обов’язково заповнюється для Автомобіля (для причепа/напівпричепа опційно) |
|
mainCarriageLogisticsTransportMovement |
O |
об’єкт; Маршрутизація (проміжні пункти перевантаження). Заповнюється Перевізником |
|
deliveryInstructions |
M/O |
об’єкт; Вид перевезень |
|
previousAdministrativeReferencedDocument |
-/M |
об’єкт; Попередня транзакція ECMR, на основі якої складено поточний документ. Блок не вказується, якщо документ створено з «нуля» |
Таблиця 7 - Опис параметрів об’єкта Signature
Параметр |
Тип 1 |
Формат |
Опис |
---|---|---|---|
M |
Об’єкт Signature |
||
signingPartyRoleCode |
M |
string |
Роль підписанта (наприклад, Вантажовідправник - CZ). Довідник ролей |
partySignature |
M |
string |
Підпис (base64 підпису p7s) |
name |
M |
string |
ПІБ підписанта (відповідальної особи) |
position |
O |
string |
Посада підписанта (відповідальної особи) |
specifiedTaxRegistration |
M |
об’єкт; Ідентифікаційний код відповідальної особи |
Таблиця 8 - Опис параметрів об’єкта DocumentCode
Параметр |
Тип 1 |
Формат |
Опис |
---|---|---|---|
Об’єкт DocumentCode |
|||
id |
M |
string |
код типу/підтипу документа |
Таблиця 9 - Опис параметрів об’єкта DateTime
Параметр |
Тип 1 |
Формат |
Опис |
---|---|---|---|
Об’єкт DateTime |
|||
dateTime |
datetime (2021-12-13T14:19:23+02:00) |
Дата і час складання документа |
Таблиця 10 - Опис параметрів об’єкта LogisticsLocation
Параметр |
Тип 1 |
Формат |
Опис |
---|---|---|---|
Об’єкт LogisticsLocation |
|||
id |
M/- |
об’єкт; Код КАТОТТГ місцезнаходження пункту навантаження/розвантаження/місця складання/складу
|
|
name |
O/M |
string |
Найменування місця складання / пункту навантаження / пункту розвантаження / складу
|
typeCode |
O/M/- |
string |
Тип операції: 10 - навантаження; 5 - розвантаження.
|
description |
O/M |
string |
Опис (адреса) місця складання / пункту навантаження / пункту розвантаження
|
physicalGeographicalCoordinate |
M/O/- |
об’єкт; Географічні координати
|
Таблиця 11 - Опис параметрів об’єкта EcmrUnitValue
Параметр |
Тип 1 |
Формат |
Опис |
---|---|---|---|
Об’єкт EcmrUnitValue |
|||
unitCode |
M |
string |
Код одиниці виміру (для tariffQuantity приймає значення «UAH») |
value |
M |
decimal |
Значення |
Таблиця 12 - Опис параметрів об’єкта InvoiceAmount
Параметр |
Тип 1 |
Формат |
Опис |
---|---|---|---|
Об’єкт InvoiceAmount |
|||
currencyId |
M |
string |
Тризначний код валюти (UAH) |
value |
M |
decimal |
Значення |
Таблиця 13 - Опис параметрів об’єкта TradeParty
Параметр |
Тип 1 |
Формат |
Опис |
---|---|---|---|
M |
Об’єкт TradeParty |
||
id |
M/O |
об’єкт;
|
|
name |
M |
string |
Повна назва юридичної, або фізичної особи |
roleCode |
M |
string |
Роль учасника. Довідник ролей |
tradeContact |
O |
об’єкт; Контакти відповідального представника |
|
postalTradeAddress |
O/M |
об’єкт; Юридична адреса для юр.особи, або місце реєстрації для фіз.особи |
|
taxRegistration |
O |
об’єкт; Ідентифікаційний код відповідальної особи |
|
specifiedGovernmentRegistrations |
O/M |
об’єкт; Посвідчення Водія |
Таблиця 14 - Опис параметрів об’єкта SimpleIdentity
Параметр |
Тип 1 |
Формат |
Опис |
---|---|---|---|
Об’єкт SimpleIdentity |
|||
id |
M |
string |
ідентифікатор; приймає значення в залежності від блоку, де використовується - точніше вказано в параметрі на рівень вище |
Таблиця 15 - Опис параметрів об’єкта ReferencedDocument
Параметр |
Тип 1 |
Формат |
Опис |
---|---|---|---|
Об’єкт ReferencedDocument |
|||
typeCode |
O/M |
string |
Тип документа (довідник кодів документів |
id |
O/M |
string |
Номер документа |
remarks |
O |
string |
UUID документа |
formattedIssueDateTime |
O |
об’єкт; Дата складання документа |
Таблиця 16 - Опис параметрів об’єкта HandlingInstructions
Параметр |
Тип 1 |
Формат |
Опис |
---|---|---|---|
Об’єкт HandlingInstructions |
|||
applicableTransportSettingTemperature |
O |
об’єкт; Температурний режим, необхідний для перевезення вантажу |
Таблиця 17 - Опис параметрів об’єкта TransportEvent
Параметр |
Тип 1 |
Формат |
Опис |
---|---|---|---|
Об’єкт TransportEvent |
|||
id |
O/- |
string |
Порядковий номер події (події завжди нумеруються в порядку поступового зростання за принципом N+1) |
typeCode |
O |
string |
Тип операції (розвантаження=5, завантаження=10) |
description |
O/- |
string |
Опис |
actualOccurrenceDateTime |
O |
об’єкт; Дата і час прибуття автомобіля на розвантаження |
|
scheduledOccurrenceDateTime |
O |
об’єкт; Дата і час вибуття автомобіля з-під розвантаження |
|
occurrenceLogisticsLocation |
O/M |
об’єкт; Місцезнаходження |
|
certifyingTradeParties |
O/M |
List<TradeParty> |
масив об’єктів; Інформація (РНОКПП) про відповідальних осіб (підписантів), що передбачені логікою документообігу |
applicableNotes |
O |
List<ApplicableNote> |
масив об’єктів; Примітки |
Таблиця 18 - Опис параметрів об’єкта IncludedSupplyChainConsignmentItem
Параметр |
Тип 1 |
Формат |
Опис |
---|---|---|---|
Об’єкт IncludedSupplyChainConsignmentItem |
|||
sequenceNumeric |
M |
int |
Порядковий номер рядка в таблиці |
invoiceAmount |
O |
об’єкт; Загальна сума з ПДВ |
|
grossWeightMeasure |
M |
об’єкт; Маса брутто вантажу (кг) |
|
tariffQuantity |
O |
об’єкт; Ціна без ПДВ за одиницю в грн. Це можуть бути як гривні на кілограм (грн./кг), так і гривні на ящик (грн./ящик) - залежить від зазначеної одиниці виміру |
|
globalID |
O |
об’єкт; Код УКТЗЕД продукції |
|
natureIdentificationTransportCargo |
M |
об’єкт; Найменування вантажу |
|
applicableTransportDangerousGoods |
O |
об’єкт; Клас небезпечних речовин |
|
associatedReferencedLogisticsTransportEquipment |
O |
об’єкт; Номер контейнера, в якому завантажено цей вантаж. Використовуєься опційно для контейнерих перевезень і має відповідати даним тегу UtilizedLogisticsTransportEquipment |
|
associatedReferencedDocuments |
O |
List<ReferencedDocument> |
масив об’єктів; Документи з вантажем |
transportLogisticsPackage |
O |
об’єкт; Транспортно-логістичний пакет. ВАЖЛИВО: в Україні дозволяється лише один LogisticsPackage для одного ConsignmentItem! |
|
applicableNotes |
O |
List<ApplicableNote> |
масив об’єктів; Примітки |
Таблиця 19 - Опис параметрів об’єкта UtilizedLogisticsTransportEquipment
Параметр |
Тип 1 |
Формат |
Опис |
---|---|---|---|
Об’єкт UtilizedLogisticsTransportEquipment |
|||
id |
M |
string |
Реєстраційний номер автомобіля згідно з техпаспортом
|
categoryCode |
M |
string |
Тип транспортного засобу (для автомобіля параметр не передається):
|
characteristicCode |
O |
string |
Код визначення Причіп/напівпричіп:
|
affixedLogisticsSeals |
M/O |
List<SimpleIdentity> |
масив об’єктів; Номера пломб. В Акті перепломбування для автомобіля цей об’єкт є обов’язковим |
handlingInstructions |
O |
об’єкт; Інструкції з експлуатації |
|
applicableNotes |
M/O |
List<ApplicableNote> |
масив об’єктів; Примітки |
Таблиця 20 - Опис параметрів об’єкта MainCarriageLogisticsTransportMovement
Параметр |
Тип 1 |
Формат |
Опис |
---|---|---|---|
Об’єкт MainCarriageLogisticsTransportMovement |
|||
specifiedTransportEvents** |
M |
List<TransportEvent> |
масив об’єктів; Проміжне розвантаження |
Таблиця 21 - Опис параметрів об’єкта DeliveryInstructions
Параметр |
Тип 1 |
Формат |
Опис |
---|---|---|---|
Об’єкт DeliveryInstructions |
|||
description |
O |
string |
Опис (вид роботи перевізника: за відрядним тарифом, за погодинним тарифом, за покілометровим тарифом, централізовані перевезення тощо) |
descriptionCode |
M |
string |
Код (TRANSPORTATION_TYPE) |
Таблиця 22 - Опис параметрів об’єкта PreviousAdministrativeReferencedDocument
Параметр |
Тип 1 |
Формат |
Опис |
---|---|---|---|
Об’єкт PreviousAdministrativeReferencedDocument |
|||
typeCode |
O |
string |
Тип документа, на основі якого складено поточний документ. Довідник кодів документів |
id |
M |
string |
Відповідає ExchangedDocumentContext.SpecifiedTransactionID попередніх версій |
remarks |
O |
string |
Base64 документа попередньої версії |
formattedIssueDateTime |
O |
об’єкт; Дата складання документа, на основі якого складено поточний документ |
|
attachedSpecifiedBinaryFile |
M/O |
об’єкт; Дані документа до якого складається поточний документ. Обов’язковий при створенні Акта |
Таблиця 23 - Опис параметрів об’єкта EntityId
Параметр |
Тип 1 |
Формат |
Опис |
---|---|---|---|
Об’єкт EntityId |
|||
schemeAgencyID |
O/M |
string |
ідентифікатор; приймає значення УКТЗЕД/ЄДРПОУ/РНОКПП/КАТОТТГ/GLN в залежності від блоку, де застосовується - точніше вказано в параметрі на рівень вище |
value |
M |
decimal |
Значення |
Таблиця 24 - Опис параметрів об’єкта PhysicalGeographicalCoordinate
Параметр |
Тип 1 |
Формат |
Опис |
---|---|---|---|
Об’єкт PhysicalGeographicalCoordinate |
|||
latitudeMeasure |
O |
string |
Широта |
longitudeMeasure |
O |
string |
Довгота |
systemId |
M |
GLN |
Таблиця 25 - Опис параметрів об’єкта TradeContact
Параметр |
Тип 1 |
Формат |
Опис |
---|---|---|---|
Об’єкт TradeContact |
|||
personName |
O |
string |
ПІБ |
telephoneUniversalCommunication |
O |
об’єкт; Основний телефон |
|
mobileTelephoneUniversalCommunication |
O |
об’єкт; Мобільний телефон |
|
emailURIUniversalCommunication |
O |
об’єкт; Електронна адреса |
Таблиця 26 - Опис параметрів об’єкта PostalTradeAddress
Параметр |
Тип 1 |
Формат |
Опис |
---|---|---|---|
Об’єкт PostalTradeAddress |
|||
postCode |
O |
string |
Індекс |
streetName |
M |
string |
Адреса (назва вулиці + номер будівлі) |
cityName |
M |
string |
Місто (назва населеного пункту) |
countryID |
M |
string |
Країна (UA) |
countrySubDivisionName |
O |
string |
Область та район (за наявності) |
Таблиця 27 - Опис параметрів об’єкта DateTimeString
Параметр |
Тип 1 |
Формат |
Опис |
---|---|---|---|
M |
Об’єкт DateTimeString |
||
dateTime |
datetime (2021-12-13T14:19:23+02:00) |
Дата і час складання документа |
Таблиця 28 - Опис параметрів об’єкта ApplicableTransportSettingTemperature
Параметр |
Тип 1 |
Формат |
Опис |
---|---|---|---|
Об’єкт ApplicableTransportSettingTemperature |
|||
minimum |
O |
string |
Мінімальне значення температури |
maximum |
O |
string |
Максимальне значення температури |
Таблиця 29 - Опис параметрів об’єкта ApplicableNote
Параметр |
Тип 1 |
Формат |
Опис |
---|---|---|---|
Об’єкт ApplicableNote |
|||
contentCode |
O/M |
string |
Код:
|
content |
O |
decimal |
Значення |
Таблиця 30 - Опис параметрів об’єкта Identification
Параметр |
Тип 1 |
Формат |
Опис |
---|---|---|---|
Об’єкт Identification |
|||
identification |
M |
string |
Найменування вантажу |
Таблиця 31 - Опис параметрів об’єкта ApplicableTransportDangerousGoods
Параметр |
Тип 1 |
Формат |
Опис |
---|---|---|---|
Об’єкт ApplicableTransportDangerousGoods |
|||
UNDGIdentificationCode |
O |
decimal |
Клас небезпечних речовин, до якого віднесено вантаж (у разі перевезення небезпечних вантажів). Код UNDG, 0 - якщо не використовується |
packagingDangerLevelCode |
O |
decimal |
клас небезбечних речовин 1-4 |
Таблиця 32 - Опис параметрів об’єкта TransportLogisticsPackage
Параметр |
Тип 1 |
Формат |
Опис |
---|---|---|---|
Об’єкт TransportLogisticsPackage |
|||
itemQuantity |
O |
decimal |
Кількість місць, які визначаються за кожним найменуванням вантажу (це можуть бути ящики, кошики, мішки тощо; якщо вантаж упаковано на піддонах - вказують кількість піддонів) |
typeCode |
O |
string |
Вид пакування (Довідник видів упаковок) |
type |
O |
string |
Одиниця виміру для ItemQuantity |
physicalLogisticsShippingMarks |
O |
об’єкт; Маркування |
Таблиця 33 - Опис параметрів об’єкта AttachedSpecifiedBinaryFile
Параметр |
Тип 1 |
Формат |
Опис |
---|---|---|---|
Об’єкт AttachedSpecifiedBinaryFile |
|||
id |
M |
string |
Ідентифікатор (guid) документа-підстави (ТТН / Акта); має відповідати document.id еТТН/Акта в ЦБД (значення ettnId з методу Отримання списку подій з ЦБД = значення external_doc_id Отримання мета-даних документа) |
uriid |
O |
string |
Посилання на документ |
MIMECode |
O |
string |
Код MIME типізація |
SizeMeasure |
O |
Long |
Розмір файла |
Таблиця 34 - Опис параметрів об’єкта ComunicationContact
Параметр |
Тип 1 |
Формат |
Опис |
---|---|---|---|
Об’єкт ComunicationContact |
|||
completeNumber |
O |
string |
Контактні дані |
Таблиця 35 - Опис параметрів об’єкта ShippingMarks
Параметр |
Тип 1 |
Формат |
Опис |
---|---|---|---|
Об’єкт ShippingMarks |
|||
marking |
O |
string |
Назва транспортної упаковки (вільна назва), в якій перевозиться вантаж |
barcodeLogisticsLabel |
O |
об’єкт; Штрихкод товару |
Таблиця 36 - Опис параметрів об’єкта IncludedNote
Параметр |
Тип 1 |
Формат |
Опис |
---|---|---|---|
Об’єкт IncludedNote |
|||
contentCode |
M |
об’єкт; Контент запису |
|
content |
M |
String |
Код ролі учасника. Довідник ролей
|
Таблиця 37 - Опис параметрів об’єкта ContentCode
Параметр |
Тип 1 |
Формат |
Опис |
---|---|---|---|
Об’єкт ContentCode |
|||
listAgencyID |
M для GLN (решта O) |
String |
Ідентифікатор:
Ідентифікатори logistic_unit_number_with_logger / gps_number / logger_number / reserve_number вказуються контрагентом з роллю «Вантажовідправник». Ідентифікатори transportation_max_temperature та logger_return вказуються контрагентом з роллю «Вантажоодержувач». Ідентифікатор comments може вказуватись усіма учасниками документообігу на етапі формування Чернетки ТТН-документа (для Водія/Перевізника це sub_status_id=1; для Вантажоодержувача / Експедитора (+ Водія/Перевізника в рамках опційного підписання) це sub_status_id=6) |
value |
M |
|
значення ідентифікатора |
- 1
Під визначенням колонки Тип поля мається на увазі скорочене позначення:
M (mandatory) — обов’язкові до заповнення поля;
O (optional) — необов’язкові (опціональні) до заповнення поля.