SaaSFlow
DevelopersAPIReferencevendors

Merge

Merge duplicate vendors into one. Creates the vendor described in the body, repoints the transactions and external ids of every id in vendorIds onto it…

Authentication

Checking whether you're signed in…
POST
/companies/{companyId}/vendors/merge

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
vendorIds*array<>
newVendor*

Response Body

The merged vendor

application/json
  1. response
id*string
Formatuuid
companyId*string
Formatuuid
name*string

The name of the vendor.

defaultCategorization*|

The default categorization to apply to transactions from this vendor.

domains*array<string>

An array of website domains associated with this vendor.

logo*boolean

Flag indicating if a logo is available for this vendor.

autoCreatedSource*|

The source from which this vendor was automatically created.

Value in"searchApiGoogleWebSearch""stripe""hubspot""datevPayroll""finway""pleo""digistore24""paypal"null
createdTime*|
Formatdate-time
createdUserId*string|null
lastUpdatedTime*|
Formatdate-time
lastUpdatedUserId*string|null
externalIds*array<string>

External IDs (URNs) linked to this vendor (e.g., DATEV Payroll).

curl -X POST "https://example.com/companies/string/vendors/merge" \  -H "Content-Type: application/json" \  -d '{    "vendorIds": [      "string"    ],    "newVendor": {      "name": "string"    }  }'
{  "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"  ]}

Batch delete

Delete many vendors in one call. selection works two ways: mode: "ids" with an explicit list, or mode: "filter" with the same q the list endpoint takes…

List external ids

List the external ids linked to a vendor. These are the identifiers the vendor carries in connected systems, and they are what lets an importer recognise…