Skip to content

Ramp: Fetch a custom accounting field — response body

Fetch a custom accounting field: response body. Complete fields and constraints for contract 2026-10-27.

API reference · Contract 2026-10-27

SDK schema: 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

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.