Skip to content
Patrimoine
v9.1.0

Merge Payees Endpoint

POST
/api/v1/payees/merge
curl --request POST \
  --url https://example.com/api/v1/payees/merge \
  --header 'Content-Type: application/json' \
  --data '{ "survivor_payee_id": 1, "merged_payee_ids": [ 1 ] }'

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
PayeeMergeRequest

Merge merged_payee_ids into survivor_payee_id: their transactions and planned transactions move to the survivor, their names and aliases become its aliases, then they are deleted.

object
survivor_payee_id
required
Survivor Payee Id
integer
merged_payee_ids
required
Merged Payee Ids
Array<integer>
>= 1 items <= 100 items

Example generated

{
  "survivor_payee_id": 1,
  "merged_payee_ids": [
    1
  ]
}

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
PayeeMergeResult
object
transaction_count
required
Transaction Count
integer
planned_transaction_count
required
Planned Transaction Count
integer
deleted_payee_ids
required
Deleted Payee Ids
Array<integer>

Example generated

{
  "transaction_count": 1,
  "planned_transaction_count": 1,
  "deleted_payee_ids": [
    1
  ]
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object

Example generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}