Skip to content
Hoursmith Docs
Payouts

Payout integrations

Read private payout data through the REST API, understand MCP release availability, and subscribe explicitly to payout webhooks.

Payout integrations are read-only. They cannot create compensation, approve bills, initiate payments, or send bill email. Use the reviewed workflows in the app for those actions.

REST API

The Payouts reference documents nine GET endpoints under /api/v1/team-payouts: payee, bill, and payment lists/details; summary; unpaid time; and profitability. Use an Owner/Admin token with read access. Agency is required for active compensation queries; Studio retains finalized bill/payment history through the API after downgrade. Free-plan app history does not imply API access.

Payout payee IDs are not membership IDs; use the returned userId to correlate general member data. Generic member responses do not expose compensation. Preserve opaque list cursors and keep filters and sort unchanged while paging. Bills use bill currency; payment filters use actual transfer currency.

MCP release availability

As checked on September 24, 2026, npm's latest for @hoursmith/mcp-server is 0.11.0, including nine read-only payout tools. Update an older installation to use them. 0.12.0 remains unpublished; its detail-tool descriptions add explicit receiving-method/delivery metadata guidance.

The live REST schema now includes bounded receiving-method labels and delivery summaries, counts, and authenticated retained-PDF links in detail responses. Bank/UPI details, email subject/body, review tokens, and encrypted content remain excluded. Delivery status does not mean paid. See the generated payee and bill references for the exact deployed schema.

Webhooks

Agency endpoints must explicitly subscribe to team_bill.approved, team_bill.voided, team_payment.recorded, and/or team_payment.reversed. Existing subscriptions do not automatically receive them. Standard signature verification, retries, and event-ID deduplication apply.

These are minimal event snapshots, not complete private bills. They exclude pay rates, bank/tax details, and private attachment URLs. Keep your receiving endpoint private too.

Was this page helpful?

On this page