Skip to Content
SaaSFlow
DevelopersAPIReferencetransactions

Search

Search transactions with sorting and a composable filter set. It is a POST because the filter array is too structured for a query string, not because it…

Authentication

Checking whether you're signed in…
POST
/companies/{companyId}/transactions/search

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
Formatuuid

Request Body

application/json
  1. body
limit?integer

Number of transactions to return (0-500, default 100). 0 returns only totalCount; without category, counterparty, P&L type, date-rule or cash-flow-direction filters it also skips loading any rows.

Range0 <= value <= 500
Default100
offset?integer

Number of transactions to skip (default 0).

Range0 <= value
Default0
sortBy?string

Column to sort by. amountValue sorts by the signed amount (money out is negative); amountMagnitude sorts by the absolute amount, so asc puts the smallest payments in either direction first.

Default"date"
Value in"date""amountValue""amountMagnitude""fromTo"
sortDirection?string

Sort direction.

Default"desc"
Value in"asc""desc"
filters?array<|||||||||||||||>

Array of filter objects. Each filter is active by its presence.

Default[]

Response Body

Paginated search results

application/json
  1. response
items*array<>
totalCount*number

Total number of transactions matching all filters.

balanceByDate?

End-of-day account balance per visible date, in the company`s base currency. Populated only when the page rows all belong to a single account and sortBy=date.

Example Request
curl -X POST 'https://api.saasflow.com/companies/497f6eca-6276-4993-bfeb-53cbbbba6f08/transactions/search' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response200
{  "items": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",      "accountId": "3d07c219-0a88-45be-9cfc-91e9d095a1e9",      "date": "string",      "fromTo": "string",      "description": "string",      "amountValue": "string",      "amountCurrency": "EUR",      "categorizationsAutoAssigned": true,      "excludeFromAutoCategorization": true,      "notes": "string",      "source": "string",      "assignedUserId": "string",      "finApiTransactionId": "string",      "plaidTransactionId": "string",      "counterpartIban": "string",      "endToEndReference": "string",      "stripeBalanceTransactionId": "string",      "stripeInvoiceId": "string",      "stripeCreditNoteId": "string",      "stripePaymentIntentId": "string",      "stripeBillingEmail": "string",      "hubspotPortalId": "string",      "hubspotInvoiceId": "string",      "hubspotCategorizationResolved": true,      "finwayExpenseNumber": "string",      "finwayInvoiceNumber": "string",      "finwayTransactionId": "string",      "pleoExpenseId": "string",      "paypalTransactionId": "string",      "paypalEventCode": "string",      "paypalReferenceId": "string",      "paypalFeeAmount": "string",      "digistore24TransactionId": "string",      "digistore24PayoutId": "string",      "ebicsEntryId": "string",      "createdVendorId": "91002d41-22cb-48a3-bc93-148a8439ef7f",      "integrationId": "497a18ca-284e-40c0-985d-f72be35d468e",      "pending": true,      "createdTime": "2019-08-24T14:15:22Z",      "createdUserId": "string",      "lastUpdatedTime": "2019-08-24T14:15:22Z",      "lastUpdatedUserId": "string",      "categorizations": {        "property1": {          "counterparty": {            "type": "customer",            "id": "string"          },          "categoryId": "string",          "usingDateRule": {            "type": "transactionDate"          },          "computedStartDate": "2019-08-24",          "computedEndDate": "2019-08-24",          "plSplit": {            "revenue": 0,            "cogs": 0,            "cac": 0,            "pd": 0,            "ga": 0,            "no": 0,            "neutral": 0          },          "passThroughTax": 0,          "transferCounterPosition": {            "transactionId": "string",            "categorizationId": "string"          },          "internalTransitLink": {            "transactionId": "string",            "categorizationId": "string"          },          "sourceNote": "string",          "externalInvoiceUrn": "string"        },        "property2": {          "counterparty": {            "type": "customer",            "id": "string"          },          "categoryId": "string",          "usingDateRule": {            "type": "transactionDate"          },          "computedStartDate": "2019-08-24",          "computedEndDate": "2019-08-24",          "plSplit": {            "revenue": 0,            "cogs": 0,            "cac": 0,            "pd": 0,            "ga": 0,            "no": 0,            "neutral": 0          },          "passThroughTax": 0,          "transferCounterPosition": {            "transactionId": "string",            "categorizationId": "string"          },          "internalTransitLink": {            "transactionId": "string",            "categorizationId": "string"          },          "sourceNote": "string",          "externalInvoiceUrn": "string"        }      },      "inTransit": true,      "partialAmount": 0    }  ],  "totalCount": 0,  "balanceByDate": {    "property1": {      "value": 0,      "currency": "string"    },    "property2": {      "value": 0,      "currency": "string"    }  }}