Ramp: Update a tax code option
Ramp accounting.patchTaxCodeFieldOptionResource: arguments, response, policy and SDK examples.
← Accounting operations · Get started
Operation ramp.patch_tax_code_field_option_resource
Provider route: PATCH /developer/v1/accounting/tax/code/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"]["patchTaxCodeFieldOptionResource"]>[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.patchTaxCodeFieldOptionResource(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_tax_code_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 a tax code option — request body — body |
Referenced models: Update a tax code 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 a tax code option — response body |
Referenced models: Update a tax code option — response body
Schemas
Section titled “Schemas”Update a tax code 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 tax code 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 tax code option is available for. Null means the 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 | Required within parent | The external ID of the tax code option. This is the ID in your ERP system. |
is_active | boolean | Required within parent | Whether the tax code option is active. |
name | string | Required within parent | The name of the tax code option. |
ramp_id | string | Required within parent | Unique identifier for the tax code option within Ramp system. Format: uuid |
tax_rate_ids | array | Required within parent | A list of external tax rate IDs (remote_id values) associated with this tax code option. Read only: true |
tax_rate_ids[] | string | Each item |
Update a tax code 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 tax code 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 that this tax code option should be available for. Null means the option is available for all connected entities. If provided, this value replaces the existing entity remote IDs. Minimum items: 1 |
entity_remote_ids (anyOf 1)[] | string | Each item | Minimum length: 1 |
entity_remote_ids (anyOf 2) | null | Alternative | |
name | string | Optional | The name of the tax code option. |
tax_rate_ids | array | Optional | A list of external tax rate IDs (remote_id values) to associate with this tax code option. If this value is provided, it will replace all existing tax rate IDs. |
tax_rate_ids[] | string | Each item |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: ramp.patch_tax_code_field_option_resource. Catalog operation: patch_tax_code_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"]