Upload a CSV file to load many payments into a batch and import them in one step.
Introduction
Batch payments let you record many payments at once, such as a lockbox deposit or a day of mailed checks. Instead of entering each payment by hand, you upload a CSV file and BriteCore fills the batch table for you. Billing and accounting staff use this feature to save time and reduce data-entry errors.
How CSV Import Works
Uploading a file only fills the batch table. BriteCore posts no payments until you select Import Payments, so you can review and correct every row first.
When you import, BriteCore posts each row separately. A row with a problem, such as an unknown policy number, fails on its own and the other rows still post. Rows that need a decision, such as an underpayment, show Unresolved until you choose how to distribute the amount.
BriteCore dates every payment in the batch with the Transaction Date you enter when you start the batch. A date in the CSV file does not change the payment date. If the batch has no date, BriteCore uses the time of import.
Before You Begin
Confirm the following before you begin:
- The
enable-batch-paymentssetting in thepoliciessection is True, so Process Batch Payment appears on Daily Cash Receipt. - Your file is a
.csvfile that follows the rules in the Reference section. - The Transaction Date you plan to use is on or after the effective date of every policy in the file.
Upload and Import a Batch
- Go to Payments > Incoming > Daily Cash Receipt and select Process Batch Payment. If your site does not have a Payments module, go to Policies > Payments > Daily Cash Receipt instead.
- Select Start New Batch Payment.
- Enter a Title and a Transaction Date. The date defaults to today.
- Select Use invoice number to enter payments if your file identifies rows by invoice code.
- Enter Number of Entries (optional) and Amount (optional) if you want BriteCore to check that your entries add up.
- Select Start New Batch.
- Select Upload CSV file.
- In the File Upload dialog, select Choose File and pick your
.csvfile. - Select Process file.
- Review the rows in the table. Each row has the status Pending, and the row order can differ from the order in your file.
- Select Import Payments. Each row then shows OK or Unresolved.
When every row shows OK, BriteCore displays "Success, your batch was imported successfully!"
Note: Select Save progress for later to leave the batch and return to it, or Edit Batch Settings to change the Title or Transaction Date.
Resolve Underpayments
When the amount paid is less than the amount owed, the row shows Unresolved after import. Resolve it in the table, or set a distribution_action in your file so the row imports without a decision.
Resolve a row in the table
- Select Unresolved on the row.
- Read the message "You must resolve the amount paid for Policy No. … before it can be applied. How do you want to distribute this amount?"
- Choose Allow Underpayment, Equity Invoice, Change Billing Schedule Point Forward (preserve existing), or Change Billing Schedule For Term (regenerate).
- Select Import Payments again.
Resolve rows in the file
Enter one of the values in the following table in the distribution_action column. Use the value exactly as written, because BriteCore ignores a value that does not match.
| Value | What BriteCore does |
|---|---|
| Allow Underpayment | Applies the payment for the amount paid. |
| Equity Invoice | Applies the payment as an equity invoice, which requires that the policy has equity. |
| Carry Balance Forward | Carries the balance forward, which requires remaining installments. |
| Keep Credit and Apply to Future Balances | Keeps the credit and applies it to future balances. |
| Make Payment but Do Not Reinstate Policy | Applies the payment without reinstating the policy. |
| Change Billing Schedule Point Forward (preserve existing) | Moves the policy to the billing schedule in billing_schedule_id. |
| Change Billing Schedule For Term (regenerate) | Regenerates the term on the billing schedule in billing_schedule_id. |
Note: The resolution list in the table shows four of these values. The file accepts all seven.
Reference
Starter file
Start with this file and replace the sample row:
policy_number,paid_amount,payment_instrument,check_number POL-00001,250.00,Check,1001
File rules
BriteCore applies the following rules when you select Process file:
- The file is a
.csvfile. BriteCore rejects other types, such as.txt. - The file uses commas and has a header row.
- The columns can appear in any order, and each value lines up with its header.
- BriteCore rejects the whole file when a header is not in the Columns table.
- BriteCore rejects a file that contains only a header row.
- The file always includes the
policy_numbercolumn, even when you identify rows byinvoice_code.
Columns
| Column | Description |
|---|---|
policy_number |
The policy for the entry, or its account number if your site uses account numbers. |
paid_amount |
The payment amount, which defaults to the batch's default amount source (for example, Current Due) when blank. |
payment_instrument |
Money Order, Credit Card, Check, Cash, ACH, Lockbox, or None Provided. |
check_number |
The check number saved on the payment. |
invoice_code |
The invoice for the entry, in the format POL-00001-1. |
distribution_action |
How to handle an underpayment, as described in Resolve Underpayments. |
distribution_amount |
The amount to apply to the policy, if less than the amount paid. |
billing_schedule_id |
The ID of the target billing schedule, required with the two Change Billing Schedule actions. |
payor_id |
The contact ID of the payor, which BriteCore fills in from the policy's contacts when blank. |
entry_id |
A shared value that combines several rows into one entry for several policies. |
batch_datetime |
Accepted but ignored. The batch Transaction Date sets the payment date. |
Column details
Use the following details when a column needs more than one sentence:
-
payment_instrument: BriteCore records Check when you leave the column out. Enter one of the listed values in every row, because a blank or unrecognized value makes the row fail to import. -
invoice_code: Enter the policy number, a hyphen, and the invoice's sequence number, such asPOL-00001-4. The hyphen is a separator, not a minus sign. BriteCore numbers each invoice on a policy in the order it creates them, so the number can skip values when BriteCore replaces invoices. This column works only in a batch that uses Use invoice number to enter payments. -
distribution_amount: BriteCore does not apply the payment when this amount is less thanpaid_amount, and the row stays Unresolved. This column also requirespaid_amount. -
billing_schedule_id: Enter the schedule's ID, not its name. Without it, BriteCore creates the payment but does not apply it. You can get billing schedule IDs from the BriteCore API or from SQL Editor. -
payor_id: Enter a contact ID. BriteCore rejects the whole file when the value is not an ID. You can get contact IDs from the BriteCore API or from SQL Editor. -
entry_id: Enter any label you choose, such ascheck-1001, and repeat it on each row that belongs to the same payment. Rows that share a label must have the samepaid_amount, or BriteCore rejects the file.
Common errors
| Message | What to do |
|---|---|
| File type '.txt' is not allowed. | Save the file as a .csv file and upload it again. |
| The following disallowed keys were encountered in the file | Remove or rename the listed headers. |
| No payment entries were found in the file. | Add at least one data row below the header. |
| no preloaded data for policy number | Check the policy number, or the account number, in that row. |
| no preloaded data for invoice | Select Use invoice number to enter payments when you create the batch. |
| A payment method ID is required when making an electronic payment. | Enter a valid payment_instrument value in that row. |
| 'NoneType' object has no attribute 'id' | Set a Transaction Date on or after the policy's effective date. |