API documentation | API docs for agents | OpenAPI 3.1

previews

ark.preview_factoring_activity

Preview Factoring Activity 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

obligationIdstringrequired

format: uuid

preparationFingerprintstringrequired

kindstringrequired

one of: funding, customer_collection, reserve_release, fee, mixed

effectiveDatestringrequired

referencestringrequired

min length: 1; max length: 200

advanceMinorstringrequired

grossCollectionMinorstringrequired

reserveHoldMinorstringrequired

reserveReleaseMinorstringrequired

feeMinorstringrequired

feeSourcestring | nullrequired

varianceAcknowledgedboolean

default: false

varianceNotestring | null

evidenceobject | null

Example request

Shell

curl -X POST 'https://arktms.com/api/v1/billing/factoring/activities/previews' \
  -H "Authorization: Bearer $ARK_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "obligationId": "<obligationId>",
  "preparationFingerprint": "<preparationFingerprint>",
  "kind": "funding",
  "effectiveDate": "<effectiveDate>",
  "reference": "<reference>",
  "advanceMinor": "<advanceMinor>",
  "grossCollectionMinor": "<grossCollectionMinor>",
  "reserveHoldMinor": "<reserveHoldMinor>",
  "reserveReleaseMinor": "<reserveReleaseMinor>",
  "feeMinor": "<feeMinor>",
  "feeSource": "reserve"
}'

Success response

Operation result.

objectstringrequired

okbooleanrequired

api_versionstringrequired

request_idstringrequired

dataobjectrequired

data.previewobjectrequired

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