GET
/
bankaccountbalances
/
{id}
Get a bank account balance
curl --request GET \
  --url https://api.smokeball.com/bankaccountbalances/{id} \
  --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": "611ccf16-df18-433c-9900-2496f3ab902c",
  "balance": 1000,
  "contactBalances": [
    {
      "contactId": "18c05819-c321-4907-800c-d5a608729c5a",
      "matterId": "39a0a7d0-dd1c-4dea-a3f6-f8b35656f168",
      "balance": 1000
    }
  ],
  "matterBalances": [
    {
      "matterId": "39a0a7d0-dd1c-4dea-a3f6-f8b35656f168",
      "balance": 1000,
      "unpresentedChequesBalance": 0
    }
  ]
}

Authorizations

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

Path Parameters

​
id
string
required

The unique identifier of the bank account.

Response

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

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

Unique identifier of the bank account. This is the same id used for BankAccount.

Example:

"611ccf16-df18-433c-9900-2496f3ab902c"

​
balance
number

Total balance of the bank account.

Example:

1000

​
contactBalances
object[] | null

List of contact balances. If balances are stored by matter, not by contact, then there can be a contact balance with no contact id. In this case, MatterBalances should be used instead.

​
matterBalances
object[] | null

List of matter balances. A matter balance will be equal to the sum of all contact balances with the same MatterId.