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

# Reporting

## Overview

Reporting is where every payment, refund, void, capture, and adjustment in Ecrypt is auditable. The module gives you three lenses on your data: a flat **All Transactions** ledger for any date range, a **Batches** view that groups transactions by daily settlement, and a **Create/View Report** workflow for building, saving, exporting, and re-running custom column reports. Clicking any transaction anywhere in the module opens the same Transaction Detail panel used elsewhere in the dashboard, with full payment data and contextual actions.

## Navigation

Open **Reporting** in the left sidebar to reveal three sub-pages:

| Sub-page           | URL                            | Purpose                                                               |
| ------------------ | ------------------------------ | --------------------------------------------------------------------- |
| All Transactions   | `/reporting/all-transactions`  | Flat ledger of every transaction in a date range                      |
| Batches            | `/reporting/batches`           | List of daily settlement batches, drilldown to per-batch transactions |
| Create/View Report | `?actions=view-report` (modal) | Saved custom-column reports + new report builder                      |

***

## Transactions

A flat, filterable list of every transaction across every channel (Credit Card, Check, Subscriptions, Invoices, Hosted Payments — anything that produced a transaction record).

### Filter By

A pinned **Transaction Date range** chip applies a default 7-day window. Click **FILTERS** to open the Table Filters panel:

| Field       | Notes                                                                            |
| ----------- | -------------------------------------------------------------------------------- |
| Filter By   | Column to filter on (Transaction Date, Amount, Status, Customer, ID, Type, etc.) |
| Filter Type | Match mode — Range, Equals, Contains, etc. — depends on the chosen field         |
| Value       | Range picker for dates/amounts; free text for IDs/customers                      |

Click **+ ADD FILTER** to stack multiple filters and **APPLY FILTERS** to run them. **CLEAR FILTERS** removes everything (including the default date chip).

### Columns

| Column           | Notes                                             |
| ---------------- | ------------------------------------------------- |
| ID               | Transaction ID (numeric)                          |
| Transaction Date | Date and time                                     |
| Amount           | Dollar amount; negative for refunds               |
| Type             | Sale / Refund / Auth / Credit / Void              |
| Account Data     | Masked PAN or ACH identifier with card-brand icon |
| Customer         | Customer name (uppercase if not in Vault)         |
| Status           | Approved / Declined / Settled                     |

Click any row to open the **Transaction Detail Panel**.

***

## Transaction Detail Panel

The same right-side slide-over used in Subscriptions and Invoices. The exact actions available depend on whether the transaction belongs to a subscription and whether the cardholder is already a Vault customer.

### Header

* Status badge (e.g. **APPROVED**)
* Transaction timestamp
* **MERCHANT** — which merchant account ran the charge
* **INITIATED BY** — channel (API KEY, dashboard user, etc.)
* **Transaction #** — the transaction ID
* *(If subscription)* **BILLED \[cycle]** chip, **NEXT PAYMENT DATE** chip, **Subscription ID**

### Info Row Chips

* **RESPONSE** (Approved / Declined)
* **APPROVAL CODE**
* **CURRENCY**
* **ENTRY MODE** (Keyed / Swiped / etc.)

### Card Visual

Cardholder name, charge amount, masked card or ACH, expiration, brand logo.

### Body

* **Billing Address** / **Shipping Address**
* **More Info** — Subtotal, Tax, Surcharge, AVS Status, CVV Status (with info-icon explanations)
* **Subscription Info** *(subscriptions only)* — Billing Cycle, Installments, Send Receipts
* **Order information** — line items if captured

### Left Panel — MENU

* **Payment Information** (default view)
* **Transaction History** — shows the linked chain of this transaction (e.g. Sale → Refund)

### Left Panel — ACTIONS

The list adapts to the transaction:

| Action                | When it appears           | Effect                                       |
| --------------------- | ------------------------- | -------------------------------------------- |
| Void Transaction      | Unsettled transactions    | Cancels before settlement                    |
| View Receipt          | Always                    | Opens customer-facing receipt                |
| Charge Again          | Always                    | Re-runs the charge on the same card          |
| View Customer         | Customer already in Vault | Jumps to the Vault record                    |
| Add to customer vault | Customer not yet in Vault | Saves payment method to a new Vault customer |

### Left Panel — ACTIONS FOR SUBSCRIPTIONS

Appears only for transactions that belong to a subscription: Subscription History, Pay Early, Cancel Subscription, Pause Subscription, Edit Subscription. See the Subscriptions guide for details.

***

## Batches

A list of daily settlement batches. Each batch corresponds to a settlement cutoff (typically nightly at the processor's batch time).

### Columns

| Column          | Notes                                              |
| --------------- | -------------------------------------------------- |
| ID              | Internal batch record ID                           |
| Settlement Date | Cutoff date and time of the batch                  |
| Batch Number    | Processor-assigned batch number                    |
| Sales           | Count of successful sale transactions in the batch |
| Gross Amount    | Sum of sale amounts before refunds                 |
| Refunds         | Count of refunds in the batch                      |
| Voids           | Count of voids in the batch                        |
| Refund Amount   | Sum of refund amounts (positive number)            |
| Net             | Gross minus refunds = the net deposit              |

Click **FILTERS** to filter by any of the columns.

### Batch Drilldown

Click the **Batch Number** in any row (or the row itself) to open `/reporting/batch?batch=[number]` which lists every transaction inside that batch in the same table format as All Transactions. The page has:

* **← GO BACK TO BATCHES** breadcrumb
* **Batch #\[number]** title
* The transactions table with Status column showing **Settled** instead of Approved
* Click any row to open the same Transaction Detail Panel

> **Tip:** Use Batches to reconcile against bank deposits — the Net column corresponds 1:1 to the ACH funding deposit you'll see in your bank account, usually 1–2 business days after Settlement Date.

***

## Create/View Reports

Opens the **View Reporting** modal — the entry point for both running existing saved reports and building new ones.

### View Reporting (run an existing report)

| Element            | Notes                                                              |
| ------------------ | ------------------------------------------------------------------ |
| Search bar         | Filter the saved-report list by name                               |
| Saved reports list | Radio-select from the named reports already saved on this merchant |
| Date Range         | Date window to apply when running the report                       |
| View Report        | Runs the selected report in-app on the chosen date range           |
| Export Report      | Downloads the selected report as a file (CSV/Excel)                |
| Edit report        | Re-opens the field/name editor for the selected report             |

Below the controls: **OR → Create A New Report** opens the New Report builder.

### View Report output

A standard table page titled **Reporting - \[report name]** containing only the columns selected when the report was built. The page includes:

* **← GO BACK TO REPORTING LIST** breadcrumb
* **Export to report** button (top-right) to download
* Standard pagination footer

### New Report builder

| Field                       | Required     | Notes                                                      |
| --------------------------- | ------------ | ---------------------------------------------------------- |
| Search for available fields | No           | Filters the field checklist below                          |
| All                         | No           | Master checkbox that toggles every field                   |
| Field checkboxes            | At least one | Pick which columns the report includes                     |
| Report Name                 | Yes          | Label used to find the report later                        |
| SAVE                        | —            | Persists the report; it appears in the View Reporting list |
| CANCEL                      | —            | Discards without saving                                    |

#### Available Fields

The field list spans every aspect of a transaction:

**Identifiers** — Transaction Id, Merchant, Settlement Id, Settlement Number, Action

**Status / payment method** — Status, Tender Type, Entry Mode, Payment Name, Payment Network, Payment Account, Payment Account Expiration

**Amounts** — Amount, Authorization Amount, Captured Amount, Date Captured, Settled Amount, Date Settled, Voided Amount, Date Voided

**Verification** — Authorization Code, AVS Response Code, AVS Response Text, CVV Response Code, CVV Response Text, Enhanced Data Qualified

**Source** — Terminal Id, Terminal Label, Initiated by Username

**Order data** — Order Id, Order Discount, Order Surcharge, Order Shipping, Order Tip, Order Tax, Order Total

**Customer** — Customer Id, Customer Merchant Id, Customer First Name, Customer Last Name, Customer Company, Customer Phone Number, Customer Email Address

**Billing address** — Billing Address Line 1, Line 2, City, State, Postal Code, Country

**Shipping address** — Shipping Address Name, Line 1, Line 2, City, State, Postal Code, Country

**Order metadata** — `OrderMetadata` plus any custom merchant-defined fields (prefixed `[*]` in the list, e.g. `[*] Dock Number`, `[*] Slip #`, `[*] Notes`, `[*] In-Person`, `[*] Invoice#`)

> **Note:** The `[*]` custom fields are defined per merchant. The ones visible to you reflect this merchant's configuration and will differ for other accounts.

***

## Tips & Best Practices

**Use All Transactions for ad-hoc lookups; use saved reports for repeating workflows.** If you find yourself filtering the same way every Monday morning, save it as a report so you can re-run it with one click and a fresh date range.

**Reconcile against Batches, not All Transactions.** Bank deposits land on a settlement cadence. Use the Batches page's **Net** column to reconcile what hit your bank — All Transactions includes voids and pending charges that may never settle.

**Stack filters instead of exporting and slicing.** The **+ ADD FILTER** button lets you AND multiple conditions (e.g. *Status = Declined* AND *Amount > \$100* AND *Transaction Date in last 7 days*). This is usually faster than exporting to Excel.

**Name reports with intent, not content.** "Weekly settlement reconciliation" outlasts "Sale + Refund + Amount" because the second describes columns that may change, while the first describes the job-to-be-done.

**Export Report uses the currently selected Date Range.** It does *not* use whatever date range you last used in All Transactions. Pick the date range in the View Reporting modal before clicking Export.

**Transaction History on the detail panel is the audit trail.** When investigating a disputed transaction, open it and switch from Payment Information to Transaction History — every linked action (auth, capture, void, refund) shows in order with timestamps.

**"Add to customer vault" turns one-off transactions into reusable customers.** When a card runs through POS/KEY but the cardholder isn't a Vault customer yet, you can retroactively save them straight from the transaction detail panel without re-entering data.

**Custom `[*]` fields are powerful for industry-specific reporting.** If you have order metadata like Dock Number, Invoice#, or Slip # configured, include them in saved reports for operations or accounting teams who think in those terms.

**Batches lists all batches in reverse chronological order.** The default view shows the last 10 — paginate or filter by Settlement Date to find a specific batch when you have a date in mind from your bank.