ARGUS Enterprise · JSON Structure

Argus Enterprise Report Request Structure

ReportRequest schema from ARGUS Enterprise API

Type: object Properties: 7 Required: 1
Altus GroupAsset ManagementCash Flow ModelingCommercial Real EstatePortfolio ManagementValuation

ReportRequest is a JSON Structure definition published by ARGUS Enterprise, describing 7 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

reportType name propertyIds portfolioIds startDate endDate outputFormat

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/argus-enterprise/refs/heads/main/json-structure/argus-enterprise-report-request-structure.json",
  "name": "ReportRequest",
  "description": "ReportRequest schema from ARGUS Enterprise API",
  "type": "object",
  "properties": {
    "reportType": {
      "type": "string",
      "enum": [
        "PropertySummary",
        "PortfolioSummary",
        "CashFlowAnalysis",
        "ValuationSummary",
        "LeaseExpiry",
        "TenantRoll",
        "CapitalExpenditure"
      ]
    },
    "name": {
      "type": "string"
    },
    "propertyIds": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      },
      "description": "Properties to include in the report"
    },
    "portfolioIds": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      },
      "description": "Portfolios to include in the report"
    },
    "startDate": {
      "type": "date"
    },
    "endDate": {
      "type": "date"
    },
    "outputFormat": {
      "type": "string",
      "enum": [
        "PDF",
        "Excel",
        "CSV"
      ],
      "default": "PDF"
    }
  },
  "required": [
    "reportType"
  ]
}