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

Entry Sets are accounting entries that are transactionally applied. Your compliance setup might require annotating money movements using this API. Learn more in our guide to Bookkeeping.

The Bookkeeping Entry Set object
{
  "created_at": "2023-02-11T02:11:59Z",
  "date": "2020-01-31T23:59:59Z",
  "entries": [
    {
      "account_id": "bookkeeping_account_e37p1f1iuocw5intf35v",
      "amount": 1750,
      "id": "bookkeeping_entry_ctjpajsj3ks2blx10375"
    },
    {
      "account_id": "bookkeeping_account_e37p1f1iuocw5intf35v",
      "amount": -1750,
      "id": "bookkeeping_entry_ctjpajsj3ks2blx10375"
    }
  ],
  "id": "bookkeeping_entry_set_n80c6wr2p8gtc6p4ingf",
  "idempotency_key": null,
  "transaction_id": null,
  "type": "bookkeeping_entry_set"
}
Attributes
created_at
string

When the entry set was created.

date
string

The timestamp of the entry set.

entries
array

The entries.

id
string

The entry set 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.

transaction_id
string
Nullable

The transaction identifier, if any.

type
string

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

List Bookkeeping Entry Sets
curl \
  --url "${INCREASE_URL}/bookkeeping_entry_sets" \
  -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.

transaction_id
string

Filter to the Bookkeeping Entry Set that maps to this Transaction.

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 Entry Set
curl -X "POST" \
  --url "${INCREASE_URL}/bookkeeping_entry_sets" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "date": "2020-01-31T23:59:59Z",
    "entries": [
      {
        "account_id": "bookkeeping_account_9husfpw68pzmve9dvvc7",
        "amount": 100
      },
      {
        "account_id": "bookkeeping_account_t2obldz1rcu15zr54umg",
        "amount": -100
      }
    ],
    "transaction_id": "transaction_uyrp7fld2ium70oa7oi"
  }'
Parameters
date
string

The date of the transaction. Optional if transaction_id is provided, in which case we use the date of that transaction. Required otherwise.

entries
array
Required

The bookkeeping entries.

transaction_id
string

The identifier of the Transaction related to this entry set, if any.

Retrieve a Bookkeeping Entry Set
curl \
  --url "${INCREASE_URL}/bookkeeping_entry_sets/bookkeeping_entry_set_n80c6wr2p8gtc6p4ingf" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
bookkeeping_entry_set_id
string
Required

The identifier of the Bookkeeping Entry Set.