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…
Authentication
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.
companyId*string1 <= lengthaccountId*string1 <= lengthAccount archived
application/json- response
id*stringuuidcompanyId*stringuuidtype*stringThe type of account: bank, cash, creditCard, loan, other, or transit (system-managed, holds the in-flight bookings of transfers between accounts).
"bank""cash""creditCard""loan""other""transit"name*stringThe name of the account.
accountNumber*|The bank account number. Null if not provided.
includeInCashBalance*booleanWhether 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.
uuidarchived*booleanFlag indicating if the account is archived and should be hidden from most views.
expectedAnnualReturn*|The expected annual return percentage for this account, if applicable.
-8388608 <= value <= 8388607order*numberA number used for ordering accounts in the UI.
-8388608 <= value <= 8388607defaultCurrency*stringThe default currency for transactions recorded under this account.
"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*stringWhether transactions are imported manually or via bank connection.
"manual""automated"transitCurrency*|"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"nullimportSettings?bankConnection?||||||||createdTime*|date-timecreatedUserId*string|nulllastUpdatedTime*|date-timelastUpdatedUserId*string|nullcurl -X PUT "https://example.com/companies/string/accounts/string/archive"{ "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"}