Ramp: Update a vendor — vendor patch Vendor Resource
Ramp vendor.patchVendorResource: arguments, response, policy and SDK examples.
← Vendor operations · Get started
Operation ramp.patch_vendor_resource
Provider route: PATCH /developer/v1/vendors/{vendor_id}. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”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"]["patchVendorResource"]>[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.patchVendorResource(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom 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.patch_vendor_resource(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.vendor_id | string | Required within parent | Format: uuid |
body | Model | Required within parent | Expand Update a vendor — vendor patch Vendor Resource — request body — body |
Referenced models: Update a vendor — vendor patch Vendor Resource — request body — body
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Create a new vendor — response body |
Referenced models: Create a new vendor — response body
Schemas
Section titled “Schemas”10 more schemas are linked from the tables above, on the schema pages.
Update a vendor — vendor patch Vendor Resource — 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. |
address | Model | Optional | Expand Create a new vendor — request body — body address The address of the vendor. |
country | string | Optional | The country of the vendor. |
default_bank_account_id | string | Optional | Unique identifier of an existing bank account belonging to this vendor to use as its default payment method. The account determines the payment method. Existing bills are not changed. Omit to leave the default unchanged. Format: uuid |
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. Set to null to clear the default entity. Format: uuid |
default_entity_id (anyOf 2) | null | Alternative | |
description | string | Optional | Description of the vendor. |
display_name | string | Optional | Display name of the vendor. An empty string clears it. |
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. |
external_vendor_id (anyOf 2) | null | Alternative | |
is_active | boolean | Optional | Whether this vendor is active. |
name | string | Optional | Name of the vendor. 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 the terms. Omit to leave unchanged. Maximum: 3652058 Minimum: 0 |
net_payment_terms (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 an existing default vendor 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 an existing default vendor contact email. Default: false |
state | JSON | Optional | |
state (anyOf 1) | string | Alternative | Vendor-level two-letter US state abbreviation, such as VA. Required when the vendor country is US. Ignored for non-US vendor countries. Default: null |
state (anyOf 2) | null | Alternative | |
vendor_tracking_category_option_id | string | Optional | Unique identifier of the vendor. At most one of `accounting_vendor_remote_id` or `vendor_tracking_category_option_id` should be provided. Format: uuid |
Referenced models: Create a new vendor — request body — body address
Create a new vendor — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounting_vendor_remote_id | JSON | Required within parent | |
accounting_vendor_remote_id (anyOf 1) | string | Alternative | The accounting remote id of the vendor. |
accounting_vendor_remote_id (anyOf 2) | null | Alternative | |
address | Model | Optional | Expand Create a new vendor — response body — address The default address of the vendor. |
addresses | array | Required within parent | The addresses of the vendor. |
addresses[] | Model | Each item | Expand Create a new vendor — response body — addresses item |
billing_frequency | string | Optional | The billing frequency for this vendor. Known values: ANNUAL, MONTHLY, MULTIPLE, NA, OTHER, QUARTERLY, ROLLING, TBD, TWICE_A_YEAR |
contacts | array | Required within parent | Unique identifiers of contacts associated with this vendor. |
contacts[] | string | Each item | Unique identifier of the vendor contact. Format: uuid |
country | string | Required within parent | The 2-letter country of the vendor. |
created_at | string | Required within parent | The date and time when this vendor was created. Format: date-time |
default_entity_id | JSON | Required within parent | |
default_entity_id (anyOf 1) | string | Alternative | Unique identifier of the default business entity associated with this vendor. Format: uuid |
default_entity_id (anyOf 2) | null | Alternative | |
default_payment_method | JSON | Required within parent | |
default_payment_method (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative | |
description | string | Optional | Description of the vendor. |
display_name | JSON | Required within parent | |
display_name (anyOf 1) | string | Alternative | Display name of the vendor. |
display_name (anyOf 2) | null | Alternative | |
external_vendor_id | JSON | Required within parent | |
external_vendor_id (anyOf 1) | string | Alternative | Customer-defined external identifier for the vendor. This is independent of accounting system remote IDs. |
external_vendor_id (anyOf 2) | null | Alternative | |
federal_tax_classification | string | Optional | The 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 |
id | string | Required within parent | Unique identifier of the vendor. Format: uuid |
is_active | boolean | Required within parent | Whether this vendor is active. |
is_deletable | boolean | Required within parent | Whether this vendor is deletable. Read only: true |
merchant_id | string | Optional | The id of the card merchant. Format: uuid |
name | string | Required within parent | Name of the vendor. |
name_legal | string | Optional | Legal name of the vendor. |
net_payment_terms | JSON | Optional | |
net_payment_terms (anyOf 1) | JSON | Alternative | |
net_payment_terms (anyOf 1) (anyOf 1) | integer | Alternative | Number of days after receipt that payment is due. 0 means due on receipt. |
net_payment_terms (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
net_payment_terms (anyOf 2) | null | Alternative | |
parent_vendor_id | JSON | Required within parent | |
parent_vendor_id (anyOf 1) | string | Alternative | Unique identifier of the parent vendor, if this vendor has one. Format: uuid Read only: true |
parent_vendor_id (anyOf 2) | null | Alternative | |
sk_category_id | JSON | Optional | |
sk_category_id (anyOf 1) | integer | Alternative | Ramp 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) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
sk_category_name | string | Optional | The category name of the vendor. |
state | string | Optional | |
subsidiary | array | Optional | ERP subsidiary identifiers associated with this vendor. Only returned when `include_subsidiary=true`. Read only: true |
subsidiary[] | string | Each item | |
tax_address | Model | Optional | Expand Create a new vendor — response body — address The tax address of the vendor. |
total_spend_all_time | Model | Required within parent | Expand Hold Bill — response body — amount Total spend for all time for this vendor. Read only: true |
total_spend_last_30_days | Model | Required within parent | Expand Hold Bill — response body — amount Total spend for the last 30 days for this vendor. Read only: true |
total_spend_last_365_days | Model | Required within parent | Expand Hold Bill — response body — amount Total spend for the last 365 days for this vendor. Read only: true |
total_spend_ytd | Model | Required within parent | Expand Hold Bill — response body — amount Total spend year-to-date for this vendor. Read only: true |
updated_at | JSON | Required within parent | |
updated_at (anyOf 1) | string | Alternative | The date and time when this vendor was last updated. Format: date-time |
updated_at (anyOf 2) | null | Alternative | |
vendor_owner_id | JSON | Required within parent | |
vendor_owner_id (anyOf 1) | string | Alternative | Unique identifier of the user which owns this vendor. Format: uuid Read only: true |
vendor_owner_id (anyOf 2) | null | Alternative | |
vendor_type | string | Optional | The 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, Hold Bill — response body — amount, Create a new vendor — response body — default payment method policy, update source
Create a new vendor — response body — default payment method policy, update source policy value kind ADDRESS
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Create a new vendor — response body — address |
kind | string | Required within parent | Must equal: ADDRESS |
Referenced models: Create a new vendor — response body — address
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: ramp.patch_vendor_resource. Catalog operation: patch_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:write"]