Skip to main content
POST
Merge Payee

Authorizations

Authorization
string
header
required

API key authentication. Send your raw API key as the Authorization header value with NO scheme prefix — Authorization: YOUR-API-KEY. Do NOT prefix it with Bearer or ApiKey, and do not use an X-API-Key header; those are not accepted.

Path Parameters

companyId
string<uuid>
required

Company identifier

payeeId
string<uuid>
required

The payee being merged AWAY — a pure selector; every invoice linked to it is repointed

Body

application/json
toPayeeId
string<uuid>
required

The surviving payee every linked invoice is repointed to; must exist and differ from {payeeId}

author
string

Optional display label for the source system's author (e.g. the integrator-side user). Stamped as the journal record's display attribution; the acting principal stays the External API service user, so a label can never impersonate an in-app user. Ignored on idempotent replays

Required string length: 1 - 255

Response

Every emitted journal id, in execution order — empty on a converged retry (nothing left linked to the merged payee)

journalIds
string<uuid>[]
required

Every emitted journal id, in execution order