SaaSFlow
DevelopersAPIReferencevendors

Update vendor

Update a vendor. Only the fields you send change. A new `defaultCategorization` applies to future matches only; to push it onto transactions already booked against this vendor, call `apply-default-categorization` afterwards.

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.
PUT
/companies/{companyId}/vendors/{vendorId}

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
vendorId*string
Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

curl -X PUT "https://example.com/companies/string/vendors/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",  "name": "string",  "defaultCategorization": {    "categoryId": "string",    "usingDateRule": {      "type": "transactionDate"    },    "plSplit": {      "revenue": 0,      "cogs": 0,      "cac": 0,      "pd": 0,      "ga": 0,      "no": 0,      "neutral": 0    },    "passThroughTax": 0,    "transferTargetAccountId": "string"  },  "domains": [    "string"  ],  "logo": true,  "autoCreatedSource": "searchApiGoogleWebSearch",  "createdTime": "2019-08-24T14:15:22Z",  "createdUserId": "string",  "lastUpdatedTime": "2019-08-24T14:15:22Z",  "lastUpdatedUserId": "string",  "externalIds": [    "string"  ]}

Delete vendor

Delete a vendor. Transactions booked against it survive but lose their counterparty, and each one is flagged to stay out of auto-categorization so the deleted vendor is not immediately re-matched. For a duplicate record, merge instead.

Apply default categorization preview

Count what re-applying this vendor's default categorization would touch, without changing anything. The three buckets map onto the `applyTo` choices on the write endpoint: `empty` is transactions with no categorization yet, `autoAssigned` is ones SaaSFlow categorized itself, and `userEdited` is ones a person set by hand. Show these numbers before overwriting, since `applyTo: "all"` is what discards manual work.