From 57dfb9c248f66ae83e35f1cf3add30891b873a50 Mon Sep 17 00:00:00 2001 From: odscjen Date: Thu, 30 Nov 2023 17:20:21 +0000 Subject: [PATCH 1/5] add relativeValue and monetaryValue.csv --- README.md | 27 +++++++++++++++++++++++++++ codelists/monetaryValue.csv | 3 +++ extension.json | 3 ++- release-schema.json | 37 +++++++++++++++++++++++++++++++++++++ 4 files changed, 69 insertions(+), 1 deletion(-) create mode 100644 codelists/monetaryValue.csv diff --git a/README.md b/README.md index 698fe79..66ebb25 100644 --- a/README.md +++ b/README.md @@ -52,6 +52,32 @@ The following JSON snippet models a contracting process where fees are applied t } ``` +The following JSON snippet models a contracting process where fees are calculated as a percentage of the awarded contract value. + +```json +{ + "tender": { + "participationFees": [ + { + "id": "1", + "type": [ + "win" + ], + "relativeValue": { + "percentage": 0.05, + "monetaryValue": "award" + }, + "description": "Fee payable on acceptance of award.", + "methodOfPayment": [ + "wireTransfer", + "cheque" + ] + } + ] + } +} +``` + ## Issues Report issues for this extension in the [ocds-extensions repository](https://github.com/open-contracting/ocds-extensions/issues), putting the extension's name in the issue's title. @@ -61,6 +87,7 @@ Report issues for this extension in the [ocds-extensions repository](https://git ### Unreleased * Make `ParticipationFee.id` required so that participation fees are merged by identifier +* Add `relativeValue` field ### v1.1.5 diff --git a/codelists/monetaryValue.csv b/codelists/monetaryValue.csv new file mode 100644 index 0000000..03b312a --- /dev/null +++ b/codelists/monetaryValue.csv @@ -0,0 +1,3 @@ +Code,Title,Description +tender,Tender,"The estimated value of the procurement, as estimated when publishing the tender information." +award,Award,"The value of the award. Typically, this is the value of the bid being awarded." diff --git a/extension.json b/extension.json index 225905e..bee2543 100644 --- a/extension.json +++ b/extension.json @@ -13,7 +13,8 @@ ], "codelists": [ "participationFeeType.csv", - "methodOfPayment.csv" + "methodOfPayment.csv", + "monetaryValue.csv" ], "schemas": [ "release-schema.json" diff --git a/release-schema.json b/release-schema.json index 93f12e1..9eb7057 100644 --- a/release-schema.json +++ b/release-schema.json @@ -37,6 +37,11 @@ "description": "The monetary value of this fee.", "$ref": "#/definitions/Value" }, + "relativeValue": { + "title": "Relative value", + "description": "The value of the participation fee, as a percentage of the monetary value.", + "$ref": "#/definitions/RelativeValue" + }, "description": { "title": "Description", "description": "Additional information about this fee, for example: the specific cases in which the fee is applicable (e.g. hard copies of documents only), the way in which the fee is levied, or the exact nature of the fee.", @@ -73,6 +78,38 @@ "uniqueItems": true } } + }, + "RelativeValue": { + "title": "Relative value", + "description": "The value of the participation fee, as a percentage of a monetary value.", + "type": "object", + "required": [ + "percentage", + "monetaryValue" + ], + "properties": { + "percentage": { + "title": "Percentage", + "description": "The percentage of the monetary value.", + "type": [ + "number" + ], + "maximum": 1, + "minimum": 0, + "exclusiveMinimum": true + }, + "monetaryValue": { + "title": "Monetary value", + "description": "The name of the monetary value.", + "type": "string", + "enum": [ + "tender", + "award" + ], + "codelist": "monetaryValue.csv", + "openCodelist": false + } + } } } } From b4c5de5206335b71ef481d955d52f084876a130a Mon Sep 17 00:00:00 2001 From: odscjen <95221058+odscjen@users.noreply.github.com> Date: Fri, 1 Dec 2023 14:19:13 +0000 Subject: [PATCH 2/5] Update README.md Co-authored-by: Duncan Dewhurst --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 66ebb25..520f7b0 100644 --- a/README.md +++ b/README.md @@ -52,7 +52,7 @@ The following JSON snippet models a contracting process where fees are applied t } ``` -The following JSON snippet models a contracting process where fees are calculated as a percentage of the awarded contract value. +The following JSON snippet models a contracting process with a participation fee of 5% of the award value, payable by the winning bidder. ```json { From 44e90735fefc0c9fba893da36b7c197c2be3249e Mon Sep 17 00:00:00 2001 From: odscjen Date: Mon, 4 Dec 2023 09:00:17 +0000 Subject: [PATCH 3/5] apply review suggestions --- README.md | 2 +- release-schema.json | 12 ++++++------ 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 520f7b0..2c4743d 100644 --- a/README.md +++ b/README.md @@ -64,7 +64,7 @@ The following JSON snippet models a contracting process with a participation fee "win" ], "relativeValue": { - "percentage": 0.05, + "proportion": 0.05, "monetaryValue": "award" }, "description": "Fee payable on acceptance of award.", diff --git a/release-schema.json b/release-schema.json index 9eb7057..8e80696 100644 --- a/release-schema.json +++ b/release-schema.json @@ -39,7 +39,7 @@ }, "relativeValue": { "title": "Relative value", - "description": "The value of the participation fee, as a percentage of the monetary value.", + "description": "The value of the participation fee, as a proportion of the monetary value.", "$ref": "#/definitions/RelativeValue" }, "description": { @@ -81,16 +81,16 @@ }, "RelativeValue": { "title": "Relative value", - "description": "The value of the participation fee, as a percentage of a monetary value.", + "description": "The value of the participation fee, as a proportion of a monetary value.", "type": "object", "required": [ - "percentage", + "proportion", "monetaryValue" ], "properties": { - "percentage": { - "title": "Percentage", - "description": "The percentage of the monetary value.", + "proportion": { + "title": "Proportion", + "description": "The percentage of the monetary value, expressed as a decimal proportion between 0 and 1.", "type": [ "number" ], From dba1ff4ed60a9d56678d3f44dbec6ad19fa633da Mon Sep 17 00:00:00 2001 From: odscjen <95221058+odscjen@users.noreply.github.com> Date: Tue, 5 Dec 2023 15:12:29 +0000 Subject: [PATCH 4/5] Apply suggestions from code review Co-authored-by: James McKinney <26463+jpmckinney@users.noreply.github.com> --- README.md | 2 +- release-schema.json | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 2c4743d..859282e 100644 --- a/README.md +++ b/README.md @@ -52,7 +52,7 @@ The following JSON snippet models a contracting process where fees are applied t } ``` -The following JSON snippet models a contracting process with a participation fee of 5% of the award value, payable by the winning bidder. +A participation fee of 5% of the award value, payable by the winning bidder: ```json { diff --git a/release-schema.json b/release-schema.json index 8e80696..77db891 100644 --- a/release-schema.json +++ b/release-schema.json @@ -39,7 +39,7 @@ }, "relativeValue": { "title": "Relative value", - "description": "The value of the participation fee, as a proportion of the monetary value.", + "description": "The value of the participation fee, as a proportion of a monetary value.", "$ref": "#/definitions/RelativeValue" }, "description": { @@ -90,7 +90,7 @@ "properties": { "proportion": { "title": "Proportion", - "description": "The percentage of the monetary value, expressed as a decimal proportion between 0 and 1.", + "description": "The proportion of the monetary value, expressed as a decimal between 0 and 1.", "type": [ "number" ], From 192ae3a92f550b2b0efc254e587d289548ca232b Mon Sep 17 00:00:00 2001 From: odscjen Date: Tue, 5 Dec 2023 15:14:19 +0000 Subject: [PATCH 5/5] README.md: apply suggestions from review --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 859282e..99ee50d 100644 --- a/README.md +++ b/README.md @@ -10,9 +10,9 @@ The `id` field will be required in future versions of the extension. In some cases, a fee is levied for official copies of procurement documents, with unofficial copies being freely available. Bidders might be required to prove that they have paid for official copies as part of their submission. In such cases, the fee should use the 'submission' code in the `type` field, rather than the 'document' code. -## Example +## Examples -The following JSON snippet models a contracting process where fees are applied to access bidding documents and to submit bids: +A contracting process where fees are applied to access bidding documents and to submit bids: ```json {