Get bank account transactions

{
  "pagination": {
    "total": 100,
    "page": 1,
    "pageSize": 10
  },
  "data": [
    {
      "withdrawal": 1000.5,
      "deposit": 2000.75,
      "runningBalance": 3000.25,
      "formattedWithdrawal": "$1,000.50",
      "formattedDeposit": "$2,000.75",
      "formattedRunningBalance": "$3,000.25",
      "transactionNumber": "TRX-2024-001",
      "referenceNumber": "REF-2024-001",
      "referenceId": 12345,
      "referenceType": "INVOICE",
      "formattedTransactionType": "Bank Transfer",
      "balance": 5000,
      "formattedBalance": "$5,000.00",
      "date": "2024-03-20T10:30:00Z",
      "formattedDate": "March 20, 2024",
      "status": "COMPLETED",
      "formattedStatus": "Completed",
      "uncategorizedTransactionId": 67890
    }
  ]
}

GET

api

banking

transactions

{
  "pagination": {
    "total": 100,
    "page": 1,
    "pageSize": 10
  },
  "data": [
    {
      "withdrawal": 1000.5,
      "deposit": 2000.75,
      "runningBalance": 3000.25,
      "formattedWithdrawal": "$1,000.50",
      "formattedDeposit": "$2,000.75",
      "formattedRunningBalance": "$3,000.25",
      "transactionNumber": "TRX-2024-001",
      "referenceNumber": "REF-2024-001",
      "referenceId": 12345,
      "referenceType": "INVOICE",
      "formattedTransactionType": "Bank Transfer",
      "balance": 5000,
      "formattedBalance": "$5,000.00",
      "date": "2024-03-20T10:30:00Z",
      "formattedDate": "March 20, 2024",
      "status": "COMPLETED",
      "formattedStatus": "Completed",
      "uncategorizedTransactionId": 67890
    }
  ]
}

Headers

Authorization

string

required

Value must be 'Bearer ' where is an API key prefixed with 'bc_' or a JWT token.

Example:

"Bearer bc_1234567890abcdef"

organization-id

string

required

Required if Authorization is a JWT token. The organization ID to operate within.

Query Parameters

page

number

Page number for pagination

Example:

1

pageSize

number

Number of items per page

Example:

10

accountId

number

required

Bank account ID

Example:

1

precision

number

Number of decimal places to display

Example:

2

divideOn1000

boolean

Whether to divide the number by 1000

Example:

false

showZero

boolean

Whether to show zero values

Example:

true

formatMoney

enum<string>

How to format money values

Available options:

total,

always,

none

Example:

"total"

negativeFormat

enum<string>

How to format negative numbers

Available options:

parentheses,

mines

Example:

"parentheses"

Response

200 - application/json

Returns a list of bank account transactions

pagination

object

required

Pagination metadata

Show child attributes

pagination.total

number

required

Total number of items across all pages

Example:

100

pagination.page

number

required

Current page number (1-based)

Required range: x >= 1

Example:

1

pagination.pageSize

number

required

Number of items per page

Required range: x >= 1

Example:

10

data

object[]

Show child attributes

data.withdrawal

number

required

The withdrawal amount

Example:

1000.5

data.deposit

number

required

The deposit amount

Example:

2000.75

data.runningBalance

number

required

The running balance after the transaction

Example:

3000.25

data.formattedWithdrawal

string

required

Formatted withdrawal amount with currency symbol

Example:

"$1,000.50"

data.formattedDeposit

string

required

Formatted deposit amount with currency symbol

Example:

"$2,000.75"

data.formattedRunningBalance

string

required

Formatted running balance with currency symbol

Example:

"$3,000.25"

data.transactionNumber

string

required

Unique transaction number

Example:

"TRX-2024-001"

data.referenceNumber

string

required

Reference number for the transaction

Example:

"REF-2024-001"

data.referenceId

number

required

ID of the reference entity

Example:

12345

data.referenceType

string

required

Type of the reference entity

Example:

"INVOICE"

data.formattedTransactionType

string

required

Formatted transaction type

Example:

"Bank Transfer"

data.balance

number

required

Current balance

Example:

5000

data.formattedBalance

string

required

Formatted balance with currency symbol

Example:

"$5,000.00"

data.date

string<date-time>

required

Transaction date

Example:

"2024-03-20T10:30:00Z"

data.formattedDate

string

required

Formatted transaction date

Example:

"March 20, 2024"

data.status

string

required

Transaction status

Example:

"COMPLETED"

data.formattedStatus

string

required

Formatted transaction status

Example:

"Completed"

data.uncategorizedTransactionId

number

required

ID of the uncategorized transaction

Example:

67890

Uncategorize a bank transaction.Create a new bank transaction

⌘I

Get Started

API Reference

Get bank account transactions

Headers

Query Parameters

Response