Skip to content

Ramp: Business entities schemas

14 Ramp schemas with complete fields and constraints.

← Business entities operations · All schemas

Get a business entity — response body

FieldTypePresenceDescription and constraints
$objectRoot
accountsarrayRequired within parentInformation about the entity's active accounts
Read only: true
accounts[]ModelEach itemExpand Get a business entity — response body — accounts item
connected_subsidiaryJSONRequired within parent
connected_subsidiary (anyOf 1)ModelAlternativeExpand 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)nullAlternative
currencyJSONRequired within parent
currency (anyOf 1)stringAlternativeCurrency 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)nullAlternative
custom_record_fieldsarrayOptionalCustom record field values associated with this entity. Only returned when `include_custom_field_values=true`.
Read only: true
custom_record_fields[]ModelEach itemExpand Get a business entity — response body — custom record fields item
default_bill_pay_payment_account_idJSONRequired within parent
default_bill_pay_payment_account_id (anyOf 1)stringAlternativeBank 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)nullAlternative
entity_namestringRequired within parentName of the business entity.
idstringRequired within parentUnique identifier for the business entity.
Format: uuid
is_primaryJSONRequired within parent
is_primary (anyOf 1)booleanAlternativeWhether this is the primary entity for the business.
is_primary (anyOf 2)nullAlternative
location_idsarrayRequired within parentList of identifiers for locations associated with this entity.
Read only: true
location_ids[]stringEach itemFormat: uuid
payment_accountsarrayRequired within parentBank accounts eligible for bill payment for this entity.
Read only: true
payment_accounts[]ModelEach itemExpand 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

Get a business entity — response body — accounts item

FieldTypePresenceDescription and constraints
$objectRoot
bank_account_idJSONRequired within parent
bank_account_id (anyOf 1)stringAlternativeUnique identifier of the associated bank account, if exists
Format: uuid
bank_account_id (anyOf 2)nullAlternative
classificationstringRequired within parentClassification type of the account (Asset, Liability, Equity, etc.).
Known values: ANY, ASSET, CREDCARD, EQUITY, EXPENSE, LIABILITY, REVENUE, UNKNOWN
created_atstringRequired within parentWhen the account was created.
Format: date-time
external_idstringRequired within parentExternal ID of the account. If connected to a direct integration, this value is sourced from the remote ERP system.
external_namestringRequired within parentExternal name of the account. If connected to a direct integration, this value is sourced from the remote ERP system.
internal_idstringRequired within parentInternal ID of the account. This value is entered as the Account ID in Ramp as the unique ID or number assigned by your accounting provider.
usage_typeJSONRequired within parent
usage_type (anyOf 1)stringAlternativeHow the account is used within the system (Cash Account, Expense Account, etc.).
Known values: ACCRUAL_AP_ACCOUNT, ACCRUAL_LIABILITY_ACCOUNT, AR_ACCOUNTS_RECEIVABLE_ACCOUNT, AR_ACH_CREDIT_BANK_ACCOUNT, AR_BAD_DEBT_ACCOUNT, AR_CARD_FEES_ACCOUNT, AR_CASH_ACCOUNT_DEFAULT, AR_CHARGEBACK_CLEARING_ACCOUNT, AR_DEFERRED_REVENUE_ACCOUNT_DEFAULT, AR_INCOME_ACCOUNT_DEFAULT, AR_REFUNDS_CLEARING_ACCOUNT, AR_SALES_TAX_PAYABLE_ACCOUNT, AR_UNBILLED_ACCOUNTS_RECEIVABLE_ACCOUNT, AR_UNDEPOSITED_FUNDS_ACCOUNT, BILL_PAY_ACCOUNTS_PAYABLE_ACCOUNT, BILL_PAY_BANK_ACCOUNT, BILL_PAY_FX_GAIN_LOSS_ACCOUNT, BILL_PAY_RETAINAGE_PAYABLE_ACCOUNT, BOOKKEEPING_AUTOMATION_BANK_ACCOUNT, BOOKKEEPING_AUTOMATION_CLEARING_ACCOUNT, BROKERAGE_ACCOUNT, BROKERAGE_DIVIDEND_ACCOUNT, CARD_LIABILITY_ACCOUNT, CARD_TRANSACTION_BILLS_ACCOUNTS_PAYABLE_ACCOUNT, CASHBACK_ACCOUNT, CASH_ACCOUNT, FIXED_ASSET_ACCUMULATED_IMPAIRMENT_ACCOUNT, FIXED_ASSET_GAIN_ACCOUNT, FIXED_ASSET_IMPAIRMENT_LOSS_ACCOUNT, FIXED_ASSET_LOSS_ACCOUNT, FIXED_ASSET_PROCEEDS_ON_DISPOSAL_ACCOUNT, INTERCOMPANY_ACCOUNTS_PAYABLE_ACCOUNT, INTERCOMPANY_ACCOUNTS_RECEIVABLE_ACCOUNT, INTERCOMPANY_TRANSFER_CLEARING_ACCOUNT, MANAGED_PORTFOLIO_CASH_ACCOUNT, MANAGED_PORTFOLIO_FEE_EXPENSE_ACCOUNT, MANAGED_PORTFOLIO_INTEREST_INCOME_ACCOUNT, MANAGED_PORTFOLIO_POSITION_ASSET_ACCOUNT, MANAGED_PORTFOLIO_REALIZED_GAIN_LOSS_ACCOUNT, MANAGED_PORTFOLIO_UNREALIZED_GAIN_LOSS_ACCOUNT, REIMBURSEMENT_ACCOUNTS_PAYABLE_ACCOUNT, REIMBURSEMENT_BANK_ACCOUNT, TRANSFER_BANK_ACCOUNT, UNDEPOSITED_FUNDS, WALLET_ACCOUNT, WALLET_BANK_ACCOUNT, WALLET_YIELD_ACCOUNT
usage_type (anyOf 2)nullAlternative

Get a business entity — response body — connected subsidiary external id, id, name

FieldTypePresenceDescription and constraints
$objectRoot
external_idstringRequired within parentExternal ID of the subsidiary in the ERP system
idstringRequired within parentID that uniquely identifies the subsidiary within Ramp
namestringRequired within parentName of the subsidiary in the ERP system

Get a business entity — response body — custom record fields item

FieldTypePresenceDescription and constraints
$objectRoot
column_display_namestringRequired within parentThe display name of the column
column_idstringRequired within parentThe id of the column
valueJSONRequired within parentThe contents of the cell
discriminator: {"mapping": {"boolean": "#/components/schemas/BooleanCellContentsForDisplay", "custom_table": "#/components/schemas/CustomTableReferenceCellContentsForDisplay", "date": "#/components/schemas/DatetimeCellContentsForDisplay", "native_table": "#/components/schemas/NativeTableReferenceCellContentsForDisplay", "number": "#/components/schemas/NumberCellContentsForDisplay", "text": "#/components/schemas/TextCellContentsForDisplay"}, "propertyName": "type"}
value (anyOf 1)ModelAlternativeExpand Get a business entity — response body — custom record fields item value type boolean
value (anyOf 2)ModelAlternativeExpand Get a business entity — response body — custom record fields item value type custom table
value (anyOf 3)ModelAlternativeExpand Get a business entity — response body — custom record fields item value type date
value (anyOf 4)ModelAlternativeExpand Get a business entity — response body — custom record fields item value type native table
value (anyOf 5)ModelAlternativeExpand Get a business entity — response body — custom record fields item value type number
value (anyOf 6)ModelAlternativeExpand Get a business entity — response body — custom record fields item value type text

Referenced models: Get a business entity — response body — custom record fields item value type boolean, Get a business entity — response body — custom record fields item value type date, Get a business entity — response body — custom record fields item value type custom table, Get a business entity — response body — custom record fields item value type native table, Get a business entity — response body — custom record fields item value type number, Get a business entity — response body — custom record fields item value type text

Get a business entity — response body — custom record fields item value type boolean

FieldTypePresenceDescription and constraints
$objectRoot
display_namestringRequired within parent
typestringRequired within parentMust equal: boolean
valuebooleanRequired within parent

Get a business entity — response body — custom record fields item value type custom table

FieldTypePresenceDescription and constraints
$objectRoot
has_morebooleanRequired within parentIndicates if there are more rows in the table than are included in this response
rowsarrayRequired within parentThe rows referenced by this cell
rows[]ModelEach itemExpand Get a business entity — response body — custom record fields item value type custom table rows item
table_namestringRequired within parentThe custom table that referenced rows are part of
typestringRequired within parentMust equal: custom_table

Referenced models: Get a business entity — response body — custom record fields item value type custom table rows item

Get a business entity — response body — custom record fields item value type custom table rows item

FieldTypePresenceDescription and constraints
$objectRoot
display_namestringRequired within parent
external_keystringRequired within parentThe external key of the row
row_idstringRequired within parentThe id of the row
typestringRequired within parentKnown values: custom_table
Default: custom_table

Get a business entity — response body — custom record fields item value type date

FieldTypePresenceDescription and constraints
$objectRoot
display_namestringRequired within parent
typestringRequired within parentMust equal: date
valuestringRequired within parentFormat: date-time

Get a business entity — response body — custom record fields item value type native table

FieldTypePresenceDescription and constraints
$objectRoot
has_morebooleanRequired within parentIndicates if there are more rows in the table than are included in this response
rowsarrayRequired within parentThe rows referenced by this cell
rows[]ModelEach itemExpand Get a business entity — response body — custom record fields item value type native table rows item
table_namestringRequired within parentThe native table that referenced rows are part of
Known values: accounting_field_options, approver_groups, bills, business_entities, cards, contracts, departments, external_attendees, limits, locations, merchant_categories, purchase_order_line_items, purchase_orders, reimbursements, transactions, users, vendors
typestringRequired within parentMust equal: native_table

Referenced models: Get a business entity — response body — custom record fields item value type native table rows item

Get a business entity — response body — custom record fields item value type native table rows item

FieldTypePresenceDescription and constraints
$objectRoot
display_namestringRequired within parent
external_keystringRequired within parentThe id of the Ramp object
typestringRequired within parentKnown values: native_table
Default: native_table

Get a business entity — response body — custom record fields item value type number

FieldTypePresenceDescription and constraints
$objectRoot
display_namestringRequired within parent
typestringRequired within parentMust equal: number
valueJSONRequired within parent
value (anyOf 1)numberAlternative
value (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Get a business entity — response body — custom record fields item value type text

FieldTypePresenceDescription and constraints
$objectRoot
display_namestringRequired within parent
typestringRequired within parentMust equal: text
valuestringRequired within parent

Get a business entity — response body — payment accounts item

FieldTypePresenceDescription and constraints
$objectRoot
account_namestringRequired within parentDisplay name of the bank account
account_number_last_fourstringRequired within parentLast four digits of the account number
currencystringRequired within parentISO 4217 currency code of the bank account (e.g. USD, CAD)
idstringRequired within parentUnique identifier of the bank account.
Format: uuid

List business entities — response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentResources returned in this page.
data[]ModelEach itemExpand Get a business entity — response body
pageModelRequired within parentExpand List bills — response body — page
Pagination details for this response.

Referenced models: List bills — response body — page, Get a business entity — response body

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.