Winter '25 Revenova PayIQ Data Dictionary

Accessorial

Lookup(Accessorial)

A lookup to the accessorial the rule matches to.

Amount

Currency(16, 2)

Defines the amount paid if the “Flat Rate” or “Amount Per Unit/Quantity” rules are selected.

PayIQ Program

Master-Detail(PayIQ Program)

The Master-Detail relationship to the parent PayIQ Program record the Accessorial Rule belongs to.

Percent

Percent(3, 2)

Defines the percent applied to the accessorial total if the “Percent of Accessorial” rule is selected.

Rule

Picklist

Defines how the payout is calculated. Values include: “Flat Rate,” “Amount Per Unit/Quantity,” and “Percent of Accessorial.” No default value. For a Trip Plan Leg Accessorial, the selected rule auto-fills the rate/qty instead of controlling the final payout. Final payout from a Trip Plan Leg Accessorial charges is always 100% of the total on the accessorial.

Type

Picklist

The type of accessorial paid off of. Values include: “Customer Invoice Accessorial” and “Trip Plan Leg Accessorial.”

Amount

Currency(10, 2)

When the Calculation Method =

1. Amount Per Load, this is the amount earned per Load.

2. Percent of Load Margin with Min, this is the minimum amount earned per Load.

3. Percent of Load Margin with Max, this is the maximum amount earned per Load.

4. Percent of Load Margin Sliding Scale, this the amount the margin climbs to.

5. Rate per Driver Log/Trip Plan Leg Hour, this is the rate earned per hour.

6. Rate per Driver Log/Trip Plan Leg Mile, this is the rate earned per mile.

7. Rate per Driver Log/Trip Plan Leg Kilometer, this is the rate earned per km.

Calculation Custom Currency Field

Picklist

The available options for Load-level currency fields that may be used for the “Percentage of Custom Pay Amount” calculation method. The field must be a currency field.

Calculation Driver Log Distance Field(s)

Multi-picklist

Defines the fields pulled from for Driver Log distance pay calculations. Values include: “Driving Distance” and “Yard Move Distance.” No default selection.

Calculation Driver Log Duration Field(s)

Multi-picklist

Defines the fields pulled from for Driver Log duration pay calculations. Values include: “On Duty Duration,” “Sleeper Berth Duration,” “Driving Duration,” “Active Duration,” “Yard Move Duration,” and “Waiting Time Duration.” No default selections.

Calculation Method

Picklist

The calculation used to determine pay amount for each pay detail. Values include: “Amount per Load,” “Percent of Load Margin,” “Percent of Load Margin with Min,” “Percent of Load Margin with Max,” “Percent of Load Margin (Sliding Scale),” “Percent of Load Revenue,” “Percent of Load Custom Amount,” “Rate per Driver Log/Trip Plan Leg Hour,” “Rate per Driver Log/Trip Plan Leg Mile,” and “Rate per Driver Log/Trip Plan Leg Kilometer.” No default value.

Calculation Revenue Number

Picklist

For Revenue pay calculations, this selection determines which segments of revenue are included in the calculation. Values include: “Full Revenue,” “Freight Only,” “Fuel Only,” and “Freight + Fuel.” No default value.

Criteria

Picklist

The number used as the criteria for the pay bracket. Values include: “Load Margin,” “Load Margin %,” “Load Revenue,” “Load Count,” “Load Custom Amount,” “Driver Log/Trip Plan Leg Hours,” “Driver Log/Trip Plan Leg Distance (Miles),” and “Driver Log/Trip Plan Leg Distance (Km).” No default value.

Criteria Custom Currency Field

Picklist

The Load-level currency fields that are used for the “Percentage of Custom Pay Amount” calculation method. The field must be a currency field.

Criteria Driver Log Distance Field(s)

Multi-picklist

Defines which field(s) are pulled from for Driver Log distance criteria. Values include: “Driving Distance” and “Yard Move Distance.” No default value.

Criteria Driver Log Duration Field(s)

Multi-picklist

Defines which field(s) are pulled from for Driver Log duration criteria. Values include: “On Duty Duration,” “Sleeper Berth Duration,” “Driving Duration,” “Active Duration,” “Yard Move Duration,” and “Waiting Time Duration.” No default value.

Criteria Revenue Number

Picklist

Determines which segments of revenue are included in the criteria determination. Values include: “Full Revenue,” “Freight Only,” “Fuel Only,” and “Freight + Fuel.” No default value.

Financial Aggregation Method

Picklist

Defines whether to apply the pay bracket on financials aggregated across the pay period or to apply the bracket to each individual item for a participant. Values include: “Aggregated per period,” and “Individual (do not aggregate).” No default value.

Financials to Use for Calculation

Picklist

The Load financial criteria to determine the final pay calculation. Not applicable for Load Count criteria. Values include: “Quoted,” and “Invoiced.” No default value.

Financials to Use for Criteria

Picklist

The Load financial criteria to determine whether to pay on this bracket. Not applicable for Load Count criteria. Values include: “Quoted,” and “Invoiced.” No default value.

From (>)

Number(12, 2)

Defines the beginning threshold for this entry. The criteria selected must be greater than this amount to match this bracket.

PayIQ Program

Master-Detail(PayIQ Program)

The Master-Detail relationship to the parent PayIQ Program record the Calculation Tier belongs to.

Percent

Percent(3, 2)

The percentage earned when the Calculation Method is a percentage.

To (<=)

Number(12, 2)

Defines the target threshold for this entry. The criteria selected must be less than or equal to this amount. If blank, the tier has no cap.

Pay Header

Lookup(Pay Header)

A lookup to the associated Pay Header to attach the EPayment as an adjustment.

Pay Settlement Email CC

Long Text Area(131072)

Multi-email field for defining which set of CC emails the Pay Settlement is emailed to in the email pay settlements action.

Pay Settlement Email To

Long Text Area(131072)

Multi-email field for defining which set of TO emails the Pay Settlement is emailed to in the email pay settlements action.

API Field

Text(55)

The technical field name for the field this filter applies to.

API Value

Long Text Area(131072)

The actual text value the filter checks against.

Field

Text(40)

The friendly name for the field displayed in the UI.

Lookup Name

Text(255)

Stores the friendly names for lookup fields that are displayed in the place of the filter value.

Operator

Picklist

The operator applied to the field value. Values include:

1. “Equal to,” (an exact equality).

2. “Not equal to,” (an exact inequality).

3. Equal to any,” (requires at least one match in the set).

4. “Contains” (requires a full match in the set or text).

“Equal To” is the default value.

PayIQ Program

Master-Detail(PayIQ Program)

The Master-Detail relationship to the parent PayIQ Program record the Load Filter belongs to.

Table

Picklist

The table this filter applies to. Values include: “Load,” “Driver Log,” and “Trip Plan Leg.” No default value. If Pay Off Load is selected on a participant matched to a Trip Plan Leg, only Load filters are applied. If not selected, only Trip Plan Leg filters are applied.

Type

Picklist

The Salesforce field type this filter refers to. Values include: “BOOLEAN,” “CURRENCY,” “DATE,” “DATETIME,” “DOUBLE,” “EMAIL,” “MULTIPICKLIST,” “PERCENT,” “PHONE,” “PICKLIST,” “REFERENCE,” “STRING,” “TEXTAREA,” “TIME,” and “URL.” No default value.

Value

Long Text Area(131072)

The friendly value displayed in the UI.

Pay Header

Lookup(Pay Header)

A lookup to the associated Pay Header to attach the Fuel Card Transaction Line Item as an adjustment.

Custom PayIQ Amount

Currency(16, 2)

A placeholder field filled by a flow, trigger, or batch process for custom criteria/payment amounts.

Custom PayIQ Eligible Date

Date

A placeholder field that is filled by a flow, trigger, or batch process for customization to determine when to pay.

PayIQ Locked

Checkbox

Locks a Load so that it does not generate any pay records.

Sales Lead (Contact)

Lookup(Contact)

A fillable contact field to optionally pay outside contractors.

Datetime Entered

Date/Time

The date the log was generated. This date can be different from the CreatedDate because log saving is deferred for performance.

Detail

Rich Text Area(131072)

The rich text log text in HTML format.

Driver Log

Lookup(Driver Log)

A lookup to the associated Driver Log record. This is an optional reference to the Driver Log that generated the Log record. This field is set if a Participant Match or Pay Detail generated the Log.

Load

Lookup(Load)

A lookup to the associated Load. This is an optional reference to the Load that generated the log. This field is also set if a Participant Match or Pay Detail generated the log.

Pay Detail

Lookup(Pay Detail)

A lookup to the associated Pay Detail. This is an optional reference to the Pay Detail that generated the log.

PayIQ Participant Match

Lookup(PayIQ Participant Match)

A lookup to the associated PayIQ Participant Match. This is an optional reference to the PayIQ Participant match that generated the log.

Trip Plan Leg

Lookup(Trip Plan Leg)

A lookup to the associated Trip Plan Leg. This is an optional reference to the Trip Plan Leg that generated the Log. This field is also set if a Participant Match or Pay Detail generated the Log.

Type

Picklist

This field categorizes what information is logged. It corresponds to the checkboxes in the PayIQ Admin to turn on/off logs. Values include: “Currency Conversion,” “Limits,” “Math, “Performance,” and “Qualification.” No default value.

Contact

Lookup(Contact)

A lookup to the Contact the Minimum Pay Rule is for.

Driver

Lookup(Driver)

A lookup to the Driver the Minimum Pay Rule is for.

Fleet Asset

Lookup(Fleet Asset)

A lookup to the Fleet Asset the Minimum Pay Rule is for.

Minimum Pay (Per Period)

Currency(16, 2)

The amount of minimum pay per pay period. If the amount within a given pay period does not reach this threshold, an adjustment to the minimum amount is generated by the automated process.

Pay Schedule

Master-Detail(Pay Schedule)

The Master-Detail relationship to the parent Pay Schedule record the Minimum Pay Rule belongs to.

Payee Name

Formula(Text)

Resolves to the full name of the payee depending on the type.

Payee Type

Picklist

The type of payee the Minimum Pay Rule applies to. Values include: “User,” “Contact,” “Driver,” and “Fleet Asset.” No default value.

User

Lookup(User)

A lookup to the User the Minimum Pay Rule is for.

Allow Pay Estimates

Checkbox

When Checked, estimating pay is allowed for the Driver or Fleet Asset participants.

Contact

Lookup(Contact)

A lookup to the Contact.

Driver

Lookup(Driver)

A lookup to the Driver.

Effective Date

Date

The effective date of an employee or contractor. Pay is only generated on or after this date.

Email Out Pay Estimates

Checkbox

When Checked, the pay estimate report is attached to the driver confirmation for the Driver or Fleet Asset records.

Expiration Date

Date

The expiration date of an employee or contractor. Pay is only generated before or on this expiration date.

Fleet Asset

Lookup(Fleet Asset)

A lookup to the Fleet Asset.

Name

Formula (Text)

A formula field that pulls the full name from the user, contact, or the team name if the participant is a team. For display purposes.

Pay Off Load

Checkbox

When Checked, the Driver or Fleet Asset records are paid off the Load instead of the Trip Plan Leg. This opens all of the Load criteria/calculation options available in broker pay.

PayIQ Program

Lookup(PayIQ Program)

A lookup to the associated PayIQ Program. (If participant is not a team member.)

Team

Lookup(Participant)

A lookup to the associated Team. (If participant is a team member.)

Team Name

Text(255)

The team name for team-type participants.

Type

Picklist

The type of participant. Values include: “User,” “Contact,” “Driver,” “Fleet Asset,” or “Team.” “Team” is a special case where a team may have child participants that constitute team members. Teams cannot be within teams. No default value.

User

Lookup(User)

A lookup to the User.

Converted Freight (Invoiced)

Currency(16, 2)

The freight charges (invoiced) from the Load. This value is converted to the Participant currency.

Converted Freight (Quoted)

Currency(16, 2)

The freight charges (quoted) from the Load. This value is converted to the Participant currency.

Converted Fuel (Invoiced)

Currency(16, 2)

The fuel charge (invoiced) from the Load. This value is converted to the Participant currency.

Converted Fuel (Quoted)

Currency(16, 2)

The fuel charge (quoted) from the Load. This value is converted to the Participant currency.

Converted Margin (Invoiced)

Currency(16, 2)

The margin (invoiced) from the Load. This value is converted to the Participant currency.

Converted Margin (Quoted)

Currency(16, 2)

The margin (quoted) from the Load. This value is converted to the Participant currency.

Converted Revenue (Invoiced)

Currency(16, 2)

The revenue (invoiced) from the Load. This value is converted to the Participant currency.

Converted Revenue (Quoted)

Currency(16, 2)

The revenue (quoted) from the Load. This value is converted to the Participant currency.

Driver Log

Lookup(Driver Log)

A lookup to the Driver Log record the Participant Match belongs to.

Eligible Date

Date

The date when the Load is eligible for pay.

Freight Plan

Lookup(Freight Plan)

A lookup to the associated Freight Plan. The Freight Plan this Participant match was generated (if the Load is part of a freight plan). Carrier Loads may generate more than one participant match if they are running multiple customer Loads. This reference allows identifying which numbers this participant match is for.

Load

Lookup(Load)

A lookup to the Load record the Participant Match belongs to.

Participant

Lookup(Participant)

A lookup to the associated Participant.

Participant Name

Formula (Text)

A formula field that pulls the name of the Participant record. For display purposes.

Pay Period

Lookup(Pay Period)

A lookup to the associated Pay Period. The Pay Period falls within the eligible date.

PayIQ Program

Lookup(PayIQ Program)

A lookup to the associated PayIQ Program.

Trip Plan Leg

Lookup(Trip Plan Leg)

A lookup to the Trip Plan Leg record the Participant Match belongs to.

Approver

Lookup(User)

A lookup to the associated User. This field is used to facilitate the expense approval process. The user that approves expenses.

Category

Picklist

The value of the adjustment either added or subtracted from the total pay. Values include: “Addition,” and “Deduction.” No default value.

Description

Text Area(255)

An optional description field.

Generated

Checkbox

When Checked, the adjustment was created by the automated process. The default value is Unchecked. Adjustments marked as generated are cleared out by the automated process on the next run to be regenerated.

Item Total

Formula (Currency)

A formula field that equals the Rate multiplied by the Qty. The value is negative if the Category is “Deduction.”

Load

Lookup(Load)

A lookup to the associated Load. An optional reference to a Load of the adjustment is tied to a specific Load.

Minimum Pay Rule

Lookup(Minimum Pay Rule)

A lookup to the minimum pay rule that generated the Pay Adjustment.

Pay Advance

Lookup(Pay Advance)

A lookup to the pay advance that generated the Pay Adjustment.

Pay Approved

Formula (Checkbox)

A formula field indicating whether the pay Header for the Pay Adjustment belongs to is closed out.

Pay Estimate Detail

Lookup(Pay Estimate Detail)

A lookup to the Pay Estimate Detail the Pay Adjustment was copied from.

Pay Header

Master-Detail(Pay Header)

The Master-Detail relationship to the parent Pay Header record the Pay Adjustment belongs to.

Qty

Number(8, 2)

The quantify of the item this adjustment is for.

Rate

Currency(8, 2)

The rate per item this adjustment is for.

Receipt Attached

Checkbox

When “checked,” a receipt is attached for expense approval.

Remaining Balance

Currency(16, 2)

The remaining pay advance balance as of the creation of the pay adjustment.

Status

Picklist

Facilitates the expense approval process. Does not impact inclusion in the totals. Values include: “Approved,” “Declined,” “Pending,” and “Under Review.” “Pending” is the default value.

Status as of

Date/Time

The timestamp recorded when the Status field was last updated.

Status Comments

Text Area(255)

Facilitates communication for the expense approval.

Transaction Date

Date

The date the transaction was processed. May be set manually.

Type

Picklist

A field for categorizing expenses. Values Include: “Accident Insurance,” “Fuel Purchase,” “Hotel/Motel,” “Other,” and “Tire Purchase.” No default value.

Adjustment Plan

Picklist

Determines how the Pay Advance is paid out. Values include: “Flat Amount,” “Percent per Pay Period,” and “Amount per Pay Period.”

Amount Per Pay Period

Currency(16, 2)

The amount used if the Adjustment Plan is “Amount per Pay Period.”

Category

Picklist

The value of the Pay Advance to either add or subtract from the total pay. Values include: “Addition” and “Deduction.” No default value.

Contact

Lookup(Contact)

A lookup to the Contact the Pay Advance is for.

Description

Text Area(255)

An optional description field.

Driver

Lookup(Driver)

A lookup to the Driver record this Pay Advance is for.

Fleet Asset

Lookup(Fleet Asset)

A lookup to the Fleet Asset the Pay Advance is for.

Item Total

Formula(Currency)

A formula field that equals the Rate multiplied by the Qty. The value is negative if the Category is “Deduction.”

Paid Amount

Currency(16, 2)

The amount converted to adjustments.

Payee Name

Formula(Text)

Resolves to the full name of the Payee depending on the type.

Payee Type

Picklist

The type of payee the Pay Advance is for. Values include: “User,” “Contact,” “Driver,” and “Fleet Asset.” No default value.

Percent Per Pay Period

Percent(2, 2)

The percent used if the Adjustment Plan is “Percent per Pay Period.”

Qty

Number(8, 2)

The quantity of the item the Pay Advance is for.

Rate

Currency(8, 2)

The rate per item the Pay Advance is for.

Receipt Attached

Checkbox

When Checked, a recipient is attached for expense approval.

Remaining Balance

Formula(Currency)

The remaining amount to be added/deducted according to the Adjustment Plan.

Transaction Date

Date

The date the transaction was processed. Required. No default value.

Type

Picklist

A field to categorize expenses. Values include: “Accident Insurance,” “Fuel Purchase,” “Hotel/Motel,” “Other,” and “Tire Purchase.” No default value.

User

Lookup(User)

A lookup to the User record the Pay Advance is for.

Wait For Next Period To Begin Adjusting

Checkbox

When Checked, the Pay Advance is assigned to the next Pay Header after the Pay Header the Pay Advance falls into.

Accessorial

Lookup(Accessorial)

A lookup to the Accessorial the Pay Detail was generated for (if applicable).

Accessorial Qty

Number(16, 2)

The value copied quantity from the Accessorial.

Accessorial Rule

Lookup(Accessorial Rule)

A lookup to the associated Accessorial Rule. This field is a reference to the Accessorial Rule the Pay Detail was generated from (if applicable).

Accessorial Total

Currency(16, 2)

The value copied total from the Accessorial.

Calculation Tier

Lookup(Calculation Tier)

A lookup to the associated Calculation Tier. This field is a reference to the tier this Pay Detail was generated from.

Contact

Lookup(Contact)

A lookup to the associated Contact. This field is a reference to the contact the Pay Detail is for (if the participant is a Contact).

Converted Freight (Invoiced)

Formula (Currency)

A formula field that pulls the Converted Freight (Invoiced) from the participant match.

Converted Freight (Quoted)

Formula (Currency)

A formula field that pulls the Converted Freight (Quoted) from the participant match.

Converted Fuel (Invoiced)

Formula (Currency)

A formula field that pulls the Converted Fuel (Invoiced) from the participant match.

Converted Fuel (Quoted)

Formula (Currency)

A formula field that pulls the Converted Fuel (Quoted) from the participant match.

Converted Margin (Invoiced)

Formula (Currency)

A formula field that pulls the Converted Margin (Invoiced) from the participant match.

Converted Margin (Quoted)

Formula (Currency)

A formula field that pulls the Converted Margin (Quoted) from the participant match.

Converted Revenue (Invoiced)

Formula (Currency)

A formula field that pulls the Converted Revenue (Invoiced) from the participant match.

Converted Revenue (Quoted)

Formula (Currency)

A formula field that pulls the Converted Revenue (Quoted) from the participant match.

Customer

Formula (Text)

A formula field that pulls the customer on the Load.

Driver

Lookup(Driver)

A lookup to the Driver record the Pay Detail is associated with. This field is a reference to the Contact the Pay Detail is for (if the participant is a Driver).

Driver Log

Lookup(Driver Log)

A lookup to the associated Driver Log the Pay Detail was generated from.

Fleet Asset

Lookup(Fleet Asset)

A lookup to the associated Fleet Asset the Pay Detail is associated with. This field is a reference to the Contact this Pay Detail is for (if the participant is a Fleet Asset).

Load

Lookup(Load)

A lookup to the associated Load this Pay Detail was generated from.

Participant Match

Lookup(PayIQ Participant Match)

A lookup to the associated Participant Match record.

Participant Name

Formula (Text)

A formula field that pulls the full name from the identified participant the Pay Detail is for. This field also displays the type of participant in parentheses.

Pay Amount

Currency(16, 2)

The amount for this Pay Detail.

Pay Approved

Formula (Checkbox)

A formula field indicating whether the Pay Header for this Pay Detail belongs to is closed out.

Pay Header

Master-Detail(Pay Header)

The Master-Detail relationship to the parent Pay Header record the Pay Detail belongs to.

PayIQ Program

Lookup(PayIQ Program)

A lookup to the associated PayIQ Program. This field references the tier this PayIQ Program was generated from.

Trip Plan Leg

Lookup(Trip Plan Leg)

A lookup to the associated Trip Plan Leg the Pay Detail was generated from.

Trip Plan Leg Accessorial

Lookup(Trip Plan Leg Accessorial)

A lookup to the associated Trip Plan Leg Accessorial the Pay Detail was generated from.

User

Lookup(User)

A lookup to the associated User. This field references the contact this Pay Detail is for (if the participant is a User).

Driver

Lookup(Driver)

A lookup to the Driver record the Pay Estimate is for.

Email Out Pay Estimate

Checkbox

When Checked, the estimate report is included as an attachment to the Driver confirmation email.

Estimate Date

Date

The date the estimate was generated. The default value is today.

Expired

Checkbox

When Checked, a newer Pay Estimate was generated for the same Trip Plan Segment. The default value is not Checked.

Fleet Asset

Lookup(Fleet Asset)

A lookup to the Fleet Asset record the Pay Estimate is for.

Grand Total

Roll-Up Summary (SUM Pay Estimate Details

The total this Pay Estimate comes to.

Matched From Driver Log Program

Checkbox

When Checked, the Pay Estimate was generated from a Driver Log program. Adjustments to Estimate Details are disabled.

Status

Picklist

Indicates the status the Pay Estimate is in following the Driver confirmation process. Values include: “Estimated,” “Sent,” “Accepted,” and “Declined.”

Trip Plan Segment

Lookup(Trip Plan Segment)

A lookup to the Trip Plan Segment record the Pay Estimate is for.

Accessorial

Lookup(Accessorial)

A lookup to the accessorial the Pay Detail was generated for (if applicable).

Accessorial Qty

Number(16, 2)

The quantity copied from the accessorial.

Accessorial Rule

Lookup(Accessorial Rule)

A lookup to the associated Accessorial Rule. This field is a reference to the accessorial rule the Pay Detail was generated from (if applicable).

Accessorial Total

Currency(16, 2)

The total copied from the accessorial.

Adjustment

Currency(16, 2)

The adjustment of the Pay Detail up or down from the calculated amount.

Amount

Currency(16, 2)

The calculated amount of estimated pay for the Pay Detail.

Calculation Tier

Lookup(Calculation Tier)

A lookup to the associated Calculation Tier. This field is a reference to the tier the Pay Detail was generated from (if applicable).

Comment

Text Area(255)

Optional comment field for the Pay Estimate Detail.

Converted Freight (Quoted)

Currency(16, 2)

The quoted freight charge amount copied from the Load.

Converted Fuel (Quoted)

Currency(16, 2)

The quoted fuel charge amount copied from the Load.

Converted Margin (Quoted)

Currency(16, 2)

The quoted margin amount copied from the Load.

Converted Revenue (Quoted)

Currency(16, 2)

The quoted revenue amount copied from the Load.

Item Total

Formula(Currency)

The final amount for the Pay Detail after adjustment.

Load

Lookup(Load)

A lookup to the Load the Pay Estimate Detail is matched to.

Pay Estimate

Master-Detail(Pay Estimate)

The Master-Detail relationship to the parent Pay Estimate record the Pay Estimate belongs to.

PayIQ Program

Lookup(PayIQ Program)

A lookup to the PayIQ Program the Pay Estimate Detail is matched to.

Trip Plan Leg

Lookup(Trip Plan Leg)

A lookup to the Trip Plan Leg the Pay Estimate Detail is matched to.

Calculation Date

Date/Time

The date and time the Pay Header was created.

Comments

Text Area(255)

An option field to add comments to the Pay Header.

Contact

Lookup(Contact)

A lookup to the associated Contact the Pay Header is for (if it was generated for a Contact).

Date Range

Formula (Text)

A formula field that resolves from <Start Date> to <End Date>.

Driver

Lookup(Driver)

A lookup to the associated Driver the Pay Header is for (if it was generated for a Driver).

End Date

Formula (Date)

A formula field that pulls the end date from the Pay Period.

Fleet Asset

Lookup(Fleet Asset)

A lookup to the associated Fleet Asset the Pay Header is for (if it was generated for a Fleet Asset).

Grand Total

Formula (Currency)

A formula field that resolves to the Total Pay + Total Additions + Total Deductions. Total Deductions are negative at this point (and therefore added).

Participant Name

Formula (Text)

A formula field that resolves to the full name of the identified Participant this Pay Header is for. This field is for display purposes.

Pay Period

Lookup(Pay Period)

A lookup to the associated Pay Period this Pay Header is for.

Payment Status

Picklist

Used by the pay approval process to close out payments. Values include: “Approved,” “Paid,” and “Pending.” No default value.

Payroll Description

Formula (Text)

Categorizes Payroll Entries for payroll system integration.

Start Date

Formula (Date)

A formula field that pulls the start date from the Pay Period.

Sent Pay Settlement

Checkbox

When Checked, the Pay Settlement was emailed out. Automatically set during the email pay settlement action.

Subtotal Adjustment Deductions

Roll-Up Summary (SUM Pay Adjustment)

A summary field that sums the Item Totals for all Adjustments of the deduction category. The Item Totals are negative at this point (and therefore added).

Subtotal EPayment Deductions

Currency(16, 2)

The sum of all negated EPayment amounts tied to the Pay Header. This field is summed by the Match Outside Transactions job.

Subtotal FuelCard Deductions

Currency(16, 2)

The sum of all negated FuelCard transaction Line Item amounts tied to the Pay Header. This field is summed by the Match Outside Transactions job.

Total Additions

Roll-U- Summary (SUM Pay Adjustment)

A summary field that sums the Item Totals for all Adjustments of the addition category.

Total Deductions

Formula (Currency)

A formula field that resolves to the Subtotal Adjustment Deductions + Subtotal EPayment Deductions + Subtotal FuelCard Deductions. The subtotals are negative at this point (and therefore added).

Total Pay

Roll-Up Summary (SUM Pay Detail)

A summary field that sums all Pay Details on this Pay Header before adjustments.

User

Lookup(User)

A lookup to the associated User this Pay Header is for (if it was generated for a user).

Active

Formula (Checkbox)

A formula field that when “Checked” displays an active Pay Schedule. Inactive (“Unchecked”) schedules are excluded from pay generation.

Pay Schedule

Master-Detail(Pay Schedule)

The Master-Detail relationship to the parent Pay Schedule record the Pay Period belongs to.

Payment Due Date

Date

The date the pay amount earned for this Pay Period is to be paid out to the employee or contractor.

Period Beginning

Date

Defines when the Pay Period begins.

Period Ending

Date

Defines when the Pay Period ends.

Period Status

Picklist

This field indicates whether the Pay Period is closed out or not. Closed Pay Periods are excluded from pay generation. Values include: “Closed” and “Open.” No default value.

Active

Checkbox

When “Checked.” the Pay Schedule is active. Inactive (“Unchecked”) schedules are excluded from pay generation.

Fiscal Year

Text(4)

An optional informational field that defines which financial year the Pay Schedule applies to.

Pay Periods

Roll-Up Summary (COUNT Pay Period)

A formula field that counts the number of Pay Periods defined in the Pay Schedule.

Carrier Load Allocation

Picklist

This field defines how margin and revenue are allocated to Carrier Loads in a Freight Plan.

1. Cost Contribution = Percentage allocated based on Carrier Load’s contribution to total Freight Plan cost.

2. Distance Contribution = Percentage allocated base on Carrier Load’s contribution to total freight plan distance.

3. Full = 100% of margin and revenue allocated regardless of cost or distance contribution.

   Values include: “Cost Contribution,” “Distance Contribution,” and “Full.” “Cost Contribution” is the default value.

Description

Text(255)

An optional description field.

Freight Plan Load Criteria

Picklist

This field establishes that all Loads have accepted quotes/invoices generated to insure the Freight Plan is complete. “None” enforces neither criteria. Uses the flags set by the FreighPlanManagementJob in the TMS (and MUST be running for this to function properly). Values include: “All Loads must be invoiced,” “All Loads must be quoted,” and “None.” No default value.

Has Trip Plans Paying Off Loads

Checkbox

When Checked, the Prgram has Driver/Fleet Asset Participants paying off the Load defined in the Trip Plan Segment instead of the Trip Plan Leg metrics. This field is set automatically by a trigger.

Number of Driver Log Roles

Roll-Up Summary (COUNT Roles)

A formula field that counts the number of Driver Log Roles within the PayIQ Program.

Number of Load Roles

Roll-Up Summary (COUNT Roles)

A formula field that counts the number of Load Roles within the PayIQ Program.

Number of Tiers

Roll-Up Summary (COUNT Calculation Tier)

A formula field that counts the number of tiers within the PayIQ Program.

Number of Trip Plan Leg Roles

Roll-Up Summary (COUNT Roles)

A formula field that counts the number of Trip Plan Leg Roles within the PayIQ Program.

Pay Schedule

Lookup(Pay Schedule)

A lookup field to the Pay Schedule used by the PayIQ Program.

Payroll Code

Text(30)

This field categorizes Payroll Entries for the payroll system integration.

Payroll Description

Text(255)

This field categorizes Payroll Entries for the payroll system integration.

Payroll Type

Text(20)

This field categorizes Payroll Entries for the payroll system integration.

Status

Picklist

This field determines whether the program is included in Pay Generation. Values include: “Closed,” “Open,” and “Pending.” “Closed” and “Pending” are treated identically by the system. The difference is that a Program may be in a “Pending” status while the pay structure is determined during setup. The purpose is to not cause business disruption. “Pending” is the default value.

Driver Log Active Duration (Hours)

Number(16, 2)

The aggregate of Driver Log Active Duration (Hours).

Driver Log Driving Distance (Km)

Number(16, 2)

The aggregate of Driver Log Driving Distance (Km).

Driver Log Driving Distance (Miles)

Number(16, 2)

The aggregate of Driver Log Driving Distance (Miles).

Driver Log Driving Duration (Hours)

Number(16, 2)

The aggregate of Driver Log Driving Duration (Hours).

Driver Log On Duty Duration (Hours)

Number(16, 2)

The aggregate of Driver Log On Duty Duration (Hours).

Driver Log Sleeper Berth Duration (Hrs)

Number(16, 2)

The aggregate of Driver Log Sleeper Berth Duration (Hours).

Driver Log Waiting Time Duration (Hours)

Number(16, 2)

The aggregate of Driver Log Waiting Time Duration (Hours).

Driver Log Yard Move Distance (Km)

Number(16, 2)

The aggregate of Driver Log Yard Move Distance (Km).

Driver Log Yard Move Distance (Miles)

Number(16, 2)

The aggregate of Driver Log Yard Move Distance (Miles).

Driver Log Yard Move Duration (Hours)

Number(16, 2)

The aggregate of Driver Log Yard Move Duration (Hours).

Freight (Invoiced)

Currency(16, 2)

The aggregate of Freight (Invoiced).

Freight (Quoted)

Currency(16, 2)

The aggregate of Freight (Quoted).

Fuel (Invoiced)

Currency(16, 2)

The aggregate of Fuel (Invoiced).

Fuel (Quoted)

Currency(16, 2)

The aggregate of Fuel (Quoted).

Load Count

Number(18, 0)

The aggregate of Load Count.

Margin (Invoiced)

Currency(16, 2)

The aggregate of Margin (Invoiced).

Margin (Quoted)

Currency(16, 2)

The aggregate of Margin (Quoted).

Participant

Lookup(Participant)

A lookup to the Participant the aggregate record is for.

Pay Period

Lookup(Pay Period)

A lookup to the Pay Period the aggregate record is for.

Revenue (Invoiced)

Currency(16, 2)

The aggregate of Revenue (Invoiced).

Revenue (Quoted)

Currency(16, 2)

The aggregate of Revenue (Quoted).

Trip Plan Leg Hours

Number(16, 2)

The aggregate of Trip Plan leg Hours.

Trip Plan Leg Kilometers

Number(16, 2)

The aggregate of Trip Plan Leg Kilometers.

Trip Plan Leg Miles

Number(16, 2)

The aggregate of Trip Plan Leg Miles.

Eligible Date Field

Picklist

The date field on the Load used to determine which pay period to slot pay into. If no pay period on the defined pay schedule matches the eligible date field, no pay is generated. Values for Load roles include: “Custom PayIQ Eligible Date,” “Expected Delivery Date,” and “Expected Ship Date.” Use “Custom PayIQ Eligible Date” to populate a custom date with a flow, trigger, or batch process. Values for Driver Log roles are only “Certified as of.” Values for Trip Plan Leg roles are “Arrival Date,” “Departure Date,” “Last Leg Arrival Date,” and “Last Leg Departure Date.” “Expected Delivery Date” is the default value.

Lookup Type

Picklist

The object type of the participant on the Load. Values include: “User,” “Contact,” “Driver,” and “Fleet Asset.” No default value.

Parent Object

Picklist

The record that is paid off of to pull the eligible date and participant from. Values include: “Load,” “Driver Log,” and “Trip Plan Leg.” No default value.

PayIQ Program

Master-Detail(PayIQ Program)

The Master-Detail relationship to the parent PayIQ Program record the Load Role belongs to.

Role Field

Picklist

The Load field to pull participants from. A global picklist that may be expanded with custom fields on a Load. Values include: “Carrier Sales Rep,” “Customer Sales Rep,” and “Sales Lead (Contact).” No default value.

Allow Overriding Estimates

Checkbox

When Checked, the User can override pay estimate amounts.

Estimate Adjustment Lower Limit

Currency(16, 2)

Sets the lower relative limit that estimate details can be adjusted down to.

Estimate Adjustment Upper Limit

Currency(16, 2)

Sets the upper relative limit that estimate details can be adjusted up to.

Payroll ID

Text(50)

The User ID required for the Payroll System. This field is used by the Revenova TMS Payroll system integration.