[Feature]: Add lease_execution_(applicant) Report

[jimbrig]

Request Body

• auth: list(type = "basic")
• method: list(name = "getReportData", version = "r3", params = list( {{ see_below }} ))

Filter Parameters

• lease_occupancy_types
• property_group_ids
• results_based_on: One of activity, moved_in, or current_status. Default is activity.
• period: Nested object containing daterange, date, and period_type
  • daterange: Nested object containing daterange-start and daterange-end using m/d/Y format.
  • date: Date using m/d/Y format.
  • period_type: One of today, yesterday, lastwk, currentcm, priorcm, currentcq, priorcq, currentcyr, priorcyr, daterange, and date
• applicant: 1, 4, or 2 - ?
• lease_type: 1, 3, or 5. Use 1 and 3?
• summarize_by: property, lease_type, or do_not_summarize. Use lease_type?
• group_by: property, lease_type, building_units, or do_not_group. Use property?
• lease_terms: Dependent on property_group_ids and lease_occupancy_types
• consolidate_by: no_consolidation, consolidate_all_properties, or consolidate_by_property_groups. Default to no_consolidation`.
• arrange_by_property: 0 or 1. Use 0.
• subtotals: 0 or 1. Use 0?

R Reference

httr2::req_body_json(list(
      auth = list(type = 'basic'),
      method = list(
        name = "getReportData",
        version = "r3",
        params = list(
          reportName = 'lease_execution_(applicant)',
          reportVersion = '1.8',
          filters = list(
            property_group_ids = as.list(as.character(property_ids)),
            period = list(
              daterange = list(
                'daterange-start' = as.Date(format(lubridate::today() - lubridate::days(7), "%m/%d/%Y"), format = '%m/%d/%Y'),
                'daterange-end' = as.Date(format(lubridate::today(), "%m/%d/%Y"), format = '%m/%d/%Y')
              ),
              period_type = 'daterange'
            ),
            results_based_on = 'activity',
            # results_based_on = 'current_status', # "activity,moved_in,current_status"
            # "applicant" = list(
            #   1,
            #   4,
            #   2
            # ),
            # "lease_type": list(
            #   1, # New Lease
            #   3, # Renewal
            #   5  # Transfer
            # ),
            lease_type = list('1', '3'),
            summarize_by = 'lease_type', # "property,lease_type,do_not_summarize"
            group_by = 'property', # "property,lease_type,building_units,do_not_group",
            # lease_terms = list(
            #   dependencies = "property_group_ids,lease_occupancy_types"
            # ),
            consolidate_by = 'no_consolidation', # "no_consolidation,consolidate_all_properties,consolidate_by_property_groups",
            arrange_by_property = 0, # "0,1"
            subtotals = 0 # "0,1"
          )
        )
      )

Entrata Report Info

Below is the JSON response for the getReportInfo Entrata Method:

View JSON

{
  "response": {
    "requestId": "15",
    "code": 200,
    "result": {
      "reports": {
        "report": [
          {
            "name": "lease_execution_(applicant)",
            "description": "The purpose of the Lease Execution (Applicant) report is to be able to track lease signatures based on applicant types.",
            "filters": {
              "lease_occupancy_types": [],
              "property_group_ids": [
                1161867,
                641240,
                739084,
                1197886,
                1143679,
                739079,
                518044,
                676055,
                952515,
                518041,
                518046,
                1197887,
                1132027,
                577897,
                1161871,
                739085,
                518042,
                833617,
                1311849,
                739080,
                739076,
                1115679
              ],
              "results_based_on": "activity,moved_in,current_status",
              "period": {
                "daterange": {
                  "daterange-start": "m/d/Y",
                  "daterange-end": "m/d/Y"
                },
                "date": "m/d/Y",
                "period_type": "today,yesterday,currentwk,lastwk,currentcm,priorcm,currentcq,priorcq,currentcyr,priorcyr,daterange,date"
              },
              "applicant": [
                1,
                4,
                2
              ],
              "lease_type": [
                1,
                3,
                5
              ],
              "summarize_by": "property,lease_type,do_not_summarize",
              "group_by": "property,lease_type,building_units,do_not_group",
              "lease_terms": {
                "dependencies": "property_group_ids,lease_occupancy_types"
              },
              "consolidate_by": "no_consolidation,consolidate_all_properties,consolidate_by_property_groups",
              "arrange_by_property": "0,1",
              "subtotals": "0,1"
            }
          }
        ]
      }
    }
  }
}

Entrata Report List

Below is the JSON response for the report via the getReportList Entrata Method:

View JSON

{
            "id": 780715,
            "reportName": "lease_execution_(applicant)",
            "systemName": "Lease Execution Summary (Applicant)",
            "reportVersions": {
              "reportVersion": [
                {
                  "version": "1.8",
                  "isLatest": true
                },
                {
                  "version": "1.7",
                  "isLatest": false
                },
                {
                  "version": "1.5",
                  "isLatest": false,
                  "titleAddendum": "Usage metrics indicate that this version is seldom being used. If you have this report version added as an instance in Company Reports in New Reporting, added to any page in Reports, or have it included in any Packets, please update to the latest version of the report.",
                  "expiryDate": "10/11/23"
                },
                {
                  "version": "1.4",
                  "isLatest": false,
                  "titleAddendum": "Usage metrics indicate that this version is seldom being used. If you have this report version added as an instance in Company Reports in New Reporting, added to any page in Reports, or have it included in any Packets, please update to the latest version of the report.",
                  "expiryDate": "03/09/22"
                },
                {
                  "version": "1.2",
                  "isLatest": false,
                  "titleAddendum": "Usage metrics indicate that this version is seldom being used. If you have this report version added as an instance in Company Reports in New Reporting, added to any page in Reports, or have it included in any Packets, please update to the latest version of the report.",
                  "expiryDate": "03/09/22"
                },
                {
                  "version": "1.1",
                  "isLatest": false,
                  "titleAddendum": "Usage metrics indicate that this version is seldom being used. If you have this report version added as an instance in Company Reports in New Reporting, added to any page in Reports, or have it included in any Packets, please update to the latest version of the report.",
                  "expiryDate": "01/12/22"
                }
              ]
            }
          },