Fields, Statistics API

Statistics.AddService

Information about additional charges on the order, for example for waiting time.

API	Fields in Opter
id	A number that identifies the extras in the database.
deliveryId	Order number
addServiceTypeName	Extras types
invoiceStatusName	Invoice status
creditingStatusName	Resource Crediting Status
description	Description
quantity	Quantity
resourceCreditingUnitId	A number that identifies the resource credit unit in the database.
income	Income
cost	Cost

Statistics.Address

Information about the addresses on an order. An order may be divided into several shipments (stages). An address, such as a terminal, can be the recipient of one shipment and the sender of the next.

API	Fields in Opter
id	A number that identifies the address in the database.
deliveryId	Order number
countryName	Country
geographicalZoneName	Geo zone
customerId	A number that identifies the customer in the database.
customerCode	Customer code
terminalId	A number that identifies the terminal in the database.
terminalCode	Code
order	A number that identifies the address’s position in the delivery chain (sorting order).
addressLine1	Name
company	c/o
street	Street
streetNumber	No.
postcode	Postcode
city	City
information	Information
addressPositionAccuracyName	Accuracy of the address position.
longitude	Longitude
latitude	Latitude

Statistics.Customer

Information about the customer paying for an order. Customers can also be linked to addresses.

API	Fields in Opter
id	A number that identifies the customer in the database.
customerCode	Customer code
customerNumber	Customer number
name	Customer
addressLine1Visit	Name (visiting address)
streetVisit	Street (visiting address)
streetNumberVisit	No. (visiting address)
cityVisit	City (visiting address)
zipCodeVisit	Postcode (visiting address)
countryNameVisit	Country (visiting address)
phone	Phone
emailAddress	Email
invoiceReference	Our reference
addressLine1Invoice	Name (billing address)
streetInvoice	Street (billing address)
invoiceStreetNumber	No. (billing address)
cityInvoice	City (billing address)
zipCodeInvoice	Postcode (billing address)
invoiceCountryName	Country (billing address)
podTimeLimitName	Time limit for POD registration.
podTimeLimitMinutesAfterOrdering	Time limit for POD registration after ordering (minutes).
podTimeLimitMinutesAfterCompletion	Time limit for POD registration after delivery (minutes).
costPoolName	Cost pool
statisticalGroupName	Statistical group
customerCategoryName	Customer category
responsibleSalesPersonName	Responsible sales person

Statistics.Delivery

The main item in an order. An order is paid for by a customer and contains at least one shipment.

API	Fields in Opter
id	A number that identifies the order in the database.
customerId	A number that identifies the customer in the database.
customerCode	Customer code
serviceTypeId	A number that identifies the order type in the database.
serviceTypeName	Service type
priceVehicleTypeId	A number that identifies the vehicle type in the database.
priceVehicleTypeName	Vehicle type
customerProjectId	A number that identifies the customer project in the database.
customerProjectName	Customer project
timeFailureReasonName	Delay reason
invoiceStatusName	Invoice status
priceListName	Price List
deliveryCreateTypeName	Create type
regionId	A number that identifies the region in the database.
regionName	Region
statusName	Status
freightBill	Freight bill
senderReference	Sender's reference
receiverReference	Receiver's reference
projectNumber	Project
emissionForecast	CO2 emissions, estimated (g)
calculatedEmissionForecast	Calculated CO2 emissions (g)
extraId1–extraid5	ExtraID1(order)–ExtraID5(order). The field names are set on the Terminology tab in the office settings.
calculatedExtraDimension1–calculatedExtraDimension5	Extra dimension1–Extra dimension5. The names of the dimensions are set on the Terminology tab in the office settings.
calculatedPackages	Packages
calculatedWeight	Weight
calculatedLoadMeter	Load metre
calculatedPalletSpaces	Pallet space
calculatedVolume	Volume
pricingWeight	Pricing weight
calculatedDistanceKM	Distance
created	Created
changed	The date and time when the order was last amended.
transportDate	Order date
timeFailureComment	Delay comment
income	Income
cost	Cost
readyForInvoicing	Ready for invoicing/crediting
notToBeInvoiced	Not to be invoiced
manualPrice	Manual price
isConsolidation	Consolidation
consolidationOrderId	Order number for the consolidation order.
ediImportName	EDI connection (import)

Statistics.DeliveryCorrection

Information about correction invoices for an order. Correction invoices are usually issued after the order has been invoiced.

API	Fields in Opter
id	A number that identifies the correction invoice in the database.
deliveryId	Order number
priceFactor	Price factor (%)
manualPrice	Manual price
comment	Comment
created	Created
punishResource	Punish resource
currencyId	A code that identifies the currency in the database.
currencyName	Currency
invoiceStatusId	A number that identifies the invoice status in the database. The status name is returned in invoiceStatusName.
invoiceStatusName	Invoice status
customerId	A number that identifies the customer in the database.
customerCode	Customer code
customerName	Customer

Statistics.DeliveryLog

An order log that is updated whenever an order is amended, allocated, collected, and so on. The order log can be found under Order log in the order reception area.

API	Fields in Opter
id	A number that identifies the log entry in the database.
deliveryId	Order number
shipmentId	A number that identifies the shipment in the database.
deliveryStatusId	A number that identifies the order status in the database. The status name is returned in statusNameDelivery.
deliveryStatus	Order status
shipmentStatusId	A number that identifies the order status in the database. The status name is returned in statusNameShipment.
shipmentStatus	Shipment status
employeeId	A number that identifies the driver in the database.
employeeCode employeeFirstName employeeLastName	Driver
vehicleId	A number that identifies the vehicle in the database.
vehicleCode vehicleName	Vehicle
workingSessionId	A number that identifies the shift in the database.
subcontractorId	A number that identifies the subcontractor in the database.
subcontractorCode subcontractorName	Subcontractor
employeeIdUser	A number that identifies the user who logged the change in the database.
employeeFirstNameUser employeeLastNameUser	User
logTime	Time
orderChanged	Indicates whether anything other than the order status has changed. Indicated by the icon in the first column of the order log.
orderViewed	Indicates whether the order was opened without being modified. Indicated by the icon in the first column of the order log.

Statistics.DeliveryOption

Information about the options on an order.

API	Fields in Opter
deliveryId	Order number
name	Options
code	Code

Statistics.DeliveryProduct

Information about the products in an order. A product is usually a crate or a pallet, which is charged per item.

API	Fields in Opter
id	A number that identifies the product line in the database.
deliveryId	Order number
productId	A number that identifies the product in the database.
productName	Product
quantity	Quantity
price	Price
invoicedPrice	Invoiced

Statistics.Deviation

Information about deviations in an order.

API	Fields in Opter
id	A number that identifies the deviation in the database.
deliveryId	Order number
typeName	Deviation type
reasonName	Deviation reason
eventName	Deviation event
comment	Comment
completed	Completed
created	Created
evaluationEffect	Evaluation/effect
longitude	Longitude
latitude	Latitude
measure	Action
paidAmount	Paid amount
value	Value
userIdCreated	A number identifying the user who added the deviation to the order.
userNameCreated	Created by

Statistics.DirectExpense

Information about direct expense on an order. A direct expense is not treated as a sale but as an expense for the paying customer.

API	Fields in Opter
id	A number that identifies the direct expense in the database.
deliveryId	Order number
amount	Amount
created	Created
description	Description
currencyId	A code that identifies the currency in the database.
currencyName	Currency

Statistics.Employee

Information about a driver assigned to a shipment (stage). The employee is usually the driver carrying out the transport.

API	Fields in Opter
id	A number that identifies the driver in the database.
code	Call-off number
firstName surname	Driver
supplierId	A number that identifies the supplier in the database.
supplierCode	Code (for the supplier to whom the driver is attached).
supplierName	Suppliers (to which the driver is assigned).

Statistics.Invoice

Information about a customer invoice.

API	Fields in Opter
id	A number that identifies the invoice in the database.
invoiceNumber	Invoice number
invoiceDate	Invoice date
invoicePeriodNumber	Invoice Period
untilDate	End date (the invoice period)
invoiceTypeName	Invoice Type
invoiceIdReferer	A reference number that identifies the original invoice which a correction invoice amends in the database.
customerId	A number that identifies the customer in the database.
customerCode	Customer code
customerProjectName	Customer project
oCRNumber	OCR-Number
created	Created
accountingDate	Accounting date
maturityDate	Due date
adminFee	Invoice Admin Fee
fuelExtra	Fuel extra
totalExcludingTax	Turnover
tax	VAT
amountPayable	Amount to pay
directExpense	Direct Expense

Statistics.InvoiceRow

Links an order to an invoice.

API	Fields in Opter
id	A number that identifies the invoice line in the database.
invoiceId	A number that identifies the invoice in the database.
invoiceNumber	Invoice number
invoiceDate	Invoice date
deliveryId	Order number
priceItemRowId	A number that identifies the item line in the database.
addServiceId	A number that identifies the extras in the database.
priceExpenseId	A number that identifies the expenses in the database.
directExpenseId	A number that identifies the direct expense in the database.
deliveryCorrectionId	A number that identifies the entry in the database.
price	Price
fuelExtra	Fuel extra

Statistics.LooseItemBalance

Information on the number of loose items collected from and delivered to an address. This is typically used to track the stock levels of pallets and crates for an order.

API	Fields in Opter
id	A number that identifies the balance row in the database.
deliveryId	Order number
looseItemTypeName	Item type
startingQuantity	Starting quantity
endingQuantity	Final quantity

Statistics.Package

Information about a parcel in an order. Usually the dimensions and parcel number for tracking and barcode scanning.

API	Fields in Opter
id	A number that identifies the consignment in the database.
packageNumber	Package id
deliveryId	Order number
productId	A number that identifies the product in the database.
quantity	Quantity
weight	Weight
goodsType	Goods type
depth	Length
height	Height
width	Width
missingSince	Missing since
packageType	Type
text	Text
stackable	Stackable

Statistics.PackageWeightCorrection

Information regarding a change in weight on an order. Package weight corrections are usually made at terminals when the goods are weighed and measured.

API	Fields in Opter
id	A number that identifies the package weight correction in the database.
packageId	A number that identifies the consignment in the database.
packageNumber	Package ID
weight	Weight
volume	Volume
loadMeter	Load metre
palletSpaces	Pallet spaces
height	Height
width	Width
depth	Length
originalPackageWeight	Original package weight
originalPackageVolume	Original package volume
originalPackageLoadMeter	Original load metre
originalPackagePalletSpaces	Original area
originalPackageHeight	The original height of the package.
originalPackageWidth	Original width
originalPackageDepth	Original length
originalOrderCalculatedWeight	Original package weight (estimated)
originalOrderCalculatedVolume	Original package volume (estimated)
originalOrderCalculatedLoadMeter	Original load metre (estimated)
originalOrderCalculatedPalletSpaces	Original area (estimated).
originalOrderPricingWeight	Original pricing weight
originalOrderPrice	Original price
newOrderPricingWeight	New pricing weight
newOrderPrice	New price
created	Created

Statistics.Pod

Information about a pod for an order. A pod usually includes the date and time, the recipient’s name and signature.

API	Fields in Opter
id	A number that identifies the pod in the database.
deliveryId	Order number
shipmentId	Shipment number
dateTime	Date/Time
name	Name
comment	Comment
description	Remark
packageCount	Number of packages (scanned).
latitude	Latitude
longitude	Longitude
podTypeId	A number that identifies the POD-type in the database.
podTypeIdSub	A number that identifies the sub-POD-type in the database.
podTypeName	POD type
userId	A number that identifies the user in the database.
userName	Username

Statistics.PriceItemRow

Information about a price row on an order.

API	Fields in Opter
id	A number that identifies the price row in the database.
deliveryId	Order number
description	Description
extraId1–extraId8	Extra ID 1–Extra ID 8 (manual price item entry)
unit1Quantity/unit2Quantity	Quantity unit 1/Quantity unit 2
contractorInvoiceNumber	Supplier invoice no.
contractorInvoiceDone	Done contractor invoices
unit1Id/unit2Id	A number that identifies the units in the database.
unit1Name/unit2Name	Unit 1 name/Unit 2 name
priceListId	A number that identifies the price list in the database.
priceListName	Price List
priceItemId	A number that identifies the price item in the database.
priceItemName	Price item
priceItemCode	Price item code
resourceCreditingUnitId	A number that identifies the resource credit unit in the database.
income	Income
cost	Cost
resourceCreditingStatusId	A number identifying the resource crediting status in the database (1 = Do not credit, 2 = To be credited, 3 = Credited, 4 = Canceled, do not credit, 5 = Employee, do not credit, 6 = Consigned, do not credit, 7 = Archived history, 8 = Cost price item replaces, do not credit).
deliveryOptionId	A number that identifies the options in the database.
deliveryOptionName	Options
invoiceStatusId	A number that identifies the invoice status in the database (1 = NOT to be invoiced, 2 = To be invoiced, 3 = Invoiced, 4 = Cancelled (will not be invoiced), 5 = Only crediting).
priceItemTypeId	A number identifying the price item type in the database (1 = Service, 2 = Cost, 3 = Extra, 4 = Options).

Statistics.PriceRow

Detailed information about the price lines on an order.

API	Fields in Opter
id	A number that identifies the price row in the database.
deliveryId	Order number
invoiceRowId	A number that identifies the invoice line in the database.
supplierBillRowId	A number that identifies the settlement line in the database.
price	Price
discount	Discount
commissionDiscount	Commission discount
resourceValue	Resource value
unitName	Unit
unitQuantity	Quantity
productName	Product
priceItemId	A number that identifies the price item in the database.
priceItemName	Price item
pricePriceTypeId	A code that identifies the price type in the database.

Statistics.ResourceCreditingUnit

Information about revenue and costs for an order. The resource credit units are actually used to pay drivers and subcontractors, but they also include the revenue allocation for the order. The resource credit unit contains all revenue and costs relating to the order and can therefore be used as a source of prices.

API	Fields in Opter
id	A number that identifies the resource credit unit in the database.
deliveryId	Order number
transportDate	Order date
creditingUnitTypeName	Resource crediting unit type
creditingStatusName	Resource Crediting Status
shipmentId	Shipment date
addServiceId	A number that identifies the extras in the database.
priceItemRowId	A number that identifies the price row in the database.
addressId	A number that identifies the address in the database.
income	Income
indirectIncome	Indirect revenue.
cost	Cost
indirectCost	Indirect cost.
costFuelExtra	Fuel extra (cost)
resourceValue	Resource value
resourceValueFuelExtra	Fuel extra (resource value)
terminalId	A number that identifies the terminal in the database.
terminalCode	Terminal code
terminalName	Terminal name
employeeId	A number that identifies the employee in the database.
employeeCode	Call-off number
employeeFirstName employeeLastName	Driver
vehicleId	A number that identifies the vehicle in the database.
vehicleCode	Number (vehicle)
vehicleName	Vehicles
subcontractorId	A number that identifies the subcontractor in the database.
subcontractorCode	Code (subcontractor)
subcontractorName	Subcontractor
supplierId	A number that identifies the supplier in the database.
supplierCode	Code (supplier)
supplierName	Suppliers
supplierBillId	A number that identifies the supplier bill in the database.
supplierBillNumber	Credit number
supplierBillDate	Crediting date

Statistics.SalesLedgerTransactionItem

Accounting information regarding invoices and supplier bills. Usually contains an account number, an amount and other reference information.

API	Fields in Opter
id	A number that identifies the accounting line in the database.
salesLedgerTransactionId	A number that identifies the document in the database.
date	Accounting date
salesLedgerTransactionTypeId	A number that identifies the transaction type in the database.
salesLedgerTransactionItemTypeId	A number that identifies the transaction row type in the database.
accountId	A number that identifies the account in the database.
accountName	Account number
accountDescription	Description
debit	Debit
credit	Credit
taxRateId	A code that identifies the VAT rate in the database.
taxRateCode	Code
taxRateName	VAT
invoiceId	A number that identifies the invoice in the database.
supplierBillId	A number that identifies the supplier bill in the database.
deliveryId	Order number
shipmentId	Shipment number
addServiceId	A number that identifies the extras in the database.
priceExpenseId	A number that identifies the expenses in the database.
directExpenseId	A number that identifies the direct expense in the database.
priceItemRowId	A number that identifies the price row in the database.
supplierBillAdditionId	A number that identifies the supplier bill adjustments in the database.
regionId	A number that identifies the region in the database.
regionName	Region
economicUnit1Id–economicUnit5Id	A number that identifies the economic units in the database.
economicUnit1Name–economicUnit5Name	Economic Units 1–Economic Units 5. The names of the economic units are entered on the Economy tab in the office settings.
comment	Comment

Statistics.Scan

Information about a freight bill or parcel scan. Scans can be carried out upon collection, arrival at the terminal, departures from the terminal and delivery.

API	Fields in Opter
id	A number that identifies the scan in the database.
deliveryId	Order number
packageId	A number that identifies the consignment in the database.
packageNumber	Package ID
scanTypeId	A number that identifies the scan type in the database.
terminalId	A number that identifies the terminal in the database.
userId	A number that identifies the user in the database.
loadCarrierId	A number that identifies the load carrier in the database.
employeeId	A number that identifies the employee in the database.
vehicleId	A number that identifies the vehicle in the database.
subcontractorId	A number that identifies the subcontractor in the database.
scanTime	Time of scan
undoScanTime	Undone scanning
batchId	Batch
comment	Comment
routes	Route
longitude	Longitude
latitude	Latitude

Statistics.Shipment

Information about a shipment on an order. Each order contains at least one shipment, but may contain more. An order goes from the sender to the recipient (A–B), but if the order is split across terminals, the shipments may be A–T1, T1–T2 and T2–B. The shipments may be carried out by different drivers, vehicles or subcontractors. Revenue and costs are also available at project level.

API	Fields in Opter
id	A number that identifies the shipment in the database.
deliveryId	Order number
deliveryIdConsignment	Consignment order no.
deliveryTransportDate	Order date
shipmentDate	Shipment date
shipmentTypeId	A number identifying the assignment type in the database (1 = Direct transport, 2 = Pickup, 3 = Line haul, 4 = Delivery).
regionId	A number that identifies the region in the database.
regionName	Region
order	A number that identifies the shipment’s position in the supply chain (sorting order).
addressIdFrom	A number that identifies the starting address in the database.
addressIdTo	A number that identifies the final address in the database.
calculatedDistance	Distance (km)
sharingFactor	Sharing factor
earliestPickupTime	Earliest pickup time
latestPickupTime	Latest pickup time
earliestDeliveryTime	Earliest delivery time
latestDeliveryTime	Latest delivery time
loggedPickupTime	Pickup time (actual)
loggedDeliveryTime	Delivery time (actual)
income	Income
internalIndirectIncome	Internal indirect revenue.
indirectIncome	Indirect revenue.
resourceValue	Resource value
internalIndirectResourceValue	Internal indirect resource value.
cost	Cost
internalIndirectCost	Internal indirect cost.
indirectCost	Indirect cost.
emissionEstimate	CO2 emissions, estimated (g)
calculatedEmissionEstimate	CO2 emissions, calculated (g)
manualResourcePrice	Resource price
employeeId	A number that identifies the employee in the database.
employeeCode	Call-off number
employeeFirstName employeeLastName	Driver
vehicleId	A number that identifies the vehicle in the database.
vehicleCode	Number (vehicle)
vehicleName	Vehicles
supplierId	A number that identifies the supplier in the database.
supplierCode	Code (supplier)
supplierName	Suppliers
subcontractorId	A number that identifies the subcontractor in the database.
subcontractorCode	Code (subcontractor)
subcontractorName	Subcontractor
statusName	Status

Statistics.Subcontractor

Information about a subcontractor handling a shipment. A subcontractor is a separate company that manages its own dispatch, unlike vehicles or employees.

API	Fields in Opter
id	A number that identifies the subcontractor in the database.
code	Code (subcontractor)
name	Subcontractor

Statistics.Supplier

Information about a supplier. The supplier owns the vehicles or employs drivers, and acts as an administrative unit for paying drivers/vehicles that are managed, but not owned, by the transport company.

API	Fields in Opter
id	A number that identifies the supplier in the database.
code	Code (supplier)
name	Suppliers

Statistics.SupplierBill

Information regarding a supplier bill to be paid to a subcontractor or supplier.

API	Fields in Opter
id	A number that identifies the supplier bill in the database.
vehicle number	Credit note
billDate	Crediting date
transportAmount	Shipments
additionAmount	Additions
totalTax	VAT
roundingAmount	Rounding
total	Payable
subcontractorId	A number that identifies the subcontractor in the database.
subcontractorCode	Code (subcontractor)
subcontractorName	Subcontractor
supplierId	A number that identifies the supplier in the database.
supplierCode	Code (supplier)
supplierName	Suppliers

Statistics.Vehicle

Vehicle information.

API	Fields in Opter
id	A number that identifies the vehicle in the database.
code	Number
name	Name
registrationNumber	Registration number
vehicleTypeId	A number that identifies the vehicle type in the database.
vehicleTypeName	Vehicle type
supplierId	A number that identifies the supplier to whom the vehicle is linked in the database.
supplierCode	Code
supplierName	Suppliers
emissionClass	Emission class
fuelConsumption	Fuel consumption per 100 km
emissionInGramPerKilometer	CO2 emissions (g/km)
emissionPricingWeightCapacity	Capacity converted into pricing weight (kg)
fuelName	Fuel
weight	Weight
volume	Volume
loadMeter	Load metre
palletSpaces	Pallet space
extraDimension1–extraDimension5	Extra dimension1–Extra dimension5. The names of the dimensions are set on the Terminology tab in the office settings.
cost	Target cost

Statistics.WorkingSession

Information about a shift. A shift is created when a driver logs in and contains information about the shipments handled during the shift, as well as the start and end times.

API	Fields in Opter
id	A number that identifies the shift in the database.
vehicleId	A number that identifies the vehicle in the database.
vehicleCode	Vehicle number
vehicleName	Vehicle name
employeeId	A number that identifies the employee in the database.
employeeCode	Call-off number
employeeFirstName employeeLastName	Driver
supplierId	A number that identifies the supplier to whom the vehicle/driver is linked in the database.
supplierName	Suppliers
startTime	Start
endTime	End
startLunch	Lunch start
endLunch	Lunch end
comment	Comment