Skip to main content
All CollectionsData & Reporting
Loop Analytics Data Dictionary
Loop Analytics Data Dictionary

Definitions for each field in Loop's Analytics

Updated over 2 months ago

This dictionary should provide context for the fields available in Loop's Report Builder. The tables available are specific to the transportation modes and services that you use, so every table shown here may not be present in your Report Builder.

Use the table of contents to the right to quickly navigate to each section.


Payable Invoices

One row per AP invoice with some information about related payments and shipment jobs.

Column

Definition

Qid

Loop's unique identifier for the payable invoice

Status

The review status of the payable invoice

Approved By

The user who approved the payable invoice most recently

Is Approved

True if the invoice is approved

Received At

The date and time that the invoice was received by Loop. The time is in UTC

Audit Status

The status of audits performed by Loop on related shipment jobs

Is Corrected

True if the payable invoice has been corrected

Invoice Number

The payable invoice number

Is Balance Due

True if the payable invoice has an associated balance due invoice

Payee Org Name

The organization who receives money for this invoice. This will either be the vendor or the organization who receives on the vendor's behalf. An example of this is a factoring company receiving money for a trucking carrier.

Payor Org Name

The organization paying money for this invoice.

Approved Amount

The total approved amount on the payable invoice

Expected Amount

The total expected amount on the payable invoice

Invoiced Amount

The total invoiced amount on the payable invoice

Vendor Org Name

The vendor who performed the service. For example, this will often be a trucking carrier.

Payment Due Date

The due date for the payable invoice

First Pickup Date

The earliest pickup date across all related shipment jobs

Approved At

The date and time of the most recent approval

Overcharge Amount

If the invoiced amount is higher than the expected amount, this will be the difference between the two. If the expected amount is higher than the invoiced amount, this will be zero

Last Delivery Date

If the shipment job has two stops, this will be the delivery date. If multi-stop, it will be the date of the last stop

Number Of Payments

How many payments have been confirmed for this invoice

Undercharge Amount

If the invoiced amount is lower than the expected amount, this will be the difference between the two. If the expected amount is lower than the invoiced amount, this will be zero

Is Approved By Loop

True if the invoice was auto-approved or approved by a Loop team member

Invoice Payment Total

The total amount of all payments on the payable invoice

First Payment Completed

Date and time that the first payment was completed

First Payment Initiated

Date and time that the first payment was initiated

Line Item Payment Total

The total of all invoiced line items on the payment. This excluded applied discounts, offline payments, or other adjustments.

Adjustment Payment Total

The total of all adjustments applied after the line items. This includes quickpay discounts and offline payments.

Job External Identifiers

External identifiers for all related shipment jobs (comma separated)

All Payments Are Completed

True if all payments associated with the payable invoice have been completed

Applied Quickpay Discount Amount

The dollar amount of the discount applied. E.g. a 2% discount applied on $900 invoice will show as -$18.00

Invoiced Amount Before Correction

The total amount from the original payable invoice if corrected


Receivable Invoices

Details about every AR invoice.

Column

Definition

Qid

Loop's unique identifier for the receivable invoice

Status

The invoice status e.g. OPEN or DRAFT

Due Date

The due date provided to the customer. This will be empty if the invoice is not finalized

Issued At

When the invoice was issued to the customer. This will be empty if the invoice is not finalized

Payee Name

The name of the organization being paid

Payor Name

The name of the organization sending the payment

Total Amount

The total amount being invoiced

Currency Code

The currency code used for this invoice

Note To Payor

An optional note to the payor that is included in the generated invoice PDF

Invoice Number

The receivable invoice number

First Pickup Date

The earliest date for a pick-up stop on the shipment

Last Delivery Date

The latest date for a delivery stop on the shipment

Adjustment Subtotal Amount

The subtotal of all adjustments applied to this invoice

External Shipment Identifier

The identifier provided which is used to link this invoice to a shipment

Shipments

All shipments with summary information about related payable and receivable invoices. This also includes details about what we infer as the primary job. There may be more than one job associated with each shipment.

Column

Definition

Shipment Created At

The date and time that the shipment was created

BOL Numbers

BOL numbers associated with the shipment (comma separated)

PRO Numbers

PRO numbers associated with the shipment (comma separated)

External Identifiers

External identifier reference numbers associated with the shipment (comma separated)

Billing Status

The billing status across both payables and receivables.

Number Of Jobs

The total number of shipment jobs associated with this shipment

Number Of Payable Invoices

The total number of payable invoices associated with related shipment jobs,

Number Of Receivable Invoices

The total number of receivable invoices associated with his shipment,

Primary Job Mode

The transportation mode of the primary job on the shipment

Tracking Numbers

Tracking numbers associated with the shipment (comma separated)

Primary Job Vendor

The vendor organization for the primary job on the shipment

Primary Job Customer

The customer organization for the primary job on the shipment

Primary Job Pickup Date

The pickup date for the primary job on the shipment

Primary Job Delivery Date

The delivery date for the primary job on the shipment

Total Payment Amount

The total approved payment amount for related payable invoices,

Total Expected Amount

The total expected amount for related payable invoices,

Total Invoiced Amount

The total invoiced amount for related payable invoices,

Total Undercharge Amount

The total undercharge amount on related payable invoices

Total Overcharge Amount

The total overcharge amount on related payable invoices

Primary Job Audit Status

The audit status for the primary job on the shipment

Payable Invoices Are Approved

True if all related payable invoices have been approved

Payable Invoices Are Released

True if all related payable invoices have been released (paid or exported)

Receivable Invoices Are Finalized

True if all related receivable invoices have been finalized

Total Receivable Invoice Amount

The total amount for all related receivable invoices


Shipment Jobs

One row per shipment job with some information about related payable invoices. Aggregate fields are not available for each row individually but are pre-built for use in visualizations.

Column

Definition

GL Codes

GL codes applied to the job (comma separated)

Doc Status

A summary of what documents are still missing (if anything)

Mode Label

The transportation mode

PO Numbers

PO number reference numbers (comma separated)

BOL Numbers

BOL number reference numbers (comma separated)

PRO Numbers

PRO number reference numbers (comma separated)

Vendor Name

The vendor of the job. This can be a carrier or any other type of service provider.

Audit Status

The status of Loop's internal audit for this job

Carrier Name

The name of the carrier. This will only be populated for job types that are known to use a carrier as the vendor (LTL, FTL, TONU).

Customer Name

The name of the customer for which the job was performed

Origin Address

The address of the first pickup stop on the shipment job

Destination Address

The address of the last destination stop on the shipment job

Pickup Date

The date of the first pickup stop on the shipment job

Delivery Date

The date of the last destination stop on the shipment job

Is Multi Stop

True if the job is known to have more than 2 stops

Billing Status

The payable invoice billing status for this job

Is Primary Job

True if the job is considered the primary job on the related shipment. For example, if a shipment has two jobs, one being a TONU and one being FTL, the FTL job will be considered as primary

Approved Amount

The amount that was approved on a payable invoice for line items related to this job

Discount Amount

The discount amount invoiced for this specific job

Expected Amount

The expected payment amount for this job

Invoiced Amount

The amount invoiced for this specific job

Linehaul Amount

The line haul amount invoiced for this specific job

Last Approved At

The most recent approval timestamp

Tracking Numbers

Tracking number reference numbers (comma separated)

First Approved At

The first approval timestamp

Is Fully Approved

True if all of the line items invoiced for this job have been approved

Overcharge Amount

The amount that was overcharged if the invoiced amount was more than the expected amount

Undercharge Amount

The amount that was undercharged if the invoiced amount was less than the expected amount

Accessorial Amount

The accessorial amount invoiced for this specific job

Audit Published At

When the Loop internal audit was published

External Identifiers

External identifier reference number (comma separated)

Fuel Surcharge Amount

The fuel surcharge amount invoiced for this specific job

Artifact Types Received

An array of the unique types of artifacts received for this job

Payables Readiness Status

The status of the job as provided in the API shipment record artifact. This will be empty if the status was not provided

Number Of Payable Invoices

The number of payable invoices for which this job is linked to

All Payable Invoice Line Items Are Paid

All payable invoice line items related to this shipment job have been paid

Aggregate Fields

Definition

Overcharge %

Percent of jobs invoiced with an overcharge. Only overcharges of more than $1 are included here

Invoice Accuracy %

An invoice is considered accurate if the overcharge and undercharge totals are both within $1 of the expected amount

Undercharge %

Percent of jobs invoiced with an undercharge. Only undercharges of more than $1 are included here


Invoice Payments

Details about invoice payments. This table contains one row per payment performed on an invoice, so an invoice that has multiple payments will appear multiple times.

Column

Definition

Payee Org

The name of the organizations being paid

Approved At

When the payment was approved

Invoice Link

Link to the payable invoice page in Loop

Invoice Number

The payable invoice number

Invoice Status

The payable invoice status

Payment Status

The current status of the payment

Transaction Id

The payment transaction Id

Payee Is Factor

True if the payee org is a factor organization

Invoice Issue Date

When the payable invoice was first issued

Payment Completed At

When the payment was confirmed as complete

Payment Initiated At

When the payment was first initiated

Invoice Payment Total

The line item payment total plus any adjustments. This is the total amount that was paid

Payment Scheduled For

When the payment is scheduled to be executed

Job External Identifiers

The external identifier of any related shipment job external identifiers (comma separated)

Line Item Payment Total

The total approved line item payment amount being paid

Adjustment Payment Total

The total adjustment value being applied to this payment

Payment Total

The total amount paid


Payable Invoice Accessorials

One row per payable invoice accessorial line item. This includes details about the related shipment job as well.

Column

Definition

Lane

The origin and destination for the shipment job. This will only show the first origin and last destination for multi-stop jobs

Job Mode

The transportation mode of the job

Stop Type

The type of stop where the accessorial occurred

Created At

When the accessorial was first added to the payable invoice

Accessorial

The type of accessorial invoiced

Approved At

When the accessorial was approved

Description

The description extracted from the invoice

Is Approved

True if the accessorial has been approved

Invoiced Amount

The amount charged for the accessorial

Job BOL Numbers

The BOL numbers of the associated job (comma separated)

Job Pickup Date

The pickup date of the associated job

Job Is Multi Stop

True if the job has multiple stops

Accessorial Category

The category of the invoiced accessorial

Job External Identifiers

The external identifiers of the associated job (comma separated)

Job Invoiced Total Amount

The total amount invoiced across all payable invoices linked to the job


Payable Invoice Corrections

Details about corrections to payable invoices with one row per payable invoice. This table only includes payable invoices that receive a corrected invoice.

Column

Definition

Approved At

When the invoice was fully approved.,

Invoice URL

Link to the payable invoice in Loop

Invoice Number

The payable invoice number

Amount Recouped

The total amount recouped from the original invoice in the correction. This value will be positive if the original invoiced amount was more than the current invoiced amount. Otherwise this field will show $0.

Change In Amount

The original invoiced amount (pre-correction) minus the current invoiced amount.

Payee Display Name

The organization who receives money for this invoice. This will either be the vendor or the organization who receives on the vendor's behalf. An example of this is a factoring company receiving money for a trucking carrier.

Vendor Display Name

The vendor who performed the service. Often this will be a trucking carrier.

Original Invoice Amount

The invoice amount extracted from the first invoice artifact (pre-correction).,

Corrected Invoice Amount

The current invoiced amount on the payable invoice.,

First Invoice Created At

When the first invoice artifact was received for this payable invoice.

Last Correction Created At

When the most recent corrected invoice artifact was received.

Number Of Invoice Artifacts

The total number of invoice artifacts attached to the payable invoice. This includes the original, corrections, balance due, and duplicates that may have been received.


Payable Invoice Exports

Details about every payable invoice export and the associated entities. It's possible that one invoice may have been exported more than one time.

Column

Definition

Status

The status of the export

GL Codes

The GL code or codes assigned to the individual payable invoice

Payee Name

The name of the payee on the invoice

Payor Name

The name of the payor on the invoice

PO Numbers

Any PO numbers associated with the payable invoice or its job (comma separated)

BOL Numbers

Any BOL numbers associated with the payable invoice or its job (comma separated)

Exported At

The date and time that the export occurred

Export User

The user who ran the export

Currency Code

The three-letter currency code for the invoice

Invoice Number

The payable invoice number

Exported Amount

The amount exported for the payable invoice

Invoiced Amount

The amount invoiced on the payable invoice.

External Identifiers

Any external identifiers associated with the payable invoice or its job


Shipment Job Exports

Details about every shipment job export. It's possible that one job may have been exported more than once.

Column

Definition

GL Codes

GL codes associated with the shipment job (comma separated)

BOL Numbers

BOL numbers associated with the shipment job (comma separated)

PO Numbers

PO numbers associated with the shipment job (comma separated)

Invoice Numbers

Invoice numbers of any payable invoices linked to the shipment job (comma separated)

Exported At

The date and time that the export occurred

Export User

The user who performed the export

Pickup Date

The pickup date on the shipment job

Vendor Name

The name of the vendor organization on the shipment job

Origin Address

The origin address for the shipment job

Destination Address

The destination address for the shipment job

Origin Gross Weight

The total weight of all articles at the origin

Origin Gross Weight Unit

The unit for the gross weight

Release Status

The status of the export

Exported Amount

The total amount for the shipment job on the export

Invoiced Amount

The total amount invoiced for the shipment job

Currency Code

The currency code on the shipment job's invoice

Fully Approved At

The date and time that the invoice was last approved

Cost Per Weight Unit

The exported amount divided by the origin gross weight


Exceptions

All exceptions applied to Loop entities. Each row is one exception.

Column

Definition

Exception

The type of exception applied

Created At

When the exception was first added to the entity

Created By

The user who created the exception

Entity Link

The link to the entity itself within the Loop app

Resolved At

When the exception was resolved (null if not resolved

Resolved By

The user who resolved the exception (null if not resolved)

Exception Note

The optional note applied to the exception

Exception Entity

The entity type for which the exception was applied


Organizations

Basic details about every organization in Loop.

Column

Definition

QID

The qualified unique identifier of the organization

Is Factor

True if the organization is a factor

MC Number

[Trucking Carrier Only] The MC number for the carrier

Org Types

The organization types assigned to this org (comma separated)

Created At

When the organization was first created in Loop

Legal Name

The legal business name of the organization

Is Customer

True if the organization is a customer

Is Factored

True if payments to the organization are factored through a factoring company

Display Name

The display name used for the organization. This may differ from the legal business name.

Is Brokerage

True if the organization is a brokerage

USDOT Number

[Trucking Carrier Only] The USDOT for the carrier

Remittance Address

The physical address where remittances should be mailed to payees

Is Trucking Carrier

True if the organization is a trucking carrier

Payment Account Status

The status of payment account onboarding for this organization. This is only relevant if the organization will be receiving payments from Loop

Primary Billing Address

The physical address where bills should be sent to payors

Primary Payment Address

The address associated with the organization when they signed up for payments

Is Enrolled In Quick Pay

Whether or not the organization is enrolled in Quick Pay

Quick Pay Discount Percentage

The current discount percentage applied if the organization is enrolled in Quick Pay


User Activity History

A log of actions performed by users in Loop.

Column

Definition

User Name

The user who performed the activity

Entity Qid

The qualified unique identifier of the entity for which the activity was performed

Event Type

The type of activity event performed

Entity Link

The link to view the entity being actioned on

Entity Type

The type of entity for which the activity was performed

Event Recorded At

The date and time when the event was recorded

Aggregate Fields for Visualizations

Definition

Count

Count of user activity events

Did this answer your question?