Batch Format
A batch is a ZIP file containing one or more TIFF images and a single CSV index file. The CSV describes the mail items and their associated transactions. Each TIFF file in the ZIP must have a corresponding row in the CSV, and vice versa.
Also see: Mail Uploads | Rescans | Provisioning
Mail Item Types
Mail items are classified into one of the following types:
- White Mail. Mail items with no check or grant data.
- Donor Advised Fund (DAF) Check. Mail items with a check from a Donor Advised Fund. This will typically also include grant data.
- Other Check. Mail items with a check from a non-DAF source.
ZIP Structure
A batch ZIP should contain one CSV index file and one TIFF file per mail item. The TIFF filenames should correspond to the mail_item_id values in the CSV.
In this example, the CSV would contain rows with mail_item_id values mail_a1b2c3, mail_d4e5f6, and mail_g7h8i9. If a mail item has multiple transactions, only one TIFF file is needed — the mail_item_id is repeated across CSV rows but maps to a single image.
Validation Rules
- The ZIP must contain exactly one CSV file and one or more TIFF files
- Every TIFF file must have a corresponding
mail_item_idrow in the CSV - Every
mail_item_idin the CSV must have a corresponding TIFF file in the ZIP
A mail item may have multiple transactions. In this case, use the same
mail_item_id for all rows belonging to that mail item.
CSV Structure
The CSV index file has the following columns, listed in the order they should appear. They are grouped into three categories: mail item info, payment info, and transaction info. Note that column requirement indicates that the mail item cannot be processed if the column is missing.
Mail Item Info
Required for all mail items.
Payment Info
Required for all mail items that contain a check.
Transaction Info
Required for DAF checks.
Note that a DAF check may be associated with multiple grants (or “transactions”). In this case, the CSV should contain a row for each grant, sharing the same mail_item_id and check information.
Example
A mail item has a $180.00 check from DAFgiving360. The grant letter includes two grants: $100.00 from John Doe for general operating support, and $80.00 from Jane Smith for program support. The CSV should contain two rows:
