Skip to content

Ramp: Update a vendor — vendor patch Vendor Resource — request body — body

Update a vendor — vendor.patchVendorResource: request body, field body. Complete fields and constraints for contract 2026-10-27.

API reference · Contract 2026-10-27

SDK schema: Update a vendor — vendor patch Vendor Resource — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
accounting_vendor_remote_idstringOptionalThe accounting remote id of the vendor. At most one of `accounting_vendor_remote_id` or `vendor_tracking_category_option_id` should be provided.
addressModelOptionalExpand Create a new vendor — request body — body address
The address of the vendor.
countrystringOptionalThe country of the vendor.
default_bank_account_idstringOptionalUnique identifier of an existing bank account belonging to this vendor to use as its default payment method. The account determines the payment method. Existing bills are not changed. Omit to leave the default unchanged.
Format: uuid
default_entity_idJSONOptional
default_entity_id (anyOf 1)stringAlternativeUnique identifier of the default business entity to associate with this vendor. Must belong to the current business. Set to null to clear the default entity.
Format: uuid
default_entity_id (anyOf 2)nullAlternative
descriptionstringOptionalDescription of the vendor.
external_vendor_idJSONOptional
external_vendor_id (anyOf 1)stringAlternativeCustomer-defined external identifier for the vendor. This is independent of accounting system remote IDs.
external_vendor_id (anyOf 2)nullAlternative
is_activebooleanOptionalWhether this vendor is active.
namestringOptionalName of the vendor.
Minimum length: 1
net_payment_termsJSONOptional
net_payment_terms (anyOf 1)integerAlternativeNumber of days after receipt that payment is due. 0 means due on receipt; null clears the terms. Omit to leave unchanged.
Maximum: 3652058
Minimum: 0
net_payment_terms (anyOf 2)nullAlternative
request_payment_detailsbooleanOptionalWhether to request payment details from the vendor (ACH bank account, international wire transfer, and check mailing address). Requires an existing default vendor contact email.
Default: false
request_tax_detailsbooleanOptionalWhether to request tax information from the vendor (Tax Identification Number, federal tax classification, and tax address). Requires an existing default vendor contact email.
Default: false
stateJSONOptional
state (anyOf 1)stringAlternativeVendor-level two-letter US state abbreviation, such as VA. Required when the vendor country is US. Ignored for non-US vendor countries.
Default: null
state (anyOf 2)nullAlternative
vendor_tracking_category_option_idstringOptionalUnique identifier of the vendor. At most one of `accounting_vendor_remote_id` or `vendor_tracking_category_option_id` should be provided.
Format: uuid

Referenced models: Create a new vendor — request body — body address

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.