Get transactions

Retrieves a specified bank accounts transaction.

GET /bankaccounts/{bankAccountId}/transactions

Get transactions

cURL

curl --request GET \
  --url https://api.smokeball.com/bankaccounts/{bankAccountId}/transactions \
  --header 'Authorization: <api-key>' \
  --header 'x-api-key: <api-key>'

import requests

url = "https://api.smokeball.com/bankaccounts/{bankAccountId}/transactions"

headers = {
    "x-api-key": "<api-key>",
    "Authorization": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-api-key': '<api-key>', Authorization: '<api-key>'}};

fetch('https://api.smokeball.com/bankaccounts/{bankAccountId}/transactions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.smokeball.com/bankaccounts/{bankAccountId}/transactions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.smokeball.com/bankaccounts/{bankAccountId}/transactions"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.smokeball.com/bankaccounts/{bankAccountId}/transactions")
  .header("x-api-key", "<api-key>")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.smokeball.com/bankaccounts/{bankAccountId}/transactions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

200

{
  "href": "<string>",
  "relation": "<string>",
  "method": "GET",
  "self": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  },
  "id": "64818ee0-c7b4-46ec-862e-514d8b29540a",
  "payorName": "John Smith",
  "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"
  }
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

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"

MatterId · string

Filters items by the specified matter ID.

Example:

"da4e7fd1-5394-4ca9-b1c6-e18c4e2bf262"

Response

200

application/json

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

href · string | null

relation · string | null

method · string | null · default: GET

self · object | null

Show child attributes

id · string | null

Unique identifier of the transaction.

Example:

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

payorName · string | null

The name of the associated contact.

Example:

"John Smith"

matter · object | null

The associated matter.

Show child attributes

payor · object | null

The associated contact that paid the funds.

Show child attributes

bankAccount · object | null

The bank account where the transaction took place.

Show child attributes

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 | null

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

Show child attributes

reversedFromTransaction · object | null

The transaction that was recversed to create this transaction.

Show child attributes