Ramp: List options for a given custom accounting field
Ramp accounting.getCustomFieldOptionListResource: arguments, response, policy and SDK examples.
← Accounting operations · Get started
Operation ramp.get_custom_field_option_list_resource
Provider route: GET /developer/v1/accounting/field-options. 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"]["getCustomFieldOptionListResource"]>[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.getCustomFieldOptionListResource(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.get_custom_field_option_list_resource(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
query | object | Optional | Additional keys: not allowed |
query.remote_id | string | Optional | |
query.is_active | boolean | Optional | |
query.code | string | Optional | |
query.visibility | string | Optional | One of: HIDDEN, VISIBLE |
query.accounting_connection_id | JSON | Optional | |
query.accounting_connection_id (anyOf 1) | string | Alternative | Format: uuid |
query.accounting_connection_id (anyOf 2) | null | Alternative | |
query.field_remote_id | string | Optional | Minimum length: 1 |
query.field_id | string | Optional | Format: uuid |
query.start | string | Optional | |
query.page_size | integer | Optional | Default: 20 |
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 List options for a given custom accounting field — response body |
Referenced models: List options for a given custom accounting field — response body
Schemas
Section titled “Schemas”List options for a given custom accounting field — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | Resources returned in this page. |
data[] | Model | Each item | Expand Update a Ramp-only field option — response body |
page | Model | Required within parent | Expand List bills — response body — page Pagination details for this response. |
Referenced models: List bills — response body — page, Update a Ramp-only field option — response body
List bills — response body — page
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Pagination details for a Developer API response. |
next | JSON | Required within parent | |
next (anyOf 1) | string | Alternative | the query to get to the next page; it is in the format of <BASE_URL>?<new_params> |
next (anyOf 2) | null | Alternative |
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.get_custom_field_option_list_resource. Catalog operation: get_custom_field_option_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:read"]