Skip to main content
DELETE
Disconnect provider
Requires an API key with an owner, and write:gl for a general-ledger connection or write:connections for other connections. Cleanup and retained data depend on the provider. Imported accounting data is cleaned up in the same way as a disconnect in the Entendre app. If remote revocation fails after the local cleanup, the response shows the state and the revocation error. NetSuite rejects an ambiguous credential configuration with HTTP 409. Non-GL connections (exchange, bank, card, Stripe, and Fireblocks) accept the optional If-Match check that Update connection describes.

Authorizations

X-API-Key
string
header
required

Your organization API key. See Authentication.

Headers

If-Match
string

Optional. The etag from List connections. A stale value returns HTTP 412.

Idempotency-Key
string

Optional retry key. Check X-Idempotency-Applied before relying on replay protection.

Required string length: 1 - 255

Path Parameters

connection_id
string
required

ID of the connection.

Minimum string length: 1

Response

The connection is disconnected. The response shows its state, the cleanup and any revocation error.

id
string
required

Connection ID (con_…).

Example:

"con_507f1f77bcf86cd799439011"

organization_id
string
required

Organization ID (org_…).

Example:

"org_507f1f77bcf86cd799439011"

provider
string
required

Provider identifier.

Example:

"quickbooks"

auth_method
enum<string>
required

Setup method.

Available options:
oauth,
api_key
name
string
required

Connection display name.

status
enum<string>
required

Connection status.

Available options:
pending_setup,
active,
inactive,
expired,
disconnecting,
disconnected,
failed
external_account_id
string | null
required

Account ID at the provider.

Legal entities of the connection (le_…).

Legal entity ID (le_…).

source_ids
string[]
required

Sources created from the connection.

Source ID (src_…).

capabilities
string[]
required

Actions that the connection supports.

Supported action.

created_at
string<date-time>
required

ISO 8601 UTC timestamp.

Example:

"2026-08-31T12:00:00Z"

updated_at
string<date-time>
required

ISO 8601 UTC timestamp of the last change.

guidance
object
required
etag
string
required
read-only

Strong version of this resource. Send this value, including its quotes, in If-Match when updating it.

Pattern: ^"[^"\r\n]+"$
Example:

"\"v_example\""

authorization_attempt
object

The latest setup attempt.

created_by
object | null

Rain only. The user the legacy configuration records as creator. The email is masked unless include_pii=true on the list.

updated_by
object | null

Rain only. The user the legacy configuration records as last editor. The email is masked unless include_pii=true on the list.

ramp
object | null

Ramp only. Credential hints of the current Ramp connection; null on a disconnected or replaced one. The credentials themselves are never returned.

revocation_error
string | null

Why the provider did not revoke access. A disabled connection in Entendre does not prove that the provider revoked access.

retained_resources
string[]

Resource types that stay after a disconnect.

Resource types retained after disconnect.

cleanup
object

Present after bank disconnect. Counts rows removed by this call. Zero is valid for empty or already-cleaned connections.

institution_id
string | null

Bank connections only: the Plaid institution id.

last_synced_at
string<date-time> | null

Bank and Stripe connections: when the last transaction import from the provider finished.

last_error
object | null

Bank connections only: the last error that the provider reported for the connection, as the provider sent it. Null when the connection has no error.

importable_resources
string[]

General-ledger connections only: the resource types that the connection can import.

environment
enum<string> | null

Fireblocks connections only: the Fireblocks host; null when the stored host is not a known Fireblocks host.

Available options:
production,
sandbox,
null
plaid
object | null

Bank only. Plaid state of the bank connection; null on a hosted setup that has no Plaid item yet.