SaaSFlow
DevelopersAPIReferenceaccounts

Update account

Update an account. Only the fields you send change. Two rules are enforced here: transit accounts may not change their type or currency (422), and a…

Authentication

Checking whether you're signed in…
PUT
/companies/{companyId}/accounts/{accountId}

Authorization

headerAuthorization<token>

A SaaSFlow API key (format sf_…) or an OAuth bearer token. Paste only the key — the proxy adds the Bearer prefix. Create an API key in Settings → Company settings → API keys — see API keys.

Path Parameters

companyId*string
Length1 <= length
accountId*string
Length1 <= length

Request Body

application/json
  1. body
type?string
Value in"bank""cash""creditCard""loan""other"
name?string
Length1 <= length
includeInCashBalance?boolean
defaultCurrency?string
Length1 <= length
importType?string
Value in"manual""automated"
order?number
accountGroupId?string|null
archived?boolean
accountNumber?string|null
expectedAnnualReturn?number|null
defaultCategoryId?string|null
importSettings?|

Saved import column mappings, keyed by importer (for example csv). Replaces the whole object, so send the existing entries along with the one you change.

Response Body

Updated account

application/json
  1. response
id*string
Formatuuid
companyId*string
Formatuuid
type*string

The type of account: bank, cash, creditCard, loan, other, or transit (system-managed, holds the in-flight bookings of transfers between accounts).

Value in"bank""cash""creditCard""loan""other""transit"
name*string

The name of the account.

accountNumber*|

The bank account number. Null if not provided.

includeInCashBalance*boolean

Whether this account should be included in cash balance calculations and cash flow reports.

accountGroupId*|

The ID of the account group this account belongs to. Null if not part of any group.

Formatuuid
archived*boolean

Flag indicating if the account is archived and should be hidden from most views.

expectedAnnualReturn*|

The expected annual return percentage for this account, if applicable.

Range-8388608 <= value <= 8388607
order*number

A number used for ordering accounts in the UI.

Range-8388608 <= value <= 8388607
defaultCurrency*string

The default currency for transactions recorded under this account.

Value in"EUR""AUD""BRL""CAD""CHF""CNY""CZK""DKK""GBP""HKD""HUF""IDR""ILS""INR""ISK""JPY""KRW""MXN""MYR""NOK""NZD""PHP""PLN""RON""SEK""SGD""THB""TRY""USD""ZAR"
defaultCategoryId*|

The default category ID to assign to new transactions for this account.

importType*string

Whether transactions are imported manually or via bank connection.

Value in"manual""automated"
transitCurrency*|
Value in"EUR""AUD""BRL""CAD""CHF""CNY""CZK""DKK""GBP""HKD""HUF""IDR""ILS""INR""ISK""JPY""KRW""MXN""MYR""NOK""NZD""PHP""PLN""RON""SEK""SGD""THB""TRY""USD""ZAR"null
importSettings?
bankConnection?||||||||
createdTime*|
Formatdate-time
createdUserId*string|null
lastUpdatedTime*|
Formatdate-time
lastUpdatedUserId*string|null
curl -X PUT "https://example.com/companies/string/accounts/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",  "type": "bank",  "name": "string",  "accountNumber": "string",  "includeInCashBalance": true,  "accountGroupId": "f194f9ff-275e-46c2-af22-f5c47e7a5be2",  "archived": true,  "expectedAnnualReturn": -8388608,  "order": -8388608,  "defaultCurrency": "EUR",  "defaultCategoryId": "string",  "importType": "manual",  "transitCurrency": "EUR",  "importSettings": {    "csv": null  },  "bankConnection": {    "type": "finApi",    "countryCode": "string",    "status": "active",    "integrationId": "string",    "expireTime": "2019-08-24T14:15:22Z",    "lastSyncTime": "2019-08-24T14:15:22Z",    "balanceMismatchReportedBalances": [      0    ],    "balanceMismatchCalculatedBalance": 0,    "balanceMismatchSince": "2019-08-24T14:15:22Z",    "finApiAccount": {      "id": 0,      "iban": "string",      "accountHolderName": "string",      "institution": {        "id": 0,        "name": "string",        "bic": "string",        "logoStored": true      },      "createdUserId": "string"    }  },  "createdTime": "2019-08-24T14:15:22Z",  "createdUserId": "string",  "lastUpdatedTime": "2019-08-24T14:15:22Z",  "lastUpdatedUserId": "string"}

Delete account

Delete an account and cascade-delete every transaction on it, along with their categorizations. That rewrites cash balances and the P&L for every period…

Archive

Archive an account. It drops out of the app's account lists and pickers while its transactions and history stay intact, which is the right move for a…