API Response: Record Fields

Data sent back to your in the response will have records with the following fields:

iid
Type: Integer
Description: Record unique ID number.

production_id
Type: Integer
Description: Unique ID for the production this record belongs to.

created_on
Type: Date Integer
Type Details: A date/time integer given in seconds from the epoch.
Description: Date upon which the record was created.

created_by
Type: Integer
Description: Unique ID for the user who created this record.

emission_factor
Type: Integer
Description: Unique ID for the base emission factor that the map links to. The API does not have access to these, instead you are to use the map. See emission mapping for more information.

map_used
Type: Integer
Description: Unique ID for the map used for emissions. See emission mapping for more information.

map_record
Type: Integer
Description: Unique ID for the map record used for emissions. See emission mapping for more information.

record_dom
Type: Boolean
Description: Whether to use record_date or milestone. API records always use date so this will normally be empty.

record_date
Type: Date Integer
Type Details: A date/time integer given in seconds from the epoch.
Description: Date for which the record should be realised.

record_milestone
Type: Integer
Description: Unique ID for the milestone if used. API records always use date so this will normally be empty.

record_value
Type: Float
Description: The value which is used to multiply against the emission factor.

record_value_multiplier
Type: Float
Description: An additional multiplier on the value for emission factors that take multiple units (eg: weight per km for freighting).

record_actual
Type: Boolean
Description: Whether the record is an actual or an estimate.

record_aggregate
Type: Boolean
Description: Whether this is an individual record, or an aggregate total.

record_identifier
Type: String
Type Details: 50 characters maximum.
Description: A unique identification string the user supplies to avoid double-entry.

record_offset
Type: Boolean
Description: Whether any money has been paid for offsetting on this emission.

record_offset_cost
Type: Float
Description: Amount paid in offsetting in NZ Dollars.

tool_locked
Type: String
Description: Slug for Greenlit tool if this record is associated with a tool.

tool_record
Type: Integer
Description: Unique ID for the tool record in the tool table.

tool_updated
Type: Date Integer
Type Details: A date/time integer given in seconds from the epoch.
Description: Date this record was updated by the tool.

api_app
Type: Integer
Description: Unique ID for API service being used. This will normally be your API unique ID.

api_updated
Type: Date Integer
Type Details: A date/time integer given in seconds from the epoch.
Description: Date this record was updated by the API.

dropped
Type: Boolean
Description: Whether this record has been soft deleted.

department
Type: Integer
Description: Unique ID for department this record is associated with.

tracking
Type: Integer
Description: Unique ID for a tracker which may have been assigned to this record.

country
Type: Integer
Description: Unique ID for country this record applies to.