Skip to content

Data Requirements

Fields per job

Each emission calculation in EmWise is tied to a job — a single transport movement. The table below lists every field, whether it is required, and what it represents.

Job fields

FieldTypeRequiredDescription
originstringYesOrigin location (city, suburb, address, or facility name)
destinationstringYesDestination location
transport_modestringYesOne of: road, rail, aviation, sea
fuel_typestringYesFuel used — must be valid for the chosen transport mode
fuel_quantitynumberYesFuel consumed in kilolitres (kL). Must be > 0 and ≤ 999,999
vehicle_classstringConditionalRequired when multiple emission factors exist for the mode/fuel combination (see below)
reference_numberstringNoYour TMS job or trip reference. Used for idempotency — submitting the same reference twice returns the original result without creating a duplicate
client_idUUIDNoLinks the job to a client in EmWise for per-client reporting
distancenumberNoDistance in kilometres, 0–99,999. Stored for reference; not used in emissions calculation
departure_dateISO 8601NoDate/time of departure. Used to determine the NGER reporting year
arrival_dateISO 8601NoDate/time of arrival. Used as fallback if departure_date is absent
cargo_weight_tonnesnumberNoCargo weight in tonnes. Stored for reference

When is vehicle_class required?

For road diesel jobs, multiple emission factors exist because the NGER Determination assigns different CH₄ factors by Euro emission standard. If you submit transport_mode: road and fuel_type: diesel without a vehicle_class, the API returns a VEHICLE_CLASS_REQUIRED error and lists the available classes.

For aviation, rail, and sea, each transport mode / fuel type combination maps to exactly one factor, so vehicle_class is optional (though providing it is recommended for precision).

See Vehicle Classes for the full reference table.

The fuel quantity question

EmWise uses actual fuel consumed in kL as the primary input. This is Method 1 of the NGER Measurement Determination — the highest-accuracy method available for transport.

If your TMS records fuel in litres, divide by 1,000 to convert to kL (e.g. 45,000 L = 45 kL).

If you do not have fuel data for individual jobs, consider:

  • Using odometer data and average fuel consumption rates (consult your NGER auditor)
  • Obtaining fuel records from fleet cards or supplier invoices and allocating to jobs

EmWise does not currently implement Method 2 (distance-based) or Method 3 (tonne-kilometre) calculations.

Vehicle class mapping

If your TMS uses its own terminology for vehicle types, use this table to find the corresponding EmWise vehicle class code:

TMS descriptionEmWise vehicle_class
B-double, semi-trailer (post-2006)heavy_vehicle_euro4
Rigid truck (post-2006)heavy_vehicle_euro4
Semi-trailer (2001–2006)heavy_vehicle_euro3
Rigid truck (pre-2001)heavy_vehicle_euro1
Light commercial van (diesel, post-2004)light_vehicle_post2004_diesel
Passenger car (petrol, post-2004)light_vehicle_post2004_petrol
Ute / van (LPG, post-2004)light_vehicle_post2004_lpg
Older diesel truck (pre-2004 or unknown standard)road_vehicle_unspecified_diesel
Older petrol vehicle (pre-2004 or unknown)road_vehicle_unspecified_petrol
Diesel traindiesel_locomotive
Commercial jetjet_aircraft
Turboprop aircraftturboprop
Marine vessel (heavy fuel oil)vessel_fuel_oil
Marine vessel (marine diesel)vessel_diesel

When the Euro standard is uncertain, use road_vehicle_unspecified_diesel — this applies the more conservative (higher CH₄) pre-2004 factor set.

CSV format

The CSV importer accepts one job per row. Column headers must match the field names exactly (case-sensitive). Columns may appear in any order.

Required columns

origin,destination,transport_mode,fuel_type,fuel_quantity

Full example

csv
origin,destination,transport_mode,fuel_type,fuel_quantity,vehicle_class,reference_number,client_id,distance,departure_date,cargo_weight_tonnes
Sydney,Melbourne,road,diesel,85.4,heavy_vehicle_euro4,TRP-20240801-001,,869,2024-08-01T06:00:00Z,22.5
Brisbane,Sydney,road,diesel,72.1,heavy_vehicle_euro4,TRP-20240801-002,,925,2024-08-01T05:30:00Z,18.0
Melbourne,Adelaide,road,diesel,48.3,heavy_vehicle_euro3,TRP-20240802-001,,727,2024-08-02T07:00:00Z,
Sydney,Perth,aviation,jet_a1,3420,jet_aircraft,FLT-20240801-001,,3290,2024-08-01T08:00:00Z,

Notes

  • fuel_quantity is always in kL
  • distance is in km
  • departure_date / arrival_date accept ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ)
  • Leave optional fields empty (not null, not "null")
  • client_id must be the UUID of a client in your organisation if provided

Backfilling historical data

EmWise supports backfilling jobs with historical dates. Emission factors are stored for reporting years 2023 through 2026. If you need to backfill data for earlier years, contact your administrator.

When backfilling, ensure departure_date or arrival_date is set correctly — EmWise uses the departure date to determine the NGER reporting year, so a job from July 2023 must have a departure date in that period to be attributed to the 2024 reporting year (1 July 2023 – 30 June 2024).

NGER Transport Emissions Platform