The royalty payments report allows franchisors to export a list of payments received (by payment date) across all of their locations.
Running the report
Note: this feature is only available to Franchisors (parent franchise orgs).
Your Royalty payments report will live on your reporting tab. Click into the report tab in your top navigation bar, and then Royalty payments on the left side of the page.
Once on the page, you can select the date range for the report. The date range that you select filters the data in the report export based on the payment date. You can select up to one month of payments at a time. If you'd like to include today in the data pull, be sure to set your date range to end tomorrow.
You can also adjust which locations to pull the payments data for. By default, all locations will be considered in the report. Adjust the locations filter if you'd like to pull a subset of locations only.
Viewing the report output
After you click GENERATE REPORT an export of the data will be sent via email to the email address associated with your account. This may take up to an hour based on the size of the data being pull.
The email will include two files:
Summary file
The summary file displays the sum of payments received by payment type, by child org.
Fields in the summary file:
Child org name: the name of the location associated with the payments. If you receive payments in your parent account, the parent account name will show here.
Payment type: the method of payment used by the child org.
Revenue: sum of the payment value associated with the payment type.
Invoice count: count of the invoices associated with the payment type.
Payment details file
The payment details file displays each of the payments received by your child accounts for the time period specified. This file allows you to view all of the details behind the summary file.
Fields in the details file:
Parent franchise ID: the unique ID associated with your parent organization. Will be blank if the payment line is associated with your parent org.
Child Org ID: the unique ID associated with the child organization that collected the payment.
Child Org Name: the name of the child organization that collected the payment.
Job ID: the unique ID associated with the job that payment was collected against. Note that the same Job ID may be repeated in the file if multiple payments were collected on the job.
Payment Received Date: the date and time that the payment was received by the child organization.
Job Created Date: the date and time that the job was created that payment was collected against.
Job Completed Date: the date and time that the job was completed that payment was collected against. If the job hasn't been completed yet, this field will be blank.
Customer ID: the unique ID associated with the customer that made the payment.
Customer Name: the name of the customer that made the payment.
Invoice Number: the invoice number associated with the payment collected. Note that the same invoice number may be repeated in the file if multiple payments were collected on the job.
Job Duration: the total job time (from on my way to finish) of the job. Will be blank if no time was tracked on the job.
Job Description: the description of the first line item on the job.
Invoice Payment: the status of the total invoice balance. If the invoice is completely paid, it will show as paid.
Assigned Employee Name: name of the employee assigned to the job. If multiple employees are assigned, the first will show.
Job Status: the status of the job that is associated with the payment.
Payment Amount: the total amount of the payment received. Includes taxes and tips.
Payment Type: the type of payment method that was used.
Job Location Longitude: longitude associated with the address of the job.
Job Location Latitude: latitude associated with the address of the job.
Job Location Zip Code: zip code associated with the address of the job.