Ramp: List Ramp-only accounting fields

← accounting operations · Get started · OpenAPI downloads

Contract 2026-10-27 · Operation ramp.get_ramp_field_list_resource

Provider route: GET /developer/v1/accounting/ramp-fields. Alter supplies the connection’s credentials and routing.

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"]["getRampFieldListResource"]>[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.getRampFieldListResource(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.get_ramp_field_list_resource(arguments)
        result = await call.wait()
        return result.body_json()

Input

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.accounting_connection_id	JSON	Optional
query.accounting_connection_id (anyOf 1)	string	Alternative	Format: uuid
query.accounting_connection_id (anyOf 2)	null	Alternative
query.start	string	Optional
query.page_size	integer	Optional	Default: 20

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 custom accounting fields — response body

Referenced models: List custom accounting fields — response body

Policy, approvals and errors

SDK function policy ID: ramp.get_ramp_field_list_resource. Catalog operation: get_ramp_field_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"]

Official provider source