Overview
Payroll provides users with a summary of their financial earnings and access to historical earning records directly within the mobile app. You can configure the display to be detailed financial breakdowns or high-level summaries, depending on what you want your users want to see.
How It Works
The mobile app relies on your Payroll web service to populate the payroll interface with driver-specific data.
Display Options
You have two distinct options for displaying payroll within the mobile app:
Configure with the Menu
You configure the payroll feature as an item within the mobile app Menu
Users navigate to the Menu and select the payroll option to view payroll data
NOTE: We recommend displaying Payroll within the Menu for users sharing vehicles or operating as team users. Keeping Payroll within a Menu protects financial privacy by removing sensitive data from the main screen.
For more information refer to our Menus Guide.
Configure with a Dashboard Card
You define the payroll card dynamically within your authentication API response
You cannot add the payroll card via App Manager
Data Presentation
The mobile app automatically formats and displays the exact payroll information you provide via the API.
You dictate the specific values and amounts visible to the user. e.g., miles, dollars, order numbers, dates, etc.
You customize the level of detail displayed by adjusting your API responses
The mobile app updates the interface automatically when you send new data
IMPORTANT: You must verify your JSON properties match the expected platform schema to prevent display errors