MCP documentation | MCP docs for agents
ark_generate_carrier_payment_packet
ark.generate_carrier_payment_packet
Generate and store an ARK carrier payment packet PDF by combining selected load documents, then optionally attach it to the carrier payment and mark it invoiced.
- 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
loadIdstringrequiredVisible ARK load ID whose carrier payment packet should be generated.
format: uuid
dispatchIdstringrequiredVisible dispatch ID for the carrier payment.
format: uuid
carrierPaymentIdstringOptional carrier payment ID. Omit to use the carrier payment for the load dispatch.
format: uuid
sourceFileIdsarray<string>requiredLoad file IDs to merge into the carrier payment packet.
min items: 1; max items: 100
fileNamestringOptional payment packet PDF file name. A .pdf extension is added when omitted.
max length: 200
attachToCarrierPaymentbooleanAttach the generated packet to the carrier payment and mark it INVOICED.
default: true
Result
The tool returns the canonical ark.generate_carrier_payment_packet 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.