Data Service OData Feed Summary

The following table summarises the data available for each endpoint in the Data Service OData feed. In addition to the information described below, each endpoint includes Alias1, modification date and time stamp values as applicable.

Endpoint

Description

Barge

Capacities and types of barges.

Can be expanded to include extended data and barge holds. The barge holds include names, volumes, units and local centres of gravity.

BargeDespatch

Names, despatch states and load states of service trips.

Can be expanded to include extended data.

Links to barges, routes, planned products, intended shipments, intended despatch orders, nominated products, barge despatch points, despatch orders, loading transactions and unloading transactions.

BargeDespatchPoint

Loading types, planned and actual route point times and transport event templates of route points on service trips.

Can be expanded to include delays* and event data.

Links to route points and locations.

Berth

Names of berths.

Contract

Types, names, descriptions, start and end dates, basis, materials, statuses and commitments of sales and purchase contracts.

Can be expanded to include contract term names.

Links to buyer, seller and end user organisations, to companies and to contract contacts.

ContractFulfillment

Assay exchange data for a despatch order.

Can be expanded to include final analyte results.

ContractProduct

Names, required masses, units of measure (UOMs) of contract products.

Links to products and contracts.

ConversionFactor

Source and destination UOMs and the conversion factor between them for all UOM conversions.

CreditLine

Names, types, currencies, accepted and rejected statuses, expiry dates, approved credit limits, and exposure amounts of credit lines.

Links to organisations.

DespatchOrder

Names, planned despatch dates, required quantities, contract products, delivery terms, bill of lading dates and numbers, and quota names, fulfilment states and dates, and mark-to-market (MTM) details of despatch orders.

Can be expanded to include extended data.

Links to contracts; nominated and quality products; planned loading and unloading locations; ship to, bill to and pay to organisations; and assay exchange (contract fulfilment).

DespatchOrderState

Final wet and dry quantities, products and monetary information from invoice-specific despatch order snapshots. Monetary information includes prices, quotation periods, primary and secondary values, taxes, due dates, invoice types and iterations, control passed dates and MTM values.

Can be expanded to include analyte values; the QP and pricing details of each analyte; details of optional and unknown pricing lines; and snapshot costs.

Analyte values include the name, value, UOM, status, QP description, analyte mass, payable mass and value source of each analyte.

QP and pricing details include the analyte name, start and end date of QPs, price series, price, currency, price UOM, QP description, priced quantity, price status and QP status for the analyte.

Optional and unknown pricing lines include the analyte name, start and end date of QPs, price series, currency, price UOM, QP description, priced quantity, price status and QP status.

Snapshot costs include the organisation, activity, total before tax, total tax, due amount, original total, currency, total in the primary currency of the set of contract terms, full amount (called 'UnadjustedTotal' and only applicable to budgeted costs), due date, contract, contract rate, origin, destination, reference date, cost type and rate source.

Links to despatch orders.

Equipment

Names of equipment items.

Can be expanded to include delays*.

ExchangeRateSource

Names, source names and settings (frequency, required, default) of exchange rate sources.

Can be expanded to include the effective dates, source and destination currencies and values of exchange rates.

FinalAnalyteResult

Analytes and final results from assay exchanges.

Can be expanded to include results from each lot in the assay exchanges.

FinalAnalyteResultValue

Names, umpire dates, seller results, buyer results, differences, splits, umpire results, final results and pre-settlement results for each lot in assay exchanges.

Links to umpire organisations.

FinanceContract

Names, allocated quantities, units of measure, loan amounts and currencies of finance contracts.

Links to bank organisations.

HedgeFutures

Details of commodity hedge positions that are futures contracts.

Includes names, hedge dates, contract types, transaction types, broker references, markets, market commodities, maturity dates, strike prices, price types, prices series, quotation periods, numbers of contracts, quantities and settlement states.

Links to broker and owner organisations and to districts.

HedgeOptions

Details of commodity hedge positions that are options contracts.

Includes names, hedge dates, contract types, transaction types, broker references, markets, market commodities, maturity and declaration dates, strike prices, prices series, quotation periods, numbers of contracts, quantities and settlement states.

Links to broker and owner organisations and to districts.

HedgingAllocation

Details of despatch order allocations to commodity hedge positions that are futures or options contracts.

Includes names, quotas, remaining quantities and allocated quantities.

Links to despatch orders and nominated products.

Invoice

Details of actual invoices. Estimated invoices from despatch order or quota snapshots are not included.

Includes invoice numbers, dates, original, payable, paid and pending amounts, as well as the invoice state (that is, whether it is locked) and entry type (that is, accounts receivable or payable).

Can be expanded to include invoice line items, and invoice instalment data.

The invoice line items include line types, names, values, quantities, unit prices, and invoice values in primary and secondary currencies, as well as units of measure and currencies for each as applicable.

The instalments include due dates, due amounts and pending amounts.

Links to organisations, despatch orders and contracts.

Journal

Details of journal entries for invoice instalments, payments and refunds.

Includes journal group names, references, dates, names of reversal journals and incremental journals (if applicable), chart of accounts, districts, and whether journals are accruals or locked.

Can be expanded to include journal entries. The journal entries include district names, account numbers, profit and cost centres, debits and credits in primary and secondary currencies and descriptions.

Links to payments (and refunds), invoices and despatch orders.

LayCan

Authorisers, authorisation states, start dates and end dates of laycans.

Generates an error if accessed as a separate table. This data should be accessed via the ShipmentDespatchPoint endpoint.

Location

Names, descriptions and countries of locations.

MarkToMarket

Names and delivery terms of sets of mark-to-market (MTM) terms.

Can be expanded to include product data.

Links to locations and contract term names.

MineSource

Names, opening dates, closing dates, and estimated, extracted and planned tonnes of mine sources.

Can be expanded to include survey, geological information, current quality and current contributor data.

Links to locations and mine source (additional) products.

MineSourceProduct

Estimated, extracted and variance tonnes of mine source products.

Links to products.

Generates an error if accessed as a separate table. This data should be accessed via the MineSource endpoint.

Organisation

Names and roles of organisations.

Package

Names, batch names, parent package groups, products, locations, location sub-divisions, numbers of units, (wet) net, tare, gross and dry (net) masses, package types and rejection statuses of packages.

Can be expanded to include analyte values and result types.

Links to parent package groups, products and locations.

PackageGroup

Names, package group batch names, parent package groups, despatch orders, numbers of packages, numbers of units, container types, locations, location sub-divisions, net, tare and gross masses of package groups.

Can be expanded to include analyte values and result types.

Links to parent package groups, despatch orders and locations.

PackageMovement

End dates, gross masses, source locations and destination locations of package movements.

Can be expanded to include details of mass units of measure.

Links to despatch orders, products and packages.

Payment

Names, dates, payment or refund amounts, currencies and available amounts of payments and refunds.

Can be expanded to include paid or refunded invoice instalment data. The instalments include invoice data, allocation dates, due dates, due amounts, pending amounts and paid amounts, in multiple currencies if applicable.

Links to organisations, companies and payment charges.

PaymentCharge

Names, amounts and amounts affected of payment charges.

Generates an error if accessed as a separate table. This data should be accessed via the Payment endpoint.

Plan

Names, descriptions, start and end dates, period types, movement period start dates, planned and actual quantities and units of plans.

Links to process flows and products.

PriceSeries

Names, currencies, units, analytes and material types of price series.

Can be expanded to include price series values and products.

ProcessFlow

Names, descriptions, source locations and destination locations of process flows.

Links to locations.

Product

Names, descriptions and main analytes of products.

Can be expanded to include analytes.

Quota

Names, start and end dates, masses required and UOMs of contract quotas.

Links to contract products and contracts.

Route

Names of routes.

Links to route points.

RoutePoint

Names, travel times and duration times of route points.

Links to locations.

Shipment

Names, despatch states and load states of shipments.

Can be expanded to include extended data.

Links to routes, vessels and despatch orders.

ShipmentDespatchPoint

Planned and actual berth events, transport event templates and vessel NOR tendered and acceptance dates of shipment route points.

Can be expanded to include delays*.

Links to berths, laycans, route points, shipments, loading transactions and unloading transactions.

Stockpile

Names and types of stockpiles.

Links to locations and products.

StockpileShiftState

Period start and end dates, locations, products, quantities, units, stockpile names, types and balance types (opening, ins, outs, adjustments and closing) of stockpiles.

Can be expanded to include analytes values.

StockpileState

State times, quantities, units and transaction orders of stockpiles.

Can be expanded to include analyte values.

Links to stockpiles.

Trade

Basic details of trades between despatch orders and sets of mark-to-market terms, and between purchase and sales despatch orders. Includes trade names, despatch order or MTM paths, departure and arrival dates, allocated quantities, units and statuses.

Links to despatch orders, organisations, sets of mark-to-market terms, products, flash profit and loss statements and historical profit and loss statements.

TradeProfitAndLoss

Dates, quantities, totals and currencies for flash profit and loss statements of trades.

Links to trade profit and loss details.

Not designed to be used as a separate table. This data should be accessed via the Trade endpoint.

TradeProfitAndLossArchive

Dates, quantities, totals and currencies for historical profit and loss statements of trades.

Links to trade profit and loss details.

Not designed to be used as a separate table. This data should be accessed via the Trade endpoint.

TradeProfitAndLossDetail

Trade profit and loss line items. The line items include revenue, premiums, freight, contract charges, commodity and FX hedge position line items, for both purchase and sales. Each line item includes the allocation type, allocation object, trade side, category, subcategory, description, amount, quantity, price, market price, quantity UOM and currency.

Not designed to be used as a separate table. This data should be accessed via the Trade endpoint.

TrainDespatch

Names of train despatches.

Links to routes, train rakes, train despatch points, despatch orders, loading transactions and unloading transactions.

TrainDespatchPoint

Loading types, planned and actual route point times of route points on train despatches.

Can be expanded to include delays*.

Links to route points and locations.

TrainRake

Names, planned numbers of wagons of train rakes.

Can be expanded to include rail wagons.

Links to planned products.

Transaction

Dates, quantities and units of bulk transactions.

Can be expanded to include analyte values and extended data.

Links to process flows, stockpiles, locations, products and equipment items.

TruckDespatch

Names, transport operators, masses, corrected masses, mass units and registration numbers of truck despatches.

Links to truck despatch points, despatch orders, loading transactions and unloading transactions.

TruckDespatchPoint

Loading types, planned and actual route point times of route points on truck despatches.

Can be expanded to include delays*.

Links to route points and locations.

Vessel

Names, IMO numbers, capacities, dead weights and units of vessels.

Can be expanded to include vessel holds and hatch names. The vessel holds include names, volumes, units and local centres of gravity.

* Delays include start and end times, applicable and operating percentages, categories, codes, comments, definitions, durations, locations, reasons, responsibilities and related despatch names. Delays are not available as a separate endpoint.