For the complete documentation index, see llms.txt. This page is also available as Markdown.

financial_account.updated

The name, type, sync setting, or bookkeeping dates of one of your financial accounts changed, from Kick or through the Platform API.

When it fires

The event is sent each time at least one of these fields of the account changes:

Field
What changed

name

The account was renamed

type

The account type changed, for example from checking to savings

disabled

Syncing new transactions was turned off or back on

bookkeepingStartDate

The first day Kick keeps books for the account changed, or the account started or stopped following the entity's start date

bookkeepingEndDate

The last day Kick keeps books for the account changed, or the account became open-ended

It fires the same way whether the change was made in Kick or through Financial Accounts, so a change your own integration makes reaches your endpoint too. A save that changes several of these fields at once sends one event that lists all of them.

It is held back in these cases:

  • Saving a value the account already has is not a change, and sends no event.

  • Balance and sync timestamp refreshes (balance, balanceSyncedAt, transactionsSyncedAt) happen on every sync and never send this event.

  • Changes to fields not in the table above send no event.

  • An account with no entity sends nothing, because the Platform API doesn't return unassigned accounts.

Moving the account to another entity sends financial_account.moved instead.

The event is sent after the change is saved, to every organization with Platform API access that the account's workspace belongs to.

Payload

{
  "event": "financial_account.updated",
  "version": 1,
  "occurredAt": 1761645600,
  "payload": {
    "financialAccountId": "3f9c2a71-5d8e-4b6a-9c1f-7e2d4a6b8c90",
    "workspaceId": "8d3a1b52-9f1d-4a7e-b0a1-2c5d6e7f8a90",
    "entityId": "b6c4d2e1-7a3f-4c8b-9e0d-1f2a3b4c5d6e",
    "changedFields": ["bookkeepingStartDate", "bookkeepingEndDate"]
  }
}

payload carries:

Field
Type
Notes

financialAccountId

uuid

The account's id on Financial Accounts

workspaceId

uuid

Workspace the account belongs to

entityId

uuid

Entity the account is assigned to

changedFields

array of strings

Fields whose value changed, named as on the financial account resource. Always holds at least one of name, type, disabled, bookkeepingStartDate, and bookkeepingEndDate

The fields around it are the same on every event. See The event envelope.

Handling it

The payload names the fields that changed but not their new values. Read the account from Financial Accounts to get them. Skip the read when none of the listed fields matter to your integration.

When changedFields includes either bookkeeping date, the account's journal entries are regenerated, so refresh any journal entries or reports you cached for it.

A delivery that fails is retried later, so a newer change can reach you before an older one. Reading the current account, rather than applying events in arrival order, keeps your copy correct.

Last updated

Was this helpful?