Skip to content

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.

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

Referenced models: Post sync status — 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 Post sync status — response body

Referenced models: Post sync status — response body

Post sync status — request body — body
FieldTypePresenceDescription and constraints
$objectRoot
failed_syncsarrayOptionalA list of objects that failed to be synced.
Maximum items: 5000
Minimum items: 1
failed_syncs[]ModelEach itemExpand Post sync status — request body — body failed syncs item
idempotency_keystringRequired within parentAn 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_syncbooleanOptionalMark 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_syncsarrayOptionalA list of successfully synced objects.
Maximum items: 5000
Minimum items: 1
successful_syncs[]ModelEach itemExpand Post sync status — request body — body successful syncs item
sync_request_idJSONOptional
sync_request_id (anyOf 1)stringAlternativeFor 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)nullAlternative
sync_typestringRequired within parentThe 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
FieldTypePresenceDescription and constraints
$objectRoot
sync_idstringRequired within parentUnique identifier of the sync job.
Format: uuid
Post sync status — request body — body failed syncs item
FieldTypePresenceDescription and constraints
$objectRoot
errorModelRequired within parentExpand Post sync status — request body — body failed syncs item error
describes the reason why the sync object failed to sync.
idstringRequired within parentID 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
FieldTypePresenceDescription and constraints
$objectRoot
deep_link_urlstringOptionalURL 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
idstringRequired within parentID that uniquely identifies the object to sync in Ramp systems.
Format: uuid
reference_idstringRequired within parentID that uniquely identifies the object to sync in remote ERP systems.
Post sync status — request body — body failed syncs item error
FieldTypePresenceDescription and constraints
$objectRoot
messagestringRequired within parentan error message that explains the reason of the sync failure.

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

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.