SaaSFlow
DevelopersAPIReferenceaccounts

Create account

Create an account. Use `importType: "manual"` for one you will fill by hand or by CSV; accounts fed by a bank connection are created by the integration itself. `includeInCashBalance` decides whether it counts towards the cash position, which is usually false for loans. Pass `initialBalance` to seed the opening balance so the running balance is right from day one, dated before any transaction you then import. `order` is required and sets its position in the list.

Authentication

You're not signed in. Either sign in at app.saasflow.com and reload (then pick sessionCookie), or paste a SaaSFlow sf_… API key in the bearerAuth field below.
POST
/companies/{companyId}/accounts

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

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/companies/string/accounts" \  -H "Content-Type: application/json" \  -d '{    "type": "bank",    "name": "string",    "includeInCashBalance": true,    "defaultCurrency": "string",    "importType": "manual",    "order": 0  }'
{  "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",      "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"}

List accounts

List a company's accounts (bank, cash, credit card, loan, transit, other) with the integration managing each one, where there is one. `includeInCashBalance` decides whether an account counts towards the cash position, so a loan or a holding account can be excluded from it. Archived accounts are included; filter on `archived` for the live ones. Transaction counts and last-transaction dates only appear for callers with `transactions:read`.

Balances

Get the balance of each account at two points in time and the change between them. Keyed by account id, `value` is the balance on `endDate` and `valuePreviousPeriod` the balance on `startDate`. Amounts are in each account's own currency, named in `defaultCurrency`, so do not sum across accounts without converting first. Narrow to specific accounts with a comma-separated `accountIds`. For a converted series over time rather than two snapshots, use `daily_balance`.