Docs
Guides
Explanatory and how-to content
API Reference
Technical documentation
Changelog
Release notes
Dashboard
Manage your account
Status
Service status
API Reference
Bookkeeping Accounts

Accounts are T-accounts. They can store accounting entries. Your compliance setup might require annotating money movements using this API. Learn more in our guide to Bookkeeping.

The Bookkeeping Account object
{
  "account_id": null,
  "compliance_category": "customer_balance",
  "entity_id": "entity_n8y8tnk2p9339ti393yi",
  "id": "bookkeeping_account_e37p1f1iuocw5intf35v",
  "idempotency_key": null,
  "name": "John Doe Balance",
  "type": "bookkeeping_account"
}
Attributes
account_id
string
Nullable

The API Account associated with this bookkeeping account.

compliance_category
enum
Nullable

The compliance category of the account.

entity_id
string
Nullable

The Entity associated with this bookkeeping account.

id
string

The account identifier.

idempotency_key
string
Nullable

The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

name
string

The name you choose for the account.

type
string

A constant representing the object's type. For this resource it will always be bookkeeping_account.

List Bookkeeping Accounts
curl \
  --url "${INCREASE_URL}/bookkeeping_accounts" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
cursor
string

Return the page of entries after this one.

limit
integer

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

idempotency_key
string

Filter records to the one with the specified idempotency_key you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

200 character maximum
Create a Bookkeeping Account
curl -X "POST" \
  --url "${INCREASE_URL}/bookkeeping_accounts" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "name": "New Account!"
  }'
Parameters
account_id
string

The entity, if compliance_category is commingled_cash.

compliance_category
enum

The account compliance category.

entity_id
string

The entity, if compliance_category is customer_balance.

name
string
Required

The name you choose for the account.

200 character maximum
Update a Bookkeeping Account
curl -X "PATCH" \
  --url "${INCREASE_URL}/bookkeeping_accounts/bookkeeping_account_e37p1f1iuocw5intf35v" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "name": "Deprecated Account"
  }'
Parameters
bookkeeping_account_id
string
Required

The bookkeeping account you would like to update.

name
string
Required

The name you choose for the account.

200 character maximum
Retrieve a Bookkeeping Account Balance
curl \
  --url "${INCREASE_URL}/bookkeeping_accounts/bookkeeping_account_e37p1f1iuocw5intf35v/balance" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"
Returns a Bookkeeping Balance Lookup object:
{
  "balance": 100,
  "bookkeeping_account_id": "bookkeeping_account_e37p1f1iuocw5intf35v",
  "type": "bookkeeping_balance_lookup"
}
Parameters
bookkeeping_account_id
string
Required

The identifier of the Bookkeeping Account to retrieve.

at_time
string

The moment to query the balance at. If not set, returns the current balances.