Ramp: Update a vendor — accounting patch Accounting Vendor Resource
Ramp accounting.patchAccountingVendorResource: arguments, response, policy and SDK examples.
← Accounting operations · Get started
Operation ramp.patch_accounting_vendor_resource
Provider route: PATCH /developer/v1/accounting/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["accounting"]["patchAccountingVendorResource"]>[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.accounting.patchAccountingVendorResource(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.accounting.patch_accounting_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 — accounting patch Accounting Vendor Resource — request body — body |
Referenced models: Update a vendor — accounting patch Accounting 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 Fetch a vendor — accounting get Accounting Vendor Resource — response body |
Referenced models: Fetch a vendor — accounting get Accounting Vendor Resource — response body
Schemas
Section titled “Schemas”Update a vendor — accounting patch Accounting Vendor Resource — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounting_connection_id | string | Optional | If this vendor belongs to an inactive accounting connection, you must specify that accounting connection's ID. Format: uuid |
code | string | Optional | Code of the vendor; you could provide an empty string to reset the code. |
entity_remote_ids | JSON | Optional | |
entity_remote_ids (anyOf 1) | array | Alternative | Remote/external IDs of entities created through POST /developer/v1/accounting/entities that this vendor should be available for. Pass null to reset the vendor to all connected entities. Omit this field to leave entity scoping unchanged. Minimum items: 1 |
entity_remote_ids (anyOf 1)[] | string | Each item | Minimum length: 1 |
entity_remote_ids (anyOf 2) | null | Alternative | |
name | string | Optional | Name of a vendor |
reactivate | boolean | Optional | reactivate a deleted vendor One of: true |
Fetch a vendor — accounting get Accounting Vendor Resource — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounting_connection_id | string | Required within parent | ID of the accounting connection that the vendor is uploaded to. Format: uuid |
code | string | Optional | e.g. 19566 |
created_at | string | Required within parent | Date time at which the vendor account was created on Ramp. Format: date-time |
entity_remote_ids | JSON | Required within parent | |
entity_remote_ids (anyOf 1) | array | Alternative | Remote/external IDs of entities that this vendor is available for. Null means the vendor is available for all connected entities. Read only: true |
entity_remote_ids (anyOf 1)[] | string | Each item | |
entity_remote_ids (anyOf 2) | null | Alternative | |
id | string | Optional | Remote/external ID of accounting vendor in ERP system. |
is_active | boolean | Required within parent | Whether this vendor account is active on Ramp |
is_synced | boolean | Required within parent | Whether this vendor has been synced to remote ERP. |
name | string | Required within parent | Name of the vendor. |
provider_name | JSON | Required within parent | |
provider_name (anyOf 1) | string | Alternative | Name of the accounting connection that the vendor is uploaded to. Read only: true |
provider_name (anyOf 2) | null | Alternative | |
ramp_id | string | Required within parent | id to uniquely identify a vendor account within Ramp system Format: uuid |
updated_at | string | Required within parent | Date time at which the vendor account was most recently updated. Format: date-time |
vendor_category_info | Model | Optional | Expand Fetch a vendor — accounting get Accounting Vendor Resource — response body — vendor category info Category info of the general ledger account. |
Referenced models: Fetch a vendor — accounting get Accounting Vendor Resource — response body — vendor category info
Fetch a vendor — accounting get Accounting Vendor Resource — response body — vendor category info
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Optional | Remote/external ID of the accounting category from ERP system. |
name | string | Optional | Name of the accounting category in the remote ERP system. |
ramp_id | string | Optional | id to uniquely identify the accounting category within Ramp system Format: uuid |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: ramp.patch_accounting_vendor_resource. Catalog operation: patch_accounting_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: ["accounting:write"]