Sign in
Transactions

Get transaction totals

Returns the number and total amount of matching transactions in one currency.

get/transactions/stats

Request

  • Base URL: https://next-api.saturation.io/v1
  • URL: https://next-api.saturation.io/v1/transactions/stats
  • Auth: HTTP bearer

Query parameters

projectIdstring

Project ID or slug. Use none for unassigned transactions.

source'manual' | 'plaid' | 'saturation_pay' | 'saturation_credit'

How the transaction entered Saturation. Financial fields are editable only for manual transactions.

Example:manual

Transaction source. Separate multiple values with commas.

typestring

Transaction type. Separate multiple values with commas.

status'unpaid' | 'pending' | 'posted' | 'void' | 'needs_review' | 'projected' | 'rejected'

Current transaction status. Available statuses vary by source.

Example:posted

Transaction status. Separate multiple values with commas.

isReversalboolean

Set to true for refunds and other reversals.

contactIdstring

A stable resource ID, such as prj_…, txn_…, or doc_….

Example:txn_8f2a1c9e

Only transactions for this contact.

budgetLineIdstring

A stable resource ID, such as prj_…, txn_…, or doc_….

Example:txn_8f2a1c9e

Only transactions coded to this budget line.

purchaseOrderIdstring

A stable resource ID, such as prj_…, txn_…, or doc_….

Example:txn_8f2a1c9e

Linked purchase order ID.

currencystring required

Three-letter currency code for the total.

dateFromstring date-time

Earliest transaction time, inclusive. Must be on or before dateTo.

dateTostring date-time

Latest transaction time, inclusive.

amountMininteger

Minimum amount, inclusive, in minor currency units.

amountMaxinteger

Maximum amount, inclusive, in minor currency units.

isItemizedboolean

Set to true for itemized transactions or false for transactions without items.

merchantstring

Merchant name. Matching is case-insensitive and partial.

hasDocumentsboolean

Set to true for transactions with documents or false for transactions without documents.

qstring

Search transaction descriptions.

Response

Totals for matching transactions.

totalinteger required

Number of matching transactions.

Example response

{
  "total": 142,
  "amount": {
    "amount": 152900,
    "currency": "USD"
  }
}

Changes

No operation changes recorded.