Ramp: Get a business entity — response body
Get a business entity: response body. Complete fields and constraints for contract 2026-10-27.
API reference · Contract 2026-10-27
SDK schema: Get a business entity — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounts | array | Required within parent | Information about the entity’s active accounts Read only: true |
accounts[] | Model | Each item | Expand Get a business entity — response body — accounts item |
connected_subsidiary | JSON | Required within parent | |
connected_subsidiary (anyOf 1) | Model | Alternative | Expand Get a business entity — response body — connected subsidiary external id, id, name The subsidiary in the ERP system that this entity is mapped to. This determines which subsidiary transactions from this entity will be synced to. Read only: true |
connected_subsidiary (anyOf 2) | null | Alternative | |
currency | JSON | Required within parent | |
currency (anyOf 1) | string | Alternative | Currency used by this business entity. Known values: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNH, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, EURC, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, OPEN_USD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLE, SLL, SOS, SRD, SSP, STN, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USDB, USDC, USDG, USDT, USN, UYI, UYU, UYW, UZS, VED, VES, VND, VUV, WST, XAD, XAF, XAG, XAU, XBA, XBB, XBC, XBD, XCD, XCG, XDR, XOF, XPD, XPF, XPT, XSU, XTS, XUA, XXX, YER, ZAR, ZMW, ZWG, ZWL |
currency (anyOf 2) | null | Alternative | |
custom_record_fields | array | Optional | Custom record field values associated with this entity. Only returned when `include_custom_field_values=true`. Read only: true |
custom_record_fields[] | Model | Each item | Expand Get a business entity — response body — custom record fields item |
default_bill_pay_payment_account_id | JSON | Required within parent | |
default_bill_pay_payment_account_id (anyOf 1) | string | Alternative | Bank account UUID of the entity’s configured default Bill Pay payment account, if one exists. This UUID can be matched against payment_accounts[].id and accounts[].bank_account_id when those records are present. Format: uuid Read only: true |
default_bill_pay_payment_account_id (anyOf 2) | null | Alternative | |
entity_name | string | Required within parent | Name of the business entity. |
id | string | Required within parent | Unique identifier for the business entity. Format: uuid |
is_primary | JSON | Required within parent | |
is_primary (anyOf 1) | boolean | Alternative | Whether this is the primary entity for the business. |
is_primary (anyOf 2) | null | Alternative | |
location_ids | array | Required within parent | List of identifiers for locations associated with this entity. Read only: true |
location_ids[] | string | Each item | Format: uuid |
payment_accounts | array | Required within parent | Bank accounts eligible for bill payment for this entity. Read only: true |
payment_accounts[] | Model | Each item | Expand Get a business entity — response body — payment accounts item |
Referenced models: Get a business entity — response body — connected subsidiary external id, id, name, Get a business entity — response body — payment accounts item, Get a business entity — response body — custom record fields item, Get a business entity — response body — accounts item