Додавання документа до eТТН

URI: /ettn/addDocument/648c2da1085dcd82500f2bd2

Використовується для додавання документа до eТТН.

Запит виконується методом POST у json форматі з даними.

Параметри запиту

Ім'я	Тип	Обов.	Опис
exchangedDocumentContext	object	Так	Технічні дані
exchangedDocumentContext. dateTime	string	Так	Дата і час складання документа
exchangedDocumentContext. logisticName	string	Так	Місце складання документа
exchangedDocumentContext. logisticDescription	string	Так	Адреса місця складання документа
exchangedDocumentContext. status	string	Так	Поточний статус eТТН: PLANNED - Перевезення заплановано. Документ е-ТТН створено та підписано вантажовідправником. Вантаж готовий до відвантаження PICKUP - Відбулось завантаження (на початковому або проміжному складі), документ е-ТТН підписано перевізником, що підтверджує матеріальну відповідальність за вантаж. Вантаж у процесі перевезення. ONSTORAGE - Вантаж прийнято на зберігання на проміжному складі, відбулось розвантаження. ARRIVAL - Вантаж отримано і прийнято на пункті призначення, матеріальну відповідальність перекладено на вантажоодержувача. CANCELED - Документ відмінено
chainConsignment	object	Так	Інформація про перевезення
chainConsignment. grossWeightUnitCode	string	Так	Одиниця виміру ваги брутто (можливе тільки одне значення KGM)
chainConsignment. grossWeightMeasure	string	Так	Маса брутто вантажу
chainConsignment. associatedInvoiceCurrencyID	string	Так	Код одиниці виміру (UAH)
chainConsignment. associatedInvoiceAmount	string	Так	Ціна без ПДВ за одиницю
chainConsignment. quantity	string	Так	Загальна кількість місць вантажу (контейнерів)
consignorTradeParty	object	Так	Вантажовідправник
consignorTradeParty.schemeAgencyID	string	Так	Назва ідентифікатора (ЄДРПОУ, КАТОТТГ, РНОКПП, УКТЗЕД)
consignorTradeParty.id	string	Так	ЄДРПОУ/КАТОТТГ/РНОКПП/УКТЗЕД вантажовідправника
consignorTradeParty.name	string	Так	Ім'я вантажовідправника
consignorTradeParty.surname	string	Так	Прізвище вантажовідправника
consignorTradeParty.patronymic	string	Так	По батькові вантажовідправника
consignorTradeParty.roleCode	string	Так	Роль учасника (Вантажовідправник - CZ)
consignorTradeParty.telephone	string	Так	Основний телефон вантажовідправника
consignorTradeParty.mobile	string	Так	Мобільний телефон вантажовідправника
consignorTradeParty.email	string	Так	Електронна адреса вантажовідправника
consignorTradeParty.postCode	string	Так	Поштовий індекс вантажовідправника
consignorTradeParty.street	string	Так	Адреса (назва вулиці + номер будівлі)
consignorTradeParty.city	string	Так	Місто (назва населеного пункту)
consignorTradeParty.countryID	string	Так	Країна (UA)
consignorTradeParty.countryName	string	Так	Назва країни
consignorTradeParty.taxRegistration	string	Так	ЄДРПОУ підприємства, та/або РНОКПП всіх відповідальних осіб
consigneeTradeParty	object	Так	Вантажоодержувач
consigneeTradeParty.id	string	Так	ЄДРПОУ/КАТОТТГ/РНОКПП/УКТЗЕД вантажоодержувача
consigneeTradeParty.name	string	Так	Ім'я вантажоодержувача
consigneeTradeParty.surname	string	Так	Прізвище вантажоодержувача
consigneeTradeParty.patronymic	string	Так	По батькові вантажоодержувача
consigneeTradeParty.telephone	string	Так	Основний телефон вантажоодержувача
consigneeTradeParty.mobile	string	Так	Мобільний телефон вантажоодержувача
consigneeTradeParty.email	string	Так	Електронна адреса вантажоодержувача
consigneeTradeParty.postCode	string	Так	Поштовий індекс вантажоодержувача
consigneeTradeParty.street	string	Так	Адреса (назва вулиці + номер будівлі)
consigneeTradeParty.city	string	Так	Місто (назва населеного пункту)
consigneeTradeParty.countryID	string	Так	Країна (UA)
consigneeTradeParty.countryName	string	Так	Назва країни
consigneeTradeParty.taxRegistration	string	Так	ЄДРПОУ підприємства, та/або РНОКПП всіх відповідальних осіб
carrierTradeParty	object	Так	Перевізник
carrierTradeParty.id	string	Так	ЄДРПОУ/КАТОТТГ/РНОКПП/УКТЗЕД перевізника
carrierTradeParty.name	string	Так	Ім'я перевізника
carrierTradeParty.surname	string	Так	Прізвище перевізника
carrierTradeParty.patronymic	string	Так	По батькові перевізника
carrierTradeParty.telephone	string	Так	Основний телефон перевізника
carrierTradeParty.mobile	string	Так	Мобільний телефон перевізника
carrierTradeParty.email	string	Так	Електронна адреса перевізника
carrierTradeParty.postCode	string	Так	Поштовий індекс перевізника
carrierTradeParty.street	string	Так	Адреса (назва вулиці + номер будівлі)
carrierTradeParty.city	string	Так	Місто (назва населеного пункту)
carrierTradeParty.countryID	string	Так	Країна (UA)
carrierTradeParty.countryName	string	Так	Назва країни
carrierTradeParty.taxRegistration	string	Так	ЄДРПОУ підприємства, та/або РНОКПП всіх відповідальних осіб. У випадку перевізника - РНОКПП водія обов'язково!
forwarder	object	Так	Експедитор
forwarder.id	string	Так	Номер ідентифікатора
forwarder.name	string	Так	Ім'я експедитора
forwarder.surname	string	Так	Прізвище експедитора
forwarder.patronymic	string	Так	По батькові експедитора
forwarder.telephone	string	Так	Основний телефон експедитора
forwarder.mobile	string	Так	Мобільний телефон експедитора
forwarder.email	string	Так	Електронна адрес експедитора
forwarder.postCode	string	Так	Поштовий індекс експедитора
forwarder.street	string	Так	Адреса (назва вулиці + номер будівлі)
forwarder.city	string	Так	Місто (назва населеного пункту)
forwarder.countryID	string	Так	Країна (UA)
forwarder.countryName	string	Так	Назва країни
forwarder.taxRegistration	string	Так	РНОКПП всіх відповідальних осіб за необхідності
customer	object	Так	Замовник
customer.id	string	Так	ЄДРПОУ/КАТОТТГ/РНОКПП/УКТЗЕД замовника
customer.name	string	Так	Ім'я замовника
customer.surname	string	Так	Прізвище замовника
customer.patronymic	string	Так	По батькові замовника
customer.telephone	string	Так	Основний телефон замовника
customer.mobile	string	Так	Мобільний телефон замовника
customer.email	string	Так	Електронна адреса замовника
customer.postCode	string	Так	Поштовий індекс замовника
customer.street	string	Так	Адреса (назва вулиці + номер будівлі)
customer.city	string	Так	Місто (назва населеного пункту)
customer.countryID	string	Так	Країна (UA)
customer.countryName	string	Так	Назва країни
customer.taxRegistration	string	Так	ЄДРПОУ підприємства, та/або РНОКПП всіх відповідальних осіб за необхідності
security	object	Так	Охоронна компанія
security.id	string	Так	ЄДРПОУ/КАТОТТГ/РНОКПП/УКТЗЕД охоронної компанії
security.companyName	string	Так	Повне найменування охоронної компанії, що надає охоронні послуги вантажу під час перевезення
security.contact	object	Так	Контакти відповідального представника
security.contact.name	string	Так	Ім'я відповідального представника
security.contact.surname	string	Так	Прізвище відповідального представника
security.contact.patronymic	string	Так	По батькові відповідального представника
chainConsignmentNext	object	Так	Відомості про вантаж
chainConsignmentNext. itemGrossWeightUnitCode	string	Так	Одиниця виміру ваги брутто (можливе тільки одне значення KGM)
chainConsignmentNext. itemGrossWeightMeasure	string	Так	Маса брутто вантажу
chainConsignmentNext. amount	string	Так	Ціна без ПДВ за одиницю
chainConsignmentNext. schemeAgencyID	string	Так	УКТЗЕД (код продукції)
chainConsignmentNext. temperatureMin	string	Так	Мінімальна температура під час перевезення
chainConsignmentNext. temperatureMax	string	Так	Максимальна температура під час перевезення
chainConsignmentNext. chainID	string	Так
chainConsignmentNext. amountOne	string	Так
chainConsignmentNext. minimumValueMeasure	string	Так	Мінімальна температура під час перевезення
chainConsignmentNext. minimumValueUnitCode	string	Так	Одиниця виміру температури
chainConsignmentNext. cargoName	string	Так	Найменування вантажу
chainConsignmentNext. dangerousGoods	string	Так	Клас небезпечних речовин, до якого віднесено вантаж (у разі перевезення небезпечних вантажів). Код UNDG, 0 - якщо не використовується
chainConsignmentNext. dangerousGoodsLevel	string	Так	Клас небезпечних речовин 1-4
chainConsignmentNext. sequenceNumeric	string	Так	Порядковий номер вантажу
chainConsignmentNext. itemCurrencyID	string	Так	Назва валюти
chainConsignmentNext. itemCurrencyValue	string	Так	Загальна сума з ПДВ
chainConsignmentNext. itemTariffQuantityCode	string	Так	Назва валюти
chainConsignmentNext. itemTariffQuantityValue	string	Так	Ціна за одиницю без ПДВ
chainConsignmentNext. packageQuantity	string	Так	Кількість місць, які визначаються за кожним найменуванням вантажу
chainConsignmentNext. packageCode	string	Так	Вид пакування (https://gs1.se/en/guides/documentation/code-lists/t0137-packaging-type-code/)
chainConsignmentNext. associatedReferencedLogistics TransportEquipment	list[object]	Так	Містить список контейнерів з вантажем
chainConsignmentNext. associatedReferencedLogistics TransportEquipment. transportEquipment	string	Так	Номер контейнера з вантажем
chainConsignmentNext. associatedReferencedDocument	list[object]	Так	Містить список документів з вантажем
chainConsignmentNext. associatedReferencedDocument. associatedDocumentID	string	Так	Ідентифікатор документа з вантажем
chainConsignmentNext. associatedReferencedDocument. associatedDocumentRemark	string	Так	UUID супровідного документа
chainConsignmentNext. transportLogisticsPackage	list[object]	Так	Параметри пакування
chainConsignmentNext. transportLogisticsPackage.packageCount	string	Так	Кількість місць
chainConsignmentNext. transportLogisticsPackage.typeCode	string	Так	Вид пакування
chainConsignmentNext. transportLogisticsPackage.type	string	Так	Одиниця виміру
chainConsignmentNext. transportLogisticsPackage.packageName	string	Так	Назва транспортного пакування
chainConsignmentNext. transportLogisticsPackage.barcode	string	Так	Бар-коди
chainConsignmentNext.applicableNote	list[object]	Так	Додаткові примітки
chainConsignmentNext. applicableNote.contentCode	string	Так	Код примітки: VENDOR_CODE - артикул QUANTITY - кількість товару URL - Посилання на документ BASE_UOM - Одиниця виміру кількості товару BUYER_CODE - артикул покупця PRICE_WITH_VAT - ціна за одиницю з ПДВ SUM_WITHOUT_VAT - загальна сума без ПДВ RETURN_TARE - ознака "зворотня тара" NET_WEIGHT - маса нетто RTP_TYPE - Тип транспортного пакування RTP_NAME - Назва транспортного пакування RTP_QUANTITY - Кількість транспортного пакування
chainConsignmentNext. applicableNote.content	string	Так	Вміст примітки
carrierLogistics	object	Так	Пункт навантаження
carrierLogistics.id	string	Так	КАТОТТГ пункту навантаження
carrierLogistics.name	string	Так	Найменування пункту навантаження
carrierLogistics.typeCode	string	Так	Тип операції: 10 - навантаження; 5 - розвантаження
carrierLogistics.latitudeMeasure	string	Так	Географічні координати (широта)
carrierLogistics.longitudeMeasure	string	Так	Географічні координати (довгота)
consigneeLogistics	object	Так	Пункт розвантаження
consigneeLogistics.id	string	Так	КАТОТТГ пункту розвантаження
consigneeLogistics.name	string	Так	Найменування пункту розвантаження
consigneeLogistics.typeCode	string	Так	Тип операції: 10 - навантаження; 5 - розвантаження
consigneeLogistics.latitudeMeasure	string	Так	Географічні координати (широта)
consigneeLogistics.longitudeMeasure	string	Так	Географічні координати (довгота)
transportEquipmentCar	object	Так	Автомобіль
transportEquipmentCar.id	string	Так	Реєстраційний номер автомобіля згідно з техпаспортом
transportEquipmentCar.code	integer	Так
transportEquipmentCar.country	string	Так	Країна реєстрації автомобіля
transportEquipmentCar.applicableNote	list[object]	Так	Додаткові параметри
transportEquipmentCar. applicableNote.code	string	Так	Назва параметра (BRAND, MODEL, COLOR)
transportEquipmentCar. applicableNote.content	string	Так	Значення параметра
transportTrailer	object	Так	Причіп/напівпричіп
transportTrailer.id	string	Так	Реєстраційний номер причіпа/напівпричіпа згідно з техпаспортом
transportTrailer.code	integer	Так
transportTrailer.country	string	Так	Країна реєстрації причепа
transportTrailer.categoryCode	string	Так	Категорія причепа: BX - Boxcar (ЗД вагон) CN - Контейнер TE - Trailer (причеп)
transportTrailer.characteristicCode	string	Так	Тип причепа: 14 - причеп 17 - напів-причеп
transportTrailer.affixedLogisticsSeal	list[object]	Так	Інформація про пломбування SEAL_NO
transportTrailer.affixedLogisticsSeal.id	string	Так	Номер пломби, якою проводилося пломбування причіпа/напівпричіпа
transportTrailer.applicableNote	list[object]	Так	Додаткові параметри
transportTrailer. applicableNote.code	string	Так	Назва параметра (BRAND, MODEL)
transportTrailer. applicableNote.content	string	Так	Значення параметра
uaSignatureStorage	object	Так	Підписи
uaSignatureStorage.typeCode	string	Так
uaSignatureStorage.documentBase64	string	Так	Base64 документа
uaSignatureStorage.signature	list[object]	Так	Параметри підпису документа
uaSignatureStorage. signature.signingPartyRoleCode	string	Так	Роль підписанта
uaSignatureStorage. signature.signatureBase64	string	Так	Підпис (base64 підпису p7s)
uaSignatureStorage. signature.name	string	Так	ПІБ підписанта
uaSignatureStorage. signature.position	string	Так	Посада підписанта
uaSignatureStorage. signature.taxRegistration	string	Так	РНОКПП відповідальної особи

Приклад запиту

Запит повинен містити наступні заголовки:

Authorization: {{bearer}}
Content-Type: application/json
Accept: application/json

Запит: /ettn/addDocument/648c2da1085dcd82500f2bd2
{
    "exchangedDocumentContext": {
        "dateTime": "2021-10-26 21:32:52",
        "logisticName": "Місце складання документа",
        "logisticDescription": "79000, м.Львів, вул. Словацького, 1",
        "status": "PLANNED"
    },
    "chainConsignment": {
        "grossWeightUnitCode": "KGM",
        "grossWeightMeasure": "24601",
        "associatedInvoiceCurrencyID": "UAH",
        "associatedInvoiceAmount": "100",
        "quantity": "11"
    },
    "consignorTradeParty": {
        "schemeAgencyID": "ЄДРПОУ",
        "id": "12345678",
        "name": "Василь",
        "surname": "Васильченко",
        "patronymic": "Васильович",
        "roleCode": "CZ",
        "telephone": "0441112233",
        "mobile": "0931112233",
        "email": "[email protected]",
        "postCode": "01001",
        "street": "вул.Хрещатик, 22",
        "city": "Київ",
        "countryID": "UA",
        "countryName": "м.Київ",
        "taxRegistration": "12345678"
    },
    "consigneeTradeParty": {
        "id": "12345679",
        "name": "Василь",
        "surname": "Васильченко",
        "patronymic": "Васильович",
        "telephone": "0441112233",
        "mobile": "0931112233",
        "email": "[email protected]",
        "postCode": "01001",
        "street": "вул.Хрещатик, 22",
        "city": "Київ",
        "countryID": "UA",
        "countryName": "м.Київ",
        "taxRegistration": "12345678"
    },
    "carrierTradeParty": {
        "id": "12345680",
        "name": "Василь",
        "surname": "Васильченко",
        "patronymic": "Васильович",
        "telephone": "0441112233",
        "mobile": "0931112233",
        "email": "[email protected]",
        "postCode": "01001",
        "street": "вул.Хрещатик, 22",
        "city": "Київ",
        "countryID": "UA",
        "countryName": "м.Київ",
        "taxRegistration": "12345678"
    },
    "forwarder": {
        "id": "12345681",
        "name": "Василь",
        "surname": "Васильченко",
        "patronymic": "Васильович",
        "telephone": "0441112233",
        "mobile": "0931112233",
        "email": "[email protected]",
        "postCode": "01001",
        "street": "вул.Хрещатик, 22",
        "city": "Київ",
        "countryID": "UA",
        "countryName": "м.Київ",
        "taxRegistration": "12345678"
    },
    "customer": {
        "id": "12345682",
        "name": "Василь",
        "surname": "Васильченко",
        "patronymic": "Васильович",
        "telephone": "0441112233",
        "mobile": "0931112233",
        "email": "[email protected]",
        "postCode": "01001",
        "street": "вул.Хрещатик, 22",
        "city": "Київ",
        "countryID": "UA",
        "countryName": "м.Київ",
        "taxRegistration": "12345678"
    },
    "security": {
        "id": "12345678",
        "companyName": "ТОВ Компанія охорона",
        "contact": {
            "name": "Іван",
            "surname": "Небезпечний",
            "patronymic": "Іванович"
        }
    },
    "chainConsignmentNext": {
        "itemGrossWeightUnitCode": "KGM",
        "itemGrossWeightMeasure": "246",
        "amount": "100",
        "schemeAgencyID": "0101 30 00 00",
        "temperatureMin": "-20",
        "temperatureMax": "-15",
        "chainID": "1",
        "amountOne": "500",
        "minimumValueMeasure": "-20",
        "minimumValueUnitCode": "CEL",
        "cargoName": "Опис елементу 1 вантажу",
        "dangerousGoods": "0",
        "dangerousGoodsLevel": "1",
        "sequenceNumeric": "1",
        "itemCurrencyID": "UAH",
        "itemCurrencyValue": "10",
        "ItemTariffQuantityCode": "UAH",
        "ItemTariffQuantityValue": "500",
        "packageQuantity": "100",
        "packageCode": "CN",
        "associatedReferencedLogisticsTransportEquipment": [
            {
                "transportEquipment": "123456789-123"
            }
        ],
        "associatedReferencedDocument": [
            {
                "associatedDocumentID": "123123",
                "associatedDocumentRemark": "Опис документу"
            }
        ],
        "transportLogisticsPackage": [
            {
                "packageCount": "100",
                "typeCode": "SA",
                "type": "кг",
                "packageName": "Упаковано в мішки",
                "barcode": "1234578"
            }
        ],
        "applicableNote": [
            {
                "contentCode": "VENDOR_CODE",
                "content": "123123"
            },
            {
                "contentCode": "QUANTITY",
                "content": "1"
            },
            {
                "contentCode": "URL",
                "content": "https://name.domain.com"
            },
            {
                "contentCode": "BASE_UOM",
                "content": "шт"
            },
            {
                "contentCode": "BUYER_CODE",
                "content": "123"
            },
            {
                "contentCode": "PRICE_WITH_VAT",
                "content": "100"
            },
            {
                "contentCode": "RETURN_TARE",
                "content": "так"
            },
            {
                "contentCode": "NET_WEIGHT",
                "content": "100"
            },
            {
                "contentCode": "RTP_TYPE",
                "content": "конейнер"
            },
            {
                "contentCode": "RTP_NAME",
                "content": "конейнер для перевезення сипучих речовин"
            },
            {
                "contentCode": "RTP_QUANTITY",
                "content": "1"
            }
        ]
    },
    "carrierLogistics": {
        "id": "test",
        "name": "test 2",
        "typeCode": "5",
        "latitudeMeasure": "48.138708833123815",
        "longitudeMeasure": "11.503074665045691"
    },
    "consigneeLogistics": {
        "id": "test",
        "name": "test 2",
        "typeCode": "10",
        "latitudeMeasure": "48.138708833123815",
        "longitudeMeasure": "11.503074665045691"
    },
    "transportEquipmentCar": {
        "id": "АА1234ВВ",
        "code": 2,
        "country": "UK",
        "applicableNote": [
            {
                "code": "BRAND",
                "content": "Volvo"
            },
            {
                "code": "MODEL",
                "content": "Truck"
            },
            {
                "code": "COLOR",
                "content": "Синій"
            }
        ]
    },
    "transportTrailer": {
        "id": "АА1234ВВ",
        "code": 4,
        "country": "UK",
        "categoryCode": "TE",
        "characteristicCode": "14",
        "affixedLogisticsSeal": [
            {
                "id": "123123"
            },
            {
                "id": "23456"
            }
        ],
        "applicableNote": [
            {
                "code": "BRAND",
                "content": "Volvo"
            },
            {
                "code": "MODEL",
                "content": "Super Trailer"
            }
        ]
    },
    "uaSignatureStorage": {
        "typeCode": "730",
        "documentBase64": "",
        "signature": [
            {
                "signingPartyRoleCode": "CN",
                "signatureBase64": "{{signature1}}",
                "name": "Петренко В.В.",
                "position": "комірник",
                "taxRegistration": "12345678"
            },
            {
                "signingPartyRoleCode": "CA",
                "signatureBase64": "{{signature2}}",
                "name": "Іваненко В.В.",
                "position": "водій",
                "taxRegistration": "12345678"
            }
        ]
    }
}

Параметри запиту​

Приклад запиту​

Параметри запиту

Приклад запиту