Schema reference¶
The Social Economy Data Lab Specification is maintained using JSON Schema. The Schema is the authoritative source for the specification, and defines the structure of an individual deal so that it can be annotated and validated.
When publishing an individual deal or a number of deals, these deals should be packaged into a single, valid JSON file in an array of deals
.
These field names
for properties are important for ensuring that data is published in a machine-readable format. The title gives a human-readable form, with information about each of the properties included in description.
Structure¶
Each entry in SEDL is structured as a deal, consisting of one or more offers, projects and investments. In some cases, a deal will contain just a single project and investment. In other cases, a large number of the available one-to-many relationships will be required.
- Deals
- Recipient Organisation & Arranging Organisation
- Offers
- Project
- Assets
- Locations
- Investments
- Grant
- Equity
- Credit
Sections¶
Deal¶
Title | Description | Type | Format | Required |
---|---|---|---|---|
id |
string | Required | ||
Identifier | Unique internal identifier for the social investment deal. | |||
title |
string | Required | ||
Title | A title for the deal. Ideally, this is concise and under 140 characters. | |||
status |
string | |||
Status | Current status of the social investment deal: in progress, an open investment, closed without funds being drawn down, closed without core funds being approved. Use the status codelist. | |||
dealDate |
[string] | Required | ||
Deal date | The year (YYYY) or year-month (YYYY-MM) combination in which this deal should be counted. For a blended finance deal this should be the date of financial close. For other deals, this should be the date at which the most significant component was confirmed. Data analysts should be aware that components of a deal may each have their own significant dates. | |||
currency |
string | |||
Currency | The default currency for the deal. All values within the deal are assumed to be in this currency unless otherwise stated. Use GBP for £ | |||
estimatedValue |
number | |||
Estimated deal value | The total estimated value of this deal. This should be based on the optimum fund raising targets where these are available. In cases where a range if presented, the mid-point should be used. The estimated deal value may be based on documents, and does not necessarily match the sum of the values of the investments components of this deal recorded in this dataset. | |||
value |
number | |||
Confirmed deal value | The total value of this deal based on confirmed funds raised. | |||
recipientOrganization |
object | |||
Recipient Organization | The Organization in receipt of the finances from the social investment deal. See Organization |
|||
arrangingOrganization |
object | |||
Arranging Organization | The lead Organization arranging the social investment deal. See Organization |
|||
offers |
array[Offer] | |||
Offers | An offer describes the opportunity for investors to join a particular deal by providing finance by purchasing shares, making loans or providing some other form of input described by the offer documents. Each deal may have one or more offers associated with it. See Offer |
|||
projects |
array[Project] | |||
Project | Projects associated with the deal. See Project |
|||
investments |
object | |||
Investments | The financial components of the deal. | |||
investments/summary |
string | |||
Summary | A free text summary of the investment structure of this deal. | |||
investments/grants |
array[Grant] | |||
Grants | Grants made as part of the social investment deal. See Grant |
|||
investments/equity |
array[Equity] | |||
Equity Investments | Equity components of the social investment deal. See Equity |
|||
investments/credit |
array[Loan/credit] | |||
Credit Investments | Loan, bonds and leasing components of the social investment deal. See Credit |
|||
dateModified |
[string, null] | date-time | ||
Last modified | The date and time about when any part of the information for this deal was last updated. Should be in yyyy-mm-ddThh:mm:ssZ format. | |||
dataSource |
[string, null] | uri | ||
Data Source | A web link pointing to the source of this data, such as the actual data file or the publisher's website. |
Offer¶
An offer describes the opportunity for investors to join a particular deal by providing finance by purchasing shares, making loans or providing some other form of input described by the offer documents. Each deal may have one or more offers associated with it.
Title | Description | Type | Format | Required |
---|---|---|---|---|
id |
string | |||
Identifier | A unique identifier for this offer. | |||
type |
string | |||
Type | What kind of offer is this. Open offers allow investment at any time. Time limited offers have a closing date, and may only be actioned if they hit their fund-raising targets during the offer period. Values must be from the offerType codelist. | |||
url |
string | uri | ||
Web page | A link to more details of this offer | |||
offerDocumentUrl |
string | uri | ||
Offer document URL | A link to the offer document. | |||
startDate |
string | date-time | ||
Launch date | The launch date of the offer. | |||
endDate |
string | date-time | ||
Closing date | The closing date of the offer. | |||
extensionDate |
string | date-time | ||
Extension date | If an offer has been extended, the updated closing date should be provided here. | |||
minimumInvestmentTarget |
number | |||
Minimum investment target | The minimum investment target. In many offers, if this is not reached, the offer will be cancelled. | |||
investmentTarget |
number | |||
Optimum investment target | The optimum investment target. This is the primary fundraising goal for the offer. If only one target is given, this should be used. | |||
maximumInvestmentTarget |
number | |||
Maximum investment target | The maximum investment target. The offer may be closed when it reaches this target, or funds above this amount returned as the project would not be able to use them. | |||
minimumIndividualInvestment |
number | |||
Individual investment: minimum | The minimum investment amount that an individual investor may provide in response to this offer. | |||
maximumIndividualInvestment |
number | |||
Individual investment: maximum | The maximum investment amount that an individual investor may provide in response to this offer. | |||
investmentFeatures |
string | |||
Investment features | Any notable features of the investment criteria, such as variable minimum for particular geographical areas, or use of a subscription model. | |||
interestRates |
array[Interest rate] | |||
Interest rate | The interest rate specified in the offer. See InterestRate |
|||
interestRates/0/base |
string | |||
Base | If this interest rate is based on a formula with a base rate + a percentage (e.g. Bank of England rate + 35) then a codelist entry to describe the base rate is given here. Where no recognised codelist value exists, a short clear string should be used that can be easily interpreted by a data user to identify the base rate uses. Where this is no base rate, and the margin specifies the full exchange rate, base should be left blank. Values should be from the interestRate codelist, or may use a recognised interest rate code. | |||
interestRates/0/margin |
number | |||
Margin | The rate of interest charged above the base rate, as a value between 0 and 1 (e.g. 1% - 0.01). | |||
interestRates/0/effectiveRate |
number | |||
Effective rate | In cases where a variable base and margin are used, or where the interest payments have a complex profile (e.g. changing rates over the period of the investment; or effects of compound interest) then the effective rate should provide a figure that represents either (a) the value of the base and margin at the time of the offer; or (b) the average effective rate for the anticipated duration of an investment (Note: this is not the same as a Mortgage Effective Interest Rate). | |||
interestRates/0/hasAddedConditions |
boolean | |||
Has added conditions? | If true, the payment of interest may be subject to certain conditions. The conditions may be described in the details. | |||
interestRates/0/isVariable |
boolean | |||
Is variable? | If true, the rate of interest paid may vary based on time or performance of the related offer, deal or project. The rate recorded should be the initial anticipated rate. Any basis for variations may be explained in details. | |||
interestRates/0/details |
string | |||
Details | A description of the interest rate, and any specific conditions that apply, such as interest payment delays (e.g. interest is only paid from year 3 onwards), or other conditions on interest payments. | |||
matchFunding |
object | |||
Match funding | If this offer has a match funding component, this is described here. | |||
matchFunding/required |
boolean | |||
Required? | Is match funding required by this offer? | |||
matchFunding/status |
string | |||
Status | Has match funding been applied for or secured? Values must be from the matchFundingStatus codelist. | |||
matchFunding/details |
string | |||
Details | Details should be provided here of any match funding conditions for this offer, or any match funding secured. | |||
withdrawals |
array[Withdrawal conditions] | |||
Withdrawal | Can investors withdraw their investments? Each condition under which withdrawal can be made should be specified here. | |||
withdrawals/0/start |
string | |||
Initial period | Where there is an initial period during which investment may not be withdrawn this should be given either as the anticipate date (YYYY-MM-DD) at which withdrawal will first be allowed, or as the period from the close of the deal using ISO 8601 duration format. For example, if capital cannot be widthdrawn for 3 years and 6 months, this field should contain '3Y6M'. | |||
withdrawals/0/description |
string | |||
Description | A description of any conditions on withdrawal. | |||
withdrawals/0/capitalLimit |
string | |||
Capital limit | Details of any limit on the amount of capital that can be withdrawn. This field may currently be populated as a string, but a structured representation for this data may be identified in future. | |||
taxReliefs |
array[Tax relief] | |||
Tax relief | Details of the tax relief available for this offer See TaxRelief |
|||
taxReliefs/0/type |
string | |||
Type | A code describing the type of tax relief available. Values should be from the taxRelief codelist. | |||
taxReliefs/0/status |
string | |||
Status | The status of this tax relief. Values should be from the taxReliefStatus codelist. | |||
csuStandardMark |
object | |||
CSU Standard Mark | The Community Shares Unit standard mark is awarded to offers that meet national standards of good practice in the UK. See https://communityshares.org.uk/standard-mark-0 for more details. | |||
csuStandardMark/awarded |
boolean | |||
Awarded | Has this offer been awarded the CSU Standard Mark | |||
csuStandardMark/practitioner |
string | |||
Practitioner | The name of the practitioner involved in this CSU Standard Mark award. | |||
crowdfunding |
object | |||
Crowd funding | If this offer took place through a crowdfunding platform, details should be provided here. | |||
crowdfunding/platform |
string | |||
Platform | The name of the platform the offer took place on | |||
crowdfunding/url |
string | uri | ||
URL | The URL of the crowdfunding platform page for this offer. |
Project¶
Projects associated with the deal.
Title | Description | Type | Format | Required |
---|---|---|---|---|
id |
string | |||
Identifier | ||||
title |
string | |||
Title | The title of this project | |||
description |
string | |||
Description | A description of this project | |||
status |
string | |||
Status | What is the current status of this project when last updated. Values must be from the projectStatus codelist. | |||
startDate |
string | date-time | ||
Start date | When was/is this project scheduled to start? | |||
endDate |
string | date-time | ||
End date | When was/is this project scheduled to end? | |||
editionDate |
string | date-time | ||
Version date | If this project has been through a number of stages, iterations or phases, which 'edition' of the project does the information presented here represent? This should be indicated using a date. For example, if a particular project worked to raise capital to buy property in 2016, and then separately raised working capital from June 2018, there may be two project entries, one with editionDate of 2016-01-01, and the other with an editionDate of 2018-06-01 |
|||
estimatedValue |
number | |||
Estimated value | The overall estimated value of this edition of the project. Given in the default currency. | |||
raisedValue |
number | |||
Project raised value | The total raised for this project. This may match the sum of the deal components related to this project, but may in some cases also include investments from across a range of deals where the project was funded through more than one deal. Given in the default currency. | |||
achieved |
boolean | |||
Project achieved? | Did this edition of the project meet its stated goals? For example, successfully raising finance and purchasing the assets specified, or delivering the services in the description. Further information can be provided in in the notes field if required. | |||
classification |
array[Classification] | |||
Classification | Project classification | |||
classification/0/scheme |
string | |||
Scheme | A code describing the classification scheme in use. Values should be from the classificationScheme codelist where applicable. Alternative codelist entries may be used by agreement between data publishers. | |||
classification/0/code |
string | |||
Code | A code from the classification scheme. | |||
classification/0/title |
string | |||
Title | The title or label used in the classification scheme. | |||
purposeOfFinance |
array[string] | |||
Purpose of finance | A description of the role of finance in this project. |
|||
assets |
array[Asset] | |||
Assets | If this project involves the purchase of assets details of those assets should be provided here. See Asset |
|||
assets/0/id |
string | |||
Identifier | A unique identifier for this asset | |||
assets/0/description |
string | |||
Description | A short title or description of this asset | |||
assets/0/type |
string | |||
Type | The type of asset. Values must be from the assetType codelist. | |||
assets/0/status |
string | |||
Status | Is the purchase of these assets planned or completed? Values must be from the assetStatus codelist. | |||
assets/0/quantity |
number | |||
Quantity | What is the estimated or actual quantity of these assets to be purchased. | |||
assets/0/purchasePrice |
number | |||
Purchase price | What was/is the purchase price of this/these assets? This must be given in the default currency of this deal. | |||
assets/0/totalValue |
number | |||
Total value | What is the total value given to this/these asset(s)? This must be given in the default currency of this deal. | |||
assets/0/valuationMethod |
string | |||
Valuation method | How has the value in 'total value' been arrived at? Values should be from the valuationMethod codelist. | |||
assets/0/isSecurity |
boolean | |||
Is this asset security? | Set to true if this asset is being used as security for some other component of a related deal. | |||
assets/0/referenceNumbers |
array[string] | |||
Reference number(s) | One or more reference numbers for this asset. For example, the land registry title number in the case of property assets. | |||
locations |
array[object] | |||
Location | Information on locations associated with the project. See Location |
|||
locations/0/id |
string | |||
Identifier | Location identifier | |||
locations/0/name |
[string, null] | |||
Name | A name for this location. | |||
locations/0/description |
[string, null] | |||
Description | A description of this location. This could include details of the element of the activity that takes place here. | |||
locations/0/countryCode |
[string, null] | |||
Country Code | The ISO Country Code of the location of this activity. | |||
locations/0/postcode |
string | |||
Postcode | A postcode for this location. | |||
locations/0/geoCode |
[string, null] | |||
Geographic Code | A code referring to a geographical area, drawn from an established gazetteer. For example, the code for a local authority ward, or parliamentary constituency. | |||
locations/0/geoCodeType |
[string, null] | |||
Geographic Code Type | The type of Geographic Code (geoCode) used (e.g. Ward, Parliamentary Constituency etc.). This value for this field should be drawn from the codelist of geographic code types. | |||
locations/0/latitude |
[string, null] | |||
Latitude | The latitude of a point location | |||
locations/0/longitude |
[string, null] | |||
Longitude | The longitude of a point location | |||
notes |
string | |||
Notes | Notes related to this project which cannot otherwise be captured as structured data may be entered here. Any information which can be provide using a structured data field MUST NOT be included in the notes, but should instead be represented as structured data. |
Grant¶
Grants made as part of the social investment deal.
Title | Description | Type | Format | Required |
---|---|---|---|---|
id |
string | |||
Identifier | A unique identifier for this grant. | |||
status |
string | |||
Status | The status of this investment. Values should be from the investmentStatus codelist. See InvestmentStatus |
|||
purpose |
array[string] | |||
Purpose | The purpose(s) of this investment into the related organisation or project. Values must be from the investmentPurpose codelist. |
|||
description |
string | |||
Description | A description of the purpose of this grant. | |||
dateOffered |
string | date-time | ||
Date Offered | The date that the grant was offered. | |||
dateAgreed |
string | date-time | ||
Date Agreed | The date that the grant was agreed. | |||
currency |
string | |||
Currency | The ISO 4217 three-digit country code (e.g. GBP for £). | |||
amountRequested |
number | |||
Amount requested | The total amount requested/applied for from this grant source. | |||
amountCommitted |
number | |||
Amount committed | The total committed value of this grant. | |||
amountDisbursed |
number | |||
Amount disbursed | The total committed disbursed from this grant. | |||
fundingOrganization |
object | |||
Funding Organization | Details of the organization making this grant. See Organization |
|||
isMatchFunding |
boolean | |||
Is match funding? | If true, this investment, or proportion of it, is counted towards certain match funding requirements of this deal. More details may be given in the notes. | |||
notes |
string | |||
Notes | Notes related to this deal which cannot otherwise be captured as structured data may be entered here. Any information which can be provide using a structured data field MUST NOT be included in the notes, but should instead be represented as structured data. |
Credit¶
Loan, bonds and leasing components of the social investment deal.
Title | Description | Type | Format | Required |
---|---|---|---|---|
id |
string | |||
Identifier | A unique identifier for this loan | |||
status |
string | |||
Status | The status of this investment. Values should be from the investmentStatus codelist. See InvestmentStatus |
|||
purpose |
array[string] | |||
Purpose | The purpose(s) of this investment into the related organisation or project. Values must be from the investmentPurpose codelist. |
|||
description |
string | |||
None | A description of this loan/credit funding | |||
currency |
string | |||
Currency | The ISO 4217 three-digit country code (e.g. GBP for £). | |||
estimatedValue |
number | |||
Estimated value | The estimated value to be raised through this credit or loan. This may come from an offer document, or from other sources. Once credit is confirmed, the actual amount should be recorded in the value field. |
|||
dateOffered |
string | date-time | ||
Date Offered | The date that the loan was offered. | |||
dateAgreed |
string | date-time | ||
Date Agreed | The date that the loan was agreed as part of the Deal. | |||
value |
number | |||
Value | The total value of the credit or loan provided. | |||
durationInMonths |
number | |||
Term (months) | The term of this credit/loan in months | |||
initialRepaymentHoliday |
number | |||
Initial repayment holiday (months) | If this loan or credit comes with an initial repayment holiday, enter the period in months here | |||
interestRate |
object | |||
Interest rate | The interest rate. See InterestRate |
|||
interestRate/base |
string | |||
Base | If this interest rate is based on a formula with a base rate + a percentage (e.g. Bank of England rate + 35) then a codelist entry to describe the base rate is given here. Where no recognised codelist value exists, a short clear string should be used that can be easily interpreted by a data user to identify the base rate uses. Where this is no base rate, and the margin specifies the full exchange rate, base should be left blank. Values should be from the interestRate codelist, or may use a recognised interest rate code. | |||
interestRate/margin |
number | |||
Margin | The rate of interest charged above the base rate, as a value between 0 and 1 (e.g. 1% - 0.01). | |||
interestRate/effectiveRate |
number | |||
Effective rate | In cases where a variable base and margin are used, or where the interest payments have a complex profile (e.g. changing rates over the period of the investment; or effects of compound interest) then the effective rate should provide a figure that represents either (a) the value of the base and margin at the time of the offer; or (b) the average effective rate for the anticipated duration of an investment (Note: this is not the same as a Mortgage Effective Interest Rate). | |||
interestRate/hasAddedConditions |
boolean | |||
Has added conditions? | If true, the payment of interest may be subject to certain conditions. The conditions may be described in the details. | |||
interestRate/isVariable |
boolean | |||
Is variable? | If true, the rate of interest paid may vary based on time or performance of the related offer, deal or project. The rate recorded should be the initial anticipated rate. Any basis for variations may be explained in details. | |||
interestRate/details |
string | |||
Details | A description of the interest rate, and any specific conditions that apply, such as interest payment delays (e.g. interest is only paid from year 3 onwards), or other conditions on interest payments. | |||
interestPayable |
number | |||
Interest payable | The total interest payable over the duration of the credit/loan. | |||
fundingOrganization |
object | |||
Funding Organization | Organization providing this credit or loan. See Organization |
|||
notes |
string | |||
Notes | Notes related to this deal which cannot otherwise be captured as structured data may be entered here. Any information which can be provide using a structured data field MUST NOT be included in the notes, but should instead be represented as structured data. |
Equity¶
Equity components of the social investment deal.
Title | Description | Type | Format | Required |
---|---|---|---|---|
id |
string | |||
Identifier | A unique identifier for this equity investment | |||
status |
string | |||
Status | The status of this investment. Values should be from the investmentStatus codelist. See InvestmentStatus |
|||
purpose |
array[string] | |||
Purpose | The purpose(s) of this investment into the related organisation or project. Values must be from the investmentPurpose codelist. |
|||
description |
string | |||
Description | A description of this equity investment | |||
type |
string | |||
Type | Does this entry describe a single equity holding by an institutional investor, or one or more equity holdings from retail investors (usually individuals)? Values must be from the equityType codelist. | |||
platform |
string | |||
Platform | Was this equity raised through a particular platform. This may be lisetd using the format 'Online: {name}' or 'Offline: {name}' to indicate whether this was an Internet based platform or not. Where the platform name is not known, 'Online' or 'Offline' may be entered. | |||
numberOfInvestors |
number | |||
Number of investors | Where this entry represents the total equity held by more than one party, enter the number of investors the entry describes here. In other cases, enter 1. | |||
currency |
string | |||
Currency | The ISO 4217 three-digit country code (e.g. GBP for £). | |||
estimatedValue |
number | |||
Estimated value | The estimated value to be raised through this equity. This may be set out in offer documents as an optimum target, or may come from other sources. In general, an estimated value will be from before this equity investment was completed, with the actually agreed amount in the value field. |
|||
dateOffered |
string | date-time | ||
Date Offered | The date that the investment was offered. | |||
dateAgreed |
string | date-time | ||
Date Agreed | The date that the investment was agreed as part of the deal. | |||
value |
number | |||
Value | The total value of the equity provided. | |||
shareClass |
string | |||
Share class | The class of shares provided in return for this investment | |||
shareCapitalIssued |
number | |||
Share capital issued | The percentage of the share class issued in return for this investment. Expressed as a value between 0 and 1. | |||
shareRights |
string | |||
Share rights | The rights associated with this class of share. | |||
taxReliefs |
array[Tax relief] | |||
Tax relief | Details of the tax relief available for this investment. See TaxRelief |
|||
taxReliefs/0/type |
string | |||
Type | A code describing the type of tax relief available. Values should be from the taxRelief codelist. | |||
taxReliefs/0/status |
string | |||
Status | The status of this tax relief. Values should be from the taxReliefStatus codelist. | |||
fund |
object | |||
Fund | The fund that the investment forms a part of. See Fund |
|||
fund/code |
string | |||
Code | An identifier for this fund. | |||
fund/title |
[string, null] | |||
Title | The title of this fund. | |||
fund/description |
[string, null] | |||
Description | A description of this fund. | |||
fund/url |
[string, null] | uri | ||
URL | A web link to more details of this fund. | |||
fund/dateModified |
string | date-time | ||
Last modified | The date and time when information about this fund was last updated. | |||
isMatchFunding |
boolean | |||
Is match funding? | If true, this investment, or proportion of it, is counted towards certain match funding requirements of this deal. More details may be given in the notes. | |||
notes |
string | |||
Notes | Notes related to this deal which cannot otherwise be captured as structured data may be entered here. Any information which can be provide using a structured data field MUST NOT be included in the notes, but should instead be represented as structured data. |
Organization¶
The organization object is based on the schema.org Organization and PostalAddress types, with the addition of fields for describing UK Charity and Company Numbers, and providing information on the type of structure of the organization.
Title | Description | Type | Format | Required |
---|---|---|---|---|
name |
string | Required | ||
Name | Organization name | |||
id |
string | Required | ||
Identifier | A globally unique identifier for this Organization. This enables data on funders and recipients to be linked up across different datasets. Org-id.guide links to a number of official registers that can be used to generate identifiers in a common way (e.g. using UK Company or Charity number). Alternatively, unique identifiers from the publisher's internal systems can be used. | |||
alternateName |
string | |||
Alternate Name | An alternative name for this Organization (e.g. trading name) | |||
charityNumber |
string | |||
Charity Number | Registered charity number, if applicable. | |||
companyNumber |
string | |||
Company Number | Registered UK company number, if applicable. | |||
streetAddress |
string | |||
Street Address | Building number and street name. | |||
addressLocality |
string | |||
City | City or town. | |||
addressRegion |
string | |||
County | County | |||
addressCountry |
string | |||
Country | Country | |||
postalCode |
string | |||
Postal Code | Postal code (please try and provide a post code whenever possible) | |||
department |
string | |||
Department | The department or sub-unit of this Organization making or receiving the grant. | |||
contactName |
string | |||
Contact Name | The contact person at this Organization. | |||
telephone |
string | |||
Phone Number | Contact phone number. | |||
email |
string | |||
The email address for this Organization. | ||||
description |
string | |||
Description | A short description of this Organization and its area of work | |||
organizationType |
[string, null] | |||
Organization Type | A value from the Organization Type codelist describing the nature of this organization. Values should be from the organizationType codelist. | |||
industryClassifications |
array[string] | |||
Industry classifications | This field may be used to provide a list (array) of industry classifications. SIC codes are preferred, but the user may need to check and identify which codes are in use. | |||
startDate |
string | date-time | ||
Start date | When was this organisation established? | |||
endDate |
string | date-time | ||
End date | When was this organisation dissolved? If the organization is still active this field should be blank. | |||
url |
string | uri | ||
Web Address | A web address for the organization | |||
location |
array[object] | |||
Location | Locations associated with the organization See Location |
|||
dateModified |
string | date-time | ||
Last modified | The date and time when information about this Organization was last updated. |
Location¶
The location block provides a range of ways of expressing the location of an organization or project. Not all need to be used in every case.
Title | Description | Type | Format | Required |
---|---|---|---|---|
id |
string | |||
Identifier | Location identifier | |||
name |
[string, null] | |||
Name | A name for this location. | |||
description |
[string, null] | |||
Description | A description of this location. This could include details of the element of the activity that takes place here. | |||
countryCode |
[string, null] | |||
Country Code | The ISO Country Code of the location of this activity. | |||
postcode |
string | |||
Postcode | A postcode for this location. | |||
geoCode |
[string, null] | |||
Geographic Code | A code referring to a geographical area, drawn from an established gazetteer. For example, the code for a local authority ward, or parliamentary constituency. | |||
geoCodeType |
[string, null] | |||
Geographic Code Type | The type of Geographic Code (geoCode) used (e.g. Ward, Parliamentary Constituency etc.). This value for this field should be drawn from the codelist of geographic code types. | |||
latitude |
[string, null] | |||
Latitude | The latitude of a point location | |||
longitude |
[string, null] | |||
Longitude | The longitude of a point location |
Interest Rate¶
Title | Description | Type | Format | Required |
---|---|---|---|---|
base |
string | |||
Base | If this interest rate is based on a formula with a base rate + a percentage (e.g. Bank of England rate + 35) then a codelist entry to describe the base rate is given here. Where no recognised codelist value exists, a short clear string should be used that can be easily interpreted by a data user to identify the base rate uses. Where this is no base rate, and the margin specifies the full exchange rate, base should be left blank. Values should be from the interestRate codelist, or may use a recognised interest rate code. | |||
margin |
number | |||
Margin | The rate of interest charged above the base rate, as a value between 0 and 1 (e.g. 1% - 0.01). | |||
effectiveRate |
number | |||
Effective rate | In cases where a variable base and margin are used, or where the interest payments have a complex profile (e.g. changing rates over the period of the investment; or effects of compound interest) then the effective rate should provide a figure that represents either (a) the value of the base and margin at the time of the offer; or (b) the average effective rate for the anticipated duration of an investment (Note: this is not the same as a Mortgage Effective Interest Rate). | |||
hasAddedConditions |
boolean | |||
Has added conditions? | If true, the payment of interest may be subject to certain conditions. The conditions may be described in the details. | |||
isVariable |
boolean | |||
Is variable? | If true, the rate of interest paid may vary based on time or performance of the related offer, deal or project. The rate recorded should be the initial anticipated rate. Any basis for variations may be explained in details. | |||
details |
string | |||
Details | A description of the interest rate, and any specific conditions that apply, such as interest payment delays (e.g. interest is only paid from year 3 onwards), or other conditions on interest payments. |
Codelists¶
A codelist consists of:
- A code. A code should always be written in data in exactly the way it is given here. We use a mix of English language words, camelCase strings, and symbols (e.g. GBP for Great British Pound Stering, or £). We have chosen codes assuming that in some spreadsheet data entry approaches, codes may be displayed directly to users, and as such, they should be reasonably intelligible. In one case (organizationType) the codes therefore include both a symbol and an extended label. Consuming applications may wish to strip the second part of these strings when processing the data.
- A title. These are the labels that should be displayed in a user interface whenever possible. Titles may be translated and displayed in different languages if required.
- A description. This provides details on when the code should be used. Not all our codes have descriptions at present.
AssetStatus¶
Code Title Description planned Planned purchased Purchased
AssetType¶
Code Title Description land Land property Property other Other
ClassificationScheme¶
Code Title Description ptcCommunityBusiness Power to Change: Community Business Classification bscOutcome Big Society Capital: Outcome areas bscBeneficiary Big Society Capital: Beneficiary groups
EquityType¶
Code Title Description institutional Institutional retail Retail mixed Mixed
InterestRate¶
Code Title Description BofE LIBOR
InvestmentPurpose¶
Code Title Description acquisition Acquisition asset Asset bridgingLoan Bridging loan capital Capital developmentCapital Development Capital growthFinance Growth Finance multiple Multiple property Property propertyRefurbishment Property refurbishment other Other restructuringFinance Restructuring Finance startupCosts Start up costs workingCapital Working Capital
InvestmentStatus¶
Code Title Description requested Requested offered Offered expected Expected confirmed Confirmed cancelled Cancelled
MatchFundingStatus¶
Code Title Description appliedFor Applied for secured Secured
OfferType¶
Code Title Description open Open The offer remains open, with new participants investing at any time. timeBound Time bound The offer closes after a specified period. targetBound Target bound The offer closes after a specified target is met.
OrganizationType¶
Code Title Description CIO - Charitable Incorporated Organisation Charitable Incorporated Organisation CLG - Company Limited by Guarantee Company Limited by Guarantee CLS - Company Limited by Shares Company Limited by Shares IPS - Industrial and Provident Society Industrial and Provident Society LLP - Limited Liability Partnership Limited Liability Partnership LA - Local Authority Local Authority CU - Mutual (Credit Union) Mutual (Credit Union) FS - Mutual (Friendly Society) Mutual (Friendly Society) PLC - Public Listed Company Public Listed Company BENCOM - Registered Society (BenCom) Registered Society (BenCom) COOP - Registered Society (Cooperative) Registered Society (Cooperative) UNINC - Unincorporated Organisation Unincorporated Organisation OTH - Other Other
ProjectStatus¶
Code Title Description planned Planned ongoing Ongoing completed Completed didNotProceed Did not proceed
Status¶
Code Title Description pipeline Pipeline The deal is anticipated or under development. live Live Investments can be made into this deal. didNotProceed Did not proceed The deal did not proceed. closed Closed No new investments can be made, but the project funded by the deal may be ongoing.
TaxRelief¶
Code Title Description Other Other SEIS Seed Enterprise Investment Scheme EIS Enterprise Investment Scheme SITR Social Investment Tax Relief CITR Community Investment Tax Relief
TaxReliefStatus¶
Code Title Description advanceAssuranceAppliedFor Advance assurance applied for advanceAssuranceReceived Advance assurance received fullTaxReliefApproval Full tax relief approval applicationRejected Application rejected notAppliedFor Relief not applied for
ValuationMethod¶
Code Title Description estimated Estimated actual Actual