Supergood | CCH iFirm API

Supergood | CCH iFirm API

Programmatically access CCH iFirm client data, jobs/workflows, timesheets, billing, and document/portal artifacts with a stable REST API. Supergood builds and operates production-grade, unofficial CCH iFirm integrations so your team can automate firm operations and compliance workflows without heavy custom engineering.

Plain English: CCH iFirm is Wolters Kluwer’s cloud suite for accounting firms to manage clients, engagements, time & billing, workflow, and document sharing. An unofficial API lets you programmatically pull client lists, engagement/jobs, tasks, timesheets, WIP and invoices, and documents—and push new records or updates back into CCH iFirm.

For a tech company integrating with CCH iFirm—especially a GRC, regtech, or audit startup—this means you can ingest real-time client and engagement metadata, orchestrate job/task workflows, collect and attach evidence documents, sync timesheets and invoices to your ledgers, and drive compliance dashboards. You can trigger client-facing portal updates, automate approvals, surface SLA alerts for due dates, and keep downstream systems (ERP/accounting like QuickBooks/Xero, analytics, CRM, scheduling) in lockstep.

What is CCH iFirm?

CCH iFirm (https://www.wolterskluwer.com/en/solutions/cch-ifirm) is a cloud platform for accounting and advisory practices that centralizes client management, engagements/jobs, time & billing, workflow, and document/portal collaboration. Firms use CCH iFirm to track compliance obligations and service delivery (e.g., audits, tax returns, BAS/VAT, financial statements), manage staff assignments and due dates, capture timesheets and WIP, issue invoices and collect payments, and exchange documents securely with clients.

Core product areas include:

  • Practice Management (Clients, Groups, Jobs/Engagements, Workflow, Tasks, Assignments, Due Dates)
  • Time & Billing (Timesheets, WIP, Fees, Disbursements, Invoices, Payments)
  • Document & Portal (Document Storage, Foldering, Client Portal, Sharing/Approvals)
  • Compliance & Lodgement (Milestones, Checklists, Periods, Statutory Deadlines)
  • CRM & Contacts (Client Profiles, Primary Contacts, Communication Preferences)

Common data entities:

  • Firms, Users, Roles/Permissions
  • Clients and Groups (entities, relationships, tax/registration numbers)
  • Contacts (primary, billing)
  • Jobs/Engagements (type, period, status, due dates)
  • Workflow Tasks and Checklists (assignees, stages, approvals)
  • Timesheets/Activities (date, hours, billable, cost codes)
  • WIP and Billing (fees, disbursements, write-ups/downs)
  • Invoices and Payments (line items, taxes, status)
  • Documents and Portal Artifacts (folders, tags, sharing state)

The CCH iFirm Integration Challenge

Accounting practices rely on CCH iFirm daily, but turning portal-based workflows into API-driven automation is non-trivial:

  • Role-aware access: Partners, staff, and clients each see different data, scopes, and approval states
  • Financial rigor: WIP, invoices, taxes, and write-ups/downs require precise, auditable handling
  • Workflow-oriented UI: Jobs, tasks, and checklists are optimized for front-end flows
  • Authentication complexity: SSO/MFA and session lifecycles complicate headless automation
  • Data spread: Key objects span clients, jobs, tasks, time, billing, and documents with context in multiple views

How Supergood Creates CCH iFirm APIs

Supergood reverse-engineers authenticated browser flows and network interactions to deliver a resilient API endpoint layer for your CCH iFirm tenant.

  • Handles username/password, SSO/OAuth, and MFA (SMS, email, TOTP) securely
  • Maintains session continuity with automated refresh and change detection
  • Normalizes responses so you can integrate once and rely on consistent objects across modules
  • Aligns with customer entitlements and role-based permissions to ensure compliant access

Use Cases

Client & Engagement Data Sync

  • Mirror clients, contacts, and groups into your internal systems
  • Keep engagement/job metadata current for compliance dashboards and audit planning
  • Normalize identifiers (client codes, tax numbers) across multi-entity operations

Workflow & Evidence Automation

  • Create jobs and task structures from your compliance templates
  • Trigger approvals/sign-offs and track status transitions
  • Attach evidence files, map them to tasks, and surface reviewer checks

Time & Billing Reconciliation

  • Pull timesheets and WIP to reconcile with your financial systems
  • Generate invoices from engagement progress and push back to CCH iFirm
  • Monitor write-ups/downs and billable utilization for risk and performance reporting

Document & Portal Management

  • Upload policy/KYC documents and audit evidence directly to client folders
  • Control portal visibility and tags for downstream discovery
  • Streamline retention policies and audit trails for document handling

Available Endpoints

Authentication

POST /sessions: Establish a session using credentials. Supergood manages MFA (SMS, email, TOTP) and SSO/OAuth when enabled. Returns a short-lived auth token maintained by the platform.

curl --request POST \
  --url https://api.supergood.ai/integrations/<integration_id>/sessions \
  --header 'Authorization: Basic <Base64 encoded token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "username": "[email protected]",
    "password": "<password>",
    "mfa": { "type": "totp", "code": "123456" }
  }'

Example response

{
  "authToken": "eyJhbGciOi...",
  "expiresIn": 3600,
  "user": {
    "id": "u_ifirm_913b10",
    "name": "Engagement Manager",
    "entitlements": ["clients", "jobs", "tasks", "time", "billing", "documents"]
  }
}

POST /sessions/refresh: Refresh an existing token to keep sessions uninterrupted.

Clients

GET /clients: List clients with filters and summary details.

Query parameters

  • groupId: string
  • status: active | archived | prospect
  • service: audit | tax | advisory | bookkeeping
  • updatedFrom, updatedTo: ISO 8601 timestamps
  • page, pageSize: integers for pagination

Example response

{
  "items": [
    {
      "clientId": "cl_4f29a1",
      "clientCode": "ACME-001",
      "name": "Acme Manufacturing Pty Ltd",
      "status": "active",
      "country": "AU",
      "taxNumber": "ABN 12 345 678 901",
      "groupId": "grp_8c31f0",
      "primaryContact": {
        "name": "Dana Smith",
        "email": "[email protected]",
        "phone": "+61 2 5550 1234"
      },
      "services": ["audit", "tax"],
      "address": {
        "line1": "100 Market St",
        "city": "Sydney",
        "region": "NSW",
        "postalCode": "2000",
        "country": "AU"
      },
      "tags": ["Manufacturing", "High Risk"],
      "updatedAt": "2026-01-20T13:45:00Z"
    }
  ],
  "page": 1,
  "pageSize": 50,
  "total": 1
}

Jobs/Engagements

POST /clients/{clientId}/jobs: Create a job (engagement) with type, period, budget, and assignments.

curl --request POST \
  --url https://api.supergood.ai/integrations/<integration_id>/clients/cl_4f29a1/jobs \
  --header 'Authorization: Bearer <authToken>' \
  --header 'Content-Type: application/json' \
  --data '{
    "title": "FY2025 Statutory Audit",
    "jobType": "audit",
    "periodStart": "2025-07-01",
    "periodEnd": "2026-06-30",
    "dueDate": "2026-09-30",
    "status": "planned",
    "assignedStaff": ["u_ifirm_913b10", "u_ifirm_7a8c32"],
    "budgetHours": 280,
    "billable": true,
    "checklistTemplateCode": "AUDIT-STD-2025",
    "notes": "Group audit with 2 subsidiaries.",
    "referenceId": "grc-eng-7782"
  }'

Example response

{
  "jobId": "job_72be50",
  "status": "planned",
  "createdAt": "2026-01-21T10:03:11Z"
}

Workflow Tasks

PATCH /jobs/{jobId}/tasks/{taskId}: Update task status, assignee, due date, and checklist progress.

curl --request PATCH \
  --url https://api.supergood.ai/integrations/<integration_id>/jobs/job_72be50/tasks/tsk_3f10c4 \
  --header 'Authorization: Bearer <authToken>' \
  --header 'Content-Type: application/json' \
  --data '{
    "status": "in_progress",
    "assigneeId": "u_ifirm_7a8c32",
    "dueDate": "2026-02-15",
    "percentComplete": 40,
    "checklist": [
      {"itemId": "chk_1001", "completed": true},
      {"itemId": "chk_1002", "completed": false}
    ],
    "review": {"required": true, "state": "pending"},
    "notes": "Confirm inventory sampling selection and tolerance."
  }'

Example response

{
  "taskId": "tsk_3f10c4",
  "status": "in_progress",
  "assigneeId": "u_ifirm_7a8c32",
  "percentComplete": 40,
  "updatedAt": "2026-01-22T08:15:12Z"
}

Documents & Portal

POST /clients/{clientId}/documents: Upload a document with classification, tagging, and portal visibility.

curl --request POST \
  --url https://api.supergood.ai/integrations/<integration_id>/clients/cl_4f29a1/documents \
  --header 'Authorization: Bearer <authToken>' \
  --header 'Content-Type: application/json' \
  --data '{
    "fileName": "inventory_count_sheet.pdf",
    "uploadToken": "upl_08ab73",
    "category": "Audit Evidence",
    "tags": ["Inventory", "FY2025"],
    "jobId": "job_72be50",
    "portalVisible": true,
    "retentionPolicy": {"class": "Audit", "years": 7},
    "checksum": "b1946ac92492d2347c6235b4d2611184"
  }'

Example response

{
  "documentId": "doc_90e412",
  "version": 1,
  "status": "stored",
  "createdAt": "2026-01-21T10:03:11Z"
}

Get full API Specs →


Technical Specifications

  • Authentication: Username/password with MFA (SMS, email, TOTP) and SSO/OAuth where enabled; supports service accounts or customer-managed credentials
  • Response format: JSON with consistent resource schemas and pagination across modules
  • Rate limits: Tuned for enterprise throughput while honoring customer entitlements and usage controls
  • Session management: Automatic reauth and cookie/session rotation with health checks
  • Data freshness: Near real-time retrieval of clients, jobs, tasks, timesheets, billing, and documents
  • Security: Encrypted transport, scoped tokens, and audit logging; respects CCH iFirm role-based permissions
  • Webhooks: Optional asynchronous delivery for long-running workflows (e.g., approvals, due date changes)

Performance Characteristics

  • Latency: Sub-second responses for list/detail queries under normal load
  • Throughput: Designed for high-volume client/job sync and document/task processing
  • Reliability: Retry logic, backoff, and idempotency keys minimize duplicate actions
  • Adaptation: Continuous monitoring for UI/API changes with rapid adapter updates

Getting Started

  1. Schedule Integration Assessment

Book a 30-minute session to confirm your modules, licensing, and authentication model.

  1. Supergood Builds and Validates Your API

We deliver a hardened CCH iFirm adapter tailored to your workflows and entitlements.

  1. Deploy with Monitoring

Go live with continuous monitoring and automatic adjustments as CCH iFirm evolves.

Schedule Integration Call →


Frequently Asked Questions

Q: Which CCH iFirm modules can this integration cover?

Supergood supports workflows across commonly used modules such as Practice Management (Clients, Groups, Jobs/Engagements, Workflow/Tasks), Time & Billing (Timesheets, WIP, Invoices, Payments), and Document/Portal, subject to your licensing and entitlements. We scope coverage during integration assessment.

Q: How are MFA and SSO handled for automation?

We support username/password + MFA (SMS, email, TOTP) and can operate behind SSO/OAuth when enabled. Sessions are refreshed automatically with secure challenge handling.

Q: Can you sync invoices and timesheets to our accounting system?

Yes. We can normalize WIP, invoices, fees/disbursements, and billable hours to match your ERP/accounting schema and deliver updates via webhooks or polling while complying with rate and permission constraints. We commonly integrate with QuickBooks and Xero.

Q: Are portal documents and approvals supported?

Yes. We support downloading approval artifacts and uploading attachments via signed uploads, with checksum validation and time-limited URLs. Portal visibility, retention policies, and tagging are modeled explicitly in our normalized responses.



Ready to automate your CCH iFirm workflows?

Supergood can have your CCH iFirm integration live in days with no ongoing engineering maintenance.

Get Started →

Read more