API documentation | API docs for agents | OpenAPI 3.1

preview

ark.preview_billing_financial_action

Preview Billing Financial Action through the authoritative Billing application boundary.

Availability: Expanded preview
Scopes: loads:readbilling:read
ARK permissions: canViewLoadscanViewBilling
Team visibility: Required and enforced
Idempotency-Key: Not required
Approval: No MCP approval on REST API-token calls
Rate limit: API credential and organization budgets

Parameters

None.

Request body

reasonstring

default: "Billing workbench action"; min length: 1; max length: 1000

queueQuickBooksSyncboolean

default: false

targetsarray<object>required

min items: 1; max items: 1

correctionSidestringrequired

one of: ap, ar

effectiveDatestring

accountingDatestring

evidenceReferencestring | null

reviewItemIdstring

format: uuid

reviewItemVersioninteger

max: 9007199254740991

reconciliationIdstring

format: uuid

reconciliationVersioninteger

max: 9007199254740991

correctionEvidenceIdstring

format: uuid

correctionPaymentIdstring

format: uuid

correctionPaymentVersioninteger

max: 9007199254740991

actionstringrequired

reconciliationResolutionKindstring

one of: stopped_or_superseded, recovered, reclassified, dismissed

correctionAmountMinorstring

correctionApplicationReversalsarray<object>

min items: 1; max items: 100

correctionExpectedObligationVersionsobject

correctionDestinationReferencestring

min length: 1; max length: 255

correctionApprovalReferencestring

min length: 1; max length: 255

Example request

Shell

curl -X POST 'https://arktms.com/api/v1/billing/financial-actions/preview' \
  -H "Authorization: Bearer $ARK_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "targets": [
    {
      "obligationId": "<obligationId>",
      "expectedWorkflowVersion": 1,
      "expectedBalanceVersion": 1
    }
  ],
  "correctionSide": "ap",
  "reviewItemId": "<reviewItemId>",
  "reviewItemVersion": 1,
  "reconciliationId": "<reconciliationId>",
  "reconciliationVersion": 1,
  "correctionEvidenceId": "<correctionEvidenceId>",
  "correctionPaymentId": "<correctionPaymentId>",
  "correctionPaymentVersion": 1,
  "action": "reconciliation.match_payment"
}'

Success response

Operation result.

objectstringrequired

okbooleanrequired

api_versionstringrequired

request_idstringrequired

dataobjectrequired

data.okbooleanrequired

data.actionstringrequired

data.updatedCountintegerrequired

min: 0

data.messagestringrequired

data.failuresarray<object>required

Action-specific JSON-safe result, including current versions and fingerprints.

Errors

HTTP 400: Invalid request
HTTP 401: Authentication required
HTTP 403: Permission, scope, team, or entitlement denied
HTTP 404: Resource not found
HTTP 409: Idempotency conflict or in-progress retry