Skip to main content
Version: 1.0.0-beta

Field Reference — Reporting

Report Fields

FieldTypeRequiredDescription
idIntegerAutoUnique identifier
engagement_idIntegerOptionalParent engagement (null for portfolio reports)
titleStringReport title
template_idIntegerOptionalReport template reference
template_versionIntegerOptionalTemplate version used
cover_titleStringOptionalCover page title
cover_dateStringOptionalCover page date
confidentiality_levelStringAutoDefault: "Confidential"
executive_summaryTextOptionalExecutive summary narrative
introductionTextOptionalIntroduction section
objectivesJSON ArrayOptionalList of audit objectives
scopeTextOptionalScope description
overall_ratingStringOptionalSatisfactory / Needs Improvement / Unsatisfactory
sections_jsonJSON ArrayOptionalCustom sections structure
conclusionTextOptionalConclusion narrative
statusStringAutoDRAFT, REVIEW, APPROVED, ISSUED
created_atDateTimeAutoCreation timestamp
generated_atDateTimeAutoWhen AI generated content
exported_atDateTimeAutoLast PDF export time
issued_atDateTimeAutoWhen officially issued

Report Version Fields

FieldTypeDescription
idIntegerUnique identifier
report_idIntegerParent report
version_numberIntegerSequential version
content_snapshotStringFull content snapshot (JSON/HTML)
created_atDateTimeVersion creation time
created_by_idStringUser who created the version

Report Approval Fields

FieldTypeDescription
idIntegerUnique identifier
report_idIntegerParent report
approver_idStringApprover user ID
roleStringApprover role (CAE, Manager)
statusStringPENDING, APPROVED, REJECTED
approved_atDateTimeDecision timestamp
commentsStringApproval/rejection comments

Status Transitions

DRAFT → REVIEW → APPROVED → ISSUED
↑ |
└── (rejected/revisions)