Skip to content

Ramp: Update an accounting connection

Ramp accounting.patchAccountingConnectionDetailResource: arguments, response, policy and SDK examples.

← Accounting operations · Get started

Operation ramp.patch_accounting_connection_detail_resource

Provider route: PATCH /developer/v1/accounting/connection/{connection_id}. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/ramp with npm, or alter-sdk-ramp with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { RampIntegration } from "@alter-ai/ramp";
async function execute(input: Parameters<RampIntegration["accounting"]["patchAccountingConnectionDetailResource"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new RampIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.accounting.patchAccountingConnectionDetailResource(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_ramp import RampIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = RampIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.accounting.patch_accounting_connection_detail_resource(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.connection_idstringRequired within parent
bodyModelRequired within parentExpand Update an accounting connection — request body — body

Referenced models: Update an accounting connection — request body — body

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Update an accounting connection — response body

Referenced models: Update an accounting connection — response body

Update an accounting connection — request body — body
FieldTypePresenceDescription and constraints
$objectRoot
settingsModelOptionalExpand Update an accounting connection — request body — body settings
Settings for the accounting connection. Only applies to API-based connections.

Referenced models: Update an accounting connection — request body — body settings

Update an accounting connection — response body
FieldTypePresenceDescription and constraints
$objectRoot
connection_typestringRequired within parentThe type of the accounting connection.
Known values: API, CSV, DIRECT
Read only: true
created_atstringRequired within parentThe date and time the accounting connection was created.
Format: date-time
idstringRequired within parentFormat: uuid
is_activebooleanRequired within parentWhether the accounting connection is active.
Read only: true
is_ready_to_migratebooleanRequired within parentWhether an Accounting Connection is marked as ready to migrate. For use by the ERP migration flow. Only one Accounting Connection will be marked as ready to migrate per business at a given time. Once a customer begins an ERP migration, a ready to migrate Accounting Connection will no longer be considered ready to migrate.
Read only: true
last_linked_atJSONRequired within parent
last_linked_at (anyOf 1)stringAlternativeThe date and time the accounting connection was last connected.
Format: date-time
last_linked_at (anyOf 2)nullAlternative
remote_provider_nameJSONRequired within parent
remote_provider_name (anyOf 1)stringAlternativeThe name of the accounting connection.
Read only: true
remote_provider_name (anyOf 2)nullAlternative
settingsJSONRequired within parent
settings (anyOf 1)ModelAlternativeExpand Update an accounting connection — response body — settings entity selection enabled, reimbursement sync button enabled, transaction accounting vendor creation on sync enabled, transaction sync button enabled, vendor credits enabled
The connection settings for this accounting connection. Only applies to API-based accounting connections. This field will be empty for non-API based accounting connections.
Read only: true
settings (anyOf 2)nullAlternative
statusstringRequired within parentThe current status of the accounting connection.
Known values: failed_to_auth, linked, revoked, unlinked

Referenced models: Update an accounting connection — response body — settings entity selection enabled, reimbursement sync button enabled, transaction accounting vendor creation on sync enabled, transaction sync button enabled, vendor credits enabled

Update an accounting connection — request body — body settings
FieldTypePresenceDescription and constraints
$objectRoot
entity_selection_enabledbooleanOptionalWhether ERP entity selection is enabled for this accounting connection. Only applies to API-based connections.
reimbursement_sync_button_enabledbooleanOptionalWhether the reimbursement sync button is enabled for this accounting connection. Only applies to API-based connections.
transaction_accounting_vendor_creation_on_sync_enabledbooleanOptionalWhether card transactions missing a mapped accounting vendor should require vendor creation before sync. Only applies to API-based connections.
transaction_sync_button_enabledbooleanOptionalWhether the transaction sync button is enabled for this accounting connection. Only applies to API-based connections.
vendor_credits_enabledbooleanOptionalWhether vendor credits are enabled for this accounting connection. Only applies to API-based connections.
Update an accounting connection — response body — settings entity selection enabled, reimbursement sync button enabled, transaction accounting vendor creation on sync enabled, transaction sync button enabled, vendor credits enabled
FieldTypePresenceDescription and constraints
$objectRoot
entity_selection_enabledbooleanRequired within parentWhether ERP entity selection is enabled for this accounting connection. Only applies to API-based connections.
reimbursement_sync_button_enabledbooleanRequired within parentWhether the reimbursement sync button is enabled for this accounting connection. Only applies to API-based connections.
transaction_accounting_vendor_creation_on_sync_enabledbooleanRequired within parentWhether card transactions missing a mapped accounting vendor should require vendor creation before sync. Only applies to API-based connections.
transaction_sync_button_enabledbooleanRequired within parentWhether the transaction sync button is enabled for this accounting connection. Only applies to API-based connections.
vendor_credits_enabledbooleanRequired within parentWhether vendor credits are enabled for this accounting connection. Only applies to API-based connections.

SDK function policy ID: ramp.patch_accounting_connection_detail_resource. Catalog operation: patch_accounting_connection_detail_resource. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["accounting:write"]

Official provider source

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.