v4

latestOpenAPI 3.1.02026-08-032294621.7 MB
Vendors

Update vendor (partial)

Update specific fields on a vendor. Send only the fields you want to change — anything you don't send stays as it is. To clear a nullable field, send null.

Example — rename a vendor and update its TIN:

{"name": "Acme Supply Co.", "tin": "12-3456789", "tin_type": "ein"}

Example — change payment routing:

{"bank_account_number": "000123456789", "bank_routing_number": "021000021"}

Existing attachments are preserved unless you explicitly send the attachments field; use the dedicated attachments endpoint to manage them.

Custom fields

Set custom fields by name:

{"custom_fields": [{"Partner": true}, {"Tier": "Gold"}]}

Each item is a one-key object where the key is the custom field's name and the value is whatever you want to set. Use null to clear a field. If the name doesn't match a custom field in your organization you'll get a 422 back — we won't silently ignore it. If you happen to have two custom fields with the same name, use the id-based shape:

{"custom_fields": [{"field": {"id": 42}, "value": {"custom_field_id": 42, "value": "Acme"}}]}

Omitting custom_fields from the request leaves existing values untouched.

patch/public/v2/vendors/{vendor_id}/

Path parameters

vendor_idinteger required

Request body

custom_fieldsobject[] nullable
is_activeboolean nullable
vendor_type'individual' | 'company' | 'intercompany' | 'tax_agency'
namestring nullable
unique_idstring nullable
emailstring nullable
phonestring nullable
websitestring nullable
single_addressstring nullable
is_1099_eligibleboolean nullable
tinstring nullable
tin_type'ein' | 'ssn' | 'utr'
record_status'draft' | 'posted' | 'archived'
term_idinteger nullable
customer_account_numberstring nullable
name_on_checkstring nullable
preferred_payment_method_idinteger nullable
bank_account_numberstring nullable
bank_routing_numberstring nullable

Response

OK

term_idinteger nullable required
term_namestring required
preferred_payment_method_idinteger nullable required
preferred_payment_method_namestring required
approval_statusstring nullable
idinteger required
vendor_typestring required
company_idinteger nullable
company_namestring nullable
customer_account_numberstring
name_on_checkstring
bank_account_numberstring
bank_routing_numberstring
single_addressstring nullable
namestring required
unique_idstring nullable

External identifier supplied by the user to disambiguate vendors that share a display name (e.g. an ID from another system).

websitestring nullable
emailstring nullable
is_activeboolean
phonestring nullable
is_1099_eligibleboolean
tinstring nullable
tin_typestring nullable
record_status'draft' | 'posted' | 'archived'