Tutorial (registration)
This tutorial describes how to work with regular contracting in tender system.
Contract will be created in the tender system after award activation.
Setting contract value
Let’s see the created contract with next request:
Request
GET /api/2.5/tenders/9edb2de5d15247d485a377e07702bc83/contracts/e07c2e4ee19e43c5bce75b127566b232 HTTP/1.0
Authorization: Bearer broker
Host: public-api-sandbox.prozorro.gov.ua
Response
HTTP/1.0 200 OK
Content-Type: application/json
{
"data": {
"suppliers": [
{
"name": "Державне управління справами",
"identifier": {
"scheme": "UA-EDR",
"id": "00037256",
"legalName": "Державне управління справами",
"uri": "http://www.dus.gov.ua/"
},
"address": {
"streetAddress": "вул. Банкова, 11, корпус 1",
"locality": "м. Київ",
"region": "м. Київ",
"postalCode": "01220",
"countryName": "Україна"
},
"contactPoint": {
"name": "Державне управління справами",
"telephone": "+0440000000"
},
"scale": "micro"
}
],
"items": [
{
"id": "b5ff13b59b7e4f2495ec32bda0e78958",
"description": "футляри до державних нагород",
"unit": {
"name": "кг",
"value": {
"amount": 6.0,
"currency": "UAH",
"valueAddedTaxIncluded": true
},
"code": "KGM"
},
"quantity": 5.0,
"classification": {
"description": "Cartons",
"scheme": "ДК021",
"id": "44617100-9"
},
"additionalClassifications": [
{
"scheme": "ДКПП",
"id": "17.21.1",
"description": "папір і картон гофровані, паперова й картонна тара"
}
],
"deliveryDate": {
"startDate": "2023-01-03T00:00:00+02:00",
"endDate": "2023-01-06T00:00:00+02:00"
},
"deliveryAddress": {
"streetAddress": "вул. Банкова 1",
"locality": "м. Київ",
"region": "м. Київ",
"postalCode": "79000",
"countryName": "Україна"
}
},
{
"id": "64da1c2d32904c7780c7a080c03b9058",
"description": "футляри до державних нагород",
"unit": {
"name": "кг",
"value": {
"amount": 6.0,
"currency": "UAH",
"valueAddedTaxIncluded": true
},
"code": "KGM"
},
"quantity": 5.0,
"classification": {
"description": "Cartons",
"scheme": "ДК021",
"id": "44617100-9"
},
"additionalClassifications": [
{
"scheme": "ДКПП",
"id": "17.21.1",
"description": "папір і картон гофровані, паперова й картонна тара"
}
],
"deliveryDate": {
"startDate": "2023-01-03T00:00:00+02:00",
"endDate": "2023-01-06T00:00:00+02:00"
},
"deliveryAddress": {
"streetAddress": "вул. Банкова 1",
"locality": "м. Київ",
"region": "м. Київ",
"postalCode": "79000",
"countryName": "Україна"
}
}
],
"contractID": "UA-2023-01-01-000001-a-1",
"id": "e07c2e4ee19e43c5bce75b127566b232",
"status": "pending",
"awardID": "d64f2e4a9a0e43a093a29c203ad56b71",
"date": "2023-01-01T00:00:00+02:00",
"value": {
"amount": 500.0,
"currency": "UAH",
"valueAddedTaxIncluded": true,
"amountNet": 500.0
}
}
}
By default contract value amount and amountNet is set based on the award value amount, but there is a possibility to set custom contract value.
You can update value amount and amountNet following next rules:
valueAddedTaxIncluded |
Validation |
|
contract |
award |
|
true |
true/false |
Amount should be greater than amountNet and differ by no more than 20% |
true |
Amount should be less or equal to awarded amount |
|
false |
AmountNet should be less or equal to awarded amount |
|
false |
true/false |
Amount and amountNet should be equal |
true/false |
Amount should be less or equal to awarded amount |
|
Let’s set contract contract value with next request:
Request
PATCH /api/2.5/tenders/9edb2de5d15247d485a377e07702bc83/contracts/e07c2e4ee19e43c5bce75b127566b232?acc_token=b335e5d31c7b4c8291d7a477b18ec529 HTTP/1.0
Authorization: Bearer broker
Content-Type: application/json
Host: lb-api-sandbox.prozorro.gov.ua
{
"data": {
"contractNumber": "contract #13111",
"value": {
"amount": 238,
"amountNet": 230
}
}
}
Response
HTTP/1.0 200 OK
Content-Type: application/json
{
"data": {
"id": "e07c2e4ee19e43c5bce75b127566b232",
"awardID": "d64f2e4a9a0e43a093a29c203ad56b71",
"contractID": "UA-2023-01-01-000001-a-1",
"contractNumber": "contract #13111",
"status": "pending",
"value": {
"amount": 238.0,
"currency": "UAH",
"valueAddedTaxIncluded": true,
"amountNet": 230.0
},
"items": [
{
"id": "b5ff13b59b7e4f2495ec32bda0e78958",
"description": "футляри до державних нагород",
"unit": {
"name": "кг",
"value": {
"amount": 6.0,
"currency": "UAH",
"valueAddedTaxIncluded": true
},
"code": "KGM"
},
"quantity": 5.0,
"classification": {
"description": "Cartons",
"scheme": "ДК021",
"id": "44617100-9"
},
"additionalClassifications": [
{
"scheme": "ДКПП",
"id": "17.21.1",
"description": "папір і картон гофровані, паперова й картонна тара"
}
],
"deliveryDate": {
"startDate": "2023-01-03T00:00:00+02:00",
"endDate": "2023-01-06T00:00:00+02:00"
},
"deliveryAddress": {
"streetAddress": "вул. Банкова 1",
"locality": "м. Київ",
"region": "м. Київ",
"postalCode": "79000",
"countryName": "Україна"
}
},
{
"id": "64da1c2d32904c7780c7a080c03b9058",
"description": "футляри до державних нагород",
"unit": {
"name": "кг",
"value": {
"amount": 6.0,
"currency": "UAH",
"valueAddedTaxIncluded": true
},
"code": "KGM"
},
"quantity": 5.0,
"classification": {
"description": "Cartons",
"scheme": "ДК021",
"id": "44617100-9"
},
"additionalClassifications": [
{
"scheme": "ДКПП",
"id": "17.21.1",
"description": "папір і картон гофровані, паперова й картонна тара"
}
],
"deliveryDate": {
"startDate": "2023-01-03T00:00:00+02:00",
"endDate": "2023-01-06T00:00:00+02:00"
},
"deliveryAddress": {
"streetAddress": "вул. Банкова 1",
"locality": "м. Київ",
"region": "м. Київ",
"postalCode": "79000",
"countryName": "Україна"
}
}
],
"suppliers": [
{
"name": "Державне управління справами",
"identifier": {
"scheme": "UA-EDR",
"id": "00037256",
"legalName": "Державне управління справами",
"uri": "http://www.dus.gov.ua/"
},
"address": {
"streetAddress": "вул. Банкова, 11, корпус 1",
"locality": "м. Київ",
"region": "м. Київ",
"postalCode": "01220",
"countryName": "Україна"
},
"contactPoint": {
"name": "Державне управління справами",
"telephone": "+0440000000"
},
"scale": "micro"
}
],
"date": "2023-01-01T00:00:00+02:00"
}
}
200 OK response was returned. The value was modified successfully.
Setting contract signature date
There is a possibility to set custom contract signature date. You can insert appropriate date into the dateSigned field.
If this date is not set, it will be auto-generated on the date of contract registration.
Request
PATCH /api/2.5/tenders/9edb2de5d15247d485a377e07702bc83/contracts/e07c2e4ee19e43c5bce75b127566b232?acc_token=b335e5d31c7b4c8291d7a477b18ec529 HTTP/1.0
Authorization: Bearer broker
Content-Type: application/json
Host: lb-api-sandbox.prozorro.gov.ua
{
"data": {
"dateSigned": "2023-01-01T00:00:01+02:00"
}
}
Response
HTTP/1.0 200 OK
Content-Type: application/json
null
Setting contract validity period
Setting contract validity period is optional, but if it is needed, you can set appropriate startDate and endDate.
Request
PATCH /api/2.5/tenders/9edb2de5d15247d485a377e07702bc83/contracts/e07c2e4ee19e43c5bce75b127566b232?acc_token=b335e5d31c7b4c8291d7a477b18ec529 HTTP/1.0
Authorization: Bearer broker
Content-Type: application/json
Host: lb-api-sandbox.prozorro.gov.ua
{
"data": {
"period": {
"startDate": "2023-01-01T00:00:01+02:00",
"endDate": "2024-01-01T00:00:01+02:00"
}
}
}
Response
HTTP/1.0 200 OK
Content-Type: application/json
{
"data": {
"id": "e07c2e4ee19e43c5bce75b127566b232",
"awardID": "d64f2e4a9a0e43a093a29c203ad56b71",
"contractID": "UA-2023-01-01-000001-a-1",
"contractNumber": "contract #13111",
"status": "pending",
"period": {
"startDate": "2023-01-01T00:00:01+02:00",
"endDate": "2024-01-01T00:00:01+02:00"
},
"value": {
"amount": 238.0,
"currency": "UAH",
"valueAddedTaxIncluded": true,
"amountNet": 230.0
},
"items": [
{
"id": "b5ff13b59b7e4f2495ec32bda0e78958",
"description": "футляри до державних нагород",
"unit": {
"name": "кг",
"value": {
"amount": 6.0,
"currency": "UAH",
"valueAddedTaxIncluded": true
},
"code": "KGM"
},
"quantity": 5.0,
"classification": {
"description": "Cartons",
"scheme": "ДК021",
"id": "44617100-9"
},
"additionalClassifications": [
{
"scheme": "ДКПП",
"id": "17.21.1",
"description": "папір і картон гофровані, паперова й картонна тара"
}
],
"deliveryDate": {
"startDate": "2023-01-03T00:00:00+02:00",
"endDate": "2023-01-06T00:00:00+02:00"
},
"deliveryAddress": {
"streetAddress": "вул. Банкова 1",
"locality": "м. Київ",
"region": "м. Київ",
"postalCode": "79000",
"countryName": "Україна"
}
},
{
"id": "64da1c2d32904c7780c7a080c03b9058",
"description": "футляри до державних нагород",
"unit": {
"name": "кг",
"value": {
"amount": 6.0,
"currency": "UAH",
"valueAddedTaxIncluded": true
},
"code": "KGM"
},
"quantity": 5.0,
"classification": {
"description": "Cartons",
"scheme": "ДК021",
"id": "44617100-9"
},
"additionalClassifications": [
{
"scheme": "ДКПП",
"id": "17.21.1",
"description": "папір і картон гофровані, паперова й картонна тара"
}
],
"deliveryDate": {
"startDate": "2023-01-03T00:00:00+02:00",
"endDate": "2023-01-06T00:00:00+02:00"
},
"deliveryAddress": {
"streetAddress": "вул. Банкова 1",
"locality": "м. Київ",
"region": "м. Київ",
"postalCode": "79000",
"countryName": "Україна"
}
}
],
"suppliers": [
{
"name": "Державне управління справами",
"identifier": {
"scheme": "UA-EDR",
"id": "00037256",
"legalName": "Державне управління справами",
"uri": "http://www.dus.gov.ua/"
},
"address": {
"streetAddress": "вул. Банкова, 11, корпус 1",
"locality": "м. Київ",
"region": "м. Київ",
"postalCode": "01220",
"countryName": "Україна"
},
"contactPoint": {
"name": "Державне управління справами",
"telephone": "+0440000000"
},
"scale": "micro"
}
],
"date": "2023-01-01T00:00:00+02:00",
"dateSigned": "2023-01-01T00:00:01+02:00"
}
}
Uploading contract documentation
You can upload contract documents. Let’s upload contract document:
Request
POST /api/2.5/tenders/9edb2de5d15247d485a377e07702bc83/contracts/e07c2e4ee19e43c5bce75b127566b232/documents?acc_token=b335e5d31c7b4c8291d7a477b18ec529 HTTP/1.0
Authorization: Bearer broker
Content-Type: application/json
Host: lb-api-sandbox.prozorro.gov.ua
{
"data": {
"title": "contract_first_document.doc",
"url": "http://public-docs-sandbox.prozorro.gov.ua/get/fd05000cea6644509133d7a55a6d0eb6?Signature=e2yrSHePvCCaArb8l8C2tj9kmieyS1nZWyeRu8m1AFdMF41Dcq4uHhopFSU4XK%2Fd56pJof3b83mn57qXn%2F4DBA%3D%3D&KeyID=a8968c46",
"hash": "md5:00000000000000000000000000000000",
"format": "application/msword"
}
}
Response
HTTP/1.0 201 Created
Content-Type: application/json
Location: http://lb-api-sandbox.prozorro.gov.ua/api/2.5/tenders/9edb2de5d15247d485a377e07702bc83/contracts/e07c2e4ee19e43c5bce75b127566b232/documents/e0dbb5b1ba48444caa87e74919f15684
{
"data": {
"hash": "md5:00000000000000000000000000000000",
"title": "contract_first_document.doc",
"format": "application/msword",
"url": "http://public-docs-sandbox.prozorro.gov.ua/get/fd05000cea6644509133d7a55a6d0eb6?Signature=BGFjPoS7Fy6SJmiIpVychi4qX2I%2FLWV1%2Bq5Hj2XRrdRyYCMhO2KkHlHjL5DS8QqeV38n2bjWlho1wM03cTe6AQ%3D%3D&KeyID=a8968c46",
"documentOf": "tender",
"language": "uk",
"id": "e0dbb5b1ba48444caa87e74919f15684",
"datePublished": "2023-01-01T00:00:01+02:00",
"dateModified": "2023-01-01T00:00:01+02:00"
}
}
201 Created response code and Location header confirm document was added.
Let’s see the list of contract documents:
Request
GET /api/2.5/tenders/9edb2de5d15247d485a377e07702bc83/contracts/e07c2e4ee19e43c5bce75b127566b232/documents HTTP/1.0
Authorization: Bearer broker
Host: public-api-sandbox.prozorro.gov.ua
Response
HTTP/1.0 200 OK
Content-Type: application/json
{
"data": [
{
"hash": "md5:00000000000000000000000000000000",
"title": "contract_first_document.doc",
"format": "application/msword",
"url": "http://public-docs-sandbox.prozorro.gov.ua/get/fd05000cea6644509133d7a55a6d0eb6?Signature=BGFjPoS7Fy6SJmiIpVychi4qX2I%2FLWV1%2Bq5Hj2XRrdRyYCMhO2KkHlHjL5DS8QqeV38n2bjWlho1wM03cTe6AQ%3D%3D&KeyID=a8968c46",
"documentOf": "tender",
"language": "uk",
"id": "e0dbb5b1ba48444caa87e74919f15684",
"datePublished": "2023-01-01T00:00:01+02:00",
"dateModified": "2023-01-01T00:00:01+02:00"
}
]
}
We can add another contract document:
Request
POST /api/2.5/tenders/9edb2de5d15247d485a377e07702bc83/contracts/e07c2e4ee19e43c5bce75b127566b232/documents?acc_token=b335e5d31c7b4c8291d7a477b18ec529 HTTP/1.0
Authorization: Bearer broker
Content-Type: application/json
Host: lb-api-sandbox.prozorro.gov.ua
{
"data": {
"title": "contract_second_document.doc",
"url": "http://public-docs-sandbox.prozorro.gov.ua/get/7b57c09aa077422282cf6ef8753e3812?Signature=%2BwMUeT85IquTIXshlYTJupRwU7o1opkRRl486MEG44nx4kpBFC5O6i23Ks7pkjV7qiK2Hpjk%2FE4b%2BBjlEsyGCA%3D%3D&KeyID=a8968c46",
"hash": "md5:00000000000000000000000000000000",
"format": "application/msword"
}
}
Response
HTTP/1.0 201 Created
Content-Type: application/json
Location: http://lb-api-sandbox.prozorro.gov.ua/api/2.5/tenders/9edb2de5d15247d485a377e07702bc83/contracts/e07c2e4ee19e43c5bce75b127566b232/documents/a5eda0ad89cd4f5eb58da1a4840c0239
{
"data": {
"hash": "md5:00000000000000000000000000000000",
"title": "contract_second_document.doc",
"format": "application/msword",
"url": "http://public-docs-sandbox.prozorro.gov.ua/get/7b57c09aa077422282cf6ef8753e3812?Signature=loqXGLRZ6q7oNmHis9gM8i0hhPHnbyFLL8%2FuhAi2fzy85szHT3mTZKW4RNCOVszftzu7ATdFx89ccnO0RmaUBg%3D%3D&KeyID=a8968c46",
"documentOf": "tender",
"language": "uk",
"id": "a5eda0ad89cd4f5eb58da1a4840c0239",
"datePublished": "2023-01-01T00:00:01+02:00",
"dateModified": "2023-01-01T00:00:01+02:00"
}
}
201 Created response code and Location header confirm second document was uploaded.
Let’s see the list of all added contract documents:
Request
GET /api/2.5/tenders/9edb2de5d15247d485a377e07702bc83/contracts/e07c2e4ee19e43c5bce75b127566b232/documents HTTP/1.0
Authorization: Bearer broker
Host: public-api-sandbox.prozorro.gov.ua
Response
HTTP/1.0 200 OK
Content-Type: application/json
{
"data": [
{
"hash": "md5:00000000000000000000000000000000",
"title": "contract_first_document.doc",
"format": "application/msword",
"url": "http://public-docs-sandbox.prozorro.gov.ua/get/fd05000cea6644509133d7a55a6d0eb6?Signature=BGFjPoS7Fy6SJmiIpVychi4qX2I%2FLWV1%2Bq5Hj2XRrdRyYCMhO2KkHlHjL5DS8QqeV38n2bjWlho1wM03cTe6AQ%3D%3D&KeyID=a8968c46",
"documentOf": "tender",
"language": "uk",
"id": "e0dbb5b1ba48444caa87e74919f15684",
"datePublished": "2023-01-01T00:00:01+02:00",
"dateModified": "2023-01-01T00:00:01+02:00"
},
{
"hash": "md5:00000000000000000000000000000000",
"title": "contract_second_document.doc",
"format": "application/msword",
"url": "http://public-docs-sandbox.prozorro.gov.ua/get/7b57c09aa077422282cf6ef8753e3812?Signature=loqXGLRZ6q7oNmHis9gM8i0hhPHnbyFLL8%2FuhAi2fzy85szHT3mTZKW4RNCOVszftzu7ATdFx89ccnO0RmaUBg%3D%3D&KeyID=a8968c46",
"documentOf": "tender",
"language": "uk",
"id": "a5eda0ad89cd4f5eb58da1a4840c0239",
"datePublished": "2023-01-01T00:00:01+02:00",
"dateModified": "2023-01-01T00:00:01+02:00"
}
]
}
Set contract signature date
There is a possibility to set custom contract signature date. If the date is not set it will be generated on contract registration.
Request
PATCH /api/2.5/tenders/9edb2de5d15247d485a377e07702bc83/contracts/e07c2e4ee19e43c5bce75b127566b232?acc_token=b335e5d31c7b4c8291d7a477b18ec529 HTTP/1.0
Authorization: Bearer broker
Content-Type: application/json
Host: lb-api-sandbox.prozorro.gov.ua
{
"data": {
"dateSigned": "2023-01-01T00:00:01+02:00"
}
}
Response
HTTP/1.0 200 OK
Content-Type: application/json
null
Contract registration
Request
PATCH /api/2.5/tenders/9edb2de5d15247d485a377e07702bc83/contracts/e07c2e4ee19e43c5bce75b127566b232?acc_token=b335e5d31c7b4c8291d7a477b18ec529 HTTP/1.0
Authorization: Bearer broker
Content-Type: application/json
Host: lb-api-sandbox.prozorro.gov.ua
{
"data": {
"status": "active"
}
}
Response
HTTP/1.0 200 OK
Content-Type: application/json
{
"data": {
"id": "e07c2e4ee19e43c5bce75b127566b232",
"awardID": "d64f2e4a9a0e43a093a29c203ad56b71",
"contractID": "UA-2023-01-01-000001-a-1",
"contractNumber": "contract #13111",
"status": "active",
"period": {
"startDate": "2023-01-01T00:00:01+02:00",
"endDate": "2024-01-01T00:00:01+02:00"
},
"value": {
"amount": 238.0,
"currency": "UAH",
"valueAddedTaxIncluded": true,
"amountNet": 230.0
},
"items": [
{
"id": "b5ff13b59b7e4f2495ec32bda0e78958",
"description": "футляри до державних нагород",
"unit": {
"name": "кг",
"value": {
"amount": 6.0,
"currency": "UAH",
"valueAddedTaxIncluded": true
},
"code": "KGM"
},
"quantity": 5.0,
"classification": {
"description": "Cartons",
"scheme": "ДК021",
"id": "44617100-9"
},
"additionalClassifications": [
{
"scheme": "ДКПП",
"id": "17.21.1",
"description": "папір і картон гофровані, паперова й картонна тара"
}
],
"deliveryDate": {
"startDate": "2023-01-03T00:00:00+02:00",
"endDate": "2023-01-06T00:00:00+02:00"
},
"deliveryAddress": {
"streetAddress": "вул. Банкова 1",
"locality": "м. Київ",
"region": "м. Київ",
"postalCode": "79000",
"countryName": "Україна"
}
},
{
"id": "64da1c2d32904c7780c7a080c03b9058",
"description": "футляри до державних нагород",
"unit": {
"name": "кг",
"value": {
"amount": 6.0,
"currency": "UAH",
"valueAddedTaxIncluded": true
},
"code": "KGM"
},
"quantity": 5.0,
"classification": {
"description": "Cartons",
"scheme": "ДК021",
"id": "44617100-9"
},
"additionalClassifications": [
{
"scheme": "ДКПП",
"id": "17.21.1",
"description": "папір і картон гофровані, паперова й картонна тара"
}
],
"deliveryDate": {
"startDate": "2023-01-03T00:00:00+02:00",
"endDate": "2023-01-06T00:00:00+02:00"
},
"deliveryAddress": {
"streetAddress": "вул. Банкова 1",
"locality": "м. Київ",
"region": "м. Київ",
"postalCode": "79000",
"countryName": "Україна"
}
}
],
"suppliers": [
{
"name": "Державне управління справами",
"identifier": {
"scheme": "UA-EDR",
"id": "00037256",
"legalName": "Державне управління справами",
"uri": "http://www.dus.gov.ua/"
},
"address": {
"streetAddress": "вул. Банкова, 11, корпус 1",
"locality": "м. Київ",
"region": "м. Київ",
"postalCode": "01220",
"countryName": "Україна"
},
"contactPoint": {
"name": "Державне управління справами",
"telephone": "+0440000000"
},
"scale": "micro"
}
],
"date": "2023-01-01T00:00:01+02:00",
"documents": [
{
"id": "e0dbb5b1ba48444caa87e74919f15684",
"datePublished": "2023-01-01T00:00:01+02:00",
"hash": "md5:00000000000000000000000000000000",
"title": "contract_first_document.doc",
"format": "application/msword",
"url": "http://public-docs-sandbox.prozorro.gov.ua/get/fd05000cea6644509133d7a55a6d0eb6?Signature=BGFjPoS7Fy6SJmiIpVychi4qX2I%2FLWV1%2Bq5Hj2XRrdRyYCMhO2KkHlHjL5DS8QqeV38n2bjWlho1wM03cTe6AQ%3D%3D&KeyID=a8968c46",
"documentOf": "tender",
"dateModified": "2023-01-01T00:00:01+02:00",
"language": "uk"
},
{
"id": "a5eda0ad89cd4f5eb58da1a4840c0239",
"datePublished": "2023-01-01T00:00:01+02:00",
"hash": "md5:00000000000000000000000000000000",
"title": "contract_second_document.doc",
"format": "application/msword",
"url": "http://public-docs-sandbox.prozorro.gov.ua/get/7b57c09aa077422282cf6ef8753e3812?Signature=loqXGLRZ6q7oNmHis9gM8i0hhPHnbyFLL8%2FuhAi2fzy85szHT3mTZKW4RNCOVszftzu7ATdFx89ccnO0RmaUBg%3D%3D&KeyID=a8968c46",
"documentOf": "tender",
"dateModified": "2023-01-01T00:00:01+02:00",
"language": "uk"
}
],
"dateSigned": "2023-01-01T00:00:01+02:00"
}
}
Completing contract
When the tender is completed, contract (that has been created in the tender system) is transferred to the contract system automatically.
Read more about working with regular contracting in contracting system in Tutorial section.