SaaSFlow
DevelopersAPIReferencedata

PeriodDetails

Use this when the user asks for the detailed breakdown of a single period (transactions, categorizations, totals). Requires permissions: transactions:read.

Authentication

Checking whether you're signed in…
POST
/companies/{companyId}/data/periodDetails

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

Request Body

application/json
  1. body
startDate*string
Match^\d{4}-\d{2}-\d{2}
endDate*string
Match^\d{4}-\d{2}-\d{2}
dateDefinition*string
Value in"distributed""cash"
splitBy*string
Value in"account""counterparty"
includePlanned?boolean
filter?

Response Body

periodDetails result

application/json
  1. response
amountBySplitId*
total*number
namesBySplitId?
invoicedAmountBySplitId?
invoicedTotal?number
invoicedDueDateRange?
plannedAmountBySplitId?
plannedTotal?number
plannedHasRolledForwardInvoices?boolean
curl -X POST "https://example.com/companies/string/data/periodDetails" \  -H "Content-Type: application/json" \  -d '{    "startDate": "string",    "endDate": "string",    "dateDefinition": "distributed",    "splitBy": "account"  }'
{  "amountBySplitId": {    "property1": 0,    "property2": 0  },  "total": 0,  "namesBySplitId": {    "property1": "string",    "property2": "string"  },  "invoicedAmountBySplitId": {    "property1": 0,    "property2": 0  },  "invoicedTotal": 0,  "invoicedDueDateRange": {    "min": "string",    "max": "string"  },  "plannedAmountBySplitId": {    "property1": 0,    "property2": 0  },  "plannedTotal": 0,  "plannedHasRolledForwardInvoices": true}

ProfitLossData

Use this when the user asks for a P&L statement (revenue, costs, gross/operating/net profit) for a period. Requires permissions: financials:read.

Cohorts

Use this when the user asks about customer retention or revenue retention by cohort. Returns the cohort matrix only (one entry per cohort month, MRR and…