Client Requests (Firm)

Create a client request for a firm-managed company

Creates a request on the named company's books. The company must belong to the caller's firm (404 otherwise). Returns the created request detail plus the client-facing public link.

post/firm/client-requests

Request

  • Base URL: https://ledgerhq.pro/api/v1
  • URL: https://ledgerhq.pro/api/v1/firm/client-requests
  • Auth: one of:
    • HTTP bearer and API key in header x-organization-id
    • HTTP bearer and API key in header x-organization-id

Request body

companyOrganizationIdstring uuid required

Firm-managed company to create the request in.

questionstring required
goalstring nullable

What resolves the request. Defaults to the question.

requestType'question' | 'document_statement' | 'document_receipt' | 'document_other' | 'task' | 'message' | 'bank_reconnect'

message creates an active in-app conversation that stays open until the firm closes it.

subjectstring nullable
ownerIdsstring[]

Explicit company owner-contact ids to add as participants.

attachmentIdsstring[]

Company attachment ids returned by POST /attachments/presign.

assignedActor'tally' | 'firm_user'

Handler for the request. Defaults to tally.

assignedUserIdstring uuid nullable
dueDatestring date-time nullable
relatedEntityTypestring nullable
relatedEntityIdstring uuid nullable
metadataobject

Response

Created request and public client link

requestobject

Changes

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