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

Authorization<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.

In: header

Path Parameters

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

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

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…