Skip to content

Ramp: Register a new API based accounting connection — request body — body

Register a new API based accounting connection: request body, field body. Complete fields and constraints for contract 2026-10-27.

API reference · Contract 2026-10-27

SDK schema: Register a new API based accounting connection — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
reactivatebooleanOptionalDeprecated, use POST accounting/connection/<connection_id>/reactivate.
Default: false
remote_provider_namestringRequired within parentThe name of the accounting connection.
settingsJSONOptional
settings (anyOf 1)ModelAlternativeExpand Register a new API based accounting connection — request body — body settings entity selection enabled, reimbursement sync button enabled, transaction accounting vendor creation on sync enabled, transaction sync button enabled, vendor credits enabled
Optional settings for the accounting connection. Only applies to API-based connections.
Default: null
settings (anyOf 2)nullAlternative

Referenced models: Register a new API based accounting connection — request body — body settings entity selection enabled, reimbursement sync button enabled, transaction accounting vendor creation on sync enabled, transaction sync button enabled, vendor credits enabled

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.