Ramp: Fetch a vendor agreement — response body

API reference · Contract 2026-10-27

SDK schema: Fetch a vendor agreement — response body

Field	Type	Presence	Description and constraints
$	object	Root
archived_at	JSON	Optional
archived_at (anyOf 1)	string	Alternative	Format: date-time
archived_at (anyOf 2)	null	Alternative
auto_renewal	boolean	Required within parent	Whether the agreement automatically renews.
available_actions	Model	Required within parent	Expand Fetch a vendor agreement — response body — available actions
comment_thread_uuid	JSON	Required within parent
comment_thread_uuid (anyOf 1)	string	Alternative	Unique identifier of the comment thread for this agreement. Default: null
comment_thread_uuid (anyOf 2)	null	Alternative
contract_owners	array	Required within parent
contract_owners[]	Model	Each item	Expand Fetch a vendor agreement — response body — contract owners item
created_at	string	Required within parent	Format: date-time
currency	string	Required within parent	Currency code for the agreement amounts.
custom_record_field_values	array	Required within parent
custom_record_field_values[]	Model	Each item	Expand Get a business entity — response body — custom record fields item
days_remaining	Model	Required within parent	Expand Fetch a vendor agreement — response body — days remaining
deleted_at	JSON	Optional
deleted_at (anyOf 1)	string	Alternative	Format: date-time
deleted_at (anyOf 2)	null	Alternative
description	JSON	Required within parent
description (anyOf 1)	string	Alternative	Description of the vendor agreement. Default: null
description (anyOf 2)	null	Alternative
draft_spend_requests	array	Required within parent
draft_spend_requests[]	Model	Each item	Expand Fetch a vendor agreement — response body — draft spend requests item
end_date	JSON	Required within parent
end_date (anyOf 1)	string	Alternative	End date of the agreement. Default: null Format: date
end_date (anyOf 2)	null	Alternative
has_approved_renewal_request	boolean	Required within parent	Whether an approved renewal request exists for this agreement.
id	string	Required within parent	Format: uuid
is_active	boolean	Required within parent	Whether the agreement is currently active.
is_snoozed	boolean	Required within parent	Whether renewal notifications for this agreement are snoozed.
is_up_for_renewal	boolean	Required within parent	Whether the agreement is currently up for renewal.
last_date_to_terminate	JSON	Required within parent
last_date_to_terminate (anyOf 1)	string	Alternative	Last date by which the agreement can be terminated. Default: null Format: date
last_date_to_terminate (anyOf 2)	null	Alternative
latest_rejected_renewal_request	JSON	Optional
latest_rejected_renewal_request (anyOf 1)	Model	Alternative	Expand Fetch a vendor agreement — response body — latest rejected renewal request can view, id, reason, rejected at, unified request id, user full name
latest_rejected_renewal_request (anyOf 2)	null	Alternative
line_items	JSON	Optional
line_items (anyOf 1)	array	Alternative
line_items (anyOf 1)[]	object	Each item
line_items (anyOf 2)	null	Alternative
name	string	Required within parent	Name of the vendor agreement.
notification_trigger_group	JSON	Optional
notification_trigger_group (anyOf 1)	Model	Alternative	Expand Fetch a vendor agreement — response body — notification_trigger_group / type: CUSTOM SETTING, DEFAULT BUSINESS SETTING
notification_trigger_group (anyOf 2)	null	Alternative
notifications_on	boolean	Required within parent	Whether notifications are enabled for this agreement.
payee	Model	Required within parent	Expand Fetch a vendor agreement — response body — payee
pending_spend_requests	array	Required within parent
pending_spend_requests[]	Model	Each item	Expand Fetch a vendor agreement — response body — pending spend requests item
purchase_orders	array	Required within parent
purchase_orders[]	Model	Each item	Expand Fetch a vendor agreement — response body — purchase orders item
ramp_event_history_id	string	Required within parent	Format: uuid
renewal_action	JSON	Optional
renewal_action (anyOf 1)	object	Alternative
renewal_action (anyOf 2)	null	Alternative
renewal_status	string	Required within parent	Known values: CANCELLED, EVALUATING, EXPIRED, INITIATED, NOT_STARTED, PLANNING, REJECTED, RENEWED, TERMINATED
start_date	JSON	Required within parent
start_date (anyOf 1)	string	Alternative	Start date of the agreement. Default: null Format: date
start_date (anyOf 2)	null	Alternative
total_value	Model	Required within parent	Expand Hold Bill — response body — amount
updated_at	string	Required within parent	Format: date-time

Referenced models: Fetch a vendor agreement — response body — contract owners item, Fetch a vendor agreement — response body — latest rejected renewal request can view, id, reason, rejected at, unified request id, user full name, Fetch a vendor agreement — response body — days remaining, Fetch a vendor agreement — response body — draft spend requests item, Fetch a vendor agreement — response body — notification_trigger_group / type: CUSTOM SETTING, DEFAULT BUSINESS SETTING, Fetch a vendor agreement — response body — pending spend requests item, Fetch a vendor agreement — response body — purchase orders item, Hold Bill — response body — amount, Get a business entity — response body — custom record fields item, Fetch a vendor agreement — response body — available actions, Fetch a vendor agreement — response body — payee