Fall '24 Revenova PayIQ Data Dictionary

Amount

Currency(10, 2)

When the Calculation Method is:

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

2. Percent Per Load with Min Amount - this is the minimum amount earned per Load.

3. Percent Per Load with Max Amount - this is the maximum amount earned per Load.

4. Percent of Margin Sliding Scale - this is the cap the margin climbs to.

Calculation Method

Picklist

The calculation used to determine pay amount for each pay detail. Values include: “Amount per Load,” “Percent of Margin,” “Percent per Load with Min Amount,” “Percent per Load with Max Amount,” “Percent of Margin Sliding Scale,” and “Percent of Revenue.” No default value.

Criteria

Picklist

The number used as the criteria for the pay bracket. Values include: “Margin,” “Margin %,” “Revenue,” and “Load Count.” 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 Load individually for a participant. Values include: “Aggregated Load Financials per period,” and “Individual Load Financials (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 Header

Lookup(Pay Header)

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

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.

Field API Name

Text(55)

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

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.

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 text value the filter checks against.

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 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. “Expected Delivery Date” is the default value.

Lookup Type

Picklist

The object type of the participant on the Load. Values include: “Contact,” and “User.” 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.

Contact

Lookup(Contact)

A lookup to the associated Contact record.

Effective Date

Date

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

Expiration Date

Date

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

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.

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: “Contact,” “Team,” and “User.” “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 associated User. (If participant is a user-type.)

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.

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.

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.

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.

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 this Pay Detail is for (if the participant is a contact).

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.

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.

Participant Name

Formula (Text)

A formula field that pulls the full name from the User or Contact this Pay Detail is for. This field also displays the type of user 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.

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).

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>

End Date

Formula (Date)

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

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 user or contact 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.

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.

Error Email

Email

An email address that unexpected errors are sent to. This email should be set to an internal Revenova email. Any emails sent to this address should be escalated as bug reports.

Generate Pay Batch Size

Integer

This field controls the batch size for the Generate Pay job. The default value is 200.

Log Currency Conversions

Checkbox

This field controls whether Currency Conversions are logged (only applicable to multi-currency orgs). The default value is “Checked.”

Log Governor Limits

Checkbox

This field controls whether Governor Limits are logged. The default value is “Unchecked.”

Log Math

Checkbox

This field controls whether Math is logged. The default value is “Checked.”

Log Performance

Checkbox

This field controls whether Performance is logged. The default value is “Unchecked.”

Log Qualification

Checkbox

This field controls whether Qualification (criteria met / not met) is logged. The default value is “Checked.”

Match Loads to Participants Batch Size

Integer

This field controls the batch size for the Match Loads to Participants job. The default value is 200.

Match Outside Transactions Batch Size

Integer

This field controls the batch size for the Match Outside Transactions job. The default value is 2000.

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.

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.

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.

Converted Margin (Invoiced)

Currency(16, 2)

The margin (invoiced) from the Load for performing aggregates. This value is converted to the org currency.

Converted Margin (Quoted)

Currency(16, 2)

The margin (quoted) from the Load for performing aggregates. This value is converted to the org currency.

Converted Revenue (Invoiced)

Currency(16, 2)

The revenue (invoiced) from the Load for performing aggregates. This value is converted to the org currency.

Converted Revenue (Quoted)

Currency(16, 2)

The revenue (quoted) from the Load for performing aggregates. This value is converted to the org currency.

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 PayIQ 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

Master-Detail(Load)

The Master-Detail relationship to the parent Load record the PayIQ 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.

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. Used by 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.

Number of Tiers

Roll-Up Summary (COUNT Calculation Tier)

A formula field that counts the number of tiers 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.

Payroll ID

Text(50)

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