Condition Reports

Generate condition report PDF

Generate a filled condition report PDF via AnnexGenerationService.generate_condition_report_pdf(), which extends the existing generate_edl_annex() method by injecting recorded element conditions, meter snapshots, and key snapshots into the Typst template (etat_des_lieux.typ).

Equipment and inventory data are auto-captured from current state via EquipmentPort and RoomInventoryPort: no separate endpoints needed.

Meter readings are resolved via the lease_meter → meter → meter.type chain to map to the template's meter_readings: {electricity, gas, cold_water, hot_water} contract.

The generated PDF follows décret 2016-382 format requirements.

Note: This produces a filled PDF (from recorded observations). The existing system annex "etat_des_lieux" (via download_lease_annex) continues to produce a blank PDF for on-site use.

Permissions required: leases:write

post/leases/{lease_id}/condition-reports/{report_id}/generate-pdf

Request

  • Base URL: https://api.faireplace.com/api
  • URL: https://api.faireplace.com/api/leases/{lease_id}/condition-reports/{report_id}/generate-pdf
  • Auth: HTTP bearer

Path parameters

lease_idstring uuid required
report_idstring uuid required

Response

PDF generated, document_url updated

idstring uuid
lease_idstring uuid
report_type'ENTRY' | 'EXIT'
report_datestring date
status'DRAFT' | 'COMPLETED' | 'SIGNED' | 'DISPUTED'
conducted_bystring
conducted_by_type'OWNER' | 'AGENT' | 'BAILIFF'
general_notesstring nullable
document_urlstring nullable

Filled PDF URL (from generate-pdf)

document_signature_idstring uuid nullable

FK to document_signatures (from initiate-signature)

signed_document_urlstring nullable

Signed PDF URL (from finalize-signature)

created_atstring date-time
updated_atstring date-time

Changes

No recorded changes to this operation across all 1 revision of this API.