Client Onboarding

Get a company's onboarding checklist

Returns the firm-started onboarding checklist for a managed company, or onboarding:null when none was started (a website signup keeps its own onboarding record). Six steps: client details, engagement letter, billing, client portal, books setup, finish. Each step reports done, not needed, or open, and whether it was detected automatically or marked by hand. Amounts are integer cents.

get/companies/{companyId}/onboarding

Request

  • Base URL: https://ledgerhq.pro/api/v1
  • URL: https://ledgerhq.pro/api/v1/companies/{companyId}/onboarding
  • Auth: one of:
    • HTTP bearer and API key in header x-organization-id
    • HTTP bearer and API key in header x-organization-id

Path parameters

companyIdstring uuid required

LedgerHQ company UUID

Response

{onboarding: checklist | null}

Changes

No recorded changes to this operation across all 5 revisions of this API.