Skip to content

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.

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 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.post_accounting_entity_list_resource(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
bodyModelRequired within parentExpand Upload entities — request body — body

Referenced models: Upload entities — 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 Upload entities — response body

Referenced models: Upload entities — response body

Upload entities — request body — body
FieldTypePresenceDescription and constraints
$objectRoot
accounting_connection_idJSONOptional
accounting_connection_id (anyOf 1)stringAlternativeSpecify 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)nullAlternative
entitiesarrayRequired within parentA list of subsidiaries/entities to create inside the business's Subsidiary tracking category.
Maximum items: 500
Minimum items: 1
entities[]ModelEach itemExpand Upload entities — request body — body entities item

Referenced models: Upload entities — request body — body entities item

Upload entities — response body
FieldTypePresenceDescription and constraints
$objectRoot
accounting_connection_idstringOptionalID of the accounting connection that the subsidiaries/entities are uploaded to.
Format: uuid
entitiesarrayRequired within parentA list of subsidiaries/entities that were successfully uploaded.
entities[]ModelEach itemExpand Upload entities — response body — entities item

Referenced models: Upload entities — response body — entities item

Upload entities — request body — body entities item
FieldTypePresenceDescription and constraints
$objectRoot
countryJSONOptional
country (anyOf 1)stringAlternativeOptional ISO 3166 alpha-2 country code (e.g., "US").
Default: null
country (anyOf 2)nullAlternative
currencyJSONOptional
currency (anyOf 1)stringAlternativeOptional ISO 4217 currency code (e.g., "USD").
Default: null
currency (anyOf 2)nullAlternative
federal_id_numberJSONOptional
federal_id_number (anyOf 1)stringAlternativeOptional tax identification number.
Default: null
federal_id_number (anyOf 2)nullAlternative
idstringRequired within parentRemote/external ID of the subsidiary in the ERP.
namestringRequired within parentName of the subsidiary/entity.
Upload entities — response body — entities item
FieldTypePresenceDescription and constraints
$objectRoot
accounting_connection_idstringRequired within parentID of the accounting connection that the subsidiary/entity is uploaded to.
Format: uuid
countryJSONRequired within parent
country (anyOf 1)stringAlternativeISO 3166 alpha-2 country code, if provided on upload.
Read only: true
country (anyOf 2)nullAlternative
currencyJSONRequired within parent
currency (anyOf 1)stringAlternativeISO 4217 currency code, if provided on upload.
Read only: true
currency (anyOf 2)nullAlternative
federal_id_numberJSONRequired within parent
federal_id_number (anyOf 1)stringAlternativeTax identification number, if provided on upload.
Read only: true
federal_id_number (anyOf 2)nullAlternative
idstringOptionalRemote/external ID of the subsidiary in the ERP.
is_activebooleanRequired within parentWhether the subsidiary/entity is active.
namestringRequired within parentName of the subsidiary/entity.
ramp_idstringRequired within parentid to uniquely identify a subsidiary/entity within Ramp system
Format: uuid

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"]

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.