Ramp: Update an inventory item option
Ramp accounting.patchInventoryItemFieldOptionResource: arguments, response, policy and SDK examples.
← Accounting operations · Get started
Operation ramp.patch_inventory_item_field_option_resource
Provider route: PATCH /developer/v1/accounting/inventory-item/options/{option_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"]["patchInventoryItemFieldOptionResource"]>[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.patchInventoryItemFieldOptionResource(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_inventory_item_field_option_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.option_id | string | Required within parent | |
body | Model | Required within parent | Expand Update an inventory item option — request body — body |
Referenced models: Update an inventory item option — 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 Update an inventory item option — response body |
Referenced models: Update an inventory item option — response body
Schemas
Section titled “Schemas”Update an inventory item option — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounting_connection_id | string | Required within parent | ID of the accounting connection that the inventory item option belongs to. Format: uuid |
entity_remote_ids | JSON | Required within parent | |
entity_remote_ids (anyOf 1) | array | Alternative | Remote/external IDs of entities that this inventory item option is available for. Null means the inventory item option is available for all connected entities. Read only: true |
entity_remote_ids (anyOf 1)[] | string | Each item | |
entity_remote_ids (anyOf 2) | null | Alternative | |
gl_account_id | JSON | Required within parent | |
gl_account_id (anyOf 1) | string | Alternative | The Ramp ID of the GL account associated with this inventory item option, or null if no GL account is linked. Format: uuid Read only: true |
gl_account_id (anyOf 2) | null | Alternative | |
id | string | Required within parent | The external ID of the inventory item option. This is the ID in your ERP system. |
is_active | boolean | Required within parent | Whether the inventory item option is active. |
name | string | Required within parent | The name of the inventory item option. |
ramp_id | string | Required within parent | Unique identifier for the inventory item option within Ramp system. Format: uuid |
Update an inventory item option — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounting_connection_id | JSON | Optional | |
accounting_connection_id (anyOf 1) | string | Alternative | If this inventory item option belongs to an inactive accounting connection, you must specify that accounting connection's ID. Format: uuid |
accounting_connection_id (anyOf 2) | null | Alternative | |
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 inventory item option should be available for. Pass null to reset the inventory item option 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 | |
gl_account_id | string | Optional | The Ramp ID (ramp_id) of the GL account to associate with this inventory item option. The GL account must already exist in Ramp. Use POST /developer/v1/accounting/accounts to upload GL accounts. Format: uuid |
name | string | Optional | The name of the inventory item option. |
reactivate | boolean | Optional | Reactivate a deleted inventory item option. If provided, this must be true; false is not allowed. One of: true |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: ramp.patch_inventory_item_field_option_resource. Catalog operation: patch_inventory_item_field_option_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"]