Ramp: Upload new options
Ramp accounting.postCustomFieldOptionListResource: arguments, response, policy and SDK examples.
← Accounting operations · Get started
Operation ramp.post_custom_field_option_list_resource
Provider route: POST /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"]["postCustomFieldOptionListResource"]>[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.postCustomFieldOptionListResource(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.post_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 |
body | Model | Required within parent | Expand Upload new options — request body — body |
Referenced models: Upload new options — 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 Upload new options — response body |
Referenced models: Upload new options — response body
Schemas
Section titled “Schemas”Upload new options — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounting_connection_id | JSON | Optional | |
accounting_connection_id (anyOf 1) | string | Alternative | Specify an accounting connection. This connection must be an accounting API based connection. If not provided we default to the current active connection. Format: uuid |
accounting_connection_id (anyOf 2) | null | Alternative | |
field_id | string | Required within parent | The ID of the custom accounting field that this custom accounting field option belongs to. This is the ramp_id returned from custom field endpoints. Format: uuid |
options | array | Required within parent | A list of field options for a given custom accounting field. Maximum items: 500 Minimum items: 1 |
options[] | Model | Each item | Expand Upload new options — request body — body options item |
Referenced models: Upload new options — request body — body options item
Upload new options — 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 options are uploaded to. Format: uuid |
options | array | Optional | A list of custom accounting field options that are successfully uploaded. |
options[] | Model | Each item | Expand Update a Ramp-only field option — response body |
uploaded | array | Optional | A list of uuids from the uploaded vendors, gl accounts or custom accounting field options. |
uploaded[] | string | Each item | Format: uuid |
Referenced models: Update a Ramp-only field option — response body
Upload new options — request body — body options item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
code | string | Optional | Code of the custom accounting field option; e.g. 400-100. |
display_name | string | Optional | Set an optional user-facing display name of the custom field option. |
entity_remote_ids | array | Optional | Remote/external IDs of entities created through POST /developer/v1/accounting/entities that this custom field option should be available for. Omit this field to make the custom field option available for all connected entities on accounting connections with entity selection enabled. Minimum items: 1 |
entity_remote_ids[] | string | Each item | Minimum length: 1 |
id | string | Required within parent | Remote/external ID of custom accounting field option from ERP system. |
value | string | Required within parent | e.g. Employees:Salaries & Wages |
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.post_custom_field_option_list_resource. Catalog operation: post_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:write"]