MCP documentation | MCP docs for agents
ark_record_customer_payments
ark.record_customer_payments
Record selected invoiced or factored ARK customer payments as PAID in one AR workflow, with optional QuickBooks customer payment sync.
- Availability
- Expanded preview
- Scopes
loads:readbilling:write- ARK permissions
canViewLoadscanViewBillingcanMakeAdjustments- Team visibility
- Required and enforced
- Approval policy
ask_before_write- ARK approval request
- Required before execution
- Idempotency
- Required for external execution
- Read-only
- No
- Destructive
- No
- External side effect
- Yes
- Rate limit
- OAuth MCP credential and organization budgets
Input
customerPaymentIdsarray<string>requiredVisible INVOICED or FACTORED customer payment IDs to mark PAID.
min items: 1; max items: 100
referenceNumberstring | nullOptional payment reference number applied to every selected payment.
max length: 100
paidDatestringrequiredPayment date in YYYY-MM-DD format.
queueQuickBooksSyncbooleanAlso queue QuickBooks customer payment sync for positive-value invoices.
default: false
depositToAccountIdstringQuickBooks deposit account ID used when queueQuickBooksSync is true.
max length: 100
Result
The tool returns the canonical ark.record_customer_payments operation result in structuredContent and mirrors the same JSON as text. Errors set isError: true and return a stable error code, message, and optional details.