CRM Proposals

Preview exact charges before starting billing (read-only)

Firm-side proposals. Select the firm with x-organization-id. Reads require active staff membership and access to every linked company; prospects are visible to their creator or firm managers. Writes require Firm Owner/Admin and billing permission. OAuth requires the broad mcp grant. Saves are revision-checked and idempotent using a stable requestId. All amounts are integer USD cents. Historical service dates and separately priced backwork are supported; saves never send, sign, provision companies or charge. Invalid dates, overlapping backwork/ongoing coverage and deposits exceeding the fee are rejected.

post/firm/crm/proposals/{id}/companies/{engagementId}/billing/preview

Request

  • Base URL: https://ledgerhq.pro/api/v1
  • URL: https://ledgerhq.pro/api/v1/firm/crm/proposals/{id}/companies/{engagementId}/billing/preview
  • 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

idstring uuid required
engagementIdstring uuid required

Request body

timeZonestring

Billing timezone, displayed during review. Date-based collections are scheduled at 09:00 in this timezone.

firstChargeOnstring required

First collection date, today or later; historical service dates do not initiate collection

firstUnpaidPeriodsobject

First unpaid recurring period for each service line; omit to use agreed ongoing coverage start. Already-paid periods can be skipped explicitly.

method'stripe' | 'outside'

stripe collects through the firm's connected Stripe account; outside records that the firm bills this engagement elsewhere and creates no charge

Response

Success

object required

Changes

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