Ramp: Fetch all accounting connections for the current business
Ramp accounting.getAccountingAllConnectionsResource: arguments, response, policy and SDK examples.
← Accounting operations · Get started
Operation ramp.get_accounting_all_connections_resource
Provider route: GET /developer/v1/accounting/all-connections. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”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"]["getAccountingAllConnectionsResource"]>[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.getAccountingAllConnectionsResource(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom 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.get_accounting_all_connections_resource(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Fetch all accounting connections for the current business — response body |
Referenced models: Fetch all accounting connections for the current business — response body
Schemas
Section titled “Schemas”Fetch all accounting connections for the current business — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
connections | array | Required within parent | A list of accounting connections for the current business. |
connections[] | Model | Each item | Expand Update an accounting connection — response body |
Referenced models: Update an accounting connection — response body
Update an accounting connection — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
connection_type | string | Required within parent | The type of the accounting connection. Known values: API, CSV, DIRECT Read only: true |
created_at | string | Required within parent | The date and time the accounting connection was created. Format: date-time |
id | string | Required within parent | Format: uuid |
is_active | boolean | Required within parent | Whether the accounting connection is active. Read only: true |
is_ready_to_migrate | boolean | Required within parent | Whether 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_at | JSON | Required within parent | |
last_linked_at (anyOf 1) | string | Alternative | The date and time the accounting connection was last connected. Format: date-time |
last_linked_at (anyOf 2) | null | Alternative | |
remote_provider_name | JSON | Required within parent | |
remote_provider_name (anyOf 1) | string | Alternative | The name of the accounting connection. Read only: true |
remote_provider_name (anyOf 2) | null | Alternative | |
settings | JSON | Required within parent | |
settings (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative | |
status | string | Required within parent | The current status of the accounting connection. Known values: failed_to_auth, linked, revoked, unlinked |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
entity_selection_enabled | boolean | Required within parent | Whether ERP entity selection is enabled for this accounting connection. Only applies to API-based connections. |
reimbursement_sync_button_enabled | boolean | Required within parent | Whether the reimbursement sync button is enabled for this accounting connection. Only applies to API-based connections. |
transaction_accounting_vendor_creation_on_sync_enabled | boolean | Required within parent | Whether card transactions missing a mapped accounting vendor should require vendor creation before sync. Only applies to API-based connections. |
transaction_sync_button_enabled | boolean | Required within parent | Whether the transaction sync button is enabled for this accounting connection. Only applies to API-based connections. |
vendor_credits_enabled | boolean | Required within parent | Whether vendor credits are enabled for this accounting connection. Only applies to API-based connections. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: ramp.get_accounting_all_connections_resource. Catalog operation: get_accounting_all_connections_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:read"]