Authenticate a Connection
Submit credentials for the connection’s provider, clear the pending-authentication flag, and run a health check.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
- MSDynamicsBCConnectionAuthenticateBody
- MSDynamicsFOConnectionAuthenticateBody
- NetsuiteConnectionAuthenticateBody
- SalesforceConnectionAuthenticateBody
Response
Successful Response
- AcumaticaConnection
- BillingPlatformConnection
- BoomiConnection
- ChargebeeConnection
- CitiConnection
- JpmcConnection
- KyribaConnection
- MSDynamicsBCConnection
- MSDynamicsFOConnection
- NetsuiteConnection
- OdooConnection
- OracleFusionConnection
- QuickbooksConnection
- QuickbooksDesktopConnection
- SageIntacctConnection
- SalesforceConnection
- SampleDataGeneratorConnection
- ServiceNowConnection
- ServiceTitanConnection
- WorkdayConnection
- ZendeskConnection
- ZuoraConnection
Acumatica ERP integration connection.
Whether this connection is still pending authentication. This is normally only used for oauth2 connections.
Whether sync tasks are disabled. The intent of this column is to temporarily pause sync tasks for maintenance/deploys/etc.
List of unified models synced through this connection
When the next sync is scheduled to run.
User defined name of the linked integration.
"acumatica"Acumatica instance base URL including the IIS instance segment (e.g. https://erpsandbox.example.com/AcumaticaSandbox).
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 @.
Web service endpoint name (default 'Default'; custom endpoints supported).
Endpoint version string (e.g. '24.200.001'). Mirrors Acumatica release.
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 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.
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.
String representing the object's type. Objects of the same type share the same value.
The authorization url for this connection.
The integration provider for this connection.
Whether the integration connection is configured.
List of missing settings.
Whether the integration connection is healthy. This is determined based on a few checks:
- Configuration (e.g. settings)
- Connection
- Permissions
The v1 linked integration id.
