Skip to content

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.

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 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.patch_tax_code_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.option_idstringRequired within parent
bodyModelRequired within parentExpand Update a tax code option — request body — body

Referenced models: Update a tax code option — 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 tax code option — response body

Referenced models: Update a tax code option — response body

Update a tax code option — response body
FieldTypePresenceDescription and constraints
$objectRoot
accounting_connection_idstringRequired within parentID of the accounting connection that the tax code option belongs to.
Format: uuid
entity_remote_idsJSONRequired within parent
entity_remote_ids (anyOf 1)arrayAlternativeRemote/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)[]stringEach item
entity_remote_ids (anyOf 2)nullAlternative
idstringRequired within parentThe external ID of the tax code option. This is the ID in your ERP system.
is_activebooleanRequired within parentWhether the tax code option is active.
namestringRequired within parentThe name of the tax code option.
ramp_idstringRequired within parentUnique identifier for the tax code option within Ramp system.
Format: uuid
tax_rate_idsarrayRequired within parentA list of external tax rate IDs (remote_id values) associated with this tax code option.
Read only: true
tax_rate_ids[]stringEach item
Update a tax code option — request body — body
FieldTypePresenceDescription and constraints
$objectRoot
accounting_connection_idJSONOptional
accounting_connection_id (anyOf 1)stringAlternativeIf 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)nullAlternative
entity_remote_idsJSONOptional
entity_remote_ids (anyOf 1)arrayAlternativeRemote/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)[]stringEach itemMinimum length: 1
entity_remote_ids (anyOf 2)nullAlternative
namestringOptionalThe name of the tax code option.
tax_rate_idsarrayOptionalA 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[]stringEach item

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"]

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.