Skip to content

Ramp: Update a custom accounting field option — accounting put Custom Field Option Resource

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

← Accounting operations · Get started

Operation ramp.put_custom_field_option_resource

Provider route: PUT /developer/v1/accounting/field-options/{field_option_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["accounting"]["putCustomFieldOptionResource"]>[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.putCustomFieldOptionResource(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.put_custom_field_option_resource(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.field_option_idstringRequired within parent
bodyModelRequired within parentExpand Update a custom accounting field option — accounting put Custom Field Option Resource — request body — body

Referenced models: Update a custom accounting field option — accounting put Custom Field Option Resource — request body — body

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Update a Ramp-only field option — response body

Referenced models: Update a Ramp-only field option — response body

Update a custom accounting field option — accounting put Custom Field Option Resource — request body — body
FieldTypePresenceDescription and constraints
$objectRoot
codestringOptionalOnly available if not using a direct ERP integration: Code of the custom accounting field option; you could provide an empty string to reset the code.
display_namestringOptionalAvailable to all: Update the display name of the custom field option.
entity_remote_idsJSONOptional
entity_remote_ids (anyOf 1)arrayAlternativeRemote/external IDs of entities created through POST /developer/v1/accounting/entities that this custom field option should be available for. Pass null to reset the custom field option to all connected entities. Omit this field to leave entity scoping unchanged.
Minimum items: 1
entity_remote_ids (anyOf 1)[]stringEach itemMinimum length: 1
entity_remote_ids (anyOf 2)nullAlternative
reactivatebooleanOptionalOnly available if not using a direct ERP integration: reactivate a deleted custom field option
One of: true
valuestringOptionalOnly available if not using a direct ERP integration: Name of the custom accounting field option.
visibilitystringOptionalAvailable to all: Hide or Show option
One of: HIDDEN, VISIBLE
Update a Ramp-only field option — response body
FieldTypePresenceDescription and constraints
$objectRoot
accounting_connection_idstringRequired within parentID of the accounting connection that the custom accounting field option belongs to.
Format: uuid
codestringOptionalCode of the custom field option; Usually it is a unique identifier for the custom field option in the remote ERP system.
created_atstringOptionalFormat: date-time
display_namestringOptionalDisplay name of the custom field option.
entity_remote_idsJSONRequired within parent
entity_remote_ids (anyOf 1)arrayAlternativeRemote/external IDs of entities that this custom field option is available for. Null means the custom field option is available for all connected entities.
Read only: true
entity_remote_ids (anyOf 1)[]stringEach item
entity_remote_ids (anyOf 2)nullAlternative
idstringOptionalRemote/external ID of custom accounting field option from ERP system.
is_activebooleanOptional
provider_nameJSONRequired within parent
provider_name (anyOf 1)stringAlternativeName of the accounting connection that the custom accounting field option belongs to.
Read only: true
provider_name (anyOf 2)nullAlternative
ramp_idstringOptionalid to uniquely identify a custom field option within Ramp system
Format: uuid
updated_atstringOptionalFormat: date-time
valuestringOptionalA vendor is a person or business that provides goods or services
visibilitystringOptionalVisibility of the custom field option.
Known values: HIDDEN, VISIBLE

SDK function policy ID: ramp.put_custom_field_option_resource. Catalog operation: put_custom_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"]

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.