Skip to content

Ramp: Fetch a vendor — vendor get Vendor Resource

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

← Vendor operations · Get started

Operation ramp.get_vendor_resource

Provider route: GET /developer/v1/vendors/{vendor_id}. 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"]["getVendorResource"]>[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.getVendorResource(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.get_vendor_resource(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.vendor_idstringRequired within parentFormat: uuid

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Fetch a vendor — vendor get Vendor Resource — response body

Referenced models: Fetch a vendor — vendor get Vendor Resource — response body

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

Fetch a vendor — vendor get Vendor Resource — response body
FieldTypePresenceDescription and constraints
$objectRoot
accounting_vendor_remote_idJSONRequired within parent
accounting_vendor_remote_id (anyOf 1)stringAlternativeThe accounting remote id of the vendor.
accounting_vendor_remote_id (anyOf 2)nullAlternative
addressModelOptionalExpand Create a new vendor — response body — address
The default address of the vendor.
addressesarrayRequired within parentThe addresses of the vendor.
addresses[]ModelEach itemExpand Create a new vendor — response body — addresses item
approval_statusstringRequired within parentApproval status of the vendor.
Known values: APPROVED, PENDING, REJECTED
billing_frequencystringOptionalThe billing frequency for this vendor.
Known values: ANNUAL, MONTHLY, MULTIPLE, NA, OTHER, QUARTERLY, ROLLING, TBD, TWICE_A_YEAR
contactsarrayRequired within parentUnique identifiers of contacts associated with this vendor.
contacts[]stringEach itemUnique identifier of the vendor contact.
Format: uuid
countrystringRequired within parentThe 2-letter country of the vendor.
created_atstringRequired within parentThe date and time when this vendor was created.
Format: date-time
custom_form_collection_responseJSONRequired within parent
custom_form_collection_response (anyOf 1)ModelAlternativeExpand Fetch a custom form collection response by ID — response body — custom form collection response
Custom form collection with an associated response log entry.
Read only: true
custom_form_collection_response (anyOf 2)nullAlternative
custom_record_fieldsJSONRequired within parent
custom_record_fields (anyOf 1)arrayAlternativeRead only: true
custom_record_fields (anyOf 1)[]ModelEach itemExpand Get a business entity — response body — custom record fields item
custom_record_fields (anyOf 2)nullAlternative
default_entity_idJSONRequired within parent
default_entity_id (anyOf 1)stringAlternativeUnique identifier of the default business entity associated with this vendor.
Format: uuid
default_entity_id (anyOf 2)nullAlternative
default_payment_methodJSONRequired within parent
default_payment_method (anyOf 1)ModelAlternativeExpand Create a new vendor — response body — default payment method policy, update source
Default payment method for this vendor, including update source and policy.
Read only: true
default_payment_method (anyOf 2)nullAlternative
descriptionstringOptionalDescription of the vendor.
display_nameJSONRequired within parent
display_name (anyOf 1)stringAlternativeDisplay name of the vendor.
display_name (anyOf 2)nullAlternative
external_vendor_idJSONRequired within parent
external_vendor_id (anyOf 1)stringAlternativeCustomer-defined external identifier for the vendor. This is independent of accounting system remote IDs.
external_vendor_id (anyOf 2)nullAlternative
federal_tax_classificationstringOptionalThe federal tax classification of the vendor.
Known values: C_CORPORATION, INDIVIDUAL_SOLE_PROPRIETOR_SINGLE_MEMBER_LLC, INTERNATIONAL, LLC_C_CORPORATION, LLC_PARTNERSHIP, LLC_S_CORPORATION, OTHER, PARTNERSHIP, S_CORPORATION, TRUST_ESTATE
idstringRequired within parentUnique identifier of the vendor.
Format: uuid
is_activebooleanRequired within parentWhether this vendor is active.
is_deletablebooleanRequired within parentWhether this vendor is deletable.
Read only: true
merchant_idstringOptionalThe id of the card merchant.
Format: uuid
namestringRequired within parentName of the vendor.
name_legalstringOptionalLegal name of the vendor.
net_payment_termsJSONOptional
net_payment_terms (anyOf 1)JSONAlternative
net_payment_terms (anyOf 1) (anyOf 1)integerAlternativeNumber of days after receipt that payment is due. 0 means due on receipt.
net_payment_terms (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
net_payment_terms (anyOf 2)nullAlternative
parent_vendor_idJSONRequired within parent
parent_vendor_id (anyOf 1)stringAlternativeUnique identifier of the parent vendor, if this vendor has one.
Format: uuid
Read only: true
parent_vendor_id (anyOf 2)nullAlternative
sk_category_idJSONOptional
sk_category_id (anyOf 1)integerAlternativeRamp category code of the vendor.
Known values: 1, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 2, 20, 21, 23, 24, 25, 26, 27, 28, 29, 3, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 4, 40, 41, 42, 43, 44, 5, 6, 7, 8, 9
sk_category_id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
sk_category_namestringOptionalThe category name of the vendor.
statestringOptional
subsidiaryarrayOptionalERP subsidiary identifiers associated with this vendor. Only returned when `include_subsidiary=true`.
Read only: true
subsidiary[]stringEach item
tax_addressModelOptionalExpand Create a new vendor — response body — address
The tax address of the vendor.
total_spend_all_timeModelRequired within parentExpand Hold Bill — response body — amount
Total spend for all time for this vendor.
Read only: true
total_spend_last_30_daysModelRequired within parentExpand Hold Bill — response body — amount
Total spend for the last 30 days for this vendor.
Read only: true
total_spend_last_365_daysModelRequired within parentExpand Hold Bill — response body — amount
Total spend for the last 365 days for this vendor.
Read only: true
total_spend_ytdModelRequired within parentExpand Hold Bill — response body — amount
Total spend year-to-date for this vendor.
Read only: true
updated_atJSONRequired within parent
updated_at (anyOf 1)stringAlternativeThe date and time when this vendor was last updated.
Format: date-time
updated_at (anyOf 2)nullAlternative
vendor_owner_idJSONRequired within parent
vendor_owner_id (anyOf 1)stringAlternativeUnique identifier of the user which owns this vendor.
Format: uuid
Read only: true
vendor_owner_id (anyOf 2)nullAlternative
vendor_typestringOptionalThe type of vendor if bill pay.
Known values: BUSINESS, INDIVIDUAL

Referenced models: Create a new vendor — response body — address, Create a new vendor — response body — addresses item, Fetch a custom form collection response by ID — response body — custom form collection response, Hold Bill — response body — amount, Get a business entity — response body — custom record fields item, Create a new vendor — response body — default payment method policy, update source

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.
Get a business entity — response body — custom record fields item value type boolean
FieldTypePresenceDescription and constraints
$objectRoot
display_namestringRequired within parent
typestringRequired within parentMust equal: boolean
valuebooleanRequired within parent

SDK function policy ID: ramp.get_vendor_resource. Catalog operation: get_vendor_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:read"]

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.