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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounting_connection_id | string | Required within parent | ID of the accounting connection that the custom accounting fields are uploaded to. Format: uuid |
created_at | string | Optional | Format: date-time |
display_name | JSON | Required within parent | |
display_name (anyOf 1) | string | Alternative | Name of the custom accounting field on Ramp. |
display_name (anyOf 2) | null | Alternative | |
id | string | Optional | Remote/external ID of custom accounting field from ERP system. |
input_type | string | Required within parent | The input type for the custom accounting field. Known values: BOOLEAN, DATE, FREE_FORM_TEXT, SINGLE_CHOICE |
is_active | boolean | Optional | |
is_required_for | array | Required within parent | Types 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[] | string | Each item | Known values: BILL, BILL_PAYMENT, CUSTOMER, INVOICE, PURCHASE_ORDER, REIMBURSEMENT, SPEND_PROGRAM, TRANSACTION, TRANSFER_LEDGER_ENTRY_MAPPING, VENDOR_CREDIT |
is_splittable | boolean | Optional | |
name | string | Optional | Name of the custom accounting field in the remote ERP system. |
provider_name | JSON | Required within parent | |
provider_name (anyOf 1) | string | Alternative | Name of the accounting connection that the custom accounting field is uploaded to. Read only: true |
provider_name (anyOf 2) | null | Alternative | |
ramp_id | string | Optional | id to uniquely identify a custom accounting field within Ramp system Format: uuid |
updated_at | string | Optional | Format: date-time |