Reports

The following endpoints allow you to get various tip reports for businesses. These endpoints can be used with any product.

v1/reports/payroll-run#

Returns a payroll run report for the business whose account token is passed in the request.

Request body structure (TS notation)

interface GetPayrollRunRequest {
  appId: string; // Your app ID
  appSecret: string; // Your app secret
  accountToken: string; // The account token for the business whose payroll run report we want to get
  payload: {
    fromDate: string; // The start date for the payroll run, in ISO8601 format
    toDate: string; // The end date for the payroll run, in ISO8601 format
    locationId?: number; // Optional location id
  }
}

Response body structure (TS notation)

interface PayrollRunReport {
  data: { // An array of objects, each representing one staff member on a location
    employeeId: string; // Unique identifier for the staff member
    firstName: string;
    lastName: string;
    locationId: number; // Id of location
    location: string; // Name of the location
    totalCardTips: number; // Total amount of tips received via card
    totalCashTips: number; // Total amount of tips received via cash
    totalTips: number; // Total amount of tips
  }[]
}