Skip to main content
GET
Get a Connection

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

connection_id
string
required

Response

Successful Response

Acumatica ERP integration connection.

created_at
string<date-time>
required
modified_at
string<date-time> | null
required
id
string
required
is_authentication_pending
boolean
required

Whether this connection is still pending authentication. This is normally only used for oauth2 connections.

is_running_setup
boolean
required
is_sync_disabled
boolean
required

Whether sync tasks are disabled. The intent of this column is to temporarily pause sync tasks for maintenance/deploys/etc.

health
IntegrationConnectionHealth · object | null
required
models
IntegrationConnectionModel · object[]
required

List of unified models synced through this connection

next_sync_at
string<date-time> | null
required

When the next sync is scheduled to run.

name
string | null
required

User defined name of the linked integration.

owner_id
string | null
required
requires_setup
boolean
required
provider_name
string
required
Allowed value: "acumatica"
base_url
string
required

Acumatica instance base URL including the IIS instance segment (e.g. https://erpsandbox.example.com/AcumaticaSandbox).

tenant
string
required

Acumatica tenant (company) login name as it appears on the Tenants form (SM203520). For multi-company installs this is also the suffix appended to client_id after @.

endpoint_name
string
required

Web service endpoint name (default 'Default'; custom endpoints supported).

endpoint_version
string
required

Endpoint version string (e.g. '24.200.001'). Mirrors Acumatica release.

scope
string | null
required

OAuth scope string. 'api' for single-session, 'api offline_access' to get a refresh token, 'api:concurrent_access' to allow multiple simultaneous tokens for the same client.

branches
string[] | null
required

Branches the connection is authorized to sync. Each value is a BranchCD code (e.g. 'STSMC') that is sent in the PX-CbApiBranch header on AR transactional reads.

default_currency
string | null
required

ISO-4217 currency code used as the fallback when Acumatica's Default endpoint omits CurrencyID on AR documents — Invoice and CreditMemo entities do not expose a currency field in the current contract, so per-tenant single-currency installs need to set this on the connection. Payment rows carry CurrencyID directly and ignore this. Mapper fails loudly if neither the row nor this column carries a currency.

object
string
required
read-only

String representing the object's type. Objects of the same type share the same value.

authorization_url
string | null
required

The authorization url for this connection.

provider
object
required
read-only

The integration provider for this connection.

is_configured
boolean
required
read-only

Whether the integration connection is configured.

missing_settings
string[]
required
read-only

List of missing settings.

is_healthy
boolean
required
read-only

Whether the integration connection is healthy. This is determined based on a few checks:

  1. Configuration (e.g. settings)
  2. Connection
  3. Permissions
linked_integration_id
string | null
required

The v1 linked integration id.