Skip to main content
Merge recipients

Authorizations

Authorization
string
header
required

Personal API key sent as a bearer token, together with X-Organization-Id. The key must have at least the access level the endpoint requires (read, write or admin).

Headers

X-Organization-Id
string

The organization to act in. Required for personal API keys; list the organizations you can access with GET /v1/organizations.

Path Parameters

id
string<uuid>
required

Body

application/json
source_ids
string<uuid>[]
required
Required array length: 1 - 100 elements

Response

The merge and affected agreements.

target
object
required
workflow_run_ids
string<uuid>[]
required
merged_ids
string<uuid>[]
required
affected_agreement_ids
string<uuid>[]
required
invoices_moved
integer
required

Invoices of the merged parties that move to the retained party in the background.

Required range: x >= 0