base.yml 77.3 KB
Newer Older
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
schemas:
  base.ApiResponse:
    x-baseClass: 'prozorro_sale.procedure.models.base.ApiResponse'
    type: object
    title: base.ApiResponse
    description: ' ApiResponse model '
    properties:
      message:
        type: string
  base.MultiLang:
    x-baseClass: 'prozorro_sale.procedure.models.base.MultiLang'
    type: object
    title: base.MultiLang
    description: ' Multi language string model '
    properties:
      uk_UA:
17
18
        x-legalNameUa: Назва українською
        x-legalNameEn: Ukrainian name
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
19
        type: string
20
        minLength: 1
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
21
      en_US:
22
23
        x-legalNameUa: Назва англійською
        x-legalNameEn: English name
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
24
25
26
27
28
29
30
31
        type: string
    required:
      - uk_UA
  base.Period:
    x-baseClass: 'prozorro_sale.procedure.models.base.Period'
    type: object
    title: base.Period
    description: |
Kateryna Zhluktenko's avatar
Kateryna Zhluktenko committed
32
      Period model <br>
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
      Містить дані щодо кожного з періодів процедури, а також аварду та договору (за наявності).
    properties:
      startDate:
        type: string
        format: date-time
        readOnly: true
        x-default: now
        x-legalNameUa: Дата та час початку
        x-legalNameEn: Start date
      endDate:
        type: string
        format: date-time
        readOnly: true
        x-legalNameUa: Дата та час завершення
        x-legalNameEn: End date
    required:
      - startDate
50
51
52
  base.LifeTime:
    type: object
    title: base.LifeTime
53
    x-baseClass: 'prozorro_sale.procedure.models.base.LifeTime'
54
    description: 'LifeTime model Містить дані щодо тривалості періоду (від - до). dateTill > dateFrom'
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
    properties:
      dateFrom:
        type: string
        format: date-time
        x-default: now
        x-legalNameUa: Період з
        x-legalNameEn: Date from
      dateTill:
        type: string
        format: date-time
        x-legalNameUa: Період по
        x-legalNameEn: Date till
    required:
      - dateFrom
      - dateTill
70
  base.Value:
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
71
    type: object
72
    title: base.Value
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
73
    description: |
74
75
      Value model
      Містить дані щодо вартості. За замовчуванням: валюта - гривня. Може використовуватися для реєстраційного і гарантійного внесків і т.д.
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
    properties:
      currency:
        type: string
        enum:
          - UAH
        x-legalNameUa: Валюта
        x-legalNameEn: Currency
      amount:
        type: number
        format: float
        x-format: decimal-float
        example: 10.0
        minimum: 0
        x-legalNameUa: Сума
        x-legalNameEn: Amount
    required:
      - currency
      - amount
94
  base.ValueWithTax:
95
96
    x-baseClass: 'prozorro_sale.procedure.models.base.Value'
    type: object
97
    title: base.ValueWithTax
98
99
100
101
    description: |
      Value model <br>
      Містить дані щодо вартості. За замовчуванням: валюта - гривня, ПДВ - включено. Може використовуватися для стартової ціни лота, кроку аукціону і т.д.
    allOf:
102
      - $ref: '#/components/schemas/base.Value'
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
      - type: object
        properties:
          amount:
            type: number
            format: float
            x-format: decimal-float
            example: 10.0
            minimum: 0
            exclusiveMinimum: true
            x-legalNameUa: Сума
            x-legalNameEn: Amount
          valueAddedTaxIncluded:
            type: boolean
            default: true
            x-legalNameUa: Податок
            x-legalNameEn: Tax
        required:
          - currency
          - amount
122
123
124
  base.DutchStep:
    x-baseClass: 'prozorro_sale.procedure.models.base.DutchStep'
    type: object
125
    description: |
Kateryna Zhluktenko's avatar
Kateryna Zhluktenko committed
126
      Поля dutchStepPercent та dutchStepValue автогенеруються на рівні ЦБД, без можливості внесення змін Організатором <br>
127
      Для поля dutchStepQuantity ЦБД формує дефолтне значення згідно процедури, Організатор має можливість змінити дефолтне значення.
128
129
130
131
132
133
134
135
136
137
    x-legalNameUa: Крок голландського раунду
    x-legalNameEn: Dutch steps
    title: base.DutchStep
    properties:
      dutchStepQuantity:
        type: integer
        format: int64
        minimum: 1
        x-legalNameUa: Кількість кроків
        x-legalNameEn: Dutch steps quantity
138
      dutchStepPercent:
139
140
141
142
143
144
        type: integer
        format: int64
        default: 1
        x-legalNameUa: Відсоток зниження, %
        x-legalNameEn: Percentage reduction, %
      dutchStepValue:
Vasyl Skab's avatar
Vasyl Skab committed
145
        description: автогеровано, розраховується як 1% від стартової ціни
146
147
148
        type: object
        readOnly: true
        allOf:
149
          - $ref: '#/components/schemas/base.Value'
150
151
152
153
154
155
156
157
158
159
          - type: object
            properties:
              amount:
                type: number
                format: float
                x-format: decimal-float
                example: 10.0
                minimum: 0
                x-legalNameUa: Сума
                x-legalNameEn: Amount
160
161
        x-legalNameUa: Розмір кроку голландського раунду, грн
        x-legalNameEn: Dutch step value
162
163
164
165
166
  base.DutchMinimalStep:
    x-baseClass: 'prozorro_sale.procedure.models.base.DutchMinimalStep'
    title: base.DutchMinimalStep
    type: object
    description: |
Vasyl Skab's avatar
Vasyl Skab committed
167
      Крок аукціону складає 1% від стартової ціни
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
    properties:
      currency:
        type: string
        enum:
          - UAH
        default: UAH
        readOnly: true
        x-legalNameUa: Валюта
        x-legalNameEn: Currency
      amount:
        type: number
        format: float
        readOnly: true
        x-format: decimal-float
        x-legalNameUa: Сума
        x-legalNameEn: Amount
      valueAddedTaxIncluded:
        type: boolean
        default: true
187
        deprecated: true
188
189
190
191
        x-legalNameUa: Податок
        x-legalNameEn: Tax included
    x-legalNameUa: Розмір кроку аукціону
    x-legalNameEn: Minimal step
192
193
194
195
196
197
198
  base.AddressIdentifier:
    type: object
    title: base.AddressIdentifier
    description: AddressIdentifier model
    x-baseClass: 'prozorro_sale.procedure.models.base.AddressIdentifier'
    properties:
      scheme:
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
199
        description: обирається зі словника https://procedure-sandbox.prozorro.sale/api/classifiers/koatuu
200
201
202
203
204
205
206
207
208
209
210
211
212
        type: string
        enum:
          - koatuu
        x-legalNameUa: Класифікатор об’єктів адміністративно-територіального устрою України
        x-legalNameEn: Type of objects of administrative-territorial organization of Ukraine
      name:
        readOnly: true
        allOf:
          - $ref: '#/components/schemas/base.MultiLang'
        x-legalNameUa: Назва адміністративно-територіальних об’єктів України
        x-legalNameEn: Name of objects of administrative-territorial organization of Ukraine
      id:
        type: string
213
214
        x-dictionaries:
          - koatuu
215
216
217
218
219
        x-legalNameUa: Код адміністративно-територіальних об’єктів України
        x-legalNameEn: ID of objects of administrative-territorial organization of Ukraine
    required:
      - scheme
      - id
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
220
221
222
223
  base.Address:
    type: object
    title: base.Address
    description: |
Kateryna Zhluktenko's avatar
Kateryna Zhluktenko committed
224
      Address model <br>
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
225
226
      Може містити дані щодо місцезнаходження організатора, учасника та лота.
    properties:
227
228
229
230
231
232
      addressID:
        type: object
        allOf:
          - $ref: '#/components/schemas/base.AddressIdentifier'
        x-legalNameUa: Код об’єктів адміністративно-територіального устрою України
        x-legalNameEn: ID of objects of administrative-territorial organization of Ukraine
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
233
      streetAddress:
234
235
        allOf:
          - $ref: '#/components/schemas/base.MultiLang'
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
236
        x-legalNameUa: Адреса
237
        x-legalNameEn: Address
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
238
      locality:
239
240
        allOf:
          - $ref: '#/components/schemas/base.MultiLang'
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
241
242
243
        x-legalNameUa: Населений пункт
        x-legalNameEn: City
      region:
244
245
        allOf:
          - $ref: '#/components/schemas/base.MultiLang'
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
246
247
248
249
250
251
252
253
254
255
        x-legalNameUa: Область
        x-legalNameEn: Region
      postalCode:
        type: string
        minLength: 5
        x-legalNameUa: Поштовий індекс
        x-legalNameEn: ZIP code
      countryName:
        allOf:
          - $ref: '#/components/schemas/base.MultiLang'
256
257
        x-legalNameUa: Країна
        x-legalNameEn: Country
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
258
259
    required:
      - countryName
Mike Hoang's avatar
Mike Hoang committed
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
  base.AddressUa:
    title: base.AddressUa
    allOf:
      - $ref: '#/components/schemas/base.Address'
      - type: object
        properties:
          region:
            allOf:
              - $ref: '#/components/schemas/base.MultiLang'
              - type: object
                properties:
                  uk_UA:
                    type: string
                    enum:
                      - Автономна Республіка Крим
                      - Вінницька область
                      - Волинська область
                      - Дніпропетровська область
                      - Донецька область
                      - Житомирська область
                      - Закарпатська область
                      - Запорізька область
                      - Івано-Франківська область
                      - Київська область
                      - Київ
                      - Кіровоградська область
                      - Луганська область
                      - Львівська область
                      - Миколаївська область
                      - Одеська область
                      - Полтавська область
                      - Рівненська область
                      - Севастополь
                      - Сумська область
                      - Тернопільська область
                      - Харківська область
                      - Херсонська область
                      - Хмельницька область
                      - Черкаська область
                      - Чернівецька область
                      - Чернігівська область
            x-legalNameUa: Область
            x-legalNameEn: Region
          countryName:
            allOf:
              - $ref: '#/components/schemas/base.MultiLang'
              - type: object
                properties:
                  uk_UA:
                    type: string
                    enum:
                      - Україна
        required:
          - region
          - countryName
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
315
316
317
318
  base.ContactPoint:
    type: object
    title: base.ContactPoint
    description: |
Kateryna Zhluktenko's avatar
Kateryna Zhluktenko committed
319
      ContactPoint model <br>
320
      Містить дані про контакту особу та може використовуватися для організатора, учасника і автора запитання в моделях SellingEntity та Organization
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
    properties:
      name:
        allOf:
          - $ref: '#/components/schemas/base.MultiLang'
        x-legalNameUa: ПІБ
        x-legalNameEn: Main contact name
      email:
        type: string
        format: email
        x-legalNameUa: Адреса електронної пошти
        x-legalNameEn: Main contact e-mail
      telephone:
        type: string
        pattern: '^[+][0-9]+$'
        x-legalNameUa: Номер телефону
        x-legalNameEn: Main contact tel
      faxNumber:
        type: string
        pattern: '^[+][0-9]+$'
        x-legalNameUa: Номер факсу
        x-legalNameEn: Main contact fax
      url:
        type: string
        format: uri
        example: 'http://string.com'
        x-legalNameUa: Веб адреса
347
        x-legalNameEn: Website
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
348
349
350
351
352
353
354
355
356
    required:
      - name
      - email
      - telephone
  base.Classification:
    x-baseClass: 'prozorro_sale.procedure.models.base.Classification'
    type: object
    title: base.Classification
    description: |
357
      Модель основного класифікатора, що є обов''язковою складовою моделі Item, значення обирається зі словника.<br>
Vasyl Skab's avatar
Vasyl Skab committed
358
      Посилання на ендпоінт з класифікаторами: https://procedure-sandbox.prozorro.sale/api/classifiers/CAV <br>
359
      В моделі Item може бути присутній лише один основний класифікатор.
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
360
361
362
    properties:
      scheme:
        type: string
363
364
        enum:
          - CAV
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
365
366
367
368
369
370
371
372
373
        x-legalNameUa: Схема класифікатора
        x-legalNameEn: Item classification scheme
      description:
        readOnly: true
        allOf:
          - $ref: '#/components/schemas/base.MultiLang'
        x-legalNameUa: Опис коду класифікатора
        x-legalNameEn: Classification description
      id:
374
        description: |
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
375
376
377
378
379
380
381
          Має бути валідація у вигляді переліку можливих значень для id класифікаторів в рамках кожної окремої процедури
        type: string
        x-legalNameUa: Код класифікатора
        x-legalNameEn: Classification ID
    required:
      - scheme
      - id
382
383
  base.AdditionalClassification:
    x-baseClass: 'prozorro_sale.procedure.models.base.AdditionalClassification'
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
384
    type: object
385
    title: base.AdditionalClassification
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
386
    description: |
387
388
389
      Модель додаткового класифікатора, що є не обов''язковою складовою моделі Item, значення обирається зі словника.<br>
      Посилання на ендпоінт з класифікаторами: https://procedure-sandbox.prozorro.sale/api/classifiers.<br>
      Містить додаткові можливі дані про лот. В моделі Item може бути необмежена кількість додаткових класифікаторів.
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
    properties:
      scheme:
        type: string
        x-legalNameUa: Схема додаткового класифікатору
        x-legalNameEn: Item additional classification scheme
      description:
        x-legalNameUa: Опис додаткового класифікатору
        x-legalNameEn: Item additional classification description
        readOnly: true
        allOf:
          - $ref: '#/components/schemas/base.MultiLang'
      id:
        type: string
        x-legalNameUa: Код додаткового класифікатору
        x-legalNameEn: Item additional classification ID
    required:
      - scheme
      - id
  base.Unit:
    x-baseClass: 'prozorro_sale.procedure.models.base.Unit'
    type: object
    title: base.Unit
    description: |
      Unit model
      Містить дані щодо одиницю виміру (код), значення якої має обиратися зі словника
    properties:
      code:
        description: |
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
418
419
          словник https://procedure-sandbox.prozorro.sale/api/classifiers/unitCode <br>
          Обов'язково вказувати, який саме код одиниці виміру необхідно використовувати в рамках кожної окремої процедури
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
420
421
422
423
424
425
426
427
428
429
        type: string
        readOnly: true
        x-legalNameUa: Код одиниці виміру
        x-legalNameEn: Unit code
      name:
        readOnly: true
        allOf:
          - $ref: '#/components/schemas/base.MultiLang'
        x-legalNameUa: Назва одиниці виміру
        x-legalNameEn: Item unit name
430
431
    required:
      - code
432
  base.Item:
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
433
    type: object
434
    title: base.Item
435
    x-baseClass: 'prozorro_sale.procedure.models.base.Item'
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
436
    description: |
Kateryna Zhluktenko's avatar
Kateryna Zhluktenko committed
437
      Item model <br>
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
      Описує склад лота.
    properties:
      id:
        type: string
        readOnly: true
        x-default: hex
        x-legalNameUa: Внутрішній ідентифікатор об'єкта
        x-legalNameEn: Item ID
      description:
        x-legalNameUa: Опис об'єкта
        x-legalNameEn: Item description
        allOf:
          - $ref: '#/components/schemas/base.MultiLang'
      classification:
        allOf:
          - $ref: '#/components/schemas/base.Classification'
        x-legalNameUa: Класифікатор об'єкта
        x-legalNameEn: Item classification
      unit:
        allOf:
          - $ref: '#/components/schemas/base.Unit'
        x-legalNameUa: Одиниці виміру об'єкта
        x-legalNameEn: Item unit
      quantity:
        type: number
        format: float
        minimum: 0
        x-strict: 4
        example: 11.1126
        x-legalNameUa: Кількість одиниць
        x-legalNameEn: Item quantity
      address:
        allOf:
          - $ref: '#/components/schemas/base.Address'
        x-legalNameUa: Місцезнаходження
473
        x-legalNameEn: Item address
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
474
475
476
477
478
479
480
481
482
483
484
485
486
487
    required:
      - description
      - classification
      - unit
      - quantity
  base.Identifier:
    x-baseClass: 'prozorro_sale.procedure.models.base.Identifier'
    type: object
    title: base.Identifier
    description: |
      Identifier model
      Містить дані щодо ідентифікації учасника аукціону
    properties:
      scheme:
488
        description: |
489
          Обирається одне значення зі словників: <br>
490
491
          https://procedure-sandbox.prozorro.sale/api/classifiers/identifiers <br>
          https://procedure-sandbox.prozorro.sale/api/classifiers/ua_identifiers
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
492
        type: string
493
494
495
        x-dictionaries:
          - identifiers
          - ua_identifiers
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
        x-legalNameUa: Ідентифікатори організації
        x-legalNameEn: ID type
      legalName:
        allOf:
          - $ref: '#/components/schemas/base.MultiLang'
        x-legalNameUa: Повна юридична назва організації
        x-legalNameEn: Legal name
      id:
        type: string
        x-legalNameUa: Код ЄДРПОУ або ІПН або паспорт
        x-legalNameEn: ID
    required:
      - scheme
      - legalName
      - id
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
  base.SellingEntityIdentifier:
    x-baseClass: 'prozorro_sale.procedure.models.base.SellingEntityIdentifier'
    type: object
    title: base.SellingEntityIdentifier
    description: |
      SellingEntityIdentifier model <br>
      Містить дані щодо індентифікації Організатора аукціону, що є юридичною особою, що створена та зареєстрована відповідно до законодавства України з місцезнаходженням на її території.
    allOf:
      - $ref: '#/components/schemas/base.Identifier'
      - type: object
        properties:
          scheme:
            description: |
              Обирається одне значення зі словника https://procedure-sandbox.prozorro.sale/api/classifiers/ua_identifiers
            type: string
            x-dictionaries:
              - ua_identifiers
            x-legalNameUa: Тип ідентифікації Організатора аукціону
            x-legalNameEn: Organizer ID type
530
  base.OrganizationWithoutContacts:
531
    x-baseClass: 'prozorro_sale.procedure.models.base.OrganizationWithoutContacts'
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
532
    type: object
533
    title: base.OrganizationWithoutContacts
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
534
    description: |
535
      Organization without contacts model <br>
536
      Містить дані про учасника аукціону (у тому числі ідентифікаційні дані та місцезнаходження)
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
537
538
    properties:
      name:
539
        description: |
540
          автогенерується з поля identifier.legalName
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
541
542
        allOf:
          - $ref: '#/components/schemas/base.MultiLang'
Vasyl Skab's avatar
Vasyl Skab committed
543
544
        x-legalNameUa: Повна юридична назва організації або ПІБ
        x-legalNameEn: Legal name or Full Name
545
        readOnly: true
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
546
547
548
      identifier:
        allOf:
          - $ref: '#/components/schemas/base.Identifier'
549
        x-legalNameUa: Ідентифікатори організації або особи
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
550
551
552
553
        x-legalNameEn: Identifier
      address:
        allOf:
          - $ref: '#/components/schemas/base.Address'
Olga Kochubynska's avatar
Olga Kochubynska committed
554
555
556
557
558
559
          - type: object
            required:
              - streetAddress
              - locality
              - region
              - countryName
560
        x-legalNameUa: Адреса
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
561
        x-legalNameEn: Address
562
      representativeInfo:
563
        description: Інформація про документ або дані, що підтверджують повноваження представника юридичної особи (наприклад довіреність)
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
564
565
566
567
        type: string
        example: "Довіреність  123 від 22.02.2012, дійсна до 30.03.2012/Наказ  142 від 14.12.2019/Статут ТОВ Кульбаба від 24.07.2002"
        x-legalNameUa: Інформація щодо підтвердження повноважень
        x-legalNameEn: Representative information
568
569
570
    required:
      - identifier
      - address
571
  base.Organization:
572
    x-baseClass: 'prozorro_sale.procedure.models.base.Organization'
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
    type: object
    title: base.Organization
    description: |
      Organization model <br>
      Містить дані про учасника аукціону (у тому числі ідентифікаційні дані, місцезнаходження та дані контактної особи учасника)
    allOf:
      - $ref: '#/components/schemas/base.OrganizationWithoutContacts'
      - type: object
        properties:
          contactPoint:
            allOf:
              - $ref: '#/components/schemas/base.ContactPoint'
            x-legalNameUa: Контактна особа
            x-legalNameEn: Main contact
        required:
          - identifier
          - address
          - contactPoint
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
  base.SellingEntity:
    x-baseClass: 'prozorro_sale.procedure.models.base.SellingEntity'
    type: object
    title: base.SellingEntity
    description: |
      SellingEntity model <br>
      Містить дані про організатора аукціону, який може бути виключно юридичною особою, що створена та зареєстрована відповідно до законодавства України з місцезнаходженням на її території.
    allOf:
      - $ref: '#/components/schemas/base.Organization'
      - type: object
        properties:
          identifier:
            allOf:
              - $ref: '#/components/schemas/base.SellingEntityIdentifier'
            x-legalNameUa: Ідентифікатор Організатора аукціону
            x-legalNameEn: Organizer ID
          address:
            description: |
              Модель адреси, що містить дані щодо місцезнаходження Організатора аукціону, <br>
              що є юридичною особою, що створена та зареєстрована відповідно до законодавства України<br>
              з місцезнаходженням на її території
            allOf:
              - $ref: '#/components/schemas/base.AddressUa'
              - type: object
                required:
                  - streetAddress
                  - locality
                  - region
                  - countryName
            x-legalNameUa: Місцезнаходження Організатора аукціону
            x-legalNameEn: Organizer address
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
622
623
624
625
626
  base.Document:
    x-baseClass: 'prozorro_sale.procedure.models.base.Document'
    type: object
    title: base.Document
    description: |
Kateryna Zhluktenko's avatar
Kateryna Zhluktenko committed
627
      Document model <br>
628
      Містить дані щодо структури документу та є складовою моделей процедури (Items, Bid, Award, Contract, Cancellation, Pocedure)<br><br>
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
    properties:
      id:
        type: string
        x-default: hex
        x-legalNameUa: Ідентифікатор документу
        x-legalNameEn: Document ID
        readOnly: true
      title:
        allOf:
          - $ref: '#/components/schemas/base.MultiLang'
        x-legalNameUa: Назва документу
        x-legalNameEn: Document title
      description:
        allOf:
          - $ref: '#/components/schemas/base.MultiLang'
        x-legalNameUa: Опис документу
        x-legalNameEn: Document description
      url:
        type: string
        x-format: ds-url
        x-legalNameUa: Посилання на документ
        x-legalNameEn: Document link
        readOnly: true
        example: 'http://string.com'
653
      relatedDocument:
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
654
655
656
        description: |
          Ідентифікатор, що відображається тільки в документі digitalSignature та використовується <br>
          для відображення зв'язку між цифровим підписом та документом сутності процедури.
657
658
659
660
        type: string
        example: 5e300ec4080b60d45dc28bb8
        x-legalNameUa: Пов'язаний документ
        x-legalNameEn: Related document
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
661
662
663
664
665
666
667
668
      documentOf:
        type: string
        enum:
          - auction
          - bid
          - award
          - contract
          - cancellation
669
          - prolongation
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
        x-legalNameUa: Об'єкт документу
        x-legalNameEn: Document object
      documentType:
        type: string
        x-legalNameUa: Тип документу
        x-legalNameEn: Document type
        readOnly: true
      datePublished:
        type: string
        format: date-time
        x-default: now
        x-legalNameUa: Дата публікації документу
        x-legalNameEn: Document publishing date
        readOnly: true
      dateModified:
        type: string
        format: date-time
        x-default: now
        x-legalNameUa: Остання дата редагування документу
        x-legalNameEn: Document modified date
        readOnly: true
      index:
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
692
693
694
695
696
697
        description: |
          Чим менше значення поля, тим вище документ буде при відображенні на майданчиках. <br>
          Основним документом вважається документ з мінімальним значенням індексу. <br>
          Якщо параметр не зазначений, документи будуть виводитись останніми у переліку. <br>
          Якщо кілька документів мають однакове значення параметру, порядок сортування буде залежати від dateModified, <br>
          Пріоритет у документів доданих раніше.
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
        type: integer
        format: int64
        x-legalNameUa: Параметр сортування ілюстрацій
        x-legalNameEn: Document index
      format:
        type: string
        x-legalNameUa: Формат документу
        x-legalNameEn: Document format
        readOnly: true
      language:
        type: string
        x-legalNameUa: Мова документу
        x-legalNameEn: Document language
      hash:
        type: string
        x-legalNameUa: Хеш документу
        x-legalNameEn: Document hash
      _Document__addedInQualificationState:
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
716
        description: Індикатор, який  вказує, чи був документ доданий у статусі qualification
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
717
718
719
720
        type: boolean
      token:
        type: string
      _ds_id:
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
721
        description: Ідентифікатор документа в document service
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
722
723
724
        type: string
        readOnly: true
      _ds_scope:
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
725
        description: Тип документа за доступом [public/private]
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
726
727
728
729
730
        type: string
        readOnly: true
    required:
      - title
      - documentOf
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
  base.CancellationDocument:
    x-baseClass: 'prozorro_sale.procedure.models.base.CancellationDocument'
    type: object
    title: base.CancellationDocument
    allOf:
      - $ref: '#/components/schemas/base.Document'
      - type: object
        properties:
          documentType:
            type: string
            enum:
              - cancellationDetails
              - digitalSignature
          documentOf:
            type: string
            readOnly: true
            enum:
              - cancellation
        x-legalNameUa: Документи та додатки пов’язані зі скасуванням
        x-legalNameEn: Cancellation documents
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
751
752
753
754
755
  base.Question:
    x-baseClass: 'prozorro_sale.procedure.models.base.Question'
    type: object
    title: base.Question
    description: |
Kateryna Zhluktenko's avatar
Kateryna Zhluktenko committed
756
      Question model <br>
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
      Описує сервіс обговорення аукціону (запитання-відповідь)
    properties:
      owner:
        type: string
        readOnly: true
        x-legalNameUa: Ідентифікатор майданчика
        x-legalNameEn: Broker ID
      ownerToken:
        type: string
        format: uuid
        readOnly: true
        x-default: hex
      id:
        type: string
        readOnly: true
        x-default: hex
        x-legalNameUa: Ідентифікатор запитання
        x-legalNameEn: Question ID
      author:
        allOf:
777
          - $ref: '#/components/schemas/base.ContactPoint'
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
778
779
780
781
782
783
784
785
        x-legalNameUa: Автор запитання
        x-legalNameEn: Question author
      title:
        allOf:
          - $ref: '#/components/schemas/base.MultiLang'
        x-legalNameUa: Назва запитання
        x-legalNameEn: Question title
      description:
786
787
        allOf:
          - $ref: '#/components/schemas/base.MultiLang'
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
788
789
        x-legalNameUa: Текст запитання
        x-legalNameEn: Question description
790
      datePublished:
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
        type: string
        format: date-time
        readOnly: true
        x-default: now
        x-legalNameUa: Дата публікації запитання
        x-legalNameEn: Question date
      dateModified:
        type: string
        format: date-time
        readOnly: true
        x-default: now
        x-legalNameUa: Дата редагування запитання
        x-legalNameEn: Question modification date
      dateAnswered:
        type: string
        format: date-time
        readOnly: true
        x-legalNameUa: Дата відповіді на запитання
        x-legalNameEn: Answer date
      answer:
811
812
        allOf:
          - $ref: '#/components/schemas/base.MultiLang'
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
813
814
        x-legalNameUa: Відповідь на запитання
        x-legalNameEn: Answer
815
816
817
818
819
820
821
      can_update_until:
        type: string
        format: date-time
        description: |
          Верхня межа часу, до якого включно допускається оновлювати створене запитання.  <br>
          Автогенерується враховуючи дату публікації запитання + 2 години
        readOnly: true
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
822
823
824
825
826
827
828
    required:
      - author
      - title
  base.Bid:
    type: object
    title: base.Bid
    description: |
Kateryna Zhluktenko's avatar
Kateryna Zhluktenko committed
829
      Bid model <br>
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
830
      Містить дані заяви на участь, її автора (учасника) та цінову пропозицію
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
    x-baseClass: 'prozorro_sale.procedure.models.base.Bid'
    properties:
      owner:
        type: string
        readOnly: true
        x-legalNameUa: Ідентифікатор майданчика
        x-legalNameEn: Broker ID
      ownerToken:
        type: string
        format: uuid
        readOnly: true
        x-default: hex
      id:
        type: string
        readOnly: true
        x-default: hex
        x-legalNameUa: Ідентифікатор заяви на участь
        x-legalNameEn: Bid ID
849
      bidders:
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
850
        type: array
851
852
        minItems: 1
        maxItems: 1
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
853
854
855
856
        items:
          $ref: '#/components/schemas/base.Organization'
        x-legalNameUa: Інформація про учасника
        x-legalNameEn: Bidder
857
      datePublished:
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
858
859
860
861
862
863
        type: string
        format: date-time
        readOnly: true
        x-default: now
        x-legalNameUa: Дата заяви на участь
        x-legalNameEn: Bid date
Vitalii Fisenko's avatar
Vitalii Fisenko committed
864
865
866
867
868
869
870
      dateModified:
        type: string
        format: date-time
        readOnly: true
        x-default: now
        x-legalNameUa: Остання дата редагування ставки
        x-legalNameEn: Bid modified date
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
871
      status:
872
        description: необхідно вказувати можливі значення в залежності від процедури, наприклад, draft, active, deleted
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
873
874
875
876
877
        type: string
        x-legalNameUa: Статус заяви на участь
        x-legalNameEn: Bid status
      value:
        allOf:
878
          - $ref: '#/components/schemas/base.Value'
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
879
880
881
882
883
884
885
886
887
888
889
890
        x-legalNameUa: Цінова пропозиція
        x-legalNameEn: Bid price amount
      documents:
        description: |
          поле має містити перелік типів документів, які вимагаються нормативною документацією для кожної окремої процедури
        type: array
        x-format: list-object
        default: []
        items:
          type: object
          allOf:
            - $ref: '#/components/schemas/base.Document'
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
891
892
893
894
895
896
            - type: object
              properties:
                documentOf:
                  type: string
                  enum:
                    - bid
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
897
898
899
        x-legalNameUa: Документи до заяви про участь
        x-legalNameEn: Documents
      participationUrl:
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
900
901
        description: Веб-адреса, яка доступна тільки для учасника, що подав заяву на участь в аукціоні. <br>
          Час генерації посилання відповідає моменту набуття процедурою статусу active.auction
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
902
        type: string
903
        x-format: rel-auth-url
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
904
        readOnly: true
905
        example: /api/auth/auction?token=token
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
906
907
908
        x-legalNameUa: Веб-адреса для участі в аукціоні
        x-legalNameEn: Bidder participation link
    required:
909
      - bidders
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
910
      - value
911
  base.VerificationDocumentInfo:
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
912
    type: object
913
    title: base.VerificationDocumentInfo
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
914
    description: |
Kateryna Zhluktenko's avatar
Kateryna Zhluktenko committed
915
      VerificationDocumentInfo model <br>
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
        Може містити дані про документ, наприклад ліцензія, який може використовуватися в моделях Організатора або Учасника
    properties:
      description:
        allOf:
          - $ref: '#/components/schemas/base.MultiLang'
        x-legalNameUa: Опис документа
        x-legalNameEn: Documents description
      id:
        type: string
        minLength: 3
        x-legalNameUa: Номер документа
        x-legalNameEn: Business verification documents ID
      date:
        type: string
        format: date-time
        x-legalNameUa: Дата видачі документа
        x-legalNameEn: Business verification documents date
  base.AccountIdentification:
    x-baseClass: 'prozorro_sale.procedure.models.base.AccountIdentification'
    type: object
    title: base.AccountIdentification
    description: |
Kateryna Zhluktenko's avatar
Kateryna Zhluktenko committed
938
      АccountIdentification model <br>
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
939
940
941
      Містить дані щодо можливих, до заповнення, банківських ідентифікаторів, є обов'язковою складовою моделі BankAccount
    properties:
      description:
942
        readOnly: true
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
943
944
945
946
947
948
        allOf:
          - $ref: '#/components/schemas/base.MultiLang'
        x-legalNameUa: Опис до банківських реквізитів
        x-legalNameEn: Account identification description
      scheme:
        description: |
949
          Обирається одне значення зі словника https://procedure-sandbox.prozorro.sale/api/dictionaries/accountIdentifiers
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
950
        type: string
951
952
        x-dictionaries:
          - accountIdentifiers
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
953
954
        x-legalNameUa: Тип банківського ідентифікатора
        x-legalNameEn: Account identification type
955
956
957
958
959
960
961
      id:
        type: string
        x-legalNameUa: Ідентифікатор
        x-legalNameEn: Account identification ID
    required:
      - id
      - scheme
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
962
  base.BankAccount:
963
    x-baseClass: 'prozorro_sale.procedure.models.base.BankAccount'
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
964
965
966
    type: object
    title: base.BankAccount
    description: |
Kateryna Zhluktenko's avatar
Kateryna Zhluktenko committed
967
968
      BankAccount model <br>
      Містить дані про банківські реквизити <br>
969
      За умови заповнення будь-якого з полів в bankAccount обов'язкове до заповнення як мінімум 1 схема з accountIdentifications
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
    properties:
      id:
        type: string
        readOnly: true
        x-default: hex
        x-legalNameUa: Ідентифікатор банківського рахунку
        x-legalNameEn: Bank account ID
      bankName:
        allOf:
          - $ref: '#/components/schemas/base.MultiLang'
        x-legalNameUa: Назва банку
        x-legalNameEn: Bank name
      description:
        allOf:
          - $ref: '#/components/schemas/base.MultiLang'
        x-legalNameUa: Опис
        x-legalNameEn: Bank account description
987
      accountIdentifications:
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
988
989
        type: array
        default: []
990
        minItems: 1
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
991
992
993
        items:
          $ref: '#/components/schemas/base.AccountIdentification'
        x-legalNameUa: Банківські реквізити
994
        x-legalNameEn: Account identifications
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
995
    required:
996
      - accountIdentifications
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
  base.BankAccountWithCurrency:
    title: base.BankAccountWithCurrency
    description: |
      BankAccount model with currency <br>
      Містить дані про банківські реквизити з вказуванням валюти
    allOf:
      - $ref: '#/components/schemas/base.BankAccount'
      - type: object
        properties:
          currency:
            type: string
            enum:
              - UAH
              - USD
              - EUR
            x-legalNameUa: Валюта
            x-legalNameEn: Currency
1014
1015
1016
        required:
          - accountIdentifications
          - currency
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
1017
1018
1019
1020
1021
  base.Award:
    x-baseClass: 'prozorro_sale.procedure.models.base.Award'
    type: object
    title: base.Award
    description: |
1022
1023
1024
      Award model <br>
      Містить дані щодо об'єкта, що формується за результатами аукціону в межах якого відбувається кваліфікація кожного окремого учасника <br>
      LegalNames значень у полі status мають бути додані в документ з лигнеймами для процедури.?????
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
    properties:
      id:
        type: string
        x-legalNameUa: Ідентифікатор кваліфікації учасника аукціону
        x-legalNameEn: Award ID
        x-default: hex
        readOnly: true
      bidId:
        type: string
        x-legalNameUa: Ідентифікатор заяви на участь учасника аукціону
        x-legalNameEn: Award bid ID
        readOnly: true
      title:
        x-legalNameUa: Назва рішення щодо кваліфікації учасника аукціону
        x-legalNameEn: Award title
        allOf:
          - $ref: '#/components/schemas/base.MultiLang'
      description:
        x-legalNameUa: Опис рішення щодо кваліфікації учасника аукціону
        x-legalNameEn: Award description
        allOf:
          - $ref: '#/components/schemas/base.MultiLang'
      status:
        type: string
        x-legalNameUa: Статус кваліфікації учасника аукціону
        x-legalNameEn: Award status
1051
1052
1053
1054
      terminationReason:
        type: string
        x-legalNameUa: Причина дискваліфікації/відмови учаснику
        x-legalNameEn: Disqualification reason
1055
      datePublished:
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
1056
1057
1058
1059
1060
1061
1062
1063
        type: string
        format: date-time
        x-legalNameUa: Дата початку кваліфікації учасника аукціону
        x-legalNameEn: Award date
        x-default: now
        readOnly: true
      value:
        allOf:
1064
          - $ref: '#/components/schemas/base.Value'
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
1065
1066
        x-legalNameUa: Цінова пропозиція
        x-legalNameEn: Award price
1067
        readOnly: true
1068
      buyers:
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
1069
1070
1071
1072
1073
        type: array
        default: []
        items:
          $ref: '#/components/schemas/base.Organization'
        x-legalNameUa: Інформація про учасника
1074
        x-legalNameEn: Successful bidders
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
1075
1076
1077
1078
1079
      items:
        type: array
        x-format: list-object
        default: []
        items:
1080
          $ref: '#/components/schemas/base.Item'
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
        x-legalNameUa: Склад лоту
        x-legalNameEn: Award item
      documents:
        type: array
        x-format: list-object
        default: []
        items:
          type: object
          allOf:
            - $ref: '#/components/schemas/base.Document'
            - type: object
              properties:
                documentType:
                  type: string
                  enum:
                    - auctionProtocol
                    - rejectionProtocol
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
1098
1099
                    - act
                    - digitalSignature
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
                documentOf:
                  type: string
                  readOnly: true
                  enum:
                    - award
        x-legalNameUa: Документи до аварду
        x-legalNameEn: Award Documents
      dateModified:
        type: string
        format: date-time
        x-legalNameUa: Дата редагування
        x-legalNameEn: Award modification date
        x-default: now
        readOnly: true
    required:
      - bidId
      - value
1117
  base.InfiniteContract:
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
1118
1119
    x-baseClass: 'prozorro_sale.procedure.models.base.Contract'
    type: object
1120
    title: base.InfiniteContract
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
1121
1122
1123
    description: |
      Contract model<br>
      Містить дані щодо договору, який формується, підписується та публікується в рамках процедури.
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
    properties:
      id:
        type: string
        readOnly: true
        x-default: hex
        x-legalNameUa: Внутрішній ідентифікатор контракту
        x-legalNameEn: Contract ID
      awardId:
        type: string
        readOnly: true
        x-legalNameUa: Ідентифікатор переможця
        x-legalNameEn: Award ID
      contractNumber:
        type: string
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
1138
        minLength: 1
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
        x-legalNameUa: Номер договору
        x-legalNameEn: Contract's number
      title:
        allOf:
          - $ref: '#/components/schemas/base.MultiLang'
        x-legalNameUa: Назва договору
        x-legalNameEn: Contract's title
      description:
        allOf:
          - $ref: '#/components/schemas/base.MultiLang'
        x-legalNameUa: Опис договору
        x-legalNameEn: Contract's description
      value:
        allOf:
1153
          - $ref: '#/components/schemas/base.ValueWithTax'
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
1154
1155
1156
        readOnly: true
        x-legalNameUa: Вартість договору
        x-legalNameEn: Contract's price
1157
      contractTotalValue:
1158
        description: Дані зазначаються Організатором, вказується заключна вартість договору в грн. (UAH)
1159
        allOf:
1160
          - $ref: '#/components/schemas/base.ValueWithTax'
1161
1162
        x-legalNameUa: Заключна вартість договору
        x-legalNameEn: Total contract's value
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
1163
1164
1165
1166
1167
      items:
        type: array
        x-format: list-object
        default: []
        items:
1168
          $ref: '#/components/schemas/base.Item'
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
1169
1170
        x-legalNameUa: Склад лоту
        x-legalNameEn: Contract's item
1171
      buyers:
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
1172
1173
1174
1175
1176
1177
        type: array
        default: []
        items:
          $ref: '#/components/schemas/base.Organization'
        readOnly: true
        x-legalNameUa: Переможець
1178
        x-legalNameEn: Contract's winners
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
      status:
        description: |
          вказувати перелік статусів (enum)
        type: string
        readOnly: true
        x-legalNameUa: Статус договору
        x-legalNameEn: Contract's status
      dateSigned:
        type: string
        format: date-time
        x-legalNameUa: Дата підписання договору
        x-legalNameEn: Signing date
1191
      datePublished:
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
1192
1193
1194
1195
        type: string
        format: date-time
        readOnly: true
        x-default: now
1196
        x-legalNameUa: Дата створення об'єкта договіру
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
        x-legalNameEn: Contract's creation date
      dateModified:
        type: string
        format: date-time
        readOnly: true
        x-default: now
        x-legalNameUa: Остання дата редагування договіру
        x-legalNameEn: Contract's modified date
      documents:
        type: array
        x-format: list-object
        default: []
        items:
          type: object
          allOf:
            - $ref: '#/components/schemas/base.Document'
            - type: object
              properties:
                documentType:
                  type: string
                  enum:
                    - contractNotice
                    - contractSigned
                    - contractAnnexe
        x-legalNameUa: Документи та додатки пов’язані з договором
        x-legalNameEn: Contract's documents
    required:
      - awardId
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
  base.Contract:
    type: object
    title: base.Contract
    allOf:
      - $ref: '#/components/schemas/base.InfiniteContract'
      - type: object
        properties:
          contractTime:
            type: object
            allOf:
              - $ref: '#/components/schemas/base.LifeTime'
            x-legalNameUa: Строк дії договору
            x-legalNameEn: Contract's terms
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
1238
1239
1240
1241
1242
  base.Cancellation:
    x-baseClass: 'prozorro_sale.procedure.models.base.Cancellation'
    type: object
    title: base.Cancellation
    description: |
Kateryna Zhluktenko's avatar
Kateryna Zhluktenko committed
1243
      Cancellation model <br>
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
1244
1245
1246
1247
1248
      Містить дані щодо скасування аукціону
    properties:
      id:
        type: string
        readOnly: true
Kateryna Zhluktenko's avatar
Kateryna Zhluktenko committed
1249
        x-legalNameUa: Ідентифікатор об'єкта скасування
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
        x-legalNameEn: Aucton cancellation ID
        x-default: hex
      reason:
        x-legalNameUa: Причина скасування Аукціону
        x-legalNameEn: Cancellation reason
        allOf:
          - $ref: '#/components/schemas/base.MultiLang'
      documents:
        type: array
        x-format: list-object
        default: []
        items:
          type: object
          allOf:
1264
            - $ref: '#/components/schemas/base.CancellationDocument'
1265
      datePublished:
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
1266
1267
1268
1269
1270
        type: string
        format: date-time
        x-legalNameUa: Дата скасування
        x-legalNameEn: Cancellation date
    required:
1271
      - datePublished
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
1272
1273
1274
1275
1276
      - reason
      - documents
  base.Discount:
    type: object
    title: base.Discount
1277
    x-baseClass: 'prozorro_sale.procedure.models.base.Discount'
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
1278
    description: |
Kateryna Zhluktenko's avatar
Kateryna Zhluktenko committed
1279
      Discount model <br>
1280
      Містить дані щодо знижки, обов'язковість або необов'язковість,  у випадку повторного виставлення лота, визначається на рівні кожної окремої процедури. <br>
1281
      Якщо значення Discount true, обов'язкові до заповнення discountPercent та previousAuctionValue
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
1282
    properties:
1283
      previousAuctionValue:
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
1284
1285
        type: object
        allOf:
1286
          - $ref: '#/components/schemas/base.ValueWithTax'
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
1287
1288
        x-legalNameUa: Стартова вартість попереднього аукціону
        x-legalNameEn: Priveous auction amount
1289
      discountPercent:
1290
        x-format: decimal-float
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
1291
1292
1293
1294
1295
        type: number
        format: float
        example: 10.5
        x-legalNameUa: Розмір знижки від попереднього аукціону, %
        x-legalNameEn: Amount of discount, %
1296
1297
1298
1299
      discount: # если true то обязательные % и сумма
        type: boolean
        x-legalNameUa: Знижка
        x-legalNameEn: Discount
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
1300
1301
1302
1303
1304
1305
1306
1307
1308
    required:
      - discount
  base.Location:
    type: object
    title: base.Location
    description: ' Location model '
    properties:
      latitude:
        type: string
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
1309
1310
        x-legalNameUa: Широта
        x-legalNameEn: Latitude
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
1311
1312
      longitude:
        type: string
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
1313
1314
        x-legalNameUa: Довгота
        x-legalNameEn: Longitude
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
1315
1316
      elevation:
        type: string
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
1317
1318
        x-legalNameUa: Висота
        x-legalNameEn: Elevation
Dmytro Halinovskyi's avatar
Dmytro Halinovskyi committed
1319
1320
1321
    required:
      - latitude
      - longitude
1322
1323
1324
1325
1326
1327
  base.CommonClientBid:
    title: base.CommonClientBid
    description: 'Bid model for swagger api client'
    allOf:
      - $ref: '#/components/schemas/base.Bid'
      - type: object
1328
1329
1330
1331
1332
        properties:
          initialValueAmount:
            readOnly: true
            type: number
            format: float
1333
          bidderPriorityPresence:
1334
1335
            readOnly: true
            type: boolean
1336
        required:
1337
          - bidders
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
  base.RegistrationDetails:
    type: object
    title: base.RegistrationDetails
    properties:
      registrationStatus:
        type: string
        description: |
          Обирається одне значення зі словника https://procedure-sandbox.prozorro.sale/api/dictionaries/registrationStatus
        x-dictionaries:
          - registrationStatus
        x-legalNameUa: Cтатус реєстрації
        x-legalNameEn: Registration status
      registrationID:
        type: string
        x-legalNameUa: Номер запису
        x-legalNameEn: Registration ID
      registrationDate:
        type: string
        format: date-time
        x-legalNameUa: Дата реєстрації
        x-legalNameEn: Registration date
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
  base.LandProps:
    type: object
    title: base.LandProps
    x-baseClass: 'prozorro_sale.procedure.models.base.BaseItemProps'
    description: |
      Model with specific properties for land <br>
      Специфічні поля для типу об'єкта Земельна ділянка
    properties:
      itemPropsType:
        type: string
        readOnly: true
        default: land
      landArea:
        type: number
        format: float
        example: 1285.0
        minimum: 0
        x-legalNameUa: Площа ділянки, га
        x-legalNameEn: Land area, ha
      cadastralNumber:
        type: string
        x-legalNameUa: Кадастровий номер
        x-legalNameEn: Cadastral number
      ownershipType:
        type: string
        x-dictionaries:
          - ownershipType
        description: Обирається одне значення зі словника https://procedure-sandbox.prozorro.sale/api/dictionaries/ownershipType
        x-legalNameUa: Тип власності
        x-legalNameEn: Ownership type
      encumbrances:
        type: string
        x-dictionaries:
          - encumbrances
        description: Обирається одне значення зі словника https://procedure-sandbox.prozorro.sale/api/dictionaries/encumbrances
        x-legalNameUa: Наявність обтяжень
        x-legalNameEn: Encumbrances
      jointOwnership:
        type: string
        x-legalNameUa: Наявність співвласників
        x-legalNameEn: Joint owner ship
      utilitiesAvailability:
        type: string
        x-legalNameUa: Наявність інженерних мереж
        x-legalNameEn: Utilities availability
1404
1405
1406
1407
1408
1409
1410
1411
  base.RealEstateProps:
    type: object
    title: base.RealEstateProps
    x-baseClass: 'prozorro_sale.procedure.models.base.RealEstateProps'
    description: |
      Model with specific properties for real estate <br>
      Специфічні поля для типу об'єкта Нерухоме майно
    properties:
1412
1413
1414
1415
      itemPropsType:
        type: string
        readOnly: true
        default: realEstate
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
      totalBuildingArea:
        type: number
        format: float
        example: 1285.0
        minimum: 0
        x-legalNameUa: Загальна площа будівлі, кв.м.
        x-legalNameEn: The total area of the building, sq.m.
      totalObjectArea:
        type: number
        format: float
        example: 1285.0
        minimum: 0
        x-legalNameUa: Загальна площа об''єкта в будівлі, кв.м.
        x-legalNameEn: The total object area of the building, sq.m.
      usableArea:
        type: number
        format: float
        example: 1285.0
        minimum: 0
        x-legalNameUa: Корисна площа об''єкта в будівлі, кв.м.
        x-legalNameEn: The usable object area of the building, sq.m.
      constructionYear:
        type: integer
        format: int64
        example: 1983
        x-legalNameUa: Рік будівництва
        x-legalNameEn: Construction year
      constructionTechnology:
        type: string
        x-dictionaries:
          - constructionTechnology
        description: |
          Обирається одне значення зі словника https://procedure-sandbox.prozorro.sale/api/dictionaries/constructionTechnology
        x-legalNameUa: Технологія будівництва
        x-legalNameEn: Construction technology
      livingArea:
        type: number
        format: float
        example: 1285.0
        minimum: 0
        x-legalNameUa: Житлова площа, кв. м
        x-legalNameEn: Living area, sq.m.
      kitchenArea:
        type: number
        format: float
        example: 1285.0
        minimum: 0
        x-legalNameUa: Площа кухні, кв. м
        x-legalNameEn: Kitchen area, sq.m.
      landArea:
        type: number
        format: float
        example: 1285.0
        minimum: 0
        x-legalNameUa: Площа ділянки, кв. м
        x-legalNameEn: Land area, sq.m.
      locationInBuilding:
        type: string
        x-dictionaries:
          - floorType
        description: |
          Обирається одне значення зі словника https://procedure-sandbox.prozorro.sale/api/dictionaries/floorType
        x-legalNameUa: Місце розташування об’єкта в будівлі
        x-legalNameEn: Location of the object in the building
      floors:
        type: string
        x-legalNameUa: Номер поверху або поверхів
        x-legalNameEn: Floor(s) number
        example: 2-3, 7
      generalCondition:
        type: string
        x-legalNameUa: Технічний стан об'єкта
        x-legalNameEn: Technical condition of the object
      serviceElectricity:
        type: boolean
        x-legalNameUa: Чи приєднаний об'єкт до електромережі
        x-legalNameEn: Connection to the electrical network
      powerSupplyCapacity:
        type: number
        format: float
        example: 42.0
        minimum: 0
        x-legalNameUa: Потужність електромережі, кВт
        x-legalNameEn: Power supply, kW
      powerSupplyClass:
        type: string
        x-dictionaries:
          - powerSupplyClass
        description: |
          Обирається одне значення зі словника https://procedure-sandbox.prozorro.sale/api/dictionaries/powerSupplyClass
        x-legalNameUa: Ступінь потужності електромережі
        x-legalNameEn: Power supply class
      serviceWater:
        type: boolean
        x-legalNameUa: Водозабезпечення присутнє
        x-legalNameEn: Water supply is present
      serviceSewerage:
        type: boolean
        x-legalNameUa: Каналізація присутня
        x-legalNameEn: Sewerage is present
      serviceGas:
        type: boolean
        x-legalNameUa: Газифікація присутня
        x-legalNameEn: Gasification is present
      serviceCentralHeating:
        type: boolean
        x-legalNameUa: Централізоване опалення присутнє
        x-legalNameEn: Centralized heating is present
      serviceAutonomousHeating:
        type: boolean
        x-legalNameUa: Автономне опалення присутнє
        x-legalNameEn: Autonomous heating is present
      serviceHeatingCounter:
        type: boolean
        x-legalNameUa: Лічильник опалення присутній
        x-legalNameEn: Heating meter is present
      serviceVentilation:
        type: boolean
        x-legalNameUa: Вентиляція присутня
        x-legalNameEn: Ventilation is present
      serviceAirConditioning:
        type: boolean
        x-legalNameUa: Кондиціонування присутнє
        x-legalNameEn: Air conditioning is present
      servicePhone:
        type: boolean
        x-legalNameUa: Телефонізація присутня
        x-legalNameEn: Telephony is present
      serviceTV:
        type: boolean
        x-legalNameUa: Телебачення присутнє
        x-legalNameEn: Television is present
      serviceInternet:
        type: boolean
        x-legalNameUa: Інтернет присутній
        x-legalNameEn: Internet is present
      serviceElevator:
        type: boolean
        x-legalNameUa: Ліфт присутній
        x-legalNameEn: Elevator is present
      serviceSecurityAlarm:
        type: boolean
        x-legalNameUa: Охоронна сигналізація присутня
        x-legalNameEn: Security alarm is present
      serviceFireAlarm:
        type: boolean
        x-legalNameUa: Пожежна сигналізація присутня
        x-legalNameEn: Fire alarm is present
      servicesDescription:
        type: string
        x-legalNameUa: Додаткова інформація щодо комунікацій, що є в об''єкті
        x-legalNameEn: Additional information regarding communications available in the facility
        example: Водопостачання - Центральне, Свердловина; Газопостачання - Наявне; Опалення - Центральне, Автономне газове, Автономне електричне; Каналізація - Центральна, Септик
      servicesAccounting:
        type: string
        x-legalNameUa: Інформація про наявність окремих особових рахунків на об'єкт, відкритих постачальниками комунальних послуг
        x-legalNameEn: Information on the availability of separate personal accounts for the object, opened by utility providers
      landTax:
        type: string
        x-legalNameUa: Інформація щодо компенсації сплати земельного податку за користування земельною ділянкою, на якій розташований об'єкт
        x-legalNameEn: Information on compensation for the payment of land tax for the use of the land plot on which the object is located
1577
1578
    required: 
      - totalObjectArea     
1579
1580
1581
1582
1583
1584
1585
1586
  base.JointPropertyComplexProps:
    type: object
    title: base.JointPropertyComplexProps
    x-baseClass: 'prozorro_sale.procedure.models.base.BaseItemProps'
    description: |
      Model with specific properties for Joint Property Complex <br>
      Специфічні поля для типу об'єкта ЄМК
    properties:
1587
1588
1589
1590
      itemPropsType:
        type: string
        readOnly: true
        default: jointPropertyComplex
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
      quantityAndNomenclature:
        type: string
        x-legalNameUa: Обсяг та основна номенклатура продукції (робіт, послуг), у тому числі експортної
        x-legalNameEn: Quantity and basic nomenclature of products (works, services), including export
      workplacesQuantity:
        type: integer
        format: int64
        example: 500
        x-legalNameUa: Кількість робочих місць, ociб
        x-legalNameEn: Workplaces quantity, persons
      buildingsInformation:
        type: string
        x-legalNameUa: Відомості про будівлі (споруди, приміщення) єдиного майнового комплексу в обсязі, передбаченому для інформації про нерухоме майно
        x-legalNameEn: Information about buildings (structures, premises) of a single property complex
        example: Будівлі А, Б, В, Г, Д, склад Д, розбірна конструкція Є, ТП 4305, прохідна, мощення
      landPlotInformation:
        type: string
        x-legalNameUa: Відомості про земельну ділянку, на якій розташовано єдиний майновий комплекс
        x-legalNameEn: Information about the land plot on which the property complex is located
        example: Площа ділянки, кадастровий номер - '8000000000:72:233:0018' або обліковий номер
1611
1612
1613
      landProps:
        allOf:
          - $ref: '#/components/schemas/base.LandProps'
1614
1615
1616
1617
1618
1619
          - type: object
            properties:
              landIntendedUse: