Full schema reference

The table below contains all possible fields provided by the OCDS for PPPs schema

Browsing the schema

This page presents the release schema as a table. You can also download the canonical version of the release schema as JSON Schema, download it as a CSV spreadsheet, or view it in an interactive browser.

Title

Description

Type

Format

Required

ocid

string

Required

Open Contracting ID

A globally unique identifier for this Open Contracting Process. Composed of an ocid prefix and an identifier for the contracting process. For more information see the Open Contracting Identifier guidance

id

string

Required

Release ID

An identifier for this particular release of information. A release identifier must be unique within the scope of its related contracting process (defined by a common ocid). A release identifier must not contain the # character.

date

string

date-time

Required

Release Date

The date on which the information contained in the release was first recorded in, or published by, any system.

tag

array[string]

Required

Release Tag

One or more values from the closed releaseTag codelist. Tags can be used to filter releases and to understand the kind of information that releases might contain.

initiationType

string

Required

Initiation type

The type of initiation process used for this contract, from the closed initiationType codelist.

parties

array[Organization]

Parties

Information on the parties (organizations, economic operators and other participants) who are involved in the contracting process and their roles, e.g. buyer, procuring entity, supplier etc. Organization references elsewhere in the schema are used to refer back to this entries in this list.

parties/0/name

[string, null]

Common name

A common name for this organization or other participant in the contracting process. The identifier object provides a space for the formal legal name, and so this may either repeat that value, or may provide the common name by which this organization or entity is known. This field may also include details of the department or sub-unit involved in this contracting process.

parties/0/id

string

Entity ID

The ID used for cross-referencing to this party from other sections of the release. This field may be built with the following structure {identifier.scheme}-{identifier.id}(-{department-identifier}).

parties/0/identifier

object

Primary identifier

The primary identifier for this organization or participant. Identifiers that uniquely pick out a legal entity should be preferred. Consult the organization identifier guidance for the preferred scheme and identifier to use.

parties/0/identifier/scheme

[string, null]

Scheme

Organization identifiers should be taken from an existing organization identifier list. The scheme field is used to indicate the list or register from which the identifier is taken. This value should be taken from the Organization Identifier Scheme codelist.

parties/0/identifier/id

[string, integer, null]

ID

The identifier of the organization in the selected scheme.

parties/0/identifier/legalName

[string, null]

Legal Name

The legally registered name of the organization.

parties/0/identifier/uri

[string, null]

uri

URI

A URI to identify the organization, such as those provided by Open Corporates or some other relevant URI provider. This is not for listing the website of the organization: that can be done through the URL field of the Organization contact point.

parties/0/additionalIdentifiers

array[Identifier]

Additional identifiers

A list of additional / supplemental identifiers for the organization or participant, using the organization identifier guidance. This can be used to provide an internally used identifier for this organization in addition to the primary legal entity identifier.

parties/0/additionalIdentifiers/0/scheme

[string, null]

Scheme

Organization identifiers should be taken from an existing organization identifier list. The scheme field is used to indicate the list or register from which the identifier is taken. This value should be taken from the Organization Identifier Scheme codelist.

parties/0/additionalIdentifiers/0/id

[string, integer, null]

ID

The identifier of the organization in the selected scheme.

parties/0/additionalIdentifiers/0/legalName

[string, null]

Legal Name

The legally registered name of the organization.

parties/0/additionalIdentifiers/0/uri

[string, null]

uri

URI

A URI to identify the organization, such as those provided by Open Corporates or some other relevant URI provider. This is not for listing the website of the organization: that can be done through the URL field of the Organization contact point.

parties/0/address

object

Address

An address. This may be the legally registered address of the organization, or may be a correspondence address for this particular contracting process.

parties/0/address/streetAddress

[string, null]

Street address

The street address. For example, 1600 Amphitheatre Pkwy.

parties/0/address/locality

[string, null]

Locality

The locality. For example, Mountain View.

parties/0/address/region

[string, null]

Region

The region. For example, CA.

parties/0/address/postalCode

[string, null]

Postal code

The postal code. For example, 94043.

parties/0/address/countryName

[string, null]

Country name

The country name. For example, United States.

parties/0/contactPoint

object

Contact point

Contact details that can be used for this party.

parties/0/contactPoint/name

[string, null]

Name

The name of the contact person, department, or contact point, for correspondence relating to this contracting process.

parties/0/contactPoint/email

[string, null]

Email

The e-mail address of the contact point/person.

parties/0/contactPoint/telephone

[string, null]

Telephone

The telephone number of the contact point/person. This should include the international dialing code.

parties/0/contactPoint/faxNumber

[string, null]

Fax number

The fax number of the contact point/person. This should include the international dialing code.

parties/0/contactPoint/url

[string, null]

uri

URL

A web address for the contact point/person.

parties/0/roles

array[string]

Party roles

The party's role(s) in the contracting process, using the open partyRole codelist.

parties/0/details

[object, null]

Details

Additional classification information about parties can be provided using partyDetail extensions that define particular fields and classification schemes.

parties/0/shareholders

array[Shareholding]

Shareholdings

Shareholdings in the organization: used to provide company ownership information for firms, primarily in the case of large and complex contracts, like public private partnerships, that require disclosure of this information by bidders or suppliers.

parties/0/shareholders/0/id

string

Required

ID

A local identifier for this shareholding, unique within this array.

parties/0/shareholders/0/shareholder

object

Shareholder

The organization holding the share.

parties/0/shareholders/0/shareholder/name

[string, null]

Organization name

The name of the party being referenced. This must match the name of an entry in the parties section.

parties/0/shareholders/0/shareholder/id

[string, integer]

Organization ID

The id of the party being referenced. This must match the id of an entry in the parties section.

parties/0/shareholders/0/shareholder/identifier

object

Primary identifier

The primary identifier for this organization. Identifiers that uniquely pick out a legal entity should be preferred. Consult the organization identifier guidance for the preferred scheme and identifier to use.

parties/0/shareholders/0/shareholder/identifier/scheme

[string, null]

Scheme

Organization identifiers should be taken from an existing organization identifier list. The scheme field is used to indicate the list or register from which the identifier is taken. This value should be taken from the Organization Identifier Scheme codelist.

parties/0/shareholders/0/shareholder/identifier/id

[string, integer, null]

ID

The identifier of the organization in the selected scheme.

parties/0/shareholders/0/shareholder/identifier/legalName

[string, null]

Legal Name

The legally registered name of the organization.

parties/0/shareholders/0/shareholder/identifier/uri

[string, null]

uri

URI

A URI to identify the organization, such as those provided by Open Corporates or some other relevant URI provider. This is not for listing the website of the organization: that can be done through the URL field of the Organization contact point.

parties/0/shareholders/0/shareholder/address

object

Address

(Deprecated outside the parties section)

parties/0/shareholders/0/shareholder/address/streetAddress

[string, null]

Street address

The street address. For example, 1600 Amphitheatre Pkwy.

parties/0/shareholders/0/shareholder/address/locality

[string, null]

Locality

The locality. For example, Mountain View.

parties/0/shareholders/0/shareholder/address/region

[string, null]

Region

The region. For example, CA.

parties/0/shareholders/0/shareholder/address/postalCode

[string, null]

Postal code

The postal code. For example, 94043.

parties/0/shareholders/0/shareholder/address/countryName

[string, null]

Country name

The country name. For example, United States.

parties/0/shareholders/0/shareholder/additionalIdentifiers

array[Identifier]

Additional identifiers

(Deprecated outside the parties section) A list of additional / supplemental identifiers for the organization, using the organization identifier guidance. This can be used to provide an internally used identifier for this organization in addition to the primary legal entity identifier.

parties/0/shareholders/0/shareholder/additionalIdentifiers/0/scheme

[string, null]

Scheme

Organization identifiers should be taken from an existing organization identifier list. The scheme field is used to indicate the list or register from which the identifier is taken. This value should be taken from the Organization Identifier Scheme codelist.

parties/0/shareholders/0/shareholder/additionalIdentifiers/0/id

[string, integer, null]

ID

The identifier of the organization in the selected scheme.

parties/0/shareholders/0/shareholder/additionalIdentifiers/0/legalName

[string, null]

Legal Name

The legally registered name of the organization.

parties/0/shareholders/0/shareholder/additionalIdentifiers/0/uri

[string, null]

uri

URI

A URI to identify the organization, such as those provided by Open Corporates or some other relevant URI provider. This is not for listing the website of the organization: that can be done through the URL field of the Organization contact point.

parties/0/shareholders/0/shareholder/contactPoint

object

Contact point

(Deprecated outside the parties section)

parties/0/shareholders/0/shareholder/contactPoint/name

[string, null]

Name

The name of the contact person, department, or contact point, for correspondence relating to this contracting process.

parties/0/shareholders/0/shareholder/contactPoint/email

[string, null]

Email

The e-mail address of the contact point/person.

parties/0/shareholders/0/shareholder/contactPoint/telephone

[string, null]

Telephone

The telephone number of the contact point/person. This should include the international dialing code.

parties/0/shareholders/0/shareholder/contactPoint/faxNumber

[string, null]

Fax number

The fax number of the contact point/person. This should include the international dialing code.

parties/0/shareholders/0/shareholder/contactPoint/url

[string, null]

uri

URL

A web address for the contact point/person.

parties/0/shareholders/0/shareholding

[number, null]

Shareholding

The proportion of the organization's shares held by the shareholder, expressed as a decimal between 0 and 1.

parties/0/shareholders/0/votingRights

[string, null]

Voting rights

The type of voting rights associated with the shareholder's shares.

parties/0/shareholders/0/votingRightsDetails

[string, null]

Voting rights details

Detailed information about the voting rights associated with the shareholder's shares: for example, when the shareholder voting rights are restricted, additional or enhanced.

parties/0/shareholders/0/notes

[string, null]

Notes

Additional notes on the shareholding or shareholder: for example, details on any caps on equity transfer, or lock-in arrangements, applicable to the shareholder.

buyer

object

Buyer

A buyer is an entity whose budget will be used to pay for goods, works or services related to a contract. This may be different from the procuring entity who may be specified in the tender data.

buyer/name

[string, null]

Organization name

The name of the party being referenced. This must match the name of an entry in the parties section.

buyer/id

[string, integer]

Organization ID

The id of the party being referenced. This must match the id of an entry in the parties section.

buyer/identifier

object

Primary identifier

The primary identifier for this organization. Identifiers that uniquely pick out a legal entity should be preferred. Consult the organization identifier guidance for the preferred scheme and identifier to use.

buyer/identifier/scheme

[string, null]

Scheme

Organization identifiers should be taken from an existing organization identifier list. The scheme field is used to indicate the list or register from which the identifier is taken. This value should be taken from the Organization Identifier Scheme codelist.

buyer/identifier/id

[string, integer, null]

ID

The identifier of the organization in the selected scheme.

buyer/identifier/legalName

[string, null]

Legal Name

The legally registered name of the organization.

buyer/identifier/uri

[string, null]

uri

URI

A URI to identify the organization, such as those provided by Open Corporates or some other relevant URI provider. This is not for listing the website of the organization: that can be done through the URL field of the Organization contact point.

buyer/address

object

Address

(Deprecated outside the parties section)

buyer/address/streetAddress

[string, null]

Street address

The street address. For example, 1600 Amphitheatre Pkwy.

buyer/address/locality

[string, null]

Locality

The locality. For example, Mountain View.

buyer/address/region

[string, null]

Region

The region. For example, CA.

buyer/address/postalCode

[string, null]

Postal code

The postal code. For example, 94043.

buyer/address/countryName

[string, null]

Country name

The country name. For example, United States.

buyer/additionalIdentifiers

array[Identifier]

Additional identifiers

(Deprecated outside the parties section) A list of additional / supplemental identifiers for the organization, using the organization identifier guidance. This can be used to provide an internally used identifier for this organization in addition to the primary legal entity identifier.

buyer/additionalIdentifiers/0/scheme

[string, null]

Scheme

Organization identifiers should be taken from an existing organization identifier list. The scheme field is used to indicate the list or register from which the identifier is taken. This value should be taken from the Organization Identifier Scheme codelist.

buyer/additionalIdentifiers/0/id

[string, integer, null]

ID

The identifier of the organization in the selected scheme.

buyer/additionalIdentifiers/0/legalName

[string, null]

Legal Name

The legally registered name of the organization.

buyer/additionalIdentifiers/0/uri

[string, null]

uri

URI

A URI to identify the organization, such as those provided by Open Corporates or some other relevant URI provider. This is not for listing the website of the organization: that can be done through the URL field of the Organization contact point.

buyer/contactPoint

object

Contact point

(Deprecated outside the parties section)

buyer/contactPoint/name

[string, null]

Name

The name of the contact person, department, or contact point, for correspondence relating to this contracting process.

buyer/contactPoint/email

[string, null]

Email

The e-mail address of the contact point/person.

buyer/contactPoint/telephone

[string, null]

Telephone

The telephone number of the contact point/person. This should include the international dialing code.

buyer/contactPoint/faxNumber

[string, null]

Fax number

The fax number of the contact point/person. This should include the international dialing code.

buyer/contactPoint/url

[string, null]

uri

URL

A web address for the contact point/person.

planning

object

Planning

Information from the planning phase of the contracting process. This includes information related to the process of deciding what to contract, when and how.

planning/rationale

[string, null]

Rationale

The rationale for the procurement provided in free text. More detail can be provided in an attached document.

planning/budget

object

Budget

Details of the budget that funds this contracting process.

planning/budget/id

[string, integer, null]

ID

An identifier for the budget line item which provides funds for this contracting process. This identifier should be possible to cross-reference against the provided data source.

planning/budget/description

[string, null]

Budget Source

A short free text description of the budget source. May be used to provide the title of the budget line, or the programme used to fund this project.

planning/budget/amount

object

Amount

The value reserved in the budget for this contracting process. A negative value indicates anticipated income to the budget as a result of this contracting process, rather than expenditure. Where the budget is drawn from multiple sources, the budget breakdown extension can be used.

planning/budget/amount/amount

[number, null]

Amount

Amount as a number.

planning/budget/amount/currency

[string, null]

Currency

The currency of the amount, from the closed currency codelist.

planning/budget/project

[string, null]

Project title

The name of the project through which this contracting process is funded (if applicable). Some organizations maintain a registry of projects, and the data should use the name by which the project is known in that registry. No translation option is offered for this string, as translated values can be provided in third-party data, linked from the data source above.

planning/budget/projectID

[string, integer, null]

Project identifier

An external identifier for the project that this contracting process forms part of, or is funded via (if applicable). Some organizations maintain a registry of projects, and the data should use the identifier from the relevant registry of projects.

planning/budget/uri

[string, null]

uri

Linked budget information

A URI pointing directly to a machine-readable record about the budget line-item or line-items that fund this contracting process. Information can be provided in a range of formats, including using IATI, the Open Fiscal Data Standard or any other standard which provides structured data on budget sources. Human readable documents can be included using the planning.documents block.

planning/budget/source

[string, null]

uri

Data Source

(Deprecated in 1.1) Used to point either to a corresponding Budget Data Package, or to a machine or human-readable source where users can find further information on the budget line item identifiers, or project identifiers, provided here.

planning/budget/finance

array[Financing arrangement]

Finance

Information about financing arrangements for a future contracting process.

planning/budget/finance/0/id

string

Required

ID

An identifier for this financing arrangement.

planning/budget/finance/0/title

[string, null]

Title

A short title for this financing arrangement.

planning/budget/finance/0/description

[string, null]

Description

A short description of this financing arrangement. This may include details of service fees, commitment fees, lender rights, step in arrangements, exchange rate guarantees, and for syndicated loans, details of syndication and any members of the syndicate.

planning/budget/finance/0/value

object

Value

The total value of this finance.

planning/budget/finance/0/value/amount

[number, null]

Amount

Amount as a number.

planning/budget/finance/0/value/currency

[string, null]

Currency

The currency of the amount, from the closed currency codelist.

planning/budget/finance/0/financingParty

object

Financing organization

The organization providing this financing arrangement.

planning/budget/finance/0/financingParty/name

[string, null]

Organization name

The name of the party being referenced. This must match the name of an entry in the parties section.

planning/budget/finance/0/financingParty/id

[string, integer]

Organization ID

The id of the party being referenced. This must match the id of an entry in the parties section.

planning/budget/finance/0/financingParty/identifier

object

Primary identifier

The primary identifier for this organization. Identifiers that uniquely pick out a legal entity should be preferred. Consult the organization identifier guidance for the preferred scheme and identifier to use.

planning/budget/finance/0/financingParty/identifier/scheme

[string, null]

Scheme

Organization identifiers should be taken from an existing organization identifier list. The scheme field is used to indicate the list or register from which the identifier is taken. This value should be taken from the Organization Identifier Scheme codelist.

planning/budget/finance/0/financingParty/identifier/id

[string, integer, null]

ID

The identifier of the organization in the selected scheme.

planning/budget/finance/0/financingParty/identifier/legalName

[string, null]

Legal Name

The legally registered name of the organization.

planning/budget/finance/0/financingParty/identifier/uri

[string, null]

uri

URI

A URI to identify the organization, such as those provided by Open Corporates or some other relevant URI provider. This is not for listing the website of the organization: that can be done through the URL field of the Organization contact point.

planning/budget/finance/0/financingParty/address

object

Address

(Deprecated outside the parties section)

planning/budget/finance/0/financingParty/address/streetAddress

[string, null]

Street address

The street address. For example, 1600 Amphitheatre Pkwy.

planning/budget/finance/0/financingParty/address/locality

[string, null]

Locality

The locality. For example, Mountain View.

planning/budget/finance/0/financingParty/address/region

[string, null]

Region

The region. For example, CA.

planning/budget/finance/0/financingParty/address/postalCode

[string, null]

Postal code

The postal code. For example, 94043.

planning/budget/finance/0/financingParty/address/countryName

[string, null]

Country name

The country name. For example, United States.

planning/budget/finance/0/financingParty/additionalIdentifiers

array[Identifier]

Additional identifiers

(Deprecated outside the parties section) A list of additional / supplemental identifiers for the organization, using the organization identifier guidance. This can be used to provide an internally used identifier for this organization in addition to the primary legal entity identifier.

planning/budget/finance/0/financingParty/additionalIdentifiers/0/scheme

[string, null]

Scheme

Organization identifiers should be taken from an existing organization identifier list. The scheme field is used to indicate the list or register from which the identifier is taken. This value should be taken from the Organization Identifier Scheme codelist.

planning/budget/finance/0/financingParty/additionalIdentifiers/0/id

[string, integer, null]

ID

The identifier of the organization in the selected scheme.

planning/budget/finance/0/financingParty/additionalIdentifiers/0/legalName

[string, null]

Legal Name

The legally registered name of the organization.

planning/budget/finance/0/financingParty/additionalIdentifiers/0/uri

[string, null]

uri

URI

A URI to identify the organization, such as those provided by Open Corporates or some other relevant URI provider. This is not for listing the website of the organization: that can be done through the URL field of the Organization contact point.

planning/budget/finance/0/financingParty/contactPoint

object

Contact point

(Deprecated outside the parties section)

planning/budget/finance/0/financingParty/contactPoint/name

[string, null]

Name

The name of the contact person, department, or contact point, for correspondence relating to this contracting process.

planning/budget/finance/0/financingParty/contactPoint/email

[string, null]

Email

The e-mail address of the contact point/person.

planning/budget/finance/0/financingParty/contactPoint/telephone

[string, null]

Telephone

The telephone number of the contact point/person. This should include the international dialing code.

planning/budget/finance/0/financingParty/contactPoint/faxNumber

[string, null]

Fax number

The fax number of the contact point/person. This should include the international dialing code.

planning/budget/finance/0/financingParty/contactPoint/url

[string, null]

uri

URL

A web address for the contact point/person.

planning/budget/finance/0/financingPartyType

[string, null]

Financing organization type

The type of the financing organization, from the closed financingPartyType codelist.

planning/budget/finance/0/source

[string, null]

Funding source

The source of funds for this financing arrangement. For example, the Green Climate Fund.

planning/budget/finance/0/assetClass

array[string]

Asset class

The asset classes used in this financing arrangement, from the closed assetClass codelist.

planning/budget/finance/0/type

[string, null]

Type

The type of this financing arrangement, from the closed financingArrangementType codelist.

planning/budget/finance/0/repaymentPriority

[string, null]

Repayment priority

The order in which the debt in this financing arrangement will be repaid in case of default, from the closed debtRepaymentPriority codelist.

planning/budget/finance/0/concessional

[boolean, null]

Concessional

Whether this financing arrangement is provided below market rate in order to accelerate climate or development objectives. Also called soft financing and subsidized funding.

planning/budget/finance/0/resultsBased

[boolean, null]

Results based

Whether payments under this financing arrangement are contingent on the achievement of pre-defined results.

planning/budget/finance/0/period

object

Finance period

The period covered by this financing arrangement. Also called maturity.

planning/budget/finance/0/period/startDate

[string, null]

date-time

Start date

The start date for the period. When known, a precise start date must be provided.

planning/budget/finance/0/period/endDate

[string, null]

date-time

End date

The end date for the period. When known, a precise end date must be provided.

planning/budget/finance/0/period/maxExtentDate

[string, null]

date-time

Maximum extent

The period cannot be extended beyond this date. This field can be used to express the maximum available date for extension or renewal of this period.

planning/budget/finance/0/period/durationInDays

[integer, null]

Duration (days)

The maximum duration of this period in days. A user interface can collect or display this data in months or years as appropriate, and then convert it into days when storing this field. This field can be used when exact dates are not known. If a startDate and endDate are set, this field, if used, should be equal to the difference between startDate and endDate. Otherwise, if a startDate and maxExtentDate are set, this field, if used, should be equal to the difference between startDate and maxExtentDate.

planning/budget/finance/0/paymentPeriod

object

Payment period

The period over which the borrower in this financing arrangement is obliged to make payments.

planning/budget/finance/0/paymentPeriod/startDate

[string, null]

date-time

Start date

The start date for the period. When known, a precise start date must be provided.

planning/budget/finance/0/paymentPeriod/endDate

[string, null]

date-time

End date

The end date for the period. When known, a precise end date must be provided.

planning/budget/finance/0/paymentPeriod/maxExtentDate

[string, null]

date-time

Maximum extent

The period cannot be extended beyond this date. This field can be used to express the maximum available date for extension or renewal of this period.

planning/budget/finance/0/paymentPeriod/durationInDays

[integer, null]

Duration (days)

The maximum duration of this period in days. A user interface can collect or display this data in months or years as appropriate, and then convert it into days when storing this field. This field can be used when exact dates are not known. If a startDate and endDate are set, this field, if used, should be equal to the difference between startDate and endDate. Otherwise, if a startDate and maxExtentDate are set, this field, if used, should be equal to the difference between startDate and maxExtentDate.

planning/budget/finance/0/paymentFrequency

[number, null]

Payment frequency (days)

The average payment frequency (in days) of this financing arrangement. For example, 365 for yearly, 30.4 for monthly, or 1 for daily.

planning/budget/finance/0/interestRate

object

Interest rate

The interest rate associated with this finance.

planning/budget/finance/0/interestRate/base

[string, number, null]

Base

The variable to which an additional margin amount is added to get the interest amount. This can be specified as a fixed number, as a known variable (e.g. LIBOR or LIBOR+1%), or can be omitted if margin specifies the entire interest rate.

planning/budget/finance/0/interestRate/margin

[number, null]

Margin

The variable added to the base to give the interest amount, expressed as a decimal (for example, 0.1) and not as a percentage (for example, 10).

planning/budget/finance/0/interestRate/fixed

[boolean, null]

Fixed rate

A boolean field. If this interest rate of fixed, set to true. Otherwise, set to false.

planning/budget/finance/0/interestRate/notes

[string, null]

Notes

Any explanatory notes concerning the interest rate.

planning/budget/finance/0/exchangeRateGuarantee

[boolean, null]

Exchange rate guarantees

Whether there is an associated exchange rate guarantee with this source of finance.

planning/budget/finance/0/stepInRights

[boolean, null]

Step in rights

Whether provision of this finance confers any step in rights to the financing organization.

planning/budget/finance/0/relatedLots

array[string]

Related lot(s)

The identifiers of the lots to which this financing arrangement relates.

planning/documents

array[Document]

Documents

A list of documents related to the planning process.

planning/documents/0/id

[string, integer]

Required

ID

A local, unique identifier for this document. This field is used to keep track of multiple revisions of a document through the compilation from release to record mechanism.

planning/documents/0/documentType

[string, null]

Document type

A classification of the document described, using the open documentType codelist.

planning/documents/0/title

[string, null]

Title

The document title.

planning/documents/0/description

[string, null]

Description

A short description of the document. Descriptions are recommended to not exceed 250 words. In the event the document is not accessible online, the description field can be used to describe arrangements for obtaining a copy of the document.

planning/documents/0/url

[string, null]

uri

URL

A direct link to the document or attachment. The server providing access to this document ought to be configured to correctly report the document mime type.

planning/documents/0/datePublished

[string, null]

date-time

Date published

The date on which the document was first published. This is particularly important for legally important documents such as notices of a tender.

planning/documents/0/dateModified

[string, null]

date-time

Date modified

Date that the document was last modified

planning/documents/0/format

[string, null]

Format

The format of the document, using the open IANA Media Types codelist (see the values in the 'Template' column), or using the 'offline/print' code if the described document is published offline. For example, web pages have a format of 'text/html'.

planning/documents/0/language

[string, null]

Language

The language of the linked document using either two-letter ISO639-1, or extended BCP47 language tags. The use of lowercase two-letter codes from ISO639-1 is recommended unless there is a clear user need for distinguishing the language subtype.

planning/documents/0/pageStart

[string, null]

Page start

When the information referenced exists within a large document, indicate the first page on which it can be found. This should refer to the printed page number, not the page number reported by software applications.

planning/documents/0/pageEnd

[string, null]

Page end

When the information referenced exists within a large document, indicate the last page on which it can be found. This should refer to the printed page number, not the page number reported by software applications.

planning/documents/0/accessDetails

[string, null]

Access details

A description of any special arrangements needed to access this document, for example: registering for access, paying a fee, or visiting a location to inspect the document.

planning/documents/0/accessDetailsURL

[string, null]

uri

Access details URL

A web address for information on any special arrangements needed to access the document.

planning/documents/0/author

[string, null]

Author

The names of the authors of the document.

planning/documents/0/unofficialTranslations

array[string]

Unofficial translations

The languages in which unofficial translations of the document are available, from the open language codelist. A BCP47 language tag is allowed, if there is a user need for the additional information.

planning/milestones

array[Milestone]

Planning milestones

A list of milestones associated with the planning stage.

planning/milestones/0/id

[string, integer]

Required

ID

A local identifier for this milestone, unique within this block. This field is used to keep track of multiple revisions of a milestone through the compilation from release to record mechanism.

planning/milestones/0/title

[string, null]

Title

Milestone title

planning/milestones/0/type

[string, null]

Milestone type

The nature of the milestone, using the open milestoneType codelist.

planning/milestones/0/description

[string, null]

Description

A description of the milestone.

planning/milestones/0/code

[string, null]

Milestone code

Milestone codes can be used to track specific events that take place for a particular kind of contracting process. For example, a code of 'approvalLetter' can be used to allow applications to understand this milestone represents the date an approvalLetter is due or signed.

planning/milestones/0/dueDate

[string, null]

date-time

Due date

The date the milestone is due.

planning/milestones/0/dateMet

[string, null]

date-time

Date met

The date on which the milestone was met.

planning/milestones/0/dateModified

[string, null]

date-time

Date modified

The date the milestone was last reviewed or modified and the status was altered or confirmed to still be correct.

planning/milestones/0/status

[string, null]

Status

The status that was realized on the date provided in dateModified, from the closed milestoneStatus codelist.

planning/milestones/0/documents

array[Document]

Documents

List of documents associated with this milestone (Deprecated in 1.1).

planning/milestones/0/documents/0/id

[string, integer]

Required

ID

A local, unique identifier for this document. This field is used to keep track of multiple revisions of a document through the compilation from release to record mechanism.

planning/milestones/0/documents/0/documentType

[string, null]

Document type

A classification of the document described, using the open documentType codelist.

planning/milestones/0/documents/0/title

[string, null]

Title

The document title.

planning/milestones/0/documents/0/description

[string, null]

Description

A short description of the document. Descriptions are recommended to not exceed 250 words. In the event the document is not accessible online, the description field can be used to describe arrangements for obtaining a copy of the document.

planning/milestones/0/documents/0/url

[string, null]

uri

URL

A direct link to the document or attachment. The server providing access to this document ought to be configured to correctly report the document mime type.

planning/milestones/0/documents/0/datePublished

[string, null]

date-time

Date published

The date on which the document was first published. This is particularly important for legally important documents such as notices of a tender.

planning/milestones/0/documents/0/dateModified

[string, null]

date-time

Date modified

Date that the document was last modified

planning/milestones/0/documents/0/format

[string, null]

Format

The format of the document, using the open IANA Media Types codelist (see the values in the 'Template' column), or using the 'offline/print' code if the described document is published offline. For example, web pages have a format of 'text/html'.

planning/milestones/0/documents/0/language

[string, null]

Language

The language of the linked document using either two-letter ISO639-1, or extended BCP47 language tags. The use of lowercase two-letter codes from ISO639-1 is recommended unless there is a clear user need for distinguishing the language subtype.

planning/milestones/0/documents/0/pageStart

[string, null]

Page start

When the information referenced exists within a large document, indicate the first page on which it can be found. This should refer to the printed page number, not the page number reported by software applications.

planning/milestones/0/documents/0/pageEnd

[string, null]

Page end

When the information referenced exists within a large document, indicate the last page on which it can be found. This should refer to the printed page number, not the page number reported by software applications.

planning/milestones/0/documents/0/accessDetails

[string, null]

Access details

A description of any special arrangements needed to access this document, for example: registering for access, paying a fee, or visiting a location to inspect the document.

planning/milestones/0/documents/0/accessDetailsURL

[string, null]

uri

Access details URL

A web address for information on any special arrangements needed to access the document.

planning/milestones/0/documents/0/author

[string, null]

Author

The names of the authors of the document.

planning/milestones/0/documents/0/unofficialTranslations

array[string]

Unofficial translations

The languages in which unofficial translations of the document are available, from the open language codelist. A BCP47 language tag is allowed, if there is a user need for the additional information.

planning/forecasts

array[Metric]

Forecasts

Any forecasts metrics for a future contracting process.

planning/forecasts/0/id

string

Required

Identifier

An identifier for this metric. In some cases this may be drawn from a codelist of metrics required for this type of contracting process, or in other instances may be an arbitrary identifier.

planning/forecasts/0/title

[string, null]

Title

The title of this metric

planning/forecasts/0/description

[string, null]

Description

A short description of the metric. This may include short details of measurement methods.

planning/forecasts/0/observations

array[Observation]

Observations

An array of target or actual values for this metric.

planning/forecasts/0/observations/0/id

string

Required

Identifier

A local identifier for this specific observation. This may be an arbitrary identifier, or could be a composite of the metric identifier, and the date and other dimensions of this observation.

planning/forecasts/0/observations/0/period

object

Period

The period over which this observation is measured.

planning/forecasts/0/observations/0/period/startDate

[string, null]

date-time

Start date

The start date for the period. When known, a precise start date must be provided.

planning/forecasts/0/observations/0/period/endDate

[string, null]

date-time

End date

The end date for the period. When known, a precise end date must be provided.

planning/forecasts/0/observations/0/period/maxExtentDate

[string, null]

date-time

Maximum extent

The period cannot be extended beyond this date. This field can be used to express the maximum available date for extension or renewal of this period.

planning/forecasts/0/observations/0/period/durationInDays

[integer, null]

Duration (days)

The maximum duration of this period in days. A user interface can collect or display this data in months or years as appropriate, and then convert it into days when storing this field. This field can be used when exact dates are not known. If a startDate and endDate are set, this field, if used, should be equal to the difference between startDate and endDate. Otherwise, if a startDate and maxExtentDate are set, this field, if used, should be equal to the difference between startDate and maxExtentDate.

planning/forecasts/0/observations/0/value

object

Value

For financial metrics, the value of this forecast, target or actual observation.

planning/forecasts/0/observations/0/value/amount

[number, null]

Amount

Amount as a number.

planning/forecasts/0/observations/0/value/currency

[string, null]

Currency

The currency of the amount, from the closed currency codelist.

planning/forecasts/0/observations/0/measure

[string, number, null]

Measure

For non-financial metrics, the measure of this forecast, target or actual observation. Measures may be provided as free text or numerical values.

planning/forecasts/0/observations/0/unit

object

Unit

Unit

planning/forecasts/0/observations/0/unit/name

[string, null]

Unit name

The name of the unit.

planning/forecasts/0/observations/0/unit/scheme

[string, null]

Scheme

The list from which units of measure identifiers are taken. It is recommended to use the scheme 'UNCEFACT' and codes from the UN/CEFACT Recommendation 20 list of "Codes for Units of Measure Used in International Trade".

planning/forecasts/0/observations/0/unit/id

[string, null]

ID

The identifier from the codelist referenced in the scheme field. For example, with UNCEFACT, this is the value of the 'Common Code' column. From this identifier, applications can look-up the human readable name or symbol for this unit of measure.

planning/forecasts/0/observations/0/unit/uri

[string, null]

uri

URI

If the scheme used provide a machine-readable URI for this unit of measure, this can be given.

planning/forecasts/0/observations/0/dimensions

object

Dimensions

Any number of dimensions can be recorded within this object. Dimensions names should follow the camelCase conventions of OCDS.

planning/forecasts/0/observations/0/notes

[string, null]

Notes

Any notes on this observation. This may include clarifying information.

planning/forecasts/0/observations/0/relatedImplementationMilestone

object

Related implementation milestone

A link to the milestone in the implementation section of OCDS to which this forecast, target or actual observation relates.

planning/forecasts/0/observations/0/relatedImplementationMilestone/id

string

Required

Milestone ID

The ID of the milestone being referenced, this must match the ID of a milestone described elsewhere in a release about this contracting process.

planning/forecasts/0/observations/0/relatedImplementationMilestone/title

[string, null]

Milestone title

The title of the milestone being referenced, this must match the title of a milestone described elsewhere in a release about this contracting process.

planning/project

object

Project information

Information about the infrastructure or public-private partnership project to which the planning process is related.

planning/project/id

[string, null]

Identifier

An externally provided identifier for the project. This can be a URI, an identifier from a projects register, or based on the canonical version of the project's name. Project identifiers should be unique within the scope of the publication.

planning/project/title

[string, null]

Title

The name of the project. If a projects register is available, this should be the same as the project's name in that register.

planning/project/description

[string, null]

Description

A short description of the project.

planning/project/totalValue

object

Total value

The total anticipated value of the project over its lifetime.

planning/project/totalValue/amount

[number, null]

Amount

Amount as a number.

planning/project/totalValue/currency

[string, null]

Currency

The currency of the amount, from the closed currency codelist.

planning/project/uri

[string, null]

uri

URI

The URI of a resource with additional information about the project.

planning/project/sector

object

Sector

The primary sector to which the project relates. It is recommended to use the scheme 'oc4idsProjectSector' and codes from the OC4IDS projectSector codelist.

planning/project/sector/scheme

[string, null]

Scheme

The scheme or codelist from which the classification code is taken. For line item classifications, this uses the open itemClassificationScheme codelist.

planning/project/sector/id

[string, integer, null]

ID

The classification code taken from the scheme.

planning/project/sector/description

[string, null]

Description

A textual description or title for the classification code.

planning/project/sector/uri

[string, null]

uri

URI

A URI to uniquely identify the classification code.

planning/project/additionalClassifications

array[Classification]

Additional classifications

Additional classifications for the project. For example, a sector or strategic framework classification.

planning/project/additionalClassifications/0/scheme

[string, null]

Scheme

The scheme or codelist from which the classification code is taken. For line item classifications, this uses the open itemClassificationScheme codelist.

planning/project/additionalClassifications/0/id

[string, integer, null]

ID

The classification code taken from the scheme.

planning/project/additionalClassifications/0/description

[string, null]

Description

A textual description or title for the classification code.

planning/project/additionalClassifications/0/uri

[string, null]

uri

URI

A URI to uniquely identify the classification code.

planning/project/locations

array[Delivery Location]

Locations

Information about the locations where the project is taking place.

planning/project/locations/0/description

[string, null]

Description

A name or description of this location. This might include the name(s) of the location(s), or might provide a human-readable description of the location to be covered.

planning/project/locations/0/geometry

object

Geometry

We follow the GeoJSON standard to express basic location information, using longitude, latitude, and optional elevation values in the WGS84 (EPSG:4326) projection. A point location can be identified by geocoding a delivery address. For concession licenses, or other contracts covering a polygon location which is not contained in a known gazetteer, polygon and multi-polygon can be used.

planning/project/locations/0/geometry/type

[string, null]

Type

The type of GeoJSON Geometry Objects being provided. To provide longitude, latitude, and optional elevation, use 'Point', and enter an array of [longitude, latitude] or [longitude, latitude, elevation] as the value of the coordinates field: e.g. [-122.085, 37.42].

planning/project/locations/0/geometry/coordinates

array[[number, array]]

Coordinates

The relevant array of points, e.g. [longitude, latitude] or [longitude, latitude, elevation], or a nested array of points, for the GeoJSON geometry being described. The longitude and latitude must be expressed in decimal degrees in the WGS84 (EPSG:4326) projection.

planning/project/locations/0/gazetteer

object

Gazetteer

Identifiers from a gazetteer (a geographical index or directory) for the location.

planning/project/locations/0/gazetteer/scheme

[string, null]

Gazetteer scheme

The identifier of the gazetteer. The locationGazetteers.csv codelist provides details of services, where available, that can resolve a gazetteer entry to provide location names.

planning/project/locations/0/gazetteer/identifiers

array[[string]]

Identifiers

An array of one or more codes drawn from the gazetteer indicated by the scheme field.

planning/project/locations/0/uri

[string, null]

URI

A URI to a further description of the activity location. This might be a human-readable document with information on the location, or a machine-readable description of the location.

tender

object

Tender

The activities undertaken in order to enter into a contract.

tender/id

[string, integer]

Required

Tender ID

An identifier for this tender process. This may be the same as the ocid, or may be an internal identifier for this tender.

tender/title

[string, null]

Tender title

A title for this tender. This will often be used by applications as a headline to attract interest, and to help analysts understand the nature of this procurement.

tender/description

[string, null]

Tender description

A summary description of the tender. This complements any structured information provided using the items array. Descriptions should be short and easy to read. Avoid using ALL CAPS.

tender/status

[string, null]

Tender status

The current status of the tender, from the closed tenderStatus codelist.

tender/procuringEntity

object

Procuring entity

The entity managing the procurement. This may be different from the buyer who pays for, or uses, the items being procured.

tender/procuringEntity/name

[string, null]

Organization name

The name of the party being referenced. This must match the name of an entry in the parties section.

tender/procuringEntity/id

[string, integer]

Organization ID

The id of the party being referenced. This must match the id of an entry in the parties section.

tender/procuringEntity/identifier

object

Primary identifier

The primary identifier for this organization. Identifiers that uniquely pick out a legal entity should be preferred. Consult the organization identifier guidance for the preferred scheme and identifier to use.

tender/procuringEntity/identifier/scheme

[string, null]

Scheme

Organization identifiers should be taken from an existing organization identifier list. The scheme field is used to indicate the list or register from which the identifier is taken. This value should be taken from the Organization Identifier Scheme codelist.

tender/procuringEntity/identifier/id

[string, integer, null]

ID

The identifier of the organization in the selected scheme.

tender/procuringEntity/identifier/legalName

[string, null]

Legal Name

The legally registered name of the organization.

tender/procuringEntity/identifier/uri

[string, null]

uri

URI

A URI to identify the organization, such as those provided by Open Corporates or some other relevant URI provider. This is not for listing the website of the organization: that can be done through the URL field of the Organization contact point.

tender/procuringEntity/address

object

Address

(Deprecated outside the parties section)

tender/procuringEntity/address/streetAddress

[string, null]

Street address

The street address. For example, 1600 Amphitheatre Pkwy.

tender/procuringEntity/address/locality

[string, null]

Locality

The locality. For example, Mountain View.

tender/procuringEntity/address/region

[string, null]

Region

The region. For example, CA.

tender/procuringEntity/address/postalCode

[string, null]

Postal code

The postal code. For example, 94043.

tender/procuringEntity/address/countryName

[string, null]

Country name

The country name. For example, United States.

tender/procuringEntity/additionalIdentifiers

array[Identifier]

Additional identifiers

(Deprecated outside the parties section) A list of additional / supplemental identifiers for the organization, using the organization identifier guidance. This can be used to provide an internally used identifier for this organization in addition to the primary legal entity identifier.

tender/procuringEntity/additionalIdentifiers/0/scheme

[string, null]

Scheme

Organization identifiers should be taken from an existing organization identifier list. The scheme field is used to indicate the list or register from which the identifier is taken. This value should be taken from the Organization Identifier Scheme codelist.

tender/procuringEntity/additionalIdentifiers/0/id

[string, integer, null]

ID

The identifier of the organization in the selected scheme.

tender/procuringEntity/additionalIdentifiers/0/legalName

[string, null]

Legal Name

The legally registered name of the organization.

tender/procuringEntity/additionalIdentifiers/0/uri

[string, null]

uri

URI

A URI to identify the organization, such as those provided by Open Corporates or some other relevant URI provider. This is not for listing the website of the organization: that can be done through the URL field of the Organization contact point.

tender/procuringEntity/contactPoint

object

Contact point

(Deprecated outside the parties section)

tender/procuringEntity/contactPoint/name

[string, null]

Name

The name of the contact person, department, or contact point, for correspondence relating to this contracting process.

tender/procuringEntity/contactPoint/email

[string, null]

Email

The e-mail address of the contact point/person.

tender/procuringEntity/contactPoint/telephone

[string, null]

Telephone

The telephone number of the contact point/person. This should include the international dialing code.

tender/procuringEntity/contactPoint/faxNumber

[string, null]

Fax number

The fax number of the contact point/person. This should include the international dialing code.

tender/procuringEntity/contactPoint/url

[string, null]

uri

URL

A web address for the contact point/person.

tender/items

array[Item]

Items to be procured

The goods and services to be purchased, broken into line items wherever possible. Items should not be duplicated, but the quantity specified instead.

tender/items/0/id

[string, integer]

Required

ID

A local identifier to reference and merge the items by. Must be unique within a given array of items.

tender/items/0/description

[string, null]

Description

A description of the goods, services to be provided.

tender/items/0/classification

object

Classification

The primary classification for the item.

tender/items/0/classification/scheme

[string, null]

Scheme

The scheme or codelist from which the classification code is taken. For line item classifications, this uses the open itemClassificationScheme codelist.

tender/items/0/classification/id

[string, integer, null]

ID

The classification code taken from the scheme.

tender/items/0/classification/description

[string, null]

Description

A textual description or title for the classification code.

tender/items/0/classification/uri

[string, null]

uri

URI

A URI to uniquely identify the classification code.

tender/items/0/additionalClassifications

array[Classification]

Additional classifications

An array of additional classifications for the item.

tender/items/0/additionalClassifications/0/scheme

[string, null]

Scheme

The scheme or codelist from which the classification code is taken. For line item classifications, this uses the open itemClassificationScheme codelist.

tender/items/0/additionalClassifications/0/id

[string, integer, null]

ID

The classification code taken from the scheme.

tender/items/0/additionalClassifications/0/description

[string, null]

Description

A textual description or title for the classification code.

tender/items/0/additionalClassifications/0/uri

[string, null]

uri

URI

A URI to uniquely identify the classification code.

tender/items/0/quantity

[number, null]

Quantity

The number of units to be provided.

tender/items/0/unit

object

Unit

A description of the unit in which the supplies, services or works are provided (e.g. hours, kilograms) and the unit-price.

tender/items/0/unit/scheme

[string, null]

Scheme

The list from which identifiers for units of measure are taken, using the open unitClassificationScheme codelist. 'UNCEFACT' is recommended.

tender/items/0/unit/id

[string, null]

ID

The identifier from the codelist referenced in the scheme field. Check the unitClassificationScheme codelist for details of how to find and use identifiers from the scheme in use.

tender/items/0/unit/name

[string, null]

Name

Name of the unit.

tender/items/0/unit/value

object

Value

The monetary value of a single unit.

tender/items/0/unit/value/amount

[number, null]

Amount

Amount as a number.

tender/items/0/unit/value/currency

[string, null]

Currency

The currency of the amount, from the closed currency codelist.

tender/items/0/unit/uri

[string, null]

uri

URI

The machine-readable URI for the unit of measure, provided by the scheme.

tender/items/0/deliveryLocation

object

Delivery Location

The location where activity related to this tender, contract or license will be delivered, or will take place.

tender/items/0/deliveryLocation/description

[string, null]

Description

A name or description of this location. This might include the name(s) of the location(s), or might provide a human-readable description of the location to be covered.

tender/items/0/deliveryLocation/geometry

object

Geometry

We follow the GeoJSON standard to express basic location information, using longitude, latitude, and optional elevation values in the WGS84 (EPSG:4326) projection. A point location can be identified by geocoding a delivery address. For concession licenses, or other contracts covering a polygon location which is not contained in a known gazetteer, polygon and multi-polygon can be used.

tender/items/0/deliveryLocation/geometry/type

[string, null]

Type

The type of GeoJSON Geometry Objects being provided. To provide longitude, latitude, and optional elevation, use 'Point', and enter an array of [longitude, latitude] or [longitude, latitude, elevation] as the value of the coordinates field: e.g. [-122.085, 37.42].

tender/items/0/deliveryLocation/geometry/coordinates

array[[number, array]]

Coordinates

The relevant array of points, e.g. [longitude, latitude] or [longitude, latitude, elevation], or a nested array of points, for the GeoJSON geometry being described. The longitude and latitude must be expressed in decimal degrees in the WGS84 (EPSG:4326) projection.

tender/items/0/deliveryLocation/gazetteer

object

Gazetteer

Identifiers from a gazetteer (a geographical index or directory) for the location.

tender/items/0/deliveryLocation/gazetteer/scheme

[string, null]

Gazetteer scheme

The identifier of the gazetteer. The locationGazetteers.csv codelist provides details of services, where available, that can resolve a gazetteer entry to provide location names.

tender/items/0/deliveryLocation/gazetteer/identifiers

array[[string]]

Identifiers

An array of one or more codes drawn from the gazetteer indicated by the scheme field.

tender/items/0/deliveryLocation/uri

[string, null]

URI

A URI to a further description of the activity location. This might be a human-readable document with information on the location, or a machine-readable description of the location.

tender/items/0/deliveryAddress

object

Delivery Address

The address to which, or where, goods or services related to this tender, contract or license will be delivered.

tender/items/0/deliveryAddress/streetAddress

[string, null]

Street address

The street address. For example, 1600 Amphitheatre Pkwy.

tender/items/0/deliveryAddress/locality

[string, null]

Locality

The locality. For example, Mountain View.

tender/items/0/deliveryAddress/region

[string, null]

Region

The region. For example, CA.

tender/items/0/deliveryAddress/postalCode

[string, null]

Postal code

The postal code. For example, 94043.

tender/items/0/deliveryAddress/countryName

[string, null]

Country name

The country name. For example, United States.

tender/value

object

Value

The total upper estimated value of the procurement. A negative value indicates that the contracting process may involve payments from the supplier to the buyer (commonly used in concession contracts).

tender/value/amount

[number, null]

Amount

Amount as a number.

tender/value/currency

[string, null]

Currency

The currency of the amount, from the closed currency codelist.

tender/minValue

object

Minimum value

The minimum estimated value of the procurement. A negative value indicates that the contracting process may involve payments from the supplier to the buyer (commonly used in concession contracts).

tender/minValue/amount

[number, null]

Amount

Amount as a number.

tender/minValue/currency

[string, null]

Currency

The currency of the amount, from the closed currency codelist.

tender/procurementMethod

[string, null]

Procurement method

The procurement method, from the closed method codelist.

tender/procurementMethodDetails

[string, null]

Procurement method details

Additional detail on the procurement method used. This field can be used to provide the local name of the particular procurement method used.

tender/procurementMethodRationale

[string, null]

Procurement method rationale

Rationale for the chosen procurement method. This is especially important to provide a justification in the case of limited tenders or direct awards.

tender/mainProcurementCategory

[string, null]

Main procurement category

The primary category describing the main object of this contracting process, from the closed procurementCategory codelist.

tender/additionalProcurementCategories

array[string]

Additional procurement categories

Any additional categories describing the objects of this contracting process, using the open extendedProcurementCategory codelist.

tender/awardCriteria

[string, null]

Award criteria

The award criteria for the procurement, using the open awardCriteria codelist.

tender/awardCriteriaDetails

[string, null]

Award criteria details

Any detailed or further information on the award or selection criteria.

tender/submissionMethod

array[string]

Submission method

The methods by which bids are submitted, using the open submissionMethod codelist.

tender/submissionMethodDetails

[string, null]

Submission method details

Any detailed or further information on the submission method. This can include the address, e-mail address or online service to which bids are submitted, and any special requirements to be followed for submissions.

tender/tenderPeriod

object

Tender period

The period when the tender is open for submissions. The end date is the closing date for tender submissions.

tender/tenderPeriod/startDate

[string, null]

date-time

Start date

The start date for the period. When known, a precise start date must be provided.

tender/tenderPeriod/endDate

[string, null]

date-time

End date

The end date for the period. When known, a precise end date must be provided.

tender/tenderPeriod/maxExtentDate

[string, null]

date-time

Maximum extent

The period cannot be extended beyond this date. This field can be used to express the maximum available date for extension or renewal of this period.

tender/tenderPeriod/durationInDays

[integer, null]

Duration (days)

The maximum duration of this period in days. A user interface can collect or display this data in months or years as appropriate, and then convert it into days when storing this field. This field can be used when exact dates are not known. If a startDate and endDate are set, this field, if used, should be equal to the difference between startDate and endDate. Otherwise, if a startDate and maxExtentDate are set, this field, if used, should be equal to the difference between startDate and maxExtentDate.

tender/enquiryPeriod

object

Enquiry period

The period during which potential bidders may submit questions and requests for clarification to the entity managing procurement. Details of how to submit enquiries should be provided in attached notices, or in submissionMethodDetails. Structured dates for when responses to questions will be made can be provided using tender milestones.

tender/enquiryPeriod/startDate

[string, null]

date-time

Start date

The start date for the period. When known, a precise start date must be provided.

tender/enquiryPeriod/endDate

[string, null]

date-time

End date

The end date for the period. When known, a precise end date must be provided.

tender/enquiryPeriod/maxExtentDate

[string, null]

date-time

Maximum extent

The period cannot be extended beyond this date. This field can be used to express the maximum available date for extension or renewal of this period.

tender/enquiryPeriod/durationInDays

[integer, null]

Duration (days)

The maximum duration of this period in days. A user interface can collect or display this data in months or years as appropriate, and then convert it into days when storing this field. This field can be used when exact dates are not known. If a startDate and endDate are set, this field, if used, should be equal to the difference between startDate and endDate. Otherwise, if a startDate and maxExtentDate are set, this field, if used, should be equal to the difference between startDate and maxExtentDate.

tender/hasEnquiries

[boolean, null]

Has enquiries?

A true/false field to indicate whether any enquiries were received during the tender process. Structured information on enquiries that were received, and responses to them, can be provided using the enquiries extension.

tender/eligibilityCriteria

[string, null]

Eligibility criteria

A description of any eligibility criteria for potential suppliers.

tender/awardPeriod

object

Evaluation and award period

The period for decision making regarding the contract award. The end date should be the date on which an award decision is due to be finalized. The start date may be used to indicate the start of an evaluation period.

tender/awardPeriod/startDate

[string, null]

date-time

Start date

The start date for the period. When known, a precise start date must be provided.

tender/awardPeriod/endDate

[string, null]

date-time

End date

The end date for the period. When known, a precise end date must be provided.

tender/awardPeriod/maxExtentDate

[string, null]

date-time

Maximum extent

The period cannot be extended beyond this date. This field can be used to express the maximum available date for extension or renewal of this period.

tender/awardPeriod/durationInDays

[integer, null]

Duration (days)

The maximum duration of this period in days. A user interface can collect or display this data in months or years as appropriate, and then convert it into days when storing this field. This field can be used when exact dates are not known. If a startDate and endDate are set, this field, if used, should be equal to the difference between startDate and endDate. Otherwise, if a startDate and maxExtentDate are set, this field, if used, should be equal to the difference between startDate and maxExtentDate.

tender/contractPeriod

object

Contract period

The period over which the contract is estimated or required to be active. If the tender does not specify explicit dates, the duration field may be used.

tender/contractPeriod/startDate

[string, null]

date-time

Start date

The start date for the period. When known, a precise start date must be provided.

tender/contractPeriod/endDate

[string, null]

date-time

End date

The end date for the period. When known, a precise end date must be provided.

tender/contractPeriod/maxExtentDate

[string, null]

date-time

Maximum extent

The period cannot be extended beyond this date. This field can be used to express the maximum available date for extension or renewal of this period.

tender/contractPeriod/durationInDays

[integer, null]

Duration (days)

The maximum duration of this period in days. A user interface can collect or display this data in months or years as appropriate, and then convert it into days when storing this field. This field can be used when exact dates are not known. If a startDate and endDate are set, this field, if used, should be equal to the difference between startDate and endDate. Otherwise, if a startDate and maxExtentDate are set, this field, if used, should be equal to the difference between startDate and maxExtentDate.

tender/numberOfTenderers

[integer, null]

Number of tenderers

The number of parties who submit a bid.

tender/tenderers

array[Organization reference]

Tenderers

All parties who submit a bid on a tender. More detailed information on bids and the bidding organization can be provided using the bid extension.

tender/tenderers/0/name

[string, null]

Organization name

The name of the party being referenced. This must match the name of an entry in the parties section.

tender/tenderers/0/id

[string, integer]

Organization ID

The id of the party being referenced. This must match the id of an entry in the parties section.

tender/tenderers/0/identifier

object

Primary identifier

The primary identifier for this organization. Identifiers that uniquely pick out a legal entity should be preferred. Consult the organization identifier guidance for the preferred scheme and identifier to use.

tender/tenderers/0/identifier/scheme

[string, null]

Scheme

Organization identifiers should be taken from an existing organization identifier list. The scheme field is used to indicate the list or register from which the identifier is taken. This value should be taken from the Organization Identifier Scheme codelist.

tender/tenderers/0/identifier/id

[string, integer, null]

ID

The identifier of the organization in the selected scheme.

tender/tenderers/0/identifier/legalName

[string, null]

Legal Name

The legally registered name of the organization.

tender/tenderers/0/identifier/uri

[string, null]

uri

URI

A URI to identify the organization, such as those provided by Open Corporates or some other relevant URI provider. This is not for listing the website of the organization: that can be done through the URL field of the Organization contact point.

tender/tenderers/0/address

object

Address

(Deprecated outside the parties section)

tender/tenderers/0/address/streetAddress

[string, null]

Street address

The street address. For example, 1600 Amphitheatre Pkwy.

tender/tenderers/0/address/locality

[string, null]

Locality

The locality. For example, Mountain View.

tender/tenderers/0/address/region

[string, null]

Region

The region. For example, CA.

tender/tenderers/0/address/postalCode

[string, null]

Postal code

The postal code. For example, 94043.

tender/tenderers/0/address/countryName

[string, null]

Country name

The country name. For example, United States.

tender/tenderers/0/additionalIdentifiers

array[Identifier]

Additional identifiers

(Deprecated outside the parties section) A list of additional / supplemental identifiers for the organization, using the organization identifier guidance. This can be used to provide an internally used identifier for this organization in addition to the primary legal entity identifier.

tender/tenderers/0/additionalIdentifiers/0/scheme

[string, null]

Scheme

Organization identifiers should be taken from an existing organization identifier list. The scheme field is used to indicate the list or register from which the identifier is taken. This value should be taken from the Organization Identifier Scheme codelist.

tender/tenderers/0/additionalIdentifiers/0/id

[string, integer, null]

ID

The identifier of the organization in the selected scheme.

tender/tenderers/0/additionalIdentifiers/0/legalName

[string, null]

Legal Name

The legally registered name of the organization.

tender/tenderers/0/additionalIdentifiers/0/uri

[string, null]

uri

URI

A URI to identify the organization, such as those provided by Open Corporates or some other relevant URI provider. This is not for listing the website of the organization: that can be done through the URL field of the Organization contact point.

tender/tenderers/0/contactPoint

object

Contact point

(Deprecated outside the parties section)

tender/tenderers/0/contactPoint/name

[string, null]

Name

The name of the contact person, department, or contact point, for correspondence relating to this contracting process.

tender/tenderers/0/contactPoint/email

[string, null]

Email

The e-mail address of the contact point/person.

tender/tenderers/0/contactPoint/telephone

[string, null]

Telephone

The telephone number of the contact point/person. This should include the international dialing code.

tender/tenderers/0/contactPoint/faxNumber

[string, null]

Fax number

The fax number of the contact point/person. This should include the international dialing code.

tender/tenderers/0/contactPoint/url

[string, null]

uri

URL

A web address for the contact point/person.

tender/documents

array[Document]

Documents

All documents and attachments related to the tender, including any notices. See the documentType codelist for details of potential documents to include. Common documents include official legal notices of tender, technical specifications, evaluation criteria, and, as a tender process progresses, clarifications and replies to queries.

tender/documents/0/id

[string, integer]

Required

ID

A local, unique identifier for this document. This field is used to keep track of multiple revisions of a document through the compilation from release to record mechanism.

tender/documents/0/documentType

[string, null]

Document type

A classification of the document described, using the open documentType codelist.

tender/documents/0/title

[string, null]

Title

The document title.

tender/documents/0/description

[string, null]

Description

A short description of the document. Descriptions are recommended to not exceed 250 words. In the event the document is not accessible online, the description field can be used to describe arrangements for obtaining a copy of the document.

tender/documents/0/url

[string, null]

uri

URL

A direct link to the document or attachment. The server providing access to this document ought to be configured to correctly report the document mime type.

tender/documents/0/datePublished

[string, null]

date-time

Date published

The date on which the document was first published. This is particularly important for legally important documents such as notices of a tender.

tender/documents/0/dateModified

[string, null]

date-time

Date modified

Date that the document was last modified

tender/documents/0/format

[string, null]

Format

The format of the document, using the open IANA Media Types codelist (see the values in the 'Template' column), or using the 'offline/print' code if the described document is published offline. For example, web pages have a format of 'text/html'.

tender/documents/0/language

[string, null]

Language

The language of the linked document using either two-letter ISO639-1, or extended BCP47 language tags. The use of lowercase two-letter codes from ISO639-1 is recommended unless there is a clear user need for distinguishing the language subtype.

tender/documents/0/pageStart

[string, null]

Page start

When the information referenced exists within a large document, indicate the first page on which it can be found. This should refer to the printed page number, not the page number reported by software applications.

tender/documents/0/pageEnd

[string, null]

Page end

When the information referenced exists within a large document, indicate the last page on which it can be found. This should refer to the printed page number, not the page number reported by software applications.

tender/documents/0/accessDetails

[string, null]

Access details

A description of any special arrangements needed to access this document, for example: registering for access, paying a fee, or visiting a location to inspect the document.

tender/documents/0/accessDetailsURL

[string, null]

uri

Access details URL

A web address for information on any special arrangements needed to access the document.

tender/documents/0/author

[string, null]

Author

The names of the authors of the document.

tender/documents/0/unofficialTranslations

array[string]

Unofficial translations

The languages in which unofficial translations of the document are available, from the open language codelist. A BCP47 language tag is allowed, if there is a user need for the additional information.

tender/milestones

array[Milestone]

Milestones

A list of milestones associated with the tender.

tender/milestones/0/id

[string, integer]

Required

ID

A local identifier for this milestone, unique within this block. This field is used to keep track of multiple revisions of a milestone through the compilation from release to record mechanism.

tender/milestones/0/title

[string, null]

Title

Milestone title

tender/milestones/0/type

[string, null]

Milestone type

The nature of the milestone, using the open milestoneType codelist.

tender/milestones/0/description

[string, null]

Description

A description of the milestone.

tender/milestones/0/code

[string, null]

Milestone code

Milestone codes can be used to track specific events that take place for a particular kind of contracting process. For example, a code of 'approvalLetter' can be used to allow applications to understand this milestone represents the date an approvalLetter is due or signed.

tender/milestones/0/dueDate

[string, null]

date-time

Due date

The date the milestone is due.

tender/milestones/0/dateMet

[string, null]

date-time

Date met

The date on which the milestone was met.

tender/milestones/0/dateModified

[string, null]

date-time

Date modified

The date the milestone was last reviewed or modified and the status was altered or confirmed to still be correct.

tender/milestones/0/status

[string, null]

Status

The status that was realized on the date provided in dateModified, from the closed milestoneStatus codelist.

tender/milestones/0/documents

array[Document]

Documents

List of documents associated with this milestone (Deprecated in 1.1).

tender/milestones/0/documents/0/id

[string, integer]

Required

ID

A local, unique identifier for this document. This field is used to keep track of multiple revisions of a document through the compilation from release to record mechanism.

tender/milestones/0/documents/0/documentType

[string, null]

Document type

A classification of the document described, using the open documentType codelist.

tender/milestones/0/documents/0/title

[string, null]

Title

The document title.

tender/milestones/0/documents/0/description

[string, null]

Description

A short description of the document. Descriptions are recommended to not exceed 250 words. In the event the document is not accessible online, the description field can be used to describe arrangements for obtaining a copy of the document.

tender/milestones/0/documents/0/url

[string, null]

uri

URL

A direct link to the document or attachment. The server providing access to this document ought to be configured to correctly report the document mime type.

tender/milestones/0/documents/0/datePublished

[string, null]

date-time

Date published

The date on which the document was first published. This is particularly important for legally important documents such as notices of a tender.

tender/milestones/0/documents/0/dateModified

[string, null]

date-time

Date modified

Date that the document was last modified

tender/milestones/0/documents/0/format

[string, null]

Format

The format of the document, using the open IANA Media Types codelist (see the values in the 'Template' column), or using the 'offline/print' code if the described document is published offline. For example, web pages have a format of 'text/html'.

tender/milestones/0/documents/0/language

[string, null]

Language

The language of the linked document using either two-letter ISO639-1, or extended BCP47 language tags. The use of lowercase two-letter codes from ISO639-1 is recommended unless there is a clear user need for distinguishing the language subtype.

tender/milestones/0/documents/0/pageStart

[string, null]

Page start

When the information referenced exists within a large document, indicate the first page on which it can be found. This should refer to the printed page number, not the page number reported by software applications.

tender/milestones/0/documents/0/pageEnd

[string, null]

Page end

When the information referenced exists within a large document, indicate the last page on which it can be found. This should refer to the printed page number, not the page number reported by software applications.

tender/milestones/0/documents/0/accessDetails

[string, null]

Access details

A description of any special arrangements needed to access this document, for example: registering for access, paying a fee, or visiting a location to inspect the document.

tender/milestones/0/documents/0/accessDetailsURL

[string, null]

uri

Access details URL

A web address for information on any special arrangements needed to access the document.

tender/milestones/0/documents/0/author

[string, null]

Author

The names of the authors of the document.

tender/milestones/0/documents/0/unofficialTranslations

array[string]

Unofficial translations

The languages in which unofficial translations of the document are available, from the open language codelist. A BCP47 language tag is allowed, if there is a user need for the additional information.

tender/amendments

array[Amendment]

Amendments

A tender amendment is a formal change to the tender, and generally involves the publication of a new tender notice/release. The rationale and a description of the changes made can be provided here.

tender/amendments/0/date

[string, null]

date-time

Amendment date

The date of this amendment.

tender/amendments/0/rationale

[string, null]

Rationale

An explanation for the amendment.

tender/amendments/0/id

[string, null]

ID

An identifier for this amendment: often the amendment number

tender/amendments/0/description

[string, null]

Description

A free text, or semi-structured, description of the changes made in this amendment.

tender/amendments/0/amendsReleaseID

[string, null]

Amended release (identifier)

Provide the identifier (release.id) of the OCDS release (from this contracting process) that provides the values for this contracting process before the amendment was made.

tender/amendments/0/releaseID

[string, null]

Amending release (identifier)

Provide the identifier (release.id) of the OCDS release (from this contracting process) that provides the values for this contracting process after the amendment was made.

tender/amendments/0/changes

array[object]

Amended fields

An array of change objects describing the fields changed, and their former values. (Deprecated in 1.1)

tender/amendments/0/changes/0/property

string

Property

The property name that has been changed relative to the place the amendment is. For example if the contract value has changed, then the property under changes within the contract.amendment would be value.amount. (Deprecated in 1.1)

tender/amendment

object

Amendment

The use of individual amendment objects has been deprecated. From OCDS 1.1 information should be provided in the amendments array.

tender/amendment/date

[string, null]

date-time

Amendment date

The date of this amendment.

tender/amendment/rationale

[string, null]

Rationale

An explanation for the amendment.

tender/amendment/id

[string, null]

ID

An identifier for this amendment: often the amendment number

tender/amendment/description

[string, null]

Description

A free text, or semi-structured, description of the changes made in this amendment.

tender/amendment/amendsReleaseID

[string, null]

Amended release (identifier)

Provide the identifier (release.id) of the OCDS release (from this contracting process) that provides the values for this contracting process before the amendment was made.

tender/amendment/releaseID

[string, null]

Amending release (identifier)

Provide the identifier (release.id) of the OCDS release (from this contracting process) that provides the values for this contracting process after the amendment was made.

tender/amendment/changes

array[object]

Amended fields

An array of change objects describing the fields changed, and their former values. (Deprecated in 1.1)

tender/amendment/changes/0/property

string

Property

The property name that has been changed relative to the place the amendment is. For example if the contract value has changed, then the property under changes within the contract.amendment would be value.amount. (Deprecated in 1.1)

tender/targets

array[Metric]

Targets

Any target metrics for this contracting process.

tender/targets/0/id

string

Required

Identifier

An identifier for this metric. In some cases this may be drawn from a codelist of metrics required for this type of contracting process, or in other instances may be an arbitrary identifier.

tender/targets/0/title

[string, null]

Title

The title of this metric

tender/targets/0/description

[string, null]

Description

A short description of the metric. This may include short details of measurement methods.

tender/targets/0/observations

array[Observation]

Observations

An array of target or actual values for this metric.

tender/targets/0/observations/0/id

string

Required

Identifier

A local identifier for this specific observation. This may be an arbitrary identifier, or could be a composite of the metric identifier, and the date and other dimensions of this observation.

tender/targets/0/observations/0/period

object

Period

The period over which this observation is measured.

tender/targets/0/observations/0/period/startDate

[string, null]

date-time

Start date

The start date for the period. When known, a precise start date must be provided.

tender/targets/0/observations/0/period/endDate

[string, null]

date-time

End date

The end date for the period. When known, a precise end date must be provided.

tender/targets/0/observations/0/period/maxExtentDate

[string, null]

date-time

Maximum extent

The period cannot be extended beyond this date. This field can be used to express the maximum available date for extension or renewal of this period.

tender/targets/0/observations/0/period/durationInDays

[integer, null]

Duration (days)

The maximum duration of this period in days. A user interface can collect or display this data in months or years as appropriate, and then convert it into days when storing this field. This field can be used when exact dates are not known. If a startDate and endDate are set, this field, if used, should be equal to the difference between startDate and endDate. Otherwise, if a startDate and maxExtentDate are set, this field, if used, should be equal to the difference between startDate and maxExtentDate.

tender/targets/0/observations/0/value

object

Value

For financial metrics, the value of this forecast, target or actual observation.

tender/targets/0/observations/0/value/amount

[number, null]

Amount

Amount as a number.

tender/targets/0/observations/0/value/currency

[string, null]

Currency

The currency of the amount, from the closed currency codelist.

tender/targets/0/observations/0/measure

[string, number, null]

Measure

For non-financial metrics, the measure of this forecast, target or actual observation. Measures may be provided as free text or numerical values.

tender/targets/0/observations/0/unit

object

Unit

Unit

tender/targets/0/observations/0/unit/name

[string, null]

Unit name

The name of the unit.

tender/targets/0/observations/0/unit/scheme

[string, null]

Scheme

The list from which units of measure identifiers are taken. It is recommended to use the scheme 'UNCEFACT' and codes from the UN/CEFACT Recommendation 20 list of "Codes for Units of Measure Used in International Trade".

tender/targets/0/observations/0/unit/id

[string, null]

ID

The identifier from the codelist referenced in the scheme field. For example, with UNCEFACT, this is the value of the 'Common Code' column. From this identifier, applications can look-up the human readable name or symbol for this unit of measure.

tender/targets/0/observations/0/unit/uri

[string, null]

uri

URI

If the scheme used provide a machine-readable URI for this unit of measure, this can be given.

tender/targets/0/observations/0/dimensions

object

Dimensions

Any number of dimensions can be recorded within this object. Dimensions names should follow the camelCase conventions of OCDS.

tender/targets/0/observations/0/notes

[string, null]

Notes

Any notes on this observation. This may include clarifying information.

tender/targets/0/observations/0/relatedImplementationMilestone

object

Related implementation milestone

A link to the milestone in the implementation section of OCDS to which this forecast, target or actual observation relates.

tender/targets/0/observations/0/relatedImplementationMilestone/id

string

Required

Milestone ID

The ID of the milestone being referenced, this must match the ID of a milestone described elsewhere in a release about this contracting process.

tender/targets/0/observations/0/relatedImplementationMilestone/title

[string, null]

Milestone title

The title of the milestone being referenced, this must match the title of a milestone described elsewhere in a release about this contracting process.

awards

array[Award]

Awards

Information from the award phase of the contracting process. There can be more than one award per contracting process e.g. because the contract is split among different providers, or because it is a standing offer.

awards/0/id

[string, integer]

Required

Award ID

The identifier for this award. It must be unique and must not change within the Open Contracting Process it is part of (defined by a single ocid). See the identifier guidance for further details.

awards/0/title

[string, null]

Title

Award title

awards/0/description

[string, null]

Description

Award description

awards/0/status

[string, null]

Award status

The current status of the award, from the closed awardStatus codelist.

awards/0/date

[string, null]

date-time

Award date

The date of the contract award. This is usually the date on which a decision to award was made.

awards/0/value

object

Value

The total value of this award. In the case of a framework contract this may be the total estimated lifetime value, or maximum value, of the agreement. There may be more than one award per procurement. A negative value indicates that the award may involve payments from the supplier to the buyer (commonly used in concession contracts).

awards/0/value/amount

[number, null]

Amount

Amount as a number.

awards/0/value/currency

[string, null]

Currency

The currency of the amount, from the closed currency codelist.

awards/0/suppliers

array[Organization reference]

Suppliers

The suppliers awarded this award. If different suppliers have been awarded different items or values, these should be split into separate award blocks.

awards/0/suppliers/0/name

[string, null]

Organization name

The name of the party being referenced. This must match the name of an entry in the parties section.

awards/0/suppliers/0/id

[string, integer]

Organization ID

The id of the party being referenced. This must match the id of an entry in the parties section.

awards/0/suppliers/0/identifier

object

Primary identifier

The primary identifier for this organization. Identifiers that uniquely pick out a legal entity should be preferred. Consult the organization identifier guidance for the preferred scheme and identifier to use.

awards/0/suppliers/0/identifier/scheme

[string, null]

Scheme

Organization identifiers should be taken from an existing organization identifier list. The scheme field is used to indicate the list or register from which the identifier is taken. This value should be taken from the Organization Identifier Scheme codelist.

awards/0/suppliers/0/identifier/id

[string, integer, null]

ID

The identifier of the organization in the selected scheme.

awards/0/suppliers/0/identifier/legalName

[string, null]

Legal Name

The legally registered name of the organization.

awards/0/suppliers/0/identifier/uri

[string, null]

uri

URI

A URI to identify the organization, such as those provided by Open Corporates or some other relevant URI provider. This is not for listing the website of the organization: that can be done through the URL field of the Organization contact point.

awards/0/suppliers/0/address

object

Address

(Deprecated outside the parties section)

awards/0/suppliers/0/address/streetAddress

[string, null]

Street address

The street address. For example, 1600 Amphitheatre Pkwy.

awards/0/suppliers/0/address/locality

[string, null]

Locality

The locality. For example, Mountain View.

awards/0/suppliers/0/address/region

[string, null]

Region

The region. For example, CA.

awards/0/suppliers/0/address/postalCode

[string, null]

Postal code

The postal code. For example, 94043.

awards/0/suppliers/0/address/countryName

[string, null]

Country name

The country name. For example, United States.

awards/0/suppliers/0/additionalIdentifiers

array[Identifier]

Additional identifiers

(Deprecated outside the parties section) A list of additional / supplemental identifiers for the organization, using the organization identifier guidance. This can be used to provide an internally used identifier for this organization in addition to the primary legal entity identifier.

awards/0/suppliers/0/additionalIdentifiers/0/scheme

[string, null]

Scheme

Organization identifiers should be taken from an existing organization identifier list. The scheme field is used to indicate the list or register from which the identifier is taken. This value should be taken from the Organization Identifier Scheme codelist.

awards/0/suppliers/0/additionalIdentifiers/0/id

[string, integer, null]

ID

The identifier of the organization in the selected scheme.

awards/0/suppliers/0/additionalIdentifiers/0/legalName

[string, null]

Legal Name

The legally registered name of the organization.

awards/0/suppliers/0/additionalIdentifiers/0/uri

[string, null]

uri

URI

A URI to identify the organization, such as those provided by Open Corporates or some other relevant URI provider. This is not for listing the website of the organization: that can be done through the URL field of the Organization contact point.

awards/0/suppliers/0/contactPoint

object

Contact point

(Deprecated outside the parties section)

awards/0/suppliers/0/contactPoint/name

[string, null]

Name

The name of the contact person, department, or contact point, for correspondence relating to this contracting process.

awards/0/suppliers/0/contactPoint/email

[string, null]

Email

The e-mail address of the contact point/person.

awards/0/suppliers/0/contactPoint/telephone

[string, null]

Telephone

The telephone number of the contact point/person. This should include the international dialing code.

awards/0/suppliers/0/contactPoint/faxNumber

[string, null]

Fax number

The fax number of the contact point/person. This should include the international dialing code.

awards/0/suppliers/0/contactPoint/url

[string, null]

uri

URL

A web address for the contact point/person.

awards/0/items

array[Item]

Items awarded

The goods and services awarded in this award, broken into line items wherever possible. Items should not be duplicated, but the quantity specified instead.

awards/0/items/0/id

[string, integer]

Required

ID

A local identifier to reference and merge the items by. Must be unique within a given array of items.

awards/0/items/0/description

[string, null]

Description

A description of the goods, services to be provided.

awards/0/items/0/classification

object

Classification

The primary classification for the item.

awards/0/items/0/classification/scheme

[string, null]

Scheme

The scheme or codelist from which the classification code is taken. For line item classifications, this uses the open itemClassificationScheme codelist.

awards/0/items/0/classification/id

[string, integer, null]

ID

The classification code taken from the scheme.

awards/0/items/0/classification/description

[string, null]

Description

A textual description or title for the classification code.

awards/0/items/0/classification/uri

[string, null]

uri

URI

A URI to uniquely identify the classification code.

awards/0/items/0/additionalClassifications

array[Classification]

Additional classifications

An array of additional classifications for the item.

awards/0/items/0/additionalClassifications/0/scheme

[string, null]

Scheme

The scheme or codelist from which the classification code is taken. For line item classifications, this uses the open itemClassificationScheme codelist.

awards/0/items/0/additionalClassifications/0/id

[string, integer, null]

ID

The classification code taken from the scheme.

awards/0/items/0/additionalClassifications/0/description

[string, null]

Description

A textual description or title for the classification code.

awards/0/items/0/additionalClassifications/0/uri

[string, null]

uri

URI

A URI to uniquely identify the classification code.

awards/0/items/0/quantity

[number, null]

Quantity

The number of units to be provided.

awards/0/items/0/unit

object

Unit

A description of the unit in which the supplies, services or works are provided (e.g. hours, kilograms) and the unit-price.

awards/0/items/0/unit/scheme

[string, null]

Scheme

The list from which identifiers for units of measure are taken, using the open unitClassificationScheme codelist. 'UNCEFACT' is recommended.

awards/0/items/0/unit/id

[string, null]

ID

The identifier from the codelist referenced in the scheme field. Check the unitClassificationScheme codelist for details of how to find and use identifiers from the scheme in use.

awards/0/items/0/unit/name

[string, null]

Name

Name of the unit.

awards/0/items/0/unit/value

object

Value

The monetary value of a single unit.

awards/0/items/0/unit/value/amount

[number, null]

Amount

Amount as a number.

awards/0/items/0/unit/value/currency

[string, null]

Currency

The currency of the amount, from the closed currency codelist.

awards/0/items/0/unit/uri

[string, null]

uri

URI

The machine-readable URI for the unit of measure, provided by the scheme.

awards/0/items/0/deliveryLocation

object

Delivery Location

The location where activity related to this tender, contract or license will be delivered, or will take place.

awards/0/items/0/deliveryLocation/description

[string, null]

Description

A name or description of this location. This might include the name(s) of the location(s), or might provide a human-readable description of the location to be covered.

awards/0/items/0/deliveryLocation/geometry

object

Geometry

We follow the GeoJSON standard to express basic location information, using longitude, latitude, and optional elevation values in the WGS84 (EPSG:4326) projection. A point location can be identified by geocoding a delivery address. For concession licenses, or other contracts covering a polygon location which is not contained in a known gazetteer, polygon and multi-polygon can be used.

awards/0/items/0/deliveryLocation/geometry/type

[string, null]

Type

The type of GeoJSON Geometry Objects being provided. To provide longitude, latitude, and optional elevation, use 'Point', and enter an array of [longitude, latitude] or [longitude, latitude, elevation] as the value of the coordinates field: e.g. [-122.085, 37.42].

awards/0/items/0/deliveryLocation/geometry/coordinates

array[[number, array]]

Coordinates

The relevant array of points, e.g. [longitude, latitude] or [longitude, latitude, elevation], or a nested array of points, for the GeoJSON geometry being described. The longitude and latitude must be expressed in decimal degrees in the WGS84 (EPSG:4326) projection.

awards/0/items/0/deliveryLocation/gazetteer

object

Gazetteer

Identifiers from a gazetteer (a geographical index or directory) for the location.

awards/0/items/0/deliveryLocation/gazetteer/scheme

[string, null]

Gazetteer scheme

The identifier of the gazetteer. The locationGazetteers.csv codelist provides details of services, where available, that can resolve a gazetteer entry to provide location names.

awards/0/items/0/deliveryLocation/gazetteer/identifiers

array[[string]]

Identifiers

An array of one or more codes drawn from the gazetteer indicated by the scheme field.

awards/0/items/0/deliveryLocation/uri

[string, null]

URI

A URI to a further description of the activity location. This might be a human-readable document with information on the location, or a machine-readable description of the location.

awards/0/items/0/deliveryAddress

object

Delivery Address

The address to which, or where, goods or services related to this tender, contract or license will be delivered.

awards/0/items/0/deliveryAddress/streetAddress

[string, null]

Street address

The street address. For example, 1600 Amphitheatre Pkwy.

awards/0/items/0/deliveryAddress/locality

[string, null]

Locality

The locality. For example, Mountain View.

awards/0/items/0/deliveryAddress/region

[string, null]

Region

The region. For example, CA.

awards/0/items/0/deliveryAddress/postalCode

[string, null]

Postal code

The postal code. For example, 94043.

awards/0/items/0/deliveryAddress/countryName

[string, null]

Country name

The country name. For example, United States.

awards/0/contractPeriod

object

Contract period

The period for which the contract has been awarded.

awards/0/contractPeriod/startDate

[string, null]

date-time

Start date

The start date for the period. When known, a precise start date must be provided.

awards/0/contractPeriod/endDate

[string, null]

date-time

End date

The end date for the period. When known, a precise end date must be provided.

awards/0/contractPeriod/maxExtentDate

[string, null]

date-time

Maximum extent

The period cannot be extended beyond this date. This field can be used to express the maximum available date for extension or renewal of this period.

awards/0/contractPeriod/durationInDays

[integer, null]

Duration (days)

The maximum duration of this period in days. A user interface can collect or display this data in months or years as appropriate, and then convert it into days when storing this field. This field can be used when exact dates are not known. If a startDate and endDate are set, this field, if used, should be equal to the difference between startDate and endDate. Otherwise, if a startDate and maxExtentDate are set, this field, if used, should be equal to the difference between startDate and maxExtentDate.

awards/0/documents

array[Document]

Documents

All documents and attachments related to the award, including any notices.

awards/0/documents/0/id

[string, integer]

Required

ID

A local, unique identifier for this document. This field is used to keep track of multiple revisions of a document through the compilation from release to record mechanism.

awards/0/documents/0/documentType

[string, null]

Document type

A classification of the document described, using the open documentType codelist.

awards/0/documents/0/title

[string, null]

Title

The document title.

awards/0/documents/0/description

[string, null]

Description

A short description of the document. Descriptions are recommended to not exceed 250 words. In the event the document is not accessible online, the description field can be used to describe arrangements for obtaining a copy of the document.

awards/0/documents/0/url

[string, null]

uri

URL

A direct link to the document or attachment. The server providing access to this document ought to be configured to correctly report the document mime type.

awards/0/documents/0/datePublished

[string, null]

date-time

Date published

The date on which the document was first published. This is particularly important for legally important documents such as notices of a tender.

awards/0/documents/0/dateModified

[string, null]

date-time

Date modified

Date that the document was last modified

awards/0/documents/0/format

[string, null]

Format

The format of the document, using the open IANA Media Types codelist (see the values in the 'Template' column), or using the 'offline/print' code if the described document is published offline. For example, web pages have a format of 'text/html'.

awards/0/documents/0/language

[string, null]

Language

The language of the linked document using either two-letter ISO639-1, or extended BCP47 language tags. The use of lowercase two-letter codes from ISO639-1 is recommended unless there is a clear user need for distinguishing the language subtype.

awards/0/documents/0/pageStart

[string, null]

Page start

When the information referenced exists within a large document, indicate the first page on which it can be found. This should refer to the printed page number, not the page number reported by software applications.

awards/0/documents/0/pageEnd

[string, null]

Page end

When the information referenced exists within a large document, indicate the last page on which it can be found. This should refer to the printed page number, not the page number reported by software applications.

awards/0/documents/0/accessDetails

[string, null]

Access details

A description of any special arrangements needed to access this document, for example: registering for access, paying a fee, or visiting a location to inspect the document.

awards/0/documents/0/accessDetailsURL

[string, null]

uri

Access details URL

A web address for information on any special arrangements needed to access the document.

awards/0/documents/0/author

[string, null]

Author

The names of the authors of the document.

awards/0/documents/0/unofficialTranslations

array[string]

Unofficial translations

The languages in which unofficial translations of the document are available, from the open language codelist. A BCP47 language tag is allowed, if there is a user need for the additional information.

awards/0/amendments

array[Amendment]

Amendments

An award amendment is a formal change to the details of the award, and generally involves the publication of a new award notice/release. The rationale and a description of the changes made can be provided here.

awards/0/amendments/0/date

[string, null]

date-time

Amendment date

The date of this amendment.

awards/0/amendments/0/rationale

[string, null]

Rationale

An explanation for the amendment.

awards/0/amendments/0/id

[string, null]

ID

An identifier for this amendment: often the amendment number

awards/0/amendments/0/description

[string, null]

Description

A free text, or semi-structured, description of the changes made in this amendment.

awards/0/amendments/0/amendsReleaseID

[string, null]

Amended release (identifier)

Provide the identifier (release.id) of the OCDS release (from this contracting process) that provides the values for this contracting process before the amendment was made.

awards/0/amendments/0/releaseID

[string, null]

Amending release (identifier)

Provide the identifier (release.id) of the OCDS release (from this contracting process) that provides the values for this contracting process after the amendment was made.

awards/0/amendments/0/changes

array[object]

Amended fields

An array of change objects describing the fields changed, and their former values. (Deprecated in 1.1)

awards/0/amendments/0/changes/0/property

string

Property

The property name that has been changed relative to the place the amendment is. For example if the contract value has changed, then the property under changes within the contract.amendment would be value.amount. (Deprecated in 1.1)

awards/0/amendment

object

Amendment

The use of individual amendment objects has been deprecated. From OCDS 1.1 information should be provided in the amendments array.

awards/0/amendment/date

[string, null]

date-time

Amendment date

The date of this amendment.

awards/0/amendment/rationale

[string, null]

Rationale

An explanation for the amendment.

awards/0/amendment/id

[string, null]

ID

An identifier for this amendment: often the amendment number

awards/0/amendment/description

[string, null]

Description

A free text, or semi-structured, description of the changes made in this amendment.

awards/0/amendment/amendsReleaseID

[string, null]

Amended release (identifier)

Provide the identifier (release.id) of the OCDS release (from this contracting process) that provides the values for this contracting process before the amendment was made.

awards/0/amendment/releaseID

[string, null]

Amending release (identifier)

Provide the identifier (release.id) of the OCDS release (from this contracting process) that provides the values for this contracting process after the amendment was made.

awards/0/amendment/changes

array[object]

Amended fields

An array of change objects describing the fields changed, and their former values. (Deprecated in 1.1)

awards/0/amendment/changes/0/property

string

Property

The property name that has been changed relative to the place the amendment is. For example if the contract value has changed, then the property under changes within the contract.amendment would be value.amount. (Deprecated in 1.1)

awards/0/relatedBid

[string, null]

Related bid

Where bid details are used, a cross reference to the entry in the bids array to which this award relates. Provide the bid identifier here.

awards/0/agreedMetrics

array[Metric]

Agreed metrics

Any target metrics set out as part of the contract award.

awards/0/agreedMetrics/0/id

string

Required

Identifier

An identifier for this metric. In some cases this may be drawn from a codelist of metrics required for this type of contracting process, or in other instances may be an arbitrary identifier.

awards/0/agreedMetrics/0/title

[string, null]

Title

The title of this metric

awards/0/agreedMetrics/0/description

[string, null]

Description

A short description of the metric. This may include short details of measurement methods.

awards/0/agreedMetrics/0/observations

array[Observation]

Observations

An array of target or actual values for this metric.

awards/0/agreedMetrics/0/observations/0/id

string

Required

Identifier

A local identifier for this specific observation. This may be an arbitrary identifier, or could be a composite of the metric identifier, and the date and other dimensions of this observation.

awards/0/agreedMetrics/0/observations/0/period

object

Period

The period over which this observation is measured.

awards/0/agreedMetrics/0/observations/0/period/startDate

[string, null]

date-time

Start date

The start date for the period. When known, a precise start date must be provided.

awards/0/agreedMetrics/0/observations/0/period/endDate

[string, null]

date-time

End date

The end date for the period. When known, a precise end date must be provided.

awards/0/agreedMetrics/0/observations/0/period/maxExtentDate

[string, null]

date-time

Maximum extent

The period cannot be extended beyond this date. This field can be used to express the maximum available date for extension or renewal of this period.

awards/0/agreedMetrics/0/observations/0/period/durationInDays

[integer, null]

Duration (days)

The maximum duration of this period in days. A user interface can collect or display this data in months or years as appropriate, and then convert it into days when storing this field. This field can be used when exact dates are not known. If a startDate and endDate are set, this field, if used, should be equal to the difference between startDate and endDate. Otherwise, if a startDate and maxExtentDate are set, this field, if used, should be equal to the difference between startDate and maxExtentDate.

awards/0/agreedMetrics/0/observations/0/value

object

Value

For financial metrics, the value of this forecast, target or actual observation.

awards/0/agreedMetrics/0/observations/0/value/amount

[number, null]

Amount

Amount as a number.

awards/0/agreedMetrics/0/observations/0/value/currency

[string, null]

Currency

The currency of the amount, from the closed currency codelist.

awards/0/agreedMetrics/0/observations/0/measure

[string, number, null]

Measure

For non-financial metrics, the measure of this forecast, target or actual observation. Measures may be provided as free text or numerical values.

awards/0/agreedMetrics/0/observations/0/unit

object

Unit

Unit

awards/0/agreedMetrics/0/observations/0/unit/name

[string, null]

Unit name

The name of the unit.

awards/0/agreedMetrics/0/observations/0/unit/scheme

[string, null]

Scheme

The list from which units of measure identifiers are taken. It is recommended to use the scheme 'UNCEFACT' and codes from the UN/CEFACT Recommendation 20 list of "Codes for Units of Measure Used in International Trade".

awards/0/agreedMetrics/0/observations/0/unit/id

[string, null]

ID

The identifier from the codelist referenced in the scheme field. For example, with UNCEFACT, this is the value of the 'Common Code' column. From this identifier, applications can look-up the human readable name or symbol for this unit of measure.

awards/0/agreedMetrics/0/observations/0/unit/uri

[string, null]

uri

URI

If the scheme used provide a machine-readable URI for this unit of measure, this can be given.

awards/0/agreedMetrics/0/observations/0/dimensions

object

Dimensions

Any number of dimensions can be recorded within this object. Dimensions names should follow the camelCase conventions of OCDS.

awards/0/agreedMetrics/0/observations/0/notes

[string, null]

Notes

Any notes on this observation. This may include clarifying information.

awards/0/agreedMetrics/0/observations/0/relatedImplementationMilestone

object

Related implementation milestone

A link to the milestone in the implementation section of OCDS to which this forecast, target or actual observation relates.

awards/0/agreedMetrics/0/observations/0/relatedImplementationMilestone/id

string

Required

Milestone ID

The ID of the milestone being referenced, this must match the ID of a milestone described elsewhere in a release about this contracting process.

awards/0/agreedMetrics/0/observations/0/relatedImplementationMilestone/title

[string, null]

Milestone title

The title of the milestone being referenced, this must match the title of a milestone described elsewhere in a release about this contracting process.

awards/0/evaluationIndicators

object

Evaluation of PPP option

Key indicators that describe how the PPP option has been evaluated by government.

awards/0/evaluationIndicators/riskPremium

[number, null]

Risk premium

The risk premium used by government when evaluating the PPP option, expressed as a decimal (for example, 0.1) and not as a percentage (for example, 10).

awards/0/evaluationIndicators/riskPremiumDetails

[string, null]

Risk premium details

Additional details on the risk premium used: for example, the rationale.

awards/0/evaluationIndicators/discountRate

[number, null]

Discount rate

The discount rate used by government when evaluating the PPP option, expressed as a decimal (for example, 0.1) and not as a percentage (for example, 10).

awards/0/evaluationIndicators/discountRateDetails

[string, null]

Discount rate details

Additional details on the discount rate used.

awards/0/evaluationIndicators/netPresentValue

object

Net present value

The discounted value of an investment's cash inflows minus the discounted value of its cash outflows.

awards/0/evaluationIndicators/netPresentValue/amount

[number, null]

Amount

Amount as a number.

awards/0/evaluationIndicators/netPresentValue/currency

[string, null]

Currency

The currency of the amount, from the closed currency codelist.

awards/0/evaluationIndicators/netPresentValueDetails

[string, null]

Net present value details

Additional details on the calculation of the net present value.

contracts

array[Contract]

Contracts

Information from the contract creation phase of the procurement process.

contracts/0/id

[string, integer]

Required

Contract ID

The identifier for this contract. It must be unique and must not change within the Open Contracting Process it is part of (defined by a single ocid). See the identifier guidance for further details.

contracts/0/awardID

[string, integer]

Required

Award ID

The award.id against which this contract is being issued.

contracts/0/title

[string, null]

Contract title

Contract title

contracts/0/description

[string, null]

Contract description

Contract description

contracts/0/status

[string, null]

Contract status

The current status of the contract, from the closed contractStatus codelist.

contracts/0/period

object

Period

The start and end date for the contract.

contracts/0/period/startDate

[string, null]

date-time

Start date

The start date for the period. When known, a precise start date must be provided.

contracts/0/period/endDate

[string, null]

date-time

End date

The end date for the period. When known, a precise end date must be provided.

contracts/0/period/maxExtentDate

[string, null]

date-time

Maximum extent

The period cannot be extended beyond this date. This field can be used to express the maximum available date for extension or renewal of this period.

contracts/0/period/durationInDays

[integer, null]

Duration (days)

The maximum duration of this period in days. A user interface can collect or display this data in months or years as appropriate, and then convert it into days when storing this field. This field can be used when exact dates are not known. If a startDate and endDate are set, this field, if used, should be equal to the difference between startDate and endDate. Otherwise, if a startDate and maxExtentDate are set, this field, if used, should be equal to the difference between startDate and maxExtentDate.

contracts/0/value

object

Value

The total value of this contract. A negative value indicates that the contract will involve payments from the supplier to the buyer (commonly used in concession contracts).

contracts/0/value/amount

[number, null]

Amount

Amount as a number.

contracts/0/value/currency

[string, null]

Currency

The currency of the amount, from the closed currency codelist.

contracts/0/items

array[Item]

Items contracted

The goods, services, and any intangible outcomes in this contract. Note: If the items are the same as the award do not repeat.

contracts/0/items/0/id

[string, integer]

Required

ID

A local identifier to reference and merge the items by. Must be unique within a given array of items.

contracts/0/items/0/description

[string, null]

Description

A description of the goods, services to be provided.

contracts/0/items/0/classification

object

Classification

The primary classification for the item.

contracts/0/items/0/classification/scheme

[string, null]

Scheme

The scheme or codelist from which the classification code is taken. For line item classifications, this uses the open itemClassificationScheme codelist.

contracts/0/items/0/classification/id

[string, integer, null]

ID

The classification code taken from the scheme.

contracts/0/items/0/classification/description

[string, null]

Description

A textual description or title for the classification code.

contracts/0/items/0/classification/uri

[string, null]

uri

URI

A URI to uniquely identify the classification code.

contracts/0/items/0/additionalClassifications

array[Classification]

Additional classifications

An array of additional classifications for the item.

contracts/0/items/0/additionalClassifications/0/scheme

[string, null]

Scheme

The scheme or codelist from which the classification code is taken. For line item classifications, this uses the open itemClassificationScheme codelist.

contracts/0/items/0/additionalClassifications/0/id

[string, integer, null]

ID

The classification code taken from the scheme.

contracts/0/items/0/additionalClassifications/0/description

[string, null]

Description

A textual description or title for the classification code.

contracts/0/items/0/additionalClassifications/0/uri

[string, null]

uri

URI

A URI to uniquely identify the classification code.

contracts/0/items/0/quantity

[number, null]

Quantity

The number of units to be provided.

contracts/0/items/0/unit

object

Unit

A description of the unit in which the supplies, services or works are provided (e.g. hours, kilograms) and the unit-price.

contracts/0/items/0/unit/scheme

[string, null]

Scheme

The list from which identifiers for units of measure are taken, using the open unitClassificationScheme codelist. 'UNCEFACT' is recommended.

contracts/0/items/0/unit/id

[string, null]

ID

The identifier from the codelist referenced in the scheme field. Check the unitClassificationScheme codelist for details of how to find and use identifiers from the scheme in use.

contracts/0/items/0/unit/name

[string, null]

Name

Name of the unit.

contracts/0/items/0/unit/value

object

Value

The monetary value of a single unit.

contracts/0/items/0/unit/value/amount

[number, null]

Amount

Amount as a number.

contracts/0/items/0/unit/value/currency

[string, null]

Currency

The currency of the amount, from the closed currency codelist.

contracts/0/items/0/unit/uri

[string, null]

uri

URI

The machine-readable URI for the unit of measure, provided by the scheme.

contracts/0/items/0/deliveryLocation

object

Delivery Location

The location where activity related to this tender, contract or license will be delivered, or will take place.

contracts/0/items/0/deliveryLocation/description

[string, null]

Description

A name or description of this location. This might include the name(s) of the location(s), or might provide a human-readable description of the location to be covered.

contracts/0/items/0/deliveryLocation/geometry

object

Geometry

We follow the GeoJSON standard to express basic location information, using longitude, latitude, and optional elevation values in the WGS84 (EPSG:4326) projection. A point location can be identified by geocoding a delivery address. For concession licenses, or other contracts covering a polygon location which is not contained in a known gazetteer, polygon and multi-polygon can be used.

contracts/0/items/0/deliveryLocation/geometry/type

[string, null]

Type

The type of GeoJSON Geometry Objects being provided. To provide longitude, latitude, and optional elevation, use 'Point', and enter an array of [longitude, latitude] or [longitude, latitude, elevation] as the value of the coordinates field: e.g. [-122.085, 37.42].

contracts/0/items/0/deliveryLocation/geometry/coordinates

array[[number, array]]

Coordinates

The relevant array of points, e.g. [longitude, latitude] or [longitude, latitude, elevation], or a nested array of points, for the GeoJSON geometry being described. The longitude and latitude must be expressed in decimal degrees in the WGS84 (EPSG:4326) projection.

contracts/0/items/0/deliveryLocation/gazetteer

object

Gazetteer

Identifiers from a gazetteer (a geographical index or directory) for the location.

contracts/0/items/0/deliveryLocation/gazetteer/scheme

[string, null]

Gazetteer scheme

The identifier of the gazetteer. The locationGazetteers.csv codelist provides details of services, where available, that can resolve a gazetteer entry to provide location names.

contracts/0/items/0/deliveryLocation/gazetteer/identifiers

array[[string]]

Identifiers

An array of one or more codes drawn from the gazetteer indicated by the scheme field.

contracts/0/items/0/deliveryLocation/uri

[string, null]

URI

A URI to a further description of the activity location. This might be a human-readable document with information on the location, or a machine-readable description of the location.

contracts/0/items/0/deliveryAddress

object

Delivery Address

The address to which, or where, goods or services related to this tender, contract or license will be delivered.

contracts/0/items/0/deliveryAddress/streetAddress

[string, null]

Street address

The street address. For example, 1600 Amphitheatre Pkwy.

contracts/0/items/0/deliveryAddress/locality

[string, null]

Locality

The locality. For example, Mountain View.

contracts/0/items/0/deliveryAddress/region

[string, null]

Region

The region. For example, CA.

contracts/0/items/0/deliveryAddress/postalCode

[string, null]

Postal code

The postal code. For example, 94043.

contracts/0/items/0/deliveryAddress/countryName

[string, null]

Country name

The country name. For example, United States.

contracts/0/dateSigned

[string, null]

date-time

Date signed

The date the contract was signed. In the case of multiple signatures, the date of the last signature.

contracts/0/documents

array[Document]

Documents

All documents and attachments related to the contract, including any notices.

contracts/0/documents/0/id

[string, integer]

Required

ID

A local, unique identifier for this document. This field is used to keep track of multiple revisions of a document through the compilation from release to record mechanism.

contracts/0/documents/0/documentType

[string, null]

Document type

A classification of the document described, using the open documentType codelist.

contracts/0/documents/0/title

[string, null]

Title

The document title.

contracts/0/documents/0/description

[string, null]

Description

A short description of the document. Descriptions are recommended to not exceed 250 words. In the event the document is not accessible online, the description field can be used to describe arrangements for obtaining a copy of the document.

contracts/0/documents/0/url

[string, null]

uri

URL

A direct link to the document or attachment. The server providing access to this document ought to be configured to correctly report the document mime type.

contracts/0/documents/0/datePublished

[string, null]

date-time

Date published

The date on which the document was first published. This is particularly important for legally important documents such as notices of a tender.

contracts/0/documents/0/dateModified

[string, null]

date-time

Date modified

Date that the document was last modified

contracts/0/documents/0/format

[string, null]

Format

The format of the document, using the open IANA Media Types codelist (see the values in the 'Template' column), or using the 'offline/print' code if the described document is published offline. For example, web pages have a format of 'text/html'.

contracts/0/documents/0/language

[string, null]

Language

The language of the linked document using either two-letter ISO639-1, or extended BCP47 language tags. The use of lowercase two-letter codes from ISO639-1 is recommended unless there is a clear user need for distinguishing the language subtype.

contracts/0/documents/0/pageStart

[string, null]

Page start

When the information referenced exists within a large document, indicate the first page on which it can be found. This should refer to the printed page number, not the page number reported by software applications.

contracts/0/documents/0/pageEnd

[string, null]

Page end

When the information referenced exists within a large document, indicate the last page on which it can be found. This should refer to the printed page number, not the page number reported by software applications.

contracts/0/documents/0/accessDetails

[string, null]

Access details

A description of any special arrangements needed to access this document, for example: registering for access, paying a fee, or visiting a location to inspect the document.

contracts/0/documents/0/accessDetailsURL

[string, null]

uri

Access details URL

A web address for information on any special arrangements needed to access the document.

contracts/0/documents/0/author

[string, null]

Author

The names of the authors of the document.

contracts/0/documents/0/unofficialTranslations

array[string]

Unofficial translations

The languages in which unofficial translations of the document are available, from the open language codelist. A BCP47 language tag is allowed, if there is a user need for the additional information.

contracts/0/implementation

object

Implementation

Information related to the implementation of the contract in accordance with the obligations laid out therein.

contracts/0/implementation/transactions

array[Transaction information]

Transactions

A list of the spending transactions made against this contract

contracts/0/implementation/transactions/0/id

[string, integer]

Required

ID

A unique identifier for this transaction. This identifier should be possible to cross-reference against the provided data source. For IATI this is the transaction reference.

contracts/0/implementation/transactions/0/source

[string, null]

uri

Data source

Used to point either to a corresponding Fiscal Data Package, IATI file, or machine or human-readable source where users can find further information on the budget line item identifiers, or project identifiers, provided here.

contracts/0/implementation/transactions/0/date

[string, null]

date-time

Date

The date of the transaction

contracts/0/implementation/transactions/0/value

object

Value

The value of the transaction.

contracts/0/implementation/transactions/0/value/amount

[number, null]

Amount

Amount as a number.

contracts/0/implementation/transactions/0/value/currency

[string, null]

Currency

The currency of the amount, from the closed currency codelist.

contracts/0/implementation/transactions/0/payer

object

Payer

An organization reference for the organization from which the funds in this transaction originate.

contracts/0/implementation/transactions/0/payer/name

[string, null]

Organization name

The name of the party being referenced. This must match the name of an entry in the parties section.

contracts/0/implementation/transactions/0/payer/id

[string, integer]

Organization ID

The id of the party being referenced. This must match the id of an entry in the parties section.

contracts/0/implementation/transactions/0/payer/identifier

object

Primary identifier

The primary identifier for this organization. Identifiers that uniquely pick out a legal entity should be preferred. Consult the organization identifier guidance for the preferred scheme and identifier to use.

contracts/0/implementation/transactions/0/payer/identifier/scheme

[string, null]

Scheme

Organization identifiers should be taken from an existing organization identifier list. The scheme field is used to indicate the list or register from which the identifier is taken. This value should be taken from the Organization Identifier Scheme codelist.

contracts/0/implementation/transactions/0/payer/identifier/id

[string, integer, null]

ID

The identifier of the organization in the selected scheme.

contracts/0/implementation/transactions/0/payer/identifier/legalName

[string, null]

Legal Name

The legally registered name of the organization.

contracts/0/implementation/transactions/0/payer/identifier/uri

[string, null]

uri

URI

A URI to identify the organization, such as those provided by Open Corporates or some other relevant URI provider. This is not for listing the website of the organization: that can be done through the URL field of the Organization contact point.

contracts/0/implementation/transactions/0/payer/address

object

Address

(Deprecated outside the parties section)

contracts/0/implementation/transactions/0/payer/address/streetAddress

[string, null]

Street address

The street address. For example, 1600 Amphitheatre Pkwy.

contracts/0/implementation/transactions/0/payer/address/locality

[string, null]

Locality

The locality. For example, Mountain View.

contracts/0/implementation/transactions/0/payer/address/region

[string, null]

Region

The region. For example, CA.

contracts/0/implementation/transactions/0/payer/address/postalCode

[string, null]

Postal code

The postal code. For example, 94043.

contracts/0/implementation/transactions/0/payer/address/countryName

[string, null]

Country name

The country name. For example, United States.

contracts/0/implementation/transactions/0/payer/additionalIdentifiers

array[Identifier]

Additional identifiers

(Deprecated outside the parties section) A list of additional / supplemental identifiers for the organization, using the organization identifier guidance. This can be used to provide an internally used identifier for this organization in addition to the primary legal entity identifier.

contracts/0/implementation/transactions/0/payer/additionalIdentifiers/0/scheme

[string, null]

Scheme

Organization identifiers should be taken from an existing organization identifier list. The scheme field is used to indicate the list or register from which the identifier is taken. This value should be taken from the Organization Identifier Scheme codelist.

contracts/0/implementation/transactions/0/payer/additionalIdentifiers/0/id

[string, integer, null]

ID

The identifier of the organization in the selected scheme.

contracts/0/implementation/transactions/0/payer/additionalIdentifiers/0/legalName

[string, null]

Legal Name

The legally registered name of the organization.

contracts/0/implementation/transactions/0/payer/additionalIdentifiers/0/uri

[string, null]

uri

URI

A URI to identify the organization, such as those provided by Open Corporates or some other relevant URI provider. This is not for listing the website of the organization: that can be done through the URL field of the Organization contact point.

contracts/0/implementation/transactions/0/payer/contactPoint

object

Contact point

(Deprecated outside the parties section)

contracts/0/implementation/transactions/0/payer/contactPoint/name

[string, null]

Name

The name of the contact person, department, or contact point, for correspondence relating to this contracting process.

contracts/0/implementation/transactions/0/payer/contactPoint/email

[string, null]

Email

The e-mail address of the contact point/person.

contracts/0/implementation/transactions/0/payer/contactPoint/telephone

[string, null]

Telephone

The telephone number of the contact point/person. This should include the international dialing code.

contracts/0/implementation/transactions/0/payer/contactPoint/faxNumber

[string, null]

Fax number

The fax number of the contact point/person. This should include the international dialing code.

contracts/0/implementation/transactions/0/payer/contactPoint/url

[string, null]

uri

URL

A web address for the contact point/person.

contracts/0/implementation/transactions/0/payee

object

Payee

An organization reference for the organization which receives the funds in this transaction.

contracts/0/implementation/transactions/0/payee/name

[string, null]

Organization name

The name of the party being referenced. This must match the name of an entry in the parties section.

contracts/0/implementation/transactions/0/payee/id

[string, integer]

Organization ID

The id of the party being referenced. This must match the id of an entry in the parties section.

contracts/0/implementation/transactions/0/payee/identifier

object

Primary identifier

The primary identifier for this organization. Identifiers that uniquely pick out a legal entity should be preferred. Consult the organization identifier guidance for the preferred scheme and identifier to use.

contracts/0/implementation/transactions/0/payee/identifier/scheme

[string, null]

Scheme

Organization identifiers should be taken from an existing organization identifier list. The scheme field is used to indicate the list or register from which the identifier is taken. This value should be taken from the Organization Identifier Scheme codelist.

contracts/0/implementation/transactions/0/payee/identifier/id

[string, integer, null]

ID

The identifier of the organization in the selected scheme.

contracts/0/implementation/transactions/0/payee/identifier/legalName

[string, null]

Legal Name

The legally registered name of the organization.

contracts/0/implementation/transactions/0/payee/identifier/uri

[string, null]

uri

URI

A URI to identify the organization, such as those provided by Open Corporates or some other relevant URI provider. This is not for listing the website of the organization: that can be done through the URL field of the Organization contact point.

contracts/0/implementation/transactions/0/payee/address

object

Address

(Deprecated outside the parties section)

contracts/0/implementation/transactions/0/payee/address/streetAddress

[string, null]

Street address

The street address. For example, 1600 Amphitheatre Pkwy.

contracts/0/implementation/transactions/0/payee/address/locality

[string, null]

Locality

The locality. For example, Mountain View.

contracts/0/implementation/transactions/0/payee/address/region

[string, null]

Region

The region. For example, CA.

contracts/0/implementation/transactions/0/payee/address/postalCode

[string, null]

Postal code

The postal code. For example, 94043.

contracts/0/implementation/transactions/0/payee/address/countryName

[string, null]

Country name

The country name. For example, United States.

contracts/0/implementation/transactions/0/payee/additionalIdentifiers

array[Identifier]

Additional identifiers

(Deprecated outside the parties section) A list of additional / supplemental identifiers for the organization, using the organization identifier guidance. This can be used to provide an internally used identifier for this organization in addition to the primary legal entity identifier.

contracts/0/implementation/transactions/0/payee/additionalIdentifiers/0/scheme

[string, null]

Scheme

Organization identifiers should be taken from an existing organization identifier list. The scheme field is used to indicate the list or register from which the identifier is taken. This value should be taken from the Organization Identifier Scheme codelist.

contracts/0/implementation/transactions/0/payee/additionalIdentifiers/0/id

[string, integer, null]

ID

The identifier of the organization in the selected scheme.

contracts/0/implementation/transactions/0/payee/additionalIdentifiers/0/legalName

[string, null]

Legal Name

The legally registered name of the organization.

contracts/0/implementation/transactions/0/payee/additionalIdentifiers/0/uri

[string, null]

uri

URI

A URI to identify the organization, such as those provided by Open Corporates or some other relevant URI provider. This is not for listing the website of the organization: that can be done through the URL field of the Organization contact point.

contracts/0/implementation/transactions/0/payee/contactPoint

object

Contact point

(Deprecated outside the parties section)

contracts/0/implementation/transactions/0/payee/contactPoint/name

[string, null]

Name

The name of the contact person, department, or contact point, for correspondence relating to this contracting process.

contracts/0/implementation/transactions/0/payee/contactPoint/email

[string, null]

Email

The e-mail address of the contact point/person.

contracts/0/implementation/transactions/0/payee/contactPoint/telephone

[string, null]

Telephone

The telephone number of the contact point/person. This should include the international dialing code.

contracts/0/implementation/transactions/0/payee/contactPoint/faxNumber

[string, null]

Fax number

The fax number of the contact point/person. This should include the international dialing code.

contracts/0/implementation/transactions/0/payee/contactPoint/url

[string, null]

uri

URL

A web address for the contact point/person.

contracts/0/implementation/transactions/0/uri

[string, null]

uri

Linked spending information

A URI pointing directly to a machine-readable record about this spending transaction.

contracts/0/implementation/transactions/0/amount

object

Amount

(Deprecated in 1.1. Use transaction.value instead) The value of the transaction. A negative value indicates a refund or correction.

contracts/0/implementation/transactions/0/amount/amount

[number, null]

Amount

Amount as a number.

contracts/0/implementation/transactions/0/amount/currency

[string, null]

Currency

The currency of the amount, from the closed currency codelist.

contracts/0/implementation/transactions/0/providerOrganization

object

Provider organization

(Deprecated in 1.1. Use transaction.payer instead.) The Organization Identifier for the organization from which the funds in this transaction originate. Expressed following the Organizational Identifier standard - consult the documentation and the codelist.

contracts/0/implementation/transactions/0/providerOrganization/scheme

[string, null]

Scheme

Organization identifiers should be taken from an existing organization identifier list. The scheme field is used to indicate the list or register from which the identifier is taken. This value should be taken from the Organization Identifier Scheme codelist.

contracts/0/implementation/transactions/0/providerOrganization/id

[string, integer, null]

ID

The identifier of the organization in the selected scheme.

contracts/0/implementation/transactions/0/providerOrganization/legalName

[string, null]

Legal Name

The legally registered name of the organization.

contracts/0/implementation/transactions/0/providerOrganization/uri

[string, null]

uri

URI

A URI to identify the organization, such as those provided by Open Corporates or some other relevant URI provider. This is not for listing the website of the organization: that can be done through the URL field of the Organization contact point.

contracts/0/implementation/transactions/0/receiverOrganization

object

Receiver organization

(Deprecated in 1.1. Use transaction.payee instead). The Organization Identifier for the organization which receives the funds in this transaction. Expressed following the Organizational Identifier standard - consult the documentation and the codelist.

contracts/0/implementation/transactions/0/receiverOrganization/scheme

[string, null]

Scheme

Organization identifiers should be taken from an existing organization identifier list. The scheme field is used to indicate the list or register from which the identifier is taken. This value should be taken from the Organization Identifier Scheme codelist.

contracts/0/implementation/transactions/0/receiverOrganization/id

[string, integer, null]

ID

The identifier of the organization in the selected scheme.

contracts/0/implementation/transactions/0/receiverOrganization/legalName

[string, null]

Legal Name

The legally registered name of the organization.

contracts/0/implementation/transactions/0/receiverOrganization/uri

[string, null]

uri

URI

A URI to identify the organization, such as those provided by Open Corporates or some other relevant URI provider. This is not for listing the website of the organization: that can be done through the URL field of the Organization contact point.

contracts/0/implementation/milestones

array[Milestone]

Milestones

As milestones are completed, the milestone's status and dates should be updated.

contracts/0/implementation/milestones/0/id

[string, integer]

Required

ID

A local identifier for this milestone, unique within this block. This field is used to keep track of multiple revisions of a milestone through the compilation from release to record mechanism.

contracts/0/implementation/milestones/0/title

[string, null]

Title

Milestone title

contracts/0/implementation/milestones/0/type

[string, null]

Milestone type

The nature of the milestone, using the open milestoneType codelist.

contracts/0/implementation/milestones/0/description

[string, null]

Description

A description of the milestone.

contracts/0/implementation/milestones/0/code

[string, null]

Milestone code

Milestone codes can be used to track specific events that take place for a particular kind of contracting process. For example, a code of 'approvalLetter' can be used to allow applications to understand this milestone represents the date an approvalLetter is due or signed.

contracts/0/implementation/milestones/0/dueDate

[string, null]

date-time

Due date

The date the milestone is due.

contracts/0/implementation/milestones/0/dateMet

[string, null]

date-time

Date met

The date on which the milestone was met.

contracts/0/implementation/milestones/0/dateModified

[string, null]

date-time

Date modified

The date the milestone was last reviewed or modified and the status was altered or confirmed to still be correct.

contracts/0/implementation/milestones/0/status

[string, null]

Status

The status that was realized on the date provided in dateModified, from the closed milestoneStatus codelist.

contracts/0/implementation/milestones/0/documents

array[Document]

Documents

List of documents associated with this milestone (Deprecated in 1.1).

contracts/0/implementation/milestones/0/documents/0/id

[string, integer]

Required

ID

A local, unique identifier for this document. This field is used to keep track of multiple revisions of a document through the compilation from release to record mechanism.

contracts/0/implementation/milestones/0/documents/0/documentType

[string, null]

Document type

A classification of the document described, using the open documentType codelist.

contracts/0/implementation/milestones/0/documents/0/title

[string, null]

Title

The document title.

contracts/0/implementation/milestones/0/documents/0/description

[string, null]

Description

A short description of the document. Descriptions are recommended to not exceed 250 words. In the event the document is not accessible online, the description field can be used to describe arrangements for obtaining a copy of the document.

contracts/0/implementation/milestones/0/documents/0/url

[string, null]

uri

URL

A direct link to the document or attachment. The server providing access to this document ought to be configured to correctly report the document mime type.

contracts/0/implementation/milestones/0/documents/0/datePublished

[string, null]

date-time

Date published

The date on which the document was first published. This is particularly important for legally important documents such as notices of a tender.

contracts/0/implementation/milestones/0/documents/0/dateModified

[string, null]

date-time

Date modified

Date that the document was last modified

contracts/0/implementation/milestones/0/documents/0/format

[string, null]

Format

The format of the document, using the open IANA Media Types codelist (see the values in the 'Template' column), or using the 'offline/print' code if the described document is published offline. For example, web pages have a format of 'text/html'.

contracts/0/implementation/milestones/0/documents/0/language

[string, null]

Language

The language of the linked document using either two-letter ISO639-1, or extended BCP47 language tags. The use of lowercase two-letter codes from ISO639-1 is recommended unless there is a clear user need for distinguishing the language subtype.

contracts/0/implementation/milestones/0/documents/0/pageStart

[string, null]

Page start

When the information referenced exists within a large document, indicate the first page on which it can be found. This should refer to the printed page number, not the page number reported by software applications.

contracts/0/implementation/milestones/0/documents/0/pageEnd

[string, null]

Page end

When the information referenced exists within a large document, indicate the last page on which it can be found. This should refer to the printed page number, not the page number reported by software applications.

contracts/0/implementation/milestones/0/documents/0/accessDetails

[string, null]

Access details

A description of any special arrangements needed to access this document, for example: registering for access, paying a fee, or visiting a location to inspect the document.

contracts/0/implementation/milestones/0/documents/0/accessDetailsURL

[string, null]

uri

Access details URL

A web address for information on any special arrangements needed to access the document.

contracts/0/implementation/milestones/0/documents/0/author

[string, null]

Author

The names of the authors of the document.

contracts/0/implementation/milestones/0/documents/0/unofficialTranslations

array[string]

Unofficial translations

The languages in which unofficial translations of the document are available, from the open language codelist. A BCP47 language tag is allowed, if there is a user need for the additional information.

contracts/0/implementation/documents

array[Document]

Documents

Documents and reports that are part of the implementation phase e.g. audit and evaluation reports.

contracts/0/implementation/documents/0/id

[string, integer]

Required

ID

A local, unique identifier for this document. This field is used to keep track of multiple revisions of a document through the compilation from release to record mechanism.

contracts/0/implementation/documents/0/documentType

[string, null]

Document type

A classification of the document described, using the open documentType codelist.

contracts/0/implementation/documents/0/title

[string, null]

Title

The document title.

contracts/0/implementation/documents/0/description

[string, null]

Description

A short description of the document. Descriptions are recommended to not exceed 250 words. In the event the document is not accessible online, the description field can be used to describe arrangements for obtaining a copy of the document.

contracts/0/implementation/documents/0/url

[string, null]

uri

URL

A direct link to the document or attachment. The server providing access to this document ought to be configured to correctly report the document mime type.

contracts/0/implementation/documents/0/datePublished

[string, null]

date-time

Date published

The date on which the document was first published. This is particularly important for legally important documents such as notices of a tender.

contracts/0/implementation/documents/0/dateModified

[string, null]

date-time

Date modified

Date that the document was last modified

contracts/0/implementation/documents/0/format

[string, null]

Format

The format of the document, using the open IANA Media Types codelist (see the values in the 'Template' column), or using the 'offline/print' code if the described document is published offline. For example, web pages have a format of 'text/html'.

contracts/0/implementation/documents/0/language

[string, null]

Language

The language of the linked document using either two-letter ISO639-1, or extended BCP47 language tags. The use of lowercase two-letter codes from ISO639-1 is recommended unless there is a clear user need for distinguishing the language subtype.

contracts/0/implementation/documents/0/pageStart

[string, null]

Page start

When the information referenced exists within a large document, indicate the first page on which it can be found. This should refer to the printed page number, not the page number reported by software applications.

contracts/0/implementation/documents/0/pageEnd

[string, null]

Page end

When the information referenced exists within a large document, indicate the last page on which it can be found. This should refer to the printed page number, not the page number reported by software applications.

contracts/0/implementation/documents/0/accessDetails

[string, null]

Access details

A description of any special arrangements needed to access this document, for example: registering for access, paying a fee, or visiting a location to inspect the document.

contracts/0/implementation/documents/0/accessDetailsURL

[string, null]

uri

Access details URL

A web address for information on any special arrangements needed to access the document.

contracts/0/implementation/documents/0/author

[string, null]

Author

The names of the authors of the document.

contracts/0/implementation/documents/0/unofficialTranslations

array[string]

Unofficial translations

The languages in which unofficial translations of the document are available, from the open language codelist. A BCP47 language tag is allowed, if there is a user need for the additional information.

contracts/0/implementation/charges

array[Charge]

Charges

Information on the revenue to be raised through charges, as set out in the contract or as subsequently revised during the life of the project.

contracts/0/implementation/charges/0/id

string

Required

Charge identifier

A local identifier for this specific charge. This field is used to keep track of revisions of a charge across multiple OCDS releases.

contracts/0/implementation/charges/0/title

[string, null]

Charge title

A descriptive title for this charge.

contracts/0/implementation/charges/0/paidBy

[string, null]

Paid by

Is this a user charge (paid by businesses or citizens using the facilities provided by the contract), or a charge paid by the government?

contracts/0/implementation/charges/0/period

object

Period

The period to which this charge applies.

contracts/0/implementation/charges/0/period/startDate

[string, null]

date-time

Start date

The start date for the period. When known, a precise start date must be provided.

contracts/0/implementation/charges/0/period/endDate

[string, null]

date-time

End date

The end date for the period. When known, a precise end date must be provided.

contracts/0/implementation/charges/0/period/maxExtentDate

[string, null]

date-time

Maximum extent

The period cannot be extended beyond this date. This field can be used to express the maximum available date for extension or renewal of this period.

contracts/0/implementation/charges/0/period/durationInDays

[integer, null]

Duration (days)

The maximum duration of this period in days. A user interface can collect or display this data in months or years as appropriate, and then convert it into days when storing this field. This field can be used when exact dates are not known. If a startDate and endDate are set, this field, if used, should be equal to the difference between startDate and endDate. Otherwise, if a startDate and maxExtentDate are set, this field, if used, should be equal to the difference between startDate and maxExtentDate.

contracts/0/implementation/charges/0/estimatedValue

object

Estimated value

What is the estimated total value to be raised from this charge during this period.

contracts/0/implementation/charges/0/estimatedValue/amount

[number, null]

Amount

Amount as a number.

contracts/0/implementation/charges/0/estimatedValue/currency

[string, null]

Currency

The currency of the amount, from the closed currency codelist.

contracts/0/implementation/charges/0/actualValue

object

Actual value

In the implementation section, this field may be updated with the total revenue raised from this charge during this period.

contracts/0/implementation/charges/0/actualValue/amount

[number, null]

Amount

Amount as a number.

contracts/0/implementation/charges/0/actualValue/currency

[string, null]

Currency

The currency of the amount, from the closed currency codelist.

contracts/0/implementation/charges/0/notes

[string, null]

Notes

Any notes on this charge. This may include clarifying information.

contracts/0/implementation/metrics

array[Metric]

Metrics

Reported results from the delivery of the contracted goods, works or services.

contracts/0/implementation/metrics/0/id

string

Required

Identifier

An identifier for this metric. In some cases this may be drawn from a codelist of metrics required for this type of contracting process, or in other instances may be an arbitrary identifier.

contracts/0/implementation/metrics/0/title

[string, null]

Title

The title of this metric

contracts/0/implementation/metrics/0/description

[string, null]

Description

A short description of the metric. This may include short details of measurement methods.

contracts/0/implementation/metrics/0/observations

array[Observation]

Observations

An array of target or actual values for this metric.

contracts/0/implementation/metrics/0/observations/0/id

string

Required

Identifier

A local identifier for this specific observation. This may be an arbitrary identifier, or could be a composite of the metric identifier, and the date and other dimensions of this observation.

contracts/0/implementation/metrics/0/observations/0/period

object

Period

The period over which this observation is measured.

contracts/0/implementation/metrics/0/observations/0/period/startDate

[string, null]

date-time

Start date

The start date for the period. When known, a precise start date must be provided.

contracts/0/implementation/metrics/0/observations/0/period/endDate

[string, null]

date-time

End date

The end date for the period. When known, a precise end date must be provided.

contracts/0/implementation/metrics/0/observations/0/period/maxExtentDate

[string, null]

date-time

Maximum extent

The period cannot be extended beyond this date. This field can be used to express the maximum available date for extension or renewal of this period.

contracts/0/implementation/metrics/0/observations/0/period/durationInDays

[integer, null]

Duration (days)

The maximum duration of this period in days. A user interface can collect or display this data in months or years as appropriate, and then convert it into days when storing this field. This field can be used when exact dates are not known. If a startDate and endDate are set, this field, if used, should be equal to the difference between startDate and endDate. Otherwise, if a startDate and maxExtentDate are set, this field, if used, should be equal to the difference between startDate and maxExtentDate.

contracts/0/implementation/metrics/0/observations/0/value

object

Value

For financial metrics, the value of this forecast, target or actual observation.

contracts/0/implementation/metrics/0/observations/0/value/amount

[number, null]

Amount

Amount as a number.

contracts/0/implementation/metrics/0/observations/0/value/currency

[string, null]

Currency

The currency of the amount, from the closed currency codelist.

contracts/0/implementation/metrics/0/observations/0/measure

[string, number, null]

Measure

For non-financial metrics, the measure of this forecast, target or actual observation. Measures may be provided as free text or numerical values.

contracts/0/implementation/metrics/0/observations/0/unit

object

Unit

Unit

contracts/0/implementation/metrics/0/observations/0/unit/name

[string, null]

Unit name

The name of the unit.

contracts/0/implementation/metrics/0/observations/0/unit/scheme

[string, null]

Scheme

The list from which units of measure identifiers are taken. It is recommended to use the scheme 'UNCEFACT' and codes from the UN/CEFACT Recommendation 20 list of "Codes for Units of Measure Used in International Trade".

contracts/0/implementation/metrics/0/observations/0/unit/id

[string, null]

ID

The identifier from the codelist referenced in the scheme field. For example, with UNCEFACT, this is the value of the 'Common Code' column. From this identifier, applications can look-up the human readable name or symbol for this unit of measure.

contracts/0/implementation/metrics/0/observations/0/unit/uri

[string, null]

uri

URI

If the scheme used provide a machine-readable URI for this unit of measure, this can be given.

contracts/0/implementation/metrics/0/observations/0/dimensions

object

Dimensions

Any number of dimensions can be recorded within this object. Dimensions names should follow the camelCase conventions of OCDS.

contracts/0/implementation/metrics/0/observations/0/notes

[string, null]

Notes

Any notes on this observation. This may include clarifying information.

contracts/0/implementation/metrics/0/observations/0/relatedImplementationMilestone

object

Related implementation milestone

A link to the milestone in the implementation section of OCDS to which this forecast, target or actual observation relates.

contracts/0/implementation/metrics/0/observations/0/relatedImplementationMilestone/id

string

Required

Milestone ID

The ID of the milestone being referenced, this must match the ID of a milestone described elsewhere in a release about this contracting process.

contracts/0/implementation/metrics/0/observations/0/relatedImplementationMilestone/title

[string, null]

Milestone title

The title of the milestone being referenced, this must match the title of a milestone described elsewhere in a release about this contracting process.

contracts/0/implementation/performanceFailures

array[Performance failure disclosure]

Performance failure disclosures

An array of performance failure disclosures, detailing performance failures for different periods and categories.

contracts/0/implementation/performanceFailures/0/id

string

Required

Identifier

A local identifier for this specific category and period of performance failure. This field is used to keep track of revisions of a charge across multiple OCDS releases.

contracts/0/implementation/performanceFailures/0/period

object

Performance failure period

The reporting period for the performance failures.

contracts/0/implementation/performanceFailures/0/period/startDate

[string, null]

date-time

Start date

The start date for the period. When known, a precise start date must be provided.

contracts/0/implementation/performanceFailures/0/period/endDate

[string, null]

date-time

End date

The end date for the period. When known, a precise end date must be provided.

contracts/0/implementation/performanceFailures/0/period/maxExtentDate

[string, null]

date-time

Maximum extent

The period cannot be extended beyond this date. This field can be used to express the maximum available date for extension or renewal of this period.

contracts/0/implementation/performanceFailures/0/period/durationInDays

[integer, null]

Duration (days)

The maximum duration of this period in days. A user interface can collect or display this data in months or years as appropriate, and then convert it into days when storing this field. This field can be used when exact dates are not known. If a startDate and endDate are set, this field, if used, should be equal to the difference between startDate and endDate. Otherwise, if a startDate and maxExtentDate are set, this field, if used, should be equal to the difference between startDate and maxExtentDate.

contracts/0/implementation/performanceFailures/0/category

[string, null]

Performance failure category

The category of the performance failures.

contracts/0/implementation/performanceFailures/0/events

[number, null]

Number of events

The number of performance failures for this period and category.

contracts/0/implementation/performanceFailures/0/penaltyContracted

[string, null]

Contracted penalty

A description of the penalty or abatement provided for in the contract for this period, category and number of performance failures.

contracts/0/implementation/performanceFailures/0/penaltyImposed

[string, null]

Penalty imposed

A description of the penalty or abatement imposed for this period, category and number of performance failures.

contracts/0/implementation/performanceFailures/0/penaltyPaid

[boolean, null]

Penalty paid

Whether the penalty imposed for this period, category and number of performance failures has been paid.

contracts/0/implementation/tariffs

array[Tariff]

Tariffs

The tariffs as they apply during the life of the project. Also known as tolls or user charges. These may be initially copied from the contract section, and then updated with any revisions over the lifetime of the implementation phase.

contracts/0/implementation/tariffs/0/id

string

Required

Identifier

A local identifier for this specific tariff. This field is used to keep track of revisions of a tariff across multiple OCDS releases.

contracts/0/implementation/tariffs/0/title

[string, null]

Title

The title of this tariff.

contracts/0/implementation/tariffs/0/paidBy

[string, null]

Paid by

Is this a user charge (paid by businesses or citizens using the facilities provided by the contract), or a charge paid by the government?

contracts/0/implementation/tariffs/0/period

object

Period

The period to which this tariff applies.

contracts/0/implementation/tariffs/0/period/startDate

[string, null]

date-time

Start date

The start date for the period. When known, a precise start date must be provided.

contracts/0/implementation/tariffs/0/period/endDate

[string, null]

date-time

End date

The end date for the period. When known, a precise end date must be provided.

contracts/0/implementation/tariffs/0/period/maxExtentDate

[string, null]

date-time

Maximum extent

The period cannot be extended beyond this date. This field can be used to express the maximum available date for extension or renewal of this period.

contracts/0/implementation/tariffs/0/period/durationInDays

[integer, null]

Duration (days)

The maximum duration of this period in days. A user interface can collect or display this data in months or years as appropriate, and then convert it into days when storing this field. This field can be used when exact dates are not known. If a startDate and endDate are set, this field, if used, should be equal to the difference between startDate and endDate. Otherwise, if a startDate and maxExtentDate are set, this field, if used, should be equal to the difference between startDate and maxExtentDate.

contracts/0/implementation/tariffs/0/value

object

Value

The price per unit of this tariff.

contracts/0/implementation/tariffs/0/value/amount

[number, null]

Amount

Amount as a number.

contracts/0/implementation/tariffs/0/value/currency

[string, null]

Currency

The currency of the amount, from the closed currency codelist.

contracts/0/implementation/tariffs/0/unit

object

Unit

The unit against which this tariff is charged.

contracts/0/implementation/tariffs/0/unit/name

[string, null]

Unit name

The name of the unit that the tariff is charged against. E.g. tonnes,

contracts/0/implementation/tariffs/0/unit/scheme

[string, null]

Scheme

The list from which units of measure identifiers are taken. It is recommended to use the scheme 'UNCEFACT' and codes from the UN/CEFACT Recommendation 20 list of "Codes for Units of Measure Used in International Trade".

contracts/0/implementation/tariffs/0/unit/id

[string, null]

ID

The identifier from the codelist referenced in the schema property. For example, with UNCEFACT, this is the value of the 'Common Code' column. From this identifier, applications can look-up the human readable name or symbol for this unit of measure.

contracts/0/implementation/tariffs/0/unit/uri

[string, null]

uri

URI

If the scheme used provide a machine-readable URI for this unit of measure, this can be given.

contracts/0/implementation/tariffs/0/dimensions

object

Dimensions

Used to capture the different breakdowns in tariff charges. Any number of dimensions can be recorded within this object. Dimensions names should follow the camelCase conventions of OCDS.

contracts/0/implementation/tariffs/0/notes

[string, null]

Notes

Any notes on this tariff line item. This may include clarifying information.

contracts/0/relatedProcesses

array[Related Process]

Related processes

The details of related processes: for example, if this process is followed by one or more contracting processes, represented under a separate open contracting identifier (ocid). This is commonly used to refer to subcontracts and to renewal or replacement processes for this contract.

contracts/0/relatedProcesses/0/id

string

Relationship ID

A local identifier for this relationship, unique within this array.

contracts/0/relatedProcesses/0/relationship

array[string]

Relationship

The type of relationship, using the open relatedProcess codelist.

contracts/0/relatedProcesses/0/title

[string, null]

Related process title

The title of the related process, where referencing an open contracting process, this field should match the tender/title field in the related process.

contracts/0/relatedProcesses/0/scheme

[string, null]

Scheme

The identification scheme used by this cross-reference, using the open relatedProcessScheme codelist.

contracts/0/relatedProcesses/0/identifier

[string, null]

Identifier

The identifier of the related process. If the scheme is 'ocid', this must be an Open Contracting ID (ocid).

contracts/0/relatedProcesses/0/uri

[string, null]

uri

Related process URI

A URI pointing to a machine-readable document, release or record package containing the identified related process.

contracts/0/milestones

array[Milestone]

Contract milestones

A list of milestones associated with the finalization of this contract.

contracts/0/milestones/0/id

[string, integer]

Required

ID

A local identifier for this milestone, unique within this block. This field is used to keep track of multiple revisions of a milestone through the compilation from release to record mechanism.

contracts/0/milestones/0/title

[string, null]

Title

Milestone title

contracts/0/milestones/0/type

[string, null]

Milestone type

The nature of the milestone, using the open milestoneType codelist.

contracts/0/milestones/0/description

[string, null]

Description

A description of the milestone.

contracts/0/milestones/0/code

[string, null]

Milestone code

Milestone codes can be used to track specific events that take place for a particular kind of contracting process. For example, a code of 'approvalLetter' can be used to allow applications to understand this milestone represents the date an approvalLetter is due or signed.

contracts/0/milestones/0/dueDate

[string, null]

date-time

Due date

The date the milestone is due.

contracts/0/milestones/0/dateMet

[string, null]

date-time

Date met

The date on which the milestone was met.

contracts/0/milestones/0/dateModified

[string, null]

date-time

Date modified

The date the milestone was last reviewed or modified and the status was altered or confirmed to still be correct.

contracts/0/milestones/0/status

[string, null]

Status

The status that was realized on the date provided in dateModified, from the closed milestoneStatus codelist.

contracts/0/milestones/0/documents

array[Document]

Documents

List of documents associated with this milestone (Deprecated in 1.1).

contracts/0/milestones/0/documents/0/id

[string, integer]

Required

ID

A local, unique identifier for this document. This field is used to keep track of multiple revisions of a document through the compilation from release to record mechanism.

contracts/0/milestones/0/documents/0/documentType

[string, null]

Document type

A classification of the document described, using the open documentType codelist.

contracts/0/milestones/0/documents/0/title

[string, null]

Title

The document title.

contracts/0/milestones/0/documents/0/description

[string, null]

Description

A short description of the document. Descriptions are recommended to not exceed 250 words. In the event the document is not accessible online, the description field can be used to describe arrangements for obtaining a copy of the document.

contracts/0/milestones/0/documents/0/url

[string, null]

uri

URL

A direct link to the document or attachment. The server providing access to this document ought to be configured to correctly report the document mime type.

contracts/0/milestones/0/documents/0/datePublished

[string, null]

date-time

Date published

The date on which the document was first published. This is particularly important for legally important documents such as notices of a tender.

contracts/0/milestones/0/documents/0/dateModified

[string, null]

date-time

Date modified

Date that the document was last modified

contracts/0/milestones/0/documents/0/format

[string, null]

Format

The format of the document, using the open IANA Media Types codelist (see the values in the 'Template' column), or using the 'offline/print' code if the described document is published offline. For example, web pages have a format of 'text/html'.

contracts/0/milestones/0/documents/0/language

[string, null]

Language

The language of the linked document using either two-letter ISO639-1, or extended BCP47 language tags. The use of lowercase two-letter codes from ISO639-1 is recommended unless there is a clear user need for distinguishing the language subtype.

contracts/0/milestones/0/documents/0/pageStart

[string, null]

Page start

When the information referenced exists within a large document, indicate the first page on which it can be found. This should refer to the printed page number, not the page number reported by software applications.

contracts/0/milestones/0/documents/0/pageEnd

[string, null]

Page end

When the information referenced exists within a large document, indicate the last page on which it can be found. This should refer to the printed page number, not the page number reported by software applications.

contracts/0/milestones/0/documents/0/accessDetails

[string, null]

Access details

A description of any special arrangements needed to access this document, for example: registering for access, paying a fee, or visiting a location to inspect the document.

contracts/0/milestones/0/documents/0/accessDetailsURL

[string, null]

uri

Access details URL

A web address for information on any special arrangements needed to access the document.

contracts/0/milestones/0/documents/0/author

[string, null]

Author

The names of the authors of the document.

contracts/0/milestones/0/documents/0/unofficialTranslations

array[string]

Unofficial translations

The languages in which unofficial translations of the document are available, from the open language codelist. A BCP47 language tag is allowed, if there is a user need for the additional information.

contracts/0/amendments

array[Amendment]

Amendments

A contract amendment is a formal change to, or extension of, a contract, and generally involves the publication of a new contract notice/release, or some other documents detailing the change. The rationale and a description of the changes made can be provided here.

contracts/0/amendments/0/date

[string, null]

date-time

Amendment date

The date of this amendment.

contracts/0/amendments/0/rationale

[string, null]

Rationale

An explanation for the amendment.

contracts/0/amendments/0/id

[string, null]

ID

An identifier for this amendment: often the amendment number

contracts/0/amendments/0/description

[string, null]

Description

A free text, or semi-structured, description of the changes made in this amendment.

contracts/0/amendments/0/amendsReleaseID

[string, null]

Amended release (identifier)

Provide the identifier (release.id) of the OCDS release (from this contracting process) that provides the values for this contracting process before the amendment was made.

contracts/0/amendments/0/releaseID

[string, null]

Amending release (identifier)

Provide the identifier (release.id) of the OCDS release (from this contracting process) that provides the values for this contracting process after the amendment was made.

contracts/0/amendments/0/changes

array[object]

Amended fields

An array of change objects describing the fields changed, and their former values. (Deprecated in 1.1)

contracts/0/amendments/0/changes/0/property

string

Property

The property name that has been changed relative to the place the amendment is. For example if the contract value has changed, then the property under changes within the contract.amendment would be value.amount. (Deprecated in 1.1)

contracts/0/amendment

object

Amendment

The use of individual amendment objects has been deprecated. From OCDS 1.1 information should be provided in the amendments array.

contracts/0/amendment/date

[string, null]

date-time

Amendment date

The date of this amendment.

contracts/0/amendment/rationale

[string, null]

Rationale

An explanation for the amendment.

contracts/0/amendment/id

[string, null]

ID

An identifier for this amendment: often the amendment number

contracts/0/amendment/description

[string, null]

Description

A free text, or semi-structured, description of the changes made in this amendment.

contracts/0/amendment/amendsReleaseID

[string, null]

Amended release (identifier)

Provide the identifier (release.id) of the OCDS release (from this contracting process) that provides the values for this contracting process before the amendment was made.

contracts/0/amendment/releaseID

[string, null]

Amending release (identifier)

Provide the identifier (release.id) of the OCDS release (from this contracting process) that provides the values for this contracting process after the amendment was made.

contracts/0/amendment/changes

array[object]

Amended fields

An array of change objects describing the fields changed, and their former values. (Deprecated in 1.1)

contracts/0/amendment/changes/0/property

string

Property

The property name that has been changed relative to the place the amendment is. For example if the contract value has changed, then the property under changes within the contract.amendment would be value.amount. (Deprecated in 1.1)

contracts/0/finance

array[Financing arrangement]

Finance

Information about financing arrangements for this contract.

contracts/0/finance/0/id

string

Required

ID

An identifier for this financing arrangement.

contracts/0/finance/0/title

[string, null]

Title

A short title for this financing arrangement.

contracts/0/finance/0/description

[string, null]

Description

A short description of this financing arrangement. This may include details of service fees, commitment fees, lender rights, step in arrangements, exchange rate guarantees, and for syndicated loans, details of syndication and any members of the syndicate.

contracts/0/finance/0/value

object

Value

The total value of this finance.

contracts/0/finance/0/value/amount

[number, null]

Amount

Amount as a number.

contracts/0/finance/0/value/currency

[string, null]

Currency

The currency of the amount, from the closed currency codelist.

contracts/0/finance/0/financingParty

object

Financing organization

The organization providing this financing arrangement.

contracts/0/finance/0/financingParty/name

[string, null]

Organization name

The name of the party being referenced. This must match the name of an entry in the parties section.

contracts/0/finance/0/financingParty/id

[string, integer]

Organization ID

The id of the party being referenced. This must match the id of an entry in the parties section.

contracts/0/finance/0/financingParty/identifier

object

Primary identifier

The primary identifier for this organization. Identifiers that uniquely pick out a legal entity should be preferred. Consult the organization identifier guidance for the preferred scheme and identifier to use.

contracts/0/finance/0/financingParty/identifier/scheme

[string, null]

Scheme

Organization identifiers should be taken from an existing organization identifier list. The scheme field is used to indicate the list or register from which the identifier is taken. This value should be taken from the Organization Identifier Scheme codelist.

contracts/0/finance/0/financingParty/identifier/id

[string, integer, null]

ID

The identifier of the organization in the selected scheme.

contracts/0/finance/0/financingParty/identifier/legalName

[string, null]

Legal Name

The legally registered name of the organization.

contracts/0/finance/0/financingParty/identifier/uri

[string, null]

uri

URI

A URI to identify the organization, such as those provided by Open Corporates or some other relevant URI provider. This is not for listing the website of the organization: that can be done through the URL field of the Organization contact point.

contracts/0/finance/0/financingParty/address

object

Address

(Deprecated outside the parties section)

contracts/0/finance/0/financingParty/address/streetAddress

[string, null]

Street address

The street address. For example, 1600 Amphitheatre Pkwy.

contracts/0/finance/0/financingParty/address/locality

[string, null]

Locality

The locality. For example, Mountain View.

contracts/0/finance/0/financingParty/address/region

[string, null]

Region

The region. For example, CA.

contracts/0/finance/0/financingParty/address/postalCode

[string, null]

Postal code

The postal code. For example, 94043.

contracts/0/finance/0/financingParty/address/countryName

[string, null]

Country name

The country name. For example, United States.

contracts/0/finance/0/financingParty/additionalIdentifiers

array[Identifier]

Additional identifiers

(Deprecated outside the parties section) A list of additional / supplemental identifiers for the organization, using the organization identifier guidance. This can be used to provide an internally used identifier for this organization in addition to the primary legal entity identifier.

contracts/0/finance/0/financingParty/additionalIdentifiers/0/scheme

[string, null]

Scheme

Organization identifiers should be taken from an existing organization identifier list. The scheme field is used to indicate the list or register from which the identifier is taken. This value should be taken from the Organization Identifier Scheme codelist.

contracts/0/finance/0/financingParty/additionalIdentifiers/0/id

[string, integer, null]

ID

The identifier of the organization in the selected scheme.

contracts/0/finance/0/financingParty/additionalIdentifiers/0/legalName

[string, null]

Legal Name

The legally registered name of the organization.

contracts/0/finance/0/financingParty/additionalIdentifiers/0/uri

[string, null]

uri

URI

A URI to identify the organization, such as those provided by Open Corporates or some other relevant URI provider. This is not for listing the website of the organization: that can be done through the URL field of the Organization contact point.

contracts/0/finance/0/financingParty/contactPoint

object

Contact point

(Deprecated outside the parties section)

contracts/0/finance/0/financingParty/contactPoint/name

[string, null]

Name

The name of the contact person, department, or contact point, for correspondence relating to this contracting process.

contracts/0/finance/0/financingParty/contactPoint/email

[string, null]

Email

The e-mail address of the contact point/person.

contracts/0/finance/0/financingParty/contactPoint/telephone

[string, null]

Telephone

The telephone number of the contact point/person. This should include the international dialing code.

contracts/0/finance/0/financingParty/contactPoint/faxNumber

[string, null]

Fax number

The fax number of the contact point/person. This should include the international dialing code.

contracts/0/finance/0/financingParty/contactPoint/url

[string, null]

uri

URL

A web address for the contact point/person.

contracts/0/finance/0/financingPartyType

[string, null]

Financing organization type

The type of the financing organization, from the closed financingPartyType codelist.

contracts/0/finance/0/source

[string, null]

Funding source

The source of funds for this financing arrangement. For example, the Green Climate Fund.

contracts/0/finance/0/assetClass

array[string]

Asset class

The asset classes used in this financing arrangement, from the closed assetClass codelist.

contracts/0/finance/0/type

[string, null]

Type

The type of this financing arrangement, from the closed financingArrangementType codelist.

contracts/0/finance/0/repaymentPriority

[string, null]

Repayment priority

The order in which the debt in this financing arrangement will be repaid in case of default, from the closed debtRepaymentPriority codelist.

contracts/0/finance/0/concessional

[boolean, null]

Concessional

Whether this financing arrangement is provided below market rate in order to accelerate climate or development objectives. Also called soft financing and subsidized funding.

contracts/0/finance/0/resultsBased

[boolean, null]

Results based

Whether payments under this financing arrangement are contingent on the achievement of pre-defined results.

contracts/0/finance/0/period

object

Finance period

The period covered by this financing arrangement. Also called maturity.

contracts/0/finance/0/period/startDate

[string, null]

date-time

Start date

The start date for the period. When known, a precise start date must be provided.

contracts/0/finance/0/period/endDate

[string, null]

date-time

End date

The end date for the period. When known, a precise end date must be provided.

contracts/0/finance/0/period/maxExtentDate

[string, null]

date-time

Maximum extent

The period cannot be extended beyond this date. This field can be used to express the maximum available date for extension or renewal of this period.

contracts/0/finance/0/period/durationInDays

[integer, null]

Duration (days)

The maximum duration of this period in days. A user interface can collect or display this data in months or years as appropriate, and then convert it into days when storing this field. This field can be used when exact dates are not known. If a startDate and endDate are set, this field, if used, should be equal to the difference between startDate and endDate. Otherwise, if a startDate and maxExtentDate are set, this field, if used, should be equal to the difference between startDate and maxExtentDate.

contracts/0/finance/0/paymentPeriod

object

Payment period

The period over which the borrower in this financing arrangement is obliged to make payments.

contracts/0/finance/0/paymentPeriod/startDate

[string, null]

date-time

Start date

The start date for the period. When known, a precise start date must be provided.

contracts/0/finance/0/paymentPeriod/endDate

[string, null]

date-time

End date

The end date for the period. When known, a precise end date must be provided.

contracts/0/finance/0/paymentPeriod/maxExtentDate

[string, null]

date-time

Maximum extent

The period cannot be extended beyond this date. This field can be used to express the maximum available date for extension or renewal of this period.

contracts/0/finance/0/paymentPeriod/durationInDays

[integer, null]

Duration (days)

The maximum duration of this period in days. A user interface can collect or display this data in months or years as appropriate, and then convert it into days when storing this field. This field can be used when exact dates are not known. If a startDate and endDate are set, this field, if used, should be equal to the difference between startDate and endDate. Otherwise, if a startDate and maxExtentDate are set, this field, if used, should be equal to the difference between startDate and maxExtentDate.

contracts/0/finance/0/paymentFrequency

[number, null]

Payment frequency (days)

The average payment frequency (in days) of this financing arrangement. For example, 365 for yearly, 30.4 for monthly, or 1 for daily.

contracts/0/finance/0/interestRate

object

Interest rate

The interest rate associated with this finance.

contracts/0/finance/0/interestRate/base

[string, number, null]

Base

The variable to which an additional margin amount is added to get the interest amount. This can be specified as a fixed number, as a known variable (e.g. LIBOR or LIBOR+1%), or can be omitted if margin specifies the entire interest rate.

contracts/0/finance/0/interestRate/margin

[number, null]

Margin

The variable added to the base to give the interest amount, expressed as a decimal (for example, 0.1) and not as a percentage (for example, 10).

contracts/0/finance/0/interestRate/fixed

[boolean, null]

Fixed rate

A boolean field. If this interest rate of fixed, set to true. Otherwise, set to false.

contracts/0/finance/0/interestRate/notes

[string, null]

Notes

Any explanatory notes concerning the interest rate.

contracts/0/finance/0/exchangeRateGuarantee

[boolean, null]

Exchange rate guarantees

Whether there is an associated exchange rate guarantee with this source of finance.

contracts/0/finance/0/stepInRights

[boolean, null]

Step in rights

Whether provision of this finance confers any step in rights to the financing organization.

contracts/0/finance/0/relatedLots

array[string]

Related lot(s)

The identifiers of the lots to which this financing arrangement relates.

contracts/0/agreedMetrics

array[Metric]

Agreed metrics

Any target metrics set out as part of the contract documents.

contracts/0/agreedMetrics/0/id

string

Required

Identifier

An identifier for this metric. In some cases this may be drawn from a codelist of metrics required for this type of contracting process, or in other instances may be an arbitrary identifier.

contracts/0/agreedMetrics/0/title

[string, null]

Title

The title of this metric

contracts/0/agreedMetrics/0/description

[string, null]

Description

A short description of the metric. This may include short details of measurement methods.

contracts/0/agreedMetrics/0/observations

array[Observation]

Observations

An array of target or actual values for this metric.

contracts/0/agreedMetrics/0/observations/0/id

string

Required

Identifier

A local identifier for this specific observation. This may be an arbitrary identifier, or could be a composite of the metric identifier, and the date and other dimensions of this observation.

contracts/0/agreedMetrics/0/observations/0/period

object

Period

The period over which this observation is measured.

contracts/0/agreedMetrics/0/observations/0/period/startDate

[string, null]

date-time

Start date

The start date for the period. When known, a precise start date must be provided.

contracts/0/agreedMetrics/0/observations/0/period/endDate

[string, null]

date-time

End date

The end date for the period. When known, a precise end date must be provided.

contracts/0/agreedMetrics/0/observations/0/period/maxExtentDate

[string, null]

date-time

Maximum extent

The period cannot be extended beyond this date. This field can be used to express the maximum available date for extension or renewal of this period.

contracts/0/agreedMetrics/0/observations/0/period/durationInDays

[integer, null]

Duration (days)

The maximum duration of this period in days. A user interface can collect or display this data in months or years as appropriate, and then convert it into days when storing this field. This field can be used when exact dates are not known. If a startDate and endDate are set, this field, if used, should be equal to the difference between startDate and endDate. Otherwise, if a startDate and maxExtentDate are set, this field, if used, should be equal to the difference between startDate and maxExtentDate.

contracts/0/agreedMetrics/0/observations/0/value

object

Value

For financial metrics, the value of this forecast, target or actual observation.

contracts/0/agreedMetrics/0/observations/0/value/amount

[number, null]

Amount

Amount as a number.

contracts/0/agreedMetrics/0/observations/0/value/currency

[string, null]

Currency

The currency of the amount, from the closed currency codelist.

contracts/0/agreedMetrics/0/observations/0/measure

[string, number, null]

Measure

For non-financial metrics, the measure of this forecast, target or actual observation. Measures may be provided as free text or numerical values.

contracts/0/agreedMetrics/0/observations/0/unit

object

Unit

Unit

contracts/0/agreedMetrics/0/observations/0/unit/name

[string, null]

Unit name

The name of the unit.

contracts/0/agreedMetrics/0/observations/0/unit/scheme

[string, null]

Scheme

The list from which units of measure identifiers are taken. It is recommended to use the scheme 'UNCEFACT' and codes from the UN/CEFACT Recommendation 20 list of "Codes for Units of Measure Used in International Trade".

contracts/0/agreedMetrics/0/observations/0/unit/id

[string, null]

ID

The identifier from the codelist referenced in the scheme field. For example, with UNCEFACT, this is the value of the 'Common Code' column. From this identifier, applications can look-up the human readable name or symbol for this unit of measure.

contracts/0/agreedMetrics/0/observations/0/unit/uri

[string, null]

uri

URI

If the scheme used provide a machine-readable URI for this unit of measure, this can be given.

contracts/0/agreedMetrics/0/observations/0/dimensions

object

Dimensions

Any number of dimensions can be recorded within this object. Dimensions names should follow the camelCase conventions of OCDS.

contracts/0/agreedMetrics/0/observations/0/notes

[string, null]

Notes

Any notes on this observation. This may include clarifying information.

contracts/0/agreedMetrics/0/observations/0/relatedImplementationMilestone

object

Related implementation milestone

A link to the milestone in the implementation section of OCDS to which this forecast, target or actual observation relates.

contracts/0/agreedMetrics/0/observations/0/relatedImplementationMilestone/id

string

Required

Milestone ID

The ID of the milestone being referenced, this must match the ID of a milestone described elsewhere in a release about this contracting process.

contracts/0/agreedMetrics/0/observations/0/relatedImplementationMilestone/title

[string, null]

Milestone title

The title of the milestone being referenced, this must match the title of a milestone described elsewhere in a release about this contracting process.

contracts/0/riskAllocation

array[Risk]

Risk allocation

Information on the allocation of risks relating to the contract.

contracts/0/riskAllocation/0/id

[string, integer]

Required

Risk ID

A local identifier for this risk, unique within this block. This field is used to keep track of multiple revisions of a risk through the compilation from release to record mechanism.

contracts/0/riskAllocation/0/category

[string, null]

Risk category

The category of the risk, from the riskCategory codelist.

contracts/0/riskAllocation/0/description

[string, null]

Risk description

The description of the risk.

contracts/0/riskAllocation/0/allocation

[string, null]

Risk allocation

The party to the contract that retains the risk.

contracts/0/riskAllocation/0/notes

[string, null]

Risk notes

Additional notes on the risk, for example the rationale for the allocation.

contracts/0/signatories

array[Organization reference]

Contract signatories

The signatories to the contract. Each signatory should have a corresponding entry in the parties array.

contracts/0/signatories/0/name

[string, null]

Organization name

The name of the party being referenced. This must match the name of an entry in the parties section.

contracts/0/signatories/0/id

[string, integer]

Organization ID

The id of the party being referenced. This must match the id of an entry in the parties section.

contracts/0/signatories/0/identifier

object

Primary identifier

The primary identifier for this organization. Identifiers that uniquely pick out a legal entity should be preferred. Consult the organization identifier guidance for the preferred scheme and identifier to use.

contracts/0/signatories/0/identifier/scheme

[string, null]

Scheme

Organization identifiers should be taken from an existing organization identifier list. The scheme field is used to indicate the list or register from which the identifier is taken. This value should be taken from the Organization Identifier Scheme codelist.

contracts/0/signatories/0/identifier/id

[string, integer, null]

ID

The identifier of the organization in the selected scheme.

contracts/0/signatories/0/identifier/legalName

[string, null]

Legal Name

The legally registered name of the organization.

contracts/0/signatories/0/identifier/uri

[string, null]

uri

URI

A URI to identify the organization, such as those provided by Open Corporates or some other relevant URI provider. This is not for listing the website of the organization: that can be done through the URL field of the Organization contact point.

contracts/0/signatories/0/address

object

Address

(Deprecated outside the parties section)

contracts/0/signatories/0/address/streetAddress

[string, null]

Street address

The street address. For example, 1600 Amphitheatre Pkwy.

contracts/0/signatories/0/address/locality

[string, null]

Locality

The locality. For example, Mountain View.

contracts/0/signatories/0/address/region

[string, null]

Region

The region. For example, CA.

contracts/0/signatories/0/address/postalCode

[string, null]

Postal code

The postal code. For example, 94043.

contracts/0/signatories/0/address/countryName

[string, null]

Country name

The country name. For example, United States.

contracts/0/signatories/0/additionalIdentifiers

array[Identifier]

Additional identifiers

(Deprecated outside the parties section) A list of additional / supplemental identifiers for the organization, using the organization identifier guidance. This can be used to provide an internally used identifier for this organization in addition to the primary legal entity identifier.

contracts/0/signatories/0/additionalIdentifiers/0/scheme

[string, null]

Scheme

Organization identifiers should be taken from an existing organization identifier list. The scheme field is used to indicate the list or register from which the identifier is taken. This value should be taken from the Organization Identifier Scheme codelist.

contracts/0/signatories/0/additionalIdentifiers/0/id

[string, integer, null]

ID

The identifier of the organization in the selected scheme.

contracts/0/signatories/0/additionalIdentifiers/0/legalName

[string, null]

Legal Name

The legally registered name of the organization.

contracts/0/signatories/0/additionalIdentifiers/0/uri

[string, null]

uri

URI

A URI to identify the organization, such as those provided by Open Corporates or some other relevant URI provider. This is not for listing the website of the organization: that can be done through the URL field of the Organization contact point.

contracts/0/signatories/0/contactPoint

object

Contact point

(Deprecated outside the parties section)

contracts/0/signatories/0/contactPoint/name

[string, null]

Name

The name of the contact person, department, or contact point, for correspondence relating to this contracting process.

contracts/0/signatories/0/contactPoint/email

[string, null]

Email

The e-mail address of the contact point/person.

contracts/0/signatories/0/contactPoint/telephone

[string, null]

Telephone

The telephone number of the contact point/person. This should include the international dialing code.

contracts/0/signatories/0/contactPoint/faxNumber

[string, null]

Fax number

The fax number of the contact point/person. This should include the international dialing code.

contracts/0/signatories/0/contactPoint/url

[string, null]

uri

URL

A web address for the contact point/person.

contracts/0/tariffs

array[Tariff]

Tariffs

The tariffs as set out in the contract schedules. Also known as tolls or user charges. Updates to tariffs over the operation of the contract can be provided in the implementation section.

contracts/0/tariffs/0/id

string

Required

Identifier

A local identifier for this specific tariff. This field is used to keep track of revisions of a tariff across multiple OCDS releases.

contracts/0/tariffs/0/title

[string, null]

Title

The title of this tariff.

contracts/0/tariffs/0/paidBy

[string, null]

Paid by

Is this a user charge (paid by businesses or citizens using the facilities provided by the contract), or a charge paid by the government?

contracts/0/tariffs/0/period

object

Period

The period to which this tariff applies.

contracts/0/tariffs/0/period/startDate

[string, null]

date-time

Start date

The start date for the period. When known, a precise start date must be provided.

contracts/0/tariffs/0/period/endDate

[string, null]

date-time

End date

The end date for the period. When known, a precise end date must be provided.

contracts/0/tariffs/0/period/maxExtentDate

[string, null]

date-time

Maximum extent

The period cannot be extended beyond this date. This field can be used to express the maximum available date for extension or renewal of this period.

contracts/0/tariffs/0/period/durationInDays

[integer, null]

Duration (days)

The maximum duration of this period in days. A user interface can collect or display this data in months or years as appropriate, and then convert it into days when storing this field. This field can be used when exact dates are not known. If a startDate and endDate are set, this field, if used, should be equal to the difference between startDate and endDate. Otherwise, if a startDate and maxExtentDate are set, this field, if used, should be equal to the difference between startDate and maxExtentDate.

contracts/0/tariffs/0/value

object

Value

The price per unit of this tariff.

contracts/0/tariffs/0/value/amount

[number, null]

Amount

Amount as a number.

contracts/0/tariffs/0/value/currency

[string, null]

Currency

The currency of the amount, from the closed currency codelist.

contracts/0/tariffs/0/unit

object

Unit

The unit against which this tariff is charged.

contracts/0/tariffs/0/unit/name

[string, null]

Unit name

The name of the unit that the tariff is charged against. E.g. tonnes,

contracts/0/tariffs/0/unit/scheme

[string, null]

Scheme

The list from which units of measure identifiers are taken. It is recommended to use the scheme 'UNCEFACT' and codes from the UN/CEFACT Recommendation 20 list of "Codes for Units of Measure Used in International Trade".

contracts/0/tariffs/0/unit/id

[string, null]

ID

The identifier from the codelist referenced in the schema property. For example, with UNCEFACT, this is the value of the 'Common Code' column. From this identifier, applications can look-up the human readable name or symbol for this unit of measure.

contracts/0/tariffs/0/unit/uri

[string, null]

uri

URI

If the scheme used provide a machine-readable URI for this unit of measure, this can be given.

contracts/0/tariffs/0/dimensions

object

Dimensions

Used to capture the different breakdowns in tariff charges. Any number of dimensions can be recorded within this object. Dimensions names should follow the camelCase conventions of OCDS.

contracts/0/tariffs/0/notes

[string, null]

Notes

Any notes on this tariff line item. This may include clarifying information.

contracts/0/financeSummary

object

Finance summary

Key indicators that describe the financial model of the PPP.

contracts/0/financeSummary/debtEquityRatio

[number, null]

Debt-equity ratio

The debt-equity ratio of the project, expressed as a decimal (for example, 0.1). Also called gearing or leverage.

contracts/0/financeSummary/debtEquityRatioDetails

[string, null]

Debt-equity ratio details

Additional details on the calculation of the debt equity ratio.

contracts/0/financeSummary/shareCapital

object

Share capital

The value of the capital in the project that comes from the issue of shares.

contracts/0/financeSummary/shareCapital/amount

[number, null]

Amount

Amount as a number.

contracts/0/financeSummary/shareCapital/currency

[string, null]

Currency

The currency of the amount, from the closed currency codelist.

contracts/0/financeSummary/shareCapitalDetails

[string, null]

Share capital details

Additional details on the calculation of the share capital.

contracts/0/financeSummary/subsidyRatio

[number, null]

Subsidy ratio

The subsidy's proportion of the project value, expressed as a decimal between 0 and 1.

contracts/0/financeSummary/subsidyRatioDetails

[string, null]

Subsidy ratio details

Additional details on the calculation of the subsidy ratio.

contracts/0/financeSummary/projectIRR

[number, null]

Internal rate of return

The internal rate of return of the project, expressed as a decimal (for example, 0.1) and not as a percentage (for example, 10).

contracts/0/financeSummary/projectIRRDetails

[string, null]

Internal rate of return details

Additional details on the calculation of the project IRR.

language

[string, null]

Release language

The default language of the data using either two-letter ISO639-1, or extended BCP47 language tags. The use of lowercase two-letter codes from ISO639-1 is recommended.

relatedProcesses

array[Related Process]

Related processes

The details of related processes: for example, if this process follows on from one or more other processes, represented under a separate open contracting identifier (ocid). This is commonly used to relate mini-competitions to their parent frameworks or individual tenders to a broader planning process.

relatedProcesses/0/id

string

Relationship ID

A local identifier for this relationship, unique within this array.

relatedProcesses/0/relationship

array[string]

Relationship

The type of relationship, using the open relatedProcess codelist.

relatedProcesses/0/title

[string, null]

Related process title

The title of the related process, where referencing an open contracting process, this field should match the tender/title field in the related process.

relatedProcesses/0/scheme

[string, null]

Scheme

The identification scheme used by this cross-reference, using the open relatedProcessScheme codelist.

relatedProcesses/0/identifier

[string, null]

Identifier

The identifier of the related process. If the scheme is 'ocid', this must be an Open Contracting ID (ocid).

relatedProcesses/0/uri

[string, null]

uri

Related process URI

A URI pointing to a machine-readable document, release or record package containing the identified related process.

bids

object

Bids

The bid section is used to publish summary statistics, and where applicable, individual bid information.

bids/statistics

array[Bid Statistic]

Statistics

Summary statistics on the number and nature of bids received. Where information is provided on individual bids, these statistics should match those that can be calculated from the bid details array.

bids/statistics/0/id

string

Required

ID

An internal identifier for this statistic.

bids/statistics/0/measure

string

Required

Measure

The statistic reported in the value.

bids/statistics/0/date

[string, null]

date-time

Date

The date when this statistic was last updated. This is often the closing date of the tender process. This field may be omitted unless either (a) the same statistic is provided from multiple points in time, or (b) there is a specific local requirement for the date when statistics were calculated to be provided.

bids/statistics/0/value

number

Required

Value

The value for the measure in question. Total counts should be provided as an integer. Percentages should be provided as a proportion of 1 (e.g. 10% = 0.1)

bids/statistics/0/currency

[string, null]

Currency

The currency of the amount in the value field, if the statistic has a monetary value.

bids/statistics/0/notes

[string, null]

Notes

Any notes needed to understand or interpret the given statistic.

bids/statistics/0/relatedLot

[string, null]

Related Lot

Where lots are in use, if this statistic relates to bids on a particular lot, provide the lot identifier here. If left blank, the statistic will be interpreted as applying to the whole tender.

bids/details

array[Bid]

Bid details

An array of bids, providing information on the bidders, and where applicable, bid status, bid values and related documents. The extent to which this information can be disclosed varies from jurisdiction to jurisdiction.

bids/details/0/id

[string]

Required

ID

A local identifier for this bid

bids/details/0/date

[string, null]

date-time

Date

The date when this bid was received.

bids/details/0/status

[string, null]

Status

The status of the bid.

bids/details/0/tenderers

array[Organization reference]

Tenderer

The party, or parties, responsible for this bid.

bids/details/0/tenderers/0/name

[string, null]

Organization name

The name of the party being referenced. This must match the name of an entry in the parties section.

bids/details/0/tenderers/0/id

[string, integer]

Organization ID

The id of the party being referenced. This must match the id of an entry in the parties section.

bids/details/0/tenderers/0/identifier

object

Primary identifier

The primary identifier for this organization. Identifiers that uniquely pick out a legal entity should be preferred. Consult the organization identifier guidance for the preferred scheme and identifier to use.

bids/details/0/tenderers/0/identifier/scheme

[string, null]

Scheme

Organization identifiers should be taken from an existing organization identifier list. The scheme field is used to indicate the list or register from which the identifier is taken. This value should be taken from the Organization Identifier Scheme codelist.

bids/details/0/tenderers/0/identifier/id

[string, integer, null]

ID

The identifier of the organization in the selected scheme.

bids/details/0/tenderers/0/identifier/legalName

[string, null]

Legal Name

The legally registered name of the organization.

bids/details/0/tenderers/0/identifier/uri

[string, null]

uri

URI

A URI to identify the organization, such as those provided by Open Corporates or some other relevant URI provider. This is not for listing the website of the organization: that can be done through the URL field of the Organization contact point.

bids/details/0/tenderers/0/address

object

Address

(Deprecated outside the parties section)

bids/details/0/tenderers/0/address/streetAddress

[string, null]

Street address

The street address. For example, 1600 Amphitheatre Pkwy.

bids/details/0/tenderers/0/address/locality

[string, null]

Locality

The locality. For example, Mountain View.

bids/details/0/tenderers/0/address/region

[string, null]

Region

The region. For example, CA.

bids/details/0/tenderers/0/address/postalCode

[string, null]

Postal code

The postal code. For example, 94043.

bids/details/0/tenderers/0/address/countryName

[string, null]

Country name

The country name. For example, United States.

bids/details/0/tenderers/0/additionalIdentifiers

array[Identifier]

Additional identifiers

(Deprecated outside the parties section) A list of additional / supplemental identifiers for the organization, using the organization identifier guidance. This can be used to provide an internally used identifier for this organization in addition to the primary legal entity identifier.

bids/details/0/tenderers/0/additionalIdentifiers/0/scheme

[string, null]

Scheme

Organization identifiers should be taken from an existing organization identifier list. The scheme field is used to indicate the list or register from which the identifier is taken. This value should be taken from the Organization Identifier Scheme codelist.

bids/details/0/tenderers/0/additionalIdentifiers/0/id

[string, integer, null]

ID

The identifier of the organization in the selected scheme.

bids/details/0/tenderers/0/additionalIdentifiers/0/legalName

[string, null]

Legal Name

The legally registered name of the organization.

bids/details/0/tenderers/0/additionalIdentifiers/0/uri

[string, null]

uri

URI

A URI to identify the organization, such as those provided by Open Corporates or some other relevant URI provider. This is not for listing the website of the organization: that can be done through the URL field of the Organization contact point.

bids/details/0/tenderers/0/contactPoint

object

Contact point

(Deprecated outside the parties section)

bids/details/0/tenderers/0/contactPoint/name

[string, null]

Name

The name of the contact person, department, or contact point, for correspondence relating to this contracting process.

bids/details/0/tenderers/0/contactPoint/email

[string, null]

Email

The e-mail address of the contact point/person.

bids/details/0/tenderers/0/contactPoint/telephone

[string, null]

Telephone

The telephone number of the contact point/person. This should include the international dialing code.

bids/details/0/tenderers/0/contactPoint/faxNumber

[string, null]

Fax number

The fax number of the contact point/person. This should include the international dialing code.

bids/details/0/tenderers/0/contactPoint/url

[string, null]

uri

URL

A web address for the contact point/person.

bids/details/0/value

object

Value

The total value of the bid.

bids/details/0/value/amount

[number, null]

Amount

Amount as a number.

bids/details/0/value/currency

[string, null]

Currency

The currency of the amount, from the closed currency codelist.

bids/details/0/documents

array[Document]

Documents

All documents and attachments related to the bid and its evaluation.

bids/details/0/documents/0/id

[string, integer]

Required

ID

A local, unique identifier for this document. This field is used to keep track of multiple revisions of a document through the compilation from release to record mechanism.

bids/details/0/documents/0/documentType

[string, null]

Document type

A classification of the document described, using the open documentType codelist.

bids/details/0/documents/0/title

[string, null]

Title

The document title.

bids/details/0/documents/0/description

[string, null]

Description

A short description of the document. Descriptions are recommended to not exceed 250 words. In the event the document is not accessible online, the description field can be used to describe arrangements for obtaining a copy of the document.

bids/details/0/documents/0/url

[string, null]

uri

URL

A direct link to the document or attachment. The server providing access to this document ought to be configured to correctly report the document mime type.

bids/details/0/documents/0/datePublished

[string, null]

date-time

Date published

The date on which the document was first published. This is particularly important for legally important documents such as notices of a tender.

bids/details/0/documents/0/dateModified

[string, null]

date-time

Date modified

Date that the document was last modified

bids/details/0/documents/0/format

[string, null]

Format

The format of the document, using the open IANA Media Types codelist (see the values in the 'Template' column), or using the 'offline/print' code if the described document is published offline. For example, web pages have a format of 'text/html'.

bids/details/0/documents/0/language

[string, null]

Language

The language of the linked document using either two-letter ISO639-1, or extended BCP47 language tags. The use of lowercase two-letter codes from ISO639-1 is recommended unless there is a clear user need for distinguishing the language subtype.

bids/details/0/documents/0/pageStart

[string, null]

Page start

When the information referenced exists within a large document, indicate the first page on which it can be found. This should refer to the printed page number, not the page number reported by software applications.

bids/details/0/documents/0/pageEnd

[string, null]

Page end

When the information referenced exists within a large document, indicate the last page on which it can be found. This should refer to the printed page number, not the page number reported by software applications.

bids/details/0/documents/0/accessDetails

[string, null]

Access details

A description of any special arrangements needed to access this document, for example: registering for access, paying a fee, or visiting a location to inspect the document.

bids/details/0/documents/0/accessDetailsURL

[string, null]

uri

Access details URL

A web address for information on any special arrangements needed to access the document.

bids/details/0/documents/0/author

[string, null]

Author

The names of the authors of the document.

bids/details/0/documents/0/unofficialTranslations

array[string]

Unofficial translations

The languages in which unofficial translations of the document are available, from the open language codelist. A BCP47 language tag is allowed, if there is a user need for the additional information.