Skip to content

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.

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

Referenced models: Upload general ledger accounts — 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 general ledger accounts — response body

Referenced models: Upload general ledger accounts — response body

Upload general ledger accounts — 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
gl_accountsarrayRequired within parentA list of general ledger accounts that you want to use to classify your Ramp transactions.
Maximum items: 500
Minimum items: 1
gl_accounts[]ModelEach itemExpand 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
FieldTypePresenceDescription and constraints
$objectRoot
accounting_connection_idstringOptionalID of the accounting connection that the general ledger accounts are uploaded to.
Format: uuid
gl_accountsarrayOptionalA list of general ledger accounts that are successfully uploaded.
gl_accounts[]ModelEach itemExpand Fetch a general ledger account — response body
uploadedarrayOptionalA list of uuids from the uploaded vendors, gl accounts or custom accounting field options.
uploaded[]stringEach itemFormat: uuid

Referenced models: Fetch a general ledger account — response body

Upload general ledger accounts — request body — body gl accounts item
FieldTypePresenceDescription and constraints
$objectRoot
classificationstringRequired within parentOne of: ANY, ASSET, CREDCARD, EQUITY, EXPENSE, LIABILITY, REVENUE, UNKNOWN
codestringOptionale.g. 400-100.
entity_remote_idsarrayOptionalRemote/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[]stringEach itemMinimum length: 1
idstringRequired within parentRemote/external ID of GL account in ERP system.
namestringRequired within parente.g. Travel : Travel - Lodging.
Fetch a general ledger account — response body
FieldTypePresenceDescription and constraints
$objectRoot
accounting_connection_idstringRequired within parentID of the accounting connection that the GL account is uploaded to.
Format: uuid
classificationJSONOptional
classification (anyOf 1)stringAlternativeKnown values: ANY, ASSET, CREDCARD, EQUITY, EXPENSE, LIABILITY, REVENUE, UNKNOWN
Read only: true
classification (anyOf 2)nullAlternative
codestringOptionale.g. 400-100.
created_atstringRequired within parentFormat: date-time
entity_remote_idsJSONRequired within parent
entity_remote_ids (anyOf 1)arrayAlternativeRemote/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)[]stringEach item
entity_remote_ids (anyOf 2)nullAlternative
gl_account_category_infoModelOptionalExpand Fetch a vendor — accounting get Accounting Vendor Resource — response body — vendor category info
Category info of the general ledger account.
idstringOptionalRemote/external ID of GL account in ERP system.
is_activebooleanRequired within parent
namestringRequired within parente.g. Travel : Travel - Lodging.
provider_nameJSONRequired within parent
provider_name (anyOf 1)stringAlternativeName of the accounting connection that the GL account is uploaded to.
Read only: true
provider_name (anyOf 2)nullAlternative
ramp_idstringRequired within parentid to uniquely identify a general ledger account within Ramp system
Format: uuid
updated_atstringOptionalFormat: date-time
visibilitystringOptionalVisibility 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
FieldTypePresenceDescription and constraints
$objectRoot
idstringOptionalRemote/external ID of the accounting category from ERP system.
namestringOptionalName of the accounting category in the remote ERP system.
ramp_idstringOptionalid to uniquely identify the accounting category within Ramp system
Format: uuid

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

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.