Tutorial
Exploring basic rules
Let’s try exploring the /agreements endpoint:
Request
GET /api/2.5/agreements HTTP/1.0
Host: public-api-sandbox.prozorro.gov.ua
Response
HTTP/1.0 200 OK
Content-Type: application/json
{
"data": [],
"next_page": {
"offset": "",
"path": "/api/2.5/agreements",
"uri": "http://public-api-sandbox.prozorro.gov.ua/api/2.5/agreements"
}
}
Just invoking it reveals an empty set.
Agreement is transferred from the tender system by an automated process.
Creating agreement
Let’s say that we have conducted tender and it has complete status. When the tender is completed, agreement (that has been created in the tender system) is transferred to the agreement system automatically.
Brokers (eMalls) can’t create agreements in the agreement system.
Getting agreement
Agreement in the tender system
Request
GET /api/2.5/tenders/bcc35be92ed24536a5af9ede5e2de5e0/agreements/b7536ab0fbe34a1dafa73fe7943ff79c HTTP/1.0
Authorization: Bearer broker
Host: public-api-sandbox.prozorro.gov.ua
Response
HTTP/1.0 200 OK
Content-Type: application/json
{
"data": {
"id": "b7536ab0fbe34a1dafa73fe7943ff79c",
"items": [
{
"id": "00662cb27141433b86593cedfcd4c3d9",
"description": "футляри до державних нагород",
"unit": {
"name": "item",
"code": "KGM"
},
"quantity": 5.0,
"classification": {
"description": "Cartons",
"scheme": "ДК021",
"id": "44617100-9"
},
"additionalClassifications": [
{
"scheme": "ДКПП",
"id": "17.21.1",
"description": "папір і картон гофровані, паперова й картонна тара"
}
],
"relatedLot": "04651361e47848abb6eda21e59c8b4a1",
"deliveryDate": {
"startDate": "2018-06-27T13:39:09.362837+03:00",
"endDate": "2018-06-30T13:39:09.362837+03:00"
},
"deliveryAddress": {
"streetAddress": "вул. Банкова 1",
"locality": "м. Київ",
"region": "м. Київ",
"postalCode": "79000",
"countryName": "Україна"
},
"description_en": "Cases for state awards"
}
],
"agreementID": "UA-2023-10-10-000001-a-e75ece1cddb64807825e058d729510f61",
"date": "2023-10-10T01:00:00+03:00",
"contracts": [
{
"id": "3f790a2fc7c647a7be968a10e669e9fa",
"suppliers": [
{
"contactPoint": {
"name_en": "State administration",
"name": "Державне управління справами",
"telephone": "+0440000000"
},
"name_en": "State administration",
"identifier": {
"scheme": "UA-EDR",
"legalName_en": "dus.gov.ua",
"id": "00037256",
"uri": "http://www.dus.gov.ua/"
},
"name": "Державне управління справами",
"address": {
"countryName": "Україна",
"postalCode": "01220",
"region": "м. Київ",
"streetAddress": "вул. Банкова, 11, корпус 1",
"locality": "м. Київ"
},
"scale": "micro"
}
],
"awardID": "f99be86681de4f368037738d6af12903",
"bidID": "78290ccc2a114830a97e8f2c510bacaf",
"date": "2023-10-10T01:00:00+03:00",
"unitPrices": [
{
"relatedItem": "00662cb27141433b86593cedfcd4c3d9",
"value": {
"currency": "UAH",
"valueAddedTaxIncluded": true,
"amount": 93
}
}
],
"status": "active"
},
{
"id": "142288b4ac5447c088ae5c55bed1f9fc",
"suppliers": [
{
"contactPoint": {
"name_en": "State administration",
"name": "Державне управління справами",
"telephone": "+0440000000"
},
"name_en": "State administration",
"identifier": {
"scheme": "UA-EDR",
"legalName_en": "dus.gov.ua",
"id": "00037256",
"uri": "http://www.dus.gov.ua/"
},
"name": "Державне управління справами",
"address": {
"countryName": "Україна",
"postalCode": "01220",
"region": "м. Київ",
"streetAddress": "вул. Банкова, 11, корпус 1",
"locality": "м. Київ"
},
"scale": "micro"
}
],
"awardID": "e5e6c374e9db46c2bf634056b03768db",
"bidID": "be6885d5a2ec4336a11ed73370239ed6",
"date": "2023-10-10T01:00:00+03:00",
"unitPrices": [
{
"relatedItem": "00662cb27141433b86593cedfcd4c3d9",
"value": {
"currency": "UAH",
"valueAddedTaxIncluded": true,
"amount": 93
}
}
],
"status": "active"
},
{
"id": "bd325edc619c4f61b067e07529a08461",
"suppliers": [
{
"contactPoint": {
"name_en": "State administration",
"name": "Державне управління справами",
"telephone": "+0440000000"
},
"name_en": "State administration",
"identifier": {
"scheme": "UA-EDR",
"legalName_en": "dus.gov.ua",
"id": "00037256",
"uri": "http://www.dus.gov.ua/"
},
"name": "Державне управління справами",
"address": {
"countryName": "Україна",
"postalCode": "01220",
"region": "м. Київ",
"streetAddress": "вул. Банкова, 11, корпус 1",
"locality": "м. Київ"
},
"scale": "micro"
}
],
"awardID": "ea7c848eefbb4037a273456dd333ce1a",
"bidID": "593a5fc959d64463b40f460fe47f30cb",
"date": "2023-10-10T01:00:00+03:00",
"unitPrices": [
{
"relatedItem": "00662cb27141433b86593cedfcd4c3d9",
"value": {
"currency": "UAH",
"valueAddedTaxIncluded": true,
"amount": 93
}
}
],
"status": "active"
}
],
"status": "active"
}
}
Agreement id is the same in both tender and agreement system.
Let’s access the URL of the created object inside agreement system:
Request
GET /api/2.5/agreements/b7536ab0fbe34a1dafa73fe7943ff79c HTTP/1.0
Host: public-api-sandbox.prozorro.gov.ua
Response
HTTP/1.0 200 OK
Content-Type: application/json
{
"data": {
"agreementID": "UA-2023-10-10-000001-a-e75ece1cddb64807825e058d729510f61",
"status": "active",
"owner": "broker",
"contracts": [
{
"id": "3f790a2fc7c647a7be968a10e669e9fa",
"status": "active",
"suppliers": [
{
"name": "Державне управління справами",
"name_en": "State administration",
"identifier": {
"scheme": "UA-EDR",
"id": "00037256",
"legalName_en": "dus.gov.ua",
"uri": "http://www.dus.gov.ua/"
},
"address": {
"streetAddress": "вул. Банкова, 11, корпус 1",
"locality": "м. Київ",
"region": "м. Київ",
"postalCode": "01220",
"countryName": "Україна"
},
"contactPoint": {
"name": "Державне управління справами",
"name_en": "State administration",
"telephone": "+0440000000"
},
"scale": "micro"
}
],
"unitPrices": [
{
"relatedItem": "00662cb27141433b86593cedfcd4c3d9",
"value": {
"currency": "UAH",
"valueAddedTaxIncluded": true,
"amount": 93
}
}
],
"awardID": "f99be86681de4f368037738d6af12903",
"bidID": "78290ccc2a114830a97e8f2c510bacaf",
"date": "2023-10-10T01:00:00+03:00"
},
{
"id": "142288b4ac5447c088ae5c55bed1f9fc",
"status": "active",
"suppliers": [
{
"name": "Державне управління справами",
"name_en": "State administration",
"identifier": {
"scheme": "UA-EDR",
"id": "00037256",
"legalName_en": "dus.gov.ua",
"uri": "http://www.dus.gov.ua/"
},
"address": {
"streetAddress": "вул. Банкова, 11, корпус 1",
"locality": "м. Київ",
"region": "м. Київ",
"postalCode": "01220",
"countryName": "Україна"
},
"contactPoint": {
"name": "Державне управління справами",
"name_en": "State administration",
"telephone": "+0440000000"
},
"scale": "micro"
}
],
"unitPrices": [
{
"relatedItem": "00662cb27141433b86593cedfcd4c3d9",
"value": {
"currency": "UAH",
"valueAddedTaxIncluded": true,
"amount": 93
}
}
],
"awardID": "e5e6c374e9db46c2bf634056b03768db",
"bidID": "be6885d5a2ec4336a11ed73370239ed6",
"date": "2023-10-10T01:00:00+03:00"
},
{
"id": "bd325edc619c4f61b067e07529a08461",
"status": "active",
"suppliers": [
{
"name": "Державне управління справами",
"name_en": "State administration",
"identifier": {
"scheme": "UA-EDR",
"id": "00037256",
"legalName_en": "dus.gov.ua",
"uri": "http://www.dus.gov.ua/"
},
"address": {
"streetAddress": "вул. Банкова, 11, корпус 1",
"locality": "м. Київ",
"region": "м. Київ",
"postalCode": "01220",
"countryName": "Україна"
},
"contactPoint": {
"name": "Державне управління справами",
"name_en": "State administration",
"telephone": "+0440000000"
},
"scale": "micro"
}
],
"unitPrices": [
{
"relatedItem": "00662cb27141433b86593cedfcd4c3d9",
"value": {
"currency": "UAH",
"valueAddedTaxIncluded": true,
"amount": 93
}
}
],
"awardID": "ea7c848eefbb4037a273456dd333ce1a",
"bidID": "593a5fc959d64463b40f460fe47f30cb",
"date": "2023-10-10T01:00:00+03:00"
}
],
"items": [
{
"id": "00662cb27141433b86593cedfcd4c3d9",
"description": "футляри до державних нагород",
"quantity": 5.0,
"relatedLot": "04651361e47848abb6eda21e59c8b4a1",
"classification": {
"description": "Cartons",
"scheme": "ДК021",
"id": "44617100-9"
},
"additionalClassifications": [
{
"scheme": "ДКПП",
"id": "17.21.1",
"description": "папір і картон гофровані, паперова й картонна тара"
}
],
"description_en": "Cases for state awards",
"deliveryDate": {
"startDate": "2018-06-27T13:39:09.362837+03:00",
"endDate": "2018-06-30T13:39:09.362837+03:00"
},
"deliveryAddress": {
"streetAddress": "вул. Банкова 1",
"locality": "м. Київ",
"region": "м. Київ",
"postalCode": "79000",
"countryName": "Україна"
},
"unit": {
"name": "item",
"code": "KGM"
}
}
],
"procuringEntity": {
"name": "Державне управління справами",
"name_en": "State administration",
"identifier": {
"scheme": "UA-EDR",
"id": "00037256",
"legalName_en": "dus.gov.ua",
"uri": "http://www.dus.gov.ua/"
},
"kind": "general",
"contactPoint": {
"name": "Державне управління справами",
"name_en": "State administration",
"telephone": "+0440000000",
"availableLanguage": "uk"
},
"address": {
"streetAddress": "вул. Банкова, 11, корпус 1",
"locality": "м. Київ",
"region": "м. Київ",
"postalCode": "01220",
"countryName": "Україна"
}
},
"tender_id": "bcc35be92ed24536a5af9ede5e2de5e0",
"numberOfContracts": 3,
"dateModified": "2023-10-10T01:00:00+03:00",
"id": "b7536ab0fbe34a1dafa73fe7943ff79c"
},
"config": {
"restricted": false
}
}
Getting access
In order to get rights for future agreement editing, you need to use this view PATCH: /agreements/{id}/credentials?acc_token={tender_token} with the API key of the eMall (broker), where tender was generated.
In the PATCH: /agreements/{id}/credentials?acc_token={tender_token}:
idstands for agreement id,tender_tokenis tender’s token (is used for agreement token generation).
Response will contain access.token for the agreement that can be used for further agreement modification.
Request
PATCH /api/2.5/agreements/b7536ab0fbe34a1dafa73fe7943ff79c/credentials?acc_token=b76d0e5d00ec4313b7be7fc5341f6e1c HTTP/1.0
Authorization: Bearer broker
Content-Type: application/json
Host: lb-api-sandbox.prozorro.gov.ua
Response
HTTP/1.0 200 OK
Content-Type: application/json
{
"data": {
"agreementID": "UA-2023-10-10-000001-a-e75ece1cddb64807825e058d729510f61",
"status": "active",
"owner": "broker",
"contracts": [
{
"id": "3f790a2fc7c647a7be968a10e669e9fa",
"status": "active",
"suppliers": [
{
"name": "Державне управління справами",
"name_en": "State administration",
"identifier": {
"scheme": "UA-EDR",
"id": "00037256",
"legalName_en": "dus.gov.ua",
"uri": "http://www.dus.gov.ua/"
},
"address": {
"streetAddress": "вул. Банкова, 11, корпус 1",
"locality": "м. Київ",
"region": "м. Київ",
"postalCode": "01220",
"countryName": "Україна"
},
"contactPoint": {
"name": "Державне управління справами",
"name_en": "State administration",
"telephone": "+0440000000"
},
"scale": "micro"
}
],
"unitPrices": [
{
"relatedItem": "00662cb27141433b86593cedfcd4c3d9",
"value": {
"currency": "UAH",
"valueAddedTaxIncluded": true,
"amount": 93
}
}
],
"awardID": "f99be86681de4f368037738d6af12903",
"bidID": "78290ccc2a114830a97e8f2c510bacaf",
"date": "2023-10-10T01:00:00+03:00"
},
{
"id": "142288b4ac5447c088ae5c55bed1f9fc",
"status": "active",
"suppliers": [
{
"name": "Державне управління справами",
"name_en": "State administration",
"identifier": {
"scheme": "UA-EDR",
"id": "00037256",
"legalName_en": "dus.gov.ua",
"uri": "http://www.dus.gov.ua/"
},
"address": {
"streetAddress": "вул. Банкова, 11, корпус 1",
"locality": "м. Київ",
"region": "м. Київ",
"postalCode": "01220",
"countryName": "Україна"
},
"contactPoint": {
"name": "Державне управління справами",
"name_en": "State administration",
"telephone": "+0440000000"
},
"scale": "micro"
}
],
"unitPrices": [
{
"relatedItem": "00662cb27141433b86593cedfcd4c3d9",
"value": {
"currency": "UAH",
"valueAddedTaxIncluded": true,
"amount": 93
}
}
],
"awardID": "e5e6c374e9db46c2bf634056b03768db",
"bidID": "be6885d5a2ec4336a11ed73370239ed6",
"date": "2023-10-10T01:00:00+03:00"
},
{
"id": "bd325edc619c4f61b067e07529a08461",
"status": "active",
"suppliers": [
{
"name": "Державне управління справами",
"name_en": "State administration",
"identifier": {
"scheme": "UA-EDR",
"id": "00037256",
"legalName_en": "dus.gov.ua",
"uri": "http://www.dus.gov.ua/"
},
"address": {
"streetAddress": "вул. Банкова, 11, корпус 1",
"locality": "м. Київ",
"region": "м. Київ",
"postalCode": "01220",
"countryName": "Україна"
},
"contactPoint": {
"name": "Державне управління справами",
"name_en": "State administration",
"telephone": "+0440000000"
},
"scale": "micro"
}
],
"unitPrices": [
{
"relatedItem": "00662cb27141433b86593cedfcd4c3d9",
"value": {
"currency": "UAH",
"valueAddedTaxIncluded": true,
"amount": 93
}
}
],
"awardID": "ea7c848eefbb4037a273456dd333ce1a",
"bidID": "593a5fc959d64463b40f460fe47f30cb",
"date": "2023-10-10T01:00:00+03:00"
}
],
"items": [
{
"id": "00662cb27141433b86593cedfcd4c3d9",
"description": "футляри до державних нагород",
"quantity": 5.0,
"relatedLot": "04651361e47848abb6eda21e59c8b4a1",
"classification": {
"description": "Cartons",
"scheme": "ДК021",
"id": "44617100-9"
},
"additionalClassifications": [
{
"scheme": "ДКПП",
"id": "17.21.1",
"description": "папір і картон гофровані, паперова й картонна тара"
}
],
"description_en": "Cases for state awards",
"deliveryDate": {
"startDate": "2018-06-27T13:39:09.362837+03:00",
"endDate": "2018-06-30T13:39:09.362837+03:00"
},
"deliveryAddress": {
"streetAddress": "вул. Банкова 1",
"locality": "м. Київ",
"region": "м. Київ",
"postalCode": "79000",
"countryName": "Україна"
},
"unit": {
"name": "item",
"code": "KGM"
}
}
],
"procuringEntity": {
"name": "Державне управління справами",
"name_en": "State administration",
"identifier": {
"scheme": "UA-EDR",
"id": "00037256",
"legalName_en": "dus.gov.ua",
"uri": "http://www.dus.gov.ua/"
},
"kind": "general",
"contactPoint": {
"name": "Державне управління справами",
"name_en": "State administration",
"telephone": "+0440000000",
"availableLanguage": "uk"
},
"address": {
"streetAddress": "вул. Банкова, 11, корпус 1",
"locality": "м. Київ",
"region": "м. Київ",
"postalCode": "01220",
"countryName": "Україна"
}
},
"tender_id": "bcc35be92ed24536a5af9ede5e2de5e0",
"numberOfContracts": 3,
"dateModified": "2023-10-10T01:00:00+03:00",
"id": "b7536ab0fbe34a1dafa73fe7943ff79c"
},
"access": {
"token": "9870067ea6e64d14adf4016d24d15f0c",
"transfer": "b0a78824908548d7abce4666df53829d"
}
}
Let’s view agreements.
Request
GET /api/2.5/agreements HTTP/1.0
Authorization: Bearer broker
Host: public-api-sandbox.prozorro.gov.ua
Response
HTTP/1.0 200 OK
Content-Type: application/json
{
"data": [
{
"dateModified": "2023-10-10T01:00:00+03:00",
"id": "b7536ab0fbe34a1dafa73fe7943ff79c"
}
],
"next_page": {
"offset": 1696888800.0,
"path": "/api/2.5/agreements?offset=1696888800.0",
"uri": "http://public-api-sandbox.prozorro.gov.ua/api/2.5/agreements?offset=1696888800.0"
}
}
We do see the internal id of a agreement (that can be used to construct full URL by prepending http://api-sandbox.openprocurement.org/api/0/agreements/) and its dateModified datestamp.
Modifying agreement
Essential agreement terms can be modified by the submission of a new change object to the Agreement.changes container. Change can be one of this types ChangeTaxRate in cfaua, ChangeItemPriceVariation in cfaua, ChangePartyWithdrawal in cfaua or ChangeThirdParty in cfaua
All changes are processed by the endpoint /agreement/{id}/changes.
Submitting a change
Let’s add new change to the agreement:
Request
POST /api/2.5/agreements/b7536ab0fbe34a1dafa73fe7943ff79c/changes?acc_token=9870067ea6e64d14adf4016d24d15f0c HTTP/1.0
Authorization: Bearer broker
Content-Type: application/json
Host: lb-api-sandbox.prozorro.gov.ua
{
"data": {
"rationale": "Опис причини змін егріменту",
"rationale_en": "Agreement change cause",
"rationaleType": "taxRate"
}
}
Response
HTTP/1.0 201 Created
Content-Type: application/json
{
"data": {
"status": "pending",
"rationale": "Опис причини змін егріменту",
"rationale_en": "Agreement change cause",
"date": "2023-10-10T01:00:00+03:00",
"rationaleType": "taxRate",
"id": "4f32972b3cfd4f248814b2a88e8e21d6"
}
}
Note that you should provide value in rationaleType field. This field is required.
You can view the change:
Request
GET /api/2.5/agreements/b7536ab0fbe34a1dafa73fe7943ff79c/changes/4f32972b3cfd4f248814b2a88e8e21d6 HTTP/1.0
Authorization: Bearer broker
Host: public-api-sandbox.prozorro.gov.ua
Response
HTTP/1.0 200 OK
Content-Type: application/json
{
"data": {
"status": "pending",
"rationale": "Опис причини змін егріменту",
"rationale_en": "Agreement change cause",
"date": "2023-10-10T01:00:00+03:00",
"rationaleType": "taxRate",
"id": "4f32972b3cfd4f248814b2a88e8e21d6"
}
}
Change can be modified while it is in the pending status:
Request
PATCH /api/2.5/agreements/b7536ab0fbe34a1dafa73fe7943ff79c/changes/4f32972b3cfd4f248814b2a88e8e21d6?acc_token=9870067ea6e64d14adf4016d24d15f0c HTTP/1.0
Authorization: Bearer broker
Content-Type: application/json
Host: lb-api-sandbox.prozorro.gov.ua
{
"data": {
"rationale": "Друга і третя поставка має бути розфасована"
}
}
Response
HTTP/1.0 200 OK
Content-Type: application/json
{
"data": {
"id": "4f32972b3cfd4f248814b2a88e8e21d6",
"status": "pending",
"date": "2023-10-10T01:00:00+03:00",
"rationale": "Друга і третя поставка має бути розфасована",
"rationale_en": "Agreement change cause",
"rationaleType": "taxRate"
}
}
Uploading change document
Document can be added only while change is in the pending status.
Document has to be added in two stages:
you should upload document
Request
POST /api/2.5/agreements/b7536ab0fbe34a1dafa73fe7943ff79c/documents?acc_token=9870067ea6e64d14adf4016d24d15f0c HTTP/1.0
Authorization: Bearer broker
Content-Type: application/json
Host: lb-api-sandbox.prozorro.gov.ua
{
"data": {
"title": "agreement_changes.doc",
"url": "http://public-docs-sandbox.prozorro.gov.ua/get/6c343bcdd7d241068f88138036b4e52a?Signature=vhFVJH%2BWXh8iggm9ieV4RAxb8cH6Bmf%2F%2BacGhtnigHlLyPezAg2WgaAnhdh211eXDo0T2q%2F22rai3BVdbVH7BQ%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/agreements/b7536ab0fbe34a1dafa73fe7943ff79c/documents/59daf3cfcf9c441281a2a215d44bfb65
{
"data": {
"hash": "md5:00000000000000000000000000000000",
"title": "agreement_changes.doc",
"format": "application/msword",
"url": "http://public-docs-sandbox.prozorro.gov.ua/get/6c343bcdd7d241068f88138036b4e52a?Signature=cU7WXirw65OUUhuS5lZDppSTLBBAEOZ6GMLIefKy1mqh5Qe9B9T8b%2B%2BfoucGKMRZRL2%2FSJeoZWpypUlbWdU5DA%3D%3D&KeyID=a8968c46",
"language": "uk",
"documentOf": "agreement",
"id": "59daf3cfcf9c441281a2a215d44bfb65",
"datePublished": "2023-10-10T01:00:00+03:00",
"dateModified": "2023-10-10T01:00:00+03:00"
}
}
you should set document properties
"documentOf": "change"and"relatedItem": "{change.id}"in order to bind the uploaded document to the change:
Request
PATCH /api/2.5/agreements/b7536ab0fbe34a1dafa73fe7943ff79c/documents/59daf3cfcf9c441281a2a215d44bfb65?acc_token=9870067ea6e64d14adf4016d24d15f0c HTTP/1.0
Authorization: Bearer broker
Content-Type: application/json
Host: lb-api-sandbox.prozorro.gov.ua
{
"data": {
"documentOf": "change",
"relatedItem": "4f32972b3cfd4f248814b2a88e8e21d6"
}
}
Response
HTTP/1.0 200 OK
Content-Type: application/json
{
"data": {
"relatedItem": "4f32972b3cfd4f248814b2a88e8e21d6",
"id": "59daf3cfcf9c441281a2a215d44bfb65",
"datePublished": "2023-10-10T01:00:00+03:00",
"hash": "md5:00000000000000000000000000000000",
"title": "agreement_changes.doc",
"format": "application/msword",
"url": "http://public-docs-sandbox.prozorro.gov.ua/get/6c343bcdd7d241068f88138036b4e52a?Signature=cU7WXirw65OUUhuS5lZDppSTLBBAEOZ6GMLIefKy1mqh5Qe9B9T8b%2B%2BfoucGKMRZRL2%2FSJeoZWpypUlbWdU5DA%3D%3D&KeyID=a8968c46",
"dateModified": "2023-10-10T01:00:00+03:00",
"language": "uk",
"documentOf": "change"
}
}
Updating agreement properties
Now you can update agreement properties which belong to the change.
Request
PATCH /api/2.5/agreements/b7536ab0fbe34a1dafa73fe7943ff79c/changes/4f32972b3cfd4f248814b2a88e8e21d6?acc_token=9870067ea6e64d14adf4016d24d15f0c HTTP/1.0
Authorization: Bearer broker
Content-Type: application/json
Host: lb-api-sandbox.prozorro.gov.ua
{
"data": {
"modifications": [
{
"itemId": "00662cb27141433b86593cedfcd4c3d9",
"factor": 0.1605
}
]
}
}
Response
HTTP/1.0 200 OK
Content-Type: application/json
{
"data": {
"id": "4f32972b3cfd4f248814b2a88e8e21d6",
"status": "pending",
"date": "2023-10-10T01:00:00+03:00",
"rationale": "Друга і третя поставка має бути розфасована",
"rationale_en": "Agreement change cause",
"rationaleType": "taxRate",
"modifications": [
{
"itemId": "00662cb27141433b86593cedfcd4c3d9",
"factor": 0.1605
}
]
}
}
In case of multiple Item you are allowed to change in modifications each factor.
Agreement preview
Also, while change is in the pending status, you can see agreement as change would be applied.
You need to use this view GET: /agreements/{id}/preview?acc_token={agreement_token}.
Request
GET /api/2.5/agreements/b7536ab0fbe34a1dafa73fe7943ff79c/preview?acc_token=9870067ea6e64d14adf4016d24d15f0c HTTP/1.0
Authorization: Bearer broker
Host: public-api-sandbox.prozorro.gov.ua
Response
HTTP/1.0 200 OK
Content-Type: application/json
{
"data": {
"agreementID": "UA-2023-10-10-000001-a-e75ece1cddb64807825e058d729510f61",
"status": "active",
"owner": "broker",
"contracts": [
{
"id": "3f790a2fc7c647a7be968a10e669e9fa",
"status": "active",
"suppliers": [
{
"name": "Державне управління справами",
"name_en": "State administration",
"identifier": {
"scheme": "UA-EDR",
"id": "00037256",
"legalName_en": "dus.gov.ua",
"uri": "http://www.dus.gov.ua/"
},
"address": {
"streetAddress": "вул. Банкова, 11, корпус 1",
"locality": "м. Київ",
"region": "м. Київ",
"postalCode": "01220",
"countryName": "Україна"
},
"contactPoint": {
"name": "Державне управління справами",
"name_en": "State administration",
"telephone": "+0440000000"
},
"scale": "micro"
}
],
"unitPrices": [
{
"relatedItem": "00662cb27141433b86593cedfcd4c3d9",
"value": {
"currency": "UAH",
"valueAddedTaxIncluded": true,
"amount": 14.93
}
}
],
"awardID": "f99be86681de4f368037738d6af12903",
"bidID": "78290ccc2a114830a97e8f2c510bacaf",
"date": "2023-10-10T01:00:00+03:00"
},
{
"id": "142288b4ac5447c088ae5c55bed1f9fc",
"status": "active",
"suppliers": [
{
"name": "Державне управління справами",
"name_en": "State administration",
"identifier": {
"scheme": "UA-EDR",
"id": "00037256",
"legalName_en": "dus.gov.ua",
"uri": "http://www.dus.gov.ua/"
},
"address": {
"streetAddress": "вул. Банкова, 11, корпус 1",
"locality": "м. Київ",
"region": "м. Київ",
"postalCode": "01220",
"countryName": "Україна"
},
"contactPoint": {
"name": "Державне управління справами",
"name_en": "State administration",
"telephone": "+0440000000"
},
"scale": "micro"
}
],
"unitPrices": [
{
"relatedItem": "00662cb27141433b86593cedfcd4c3d9",
"value": {
"currency": "UAH",
"valueAddedTaxIncluded": true,
"amount": 14.93
}
}
],
"awardID": "e5e6c374e9db46c2bf634056b03768db",
"bidID": "be6885d5a2ec4336a11ed73370239ed6",
"date": "2023-10-10T01:00:00+03:00"
},
{
"id": "bd325edc619c4f61b067e07529a08461",
"status": "active",
"suppliers": [
{
"name": "Державне управління справами",
"name_en": "State administration",
"identifier": {
"scheme": "UA-EDR",
"id": "00037256",
"legalName_en": "dus.gov.ua",
"uri": "http://www.dus.gov.ua/"
},
"address": {
"streetAddress": "вул. Банкова, 11, корпус 1",
"locality": "м. Київ",
"region": "м. Київ",
"postalCode": "01220",
"countryName": "Україна"
},
"contactPoint": {
"name": "Державне управління справами",
"name_en": "State administration",
"telephone": "+0440000000"
},
"scale": "micro"
}
],
"unitPrices": [
{
"relatedItem": "00662cb27141433b86593cedfcd4c3d9",
"value": {
"currency": "UAH",
"valueAddedTaxIncluded": true,
"amount": 14.93
}
}
],
"awardID": "ea7c848eefbb4037a273456dd333ce1a",
"bidID": "593a5fc959d64463b40f460fe47f30cb",
"date": "2023-10-10T01:00:00+03:00"
}
],
"items": [
{
"id": "00662cb27141433b86593cedfcd4c3d9",
"description": "футляри до державних нагород",
"quantity": 5.0,
"relatedLot": "04651361e47848abb6eda21e59c8b4a1",
"classification": {
"description": "Cartons",
"scheme": "ДК021",
"id": "44617100-9"
},
"additionalClassifications": [
{
"scheme": "ДКПП",
"id": "17.21.1",
"description": "папір і картон гофровані, паперова й картонна тара"
}
],
"description_en": "Cases for state awards",
"deliveryDate": {
"startDate": "2018-06-27T13:39:09.362837+03:00",
"endDate": "2018-06-30T13:39:09.362837+03:00"
},
"deliveryAddress": {
"streetAddress": "вул. Банкова 1",
"locality": "м. Київ",
"region": "м. Київ",
"postalCode": "79000",
"countryName": "Україна"
},
"unit": {
"name": "item",
"code": "KGM"
}
}
],
"procuringEntity": {
"name": "Державне управління справами",
"name_en": "State administration",
"identifier": {
"scheme": "UA-EDR",
"id": "00037256",
"legalName_en": "dus.gov.ua",
"uri": "http://www.dus.gov.ua/"
},
"kind": "general",
"contactPoint": {
"name": "Державне управління справами",
"name_en": "State administration",
"telephone": "+0440000000",
"availableLanguage": "uk"
},
"address": {
"streetAddress": "вул. Банкова, 11, корпус 1",
"locality": "м. Київ",
"region": "м. Київ",
"postalCode": "01220",
"countryName": "Україна"
}
},
"tender_id": "bcc35be92ed24536a5af9ede5e2de5e0",
"numberOfContracts": 3,
"dateModified": "2023-10-10T01:00:00+03:00",
"changes": [
{
"id": "4f32972b3cfd4f248814b2a88e8e21d6",
"status": "pending",
"date": "2023-10-10T01:00:00+03:00",
"rationale": "Друга і третя поставка має бути розфасована",
"rationale_en": "Agreement change cause",
"rationaleType": "taxRate",
"modifications": [
{
"itemId": "00662cb27141433b86593cedfcd4c3d9",
"factor": 0.1605
}
]
}
],
"documents": [
{
"relatedItem": "4f32972b3cfd4f248814b2a88e8e21d6",
"id": "59daf3cfcf9c441281a2a215d44bfb65",
"datePublished": "2023-10-10T01:00:00+03:00",
"hash": "md5:00000000000000000000000000000000",
"title": "agreement_changes.doc",
"format": "application/msword",
"url": "http://public-docs-sandbox.prozorro.gov.ua/get/6c343bcdd7d241068f88138036b4e52a?Signature=cU7WXirw65OUUhuS5lZDppSTLBBAEOZ6GMLIefKy1mqh5Qe9B9T8b%2B%2BfoucGKMRZRL2%2FSJeoZWpypUlbWdU5DA%3D%3D&KeyID=a8968c46",
"dateModified": "2023-10-10T01:00:00+03:00",
"language": "uk",
"documentOf": "change"
}
],
"id": "b7536ab0fbe34a1dafa73fe7943ff79c"
}
}
As you can see, value.amount on contracts unitPrices are changed due modification is applied. So if this modification is what you need, you can apply change.
Applying the change
Change can be applied by switching to the active status.
In order to apply active status dateSigned field must be set.
After this change can’t be modified anymore.
Request
PATCH /api/2.5/agreements/b7536ab0fbe34a1dafa73fe7943ff79c/changes/4f32972b3cfd4f248814b2a88e8e21d6?acc_token=9870067ea6e64d14adf4016d24d15f0c HTTP/1.0
Authorization: Bearer broker
Content-Type: application/json
Host: lb-api-sandbox.prozorro.gov.ua
{
"data": {
"status": "active",
"dateSigned": "2023-10-10T01:00:00+03:00"
}
}
Response
HTTP/1.0 200 OK
Content-Type: application/json
{
"data": {
"id": "4f32972b3cfd4f248814b2a88e8e21d6",
"status": "active",
"date": "2023-10-10T01:00:00+03:00",
"rationale": "Друга і третя поставка має бути розфасована",
"rationale_en": "Agreement change cause",
"dateSigned": "2023-10-10T01:00:00+03:00",
"rationaleType": "taxRate",
"modifications": [
{
"itemId": "00662cb27141433b86593cedfcd4c3d9",
"factor": 0.1605
}
]
}
}
dateSigned field validation:
for the first agreement change date should be after agreement.dateSigned;
for all next change objects date should be after the previous change.dateSigned.
You can view all changes:
Request
GET /api/2.5/agreements/b7536ab0fbe34a1dafa73fe7943ff79c/changes HTTP/1.0
Authorization: Bearer broker
Host: public-api-sandbox.prozorro.gov.ua
Response
HTTP/1.0 200 OK
Content-Type: application/json
{
"data": [
{
"id": "4f32972b3cfd4f248814b2a88e8e21d6",
"status": "active",
"date": "2023-10-10T01:00:00+03:00",
"rationale": "Друга і третя поставка має бути розфасована",
"rationale_en": "Agreement change cause",
"dateSigned": "2023-10-10T01:00:00+03:00",
"rationaleType": "taxRate",
"modifications": [
{
"itemId": "00662cb27141433b86593cedfcd4c3d9",
"factor": 0.1605
}
]
}
]
}
All changes are also listed on the agreement view.
Request
GET /api/2.5/agreements/b7536ab0fbe34a1dafa73fe7943ff79c HTTP/1.0
Authorization: Bearer broker
Host: public-api-sandbox.prozorro.gov.ua
Response
HTTP/1.0 200 OK
Content-Type: application/json
{
"data": {
"agreementID": "UA-2023-10-10-000001-a-e75ece1cddb64807825e058d729510f61",
"status": "active",
"owner": "broker",
"contracts": [
{
"id": "3f790a2fc7c647a7be968a10e669e9fa",
"status": "active",
"suppliers": [
{
"name": "Державне управління справами",
"name_en": "State administration",
"identifier": {
"scheme": "UA-EDR",
"id": "00037256",
"legalName_en": "dus.gov.ua",
"uri": "http://www.dus.gov.ua/"
},
"address": {
"streetAddress": "вул. Банкова, 11, корпус 1",
"locality": "м. Київ",
"region": "м. Київ",
"postalCode": "01220",
"countryName": "Україна"
},
"contactPoint": {
"name": "Державне управління справами",
"name_en": "State administration",
"telephone": "+0440000000"
},
"scale": "micro"
}
],
"unitPrices": [
{
"relatedItem": "00662cb27141433b86593cedfcd4c3d9",
"value": {
"currency": "UAH",
"valueAddedTaxIncluded": true,
"amount": 14.93
}
}
],
"awardID": "f99be86681de4f368037738d6af12903",
"bidID": "78290ccc2a114830a97e8f2c510bacaf",
"date": "2023-10-10T01:00:00+03:00"
},
{
"id": "142288b4ac5447c088ae5c55bed1f9fc",
"status": "active",
"suppliers": [
{
"name": "Державне управління справами",
"name_en": "State administration",
"identifier": {
"scheme": "UA-EDR",
"id": "00037256",
"legalName_en": "dus.gov.ua",
"uri": "http://www.dus.gov.ua/"
},
"address": {
"streetAddress": "вул. Банкова, 11, корпус 1",
"locality": "м. Київ",
"region": "м. Київ",
"postalCode": "01220",
"countryName": "Україна"
},
"contactPoint": {
"name": "Державне управління справами",
"name_en": "State administration",
"telephone": "+0440000000"
},
"scale": "micro"
}
],
"unitPrices": [
{
"relatedItem": "00662cb27141433b86593cedfcd4c3d9",
"value": {
"currency": "UAH",
"valueAddedTaxIncluded": true,
"amount": 14.93
}
}
],
"awardID": "e5e6c374e9db46c2bf634056b03768db",
"bidID": "be6885d5a2ec4336a11ed73370239ed6",
"date": "2023-10-10T01:00:00+03:00"
},
{
"id": "bd325edc619c4f61b067e07529a08461",
"status": "active",
"suppliers": [
{
"name": "Державне управління справами",
"name_en": "State administration",
"identifier": {
"scheme": "UA-EDR",
"id": "00037256",
"legalName_en": "dus.gov.ua",
"uri": "http://www.dus.gov.ua/"
},
"address": {
"streetAddress": "вул. Банкова, 11, корпус 1",
"locality": "м. Київ",
"region": "м. Київ",
"postalCode": "01220",
"countryName": "Україна"
},
"contactPoint": {
"name": "Державне управління справами",
"name_en": "State administration",
"telephone": "+0440000000"
},
"scale": "micro"
}
],
"unitPrices": [
{
"relatedItem": "00662cb27141433b86593cedfcd4c3d9",
"value": {
"currency": "UAH",
"valueAddedTaxIncluded": true,
"amount": 14.93
}
}
],
"awardID": "ea7c848eefbb4037a273456dd333ce1a",
"bidID": "593a5fc959d64463b40f460fe47f30cb",
"date": "2023-10-10T01:00:00+03:00"
}
],
"items": [
{
"id": "00662cb27141433b86593cedfcd4c3d9",
"description": "футляри до державних нагород",
"quantity": 5.0,
"relatedLot": "04651361e47848abb6eda21e59c8b4a1",
"classification": {
"description": "Cartons",
"scheme": "ДК021",
"id": "44617100-9"
},
"additionalClassifications": [
{
"scheme": "ДКПП",
"id": "17.21.1",
"description": "папір і картон гофровані, паперова й картонна тара"
}
],
"description_en": "Cases for state awards",
"deliveryDate": {
"startDate": "2018-06-27T13:39:09.362837+03:00",
"endDate": "2018-06-30T13:39:09.362837+03:00"
},
"deliveryAddress": {
"streetAddress": "вул. Банкова 1",
"locality": "м. Київ",
"region": "м. Київ",
"postalCode": "79000",
"countryName": "Україна"
},
"unit": {
"name": "item",
"code": "KGM"
}
}
],
"procuringEntity": {
"name": "Державне управління справами",
"name_en": "State administration",
"identifier": {
"scheme": "UA-EDR",
"id": "00037256",
"legalName_en": "dus.gov.ua",
"uri": "http://www.dus.gov.ua/"
},
"kind": "general",
"contactPoint": {
"name": "Державне управління справами",
"name_en": "State administration",
"telephone": "+0440000000",
"availableLanguage": "uk"
},
"address": {
"streetAddress": "вул. Банкова, 11, корпус 1",
"locality": "м. Київ",
"region": "м. Київ",
"postalCode": "01220",
"countryName": "Україна"
}
},
"tender_id": "bcc35be92ed24536a5af9ede5e2de5e0",
"numberOfContracts": 3,
"dateModified": "2023-10-10T01:00:00+03:00",
"changes": [
{
"id": "4f32972b3cfd4f248814b2a88e8e21d6",
"status": "active",
"date": "2023-10-10T01:00:00+03:00",
"rationale": "Друга і третя поставка має бути розфасована",
"rationale_en": "Agreement change cause",
"dateSigned": "2023-10-10T01:00:00+03:00",
"rationaleType": "taxRate",
"modifications": [
{
"itemId": "00662cb27141433b86593cedfcd4c3d9",
"factor": 0.1605
}
]
}
],
"documents": [
{
"relatedItem": "4f32972b3cfd4f248814b2a88e8e21d6",
"id": "59daf3cfcf9c441281a2a215d44bfb65",
"datePublished": "2023-10-10T01:00:00+03:00",
"hash": "md5:00000000000000000000000000000000",
"title": "agreement_changes.doc",
"format": "application/msword",
"url": "http://public-docs-sandbox.prozorro.gov.ua/get/6c343bcdd7d241068f88138036b4e52a?Signature=cU7WXirw65OUUhuS5lZDppSTLBBAEOZ6GMLIefKy1mqh5Qe9B9T8b%2B%2BfoucGKMRZRL2%2FSJeoZWpypUlbWdU5DA%3D%3D&KeyID=a8968c46",
"dateModified": "2023-10-10T01:00:00+03:00",
"language": "uk",
"documentOf": "change"
}
],
"id": "b7536ab0fbe34a1dafa73fe7943ff79c"
},
"config": {
"restricted": false
}
}
Uploading documentation
Procuring entity can upload PDF files into the created agreement. Uploading should follow the upload rules.
Request
POST /api/2.5/agreements/b7536ab0fbe34a1dafa73fe7943ff79c/documents?acc_token=9870067ea6e64d14adf4016d24d15f0c HTTP/1.0
Authorization: Bearer broker
Content-Type: application/json
Host: lb-api-sandbox.prozorro.gov.ua
{
"data": {
"title": "agreement.doc",
"url": "http://public-docs-sandbox.prozorro.gov.ua/get/11eb2dec3c4941aaa20b9f9f3242da8a?Signature=v%2FqOQ3a%2F1XjZ5CNeWW9svvq7xZB97hdeUhbVCLijO8pQrmyesxDtxrSGFlx2zFRx%2FOGSobWlAboCFcODDivODQ%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/agreements/b7536ab0fbe34a1dafa73fe7943ff79c/documents/34286f7d023a4c1abd83c3bcece2707f
{
"data": {
"hash": "md5:00000000000000000000000000000000",
"title": "agreement.doc",
"format": "application/msword",
"url": "http://public-docs-sandbox.prozorro.gov.ua/get/11eb2dec3c4941aaa20b9f9f3242da8a?Signature=aSUaH4aKyvvHHNyDgX%2BUS92rE%2Fpy8aEUBTNaribYkkc5XyYX4awtgUD8TuwG0XeiLc87akD36sgPaPE32NZnCg%3D%3D&KeyID=a8968c46",
"language": "uk",
"documentOf": "agreement",
"id": "34286f7d023a4c1abd83c3bcece2707f",
"datePublished": "2023-10-10T01:00:00+03:00",
"dateModified": "2023-10-10T01:00:00+03:00"
}
}
201 Created response code and Location header confirm document creation. We can additionally query the documents collection API endpoint to confirm the action:
Request
GET /api/2.5/agreements/b7536ab0fbe34a1dafa73fe7943ff79c/documents?acc_token=9870067ea6e64d14adf4016d24d15f0c HTTP/1.0
Authorization: Bearer broker
Host: public-api-sandbox.prozorro.gov.ua
Response
HTTP/1.0 200 OK
Content-Type: application/json
{
"data": [
{
"relatedItem": "4f32972b3cfd4f248814b2a88e8e21d6",
"id": "59daf3cfcf9c441281a2a215d44bfb65",
"datePublished": "2023-10-10T01:00:00+03:00",
"hash": "md5:00000000000000000000000000000000",
"title": "agreement_changes.doc",
"format": "application/msword",
"url": "http://public-docs-sandbox.prozorro.gov.ua/get/6c343bcdd7d241068f88138036b4e52a?Signature=cU7WXirw65OUUhuS5lZDppSTLBBAEOZ6GMLIefKy1mqh5Qe9B9T8b%2B%2BfoucGKMRZRL2%2FSJeoZWpypUlbWdU5DA%3D%3D&KeyID=a8968c46",
"dateModified": "2023-10-10T01:00:00+03:00",
"language": "uk",
"documentOf": "change"
},
{
"hash": "md5:00000000000000000000000000000000",
"title": "agreement.doc",
"format": "application/msword",
"url": "http://public-docs-sandbox.prozorro.gov.ua/get/11eb2dec3c4941aaa20b9f9f3242da8a?Signature=aSUaH4aKyvvHHNyDgX%2BUS92rE%2Fpy8aEUBTNaribYkkc5XyYX4awtgUD8TuwG0XeiLc87akD36sgPaPE32NZnCg%3D%3D&KeyID=a8968c46",
"language": "uk",
"documentOf": "agreement",
"id": "34286f7d023a4c1abd83c3bcece2707f",
"datePublished": "2023-10-10T01:00:00+03:00",
"dateModified": "2023-10-10T01:00:00+03:00"
}
]
}
And again we can confirm that there are two documents uploaded.
Request
POST /api/2.5/agreements/b7536ab0fbe34a1dafa73fe7943ff79c/documents?acc_token=9870067ea6e64d14adf4016d24d15f0c HTTP/1.0
Authorization: Bearer broker
Content-Type: application/json
Host: lb-api-sandbox.prozorro.gov.ua
{
"data": {
"title": "agreement_additional_docs.doc",
"url": "http://public-docs-sandbox.prozorro.gov.ua/get/a8c422f0d19e454891bd6c7bf538cb56?Signature=mgZfr05rkCOhapXVu43Ab%2FvwznTQy%2BHE9NpHorxn3kPP75z%2BXUxnBZ41TOBtDM7R0rfVQvQgffcNimBtiOFYCQ%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/agreements/b7536ab0fbe34a1dafa73fe7943ff79c/documents/eb5d4132ab284c208e47dd012b0f2a6b
{
"data": {
"hash": "md5:00000000000000000000000000000000",
"title": "agreement_additional_docs.doc",
"format": "application/msword",
"url": "http://public-docs-sandbox.prozorro.gov.ua/get/a8c422f0d19e454891bd6c7bf538cb56?Signature=l7XDy0xp10QmGZTwdWpN%2F6T9NyfWuvV91%2BX3fhdtEcWlsj8IjuQ%2Fqj%2B7VWPN1RM8BWhUmb7jktjc6gXIHgRwBQ%3D%3D&KeyID=a8968c46",
"language": "uk",
"documentOf": "agreement",
"id": "eb5d4132ab284c208e47dd012b0f2a6b",
"datePublished": "2023-10-10T01:00:00+03:00",
"dateModified": "2023-10-10T01:00:00+03:00"
}
}
In case we made an error, we can reupload the document over the older version:
Request
PUT /api/2.5/agreements/b7536ab0fbe34a1dafa73fe7943ff79c/documents/eb5d4132ab284c208e47dd012b0f2a6b?acc_token=9870067ea6e64d14adf4016d24d15f0c HTTP/1.0
Authorization: Bearer broker
Content-Type: application/json
Host: lb-api-sandbox.prozorro.gov.ua
{
"data": {
"title": "agreement_additional_docs.doc",
"url": "http://public-docs-sandbox.prozorro.gov.ua/get/d41141b923574f31b55bb728076744c5?Signature=gf5g0y6A72zdzKKXSO3rs%2Fi909in90TfVvF5zGhqniVYi9L2enwWu%2B4qmhLAmCI7SnEqXDH%2BlYSHxxcq7sj0BA%3D%3D&KeyID=a8968c46",
"hash": "md5:00000000000000000000000000000000",
"format": "application/msword"
}
}
Response
HTTP/1.0 200 OK
Content-Type: application/json
{
"data": {
"id": "eb5d4132ab284c208e47dd012b0f2a6b",
"datePublished": "2023-10-10T01:00:00+03:00",
"hash": "md5:00000000000000000000000000000000",
"title": "agreement_additional_docs.doc",
"format": "application/msword",
"url": "http://public-docs-sandbox.prozorro.gov.ua/get/d41141b923574f31b55bb728076744c5?Signature=mka6smLvqizbQTfO5zttaBl0L1iNsnfonJHjBmAaWOqflP%2FdQtzy6LFcx6uujeC5rElua6Cf1pLu5BfrQkWWCA%3D%3D&KeyID=a8968c46",
"dateModified": "2023-10-10T01:00:00+03:00",
"language": "uk",
"documentOf": "agreement"
}
}
And we can see that it is overriding the original version:
Request
GET /api/2.5/agreements/b7536ab0fbe34a1dafa73fe7943ff79c/documents/eb5d4132ab284c208e47dd012b0f2a6b?acc_token=9870067ea6e64d14adf4016d24d15f0c HTTP/1.0
Authorization: Bearer broker
Host: public-api-sandbox.prozorro.gov.ua
Response
HTTP/1.0 200 OK
Content-Type: application/json
{
"data": {
"id": "eb5d4132ab284c208e47dd012b0f2a6b",
"datePublished": "2023-10-10T01:00:00+03:00",
"hash": "md5:00000000000000000000000000000000",
"title": "agreement_additional_docs.doc",
"format": "application/msword",
"url": "http://public-docs-sandbox.prozorro.gov.ua/get/d41141b923574f31b55bb728076744c5?Signature=mka6smLvqizbQTfO5zttaBl0L1iNsnfonJHjBmAaWOqflP%2FdQtzy6LFcx6uujeC5rElua6Cf1pLu5BfrQkWWCA%3D%3D&KeyID=a8968c46",
"dateModified": "2023-10-10T01:00:00+03:00",
"language": "uk",
"documentOf": "agreement",
"previousVersions": [
{
"hash": "md5:00000000000000000000000000000000",
"title": "agreement_additional_docs.doc",
"format": "application/msword",
"url": "http://public-docs-sandbox.prozorro.gov.ua/get/a8c422f0d19e454891bd6c7bf538cb56?Signature=l7XDy0xp10QmGZTwdWpN%2F6T9NyfWuvV91%2BX3fhdtEcWlsj8IjuQ%2Fqj%2B7VWPN1RM8BWhUmb7jktjc6gXIHgRwBQ%3D%3D&KeyID=a8968c46",
"language": "uk",
"documentOf": "agreement",
"id": "eb5d4132ab284c208e47dd012b0f2a6b",
"datePublished": "2023-10-10T01:00:00+03:00",
"dateModified": "2023-10-10T01:00:00+03:00"
}
]
}
}
Completing agreement
Agreement can be completed by switching to terminated status.
Let’s perform these actions in single request:
Request
PATCH /api/2.5/agreements/b7536ab0fbe34a1dafa73fe7943ff79c?acc_token=9870067ea6e64d14adf4016d24d15f0c HTTP/1.0
Authorization: Bearer broker
Content-Type: application/json
Host: lb-api-sandbox.prozorro.gov.ua
{
"data": {
"status": "terminated"
}
}
Response
HTTP/1.0 200 OK
Content-Type: application/json
{
"data": {
"agreementID": "UA-2023-10-10-000001-a-e75ece1cddb64807825e058d729510f61",
"status": "terminated",
"dateModified": "2023-10-10T01:00:00+03:00",
"owner": "broker",
"changes": [
{
"id": "4f32972b3cfd4f248814b2a88e8e21d6",
"status": "active",
"date": "2023-10-10T01:00:00+03:00",
"rationale": "Друга і третя поставка має бути розфасована",
"rationale_en": "Agreement change cause",
"dateSigned": "2023-10-10T01:00:00+03:00",
"rationaleType": "taxRate",
"modifications": [
{
"itemId": "00662cb27141433b86593cedfcd4c3d9",
"factor": 0.1605
}
]
}
],
"documents": [
{
"relatedItem": "4f32972b3cfd4f248814b2a88e8e21d6",
"id": "59daf3cfcf9c441281a2a215d44bfb65",
"datePublished": "2023-10-10T01:00:00+03:00",
"hash": "md5:00000000000000000000000000000000",
"title": "agreement_changes.doc",
"format": "application/msword",
"url": "http://public-docs-sandbox.prozorro.gov.ua/get/6c343bcdd7d241068f88138036b4e52a?Signature=cU7WXirw65OUUhuS5lZDppSTLBBAEOZ6GMLIefKy1mqh5Qe9B9T8b%2B%2BfoucGKMRZRL2%2FSJeoZWpypUlbWdU5DA%3D%3D&KeyID=a8968c46",
"dateModified": "2023-10-10T01:00:00+03:00",
"language": "uk",
"documentOf": "change"
},
{
"id": "34286f7d023a4c1abd83c3bcece2707f",
"datePublished": "2023-10-10T01:00:00+03:00",
"hash": "md5:00000000000000000000000000000000",
"title": "agreement.doc",
"format": "application/msword",
"url": "http://public-docs-sandbox.prozorro.gov.ua/get/11eb2dec3c4941aaa20b9f9f3242da8a?Signature=aSUaH4aKyvvHHNyDgX%2BUS92rE%2Fpy8aEUBTNaribYkkc5XyYX4awtgUD8TuwG0XeiLc87akD36sgPaPE32NZnCg%3D%3D&KeyID=a8968c46",
"dateModified": "2023-10-10T01:00:00+03:00",
"language": "uk",
"documentOf": "agreement"
},
{
"id": "eb5d4132ab284c208e47dd012b0f2a6b",
"datePublished": "2023-10-10T01:00:00+03:00",
"hash": "md5:00000000000000000000000000000000",
"title": "agreement_additional_docs.doc",
"format": "application/msword",
"url": "http://public-docs-sandbox.prozorro.gov.ua/get/a8c422f0d19e454891bd6c7bf538cb56?Signature=l7XDy0xp10QmGZTwdWpN%2F6T9NyfWuvV91%2BX3fhdtEcWlsj8IjuQ%2Fqj%2B7VWPN1RM8BWhUmb7jktjc6gXIHgRwBQ%3D%3D&KeyID=a8968c46",
"dateModified": "2023-10-10T01:00:00+03:00",
"language": "uk",
"documentOf": "agreement"
},
{
"id": "eb5d4132ab284c208e47dd012b0f2a6b",
"datePublished": "2023-10-10T01:00:00+03:00",
"hash": "md5:00000000000000000000000000000000",
"title": "agreement_additional_docs.doc",
"format": "application/msword",
"url": "http://public-docs-sandbox.prozorro.gov.ua/get/d41141b923574f31b55bb728076744c5?Signature=mka6smLvqizbQTfO5zttaBl0L1iNsnfonJHjBmAaWOqflP%2FdQtzy6LFcx6uujeC5rElua6Cf1pLu5BfrQkWWCA%3D%3D&KeyID=a8968c46",
"dateModified": "2023-10-10T01:00:00+03:00",
"language": "uk",
"documentOf": "agreement"
}
],
"contracts": [
{
"id": "3f790a2fc7c647a7be968a10e669e9fa",
"status": "active",
"suppliers": [
{
"name": "Державне управління справами",
"name_en": "State administration",
"identifier": {
"scheme": "UA-EDR",
"id": "00037256",
"legalName_en": "dus.gov.ua",
"uri": "http://www.dus.gov.ua/"
},
"address": {
"streetAddress": "вул. Банкова, 11, корпус 1",
"locality": "м. Київ",
"region": "м. Київ",
"postalCode": "01220",
"countryName": "Україна"
},
"contactPoint": {
"name": "Державне управління справами",
"name_en": "State administration",
"telephone": "+0440000000"
},
"scale": "micro"
}
],
"unitPrices": [
{
"relatedItem": "00662cb27141433b86593cedfcd4c3d9",
"value": {
"currency": "UAH",
"valueAddedTaxIncluded": true,
"amount": 14.93
}
}
],
"awardID": "f99be86681de4f368037738d6af12903",
"bidID": "78290ccc2a114830a97e8f2c510bacaf",
"date": "2023-10-10T01:00:00+03:00"
},
{
"id": "142288b4ac5447c088ae5c55bed1f9fc",
"status": "active",
"suppliers": [
{
"name": "Державне управління справами",
"name_en": "State administration",
"identifier": {
"scheme": "UA-EDR",
"id": "00037256",
"legalName_en": "dus.gov.ua",
"uri": "http://www.dus.gov.ua/"
},
"address": {
"streetAddress": "вул. Банкова, 11, корпус 1",
"locality": "м. Київ",
"region": "м. Київ",
"postalCode": "01220",
"countryName": "Україна"
},
"contactPoint": {
"name": "Державне управління справами",
"name_en": "State administration",
"telephone": "+0440000000"
},
"scale": "micro"
}
],
"unitPrices": [
{
"relatedItem": "00662cb27141433b86593cedfcd4c3d9",
"value": {
"currency": "UAH",
"valueAddedTaxIncluded": true,
"amount": 14.93
}
}
],
"awardID": "e5e6c374e9db46c2bf634056b03768db",
"bidID": "be6885d5a2ec4336a11ed73370239ed6",
"date": "2023-10-10T01:00:00+03:00"
},
{
"id": "bd325edc619c4f61b067e07529a08461",
"status": "active",
"suppliers": [
{
"name": "Державне управління справами",
"name_en": "State administration",
"identifier": {
"scheme": "UA-EDR",
"id": "00037256",
"legalName_en": "dus.gov.ua",
"uri": "http://www.dus.gov.ua/"
},
"address": {
"streetAddress": "вул. Банкова, 11, корпус 1",
"locality": "м. Київ",
"region": "м. Київ",
"postalCode": "01220",
"countryName": "Україна"
},
"contactPoint": {
"name": "Державне управління справами",
"name_en": "State administration",
"telephone": "+0440000000"
},
"scale": "micro"
}
],
"unitPrices": [
{
"relatedItem": "00662cb27141433b86593cedfcd4c3d9",
"value": {
"currency": "UAH",
"valueAddedTaxIncluded": true,
"amount": 14.93
}
}
],
"awardID": "ea7c848eefbb4037a273456dd333ce1a",
"bidID": "593a5fc959d64463b40f460fe47f30cb",
"date": "2023-10-10T01:00:00+03:00"
}
],
"items": [
{
"id": "00662cb27141433b86593cedfcd4c3d9",
"description": "футляри до державних нагород",
"quantity": 5.0,
"relatedLot": "04651361e47848abb6eda21e59c8b4a1",
"classification": {
"description": "Cartons",
"scheme": "ДК021",
"id": "44617100-9"
},
"additionalClassifications": [
{
"scheme": "ДКПП",
"id": "17.21.1",
"description": "папір і картон гофровані, паперова й картонна тара"
}
],
"description_en": "Cases for state awards",
"deliveryDate": {
"startDate": "2018-06-27T13:39:09.362837+03:00",
"endDate": "2018-06-30T13:39:09.362837+03:00"
},
"deliveryAddress": {
"streetAddress": "вул. Банкова 1",
"locality": "м. Київ",
"region": "м. Київ",
"postalCode": "79000",
"countryName": "Україна"
},
"unit": {
"name": "item",
"code": "KGM"
}
}
],
"procuringEntity": {
"name": "Державне управління справами",
"name_en": "State administration",
"identifier": {
"scheme": "UA-EDR",
"id": "00037256",
"legalName_en": "dus.gov.ua",
"uri": "http://www.dus.gov.ua/"
},
"kind": "general",
"contactPoint": {
"name": "Державне управління справами",
"name_en": "State administration",
"telephone": "+0440000000",
"availableLanguage": "uk"
},
"address": {
"streetAddress": "вул. Банкова, 11, корпус 1",
"locality": "м. Київ",
"region": "м. Київ",
"postalCode": "01220",
"countryName": "Україна"
}
},
"tender_id": "bcc35be92ed24536a5af9ede5e2de5e0",
"numberOfContracts": 3,
"id": "b7536ab0fbe34a1dafa73fe7943ff79c"
},
"config": {
"restricted": false
}
}
If agreement is unsuccessful reasons for termination terminationDetails should be specified.
Any future modification to the agreement are not allowed.
It may be useful to see top requirements: Test Cases for III level of accreditation and Test Cases for IV level of accreditation.