Ramp: Upload entities
Ramp accounting.postAccountingEntityListResource: arguments, response, policy and SDK examples.
← Accounting operations · Get started
Operation ramp.post_accounting_entity_list_resource
Provider route: POST /developer/v1/accounting/entities. 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"]["postAccountingEntityListResource"]>[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.postAccountingEntityListResource(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.post_accounting_entity_list_resource(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
body | Model | Required within parent | Expand Upload entities — request body — body |
Referenced models: Upload entities — request body — body
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 Upload entities — response body |
Referenced models: Upload entities — response body
Schemas
Section titled “Schemas”Upload entities — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounting_connection_id | JSON | Optional | |
accounting_connection_id (anyOf 1) | string | Alternative | Specify an accounting connection. This connection must be an accounting API based connection. If not provided we default to the current active connection. Format: uuid |
accounting_connection_id (anyOf 2) | null | Alternative | |
entities | array | Required within parent | A list of subsidiaries/entities to create inside the business's Subsidiary tracking category. Maximum items: 500 Minimum items: 1 |
entities[] | Model | Each item | Expand Upload entities — request body — body entities item |
Referenced models: Upload entities — request body — body entities item
Upload entities — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounting_connection_id | string | Optional | ID of the accounting connection that the subsidiaries/entities are uploaded to. Format: uuid |
entities | array | Required within parent | A list of subsidiaries/entities that were successfully uploaded. |
entities[] | Model | Each item | Expand Upload entities — response body — entities item |
Referenced models: Upload entities — response body — entities item
Upload entities — request body — body entities item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
country | JSON | Optional | |
country (anyOf 1) | string | Alternative | Optional ISO 3166 alpha-2 country code (e.g., "US"). Default: null |
country (anyOf 2) | null | Alternative | |
currency | JSON | Optional | |
currency (anyOf 1) | string | Alternative | Optional ISO 4217 currency code (e.g., "USD"). Default: null |
currency (anyOf 2) | null | Alternative | |
federal_id_number | JSON | Optional | |
federal_id_number (anyOf 1) | string | Alternative | Optional tax identification number. Default: null |
federal_id_number (anyOf 2) | null | Alternative | |
id | string | Required within parent | Remote/external ID of the subsidiary in the ERP. |
name | string | Required within parent | Name of the subsidiary/entity. |
Upload entities — response body — entities item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounting_connection_id | string | Required within parent | ID of the accounting connection that the subsidiary/entity is uploaded to. Format: uuid |
country | JSON | Required within parent | |
country (anyOf 1) | string | Alternative | ISO 3166 alpha-2 country code, if provided on upload. Read only: true |
country (anyOf 2) | null | Alternative | |
currency | JSON | Required within parent | |
currency (anyOf 1) | string | Alternative | ISO 4217 currency code, if provided on upload. Read only: true |
currency (anyOf 2) | null | Alternative | |
federal_id_number | JSON | Required within parent | |
federal_id_number (anyOf 1) | string | Alternative | Tax identification number, if provided on upload. Read only: true |
federal_id_number (anyOf 2) | null | Alternative | |
id | string | Optional | Remote/external ID of the subsidiary in the ERP. |
is_active | boolean | Required within parent | Whether the subsidiary/entity is active. |
name | string | Required within parent | Name of the subsidiary/entity. |
ramp_id | string | Required within parent | id to uniquely identify a subsidiary/entity within Ramp system Format: uuid |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: ramp.post_accounting_entity_list_resource. Catalog operation: post_accounting_entity_list_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"]