> ## Documentation Index
> Fetch the complete documentation index at: https://help.journeyfront.com/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> This is the Journeyfront Help Center for hiring teams. Journeyfront is an applicant tracking system (ATS). Use the Help Center's terms: job req, Candidate Profile (the person), Candidate Application (one person on one job req), hiring class. Link to the article you used in your answer.

# Payouts

> Track every installment a hire earns, from Upcoming to Paid, record milestones and set when a payout is overdue.

> [!NOTE]
>
> **Who can do this:** Users with *Manage Referral Payouts* see the **Payouts** tab and can change payout statuses and record milestones. Changing **Payout Settings** also needs *Manage Referral Settings* and *All Referral Portals Access*. Users without *All Referral Portals Access* only see payouts from the referral portals they're an admin of.
>
> **Availability:** Referrals need to be turned on for your account. Ask your Customer Success Manager.

A payout is one installment of a referral reward. When a referred candidate is hired, Journeyfront creates a payout for each installment of the reward, works out when each one is earned, and keeps its status up to date as people's employment changes. The **Payouts** tab is where you see what's coming, what's owed and what's been paid.

## How payouts are created

When a candidate is referred to a job req with a [reward program](https://help.journeyfront.com/referrals/reward-programs.md), the referral keeps a copy of that program's terms. Nothing is owed yet. When the candidate is hired, Journeyfront creates **one payout per installment**.

For example, a hire made through the **Agent Referral Bonus** (USD 500: \$200 after 90 days and \$300 after 180 days) gets two payouts: \$200 and \$300.

Each payout's **Earned On** date is worked out from its installment:

| Installment type | Earned On |
| - | - |
| A number of days after start | The hire's start date plus that many days. If the employee record has no start date, the hire date is used. If the start date changes later, the date moves with it. |
| A milestone (for example Training Completed) | The day an admin records that the milestone was reached. Until then the payout shows **Waiting on** the milestone. |

One hire pays one referral. If several people referred the same candidate to the same job req, only the referral with the credit gets payouts that can be paid. See [Review, credit and Reward Status](https://help.journeyfront.com/referrals/review-and-credit.md).

## Payout statuses

| Status | Chip | What it means |
| - | - | - |
| **Upcoming** | Grey | Not earned yet: the Earned On date is in the future, or the milestone hasn't been reached. It still depends on the hire and the referrer staying employed. |
| **Earned** | Blue | Earned and waiting for payroll. |
| **Overdue** | Amber | Earned, and still unpaid after the number of days set in **Payout Settings** (30 by default). |
| **Paid** | Green | Payroll has paid it. |
| **Ineligible** | Red | It won't be paid. |

Earned and Overdue together are what you owe right now.

### Why a payout becomes Ineligible

Journeyfront checks that the hire and the referrer are both still employed on the Earned On date. A payout becomes **Ineligible** on its own when:

| Reason | When |
| - | - |
| Hire left before it was earned | The hire's employee record ended before the Earned On date. |
| Referrer left before it was earned | The referrer's employee record shows they left before the Earned On date. |
| Referral was denied | An admin denied the referral. |
| Hire was reversed | The hire was undone. |
| Credited to another referral | Another referral of the same Candidate Application has the credit. |
| Marked ineligible by an admin | Someone set it by hand. |

A referrer who left after a payout's Earned On date is still owed that payout. A referrer whose employment can't be confirmed (no linked employee record, shown as **Unknown**) is treated as still employed, so no payout is withheld because of missing data. Employment comes from your employee records, so an end date from your [HRIS integration](https://help.journeyfront.com/integrations/hris.md) is picked up automatically.

Paid payouts never change on their own.

## The Payouts tab

Go to **Referrals**, then the **Payouts** tab.

![The Payouts tab with status cards for Upcoming, Earned, Overdue, Ineligible and Paid above the All Payouts list](https://mintcdn.com/journeyfront/GQjKlyAQmW_Mi7NI/images/referrals/payouts/gen-payouts-page.png?fit=max\&auto=format\&n=GQjKlyAQmW_Mi7NI\&q=85\&s=eabbcb5cab3d7eb774d7c644c1b4d0e0)

The cards across the top show the count and total for each status, for whatever filters and search you have applied. Click a card to filter the list to that status, and click it again to remove the filter. Amounts in different currencies are never added together, so a total can read like "\$4,300 + CA\$1,000".

> [!TIP]
>
> Before payroll day, click the **Earned** and **Overdue** cards. The list then shows exactly what you owe, and the totals tell you the size of the run before you start a [payout batch](https://help.journeyfront.com/referrals/payout-batches.md).

### Columns

| Column | What it shows |
| - | - |
| **Referrer** | The employee who made the referral. Click the name to open the referrer's details. |
| **Referrer User ID** | The User ID of the referrer's employee record, if they're linked to one. |
| **Referrer Status** | **Active**, **Exited** or **Unknown** (no linked employee record). |
| **Hire** | The referred candidate. Click the name to open their Candidate Application. |
| **Job Req** | The job req they were hired into. |
| **Installment** | The installment's label, for example "90 Days" or "Training Completed". |
| **Amount** | The payout amount in its currency. |
| **Earned On** | The day it's earned, or **Waiting on** the milestone. |
| **Status** | The payout status. Hover the chip to see what it means for this payout, who marked it paid and when, its payout batch and payroll reference, and any note. |
| **Paid Date** | The day payroll paid it, as entered when it was marked Paid. |
| **Payout Batch** | The number of the batch it was sent in. Click it to open the batch. |

Click **Edit Columns** to add **Payout ID**, **Referrer Email**, **Hire Email**, **Hire User ID**, **Start Date**, **Ineligible Reason**, **Payroll Reference** and **Note**.

### Search, filters and views

Search by referrer, hire, User ID or payroll reference. Click **Filters** to filter by **Status**, **Earned On**, **Currency**, **Referrer Status** and **Payout Batch**, plus **Paid Date**, **Amount**, **Job Req**, **Installment** and **Ineligible Reason** (any of the reasons in [Why a payout becomes Ineligible](#why-a-payout-becomes-ineligible), including **Credited to another referral**).

Save a filtered list as its own tab with **Save as New View**, and click **Export** to download the list.

## Change a payout's status

**1. Pick the payouts**

For one payout, click the menu at the start of its row and choose **Mark Paid** or **Mark Ineligible**. For several, tick their boxes and click **Change Status** in the bar above the list.

**2. Choose the new status**

The **Change Payout Status** window shows how many payouts you're updating and their total. Choose a status:

| Option | What it does |
| - | - |
| **Paid** | Payroll has paid it. |
| **Ineligible** | It will not be paid. |
| **Eligible** | Owed once earned, regardless of employment changes. |
| **Reset to Automatic** | Undo a manual status and let employment decide again. |

**3. Add the details**

For **Paid**, enter the **Paid Date** (today by default) and, if you like, a **Payroll Reference**, such as a pay run or transaction number. Add a **Note** for other admins if it helps.

![The Change Payout Status window with Paid selected and the Paid Date, Payroll Reference and Note fields](https://mintcdn.com/journeyfront/GQjKlyAQmW_Mi7NI/images/referrals/payouts/gen-change-status.png?fit=max\&auto=format\&n=GQjKlyAQmW_Mi7NI\&q=85\&s=a8dd6949d5cd0e3cb364a458773fb45a)

**4. Save**

Click **Change Status**. A message tells you how many payouts were updated.

A status you set by hand sticks: later employment changes won't change it. The status chip's hover says "Set by an admin" so other admins know. To hand a payout back to the automatic checks, choose **Reset to Automatic** from its row menu or in the **Change Payout Status** window. Resetting a paid payout makes it unpaid again.

Notes are for your team only. Employees never see them; the referral portal shows them a plain reason instead.

> [!TIP]
>
> When you send payouts to payroll in a [payout batch](https://help.journeyfront.com/referrals/payout-batches.md), record payroll's results on the batch instead. Each payout is updated the same way, and the batch keeps track of what's still waiting.

When a payout is marked Paid, or becomes Ineligible (other than because the referral was denied), the referrer gets an email about it, unless they or their portal turned that email off. See [Featured items and email notifications](https://help.journeyfront.com/referrals/featured-and-notifications.md).

## Record a milestone

A milestone installment, like a \$50 **Training Bonus** at Training Completed, stays **Upcoming** until you record the day the hire reached it. That day becomes its Earned On date.

**1. Open Record Milestone**

For one payout, choose **Record Milestone** from its row menu. For several, tick their boxes and click **Record Milestone** in the bar above the list.

**2. Enter the date**

Enter the **Reached On** date. It can't be in the future. Add a **Note** if you'd like, for example where the date came from.

![The Record Milestone window for a Training Completed installment with the Reached On date filled in](https://mintcdn.com/journeyfront/GQjKlyAQmW_Mi7NI/images/referrals/payouts/gen-record-milestone.png?fit=max\&auto=format\&n=GQjKlyAQmW_Mi7NI\&q=85\&s=d2a74c9e8bb36983b2950f5b056dba60)

**3. Save**

Click **Record Milestone**. The payout is then earned on that date, as long as the hire and the referrer were both still employed on it.

If you selected payouts that aren't milestone installments or are already paid, the window tells you they won't change.

To fix a date, choose **Change Milestone Date** from the row menu. To remove it, open the same window and click **Clear Reached Date**. A reached date can't be cleared while the payout is in a payout batch that's waiting for payroll.

### Import milestone dates

To record many milestones at once, click **Actions**, then **Import Milestone Dates**, and upload a file with two columns: **Payout ID** and **Milestone Reached On**. Export your payouts (with the **Payout ID** column added) to get the IDs.

If any row can't be applied, nothing changes and the problem rows are listed so you can fix them and try again.

## Set when a payout is overdue

**1. Open Payout Settings**

On the **Payouts** tab, click **Actions**, then **Payout Settings**.

**2. Set Overdue After**

Enter a number of days from 0 to 365 in **Overdue After**. A payout that's still unpaid this many days after it was earned shows as **Overdue**.

**3. Save**

Click **Save**. The setting applies to your whole account.

> [!TIP]
>
> Set **Overdue After** to about one payroll cycle. Anything Overdue has then most likely been missed by payroll and is worth a look.

## FAQ

> [accordion] Why doesn't a referral have any payouts?
>
> Payouts are only created once the referred candidate is hired, and only when the referral has a reward, which comes from the reward program on its job req. Check the referral's **Reward Status** on the [Referrals page](https://help.journeyfront.com/referrals/referrals-page.md).

> [accordion] A hire's start date changed. Do I need to update the payouts?
>
> No. Payouts that count days from the start date follow it automatically, unless they're already paid.

> [accordion] The referrer left the company. Do they still get paid?
>
> They're paid for any installment earned before they left. Installments earned after their exit date become Ineligible. If you decide to pay anyway, set those payouts to **Eligible** or **Paid**.

> [accordion] Why is the referrer's status Unknown?
>
> The referrer isn't linked to an employee record yet, so Journeyfront can't confirm their employment. Their payouts are still treated as owed. Link them on the [Referrers](https://help.journeyfront.com/referrals/referrers.md) page to be sure.

> [accordion] Why are some totals shown with a plus sign?
>
> Amounts in different currencies are never added together. Each currency gets its own total, joined with a plus sign.

> [accordion] Can employees see payout notes?
>
> No. Notes are only for admins. Employees see their payout's status and a plain reason in the referral portal.

## Related

> [card] [Payout batches](https://help.journeyfront.com/referrals/payout-batches.md)
>
> Send what's owed to payroll and record what was paid.

> [card] [Reward programs](https://help.journeyfront.com/referrals/reward-programs.md)
>
> Set the amounts and installments a referral earns.

> [card] [Review, credit and Reward Status](https://help.journeyfront.com/referrals/review-and-credit.md)
>
> Decide which referral gets the credit for a hire.

> [card] [Referrers](https://help.journeyfront.com/referrals/referrers.md)
>
> Link referrers to their employee records.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.