Overview

Manage driver pay items and pay stubs.

Pay stubs are for companies to track and communicate employee expenses. Rose Rocket pay stubs are created by collecting payroll financial line items onto a pay stub.

These objects are in the Payroll module along with pay items. Pay items are added as costs on manifests for the driver. The pay stub is a consolidation of any driver pay items and acts as the equivalent of a bill for the driver.

Under the Payroll section, view the Driver pay items board for all costs for the driver. Select the specific driver’s pay items and then select the Create pay stub button.

Visible financial line items are in the workInProgress status with the destination of payStub. After adding these to a pay stub, the status updates to booked and the item is removed from pay items.

NOTE: User pay items can only be from the same driver on a single pay stub. Rose Rocket doesn’t support multiple drivers on a single pay stub.

Pay and deduction attributes

Pay stubs include the pay items from the manifest as the subtotal amount. Pay items not attached to a manifest are categorized as Other pay and deductions. The total pay represents the subtotal combined with the Other pay and deductions category.

API configuration

When using the API to make requests, see the pages below for the process. These guides walk through the requirements and setup to access the Rose Rocket API with your application.

Authentication - Access Rose Rocket with OAuth 2.0
Object operations - Configure your requests

Object structure

Use the table below for information about the pay stub objects.

Fields	Label	Type	Description
id	ID	string	Global unique identifier for record
fullId	Full ID	string	Full ID of pay stub, identifies record as seen by user
status	Status	string, enumerated	Status of pay stub, valid values: `created`, `approved`, `followUpNeeded`, `sent`, `paid`, `archived` NOTE: Defaults to `created`.
user	User	User connected object *See Connected object section	Driver on pay stub
lineItems	Line Items	FinancialLineItem connected object array *See Connected object section	Details items user is paid for
documents	Documents	Document connected object *See Connected object section	Documents attached to pay stub
payPeriodStartDate	Pay Period Start Date	date	Start of pay period as beginning of period employee worked or earned wages
payPeriodEndDate	Pay Period End Date	date	End of pay period as end of period employees worked or earned wages
payDate	Pay Date	date	Date payment is made, date employees are paid
approvedAt	Approved At	date	Date pay stub was approved
approvedBy	Approved By	string	User approving pay stub
notes	Notes	string	Notes about pay stub
sentAt	Sent At	date	Date pay stub sent to receiving party, such as by email
otherPayAndDeductions	Other Pay and Deductions	float	Returns total pre-tax of all line items on invoice without manifest associated NOTE: This field is derived from the lineItems attributes. *See Read-only fields.
subTotal	Sub Total	float	Returns total pre-tax of all line items on invoice before adjustments for other pay and deductions NOTE: This field is derived from the lineItems attribute. *See Read-only fields.
total	Total	float	Returns complete total of all line items on pay stub
manifest	Manifest	Manifest connected object *See Connected object section	Associated manifest to paystub