SaaSFlow
DevelopersAPIReferencecompanies

Update company

Update company settings. Only the fields you send change. Changing baseCurrency restates every converted figure in the app, including historical ones, so…

Authentication

Checking whether you're signed in…
PUT
/companies/{companyId}

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
name?string
Length1 <= length
baseCurrency?string
plShowPlanningPercentageForPastMonths?boolean
plShowAllCategories?boolean
plRecognizeRevenueOnInvoice?boolean
valuationCategory?|
Value in"traditional""aiEnhanced""aiNative"null
valuationLens?|
Value in"fundraising""acquisition"null
domain?|

The company's website, such as example.com. A full URL is reduced to its domain. Null clears it.

Response Body

Updated company

application/json
  1. response
id*string
Formatuuid
firestoreId*string|null
name*string

The name of the company.

baseCurrency*string

The base currency for the company.

Value in"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"
domain*|

The company's website domain, such as example.com. Null when not set.

customLogoPath*|

Path of the logo uploaded in the company settings, relative to the public assets host. Null when the company shows the logo of its website domain.

lastOverallUpdatedTime*string

When any data within the company was last updated.

Formatdate-time
plShowPlanningPercentageForPastMonths*boolean

Whether to show planning percentages for past months in P&L.

plShowAllCategories*boolean

Whether to show all categories in P&L, including empty ones.

plRecognizeRevenueOnInvoice*boolean
dataStartDate*|

The company-wide data start date. Imports skip transactions dated before it. Null means no start date is set.

valuationCategory*|

Self-declared company category used by the valuation estimate. Null means traditional B2B SaaS.

Value in"traditional""aiEnhanced""aiNative"null
valuationLens*|

Which comparable set the valuation estimate prices against. Null means fundraising.

Value in"fundraising""acquisition"null
systemStatus*string

The status of the company.

Value in"sandbox""trial""free""paid""cancelled""expired""beta"
systemTrialUntil*|
Formatdate-time
systemExpiredAt*|
Formatdate-time
systemDeletionWarning*|
Range-2147483648 <= value <= 2147483647
systemSandboxExpireTime*|
Formatdate-time
systemDeletionScheduledTime*|
Formatdate-time
systemStripe?|null
systemTierOverageSince*|
Formatdate-time
computedCommittedMrrEur*string|null
computedActiveCustomerCount*|
Range-2147483648 <= value <= 2147483647
computedMetricsTime*|
Formatdate-time
createdTime*|
Formatdate-time
createdUserId*string|null
lastUpdatedTime*|
Formatdate-time
lastUpdatedUserId*string|null
curl -X PUT "https://example.com/companies/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "firestoreId": "string",  "name": "string",  "baseCurrency": "EUR",  "domain": "string",  "customLogoPath": "string",  "lastOverallUpdatedTime": "2019-08-24T14:15:22Z",  "plShowPlanningPercentageForPastMonths": true,  "plShowAllCategories": true,  "plRecognizeRevenueOnInvoice": true,  "dataStartDate": "string",  "valuationCategory": "traditional",  "valuationLens": "fundraising",  "systemStatus": "sandbox",  "systemTrialUntil": "2019-08-24T14:15:22Z",  "systemExpiredAt": "2019-08-24T14:15:22Z",  "systemDeletionWarning": -2147483648,  "systemSandboxExpireTime": "2019-08-24T14:15:22Z",  "systemDeletionScheduledTime": "2019-08-24T14:15:22Z",  "systemStripe": {    "customerId": "string",    "subscription": {      "id": "string",      "status": "active",      "productName": "starter",      "interval": "monthly",      "currentPeriodStart": "string",      "currentPeriodEnd": "string",      "price": {        "value": 0,        "currency": "string"      },      "cancelAt": "string",      "limits": {        "minARR": 0,        "maxARR": 0      }    }  },  "systemTierOverageSince": "2019-08-24T14:15:22Z",  "computedCommittedMrrEur": "string",  "computedActiveCustomerCount": -2147483648,  "computedMetricsTime": "2019-08-24T14:15:22Z",  "createdTime": "2019-08-24T14:15:22Z",  "createdUserId": "string",  "lastUpdatedTime": "2019-08-24T14:15:22Z",  "lastUpdatedUserId": "string"}

Retrieve company

Retrieve one company with its settings and its member list. baseCurrency is the currency every cross-currency figure is converted into, so read it before…

Delete logo

Delete the uploaded company logo. The company shows the logo of its website domain again, or its initials when it has none.