MCP documentation | MCP docs for agents
ark_preflight_carrier_remittance_email
ark.preflight_carrier_remittance_email
Check whether selected ARK carrier payments or settlements are ready to send grouped carrier or factoring remittance emails.
- Availability
- Expanded preview
- Scopes
loads:readbilling:read- ARK permissions
canViewLoadscanViewBilling- Team visibility
- Required and enforced
- Approval policy
none- ARK approval request
- Not required
- Idempotency
- Not required
- Read-only
- Yes
- Destructive
- No
- External side effect
- No
- Rate limit
- OAuth MCP credential and organization budgets
Input
remittanceTypestringrequiredUse payment with carrierPaymentIds for selected payments, or settlement with settlementNumbers for existing carrier settlements.
one of: payment, settlement
carrierPaymentIdsarray<string>Visible carrier payment IDs when remittanceType is payment.
min items: 1; max items: 100
settlementNumbersarray<integer>Visible carrier settlement numbers when remittanceType is settlement.
min items: 1; max items: 50
Result
The tool returns the canonical ark.preflight_carrier_remittance_email 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.