Ramp: Post sync status
Ramp accounting.postSyncListResource: arguments, response, policy and SDK examples.
← Accounting operations · Get started
Operation ramp.post_sync_list_resource
Provider route: POST /developer/v1/accounting/syncs. 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"]["postSyncListResource"]>[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.postSyncListResource(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_sync_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 Post sync status — request body — body |
Referenced models: Post sync status — 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 sync status — response body |
Referenced models: Post sync status — response body
Schemas
Section titled “Schemas”Post sync status — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
failed_syncs | array | Optional | A list of objects that failed to be synced. Maximum items: 5000 Minimum items: 1 |
failed_syncs[] | Model | Each item | Expand Post sync status — request body — body failed syncs item |
idempotency_key | string | Required within parent | An idempotency key is a unique value generated by the client which the server uses to recognize subsequent retries of the same request. To avoid collisions, we encourage clients to use random generated UUIDs. |
mark_ready_to_sync | boolean | Optional | Mark successful transaction syncs ready before recording completion, clearing their accounting requirements. Only supported for TRANSACTION_SYNC without sync_request_id; failed_syncs are not marked ready. Defaults to false. |
successful_syncs | array | Optional | A list of successfully synced objects. Maximum items: 5000 Minimum items: 1 |
successful_syncs[] | Model | Each item | Expand Post sync status — request body — body successful syncs item |
sync_request_id | JSON | Optional | |
sync_request_id (anyOf 1) | string | Alternative | For Sync Button flows, provide the sync request ID received from the TRANSACTION_SYNC_REQUESTED, REIMBURSEMENT_SYNC_REQUESTED, or ACCRUAL_SYNC_REQUESTED outbound webhook. Do not provide this value for non-Sync Button flows. Default: null Format: uuid |
sync_request_id (anyOf 2) | null | Alternative | |
sync_type | string | Required within parent | The type of object to sync. One of: ACCRUAL_SYNC, BILL_PAYMENT_SYNC, BILL_SYNC, BROKERAGE_ORDER_SYNC, RECOGNITION_SCHEDULE_ENTRY_SYNC, REIMBURSEMENT_SYNC, REPAYMENT_SYNC, STATEMENT_CREDIT_SYNC, TRANSACTION_SYNC, TRANSFER_SYNC, WALLET_TRANSFER_SYNC |
Referenced models: Post sync status — request body — body failed syncs item, Post sync status — request body — body successful syncs item
Post sync status — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
sync_id | string | Required within parent | Unique identifier of the sync job. Format: uuid |
Post sync status — request body — body failed syncs item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
error | Model | Required within parent | Expand Post sync status — request body — body failed syncs item error describes the reason why the sync object failed to sync. |
id | string | Required within parent | ID that uniquely identifies the object to sync in Ramp systems. Format: uuid |
Referenced models: Post sync status — request body — body failed syncs item error
Post sync status — request body — body successful syncs item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
deep_link_url | string | Optional | URL that links to the object in the remote ERP system. Applicable for transactions, reimbursements, bills, and bill payments. Bill payment syncs update the bill's URL. Omitting this field preserves the existing URL. Format: url |
id | string | Required within parent | ID that uniquely identifies the object to sync in Ramp systems. Format: uuid |
reference_id | string | Required within parent | ID that uniquely identifies the object to sync in remote ERP systems. |
Post sync status — request body — body failed syncs item error
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
message | string | Required within parent | an error message that explains the reason of the sync failure. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: ramp.post_sync_list_resource. Catalog operation: post_sync_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"]