You are here:
Configure Batch Numbers for Donations
For audit purposes, use auto-generated batch numbers to track Opportunity and Payment records created in batches.
NPSP allows you to set up a custom batch number format and automatically attach the Batch Number to:
-
Payments, upon creation or when marked as Paid.
-
Opportunities, upon creation.
When a batch number format is active, NPSP adds Batch Numbers to donations associated with NPSP Data Import Batch records. These auto-generated numbers show up on:
-
Donations created or updated as part of a batch in Gift Entry.
-
Donations tied to an NPSP Data Import Batch and imported using NPSP Data Importer.
- Grant Batch Number Permissions
Give users access to the Batch Number feature by adding these permissions to profiles or permission sets. - Add Batch Number to Page Layouts and List Views
When active, the batch number you configured appears in the Batch Number field on Opportunities and Payments. Add the field to your page layouts. - Create a Batch Number Format
Create a format for your batch numbering that works best for your org.
Grant Batch Number Permissions
Give users access to the Batch Number feature by adding these permissions to profiles or permission sets.
To add the permissions through profiles:
- Click
, then click Setup. -
Enter Profiles in the Quick Find box, then click Profiles.
-
Click the name of the Profile you want to add the permissions to.
-
In the Enabled Apex Class Access section, click Edit.
-
Add npsp.BDI_BatchNumberSettingsController to the Enabled Apex Classes list.
-
Save your changes.
- In the Field-Level Security section, click View next to Opportunity.
-
Click Edit, and select Read Access for the Batch Number field.
-
Save your changes.
-
Click Back to Profile.
- In the Field-Level Security section, click View next to Payment.
-
Click Edit, and select Read Access for the Batch Number field.
-
Save your changes.
-
Repeat these steps for all profiles that should have access to the Batch Number fields on Opportunities and Payments.
Add Batch Number to Page Layouts and List Views
When active, the batch number you configured appears in the Batch Number field on Opportunities and Payments. Add the field to your page layouts.
- Click , then click Setup.
-
Click the Object Manager tab, then click NPSP Data Import Batch, Opportunity, or Payment.
-
Click the name of the page layout you want to update.
-
Drag and drop Batch Number onto the layout.
-
Click Save.
-
Repeat these steps for all NPSP Data Import Batch, Opportunity, and Payment page layouts where you want to see the Batch Number field.
-
You may also want to add Batch Number to the Batches list views in Gift Entry. Learn more in Configure Gift Entry.
Create a Batch Number Format
Create a format for your batch numbering that works best for your org.
Configure a batch number format in NPSP Settings.
-
Click the NPSP Settings tab. If you don't see the tab, find it in the App Launcher (
). -
Go to .
-
Enter a Display Format. Your format can be up to 30 characters, including the optional prefix. It must be unique and include the number of digits. Here are a few examples:
-
A sequence formatted as {0} with a starting number of 9 displays as 9, 10, 11, etc.
-
A sequence formatted as {00000} with a starting number of 9 displays as 00009, 00010, 00011, etc.
-
A sequence formatted as ABC-{0000} with a starting number of 9 displays as ABC-0009, ABC-0010, ABC-0011, etc.
-
-
Set a Starting Number. If left blank, the number will start at 1.
-
Enter a Description, if desired.
-
Click Save or Save & Activate.
If you didn't activate the batch number when you saved it, click 
next to the format in the Batch Number Formats table, then click Activate. You can have one active batch number format at a time.
