Jupiter ERP
Account API

List Bank Transactions

/api/account/bank-transactions

GETHTTP
get/api/account/bank-transactions

Example request

GET https://api.jupiter-erp.com/api/account/bank-transactions

Code
curl -X GET 'https://api.jupiter-erp.com/api/account/bank-transactions' \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'X-Account-Uuid: YOUR_ACCOUNT_UUID' \
  -H 'Accept: application/json'

Parameters

NameInRequiredDescription
bank_account_idquerynoOptional. Filter by bank account; omit to list all transactions.
searchquerynoSearch in counterparty (Empfänger) and reference (Verwendungszweck). SQL-like: `test*` begins with, `*test` ends with, `*test*` contains, `test` exact.
transaction_date_fromquerynoFilter transactions from this date (inclusive). Format Y-m-d.
transaction_date_toquerynoFilter transactions until this date (inclusive). Format Y-m-d.
amount_cents_minquerynoMinimum amount (signed, in cents). Use negative for debits.
amount_cents_maxquerynoMaximum amount (signed, in cents). Use negative for debits.
amount_assignable_cents_minquerynoMinimum open (assignable) amount in cents (magnitude, non-negative).
amount_assignable_cents_maxquerynoMaximum open (assignable) amount in cents (magnitude, non-negative).
currency_codequerynoFilter by transaction currency (ISO 4217, e.g. EUR, USD).
sourcequerynoFilter by source (manual, csv, api)
assignment_statusquerynoFilter by assignment status (open, partially_assigned, fully_assigned, private, transfer)
auto_detectedquerynoFilter by auto-detected flag (true/false)
#/components/parameters/RecordLockedQueryParameter
order_byqueryno
#/components/parameters/OrderDirParameter
#/components/parameters/PerPageParameter
#/components/parameters/PageParameter

Responses

200OK
FieldTypeDescription
data*object[]

array

Elements

FieldTypeDescription
amount_assignable_cents*integerAmount in cents that can still be assigned to payables (0 when fully assigned, private, or no assignment required)
amount_cents*integerSigned; positive = credit, negative = debit
assignment_status*stringDerived from allocations, linked transfer, is_private, and is_no_assignment_required. open, partially_assigned, fully_assigned, private, no_assignment_required, transfer

string

  • open
  • partially_assigned
  • fully_assigned
  • private
  • no_assignment_required
  • transfer
auto_detected*booleanAutomatically detected e.g. by import or matching
bank_account_id*integer
counterparty_account_numberstring
counterparty_bank_codestring
counterparty_namestring
created_atstring (date-time)Creation timestamp in ISO 8601 format.
currency_codestring
external_idstring
id*integer
is_no_assignment_required*booleanUser-marked as not requiring document assignment (e.g. zero-amount transactions)
is_private*booleanUser-marked as private (no business assignment)
linked_transferobjectSummary of the paired bank transaction in an internal account transfer (Umbuchung).

Summary of the paired bank transaction in an internal account transfer (Umbuchung).

FieldTypeDescription
amount_cents*integerSigned; positive = credit, negative = debit
bank_account_id*integer
counterparty_namestring
currency_codestring
id*integer
referencestring
transaction_date*stringTimestamp in W3C format, will be saved in UTC time +00:00
locked_atstringTimestamp in W3C format, will be saved in UTC time +00:00
memostring
referencestring
source*stringmanual, csv, api
transaction_date*stringTimestamp in W3C format, will be saved in UTC time +00:00
updated_atstring (date-time)Last update timestamp in ISO 8601 format.
value_datestringDate in Y-m-d format
meta*object
FieldTypeDescription
current_page*integerThe current page number.
items_from*integerThe starting item number on the current page.
items_to*integerThe ending item number on the current page.
last_page*integerThe last page number.
per_page*integerThe number of items per page.
total*integerThe total number of items.
Example response
{
  "data": [
    {
      "id": 0,
      "bank_account_id": 0,
      "transaction_date": "2025-01-14T13:51:15.000Z",
      "value_date": "2025-01-14T00:00:00.000Z",
      "amount_cents": 0,
      "currency_code": "string",
      "source": "string",
      "assignment_status": "open",
      "amount_assignable_cents": 0,
      "is_private": true,
      "is_no_assignment_required": true,
      "auto_detected": true
    }
  ],
  "meta": {
    "current_page": 1,
    "last_page": 1,
    "per_page": 15,
    "total": 1,
    "items_from": 1,
    "items_to": 1
  }
}
Bank Transactions

Questions about integration?

GET /api/account/bank-transactions · Jupiter ERP