Skip to content

Ramp: Create a new vendor

Ramp vendor.postVendorListResource: arguments, response, policy and SDK examples.

← Vendor operations · Get started

Operation ramp.post_vendor_list_resource

Provider route: POST /developer/v1/vendors. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/ramp with npm, or alter-sdk-ramp with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { RampIntegration } from "@alter-ai/ramp";
async function execute(input: Parameters<RampIntegration["vendor"]["postVendorListResource"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new RampIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.vendor.postVendorListResource(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_ramp import RampIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = RampIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.vendor.post_vendor_list_resource(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
bodyModelRequired within parentExpand Create a new vendor — request body — body

Referenced models: Create a new vendor — request body — body

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Create a new vendor — response body

Referenced models: Create a new vendor — response body

7 more schemas are linked from the tables above, on the schema pages.

Create a new vendor — request body — body
FieldTypePresenceDescription and constraints
$objectRoot
accounting_vendor_remote_idstringOptionalThe 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_idJSONOptional
acting_user_id (anyOf 1)stringAlternativeDeprecated 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)nullAlternative
addressModelOptionalExpand Create a new vendor — request body — body address
The address of the vendor.
business_vendor_contactsModelRequired within parentExpand Create a new vendor — request body — body business vendor contacts
Detailed information about the vendor contact.
countryJSONOptional
country (anyOf 1)stringAlternativeThe country of the vendor. Defaults to US when omitted or null.
country (anyOf 2)nullAlternative
default_entity_idJSONOptional
default_entity_id (anyOf 1)stringAlternativeUnique 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)nullAlternative
external_vendor_idJSONOptional
external_vendor_id (anyOf 1)stringAlternativeCustomer-defined external identifier for the vendor. This is independent of accounting system remote IDs.
Default: null
external_vendor_id (anyOf 2)nullAlternative
namestringOptionalName of the new vendor to be created.
Minimum length: 1
net_payment_termsJSONOptional
net_payment_terms (anyOf 1)integerAlternativeNumber 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)nullAlternative
parent_vendor_idJSONOptional
parent_vendor_id (anyOf 1)stringAlternativeUnique identifier of the parent vendor to associate with this vendor.
Default: null
Format: uuid
parent_vendor_id (anyOf 2)nullAlternative
request_payment_detailsbooleanOptionalWhether 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_detailsbooleanOptionalWhether to request tax information from the vendor (Tax Identification Number, federal tax classification, and tax address). Requires a contact email.
Default: false
requesting_user_idJSONOptional
requesting_user_id (anyOf 1)stringAlternativeUnique 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)nullAlternative
stateJSONOptional
state (anyOf 1)stringAlternativeOptional vendor-level two-letter US state abbreviation, such as VA. Ignored for non-US vendor countries.
Default: null
state (anyOf 2)nullAlternative
vendor_owner_idJSONOptional
vendor_owner_id (anyOf 1)stringAlternativeUnique 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)nullAlternative
vendor_tracking_category_option_idstringOptionalRamp 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

Create a new vendor — request body — body business vendor contacts
FieldTypePresenceDescription and constraints
$objectRoot
emailstringRequired within parent
first_namestringOptional
last_namestringOptional
phonestringOptional
Create a new vendor — request body — body address
FieldTypePresenceDescription and constraints
$objectRoot
address_line_1stringRequired within parentPrimary address line of the vendor.
address_line_2JSONOptional
address_line_2 (anyOf 1)stringAlternativeSecondary address line or suite number of the vendor.
address_line_2 (anyOf 2)nullAlternative
citystringRequired within parentCity of the vendor address.
countrystringRequired within parentCountry of the vendor address.
pay_to_nameJSONOptional
pay_to_name (anyOf 1)stringAlternativeRecipient name printed on checks mailed to this address. Defaults to the vendor name.
Pattern: \s*\S
pay_to_name (anyOf 2)nullAlternative
postal_codestringRequired within parentPostal or ZIP code of the vendor address.
stateJSONOptional
state (anyOf 1)stringAlternativeAddress state/province abbreviation. For US addresses, use the two-letter state abbreviation, such as VA. Required for addresses in US, CA, and AU. Ignored for other countries.
state (anyOf 2)nullAlternative
Create a new vendor — response body — address
FieldTypePresenceDescription and constraints
$objectRoot
address_line_1stringRequired within parentPrimary address line of the vendor address.
address_line_2stringOptionalSecondary address line of the vendor address.
citystringRequired within parentCity of the vendor address.
countrystringRequired within parentCountry of the vendor address.
postal_codestringRequired within parentPostal or ZIP code of the vendor address.
statestringOptionalState or province of the vendor address.
Create a new vendor — response body — addresses item
FieldTypePresenceDescription and constraints
$objectRoot
address_line_1stringRequired within parentPrimary address line of the vendor address.
address_line_2stringOptionalSecondary address line of the vendor address.
citystringRequired within parentCity of the vendor address.
countrystringRequired within parentCountry of the vendor address.
idstringRequired within parentUnique identifier of the vendor address.
Format: uuid
is_defaultbooleanRequired within parentWhether this is the vendor's default address.
Read only: true
pay_to_namestringRequired within parentRecipient name printed on checks mailed to this address.
postal_codestringRequired within parentPostal or ZIP code of the vendor address.
statestringOptionalState or province of the vendor address.
Hold Bill — response body — amount
FieldTypePresenceDescription and constraints
$objectRoot
amountJSONRequired within parent
amount (anyOf 1)integerAlternativethe amount of money represented in the smallest denomination of the currency. For example, when the currency is USD, then the amount is expressed in cents.
amount (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
currency_codestringRequired within parentThe type of currency, in ISO 4217 format. e.g. USD for US dollars
Default: USD
minor_unit_conversion_rateJSONRequired within parent
minor_unit_conversion_rate (anyOf 1)JSONAlternative
minor_unit_conversion_rate (anyOf 1) (anyOf 1)integerAlternativeThe conversion factor to convert from the integer amount to the actual currency value. Divide amount by this value to get the real currency amount. For USD, this is 100 (e.g., 12034 / 100 = 120.34 USD). See https://docs.ramp.com/developer-api/v1/monetary-values for more information.
Read only: true
minor_unit_conversion_rate (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
minor_unit_conversion_rate (anyOf 2)nullAlternative
Create a new vendor — response body — default payment method policy, update source
FieldTypePresenceDescription and constraints
$objectRoot
policyJSONOptional
policy (anyOf 1)ModelAlternativeExpand Create a new vendor — response body — default payment method policy, update source policy value
policy (anyOf 2)nullAlternative
update_sourceJSONOptional
update_source (anyOf 1)stringAlternativeKnown values: AUTO, MANUAL
update_source (anyOf 2)nullAlternative

Referenced models: Create a new vendor — response body — default payment method policy, update source policy value

SDK function policy ID: ramp.post_vendor_list_resource. Catalog operation: post_vendor_list_resource. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["vendors:write"]

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.