Update Payee
Updates an existing payee. Only send fields you want to change.
Optional update fields:
name- Update payee namepayeeType- Update payee typeemail- Update email address (send null to clear)alternateEmails- Update alternate emailsphoneNumber- Update phone numberdescription- Update descriptionaddress- Update unstructured addressaddressStructured- Update structured addresslawFirmType- Update law firm typebankInfo- Update bank informationtaxIdNumber- Update tax ID numberexternalPayee- Update external payee referencecreatedAt- Update creation timestamp (for imports)
Required permission: company.payee:create
Authorizations
API key authentication. Include your key in the Authorization header: Authorization: ApiKey YOUR-API-KEY
Path Parameters
Company identifier
Payee identifier
Body
Request body for updating a payee. Only include fields you want to change.
Update payee name
Type of payee
lawFirm, expert, vendor, other, financingCompany Update email (send null to clear)
Update alternate emails
Update phone number
Update description
Update unstructured address
Structured address with parsed components (payee-specific format)
Type of law firm (only applicable when payeeType is lawFirm)
defense, plaintiff Bank account information for payments
Update tax ID number
Reference to an external payee in another system
Update creation timestamp (ISO 8601)
Response
Payee updated successfully
A payee entity (law firm, expert, vendor, etc.)
Payee identifier
Company identifier
Payee name
Type of payee
lawFirm, expert, vendor, other, financingCompany Primary email address
Additional email addresses
Phone number
Description of the payee
Unstructured address string
Structured address with parsed components
Type of law firm (only for payeeType lawFirm)
defense, plaintiff Bank account information
Tax identification number
Reference to payee in external system
When the payee was created (ISO 8601)
User ID who created the payee
When the payee was last updated (ISO 8601)
User ID who last updated the payee