Skip to content
Patrimoine
v9.1.0

Update Payee Endpoint

PATCH
/api/v1/payees/{payee_id}
curl --request PATCH \
  --url https://example.com/api/v1/payees/1 \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "default_category_id": 1, "default_subcategory_id": 1 }'

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
payee_id
required
Payee Id
integer

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
PayeeUpdate

An explicit null category clears both defaults; null for name is ignored.

object
name
Any of:
string
>= 1 characters <= 255 characters
default_category_id
Any of:
integer
default_subcategory_id
Any of:
integer

Example generated

{
  "name": "example",
  "default_category_id": 1,
  "default_subcategory_id": 1
}

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
PayeeOut
object
id
required
Id
integer
user_id
required
User Id
integer
name
required
Name
string
default_category_id
required
Any of:
integer
default_subcategory_id
required
Any of:
integer
aliases
Aliases
Array<string>
default:
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time
usage_count
Usage Count
integer
0
planned_transaction_count
Planned Transaction Count
integer
0

Example 

{
  "aliases": [],
  "usage_count": 0,
  "planned_transaction_count": 0
}

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": {}
    }
  ]
}