Transfer Report

GET /api/v1/reports/transfer

Returns transfer transaction data grouped by category over time periods. This endpoint provides the same data as the Transfer Report in the web UI, which helps reconcile transfers between accounts.

Query Parameters

Example Request

curl -X GET "https://statements.finopsbricks.com/api/v1/reports/transfer?date_from=2024-01-01&date_to=2024-12-31&group_by=month&accounts=acc123,acc456" \
  -H "api-key: fob_stm_xxxxxxxxxxxx" \
  -H "api-secret: xxxxxxxxxxxxxxxx"

Response

{
  "data": {
    "period": {
      "date_from": "2024-01-01",
      "date_to": "2024-12-31",
      "group_by": "month"
    },
    "accounts": [
      {
        "id": "acc123",
        "name": "Business Checking",
        "category": "bank"
      },
      {
        "id": "acc456",
        "name": "Savings Account",
        "category": "bank"
      }
    ],
    "data": [
      {
        "category": "transfers",
        "2024-01": {
          "inflow": 5000.00,
          "outflow": 3000.00,
          "net": 2000.00,
          "transaction_count": 12
        },
        "2024-02": {
          "inflow": 7000.00,
          "outflow": 4000.00,
          "net": 3000.00,
          "transaction_count": 15
        }
      }
    ]
  }
}

Response Fields

period

accounts

Array of account objects included in the report (non-archived accounts).

data

Array of transfer data objects grouped by category.

Each period object contains:

Understanding Transfer Reports

Transfer reports show transactions categorized as "transfer" type, which represent money movement between your own accounts. Key use cases:

• Reconciliation: Verify that transfers between accounts are properly recorded
• Cash Movement: Track how money flows between different accounts
• Balance Verification: Ensure transfer inflows match transfer outflows across accounts

For proper reconciliation, transfer inflows should equal transfer outflows across all accounts (net should approach zero when summed).

Filtering Options

Special Values

• entity='empty': Filters for transactions with null or empty entity field
• category='empty': Filters for transactions with null or empty category field

Partial Matching

The particulars, entity, and category filters use case-insensitive partial matching:

• particulars=payment matches "Monthly Payment", "PAYMENT RECEIVED", "Prepayment"
• entity=acme matches "Acme Corp", "ACME Inc", "Acme Holdings"

Account Filtering

Pass comma-separated account IDs to filter transactions:

• accounts=acc123 - Single account
• accounts=acc123,acc456,acc789 - Multiple accounts

Errors