Ramp: Post accounting coding selections to an object
Ramp accounting.postCodingsResource: arguments, response, policy and SDK examples.
← Accounting operations · Get started
Operation ramp.post_codings_resource
Provider route: POST /developer/v1/accounting/codings. 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"]["postCodingsResource"]>[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.postCodingsResource(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_codings_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 Post accounting coding selections to an object — request body — body |
Referenced models: Post accounting coding selections to an object — 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 Post accounting coding selections to an object — response body |
Referenced models: Post accounting coding selections to an object — response body
Schemas
Section titled “Schemas”Post accounting coding selections to an object — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounting_coding_selections | array | Required within parent | |
accounting_coding_selections[] | Model | Each item | Expand Post accounting coding selections to an object — response body — accounting coding selections item |
object_id | string | Required within parent | The ID of the Ramp object to code. Format: uuid |
object_type | string | Required within parent | The type of Ramp object to code. One of: TRANSACTION |
Referenced models: Post accounting coding selections to an object — response body — accounting coding selections item
Post accounting coding selections to an object — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounting_coding_selections | array | Required within parent | |
accounting_coding_selections[] | Model | Each item | Expand Post accounting coding selections to an object — response body — accounting coding selections item |
object_id | string | Required within parent | The ID of the Ramp object to code. Format: uuid |
object_type | string | Required within parent | The type of Ramp object to code. Known values: TRANSACTION |
Referenced models: Post accounting coding selections to an object — response body — accounting coding selections item
Post accounting coding selections to an object — response body — accounting coding selections item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounting_field_id | string | Required within parent | The ID of the custom accounting field. This is the ramp_id returned from the custom field endpoints. Format: uuid |
accounting_field_option_id | JSON | Optional | |
accounting_field_option_id (anyOf 1) | string | Alternative | The accounting field option ID returned by the custom field options endpoints. When posting accounting codings, set this to null without free_form_text to clear the field. Existing accounting permissions and policy validation apply. Format: uuid |
accounting_field_option_id (anyOf 2) | null | Alternative | |
free_form_text | string | Optional |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: ramp.post_codings_resource. Catalog operation: post_codings_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"]