Reports

Send a report packet

Sends the interactive report page as a one-way monthly packet notification and records a durable company-period delivery. It does not create a Client Request because no client response is expected. Deliver to either an active company owner with client-portal access or an active outside tax preparer. Provide ownerContactId for company_owner delivery or taxPreparerId for tax_preparer delivery. Reuse resendKey for an exact retry and change it only for an explicit resend.

post/reports/packets/{packetId}/send

Request

  • Base URL: https://ledgerhq.pro/api/v1
  • URL: https://ledgerhq.pro/api/v1/reports/packets/{packetId}/send
  • 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

packetIdstring uuid required

Report packet UUID

Request body

companyOrganizationIdstring uuid required
ownerContactIdstring uuid
taxPreparerIdstring uuid
recipientType'company_owner' | 'tax_preparer'
coverNotestring nullable

Legacy alias for personalNote. Rejected when it conflicts with personalNote.

personalNotestring nullable

Optional accountant personal note shown before the financial highlights.

noteAuthorUserIdstring uuid nullable

Exact active firm member attributed on the note. Defaults to the authenticated sender.

noteSource'accountant' | 'tally' nullable
noteContentDigeststring nullable
noteOperation'draft' | 'rewrite' | 'shorten' nullable
attachmentIdsstring[]
resendKeystring nullable
confirmunknown required

Response

Report packet delivery receipt

packetIdstring uuid required
contentDigeststring required
deliveryIdstring uuid required
providerMessageIdstring nullable required
duplicateboolean required
attachmentIdsstring[] required
pageUrlPathstring required
idempotencyKeystring required

Changes

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