Skip to content

Ramp: Bulk delete field option filter rules

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

← Accounting operations · Get started

Operation ramp.delete_field_option_filter_rules_list_resource

Provider route: DELETE /developer/v1/accounting/field-option-filter-rules. 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"]["deleteFieldOptionFilterRulesListResource"]>[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.deleteFieldOptionFilterRulesListResource(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.delete_field_option_filter_rules_list_resource(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
bodyModelRequired within parentExpand Bulk delete field option filter rules — request body — body

Referenced models: Bulk delete field option filter rules — 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 Bulk delete field option filter rules — response body

Referenced models: Bulk delete field option filter rules — response body

Bulk delete field option filter rules — request body — body
FieldTypePresenceDescription and constraints
$objectRoot
accounting_connection_idJSONOptional
accounting_connection_id (anyOf 1)stringAlternativeIf these filter rules belong to an inactive accounting connection, you must specify that accounting connection's ID.
Format: uuid
accounting_connection_id (anyOf 2)nullAlternative
rulesarrayRequired within parentA list of field option filter rules to delete, identified by their target and required selections.
Maximum items: 1000
Minimum items: 1
rules[]ModelEach itemExpand Bulk create field option filter rules — request body — body rules item

Referenced models: Bulk create field option filter rules — request body — body rules item

Bulk delete field option filter rules — response body
FieldTypePresenceDescription and constraints
$objectRoot
deleted_countJSONRequired within parent
deleted_count (anyOf 1)integerAlternativeThe number of filter rules that were deleted.
deleted_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
not_found_countJSONRequired within parent
not_found_count (anyOf 1)integerAlternativeThe number of filter rules that were not found (already deleted or never existed).
not_found_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Bulk create field option filter rules — request body — body rules item
FieldTypePresenceDescription and constraints
$objectRoot
required_selectionsarrayRequired within parentThe set of trigger field option selections that must all be met (AND logic) for the target option to be available. Multiple rules for the same target option use OR logic between them.
Minimum items: 1
required_selections[]ModelEach itemExpand Bulk create field option filter rules — request body — body rules item required selections item
target_field_option_remote_idstringRequired within parentThe remote ID of the target field option that is conditionally available.
Minimum length: 1
target_field_remote_idstringRequired within parentThe remote ID of the target accounting field whose options are filtered.
Minimum length: 1

Referenced models: Bulk create field option filter rules — request body — body rules item required selections item

Bulk create field option filter rules — request body — body rules item required selections item
FieldTypePresenceDescription and constraints
$objectRoot
trigger_field_option_remote_idstringRequired within parentThe remote ID of the required field option.
Minimum length: 1
trigger_field_remote_idstringRequired within parentThe remote ID of the required accounting field.
Minimum length: 1

SDK function policy ID: ramp.delete_field_option_filter_rules_list_resource. Catalog operation: delete_field_option_filter_rules_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: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.