Skip to main content

List Bank Transactions

Retrieve a list of bank transactions for the authenticated business.
schema
string
Schema identifier. Must be bank_transaction. Defaults to bank_transaction if not provided
bank
string
Filter by bank UUID
status
string
Filter by status (categorized, recognized, uncategorized)
page
number
Page number for pagination
limit
number
Number of records per page
date_order
string
Order records by date. Values: asc (oldest first) or desc (newest first). Default: desc
curl -X GET "https://api.useadam.io/v1/adam/bank-transactions?schema=bank_transaction&page=1&limit=20" \
  -H "X-API-Key: your_secret_key"

Get Bank Transaction

Retrieve a specific bank transaction by UUID.
uuid
string
required
Bank transaction UUID
curl -X GET "https://api.useadam.io/v1/adam/bank-transactions/transaction-uuid" \
  -H "X-API-Key: your_secret_key"

Upload Bank Transactions

Upload bank transactions (CSV or JSON format).
bank
string
required
Bank UUID
transactions
array
required
Array of transaction objects
transactions[].date
string
required
Transaction date (YYYY-MM-DD)
transactions[].amount
number
required
Transaction amount
transactions[].type
string
required
Transaction type (debit or credit)
transactions[].narration
string
Transaction description
transactions[].ref
string
Transaction reference
date_format
string
Date format (e.g., “Y-m-d”). Default: “Y-m-d”
curl -X POST "https://api.useadam.io/v1/adam/bank-transactions/upload" \
  -H "X-API-Key: your_secret_key" \
  -H "Content-Type: application/json" \
  -d '{
    "bank_uuid": "bank-uuid",
    "transactions": [
      {
        "date": "2024-01-15",
        "amount": 100.00,
        "type": "debit",
        "narration": "Payment to supplier",
        "ref": "TXN123"
      }
    ],
    "date_format": "Y-m-d"
  }'

Update Bank Transaction

Update a bank transaction by UUID.
uuid
string
required
Bank transaction UUID
date
string
Transaction date (YYYY-MM-DD)
narration
string
Transaction description
status
string
Transaction status (categorized, recognized, uncategorized)
account
string
Account name
curl -X PUT "https://api.useadam.io/v1/adam/bank-transactions/transaction-uuid" \
  -H "X-API-Key: your_secret_key" \
  -H "Content-Type: application/json" \
  -d '{
    "date": "2024-01-16",
    "narration": "Updated description",
    "status": "categorized",
    "account": "Expense Account",
    "link_destination": "expenses"
  }'

Delete Bank Transaction

Delete a bank transaction by UUID.
uuid
string
required
Bank transaction UUID
curl -X DELETE "https://api.useadam.io/v1/adam/bank-transactions/transaction-uuid" \
  -H "X-API-Key: your_secret_key"