> ## 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.

# Payout batches

> Send what is owed to payroll in a logged batch, then record what payroll paid.

> [!NOTE]
>
> **Who can do this:** Users with *Manage Referral Payouts*. 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 batch is a record of one payroll run: which owed payouts you sent, who sent them, and the file payroll received. Payroll still does the paying. When payroll reports back, you record the results on the batch, and each payout is updated for you.

Batches keep every payout from being paid twice or forgotten. A payout that's waiting in one batch can't go into another, and anything payroll didn't pay goes back into the pool for the next batch.

## Run a payout batch

**1. Choose what to include**

Go to **Referrals**, then the **Payouts** tab. Either filter the list (for example by **Currency** or **Job Req**), or tick the boxes of the payouts you want.

**2. Click Run Payout Batch**

With no rows ticked, click **Run Payout Batch** in the toolbar to use the list's filters. With rows ticked, click **Run Payout Batch** in the bar above the list.

**3. Name the batch and set Earned By**

Give the batch a **Name** if you like, for example "October 2026 payroll". If you leave it blank, it's called "Payout Batch" plus its number.

Set **Earned By** to your payroll cutoff. The batch includes payouts earned on or before this date. It starts as today.

**4. Review the payouts**

The **Payouts** list shows every payout the batch will include, with its referrer's status, the hire, the installment, the amount, the Earned On date and the payout status. **Includes** shows how many are included and the total per currency.

Untick any payout to leave it out of this batch.

![The Run Payout Batch window with the Name and Earned By fields, a warning about one unconfirmed referrer, and the list of payouts to include](https://mintcdn.com/journeyfront/GQjKlyAQmW_Mi7NI/images/referrals/payout-batches/gen-run-batch.png?fit=max\&auto=format\&n=GQjKlyAQmW_Mi7NI\&q=85\&s=812044ea6de678fff00f8b8e181b3148)

**5. Run it**

Click **Run Batch with** and the number of payouts. The batch is saved and its file downloads as a CSV for you to send to payroll.

> [!TIP]
>
> Read the yellow warning before you run. It counts payouts whose referrers can't be confirmed as still employed (**Exited** or **Unknown**). Hover a payout's status chip to see why it's still owed, for example a referrer who left after the payout was earned.

### What a batch includes

Only owed payouts (**Earned** or **Overdue**) go in a batch. A payout is left out when:

| Left out because | What to do |
| - | - |
| Already in a batch waiting for results | Record that batch's results first. |
| Its referral needs review | Review the referral on the [Referrals page](https://help.journeyfront.com/referrals/referrals-page.md). See [Review, credit and Reward Status](https://help.journeyfront.com/referrals/review-and-credit.md). |
| Not earned by the Earned By date | Wait, or move the **Earned By** date. |
| Milestone not reached yet | [Record the milestone](https://help.journeyfront.com/referrals/payouts.md#record-a-milestone) first. |
| Already paid, or Ineligible | Nothing. These are never sent. |

When you run a batch from the list's filters, the window counts the owed payouts it left out because they're already in a waiting batch or their referral needs review. When you run it from ticked rows, a **Left Out** list names each ticked payout that couldn't be included and the reason. A batch can hold up to 20,000 payouts.

## The batch file

The file payroll receives has one row per payout, with these columns:

| Column | What it holds |
| - | - |
| **Batch** | The batch number. |
| **Payout ID** | The ID that matches the row back to its payout. Keep it in the file. |
| **Referrer**, **Referrer Email** | Who to pay. |
| **Referrer User ID**, **Referrer External Employee ID** | The referrer's Journeyfront User ID and the employee ID from their employee record, so payroll can match its own records. |
| **Hire**, **Job Req** | The hire the reward is for. |
| **Installment**, **Amount**, **Currency**, **Earned On** | What's owed. |
| **Status**, **Paid Date**, **Payroll Reference**, **Note** | Left blank for payroll to fill in and send back. |

The file is saved exactly as it was run, so you can download it again later.

## The Payout Batches tab

Go to **Referrals**, then the **Payout Batches** tab, to see every batch your team has run.

![The Payout Batches tab listing batches with their Batch ID, Ran Date, Ran By, Earned By, Payouts, Total and Results](https://mintcdn.com/journeyfront/GQjKlyAQmW_Mi7NI/images/referrals/payout-batches/gen-batches-page.png?fit=max\&auto=format\&n=GQjKlyAQmW_Mi7NI\&q=85\&s=f819b3981f799af8763484f628b21e0f)

| Column | What it shows |
| - | - |
| **Batch** | The batch's name. Click it to open the batch. |
| **Batch ID** | A short ID for the batch. Click it to copy it. |
| **Ran Date** | When it was run. |
| **Ran By** | Who ran it. |
| **Earned By** | The cutoff date it was run with. |
| **Payouts** | How many payouts it holds. |
| **Total** | Its total, per currency. |
| **Results** | How many payouts have a result, for example "6 of 8 recorded", or **All Recorded** in green once nothing is waiting. |

Search by name, number, batch ID or who ran it, and filter by **Results** (**Waiting** or **All Recorded**), **Ran By**, **Ran Date** and **Earned By**.

## Record what payroll paid

Open a batch to see its details and its payouts. Each payout has a **Result**:

| Result | Chip | What it means |
| - | - | - |
| **Waiting** | Grey | Waiting for what payroll reports back. |
| **Paid** | Green | Payroll paid it. The payout is marked Paid. |
| **Not Paid** | Amber | Payroll didn't pay it this time. It stays owed and can go in the next payout batch. |
| **Ineligible** | Red | It won't be paid. The payout is marked Ineligible. |

A payout's result follows the payout itself, so if someone changes its status on the **Payouts** tab, the batch shows it too.

### Record results by hand

**1. Pick the payouts**

Open the batch. To record the same result for everything still waiting, leave the boxes unticked. To record some, tick the waiting payouts you want.

![An open payout batch with its details and two waiting payouts ticked, and the Record Selected as Paid button highlighted](https://mintcdn.com/journeyfront/GQjKlyAQmW_Mi7NI/images/referrals/payout-batches/gen-batch-details.png?fit=max\&auto=format\&n=GQjKlyAQmW_Mi7NI\&q=85\&s=db9270762687974d416ec213c5afb1bc)

**2. Choose the result**

Click **Record All as Paid**, **Record All as Not Paid** or **Record All as Ineligible**. With payouts ticked, the buttons read **Record Selected as** instead.

**3. Add the details**

For Paid, enter the **Paid Date** (today by default) and an optional **Payroll Reference**. For any result you can add a **Note**, for example why payroll didn't pay it. The note is saved on each payout, for admins only.

**4. Save**

Click the button at the bottom of the window to record the results.

### Upload the returned file

If payroll fills in the batch file and sends it back, upload it instead of recording each result.

**1. Open the batch**

Open the batch the file belongs to and click **Upload Payroll File**.

**2. Upload the file**

Upload the file. It needs a **Payout ID** and a **Status** column (Paid, Not Paid or Ineligible), and can include **Paid Date**, **Payroll Reference** and **Note**.

**3. Check the summary**

Journeyfront tells you how many payouts were recorded as Paid, Not Paid and Ineligible.

How each row is read:

| Status in the file | Result |
| - | - |
| Paid | Recorded as paid, with payroll's date and payroll reference. |
| Not Paid (or Not Processed, Unpaid) | Recorded as not paid. It stays owed for the next payout batch. |
| Ineligible (or Not Eligible) | Marked ineligible. |
| Blank | Keeps waiting. |

Every row must be a payout in this batch. If any row can't be applied, nothing changes and the problem rows are listed, so you can fix the file and upload it again.

> [!TIP]
>
> Ask payroll to send back the file you gave them, with only the **Status**, **Paid Date**, **Payroll Reference** and **Note** columns filled in. The **Payout ID** column is what matches each row, so it must stay as it was.

When payouts are recorded as Paid or Ineligible, referrers get 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).

## Rename or download a batch

In an open batch:

* Click the pencil next to the name to **Rename** it.
* Click **CSV** or **Excel** to download the batch file again.
* Click the **Batch ID** to copy it.

A batch is done when nothing in it is waiting. Its **Results** then read **All Recorded**.

## FAQ

> [accordion] Does running a batch pay anyone?
>
> No. Journeyfront records the batch and gives you its file. Your payroll team pays, and you record what they report back.

> [accordion] Why isn't a payout in my batch?
>
> It may not be owed by the **Earned By** date, its milestone may not be recorded, it may already be waiting in another batch, or its referral may need review. The Run Payout Batch window tells you how many were left out and why.

> [accordion] What happens to payouts payroll didn't pay?
>
> Record them as **Not Paid**. They stay owed and show up for the next batch.

> [accordion] Can I put the same payout in two batches?
>
> Not while it's waiting in one. Once it's recorded as Not Paid, it can go in a later batch.

> [accordion] Can I run a batch for one currency?
>
> Yes. Filter the **Payouts** tab by **Currency** before you click **Run Payout Batch**. Totals are always shown per currency.

> [accordion] Can I change a payout's result after recording it?
>
> Change the payout's status on the **Payouts** tab. The batch picks up the change.

## Related

> [card] [Payouts](https://help.journeyfront.com/referrals/payouts.md)
>
> See what's upcoming, owed and paid.

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

> [card] [Review, credit and Reward Status](https://help.journeyfront.com/referrals/review-and-credit.md)
>
> Clear referrals that need review.

> [card] [Permissions and portal admins](https://help.journeyfront.com/referrals/permissions.md)
>
> Who can see and manage payouts.


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