Адреса API та документація (Swagger)
Приклади:
- договір contract.json
- додаткова угода addendum.json
- акт act.json
- штраф fine.json
Структура Contract (договір)
| № з/п | Найменування | Обов'язковість | Тип даних | min | max | Опис |
|---|---|---|---|---|---|---|
| 1 | extId | так | String | 1 | 256 | Ідентифікатор документа в зовнішній системі |
| 2 | documentNumber | так | String | 1 | 256 | Номер договору |
| 3 | documentDate | так | Date YYYY-MM-DD | - | - | Дата укладання договору |
| 4 | amount | так | double | 0.00 | 999_999_999_999.99 | Вартість договору |
| 5 | currency | так | String | 3 | 3 | Валюта договору за ISO 4217 (літерний код) |
| 6 | amountUAH | залежить від currency | double | 0.00 | 999_999_999_999.99 | Еквівалент у гривні (для currency != UAH) |
| 7 | fromDate | так | Date YYYY-MM-DD | - | - | Дата початку дії договору |
| 8 | toDate | залежить від noTerm | Date YYYY-MM-DD | - | - | Дата закінчення дії договору |
| 9 | subject | так | String | 1 | 3000 | Предмет договору |
| 10 | noTerm | так | boolean | - | - | Ознака безстроковості (безстроковий = true) |
| 11 | pdvInclude | так | boolean | - | - | Ознака ПДВ у вартості договору (з ПДВ = true) |
| 12 | pdvAmount | залежить від pdvInclude | double | 0.00 | 999_999_999_999.99 | Сума ПДВ у вартості договору (для pdvInclude = true) |
| 13 | tender | так | boolean | - | - | Ознака тендерної процедури (тендерна процедура = true) |
| 14 | reason | залежить від tender | String | 1 | 3000 | Обгрунтування відсутності тендерної процедури (для tender = false) |
| 15 | contractors | так | array[contractor] | 1 | - | Список контрагентів (дивитись "Структура contractor") |
| 16 | specifications | ні | array[specification] | 1 | - | Список специфікацій (дивитись "Структура specification") |
| 17 | isCpvVat | залежить від specifications | boolean | - | - | Ознака ПДВ у ціні товару (роботи, послуги) в специфікації (з ПДВ = true). |
| 18 | procurements | так | array[String] | 1 | - | Список кодів товару (роботи, послуги) за ДК 021:2015 |
Структура Addendum (додаткова угода)
| № з/п | Найменування | Обов'язковість | Тип даних | min | max | Опис |
|---|---|---|---|---|---|---|
| 1 | extId | так | String | 1 | 256 | Ідентифікатор документа в зовнішній системі |
| 2 | parentExtId | так | String | 1 | 256 | Ідентифікатор батьківського договору в зовнішній системі |
| 3 | documentNumber | так | String | 1 | 256 | Номер додаткової угоди |
| 4 | documentDate | так | Date YYYY-MM-DD | - | - | Дата укладання додаткової угоди |
| 5 | amount | так | double | 0.00 | 999_999_999_999.99 | Скоригована вартість договору |
| 6 | currency | так | String | 3 | 3 | Валюта додаткової угоди за ISO 4217 (літерний код) |
| 7 | amountUAH | залежить від currency | double | 0.00 | 999_999_999_999.99 | Еквівалент у гривні (для currency != UAH) |
| 8 | noTerm | так | boolean | - | - | Ознака безстроковості (безстроковий = true) |
| 9 | fromDate | так | Date YYYY-MM-DD | - | - | Дата початку дії додаткової угоди |
| 10 | toDate | залежить від noTerm | Date YYYY-MM-DD | - | - | Дата закінчення дії додаткової угоди |
| 11 | subject | так | String | 1 | 3000 | Предмет додаткової угоди |
| 12 | pdvInclude | так | boolean | - | - | Ознака ПДВ для скоригованої вартості договору (з ПДВ = true) |
| 13 | pdvAmount | залежить від pdvInclude | double | 0.00 | 999_999_999_999.99 | Сума ПДВ у скоригованій вартості договору (для isCorrectionWithPdv = true) |
| 14 | reasons | так | array[String] | 1 | 4 | Список підстав для укладання додаткової угоди: SUBJECT - зміна предмету договору PRICE - зміна ціни договору TERM - зміна терміну договору OTHER - інше |
| 15 | reasonOtherComment | залежить від reasons | String | 1 | 3000 | Деталізація підстави укладання додаткової угоди (для reasons = "OTHER") |
| 16 | amountIncrease | так | double | 0.00 | 999_999_999_999.99 | Вартість додаткової угоди |
| 17 | correctionType | так | String | - | - | Вплив додаткової угоди на вартість договору: INCREASE - збільшує вартість договору DECREASE - зменшує вартість договору NOT_CHANGE - не змінює |
| 18 | isCorrectionWithPdv | так | boolean | - | - | Ознака ПДВ у вартості додаткової угоди (з ПДВ = true) |
| 19 | correctionPdvValue | залежить від isCorrectionWithPdv | double | 0.00 | 999_999_999_999.99 | Сума ПДВ у вартості додаткової угоди (для pdvInclude = true) |
| 20 | contractors | так | array[contractor] | 1 | - | Список контрагентів (дивитись "Структура contractor") |
| 21 | specifications | ні | array[ specification] | 1 | - | Список специфікацій (дивитись "Структура specification") |
| 22 | isCpvVat | так | boolean | - | - | Ознака ПДВ у ціні товару (роботи, послуги) в специфікації (з ПДВ = true) |
| 23 | procurements | так | array[String] | 1 | - | Список кодів товару (роботи, послуги) за ДК 021:2015 |
Структура Act (акту/накладної)
| № з/п | Найменування | Обов'язковість | Тип даних | min | max | Опис |
|---|---|---|---|---|---|---|
| 1 | extId | так | String | 1 | 256 | Ідентифікатор документа в зовнішній системі |
| 2 | parentExtId | так | String | 1 | 256 | Ідентифікатор батьківського договору в зовнішній системі |
| 3 | documentNumber | так | String | 1 | 256 | Номер акту (накладної) |
| 4 | documentDate | так | Date YYYY-MM-DD | - | - | Дата укладання акту (накладної) |
| 5 | amount | так | double | -999_999_999_999.99 | 999_999_999_999.99 | Вартість акту (накладної) |
| 6 | currency | так | String | 3 | 3 | Валюта акту (накладної) за ISO 4217 (літерний код) |
| 7 | amountUAH | залежить від currency | double | -999_999_999_999.99 | 999_999_999_999.99 | Еквівалент у гривні (для currency != UAH) |
| 8 | pdvInclude | так | boolean | - | - | Ознака ПДВ у вартості акту (накладної) (з ПДВ = true) |
| 9 | pdvAmount | залежить від pdvInclude | double | -999_999_999_999.99 | 999_999_999_999.99 | Сума ПДВ у вартості акту (накладної0 (для pdvInclude = true) |
| 10 | contractors | так | array[contractor] | 1 | - | Список контрагентів (дивитись "Структура contractor") |
| 11 | specifications | ні | array[specification] | 1 | - | Список специфікацій (дивитись "Структура specification") |
| 12 | isCpvVat | так | boolean | - | - | Ознака ПДВ у ціні товару (роботи, послуги) в специфікації (з ПДВ = true) |
Структура Fine (штраф)
| № з/п | Найменування | Обов'язковість | Тип даних | min | max | Опис |
|---|---|---|---|---|---|---|
| 1 | extId | так | String | 1 | 256 | Ідентифікатор документа в зовнішній системі |
| 2 | parentExtId | так | String | 1 | 256 | Ідентифікатор батьківського договору в зовнішній системі |
| 3 | documentNumber | так | String | 1 | 256 | Номер штрафу |
| 4 | documentDate | так | Date YYYY-MM-DD | - | - | Дата укладання штрафу |
| 5 | amount | так | double | -999_999_999_999.99 | 999_999_999_999.99 | Вартість штрафу |
| 6 | currency | так | String | 3 | 3 | Валюта штрафу за ISO 4217 (літерний код) |
| 7 | amountUAH | залежить від currency | double | -999_999_999_999.99 | 999_999_999_999.99 | Еквівалент у гривні (для currency != UAH) |
| 8 | contractors | так | array[contractor] | 1 | - | Список контрагентів (дивитись "Структура contractor") |
Додаткові структури
Структура Contractor
| № з/п | Найменування | Обов'язковість | Тип даних | min | max | Опис |
|---|---|---|---|---|---|---|
| 1 | identifier | так | String | 8 10 | 8 10 | ЄДРПОУ контрагента або ІПН контрагента |
| 2 | type | так | String | 1 | 1 | Тип контрагента: LEGAL - юридична особа FOP - фізична особа-підприємець PERSON - фізична особа |
| 3 | name | так | String | 1 | 512 | Назва контрагента |
| 4 | firstName | так | String | 1 | 256 | Ім'я керівника контрагента |
| 5 | lastName | так | String | 1 | 256 | Прізвище керівника контрагента |
| 6 | middleName | ні | String | 1 | 256 | По батькові керівника контрагента |
| 7 | address | так | object | 1 | 1 | Об'єкт адреса контрагента (дивитись "Структура address") |
Структура Address
| № з/п | Найменування | Обов'язковість | Тип даних | min | max | Опис |
|---|---|---|---|---|---|---|
| 1 | country | так | String | 3 | 3 | Назва країни за ISO 3166-1 (alpha3) |
| 2 | region | так | String | 1 | 256 | Назва області (за КАТОТТГ для country = UKR) |
| 3 | district | ні | String | 1 | 256 | Назва району області (за КАТОТТГ для country = UKR) |
| 4 | city | так | String | 1 | 256 | Назва міста (за КАТОТТГ для country = UKR) |
| 5 | districtCity | ні | String | 1 | 256 | Назва району міста (за КАТОТТГ для country = UKR) |
| 6 | street | так | String | 1 | 512 | Назва вулиці |
| 7 | house | так | String | 1 | 10 | Номер будинку |
| 8 | housing | ні | String | 1 | 25 | Номер корпусу |
| 9 | office | ні | String | 1 | 10 | Номер офісу (квартири) |
Структура Specification
| № з/п | Найменування | Обов'язковість | Тип даних | min | max | Опис |
|---|---|---|---|---|---|---|
| 1 | name | так | String | 1 | 1024 | Назва товару (роботи, послуги) |
| 2 | specCode | ні | String | - | - | Код товару (роботи, послуги) за ДК 016:2010 |
| 3 | cpvCode | ні | String | - | - | Код товару (роботи, послуги) за ДК 021:2015 |
| 4 | itemDimension | так | String | - | - | Код одиниці виміру товару (роботи, послуги) за ДК 011-96 |
| 5 | itemCount | так | double | -999_999_999_999.9999 | 999_999_999_999.9999 | Кількість товару (роботи, послуги) |
| 6 | itemCost | так | double | 0.0001 | 999_999_999_999.9999 | Вартість товару (роботи, послуги) |