Skip to main content
GET
List Chart Transactions

Authorizations

Authorization
string
header
required

Token-based authentication with required prefix "Token"

Query Parameters

account
integer
account_id
integer
account_rollup
boolean
default:false
account_subtype
string
account_type
string
accounts
integer
aggregation_fields
string

Comma-separated aggregations, e.g. sum:amount,count:id

all_time
boolean
default:false

If true, uses full transaction date range for the customer; start_date and end_date are ignored

bank
integer
bank_description
string
bank_id
integer
categorized
string

Filter by categorization state (true/false)

credit_amount_equal
number<double>
credit_amount_gte
number<double>
credit_amount_lte
number<double>
credit_amount_null
boolean
default:false
currency
string
debit_amount_equal
number<double>
debit_amount_gte
number<double>
debit_amount_lte
number<double>
debit_amount_null
boolean
default:false
department
integer
department_id
integer
department_or_unassigned
boolean
default:false
download
boolean
default:false

If true, dispatch async CSV/Excel email export instead of returning rows

end_date
string<date>

Latest date (inclusive) for which to retrieve data. Defaults to end of current month

entity
integer
entity_id
integer
entity_rollup
boolean
default:false
exclude_entity
integer
exclude_entity_id
integer
exclude_id
integer
exclude_journal
integer
exclude_reconciliation_report
integer
exclude_uncategorized_accounts
boolean
default:false
expense_or_ap
boolean
fields
string

Comma-separated list of columns to return, e.g. 'posted_at,debit_amount,account'. Omit to receive the full payload. 'id' is always included. Narrowing the column list also skips the derived values behind the omitted columns, so it is the recommended way to pull large pages: a 1000-row page returns roughly 90% less data and responds materially faster when only a few columns are needed. Unrecognized names are ignored.

group
integer
group_fields
string

Comma-separated list of fields to group by (e.g. account,vendor,tag_group_)

group_id
integer
group_keys
string

Comma-separated values matched positionally to group_fields for drill-down

has_linked_fixed_asset
string
has_parent_bank_transaction
string
include_deleted
boolean
default:false

When set to 'true', returns ONLY deleted records instead of active records. Deleted records contain minimal data: 'id', 'is_deleted=true', 'deleted_at' timestamp, and 'last_modified_at'. When 'false' or omitted, returns ONLY active records. This provides clean separation between active and deleted data.

include_matches
boolean
default:false

If true, include match metadata (has_matches, primary_action_type) in serialized rows

is_not_reconciled
boolean
default:false
is_reconciled
boolean
default:false
journal_type
string
journal_type__nin
string
last_modified_at__gte
string

Filter for records modified on or after this timestamp. Format: ISO 8601 (e.g., '2024-01-01T00:00:00Z' or '2024-01-01'). Works with both active records and deleted records (filters by deletion time for deleted records).

last_modified_at__lte
string

Filter for records modified on or before this timestamp. Format: ISO 8601 (e.g., '2024-12-31T23:59:59Z' or '2024-12-31'). Works with both active records and deleted records (filters by deletion time for deleted records).

limit
integer
default:100

Maximum number of records to return per page. Default 100, maximum 10000. Use with offset to paginate

match_type
enum<string>
default:all
Available options:
all,
any
needs_review
boolean
default:false
no_department
boolean
no_tag
boolean
no_vendor
boolean
offset
integer
default:0

Number of records to skip before collecting the result page. Use with limit to paginate

opposing_account
integer
opposing_account_subtype
string
ordering
string
payee
string

Integer payee id or Campfire ID (VEN-/CUST-/EMP-)

payee_id
string

Integer payee id or Campfire ID (VEN-/CUST-/EMP-)

pivot_fields
string

Comma-separated list of pivot dimensions

q
string

Free-text search across journal memo, bank description, and related fields

reconciliation_report
integer
revenue_or_receivables
boolean
shouldPivot
boolean
default:false
sort
string

Sort field; prefix with - for descending. Default: -posted_at

start_date
string<date>

Earliest date (inclusive) for which to retrieve data. Defaults to six months ago

tag
integer
tag_groups
integer
tag_id
integer
vendor
string

Integer payee id or Campfire ID (VEN-/CUST-/EMP-)

vendor_id
string

Integer payee id or Campfire ID (VEN-/CUST-/EMP-)

Response

200 - application/json
count
integer
required
Example:

123

results
object[]
required
next
string<uri> | null
Example:

"http://api.example.org/accounts/?offset=400&limit=100"

previous
string<uri> | null
Example:

"http://api.example.org/accounts/?offset=200&limit=100"