Skip to content

Ramp: Upload entities — request body — body entities item

Upload entities: request body, field body / entities / item. Complete fields and constraints for contract 2026-10-27.

API reference · Contract 2026-10-27

SDK schema: Upload entities — request body — body entities item

FieldTypePresenceDescription and constraints
$objectRoot
countryJSONOptional
country (anyOf 1)stringAlternativeOptional ISO 3166 alpha-2 country code (e.g., “US”).
Default: null
country (anyOf 2)nullAlternative
currencyJSONOptional
currency (anyOf 1)stringAlternativeOptional ISO 4217 currency code (e.g., “USD”).
Default: null
currency (anyOf 2)nullAlternative
federal_id_numberJSONOptional
federal_id_number (anyOf 1)stringAlternativeOptional tax identification number.
Default: null
federal_id_number (anyOf 2)nullAlternative
idstringRequired within parentRemote/external ID of the subsidiary in the ERP.
namestringRequired within parentName of the subsidiary/entity.

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.