Auction

Schema

id:

string, auto-generated, read-only

auctionID:

string, auto-generated, read-only

The auction identifier to refer auction to in “paper” documentation.

OpenContracting Description: It is included to make the flattened data structure more convenient.

procurementMethodType:
 

string, auto-generated, read-only

Type that defines what type of the procedure is going to be used. Possible values:

  • sellout.english - procedure with the open ascending price auction;
  • sellout.insider - procedure with the insider auction.
procurementMethodDetails:
 

string, optional

Parameter that accelerates auction periods. Set quick, accelerator=1440 as text value for procurementMethodDetails for the time frames to be reduced in 1440 times.

submissionMethodDetails:
 

string, optional

Parameter that works only with mode = “test” and speeds up auction start date.

Possible value is quick.

sandboxParameters:
 

string, optional

Parameter that accelerates lot periods. Set quick, accelerator=1440 as text value for sandboxParameters for the time frames to be reduced in 1440 times.

auctionPeriod:

Period, required

Period when the first auction is conducted. Here only startDate has be provided.

tenderingDuration:
 

Duration, required

Duration of tenderPeriod for 2nd and 3rd procedures within the privatization cycle.

documents:

Array of Documents objects, optional

OpenContracting Description: All documents and attachments related to the auction.

value:

Value, required

Total available budget of the 1st auction. Bids lower than value will be rejected.

Auction.value for 2nd and 3rd auctions within the privatization cycle will be calculated as half of the auction.value provided.

OpenContracting Description: The total estimated value of the procurement.

guarantee:

Guarantee, required

Bid guarantee. Lots.auctions.guarantee for 2nd and 3rd auctions within the privatization cycle will be calculated auctomatically.

minimalStep:

Value, required

The minimal step of the 1st auction. Lots.auctions.minimalStep for 2nd and 3rd auctions within the privatization cycle will be calculated auctomatically.

auctionParameters:
 

Auction Parameters, optional

Parameters for the auction to be held.

Ogranizator can optionally set value for the 3rd auction within the lots.auctions structure.

bankAccount:

Bank Account, required

Details which uniquely identify a bank account, and are used when making or receiving a payment.

tenderAttempts:

integer, auto-generated, read-only

The number which represents what time (from 1 up to 3) procedure with a current lot takes place.

status:

string, required

Auction status within which the lot is being sold:

Status Description
scheduled

The process is planned, but is not yet taking place.

Details of the anticipated dates may be provided further

active The process is currently taking place
complete The process is complete;
cancelled The process has been cancelled;
unsuccessful The process has been unsuccessful.
contracts:

Array of Сontracts, auto-generated, read-only

Information of the related contract.

relatedProcessID:
 

uuid, required

Internal id of the auction.

Auction Parameters

Schema

type:

string, auto-generated, read-only

Type of the auction.

dutchSteps:

integer, required for the third auction

Number of steps within the dutch part of the insider auction.

Possible values are [1; 100]. Defaul value is 99.

Duration

Duration in ISO 8601.

Value

Schema

amount:

float, required

Should be positive.

OpenContracting Description: Amount as a number.

currency:

string, required

OpenContracting Description: The currency in 3-letter ISO 4217 format.

valueAddedTaxIncluded:
 

bool, required

Possible values are true or false.

Guarantee

Schema

amount:

float, required

Should be positive.

OpenContracting Description: Amount as a number.

currency:

string, required

OpenContracting Description: The currency in 3-letter ISO 4217 format.

Bank Account

Schema

description:

string, multilingual, optional

Additional information that has to be noted from the Organizator’s point.

bankName:

string, required

Name of the bank.

accountIdentification:
 

Array of Classification, required

Major data on the account details of the state entity selling a lot, to facilitate payments at the end of the process.

Most frequently used are:

  • UA-EDR;
  • UA-MFO;
  • accountNumber.

Сontracts

Schema

type:

string, required, auto-generated, read-only

Type of the contract. The only value is yoke.

contractID:

string, required, auto-generated, read-only

The contract identifier to refer to in “paper” documentation.

Added as long as the contract is being created within the Module of Contracting.

relatedProcessID:
 

uuid, required, auto-generated, read-only

Internal identifier of the object within the Module of Contracting.

Added as long as the contract is being created within the Module of Contracting.