USusesecuro
payees

Update Payee

Changed on
patch/api/payees/{payee_id}

Request

Path parameters

payee_idstring uuid required

Headers

X-Workspace-Idstring nullable

Request body

namestring nullable
type'person' | 'company' nullable
is_favoriteboolean nullable
notesstring nullable
emailstring nullable
phonestring nullable
addressstring nullable
websitestring nullable

Response

Successful Response

idstring uuid required
user_idstring uuid required
namestring required
type'person' | 'company' nullable
source'manual' | 'sync' | 'import'
is_favoriteboolean required
notesstring nullable
emailstring nullable
phonestring nullable
addressstring nullable
websitestring nullable
created_atstring date-time required
transaction_countinteger

Changes

  • 416a7752fec4Revision changes
    • breaking

      request property / was restricted to a list of enum values

    • breaking

      the response property became optional for the status

    • breaking

      response property type list-of-types was widened by adding types null to media type application/json of response 200

    • warning

      the / request property's maxLength was set to 255

    • warning

      the / request property's maxLength was set to 1000

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new company enum value to the request property /

    • info

      added the new person enum value to the request property /

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status