Ramp: Upload general ledger accounts
Ramp accounting.postGlAccountListResource: arguments, response, policy and SDK examples.
← Accounting operations · Get started
Operation ramp.post_gl_account_list_resource
Provider route: POST /developer/v1/accounting/accounts. 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"]["postGlAccountListResource"]>[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.postGlAccountListResource(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_gl_account_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 general ledger accounts — request body — body |
Referenced models: Upload general ledger accounts — 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 general ledger accounts — response body |
Referenced models: Upload general ledger accounts — response body
Schemas
Section titled “Schemas”Upload general ledger accounts — 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 | |
gl_accounts | array | Required within parent | A list of general ledger accounts that you want to use to classify your Ramp transactions. Maximum items: 500 Minimum items: 1 |
gl_accounts[] | Model | Each item | Expand Upload general ledger accounts — request body — body gl accounts item |
Referenced models: Upload general ledger accounts — request body — body gl accounts item
Upload general ledger accounts — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounting_connection_id | string | Optional | ID of the accounting connection that the general ledger accounts are uploaded to. Format: uuid |
gl_accounts | array | Optional | A list of general ledger accounts that are successfully uploaded. |
gl_accounts[] | Model | Each item | Expand Fetch a general ledger account — response body |
uploaded | array | Optional | A list of uuids from the uploaded vendors, gl accounts or custom accounting field options. |
uploaded[] | string | Each item | Format: uuid |
Referenced models: Fetch a general ledger account — response body
Upload general ledger accounts — request body — body gl accounts item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
classification | string | Required within parent | One of: ANY, ASSET, CREDCARD, EQUITY, EXPENSE, LIABILITY, REVENUE, UNKNOWN |
code | string | Optional | e.g. 400-100. |
entity_remote_ids | array | Optional | Remote/external IDs of entities created through POST /developer/v1/accounting/entities that this GL account should be available for. Omit this field to make the GL account available for all connected entities on accounting connections with entity selection enabled. Minimum items: 1 |
entity_remote_ids[] | string | Each item | Minimum length: 1 |
id | string | Required within parent | Remote/external ID of GL account in ERP system. |
name | string | Required within parent | e.g. Travel : Travel - Lodging. |
Fetch a general ledger account — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounting_connection_id | string | Required within parent | ID of the accounting connection that the GL account is uploaded to. Format: uuid |
classification | JSON | Optional | |
classification (anyOf 1) | string | Alternative | Known values: ANY, ASSET, CREDCARD, EQUITY, EXPENSE, LIABILITY, REVENUE, UNKNOWN Read only: true |
classification (anyOf 2) | null | Alternative | |
code | string | Optional | e.g. 400-100. |
created_at | string | Required within parent | Format: date-time |
entity_remote_ids | JSON | Required within parent | |
entity_remote_ids (anyOf 1) | array | Alternative | Remote/external IDs of entities that this GL account is available for. Null means the GL account is available for all connected entities. Read only: true |
entity_remote_ids (anyOf 1)[] | string | Each item | |
entity_remote_ids (anyOf 2) | null | Alternative | |
gl_account_category_info | Model | Optional | Expand Fetch a vendor — accounting get Accounting Vendor Resource — response body — vendor category info Category info of the general ledger account. |
id | string | Optional | Remote/external ID of GL account in ERP system. |
is_active | boolean | Required within parent | |
name | string | Required within parent | e.g. Travel : Travel - Lodging. |
provider_name | JSON | Required within parent | |
provider_name (anyOf 1) | string | Alternative | Name of the accounting connection that the GL account is uploaded to. Read only: true |
provider_name (anyOf 2) | null | Alternative | |
ramp_id | string | Required within parent | id to uniquely identify a general ledger account within Ramp system Format: uuid |
updated_at | string | Optional | Format: date-time |
visibility | string | Optional | Visibility of the general ledger account. Known values: HIDDEN, VISIBLE |
Referenced models: Fetch a vendor — accounting get Accounting Vendor Resource — response body — vendor category info
Fetch a vendor — accounting get Accounting Vendor Resource — response body — vendor category info
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Optional | Remote/external ID of the accounting category from ERP system. |
name | string | Optional | Name of the accounting category in the remote ERP system. |
ramp_id | string | Optional | id to uniquely identify the accounting category within Ramp system Format: uuid |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: ramp.post_gl_account_list_resource. Catalog operation: post_gl_account_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"]