Skip to content

Ramp: Fetch a Ramp-only accounting field

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

← Accounting operations · Get started

Operation ramp.get_ramp_field_resource

Provider route: GET /developer/v1/accounting/ramp-fields/{field_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"]["getRampFieldResource"]>[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.getRampFieldResource(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_resource(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.field_idstringRequired within parentFormat: uuid
queryobjectOptionalAdditional keys: not allowed
query.accounting_connection_idJSONOptional
query.accounting_connection_id (anyOf 1)stringAlternativeFormat: uuid
query.accounting_connection_id (anyOf 2)nullAlternative

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Fetch a custom accounting field — response body

Referenced models: Fetch a custom accounting field — response body

Fetch a custom accounting field — response body
FieldTypePresenceDescription and constraints
$objectRoot
accounting_connection_idstringRequired within parentID of the accounting connection that the custom accounting fields are uploaded to.
Format: uuid
created_atstringOptionalFormat: date-time
display_nameJSONRequired within parent
display_name (anyOf 1)stringAlternativeName of the custom accounting field on Ramp.
display_name (anyOf 2)nullAlternative
idstringOptionalRemote/external ID of custom accounting field from ERP system.
input_typestringRequired within parentThe input type for the custom accounting field.
Known values: BOOLEAN, DATE, FREE_FORM_TEXT, SINGLE_CHOICE
is_activebooleanOptional
is_required_forarrayRequired within parentTypes of objects that require this accounting field to be used for coding before they can be marked as ready to sync.
Read only: true
is_required_for[]stringEach itemKnown values: BILL, BILL_PAYMENT, CUSTOMER, INVOICE, PURCHASE_ORDER, REIMBURSEMENT, SPEND_PROGRAM, TRANSACTION, TRANSFER_LEDGER_ENTRY_MAPPING, VENDOR_CREDIT
is_splittablebooleanOptional
namestringOptionalName of the custom accounting field in the remote ERP system.
provider_nameJSONRequired within parent
provider_name (anyOf 1)stringAlternativeName of the accounting connection that the custom accounting field is uploaded to.
Read only: true
provider_name (anyOf 2)nullAlternative
ramp_idstringOptionalid to uniquely identify a custom accounting field within Ramp system
Format: uuid
updated_atstringOptionalFormat: date-time

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

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.