Ramp: Fetch a vendor — vendor get Vendor Resource — response body

API reference · Contract 2026-10-27

SDK schema: Fetch a vendor — vendor get Vendor Resource — response body

Field	Type	Presence	Description and constraints
$	object	Root
accounting_vendor_remote_id	JSON	Required within parent
accounting_vendor_remote_id (anyOf 1)	string	Alternative	The accounting remote id of the vendor.
accounting_vendor_remote_id (anyOf 2)	null	Alternative
address	Model	Optional	Expand Create a new vendor — response body — address The default address of the vendor.
addresses	array	Required within parent	The addresses of the vendor.
addresses[]	Model	Each item	Expand Create a new vendor — response body — addresses item
approval_status	string	Required within parent	Approval status of the vendor. Known values: APPROVED, PENDING, REJECTED
billing_frequency	string	Optional	The billing frequency for this vendor. Known values: ANNUAL, MONTHLY, MULTIPLE, NA, OTHER, QUARTERLY, ROLLING, TBD, TWICE_A_YEAR
contacts	array	Required within parent	Unique identifiers of contacts associated with this vendor.
contacts[]	string	Each item	Unique identifier of the vendor contact. Format: uuid
country	string	Required within parent	The 2-letter country of the vendor.
created_at	string	Required within parent	The date and time when this vendor was created. Format: date-time
custom_form_collection_response	JSON	Required within parent
custom_form_collection_response (anyOf 1)	Model	Alternative	Expand Fetch a custom form collection response by ID — response body — custom form collection response Custom form collection with an associated response log entry. Read only: true
custom_form_collection_response (anyOf 2)	null	Alternative
custom_record_fields	JSON	Required within parent
custom_record_fields (anyOf 1)	array	Alternative	Read only: true
custom_record_fields (anyOf 1)[]	Model	Each item	Expand Get a business entity — response body — custom record fields item
custom_record_fields (anyOf 2)	null	Alternative
default_entity_id	JSON	Required within parent
default_entity_id (anyOf 1)	string	Alternative	Unique identifier of the default business entity associated with this vendor. Format: uuid
default_entity_id (anyOf 2)	null	Alternative
default_payment_method	JSON	Required within parent
default_payment_method (anyOf 1)	Model	Alternative	Expand Create a new vendor — response body — default payment method policy, update source Default payment method for this vendor, including update source and policy. Read only: true
default_payment_method (anyOf 2)	null	Alternative
description	string	Optional	Description of the vendor.
external_vendor_id	JSON	Required within parent
external_vendor_id (anyOf 1)	string	Alternative	Customer-defined external identifier for the vendor. This is independent of accounting system remote IDs.
external_vendor_id (anyOf 2)	null	Alternative
federal_tax_classification	string	Optional	The federal tax classification of the vendor. Known values: C_CORPORATION, INDIVIDUAL_SOLE_PROPRIETOR_SINGLE_MEMBER_LLC, INTERNATIONAL, LLC_C_CORPORATION, LLC_PARTNERSHIP, LLC_S_CORPORATION, OTHER, PARTNERSHIP, S_CORPORATION, TRUST_ESTATE
id	string	Required within parent	Unique identifier of the vendor. Format: uuid
is_active	boolean	Required within parent	Whether this vendor is active.
is_deletable	boolean	Required within parent	Whether this vendor is deletable. Read only: true
merchant_id	string	Optional	The id of the card merchant. Format: uuid
name	string	Required within parent	Name of the vendor.
name_legal	string	Optional	Legal name of the vendor.
net_payment_terms	JSON	Optional
net_payment_terms (anyOf 1)	JSON	Alternative
net_payment_terms (anyOf 1) (anyOf 1)	integer	Alternative	Number of days after receipt that payment is due. 0 means due on receipt.
net_payment_terms (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
net_payment_terms (anyOf 2)	null	Alternative
parent_vendor_id	JSON	Required within parent
parent_vendor_id (anyOf 1)	string	Alternative	Unique identifier of the parent vendor, if this vendor has one. Format: uuid Read only: true
parent_vendor_id (anyOf 2)	null	Alternative
sk_category_id	JSON	Optional
sk_category_id (anyOf 1)	integer	Alternative	Ramp category code of the vendor. Known values: 1, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 2, 20, 21, 23, 24, 25, 26, 27, 28, 29, 3, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 4, 40, 41, 42, 43, 44, 5, 6, 7, 8, 9
sk_category_id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
sk_category_name	string	Optional	The category name of the vendor.
state	string	Optional
subsidiary	array	Optional	ERP subsidiary identifiers associated with this vendor. Only returned when `include_subsidiary=true`. Read only: true
subsidiary[]	string	Each item
tax_address	Model	Optional	Expand Create a new vendor — response body — address The tax address of the vendor.
total_spend_all_time	Model	Required within parent	Expand Hold Bill — response body — amount Total spend for all time for this vendor. Read only: true
total_spend_last_30_days	Model	Required within parent	Expand Hold Bill — response body — amount Total spend for the last 30 days for this vendor. Read only: true
total_spend_last_365_days	Model	Required within parent	Expand Hold Bill — response body — amount Total spend for the last 365 days for this vendor. Read only: true
total_spend_ytd	Model	Required within parent	Expand Hold Bill — response body — amount Total spend year-to-date for this vendor. Read only: true
updated_at	JSON	Required within parent
updated_at (anyOf 1)	string	Alternative	The date and time when this vendor was last updated. Format: date-time
updated_at (anyOf 2)	null	Alternative
vendor_owner_id	JSON	Required within parent
vendor_owner_id (anyOf 1)	string	Alternative	Unique identifier of the user which owns this vendor. Format: uuid Read only: true
vendor_owner_id (anyOf 2)	null	Alternative
vendor_type	string	Optional	The type of vendor if bill pay. Known values: BUSINESS, INDIVIDUAL

Referenced models: Create a new vendor — response body — address, Create a new vendor — response body — addresses item, Fetch a custom form collection response by ID — response body — custom form collection response, Hold Bill — response body — amount, Get a business entity — response body — custom record fields item, Create a new vendor — response body — default payment method policy, update source