Ramp: Create a new vendor — request body — body
Create a new vendor: request body, field body. Complete fields and constraints for contract 2026-10-27.
API reference · Contract 2026-10-27
SDK schema: Create a new vendor — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounting_vendor_remote_id | string | Optional | The accounting remote id of the vendor. At most one of `accounting_vendor_remote_id` or `vendor_tracking_category_option_id` should be provided. The referenced accounting vendor must not already be linked to another Ramp vendor. |
acting_user_id | JSON | Optional | |
acting_user_id (anyOf 1) | string | Alternative | Deprecated and ignored. This field is accepted for backward compatibility only. Use `requesting_user_id` to control the requestor on vendor detail requests. Default: null Format: uuid |
acting_user_id (anyOf 2) | null | Alternative | |
address | Model | Optional | Expand Create a new vendor — request body — body address The address of the vendor. |
business_vendor_contacts | Model | Required within parent | Expand Create a new vendor — request body — body business vendor contacts Detailed information about the vendor contact. |
country | JSON | Optional | |
country (anyOf 1) | string | Alternative | The country of the vendor. Defaults to US when omitted or null. |
country (anyOf 2) | null | Alternative | |
default_entity_id | JSON | Optional | |
default_entity_id (anyOf 1) | string | Alternative | Unique identifier of the default business entity to associate with this vendor. Must belong to the current business. If omitted, the vendor is created without a default entity. Default: null Format: uuid |
default_entity_id (anyOf 2) | null | Alternative | |
external_vendor_id | JSON | Optional | |
external_vendor_id (anyOf 1) | string | Alternative | Customer-defined external identifier for the vendor. This is independent of accounting system remote IDs. Default: null |
external_vendor_id (anyOf 2) | null | Alternative | |
name | string | Optional | Name of the new vendor to be created. Minimum length: 1 |
net_payment_terms | JSON | Optional | |
net_payment_terms (anyOf 1) | integer | Alternative | Number of days after receipt that payment is due. 0 means due on receipt. Null clears terms; omission may inherit terms from a parent vendor. Maximum: 3652058 Minimum: 0 |
net_payment_terms (anyOf 2) | null | Alternative | |
parent_vendor_id | JSON | Optional | |
parent_vendor_id (anyOf 1) | string | Alternative | Unique identifier of the parent vendor to associate with this vendor. Default: null Format: uuid |
parent_vendor_id (anyOf 2) | null | Alternative | |
request_payment_details | boolean | Optional | Whether to request payment details from the vendor (ACH bank account, international wire transfer, and check mailing address). Requires a contact email. Default: false |
request_tax_details | boolean | Optional | Whether to request tax information from the vendor (Tax Identification Number, federal tax classification, and tax address). Requires a contact email. Default: false |
requesting_user_id | JSON | Optional | |
requesting_user_id (anyOf 1) | string | Alternative | Unique identifier of the Ramp user to record as the requestor for any payment or tax details request created during vendor creation. Defaults to existing vendor creation behavior when omitted. Requires the token user to have admin or owner privileges. Default: null Format: uuid |
requesting_user_id (anyOf 2) | null | Alternative | |
state | JSON | Optional | |
state (anyOf 1) | string | Alternative | Optional vendor-level two-letter US state abbreviation, such as VA. Ignored for non-US vendor countries. Default: null |
state (anyOf 2) | null | Alternative | |
vendor_owner_id | JSON | Optional | |
vendor_owner_id (anyOf 1) | string | Alternative | Unique identifier of the user that will own this vendor. If omitted, the vendor will be created without an owner. Default: null Format: uuid |
vendor_owner_id (anyOf 2) | null | Alternative | |
vendor_tracking_category_option_id | string | Optional | Ramp unique identifier of the accounting vendor to link to this vendor. At most one of `accounting_vendor_remote_id` or `vendor_tracking_category_option_id` should be provided. The referenced accounting vendor must not already be linked to another Ramp vendor. Format: uuid |
Referenced models: Create a new vendor — request body — body business vendor contacts, Create a new vendor — request body — body address