forecast

iati-activities/iati-activity/fss/forecast

This is the reference page for the XML element forecast. See also the relevant overview page: CRS & FSS

Definition

A container to hold separate forecasts for each of the years specified

The text in this element must be of type xsd:decimal.

Attributes

@year

The calendar year that the forward spend covers

This value must be of type xsd:decimal.

@currency

A three letter ISO 4217 code for the original currency of the amount. This is required for all currency amounts unless the iati-activity/@default-currency (or iati-organisation/@default-currency for an organisation file) attribute is specified.

Currency codes are listed at http://iatistandard.org/codelists/currency

This value must be of type xsd:string.

This value must be on the Currency codelist.

@value-date

The date that this value was set (to allow historical currency conversion). The date must be in ISO 8601 format (YYYY-MM-DD).

This value must be of type xsd:date.

Example Usage

Example usage of forecast in context of fss element.

Example declares year as 2014, with a value of 10000:

A date in ISO 8601 format (YYYY-MM-DD) is required for value-date date of the forecast:

The ISO 4217 code for the currency in which the forecast is denominated should be declared using the Currency codelist, but only if different to default-currency in the iati-activity element.

  <fss extraction-date="2014-05-06" priority="1" phaseout-year="2016">
   <forecast year="2014" value-date="2013-07-03" currency="GBP">10000</forecast>
  </fss>

Example of multiple forecast elements:

  <fss extraction-date="2014-05-06" priority="1" phaseout-year="2016">
   <forecast year="2014" value-date="2013-07-03" currency="GBP">10000</forecast>
   <forecast year="2015" currency="GBP" value-date="2013-07-03">20000</forecast>
  </fss>

Changelog

1.03

New in 1.03
Added the optional fss element and its child elements

Developer tools

Find the source of this documentation on github:

Last updated on 2015-10-16