Ramp: Fetch a vendor agreement — response body — payee
Fetch a vendor agreement: response body, field payee. Complete fields and constraints for contract 2026-10-27.
API reference · Contract 2026-10-27
SDK schema: Fetch a vendor agreement — response body — payee
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
approval_instance_uuid | JSON | Required within parent | |
approval_instance_uuid (anyOf 1) | string | Alternative | |
approval_instance_uuid (anyOf 2) | null | Alternative | |
approval_status | string | Required within parent | Known values: APPROVED, PENDING, REJECTED |
available_actions | Model | Required within parent | Expand Fetch a vendor agreement — response body — payee available actions |
business_vendor | JSON | Required within parent | |
business_vendor (anyOf 1) | Model | Alternative | Expand Fetch a vendor agreement — response body — payee business vendor uuid, vendor tracking category option id |
business_vendor (anyOf 2) | null | Alternative | |
card_merchants | array | Required within parent | |
card_merchants[] | Model | Each item | Expand Fetch a vendor agreement — response body — payee card merchants item |
dba_name | JSON | Required within parent | |
dba_name (anyOf 1) | string | Alternative | |
dba_name (anyOf 2) | null | Alternative | |
deleted_at | JSON | Required within parent | |
deleted_at (anyOf 1) | string | Alternative | Format: date-time |
deleted_at (anyOf 2) | null | Alternative | |
image_url | JSON | Required within parent | |
image_url (anyOf 1) | string | Alternative | |
image_url (anyOf 2) | null | Alternative | |
is_draft | boolean | Required within parent | |
name | string | Required within parent | |
owners | array | Required within parent | |
owners[] | Model | Each item | Expand Fetch a vendor agreement — response body — payee owners item |
uuid | string | Required within parent | |
website | JSON | Required within parent | |
website (anyOf 1) | string | Alternative | |
website (anyOf 2) | null | Alternative |
Referenced models: Fetch a vendor agreement — response body — payee owners item, Fetch a vendor agreement — response body — payee business vendor uuid, vendor tracking category option id, Fetch a vendor agreement — response body — payee available actions, Fetch a vendor agreement — response body — payee card merchants item