Tutorial

Exploring basic rules

Let’s try exploring the /contracts endpoint:

Request

GET /api/2.5/contracts 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/contracts",
    "uri": "http://public-api-sandbox.prozorro.gov.ua/api/2.5/contracts"
  }
}

Just invoking it reveals an empty set.

Contract is transferred from the tender system by an automated process.

Creating contract

Let’s say that we have conducted tender and it has complete status. When the tender is completed, contract (that has been created in the tender system) is transferred to the contract system automatically.

Brokers (eMalls) can’t create contracts in the contract system.

Getting contract

Contract in the tender system

Request

GET /api/2.5/tenders/fb4ee4451adb48f981d1518851ee4007/contracts/b67af9433cdc413fb8a098088d0cef85 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": "b67af9433cdc413fb8a098088d0cef85",
    "awardID": "034e185d515f40a1a151c02cc3516157",
    "contractID": "UA-2023-01-01-000001-a-1",
    "status": "active",
    "value": {
      "amount": 500.0,
      "currency": "UAH",
      "valueAddedTaxIncluded": true,
      "amountNet": 490.0
    },
    "items": [
      {
        "id": "b08960c0f87b47a78ac6347d98e8af52",
        "description": "футляри до державних нагород",
        "classification": {
          "description": "Cartons",
          "scheme": "ДК021",
          "id": "44617100-9"
        },
        "additionalClassifications": [
          {
            "scheme": "ДКПП",
            "id": "17.21.1",
            "description": "папір і картон гофровані, паперова й картонна тара"
          }
        ],
        "unit": {
          "name": "кг",
          "value": {
            "amount": 6.0,
            "currency": "UAH",
            "valueAddedTaxIncluded": true
          },
          "code": "KGM"
        },
        "quantity": 5.0,
        "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": "1f7aeaf465fd44f393098f8363a5e059",
        "description": "футляри до державних нагород",
        "classification": {
          "description": "Cartons",
          "scheme": "ДК021",
          "id": "44617100-9"
        },
        "additionalClassifications": [
          {
            "scheme": "ДКПП",
            "id": "17.21.1",
            "description": "папір і картон гофровані, паперова й картонна тара"
          }
        ],
        "unit": {
          "name": "кг",
          "value": {
            "amount": 6.0,
            "currency": "UAH",
            "valueAddedTaxIncluded": true
          },
          "code": "KGM"
        },
        "quantity": 5.0,
        "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": {
          "telephone": "+0440000000",
          "name": "Державне управління справами"
        },
        "scale": "micro"
      }
    ],
    "date": "2023-01-01T00:00:01+02:00",
    "dateSigned": "2023-01-01T00:00:01+02:00"
  }
}

Contract id is the same in both tender and contract system.

Let’s access the URL of the created object:

Request

GET /api/2.5/contracts/b67af9433cdc413fb8a098088d0cef85 HTTP/1.0
Host: public-api-sandbox.prozorro.gov.ua

Response

HTTP/1.0 200 OK
Content-Type: application/json

{
  "data": {
    "awardID": "034e185d515f40a1a151c02cc3516157",
    "contractID": "UA-2023-01-01-000001-a-1",
    "status": "active",
    "value": {
      "amount": 500.0,
      "currency": "UAH",
      "valueAddedTaxIncluded": true,
      "amountNet": 490.0
    },
    "dateSigned": "2023-01-01T00:00:01+02:00",
    "items": [
      {
        "id": "b08960c0f87b47a78ac6347d98e8af52",
        "description": "футляри до державних нагород",
        "quantity": 5.0,
        "deliveryDate": {
          "startDate": "2023-01-03T00:00:00+02:00",
          "endDate": "2023-01-06T00:00:00+02:00"
        },
        "classification": {
          "description": "Cartons",
          "scheme": "ДК021",
          "id": "44617100-9"
        },
        "additionalClassifications": [
          {
            "scheme": "ДКПП",
            "id": "17.21.1",
            "description": "папір і картон гофровані, паперова й картонна тара"
          }
        ],
        "unit": {
          "name": "кг",
          "value": {
            "amount": 6.0,
            "currency": "UAH",
            "valueAddedTaxIncluded": true
          },
          "code": "KGM"
        },
        "deliveryAddress": {
          "streetAddress": "вул. Банкова 1",
          "locality": "м. Київ",
          "region": "м. Київ",
          "postalCode": "79000",
          "countryName": "Україна"
        }
      },
      {
        "id": "1f7aeaf465fd44f393098f8363a5e059",
        "description": "футляри до державних нагород",
        "quantity": 5.0,
        "deliveryDate": {
          "startDate": "2023-01-03T00:00:00+02:00",
          "endDate": "2023-01-06T00:00:00+02:00"
        },
        "classification": {
          "description": "Cartons",
          "scheme": "ДК021",
          "id": "44617100-9"
        },
        "additionalClassifications": [
          {
            "scheme": "ДКПП",
            "id": "17.21.1",
            "description": "папір і картон гофровані, паперова й картонна тара"
          }
        ],
        "unit": {
          "name": "кг",
          "value": {
            "amount": 6.0,
            "currency": "UAH",
            "valueAddedTaxIncluded": true
          },
          "code": "KGM"
        },
        "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": "Україна"
        },
        "scale": "micro",
        "contactPoint": {
          "name": "Державне управління справами",
          "telephone": "+0440000000"
        }
      }
    ],
    "procuringEntity": {
      "name": "Державне управління справами",
      "identifier": {
        "scheme": "UA-EDR",
        "id": "00037256",
        "legalName": "Державне управління справами",
        "uri": "http://www.dus.gov.ua/"
      },
      "address": {
        "streetAddress": "вул. Банкова, 11, корпус 1",
        "locality": "м. Київ",
        "region": "м. Київ",
        "postalCode": "01220",
        "countryName": "Україна"
      },
      "kind": "general",
      "contactPoint": {
        "name": "Державне управління справами",
        "telephone": "+0440000000"
      }
    },
    "owner": "broker",
    "tender_id": "fb4ee4451adb48f981d1518851ee4007",
    "dateCreated": "2023-01-01T00:00:01+02:00",
    "dateModified": "2023-01-01T00:00:01+02:00",
    "id": "b67af9433cdc413fb8a098088d0cef85"
  }
}

Getting access

In order to get rights for future contract editing, you need to use this view PATCH: /contracts/{id}/credentials?acc_token={tender_token} with the API key of the eMall (broker), where tender was generated.

In the PATCH: /contracts/{id}/credentials?acc_token={tender_token}:

• id stands for contract id,
• tender_token is tender’s token (is used for contract token generation).

Response will contain access.token for the contract that can be used for further contract modification.

Request

PATCH /api/2.5/contracts/b67af9433cdc413fb8a098088d0cef85/credentials?acc_token=6f5812701e2c4aa28ba1fb8e786e9910 HTTP/1.0
Authorization: Bearer broker
Content-Length: 0
Content-Type: application/json
Host: lb-api-sandbox.prozorro.gov.ua

Response

HTTP/1.0 200 OK
Content-Type: application/json

{
  "data": {
    "awardID": "034e185d515f40a1a151c02cc3516157",
    "contractID": "UA-2023-01-01-000001-a-1",
    "status": "active",
    "value": {
      "amount": 500.0,
      "currency": "UAH",
      "valueAddedTaxIncluded": true,
      "amountNet": 490.0
    },
    "dateSigned": "2023-01-01T00:00:01+02:00",
    "items": [
      {
        "id": "b08960c0f87b47a78ac6347d98e8af52",
        "description": "футляри до державних нагород",
        "quantity": 5.0,
        "deliveryDate": {
          "startDate": "2023-01-03T00:00:00+02:00",
          "endDate": "2023-01-06T00:00:00+02:00"
        },
        "classification": {
          "description": "Cartons",
          "scheme": "ДК021",
          "id": "44617100-9"
        },
        "additionalClassifications": [
          {
            "scheme": "ДКПП",
            "id": "17.21.1",
            "description": "папір і картон гофровані, паперова й картонна тара"
          }
        ],
        "unit": {
          "name": "кг",
          "value": {
            "amount": 6.0,
            "currency": "UAH",
            "valueAddedTaxIncluded": true
          },
          "code": "KGM"
        },
        "deliveryAddress": {
          "streetAddress": "вул. Банкова 1",
          "locality": "м. Київ",
          "region": "м. Київ",
          "postalCode": "79000",
          "countryName": "Україна"
        }
      },
      {
        "id": "1f7aeaf465fd44f393098f8363a5e059",
        "description": "футляри до державних нагород",
        "quantity": 5.0,
        "deliveryDate": {
          "startDate": "2023-01-03T00:00:00+02:00",
          "endDate": "2023-01-06T00:00:00+02:00"
        },
        "classification": {
          "description": "Cartons",
          "scheme": "ДК021",
          "id": "44617100-9"
        },
        "additionalClassifications": [
          {
            "scheme": "ДКПП",
            "id": "17.21.1",
            "description": "папір і картон гофровані, паперова й картонна тара"
          }
        ],
        "unit": {
          "name": "кг",
          "value": {
            "amount": 6.0,
            "currency": "UAH",
            "valueAddedTaxIncluded": true
          },
          "code": "KGM"
        },
        "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": "Україна"
        },
        "scale": "micro",
        "contactPoint": {
          "name": "Державне управління справами",
          "telephone": "+0440000000"
        }
      }
    ],
    "procuringEntity": {
      "name": "Державне управління справами",
      "identifier": {
        "scheme": "UA-EDR",
        "id": "00037256",
        "legalName": "Державне управління справами",
        "uri": "http://www.dus.gov.ua/"
      },
      "address": {
        "streetAddress": "вул. Банкова, 11, корпус 1",
        "locality": "м. Київ",
        "region": "м. Київ",
        "postalCode": "01220",
        "countryName": "Україна"
      },
      "kind": "general",
      "contactPoint": {
        "name": "Державне управління справами",
        "telephone": "+0440000000"
      }
    },
    "owner": "broker",
    "tender_id": "fb4ee4451adb48f981d1518851ee4007",
    "dateCreated": "2023-01-01T00:00:01+02:00",
    "dateModified": "2023-01-01T00:00:01+02:00",
    "id": "b67af9433cdc413fb8a098088d0cef85"
  },
  "access": {
    "token": "e2cad9981b614b92a8262ec3ab0b7755",
    "transfer": "ea1093015e174f08bd1032f002c60484"
  }
}

Let’s view contracts.

Request

GET /api/2.5/contracts 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-01-01T00:00:01+02:00",
      "id": "b67af9433cdc413fb8a098088d0cef85"
    }
  ],
  "next_page": {
    "offset": 1672524001.0,
    "path": "/api/2.5/contracts?offset=1672524001.0",
    "uri": "http://public-api-sandbox.prozorro.gov.ua/api/2.5/contracts?offset=1672524001.0"
  }
}

We do see the internal id of a contract (that can be used to construct full URL by prepending http://api-sandbox.openprocurement.org/api/0/contracts/) and its dateModified datestamp.

Modifying contract

You can make changes to the contract in cases described in the 4th part of Article 36 of the Law “On the Public Procurement”.

Essential contract terms can be modified by the submission of a new Change object to the Contract.changes container.

All changes are processed by the endpoint /contracts/{id}/changes.

Submitting a change

Let’s add new change to the contract:

Request

POST /api/2.5/contracts/b67af9433cdc413fb8a098088d0cef85/changes?acc_token=e2cad9981b614b92a8262ec3ab0b7755 HTTP/1.0
Authorization: Bearer broker
Content-Length: 267
Content-Type: application/json
Host: lb-api-sandbox.prozorro.gov.ua

{
  "data": {
    "rationale": "Опис причини змін контракту",
    "rationale_en": "Contract change cause",
    "rationaleTypes": [
      "volumeCuts",
      "priceReduction"
    ]
  }
}

Response

HTTP/1.0 201 Created
Content-Type: application/json

{
  "data": {
    "rationale": "Опис причини змін контракту",
    "rationale_en": "Contract change cause",
    "rationaleTypes": [
      "volumeCuts",
      "priceReduction"
    ],
    "id": "d1ce56999c404806932bd89a9966a020",
    "status": "pending",
    "date": "2023-01-01T00:00:01+02:00"
  }
}

Note that you can provide more than one value in rationaleTypes field.

You can view the change:

Request

GET /api/2.5/contracts/b67af9433cdc413fb8a098088d0cef85/changes/d1ce56999c404806932bd89a9966a020 HTTP/1.0
Authorization: Bearer broker
Host: public-api-sandbox.prozorro.gov.ua

Response

HTTP/1.0 200 OK
Content-Type: application/json

{
  "data": {
    "rationale": "Опис причини змін контракту",
    "rationale_en": "Contract change cause",
    "rationaleTypes": [
      "volumeCuts",
      "priceReduction"
    ],
    "id": "d1ce56999c404806932bd89a9966a020",
    "status": "pending",
    "date": "2023-01-01T00:00:01+02:00"
  }
}

Change can be modified while it is in the pending status:

Request

PATCH /api/2.5/contracts/b67af9433cdc413fb8a098088d0cef85/changes/d1ce56999c404806932bd89a9966a020?acc_token=e2cad9981b614b92a8262ec3ab0b7755 HTTP/1.0
Authorization: Bearer broker
Content-Length: 255
Content-Type: application/json
Host: lb-api-sandbox.prozorro.gov.ua

{
  "data": {
    "rationale": "Друга і третя поставка має бути розфасована"
  }
}

Response

HTTP/1.0 200 OK
Content-Type: application/json

{
  "data": {
    "rationale": "Друга і третя поставка має бути розфасована",
    "rationale_en": "Contract change cause",
    "rationaleTypes": [
      "volumeCuts",
      "priceReduction"
    ],
    "id": "d1ce56999c404806932bd89a9966a020",
    "status": "pending",
    "date": "2023-01-01T00:00:01+02:00"
  }
}

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/contracts/b67af9433cdc413fb8a098088d0cef85/documents?acc_token=e2cad9981b614b92a8262ec3ab0b7755 HTTP/1.0
Authorization: Bearer broker
Content-Length: 339
Content-Type: application/json
Host: lb-api-sandbox.prozorro.gov.ua

{
  "data": {
    "title": "contract_changes.doc",
    "url": "http://public-docs-sandbox.prozorro.gov.ua/get/f63818a2a95e4f2ab5e07260dfe16911?Signature=zs%2FqPiheOiDm1x6q43ctYZNYrwUm6reLF%2F09Ls5WtBbmnb4g%2B09oOdRoLAvJAPEUPlxqg%2FR87F4bF2GB5pQnCA%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/contracts/b67af9433cdc413fb8a098088d0cef85/documents/34379d8b0c6a4ef4a38489cd7e46af9b

{
  "data": {
    "hash": "md5:00000000000000000000000000000000",
    "title": "contract_changes.doc",
    "format": "application/msword",
    "url": "http://public-docs-sandbox.prozorro.gov.ua/get/f63818a2a95e4f2ab5e07260dfe16911?Signature=AIUP5kGnx%2BOdbPRF%2B0t6WebywkPEF8BHamAxW9BXr224HyI%2BSXYFxn6QzmhVRFlpv08gR6kyoyAjzLIo6xcVAA%3D%3D&KeyID=a8968c46",
    "documentOf": "contract",
    "id": "34379d8b0c6a4ef4a38489cd7e46af9b",
    "datePublished": "2023-01-01T00:00:01+02:00",
    "dateModified": "2023-01-01T00:00:01+02: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/contracts/b67af9433cdc413fb8a098088d0cef85/documents/34379d8b0c6a4ef4a38489cd7e46af9b?acc_token=e2cad9981b614b92a8262ec3ab0b7755 HTTP/1.0
Authorization: Bearer broker
Content-Length: 85
Content-Type: application/json
Host: lb-api-sandbox.prozorro.gov.ua

{
  "data": {
    "documentOf": "change",
    "relatedItem": "d1ce56999c404806932bd89a9966a020"
  }
}

Response

HTTP/1.0 200 OK
Content-Type: application/json

{
  "data": {
    "relatedItem": "d1ce56999c404806932bd89a9966a020",
    "id": "34379d8b0c6a4ef4a38489cd7e46af9b",
    "hash": "md5:00000000000000000000000000000000",
    "title": "contract_changes.doc",
    "format": "application/msword",
    "url": "http://public-docs-sandbox.prozorro.gov.ua/get/f63818a2a95e4f2ab5e07260dfe16911?Signature=AIUP5kGnx%2BOdbPRF%2B0t6WebywkPEF8BHamAxW9BXr224HyI%2BSXYFxn6QzmhVRFlpv08gR6kyoyAjzLIo6xcVAA%3D%3D&KeyID=a8968c46",
    "documentOf": "change",
    "datePublished": "2023-01-01T00:00:01+02:00",
    "dateModified": "2023-01-01T00:00:01+02:00"
  }
}

Updating contract properties

Now you can update contract properties which belong to the change.

You can update value amount and amountNet following next rules:

valueAddedTaxIncluded	Validation
true	Amount should be greater than amountNet and differ by no more than 20%
false	Amount and amountNet should be equal

Request

PATCH /api/2.5/contracts/b67af9433cdc413fb8a098088d0cef85?acc_token=e2cad9981b614b92a8262ec3ab0b7755 HTTP/1.0
Authorization: Bearer broker
Content-Length: 148
Content-Type: application/json
Host: lb-api-sandbox.prozorro.gov.ua

{
  "data": {
    "value": {
      "amount": 438,
      "amountNet": 430
    },
    "period": {
      "startDate": "2023-01-01T00:00:01+02:00",
      "endDate": "2023-01-31T00:00:01+02:00"
    }
  }
}

Response

HTTP/1.0 200 OK
Content-Type: application/json

{
  "data": {
    "awardID": "034e185d515f40a1a151c02cc3516157",
    "contractID": "UA-2023-01-01-000001-a-1",
    "period": {
      "startDate": "2023-01-01T00:00:01+02:00",
      "endDate": "2023-01-31T00:00:01+02:00"
    },
    "dateSigned": "2023-01-01T00:00:01+02:00",
    "dateModified": "2023-01-01T00:00:01+02:00",
    "dateCreated": "2023-01-01T00:00:01+02:00",
    "items": [
      {
        "id": "b08960c0f87b47a78ac6347d98e8af52",
        "description": "футляри до державних нагород",
        "quantity": 5.0,
        "deliveryDate": {
          "startDate": "2023-01-03T00:00:00+02:00",
          "endDate": "2023-01-06T00:00:00+02:00"
        },
        "classification": {
          "description": "Cartons",
          "scheme": "ДК021",
          "id": "44617100-9"
        },
        "additionalClassifications": [
          {
            "scheme": "ДКПП",
            "id": "17.21.1",
            "description": "папір і картон гофровані, паперова й картонна тара"
          }
        ],
        "unit": {
          "name": "кг",
          "value": {
            "amount": 6.0,
            "currency": "UAH",
            "valueAddedTaxIncluded": true
          },
          "code": "KGM"
        },
        "deliveryAddress": {
          "streetAddress": "вул. Банкова 1",
          "locality": "м. Київ",
          "region": "м. Київ",
          "postalCode": "79000",
          "countryName": "Україна"
        }
      },
      {
        "id": "1f7aeaf465fd44f393098f8363a5e059",
        "description": "футляри до державних нагород",
        "quantity": 5.0,
        "deliveryDate": {
          "startDate": "2023-01-03T00:00:00+02:00",
          "endDate": "2023-01-06T00:00:00+02:00"
        },
        "classification": {
          "description": "Cartons",
          "scheme": "ДК021",
          "id": "44617100-9"
        },
        "additionalClassifications": [
          {
            "scheme": "ДКПП",
            "id": "17.21.1",
            "description": "папір і картон гофровані, паперова й картонна тара"
          }
        ],
        "unit": {
          "name": "кг",
          "value": {
            "amount": 6.0,
            "currency": "UAH",
            "valueAddedTaxIncluded": true
          },
          "code": "KGM"
        },
        "deliveryAddress": {
          "streetAddress": "вул. Банкова 1",
          "locality": "м. Київ",
          "region": "м. Київ",
          "postalCode": "79000",
          "countryName": "Україна"
        }
      }
    ],
    "tender_id": "fb4ee4451adb48f981d1518851ee4007",
    "owner": "broker",
    "status": "active",
    "suppliers": [
      {
        "name": "Державне управління справами",
        "identifier": {
          "scheme": "UA-EDR",
          "id": "00037256",
          "legalName": "Державне управління справами",
          "uri": "http://www.dus.gov.ua/"
        },
        "address": {
          "streetAddress": "вул. Банкова, 11, корпус 1",
          "locality": "м. Київ",
          "region": "м. Київ",
          "postalCode": "01220",
          "countryName": "Україна"
        },
        "scale": "micro",
        "contactPoint": {
          "name": "Державне управління справами",
          "telephone": "+0440000000"
        }
      }
    ],
    "procuringEntity": {
      "name": "Державне управління справами",
      "identifier": {
        "scheme": "UA-EDR",
        "id": "00037256",
        "legalName": "Державне управління справами",
        "uri": "http://www.dus.gov.ua/"
      },
      "address": {
        "streetAddress": "вул. Банкова, 11, корпус 1",
        "locality": "м. Київ",
        "region": "м. Київ",
        "postalCode": "01220",
        "countryName": "Україна"
      },
      "kind": "general",
      "contactPoint": {
        "name": "Державне управління справами",
        "telephone": "+0440000000"
      }
    },
    "changes": [
      {
        "rationale": "Друга і третя поставка має бути розфасована",
        "rationale_en": "Contract change cause",
        "rationaleTypes": [
          "volumeCuts",
          "priceReduction"
        ],
        "id": "d1ce56999c404806932bd89a9966a020",
        "status": "pending",
        "date": "2023-01-01T00:00:01+02:00"
      }
    ],
    "documents": [
      {
        "relatedItem": "d1ce56999c404806932bd89a9966a020",
        "id": "34379d8b0c6a4ef4a38489cd7e46af9b",
        "hash": "md5:00000000000000000000000000000000",
        "title": "contract_changes.doc",
        "format": "application/msword",
        "url": "http://lb-api-sandbox.prozorro.gov.ua/api/2.5/contracts/b67af9433cdc413fb8a098088d0cef85/documents/34379d8b0c6a4ef4a38489cd7e46af9b?download=f63818a2a95e4f2ab5e07260dfe16911",
        "documentOf": "change",
        "datePublished": "2023-01-01T00:00:01+02:00",
        "dateModified": "2023-01-01T00:00:01+02:00"
      }
    ],
    "value": {
      "amount": 438.0,
      "currency": "UAH",
      "valueAddedTaxIncluded": true,
      "amountNet": 430.0
    },
    "id": "b67af9433cdc413fb8a098088d0cef85"
  }
}

We see the added properties have merged with existing contract data. Additionally, the dateModified property was updated to reflect the last modification datestamp.

Fields that can be modified: title, description, status, value.amount, value.amountNet, period, items, amountPaid.amount, amountPaid.amountNet, terminationDetails.

See examples of items customization below. You can:

• update item:

Request

PATCH /api/2.5/contracts/b67af9433cdc413fb8a098088d0cef85?acc_token=e2cad9981b614b92a8262ec3ab0b7755 HTTP/1.0
Authorization: Bearer broker
Content-Length: 2427
Content-Type: application/json
Host: lb-api-sandbox.prozorro.gov.ua

{
  "data": {
    "items": [
      {
        "id": "b08960c0f87b47a78ac6347d98e8af52",
        "description": "футляри до державних нагород",
        "classification": {
          "description": "Cartons",
          "scheme": "ДК021",
          "id": "44617100-9"
        },
        "additionalClassifications": [
          {
            "scheme": "ДКПП",
            "id": "17.21.1",
            "description": "папір і картон гофровані, паперова й картонна тара"
          }
        ],
        "unit": {
          "name": "кг",
          "value": {
            "amount": 6.0,
            "currency": "UAH",
            "valueAddedTaxIncluded": true
          },
          "code": "KGM"
        },
        "quantity": 2,
        "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": "1f7aeaf465fd44f393098f8363a5e059",
        "description": "футляри до державних нагород",
        "classification": {
          "description": "Cartons",
          "scheme": "ДК021",
          "id": "44617100-9"
        },
        "additionalClassifications": [
          {
            "scheme": "ДКПП",
            "id": "17.21.1",
            "description": "папір і картон гофровані, паперова й картонна тара"
          }
        ],
        "unit": {
          "name": "кг",
          "value": {
            "amount": 6.0,
            "currency": "UAH",
            "valueAddedTaxIncluded": true
          },
          "code": "KGM"
        },
        "quantity": 5.0,
        "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": "Україна"
        }
      }
    ]
  }
}

Response

HTTP/1.0 200 OK
Content-Type: application/json

{
  "data": {
    "awardID": "034e185d515f40a1a151c02cc3516157",
    "contractID": "UA-2023-01-01-000001-a-1",
    "period": {
      "startDate": "2023-01-01T00:00:01+02:00",
      "endDate": "2023-01-31T00:00:01+02:00"
    },
    "dateSigned": "2023-01-01T00:00:01+02:00",
    "dateModified": "2023-01-01T00:00:01+02:00",
    "dateCreated": "2023-01-01T00:00:01+02:00",
    "items": [
      {
        "id": "b08960c0f87b47a78ac6347d98e8af52",
        "description": "футляри до державних нагород",
        "quantity": 2.0,
        "deliveryDate": {
          "startDate": "2023-01-03T00:00:00+02:00",
          "endDate": "2023-01-06T00:00:00+02:00"
        },
        "classification": {
          "description": "Cartons",
          "scheme": "ДК021",
          "id": "44617100-9"
        },
        "additionalClassifications": [
          {
            "scheme": "ДКПП",
            "id": "17.21.1",
            "description": "папір і картон гофровані, паперова й картонна тара"
          }
        ],
        "unit": {
          "name": "кг",
          "value": {
            "amount": 6.0,
            "currency": "UAH",
            "valueAddedTaxIncluded": true
          },
          "code": "KGM"
        },
        "deliveryAddress": {
          "streetAddress": "вул. Банкова 1",
          "locality": "м. Київ",
          "region": "м. Київ",
          "postalCode": "79000",
          "countryName": "Україна"
        }
      },
      {
        "id": "1f7aeaf465fd44f393098f8363a5e059",
        "description": "футляри до державних нагород",
        "quantity": 5.0,
        "deliveryDate": {
          "startDate": "2023-01-03T00:00:00+02:00",
          "endDate": "2023-01-06T00:00:00+02:00"
        },
        "classification": {
          "description": "Cartons",
          "scheme": "ДК021",
          "id": "44617100-9"
        },
        "additionalClassifications": [
          {
            "scheme": "ДКПП",
            "id": "17.21.1",
            "description": "папір і картон гофровані, паперова й картонна тара"
          }
        ],
        "unit": {
          "name": "кг",
          "value": {
            "amount": 6.0,
            "currency": "UAH",
            "valueAddedTaxIncluded": true
          },
          "code": "KGM"
        },
        "deliveryAddress": {
          "streetAddress": "вул. Банкова 1",
          "locality": "м. Київ",
          "region": "м. Київ",
          "postalCode": "79000",
          "countryName": "Україна"
        }
      }
    ],
    "tender_id": "fb4ee4451adb48f981d1518851ee4007",
    "owner": "broker",
    "status": "active",
    "suppliers": [
      {
        "name": "Державне управління справами",
        "identifier": {
          "scheme": "UA-EDR",
          "id": "00037256",
          "legalName": "Державне управління справами",
          "uri": "http://www.dus.gov.ua/"
        },
        "address": {
          "streetAddress": "вул. Банкова, 11, корпус 1",
          "locality": "м. Київ",
          "region": "м. Київ",
          "postalCode": "01220",
          "countryName": "Україна"
        },
        "scale": "micro",
        "contactPoint": {
          "name": "Державне управління справами",
          "telephone": "+0440000000"
        }
      }
    ],
    "procuringEntity": {
      "name": "Державне управління справами",
      "identifier": {
        "scheme": "UA-EDR",
        "id": "00037256",
        "legalName": "Державне управління справами",
        "uri": "http://www.dus.gov.ua/"
      },
      "address": {
        "streetAddress": "вул. Банкова, 11, корпус 1",
        "locality": "м. Київ",
        "region": "м. Київ",
        "postalCode": "01220",
        "countryName": "Україна"
      },
      "kind": "general",
      "contactPoint": {
        "name": "Державне управління справами",
        "telephone": "+0440000000"
      }
    },
    "changes": [
      {
        "rationale": "Друга і третя поставка має бути розфасована",
        "rationale_en": "Contract change cause",
        "rationaleTypes": [
          "volumeCuts",
          "priceReduction"
        ],
        "id": "d1ce56999c404806932bd89a9966a020",
        "status": "pending",
        "date": "2023-01-01T00:00:01+02:00"
      }
    ],
    "documents": [
      {
        "relatedItem": "d1ce56999c404806932bd89a9966a020",
        "id": "34379d8b0c6a4ef4a38489cd7e46af9b",
        "hash": "md5:00000000000000000000000000000000",
        "title": "contract_changes.doc",
        "format": "application/msword",
        "url": "http://lb-api-sandbox.prozorro.gov.ua/api/2.5/contracts/b67af9433cdc413fb8a098088d0cef85/documents/34379d8b0c6a4ef4a38489cd7e46af9b?download=f63818a2a95e4f2ab5e07260dfe16911",
        "documentOf": "change",
        "datePublished": "2023-01-01T00:00:01+02:00",
        "dateModified": "2023-01-01T00:00:01+02:00"
      }
    ],
    "value": {
      "amount": 438.0,
      "currency": "UAH",
      "valueAddedTaxIncluded": true,
      "amountNet": 430.0
    },
    "id": "b67af9433cdc413fb8a098088d0cef85"
  }
}

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/contracts/b67af9433cdc413fb8a098088d0cef85/changes/d1ce56999c404806932bd89a9966a020?acc_token=e2cad9981b614b92a8262ec3ab0b7755 HTTP/1.0
Authorization: Bearer broker
Content-Length: 73
Content-Type: application/json
Host: lb-api-sandbox.prozorro.gov.ua

{
  "data": {
    "status": "active",
    "dateSigned": "2023-01-01T00:00:01+02:00"
  }
}

Response

HTTP/1.0 200 OK
Content-Type: application/json

{
  "data": {
    "rationale": "Друга і третя поставка має бути розфасована",
    "rationale_en": "Contract change cause",
    "rationaleTypes": [
      "volumeCuts",
      "priceReduction"
    ],
    "dateSigned": "2023-01-01T00:00:01+02:00",
    "id": "d1ce56999c404806932bd89a9966a020",
    "status": "active",
    "date": "2023-01-01T00:00:01+02:00"
  }
}

dateSigned field validation:

• for the first contract change date should be after contract.dateSigned;
• for all next change objects date should be after the previous change.dateSigned.

You can view all changes:

Request

GET /api/2.5/contracts/b67af9433cdc413fb8a098088d0cef85/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": [
    {
      "rationale": "Друга і третя поставка має бути розфасована",
      "rationale_en": "Contract change cause",
      "rationaleTypes": [
        "volumeCuts",
        "priceReduction"
      ],
      "dateSigned": "2023-01-01T00:00:01+02:00",
      "id": "d1ce56999c404806932bd89a9966a020",
      "status": "active",
      "date": "2023-01-01T00:00:01+02:00"
    }
  ]
}

All changes are also listed on the contract view.

Request

GET /api/2.5/contracts/b67af9433cdc413fb8a098088d0cef85 HTTP/1.0
Authorization: Bearer broker
Host: public-api-sandbox.prozorro.gov.ua

Response

HTTP/1.0 200 OK
Content-Type: application/json

{
  "data": {
    "awardID": "034e185d515f40a1a151c02cc3516157",
    "contractID": "UA-2023-01-01-000001-a-1",
    "period": {
      "startDate": "2023-01-01T00:00:01+02:00",
      "endDate": "2023-01-31T00:00:01+02:00"
    },
    "dateSigned": "2023-01-01T00:00:01+02:00",
    "dateModified": "2023-01-01T00:00:01+02:00",
    "dateCreated": "2023-01-01T00:00:01+02:00",
    "items": [
      {
        "id": "b08960c0f87b47a78ac6347d98e8af52",
        "description": "футляри до державних нагород",
        "quantity": 2.0,
        "deliveryDate": {
          "startDate": "2023-01-03T00:00:00+02:00",
          "endDate": "2023-01-06T00:00:00+02:00"
        },
        "classification": {
          "description": "Cartons",
          "scheme": "ДК021",
          "id": "44617100-9"
        },
        "additionalClassifications": [
          {
            "scheme": "ДКПП",
            "id": "17.21.1",
            "description": "папір і картон гофровані, паперова й картонна тара"
          }
        ],
        "unit": {
          "name": "кг",
          "value": {
            "amount": 6.0,
            "currency": "UAH",
            "valueAddedTaxIncluded": true
          },
          "code": "KGM"
        },
        "deliveryAddress": {
          "streetAddress": "вул. Банкова 1",
          "locality": "м. Київ",
          "region": "м. Київ",
          "postalCode": "79000",
          "countryName": "Україна"
        }
      },
      {
        "id": "1f7aeaf465fd44f393098f8363a5e059",
        "description": "футляри до державних нагород",
        "quantity": 5.0,
        "deliveryDate": {
          "startDate": "2023-01-03T00:00:00+02:00",
          "endDate": "2023-01-06T00:00:00+02:00"
        },
        "classification": {
          "description": "Cartons",
          "scheme": "ДК021",
          "id": "44617100-9"
        },
        "additionalClassifications": [
          {
            "scheme": "ДКПП",
            "id": "17.21.1",
            "description": "папір і картон гофровані, паперова й картонна тара"
          }
        ],
        "unit": {
          "name": "кг",
          "value": {
            "amount": 6.0,
            "currency": "UAH",
            "valueAddedTaxIncluded": true
          },
          "code": "KGM"
        },
        "deliveryAddress": {
          "streetAddress": "вул. Банкова 1",
          "locality": "м. Київ",
          "region": "м. Київ",
          "postalCode": "79000",
          "countryName": "Україна"
        }
      }
    ],
    "tender_id": "fb4ee4451adb48f981d1518851ee4007",
    "owner": "broker",
    "status": "active",
    "suppliers": [
      {
        "name": "Державне управління справами",
        "identifier": {
          "scheme": "UA-EDR",
          "id": "00037256",
          "legalName": "Державне управління справами",
          "uri": "http://www.dus.gov.ua/"
        },
        "address": {
          "streetAddress": "вул. Банкова, 11, корпус 1",
          "locality": "м. Київ",
          "region": "м. Київ",
          "postalCode": "01220",
          "countryName": "Україна"
        },
        "scale": "micro",
        "contactPoint": {
          "name": "Державне управління справами",
          "telephone": "+0440000000"
        }
      }
    ],
    "procuringEntity": {
      "name": "Державне управління справами",
      "identifier": {
        "scheme": "UA-EDR",
        "id": "00037256",
        "legalName": "Державне управління справами",
        "uri": "http://www.dus.gov.ua/"
      },
      "address": {
        "streetAddress": "вул. Банкова, 11, корпус 1",
        "locality": "м. Київ",
        "region": "м. Київ",
        "postalCode": "01220",
        "countryName": "Україна"
      },
      "kind": "general",
      "contactPoint": {
        "name": "Державне управління справами",
        "telephone": "+0440000000"
      }
    },
    "changes": [
      {
        "rationale": "Друга і третя поставка має бути розфасована",
        "rationale_en": "Contract change cause",
        "rationaleTypes": [
          "volumeCuts",
          "priceReduction"
        ],
        "dateSigned": "2023-01-01T00:00:01+02:00",
        "id": "d1ce56999c404806932bd89a9966a020",
        "status": "active",
        "date": "2023-01-01T00:00:01+02:00"
      }
    ],
    "documents": [
      {
        "relatedItem": "d1ce56999c404806932bd89a9966a020",
        "id": "34379d8b0c6a4ef4a38489cd7e46af9b",
        "hash": "md5:00000000000000000000000000000000",
        "title": "contract_changes.doc",
        "format": "application/msword",
        "url": "http://public-api-sandbox.prozorro.gov.ua/api/2.5/contracts/b67af9433cdc413fb8a098088d0cef85/documents/34379d8b0c6a4ef4a38489cd7e46af9b?download=f63818a2a95e4f2ab5e07260dfe16911",
        "documentOf": "change",
        "datePublished": "2023-01-01T00:00:01+02:00",
        "dateModified": "2023-01-01T00:00:01+02:00"
      }
    ],
    "value": {
      "amount": 438.0,
      "currency": "UAH",
      "valueAddedTaxIncluded": true,
      "amountNet": 430.0
    },
    "id": "b67af9433cdc413fb8a098088d0cef85"
  }
}

Uploading documentation

Procuring entity can upload PDF files into the created contract. Uploading should follow the Documents Uploading rules.

Request

POST /api/2.5/contracts/b67af9433cdc413fb8a098088d0cef85/documents?acc_token=e2cad9981b614b92a8262ec3ab0b7755 HTTP/1.0
Authorization: Bearer broker
Content-Length: 324
Content-Type: application/json
Host: lb-api-sandbox.prozorro.gov.ua

{
  "data": {
    "title": "contract.doc",
    "url": "http://public-docs-sandbox.prozorro.gov.ua/get/6b559700bb5245049bdee88a6b887e04?Signature=iK5BqT8DBd6EmNJwkh%2B8qZNfPGVub8YGuJM58munUZv4jm%2FLDGxFutNvGIGQKCjXhK0SYc3KvLR0fDdWGOlIDA%3D%3D&KeyID=a8968c46",
    "hash": "md5:00000000000000000000000000000000",
    "format": "application/pdf"
  }
}

Response

HTTP/1.0 201 Created
Content-Type: application/json
Location: http://lb-api-sandbox.prozorro.gov.ua/api/2.5/contracts/b67af9433cdc413fb8a098088d0cef85/documents/5e141b7f2d9e4d909279131289c9e25f

{
  "data": {
    "hash": "md5:00000000000000000000000000000000",
    "title": "contract.doc",
    "format": "application/pdf",
    "url": "http://public-docs-sandbox.prozorro.gov.ua/get/6b559700bb5245049bdee88a6b887e04?Signature=V%2FKGkbsShKDpTJYKPSWbL3h72mRJO%2F6uOi8x6DX1AJxypK7%2FopQidX%2BYz%2BddFJG4BR1KqDCgwBsNe4Xz0kwgBA%3D%3D&KeyID=a8968c46",
    "documentOf": "contract",
    "id": "5e141b7f2d9e4d909279131289c9e25f",
    "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 creation. We can additionally query the documents collection API endpoint to confirm the action:

Request

GET /api/2.5/contracts/b67af9433cdc413fb8a098088d0cef85/documents?acc_token=e2cad9981b614b92a8262ec3ab0b7755 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": "d1ce56999c404806932bd89a9966a020",
      "id": "34379d8b0c6a4ef4a38489cd7e46af9b",
      "hash": "md5:00000000000000000000000000000000",
      "title": "contract_changes.doc",
      "format": "application/msword",
      "url": "http://public-docs-sandbox.prozorro.gov.ua/get/f63818a2a95e4f2ab5e07260dfe16911?Signature=AIUP5kGnx%2BOdbPRF%2B0t6WebywkPEF8BHamAxW9BXr224HyI%2BSXYFxn6QzmhVRFlpv08gR6kyoyAjzLIo6xcVAA%3D%3D&KeyID=a8968c46",
      "documentOf": "change",
      "datePublished": "2023-01-01T00:00:01+02:00",
      "dateModified": "2023-01-01T00:00:01+02:00"
    },
    {
      "hash": "md5:00000000000000000000000000000000",
      "title": "contract.doc",
      "format": "application/pdf",
      "url": "http://public-docs-sandbox.prozorro.gov.ua/get/6b559700bb5245049bdee88a6b887e04?Signature=V%2FKGkbsShKDpTJYKPSWbL3h72mRJO%2F6uOi8x6DX1AJxypK7%2FopQidX%2BYz%2BddFJG4BR1KqDCgwBsNe4Xz0kwgBA%3D%3D&KeyID=a8968c46",
      "documentOf": "contract",
      "id": "5e141b7f2d9e4d909279131289c9e25f",
      "datePublished": "2023-01-01T00:00:01+02:00",
      "dateModified": "2023-01-01T00:00:01+02:00"
    }
  ]
}

And again we can confirm that there are two documents uploaded.

Request

POST /api/2.5/contracts/b67af9433cdc413fb8a098088d0cef85/documents?acc_token=e2cad9981b614b92a8262ec3ab0b7755 HTTP/1.0
Authorization: Bearer broker
Content-Length: 344
Content-Type: application/json
Host: lb-api-sandbox.prozorro.gov.ua

{
  "data": {
    "title": "contract_additional_docs.doc",
    "url": "http://public-docs-sandbox.prozorro.gov.ua/get/bdd3fb01fd5543dcb7c49a037c335baf?Signature=yor3BJmbDFsR%2FF3sKWKVbFvIKRxGyk4%2Bq4%2FUYYLNax8qJSzr0JueHukHNruZ4dqs6ooC44CFb%2BIKZW86XsSjDQ%3D%3D&KeyID=a8968c46",
    "hash": "md5:00000000000000000000000000000000",
    "format": "application/pdf"
  }
}

Response

HTTP/1.0 201 Created
Content-Type: application/json
Location: http://lb-api-sandbox.prozorro.gov.ua/api/2.5/contracts/b67af9433cdc413fb8a098088d0cef85/documents/c17142bb61854a6f8ca8caeef4c91799

{
  "data": {
    "hash": "md5:00000000000000000000000000000000",
    "title": "contract_additional_docs.doc",
    "format": "application/pdf",
    "url": "http://public-docs-sandbox.prozorro.gov.ua/get/bdd3fb01fd5543dcb7c49a037c335baf?Signature=UWVFw1k3kphG%2BaNjhh5PLf5%2B3QJiv%2FRICggmV01tLe47AT5l0xsRv%2Bn4pmBQNBQ%2BelTVOkDPRsg%2BjZlc4UQUBw%3D%3D&KeyID=a8968c46",
    "documentOf": "contract",
    "id": "c17142bb61854a6f8ca8caeef4c91799",
    "datePublished": "2023-01-01T00:00:01+02:00",
    "dateModified": "2023-01-01T00:00:01+02:00"
  }
}

In case we made an error, we can reupload the document over the older version:

Request

PUT /api/2.5/contracts/b67af9433cdc413fb8a098088d0cef85/documents/c17142bb61854a6f8ca8caeef4c91799?acc_token=e2cad9981b614b92a8262ec3ab0b7755 HTTP/1.0
Authorization: Bearer broker
Content-Length: 340
Content-Type: application/json
Host: lb-api-sandbox.prozorro.gov.ua

{
  "data": {
    "title": "contract_additional_docs.doc",
    "url": "http://public-docs-sandbox.prozorro.gov.ua/get/3dc187c0d95d4d9aaf3954aed82eb6fe?Signature=0P7pQiY6OJUKRXb%2FZ8d6xfKTohAvlySDm8MPE3mWp7eMxSRXKIvLYlsNrQSOvKAyk0v%2BIhGmq8bWNtJmNupBBA%3D%3D&KeyID=a8968c46",
    "hash": "md5:00000000000000000000000000000000",
    "format": "application/pdf"
  }
}

Response

HTTP/1.0 200 OK
Content-Type: application/json

{
  "data": {
    "id": "c17142bb61854a6f8ca8caeef4c91799",
    "hash": "md5:00000000000000000000000000000000",
    "title": "contract_additional_docs.doc",
    "format": "application/pdf",
    "url": "http://public-docs-sandbox.prozorro.gov.ua/get/3dc187c0d95d4d9aaf3954aed82eb6fe?Signature=hZosigHskiVw%2BVRXxgwRiq8GV8IEJk0s9GHzLWchLg4iuHpeBb2bUIvJRORVEc8CWfGyK9MN0r4fWsF2fnU1Dw%3D%3D&KeyID=a8968c46",
    "documentOf": "contract",
    "datePublished": "2023-01-01T00:00:01+02:00",
    "dateModified": "2023-01-01T00:00:01+02:00"
  }
}

And we can see that it is overriding the original version:

Request

GET /api/2.5/contracts/b67af9433cdc413fb8a098088d0cef85/documents/c17142bb61854a6f8ca8caeef4c91799?acc_token=e2cad9981b614b92a8262ec3ab0b7755 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": "c17142bb61854a6f8ca8caeef4c91799",
    "hash": "md5:00000000000000000000000000000000",
    "title": "contract_additional_docs.doc",
    "format": "application/pdf",
    "url": "http://public-docs-sandbox.prozorro.gov.ua/get/3dc187c0d95d4d9aaf3954aed82eb6fe?Signature=hZosigHskiVw%2BVRXxgwRiq8GV8IEJk0s9GHzLWchLg4iuHpeBb2bUIvJRORVEc8CWfGyK9MN0r4fWsF2fnU1Dw%3D%3D&KeyID=a8968c46",
    "documentOf": "contract",
    "datePublished": "2023-01-01T00:00:01+02:00",
    "dateModified": "2023-01-01T00:00:01+02:00",
    "previousVersions": [
      {
        "hash": "md5:00000000000000000000000000000000",
        "title": "contract_additional_docs.doc",
        "format": "application/pdf",
        "url": "http://public-docs-sandbox.prozorro.gov.ua/get/bdd3fb01fd5543dcb7c49a037c335baf?Signature=UWVFw1k3kphG%2BaNjhh5PLf5%2B3QJiv%2FRICggmV01tLe47AT5l0xsRv%2Bn4pmBQNBQ%2BelTVOkDPRsg%2BjZlc4UQUBw%3D%3D&KeyID=a8968c46",
        "documentOf": "contract",
        "id": "c17142bb61854a6f8ca8caeef4c91799",
        "datePublished": "2023-01-01T00:00:01+02:00",
        "dateModified": "2023-01-01T00:00:01+02:00"
      }
    ]
  }
}

Completing contract

Before contract can be completed amountPaid field value should be set (regardless whether the contract was successful or unsuccessful). Contract can be completed by switching to terminated status. Let’s perform these actions in single request:

Request

PATCH /api/2.5/contracts/b67af9433cdc413fb8a098088d0cef85?acc_token=e2cad9981b614b92a8262ec3ab0b7755 HTTP/1.0
Authorization: Bearer broker
Content-Length: 114
Content-Type: application/json
Host: lb-api-sandbox.prozorro.gov.ua

{
  "data": {
    "status": "terminated",
    "amountPaid": {
      "amount": 430,
      "amountNet": 420,
      "valueAddedTaxIncluded": true
    }
  }
}

Response

HTTP/1.0 200 OK
Content-Type: application/json

{
  "data": {
    "awardID": "034e185d515f40a1a151c02cc3516157",
    "contractID": "UA-2023-01-01-000001-a-1",
    "period": {
      "startDate": "2023-01-01T00:00:01+02:00",
      "endDate": "2023-01-31T00:00:01+02:00"
    },
    "dateSigned": "2023-01-01T00:00:01+02:00",
    "dateModified": "2023-01-01T00:00:01+02:00",
    "dateCreated": "2023-01-01T00:00:01+02:00",
    "items": [
      {
        "id": "b08960c0f87b47a78ac6347d98e8af52",
        "description": "футляри до державних нагород",
        "quantity": 2.0,
        "deliveryDate": {
          "startDate": "2023-01-03T00:00:00+02:00",
          "endDate": "2023-01-06T00:00:00+02:00"
        },
        "classification": {
          "description": "Cartons",
          "scheme": "ДК021",
          "id": "44617100-9"
        },
        "additionalClassifications": [
          {
            "scheme": "ДКПП",
            "id": "17.21.1",
            "description": "папір і картон гофровані, паперова й картонна тара"
          }
        ],
        "unit": {
          "name": "кг",
          "value": {
            "amount": 6.0,
            "currency": "UAH",
            "valueAddedTaxIncluded": true
          },
          "code": "KGM"
        },
        "deliveryAddress": {
          "streetAddress": "вул. Банкова 1",
          "locality": "м. Київ",
          "region": "м. Київ",
          "postalCode": "79000",
          "countryName": "Україна"
        }
      },
      {
        "id": "1f7aeaf465fd44f393098f8363a5e059",
        "description": "футляри до державних нагород",
        "quantity": 5.0,
        "deliveryDate": {
          "startDate": "2023-01-03T00:00:00+02:00",
          "endDate": "2023-01-06T00:00:00+02:00"
        },
        "classification": {
          "description": "Cartons",
          "scheme": "ДК021",
          "id": "44617100-9"
        },
        "additionalClassifications": [
          {
            "scheme": "ДКПП",
            "id": "17.21.1",
            "description": "папір і картон гофровані, паперова й картонна тара"
          }
        ],
        "unit": {
          "name": "кг",
          "value": {
            "amount": 6.0,
            "currency": "UAH",
            "valueAddedTaxIncluded": true
          },
          "code": "KGM"
        },
        "deliveryAddress": {
          "streetAddress": "вул. Банкова 1",
          "locality": "м. Київ",
          "region": "м. Київ",
          "postalCode": "79000",
          "countryName": "Україна"
        }
      }
    ],
    "tender_id": "fb4ee4451adb48f981d1518851ee4007",
    "owner": "broker",
    "status": "terminated",
    "suppliers": [
      {
        "name": "Державне управління справами",
        "identifier": {
          "scheme": "UA-EDR",
          "id": "00037256",
          "legalName": "Державне управління справами",
          "uri": "http://www.dus.gov.ua/"
        },
        "address": {
          "streetAddress": "вул. Банкова, 11, корпус 1",
          "locality": "м. Київ",
          "region": "м. Київ",
          "postalCode": "01220",
          "countryName": "Україна"
        },
        "scale": "micro",
        "contactPoint": {
          "name": "Державне управління справами",
          "telephone": "+0440000000"
        }
      }
    ],
    "procuringEntity": {
      "name": "Державне управління справами",
      "identifier": {
        "scheme": "UA-EDR",
        "id": "00037256",
        "legalName": "Державне управління справами",
        "uri": "http://www.dus.gov.ua/"
      },
      "address": {
        "streetAddress": "вул. Банкова, 11, корпус 1",
        "locality": "м. Київ",
        "region": "м. Київ",
        "postalCode": "01220",
        "countryName": "Україна"
      },
      "kind": "general",
      "contactPoint": {
        "name": "Державне управління справами",
        "telephone": "+0440000000"
      }
    },
    "changes": [
      {
        "rationale": "Друга і третя поставка має бути розфасована",
        "rationale_en": "Contract change cause",
        "rationaleTypes": [
          "volumeCuts",
          "priceReduction"
        ],
        "dateSigned": "2023-01-01T00:00:01+02:00",
        "id": "d1ce56999c404806932bd89a9966a020",
        "status": "active",
        "date": "2022-12-31T22:00:01"
      }
    ],
    "documents": [
      {
        "relatedItem": "d1ce56999c404806932bd89a9966a020",
        "id": "34379d8b0c6a4ef4a38489cd7e46af9b",
        "hash": "md5:00000000000000000000000000000000",
        "title": "contract_changes.doc",
        "format": "application/msword",
        "url": "http://lb-api-sandbox.prozorro.gov.ua/api/2.5/contracts/b67af9433cdc413fb8a098088d0cef85/documents/34379d8b0c6a4ef4a38489cd7e46af9b?download=f63818a2a95e4f2ab5e07260dfe16911",
        "documentOf": "change",
        "datePublished": "2023-01-01T00:00:01+02:00",
        "dateModified": "2023-01-01T00:00:01+02:00"
      },
      {
        "id": "5e141b7f2d9e4d909279131289c9e25f",
        "hash": "md5:00000000000000000000000000000000",
        "title": "contract.doc",
        "format": "application/pdf",
        "url": "http://lb-api-sandbox.prozorro.gov.ua/api/2.5/contracts/b67af9433cdc413fb8a098088d0cef85/documents/5e141b7f2d9e4d909279131289c9e25f?download=6b559700bb5245049bdee88a6b887e04",
        "documentOf": "contract",
        "datePublished": "2023-01-01T00:00:01+02:00",
        "dateModified": "2023-01-01T00:00:01+02:00"
      },
      {
        "id": "c17142bb61854a6f8ca8caeef4c91799",
        "hash": "md5:00000000000000000000000000000000",
        "title": "contract_additional_docs.doc",
        "format": "application/pdf",
        "url": "http://lb-api-sandbox.prozorro.gov.ua/api/2.5/contracts/b67af9433cdc413fb8a098088d0cef85/documents/c17142bb61854a6f8ca8caeef4c91799?download=bdd3fb01fd5543dcb7c49a037c335baf",
        "documentOf": "contract",
        "datePublished": "2023-01-01T00:00:01+02:00",
        "dateModified": "2023-01-01T00:00:01+02:00"
      },
      {
        "id": "c17142bb61854a6f8ca8caeef4c91799",
        "hash": "md5:00000000000000000000000000000000",
        "title": "contract_additional_docs.doc",
        "format": "application/pdf",
        "url": "http://lb-api-sandbox.prozorro.gov.ua/api/2.5/contracts/b67af9433cdc413fb8a098088d0cef85/documents/c17142bb61854a6f8ca8caeef4c91799?download=3dc187c0d95d4d9aaf3954aed82eb6fe",
        "documentOf": "contract",
        "datePublished": "2023-01-01T00:00:01+02:00",
        "dateModified": "2023-01-01T00:00:01+02:00"
      }
    ],
    "amountPaid": {
      "amount": 430.0,
      "currency": "UAH",
      "amountNet": 420.0,
      "valueAddedTaxIncluded": true
    },
    "value": {
      "amount": 438.0,
      "currency": "UAH",
      "valueAddedTaxIncluded": true,
      "amountNet": 430.0
    },
    "id": "b67af9433cdc413fb8a098088d0cef85"
  }
}

Note that you can set/change amountPaid.amount, amountPaid.amountNet, amountPaid.valueAddedTaxIncluded values. amountPaid.currency field value is generated from Contract.value field.

If contract is unsuccessful reasons for termination terminationDetails should be specified.

Any future modification to the contract are not allowed.