Skip to main content
GET
/
bankaccounts
/
{bankAccountId}
/
transactions
Get transactions
curl --request GET \
  --url https://api.smokeball.com/bankaccounts/{bankAccountId}/transactions \
  --header 'Authorization: <api-key>' \
  --header 'x-api-key: <api-key>'
{
  "href": "<string>",
  "relation": "<string>",
  "method": "GET",
  "self": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  },
  "id": "64818ee0-c7b4-46ec-862e-514d8b29540a",
  "matter": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  },
  "payor": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  },
  "bankAccount": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  },
  "type": "Deposit",
  "amount": 102.65,
  "enteredDate": "2023-11-07T05:31:56Z",
  "effectiveDate": "2023-11-07T05:31:56Z",
  "reference": "<string>",
  "reason": "<string>",
  "description": "<string>",
  "note": "<string>",
  "reversed": true,
  "reversedToTransaction": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  },
  "reversedFromTransaction": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  }
}

Authorizations

​
x-api-key
string
header
required
​
Authorization
string
header
required

Path Parameters

​
bankAccountId
string
required

Query Parameters

​
Offset
integer<int32>
Required range: 0 <= x <= 2147483647
​
Limit
integer<int32>
Required range: 1 <= x <= 500
​
LastUpdated
string<date-time>

Returns items updated since the specified date and time.

Example:

"2022-04-23T14:00:00Z"

Response

When request is successful. Returns a 'Transaction' object.

​
href
string | null
​
relation
string | null
​
method
string | null
default:GET
​
self
object
​
id
string | null

Unique identifier of the transaction.

Example:

"64818ee0-c7b4-46ec-862e-514d8b29540a"

​
matter
object

The associated matter.

​
payor
object

The associated contact that paid the funds.

​
bankAccount
object

The bank account where the transaction took place.

​
type
string | null

The type of the transaction.

Possible values: Deposit, DepositReversal, InvoicePayment, InvoicePaymentReversal, VendorPayment, VendorPaymentReversal Transfer, BankFees, BankFeesReversal, Interest, InterestReversal.

Example:

"Deposit"

​
amount
number<double>

The amount of the transaction in dollars. Limited to 2 decimal places (cents).

Example:

102.65

​
enteredDate
string<date-time>

Date the transaction was entered.

​
effectiveDate
string<date-time>

Date the transaction took effect.

​
reference
string | null

Reference for the transaction.

​
reason
string | null

Reason for the transaction.

​
description
string | null

Description of the transaction.

​
note
string | null

Note for the transaction (for internal use).

​
reversed
boolean

True if this transaction has been reversed.

Example:

true

​
reversedToTransaction
object

The transaction that was created as a result of reversing this transaction.

​
reversedFromTransaction
object

The transaction that was recversed to create this transaction.