Ramp: Fetch a vendor agreement — response body — purchase orders item

API reference · Contract 2026-10-27

SDK schema: Fetch a vendor agreement — response body — purchase orders item

Field	Type	Presence	Description and constraints
$	object	Root
can_view	boolean	Required within parent	Whether the current user has permission to view this purchase order.
documents	array	Required within parent
documents[]	object	Each item
end_date	JSON	Required within parent
end_date (anyOf 1)	string	Alternative	End date of the purchase order. Default: null Format: date
end_date (anyOf 2)	null	Alternative
id	string	Required within parent	Unique identifier for the purchase order.
name	JSON	Required within parent
name (anyOf 1)	string	Alternative	Name of the purchase order. Default: null
name (anyOf 2)	null	Alternative
paid_by_bill_amount	Model	Required within parent	Expand Hold Bill — response body — amount
paid_by_card_amount	Model	Required within parent	Expand Hold Bill — response body — amount
pending_bill_amount	Model	Required within parent	Expand Hold Bill — response body — amount
purchase_order_number	JSON	Required within parent
purchase_order_number (anyOf 1)	string	Alternative	External purchase order number. Default: null
purchase_order_number (anyOf 2)	null	Alternative
spend_request	Model	Required within parent	Expand Fetch a vendor agreement — response body — purchase orders item spend request
start_date	JSON	Required within parent
start_date (anyOf 1)	string	Alternative	Start date of the purchase order. Default: null Format: date
start_date (anyOf 2)	null	Alternative
status	JSON	Optional
status (anyOf 1)	string	Alternative	Known values: CLOSED, DELETED, FULLY_BILLED, OPEN, PARTIALLY_BILLED
status (anyOf 2)	null	Alternative
total_amount	Model	Required within parent	Expand Hold Bill — response body — amount

Referenced models: Fetch a vendor agreement — response body — purchase orders item spend request, Hold Bill — response body — amount