Skip to main content

GenerateComplianceReportDto

filters objectrequired
siteIdstring
obligationTypestring

Possible values: [SAFETY, ENVIRONMENTAL, OPERATIONAL, FINANCIAL, OTHER]

statusstring

Possible values: [PENDING, IN_PROGRESS, COMPLIANT, NON_COMPLIANT, OVERDUE]

responsiblePersonIdstring
startDatestring

ISO date string (inclusive)

endDatestring

ISO date string (inclusive)

monthsBacknumber

For trend report — number of months to look back, default 12

pagenumber
Default value: 1
limitnumber
Default value: 50
projectionSummaryboolean
Default value: false
formatstringrequired

Possible values: [PDF, CSV, XLSX, JSON]

deliverystring

Possible values: [inline, async]

Default value: async
GenerateComplianceReportDto
{
"filters": {
"siteId": "string",
"obligationType": "SAFETY",
"status": "PENDING",
"responsiblePersonId": "string",
"startDate": "string",
"endDate": "string",
"monthsBack": 0,
"page": 1,
"limit": 50,
"projectionSummary": false
},
"format": "PDF",
"delivery": "async"
}