PayCanvas

Read a tenant-authorized payroll workspace summary, including readiness, source status, latest period, blockers, and safe next actions. This tool cannot start or change payroll work.

get_payroll_workspace

Read a tenant-scoped source-collection job's phase, progress, and safe receipt or error code. Pass the internally resolved period ID when available so historical jobs remain addressable. This tool cannot retry, resume, or contact a provider.

get_source_collection_job

Read bounded active and voided adjustment history for one tenant period. This tool cannot create, edit, approve, or void an adjustment.

list_adjustments

Read bounded sanitized audit history with safe actor references, action metadata, hashes, and lifecycle transitions.

list_payroll_audit_events

Use this when an operator refers to the oldest, latest, current, or a date-range payroll period. List deterministic, sanitized summaries, resolve the intended period, and keep returned UUIDs internal for follow-up tools.

list_payroll_periods

Read bounded saved-decision and resolution history for one tenant period without changing decisions or private overlay contents.

list_resolutions

Read a tenant-authorized, period-scoped evidence index covering sanitized source receipts, reconciliation, source assembly, and calculation lineage. It never returns report contents, provider payloads, credentials, private mappings, aliases, or raw source rows.

list_source_evidence

List bounded, tenant- and period-scoped immutable operator review records. Each record is explicitly marked as not applied to payroll.

list_resolution_reviews

List bounded, tenant- and period-scoped unresolved payroll items. Each item includes a plain-language explanation, why it matters, and the factual question an operator should answer. This tool does not create or apply a resolution.

list_open_payroll_items

Use this when an operator has explained their evidence-based answer to an unresolved item and wants to see exactly what PayCanvas would record. It rechecks the current item and returns confirmation hashes. It creates no record and has no payroll effect.

preview_resolution_review

Use this when an authorized payroll operator wants to calculate one source-complete period. It rechecks the frozen source assembly, post-close capture in the tenant operating timezone, hard financial-integrity gates, held-money treatment for ordinary pay-affecting ambiguities, and exact state, then returns the confirmation effect. It does not create a calculation, result, approval, export, email, or payment.

preview_payroll_calculation

Use only for an unresolved item that PayCanvas marks as having a safe resolution candidate. Returns the factual question, why it exists, held-money context, stale-state hashes, and a closed list of safe choices. Present only those choices and keep opaque IDs internal. This writes nothing and cannot accept an amount, rate, identity, mapping, policy, or free-text decision.

preview_payroll_resolution

Check whether a tenant-admin operator can start a bounded America/Chicago API-backed comparison source-collection job for a date range. Returns blockers, an exact confirmation effect, and a stale-state hash. It creates no period, job, provider request, calculation, or payroll output.

preview_source_collection

Preview copying an exact set of active manual-adjustment IDs from one prior period into one open target period. Use IDs returned by list_adjustments and omit any employee the operator excluded. Returns every payee, amount, target effective date, total, blockers, and a stale-state hash. It writes nothing and rejects all-payees records.

preview_payroll_adjustment_copy

Read one bounded persisted payroll-result view: lines, employee totals, aggregates, pools, or calculation exceptions. Only dashboard-supported dimensions are accepted.

list_payroll_result_lines

Use this only after preview_resolution_review returned a preview and the operator explicitly confirmed its exact non-payroll effect. Records an immutable tenant-scoped review note with idempotency and audit receipt. It cannot apply a payroll resolution, calculate, approve, export, pay, or email.

record_resolution_review

Use only after preview_payroll_calculation returned an unblocked preview and an authorized payroll operator explicitly confirmed its exact effect. Queues the existing calculation worker against the post-close frozen source assembly and pinned configuration. It produces a financially safe result: provisional while pay-affecting items remain, otherwise final. Final is still not approved. This cannot resolve an ambiguity, approve payroll, export, email, pay, or change payroll policy.

start_payroll_calculation

Use only after preview_source_collection returned an unblocked preview and an authorized payroll operator explicitly confirmed its exact effect. Creates the existing API-backed operator-comparison period and queues its tenant-scoped source-collection job with idempotency. The background worker may perform only configured bounded provider GET requests using Vault-held credentials. It cannot calculate, approve, export, pay, email, or change payroll policy.

start_source_collection