Skip to content

Ramp: List inventory item options

Ramp accounting.getInventoryItemFieldOptionsListResource: arguments, response, policy and SDK examples.

← Accounting operations · Get started

Operation ramp.get_inventory_item_field_options_list_resource

Provider route: GET /developer/v1/accounting/inventory-item/options. 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["accounting"]["getInventoryItemFieldOptionsListResource"]>[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.getInventoryItemFieldOptionsListResource(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.accounting.get_inventory_item_field_options_list_resource(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectOptionalAdditional keys: not allowed
query.remote_idstringOptional
query.is_activebooleanOptional
query.codestringOptional
query.accounting_connection_idJSONOptional
query.accounting_connection_id (anyOf 1)stringAlternativeFormat: uuid
query.accounting_connection_id (anyOf 2)nullAlternative
query.startstringOptional
query.page_sizeintegerOptionalDefault: 20
query.is_syncedbooleanOptional

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

FieldTypePresenceDescription and constraints
$ModelRootExpand List inventory item options — response body

Referenced models: List inventory item options — response body

List inventory item options — response body
FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentResources returned in this page.
data[]ModelEach itemExpand Update an inventory item option — response body
pageModelRequired within parentExpand List bills — response body — page
Pagination details for this response.

Referenced models: Update an inventory item option — response body, List bills — response body — page

Update an inventory item option — response body
FieldTypePresenceDescription and constraints
$objectRoot
accounting_connection_idstringRequired within parentID of the accounting connection that the inventory item option belongs to.
Format: uuid
entity_remote_idsJSONRequired within parent
entity_remote_ids (anyOf 1)arrayAlternativeRemote/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)[]stringEach item
entity_remote_ids (anyOf 2)nullAlternative
gl_account_idJSONRequired within parent
gl_account_id (anyOf 1)stringAlternativeThe 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)nullAlternative
idstringRequired within parentThe external ID of the inventory item option. This is the ID in your ERP system.
is_activebooleanRequired within parentWhether the inventory item option is active.
namestringRequired within parentThe name of the inventory item option.
ramp_idstringRequired within parentUnique identifier for the inventory item option within Ramp system.
Format: uuid
List bills — response body — page
FieldTypePresenceDescription and constraints
$objectRootPagination details for a Developer API response.
nextJSONRequired within parent
next (anyOf 1)stringAlternativethe query to get to the next page; it is in the format of <BASE_URL>?<new_params>
next (anyOf 2)nullAlternative

SDK function policy ID: ramp.get_inventory_item_field_options_list_resource. Catalog operation: get_inventory_item_field_options_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: ["accounting: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.