«Електронна товарно-транспортна накладна» (е-ТТН) - об’єкт UAECMR

JSON:

Приклад тимчасово відсутній

Таблиця 1 - Опис параметрів об’єкта UAECMR

Параметр

Тип 1

Формат

Опис

M

Об’єкт UAECMR

ecmr

M

Ecmr

об’єкт; зміст документа

signatureStorage

M

SignatureStorage

об’єкт; підписи

Таблиця 2 - Опис параметрів об’єкта Ecmr

Параметр

Тип 1

Формат

Опис

Об’єкт Ecmr

documentContext

M

DocumentContext

об’єкт; технічні дані

exchangedDocument

M

ExchangedDocument

об’єкт; реквізити ТТН

specifiedSupplyChainConsignment

M

SpecifiedSupplyChainConsignment

об’єкт; інформація про перевезення

Таблиця 3 - Опис параметрів об’єкта SignatureStorage

Параметр

Тип 1

Формат

Опис

M

Об’єкт SignatureStorage

signatures

M

List<Signature>

масив об’єктів; підписи

Таблиця 4 - Опис параметрів об’єкта DocumentContext

Параметр

Тип 1

Формат

Опис

Об’єкт DocumentContext

transactionID

M

string

Номер версії документа (транзакції) в ланцюгу підписання документів

documentCode

M

DocumentCode

об’єкт; параметр контексту документа, визначений бізнес-процесом

documentSubCode

M

DocumentCode

об’єкт; параметр контексту визначеного документа

Таблиця 5 - Опис параметрів об’єкта ExchangedDocument

Параметр

Тип 1

Формат

Опис

Об’єкт ExchangedDocument

id

M

string

порядковий номер (серія) документа

issueDateTime

M

DateTime

об’єкт; Дата і час складання документа

remarks

O

string

Ремарки

includedNote

M/O

List<IncludedNote>

масив об’єктів; Додані записи. Поле обов’язкове для е-ТТН документа

issueLogisticsLocation

M

LogisticsLocation

об’єкт; Місце складання документа

Таблиця 6 - Опис параметрів об’єкта SpecifiedSupplyChainConsignment

Параметр

Тип 1

Формат

Опис

M

Об’єкт SpecifiedSupplyChainConsignment

grossWeightMeasure

M

EcmrUnitValue

Загальна вага перевезення (маса брутто) в кг

associatedInvoiceAmount

O

InvoiceAmount

Усього відпущено на загальну суму, грн

consignmentItemQuantity

M

decimal

Загальна кількість місць вантажу (контейнерів)

consignor

M

TradeParty

Вантажовідправник

consignee

M

TradeParty

Вантажоодержувач

carrier

M

TradeParty

Перевізник

notifiedTradeParties

M/O

List<TradeParty>

масив об’єктів; інформація (ЄДРПОУ / РНОКПП) про учасників перевезення. Детальніше в специфікації відповідного документа.

carrierAcceptanceLogisticsLocation

M

LogisticsLocation

об’єкт; Пункт навантаження

consigneeReceiptLogisticsLocation

M

LogisticsLocation

об’єкт; Пункт розвантаження

associatedReferencedDocuments

O

List<ReferencedDocument>

масив об’єктів; Супровідні документи на вантаж

deliveryTransportEvent

O

TransportEvent

об’єкт; Розвантажувальні роботи

pickUpTransportEvent

O/M

TransportEvent

об’єкт; Навантажувальні роботи

includedSupplyChainConsignmentItems

M

List<IncludedSupplyChainConsignmentItem>

масив об’єктів; Відомості про вантаж

utilizedLogisticsTransportEquipments

O/M

List<UtilizedLogisticsTransportEquipment>

масив об’єктів; Запис про автомобіль в перевезенні. Обов’язково заповнюється для Автомобіля (для причепа/напівпричепа опційно)

mainCarriageLogisticsTransportMovement

O

MainCarriageLogisticsTransportMovement

об’єкт; Маршрутизація (проміжні пункти перевантаження). Заповнюється Перевізником

deliveryInstructions

M/O

DeliveryInstructions

об’єкт; Вид перевезень

previousAdministrativeReferencedDocument

-/M

PreviousAdministrativeReferencedDocument

об’єкт; Попередня транзакція ECMR, на основі якої складено поточний документ. Блок не вказується, якщо документ створено з «нуля»

Таблиця 7 - Опис параметрів об’єкта Signature

Параметр

Тип 1

Формат

Опис

M

Об’єкт Signature

signingPartyRoleCode

M

string

Роль підписанта (наприклад, Вантажовідправник - CZ). Довідник ролей

partySignature

M

string

Підпис (base64 підпису p7s)

name

M

string

ПІБ підписанта (відповідальної особи)

position

O

string

Посада підписанта (відповідальної особи)

specifiedTaxRegistration

M

SimpleIdentity

об’єкт; Ідентифікаційний код відповідальної особи

Таблиця 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/-

EntityId

об’єкт; Код КАТОТТГ місцезнаходження пункту навантаження/розвантаження/місця складання/складу

  • обов’язковий об’єкт для пункту навантаження/розвантаження/місцезнаходження

  • об’єкт відсутній при заповненні місця складання документа

name

O/M

string

Найменування місця складання / пункту навантаження / пункту розвантаження / складу

  • обов’язковий параметр для пункту навантаження/розвантаження/місця складання документа

typeCode

O/M/-

string

Тип операції: 10 - навантаження; 5 - розвантаження.

  • обов’язковий параметр для пункту навантаження/розвантаження/місцезнаходження

  • параметр відсутній при заповненні місця складання документа

description

O/M

string

Опис (адреса) місця складання / пункту навантаження / пункту розвантаження

  • обов’язковий параметр для пункту навантаження/розвантаження/місця складання документа

physicalGeographicalCoordinate

M/O/-

PhysicalGeographicalCoordinate

об’єкт; Географічні координати

  • обов’язковий об’єкт для пункту навантаження/розвантаження

  • об’єкт відсутній при заповненні місцезнаходження/місця складання документа

Таблиця 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

EntityId

об’єкт;

  • Ідентифікаційний код (ЄДРПОУ / РНОКПП), є обов’язковим для:
    • consignor

    • consignee

    • carrier

    • initiatorTradeParty

    • consignorTradeParty

    • carrierTradeParty

    • consigneeTradeParty

    • customerTradeParty

    • notifiedTradeParties

  • РНОКПП, є опціональним для:
    • certifyingTradeParties

  • ЄДРПОУ, є обов’язковим для:
    • specifiedSupplyChainConsignment/mainCarriageLogisticsTransportMovement/specifiedTransportEvents/certifyingTradeParties в е-ТТН

name

M

string

Повна назва юридичної, або фізичної особи

roleCode

M

string

Роль учасника. Довідник ролей

tradeContact

O

TradeContact

об’єкт; Контакти відповідального представника

postalTradeAddress

O/M

PostalTradeAddress

об’єкт; Юридична адреса для юр.особи, або місце реєстрації для фіз.особи

taxRegistration

O

SimpleIdentity

об’єкт; Ідентифікаційний код відповідальної особи

specifiedGovernmentRegistrations

O/M

SimpleIdentity

об’єкт; Посвідчення Водія

Таблиця 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

DateTimeString

об’єкт; Дата складання документа

Таблиця 16 - Опис параметрів об’єкта HandlingInstructions

Параметр

Тип 1

Формат

Опис

Об’єкт HandlingInstructions

applicableTransportSettingTemperature

O

ApplicableTransportSettingTemperature

об’єкт; Температурний режим, необхідний для перевезення вантажу

Таблиця 17 - Опис параметрів об’єкта TransportEvent

Параметр

Тип 1

Формат

Опис

Об’єкт TransportEvent

id

O/-

string

Порядковий номер події (події завжди нумеруються в порядку поступового зростання за принципом N+1)

typeCode

O

string

Тип операції (розвантаження=5, завантаження=10)

description

O/-

string

Опис

actualOccurrenceDateTime

O

DateTime

об’єкт; Дата і час прибуття автомобіля на розвантаження

scheduledOccurrenceDateTime

O

DateTime

об’єкт; Дата і час вибуття автомобіля з-під розвантаження

occurrenceLogisticsLocation

O/M

LogisticsLocation

об’єкт; Місцезнаходження

certifyingTradeParties

O/M

List<TradeParty>

масив об’єктів; Інформація (РНОКПП) про відповідальних осіб (підписантів), що передбачені логікою документообігу

applicableNotes

O

List<ApplicableNote>

масив об’єктів; Примітки

Таблиця 18 - Опис параметрів об’єкта IncludedSupplyChainConsignmentItem

Параметр

Тип 1

Формат

Опис

Об’єкт IncludedSupplyChainConsignmentItem

sequenceNumeric

M

int

Порядковий номер рядка в таблиці

invoiceAmount

O

InvoiceAmount

об’єкт; Загальна сума з ПДВ

grossWeightMeasure

M

EcmrUnitValue

об’єкт; Маса брутто вантажу (кг)

tariffQuantity

O

EcmrUnitValue

об’єкт; Ціна без ПДВ за одиницю в грн. Це можуть бути як гривні на кілограм (грн./кг), так і гривні на ящик (грн./ящик) - залежить від зазначеної одиниці виміру

globalID

O

EntityId

об’єкт; Код УКТЗЕД продукції

natureIdentificationTransportCargo

M

Identification

об’єкт; Найменування вантажу

applicableTransportDangerousGoods

O

ApplicableTransportDangerousGoods

об’єкт; Клас небезпечних речовин

associatedReferencedLogisticsTransportEquipment

O

SimpleIdentity

об’єкт; Номер контейнера, в якому завантажено цей вантаж. Використовуєься опційно для контейнерих перевезень і має відповідати даним тегу UtilizedLogisticsTransportEquipment

associatedReferencedDocuments

O

List<ReferencedDocument>

масив об’єктів; Документи з вантажем

transportLogisticsPackage

O

TransportLogisticsPackage

об’єкт; Транспортно-логістичний пакет. ВАЖЛИВО: в Україні дозволяється лише один LogisticsPackage для одного ConsignmentItem!

applicableNotes

O

List<ApplicableNote>

масив об’єктів; Примітки

Таблиця 19 - Опис параметрів об’єкта UtilizedLogisticsTransportEquipment

Параметр

Тип 1

Формат

Опис

Об’єкт UtilizedLogisticsTransportEquipment

id

M

string

Реєстраційний номер автомобіля згідно з техпаспортом

  • укр.номери: має відповідати одному з патернів для автомобільних номерних знаків

  • єврономери: без валідації

categoryCode

M

string

Тип транспортного засобу (для автомобіля параметр не передається):

  • BX - Boxcar (ЗД вагон)

  • CN - Контейнер

  • TE - Trailer (причіп/напівпричіп)

characteristicCode

O

string

Код визначення Причіп/напівпричіп:

  • 14 - Причіп

  • 17 - Напівпричіп

affixedLogisticsSeals

M/O

List<SimpleIdentity>

масив об’єктів; Номера пломб. В Акті перепломбування для автомобіля цей об’єкт є обов’язковим

handlingInstructions

O

HandlingInstructions

об’єкт; Інструкції з експлуатації

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

DateTimeString

об’єкт; Дата складання документа, на основі якого складено поточний документ

attachedSpecifiedBinaryFile

M/O

AttachedSpecifiedBinaryFile

об’єкт; Дані документа до якого складається поточний документ. Обов’язковий при створенні Акта

Таблиця 23 - Опис параметрів об’єкта EntityId

Параметр

Тип 1

Формат

Опис

Об’єкт EntityId

schemeAgencyID

O/M

string

ідентифікатор; приймає значення УКТЗЕД/ЄДРПОУ/РНОКПП/КАТОТТГ/GLN в залежності від блоку, де застосовується - точніше вказано в параметрі на рівень вище

value

M

decimal

Значення

Таблиця 24 - Опис параметрів об’єкта PhysicalGeographicalCoordinate

Параметр

Тип 1

Формат

Опис

Об’єкт PhysicalGeographicalCoordinate

latitudeMeasure

O

string

Широта

longitudeMeasure

O

string

Довгота

systemId

M

EntityId

GLN

Таблиця 25 - Опис параметрів об’єкта TradeContact

Параметр

Тип 1

Формат

Опис

Об’єкт TradeContact

personName

O

string

ПІБ

telephoneUniversalCommunication

O

ComunicationContact

об’єкт; Основний телефон

mobileTelephoneUniversalCommunication

O

ComunicationContact

об’єкт; Мобільний телефон

emailURIUniversalCommunication

O

ComunicationContact

об’єкт; Електронна адреса

Таблиця 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

Код:

  • GROSSWEIGHT - Маса брутто (кг);

  • DOWNTIME - Час простою (години);

  • VENDOR_CODE - Артикул товару;

  • QUANTITY - Кількість товару;

  • URL - Посилання на документ;

  • BASE_UOM - Одиниця виміру кількості;

  • BUYER_CODE - Артикул покупця;

  • PRICE_WITH_VAT - Ціна за одиницю з ПДВ;

  • SUM_WITHOUT_VAT - Загальна сума без ПДВ;

  • RETURN_TARE - Ознака «зворотня тара»;

  • NET_WEIGHT - Маса нетто;

  • RTP_TYPE - Тип транспортної упаковки;

  • RTP_NAME - Назва транспортної упаковки;

  • RTP_QUANTITY - Кількість транспортної упаковки;

  • BRAND - Марка автомобіля;

  • MODEL - Модель автомобіля;

  • COLOR - Колір автомобіля;

  • TYPE - Тип (назва) автомобіля

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

ShippingMarks

об’єкт; Маркування

Таблиця 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

SimpleIdentity

об’єкт; Штрихкод товару

Таблиця 36 - Опис параметрів об’єкта IncludedNote

Параметр

Тип 1

Формат

Опис

Об’єкт IncludedNote

contentCode

M

ContentCode

об’єкт; Контент запису

content

M

String

Код ролі учасника. Довідник ролей

  • перевізник - CA

  • новий перевізник - CH

  • водій - DR

  • новий водій - DRS

Таблиця 37 - Опис параметрів об’єкта ContentCode

Параметр

Тип 1

Формат

Опис

Об’єкт ContentCode

listAgencyID

M для GLN (решта O)

String

Ідентифікатор:

  • GLN

  • transportation_max_temperature (Максимальна температура під час перевезення)

  • logger_return (Повернення логера)

  • logistic_unit_number_with_logger (Номер логістичної одиниці з термологером)

  • gps_number (Номер GPS)

  • logger_number (Номер термологера).

Ідентифікатори logistic_unit_number_with_logger / gps_number / logger_number вказуються контрагентом з роллю «Вантажовідправник». Ідентифікатори transportation_max_temperature та logger_return вказуються контрагентом з роллю «Вантажоодержувач»

value

M

  • для GLN = Число (13)

  • для transportation_max_temperature = Число (3)

  • для logger_return = «Так» / «Ні»

  • для logistic_unit_number_with_logger = Рядок

  • для gps_number = Рядок

  • для logger_number = Рядок

значення ідентифікатора


1

Під визначенням колонки Тип поля мається на увазі скорочене позначення:

  • M (mandatory) — обов’язкові до заповнення поля;

  • O (optional) — необов’язкові (опціональні) до заповнення поля.