Ramp: Update a custom accounting field option — accounting patch Custom Field Option Resource
Ramp accounting.patchCustomFieldOptionResource: arguments, response, policy and SDK examples.
← Accounting operations · Get started
Operation ramp.patch_custom_field_option_resource
Provider route: PATCH /developer/v1/accounting/field-options/{field_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"]["patchCustomFieldOptionResource"]>[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.patchCustomFieldOptionResource(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_custom_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.field_option_id | string | Required within parent | |
body | Model | Required within parent | Expand 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
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 a Ramp-only field option — response body |
Referenced models: Update a Ramp-only field option — response body
Schemas
Section titled “Schemas”Update a custom accounting field option — accounting put Custom Field Option Resource — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
code | string | Optional | Only 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_name | string | Optional | Available to all: Update the display name of the custom field option. |
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 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)[] | string | Each item | Minimum length: 1 |
entity_remote_ids (anyOf 2) | null | Alternative | |
reactivate | boolean | Optional | Only available if not using a direct ERP integration: reactivate a deleted custom field option One of: true |
value | string | Optional | Only available if not using a direct ERP integration: Name of the custom accounting field option. |
visibility | string | Optional | Available to all: Hide or Show option One of: HIDDEN, VISIBLE |
Update a Ramp-only field 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 custom accounting field option belongs to. Format: uuid |
code | string | Optional | Code of the custom field option; Usually it is a unique identifier for the custom field option in the remote ERP system. |
created_at | string | Optional | Format: date-time |
display_name | string | Optional | Display name of the custom field option. |
entity_remote_ids | JSON | Required within parent | |
entity_remote_ids (anyOf 1) | array | Alternative | Remote/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)[] | string | Each item | |
entity_remote_ids (anyOf 2) | null | Alternative | |
id | string | Optional | Remote/external ID of custom accounting field option from ERP system. |
is_active | boolean | Optional | |
provider_name | JSON | Required within parent | |
provider_name (anyOf 1) | string | Alternative | Name of the accounting connection that the custom accounting field option belongs to. Read only: true |
provider_name (anyOf 2) | null | Alternative | |
ramp_id | string | Optional | id to uniquely identify a custom field option within Ramp system Format: uuid |
updated_at | string | Optional | Format: date-time |
value | string | Optional | A vendor is a person or business that provides goods or services |
visibility | string | Optional | Visibility of the custom field option. Known values: HIDDEN, VISIBLE |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: ramp.patch_custom_field_option_resource. Catalog operation: patch_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"]