openapi: 3.1.0 info: version: 1.0.0 title: Propexo API tags: - name: invoices x-displayName: Invoices - name: admin x-displayName: Admin - name: amenities x-displayName: Amenities - name: applicants x-displayName: Applicants - name: applications x-displayName: Applications - name: appointments x-displayName: Appointments - name: call-logs x-displayName: Call Logs - name: billing-and-payments x-displayName: Billing and Payments - name: units x-displayName: Units - name: construction-job-cost x-displayName: Construction Job Cost - name: deposits x-displayName: Deposits - name: deposit-summaries x-displayName: Deposit Summaries - name: employees x-displayName: Employees - name: events x-displayName: Events - name: files x-displayName: Files - name: leads x-displayName: Leads - name: leases x-displayName: Leases - name: listings x-displayName: Listings - name: note-categories x-displayName: Note Categories - name: owners x-displayName: Owners - name: properties x-displayName: Properties - name: purchase-orders x-displayName: Purchase Orders - name: residents x-displayName: Residents - name: service-requests x-displayName: Service Requests - name: vendors x-displayName: Vendors - name: general-ledger x-displayName: General Ledger - name: timezones x-displayName: Timezones - name: webhooks x-displayName: Webhooks - name: locations x-displayName: Locations servers: - url: https://api.propexo.com x-fern-server-name: Production - url: https://api.sandbox.propexo.com x-fern-server-name: Sandbox components: securitySchemes: bearerAuth: type: http scheme: bearer schemas: Enum8: type: string enum: &a283 - APPFOLIO - BUILDIUM - ENTRATA - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The integration vendor associated with the data diff _v1_admin_data-diffs__get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query integration_vendor: $ref: "#/components/schemas/Enum8" integration_id: type: string description: The integration id associated with the data diff before: type: - string - "null" description: Only show data diffs before this timestamp after: type: - string - "null" description: Only show data diffs after this timestamp ResponseMeta: type: object properties: offset: type: integer minimum: 0 description: The offset of the first result example: 0 limit: type: integer minimum: 0 maximum: 250 description: The number of results to return example: 100 orderBy: type: array items: type: object properties: {} hasMore: type: - boolean - "null" description: Whether there are more results total: type: integer minimum: 0 description: The total number of results example: 1000 required: - orderBy Enum1: type: string enum: &a287 - APPFOLIO - BUILDIUM - ENTRATA - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record _v1_admin_data-diffs__get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: type: array items: type: object properties: id: type: string description: The unique identifier for the data diff model: type: string description: The name of the model the data diff is for model_record_id: type: string description: The ID of the record the data diff is for. For example, if model is 'units', this would represent the ID of the unit event_type: type: string enum: - NEW - UPDATE description: The data diff event type data_diff: type: object properties: {} created_at: type: string description: The date the data diff was created job_id: type: - string - "null" description: The ID of the job that affected this data diff integration_id: type: string description: The integration id integration_vendor: $ref: "#/components/schemas/Enum1" required: - id - model - model_record_id - event_type - data_diff - created_at - job_id - integration_id - integration_vendor required: - meta - results errorResponse: type: object properties: error: type: object properties: code: type: string example: invalid_request message: type: string example: invalid request details: type: object additionalProperties: {} example: details: issues: - code: unrecognized_keys keys: - foo path: [] message: "Unrecognized key(s) in object: 'foo'" name: ZodError required: - code - message required: - error _v1_admin_job-logs_{job_log_id}__get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query _v1_admin_job-logs_{job_log_id}__get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: type: object properties: id: type: string job_id: type: - string - "null" created_at: type: string job_type: type: string status: type: string parent_job_id: type: - string - "null" root_job_id: type: string job_schedule_id: type: - string - "null" integration_id: type: string associated_property_id: type: - string - "null" required: - id - job_id - created_at - job_type - status - parent_job_id - root_job_id - job_schedule_id - integration_id - associated_property_id required: - meta - results _v1_admin_job-logs_{job_log_id}_data_get_input: type: object properties: {} _v1_admin_job-logs_{job_log_id}_data_get_output: type: object properties: {} _v1_admin_logs_writes__get_input: type: object properties: limit: type: integer minimum: 1 maximum: 100 default: 100 description: Number of records to return offset: type: - integer - "null" minimum: 0 default: 0 description: Number of records to skip time_range: type: string enum: &a284 - hour - month - week - day description: Filter logs by time range integration_id: type: string description: Filter logs by integration ID status: type: string enum: - SUCCESS - FAILURE description: Filter logs by status write_category: type: string enum: &a285 - amenities - applicants - applications - contracts - crm_listings - deposit_summaries - event_types - events - file_types - file_upload - invoices - leads - leases - listings - properties - purchase_orders - recurring_resident_charges - resident_charges - resident_payments - resident_pets - residents - service_request_vendors - service_requests - transactions - units description: Filter logs by write category _v1_admin_logs_writes__get_output: type: object properties: results: type: object properties: logs: type: array items: type: object properties: id: type: string created_at: type: string job_id: type: string job_log_id: type: string status: type: string enum: - SUCCESS - FAILURE integration_id: type: string job_type: type: string parameters: {} error: type: - string - "null" name: type: string vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - INTERNAL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST required: - id - created_at - job_id - job_log_id - status - integration_id - job_type - error - name - vendor required: - logs required: - results _v1_admin_logs_jobs__get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query status: type: string enum: - SUCCESS - FAILURE integration_id: type: string job_type: type: string _v1_admin_logs_jobs__get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: type: array items: type: object properties: id: type: string job_id: type: - string - "null" created_at: type: string job_type: type: string status: type: string parent_job_id: type: - string - "null" root_job_id: type: string job_schedule_id: type: - string - "null" integration_id: type: string associated_property_id: type: - string - "null" required: - id - job_id - created_at - job_type - status - parent_job_id - root_job_id - job_schedule_id - integration_id - associated_property_id required: - meta - results _v1_admin_logs_jobs_{id}_get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query include_all_jobs: type: string default: "true" description: Whether to include job logs from jobs that have spawned from the provided job id. _v1_admin_logs_jobs_{id}_get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: type: array items: type: object properties: id: type: string job_id: type: - string - "null" created_at: type: string job_type: type: string status: type: string parent_job_id: type: - string - "null" root_job_id: type: string job_schedule_id: type: - string - "null" integration_id: type: string associated_property_id: type: - string - "null" required: - id - job_id - created_at - job_type - status - parent_job_id - root_job_id - job_schedule_id - integration_id - associated_property_id required: - meta - results Enum9: type: string enum: &a286 - APPFOLIO - BUILDIUM - ENTRATA - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The integration vendor _v1_admin_integrations__get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query integration_vendor: $ref: "#/components/schemas/Enum9" is_archived: type: boolean description: Whether or not to include archived integrations _v1_admin_integrations__get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: type: array items: type: object properties: id: type: string description: The unique identifier for the integration created_at: type: string description: The date the integration was created updated_at: type: string description: The date the integration was last updated name: type: string description: The name of the integration vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record active: type: boolean description: The active state of the integration system: type: string enum: &a1 - PRODUCTION - SANDBOX description: The system the integration is associated with sync_frequency: type: - integer - "null" description: 'Deprecated: See the job schedules endpoint for this information. The interval of the scheduled sync frequency. (e.g. "12" in the following: Sync every 12 HOURs)' deprecated: true x-fern-availability: deprecated sync_cadence: type: - string - "null" enum: - MINUTE - HOUR - DAY - WEEK - MONTH - SECOND description: 'Deprecated: See the job schedules endpoint for this information. The cadence of the scheduled sync frequency. (e.g. "HOUR" in the following: Sync every 12 HOURs)' deprecated: true x-fern-availability: deprecated max_job_concurrency: type: integer description: Maximum number of jobs that can be run at once for the integration max_request_frequency: type: integer description: Maximum number of jobs that can be run in the max request cadence max_request_cadence: type: string enum: - MINUTE - HOUR - DAY - WEEK - MONTH - SECOND description: Cadence at which to limit the max request frequency base_url: type: - string - "null" description: "DEPRECATED: see specific PMS credentials. Base URL for the integration vendor API" deprecated: true x-fern-availability: deprecated is_archived: type: boolean description: Whether or not the integration is archived last_completed_sync: type: - string - "null" description: The timestamp of the last time a sync was completed. last_completed_back_sync: type: - string - "null" description: The timestamp of the last time a back sync was completed. new_properties_are_enabled: type: boolean description: Whether or not properties need to be approved before ingesting data for them. integration_interfaces: type: array items: type: object properties: interface_name: type: string enum: - REALPAGE_CREATE_LEAD - REALPAGE_CREATE_LEAD_EVENT - REALPAGE_CREATE_RESIDENT_ACTIVITY_LOG - REALPAGE_CREATE_SERVICE_REQUEST - REALPAGE_UPDATE_APPLICANT - REALPAGE_UPDATE_LEAD - REALPAGE_UPDATE_RESIDENT - REALPAGE_UPDATE_SERVICE_REQUEST - REALPAGE_PROSPECT_MANAGEMENT_ALL_LEADS - REALPAGE_RESIDENTS_APPLICANT_GENERAL_INFO - REALPAGE_PRICING_AND_AVAILABILITY_FLOOR_PLANS - REALPAGE_PRICING_AND_AVAILABILITY_FLOOR_PLANS_PANDA - REALPAGE_PRICING_AND_AVAILABILITY_UNITS_PANDA - REALPAGE_PRICING_AND_AVAILABILITY_PICK_LISTS_PANDA - REALPAGE_PROSPECT_MANAGEMENT_LEAD - REALPAGE_PROSPECT_MANAGEMENT_LEAD_SOURCES - REALPAGE_PROSPECT_MANAGEMENT_PROPERTIES - REALPAGE_RESIDENTS_RESIDENT_ACTIVITY_LOGS - REALPAGE_RESIDENTS_RESIDENT_ACTIVITY_TYPES - REALPAGE_RESIDENTS_RESIDENT_GENERAL_INFO - REALPAGE_RESIDENTS_RESIDENT_LEASE - REALPAGE_RESIDENTS_RESIDENT_LEDGER - REALPAGE_RESIDENTS_RESIDENT_LIST - REALPAGE_FACILITIES_SERVICE_REQUESTS - REALPAGE_PROSPECT_MANAGEMENT_UNITS - REALPAGE_UNIT_UNIT_DETAILS - REALPAGE_PRICING_AND_AVAILABILITY_RENT_MATRIX - REALPAGE_SDE_CONVERGENT_BILLING - REALPAGE_FACILITIES - REALPAGE_PRICING_AND_AVAILABILITY - REALPAGE_PROSPECT_MANAGEMENT - REALPAGE_RESIDENTS - REALPAGE_UNIT - REALPAGE_RPX_AMENITIES - REALPAGE_RPX_APPOINTMENTS - REALPAGE_RPX_APPOINTMENT_AVAILABILITY - REALPAGE_RPX_CONCESSIONS - REALPAGE_RPX_CONVERGENT_BILLING_LEASES - REALPAGE_RPX_CONVERGENT_BILLING_RESIDENTS - REALPAGE_RPX_CONVERGENT_BILLING_UNITS - REALPAGE_RPX_CREATE_APPOINTMENT - REALPAGE_RPX_CREATE_LEAD - REALPAGE_RPX_CREATE_LEAD_EVENT - REALPAGE_RPX_CREATE_RESIDENT_ACTIVITY_LOG - REALPAGE_RPX_CREATE_RESIDENT_CHARGE - REALPAGE_RPX_CREATE_SERVICE_REQUEST - REALPAGE_RPX_UPDATE_APPOINTMENT - REALPAGE_RPX_UPDATE_APPOINTMENT_CANCEL - REALPAGE_RPX_UPDATE_LEAD - REALPAGE_RPX_UPDATE_SERVICE_REQUEST - REALPAGE_RPX_FLOOR_PLANS - REALPAGE_RPX_LEADS - REALPAGE_RPX_LEAD_ACTIVITY_TYPES - REALPAGE_RPX_LEAD_RELATIONSHIPS - REALPAGE_RPX_LEAD_SOURCES - REALPAGE_RPX_LISTINGS - REALPAGE_RPX_LEASING_AGENTS - REALPAGE_RPX_PET_TYPES - REALPAGE_RPX_PROSPECTS_SURVEY - REALPAGE_RPX_RESIDENT_SURVEY - REALPAGE_RPX_READ_PROPERTIES - REALPAGE_RPX_READ_PROPERTY_DATA - REALPAGE_RPX_RESIDENTS - REALPAGE_RPX_RESIDENT_ACTIVITY_LOGS - REALPAGE_RPX_RESIDENT_ACTIVITY_TYPES - REALPAGE_RPX_RESIDENT_LEDGER - REALPAGE_RPX_RESIDENT_TRANSACTION_CODES - REALPAGE_RPX_SERVICE_REQUESTS - REALPAGE_RPX_SERVICE_REQUEST_ISSUES - REALPAGE_RPX_SERVICE_REQUEST_LOCATIONS - REALPAGE_RPX_SERVICE_REQUEST_PRIORITIES - REALPAGE_RPX_SERVICE_REQUESTS_SURVEY - REALPAGE_RPX_UNITS - REALPAGE_RPX_UNITS_BY_PROPERTY - REALPAGE_RPX_UPDATE_SITE_SUBSCRIPTION - REALPAGE_RPX_ACTIVITY_RESULT_CODES - REALPAGE_RPX_CONVERGENT_BILLING - REALPAGE_RPX_FACILITIES - REALPAGE_RPX_PRICING_AND_AVAILABILITY - REALPAGE_RPX_PROSPECT_MANAGEMENT - REALPAGE_RPX_RESIDENT_MANAGEMENT - REALPAGE_RPX_RESIDENT_TRANSACTIONS - REALPAGE_RPX_CONVERGENT_BILLING_RESIDENT_LEDGER - REALPAGE_RPX_CONVERGENT_BILLING_TRANSACTION_CODES - REALPAGE_RPX_RESIDENT_MANAGEMENT_EVENTS - ENTRATA_AMENITIES - ENTRATA_AR_CODES - ENTRATA_CALL_LOGS - ENTRATA_CONCESSIONS - ENTRATA_CREATE_AMENITY - ENTRATA_CREATE_APPLICANT - ENTRATA_CREATE_APPLICANT_PETS - ENTRATA_CREATE_APPLICANT_VEHICLES - ENTRATA_CREATE_APPLICANT_EMPLOYERS - ENTRATA_CREATE_APPLICANT_ADDONS - ENTRATA_CREATE_EVENT - ENTRATA_CREATE_INVOICE - ENTRATA_CREATE_LEAD - ENTRATA_CREATE_LEASE - ENTRATA_CREATE_LEASE_DOCUMENTS - ENTRATA_CREATE_LEASE_TRANSACTION - ENTRATA_CREATE_LISTING - ENTRATA_CREATE_PURCHASE_ORDER - ENTRATA_CREATE_RECURRING_CHARGE - ENTRATA_CREATE_RESIDENT_CHARGE - ENTRATA_CREATE_SERVICE_REQUEST - ENTRATA_CREATE_SERVICE_REQUEST_FILE - ENTRATA_CREATE_SERVICE_REQUEST_NOTE - ENTRATA_CREATE_UNIT - ENTRATA_CREATE_VENDOR - ENTRATA_FEES - ENTRATA_FLOOR_PLANS - ENTRATA_GL_ACCOUNTS - ENTRATA_INVOICES - ENTRATA_LEAD_EVENTS - ENTRATA_LEAD_PICK_LIST - ENTRATA_LEASE_DETAILS - ENTRATA_LEASE_PICK_LIST - ENTRATA_LEASE_TRANSACTIONS - ENTRATA_LEASES - ENTRATA_LISTINGS - ENTRATA_PROPERTIES - ENTRATA_PET_TYPES - ENTRATA_PRICING_PICK_LIST - ENTRATA_PROPERTY_PICK_LIST - ENTRATA_PROSPECTS - ENTRATA_PURCHASE_ORDERS - ENTRATA_RENTABLE_ITEMS - ENTRATA_RESIDENT_TRANSACTION_ALLOCATIONS - ENTRATA_RESIDENTS - ENTRATA_UNIT_TYPES - ENTRATA_UNITS - ENTRATA_UPDATE_AMENITY - ENTRATA_UPDATE_APPLICANT - ENTRATA_UPDATE_LEAD - ENTRATA_UPDATE_LEASE - ENTRATA_UPDATE_RESIDENT - ENTRATA_UPDATE_SERVICE_REQUEST - ENTRATA_VENDOR_LOCATIONS - ENTRATA_VENDOR_PICK_LIST - ENTRATA_VENDORS - ENTRATA_WORK_ORDER_PICK_LIST - ENTRATA_WORK_ORDERS - ENTRATA_BASE - PROPERTYWARE_REST_CREATE_RESIDENT - PROPERTYWARE_REST_CREATE_DOCUMENT - PROPERTYWARE_REST_CREATE_RECURRING_CHARGES - PROPERTYWARE_REST_CREATE_RESIDENT_CHARGE - PROPERTYWARE_REST_CREATE_RESIDENT_CREDIT - PROPERTYWARE_REST_CREATE_RESIDENT_PAYMENT - PROPERTYWARE_REST_CREATE_UNIT - PROPERTYWARE_REST_READ_FINANCIAL_ACCOUNTS - PROPERTYWARE_REST_READ_GENERAL_LEDGER - PROPERTYWARE_REST_READ_LEASE_ADJUSTMENTS - PROPERTYWARE_REST_READ_LEASE_CHARGES - PROPERTYWARE_REST_READ_LEASE_CREDIT_MEMOS - PROPERTYWARE_REST_READ_LEASE_DISCOUNTS - PROPERTYWARE_REST_READ_LEASE_JOURNAL_ENTRIES - PROPERTYWARE_REST_READ_LEASE_PAYMENTS - PROPERTYWARE_REST_READ_LEASE_REFUNDS - PROPERTYWARE_REST_READ_LEASES - PROPERTYWARE_REST_READ_PORTFOLIOS - PROPERTYWARE_REST_READ_PROPERTIES - PROPERTYWARE_REST_READ_PROSPECTS - PROPERTYWARE_REST_READ_RECURRING_CHARGES - PROPERTYWARE_REST_READ_RESIDENTS - PROPERTYWARE_REST_READ_UNITS - PROPERTYWARE_REST_READ_INVOICES - PROPERTYWARE_REST_UPDATE_CONTACTS - PROPERTYWARE_REST_UPDATE_DOCUMENT - PROPERTYWARE_REST_UPDATE_LEASE - PROPERTYWARE_REST_UPDATE_LEASE_CUSTOM_FIELDS - PROPERTYWARE_REST_UPDATE_PROPERTY_CUSTOM_FIELDS - PROPERTYWARE_REST_UPDATE_UNIT_CUSTOM_FIELDS - RESMAN_BASE - RESMAN_CREATE_APPLICANT - RESMAN_CREATE_FILE_UPLOAD - RESMAN_CREATE_INVOICE - RESMAN_CREATE_LEAD - RESMAN_CREATE_RESIDENT_CHARGE - RESMAN_CREATE_RESIDENT_PAYMENT - RESMAN_CREATE_SERVICE_REQUEST - RESMAN_READ_ACCOUNTS - RESMAN_READ_EMPLOYEES - RESMAN_READ_INVOICES - RESMAN_READ_LEADS - RESMAN_READ_LEAD_SOURCES - RESMAN_READ_LEASES - RESMAN_READ_LEASES_PARTNER_API - RESMAN_READ_LISTINGS - RESMAN_READ_MOVE_OUTS - RESMAN_READ_PROPERTIES - RESMAN_READ_RESIDENTS - RESMAN_READ_RESIDENTS_AND_APPLICANTS - RESMAN_READ_RESIDENTS_DOB - RESMAN_READ_RESIDENT_CHARGE_CODES - RESMAN_READ_RESIDENT_TRANSACTIONS - RESMAN_READ_RENTABLE_ITEMS - RESMAN_READ_SERVICE_REQUESTS - RESMAN_READ_SERVICE_REQUEST_CATEGORIES - RESMAN_READ_UNITS - RESMAN_READ_VENDORS - RESMAN_UPDATE_APPLICANT - RESMAN_UPDATE_LEAD - RESMAN_UPDATE_SERVICE_REQUEST - RESMAN_READ_DEPOSIT_SUMMARY_PARTNER_API - APPFOLIO_CREATE_APPOINTMENT - APPFOLIO_CREATE_CHARGE - APPFOLIO_CREATE_LEAD - APPFOLIO_READ_APPLICATIONS - APPFOLIO_READ_APPOINTMENTS - APPFOLIO_READ_EMPLOYEES - APPFOLIO_READ_FINANCIAL_ACCOUNTS - APPFOLIO_READ_INVOICES - APPFOLIO_READ_LEADS - APPFOLIO_READ_LISTINGS - APPFOLIO_READ_PROPERTIES - APPFOLIO_READ_RESIDENTS - APPFOLIO_READ_RECURRING_CHARGES - APPFOLIO_READ_SERVICE_REQUESTS - APPFOLIO_READ_TENANT_LEDGERS - APPFOLIO_READ_UNITS - APPFOLIO_READ_VENDORS - APPFOLIO_UPDATE_LEAD - APPFOLIO_UPDATE_APPOINTMENT - APPFOLIO_BASE - YARDI_GUESTCARD - YARDI_RESIDENT_TRANSACTIONS - YARDI_RESIDENT_DATA - YARDI_SERVICES - YARDI_JOB_COST - YARDI_VENDOR_INVOICING - YARDI_LEASE_RENEWALS - YARDI_DEPOSIT_SUMMARIES - YARDI_REST_COMMON_DATA - YARDI_REST_SERVICE_REQUESTS - YARDI_REST_RESIDENT_TRANSACTIONS - YARDI_REST_VENDOR_INVOICING - YARDI_REST_JOB_COST - BUILDIUM_BASE - PROPERTYWARE_BASE - RENTMANAGER_BASE - RENTVINE_BASE - MRI_BASE - MRI_CREATE_EVENT - MRI_CREATE_EVENT_TYPE - MRI_CREATE_INVOICE - MRI_CREATE_PROSPECT - MRI_CREATE_RESIDENT_NOTE - MRI_CREATE_SERVICE_REQUEST - MRI_READ_ACCOUNTING_ENTITIES - MRI_READ_ALL_RESIDENTS - MRI_READ_AMENITIES - MRI_READ_APPLICANT_EVENTS - MRI_READ_APPLICANTS - MRI_READ_CHARGE_CODES - MRI_READ_EMPLOYEES - MRI_READ_EVENT_TYPES - MRI_READ_FINANCIAL_ACCOUNTS - MRI_READ_INVOICES - MRI_READ_LEAD_EVENTS - MRI_READ_LEAD_SOURCES - MRI_READ_LEADS - MRI_READ_LEASES - MRI_READ_LEASING_AGENTS - MRI_READ_NOTE_CATEGORIES - MRI_READ_OWNERS - MRI_READ_PICK_LISTS - MRI_READ_PROPERTIES - MRI_READ_RECURRING_CHARGES - MRI_READ_RESIDENT_EVENTS - MRI_READ_RESIDENT_LEDGER - MRI_READ_RESIDENT_PETS - MRI_READ_RESIDENTS - MRI_READ_SECURITY_DEPOSIT_LEDGER - MRI_READ_SERVICE_REQUESTS - MRI_READ_SODAS - MRI_READ_UNITS - MRI_READ_VENDORS - MRI_UPDATE_EVENT - MRI_UPDATE_INVOICE - MRI_UPDATE_INVOICE_AS_PAID - MRI_UPDATE_INVOICE_PAYMENT - MRI_UPDATE_INVOICE_STATUS - MRI_UPDATE_PROSPECT - MRI_UPDATE_RESIDENT - MRI_UPDATE_SERVICE_REQUEST - KNOCK_BASE - RENTCAFE_BASE - FUNNEL_BASE enabled: type: boolean version: type: - string - "null" required: - interface_name - enabled - version models: type: object additionalProperties: type: object properties: enabled: type: boolean from_interfaces: type: array items: type: string enum: - REALPAGE_CREATE_LEAD - REALPAGE_CREATE_LEAD_EVENT - REALPAGE_CREATE_RESIDENT_ACTIVITY_LOG - REALPAGE_CREATE_SERVICE_REQUEST - REALPAGE_UPDATE_APPLICANT - REALPAGE_UPDATE_LEAD - REALPAGE_UPDATE_RESIDENT - REALPAGE_UPDATE_SERVICE_REQUEST - REALPAGE_PROSPECT_MANAGEMENT_ALL_LEADS - REALPAGE_RESIDENTS_APPLICANT_GENERAL_INFO - REALPAGE_PRICING_AND_AVAILABILITY_FLOOR_PLANS - REALPAGE_PRICING_AND_AVAILABILITY_FLOOR_PLANS_PANDA - REALPAGE_PRICING_AND_AVAILABILITY_UNITS_PANDA - REALPAGE_PRICING_AND_AVAILABILITY_PICK_LISTS_PANDA - REALPAGE_PROSPECT_MANAGEMENT_LEAD - REALPAGE_PROSPECT_MANAGEMENT_LEAD_SOURCES - REALPAGE_PROSPECT_MANAGEMENT_PROPERTIES - REALPAGE_RESIDENTS_RESIDENT_ACTIVITY_LOGS - REALPAGE_RESIDENTS_RESIDENT_ACTIVITY_TYPES - REALPAGE_RESIDENTS_RESIDENT_GENERAL_INFO - REALPAGE_RESIDENTS_RESIDENT_LEASE - REALPAGE_RESIDENTS_RESIDENT_LEDGER - REALPAGE_RESIDENTS_RESIDENT_LIST - REALPAGE_FACILITIES_SERVICE_REQUESTS - REALPAGE_PROSPECT_MANAGEMENT_UNITS - REALPAGE_UNIT_UNIT_DETAILS - REALPAGE_PRICING_AND_AVAILABILITY_RENT_MATRIX - REALPAGE_SDE_CONVERGENT_BILLING - REALPAGE_FACILITIES - REALPAGE_PRICING_AND_AVAILABILITY - REALPAGE_PROSPECT_MANAGEMENT - REALPAGE_RESIDENTS - REALPAGE_UNIT - REALPAGE_RPX_AMENITIES - REALPAGE_RPX_APPOINTMENTS - REALPAGE_RPX_APPOINTMENT_AVAILABILITY - REALPAGE_RPX_CONCESSIONS - REALPAGE_RPX_CONVERGENT_BILLING_LEASES - REALPAGE_RPX_CONVERGENT_BILLING_RESIDENTS - REALPAGE_RPX_CONVERGENT_BILLING_UNITS - REALPAGE_RPX_CREATE_APPOINTMENT - REALPAGE_RPX_CREATE_LEAD - REALPAGE_RPX_CREATE_LEAD_EVENT - REALPAGE_RPX_CREATE_RESIDENT_ACTIVITY_LOG - REALPAGE_RPX_CREATE_RESIDENT_CHARGE - REALPAGE_RPX_CREATE_SERVICE_REQUEST - REALPAGE_RPX_UPDATE_APPOINTMENT - REALPAGE_RPX_UPDATE_APPOINTMENT_CANCEL - REALPAGE_RPX_UPDATE_LEAD - REALPAGE_RPX_UPDATE_SERVICE_REQUEST - REALPAGE_RPX_FLOOR_PLANS - REALPAGE_RPX_LEADS - REALPAGE_RPX_LEAD_ACTIVITY_TYPES - REALPAGE_RPX_LEAD_RELATIONSHIPS - REALPAGE_RPX_LEAD_SOURCES - REALPAGE_RPX_LISTINGS - REALPAGE_RPX_LEASING_AGENTS - REALPAGE_RPX_PET_TYPES - REALPAGE_RPX_PROSPECTS_SURVEY - REALPAGE_RPX_RESIDENT_SURVEY - REALPAGE_RPX_READ_PROPERTIES - REALPAGE_RPX_READ_PROPERTY_DATA - REALPAGE_RPX_RESIDENTS - REALPAGE_RPX_RESIDENT_ACTIVITY_LOGS - REALPAGE_RPX_RESIDENT_ACTIVITY_TYPES - REALPAGE_RPX_RESIDENT_LEDGER - REALPAGE_RPX_RESIDENT_TRANSACTION_CODES - REALPAGE_RPX_SERVICE_REQUESTS - REALPAGE_RPX_SERVICE_REQUEST_ISSUES - REALPAGE_RPX_SERVICE_REQUEST_LOCATIONS - REALPAGE_RPX_SERVICE_REQUEST_PRIORITIES - REALPAGE_RPX_SERVICE_REQUESTS_SURVEY - REALPAGE_RPX_UNITS - REALPAGE_RPX_UNITS_BY_PROPERTY - REALPAGE_RPX_UPDATE_SITE_SUBSCRIPTION - REALPAGE_RPX_ACTIVITY_RESULT_CODES - REALPAGE_RPX_CONVERGENT_BILLING - REALPAGE_RPX_FACILITIES - REALPAGE_RPX_PRICING_AND_AVAILABILITY - REALPAGE_RPX_PROSPECT_MANAGEMENT - REALPAGE_RPX_RESIDENT_MANAGEMENT - REALPAGE_RPX_RESIDENT_TRANSACTIONS - REALPAGE_RPX_CONVERGENT_BILLING_RESIDENT_LEDGER - REALPAGE_RPX_CONVERGENT_BILLING_TRANSACTION_CODES - REALPAGE_RPX_RESIDENT_MANAGEMENT_EVENTS - ENTRATA_AMENITIES - ENTRATA_AR_CODES - ENTRATA_CALL_LOGS - ENTRATA_CONCESSIONS - ENTRATA_CREATE_AMENITY - ENTRATA_CREATE_APPLICANT - ENTRATA_CREATE_APPLICANT_PETS - ENTRATA_CREATE_APPLICANT_VEHICLES - ENTRATA_CREATE_APPLICANT_EMPLOYERS - ENTRATA_CREATE_APPLICANT_ADDONS - ENTRATA_CREATE_EVENT - ENTRATA_CREATE_INVOICE - ENTRATA_CREATE_LEAD - ENTRATA_CREATE_LEASE - ENTRATA_CREATE_LEASE_DOCUMENTS - ENTRATA_CREATE_LEASE_TRANSACTION - ENTRATA_CREATE_LISTING - ENTRATA_CREATE_PURCHASE_ORDER - ENTRATA_CREATE_RECURRING_CHARGE - ENTRATA_CREATE_RESIDENT_CHARGE - ENTRATA_CREATE_SERVICE_REQUEST - ENTRATA_CREATE_SERVICE_REQUEST_FILE - ENTRATA_CREATE_SERVICE_REQUEST_NOTE - ENTRATA_CREATE_UNIT - ENTRATA_CREATE_VENDOR - ENTRATA_FEES - ENTRATA_FLOOR_PLANS - ENTRATA_GL_ACCOUNTS - ENTRATA_INVOICES - ENTRATA_LEAD_EVENTS - ENTRATA_LEAD_PICK_LIST - ENTRATA_LEASE_DETAILS - ENTRATA_LEASE_PICK_LIST - ENTRATA_LEASE_TRANSACTIONS - ENTRATA_LEASES - ENTRATA_LISTINGS - ENTRATA_PROPERTIES - ENTRATA_PET_TYPES - ENTRATA_PRICING_PICK_LIST - ENTRATA_PROPERTY_PICK_LIST - ENTRATA_PROSPECTS - ENTRATA_PURCHASE_ORDERS - ENTRATA_RENTABLE_ITEMS - ENTRATA_RESIDENT_TRANSACTION_ALLOCATIONS - ENTRATA_RESIDENTS - ENTRATA_UNIT_TYPES - ENTRATA_UNITS - ENTRATA_UPDATE_AMENITY - ENTRATA_UPDATE_APPLICANT - ENTRATA_UPDATE_LEAD - ENTRATA_UPDATE_LEASE - ENTRATA_UPDATE_RESIDENT - ENTRATA_UPDATE_SERVICE_REQUEST - ENTRATA_VENDOR_LOCATIONS - ENTRATA_VENDOR_PICK_LIST - ENTRATA_VENDORS - ENTRATA_WORK_ORDER_PICK_LIST - ENTRATA_WORK_ORDERS - ENTRATA_BASE - PROPERTYWARE_REST_CREATE_RESIDENT - PROPERTYWARE_REST_CREATE_DOCUMENT - PROPERTYWARE_REST_CREATE_RECURRING_CHARGES - PROPERTYWARE_REST_CREATE_RESIDENT_CHARGE - PROPERTYWARE_REST_CREATE_RESIDENT_CREDIT - PROPERTYWARE_REST_CREATE_RESIDENT_PAYMENT - PROPERTYWARE_REST_CREATE_UNIT - PROPERTYWARE_REST_READ_FINANCIAL_ACCOUNTS - PROPERTYWARE_REST_READ_GENERAL_LEDGER - PROPERTYWARE_REST_READ_LEASE_ADJUSTMENTS - PROPERTYWARE_REST_READ_LEASE_CHARGES - PROPERTYWARE_REST_READ_LEASE_CREDIT_MEMOS - PROPERTYWARE_REST_READ_LEASE_DISCOUNTS - PROPERTYWARE_REST_READ_LEASE_JOURNAL_ENTRIES - PROPERTYWARE_REST_READ_LEASE_PAYMENTS - PROPERTYWARE_REST_READ_LEASE_REFUNDS - PROPERTYWARE_REST_READ_LEASES - PROPERTYWARE_REST_READ_PORTFOLIOS - PROPERTYWARE_REST_READ_PROPERTIES - PROPERTYWARE_REST_READ_PROSPECTS - PROPERTYWARE_REST_READ_RECURRING_CHARGES - PROPERTYWARE_REST_READ_RESIDENTS - PROPERTYWARE_REST_READ_UNITS - PROPERTYWARE_REST_READ_INVOICES - PROPERTYWARE_REST_UPDATE_CONTACTS - PROPERTYWARE_REST_UPDATE_DOCUMENT - PROPERTYWARE_REST_UPDATE_LEASE - PROPERTYWARE_REST_UPDATE_LEASE_CUSTOM_FIELDS - PROPERTYWARE_REST_UPDATE_PROPERTY_CUSTOM_FIELDS - PROPERTYWARE_REST_UPDATE_UNIT_CUSTOM_FIELDS - RESMAN_BASE - RESMAN_CREATE_APPLICANT - RESMAN_CREATE_FILE_UPLOAD - RESMAN_CREATE_INVOICE - RESMAN_CREATE_LEAD - RESMAN_CREATE_RESIDENT_CHARGE - RESMAN_CREATE_RESIDENT_PAYMENT - RESMAN_CREATE_SERVICE_REQUEST - RESMAN_READ_ACCOUNTS - RESMAN_READ_EMPLOYEES - RESMAN_READ_INVOICES - RESMAN_READ_LEADS - RESMAN_READ_LEAD_SOURCES - RESMAN_READ_LEASES - RESMAN_READ_LEASES_PARTNER_API - RESMAN_READ_LISTINGS - RESMAN_READ_MOVE_OUTS - RESMAN_READ_PROPERTIES - RESMAN_READ_RESIDENTS - RESMAN_READ_RESIDENTS_AND_APPLICANTS - RESMAN_READ_RESIDENTS_DOB - RESMAN_READ_RESIDENT_CHARGE_CODES - RESMAN_READ_RESIDENT_TRANSACTIONS - RESMAN_READ_RENTABLE_ITEMS - RESMAN_READ_SERVICE_REQUESTS - RESMAN_READ_SERVICE_REQUEST_CATEGORIES - RESMAN_READ_UNITS - RESMAN_READ_VENDORS - RESMAN_UPDATE_APPLICANT - RESMAN_UPDATE_LEAD - RESMAN_UPDATE_SERVICE_REQUEST - RESMAN_READ_DEPOSIT_SUMMARY_PARTNER_API - APPFOLIO_CREATE_APPOINTMENT - APPFOLIO_CREATE_CHARGE - APPFOLIO_CREATE_LEAD - APPFOLIO_READ_APPLICATIONS - APPFOLIO_READ_APPOINTMENTS - APPFOLIO_READ_EMPLOYEES - APPFOLIO_READ_FINANCIAL_ACCOUNTS - APPFOLIO_READ_INVOICES - APPFOLIO_READ_LEADS - APPFOLIO_READ_LISTINGS - APPFOLIO_READ_PROPERTIES - APPFOLIO_READ_RESIDENTS - APPFOLIO_READ_RECURRING_CHARGES - APPFOLIO_READ_SERVICE_REQUESTS - APPFOLIO_READ_TENANT_LEDGERS - APPFOLIO_READ_UNITS - APPFOLIO_READ_VENDORS - APPFOLIO_UPDATE_LEAD - APPFOLIO_UPDATE_APPOINTMENT - APPFOLIO_BASE - YARDI_GUESTCARD - YARDI_RESIDENT_TRANSACTIONS - YARDI_RESIDENT_DATA - YARDI_SERVICES - YARDI_JOB_COST - YARDI_VENDOR_INVOICING - YARDI_LEASE_RENEWALS - YARDI_DEPOSIT_SUMMARIES - YARDI_REST_COMMON_DATA - YARDI_REST_SERVICE_REQUESTS - YARDI_REST_RESIDENT_TRANSACTIONS - YARDI_REST_VENDOR_INVOICING - YARDI_REST_JOB_COST - BUILDIUM_BASE - PROPERTYWARE_BASE - RENTMANAGER_BASE - RENTVINE_BASE - MRI_BASE - MRI_CREATE_EVENT - MRI_CREATE_EVENT_TYPE - MRI_CREATE_INVOICE - MRI_CREATE_PROSPECT - MRI_CREATE_RESIDENT_NOTE - MRI_CREATE_SERVICE_REQUEST - MRI_READ_ACCOUNTING_ENTITIES - MRI_READ_ALL_RESIDENTS - MRI_READ_AMENITIES - MRI_READ_APPLICANT_EVENTS - MRI_READ_APPLICANTS - MRI_READ_CHARGE_CODES - MRI_READ_EMPLOYEES - MRI_READ_EVENT_TYPES - MRI_READ_FINANCIAL_ACCOUNTS - MRI_READ_INVOICES - MRI_READ_LEAD_EVENTS - MRI_READ_LEAD_SOURCES - MRI_READ_LEADS - MRI_READ_LEASES - MRI_READ_LEASING_AGENTS - MRI_READ_NOTE_CATEGORIES - MRI_READ_OWNERS - MRI_READ_PICK_LISTS - MRI_READ_PROPERTIES - MRI_READ_RECURRING_CHARGES - MRI_READ_RESIDENT_EVENTS - MRI_READ_RESIDENT_LEDGER - MRI_READ_RESIDENT_PETS - MRI_READ_RESIDENTS - MRI_READ_SECURITY_DEPOSIT_LEDGER - MRI_READ_SERVICE_REQUESTS - MRI_READ_SODAS - MRI_READ_UNITS - MRI_READ_VENDORS - MRI_UPDATE_EVENT - MRI_UPDATE_INVOICE - MRI_UPDATE_INVOICE_AS_PAID - MRI_UPDATE_INVOICE_PAYMENT - MRI_UPDATE_INVOICE_STATUS - MRI_UPDATE_PROSPECT - MRI_UPDATE_RESIDENT - MRI_UPDATE_SERVICE_REQUEST - KNOCK_BASE - RENTCAFE_BASE - FUNNEL_BASE required: - enabled - from_interfaces can_authenticate: type: boolean description: True if the credentials and configuration for the integration allowed us to successfully authenticate with at least one PMS API endpoint, false otherwise last_data_access_check: type: - string - "null" description: The UTC timestamp of the last time an authentication check was performed for an integration. allow_manual_syncs: type: boolean default: true description: "Deprecated: This is no longer configurable and will always be true" deprecated: true x-fern-availability: deprecated configuration_meta_data: type: array items: type: object properties: last_seen: type: string interface_name: type: - string - "null" configuration_data: type: object properties: {} custom_data: type: - object - "null" properties: {} required: - last_seen - interface_name - configuration_data - custom_data required: - id - created_at - updated_at - name - vendor - active - system - max_job_concurrency - max_request_frequency - max_request_cadence - base_url - is_archived - last_completed_sync - last_completed_back_sync - new_properties_are_enabled - integration_interfaces - models - can_authenticate - last_data_access_check - configuration_meta_data required: - meta - results _v1_admin_integrations__post_input: type: object properties: integration_vendor: $ref: "#/components/schemas/Enum9" credentials: anyOf: - type: object properties: {} - type: object properties: apiKey: type: string companyId: type: string required: - apiKey - companyId description: Entrata authentication credentials title: Entrata - type: object properties: clientId: type: string databaseName: type: string partnerKey: type: string username: type: string password: type: string baseUrl: type: string required: - clientId - databaseName - partnerKey - username - password - baseUrl description: MRI authentication credentials title: MRI - type: object properties: clientId: type: string clientSecret: type: string systemId: type: string description: The system/organization ID to query data from required: - clientId - clientSecret - systemId description: Propertyware REST authentication credentials title: Propertyware REST - type: object properties: PMC_ID: type: string SITE_ID: type: string LICENSE_KEY: type: string ONESITE_USERNAME: type: string ONESITE_PASSWORD: type: string BASE_URL: type: string ftp_credentials: type: object properties: SFTP_HOST: type: string SFTP_PORT: type: number SFTP_USERNAME: type: string SFTP_PASSWORD: type: string SFTP_DIR: type: string required: - SFTP_HOST - SFTP_PORT - SFTP_USERNAME - SFTP_PASSWORD - SFTP_DIR required: - PMC_ID - SITE_ID - LICENSE_KEY - ONESITE_USERNAME description: RealPage Registered Vendor authentication credentials title: RealpageRegisteredVendor - type: object properties: username: type: string password: type: string required: - username - password description: Propertyware SOAP authentication credentials title: Propertyware SOAP - type: object properties: Username: type: string Password: type: string companyId: type: string required: - Username - Password - companyId description: Rent Manager authentication credentials title: RentManagerSandbox - type: object properties: PartnerToken: type: string companyId: type: string required: - PartnerToken - companyId description: Rent Manager authentication credentials title: RentManagerProduction - type: object properties: clientId: type: string secret: type: string required: - clientId - secret description: Buildium authentication credentials title: Buildium - type: object properties: integrationPartnerId: type: string accountId: type: string apiKey: type: string required: - integrationPartnerId - accountId - apiKey description: ResMan authentication credentials title: Resman - type: object properties: clientId: type: string clientSecret: type: string developerId: type: string required: - clientId - clientSecret - developerId description: AppFolio authentication credentials title: AppFolio - type: object properties: baseUrl: type: string minLength: 1 format: uri licensekey: type: string minLength: 1 pmcId: type: string description: This is also sometimes referred to as a "client ID" siteId: type: string method_specific: type: object properties: insertfollowup: type: object properties: baseUrl: type: string licensekey: type: string required: - baseUrl - licensekey description: The credentials specific to the insertfollowup on the Prospect Management interface. insertprospect: type: object properties: baseUrl: type: string licensekey: type: string required: - baseUrl - licensekey description: The credentials specific to the insertprospect on the Prospect Management interface. insertactivity: type: object properties: baseUrl: type: string licensekey: type: string required: - baseUrl - licensekey description: The credentials specific to the insertactivity on the Prospect Management interface. addresidentactivitylog: type: object properties: baseUrl: type: string licensekey: type: string required: - baseUrl - licensekey description: The credentials specific to the addresidentactivitylog on the Collections interface. postsinglecharge: type: object properties: baseUrl: type: string licensekey: type: string required: - baseUrl - licensekey description: The credentials specific to the postsinglecharge on the Transactions interface. addservicerequest: type: object properties: baseUrl: type: string licensekey: type: string required: - baseUrl - licensekey description: The credentials specific to the addservicerequest on the Facilities interface. getscheduledappointments: type: object properties: baseUrl: type: string licensekey: type: string required: - baseUrl - licensekey description: The credentials specific to the getscheduledappointments on the Prospect Management interface. getfloorplanlist: type: object properties: baseUrl: type: string licensekey: type: string required: - baseUrl - licensekey description: The credentials specific to the getfloorplanlist on the Pricing and Availability interface. prospectsearch: type: object properties: baseUrl: type: string licensekey: type: string required: - baseUrl - licensekey description: The credentials specific to the prospectsearch on the Prospect Management interface. getactivitytypes: type: object properties: baseUrl: type: string licensekey: type: string required: - baseUrl - licensekey description: The credentials specific to the getactivitytypes on the Prospect Management interface. getpicklistprospect: type: object properties: baseUrl: type: string licensekey: type: string required: - baseUrl - licensekey description: The credentials specific to the getpicklistprospect on the Prospect Management interface. getmarketingsourcesbyproperty: type: object properties: baseUrl: type: string licensekey: type: string required: - baseUrl - licensekey description: The credentials specific to the getmarketingsourcesbyproperty on the Prospect Management interface. getleaseinfo: type: object properties: baseUrl: type: string licensekey: type: string required: - baseUrl - licensekey description: The credentials specific to the getleaseinfo on the Convergent Billing interface. getleasingagentsbyproperty: type: object properties: baseUrl: type: string licensekey: type: string required: - baseUrl - licensekey description: The credentials specific to the getleasingagentsbyproperty on the Prospect Management interface. getunitlist: type: object properties: baseUrl: type: string licensekey: type: string required: - baseUrl - licensekey description: The credentials specific to the getunitlist on the Pricing and Availability interface. getsubscriptions: type: object properties: baseUrl: type: string licensekey: type: string required: - baseUrl - licensekey description: The credentials specific to the getsubscriptions on the AppPartner interface. getprospectsurveylist: type: object properties: baseUrl: type: string licensekey: type: string required: - baseUrl - licensekey description: The credentials specific to the getprospectsurveylist on the Survey Interfaces interface. getresidentlistinfo: type: object properties: baseUrl: type: string licensekey: type: string required: - baseUrl - licensekey description: The credentials specific to the getresidentlistinfo on the Resident Management interface. getresidentconvergent: type: object properties: baseUrl: type: string licensekey: type: string required: - baseUrl - licensekey description: The credentials specific to the getresidentconvergent on the Convergent Billing interface. getresidentactivitytypes: type: object properties: baseUrl: type: string licensekey: type: string required: - baseUrl - licensekey description: The credentials specific to the getresidentactivitytypes on the Collections interface. getresidentsactivitylogbydaterange: type: object properties: baseUrl: type: string licensekey: type: string required: - baseUrl - licensekey description: The credentials specific to the getresidentsactivitylogbydaterange on the Resident Management interface. getresidentledger: type: object properties: baseUrl: type: string licensekey: type: string required: - baseUrl - licensekey description: The credentials specific to the getresidentledger on the Transactions interface. transactioncodes: type: object properties: baseUrl: type: string licensekey: type: string required: - baseUrl - licensekey description: The credentials specific to the transactioncodes on the Transactions interface. getservicerequest: type: object properties: baseUrl: type: string licensekey: type: string required: - baseUrl - licensekey description: The credentials specific to the getservicerequest on the Facilities interface. getworkordersurveylist: type: object properties: baseUrl: type: string licensekey: type: string required: - baseUrl - licensekey description: The credentials specific to the getworkordersurveylist on the Survey Interfaces interface. getserviceissuelist: type: object properties: baseUrl: type: string licensekey: type: string required: - baseUrl - licensekey description: The credentials specific to the getserviceissuelist on the Facilities interface. getlocationlist: type: object properties: baseUrl: type: string licensekey: type: string required: - baseUrl - licensekey description: The credentials specific to the getlocationlist on the Facilities interface. getwoprioritylist: type: object properties: baseUrl: type: string licensekey: type: string required: - baseUrl - licensekey description: The credentials specific to the getwoprioritylist on the Facilities interface. getunits: type: object properties: baseUrl: type: string licensekey: type: string required: - baseUrl - licensekey description: The credentials specific to the getunits on the Convergent Billing interface. getunitsbyproperty: type: object properties: baseUrl: type: string licensekey: type: string required: - baseUrl - licensekey description: The credentials specific to the getunitsbyproperty on the Prospect Management interface. unitlist: type: object properties: baseUrl: type: string licensekey: type: string required: - baseUrl - licensekey description: The credentials specific to the unitlist on the Units interface. updateprospect: type: object properties: baseUrl: type: string licensekey: type: string required: - baseUrl - licensekey description: The credentials specific to the updateprospect on the Prospect Management interface. updateservicerequest: type: object properties: baseUrl: type: string licensekey: type: string required: - baseUrl - licensekey description: The credentials specific to the updateservicerequest on the Facilities interface. getagentsappointmenttimes: type: object properties: baseUrl: type: string licensekey: type: string required: - baseUrl - licensekey description: The credentials specific to the getagentsappointmenttimes on the Prospect Management interface. getsitelist: type: object properties: baseUrl: type: string licensekey: type: string required: - baseUrl - licensekey description: The credentials specific to the getsitelist on the AppPartner interface. updatesitesubscriptionstatus: type: object properties: baseUrl: type: string licensekey: type: string required: - baseUrl - licensekey description: The credentials specific to the updatesitesubscriptionstatus on the AppPartner interface. description: If Realpage requires you to have method specific credentials, you can specify them per API method here required: - baseUrl - licensekey description: RealPage Partner Exchange authentication credentials title: RealpagePartnerExchange - type: object properties: apiKey: type: string required: - apiKey description: Knock authentication credentials title: Knock - type: object properties: apiKey: type: string apiSecret: type: string companyId: type: string portfolioId: type: string required: - apiKey - apiSecret - companyId description: Rentvine authentication credentials title: Rentvine - type: object properties: username: type: string password: type: string database: type: string serverName: type: string platform: type: string entity: type: string license: type: string companyId: type: string pattern: ^\w+$ baseUrl: type: string common_data: type: object properties: entity: type: string license: type: string username: type: string password: type: string database: type: string serverName: type: string platform: type: string companyId: type: string pattern: ^\w+$ baseUrl: type: string required: - entity - license description: Specific credentials for the common/resident data interface vendor_invoicing: type: object properties: entity: type: string license: type: string username: type: string password: type: string database: type: string serverName: type: string platform: type: string companyId: type: string pattern: ^\w+$ baseUrl: type: string required: - entity - license description: Specific credentials for the vendor invoicing interface job_cost: type: object properties: entity: type: string license: type: string username: type: string password: type: string database: type: string serverName: type: string platform: type: string companyId: type: string pattern: ^\w+$ baseUrl: type: string required: - entity - license description: Specific credentials for the job cost interface guest_card: type: object properties: entity: type: string license: type: string username: type: string password: type: string database: type: string serverName: type: string platform: type: string companyId: type: string pattern: ^\w+$ baseUrl: type: string required: - entity - license description: Specific credentials for the guest card interface resident_transactions: type: object properties: entity: type: string license: type: string username: type: string password: type: string database: type: string serverName: type: string platform: type: string companyId: type: string pattern: ^\w+$ baseUrl: type: string required: - entity - license description: Specific credentials for the resident transactions interface service_requests: type: object properties: entity: type: string license: type: string username: type: string password: type: string database: type: string serverName: type: string platform: type: string companyId: type: string pattern: ^\w+$ baseUrl: type: string required: - entity - license description: Specific credentials for the service requests interface required: - username - password - database - serverName - platform - entity - license - companyId description: Yardi PMS authentication credentials title: Yardi - type: object properties: username: type: string password: type: string apitoken: type: string interfaceEntity: type: string required: - username - password - apitoken - interfaceEntity description: Yardi REST authentication credentials title: Yardi REST description: JSON encoded credentials for accessing the integration vendor API name: type: string description: The name of the integration system: type: string enum: *a1 description: "Deprecated: Do not use" deprecated: true sync_frequency: type: integer minimum: 1 default: 12 description: 'The interval of the scheduled sync frequency. (e.g. "12" in the following: Sync every 12 HOURs). This value will be used if the use_custom_schedule is set to false.' sync_cadence: type: string enum: - MINUTE - HOUR - DAY - WEEK - MONTH - SECOND default: HOUR description: 'The cadence of the scheduled sync frequency. (e.g. "HOUR" in the following: Sync every 12 HOURs). This value will be used if the use_custom_schedule is set to false.' max_request_cadence: type: string enum: - MINUTE - HOUR - DAY - WEEK - MONTH - SECOND default: SECOND description: 'The cadence at which to limit the max request frequency. (e.g. "SECOND" in the following: 1 request per 2 SECONDs). Requests cannot be made less frequently than once per minute' example: SECOND max_request_frequency: type: number minimum: 1 default: 1 description: 'The maximum number of requests sent to the PMS API per cadence unit. (e.g. "2" in the following: 1 request per 2 SECONDs). Requests cannot be made less frequently than once per minute' example: 1 max_job_concurrency: type: integer maximum: 100 minimum: 1 default: 1 description: 'Maximum number of jobs that can be run at once for the integration. (e.g. "1" in the following: 1 request per 2 SECONDs)' example: 1 active: type: boolean default: false description: The active state of the integration base_url: type: - string - "null" format: uri description: DEPRECATED. See specific PMS credentials for usage. deprecated: true new_properties_are_enabled: type: boolean default: true description: Whether or not properties need to be approved before by you ingesting data for them. based_on_integration_id: type: string description: A reference integration_id to base the creation of an integration on. This includes copying job scheduling frequency and similar configuration. Credentials are not copied and must still be provided. example: clwsc909e000008l73rix7mae allow_manual_syncs: type: boolean default: true description: "Deprecated: This is no longer configurable and will always be true" deprecated: true custom_sync_schedule: type: object properties: type: type: string enum: - WEEK_BASED timezone: type: string enum: &a3 - UTC - America/New_York - America/Chicago - America/Denver - America/Phoenix - America/Los_Angeles - America/Anchorage - Pacific/Honolulu interval: type: object properties: SUNDAY: &a2 type: object properties: slots: type: array items: type: object properties: start: type: string pattern: (?:[01]\d|2[0123]):(?:[012345]\d) end: type: string pattern: (?:[01]\d|2[0123]):(?:[012345]\d) sync_frequency: type: integer exclusiveMinimum: 0 sync_cadence: type: string enum: - MINUTE - HOUR - DAY - WEEK - MONTH - SECOND required: - start - end - sync_frequency - sync_cadence required: - slots MONDAY: *a2 TUESDAY: *a2 WEDNESDAY: *a2 THURSDAY: *a2 FRIDAY: *a2 SATURDAY: *a2 required: - type - timezone - interval description: A custom sync schedule configuration object which will be respected if use_custom_schedule is set to true use_custom_sync_schedule: type: boolean default: false description: Opt-in to use the configured custom_sync_schedule required: - integration_vendor - credentials - name _v1_admin_integrations__post_output: type: object properties: result: type: object properties: id: type: string description: The unique identifier for the integration created_at: type: string description: The date the integration was created updated_at: type: string description: The date the integration was last updated name: type: - string - "null" description: The name of the integration vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record active: type: boolean description: The active state of the integration system: type: string enum: *a1 description: The system the integration is associated with sync_frequency: type: integer description: 'The interval of the scheduled sync frequency. (e.g. "12" in the following: Sync every 12 HOURs). This value will be used if the use_custom_schedule is set to false.' sync_cadence: type: string enum: - MINUTE - HOUR - DAY - WEEK - MONTH - SECOND description: 'The cadence of the scheduled sync frequency. (e.g. "HOUR" in the following: Sync every 12 HOURs). This value will be used if the use_custom_schedule is set to false.' max_request_cadence: type: string enum: - MINUTE - HOUR - DAY - WEEK - MONTH - SECOND default: SECOND description: 'The cadence at which to limit the max request frequency. (e.g. "SECOND" in the following: 1 request per 2 SECONDs). Requests cannot be made less frequently than once per minute' example: SECOND max_request_frequency: type: number minimum: 1 default: 1 description: 'The maximum number of requests sent to the PMS API per cadence unit. (e.g. "2" in the following: 1 request per 2 SECONDs). Requests cannot be made less frequently than once per minute' example: 10 max_job_concurrency: type: integer minimum: 1 default: 1 description: 'Maximum number of jobs that can be run at once for the integration. (e.g. "1" in the following: 1 request per 2 SECONDs)' example: 1 base_url: type: - string - "null" description: "DEPRECATED: see specific PMS credentials. Base URL for the integration vendor API" deprecated: true x-fern-availability: deprecated customer_id: type: string description: The unique identifier for the customer is_archived: type: boolean description: Whether or not the integration is archived ping_results: type: object additionalProperties: type: string new_properties_are_enabled: type: boolean description: Whether or not properties need to be approved before ingesting data for them. allow_manual_syncs: type: boolean default: true description: "Deprecated: This is no longer configurable and will always be true" deprecated: true x-fern-availability: deprecated custom_sync_schedule: type: object properties: type: type: string enum: - WEEK_BASED timezone: type: string enum: *a3 interval: type: object properties: SUNDAY: &a4 type: object properties: slots: type: array items: type: object properties: start: type: string pattern: (?:[01]\d|2[0123]):(?:[012345]\d) end: type: string pattern: (?:[01]\d|2[0123]):(?:[012345]\d) sync_frequency: type: integer exclusiveMinimum: 0 sync_cadence: type: string enum: - MINUTE - HOUR - DAY - WEEK - MONTH - SECOND required: - start - end - sync_frequency - sync_cadence required: - slots MONDAY: *a4 TUESDAY: *a4 WEDNESDAY: *a4 THURSDAY: *a4 FRIDAY: *a4 SATURDAY: *a4 required: - type - timezone - interval use_custom_sync_schedule: type: boolean description: Opt-in to use the configured custom_sync_schedule required: - id - created_at - updated_at - name - vendor - active - system - sync_frequency - sync_cadence - base_url - customer_id - is_archived - ping_results - new_properties_are_enabled - use_custom_sync_schedule required: - result _v1_admin_users__get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query id: type: string description: The unique identifier for the user _v1_admin_users__get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: type: array items: type: object properties: id: type: string description: The unique identifier for the user created_at: type: string description: The date the user was created updated_at: type: string description: The date the user was last updated first_name: type: string description: The first name of the user last_name: type: string description: The last name of the user email: type: string format: email description: The email of the user roles: type: array items: type: string enum: - ADMIN - DEVELOPER - SUPPORT - READ_ONLY required: - id - created_at - updated_at - first_name - last_name - email - roles required: - meta - results _v1_admin_users_{id}_get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query _v1_admin_users_{id}_get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: type: - object - "null" properties: id: type: string description: The unique identifier for the user created_at: type: string description: The date the users was created updated_at: type: string description: The date the user was last updated first_name: type: string description: The first name of the user last_name: type: string description: The last name of the user email: type: string format: email description: The email of the user roles: type: array items: type: string enum: - ADMIN - DEVELOPER - SUPPORT - READ_ONLY required: - id - created_at - updated_at - first_name - last_name - email - roles required: - meta - results _v1_admin_write-status_{root_job_id}_get_input: type: object properties: {} _v1_admin_write-status_{root_job_id}_get_output: type: object properties: write_status: type: string enum: - SUCCESS - PARTIAL_SUCCESS - FAILURE - PENDING description: The status for the write operation. "SUCCESS" means that the write operation was seen as a complete success and the data has been written. "PARTIAL_SUCCESS" means that a portion of the write operation succeeded, but it was not fully successful. "FAILURE" means that the write operation completely failed."PENDING" means that the write operation is pending completion of any status. errors: type: array items: type: string created_record_id: type: - string - "null" description: The ID may be null if the job didn't run correctly or if the given PMS does not generate a new record ID for create operations. Due to varying PMS workflow requirements, some Propexo jobs will spawn other jobs. This will return the first ID created in the process and could be related to a different model than expected. This is not intended to be a complete solution and could have gaps. required: - write_status - errors - created_record_id _v1_admin_retry-write_{root_job_id}_post_input: type: object properties: {} _v1_admin_retry-write_{root_job_id}_post_output: type: object properties: success: type: boolean description: Whether the write operation has been queued to be retried. job_id: type: string description: The new job ID of the write operation that was queued. required: - success - job_id _v1_admin_integrations_{integration_id}__get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query _v1_admin_integrations_{integration_id}__get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: type: - object - "null" properties: id: type: string description: The unique identifier for the integration created_at: type: string description: The date the integration was created updated_at: type: string description: The date the integration was last updated name: type: string description: The name of the integration vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record active: type: boolean description: The active state of the integration system: type: string enum: *a1 description: The system the integration is associated with sync_frequency: type: - integer - "null" description: 'Deprecated: See the job schedules endpoint for this information. The interval of the scheduled sync frequency. (e.g. "12" in the following: Sync every 12 HOURs)' deprecated: true x-fern-availability: deprecated sync_cadence: type: - string - "null" enum: - MINUTE - HOUR - DAY - WEEK - MONTH - SECOND description: 'Deprecated: See the job schedules endpoint for this information. The cadence of the scheduled sync frequency. (e.g. "HOUR" in the following: Sync every 12 HOURs)' deprecated: true x-fern-availability: deprecated max_job_concurrency: type: integer description: Maximum number of jobs that can be run at once for the integration max_request_frequency: type: integer description: Maximum number of jobs that can be run in the max request cadence max_request_cadence: type: string enum: - MINUTE - HOUR - DAY - WEEK - MONTH - SECOND description: Cadence at which to limit the max request frequency base_url: type: - string - "null" description: "DEPRECATED: see specific PMS credentials. Base URL for the integration vendor API" deprecated: true x-fern-availability: deprecated is_archived: type: boolean description: Whether or not the integration is archived last_completed_sync: type: - string - "null" description: The timestamp of the last time a sync was completed. last_completed_back_sync: type: - string - "null" description: The timestamp of the last time a back sync was completed. new_properties_are_enabled: type: boolean description: Whether or not properties need to be approved before ingesting data for them. integration_interfaces: type: array items: type: object properties: interface_name: type: string enum: - REALPAGE_CREATE_LEAD - REALPAGE_CREATE_LEAD_EVENT - REALPAGE_CREATE_RESIDENT_ACTIVITY_LOG - REALPAGE_CREATE_SERVICE_REQUEST - REALPAGE_UPDATE_APPLICANT - REALPAGE_UPDATE_LEAD - REALPAGE_UPDATE_RESIDENT - REALPAGE_UPDATE_SERVICE_REQUEST - REALPAGE_PROSPECT_MANAGEMENT_ALL_LEADS - REALPAGE_RESIDENTS_APPLICANT_GENERAL_INFO - REALPAGE_PRICING_AND_AVAILABILITY_FLOOR_PLANS - REALPAGE_PRICING_AND_AVAILABILITY_FLOOR_PLANS_PANDA - REALPAGE_PRICING_AND_AVAILABILITY_UNITS_PANDA - REALPAGE_PRICING_AND_AVAILABILITY_PICK_LISTS_PANDA - REALPAGE_PROSPECT_MANAGEMENT_LEAD - REALPAGE_PROSPECT_MANAGEMENT_LEAD_SOURCES - REALPAGE_PROSPECT_MANAGEMENT_PROPERTIES - REALPAGE_RESIDENTS_RESIDENT_ACTIVITY_LOGS - REALPAGE_RESIDENTS_RESIDENT_ACTIVITY_TYPES - REALPAGE_RESIDENTS_RESIDENT_GENERAL_INFO - REALPAGE_RESIDENTS_RESIDENT_LEASE - REALPAGE_RESIDENTS_RESIDENT_LEDGER - REALPAGE_RESIDENTS_RESIDENT_LIST - REALPAGE_FACILITIES_SERVICE_REQUESTS - REALPAGE_PROSPECT_MANAGEMENT_UNITS - REALPAGE_UNIT_UNIT_DETAILS - REALPAGE_PRICING_AND_AVAILABILITY_RENT_MATRIX - REALPAGE_SDE_CONVERGENT_BILLING - REALPAGE_FACILITIES - REALPAGE_PRICING_AND_AVAILABILITY - REALPAGE_PROSPECT_MANAGEMENT - REALPAGE_RESIDENTS - REALPAGE_UNIT - REALPAGE_RPX_AMENITIES - REALPAGE_RPX_APPOINTMENTS - REALPAGE_RPX_APPOINTMENT_AVAILABILITY - REALPAGE_RPX_CONCESSIONS - REALPAGE_RPX_CONVERGENT_BILLING_LEASES - REALPAGE_RPX_CONVERGENT_BILLING_RESIDENTS - REALPAGE_RPX_CONVERGENT_BILLING_UNITS - REALPAGE_RPX_CREATE_APPOINTMENT - REALPAGE_RPX_CREATE_LEAD - REALPAGE_RPX_CREATE_LEAD_EVENT - REALPAGE_RPX_CREATE_RESIDENT_ACTIVITY_LOG - REALPAGE_RPX_CREATE_RESIDENT_CHARGE - REALPAGE_RPX_CREATE_SERVICE_REQUEST - REALPAGE_RPX_UPDATE_APPOINTMENT - REALPAGE_RPX_UPDATE_APPOINTMENT_CANCEL - REALPAGE_RPX_UPDATE_LEAD - REALPAGE_RPX_UPDATE_SERVICE_REQUEST - REALPAGE_RPX_FLOOR_PLANS - REALPAGE_RPX_LEADS - REALPAGE_RPX_LEAD_ACTIVITY_TYPES - REALPAGE_RPX_LEAD_RELATIONSHIPS - REALPAGE_RPX_LEAD_SOURCES - REALPAGE_RPX_LISTINGS - REALPAGE_RPX_LEASING_AGENTS - REALPAGE_RPX_PET_TYPES - REALPAGE_RPX_PROSPECTS_SURVEY - REALPAGE_RPX_RESIDENT_SURVEY - REALPAGE_RPX_READ_PROPERTIES - REALPAGE_RPX_READ_PROPERTY_DATA - REALPAGE_RPX_RESIDENTS - REALPAGE_RPX_RESIDENT_ACTIVITY_LOGS - REALPAGE_RPX_RESIDENT_ACTIVITY_TYPES - REALPAGE_RPX_RESIDENT_LEDGER - REALPAGE_RPX_RESIDENT_TRANSACTION_CODES - REALPAGE_RPX_SERVICE_REQUESTS - REALPAGE_RPX_SERVICE_REQUEST_ISSUES - REALPAGE_RPX_SERVICE_REQUEST_LOCATIONS - REALPAGE_RPX_SERVICE_REQUEST_PRIORITIES - REALPAGE_RPX_SERVICE_REQUESTS_SURVEY - REALPAGE_RPX_UNITS - REALPAGE_RPX_UNITS_BY_PROPERTY - REALPAGE_RPX_UPDATE_SITE_SUBSCRIPTION - REALPAGE_RPX_ACTIVITY_RESULT_CODES - REALPAGE_RPX_CONVERGENT_BILLING - REALPAGE_RPX_FACILITIES - REALPAGE_RPX_PRICING_AND_AVAILABILITY - REALPAGE_RPX_PROSPECT_MANAGEMENT - REALPAGE_RPX_RESIDENT_MANAGEMENT - REALPAGE_RPX_RESIDENT_TRANSACTIONS - REALPAGE_RPX_CONVERGENT_BILLING_RESIDENT_LEDGER - REALPAGE_RPX_CONVERGENT_BILLING_TRANSACTION_CODES - REALPAGE_RPX_RESIDENT_MANAGEMENT_EVENTS - ENTRATA_AMENITIES - ENTRATA_AR_CODES - ENTRATA_CALL_LOGS - ENTRATA_CONCESSIONS - ENTRATA_CREATE_AMENITY - ENTRATA_CREATE_APPLICANT - ENTRATA_CREATE_APPLICANT_PETS - ENTRATA_CREATE_APPLICANT_VEHICLES - ENTRATA_CREATE_APPLICANT_EMPLOYERS - ENTRATA_CREATE_APPLICANT_ADDONS - ENTRATA_CREATE_EVENT - ENTRATA_CREATE_INVOICE - ENTRATA_CREATE_LEAD - ENTRATA_CREATE_LEASE - ENTRATA_CREATE_LEASE_DOCUMENTS - ENTRATA_CREATE_LEASE_TRANSACTION - ENTRATA_CREATE_LISTING - ENTRATA_CREATE_PURCHASE_ORDER - ENTRATA_CREATE_RECURRING_CHARGE - ENTRATA_CREATE_RESIDENT_CHARGE - ENTRATA_CREATE_SERVICE_REQUEST - ENTRATA_CREATE_SERVICE_REQUEST_FILE - ENTRATA_CREATE_SERVICE_REQUEST_NOTE - ENTRATA_CREATE_UNIT - ENTRATA_CREATE_VENDOR - ENTRATA_FEES - ENTRATA_FLOOR_PLANS - ENTRATA_GL_ACCOUNTS - ENTRATA_INVOICES - ENTRATA_LEAD_EVENTS - ENTRATA_LEAD_PICK_LIST - ENTRATA_LEASE_DETAILS - ENTRATA_LEASE_PICK_LIST - ENTRATA_LEASE_TRANSACTIONS - ENTRATA_LEASES - ENTRATA_LISTINGS - ENTRATA_PROPERTIES - ENTRATA_PET_TYPES - ENTRATA_PRICING_PICK_LIST - ENTRATA_PROPERTY_PICK_LIST - ENTRATA_PROSPECTS - ENTRATA_PURCHASE_ORDERS - ENTRATA_RENTABLE_ITEMS - ENTRATA_RESIDENT_TRANSACTION_ALLOCATIONS - ENTRATA_RESIDENTS - ENTRATA_UNIT_TYPES - ENTRATA_UNITS - ENTRATA_UPDATE_AMENITY - ENTRATA_UPDATE_APPLICANT - ENTRATA_UPDATE_LEAD - ENTRATA_UPDATE_LEASE - ENTRATA_UPDATE_RESIDENT - ENTRATA_UPDATE_SERVICE_REQUEST - ENTRATA_VENDOR_LOCATIONS - ENTRATA_VENDOR_PICK_LIST - ENTRATA_VENDORS - ENTRATA_WORK_ORDER_PICK_LIST - ENTRATA_WORK_ORDERS - ENTRATA_BASE - PROPERTYWARE_REST_CREATE_RESIDENT - PROPERTYWARE_REST_CREATE_DOCUMENT - PROPERTYWARE_REST_CREATE_RECURRING_CHARGES - PROPERTYWARE_REST_CREATE_RESIDENT_CHARGE - PROPERTYWARE_REST_CREATE_RESIDENT_CREDIT - PROPERTYWARE_REST_CREATE_RESIDENT_PAYMENT - PROPERTYWARE_REST_CREATE_UNIT - PROPERTYWARE_REST_READ_FINANCIAL_ACCOUNTS - PROPERTYWARE_REST_READ_GENERAL_LEDGER - PROPERTYWARE_REST_READ_LEASE_ADJUSTMENTS - PROPERTYWARE_REST_READ_LEASE_CHARGES - PROPERTYWARE_REST_READ_LEASE_CREDIT_MEMOS - PROPERTYWARE_REST_READ_LEASE_DISCOUNTS - PROPERTYWARE_REST_READ_LEASE_JOURNAL_ENTRIES - PROPERTYWARE_REST_READ_LEASE_PAYMENTS - PROPERTYWARE_REST_READ_LEASE_REFUNDS - PROPERTYWARE_REST_READ_LEASES - PROPERTYWARE_REST_READ_PORTFOLIOS - PROPERTYWARE_REST_READ_PROPERTIES - PROPERTYWARE_REST_READ_PROSPECTS - PROPERTYWARE_REST_READ_RECURRING_CHARGES - PROPERTYWARE_REST_READ_RESIDENTS - PROPERTYWARE_REST_READ_UNITS - PROPERTYWARE_REST_READ_INVOICES - PROPERTYWARE_REST_UPDATE_CONTACTS - PROPERTYWARE_REST_UPDATE_DOCUMENT - PROPERTYWARE_REST_UPDATE_LEASE - PROPERTYWARE_REST_UPDATE_LEASE_CUSTOM_FIELDS - PROPERTYWARE_REST_UPDATE_PROPERTY_CUSTOM_FIELDS - PROPERTYWARE_REST_UPDATE_UNIT_CUSTOM_FIELDS - RESMAN_BASE - RESMAN_CREATE_APPLICANT - RESMAN_CREATE_FILE_UPLOAD - RESMAN_CREATE_INVOICE - RESMAN_CREATE_LEAD - RESMAN_CREATE_RESIDENT_CHARGE - RESMAN_CREATE_RESIDENT_PAYMENT - RESMAN_CREATE_SERVICE_REQUEST - RESMAN_READ_ACCOUNTS - RESMAN_READ_EMPLOYEES - RESMAN_READ_INVOICES - RESMAN_READ_LEADS - RESMAN_READ_LEAD_SOURCES - RESMAN_READ_LEASES - RESMAN_READ_LEASES_PARTNER_API - RESMAN_READ_LISTINGS - RESMAN_READ_MOVE_OUTS - RESMAN_READ_PROPERTIES - RESMAN_READ_RESIDENTS - RESMAN_READ_RESIDENTS_AND_APPLICANTS - RESMAN_READ_RESIDENTS_DOB - RESMAN_READ_RESIDENT_CHARGE_CODES - RESMAN_READ_RESIDENT_TRANSACTIONS - RESMAN_READ_RENTABLE_ITEMS - RESMAN_READ_SERVICE_REQUESTS - RESMAN_READ_SERVICE_REQUEST_CATEGORIES - RESMAN_READ_UNITS - RESMAN_READ_VENDORS - RESMAN_UPDATE_APPLICANT - RESMAN_UPDATE_LEAD - RESMAN_UPDATE_SERVICE_REQUEST - RESMAN_READ_DEPOSIT_SUMMARY_PARTNER_API - APPFOLIO_CREATE_APPOINTMENT - APPFOLIO_CREATE_CHARGE - APPFOLIO_CREATE_LEAD - APPFOLIO_READ_APPLICATIONS - APPFOLIO_READ_APPOINTMENTS - APPFOLIO_READ_EMPLOYEES - APPFOLIO_READ_FINANCIAL_ACCOUNTS - APPFOLIO_READ_INVOICES - APPFOLIO_READ_LEADS - APPFOLIO_READ_LISTINGS - APPFOLIO_READ_PROPERTIES - APPFOLIO_READ_RESIDENTS - APPFOLIO_READ_RECURRING_CHARGES - APPFOLIO_READ_SERVICE_REQUESTS - APPFOLIO_READ_TENANT_LEDGERS - APPFOLIO_READ_UNITS - APPFOLIO_READ_VENDORS - APPFOLIO_UPDATE_LEAD - APPFOLIO_UPDATE_APPOINTMENT - APPFOLIO_BASE - YARDI_GUESTCARD - YARDI_RESIDENT_TRANSACTIONS - YARDI_RESIDENT_DATA - YARDI_SERVICES - YARDI_JOB_COST - YARDI_VENDOR_INVOICING - YARDI_LEASE_RENEWALS - YARDI_DEPOSIT_SUMMARIES - YARDI_REST_COMMON_DATA - YARDI_REST_SERVICE_REQUESTS - YARDI_REST_RESIDENT_TRANSACTIONS - YARDI_REST_VENDOR_INVOICING - YARDI_REST_JOB_COST - BUILDIUM_BASE - PROPERTYWARE_BASE - RENTMANAGER_BASE - RENTVINE_BASE - MRI_BASE - MRI_CREATE_EVENT - MRI_CREATE_EVENT_TYPE - MRI_CREATE_INVOICE - MRI_CREATE_PROSPECT - MRI_CREATE_RESIDENT_NOTE - MRI_CREATE_SERVICE_REQUEST - MRI_READ_ACCOUNTING_ENTITIES - MRI_READ_ALL_RESIDENTS - MRI_READ_AMENITIES - MRI_READ_APPLICANT_EVENTS - MRI_READ_APPLICANTS - MRI_READ_CHARGE_CODES - MRI_READ_EMPLOYEES - MRI_READ_EVENT_TYPES - MRI_READ_FINANCIAL_ACCOUNTS - MRI_READ_INVOICES - MRI_READ_LEAD_EVENTS - MRI_READ_LEAD_SOURCES - MRI_READ_LEADS - MRI_READ_LEASES - MRI_READ_LEASING_AGENTS - MRI_READ_NOTE_CATEGORIES - MRI_READ_OWNERS - MRI_READ_PICK_LISTS - MRI_READ_PROPERTIES - MRI_READ_RECURRING_CHARGES - MRI_READ_RESIDENT_EVENTS - MRI_READ_RESIDENT_LEDGER - MRI_READ_RESIDENT_PETS - MRI_READ_RESIDENTS - MRI_READ_SECURITY_DEPOSIT_LEDGER - MRI_READ_SERVICE_REQUESTS - MRI_READ_SODAS - MRI_READ_UNITS - MRI_READ_VENDORS - MRI_UPDATE_EVENT - MRI_UPDATE_INVOICE - MRI_UPDATE_INVOICE_AS_PAID - MRI_UPDATE_INVOICE_PAYMENT - MRI_UPDATE_INVOICE_STATUS - MRI_UPDATE_PROSPECT - MRI_UPDATE_RESIDENT - MRI_UPDATE_SERVICE_REQUEST - KNOCK_BASE - RENTCAFE_BASE - FUNNEL_BASE enabled: type: boolean version: type: - string - "null" required: - interface_name - enabled - version models: type: object additionalProperties: type: object properties: enabled: type: boolean from_interfaces: type: array items: type: string enum: - REALPAGE_CREATE_LEAD - REALPAGE_CREATE_LEAD_EVENT - REALPAGE_CREATE_RESIDENT_ACTIVITY_LOG - REALPAGE_CREATE_SERVICE_REQUEST - REALPAGE_UPDATE_APPLICANT - REALPAGE_UPDATE_LEAD - REALPAGE_UPDATE_RESIDENT - REALPAGE_UPDATE_SERVICE_REQUEST - REALPAGE_PROSPECT_MANAGEMENT_ALL_LEADS - REALPAGE_RESIDENTS_APPLICANT_GENERAL_INFO - REALPAGE_PRICING_AND_AVAILABILITY_FLOOR_PLANS - REALPAGE_PRICING_AND_AVAILABILITY_FLOOR_PLANS_PANDA - REALPAGE_PRICING_AND_AVAILABILITY_UNITS_PANDA - REALPAGE_PRICING_AND_AVAILABILITY_PICK_LISTS_PANDA - REALPAGE_PROSPECT_MANAGEMENT_LEAD - REALPAGE_PROSPECT_MANAGEMENT_LEAD_SOURCES - REALPAGE_PROSPECT_MANAGEMENT_PROPERTIES - REALPAGE_RESIDENTS_RESIDENT_ACTIVITY_LOGS - REALPAGE_RESIDENTS_RESIDENT_ACTIVITY_TYPES - REALPAGE_RESIDENTS_RESIDENT_GENERAL_INFO - REALPAGE_RESIDENTS_RESIDENT_LEASE - REALPAGE_RESIDENTS_RESIDENT_LEDGER - REALPAGE_RESIDENTS_RESIDENT_LIST - REALPAGE_FACILITIES_SERVICE_REQUESTS - REALPAGE_PROSPECT_MANAGEMENT_UNITS - REALPAGE_UNIT_UNIT_DETAILS - REALPAGE_PRICING_AND_AVAILABILITY_RENT_MATRIX - REALPAGE_SDE_CONVERGENT_BILLING - REALPAGE_FACILITIES - REALPAGE_PRICING_AND_AVAILABILITY - REALPAGE_PROSPECT_MANAGEMENT - REALPAGE_RESIDENTS - REALPAGE_UNIT - REALPAGE_RPX_AMENITIES - REALPAGE_RPX_APPOINTMENTS - REALPAGE_RPX_APPOINTMENT_AVAILABILITY - REALPAGE_RPX_CONCESSIONS - REALPAGE_RPX_CONVERGENT_BILLING_LEASES - REALPAGE_RPX_CONVERGENT_BILLING_RESIDENTS - REALPAGE_RPX_CONVERGENT_BILLING_UNITS - REALPAGE_RPX_CREATE_APPOINTMENT - REALPAGE_RPX_CREATE_LEAD - REALPAGE_RPX_CREATE_LEAD_EVENT - REALPAGE_RPX_CREATE_RESIDENT_ACTIVITY_LOG - REALPAGE_RPX_CREATE_RESIDENT_CHARGE - REALPAGE_RPX_CREATE_SERVICE_REQUEST - REALPAGE_RPX_UPDATE_APPOINTMENT - REALPAGE_RPX_UPDATE_APPOINTMENT_CANCEL - REALPAGE_RPX_UPDATE_LEAD - REALPAGE_RPX_UPDATE_SERVICE_REQUEST - REALPAGE_RPX_FLOOR_PLANS - REALPAGE_RPX_LEADS - REALPAGE_RPX_LEAD_ACTIVITY_TYPES - REALPAGE_RPX_LEAD_RELATIONSHIPS - REALPAGE_RPX_LEAD_SOURCES - REALPAGE_RPX_LISTINGS - REALPAGE_RPX_LEASING_AGENTS - REALPAGE_RPX_PET_TYPES - REALPAGE_RPX_PROSPECTS_SURVEY - REALPAGE_RPX_RESIDENT_SURVEY - REALPAGE_RPX_READ_PROPERTIES - REALPAGE_RPX_READ_PROPERTY_DATA - REALPAGE_RPX_RESIDENTS - REALPAGE_RPX_RESIDENT_ACTIVITY_LOGS - REALPAGE_RPX_RESIDENT_ACTIVITY_TYPES - REALPAGE_RPX_RESIDENT_LEDGER - REALPAGE_RPX_RESIDENT_TRANSACTION_CODES - REALPAGE_RPX_SERVICE_REQUESTS - REALPAGE_RPX_SERVICE_REQUEST_ISSUES - REALPAGE_RPX_SERVICE_REQUEST_LOCATIONS - REALPAGE_RPX_SERVICE_REQUEST_PRIORITIES - REALPAGE_RPX_SERVICE_REQUESTS_SURVEY - REALPAGE_RPX_UNITS - REALPAGE_RPX_UNITS_BY_PROPERTY - REALPAGE_RPX_UPDATE_SITE_SUBSCRIPTION - REALPAGE_RPX_ACTIVITY_RESULT_CODES - REALPAGE_RPX_CONVERGENT_BILLING - REALPAGE_RPX_FACILITIES - REALPAGE_RPX_PRICING_AND_AVAILABILITY - REALPAGE_RPX_PROSPECT_MANAGEMENT - REALPAGE_RPX_RESIDENT_MANAGEMENT - REALPAGE_RPX_RESIDENT_TRANSACTIONS - REALPAGE_RPX_CONVERGENT_BILLING_RESIDENT_LEDGER - REALPAGE_RPX_CONVERGENT_BILLING_TRANSACTION_CODES - REALPAGE_RPX_RESIDENT_MANAGEMENT_EVENTS - ENTRATA_AMENITIES - ENTRATA_AR_CODES - ENTRATA_CALL_LOGS - ENTRATA_CONCESSIONS - ENTRATA_CREATE_AMENITY - ENTRATA_CREATE_APPLICANT - ENTRATA_CREATE_APPLICANT_PETS - ENTRATA_CREATE_APPLICANT_VEHICLES - ENTRATA_CREATE_APPLICANT_EMPLOYERS - ENTRATA_CREATE_APPLICANT_ADDONS - ENTRATA_CREATE_EVENT - ENTRATA_CREATE_INVOICE - ENTRATA_CREATE_LEAD - ENTRATA_CREATE_LEASE - ENTRATA_CREATE_LEASE_DOCUMENTS - ENTRATA_CREATE_LEASE_TRANSACTION - ENTRATA_CREATE_LISTING - ENTRATA_CREATE_PURCHASE_ORDER - ENTRATA_CREATE_RECURRING_CHARGE - ENTRATA_CREATE_RESIDENT_CHARGE - ENTRATA_CREATE_SERVICE_REQUEST - ENTRATA_CREATE_SERVICE_REQUEST_FILE - ENTRATA_CREATE_SERVICE_REQUEST_NOTE - ENTRATA_CREATE_UNIT - ENTRATA_CREATE_VENDOR - ENTRATA_FEES - ENTRATA_FLOOR_PLANS - ENTRATA_GL_ACCOUNTS - ENTRATA_INVOICES - ENTRATA_LEAD_EVENTS - ENTRATA_LEAD_PICK_LIST - ENTRATA_LEASE_DETAILS - ENTRATA_LEASE_PICK_LIST - ENTRATA_LEASE_TRANSACTIONS - ENTRATA_LEASES - ENTRATA_LISTINGS - ENTRATA_PROPERTIES - ENTRATA_PET_TYPES - ENTRATA_PRICING_PICK_LIST - ENTRATA_PROPERTY_PICK_LIST - ENTRATA_PROSPECTS - ENTRATA_PURCHASE_ORDERS - ENTRATA_RENTABLE_ITEMS - ENTRATA_RESIDENT_TRANSACTION_ALLOCATIONS - ENTRATA_RESIDENTS - ENTRATA_UNIT_TYPES - ENTRATA_UNITS - ENTRATA_UPDATE_AMENITY - ENTRATA_UPDATE_APPLICANT - ENTRATA_UPDATE_LEAD - ENTRATA_UPDATE_LEASE - ENTRATA_UPDATE_RESIDENT - ENTRATA_UPDATE_SERVICE_REQUEST - ENTRATA_VENDOR_LOCATIONS - ENTRATA_VENDOR_PICK_LIST - ENTRATA_VENDORS - ENTRATA_WORK_ORDER_PICK_LIST - ENTRATA_WORK_ORDERS - ENTRATA_BASE - PROPERTYWARE_REST_CREATE_RESIDENT - PROPERTYWARE_REST_CREATE_DOCUMENT - PROPERTYWARE_REST_CREATE_RECURRING_CHARGES - PROPERTYWARE_REST_CREATE_RESIDENT_CHARGE - PROPERTYWARE_REST_CREATE_RESIDENT_CREDIT - PROPERTYWARE_REST_CREATE_RESIDENT_PAYMENT - PROPERTYWARE_REST_CREATE_UNIT - PROPERTYWARE_REST_READ_FINANCIAL_ACCOUNTS - PROPERTYWARE_REST_READ_GENERAL_LEDGER - PROPERTYWARE_REST_READ_LEASE_ADJUSTMENTS - PROPERTYWARE_REST_READ_LEASE_CHARGES - PROPERTYWARE_REST_READ_LEASE_CREDIT_MEMOS - PROPERTYWARE_REST_READ_LEASE_DISCOUNTS - PROPERTYWARE_REST_READ_LEASE_JOURNAL_ENTRIES - PROPERTYWARE_REST_READ_LEASE_PAYMENTS - PROPERTYWARE_REST_READ_LEASE_REFUNDS - PROPERTYWARE_REST_READ_LEASES - PROPERTYWARE_REST_READ_PORTFOLIOS - PROPERTYWARE_REST_READ_PROPERTIES - PROPERTYWARE_REST_READ_PROSPECTS - PROPERTYWARE_REST_READ_RECURRING_CHARGES - PROPERTYWARE_REST_READ_RESIDENTS - PROPERTYWARE_REST_READ_UNITS - PROPERTYWARE_REST_READ_INVOICES - PROPERTYWARE_REST_UPDATE_CONTACTS - PROPERTYWARE_REST_UPDATE_DOCUMENT - PROPERTYWARE_REST_UPDATE_LEASE - PROPERTYWARE_REST_UPDATE_LEASE_CUSTOM_FIELDS - PROPERTYWARE_REST_UPDATE_PROPERTY_CUSTOM_FIELDS - PROPERTYWARE_REST_UPDATE_UNIT_CUSTOM_FIELDS - RESMAN_BASE - RESMAN_CREATE_APPLICANT - RESMAN_CREATE_FILE_UPLOAD - RESMAN_CREATE_INVOICE - RESMAN_CREATE_LEAD - RESMAN_CREATE_RESIDENT_CHARGE - RESMAN_CREATE_RESIDENT_PAYMENT - RESMAN_CREATE_SERVICE_REQUEST - RESMAN_READ_ACCOUNTS - RESMAN_READ_EMPLOYEES - RESMAN_READ_INVOICES - RESMAN_READ_LEADS - RESMAN_READ_LEAD_SOURCES - RESMAN_READ_LEASES - RESMAN_READ_LEASES_PARTNER_API - RESMAN_READ_LISTINGS - RESMAN_READ_MOVE_OUTS - RESMAN_READ_PROPERTIES - RESMAN_READ_RESIDENTS - RESMAN_READ_RESIDENTS_AND_APPLICANTS - RESMAN_READ_RESIDENTS_DOB - RESMAN_READ_RESIDENT_CHARGE_CODES - RESMAN_READ_RESIDENT_TRANSACTIONS - RESMAN_READ_RENTABLE_ITEMS - RESMAN_READ_SERVICE_REQUESTS - RESMAN_READ_SERVICE_REQUEST_CATEGORIES - RESMAN_READ_UNITS - RESMAN_READ_VENDORS - RESMAN_UPDATE_APPLICANT - RESMAN_UPDATE_LEAD - RESMAN_UPDATE_SERVICE_REQUEST - RESMAN_READ_DEPOSIT_SUMMARY_PARTNER_API - APPFOLIO_CREATE_APPOINTMENT - APPFOLIO_CREATE_CHARGE - APPFOLIO_CREATE_LEAD - APPFOLIO_READ_APPLICATIONS - APPFOLIO_READ_APPOINTMENTS - APPFOLIO_READ_EMPLOYEES - APPFOLIO_READ_FINANCIAL_ACCOUNTS - APPFOLIO_READ_INVOICES - APPFOLIO_READ_LEADS - APPFOLIO_READ_LISTINGS - APPFOLIO_READ_PROPERTIES - APPFOLIO_READ_RESIDENTS - APPFOLIO_READ_RECURRING_CHARGES - APPFOLIO_READ_SERVICE_REQUESTS - APPFOLIO_READ_TENANT_LEDGERS - APPFOLIO_READ_UNITS - APPFOLIO_READ_VENDORS - APPFOLIO_UPDATE_LEAD - APPFOLIO_UPDATE_APPOINTMENT - APPFOLIO_BASE - YARDI_GUESTCARD - YARDI_RESIDENT_TRANSACTIONS - YARDI_RESIDENT_DATA - YARDI_SERVICES - YARDI_JOB_COST - YARDI_VENDOR_INVOICING - YARDI_LEASE_RENEWALS - YARDI_DEPOSIT_SUMMARIES - YARDI_REST_COMMON_DATA - YARDI_REST_SERVICE_REQUESTS - YARDI_REST_RESIDENT_TRANSACTIONS - YARDI_REST_VENDOR_INVOICING - YARDI_REST_JOB_COST - BUILDIUM_BASE - PROPERTYWARE_BASE - RENTMANAGER_BASE - RENTVINE_BASE - MRI_BASE - MRI_CREATE_EVENT - MRI_CREATE_EVENT_TYPE - MRI_CREATE_INVOICE - MRI_CREATE_PROSPECT - MRI_CREATE_RESIDENT_NOTE - MRI_CREATE_SERVICE_REQUEST - MRI_READ_ACCOUNTING_ENTITIES - MRI_READ_ALL_RESIDENTS - MRI_READ_AMENITIES - MRI_READ_APPLICANT_EVENTS - MRI_READ_APPLICANTS - MRI_READ_CHARGE_CODES - MRI_READ_EMPLOYEES - MRI_READ_EVENT_TYPES - MRI_READ_FINANCIAL_ACCOUNTS - MRI_READ_INVOICES - MRI_READ_LEAD_EVENTS - MRI_READ_LEAD_SOURCES - MRI_READ_LEADS - MRI_READ_LEASES - MRI_READ_LEASING_AGENTS - MRI_READ_NOTE_CATEGORIES - MRI_READ_OWNERS - MRI_READ_PICK_LISTS - MRI_READ_PROPERTIES - MRI_READ_RECURRING_CHARGES - MRI_READ_RESIDENT_EVENTS - MRI_READ_RESIDENT_LEDGER - MRI_READ_RESIDENT_PETS - MRI_READ_RESIDENTS - MRI_READ_SECURITY_DEPOSIT_LEDGER - MRI_READ_SERVICE_REQUESTS - MRI_READ_SODAS - MRI_READ_UNITS - MRI_READ_VENDORS - MRI_UPDATE_EVENT - MRI_UPDATE_INVOICE - MRI_UPDATE_INVOICE_AS_PAID - MRI_UPDATE_INVOICE_PAYMENT - MRI_UPDATE_INVOICE_STATUS - MRI_UPDATE_PROSPECT - MRI_UPDATE_RESIDENT - MRI_UPDATE_SERVICE_REQUEST - KNOCK_BASE - RENTCAFE_BASE - FUNNEL_BASE required: - enabled - from_interfaces can_authenticate: type: boolean description: True if the credentials and configuration for the integration allowed us to successfully authenticate with at least one PMS API endpoint, false otherwise last_data_access_check: type: - string - "null" description: The UTC timestamp of the last time an authentication check was performed for an integration. allow_manual_syncs: type: boolean default: true description: "Deprecated: This is no longer configurable and will always be true" deprecated: true x-fern-availability: deprecated configuration_meta_data: type: array items: type: object properties: last_seen: type: string interface_name: type: - string - "null" configuration_data: type: object properties: {} custom_data: type: - object - "null" properties: {} required: - last_seen - interface_name - configuration_data - custom_data is_running_sync: type: boolean description: Whether or not a data sync is currently in progress for the integration is_running_data_access_check: type: boolean description: Whether or not a data access check is currently in progress for the integration required: - id - created_at - updated_at - name - vendor - active - system - max_job_concurrency - max_request_frequency - max_request_cadence - base_url - is_archived - last_completed_sync - last_completed_back_sync - new_properties_are_enabled - integration_interfaces - models - can_authenticate - last_data_access_check - configuration_meta_data - is_running_sync - is_running_data_access_check required: - meta - results _v1_admin_integrations_{integration_id}__put_input: type: object properties: integration_vendor: $ref: "#/components/schemas/Enum9" credentials: anyOf: - type: object properties: {} - type: object properties: apiKey: type: string companyId: type: string required: - apiKey - companyId description: Entrata authentication credentials title: Entrata - type: object properties: clientId: type: string databaseName: type: string partnerKey: type: string username: type: string password: type: string baseUrl: type: string required: - clientId - databaseName - partnerKey - username - password - baseUrl description: MRI authentication credentials title: MRI - type: object properties: clientId: type: string clientSecret: type: string systemId: type: string description: The system/organization ID to query data from required: - clientId - clientSecret - systemId description: Propertyware REST authentication credentials title: Propertyware REST - type: object properties: PMC_ID: type: string SITE_ID: type: string LICENSE_KEY: type: string ONESITE_USERNAME: type: string ONESITE_PASSWORD: type: string BASE_URL: type: string ftp_credentials: type: object properties: SFTP_HOST: type: string SFTP_PORT: type: number SFTP_USERNAME: type: string SFTP_PASSWORD: type: string SFTP_DIR: type: string required: - SFTP_HOST - SFTP_PORT - SFTP_USERNAME - SFTP_PASSWORD - SFTP_DIR required: - PMC_ID - SITE_ID - LICENSE_KEY - ONESITE_USERNAME description: RealPage Registered Vendor authentication credentials title: RealpageRegisteredVendor - type: object properties: username: type: string password: type: string required: - username - password description: Propertyware SOAP authentication credentials title: Propertyware SOAP - type: object properties: Username: type: string Password: type: string companyId: type: string required: - Username - Password - companyId description: Rent Manager authentication credentials title: RentManagerSandbox - type: object properties: PartnerToken: type: string companyId: type: string required: - PartnerToken - companyId description: Rent Manager authentication credentials title: RentManagerProduction - type: object properties: clientId: type: string secret: type: string required: - clientId - secret description: Buildium authentication credentials title: Buildium - type: object properties: integrationPartnerId: type: string accountId: type: string apiKey: type: string required: - integrationPartnerId - accountId - apiKey description: ResMan authentication credentials title: Resman - type: object properties: clientId: type: string clientSecret: type: string developerId: type: string required: - clientId - clientSecret - developerId description: AppFolio authentication credentials title: AppFolio - type: object properties: baseUrl: type: string minLength: 1 format: uri licensekey: type: string minLength: 1 pmcId: type: string description: This is also sometimes referred to as a "client ID" siteId: type: string method_specific: type: object properties: insertfollowup: type: object properties: baseUrl: type: string licensekey: type: string required: - baseUrl - licensekey description: The credentials specific to the insertfollowup on the Prospect Management interface. insertprospect: type: object properties: baseUrl: type: string licensekey: type: string required: - baseUrl - licensekey description: The credentials specific to the insertprospect on the Prospect Management interface. insertactivity: type: object properties: baseUrl: type: string licensekey: type: string required: - baseUrl - licensekey description: The credentials specific to the insertactivity on the Prospect Management interface. addresidentactivitylog: type: object properties: baseUrl: type: string licensekey: type: string required: - baseUrl - licensekey description: The credentials specific to the addresidentactivitylog on the Collections interface. postsinglecharge: type: object properties: baseUrl: type: string licensekey: type: string required: - baseUrl - licensekey description: The credentials specific to the postsinglecharge on the Transactions interface. addservicerequest: type: object properties: baseUrl: type: string licensekey: type: string required: - baseUrl - licensekey description: The credentials specific to the addservicerequest on the Facilities interface. getscheduledappointments: type: object properties: baseUrl: type: string licensekey: type: string required: - baseUrl - licensekey description: The credentials specific to the getscheduledappointments on the Prospect Management interface. getfloorplanlist: type: object properties: baseUrl: type: string licensekey: type: string required: - baseUrl - licensekey description: The credentials specific to the getfloorplanlist on the Pricing and Availability interface. prospectsearch: type: object properties: baseUrl: type: string licensekey: type: string required: - baseUrl - licensekey description: The credentials specific to the prospectsearch on the Prospect Management interface. getactivitytypes: type: object properties: baseUrl: type: string licensekey: type: string required: - baseUrl - licensekey description: The credentials specific to the getactivitytypes on the Prospect Management interface. getpicklistprospect: type: object properties: baseUrl: type: string licensekey: type: string required: - baseUrl - licensekey description: The credentials specific to the getpicklistprospect on the Prospect Management interface. getmarketingsourcesbyproperty: type: object properties: baseUrl: type: string licensekey: type: string required: - baseUrl - licensekey description: The credentials specific to the getmarketingsourcesbyproperty on the Prospect Management interface. getleaseinfo: type: object properties: baseUrl: type: string licensekey: type: string required: - baseUrl - licensekey description: The credentials specific to the getleaseinfo on the Convergent Billing interface. getleasingagentsbyproperty: type: object properties: baseUrl: type: string licensekey: type: string required: - baseUrl - licensekey description: The credentials specific to the getleasingagentsbyproperty on the Prospect Management interface. getunitlist: type: object properties: baseUrl: type: string licensekey: type: string required: - baseUrl - licensekey description: The credentials specific to the getunitlist on the Pricing and Availability interface. getsubscriptions: type: object properties: baseUrl: type: string licensekey: type: string required: - baseUrl - licensekey description: The credentials specific to the getsubscriptions on the AppPartner interface. getprospectsurveylist: type: object properties: baseUrl: type: string licensekey: type: string required: - baseUrl - licensekey description: The credentials specific to the getprospectsurveylist on the Survey Interfaces interface. getresidentlistinfo: type: object properties: baseUrl: type: string licensekey: type: string required: - baseUrl - licensekey description: The credentials specific to the getresidentlistinfo on the Resident Management interface. getresidentconvergent: type: object properties: baseUrl: type: string licensekey: type: string required: - baseUrl - licensekey description: The credentials specific to the getresidentconvergent on the Convergent Billing interface. getresidentactivitytypes: type: object properties: baseUrl: type: string licensekey: type: string required: - baseUrl - licensekey description: The credentials specific to the getresidentactivitytypes on the Collections interface. getresidentsactivitylogbydaterange: type: object properties: baseUrl: type: string licensekey: type: string required: - baseUrl - licensekey description: The credentials specific to the getresidentsactivitylogbydaterange on the Resident Management interface. getresidentledger: type: object properties: baseUrl: type: string licensekey: type: string required: - baseUrl - licensekey description: The credentials specific to the getresidentledger on the Transactions interface. transactioncodes: type: object properties: baseUrl: type: string licensekey: type: string required: - baseUrl - licensekey description: The credentials specific to the transactioncodes on the Transactions interface. getservicerequest: type: object properties: baseUrl: type: string licensekey: type: string required: - baseUrl - licensekey description: The credentials specific to the getservicerequest on the Facilities interface. getworkordersurveylist: type: object properties: baseUrl: type: string licensekey: type: string required: - baseUrl - licensekey description: The credentials specific to the getworkordersurveylist on the Survey Interfaces interface. getserviceissuelist: type: object properties: baseUrl: type: string licensekey: type: string required: - baseUrl - licensekey description: The credentials specific to the getserviceissuelist on the Facilities interface. getlocationlist: type: object properties: baseUrl: type: string licensekey: type: string required: - baseUrl - licensekey description: The credentials specific to the getlocationlist on the Facilities interface. getwoprioritylist: type: object properties: baseUrl: type: string licensekey: type: string required: - baseUrl - licensekey description: The credentials specific to the getwoprioritylist on the Facilities interface. getunits: type: object properties: baseUrl: type: string licensekey: type: string required: - baseUrl - licensekey description: The credentials specific to the getunits on the Convergent Billing interface. getunitsbyproperty: type: object properties: baseUrl: type: string licensekey: type: string required: - baseUrl - licensekey description: The credentials specific to the getunitsbyproperty on the Prospect Management interface. unitlist: type: object properties: baseUrl: type: string licensekey: type: string required: - baseUrl - licensekey description: The credentials specific to the unitlist on the Units interface. updateprospect: type: object properties: baseUrl: type: string licensekey: type: string required: - baseUrl - licensekey description: The credentials specific to the updateprospect on the Prospect Management interface. updateservicerequest: type: object properties: baseUrl: type: string licensekey: type: string required: - baseUrl - licensekey description: The credentials specific to the updateservicerequest on the Facilities interface. getagentsappointmenttimes: type: object properties: baseUrl: type: string licensekey: type: string required: - baseUrl - licensekey description: The credentials specific to the getagentsappointmenttimes on the Prospect Management interface. getsitelist: type: object properties: baseUrl: type: string licensekey: type: string required: - baseUrl - licensekey description: The credentials specific to the getsitelist on the AppPartner interface. updatesitesubscriptionstatus: type: object properties: baseUrl: type: string licensekey: type: string required: - baseUrl - licensekey description: The credentials specific to the updatesitesubscriptionstatus on the AppPartner interface. description: If Realpage requires you to have method specific credentials, you can specify them per API method here required: - baseUrl - licensekey description: RealPage Partner Exchange authentication credentials title: RealpagePartnerExchange - type: object properties: apiKey: type: string required: - apiKey description: Knock authentication credentials title: Knock - type: object properties: apiKey: type: string apiSecret: type: string companyId: type: string portfolioId: type: string required: - apiKey - apiSecret - companyId description: Rentvine authentication credentials title: Rentvine - type: object properties: username: type: string password: type: string database: type: string serverName: type: string platform: type: string entity: type: string license: type: string companyId: type: string pattern: ^\w+$ baseUrl: type: string common_data: type: object properties: entity: type: string license: type: string username: type: string password: type: string database: type: string serverName: type: string platform: type: string companyId: type: string pattern: ^\w+$ baseUrl: type: string required: - entity - license description: Specific credentials for the common/resident data interface vendor_invoicing: type: object properties: entity: type: string license: type: string username: type: string password: type: string database: type: string serverName: type: string platform: type: string companyId: type: string pattern: ^\w+$ baseUrl: type: string required: - entity - license description: Specific credentials for the vendor invoicing interface job_cost: type: object properties: entity: type: string license: type: string username: type: string password: type: string database: type: string serverName: type: string platform: type: string companyId: type: string pattern: ^\w+$ baseUrl: type: string required: - entity - license description: Specific credentials for the job cost interface guest_card: type: object properties: entity: type: string license: type: string username: type: string password: type: string database: type: string serverName: type: string platform: type: string companyId: type: string pattern: ^\w+$ baseUrl: type: string required: - entity - license description: Specific credentials for the guest card interface resident_transactions: type: object properties: entity: type: string license: type: string username: type: string password: type: string database: type: string serverName: type: string platform: type: string companyId: type: string pattern: ^\w+$ baseUrl: type: string required: - entity - license description: Specific credentials for the resident transactions interface service_requests: type: object properties: entity: type: string license: type: string username: type: string password: type: string database: type: string serverName: type: string platform: type: string companyId: type: string pattern: ^\w+$ baseUrl: type: string required: - entity - license description: Specific credentials for the service requests interface required: - username - password - database - serverName - platform - entity - license - companyId description: Yardi PMS authentication credentials title: Yardi - type: object properties: username: type: string password: type: string apitoken: type: string interfaceEntity: type: string required: - username - password - apitoken - interfaceEntity description: Yardi REST authentication credentials title: Yardi REST description: JSON encoded credentials for accessing the integration vendor API name: type: string description: The name of the integration system: type: string enum: *a1 description: "Deprecated: Do not use." deprecated: true sync_frequency: type: integer description: 'The interval of the scheduled sync frequency. (e.g. "12" in the following: Sync every 12 HOURs). This value will be used if the use_custom_schedule is set to false.' sync_cadence: type: string enum: - MINUTE - HOUR - DAY - WEEK - MONTH - SECOND description: 'The cadence of the scheduled sync frequency. (e.g. "HOUR" in the following: Sync every 12 HOURs). This value will be used if the use_custom_schedule is set to false.' max_request_cadence: type: string enum: - MINUTE - HOUR - DAY - WEEK - MONTH - SECOND default: SECOND description: 'The cadence at which to limit the max request frequency. (e.g. "SECOND" in the following: 1 request per 2 SECONDs). Requests cannot be made less frequently than once per minute' example: SECOND max_request_frequency: type: number minimum: 1 default: 1 description: 'The maximum number of requests sent to the PMS API per cadence unit. (e.g. "2" in the following: 1 request per 2 SECONDs). Requests cannot be made less frequently than once per minute' example: 1 max_job_concurrency: type: integer maximum: 100 minimum: 1 default: 1 description: 'Maximum number of jobs that can be run at once for the integration. (e.g. "1" in the following: 1 request per 2 SECONDs)' example: 1 active: type: boolean description: The active state of the integration base_url: type: - string - "null" format: uri description: DEPRECATED. See specific PMS credentials for usage. deprecated: true new_properties_are_enabled: type: boolean description: Whether or not properties need to be approved before ingesting data for them. allow_manual_syncs: type: boolean default: true description: "Deprecated: This is no longer configurable and will always be true" deprecated: true custom_sync_schedule: type: object properties: type: type: string enum: - WEEK_BASED timezone: type: string enum: *a3 interval: type: object properties: SUNDAY: &a5 type: object properties: slots: type: array items: type: object properties: start: type: string pattern: (?:[01]\d|2[0123]):(?:[012345]\d) end: type: string pattern: (?:[01]\d|2[0123]):(?:[012345]\d) sync_frequency: type: integer exclusiveMinimum: 0 sync_cadence: type: string enum: - MINUTE - HOUR - DAY - WEEK - MONTH - SECOND required: - start - end - sync_frequency - sync_cadence required: - slots MONDAY: *a5 TUESDAY: *a5 WEDNESDAY: *a5 THURSDAY: *a5 FRIDAY: *a5 SATURDAY: *a5 required: - type - timezone - interval description: A custom sync schedule configuration object use_custom_sync_schedule: type: boolean description: Opt-in to use the configured custom_sync_schedule _v1_admin_integrations_{integration_id}__put_output: type: object properties: result: type: object properties: id: type: string description: The unique identifier for the integration created_at: type: string description: The date the integration was created updated_at: type: string description: The date the integration was last updated name: type: - string - "null" description: The name of the integration integration_vendor: $ref: "#/components/schemas/Enum1" active: type: boolean description: The active state of the integration system: type: string enum: *a1 description: The system the integration is associated with sync_frequency: type: - integer - "null" description: 'Deprecated: See the job schedules endpoint for this information. The interval of the scheduled sync frequency. (e.g. "12" in the following: Sync every 12 HOURs). This value will be used if the use_custom_schedule is set to false.' x-fern-availability: deprecated deprecated: true sync_cadence: type: - string - "null" enum: - MINUTE - HOUR - DAY - WEEK - MONTH - SECOND description: 'Deprecated: See the job schedules endpoint for this information. The cadence of the scheduled sync frequency. (e.g. "HOUR" in the following: Sync every 12 HOURs). This value will be used if the use_custom_schedule is set to false.' x-fern-availability: deprecated deprecated: true max_request_cadence: type: string enum: - MINUTE - HOUR - DAY - WEEK - MONTH - SECOND default: SECOND description: 'The cadence at which to limit the max request frequency. (e.g. "SECOND" in the following: 1 request per 2 SECONDs). Requests cannot be made less frequently than once per minute' example: SECOND max_request_frequency: type: number minimum: 1 default: 10 description: 'The maximum number of requests sent to the PMS API per cadence unit. (e.g. "2" in the following: 1 request per 2 SECONDs). Requests cannot be made less frequently than once per minute' example: 10 max_job_concurrency: type: integer minimum: 1 default: 1 description: 'Maximum number of jobs that can be run at once for the integration. (e.g. "1" in the following: 1 request per 2 SECONDs)' example: 1 base_url: type: - string - "null" description: "DEPRECATED: see specific PMS credentials. Base URL for the integration vendor API" deprecated: true x-fern-availability: deprecated is_archived: type: boolean description: Whether or not the integration is archived new_properties_are_enabled: type: boolean description: Whether or not properties need to be approved before ingesting data for them. allow_manual_syncs: type: boolean default: true description: "Deprecated: This is no longer configurable and will always be true" deprecated: true x-fern-availability: deprecated custom_sync_schedule: type: object properties: type: type: string enum: - WEEK_BASED timezone: type: string enum: *a3 interval: type: object properties: SUNDAY: &a6 type: object properties: slots: type: array items: type: object properties: start: type: string pattern: (?:[01]\d|2[0123]):(?:[012345]\d) end: type: string pattern: (?:[01]\d|2[0123]):(?:[012345]\d) sync_frequency: type: integer exclusiveMinimum: 0 sync_cadence: type: string enum: - MINUTE - HOUR - DAY - WEEK - MONTH - SECOND required: - start - end - sync_frequency - sync_cadence required: - slots MONDAY: *a6 TUESDAY: *a6 WEDNESDAY: *a6 THURSDAY: *a6 FRIDAY: *a6 SATURDAY: *a6 required: - type - timezone - interval use_custom_sync_schedule: type: boolean description: Opt-in to use the configured custom_sync_schedule required: - id - created_at - updated_at - name - integration_vendor - active - system - sync_frequency - sync_cadence - base_url - is_archived - new_properties_are_enabled required: - result _v1_admin_integrations_{integration_id}__delete_input: type: object properties: {} _v1_admin_integrations_{integration_id}__delete_output: type: object properties: success: type: boolean description: Status of integration deletion required: - success _v1_admin_integrations_{integration_id}_back-sync_post_input: type: object properties: sync_config_id: type: string description: The Propexo unique identifier for a sync configuration models_to_sync: type: array items: type: string enum: &a7 - accounting_entities - address_types - amenities - ap_codes - applicant_pets - applicants - application_statuses - applications - call_logs - charge_codes - charge_code_types - charge_timings - concessions - construction_jobs - contracts - deposit_summaries - deposits - employees - event_results - event_sub_types - event_types - events - fees - file_types - financial_accounts - floor_plans - invoice_items - invoices - lead_pets - lead_relationships - lead_sources - leads - lease_services - lease_transfers - leases - listings - locations - note_categories - owners - payable_registers - pet_types - properties - property_lists - property_office_hours - purchase_orders - recurring_resident_charges - rentable_items - resident_allocations - resident_charges - resident_insurance - resident_payments - resident_pets - resident_vehicles - residents - screenings - service_request_categories - service_request_locations - service_request_notes - service_request_priorities - service_request_problems - service_request_statuses - service_request_vendor_categories - service_request_vendor_contacts - service_request_vendors - service_request_vendors_insurance - service_requests - timezones - unit_details - unit_pricing - units - vendor_insurance_coverage_types - vendor_insurance_policy_types - vendor_payment_types description: A list of the specific models to sync. This will only ingest the models specified during the sync and any relational models. For example, requesting "residents" and "leases" will also query their relational data. This can be used for times when only a limited amount of data would like to be synced. If you'd like this as part of your scheduled syncs, please contact Propexo support. _v1_admin_integrations_{integration_id}_back-sync_post_output: type: object properties: result: type: object properties: success: type: boolean required: - success required: - result _v1_admin_integrations_{integration_id}_manual-sync_post_input: type: object properties: sync_config_id: type: string description: The Propexo unique identifier for a sync configuration models_to_sync: type: array items: type: string enum: *a7 description: A list of the specific models to sync. This will only ingest the models specified during the sync and any relational models. For example, requesting "residents" and "leases" will also query their relational data. This can be used for times when only a limited amount of data would like to be synced. If you'd like this as part of your scheduled syncs, please contact Propexo support. _v1_admin_integrations_{integration_id}_manual-sync_post_output: type: object properties: result: type: object properties: success: type: boolean required: - success required: - result _v1_admin_integrations_{integration_id}_data-access_post_input: type: object properties: {} _v1_admin_integrations_{integration_id}_data-access_post_output: type: object properties: result: type: object properties: began_data_access: type: boolean description: Whether or not the data access check was successfully started. required: - began_data_access required: - result _v1_admin_integrations_{integration_id}_data-access_get_input: type: object properties: {} _v1_admin_integrations_{integration_id}_data-access_get_output: type: object properties: result: type: object properties: models: type: object additionalProperties: type: object properties: read: &a8 anyOf: - type: object properties: status: type: string enum: - SUCCESS - FAILED - PROCESSING error_message: type: - string - "null" required: - status - error_message - type: object properties: unsupported: type: boolean required: - unsupported - type: object properties: untested: type: boolean required: - untested create: *a8 update: *a8 last_data_access_check: type: - string - "null" data_access_check_in_process: type: boolean required: - models - last_data_access_check - data_access_check_in_process required: - result _v1_admin_integrations_{integration_id}_properties_get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query _v1_admin_integrations_{integration_id}_properties_get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: type: array items: type: object properties: id: type: string description: ID created_at: type: string description: The date record first entered Propexo integration_id: type: string description: The Propexo unique identifier for the integration property_id: type: string description: The Propexo unique identifier for the property enabled: type: boolean description: Whether the property is enabled and will have data ingested required: - id - created_at - integration_id - property_id - enabled required: - meta - results _v1_admin_integrations_{integration_id}_property-lists_get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query _v1_admin_integrations_{integration_id}_property-lists_get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: type: array items: type: object properties: id: type: string description: ID created_at: type: string description: The date record first entered Propexo integration_id: type: string description: The Propexo unique identifier for the integration property_list_id: type: string description: The Propexo unique identifier for the property list x_property_list_id: type: string description: The external ID from the integration vendor enabled: type: boolean description: Whether the property list is enabled and will have data ingested required: - id - created_at - integration_id - property_list_id - x_property_list_id - enabled required: - meta - results _v1_admin_integrations_{integration_id}_property-lists_post_input: type: object properties: x_property_list_id: type: string description: The external ID from the PMS for the property list. This is not the Propexo ID. You may need to request this value from your customer enabled: type: boolean description: Whether or not we should be syncing data for this property list on this integration required: - x_property_list_id - enabled _v1_admin_integrations_{integration_id}_property-lists_post_output: type: object properties: results: type: object properties: id: type: string description: ID created_at: type: string description: The date record first entered Propexo integration_id: type: string description: The Propexo unique identifier for the integration property_list_id: type: string description: The Propexo unique identifier for the property list x_property_list_id: type: string description: The external ID from the integration vendor enabled: type: boolean description: Whether the property list is enabled and will have data ingested required: - id - created_at - integration_id - property_list_id - x_property_list_id - enabled required: - results _v1_admin_integrations_{integration_id}_job-schedules__get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query _v1_admin_integrations_{integration_id}_job-schedules__get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: type: array items: type: object properties: id: type: string description: The unique identifier for the job schedule integration_id: type: string description: The unique identifier for the integration created_at: type: string description: The date the job schedule was created updated_at: type: string description: The date the job schedule was last updated job_type: type: string description: The name of the job type status: type: string enum: - ACTIVE - INACTIVE description: The status of the job schedule last_run: type: - string - "null" description: The date the job schedule last ran sync_frequency: type: integer description: The sync frequency of the job schedule sync_cadence: type: string enum: - MINUTE - HOUR - DAY - WEEK - MONTH - SECOND description: The sync cadence of the job schedule parameters: type: object properties: {} required: - id - integration_id - created_at - updated_at - job_type - status - last_run - sync_frequency - sync_cadence - parameters required: - meta - results Enum10: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: "" _v1_admin_normalization_{model}_{field}_get_input: type: object properties: integration_id: type: string description: The ID of the integration for which to retrieve custom mappings. If provided, returns integration-specific custom mappings (if they exist). If omitted, returns the default system mappings for the vendor. integration_vendor: $ref: "#/components/schemas/Enum10" required: - integration_vendor _v1_admin_normalization_{model}_{field}_get_output: type: object properties: results: type: object properties: is_custom_mapping: type: boolean description: Whether the mapping has been customized by the user for this specific integration. If true, these are custom user-defined mappings. If false, these are the default system mappings provided by Propexo. mappings: type: object additionalProperties: type: string description: 'Key-value pairs mapping PMS-specific raw values (keys) to normalized Propexo values (values). For example, for lease_status: {"current": "ACTIVE", "former": "INACTIVE", "future": "PENDING"}. These mappings are applied when data is synced from the PMS to normalize enum values to Propexo standards.' default_value: type: string description: The default normalized value to use when a PMS value does not match any key in the mappings. This ensures all values can be normalized even if they are not explicitly mapped. Typically set to values like "OTHER" for catch-all cases. required: - is_custom_mapping - mappings - default_value required: - results _v1_admin_integrations_{integration_id}_properties_batch_put_input: type: object properties: property_configuration_ids: type: array items: type: string minItems: 1 maxItems: 1000 description: Property configuration IDs (enabled_properties) to update; at least one and at most 1000. enabled: type: boolean description: Whether the listed properties should be enabled for syncing. required: - property_configuration_ids - enabled _v1_admin_integrations_{integration_id}_properties_batch_put_output: type: object properties: success: type: boolean required: - success _v1_admin_integrations_{integration_id}_properties_{property_configuration_id}_put_input: type: object properties: enabled: type: boolean description: Whether or not we should be syncing data for this property on this integration. trigger_integration_resync: type: boolean default: false description: Triggers a resync of the integration after updating the property. This request will not trigger a new sync if one is already in progress, and no HTTP failure will be returned in this case. If you need clearer feedback, consider the POST v1/admin/integrations/{id}/manual-sync endpoint as an alternative to using this flag. required: - enabled _v1_admin_integrations_{integration_id}_properties_{property_configuration_id}_put_output: type: object properties: results: type: object properties: id: type: string description: ID created_at: type: string description: The date record first entered Propexo integration_id: type: string description: The Propexo unique identifier for the integration property_id: type: string description: The Propexo unique identifier for the property enabled: type: boolean description: Whether the property is enabled and will have data ingested additional_message: type: string required: - id - created_at - integration_id - property_id - enabled required: - results _v1_admin_integrations_{integration_id}_property-lists_{property_list_configuration_id}_put_input: type: object properties: enabled: type: boolean description: Whether or not we should be syncing data for this property list on this integration. required: - enabled _v1_admin_integrations_{integration_id}_property-lists_{property_list_configuration_id}_put_output: type: object properties: results: type: object properties: id: type: string description: ID created_at: type: string description: The date record first entered Propexo integration_id: type: string description: The Propexo unique identifier for the integration property_list_id: type: string description: The Propexo unique identifier for the property list x_property_list_id: type: string description: The external ID from the integration vendor enabled: type: boolean description: Whether the property list is enabled and will have data ingested required: - id - created_at - integration_id - property_list_id - x_property_list_id - enabled required: - results _v1_admin_integrations_{integration_id}_rate-limits__get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query _v1_admin_integrations_{integration_id}_rate-limits__get_output: type: object properties: results: anyOf: - type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration api_ratelimits: type: array items: type: object properties: api: type: string description: The Entrata API associated with the rate limits updated_at: type: string description: The last time this rate limit was recorded day_limit: type: - integer - "null" description: The maxmimum number of requests per day we can query hour_limit: type: - integer - "null" description: The maxmimum number of requests per hour we can query minute_limit: type: - integer - "null" description: The maxmimum number of requests per minute we can query required: - api - updated_at - day_limit - hour_limit - minute_limit required: - integration_id - api_ratelimits - type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration updated_at: type: string description: The last time this rate limit was recorded minute_limit: type: - integer - "null" description: The maxmimum number of requests per minute we can query required: - integration_id - updated_at - minute_limit required: - results _v1_admin_integrations_{integration_id}_job-schedules_{job_schedule_id}__get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query _v1_admin_integrations_{integration_id}_job-schedules_{job_schedule_id}__get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: type: object properties: id: type: string description: The unique identifier for the job schedule integration_id: type: string description: The unique identifier for the integration created_at: type: string description: The date the job schedule was created updated_at: type: string description: The date the job schedule was last updated job_type: type: string description: The name of the job type status: type: string enum: - ACTIVE - INACTIVE description: The status of the job schedule last_run: type: - string - "null" description: The date the job schedule last ran sync_frequency: type: integer description: The sync frequency of the job schedule sync_cadence: type: string enum: - MINUTE - HOUR - DAY - WEEK - MONTH - SECOND description: The sync cadence of the job schedule parameters: type: object properties: {} required: - id - integration_id - created_at - updated_at - job_type - status - last_run - sync_frequency - sync_cadence - parameters required: - meta - results _v1_amenities__get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query x_id: type: string description: The external ID from the integration vendor location_id: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. property_id: type: string description: The Propexo unique identifier for the property integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" unit_id: type: string description: The Propexo unique identifier for the unit _v1_amenities__get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: type: array items: type: object properties: id: type: string description: The Propexo unique identifier for the amenity created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_listing_id: type: - string - "null" description: The external ID of the listing from the integration vendor x_parent_amenity_id: type: - string - "null" description: The external ID from the integration vendor of the amenity this unit and/or property amenity is associated with x_property_id: type: string description: The external ID of the property from the integration vendor x_unit_id: type: - string - "null" description: 'DEPRECATED: Please use the "units" field to see the associated units with this amenity' deprecated: true x-fern-availability: deprecated cost_in_cents: type: &a9 - number - "null" description: Cost in cents for the amenity example: 100000 custom_data: type: - object - "null" properties: {} description: type: - string - "null" description: Description of the amenity image_urls: type: array items: type: string example: https://loremflickr.com/640/480/apartment is_unit_amenity: type: - boolean - "null" description: Whether the amenity is a unit amenity meta_data: type: - object - "null" properties: {} name_normalized: type: - string - "null" enum: &a10 - ACCENT_WALLS - ACCEPTS_SMOKING - ADDITIONAL_STORAGE - AIR_CON - AIR_CONDITIONING_COMMERCIAL - AIR_CONDITIONING - ALARM - APPLIANCES_INCLUDED - AVAILABILITY_24_HOURS - BALCONY_OR_DECK_OR_PATIO - BALCONY - BASKETBALL_COURT - BEACH_ACCESS - BILINGUAL - BOAT_DOCKS - BROADBAND_INTERNET - BUSINESS_CENTER - CABLE_READY_COMMERCIAL - CABLE_READY - CABLE - CAR_WASH_AREA - CARPET - CARPORT - CEILING_FAN - CHILD_CARE - CLUB_DISCOUNT - CLUB_HOUSE - CONCIERGE - CONFERENCE_ROOM - CONTROLLED_ACCESS - COURTYARD - DISHWASHER - DISPOSAL - DOCK_HIGH_DOORS_OR_LOADING_AVAILABLE - DOOR_ATTENDANT - DOUBLE_SINK_VANITY - DRYER - ELECTRIC - ELEVATOR - FENCED_YARD - FIREPLACE - FITNESS_CENTER - FRAMED_MIRRORS - FREE_WEIGHTS - FREEZER - FURNISHED_AVAILABLE - FURNISHED - GAMING_STATIONS - GARAGE_PARKING - GARAGE - GAS - GATE - GROCERY_SERVICE - GRILL - GROUP_EXERCISE - GUEST_ROOM - HANDICAP_ACCESS - HANDRAILS - HARDWOOD_FLOORS - HEAT_ELECTRIC - HEAT_GAS - HEAT_OIL - HEAT - HEATING - HIGH_SPEED_INTERNET_COMMERCIAL - HIGH_SPEED_INTERNET - HOT_WATER - HOUSE_SITTING - HOUSEKEEPING - INDIVIDUAL_CLIMATE_CONTROL - INTERNET - ISLAND_KITCHEN - JOGGING_WALKING_TRAILS - LAKE_ACCESS - LAKE_FRONT - LAUNDRY - LAUNDRY_ROOM_OR_HOOKUPS - LAUNDRY_ROOM - LANDSCAPING - LIBRARY - LINEN_CLOSET - MEAL_SERVICE - MEDIA_ROOM - MICROWAVE - MULTI_USE_ROOM - NIGHT_PATROL - ON_SITE_MAINTENANCE - ON_SITE_MANAGEMENT - OTHER - OVEN_OR_RANGE - PACKAGE_RECEIVING - PANTRY - PARKING_COMMERCIAL - PARKING - PER_DIEM_ACCEPTED - PETS_ALLOWED - PING_PONG - PLAY_GROUND - POND - POOL - POWER - PRIVATE_BALCONY - PRIVATE_PATIO - RACQUETBALL - REC_ROOM - RECYCLING - REFRIGERATOR - SATELLITE - SAUNA - SECURITY - SEWER - SHORT_TERM_LEASE - SKYLIGHT - SMOKE_FREE - SNOW_REMOVAL - SPA - SPRINKLER_SYSTEM - STORAGE_UNITS - SUNDECK - TELEPHONE - TENNIS_COURT - TILE_FLOORING - TRANSPORTATION - TRASH - TV_LOUNGE - VALET_TRASH - VAULTED_CEILING - VIEW - VINTAGE - VINYL_FLOORING - VOLLEYBALL_COURT - WALK_IN_CLOSETS - WASHER - WATER - WD_HOOKUP - WD_IN_UNIT - WHEEL_CHAIR - WHEELCHAIR_ACCESS - WINDOW_COVERINGS - WIRELESS_INTERNET description: The name associated with the amenity name: type: string description: The name associated with the amenity units: type: array items: type: object properties: amenity_id: type: string description: The Propexo unique identifier for the amenity example: cm2j4ivcv0000eioz6rd365se unit_id: type: string description: The Propexo unique identifier for the unit example: cm2j4jbzf0002eiozdudz9bda cost_in_cents: type: &a11 - number - "null" description: Cost in cents for the amenity on a particular unit example: 100000 required: - amenity_id - unit_id - cost_in_cents x-propexo: &a12 derivedFromModel: units_to_amenity integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" property_id: type: string description: The Propexo unique identifier for the property required: - id - created_at - updated_at - last_seen - x_id - x_listing_id - x_parent_amenity_id - x_property_id - x_unit_id - cost_in_cents - custom_data - description - image_urls - is_unit_amenity - meta_data - name_normalized - name - units - integration_id - integration_vendor - property_id required: - meta - results _v1_amenities__post_input: type: object properties: integration_id: type: string property_id: type: string description: The Propexo unique identifier for the property unit_id: type: string description: The Propexo unique identifier for the unit name: type: string description: The name associated with the amenity description: type: string description: Description of the amenity is_published: type: boolean description: Whether the amenity should be published required: - integration_id _v1_amenities__post_output: type: object properties: job_id: type: string description: The ID of the job created to handle this operation data: type: object properties: {} required: - job_id - data _v1_amenities_{amenity_id}_put_input: type: object properties: name: type: string description: The name associated with the amenity description: type: string description: Description of the amenity is_published: type: boolean description: Whether the amenity should be published _v1_amenities_{amenity_id}_put_output: type: object properties: job_id: type: string description: The ID of the job created to handle this operation data: type: object properties: {} required: - job_id - data _v1_amenities_{amenity_id}_get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query _v1_amenities_{amenity_id}_get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: type: object properties: id: type: string description: The Propexo unique identifier for the amenity created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_listing_id: type: - string - "null" description: The external ID of the listing from the integration vendor x_parent_amenity_id: type: - string - "null" description: The external ID from the integration vendor of the amenity this unit and/or property amenity is associated with x_property_id: type: string description: The external ID of the property from the integration vendor x_unit_id: type: - string - "null" description: 'DEPRECATED: Please use the "units" field to see the associated units with this amenity' deprecated: true x-fern-availability: deprecated cost_in_cents: type: *a9 description: Cost in cents for the amenity example: 100000 custom_data: type: - object - "null" properties: {} description: type: - string - "null" description: Description of the amenity image_urls: type: array items: type: string example: https://loremflickr.com/640/480/apartment is_unit_amenity: type: - boolean - "null" description: Whether the amenity is a unit amenity meta_data: type: - object - "null" properties: {} name_normalized: type: - string - "null" enum: *a10 description: The name associated with the amenity name: type: string description: The name associated with the amenity units: type: array items: type: object properties: amenity_id: type: string description: The Propexo unique identifier for the amenity example: cm2j4ivcv0000eioz6rd365se unit_id: type: string description: The Propexo unique identifier for the unit example: cm2j4jbzf0002eiozdudz9bda cost_in_cents: type: *a11 description: Cost in cents for the amenity on a particular unit example: 100000 required: - amenity_id - unit_id - cost_in_cents x-propexo: *a12 integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" property_id: type: string description: The Propexo unique identifier for the property required: - id - created_at - updated_at - last_seen - x_id - x_listing_id - x_parent_amenity_id - x_property_id - x_unit_id - cost_in_cents - custom_data - description - image_urls - is_unit_amenity - meta_data - name_normalized - name - units - integration_id - integration_vendor - property_id required: - meta - results _v1_amenities_units_{id}_post_input: type: object properties: amenity: type: string description: The amenity name custom_data: type: object properties: {} description: "Deprecated: Field is no longer applicable" deprecated: true integration_id: type: string vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST required: - amenity - integration_id - vendor _v1_amenities_units_{id}_post_output: type: object properties: job_id: type: string description: The ID of the job created to handle this operation data: type: object properties: {} required: - job_id - data _v1_amenities_units_{id}_put_input: type: object properties: features: type: array items: type: string enum: &a15 - CableReady - Microwave - HardwoodFloors - HighSpeedInternet - AirConditioning - Refrigerator - Dishwasher - WalkinClosets - BalconyOrDeckOrPatio - GarageParking - Carport - FencedYard - LaundryRoomOrHookups - Fireplace - CableReadyCommercial - HighSpeedInternetCommercial - AirConditioningCommercial - Heating - OvenOrRange - HeatElectric - HeatGas - HeatOil - PetsAllowed - Balcony - PrivateBalcony - PrivatePatio - Dryer - Heat - WD_Hookup - Washer - AdditionalStorage - Alarm - Carpet - CeilingFan - ControlledAccess - Courtyard - Disposal - DoubleSinkVanity - FramedMirrors - Furnished - Handrails - IndividualClimateControl - IslandKitchen - LinenCloset - Pantry - Satellite - Skylight - TileFlooring - VaultedCeiling - View - VinylFlooring - WheelChair - WindowCoverings description: A list of unit amenities. Any existing amenities associated with the unit that are not submitted in the request will be removed from the unit _v1_amenities_units_{id}_put_output: type: object properties: job_id: type: string description: The ID of the job created to handle this operation data: type: object properties: {} required: - job_id - data _v1_amenities_properties_{id}_post_input: type: object properties: amenity: type: string description: The amenity name custom_data: type: object properties: {} description: "Deprecated: Field is no longer applicable" deprecated: true integration_id: type: string vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST required: - amenity - integration_id - vendor _v1_amenities_properties_{id}_post_output: type: object properties: job_id: type: string description: The ID of the job created to handle this operation data: type: object properties: {} required: - job_id - data _v1_amenities_properties_{id}_put_input: type: object properties: features: type: array items: type: string enum: &a13 - LaundryRoom - WheelchairAccess - DoorAttendant - Elevator - Parking - StorageUnits - Pool - FitnessCenter - TennisCourt - ClubHouse - Power - ParkingCommercial - SprinklerSystem - DockHighDoorsOrLoadingAvailable - Availability24Hours - AccentWalls - BasketballCourt - Bilingual - BoatDocks - BusinessCenter - CarWashArea - ChildCare - ClubDiscount - ConferenceRoom - Concierge - FreeWeights - FurnishedAvailable - GamingStations - Garage - Gate - GroceryService - GroupExercise - GuestRoom - Housekeeping - HouseSitting - JoggingWalkingTrails - LakeFront - LakeAccess - Library - MealService - MediaRoom - MultiUseRoom - NightPatrol - OnSiteMaintenance - OnSiteManagement - PackageReceiving - PerDiemAccepted - PlayGround - Racquetball - RecRoom - Recycling - Sauna - ShortTermLease - SmokeFree - Spa - Sundeck - Transportation - TVLounge - ValetTrash - Vintage - VolleyballCourt - WirelessInternet - HighSpeedInternet description: A list of overall property amenities. Any previously saved values that are not submitted in the update request will be deleted included_in_rent: type: array items: type: string enum: &a14 - Gas - Electric - Trash - Water - HotWater - Telephone - Heat - Cable - AirCon - Satellite - Sewer - BroadbandInternet description: A list of amenities that are included in rent. Any previously saved values that are not submitted in the update request will be deleted _v1_amenities_properties_{id}_put_output: type: object properties: job_id: type: string description: The ID of the job created to handle this operation data: type: object properties: {} required: - job_id - data _v1_amenities_buildium__post_input: type: object properties: {} _v1_amenities_buildium__post_output: type: object properties: {} _v1_amenities_entrata__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration property_id: type: string description: The Propexo unique identifier for the property unit_id: type: string description: The Propexo unique identifier for the unit name: type: string description: The name associated with the amenity description: type: string description: Description of the amenity is_published: type: boolean description: Whether the amenity should be published required: - integration_id - property_id _v1_amenities_entrata__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration property_id: type: string description: The Propexo unique identifier for the property unit_id: type: - string - "null" description: The Propexo unique identifier for the unit name: type: - string - "null" description: The name associated with the amenity description: type: - string - "null" description: Description of the amenity is_published: type: - boolean - "null" description: Whether the amenity should be published required: - integration_id - property_id - unit_id - name - description - is_published required: - meta - result _v1_amenities_entrata_{amenity_id}_put_input: type: object properties: name: type: string description: The name associated with the amenity description: type: string description: Description of the amenity is_published: type: boolean description: Whether the amenity should be published _v1_amenities_entrata_{amenity_id}_put_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: amenity_id: type: string description: The Propexo unique identifier for the amenity name: type: string description: The name associated with the amenity description: type: string description: Description of the amenity is_published: type: boolean description: Whether the amenity should be published required: - amenity_id required: - meta - result _v1_amenities_propertyware__post_input: type: object properties: {} _v1_amenities_propertyware__post_output: type: object properties: {} _v1_amenities_propertyware_{amenity_id}_put_input: type: object properties: {} _v1_amenities_propertyware_{amenity_id}_put_output: type: object properties: {} _v1_amenities_rentvine__post_input: type: object properties: {} _v1_amenities_rentvine__post_output: type: object properties: {} _v1_amenities_rentvine_{id}_put_input: type: object properties: {} _v1_amenities_rentvine_{id}_put_output: type: object properties: {} _v1_amenities_rentmanager_{id}_put_input: type: object properties: {} _v1_amenities_rentmanager_{id}_put_output: type: object properties: {} _v1_amenities_realpage__post_input: type: object properties: {} _v1_amenities_realpage__post_output: type: object properties: {} _v1_amenities_realpage_{id}_put_input: type: object properties: {} _v1_amenities_realpage_{id}_put_output: type: object properties: {} _v1_amenities_realpage_rpx__post_input: type: object properties: {} _v1_amenities_realpage_rpx__post_output: type: object properties: {} _v1_amenities_realpage_rpx_{amenity_id}_put_input: type: object properties: {} _v1_amenities_realpage_rpx_{amenity_id}_put_output: type: object properties: {} _v1_amenities_yardi_{id}_put_input: type: object properties: {} _v1_amenities_yardi_{id}_put_output: type: object properties: {} _v1_amenities_yardi__post_input: type: object properties: {} _v1_amenities_yardi__post_output: type: object properties: {} _v1_amenities_buildium_properties_{id}_put_input: type: object properties: features: type: array items: type: string enum: *a13 description: A list of overall property amenities. Any previously saved values that are not submitted in the update request will be deleted included_in_rent: type: array items: type: string enum: *a14 description: A list of amenities that are included in rent. Any previously saved values that are not submitted in the update request will be deleted required: - features - included_in_rent _v1_amenities_buildium_properties_{id}_put_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: id: type: string description: The Propexo unique identifier for the property features: type: array items: type: string enum: *a13 included_in_rent: type: array items: type: string enum: *a14 required: - id - features - included_in_rent required: - meta - result _v1_amenities_buildium_units_{id}_put_input: type: object properties: features: type: array items: type: string enum: *a15 description: A list of unit amenities. Any existing amenities associated with the unit that are not submitted in the request will be removed from the unit required: - features _v1_amenities_buildium_units_{id}_put_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: id: type: string description: The Propexo unique identifier for the unit features: type: array items: type: string enum: *a15 required: - id - features required: - meta - result _v1_amenities_rentmanager_properties__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration property_id: type: string description: The Propexo unique identifier for the property name: type: string pattern: ^[a-zA-Z0-9\s]+$ description: The name associated with the amenity description: type: string description: Description of the amenity required: - integration_id - property_id - name _v1_amenities_rentmanager_properties__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration property_id: type: string description: The Propexo unique identifier for the property name: type: string pattern: ^[a-zA-Z0-9\s]+$ description: The name associated with the amenity description: type: - string - "null" description: Description of the amenity required: - integration_id - property_id - name - description required: - meta - result _v1_amenities_rentmanager_units__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration unit_id: type: string description: The Propexo unique identifier for the unit name: type: string pattern: ^[a-zA-Z0-9\s]+$ description: The name associated with the amenity description: type: string description: Description of the amenity required: - integration_id - unit_id - name _v1_amenities_rentmanager_units__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration unit_id: type: string description: The Propexo unique identifier for the unit name: type: string pattern: ^[a-zA-Z0-9\s]+$ description: The name associated with the amenity description: type: - string - "null" description: Description of the amenity required: - integration_id - unit_id - name - description required: - meta - result _v1_applicants__get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query x_id: type: string description: The external ID from the integration vendor location_id: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. property_id: type: string description: The Propexo unique identifier for the property integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" email_1: type: string description: The primary email address associated with the applicant phone_1: type: string pattern: ^[2-9]\d{9}$ description: Filter by phone number (10 digit format only) IncomeSource: type: object properties: amount_in_cents: type: - number - "null" description: The total income of the applicant, in cents amount_raw: type: - string - "null" description: The total income amount of the applicant type_normalized: type: - string - "null" description: The type of income of the applicant type_raw: type: - string - "null" description: The type of income of the applicant required: - amount_in_cents - amount_raw - type_normalized - type_raw Applicant: type: object properties: id: type: string description: The Propexo unique identifier for the applicant created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_unit_id: type: - string - "null" description: "DEPRECATED: Use x_unit_id_preferred instead" deprecated: true x-fern-availability: deprecated x_lease_id: type: - string - "null" description: "DEPRECATED: Not in use." deprecated: true x-fern-availability: deprecated x_lead_id: type: - string - "null" description: The external ID of the lead from the integration vendor x_unit_id_preferred: type: array items: type: string address_1_alternate: type: - string - "null" description: The first alternate address line associated with the applicant address_1: type: - string - "null" description: The first address line associated with the applicant address_2_alternate: type: - string - "null" description: The second alternate address line associated with the applicant address_2: type: - string - "null" description: The second address line associated with the applicant applications: type: array items: type: object properties: applicant_id: type: string application_id: type: string status: type: - string - "null" description: DEPRECATED. Use status_raw or status_normalized deprecated: true x-fern-availability: deprecated status_raw: type: - string - "null" description: The raw status associated with the applicant status_normalized: anyOf: - type: string enum: - APPROVED - DENIED - CANCELED - OTHER - PENDING - type: string - type: "null" description: The normalized status associated with the applicant. Confirm these derived values before using them in production. custom_data: type: - object - "null" properties: {} required: - applicant_id - application_id x-propexo: &a295 derivedFromModel: applicants_to_applications city_alternate: type: - string - "null" description: The alternate city associated with the applicant city: type: - string - "null" description: The city associated with the applicant country_alternate: type: - string - "null" description: The alternate country associated with the applicant country: type: - string - "null" description: The country associated with the applicant custom_data: type: - object - "null" properties: {} date_of_birth: type: - string - "null" description: The date of birth associated with the applicant email_1: type: - string - "null" description: The primary email address associated with the applicant email_2: type: - string - "null" description: The secondary email address associated with the applicant first_name: type: - string - "null" description: The first name associated with the applicant self_reported_income: type: array items: $ref: "#/components/schemas/IncomeSource" last_name: type: - string - "null" description: The last name associated with the applicant middle_name: type: - string - "null" description: The middle name associated with the applicant notes: type: - string - "null" description: Notes associated with the applicant phone_1_type: type: - string - "null" enum: - FAX - HOME - MOBILE - OTHER - WORK description: Type of the primary phone number phone_1: type: - string - "null" description: Primary phone number associated with the applicant phone_2_type: type: - string - "null" enum: - FAX - HOME - MOBILE - OTHER - WORK description: Type of the secondary phone number phone_2: type: - string - "null" description: Secondary phone number associated with the applicant state_alternate: type: - string - "null" description: The alternate state associated with the applicant state: type: - string - "null" description: The state associated with the applicant type_normalized: type: - string - "null" description: The normalized type associated with the applicant type_raw: type: - string - "null" description: The raw type associated with the applicant zip_alternate: type: - string - "null" description: The alternate zip code associated with the applicant zip: type: - string - "null" description: The zip code associated with the applicant pets: type: array items: type: object properties: id: type: string description: The Propexo unique identifier for the applicant pet created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor age_in_years: type: - number - "null" description: The age in years of the applicant pet breed: type: - string - "null" description: The breed of the applicant pet color: type: - string - "null" description: The color of the applicant pet gender_raw: type: - string - "null" description: The raw value for the gender of the applicant pet is_declawed: type: - boolean - "null" description: Whether the applicant pet is declawed is_fixed: type: - boolean - "null" description: Whether the applicant pet is fixed is_service_animal: type: - boolean - "null" description: Whether the applicant pet is a service animal is_trained: type: - boolean - "null" description: Whether the applicant pet is trained is_vaccinated: type: - boolean - "null" description: Whether the applicant pet is vaccinated name: type: - string - "null" description: The name associated with the applicant pet notes: type: - string - "null" description: Notes associated with the applicant pet type: type: - string - "null" description: The type associated with the applicant pet weight_in_pounds: type: - number - "null" description: The weight in pounds of the applicant pet custom_data: type: - object - "null" properties: {} required: - id - created_at - updated_at - last_seen - x_id - age_in_years - breed - color - gender_raw - is_declawed - is_fixed - is_service_animal - is_trained - is_vaccinated - name - notes - type - weight_in_pounds - custom_data x-propexo: &a296 derivedFromModel: applicant_pets integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" property_id: type: string description: The Propexo unique identifier for the property unit_id_preferred: type: array items: type: string screenings: type: array items: type: object properties: id: type: string description: The Propexo ID of the screening created_at: type: string description: The date record first entered Propexo last_seen: type: string description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor status_raw: type: - string - "null" description: The status/results of the screening screening_date: type: - string - "null" description: The date the screening took place required: - id - created_at - last_seen - x_id - status_raw - screening_date x-propexo: &a153 derivedFromModel: screenings required: - id - created_at - updated_at - last_seen - x_id - x_property_id - x_unit_id - x_lease_id - x_lead_id - x_unit_id_preferred - address_1_alternate - address_1 - address_2_alternate - address_2 - applications - city_alternate - city - country_alternate - country - custom_data - date_of_birth - email_1 - email_2 - first_name - last_name - middle_name - notes - phone_1_type - phone_1 - phone_2_type - phone_2 - state_alternate - state - type_normalized - type_raw - zip_alternate - zip - pets - integration_id - integration_vendor - property_id - unit_id_preferred - screenings _v1_applicants__get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: type: array items: $ref: "#/components/schemas/Applicant" required: - meta - results _v1_applicants__post_input: type: object properties: integration_id: type: string unit_id: type: string description: The Propexo unique identifier for the unit first_name: type: string description: The first name associated with the applicant last_name: type: string description: The last name associated with the applicant send_rental_application_email: type: boolean default: false description: Whether to send the new applicant an email with a link to the online application form email_1: type: string description: The primary email address associated with the applicant phone_1: type: string description: Primary phone number associated with the applicant phone_1_type: type: string enum: &a16 - FAX - HOME - MOBILE - WORK description: Type of the primary phone number phone_2: type: string description: Secondary phone number associated with the applicant phone_2_type: type: string enum: - FAX - HOME - MOBILE - OTHER - WORK description: Type of the secondary phone number custom_data: type: object properties: {} description: "Deprecated: Field is no longer applicable" deprecated: true property_id: type: string description: The Propexo unique identifier for the property lease_period_id: type: string description: The lease period to use for the application. If supplied, this field must be one of the approved lease periods defined on the Rentvine template. You can see a list of available choices for each application template on the appropriate lease period endpoint. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements or to change the list of available lease periods lead_source_id: type: string description: The Propexo unique identifier for the lead source address_1: type: string description: The first address line associated with the applicant application_status: type: string enum: &a31 - COMPLETED - APPROVED description: The status associated with the application city: type: string description: The city associated with the applicant state: type: string description: The state associated with the applicant zip: type: string description: The zip code associated with the applicant address_2: type: string description: The second address line associated with the applicant attachments: type: array items: type: object properties: file_data: type: string maxLength: 69730304 description: The contents of the file, as a base64 encoded string. The PMS has a max file size of 50 MB. file_name: type: string description: 'The name of the file including the extension. Ex: "image.jpg"' mime_type: type: string description: 'The mime type of the file. Ex: "image/jpeg"' lease_file_type: type: string description: "Deprecated: Use the `file_type_id` field instead. The PMS specific lease file type of the document" file_type_id: type: string description: The Propexo file type ID of the lease file type to upload. Prefer this over the raw input of the lease_file_type. is_private: type: boolean description: If the file should be marked as private. If true the file will not be shown in the resident portal. required: - file_data - file_name - mime_type description: Files to upload for the applicant date_of_birth: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date of birth associated with the applicant events: type: array items: type: object properties: employee_id: type: string description: The Propexo unique identifier for the employee lead_source_id: type: string description: The Propexo unique identifier for the lead source unit_id: type: string description: The Propexo unique identifier for the unit. Only some events use this, including "Show" and "Appointment". event_name: type: string enum: &a44 - CallToProspect - CallFromProspect - Other - WalkIn - Chat - Email - Text - Webservice - Appointment - Show - Application - SelfGuidedTour - Application description: The name or type of event. This has to be from a predefined set of events. event_datetime: type: string format: date-time description: The date when the event will occur notes: type: string maxLength: 256 description: Notes associated with the event reasons_for_event: type: string description: The reasons for the event required: - employee_id - event_name - event_datetime description: A list of events to create for the new applicant move_in_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The move-in date associated with the lease pets: type: array items: type: object properties: name: type: string description: The name associated with the applicant pet. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements type: type: string description: The type associated with the applicant pet (or breed). This field is not configurable on the Rentvine template and is always required age_in_years: type: integer minimum: 0 description: The age in years of the applicant pet. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements weight_in_pounds: type: integer minimum: 0 description: The weight in pounds of the applicant pet. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements is_trained: type: boolean description: Whether the applicant pet is trained. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements color: type: string description: The color of the applicant pet. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements gender: type: string enum: &a17 - MALE - FEMALE - UNSPECIFIED description: The gender of the applicant pet. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements is_declawed: type: boolean description: Whether the applicant pet is declawed. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements is_vaccinated: type: boolean description: Whether the applicant pet is vaccinated. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements is_fixed: type: boolean description: Whether the applicant pet is fixed. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements required: - type description: A list of applicant pets. Depending on the Rentvine template, this array can be customized to be either required or optional. The template may also require a minimum number of items in the array in order to pass validation. You will need to work with your customer directly to configure this field to your application requirements vehicles: type: array items: type: object properties: make: type: string description: The make of the vehicle. This field is not configurable on the Rentvine template and is always required model: type: string description: The model of the vehicle. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements year: type: integer description: The year the vehicle was made. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements color: type: string description: The color of the vehicle. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements license_plate_number: type: string description: The license plate number of the vehicle. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements license_plate_state: type: string description: The issuing state of the license plate. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements monthly_payment_in_cents: type: integer minimum: 0 description: If the vehicle is leased or financed, the applicant's monthly payment for the vehicle in cents. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements insurance_carrier: type: string description: The insurance carrier for the applicant's vehicle. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements required: - make description: A list of vehicles for the application. Depending on the Rentvine template, this array can be customized to be either required or optional. The template may also require a minimum number of items in the array in order to pass validation. You will need to work with your customer directly to configure this field to your application requirements employment_history: type: array items: type: object properties: is_current_employer: type: boolean description: Whether this employment history entry is for a current employer. This field is not configurable on the Rentvine template and is always required name: type: string description: The name of the employer. This field is not configurable on the Rentvine template and is always required phone: type: string pattern: ^\+?\d{1,50}$ description: The phone number of the employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements address_1: type: string description: The first line of the address of the employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements address_2: type: string description: The second line of the address of the employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements city: type: string description: The city of the address of the employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements state: type: string description: The state of the address of the employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements zip: type: string description: The zip code of the address of the employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements country: type: string description: The country of the address of the employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements supervisor_first_name: type: string description: The first name of the applicant's supervisor at this employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements supervisor_last_name: type: string description: The last name of the applicant's supervisor at this employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements supervisor_title: type: string description: The title of the applicant's supervisor at this employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements supervisor_phone: type: string pattern: ^\+?\d{1,50}$ description: The phone number of the applicant's supervisor at this employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements supervisor_email: type: string format: email description: The email of the applicant's supervisor at this employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements position: type: string description: The position held at this employer, or the job description of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements monthly_income_in_cents: type: integer minimum: 0 description: "The monthly income of the applicant at this employer in cents. This field is not configurable on the Rentvine template and is always required. DEPRECATED: Use income_in_cents instead" deprecated: true income_in_cents: type: integer minimum: 0 description: The monthly income of the applicant at this employer in cents. This field is not configurable on the Rentvine template and is always required start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The start date of the applicant's employment at this employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The end date of the applicant's employment at this employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements required: - is_current_employer - name description: The employment history of the applicant. Depending on the Rentvine template, this array can be customized to be either required or optional. The template may also require a minimum number of items in the array in order to pass validation. You will need to work with your customer directly to configure this field to your application requirements add_ons: type: array items: type: object properties: rentable_item_id: type: string description: The Propexo unique identifier for the rentable item employee_id: type: string description: The Propexo unique identifier for the employee start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The start date associated with the employee end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The end date associated with the employee required: - rentable_item_id - employee_id description: Add-ons of the applicant address_type_id: type: string description: The Propexo unique identifier for the address type target_move_in_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The move-in date associated with the lead. The timestamp will be stripped off and only the date will be used desired_num_bedrooms: type: number description: The desired number of bedrooms desired_num_bathrooms: type: string description: The desired number of bathrooms desired_lease_term_in_months: type: string description: The amount of months for the lease term number_of_occupants: type: number description: The number of occupants for the applicant notes: type: string description: Notes associated with the applicant applicant_status: type: string enum: &a38 - APPLICANT - CO_APPLICANT - OCCUPANT description: The status of the applicant. This is optional and defaults to ACTIVE. middle_name: type: string description: The middle name associated with the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements application_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The application date associated with the applicant application_template_id: type: string description: "The Propexo unique identifier for the application template. The Rentvine application template dynamically defines which fields are required for each applicant/application: whether a field is active, disabled, required, or optional. A template may also allow some enums to be modified or for entire fields to be relabeled/repurposed. The functionality of a template is extensive and will likely require that you work with your customer to define a custom template for your application use case" leasing_agent_first_name: type: string description: The first name of the leasing agent. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements leasing_agent_last_name: type: string description: The last name of the leasing agent. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements leasing_agent_contact_info: type: string description: The contact info for the leasing agent. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements rent_amount_in_cents: type: integer minimum: 0 description: The rent amount in cents that the applicant will pay for the unit. This field is not configurable on the Rentvine template and is always required security_deposit_in_cents: type: integer minimum: 0 description: The security deposit in cents that the applicant will pay for the unit. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements type: type: string enum: &a18 - APPLICANT - CO_APPLICANT - OCCUPANT - GUARANTOR description: The type of applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements. Although the field itself can be made optional/required, the value must be one of the available choices and cannot be modified as part of the template marital_status: type: string enum: &a19 - SINGLE - MARRIED - ENGAGED - SEPARATED - DIVORCED - WIDOWED - UNMARRIED_PARTNERS description: The marital status of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements. Although the field itself can be made optional/required, the value must be one of the available choices and cannot be modified as part of the template maiden_name: type: string description: The maiden name or birth name of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements height: type: string description: The height of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements weight: type: string description: The weight of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements eye_color: type: string description: The eye color of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements hair_color: type: string description: The hair color of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements phone_3: type: string pattern: ^\+?\d{1,50}$ description: Third phone number associated with the applicant. An applicant can have no more than one of each phone type. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements phone_3_type: type: string enum: &a20 - HOME - WORK - MOBILE description: Type of the third phone number. An applicant can have no more than one of each phone type. identification_number: type: string description: The Social Security Number or Individual Taxpayer Identification Number associated with the applicant. Rentvine uses a pre-2011 validation scheme for SSN's meaning that some valid SSNs will be incorrectly rejected. Reach out to support if you find that a valid SSN is being rejected. This field is not configurable on the Rentvine template and is always required citizenship: type: string description: The country of citizenship of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements place_of_birth: type: string description: The place of birth of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements passport_number: type: string description: The passport number of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements student_id: type: string description: The student ID number of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements drivers_license_number: type: string description: The driver's license number of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements drivers_license_state: type: string description: The issuing state of the applicant's driver's license. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements lead_source: type: string description: The name of the source of the lead or how the applicant heard of the property management company. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements emergency_contacts: type: array items: type: object properties: first_name: type: string description: The first name of the emergency contact. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements last_name: type: string description: The last name of the emergency contact. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements relationship: type: string description: The relationship of the emergency contact to the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements address_1: type: string description: The first line of the address of the emergency contact. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements address_2: type: string description: The second line of the address of the emergency contact. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements city: type: string description: The city of the address of the emergency contact. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements state: type: string description: The state of the address of the emergency contact. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements zip: type: string description: The zip code of the address of the emergency contact. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements country: type: string description: The country of the address of the emergency contact. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements phone_1: type: string pattern: ^\+?\d{1,50}$ description: The phone number of the emergency contact. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements phone_2: type: string pattern: ^\+?\d{1,50}$ description: The second phone number of the emergency contact. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements email_1: type: string format: email description: The email of the emergency contact. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements description: A list of emergency contacts for the applicant. Depending on the Rentvine template, this array can be customized to be either required or optional. The template may also require a minimum number of items in the array in order to pass validation. You will need to work with your customer directly to configure this field to your application requirements application_references: type: array items: type: object properties: first_name: type: string description: The first name of the applicant's reference. This field is not configurable on the Rentvine template and is always required last_name: type: string description: The last name of the applicant's reference. This field is not configurable on the Rentvine template and is always required relationship: type: string description: The relationship of the applicant's reference to the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements address_1: type: string description: The first line of the address of the applicant's reference. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements address_2: type: string description: The second line of the address of the applicant's reference. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements city: type: string description: The city of the address of the applicant's reference. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements state: type: string description: The state of the address of the applicant's reference. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements zip: type: string description: The zip code of the address of the applicant's reference. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements country: type: string description: The country of the address of the applicant's reference. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements phone_1: type: string pattern: ^\+?\d{1,50}$ description: The phone number of the applicant's reference. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements required: - first_name - last_name description: A list of applicant references for the application. Depending on the Rentvine template, this array can be customized to be either required or optional. The template may also require a minimum number of items in the array in order to pass validation. You will need to work with your customer directly to configure this field to your application requirements other_occupants: type: array items: type: object properties: first_name: type: string description: The first name of the occupant. This field is not configurable on the Rentvine template and is always required last_name: type: string description: The last name of the occupant. This field is not configurable on the Rentvine template and is always required date_of_birth: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date of birth of the occupant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements relationship: type: string enum: &a21 - OTHER description: The relationship of the occupant to the applicant. The only allowed value is "OTHER" and is used to represent non-applicants under 18 years old. Contact Propexo Support if you need to support a workflow that allows adding additional applicants to an application relationship_detail: type: string description: The relationship detail of the occupant to the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements required: - first_name - last_name - relationship description: A list of other occupants who will live in the unit, such as children, etc. Depending on the Rentvine template, this array can be customized to be either required or optional. The template may also require a minimum number of items in the array in order to pass validation. You will need to work with your customer directly to configure this field to your application requirements. Do not include any applicants in this list. If your application use case requires creating multiple applicants in the same application, please reach out to Propexo Support for help. address_history: type: array items: type: object properties: address_1: type: string description: The first address line associated with the applicant's historical address. This field is not configurable on the Rentvine template and is always required address_2: type: string description: The second address line associated with the applicant's historical address. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements city: type: string description: The city associated with the applicant's historical address. This field is not configurable on the Rentvine template and is always required state: type: string enum: &a22 - AB - BC - MB - NB - NL - NT - NS - NU - ON - PE - QC - SK - YT - AL - AK - AS - AZ - AR - AA - AE - AP - CA - CO - CT - DE - DC - FL - GA - GU - HI - ID - IL - IN - IA - KS - KY - LA - ME - MD - MA - MI - MN - MS - MO - MT - NE - NV - NH - NJ - NM - NY - NC - ND - MP - OH - OK - OR - PA - PR - RI - SC - SD - TN - TX - UM - UT - VT - VI - VA - WA - WV - WI - WY description: The state associated with the applicant's historical address. This field is not configurable on the Rentvine template and is always required zip: type: string description: The zip code associated with the applicant's historical address. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements country: type: string enum: &a23 - US - CA description: The country associated with the applicant's historical address. This field is not configurable on the Rentvine template and is always required. If your application needs to support submitting an applicant who previously or currently reside(s) in another country, please reach out to Propexo Support for help address_type: type: string enum: &a24 - OWN - RENT description: Whether the applicant previously owned or rented at this address. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements monthly_payment_in_cents: type: integer minimum: 0 description: For the applicant's historical address, the applicant's monthly payment for rent or mortgage in cents. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements move_in_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date when the applicant moved into this historical address. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements move_out_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date when the applicant moved out of this address. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements. Leave out this field to indicate that the given array item is the applicant's current address. At least one address in this array (the current address) is required. manager_name: type: string description: The name of a property manager who works at this address. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements manager_phone: type: string pattern: ^\+?\d{1,50}$ description: The phone number of a property manager who works at this address. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements manager_email: type: string format: email description: The email of a property manager who works at this address. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements reason_for_leaving: type: string description: The reason the applicant decided to leave this address. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements manager_type: type: string enum: &a25 - LANDLORD - PROPERTY_MANAGER - RELATIVE - FRIEND - APARTMENT description: The type of property manager who works at this address. This field is ignored for the current address. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements required: - address_1 - city - state - zip - country minItems: 1 description: The address history of the applicant. At least one address (the current address) must be provided. Note that Rentvine allows configuring different application template requirements for the current address vs. historical addresses. Depending on the Rentvine template, this array can be customized to be either required or optional. The template may also require a minimum number of items in the array in order to pass validation. You will need to work with your customer directly to configure this field to your application requirements. Assuming that a minimum number of addresses are required in the application template, the current address does not count towards the minimum number other_income: type: array items: type: object properties: source: type: string description: The source of the income for the applicant. This field is not configurable on the Rentvine template and is always required monthly_income_in_cents: type: integer minimum: 0 description: The monthly income from this income source in cents. This field is not configurable on the Rentvine template and is always required phone: type: string pattern: ^\+?\d{1,50}$ description: The phone number related to this income source to use for income verification. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements required: - source - monthly_income_in_cents description: A list of other income sources for the applicant. Depending on the Rentvine template, this array can be customized to be either required or optional. The template may also require a minimum number of items in the array in order to pass validation. You will need to work with your customer directly to configure this field to your application requirements bank_accounts: type: array items: type: object properties: name: type: string description: The name of the bank where the account is held. This field is not configurable on the Rentvine template and is always required account_type: type: string enum: &a26 - SAVINGS - CHECKING description: The type of bank account. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements account_number: type: string description: The account number of the bank account. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements balance_in_cents: type: integer minimum: 0 description: The current balance of the bank account in cents. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements required: - name description: A list of bank accounts for the applicant. Depending on the Rentvine template, this array can be customized to be either required or optional. The template may also require a minimum number of items in the array in order to pass validation. You will need to work with your customer directly to configure this field to your application requirements credit_cards: type: array items: type: object properties: name: type: string description: The name of the bank or issuer of the credit card. This field is not configurable on the Rentvine template and is always required balance_in_cents: type: integer minimum: 0 description: The current balance of the credit card in cents. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements required: - name description: A list of credit cards for the applicant. Depending on the Rentvine template, this array can be customized to be either required or optional. The template may also require a minimum number of items in the array in order to pass validation. You will need to work with your customer directly to configure this field to your application requirements assistance: type: object properties: agency_name: type: string description: The name of the agency who is providing assistance for the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements county: type: string description: The county where the agency is located. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements technician_name: type: string description: The name of the agency's contact assigned to support the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements phone: type: string pattern: ^\+?\d{1,50}$ description: The phone number of the agency or of the agency's contact. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements assistance_amount_in_cents: type: integer minimum: 0 description: The amount of assistance for the applicant in cents. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements beds_allowed: type: string description: The number of beds allowed for the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements are_utilities_covered: type: boolean description: Whether utilities are covered for the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements description: Details for payment assistance for the applicant. Depending on the Rentvine template, this array can be customized to be either required or optional. The template may also require a minimum number of items in the array in order to pass validation. You will need to work with your customer directly to configure this field to your application requirements application_id: type: string description: Optionally, the Propexo unique identifier for the application onto which you'd like to add this applicant. If omitted, Rentvine will create a new application for this applicant. lead_id: type: string description: The Propexo unique identifier for the lead start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The start date associated with the lease end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The end date associated with the lease status: type: string enum: &a47 - PENDING - APPROVED - CANCELED - DENIED - SIGNED description: The status associated with the application rent_amount_market_in_cents: type: integer description: The market rent amount in cents for the lease employee_id: type: string description: The Propexo unique identifier for the employee third_party_id: type: string minLength: 1 description: A unique value provided to the PMS to uniquely identify the applicant from your system. organization_name: type: string description: The name of your organization. Yardi uses this for associating a applicant required: - integration_id _v1_applicants__post_output: type: object properties: job_id: type: string description: The ID of the job created to handle this operation data: type: object properties: {} required: - job_id - data _v1_applicants_{id}_get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query _v1_applicants_{id}_get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: $ref: "#/components/schemas/Applicant" required: - meta - results _v1_applicants_{id}_put_input: type: object properties: last_name: type: string description: The last name associated with the applicant first_name: type: string description: The first name associated with the applicant unit_id: type: string description: The Propexo unique identifier for the unit email_1: type: string description: The primary email address associated with the applicant phone_1: type: string description: Primary phone number associated with the applicant phone_1_type: type: string enum: *a16 description: Type of the primary phone number phone_2: type: string description: Secondary phone number associated with the applicant phone_2_type: type: string enum: - FAX - HOME - MOBILE - OTHER - WORK description: Type of the secondary phone number applicant_id: type: string description: The Propexo unique identifier for the applicant application_id: type: string description: The Propexo unique identifier for the application lease_period_id: type: string description: The lease period to use for the application. If supplied, this field must be one of the approved lease periods defined on the Rentvine template. You can see a list of available choices for each application template on the appropriate lease period endpoint. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements or to change the list of available lease periods lead_source_id: type: string description: The Propexo unique identifier for the lead source address_1: type: string description: The first address line associated with the applicant address_2: type: string description: The second address line associated with the applicant application_status: type: string enum: &a36 - COMPLETED - APPROVED description: The status associated with the application attachments: type: array items: type: object properties: file_data: type: string maxLength: 69730304 description: The contents of the file, as a base64 encoded string. The PMS has a max file size of 50 MB. file_name: type: string description: 'The name of the file including the extension. Ex: "image.jpg"' mime_type: type: string description: 'The mime type of the file. Ex: "image/jpeg"' lease_file_type: type: string description: "Deprecated: Use the `file_type_id` field instead. The PMS specific lease file type of the document" file_type_id: type: string description: The Propexo file type ID of the lease file type to upload. Prefer this over the raw input of the lease_file_type. is_private: type: boolean description: If the file should be marked as private. If true the file will not be shown in the resident portal. required: - file_data - file_name - mime_type description: Files to upload for the applicant. All the files can have a maximum combined file size of 50 MB city: type: string description: The city associated with the applicant create_new_events_only: anyOf: - type: boolean - type: string description: Whether or not new events should be created on the applicant date_of_birth: type: string format: date-time description: The date of birth associated with the applicant events: type: array items: type: object properties: unit_id: type: string description: The Propexo unique identifier for the unit x_type_id: type: string description: The PMS id for the event type. x_leasing_agent_id: type: string description: The PMS id for the leasing agent. x_sub_type_id: type: string description: The PMS id for the event sub type. x_result_id: type: string description: The PMS id for the event result. event_datetime: type: string format: date-time description: The date and time that the event occured. appointment_datetime: type: string format: date-time description: The date and time that the appointment will occur. Required if using appointment type. time_from: type: string time_to: type: string notes: type: string description: General notes about the event. title: type: string description: Title for the event. reasons_for_event: type: string description: The reason the event occurred. id: type: string description: The Propexo unique identifier for the event. Only required if attempting to update an existing event. required: - x_type_id description: "DEPRECATED: Please use /events endpoints to write events. Array of events associated with this applicant" deprecated: true move_in_date: type: string format: date-time description: The move-in date associated with the lease state: type: string description: The state associated with the applicant zip: type: string description: The zip code associated with the applicant pets: type: array items: type: object properties: name: type: string description: The name associated with the applicant pet. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements type: type: string description: The type associated with the applicant pet (or breed). This field is not configurable on the Rentvine template and is always required age_in_years: type: integer minimum: 0 description: The age in years of the applicant pet. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements weight_in_pounds: type: integer minimum: 0 description: The weight in pounds of the applicant pet. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements is_trained: type: boolean description: Whether the applicant pet is trained. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements color: type: string description: The color of the applicant pet. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements gender: type: string enum: *a17 description: The gender of the applicant pet. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements is_declawed: type: boolean description: Whether the applicant pet is declawed. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements is_vaccinated: type: boolean description: Whether the applicant pet is vaccinated. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements is_fixed: type: boolean description: Whether the applicant pet is fixed. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements required: - type description: A list of applicant pets. Depending on the Rentvine template, this array can be customized to be either required or optional. The template may also require a minimum number of items in the array in order to pass validation. You will need to work with your customer directly to configure this field to your application requirements vehicles: type: array items: type: object properties: make: type: string description: The make of the vehicle. This field is not configurable on the Rentvine template and is always required model: type: string description: The model of the vehicle. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements year: type: integer description: The year the vehicle was made. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements color: type: string description: The color of the vehicle. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements license_plate_number: type: string description: The license plate number of the vehicle. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements license_plate_state: type: string description: The issuing state of the license plate. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements monthly_payment_in_cents: type: integer minimum: 0 description: If the vehicle is leased or financed, the applicant's monthly payment for the vehicle in cents. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements insurance_carrier: type: string description: The insurance carrier for the applicant's vehicle. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements required: - make description: A list of vehicles for the application. Depending on the Rentvine template, this array can be customized to be either required or optional. The template may also require a minimum number of items in the array in order to pass validation. You will need to work with your customer directly to configure this field to your application requirements employment_history: type: array items: type: object properties: is_current_employer: type: boolean description: Whether this employment history entry is for a current employer. This field is not configurable on the Rentvine template and is always required name: type: string description: The name of the employer. This field is not configurable on the Rentvine template and is always required phone: type: string pattern: ^\+?\d{1,50}$ description: The phone number of the employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements address_1: type: string description: The first line of the address of the employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements address_2: type: string description: The second line of the address of the employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements city: type: string description: The city of the address of the employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements state: type: string description: The state of the address of the employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements zip: type: string description: The zip code of the address of the employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements country: type: string description: The country of the address of the employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements supervisor_first_name: type: string description: The first name of the applicant's supervisor at this employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements supervisor_last_name: type: string description: The last name of the applicant's supervisor at this employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements supervisor_title: type: string description: The title of the applicant's supervisor at this employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements supervisor_phone: type: string pattern: ^\+?\d{1,50}$ description: The phone number of the applicant's supervisor at this employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements supervisor_email: type: string format: email description: The email of the applicant's supervisor at this employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements position: type: string description: The position held at this employer, or the job description of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements monthly_income_in_cents: type: integer minimum: 0 description: "The monthly income of the applicant at this employer in cents. This field is not configurable on the Rentvine template and is always required. DEPRECATED: Use income_in_cents instead" deprecated: true income_in_cents: type: integer minimum: 0 description: The monthly income of the applicant at this employer in cents. This field is not configurable on the Rentvine template and is always required start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The start date of the applicant's employment at this employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The end date of the applicant's employment at this employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements required: - is_current_employer - name description: The employment history of the applicant. Depending on the Rentvine template, this array can be customized to be either required or optional. The template may also require a minimum number of items in the array in order to pass validation. You will need to work with your customer directly to configure this field to your application requirements add_ons: type: array items: type: object properties: rentable_item_id: type: string description: The Propexo unique identifier for the rentable item employee_id: type: string description: The Propexo unique identifier for the employee start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The start date associated with the employee end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The end date associated with the employee required: - rentable_item_id - employee_id description: Add-ons of the applicant. These will be added as new add-ons for the applicant address_type_id: type: string description: The Propexo unique identifier for the address type. This is required when updating the address target_move_in_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The target move in date for the applicant desired_num_bedrooms: type: number description: The desired number of bedrooms desired_num_bathrooms: type: string description: The desired number of bathrooms desired_lease_term_in_months: type: number description: The desired lease term in months of the applicant number_of_occupants: type: number description: The number of occupants for the applicant notes: type: string description: Notes associated with the applicant applicant_status: type: string enum: &a40 - APPLICANT - CO_APPLICANT - OCCUPANT description: The status of the applicant. This is optional and defaults to ACTIVE. middle_name: type: string description: The middle name associated with the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements country: type: string description: The country associated with the applicant integration_id: type: string description: The Propexo unique identifier for the integration application_template_id: type: string description: "The Propexo unique identifier for the application template. The Rentvine application template dynamically defines which fields are required for each applicant/application: whether a field is active, disabled, required, or optional. A template may also allow some enums to be modified or for entire fields to be relabeled/repurposed. The functionality of a template is extensive and will likely require that you work with your customer to define a custom template for your application use case" leasing_agent_first_name: type: string description: The first name of the leasing agent. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements leasing_agent_last_name: type: string description: The last name of the leasing agent. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements leasing_agent_contact_info: type: string description: The contact info for the leasing agent. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements rent_amount_in_cents: type: integer minimum: 0 description: The rent amount in cents that the applicant will pay for the unit. This field is not configurable on the Rentvine template and is always required security_deposit_in_cents: type: integer minimum: 0 description: The security deposit in cents that the applicant will pay for the unit. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements type: type: string enum: *a18 description: The type of applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements. Although the field itself can be made optional/required, the value must be one of the available choices and cannot be modified as part of the template marital_status: type: string enum: *a19 description: The marital status of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements. Although the field itself can be made optional/required, the value must be one of the available choices and cannot be modified as part of the template maiden_name: type: string description: The maiden name or birth name of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements height: type: string description: The height of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements weight: type: string description: The weight of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements eye_color: type: string description: The eye color of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements hair_color: type: string description: The hair color of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements phone_3: type: string pattern: ^\+?\d{1,50}$ description: Third phone number associated with the applicant. An applicant can have no more than one of each phone type. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements phone_3_type: type: string enum: *a20 description: Type of the third phone number. An applicant can have no more than one of each phone type. identification_number: type: string description: The Social Security Number or Individual Taxpayer Identification Number associated with the applicant. Rentvine uses a pre-2011 validation scheme for SSN's meaning that some valid SSNs will be incorrectly rejected. Reach out to support if you find that a valid SSN is being rejected. This field is not configurable on the Rentvine template and is always required citizenship: type: string description: The country of citizenship of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements place_of_birth: type: string description: The place of birth of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements passport_number: type: string description: The passport number of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements student_id: type: string description: The student ID number of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements drivers_license_number: type: string description: The driver's license number of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements drivers_license_state: type: string description: The issuing state of the applicant's driver's license. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements lead_source: type: string description: The name of the source of the lead or how the applicant heard of the property management company. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements emergency_contacts: type: array items: type: object properties: first_name: type: string description: The first name of the emergency contact. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements last_name: type: string description: The last name of the emergency contact. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements relationship: type: string description: The relationship of the emergency contact to the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements address_1: type: string description: The first line of the address of the emergency contact. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements address_2: type: string description: The second line of the address of the emergency contact. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements city: type: string description: The city of the address of the emergency contact. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements state: type: string description: The state of the address of the emergency contact. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements zip: type: string description: The zip code of the address of the emergency contact. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements country: type: string description: The country of the address of the emergency contact. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements phone_1: type: string pattern: ^\+?\d{1,50}$ description: The phone number of the emergency contact. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements phone_2: type: string pattern: ^\+?\d{1,50}$ description: The second phone number of the emergency contact. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements email_1: type: string format: email description: The email of the emergency contact. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements description: A list of emergency contacts for the applicant. Depending on the Rentvine template, this array can be customized to be either required or optional. The template may also require a minimum number of items in the array in order to pass validation. You will need to work with your customer directly to configure this field to your application requirements application_references: type: array items: type: object properties: first_name: type: string description: The first name of the applicant's reference. This field is not configurable on the Rentvine template and is always required last_name: type: string description: The last name of the applicant's reference. This field is not configurable on the Rentvine template and is always required relationship: type: string description: The relationship of the applicant's reference to the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements address_1: type: string description: The first line of the address of the applicant's reference. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements address_2: type: string description: The second line of the address of the applicant's reference. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements city: type: string description: The city of the address of the applicant's reference. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements state: type: string description: The state of the address of the applicant's reference. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements zip: type: string description: The zip code of the address of the applicant's reference. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements country: type: string description: The country of the address of the applicant's reference. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements phone_1: type: string pattern: ^\+?\d{1,50}$ description: The phone number of the applicant's reference. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements required: - first_name - last_name description: A list of applicant references for the application. Depending on the Rentvine template, this array can be customized to be either required or optional. The template may also require a minimum number of items in the array in order to pass validation. You will need to work with your customer directly to configure this field to your application requirements other_occupants: type: array items: type: object properties: first_name: type: string description: The first name of the occupant. This field is not configurable on the Rentvine template and is always required last_name: type: string description: The last name of the occupant. This field is not configurable on the Rentvine template and is always required date_of_birth: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date of birth of the occupant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements relationship: type: string enum: *a21 description: The relationship of the occupant to the applicant. The only allowed value is "OTHER" and is used to represent non-applicants under 18 years old. Contact Propexo Support if you need to support a workflow that allows adding additional applicants to an application relationship_detail: type: string description: The relationship detail of the occupant to the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements required: - first_name - last_name - relationship description: A list of other occupants who will live in the unit, such as children, etc. Depending on the Rentvine template, this array can be customized to be either required or optional. The template may also require a minimum number of items in the array in order to pass validation. You will need to work with your customer directly to configure this field to your application requirements. Do not include any applicants in this list. If your application use case requires creating multiple applicants in the same application, please reach out to Propexo Support for help. address_history: type: array items: type: object properties: address_1: type: string description: The first address line associated with the applicant's historical address. This field is not configurable on the Rentvine template and is always required address_2: type: string description: The second address line associated with the applicant's historical address. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements city: type: string description: The city associated with the applicant's historical address. This field is not configurable on the Rentvine template and is always required state: type: string enum: *a22 description: The state associated with the applicant's historical address. This field is not configurable on the Rentvine template and is always required zip: type: string description: The zip code associated with the applicant's historical address. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements country: type: string enum: *a23 description: The country associated with the applicant's historical address. This field is not configurable on the Rentvine template and is always required. If your application needs to support submitting an applicant who previously or currently reside(s) in another country, please reach out to Propexo Support for help address_type: type: string enum: *a24 description: Whether the applicant previously owned or rented at this address. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements monthly_payment_in_cents: type: integer minimum: 0 description: For the applicant's historical address, the applicant's monthly payment for rent or mortgage in cents. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements move_in_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date when the applicant moved into this historical address. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements move_out_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date when the applicant moved out of this address. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements. Leave out this field to indicate that the given array item is the applicant's current address. At least one address in this array (the current address) is required. manager_name: type: string description: The name of a property manager who works at this address. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements manager_phone: type: string pattern: ^\+?\d{1,50}$ description: The phone number of a property manager who works at this address. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements manager_email: type: string format: email description: The email of a property manager who works at this address. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements reason_for_leaving: type: string description: The reason the applicant decided to leave this address. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements manager_type: type: string enum: *a25 description: The type of property manager who works at this address. This field is ignored for the current address. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements required: - address_1 - city - state - zip - country minItems: 1 description: The address history of the applicant. At least one address (the current address) must be provided. Note that Rentvine allows configuring different application template requirements for the current address vs. historical addresses. Depending on the Rentvine template, this array can be customized to be either required or optional. The template may also require a minimum number of items in the array in order to pass validation. You will need to work with your customer directly to configure this field to your application requirements. Assuming that a minimum number of addresses are required in the application template, the current address does not count towards the minimum number other_income: type: array items: type: object properties: source: type: string description: The source of the income for the applicant. This field is not configurable on the Rentvine template and is always required monthly_income_in_cents: type: integer minimum: 0 description: The monthly income from this income source in cents. This field is not configurable on the Rentvine template and is always required phone: type: string pattern: ^\+?\d{1,50}$ description: The phone number related to this income source to use for income verification. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements required: - source - monthly_income_in_cents description: A list of other income sources for the applicant. Depending on the Rentvine template, this array can be customized to be either required or optional. The template may also require a minimum number of items in the array in order to pass validation. You will need to work with your customer directly to configure this field to your application requirements bank_accounts: type: array items: type: object properties: name: type: string description: The name of the bank where the account is held. This field is not configurable on the Rentvine template and is always required account_type: type: string enum: *a26 description: The type of bank account. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements account_number: type: string description: The account number of the bank account. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements balance_in_cents: type: integer minimum: 0 description: The current balance of the bank account in cents. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements required: - name description: A list of bank accounts for the applicant. Depending on the Rentvine template, this array can be customized to be either required or optional. The template may also require a minimum number of items in the array in order to pass validation. You will need to work with your customer directly to configure this field to your application requirements credit_cards: type: array items: type: object properties: name: type: string description: The name of the bank or issuer of the credit card. This field is not configurable on the Rentvine template and is always required balance_in_cents: type: integer minimum: 0 description: The current balance of the credit card in cents. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements required: - name description: A list of credit cards for the applicant. Depending on the Rentvine template, this array can be customized to be either required or optional. The template may also require a minimum number of items in the array in order to pass validation. You will need to work with your customer directly to configure this field to your application requirements assistance: type: object properties: agency_name: type: string description: The name of the agency who is providing assistance for the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements county: type: string description: The county where the agency is located. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements technician_name: type: string description: The name of the agency's contact assigned to support the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements phone: type: string pattern: ^\+?\d{1,50}$ description: The phone number of the agency or of the agency's contact. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements assistance_amount_in_cents: type: integer minimum: 0 description: The amount of assistance for the applicant in cents. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements beds_allowed: type: string description: The number of beds allowed for the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements are_utilities_covered: type: boolean description: Whether utilities are covered for the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements description: Details for payment assistance for the applicant. Depending on the Rentvine template, this array can be customized to be either required or optional. The template may also require a minimum number of items in the array in order to pass validation. You will need to work with your customer directly to configure this field to your application requirements application_date: type: string format: date-time description: The application date associated with the applicant start_date: type: string format: date-time description: The start date associated with the applicant end_date: type: string format: date-time description: The end date associated with the applicant status: type: string enum: &a50 - PENDING - APPROVED - CANCELED - DENIED - SIGNED description: The status associated with the applicant rent_amount_market_in_cents: type: integer description: The market rent amount in cents for the lease _v1_applicants_{id}_put_output: type: object properties: job_id: type: string description: The ID of the job created to handle this operation data: type: object properties: {} required: - job_id - data _v1_applicants_{id}_rentable-items_get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query x_id: type: string description: The external ID from the integration vendor location_id: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. property_id: type: string description: The Propexo unique identifier for the property integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" RentableItem: type: object properties: id: type: string description: The Propexo unique identifier for the rentable item created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_applicant_id: type: - string - "null" description: The external ID of the applicant from the integration vendor x_lead_id: type: - string - "null" description: The external ID of the lead from the integration vendor x_resident_id: type: - string - "null" description: The external ID of the resident from the integration vendor x_type_id: type: - string - "null" description: The external ID of the type from the integration vendor x_charge_code_id: type: - string - "null" description: The external ID of the charge code from the integration vendor amount_in_cents: type: &a345 - number - "null" description: The amount of the rentable item, in cents example: 100000 description: type: - string - "null" description: Description of the rentable item name: type: - string - "null" description: The name of the rentable item is_available: type: - boolean - "null" description: Whether the rentable item is available reserved_until_date: type: - string - "null" description: The date the rentable item is reserved until type: type: - string - "null" description: The type associated with the rentable item integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" property_id: type: string description: The Propexo unique identifier for the property applicant_id: type: - string - "null" description: "Deprecated: Use the /applicants/:id/rentable-items endpoint instead." deprecated: true x-fern-availability: deprecated lead_id: type: - string - "null" description: "Deprecated: Use the /leads/:id/rentable-items endpoint instead." deprecated: true x-fern-availability: deprecated resident_id: type: - string - "null" description: "Deprecated: Use the /residents/:id/rentable-items endpoint instead." deprecated: true x-fern-availability: deprecated charge_code_id: type: - string - "null" description: The Propexo unique identifier for the charge code required: - id - created_at - updated_at - last_seen - x_id - x_property_id - x_location_id - x_applicant_id - x_lead_id - x_resident_id - x_type_id - x_charge_code_id - amount_in_cents - description - name - is_available - reserved_until_date - type - integration_id - integration_vendor - property_id - applicant_id - lead_id - resident_id - charge_code_id x-propexo: derivedFromModel: rentable_items _v1_applicants_{id}_rentable-items_get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: type: array items: $ref: "#/components/schemas/RentableItem" required: - meta - results _v1_applicants_buildium__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration unit_id: type: string description: The Propexo unique identifier for the unit first_name: type: string description: The first name associated with the applicant last_name: type: string description: The last name associated with the applicant send_rental_application_email: type: boolean default: false description: Whether to send the new applicant an email with a link to the online application form email_1: type: string format: email description: The primary email address associated with the applicant phone_1: type: string description: Primary phone number associated with the applicant phone_1_type: type: string enum: &a27 - HOME - WORK - MOBILE - FAX description: Type of the primary phone number phone_2: type: string description: Secondary phone number associated with the applicant phone_2_type: type: string enum: &a28 - HOME - WORK - MOBILE - FAX description: Type of the secondary phone number custom_data: type: object properties: {} description: "Deprecated: Field is no longer applicable" deprecated: true required: - integration_id - first_name - last_name _v1_applicants_buildium__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration unit_id: type: - string - "null" description: The Propexo unique identifier for the unit first_name: type: string description: The first name associated with the applicant last_name: type: string description: The last name associated with the applicant send_rental_application_email: type: boolean default: false description: Whether to send the new applicant an email with a link to the online application form email_1: type: - string - "null" format: email description: The primary email address associated with the applicant phone_1: type: - string - "null" description: Primary phone number associated with the applicant phone_1_type: type: - string - "null" enum: *a27 description: Type of the primary phone number phone_2: type: - string - "null" description: Secondary phone number associated with the applicant phone_2_type: type: - string - "null" enum: *a28 description: Type of the secondary phone number custom_data: type: - object - "null" properties: {} deprecated: true x-fern-availability: deprecated required: - integration_id - unit_id - first_name - last_name - email_1 - phone_1 - phone_1_type - phone_2 - phone_2_type - custom_data required: - meta - result _v1_applicants_buildium_{id}_put_input: type: object properties: last_name: type: string description: The last name associated with the applicant first_name: type: string description: The first name associated with the applicant unit_id: type: string description: The Propexo unique identifier for the unit email_1: type: string format: email description: The primary email address associated with the applicant phone_1: type: string description: Primary phone number associated with the applicant phone_1_type: type: string enum: &a29 - HOME - WORK - MOBILE - FAX description: Type of the primary phone number phone_2: type: string description: Secondary phone number associated with the applicant phone_2_type: type: string enum: &a30 - HOME - WORK - MOBILE - FAX description: Type of the secondary phone number _v1_applicants_buildium_{id}_put_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: id: type: string description: The Propexo unique identifier for the applicant last_name: type: string description: The last name associated with the applicant first_name: type: string description: The first name associated with the applicant unit_id: type: string description: The Propexo unique identifier for the unit email_1: type: string format: email description: The primary email address associated with the applicant phone_1: type: string description: Primary phone number associated with the applicant phone_1_type: type: string enum: *a29 description: Type of the primary phone number phone_2: type: string description: Secondary phone number associated with the applicant phone_2_type: type: string enum: *a30 description: Type of the secondary phone number required: - id required: - meta - result _v1_applicants_entrata__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration property_id: type: string description: The Propexo unique identifier for the property lease_period_id: type: string description: The Propexo unique identifier for the lease period lead_source_id: type: string description: The Propexo unique identifier for the lead source unit_id: type: string description: The Propexo unique identifier for the unit address_1: type: string description: The first address line associated with the applicant application_status: type: string enum: *a31 description: The status associated with the application city: type: string description: The city associated with the applicant first_name: type: string description: The first name associated with the applicant last_name: type: string description: The last name associated with the applicant state: type: string description: The state associated with the applicant zip: type: string description: The zip code associated with the applicant address_2: type: string description: The second address line associated with the applicant attachments: type: array items: type: object properties: file_data: type: string maxLength: 69730304 description: The contents of the file, as a base64 encoded string. The PMS has a max file size of 50 MB. file_name: type: string description: 'The name of the file including the extension. Ex: "image.jpg"' mime_type: type: string description: 'The mime type of the file. Ex: "image/jpeg"' lease_file_type: type: string description: "Deprecated: Use the `file_type_id` field instead. The PMS specific lease file type of the document" file_type_id: type: string description: The Propexo file type ID of the lease file type to upload. Prefer this over the raw input of the lease_file_type. is_private: type: boolean description: If the file should be marked as private. If true the file will not be shown in the resident portal. required: - file_data - file_name - mime_type description: Files to upload for the applicant date_of_birth: type: string format: date-time description: The date of birth associated with the applicant email_1: type: string format: email description: The primary email address associated with the applicant events: type: array items: type: object properties: unit_id: type: string description: The Propexo unique identifier for the unit x_type_id: type: string description: The PMS id for the event type. x_leasing_agent_id: type: string description: The PMS id for the leasing agent. x_sub_type_id: type: string description: The PMS id for the event sub type. x_result_id: type: string description: The PMS id for the event result. event_datetime: type: string format: date-time description: The date and time that the event occured. appointment_datetime: type: string format: date-time description: The date and time that the appointment will occur. Required if using appointment type. time_from: type: string time_to: type: string notes: type: string description: General notes about the event. title: type: string description: Title for the event. reasons_for_event: type: string description: The reason the event occurred. required: - x_type_id description: "DEPRECATED: Please use /events endpoints to write events. Array of events associated with this applicant" deprecated: true move_in_date: type: string format: date-time description: The move-in date associated with the applicant phone_1: type: string description: Primary phone number associated with the applicant pets: type: array items: type: object properties: pet_type_id: type: string description: The Propexo unique identifier for the pet type age_in_years: type: integer minimum: 0 description: The age in years of the applicant pet name: type: string description: The name associated with the applicant pet breed: type: string description: The breed of the applicant pet gender: type: string description: The gender of the applicant pet color: type: string description: The color of the applicant pet weight_in_pounds: type: integer minimum: 0 description: The weight in pounds of the applicant pet description: type: string description: Description of the applicant pet license_city: type: string description: The city where the applicant pet license was issued license_number: type: string description: The license number of the applicant pet is_service_animal: type: boolean description: Whether the applicant pet is a service animal is_fixed: type: boolean description: Whether the applicant pet is fixed pet_spayed_or_neutered_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date when the applicant pet was spayed or neutered is_house_broken: type: boolean description: Whether the applicant pet is house broken special_provisions: type: string description: Special provisions or requirements for the applicant pet required: - pet_type_id description: Pets of the applicant vehicles: type: array items: type: object properties: vehicle_type: type: string enum: &a32 - PRIMARY - SECONDARY - OTHER description: The type associated with the applicant vehicle make: type: string description: The make of the applicant vehicle model: type: string description: The Propexo data model (e.g. units, residents, applicants, etc.) associated with the applicant vehicle year: type: integer description: The year of the applicant vehicle color: type: string description: The color of the applicant vehicle license_plate_number: type: string description: The license plate number of the applicant vehicle license_plate_state: type: string enum: &a33 - AA - AE - AK - AL - AP - AR - AS - AZ - CA - CO - CT - DC - DE - FL - FM - GA - GU - HI - IA - ID - IN - KS - KY - LA - MA - MD - ME - MH - MI - MN - MO - MP - MS - MT - NC - NE - NL - NJ - NM - NV - NY - OH - OK - OR - PA - PR - SD - TN - TX - UT - VA - VI - VT - WA - WI - WV - WY - AB - BC - MB - NB - NL - NT - NS - NU - ON - PE - QC - SK - YT description: The state associated with the applicant vehicle country_code: type: string description: The country associated with the applicant vehicle permit_number: type: string description: The permit number of the applicant vehicle notes: type: string description: Notes associated with the applicant vehicle required: - vehicle_type description: Vehicles of the applicant employment_history: type: array items: type: object properties: income_type: type: string enum: &a34 - CURRENT_EMPLOYER - PREVIOUS_EMPLOYER - OTHER_INCOME description: The name associated with the income type frequency: type: string enum: &a35 - WEEKLY - MONTHLY - YEARLY description: The frequency of the applicant employer position: type: string description: The position of the employee name: type: string description: The name associated with the applicant employer phone: type: string description: Primary phone number associated with the applicant employer address_1: type: string description: The first address line associated with the applicant employer address_2: type: string description: The second address line associated with the applicant employer address_3: type: string description: The third address line associated with the applicant employer city: type: string description: The city associated with the applicant employer state: type: string description: The state associated with the applicant employer province: type: string description: The province associated with the applicant employer zip: type: string description: The zip code associated with the applicant employer country: type: string description: The country associated with the applicant employer income_in_cents: type: integer minimum: 0 description: The total income of the employee, in cents supervisor_first_name: type: string description: The name associated with the employee supervisor_last_name: type: string description: The name associated with the employee supervisor_phone: type: string description: Primary phone number associated with the employee supervisor_email: type: string description: The primary email address associated with the employee income_effective_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The effective date of the income of the employee start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The start date associated with the employee end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The end date associated with the employee required: - income_type - frequency description: Employment history of the applicant add_ons: type: array items: type: object properties: rentable_item_id: type: string description: The Propexo unique identifier for the rentable item employee_id: type: string description: The Propexo unique identifier for the employee start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The start date associated with the employee end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The end date associated with the employee required: - rentable_item_id - employee_id description: Add-ons of the applicant required: - integration_id - property_id - lease_period_id - lead_source_id - address_1 - application_status - city - first_name - last_name - state - zip _v1_applicants_entrata__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration property_id: type: string description: The Propexo unique identifier for the property lease_period_id: type: string description: The Propexo unique identifier for the lease period lead_source_id: type: string description: The Propexo unique identifier for the lead source unit_id: type: - string - "null" address_1: type: string description: The first address line associated with the applicant application_status: type: string enum: *a31 description: The status associated with the application city: type: string description: The city associated with the applicant first_name: type: string description: The first name associated with the applicant last_name: type: string description: The last name associated with the applicant state: type: string description: The state associated with the applicant zip: type: string description: The zip code associated with the applicant address_2: type: - string - "null" attachments: type: - array - "null" items: type: object properties: file_data: type: - string - "null" maxLength: 69730304 description: The contents of the file, as a base64 encoded string. The PMS has a max file size of 50 MB. file_name: type: string description: 'The name of the file including the extension. Ex: "image.jpg"' mime_type: type: string description: 'The mime type of the file. Ex: "image/jpeg"' lease_file_type: type: string file_type_id: type: string is_private: type: boolean required: - file_name - mime_type date_of_birth: type: - string - "null" format: date-time email_1: type: - string - "null" format: email events: type: - array - "null" items: type: object properties: unit_id: type: string x_type_id: type: string description: The PMS id for the event type. x_leasing_agent_id: type: string x_sub_type_id: type: string x_result_id: type: string event_datetime: type: string format: date-time appointment_datetime: type: string format: date-time time_from: type: string time_to: type: string notes: type: string title: type: string reasons_for_event: type: string required: - x_type_id move_in_date: type: - string - "null" format: date-time phone_1: type: - string - "null" pets: type: - array - "null" items: type: object properties: pet_type_id: type: string description: The Propexo unique identifier for the pet type age_in_years: type: integer minimum: 0 name: type: string breed: type: string gender: type: string color: type: string weight_in_pounds: type: integer minimum: 0 description: type: string license_city: type: string license_number: type: string is_service_animal: type: boolean is_fixed: type: boolean pet_spayed_or_neutered_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ is_house_broken: type: boolean special_provisions: type: string required: - pet_type_id vehicles: type: - array - "null" items: type: object properties: vehicle_type: type: string enum: *a32 description: The type associated with the applicant vehicle make: type: string model: type: string year: type: integer color: type: string license_plate_number: type: string license_plate_state: type: string enum: *a33 country_code: type: string permit_number: type: string notes: type: string required: - vehicle_type employment_history: type: - array - "null" items: type: object properties: income_type: type: string enum: *a34 description: The name associated with the income type frequency: type: string enum: *a35 description: The frequency of the applicant employer position: type: string name: type: string phone: type: string address_1: type: string address_2: type: string address_3: type: string city: type: string state: type: string province: type: string zip: type: string country: type: string income_in_cents: type: integer minimum: 0 supervisor_first_name: type: string supervisor_last_name: type: string supervisor_phone: type: string supervisor_email: type: string income_effective_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ required: - income_type - frequency add_ons: type: - array - "null" items: type: object properties: rentable_item_id: type: string description: The Propexo unique identifier for the rentable item employee_id: type: string description: The Propexo unique identifier for the employee start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ required: - rentable_item_id - employee_id required: - integration_id - property_id - lease_period_id - lead_source_id - unit_id - address_1 - application_status - city - first_name - last_name - state - zip - address_2 - attachments - date_of_birth - email_1 - events - move_in_date - phone_1 - pets - vehicles - employment_history - add_ons required: - meta - result _v1_applicants_entrata_{applicant_id}_put_input: type: object properties: application_id: type: string description: The Propexo unique identifier for the application lease_period_id: type: string description: The Propexo unique identifier for the lease period unit_id: type: string description: The Propexo unique identifier for the unit lead_source_id: type: string description: The Propexo unique identifier for the lead source address_1: type: string description: The first address line associated with the applicant address_2: type: string description: The second address line associated with the applicant application_status: type: string enum: *a36 description: The status associated with the application attachments: type: array items: type: object properties: file_data: type: string maxLength: 69730304 description: The contents of the file, as a base64 encoded string. The PMS has a max file size of 50 MB. file_name: type: string description: 'The name of the file including the extension. Ex: "image.jpg"' mime_type: type: string description: 'The mime type of the file. Ex: "image/jpeg"' lease_file_type: type: string description: "Deprecated: Use the `file_type_id` field instead. The PMS specific lease file type of the document" file_type_id: type: string description: The Propexo file type ID of the lease file type to upload. Prefer this over the raw input of the lease_file_type. is_private: type: boolean description: If the file should be marked as private. If true the file will not be shown in the resident portal. required: - file_data - file_name - mime_type description: Files to upload for the applicant. All the files can have a maximum combined file size of 50 MB city: type: string description: The city associated with the applicant create_new_events_only: anyOf: - type: boolean - type: string description: Whether or not new events should be created on the applicant date_of_birth: type: string format: date-time description: The date of birth associated with the applicant email_1: type: string format: email description: The primary email address associated with the applicant events: type: array items: type: object properties: unit_id: type: string description: The Propexo unique identifier for the unit x_type_id: type: string description: The PMS id for the event type. x_leasing_agent_id: type: string description: The PMS id for the leasing agent. x_sub_type_id: type: string description: The PMS id for the event sub type. x_result_id: type: string description: The PMS id for the event result. event_datetime: type: string format: date-time description: The date and time that the event occured. appointment_datetime: type: string format: date-time description: The date and time that the appointment will occur. Required if using appointment type. time_from: type: string time_to: type: string notes: type: string description: General notes about the event. title: type: string description: Title for the event. reasons_for_event: type: string description: The reason the event occurred. id: type: string description: The Propexo unique identifier for the event. Only required if attempting to update an existing event. required: - x_type_id description: "DEPRECATED: Please use /events endpoints to write events. Array of events associated with this applicant" deprecated: true first_name: type: string description: The first name associated with the applicant last_name: type: string description: The last name associated with the applicant move_in_date: type: string format: date-time description: The move-in date associated with the applicant phone_1_type: type: string enum: &a37 - HOME - WORK - MOBILE - FAX description: Type of the primary phone number phone_1: type: string description: Primary phone number associated with the applicant state: type: string description: The state associated with the applicant zip: type: string description: The zip code associated with the applicant pets: type: array items: type: object properties: pet_type_id: type: string description: The Propexo unique identifier for the pet type age_in_years: type: integer minimum: 0 description: The age in years of the applicant pet name: type: string description: The name associated with the applicant pet breed: type: string description: The breed of the applicant pet gender: type: string description: The gender of the applicant pet color: type: string description: The color of the applicant pet weight_in_pounds: type: integer minimum: 0 description: The weight in pounds of the applicant pet description: type: string description: Description of the applicant pet license_city: type: string description: The city where the applicant pet license was issued license_number: type: string description: The license number of the applicant pet is_service_animal: type: boolean description: Whether the applicant pet is a service animal is_fixed: type: boolean description: Whether the applicant pet is fixed pet_spayed_or_neutered_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date when the applicant pet was spayed or neutered is_house_broken: type: boolean description: Whether the applicant pet is house broken special_provisions: type: string description: Special provisions or requirements for the applicant pet required: - pet_type_id description: Pets of the applicant. These will be added as new pets for the applicant vehicles: type: array items: type: object properties: vehicle_type: type: string enum: *a32 description: The type associated with the applicant vehicle make: type: string description: The make of the applicant vehicle model: type: string description: The Propexo data model (e.g. units, residents, applicants, etc.) associated with the applicant vehicle year: type: integer description: The year of the applicant vehicle color: type: string description: The color of the applicant vehicle license_plate_number: type: string description: The license plate number of the applicant vehicle license_plate_state: type: string enum: *a33 description: The state associated with the applicant vehicle country_code: type: string description: The country associated with the applicant vehicle permit_number: type: string description: The permit number of the applicant vehicle notes: type: string description: Notes associated with the applicant vehicle required: - vehicle_type description: Vehicles of the applicant. These will be added as new vehicles for the applicant employment_history: type: array items: type: object properties: income_type: type: string enum: *a34 description: The name associated with the income type frequency: type: string enum: *a35 description: The frequency of the applicant employer position: type: string description: The position of the employee name: type: string description: The name associated with the applicant employer phone: type: string description: Primary phone number associated with the applicant employer address_1: type: string description: The first address line associated with the applicant employer address_2: type: string description: The second address line associated with the applicant employer address_3: type: string description: The third address line associated with the applicant employer city: type: string description: The city associated with the applicant employer state: type: string description: The state associated with the applicant employer province: type: string description: The province associated with the applicant employer zip: type: string description: The zip code associated with the applicant employer country: type: string description: The country associated with the applicant employer income_in_cents: type: integer minimum: 0 description: The total income of the employee, in cents supervisor_first_name: type: string description: The name associated with the employee supervisor_last_name: type: string description: The name associated with the employee supervisor_phone: type: string description: Primary phone number associated with the employee supervisor_email: type: string description: The primary email address associated with the employee income_effective_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The effective date of the income of the employee start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The start date associated with the employee end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The end date associated with the employee required: - income_type - frequency description: Employment history of the applicant. These will be added as new employment history for the applicant add_ons: type: array items: type: object properties: rentable_item_id: type: string description: The Propexo unique identifier for the rentable item employee_id: type: string description: The Propexo unique identifier for the employee start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The start date associated with the employee end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The end date associated with the employee required: - rentable_item_id - employee_id description: Add-ons of the applicant. These will be added as new add-ons for the applicant required: - application_id _v1_applicants_entrata_{applicant_id}_put_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: applicant_id: type: string description: The Propexo unique identifier for the applicant application_id: type: string description: The Propexo unique identifier for the application lease_period_id: type: string description: The Propexo unique identifier for the lease period unit_id: type: string description: The Propexo unique identifier for the unit lead_source_id: type: string description: The Propexo unique identifier for the lead source address_1: type: string description: The first address line associated with the applicant address_2: type: string description: The second address line associated with the applicant application_status: type: string enum: *a36 description: The status associated with the application attachments: type: array items: type: object properties: file_data: type: string maxLength: 69730304 description: The contents of the file, as a base64 encoded string. The PMS has a max file size of 50 MB. file_name: type: string description: 'The name of the file including the extension. Ex: "image.jpg"' mime_type: type: string description: 'The mime type of the file. Ex: "image/jpeg"' lease_file_type: type: string description: "Deprecated: Use the `file_type_id` field instead. The PMS specific lease file type of the document" x-fern-availability: deprecated deprecated: true file_type_id: type: string description: The Propexo file type ID of the lease file type to upload. Prefer this over the raw input of the lease_file_type. is_private: type: boolean description: If the file should be marked as private. If true the file will not be shown in the resident portal. required: - file_data - file_name - mime_type city: type: string description: The city associated with the applicant create_new_events_only: anyOf: - type: boolean - type: string description: Whether or not new events should be created on the applicant date_of_birth: type: string format: date-time description: The date of birth associated with the applicant email_1: type: string format: email description: The primary email address associated with the applicant events: type: array items: type: object properties: unit_id: type: string description: The Propexo unique identifier for the unit x_type_id: type: string x_leasing_agent_id: type: string description: The PMS id for the leasing agent. x_sub_type_id: type: string description: The PMS id for the event sub type. x_result_id: type: string description: The PMS id for the event result. event_datetime: type: string format: date-time description: The date and time that the event occured. appointment_datetime: type: string format: date-time description: The date and time that the appointment will occur. Required if using appointment type. time_from: type: string time_to: type: string notes: type: string description: General notes about the event. title: type: string description: Title for the event. reasons_for_event: type: string description: The reason the event occurred. id: type: string description: The Propexo unique identifier for the event. Only required if attempting to update an existing event. required: - x_type_id first_name: type: string description: The first name associated with the applicant last_name: type: string description: The last name associated with the applicant move_in_date: type: string format: date-time description: The move-in date associated with the applicant phone_1_type: type: string enum: *a37 description: Type of the primary phone number phone_1: type: string description: Primary phone number associated with the applicant state: type: string description: The state associated with the applicant zip: type: string description: The zip code associated with the applicant pets: type: array items: type: object properties: pet_type_id: type: string description: The Propexo unique identifier for the pet type age_in_years: type: integer minimum: 0 description: The age in years of the applicant pet name: type: string description: The name associated with the applicant pet breed: type: string description: The breed of the applicant pet gender: type: string description: The gender of the applicant pet color: type: string description: The color of the applicant pet weight_in_pounds: type: integer minimum: 0 description: The weight in pounds of the applicant pet description: type: string description: Description of the applicant pet license_city: type: string description: The city where the applicant pet license was issued license_number: type: string description: The license number of the applicant pet is_service_animal: type: boolean description: Whether the applicant pet is a service animal is_fixed: type: boolean description: Whether the applicant pet is fixed pet_spayed_or_neutered_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date when the applicant pet was spayed or neutered is_house_broken: type: boolean description: Whether the applicant pet is house broken special_provisions: type: string description: Special provisions or requirements for the applicant pet required: - pet_type_id vehicles: type: array items: type: object properties: vehicle_type: type: string enum: *a32 description: The type associated with the applicant vehicle make: type: string description: The make of the applicant vehicle model: type: string description: The Propexo data model (e.g. units, residents, applicants, etc.) associated with the applicant vehicle year: type: integer description: The year of the applicant vehicle color: type: string description: The color of the applicant vehicle license_plate_number: type: string description: The license plate number of the applicant vehicle license_plate_state: type: string enum: *a33 description: The state associated with the applicant vehicle country_code: type: string description: The country associated with the applicant vehicle permit_number: type: string description: The permit number of the applicant vehicle notes: type: string description: Notes associated with the applicant vehicle required: - vehicle_type employment_history: type: array items: type: object properties: income_type: type: string enum: *a34 description: The name associated with the income type frequency: type: string enum: *a35 description: The frequency of the applicant employer position: type: string description: The position of the employee name: type: string description: The name associated with the applicant employer phone: type: string description: Primary phone number associated with the applicant employer address_1: type: string description: The first address line associated with the applicant employer address_2: type: string description: The second address line associated with the applicant employer address_3: type: string description: The third address line associated with the applicant employer city: type: string description: The city associated with the applicant employer state: type: string description: The state associated with the applicant employer province: type: string description: The province associated with the applicant employer zip: type: string description: The zip code associated with the applicant employer country: type: string description: The country associated with the applicant employer income_in_cents: type: integer minimum: 0 description: The total income of the employee, in cents supervisor_first_name: type: string description: The name associated with the employee supervisor_last_name: type: string description: The name associated with the employee supervisor_phone: type: string description: Primary phone number associated with the employee supervisor_email: type: string description: The primary email address associated with the employee income_effective_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The effective date of the income of the employee start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The start date associated with the employee end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The end date associated with the employee required: - income_type - frequency add_ons: type: array items: type: object properties: rentable_item_id: type: string description: The Propexo unique identifier for the rentable item employee_id: type: string description: The Propexo unique identifier for the employee start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The start date associated with the employee end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The end date associated with the employee required: - rentable_item_id - employee_id required: - applicant_id - application_id required: - meta - result _v1_applicants_mri__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration property_id: type: string description: The Propexo unique identifier for the property last_name: type: string description: The last name associated with the applicant address_type_id: type: string description: The Propexo unique identifier for the address type first_name: type: string description: The first name associated with the applicant email_1: type: string description: The primary email address associated with the applicant address_1: type: string description: The first address line associated with the applicant address_2: type: string description: The second address line associated with the applicant city: type: string description: The city associated with the applicant state: type: string enum: &a39 - AA - AE - AK - AL - AP - AR - AS - AZ - CA - CO - CT - DC - DE - FL - FM - GA - GU - HI - IA - ID - IN - KS - KY - LA - MA - MD - ME - MH - MI - MN - MO - MP - MS - MT - NC - NE - NL - NJ - NM - NV - NY - OH - OK - OR - PA - PR - SD - TN - TX - UT - VA - VI - VT - WA - WI - WV - WY description: The state associated with the applicant zip: type: string description: The zip code associated with the applicant target_move_in_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The target move in date associated with the applicant desired_num_bedrooms: type: number description: The desired number of bedrooms desired_num_bathrooms: type: string description: The desired number of bathrooms desired_lease_term_in_months: type: number description: The desired lease term in months of the applicant number_of_occupants: type: number description: The number of occupants for the applicant notes: type: string maxLength: 30 description: Notes associated with the applicant phone_1: type: string description: Primary phone number associated with the applicant phone_1_type: type: string enum: - FAX - HOME - MOBILE - OTHER - WORK description: Type of the primary phone number phone_2: type: string description: Secondary phone number associated with the applicant phone_2_type: type: string enum: - FAX - HOME - MOBILE - OTHER - WORK description: Type of the secondary phone number applicant_status: type: string enum: *a38 description: The status of the applicant. This is optional and defaults to ACTIVE. required: - integration_id - property_id - last_name _v1_applicants_mri__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration property_id: type: string description: The Propexo unique identifier for the property last_name: type: string description: The last name associated with the applicant address_type_id: type: - string - "null" description: The Propexo unique identifier for the address type first_name: type: - string - "null" description: The first name associated with the applicant email_1: type: - string - "null" description: The primary email address associated with the applicant address_1: type: - string - "null" description: The first address line associated with the applicant address_2: type: - string - "null" description: The second address line associated with the applicant city: type: - string - "null" description: The city associated with the applicant state: type: - string - "null" enum: *a39 description: The state associated with the applicant zip: type: - string - "null" description: The zip code associated with the applicant target_move_in_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" description: The target move in date associated with the applicant desired_num_bedrooms: type: - number - "null" description: The desired number of bedrooms desired_num_bathrooms: type: - string - "null" description: The desired number of bathrooms desired_lease_term_in_months: type: - number - "null" description: The desired lease term in months of the applicant number_of_occupants: type: - number - "null" description: The number of occupants for the applicant notes: type: - string - "null" maxLength: 30 description: Notes associated with the applicant phone_1: type: - string - "null" description: Primary phone number associated with the applicant phone_1_type: type: - string - "null" enum: - FAX - HOME - MOBILE - OTHER - WORK description: Type of the primary phone number phone_2: type: - string - "null" description: Secondary phone number associated with the applicant phone_2_type: type: - string - "null" enum: - FAX - HOME - MOBILE - OTHER - WORK description: Type of the secondary phone number applicant_status: type: - string - "null" enum: *a38 description: The status of the applicant. This is optional and defaults to ACTIVE. required: - integration_id - property_id - last_name - address_type_id - first_name - email_1 - address_1 - address_2 - city - state - zip - target_move_in_date - desired_num_bedrooms - desired_num_bathrooms - desired_lease_term_in_months - number_of_occupants - notes - phone_1 - phone_1_type - phone_2 - phone_2_type - applicant_status required: - meta - result _v1_applicants_mri_{applicant_id}_put_input: type: object properties: address_type_id: type: string description: The Propexo unique identifier for the address type. This is required when updating the address first_name: type: string description: The first name associated with the applicant last_name: type: string description: The last name associated with the applicant email_1: type: string description: The primary email address associated with the applicant address_1: type: string description: The first address line associated with the applicant address_2: type: string description: The second address line associated with the applicant city: type: string description: The city associated with the applicant state: type: string enum: *a39 description: The state associated with the applicant zip: type: string description: The zip code associated with the applicant target_move_in_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The target move in date for the applicant desired_num_bedrooms: type: number description: The desired number of bedrooms desired_num_bathrooms: type: string description: The desired number of bathrooms desired_lease_term_in_months: type: number description: The desired lease term in months of the applicant number_of_occupants: type: number description: The number of occupants for the applicant notes: type: string maxLength: 30 description: Notes associated with the applicant phone_1: type: string description: Primary phone number associated with the applicant phone_1_type: type: string enum: - FAX - HOME - MOBILE - OTHER - WORK description: Type of the primary phone number phone_2: type: string description: Secondary phone number associated with the applicant phone_2_type: type: string enum: - FAX - HOME - MOBILE - OTHER - WORK description: Type of the secondary phone number applicant_status: type: string enum: *a40 description: The status of the applicant. This is optional and defaults to ACTIVE. _v1_applicants_mri_{applicant_id}_put_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: applicant_id: type: string description: The Propexo unique identifier for the applicant address_type_id: type: string description: The Propexo unique identifier for the address type. This is required when updating the address first_name: type: string description: The first name associated with the applicant last_name: type: string description: The last name associated with the applicant email_1: type: string description: The primary email address associated with the applicant address_1: type: string description: The first address line associated with the applicant address_2: type: string description: The second address line associated with the applicant city: type: string description: The city associated with the applicant state: type: string enum: *a39 description: The state associated with the applicant zip: type: string description: The zip code associated with the applicant target_move_in_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The target move in date for the applicant desired_num_bedrooms: type: number description: The desired number of bedrooms desired_num_bathrooms: type: string description: The desired number of bathrooms desired_lease_term_in_months: type: number description: The desired lease term in months of the applicant number_of_occupants: type: number description: The number of occupants for the applicant notes: type: string maxLength: 30 description: Notes associated with the applicant phone_1: type: string description: Primary phone number associated with the applicant phone_1_type: type: string enum: - FAX - HOME - MOBILE - OTHER - WORK description: Type of the primary phone number phone_2: type: string description: Secondary phone number associated with the applicant phone_2_type: type: string enum: - FAX - HOME - MOBILE - OTHER - WORK description: Type of the secondary phone number applicant_status: type: string enum: *a40 description: The status of the applicant. This is optional and defaults to ACTIVE. required: - applicant_id required: - meta - result _v1_applicants_rentmanager__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration property_id: type: string description: The Propexo unique identifier for the property last_name: type: string description: The last name associated with the applicant first_name: type: string description: The first name associated with the applicant middle_name: type: string description: The middle name associated with the applicant email_1: type: string format: email description: The primary email address associated with the applicant date_of_birth: type: string format: date-time description: The date of birth associated with the applicant address_1: type: string description: The first address line associated with the applicant city: type: string description: The city associated with the applicant state: type: string description: The state associated with the applicant zip: type: string description: The zip code associated with the applicant notes: type: string description: Notes associated with the applicant application_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The application date associated with the applicant. Specifying this ensures Rent Manager classifies this prospect as an applicant custom_data: type: object properties: {} description: "Deprecated: Field is no longer applicable" deprecated: true required: - integration_id - property_id - last_name _v1_applicants_rentmanager__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration property_id: type: string description: The Propexo unique identifier for the property last_name: type: string description: The last name associated with the applicant first_name: type: - string - "null" description: The first name associated with the applicant middle_name: type: - string - "null" description: The middle name associated with the applicant email_1: type: - string - "null" format: email description: The primary email address associated with the applicant date_of_birth: type: - string - "null" format: date-time description: The date of birth associated with the applicant address_1: type: - string - "null" description: The first address line associated with the applicant city: type: - string - "null" description: The city associated with the applicant state: type: - string - "null" description: The state associated with the applicant zip: type: - string - "null" description: The zip code associated with the applicant notes: type: - string - "null" description: Notes associated with the applicant application_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" description: The application date associated with the applicant. Specifying this ensures Rent Manager classifies this prospect as an applicant custom_data: type: - object - "null" properties: {} deprecated: true x-fern-availability: deprecated required: - integration_id - property_id - last_name - first_name - middle_name - email_1 - date_of_birth - address_1 - city - state - zip - notes - application_date - custom_data required: - meta - result _v1_applicants_rentmanager_{applicant_id}_put_input: type: object properties: last_name: type: string description: The last name associated with the applicant first_name: type: string description: The first name associated with the applicant middle_name: type: string description: The middle name associated with the applicant email_1: type: string format: email description: The primary email address associated with the applicant date_of_birth: type: string format: date-time description: The date of birth associated with the applicant address_1: type: string description: The first address line associated with the applicant city: type: string description: The city associated with the applicant state: type: string description: The state associated with the applicant zip: type: string description: The zip code associated with the applicant notes: type: string description: Notes associated with the applicant required: - last_name _v1_applicants_rentmanager_{applicant_id}_put_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: applicant_id: type: string description: The Propexo unique identifier for the applicant last_name: type: string description: The last name associated with the applicant first_name: type: string description: The first name associated with the applicant middle_name: type: string description: The middle name associated with the applicant email_1: type: string format: email description: The primary email address associated with the applicant date_of_birth: type: string format: date-time description: The date of birth associated with the applicant address_1: type: string description: The first address line associated with the applicant city: type: string description: The city associated with the applicant state: type: string description: The state associated with the applicant zip: type: string description: The zip code associated with the applicant notes: type: string description: Notes associated with the applicant required: - applicant_id - last_name required: - meta - result _v1_applicants_propertyware__post_input: type: object properties: property_id: type: string description: The Propexo unique identifier for the property integration_id: type: string description: The Propexo unique identifier for the integration address_1: type: string description: First line of the street address for the applicant. This maps to the addressLine1 property of the Applicant's primary address address_2: type: string description: Second line of the street address for the applicant. This maps to the addressLine2 property of the Applicant's primary address. city: type: string description: City of the applicant's primary address. This maps to the city property of the Applicant's primary address. custom_data: type: object properties: {} description: "Deprecated: Field is no longer applicable" deprecated: true date_of_birth: type: string format: date-time description: Date of birth of the applicant. This maps to the birthDate property of the Applicant object. email_1: type: string format: email description: The primary email address for the applicant. This value maps to the email property of the Applicant object first_name: type: string description: The first name of the applicant. This value maps to the firstName property of the Applicant object. last_name: type: string description: The last name of the applicant. This value maps to the lastName property of the Applicant object phone_1: type: string description: Applicant's primary phone number. This maps to the phoneNumber property of the Applicant object. phone_1_type: type: string enum: &a41 - HOME - WORK - MOBILE - FAX description: The type of the applicant's primary phone number. The value passed in here must be one of 'HOME', 'WORK', 'MOBILE', FAX'. This maps to the phoneNumberTypeId property of the Applicant object. phone_2: type: string description: Applicant's secondary phone number. This maps to the phoneNumber property of the Applicant object. phone_2_type: type: string enum: &a42 - HOME - WORK - MOBILE - FAX description: The type of the applicant's secondary phone number. The value passed in here must be one of 'HOME', 'WORK', 'MOBILE', FAX'. This maps to the phoneNumberTypeId property of the Applicant object. state: type: string description: State of the resident's primary address. This maps to the stateCode property of the Applicant's primary address. unit_id: type: string description: The Propexo unique identifier for the unit zip: type: string description: Zip/Postal Code of the resident's primary address. This maps to the postalCode property of the Applicant's primary address. attachments: type: array items: type: object properties: file_data: type: string maxLength: 16735272 description: The contents of the file, as a base64 encoded string. The PMS has a max file size of 12 MB. file_name: type: string description: The name of the file notes: type: string description: General notes about the file is_private: type: boolean description: If the file should be marked as private required: - file_data - file_name description: Files to upload to the applicant. required: - property_id - integration_id _v1_applicants_propertyware__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: property_id: type: string description: The Propexo unique identifier for the property integration_id: type: string description: The Propexo unique identifier for the integration address_1: type: - string - "null" address_2: type: - string - "null" city: type: - string - "null" custom_data: type: - object - "null" properties: {} date_of_birth: type: - string - "null" format: date-time email_1: type: - string - "null" format: email first_name: type: - string - "null" last_name: type: - string - "null" phone_1: type: - string - "null" phone_1_type: type: - string - "null" enum: *a41 phone_2: type: - string - "null" phone_2_type: type: - string - "null" enum: *a42 state: type: - string - "null" unit_id: type: - string - "null" zip: type: - string - "null" attachments: type: - array - "null" items: type: object properties: file_data: type: - string - "null" maxLength: 16735272 description: The contents of the file, as a base64 encoded string. The PMS has a max file size of 12 MB. file_name: type: string description: The name of the file notes: type: string is_private: type: boolean required: - file_name required: - property_id - integration_id - address_1 - address_2 - city - custom_data - date_of_birth - email_1 - first_name - last_name - phone_1 - phone_1_type - phone_2 - phone_2_type - state - unit_id - zip - attachments required: - meta - result _v1_applicants_propertyware_{applicant_id}_put_input: type: object properties: address_1: type: string description: First line of the street address for the applicant. This maps to the addressLine1 property of the Applicant's primary address address_2: type: string description: Second line of the street address for the applicant. This maps to the addressLine2 property of the Applicant's primary address. city: type: string description: City of the applicant's primary address. This maps to the city property of the Applicant's primary address. custom_data: type: object properties: {} description: "Deprecated: Field is no longer applicable" deprecated: true date_of_birth: type: string format: date-time description: Date of birth of the applicant. This maps to the birthDate property of the Applicant object. email_1: type: string format: email description: The primary email address for the applicant. This value maps to the email property of the Applicant object first_name: type: string description: The first name of the applicant. This value maps to the firstName property of the Applicant object. integration_id: type: string description: The Propexo unique identifier for the integration last_name: type: string description: The last name of the applicant. This value maps to the lastName property of the Applicant object originating_lead_source_id: type: string description: The ID of the lead source. This maps to the originatingLeadSourceId property of the Application object. phone_1: type: string description: Applicant's primary phone number. This maps to the phoneNumber property of the Applicant object. phone_1_type: type: string enum: - HOME - WORK - MOBILE - FAX description: The type of the applicant's primary phone number. The value passed in here must be one of 'HOME', 'WORK', 'MOBILE', FAX'. This maps to the phoneNumberTypeId property of the Applicant object. phone_2: type: string description: Applicant's secondary phone number. This maps to the phoneNumber property of the Applicant object. phone_2_type: type: string enum: &a43 - HOME - WORK - MOBILE - FAX description: The type of the applicant's secondary phone number. The value passed in here must be one of 'HOME', 'WORK', 'MOBILE', FAX'. This maps to the phoneNumberTypeId property of the Applicant object. state: type: string description: State of the resident's primary address. This maps to the stateCode property of the Applicant's primary address. x_property_id: type: string description: The external ID of the property from the integration vendor x_unit_id: type: string description: The external ID of the unit from the integration vendor zip: type: string description: Zip/Postal Code of the resident's primary address. This maps to the postalCode property of the Applicant's primary address. required: - integration_id - x_property_id _v1_applicants_propertyware_{applicant_id}_put_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: address_1: type: - string - "null" description: First line of the street address for the applicant. This maps to the addressLine1 property of the Applicant's primary address address_2: type: - string - "null" description: Second line of the street address for the applicant. This maps to the addressLine2 property of the Applicant's primary address. city: type: - string - "null" description: City of the applicant's primary address. This maps to the city property of the Applicant's primary address. custom_data: type: - object - "null" properties: {} deprecated: true x-fern-availability: deprecated date_of_birth: type: - string - "null" format: date-time description: Date of birth of the applicant. This maps to the birthDate property of the Applicant object. email_1: type: - string - "null" format: email description: The primary email address for the applicant. This value maps to the email property of the Applicant object first_name: type: - string - "null" description: The first name of the applicant. This value maps to the firstName property of the Applicant object. integration_id: type: string description: The Propexo unique identifier for the integration last_name: type: - string - "null" description: The last name of the applicant. This value maps to the lastName property of the Applicant object originating_lead_source_id: type: string description: The ID of the lead source. This maps to the originatingLeadSourceId property of the Application object. phone_1: type: - string - "null" description: Applicant's primary phone number. This maps to the phoneNumber property of the Applicant object. phone_1_type: type: - string - "null" enum: - HOME - WORK - MOBILE - FAX description: The type of the applicant's primary phone number. The value passed in here must be one of 'HOME', 'WORK', 'MOBILE', FAX'. This maps to the phoneNumberTypeId property of the Applicant object. phone_2: type: string description: Applicant's secondary phone number. This maps to the phoneNumber property of the Applicant object. phone_2_type: type: string enum: *a43 description: The type of the applicant's secondary phone number. The value passed in here must be one of 'HOME', 'WORK', 'MOBILE', FAX'. This maps to the phoneNumberTypeId property of the Applicant object. state: type: - string - "null" description: State of the resident's primary address. This maps to the stateCode property of the Applicant's primary address. x_property_id: type: string description: The external ID of the property from the integration vendor x_unit_id: type: - string - "null" description: The external ID of the unit from the integration vendor zip: type: - string - "null" description: Zip/Postal Code of the resident's primary address. This maps to the postalCode property of the Applicant's primary address. required: - address_1 - address_2 - city - custom_data - date_of_birth - email_1 - first_name - integration_id - last_name - phone_1 - phone_1_type - state - x_property_id - x_unit_id - zip required: - meta - result _v1_applicants_realpage_{id}_put_input: type: object properties: last_name: type: string maxLength: 30 description: The last name associated with the applicant first_name: type: string maxLength: 30 description: The first name associated with the applicant middle_name: type: string maxLength: 30 description: The middle name associated with the applicant email_1: type: string format: email description: The primary email address associated with the applicant address_1: type: string description: The first address line associated with the applicant address_2: type: string description: The second address line associated with the applicant city: type: string description: The city associated with the applicant state: type: string description: The state associated with the applicant zip: type: string description: The zip code associated with the applicant country: type: string description: The country associated with the applicant _v1_applicants_realpage_{id}_put_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: id: type: string description: The Propexo unique identifier for the applicant last_name: type: string maxLength: 30 description: The last name associated with the applicant first_name: type: string maxLength: 30 description: The first name associated with the applicant middle_name: type: string maxLength: 30 description: The middle name associated with the applicant email_1: type: string format: email description: The primary email address associated with the applicant address_1: type: string description: The first address line associated with the applicant address_2: type: string description: The second address line associated with the applicant city: type: string description: The city associated with the applicant state: type: string description: The state associated with the applicant zip: type: string description: The zip code associated with the applicant country: type: string description: The country associated with the applicant required: - id required: - meta - result _v1_applicants_yardi__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration property_id: type: string description: The Propexo unique identifier for the property unit_id: type: string description: The Propexo unique identifier for the unit lead_source_id: type: string description: The Propexo unique identifier for the lead source employee_id: type: string description: The Propexo unique identifier for the employee third_party_id: type: string minLength: 1 description: A unique value provided to the PMS to uniquely identify the applicant from your system. organization_name: type: string description: The name of your organization. Yardi uses this for associating a applicant first_name: type: string description: The first name associated with the applicant last_name: type: string description: The last name associated with the applicant phone_1: type: string description: Primary phone number associated with the applicant phone_1_type: type: string enum: *a16 description: Type of the primary phone number phone_2: type: string description: Secondary phone number associated with the applicant phone_2_type: type: string enum: - FAX - HOME - MOBILE - OTHER - WORK description: Type of the secondary phone number email_1: type: string description: The primary email address associated with the applicant address_1: type: string description: The first address line associated with the applicant address_2: type: string description: The second address line associated with the applicant city: type: string description: The city associated with the applicant state: type: string description: The state associated with the applicant zip: type: string description: The zip code associated with the applicant target_move_in_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The move-in date associated with the lead. The timestamp will be stripped off and only the date will be used desired_num_bedrooms: type: number description: The desired number of bedrooms desired_lease_term_in_months: type: string description: The amount of months for the lease term notes: type: string description: Notes associated with the applicant events: type: array items: type: object properties: employee_id: type: string description: The Propexo unique identifier for the employee lead_source_id: type: string description: The Propexo unique identifier for the lead source unit_id: type: string description: The Propexo unique identifier for the unit. Only some events use this, including "Show" and "Appointment". event_name: type: string enum: *a44 description: The name or type of event. This has to be from a predefined set of events. event_datetime: type: string format: date-time description: The date when the event will occur notes: type: string maxLength: 256 description: Notes associated with the event reasons_for_event: type: string description: The reasons for the event required: - employee_id - event_name - event_datetime description: A list of events to create for the new applicant required: - integration_id - property_id - unit_id - lead_source_id - employee_id - third_party_id - organization_name - first_name - last_name _v1_applicants_yardi__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration property_id: type: string description: The Propexo unique identifier for the property unit_id: type: string description: The Propexo unique identifier for the unit lead_source_id: type: string description: The Propexo unique identifier for the lead source employee_id: type: string description: The Propexo unique identifier for the employee third_party_id: type: string minLength: 1 description: A unique value provided to the PMS to uniquely identify the applicant from your system. organization_name: type: string description: The name of your organization. Yardi uses this for associating a applicant first_name: type: string description: The first name associated with the applicant last_name: type: string description: The last name associated with the applicant phone_1: type: - string - "null" description: Primary phone number associated with the applicant phone_1_type: type: - string - "null" enum: *a16 description: Type of the primary phone number phone_2: type: - string - "null" description: Secondary phone number associated with the applicant phone_2_type: type: - string - "null" enum: - FAX - HOME - MOBILE - OTHER - WORK description: Type of the secondary phone number email_1: type: - string - "null" description: The primary email address associated with the applicant address_1: type: - string - "null" description: The first address line associated with the applicant address_2: type: - string - "null" description: The second address line associated with the applicant city: type: - string - "null" description: The city associated with the applicant state: type: - string - "null" description: The state associated with the applicant zip: type: - string - "null" description: The zip code associated with the applicant target_move_in_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" description: The move-in date associated with the lead. The timestamp will be stripped off and only the date will be used desired_num_bedrooms: type: - number - "null" description: The desired number of bedrooms desired_lease_term_in_months: type: - string - "null" description: The amount of months for the lease term notes: type: - string - "null" description: Notes associated with the applicant events: type: - array - "null" items: type: object properties: employee_id: type: string description: The Propexo unique identifier for the employee lead_source_id: type: string description: The Propexo unique identifier for the lead source unit_id: type: string description: The Propexo unique identifier for the unit. Only some events use this, including "Show" and "Appointment". event_name: type: string enum: *a44 description: The name or type of event. This has to be from a predefined set of events. event_datetime: type: string format: date-time description: The date when the event will occur notes: type: string maxLength: 256 description: Notes associated with the event reasons_for_event: type: string description: The reasons for the event required: - employee_id - event_name - event_datetime required: - integration_id - property_id - unit_id - lead_source_id - employee_id - third_party_id - organization_name - first_name - last_name - phone_1 - phone_1_type - phone_2 - phone_2_type - email_1 - address_1 - address_2 - city - state - zip - target_move_in_date - desired_num_bedrooms - desired_lease_term_in_months - notes - events required: - meta - result _v1_applicants_yardi_{applicant_id}_put_input: type: object properties: unit_id: type: string description: The Propexo unique identifier for the unit first_name: type: string description: The first name associated with the applicant last_name: type: string description: The last name associated with the applicant phone_1: type: string description: Primary phone number associated with the applicant phone_1_type: type: string enum: *a16 description: Type of the primary phone number phone_2: type: string description: Secondary phone number associated with the applicant phone_2_type: type: string enum: - FAX - HOME - MOBILE - OTHER - WORK description: Type of the secondary phone number email_1: type: string description: The primary email address associated with the applicant address_1: type: string description: The first address line associated with the applicant address_2: type: string description: The second address line associated with the applicant city: type: string description: The city associated with the applicant state: type: string description: The state associated with the applicant zip: type: string description: The zip code associated with the applicant country: type: string description: The country associated with the applicant notes: type: string description: Notes associated with the applicant _v1_applicants_yardi_{applicant_id}_put_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: applicant_id: type: string description: The Propexo unique identifier for the applicant unit_id: type: string description: The Propexo unique identifier for the unit first_name: type: string description: The first name associated with the applicant last_name: type: string description: The last name associated with the applicant phone_1: type: string description: Primary phone number associated with the applicant phone_1_type: type: string enum: *a16 description: Type of the primary phone number phone_2: type: string description: Secondary phone number associated with the applicant phone_2_type: type: string enum: - FAX - HOME - MOBILE - OTHER - WORK description: Type of the secondary phone number email_1: type: string description: The primary email address associated with the applicant address_1: type: string description: The first address line associated with the applicant address_2: type: string description: The second address line associated with the applicant city: type: string description: The city associated with the applicant state: type: string description: The state associated with the applicant zip: type: string description: The zip code associated with the applicant country: type: string description: The country associated with the applicant notes: type: string description: Notes associated with the applicant required: - applicant_id required: - meta - result _v1_applicants_rentvine__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration application_template_id: type: string description: "The Propexo unique identifier for the application template. The Rentvine application template dynamically defines which fields are required for each applicant/application: whether a field is active, disabled, required, or optional. A template may also allow some enums to be modified or for entire fields to be relabeled/repurposed. The functionality of a template is extensive and will likely require that you work with your customer to define a custom template for your application use case" leasing_agent_first_name: type: string description: The first name of the leasing agent. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements leasing_agent_last_name: type: string description: The last name of the leasing agent. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements leasing_agent_contact_info: type: string description: The contact info for the leasing agent. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements rent_amount_in_cents: type: integer minimum: 0 description: The rent amount in cents that the applicant will pay for the unit. This field is not configurable on the Rentvine template and is always required security_deposit_in_cents: type: integer minimum: 0 description: The security deposit in cents that the applicant will pay for the unit. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements move_in_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The desired move-in date to the unit listed in the application. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements lease_period_id: type: string description: The lease period to use for the application. If supplied, this field must be one of the approved lease periods defined on the Rentvine template. You can see a list of available choices for each application template on the appropriate lease period endpoint. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements or to change the list of available lease periods first_name: type: string description: The first name associated with the applicant. This field is not configurable on the Rentvine template and is always required middle_name: type: string description: The middle name associated with the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements last_name: type: string description: The last name associated with the applicant. This field is not configurable on the Rentvine template and is always required type: type: string enum: *a18 description: The type of applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements. Although the field itself can be made optional/required, the value must be one of the available choices and cannot be modified as part of the template marital_status: type: string enum: *a19 description: The marital status of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements. Although the field itself can be made optional/required, the value must be one of the available choices and cannot be modified as part of the template maiden_name: type: string description: The maiden name or birth name of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements height: type: string description: The height of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements weight: type: string description: The weight of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements eye_color: type: string description: The eye color of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements hair_color: type: string description: The hair color of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements phone_1: type: string pattern: ^\+?\d{1,50}$ description: Primary phone number associated with the applicant. An applicant can have no more than one of each phone type. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements phone_1_type: type: string enum: &a45 - HOME - WORK - MOBILE description: Type of the primary phone number. An applicant can have no more than one of each phone type phone_2: type: string pattern: ^\+?\d{1,50}$ description: Secondary phone number associated with the applicant. An applicant can have no more than one of each phone type. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements phone_2_type: type: string enum: &a46 - HOME - WORK - MOBILE description: Type of the secondary phone number. An applicant can have no more than one of each phone type. phone_3: type: string pattern: ^\+?\d{1,50}$ description: Third phone number associated with the applicant. An applicant can have no more than one of each phone type. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements phone_3_type: type: string enum: *a20 description: Type of the third phone number. An applicant can have no more than one of each phone type. email_1: type: string format: email description: The primary email address associated with the applicant. This field is not configurable on the Rentvine template and is always required date_of_birth: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date of birth associated with the applicant. This field is not configurable on the Rentvine template and is always required identification_number: type: string description: The Social Security Number or Individual Taxpayer Identification Number associated with the applicant. Rentvine uses a pre-2011 validation scheme for SSN's meaning that some valid SSNs will be incorrectly rejected. Reach out to support if you find that a valid SSN is being rejected. This field is not configurable on the Rentvine template and is always required citizenship: type: string description: The country of citizenship of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements place_of_birth: type: string description: The place of birth of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements passport_number: type: string description: The passport number of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements student_id: type: string description: The student ID number of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements drivers_license_number: type: string description: The driver's license number of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements drivers_license_state: type: string description: The issuing state of the applicant's driver's license. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements lead_source: type: string description: The name of the source of the lead or how the applicant heard of the property management company. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements emergency_contacts: type: array items: type: object properties: first_name: type: string description: The first name of the emergency contact. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements last_name: type: string description: The last name of the emergency contact. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements relationship: type: string description: The relationship of the emergency contact to the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements address_1: type: string description: The first line of the address of the emergency contact. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements address_2: type: string description: The second line of the address of the emergency contact. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements city: type: string description: The city of the address of the emergency contact. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements state: type: string description: The state of the address of the emergency contact. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements zip: type: string description: The zip code of the address of the emergency contact. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements country: type: string description: The country of the address of the emergency contact. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements phone_1: type: string pattern: ^\+?\d{1,50}$ description: The phone number of the emergency contact. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements phone_2: type: string pattern: ^\+?\d{1,50}$ description: The second phone number of the emergency contact. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements email_1: type: string format: email description: The email of the emergency contact. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements description: A list of emergency contacts for the applicant. Depending on the Rentvine template, this array can be customized to be either required or optional. The template may also require a minimum number of items in the array in order to pass validation. You will need to work with your customer directly to configure this field to your application requirements application_references: type: array items: type: object properties: first_name: type: string description: The first name of the applicant's reference. This field is not configurable on the Rentvine template and is always required last_name: type: string description: The last name of the applicant's reference. This field is not configurable on the Rentvine template and is always required relationship: type: string description: The relationship of the applicant's reference to the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements address_1: type: string description: The first line of the address of the applicant's reference. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements address_2: type: string description: The second line of the address of the applicant's reference. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements city: type: string description: The city of the address of the applicant's reference. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements state: type: string description: The state of the address of the applicant's reference. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements zip: type: string description: The zip code of the address of the applicant's reference. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements country: type: string description: The country of the address of the applicant's reference. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements phone_1: type: string pattern: ^\+?\d{1,50}$ description: The phone number of the applicant's reference. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements required: - first_name - last_name description: A list of applicant references for the application. Depending on the Rentvine template, this array can be customized to be either required or optional. The template may also require a minimum number of items in the array in order to pass validation. You will need to work with your customer directly to configure this field to your application requirements vehicles: type: array items: type: object properties: make: type: string description: The make of the vehicle. This field is not configurable on the Rentvine template and is always required model: type: string description: The model of the vehicle. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements year: type: integer description: The year the vehicle was made. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements color: type: string description: The color of the vehicle. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements license_plate_number: type: string description: The license plate number of the vehicle. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements license_plate_state: type: string description: The issuing state of the license plate. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements monthly_payment_in_cents: type: integer minimum: 0 description: If the vehicle is leased or financed, the applicant's monthly payment for the vehicle in cents. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements insurance_carrier: type: string description: The insurance carrier for the applicant's vehicle. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements required: - make description: A list of vehicles for the application. Depending on the Rentvine template, this array can be customized to be either required or optional. The template may also require a minimum number of items in the array in order to pass validation. You will need to work with your customer directly to configure this field to your application requirements other_occupants: type: array items: type: object properties: first_name: type: string description: The first name of the occupant. This field is not configurable on the Rentvine template and is always required last_name: type: string description: The last name of the occupant. This field is not configurable on the Rentvine template and is always required date_of_birth: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date of birth of the occupant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements relationship: type: string enum: *a21 description: The relationship of the occupant to the applicant. The only allowed value is "OTHER" and is used to represent non-applicants under 18 years old. Contact Propexo Support if you need to support a workflow that allows adding additional applicants to an application relationship_detail: type: string description: The relationship detail of the occupant to the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements required: - first_name - last_name - relationship description: A list of other occupants who will live in the unit, such as children, etc. Depending on the Rentvine template, this array can be customized to be either required or optional. The template may also require a minimum number of items in the array in order to pass validation. You will need to work with your customer directly to configure this field to your application requirements. Do not include any applicants in this list. If your application use case requires creating multiple applicants in the same application, please reach out to Propexo Support for help. pets: type: array items: type: object properties: name: type: string description: The name associated with the applicant pet. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements type: type: string description: The type associated with the applicant pet (or breed). This field is not configurable on the Rentvine template and is always required age_in_years: type: integer minimum: 0 description: The age in years of the applicant pet. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements weight_in_pounds: type: integer minimum: 0 description: The weight in pounds of the applicant pet. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements is_trained: type: boolean description: Whether the applicant pet is trained. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements color: type: string description: The color of the applicant pet. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements gender: type: string enum: *a17 description: The gender of the applicant pet. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements is_declawed: type: boolean description: Whether the applicant pet is declawed. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements is_vaccinated: type: boolean description: Whether the applicant pet is vaccinated. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements is_fixed: type: boolean description: Whether the applicant pet is fixed. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements required: - type description: A list of applicant pets. Depending on the Rentvine template, this array can be customized to be either required or optional. The template may also require a minimum number of items in the array in order to pass validation. You will need to work with your customer directly to configure this field to your application requirements address_history: type: array items: type: object properties: address_1: type: string description: The first address line associated with the applicant's historical address. This field is not configurable on the Rentvine template and is always required address_2: type: string description: The second address line associated with the applicant's historical address. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements city: type: string description: The city associated with the applicant's historical address. This field is not configurable on the Rentvine template and is always required state: type: string enum: *a22 description: The state associated with the applicant's historical address. This field is not configurable on the Rentvine template and is always required zip: type: string description: The zip code associated with the applicant's historical address. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements country: type: string enum: *a23 description: The country associated with the applicant's historical address. This field is not configurable on the Rentvine template and is always required. If your application needs to support submitting an applicant who previously or currently reside(s) in another country, please reach out to Propexo Support for help address_type: type: string enum: *a24 description: Whether the applicant previously owned or rented at this address. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements monthly_payment_in_cents: type: integer minimum: 0 description: For the applicant's historical address, the applicant's monthly payment for rent or mortgage in cents. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements move_in_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date when the applicant moved into this historical address. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements move_out_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date when the applicant moved out of this address. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements. Leave out this field to indicate that the given array item is the applicant's current address. At least one address in this array (the current address) is required. manager_name: type: string description: The name of a property manager who works at this address. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements manager_phone: type: string pattern: ^\+?\d{1,50}$ description: The phone number of a property manager who works at this address. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements manager_email: type: string format: email description: The email of a property manager who works at this address. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements reason_for_leaving: type: string description: The reason the applicant decided to leave this address. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements manager_type: type: string enum: *a25 description: The type of property manager who works at this address. This field is ignored for the current address. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements required: - address_1 - city - state - zip - country minItems: 1 description: The address history of the applicant. At least one address (the current address) must be provided. Note that Rentvine allows configuring different application template requirements for the current address vs. historical addresses. Depending on the Rentvine template, this array can be customized to be either required or optional. The template may also require a minimum number of items in the array in order to pass validation. You will need to work with your customer directly to configure this field to your application requirements. Assuming that a minimum number of addresses are required in the application template, the current address does not count towards the minimum number employment_history: type: array items: type: object properties: is_current_employer: type: boolean description: Whether this employment history entry is for a current employer. This field is not configurable on the Rentvine template and is always required name: type: string description: The name of the employer. This field is not configurable on the Rentvine template and is always required phone: type: string pattern: ^\+?\d{1,50}$ description: The phone number of the employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements address_1: type: string description: The first line of the address of the employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements address_2: type: string description: The second line of the address of the employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements city: type: string description: The city of the address of the employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements state: type: string description: The state of the address of the employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements zip: type: string description: The zip code of the address of the employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements country: type: string description: The country of the address of the employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements supervisor_first_name: type: string description: The first name of the applicant's supervisor at this employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements supervisor_last_name: type: string description: The last name of the applicant's supervisor at this employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements supervisor_title: type: string description: The title of the applicant's supervisor at this employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements supervisor_phone: type: string pattern: ^\+?\d{1,50}$ description: The phone number of the applicant's supervisor at this employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements supervisor_email: type: string format: email description: The email of the applicant's supervisor at this employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements position: type: string description: The position held at this employer, or the job description of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements monthly_income_in_cents: type: integer minimum: 0 description: "The monthly income of the applicant at this employer in cents. This field is not configurable on the Rentvine template and is always required. DEPRECATED: Use income_in_cents instead" deprecated: true income_in_cents: type: integer minimum: 0 description: The monthly income of the applicant at this employer in cents. This field is not configurable on the Rentvine template and is always required start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The start date of the applicant's employment at this employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The end date of the applicant's employment at this employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements required: - is_current_employer - name description: The employment history of the applicant. Depending on the Rentvine template, this array can be customized to be either required or optional. The template may also require a minimum number of items in the array in order to pass validation. You will need to work with your customer directly to configure this field to your application requirements other_income: type: array items: type: object properties: source: type: string description: The source of the income for the applicant. This field is not configurable on the Rentvine template and is always required monthly_income_in_cents: type: integer minimum: 0 description: The monthly income from this income source in cents. This field is not configurable on the Rentvine template and is always required phone: type: string pattern: ^\+?\d{1,50}$ description: The phone number related to this income source to use for income verification. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements required: - source - monthly_income_in_cents description: A list of other income sources for the applicant. Depending on the Rentvine template, this array can be customized to be either required or optional. The template may also require a minimum number of items in the array in order to pass validation. You will need to work with your customer directly to configure this field to your application requirements bank_accounts: type: array items: type: object properties: name: type: string description: The name of the bank where the account is held. This field is not configurable on the Rentvine template and is always required account_type: type: string enum: *a26 description: The type of bank account. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements account_number: type: string description: The account number of the bank account. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements balance_in_cents: type: integer minimum: 0 description: The current balance of the bank account in cents. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements required: - name description: A list of bank accounts for the applicant. Depending on the Rentvine template, this array can be customized to be either required or optional. The template may also require a minimum number of items in the array in order to pass validation. You will need to work with your customer directly to configure this field to your application requirements credit_cards: type: array items: type: object properties: name: type: string description: The name of the bank or issuer of the credit card. This field is not configurable on the Rentvine template and is always required balance_in_cents: type: integer minimum: 0 description: The current balance of the credit card in cents. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements required: - name description: A list of credit cards for the applicant. Depending on the Rentvine template, this array can be customized to be either required or optional. The template may also require a minimum number of items in the array in order to pass validation. You will need to work with your customer directly to configure this field to your application requirements assistance: type: object properties: agency_name: type: string description: The name of the agency who is providing assistance for the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements county: type: string description: The county where the agency is located. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements technician_name: type: string description: The name of the agency's contact assigned to support the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements phone: type: string pattern: ^\+?\d{1,50}$ description: The phone number of the agency or of the agency's contact. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements assistance_amount_in_cents: type: integer minimum: 0 description: The amount of assistance for the applicant in cents. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements beds_allowed: type: string description: The number of beds allowed for the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements are_utilities_covered: type: boolean description: Whether utilities are covered for the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements description: Details for payment assistance for the applicant. Depending on the Rentvine template, this array can be customized to be either required or optional. The template may also require a minimum number of items in the array in order to pass validation. You will need to work with your customer directly to configure this field to your application requirements unit_id: type: string description: The Propexo unique identifier for the unit. Rentvine always requires that a unit be specified in order to apply. However, Rentvine supports an alternative method which allows you to apply for a unit which doesn't exist in the Rentvine units list. In the rare event that this is needed for your application, please reach out to Propexo Support to configure this. application_id: type: string description: Optionally, the Propexo unique identifier for the application onto which you'd like to add this applicant. If omitted, Rentvine will create a new application for this applicant. required: - integration_id - application_template_id - rent_amount_in_cents - first_name - last_name - email_1 - date_of_birth - identification_number - address_history - unit_id _v1_applicants_rentvine__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration application_template_id: type: string description: "The Propexo unique identifier for the application template. The Rentvine application template dynamically defines which fields are required for each applicant/application: whether a field is active, disabled, required, or optional. A template may also allow some enums to be modified or for entire fields to be relabeled/repurposed. The functionality of a template is extensive and will likely require that you work with your customer to define a custom template for your application use case" leasing_agent_first_name: type: - string - "null" description: The first name of the leasing agent. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements leasing_agent_last_name: type: - string - "null" description: The last name of the leasing agent. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements leasing_agent_contact_info: type: - string - "null" description: The contact info for the leasing agent. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements rent_amount_in_cents: type: integer minimum: 0 description: The rent amount in cents that the applicant will pay for the unit. This field is not configurable on the Rentvine template and is always required security_deposit_in_cents: type: - integer - "null" minimum: 0 description: The security deposit in cents that the applicant will pay for the unit. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements move_in_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" description: The desired move-in date to the unit listed in the application. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements lease_period_id: type: - string - "null" description: The lease period to use for the application. If supplied, this field must be one of the approved lease periods defined on the Rentvine template. You can see a list of available choices for each application template on the appropriate lease period endpoint. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements or to change the list of available lease periods first_name: type: string description: The first name associated with the applicant. This field is not configurable on the Rentvine template and is always required middle_name: type: - string - "null" description: The middle name associated with the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements last_name: type: string description: The last name associated with the applicant. This field is not configurable on the Rentvine template and is always required type: type: - string - "null" enum: *a18 description: The type of applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements. Although the field itself can be made optional/required, the value must be one of the available choices and cannot be modified as part of the template marital_status: type: - string - "null" enum: *a19 description: The marital status of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements. Although the field itself can be made optional/required, the value must be one of the available choices and cannot be modified as part of the template maiden_name: type: - string - "null" description: The maiden name or birth name of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements height: type: - string - "null" description: The height of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements weight: type: - string - "null" description: The weight of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements eye_color: type: - string - "null" description: The eye color of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements hair_color: type: - string - "null" description: The hair color of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements phone_1: type: - string - "null" pattern: ^\+?\d{1,50}$ description: Primary phone number associated with the applicant. An applicant can have no more than one of each phone type. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements phone_1_type: type: - string - "null" enum: *a45 description: Type of the primary phone number. An applicant can have no more than one of each phone type phone_2: type: - string - "null" pattern: ^\+?\d{1,50}$ description: Secondary phone number associated with the applicant. An applicant can have no more than one of each phone type. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements phone_2_type: type: - string - "null" enum: *a46 description: Type of the secondary phone number. An applicant can have no more than one of each phone type. phone_3: type: - string - "null" pattern: ^\+?\d{1,50}$ description: Third phone number associated with the applicant. An applicant can have no more than one of each phone type. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements phone_3_type: type: - string - "null" enum: *a20 description: Type of the third phone number. An applicant can have no more than one of each phone type. email_1: type: string format: email description: The primary email address associated with the applicant. This field is not configurable on the Rentvine template and is always required date_of_birth: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" identification_number: type: string description: The Social Security Number or Individual Taxpayer Identification Number associated with the applicant. Rentvine uses a pre-2011 validation scheme for SSN's meaning that some valid SSNs will be incorrectly rejected. Reach out to support if you find that a valid SSN is being rejected. This field is not configurable on the Rentvine template and is always required citizenship: type: - string - "null" description: The country of citizenship of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements place_of_birth: type: - string - "null" description: The place of birth of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements passport_number: type: - string - "null" description: The passport number of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements student_id: type: - string - "null" description: The student ID number of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements drivers_license_number: type: - string - "null" description: The driver's license number of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements drivers_license_state: type: - string - "null" description: The issuing state of the applicant's driver's license. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements lead_source: type: - string - "null" description: The name of the source of the lead or how the applicant heard of the property management company. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements emergency_contacts: type: - array - "null" items: type: object properties: first_name: type: string description: The first name of the emergency contact. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements last_name: type: string description: The last name of the emergency contact. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements relationship: type: string description: The relationship of the emergency contact to the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements address_1: type: string description: The first line of the address of the emergency contact. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements address_2: type: string description: The second line of the address of the emergency contact. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements city: type: string description: The city of the address of the emergency contact. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements state: type: string description: The state of the address of the emergency contact. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements zip: type: string description: The zip code of the address of the emergency contact. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements country: type: string description: The country of the address of the emergency contact. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements phone_1: type: string pattern: ^\+?\d{1,50}$ description: The phone number of the emergency contact. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements phone_2: type: string pattern: ^\+?\d{1,50}$ description: The second phone number of the emergency contact. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements email_1: type: string format: email description: The email of the emergency contact. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements application_references: type: - array - "null" items: type: object properties: first_name: type: string description: The first name of the applicant's reference. This field is not configurable on the Rentvine template and is always required last_name: type: string description: The last name of the applicant's reference. This field is not configurable on the Rentvine template and is always required relationship: type: string description: The relationship of the applicant's reference to the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements address_1: type: string description: The first line of the address of the applicant's reference. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements address_2: type: string description: The second line of the address of the applicant's reference. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements city: type: string description: The city of the address of the applicant's reference. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements state: type: string description: The state of the address of the applicant's reference. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements zip: type: string description: The zip code of the address of the applicant's reference. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements country: type: string description: The country of the address of the applicant's reference. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements phone_1: type: string pattern: ^\+?\d{1,50}$ description: The phone number of the applicant's reference. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements required: - first_name - last_name vehicles: type: - array - "null" items: type: object properties: make: type: string description: The make of the vehicle. This field is not configurable on the Rentvine template and is always required model: type: string description: The model of the vehicle. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements year: type: integer description: The year the vehicle was made. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements color: type: string description: The color of the vehicle. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements license_plate_number: type: string description: The license plate number of the vehicle. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements license_plate_state: type: string description: The issuing state of the license plate. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements monthly_payment_in_cents: type: integer minimum: 0 description: If the vehicle is leased or financed, the applicant's monthly payment for the vehicle in cents. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements insurance_carrier: type: string description: The insurance carrier for the applicant's vehicle. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements required: - make other_occupants: type: - array - "null" items: type: object properties: first_name: type: string description: The first name of the occupant. This field is not configurable on the Rentvine template and is always required last_name: type: string description: The last name of the occupant. This field is not configurable on the Rentvine template and is always required date_of_birth: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date of birth of the occupant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements relationship: type: string enum: *a21 description: The relationship of the occupant to the applicant. The only allowed value is "OTHER" and is used to represent non-applicants under 18 years old. Contact Propexo Support if you need to support a workflow that allows adding additional applicants to an application relationship_detail: type: string description: The relationship detail of the occupant to the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements required: - first_name - last_name - relationship pets: type: - array - "null" items: type: object properties: name: type: string description: The name associated with the applicant pet. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements type: type: string description: The type associated with the applicant pet (or breed). This field is not configurable on the Rentvine template and is always required age_in_years: type: integer minimum: 0 description: The age in years of the applicant pet. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements weight_in_pounds: type: integer minimum: 0 description: The weight in pounds of the applicant pet. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements is_trained: type: boolean description: Whether the applicant pet is trained. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements color: type: string description: The color of the applicant pet. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements gender: type: string enum: *a17 description: The gender of the applicant pet. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements is_declawed: type: boolean description: Whether the applicant pet is declawed. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements is_vaccinated: type: boolean description: Whether the applicant pet is vaccinated. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements is_fixed: type: boolean description: Whether the applicant pet is fixed. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements required: - type address_history: type: array items: type: object properties: address_1: type: string description: The first address line associated with the applicant's historical address. This field is not configurable on the Rentvine template and is always required address_2: type: string description: The second address line associated with the applicant's historical address. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements city: type: string description: The city associated with the applicant's historical address. This field is not configurable on the Rentvine template and is always required state: type: string enum: *a22 description: The state associated with the applicant's historical address. This field is not configurable on the Rentvine template and is always required zip: type: string description: The zip code associated with the applicant's historical address. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements country: type: string enum: *a23 description: The country associated with the applicant's historical address. This field is not configurable on the Rentvine template and is always required. If your application needs to support submitting an applicant who previously or currently reside(s) in another country, please reach out to Propexo Support for help address_type: type: string enum: *a24 description: Whether the applicant previously owned or rented at this address. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements monthly_payment_in_cents: type: integer minimum: 0 description: For the applicant's historical address, the applicant's monthly payment for rent or mortgage in cents. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements move_in_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date when the applicant moved into this historical address. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements move_out_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date when the applicant moved out of this address. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements. Leave out this field to indicate that the given array item is the applicant's current address. At least one address in this array (the current address) is required. manager_name: type: string description: The name of a property manager who works at this address. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements manager_phone: type: string pattern: ^\+?\d{1,50}$ description: The phone number of a property manager who works at this address. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements manager_email: type: string format: email description: The email of a property manager who works at this address. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements reason_for_leaving: type: string description: The reason the applicant decided to leave this address. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements manager_type: type: string enum: *a25 description: The type of property manager who works at this address. This field is ignored for the current address. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements required: - address_1 - city - state - zip - country employment_history: type: - array - "null" items: type: object properties: is_current_employer: type: boolean description: Whether this employment history entry is for a current employer. This field is not configurable on the Rentvine template and is always required name: type: string description: The name of the employer. This field is not configurable on the Rentvine template and is always required phone: type: string pattern: ^\+?\d{1,50}$ description: The phone number of the employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements address_1: type: string description: The first line of the address of the employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements address_2: type: string description: The second line of the address of the employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements city: type: string description: The city of the address of the employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements state: type: string description: The state of the address of the employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements zip: type: string description: The zip code of the address of the employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements country: type: string description: The country of the address of the employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements supervisor_first_name: type: string description: The first name of the applicant's supervisor at this employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements supervisor_last_name: type: string description: The last name of the applicant's supervisor at this employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements supervisor_title: type: string description: The title of the applicant's supervisor at this employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements supervisor_phone: type: string pattern: ^\+?\d{1,50}$ description: The phone number of the applicant's supervisor at this employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements supervisor_email: type: string format: email description: The email of the applicant's supervisor at this employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements position: type: string description: The position held at this employer, or the job description of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements monthly_income_in_cents: type: integer minimum: 0 description: "The monthly income of the applicant at this employer in cents. This field is not configurable on the Rentvine template and is always required. DEPRECATED: Use income_in_cents instead" deprecated: true x-fern-availability: deprecated income_in_cents: type: integer minimum: 0 description: The monthly income of the applicant at this employer in cents. This field is not configurable on the Rentvine template and is always required start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The start date of the applicant's employment at this employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The end date of the applicant's employment at this employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements required: - is_current_employer - name other_income: type: - array - "null" items: type: object properties: source: type: string description: The source of the income for the applicant. This field is not configurable on the Rentvine template and is always required monthly_income_in_cents: type: integer minimum: 0 description: The monthly income from this income source in cents. This field is not configurable on the Rentvine template and is always required phone: type: string pattern: ^\+?\d{1,50}$ description: The phone number related to this income source to use for income verification. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements required: - source - monthly_income_in_cents bank_accounts: type: - array - "null" items: type: object properties: name: type: string description: The name of the bank where the account is held. This field is not configurable on the Rentvine template and is always required account_type: type: string enum: *a26 description: The type of bank account. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements account_number: type: string description: The account number of the bank account. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements balance_in_cents: type: integer minimum: 0 description: The current balance of the bank account in cents. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements required: - name credit_cards: type: - array - "null" items: type: object properties: name: type: string description: The name of the bank or issuer of the credit card. This field is not configurable on the Rentvine template and is always required balance_in_cents: type: integer minimum: 0 description: The current balance of the credit card in cents. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements required: - name assistance: type: - object - "null" properties: agency_name: type: string description: The name of the agency who is providing assistance for the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements county: type: string description: The county where the agency is located. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements technician_name: type: string description: The name of the agency's contact assigned to support the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements phone: type: string pattern: ^\+?\d{1,50}$ description: The phone number of the agency or of the agency's contact. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements assistance_amount_in_cents: type: integer minimum: 0 description: The amount of assistance for the applicant in cents. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements beds_allowed: type: string description: The number of beds allowed for the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements are_utilities_covered: type: boolean description: Whether utilities are covered for the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements unit_id: type: string description: The Propexo unique identifier for the unit. Rentvine always requires that a unit be specified in order to apply. However, Rentvine supports an alternative method which allows you to apply for a unit which doesn't exist in the Rentvine units list. In the rare event that this is needed for your application, please reach out to Propexo Support to configure this. application_id: type: - string - "null" description: Optionally, the Propexo unique identifier for the application onto which you'd like to add this applicant. If omitted, Rentvine will create a new application for this applicant. required: - integration_id - application_template_id - leasing_agent_first_name - leasing_agent_last_name - leasing_agent_contact_info - rent_amount_in_cents - security_deposit_in_cents - move_in_date - lease_period_id - first_name - middle_name - last_name - type - marital_status - maiden_name - height - weight - eye_color - hair_color - phone_1 - phone_1_type - phone_2 - phone_2_type - phone_3 - phone_3_type - email_1 - date_of_birth - identification_number - citizenship - place_of_birth - passport_number - student_id - drivers_license_number - drivers_license_state - lead_source - emergency_contacts - application_references - vehicles - other_occupants - pets - address_history - employment_history - other_income - bank_accounts - credit_cards - assistance - unit_id - application_id required: - meta - result _v1_applicants_rentvine_{applicant_id}_put_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration application_template_id: type: string description: "The Propexo unique identifier for the application template. The Rentvine application template dynamically defines which fields are required for each applicant/application: whether a field is active, disabled, required, or optional. A template may also allow some enums to be modified or for entire fields to be relabeled/repurposed. The functionality of a template is extensive and will likely require that you work with your customer to define a custom template for your application use case" leasing_agent_first_name: type: string description: The first name of the leasing agent. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements leasing_agent_last_name: type: string description: The last name of the leasing agent. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements leasing_agent_contact_info: type: string description: The contact info for the leasing agent. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements rent_amount_in_cents: type: integer minimum: 0 description: The rent amount in cents that the applicant will pay for the unit. This field is not configurable on the Rentvine template and is always required security_deposit_in_cents: type: integer minimum: 0 description: The security deposit in cents that the applicant will pay for the unit. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements move_in_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The desired move-in date to the unit listed in the application. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements lease_period_id: type: string description: The lease period to use for the application. If supplied, this field must be one of the approved lease periods defined on the Rentvine template. You can see a list of available choices for each application template on the appropriate lease period endpoint. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements or to change the list of available lease periods first_name: type: string description: The first name associated with the applicant. This field is not configurable on the Rentvine template and is always required middle_name: type: string description: The middle name associated with the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements last_name: type: string description: The last name associated with the applicant. This field is not configurable on the Rentvine template and is always required type: type: string enum: *a18 description: The type of applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements. Although the field itself can be made optional/required, the value must be one of the available choices and cannot be modified as part of the template marital_status: type: string enum: *a19 description: The marital status of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements. Although the field itself can be made optional/required, the value must be one of the available choices and cannot be modified as part of the template maiden_name: type: string description: The maiden name or birth name of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements height: type: string description: The height of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements weight: type: string description: The weight of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements eye_color: type: string description: The eye color of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements hair_color: type: string description: The hair color of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements phone_1: type: string pattern: ^\+?\d{1,50}$ description: Primary phone number associated with the applicant. An applicant can have no more than one of each phone type. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements phone_1_type: type: string enum: *a45 description: Type of the primary phone number. An applicant can have no more than one of each phone type phone_2: type: string pattern: ^\+?\d{1,50}$ description: Secondary phone number associated with the applicant. An applicant can have no more than one of each phone type. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements phone_2_type: type: string enum: *a46 description: Type of the secondary phone number. An applicant can have no more than one of each phone type. phone_3: type: string pattern: ^\+?\d{1,50}$ description: Third phone number associated with the applicant. An applicant can have no more than one of each phone type. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements phone_3_type: type: string enum: *a20 description: Type of the third phone number. An applicant can have no more than one of each phone type. email_1: type: string format: email description: The primary email address associated with the applicant. This field is not configurable on the Rentvine template and is always required date_of_birth: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date of birth associated with the applicant. This field is not configurable on the Rentvine template and is always required identification_number: type: string description: The Social Security Number or Individual Taxpayer Identification Number associated with the applicant. Rentvine uses a pre-2011 validation scheme for SSN's meaning that some valid SSNs will be incorrectly rejected. Reach out to support if you find that a valid SSN is being rejected. This field is not configurable on the Rentvine template and is always required citizenship: type: string description: The country of citizenship of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements place_of_birth: type: string description: The place of birth of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements passport_number: type: string description: The passport number of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements student_id: type: string description: The student ID number of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements drivers_license_number: type: string description: The driver's license number of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements drivers_license_state: type: string description: The issuing state of the applicant's driver's license. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements lead_source: type: string description: The name of the source of the lead or how the applicant heard of the property management company. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements emergency_contacts: type: array items: type: object properties: first_name: type: string description: The first name of the emergency contact. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements last_name: type: string description: The last name of the emergency contact. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements relationship: type: string description: The relationship of the emergency contact to the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements address_1: type: string description: The first line of the address of the emergency contact. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements address_2: type: string description: The second line of the address of the emergency contact. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements city: type: string description: The city of the address of the emergency contact. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements state: type: string description: The state of the address of the emergency contact. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements zip: type: string description: The zip code of the address of the emergency contact. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements country: type: string description: The country of the address of the emergency contact. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements phone_1: type: string pattern: ^\+?\d{1,50}$ description: The phone number of the emergency contact. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements phone_2: type: string pattern: ^\+?\d{1,50}$ description: The second phone number of the emergency contact. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements email_1: type: string format: email description: The email of the emergency contact. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements description: A list of emergency contacts for the applicant. Depending on the Rentvine template, this array can be customized to be either required or optional. The template may also require a minimum number of items in the array in order to pass validation. You will need to work with your customer directly to configure this field to your application requirements application_references: type: array items: type: object properties: first_name: type: string description: The first name of the applicant's reference. This field is not configurable on the Rentvine template and is always required last_name: type: string description: The last name of the applicant's reference. This field is not configurable on the Rentvine template and is always required relationship: type: string description: The relationship of the applicant's reference to the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements address_1: type: string description: The first line of the address of the applicant's reference. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements address_2: type: string description: The second line of the address of the applicant's reference. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements city: type: string description: The city of the address of the applicant's reference. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements state: type: string description: The state of the address of the applicant's reference. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements zip: type: string description: The zip code of the address of the applicant's reference. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements country: type: string description: The country of the address of the applicant's reference. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements phone_1: type: string pattern: ^\+?\d{1,50}$ description: The phone number of the applicant's reference. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements required: - first_name - last_name description: A list of applicant references for the application. Depending on the Rentvine template, this array can be customized to be either required or optional. The template may also require a minimum number of items in the array in order to pass validation. You will need to work with your customer directly to configure this field to your application requirements vehicles: type: array items: type: object properties: make: type: string description: The make of the vehicle. This field is not configurable on the Rentvine template and is always required model: type: string description: The model of the vehicle. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements year: type: integer description: The year the vehicle was made. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements color: type: string description: The color of the vehicle. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements license_plate_number: type: string description: The license plate number of the vehicle. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements license_plate_state: type: string description: The issuing state of the license plate. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements monthly_payment_in_cents: type: integer minimum: 0 description: If the vehicle is leased or financed, the applicant's monthly payment for the vehicle in cents. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements insurance_carrier: type: string description: The insurance carrier for the applicant's vehicle. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements required: - make description: A list of vehicles for the application. Depending on the Rentvine template, this array can be customized to be either required or optional. The template may also require a minimum number of items in the array in order to pass validation. You will need to work with your customer directly to configure this field to your application requirements other_occupants: type: array items: type: object properties: first_name: type: string description: The first name of the occupant. This field is not configurable on the Rentvine template and is always required last_name: type: string description: The last name of the occupant. This field is not configurable on the Rentvine template and is always required date_of_birth: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date of birth of the occupant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements relationship: type: string enum: *a21 description: The relationship of the occupant to the applicant. The only allowed value is "OTHER" and is used to represent non-applicants under 18 years old. Contact Propexo Support if you need to support a workflow that allows adding additional applicants to an application relationship_detail: type: string description: The relationship detail of the occupant to the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements required: - first_name - last_name - relationship description: A list of other occupants who will live in the unit, such as children, etc. Depending on the Rentvine template, this array can be customized to be either required or optional. The template may also require a minimum number of items in the array in order to pass validation. You will need to work with your customer directly to configure this field to your application requirements. Do not include any applicants in this list. If your application use case requires creating multiple applicants in the same application, please reach out to Propexo Support for help. pets: type: array items: type: object properties: name: type: string description: The name associated with the applicant pet. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements type: type: string description: The type associated with the applicant pet (or breed). This field is not configurable on the Rentvine template and is always required age_in_years: type: integer minimum: 0 description: The age in years of the applicant pet. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements weight_in_pounds: type: integer minimum: 0 description: The weight in pounds of the applicant pet. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements is_trained: type: boolean description: Whether the applicant pet is trained. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements color: type: string description: The color of the applicant pet. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements gender: type: string enum: *a17 description: The gender of the applicant pet. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements is_declawed: type: boolean description: Whether the applicant pet is declawed. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements is_vaccinated: type: boolean description: Whether the applicant pet is vaccinated. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements is_fixed: type: boolean description: Whether the applicant pet is fixed. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements required: - type description: A list of applicant pets. Depending on the Rentvine template, this array can be customized to be either required or optional. The template may also require a minimum number of items in the array in order to pass validation. You will need to work with your customer directly to configure this field to your application requirements address_history: type: array items: type: object properties: address_1: type: string description: The first address line associated with the applicant's historical address. This field is not configurable on the Rentvine template and is always required address_2: type: string description: The second address line associated with the applicant's historical address. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements city: type: string description: The city associated with the applicant's historical address. This field is not configurable on the Rentvine template and is always required state: type: string enum: *a22 description: The state associated with the applicant's historical address. This field is not configurable on the Rentvine template and is always required zip: type: string description: The zip code associated with the applicant's historical address. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements country: type: string enum: *a23 description: The country associated with the applicant's historical address. This field is not configurable on the Rentvine template and is always required. If your application needs to support submitting an applicant who previously or currently reside(s) in another country, please reach out to Propexo Support for help address_type: type: string enum: *a24 description: Whether the applicant previously owned or rented at this address. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements monthly_payment_in_cents: type: integer minimum: 0 description: For the applicant's historical address, the applicant's monthly payment for rent or mortgage in cents. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements move_in_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date when the applicant moved into this historical address. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements move_out_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date when the applicant moved out of this address. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements. Leave out this field to indicate that the given array item is the applicant's current address. At least one address in this array (the current address) is required. manager_name: type: string description: The name of a property manager who works at this address. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements manager_phone: type: string pattern: ^\+?\d{1,50}$ description: The phone number of a property manager who works at this address. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements manager_email: type: string format: email description: The email of a property manager who works at this address. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements reason_for_leaving: type: string description: The reason the applicant decided to leave this address. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements manager_type: type: string enum: *a25 description: The type of property manager who works at this address. This field is ignored for the current address. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements required: - address_1 - city - state - zip - country minItems: 1 description: The address history of the applicant. At least one address (the current address) must be provided. Note that Rentvine allows configuring different application template requirements for the current address vs. historical addresses. Depending on the Rentvine template, this array can be customized to be either required or optional. The template may also require a minimum number of items in the array in order to pass validation. You will need to work with your customer directly to configure this field to your application requirements. Assuming that a minimum number of addresses are required in the application template, the current address does not count towards the minimum number employment_history: type: array items: type: object properties: is_current_employer: type: boolean description: Whether this employment history entry is for a current employer. This field is not configurable on the Rentvine template and is always required name: type: string description: The name of the employer. This field is not configurable on the Rentvine template and is always required phone: type: string pattern: ^\+?\d{1,50}$ description: The phone number of the employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements address_1: type: string description: The first line of the address of the employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements address_2: type: string description: The second line of the address of the employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements city: type: string description: The city of the address of the employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements state: type: string description: The state of the address of the employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements zip: type: string description: The zip code of the address of the employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements country: type: string description: The country of the address of the employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements supervisor_first_name: type: string description: The first name of the applicant's supervisor at this employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements supervisor_last_name: type: string description: The last name of the applicant's supervisor at this employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements supervisor_title: type: string description: The title of the applicant's supervisor at this employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements supervisor_phone: type: string pattern: ^\+?\d{1,50}$ description: The phone number of the applicant's supervisor at this employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements supervisor_email: type: string format: email description: The email of the applicant's supervisor at this employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements position: type: string description: The position held at this employer, or the job description of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements monthly_income_in_cents: type: integer minimum: 0 description: "The monthly income of the applicant at this employer in cents. This field is not configurable on the Rentvine template and is always required. DEPRECATED: Use income_in_cents instead" deprecated: true income_in_cents: type: integer minimum: 0 description: The monthly income of the applicant at this employer in cents. This field is not configurable on the Rentvine template and is always required start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The start date of the applicant's employment at this employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The end date of the applicant's employment at this employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements required: - is_current_employer - name description: The employment history of the applicant. Depending on the Rentvine template, this array can be customized to be either required or optional. The template may also require a minimum number of items in the array in order to pass validation. You will need to work with your customer directly to configure this field to your application requirements other_income: type: array items: type: object properties: source: type: string description: The source of the income for the applicant. This field is not configurable on the Rentvine template and is always required monthly_income_in_cents: type: integer minimum: 0 description: The monthly income from this income source in cents. This field is not configurable on the Rentvine template and is always required phone: type: string pattern: ^\+?\d{1,50}$ description: The phone number related to this income source to use for income verification. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements required: - source - monthly_income_in_cents description: A list of other income sources for the applicant. Depending on the Rentvine template, this array can be customized to be either required or optional. The template may also require a minimum number of items in the array in order to pass validation. You will need to work with your customer directly to configure this field to your application requirements bank_accounts: type: array items: type: object properties: name: type: string description: The name of the bank where the account is held. This field is not configurable on the Rentvine template and is always required account_type: type: string enum: *a26 description: The type of bank account. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements account_number: type: string description: The account number of the bank account. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements balance_in_cents: type: integer minimum: 0 description: The current balance of the bank account in cents. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements required: - name description: A list of bank accounts for the applicant. Depending on the Rentvine template, this array can be customized to be either required or optional. The template may also require a minimum number of items in the array in order to pass validation. You will need to work with your customer directly to configure this field to your application requirements credit_cards: type: array items: type: object properties: name: type: string description: The name of the bank or issuer of the credit card. This field is not configurable on the Rentvine template and is always required balance_in_cents: type: integer minimum: 0 description: The current balance of the credit card in cents. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements required: - name description: A list of credit cards for the applicant. Depending on the Rentvine template, this array can be customized to be either required or optional. The template may also require a minimum number of items in the array in order to pass validation. You will need to work with your customer directly to configure this field to your application requirements assistance: type: object properties: agency_name: type: string description: The name of the agency who is providing assistance for the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements county: type: string description: The county where the agency is located. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements technician_name: type: string description: The name of the agency's contact assigned to support the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements phone: type: string pattern: ^\+?\d{1,50}$ description: The phone number of the agency or of the agency's contact. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements assistance_amount_in_cents: type: integer minimum: 0 description: The amount of assistance for the applicant in cents. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements beds_allowed: type: string description: The number of beds allowed for the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements are_utilities_covered: type: boolean description: Whether utilities are covered for the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements description: Details for payment assistance for the applicant. Depending on the Rentvine template, this array can be customized to be either required or optional. The template may also require a minimum number of items in the array in order to pass validation. You will need to work with your customer directly to configure this field to your application requirements required: - integration_id - application_template_id - rent_amount_in_cents - first_name - last_name - email_1 - date_of_birth - identification_number - address_history _v1_applicants_rentvine_{applicant_id}_put_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration application_template_id: type: string description: "The Propexo unique identifier for the application template. The Rentvine application template dynamically defines which fields are required for each applicant/application: whether a field is active, disabled, required, or optional. A template may also allow some enums to be modified or for entire fields to be relabeled/repurposed. The functionality of a template is extensive and will likely require that you work with your customer to define a custom template for your application use case" leasing_agent_first_name: type: string description: The first name of the leasing agent. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements leasing_agent_last_name: type: string description: The last name of the leasing agent. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements leasing_agent_contact_info: type: string description: The contact info for the leasing agent. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements rent_amount_in_cents: type: integer minimum: 0 description: The rent amount in cents that the applicant will pay for the unit. This field is not configurable on the Rentvine template and is always required security_deposit_in_cents: type: integer minimum: 0 description: The security deposit in cents that the applicant will pay for the unit. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements move_in_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The desired move-in date to the unit listed in the application. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements lease_period_id: type: string description: The lease period to use for the application. If supplied, this field must be one of the approved lease periods defined on the Rentvine template. You can see a list of available choices for each application template on the appropriate lease period endpoint. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements or to change the list of available lease periods first_name: type: string description: The first name associated with the applicant. This field is not configurable on the Rentvine template and is always required middle_name: type: string description: The middle name associated with the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements last_name: type: string description: The last name associated with the applicant. This field is not configurable on the Rentvine template and is always required type: type: string enum: *a18 description: The type of applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements. Although the field itself can be made optional/required, the value must be one of the available choices and cannot be modified as part of the template marital_status: type: string enum: *a19 description: The marital status of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements. Although the field itself can be made optional/required, the value must be one of the available choices and cannot be modified as part of the template maiden_name: type: string description: The maiden name or birth name of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements height: type: string description: The height of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements weight: type: string description: The weight of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements eye_color: type: string description: The eye color of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements hair_color: type: string description: The hair color of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements phone_1: type: string pattern: ^\+?\d{1,50}$ description: Primary phone number associated with the applicant. An applicant can have no more than one of each phone type. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements phone_1_type: type: string enum: *a45 description: Type of the primary phone number. An applicant can have no more than one of each phone type phone_2: type: string pattern: ^\+?\d{1,50}$ description: Secondary phone number associated with the applicant. An applicant can have no more than one of each phone type. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements phone_2_type: type: string enum: *a46 description: Type of the secondary phone number. An applicant can have no more than one of each phone type. phone_3: type: string pattern: ^\+?\d{1,50}$ description: Third phone number associated with the applicant. An applicant can have no more than one of each phone type. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements phone_3_type: type: string enum: *a20 description: Type of the third phone number. An applicant can have no more than one of each phone type. email_1: type: string format: email description: The primary email address associated with the applicant. This field is not configurable on the Rentvine template and is always required date_of_birth: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date of birth associated with the applicant. This field is not configurable on the Rentvine template and is always required identification_number: type: string description: The Social Security Number or Individual Taxpayer Identification Number associated with the applicant. Rentvine uses a pre-2011 validation scheme for SSN's meaning that some valid SSNs will be incorrectly rejected. Reach out to support if you find that a valid SSN is being rejected. This field is not configurable on the Rentvine template and is always required citizenship: type: string description: The country of citizenship of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements place_of_birth: type: string description: The place of birth of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements passport_number: type: string description: The passport number of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements student_id: type: string description: The student ID number of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements drivers_license_number: type: string description: The driver's license number of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements drivers_license_state: type: string description: The issuing state of the applicant's driver's license. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements lead_source: type: string description: The name of the source of the lead or how the applicant heard of the property management company. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements emergency_contacts: type: array items: type: object properties: first_name: type: string description: The first name of the emergency contact. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements last_name: type: string description: The last name of the emergency contact. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements relationship: type: string description: The relationship of the emergency contact to the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements address_1: type: string description: The first line of the address of the emergency contact. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements address_2: type: string description: The second line of the address of the emergency contact. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements city: type: string description: The city of the address of the emergency contact. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements state: type: string description: The state of the address of the emergency contact. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements zip: type: string description: The zip code of the address of the emergency contact. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements country: type: string description: The country of the address of the emergency contact. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements phone_1: type: string pattern: ^\+?\d{1,50}$ description: The phone number of the emergency contact. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements phone_2: type: string pattern: ^\+?\d{1,50}$ description: The second phone number of the emergency contact. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements email_1: type: string format: email description: The email of the emergency contact. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements application_references: type: array items: type: object properties: first_name: type: string description: The first name of the applicant's reference. This field is not configurable on the Rentvine template and is always required last_name: type: string description: The last name of the applicant's reference. This field is not configurable on the Rentvine template and is always required relationship: type: string description: The relationship of the applicant's reference to the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements address_1: type: string description: The first line of the address of the applicant's reference. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements address_2: type: string description: The second line of the address of the applicant's reference. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements city: type: string description: The city of the address of the applicant's reference. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements state: type: string description: The state of the address of the applicant's reference. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements zip: type: string description: The zip code of the address of the applicant's reference. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements country: type: string description: The country of the address of the applicant's reference. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements phone_1: type: string pattern: ^\+?\d{1,50}$ description: The phone number of the applicant's reference. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements required: - first_name - last_name vehicles: type: array items: type: object properties: make: type: string description: The make of the vehicle. This field is not configurable on the Rentvine template and is always required model: type: string description: The model of the vehicle. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements year: type: integer description: The year the vehicle was made. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements color: type: string description: The color of the vehicle. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements license_plate_number: type: string description: The license plate number of the vehicle. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements license_plate_state: type: string description: The issuing state of the license plate. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements monthly_payment_in_cents: type: integer minimum: 0 description: If the vehicle is leased or financed, the applicant's monthly payment for the vehicle in cents. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements insurance_carrier: type: string description: The insurance carrier for the applicant's vehicle. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements required: - make other_occupants: type: array items: type: object properties: first_name: type: string description: The first name of the occupant. This field is not configurable on the Rentvine template and is always required last_name: type: string description: The last name of the occupant. This field is not configurable on the Rentvine template and is always required date_of_birth: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date of birth of the occupant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements relationship: type: string enum: *a21 description: The relationship of the occupant to the applicant. The only allowed value is "OTHER" and is used to represent non-applicants under 18 years old. Contact Propexo Support if you need to support a workflow that allows adding additional applicants to an application relationship_detail: type: string description: The relationship detail of the occupant to the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements required: - first_name - last_name - relationship pets: type: array items: type: object properties: name: type: string description: The name associated with the applicant pet. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements type: type: string description: The type associated with the applicant pet (or breed). This field is not configurable on the Rentvine template and is always required age_in_years: type: integer minimum: 0 description: The age in years of the applicant pet. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements weight_in_pounds: type: integer minimum: 0 description: The weight in pounds of the applicant pet. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements is_trained: type: boolean description: Whether the applicant pet is trained. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements color: type: string description: The color of the applicant pet. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements gender: type: string enum: *a17 description: The gender of the applicant pet. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements is_declawed: type: boolean description: Whether the applicant pet is declawed. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements is_vaccinated: type: boolean description: Whether the applicant pet is vaccinated. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements is_fixed: type: boolean description: Whether the applicant pet is fixed. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements required: - type address_history: type: array items: type: object properties: address_1: type: string description: The first address line associated with the applicant's historical address. This field is not configurable on the Rentvine template and is always required address_2: type: string description: The second address line associated with the applicant's historical address. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements city: type: string description: The city associated with the applicant's historical address. This field is not configurable on the Rentvine template and is always required state: type: string enum: *a22 description: The state associated with the applicant's historical address. This field is not configurable on the Rentvine template and is always required zip: type: string description: The zip code associated with the applicant's historical address. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements country: type: string enum: *a23 description: The country associated with the applicant's historical address. This field is not configurable on the Rentvine template and is always required. If your application needs to support submitting an applicant who previously or currently reside(s) in another country, please reach out to Propexo Support for help address_type: type: string enum: *a24 description: Whether the applicant previously owned or rented at this address. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements monthly_payment_in_cents: type: integer minimum: 0 description: For the applicant's historical address, the applicant's monthly payment for rent or mortgage in cents. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements move_in_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date when the applicant moved into this historical address. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements move_out_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date when the applicant moved out of this address. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements. Leave out this field to indicate that the given array item is the applicant's current address. At least one address in this array (the current address) is required. manager_name: type: string description: The name of a property manager who works at this address. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements manager_phone: type: string pattern: ^\+?\d{1,50}$ description: The phone number of a property manager who works at this address. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements manager_email: type: string format: email description: The email of a property manager who works at this address. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements reason_for_leaving: type: string description: The reason the applicant decided to leave this address. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements manager_type: type: string enum: *a25 description: The type of property manager who works at this address. This field is ignored for the current address. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements required: - address_1 - city - state - zip - country employment_history: type: array items: type: object properties: is_current_employer: type: boolean description: Whether this employment history entry is for a current employer. This field is not configurable on the Rentvine template and is always required name: type: string description: The name of the employer. This field is not configurable on the Rentvine template and is always required phone: type: string pattern: ^\+?\d{1,50}$ description: The phone number of the employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements address_1: type: string description: The first line of the address of the employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements address_2: type: string description: The second line of the address of the employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements city: type: string description: The city of the address of the employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements state: type: string description: The state of the address of the employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements zip: type: string description: The zip code of the address of the employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements country: type: string description: The country of the address of the employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements supervisor_first_name: type: string description: The first name of the applicant's supervisor at this employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements supervisor_last_name: type: string description: The last name of the applicant's supervisor at this employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements supervisor_title: type: string description: The title of the applicant's supervisor at this employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements supervisor_phone: type: string pattern: ^\+?\d{1,50}$ description: The phone number of the applicant's supervisor at this employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements supervisor_email: type: string format: email description: The email of the applicant's supervisor at this employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements position: type: string description: The position held at this employer, or the job description of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements monthly_income_in_cents: type: integer minimum: 0 description: "The monthly income of the applicant at this employer in cents. This field is not configurable on the Rentvine template and is always required. DEPRECATED: Use income_in_cents instead" deprecated: true x-fern-availability: deprecated income_in_cents: type: integer minimum: 0 description: The monthly income of the applicant at this employer in cents. This field is not configurable on the Rentvine template and is always required start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The start date of the applicant's employment at this employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The end date of the applicant's employment at this employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements required: - is_current_employer - name other_income: type: array items: type: object properties: source: type: string description: The source of the income for the applicant. This field is not configurable on the Rentvine template and is always required monthly_income_in_cents: type: integer minimum: 0 description: The monthly income from this income source in cents. This field is not configurable on the Rentvine template and is always required phone: type: string pattern: ^\+?\d{1,50}$ description: The phone number related to this income source to use for income verification. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements required: - source - monthly_income_in_cents bank_accounts: type: array items: type: object properties: name: type: string description: The name of the bank where the account is held. This field is not configurable on the Rentvine template and is always required account_type: type: string enum: *a26 description: The type of bank account. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements account_number: type: string description: The account number of the bank account. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements balance_in_cents: type: integer minimum: 0 description: The current balance of the bank account in cents. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements required: - name credit_cards: type: array items: type: object properties: name: type: string description: The name of the bank or issuer of the credit card. This field is not configurable on the Rentvine template and is always required balance_in_cents: type: integer minimum: 0 description: The current balance of the credit card in cents. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements required: - name assistance: type: object properties: agency_name: type: string description: The name of the agency who is providing assistance for the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements county: type: string description: The county where the agency is located. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements technician_name: type: string description: The name of the agency's contact assigned to support the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements phone: type: string pattern: ^\+?\d{1,50}$ description: The phone number of the agency or of the agency's contact. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements assistance_amount_in_cents: type: integer minimum: 0 description: The amount of assistance for the applicant in cents. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements beds_allowed: type: string description: The number of beds allowed for the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements are_utilities_covered: type: boolean description: Whether utilities are covered for the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements applicant_id: type: string description: The Propexo unique identifier for the applicant required: - integration_id - application_template_id - rent_amount_in_cents - first_name - last_name - email_1 - date_of_birth - identification_number - address_history - applicant_id required: - meta - result _v1_applicants_resman__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration lead_id: type: string description: The Propexo unique identifier for the lead unit_id: type: string description: The Propexo unique identifier for the unit application_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The application date associated with the applicant start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The start date associated with the lease end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The end date associated with the lease status: type: string enum: *a47 description: The status associated with the application first_name: type: string description: The first name associated with the applicant last_name: type: string description: The last name associated with the applicant email_1: type: string format: email description: "Deprecated: The email field from the lead will be the email of the applicant. The primary email address associated with the applicant" deprecated: true date_of_birth: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date of birth associated with the applicant address_1: type: string description: The first address line associated with the applicant city: type: string description: The city associated with the applicant state: type: string description: The state associated with the applicant zip: type: string description: The zip code associated with the applicant phone_1: type: string description: Primary phone number associated with the applicant phone_1_type: type: string enum: &a48 - HOME - MOBILE - WORK description: Type of the primary phone number phone_2: type: string description: Secondary phone number associated with the applicant phone_2_type: type: string enum: &a49 - HOME - MOBILE - WORK description: Type of the secondary phone number rent_amount_market_in_cents: type: integer description: The market rent amount in cents for the lease move_in_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The move-in date associated with the lease required: - integration_id - lead_id - unit_id - application_date - start_date - end_date - status _v1_applicants_resman__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration lead_id: type: string description: The Propexo unique identifier for the lead unit_id: type: string description: The Propexo unique identifier for the unit application_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" status: type: string enum: *a47 description: The status associated with the application first_name: type: - string - "null" description: The first name associated with the applicant last_name: type: - string - "null" description: The last name associated with the applicant email_1: type: - string - "null" format: email description: "Deprecated: The email field from the lead will be the email of the applicant. The primary email address associated with the applicant" deprecated: true x-fern-availability: deprecated date_of_birth: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" description: The date of birth associated with the applicant address_1: type: - string - "null" description: The first address line associated with the applicant city: type: - string - "null" description: The city associated with the applicant state: type: - string - "null" description: The state associated with the applicant zip: type: - string - "null" description: The zip code associated with the applicant phone_1: type: - string - "null" description: Primary phone number associated with the applicant phone_1_type: type: - string - "null" enum: *a48 description: Type of the primary phone number phone_2: type: - string - "null" description: Secondary phone number associated with the applicant phone_2_type: type: - string - "null" enum: *a49 description: Type of the secondary phone number rent_amount_market_in_cents: type: - integer - "null" description: The market rent amount in cents for the lease move_in_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" description: The move-in date associated with the lease required: - integration_id - lead_id - unit_id - application_date - start_date - end_date - status - first_name - last_name - email_1 - date_of_birth - address_1 - city - state - zip - phone_1 - phone_1_type - phone_2 - phone_2_type - rent_amount_market_in_cents - move_in_date required: - meta - result _v1_applicants_resman_{applicant_id}_put_input: type: object properties: application_date: type: string format: date-time description: The application date associated with the applicant start_date: type: string format: date-time description: The start date associated with the applicant end_date: type: string format: date-time description: The end date associated with the applicant status: type: string enum: *a50 description: The status associated with the applicant first_name: type: string description: The first name associated with the applicant last_name: type: string description: The last name associated with the applicant email_1: type: string format: email description: "Deprecated: The email field from the lead will be the email of the applicant. The primary email address associated with the applicant" deprecated: true date_of_birth: type: string format: date-time description: The date of birth associated with the applicant address_1: type: string description: The first address line associated with the applicant city: type: string description: The city associated with the applicant state: type: string description: The state associated with the applicant zip: type: string description: The zip code associated with the applicant phone_1: type: string description: Primary phone number associated with the applicant phone_1_type: type: string enum: &a51 - HOME - MOBILE - WORK description: Type of the primary phone number phone_2: type: string description: Secondary phone number associated with the applicant phone_2_type: type: string enum: &a52 - HOME - MOBILE - WORK description: Type of the secondary phone number rent_amount_market_in_cents: type: integer description: The market rent amount in cents for the lease move_in_date: type: string format: date-time description: The move-in date associated with the lease required: - application_date - start_date - end_date - status _v1_applicants_resman_{applicant_id}_put_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: applicant_id: type: string description: The Propexo unique identifier for the applicant application_date: type: string format: date-time description: The application date associated with the applicant start_date: type: string format: date-time description: The start date associated with the applicant end_date: type: string format: date-time description: The end date associated with the applicant status: type: string enum: *a50 description: The status associated with the applicant first_name: type: string description: The first name associated with the applicant last_name: type: string description: The last name associated with the applicant email_1: type: string format: email description: "Deprecated: The email field from the lead will be the email of the applicant. The primary email address associated with the applicant" deprecated: true x-fern-availability: deprecated date_of_birth: type: string format: date-time description: The date of birth associated with the applicant address_1: type: string description: The first address line associated with the applicant city: type: string description: The city associated with the applicant state: type: string description: The state associated with the applicant zip: type: string description: The zip code associated with the applicant phone_1: type: string description: Primary phone number associated with the applicant phone_1_type: type: string enum: *a51 description: Type of the primary phone number phone_2: type: string description: Secondary phone number associated with the applicant phone_2_type: type: string enum: *a52 description: Type of the secondary phone number rent_amount_market_in_cents: type: integer description: The market rent amount in cents for the lease move_in_date: type: string format: date-time description: The move-in date associated with the lease required: - applicant_id - application_date - start_date - end_date - status required: - meta - result _v1_rentable-items_applicants_assign_post_input: type: object properties: integration_id: type: string rentable_item_id: type: string description: The Propexo unique identifier for the rentable item applicant_id: type: string description: The Propexo unique identifier for the applicant required: - integration_id _v1_rentable-items_applicants_assign_post_output: type: object properties: job_id: type: string description: The ID of the job created to handle this operation data: type: object properties: {} required: - job_id - data _v1_applicants_entrata_{applicant_id}_file-upload_post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration application_id: type: string description: The Propexo unique identifier for the application attachments: type: array items: type: object properties: file_data: type: string maxLength: 69730304 description: The contents of the file, as a base64 encoded string. The PMS has a max file size of 50 MB. file_name: type: string description: 'The name of the file including the extension. Ex: "image.jpg"' mime_type: type: string description: 'The mime type of the file. Ex: "image/jpeg"' file_type_id: type: string description: The Propexo file type ID of the file type to upload is_private: type: boolean description: If the file should be marked as private. If true the file will not be shown in the resident portal. required: - file_data - file_name - mime_type - file_type_id description: Files to upload for the applicant. All the files can have a maximum combined file size of 50 MB required: - integration_id - application_id - attachments _v1_applicants_entrata_{applicant_id}_file-upload_post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration applicant_id: type: string description: The Propexo unique identifier for the applicant application_id: type: string description: The Propexo unique identifier for the application attachments: type: array items: type: object properties: file_data: type: - string - "null" maxLength: 69730304 description: The contents of the file, as a base64 encoded string. The PMS has a max file size of 50 MB. file_name: type: string description: 'The name of the file including the extension. Ex: "image.jpg"' mime_type: type: string description: 'The mime type of the file. Ex: "image/jpeg"' file_type_id: type: string description: The Propexo file type ID of the file type to upload is_private: type: boolean required: - file_name - mime_type - file_type_id required: - integration_id - applicant_id - application_id - attachments required: - meta - result _v1_applicants_yardi_{applicant_id}_file-upload_post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration attachment: type: object properties: file_type_id: type: string description: The Propexo unique identifier for the file type. The file type provided must be listed as being compatible with the Applicants model. file_data: type: string maxLength: 66500000 file_extension: type: string enum: &a53 - pdf - doc - docx - xls - xlsx - jpg - jpeg - png description: The file extension for the attachment being uploaded description: type: string description: A description of the file being uploaded should_upload_to_tenant: type: boolean description: Determines if the file should be uploaded to the tenant page in Yardi. By default, it will be uploaded to the prospect page. If true, the file type must be associated with the residents data model. required: - file_type_id - file_data - file_extension - description description: The file to attach to the Applicant required: - integration_id - attachment _v1_applicants_yardi_{applicant_id}_file-upload_post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration applicant_id: type: string description: The Propexo unique identifier for the applicant attachment: type: object properties: file_type_id: type: string description: The Propexo unique identifier for the file type. The file type provided must be listed as being compatible with the Applicants model. file_data: type: - string - "null" maxLength: 66500000 file_extension: type: string enum: *a53 description: The file extension for the attachment being uploaded description: type: string description: A description of the file being uploaded should_upload_to_tenant: type: boolean required: - file_type_id - file_extension - description required: - integration_id - applicant_id - attachment required: - meta - result _v1_applicants_rentvine_{applicant_id}_file-upload_post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration attachment: type: object properties: file_data: type: string maxLength: 69730304 description: The contents of the file, as a base64 encoded string. We limit the file upload size to 50 MB. file_name: type: string description: 'The name of the file including the extension. Ex: "resume.pdf"' mime_type: type: string description: 'The mime type of the file. Ex: "application/pdf"' required: - file_data - file_name - mime_type description: The file data for the document upload required: - integration_id - attachment _v1_applicants_rentvine_{applicant_id}_file-upload_post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration applicant_id: type: string description: The Propexo unique identifier for the applicant attachment: type: object properties: file_data: type: - string - "null" maxLength: 69730304 description: The contents of the file, as a base64 encoded string. We limit the file upload size to 50 MB. file_name: type: string description: 'The name of the file including the extension. Ex: "resume.pdf"' mime_type: type: string description: 'The mime type of the file. Ex: "application/pdf"' required: - file_name - mime_type required: - integration_id - applicant_id - attachment required: - meta - result _v1_applicants_resman_{applicant_id}_file-upload_post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration application_id: type: string description: The Propexo unique identifier for the application attachments: type: array items: type: object properties: file_data: type: string maxLength: 34865152 description: The contents of the file, as a base64 encoded string. The PMS has a max file size of 25 MB. file_name: type: string description: The name of the file including the extension mime_type: type: string description: 'The mime type of the file. Ex: "application/pdf"' required: - file_data - file_name - mime_type minItems: 1 description: The files to be uploaded to the application. All the files can have a maximum combined file size of 50 MB required: - integration_id - application_id - attachments _v1_applicants_resman_{applicant_id}_file-upload_post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration applicant_id: type: string description: The Propexo unique identifier for the applicant application_id: type: string description: The Propexo unique identifier for the application attachments: type: array items: type: object properties: file_data: type: - string - "null" maxLength: 34865152 description: The contents of the file, as a base64 encoded string. The PMS has a max file size of 25 MB. file_name: type: string description: The name of the file including the extension mime_type: type: string description: 'The mime type of the file. Ex: "application/pdf"' required: - file_name - mime_type required: - integration_id - applicant_id - application_id - attachments required: - meta - result _v1_rentable-items_applicants_assign_yardi_post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration rentable_item_id: type: string description: The Propexo unique identifier for the rentable item applicant_id: type: string description: The Propexo unique identifier for the applicant required: - integration_id - rentable_item_id - applicant_id _v1_rentable-items_applicants_assign_yardi_post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration rentable_item_id: type: string description: The Propexo unique identifier for the rentable item applicant_id: type: string description: The Propexo unique identifier for the applicant required: - integration_id - rentable_item_id - applicant_id required: - meta - result Enum2: type: string enum: &a288 - APPFOLIO - BUILDIUM - ENTRATA - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The integration vendor for the applicant. _v1_applications__get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query x_id: type: string description: The external applicant id location_id: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. property_id: type: string description: The Propexo property id integration_id: type: string description: The Propexo integration id integration_vendor: $ref: "#/components/schemas/Enum2" Application: type: object properties: id: type: string description: The Propexo unique identifier for the application created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_property_id: type: string description: The external ID of the property from the integration vendor x_unit_id: type: - string - "null" description: The external ID of the unit from the integration vendor status: type: string description: The raw status associated with the application custom_data: type: - object - "null" properties: {} applicants: type: array items: type: object properties: applicant_id: type: string description: The Propexo unique identifier for the applicant application_id: type: string description: The Propexo unique identifier for the application status: type: - string - "null" description: DEPRECATED. Use status_raw deprecated: true x-fern-availability: deprecated status_raw: type: - string - "null" description: The raw status associated with the applicant status_normalized: type: - string - "null" description: The normalized status associated with the applicant. Confirm these derived values before using them in production. custom_data: type: - object - "null" properties: {} required: - applicant_id - application_id x-propexo: derivedFromModel: applicants_to_applications integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" property_id: type: string description: The Propexo unique identifier for the property unit_id: type: - string - "null" description: The Propexo unique identifier for the unit required: - id - created_at - updated_at - last_seen - x_id - x_location_id - x_property_id - x_unit_id - status - custom_data - applicants - integration_id - integration_vendor - property_id - unit_id x-propexo: derivedFromModel: applications _v1_applications__get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: type: array items: $ref: "#/components/schemas/Application" required: - meta - results _v1_applications__post_input: type: object properties: integration_id: type: string property_id: type: string description: The Propexo unique identifier for the property lease_period_id: type: string description: The lease period to use for the application. If supplied, this field must be one of the approved lease periods defined on the Rentvine template. You can see a list of available choices for each application template on the appropriate lease period endpoint. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements or to change the list of available lease periods lead_source_id: type: string description: The Propexo unique identifier for the lead source. Required if lead_id is not specified unit_id: type: string description: The Propexo unique identifier for the unit application_status: type: string enum: &a78 - COMPLETED - APPROVED description: The status associated with the application first_name: type: string description: The first name associated with the applicant. Required if lead_id is not specified last_name: type: string description: The last name associated with the applicant. Required if lead_id is not specified address_1: type: string description: The first address line associated with the applicant address_2: type: string description: The second address line associated with the applicant city: type: string description: The city associated with the applicant state: type: string description: The state associated with the applicant zip: type: string description: The zip code associated with the applicant attachments: type: array items: type: object properties: file_data: type: string maxLength: 69730304 description: The contents of the file, as a base64 encoded string. The PMS has a max file size of 50 MB. file_name: type: string description: 'The name of the file including the extension. Ex: "image.jpg"' mime_type: type: string description: 'The mime type of the file. Ex: "image/jpeg"' lease_file_type: type: string description: "Deprecated: Use the `file_type_id` field instead. The PMS specific lease file type of the document" file_type_id: type: string description: The Propexo file type ID of the lease file type to upload. Prefer this over the raw input of the lease_file_type. is_private: type: boolean description: If the file should be marked as private. If true the file will not be shown in the resident portal. required: - file_data - file_name - mime_type description: Files to upload for the application date_of_birth: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date of birth associated with the applicant email_1: type: string format: email description: The primary email address associated with the applicant move_in_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The desired move-in date to the unit listed in the application phone_1: type: string pattern: ^\d{10}$ description: Primary phone number associated with the applicant pets: type: array items: type: object properties: type: type: string description: The type associated with the applicant pet name: type: string description: The name associated with the applicant pet age_in_years: type: integer minimum: 0 description: The age in years of the applicant pet weight_in_pounds: type: integer minimum: 0 description: The weight in pounds of the applicant pet breed: type: string description: The breed of the applicant pet color: type: string description: The color of the applicant pet gender: type: string description: The raw value for the gender of the applicant pet is_fixed: type: boolean description: Whether the applicant pet is fixed is_service_animal: type: boolean description: Whether the applicant pet is a service animal required: - type maxItems: 6 default: &a63 [] description: "A list of applicant pets. Note: This will only be added to the primary applicant on the application." vehicles: type: array items: type: object properties: make: type: string description: The make of the vehicle model: type: string description: The model of the vehicle year: type: integer description: The year the vehicle was made color: type: string description: The color of the vehicle license_plate_number: type: string description: The license plate number of the vehicle license_plate_state: type: string enum: *a33 description: The issuing state of the license plate required: - make maxItems: 4 default: &a62 [] description: "A list of vehicles for the application. Note: This will only be added to the primary applicant on the application." employment_history: type: array items: type: object properties: is_current_employer: type: boolean description: Whether this employment history entry is for a current employer name: type: string description: The name of the employer start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The start date of the applicant's employment at this employer end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The end date of the applicant's employment at this employer. Ignore this field if is_current_employer is set to true address_1: type: string description: The first line of the address of the employer city: type: string description: The city of the address of the employer state: type: string enum: *a33 description: The state of the address of the employer zip: type: string description: The zip code of the address of the employer phone: type: string pattern: ^\d{10}$ description: "The phone number of the employer. DEPRECATED: Use supervisor_phone instead" deprecated: true supervisor_phone: type: string pattern: ^\d{10}$ description: The phone number of the applicant's supervisor supervisor_first_name: type: string description: The first name of the applicant's supervisor at this employer supervisor_last_name: type: string description: The last name of the applicant's supervisor at this employer position: type: string description: The position held at this employer, or the job description of the applicant monthly_income_in_cents: type: integer minimum: 0 description: "The monthly income of the applicant at this employer in cents. DEPRECATED: Use income_in_cents instead" deprecated: true income_in_cents: type: integer minimum: 0 description: The monthly income of the applicant at this employer in cents. deprecated: true required: - is_current_employer - name - start_date maxItems: 2 default: &a60 [] description: "The employment history of the applicant. Note: This will only be added to the primary applicant on the application." add_ons: type: array items: type: object properties: rentable_item_id: type: string description: The Propexo unique identifier for the rentable item employee_id: type: string description: The Propexo unique identifier for the employee start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The start date associated with the employee end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The end date associated with the employee required: - rentable_item_id - employee_id description: Add-ons of the application other_occupants: type: array items: type: object properties: relationship: type: string enum: &a55 - ROOMMATE - SPOUSE - GUARANTOR - OTHER description: The relationship of the occupant to the applicant first_name: type: string description: The first name associated with the occupant last_name: type: string description: The last name associated with the occupant third_party_id: type: string description: A unique ID you would like to associate with the occupant. This is not the Yardi occupant ID organization_name: type: string description: The name of your organization. Yardi uses this for associating an occupant email_1: type: string format: email description: The primary email address associated with the occupant phone_1: type: string pattern: ^\d{10}$ description: Primary phone number associated with the occupant phone_1_type: type: string enum: *a16 description: Type of the primary phone number phone_2: type: string pattern: ^\d{10}$ description: Secondary phone number associated with the occupant phone_2_type: type: string enum: *a16 description: Type of the secondary phone number address_1: type: string description: The first address line associated with the occupant city: type: string description: The city associated with the occupant state: type: string enum: *a33 description: The state associated with the occupant zip: type: string description: The zip code associated with the occupant required: - relationship - first_name - last_name - third_party_id - organization_name default: &a66 [] description: A list of other occupants for the application application_template_id: type: string description: "The Propexo unique identifier for the application template. The Rentvine application template dynamically defines which fields are required for each applicant/application: whether a field is active, disabled, required, or optional. A template may also allow some enums to be modified or for entire fields to be relabeled/repurposed. The functionality of a template is extensive and will likely require that you work with your customer to define a custom template for your application use case" leasing_agent_first_name: type: string description: The first name of the leasing agent. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements leasing_agent_last_name: type: string description: The last name of the leasing agent. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements leasing_agent_contact_info: type: string description: The contact info for the leasing agent. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements rent_amount_in_cents: type: integer minimum: 0 description: The rent amount in cents for the applicant security_deposit_in_cents: type: integer minimum: 0 description: The security deposit in cents that the applicant will pay for the unit. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements middle_name: type: string description: The middle name associated with the applicant type: type: string enum: *a18 description: The type of applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements. Although the field itself can be made optional/required, the value must be one of the available choices and cannot be modified as part of the template marital_status: type: string enum: &a57 - SINGLE - MARRIED description: The marital status of the applicant maiden_name: type: string description: The maiden name associated with the applicant height: type: string description: The height of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements weight: type: string description: The weight of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements eye_color: type: string description: The eye color of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements hair_color: type: string description: The hair color of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements phone_1_type: type: string enum: *a16 description: Type of the primary phone number phone_2: type: string pattern: ^\d{10}$ description: Secondary phone number associated with the applicant phone_2_type: type: string enum: *a16 description: Type of the secondary phone number phone_3: type: string pattern: ^\+?\d{1,50}$ description: Third phone number associated with the applicant. An applicant can have no more than one of each phone type. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements phone_3_type: type: string enum: *a20 description: Type of the third phone number. An applicant can have no more than one of each phone type. identification_number: type: string description: The social security number of the applicant citizenship: type: string description: The country of citizenship of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements place_of_birth: type: string description: The place of birth of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements passport_number: type: string description: The passport number of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements student_id: type: string description: The student ID number of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements drivers_license_number: type: string description: The driver's license number of the applicant drivers_license_state: type: string description: The issuing state of the applicant's driver's license. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements lead_source: type: string description: The name of the source of the lead or how the applicant heard of the property management company. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements emergency_contacts: type: array items: type: object properties: first_name: type: string description: The first name of the emergency contact last_name: type: string description: The last name of the emergency contact relationship: type: string enum: &a56 - DAUGHTER - FRIEND - HUSBAND - SON - WIFE - OTHER description: The relationship of the emergency contact to the applicant address_1: type: string description: The first line of the address of the emergency contact city: type: string description: The city of the address of the emergency contact state: type: string enum: *a33 description: The state of the address of the emergency contact zip: type: string description: The zip code of the address of the emergency contact country: anyOf: - type: string enum: &a54 - US - CA - type: string description: The country of the address of the emergency contact. If your application needs to support submitting an applicant who resides in another country, please reach out to Propexo Support for help phone_1: type: string pattern: ^\d{10}$ description: The phone number of the emergency contact required: - first_name - last_name - relationship maxItems: 1 default: &a59 [] description: "A list of emergency contacts for the applicant. Note: This will only be added to the primary applicant on the application." application_references: type: array items: type: object properties: first_name: type: string description: The first name of the applicant's reference. This field is not configurable on the Rentvine template and is always required last_name: type: string description: The last name of the applicant's reference. This field is not configurable on the Rentvine template and is always required relationship: type: string description: The relationship of the applicant's reference to the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements address_1: type: string description: The first line of the address of the applicant's reference. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements address_2: type: string description: The second line of the address of the applicant's reference. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements city: type: string description: The city of the address of the applicant's reference. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements state: type: string description: The state of the address of the applicant's reference. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements zip: type: string description: The zip code of the address of the applicant's reference. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements country: type: string description: The country of the address of the applicant's reference. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements phone_1: type: string pattern: ^\+?\d{1,50}$ description: The phone number of the applicant's reference. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements required: - first_name - last_name description: A list of applicant references for the application. Depending on the Rentvine template, this array can be customized to be either required or optional. The template may also require a minimum number of items in the array in order to pass validation. You will need to work with your customer directly to configure this field to your application requirements address_history: type: array items: type: object properties: address_1: type: string description: The first address line associated with the applicant's historical address city: type: string description: The city associated with the applicant's historical address state: type: string enum: *a33 description: The state associated with the applicant zip: type: string description: The zip code associated with the applicant's historical address country: anyOf: - type: string enum: *a54 - type: string description: The country associated with the applicant's historical address. If your application needs to support submitting an applicant who resides in another country, please reach out to Propexo Support for help notice_provided: type: boolean description: Whether notice has been given to the applicant's historical address property_name: type: string description: The property name of the applicant's historical address reason_for_leaving: type: string description: The reason the applicant left their historical address monthly_payment_in_cents: type: integer minimum: 0 description: For the applicant's historical address, the applicant's monthly payment for rent or mortgage in cents move_in_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date when the applicant moved into their historical address move_out_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date when the applicant moved out of their historical address. If this is the applicant's current address, omit this field manager_phone: type: string pattern: ^\d{10}$ description: The phone number of a property manager who works at this address manager_email: type: string format: email description: The email of a property manager who works at this address management_company: type: string description: The name of the company who owns the property at this address required: - address_1 - city - state - zip - notice_provided - move_in_date maxItems: 2 default: &a58 [] description: "The address history of the applicant. Note: This will only be added to the primary applicant on the application." other_income: type: array items: type: object properties: source: type: string description: The source of the income for the applicant monthly_income_in_cents: type: integer minimum: 0 description: The monthly income from this income source in cents required: - source - monthly_income_in_cents maxItems: 2 default: &a61 [] description: "A list of other income sources for the applicant. Note: This will only be added to the primary applicant on the application." bank_accounts: type: array items: type: object properties: name: type: string description: The name of the bank where the account is held. This field is not configurable on the Rentvine template and is always required account_type: type: string enum: *a26 description: The type of bank account. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements account_number: type: string description: The account number of the bank account. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements balance_in_cents: type: integer minimum: 0 description: The current balance of the bank account in cents. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements required: - name description: A list of bank accounts for the applicant. Depending on the Rentvine template, this array can be customized to be either required or optional. The template may also require a minimum number of items in the array in order to pass validation. You will need to work with your customer directly to configure this field to your application requirements credit_cards: type: array items: type: object properties: name: type: string description: The name of the bank or issuer of the credit card. This field is not configurable on the Rentvine template and is always required balance_in_cents: type: integer minimum: 0 description: The current balance of the credit card in cents. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements required: - name description: A list of credit cards for the applicant. Depending on the Rentvine template, this array can be customized to be either required or optional. The template may also require a minimum number of items in the array in order to pass validation. You will need to work with your customer directly to configure this field to your application requirements assistance: type: object properties: agency_name: type: string description: The name of the agency who is providing assistance for the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements county: type: string description: The county where the agency is located. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements technician_name: type: string description: The name of the agency's contact assigned to support the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements phone: type: string pattern: ^\+?\d{1,50}$ description: The phone number of the agency or of the agency's contact. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements assistance_amount_in_cents: type: integer minimum: 0 description: The amount of assistance for the applicant in cents. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements beds_allowed: type: string description: The number of beds allowed for the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements are_utilities_covered: type: boolean description: Whether utilities are covered for the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements description: Details for payment assistance for the applicant. Depending on the Rentvine template, this array can be customized to be either required or optional. The template may also require a minimum number of items in the array in order to pass validation. You will need to work with your customer directly to configure this field to your application requirements employee_id: type: string description: The Propexo unique identifier for the employee. Employee must have a role of LEASING_AGENT. Required if lead_id is not specified application_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The application date associated with the applicant start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The start date associated with the lease end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The end date associated with the lease status: type: string enum: &a85 - PENDING - APPROVED - CANCELED - DENIED - SIGNED description: The status associated with the application notes: type: string description: Notes associated with the applicant desired_lease_term_in_months: type: string description: The desired lease term in months of the applicant floor_plan_id: type: string description: The Propexo unique identifier for the floor plan lead_id: type: string description: The Propexo unique identifier for the lead. The lead will be converted to an applicant third_party_id: type: string minLength: 1 description: A unique ID you would like to associate with the applicant. This is not the Yardi applicant ID. Required if lead_id is not specified organization_name: type: string description: The name of your organization. Yardi uses this for associating an applicant. Required if lead_id is not specified move_out_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The desired move-out date to the unit listed in the application is_evicted: type: boolean description: Whether the applicant has been evicted is_felony: type: boolean description: Whether the applicant has a felony is_criminal_charge: type: boolean description: Whether the applicant has a criminal charge eviction_description: type: string description: The description of the eviction felony_description: type: string description: The description of the felony criminal_charge_description: type: string description: The description of the criminal charge concession_fees: type: array items: type: object properties: start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The start date of the applicant's recurring concession fee end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The end date of the applicant's recurring concession fee concession_id: type: string description: The Propexo unique identifier for the concession. This concession must be associated with the unit that the applicant is applying for required: - start_date - end_date - concession_id default: &a64 [] description: A list of concession fees for the application application_fees: type: array items: type: object properties: charge_code_id: type: string description: The Propexo unique identifier for the charge code. This must be an application fee charge code amount_in_cents: type: integer minimum: 0 description: The application fee amount in cents description: type: string description: Description of the application fee required: - charge_code_id - amount_in_cents default: &a65 [] description: A list of application fees for the application required: - integration_id _v1_applications__post_output: type: object properties: job_id: type: string description: The ID of the job created to handle this operation data: type: object properties: {} required: - job_id - data _v1_applications_{id}_get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query _v1_applications_{id}_get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: $ref: "#/components/schemas/Application" required: - meta - results _v1_applications_{id}_put_input: type: object properties: applicant_id: type: string description: The Propexo unique identifier for the applicant application_id: type: string description: The Propexo unique identifier for the application lease_period_id: type: string description: The Propexo unique identifier for the lease period unit_id: type: string description: The Propexo unique identifier for the unit lead_source_id: type: string description: The Propexo unique identifier for the lead source address_1: type: string description: The first address line associated with the applicant address_2: type: string description: The second address line associated with the applicant application_status: type: string enum: &a83 - COMPLETED - APPROVED description: The status associated with the application attachments: type: array items: type: object properties: file_data: type: string maxLength: 69730304 description: The contents of the file, as a base64 encoded string. The PMS has a max file size of 50 MB. file_name: type: string description: 'The name of the file including the extension. Ex: "image.jpg"' mime_type: type: string description: 'The mime type of the file. Ex: "image/jpeg"' lease_file_type: type: string description: "Deprecated: Use the `file_type_id` field instead. The PMS specific lease file type of the document" file_type_id: type: string description: The Propexo file type ID of the lease file type to upload. Prefer this over the raw input of the lease_file_type. is_private: type: boolean description: If the file should be marked as private. If true the file will not be shown in the resident portal. required: - file_data - file_name - mime_type description: Files to upload for the applicant. All the files can have a maximum combined file size of 50 MB city: type: string description: The city associated with the applicant create_new_events_only: anyOf: - type: boolean - type: string description: Whether or not new events should be created on the applicant date_of_birth: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date of birth associated with the applicant email_1: type: string format: email description: The primary email address associated with the applicant events: type: array items: type: object properties: unit_id: type: string description: The Propexo unique identifier for the unit x_type_id: type: string description: The PMS id for the event type. x_leasing_agent_id: type: string description: The PMS id for the leasing agent. x_sub_type_id: type: string description: The PMS id for the event sub type. x_result_id: type: string description: The PMS id for the event result. event_datetime: type: string format: date-time description: The date and time that the event occured. appointment_datetime: type: string format: date-time description: The date and time that the appointment will occur. Required if using appointment type. time_from: type: string time_to: type: string notes: type: string description: General notes about the event. title: type: string description: Title for the event. reasons_for_event: type: string description: The reason the event occurred. id: type: string description: The Propexo unique identifier for the event. Only required if attempting to update an existing event. required: - x_type_id description: "DEPRECATED: Please use /events endpoints to write events. Array of events associated with this applicant" deprecated: true first_name: type: string description: The first name associated with the applicant last_name: type: string description: The last name associated with the applicant move_in_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The desired move-in date to the unit listed in the application phone_1_type: type: string enum: *a16 description: Type of the primary phone number phone_1: type: string pattern: ^\d{10}$ description: Primary phone number associated with the applicant state: type: string description: The state associated with the applicant zip: type: string description: The zip code associated with the applicant pets: type: array items: type: object properties: type: type: string description: The type associated with the applicant pet name: type: string description: The name associated with the applicant pet age_in_years: type: integer minimum: 0 description: The age in years of the applicant pet weight_in_pounds: type: integer minimum: 0 description: The weight in pounds of the applicant pet breed: type: string description: The breed of the applicant pet color: type: string description: The color of the applicant pet gender: type: string description: The raw value for the gender of the applicant pet is_fixed: type: boolean description: Whether the applicant pet is fixed is_service_animal: type: boolean description: Whether the applicant pet is a service animal required: - type maxItems: 6 default: &a74 [] description: A list of applicant pets. If any pets are provided, this list will overwrite the existing list of pets vehicles: type: array items: type: object properties: make: type: string description: The make of the vehicle model: type: string description: The model of the vehicle year: type: integer description: The year the vehicle was made color: type: string description: The color of the vehicle license_plate_number: type: string description: The license plate number of the vehicle license_plate_state: type: string enum: *a33 description: The issuing state of the license plate required: - make maxItems: 4 default: &a73 [] description: A list of vehicles for the application employment_history: type: array items: type: object properties: is_current_employer: type: boolean description: Whether this employment history entry is for a current employer name: type: string description: The name of the employer start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The start date of the applicant's employment at this employer end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The end date of the applicant's employment at this employer. Ignore this field if is_current_employer is set to true address_1: type: string description: The first line of the address of the employer city: type: string description: The city of the address of the employer state: type: string enum: *a33 description: The state of the address of the employer zip: type: string description: The zip code of the address of the employer phone: type: string pattern: ^\d{10}$ description: The phone number of the employer supervisor_first_name: type: string description: The first name of the applicant's supervisor at this employer supervisor_last_name: type: string description: The last name of the applicant's supervisor at this employer position: type: string description: The position held at this employer, or the job description of the applicant monthly_income_in_cents: type: integer minimum: 0 description: The monthly income of the applicant at this employer in cents required: - is_current_employer - name - start_date - monthly_income_in_cents maxItems: 2 default: &a71 [] description: The employment history of the applicant add_ons: type: array items: type: object properties: rentable_item_id: type: string description: The Propexo unique identifier for the rentable item employee_id: type: string description: The Propexo unique identifier for the employee start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The start date associated with the employee end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The end date associated with the employee required: - rentable_item_id - employee_id description: Add-ons of the applicant employee_id: type: string description: The Propexo unique identifier for the employee application_status_id: type: string description: The Propexo unique identifier for the application status for this application application_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The application date associated with the applicant start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The start date associated with the lease end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The end date associated with the lease status: type: string enum: &a92 - PENDING - APPROVED - CANCELED - DENIED - SIGNED description: The status associated with the application phone_2: type: string pattern: ^\d{10}$ description: Secondary phone number associated with the applicant phone_2_type: type: string enum: *a16 description: Type of the secondary phone number notes: type: string description: Notes associated with the applicant rent_amount_in_cents: type: integer minimum: 0 description: The rent amount in cents for the applicant desired_lease_term_in_months: type: string description: The desired lease term in months of the applicant floor_plan_id: type: string description: The Propexo unique identifier for the floor plan other_occupants: type: array items: type: object properties: relationship: type: string enum: *a55 description: The relationship of the occupant to the applicant first_name: type: string description: The first name associated with the occupant last_name: type: string description: The last name associated with the occupant third_party_id: type: string minLength: 1 description: A unique ID you would like to associate with the occupant. This is not the Yardi occupant ID organization_name: type: string description: The name of your organization. Yardi uses this for associating an occupant email_1: type: string format: email description: The primary email address associated with the occupant phone_1: type: string pattern: ^\d{10}$ description: Primary phone number associated with the occupant phone_1_type: type: string enum: *a16 description: Type of the primary phone number phone_2: type: string pattern: ^\d{10}$ description: Secondary phone number associated with the occupant phone_2_type: type: string enum: *a16 description: Type of the secondary phone number address_1: type: string description: The first address line associated with the occupant city: type: string description: The city associated with the occupant state: type: string enum: *a33 description: The state associated with the occupant zip: type: string description: The zip code associated with the occupant required: - relationship - first_name - last_name - third_party_id - organization_name default: &a77 [] description: A list of other occupants for the application. Only new occupants should be passed in, existing occupants cannot be updated emergency_contacts: type: array items: type: object properties: first_name: type: string description: The first name of the emergency contact last_name: type: string description: The last name of the emergency contact relationship: type: string enum: *a56 description: The relationship of the emergency contact to the applicant address_1: type: string description: The first line of the address of the emergency contact city: type: string description: The city of the address of the emergency contact state: type: string enum: *a33 description: The state of the address of the emergency contact zip: type: string description: The zip code of the address of the emergency contact country: anyOf: - type: string enum: &a69 - United States - Canada - type: string description: The country of the address of the emergency contact. If your application needs to support submitting an applicant who resides in another country, please reach out to Propexo Support for help phone_1: type: string pattern: ^\d{10}$ description: The phone number of the emergency contact required: - first_name - last_name - relationship maxItems: 1 default: &a70 [] description: A list of emergency contacts for the applicant middle_name: type: string description: The middle name associated with the applicant maiden_name: type: string description: The maiden name associated with the applicant move_out_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The desired move-out date to the unit listed in the application is_evicted: type: boolean description: Whether the applicant has been evicted is_felony: type: boolean description: Whether the applicant has a felony is_criminal_charge: type: boolean description: Whether the applicant has a criminal charge eviction_description: type: string description: The description of the eviction felony_description: type: string description: The description of the felony criminal_charge_description: type: string description: The description of the criminal charge marital_status: type: string enum: *a57 description: The marital status of the applicant identification_number: type: string description: The social security number of the applicant drivers_license_number: type: string description: The driver's license number of the applicant address_history: type: array items: type: object properties: address_1: type: string description: The first address line associated with the applicant's historical address city: type: string description: The city associated with the applicant's historical address state: type: string enum: *a33 description: The state associated with the applicant zip: type: string description: The zip code associated with the applicant's historical address country: anyOf: - type: string enum: &a67 - United States - Canada - type: string description: The country associated with the applicant's historical address. If your application needs to support submitting an applicant who resides in another country, please reach out to Propexo Support for help notice_provided: type: boolean description: Whether notice has been given to the applicant's historical address property_name: type: string description: The property name of the applicant's historical address reason_for_leaving: type: string description: The reason the applicant left their historical address monthly_payment_in_cents: type: integer minimum: 0 description: For the applicant's historical address, the applicant's monthly payment for rent or mortgage in cents move_in_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date when the applicant moved into their historical address move_out_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date when the applicant moved out of their historical address. If this is the applicant's current address, omit this field manager_phone: type: string pattern: ^\d{10}$ description: The phone number of a property manager who works at this address manager_email: type: string format: email description: The email of a property manager who works at this address management_company: type: string description: The name of the company who owns the property at this address required: - address_1 - city - state - zip - notice_provided - move_in_date maxItems: 2 default: &a68 [] description: The address history of the applicant other_income: type: array items: type: object properties: source: type: string description: The source of the income for the applicant monthly_income_in_cents: type: integer minimum: 0 description: The monthly income from this income source in cents required: - source - monthly_income_in_cents maxItems: 2 default: &a72 [] description: A list of other income sources for the applicant concession_fees: type: array items: type: object properties: start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The start date of the applicant's recurring concession fee end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The end date of the applicant's recurring concession fee concession_id: type: string description: The Propexo unique identifier for the concession. This concession must be associated with the unit that the applicant is applying for required: - start_date - end_date - concession_id default: &a75 [] description: A list of concession fees for the application application_fees: type: array items: type: object properties: charge_code_id: type: string description: The Propexo unique identifier for the charge code. This must be an application fee charge code amount_in_cents: type: integer minimum: 0 description: The application fee amount in cents description: type: string description: Description of the application fee required: - charge_code_id - amount_in_cents default: &a76 [] description: A list of application fees for the application. Only new application fees should be passed in, existing fees cannot be updated _v1_applications_{id}_put_output: type: object properties: job_id: type: string description: The ID of the job created to handle this operation data: type: object properties: {} required: - job_id - data _v1_application-statuses__get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query property_id: type: string description: The Propexo unique identifier for the property integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" ApplicationStatus: type: object properties: id: type: string description: The Propexo unique identifier for the application status created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: type: string description: The name associated with the application status property_id: type: string description: The Propexo unique identifier for the property integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" required: - id - created_at - updated_at - last_seen - x_id - x_property_id - x_location_id - name - property_id - integration_id - integration_vendor x-propexo: derivedFromModel: application_statuses _v1_application-statuses__get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: type: array items: $ref: "#/components/schemas/ApplicationStatus" required: - meta - results _v1_application-statuses_{application_status_id}_get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query _v1_application-statuses_{application_status_id}_get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: $ref: "#/components/schemas/ApplicationStatus" required: - meta - results _v1_application-templates__get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query x_id: type: string description: The external ID from the integration vendor location_id: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. property_id: type: string description: The Propexo unique identifier for the property integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" ApplicationTemplate: type: object properties: id: type: string description: The Propexo unique identifier for the application template created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: type: string description: The name associated with the application template is_active: type: - boolean - "null" description: Whether the application template is active is_default: type: - boolean - "null" description: Whether this record is the default application template integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" property_id: type: string description: The Propexo unique identifier for the property required: - id - created_at - updated_at - last_seen - x_id - x_property_id - x_location_id - name - is_active - is_default - integration_id - integration_vendor - property_id x-propexo: derivedFromModel: rentvine_application_templates _v1_application-templates__get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: type: array items: $ref: "#/components/schemas/ApplicationTemplate" required: - meta - results _v1_application-templates_{application_template_id}_get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query _v1_application-templates_{application_template_id}_get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: $ref: "#/components/schemas/ApplicationTemplate" required: - meta - results _v1_applications_yardi__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration property_id: type: string description: The Propexo unique identifier for the property unit_id: type: string description: The Propexo unique identifier for the unit lead_id: type: string description: The Propexo unique identifier for the lead. The lead will be converted to an applicant employee_id: type: string description: The Propexo unique identifier for the employee. Employee must have a role of LEASING_AGENT. Required if lead_id is not specified lead_source_id: type: string description: The Propexo unique identifier for the lead source. Required if lead_id is not specified third_party_id: type: string minLength: 1 description: A unique ID you would like to associate with the applicant. This is not the Yardi applicant ID. Required if lead_id is not specified organization_name: type: string description: The name of your organization. Yardi uses this for associating an applicant. Required if lead_id is not specified first_name: type: string description: The first name associated with the applicant. Required if lead_id is not specified last_name: type: string description: The last name associated with the applicant. Required if lead_id is not specified middle_name: type: string description: The middle name associated with the applicant maiden_name: type: string description: The maiden name associated with the applicant email_1: type: string format: email description: The primary email address associated with the applicant phone_1: type: string pattern: ^\d{10}$ description: Primary phone number associated with the applicant phone_1_type: type: string enum: *a16 description: Type of the primary phone number phone_2: type: string pattern: ^\d{10}$ description: Secondary phone number associated with the applicant phone_2_type: type: string enum: *a16 description: Type of the secondary phone number move_in_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The desired move-in date to the unit listed in the application move_out_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The desired move-out date to the unit listed in the application desired_lease_term_in_months: type: string description: The desired lease term in months of the applicant date_of_birth: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date of birth associated with the applicant notes: type: string description: Notes associated with the applicant is_evicted: type: boolean description: Whether the applicant has been evicted is_felony: type: boolean description: Whether the applicant has a felony is_criminal_charge: type: boolean description: Whether the applicant has a criminal charge eviction_description: type: string description: The description of the eviction felony_description: type: string description: The description of the felony criminal_charge_description: type: string description: The description of the criminal charge marital_status: type: string enum: *a57 description: The marital status of the applicant identification_number: type: string description: The social security number of the applicant drivers_license_number: type: string description: The driver's license number of the applicant address_history: type: array items: type: object properties: address_1: type: string description: The first address line associated with the applicant's historical address city: type: string description: The city associated with the applicant's historical address state: type: string enum: *a33 description: The state associated with the applicant zip: type: string description: The zip code associated with the applicant's historical address country: anyOf: - type: string enum: *a54 - type: string description: The country associated with the applicant's historical address. If your application needs to support submitting an applicant who resides in another country, please reach out to Propexo Support for help notice_provided: type: boolean description: Whether notice has been given to the applicant's historical address property_name: type: string description: The property name of the applicant's historical address reason_for_leaving: type: string description: The reason the applicant left their historical address monthly_payment_in_cents: type: integer minimum: 0 description: For the applicant's historical address, the applicant's monthly payment for rent or mortgage in cents move_in_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date when the applicant moved into their historical address move_out_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date when the applicant moved out of their historical address. If this is the applicant's current address, omit this field manager_phone: type: string pattern: ^\d{10}$ description: The phone number of a property manager who works at this address manager_email: type: string format: email description: The email of a property manager who works at this address management_company: type: string description: The name of the company who owns the property at this address required: - address_1 - city - state - zip - notice_provided - move_in_date maxItems: 2 default: *a58 description: "The address history of the applicant. Note: This will only be added to the primary applicant on the application." emergency_contacts: type: array items: type: object properties: first_name: type: string description: The first name of the emergency contact last_name: type: string description: The last name of the emergency contact relationship: type: string enum: *a56 description: The relationship of the emergency contact to the applicant address_1: type: string description: The first line of the address of the emergency contact city: type: string description: The city of the address of the emergency contact state: type: string enum: *a33 description: The state of the address of the emergency contact zip: type: string description: The zip code of the address of the emergency contact country: anyOf: - type: string enum: *a54 - type: string description: The country of the address of the emergency contact. If your application needs to support submitting an applicant who resides in another country, please reach out to Propexo Support for help phone_1: type: string pattern: ^\d{10}$ description: The phone number of the emergency contact required: - first_name - last_name - relationship maxItems: 1 default: *a59 description: "A list of emergency contacts for the applicant. Note: This will only be added to the primary applicant on the application." employment_history: type: array items: type: object properties: is_current_employer: type: boolean description: Whether this employment history entry is for a current employer name: type: string description: The name of the employer start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The start date of the applicant's employment at this employer end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The end date of the applicant's employment at this employer. Ignore this field if is_current_employer is set to true address_1: type: string description: The first line of the address of the employer city: type: string description: The city of the address of the employer state: type: string enum: *a33 description: The state of the address of the employer zip: type: string description: The zip code of the address of the employer phone: type: string pattern: ^\d{10}$ description: "The phone number of the employer. DEPRECATED: Use supervisor_phone instead" deprecated: true supervisor_phone: type: string pattern: ^\d{10}$ description: The phone number of the applicant's supervisor supervisor_first_name: type: string description: The first name of the applicant's supervisor at this employer supervisor_last_name: type: string description: The last name of the applicant's supervisor at this employer position: type: string description: The position held at this employer, or the job description of the applicant monthly_income_in_cents: type: integer minimum: 0 description: "The monthly income of the applicant at this employer in cents. DEPRECATED: Use income_in_cents instead" deprecated: true income_in_cents: type: integer minimum: 0 description: The monthly income of the applicant at this employer in cents. deprecated: true required: - is_current_employer - name - start_date maxItems: 2 default: *a60 description: "The employment history of the applicant. Note: This will only be added to the primary applicant on the application." other_income: type: array items: type: object properties: source: type: string description: The source of the income for the applicant monthly_income_in_cents: type: integer minimum: 0 description: The monthly income from this income source in cents required: - source - monthly_income_in_cents maxItems: 2 default: *a61 description: "A list of other income sources for the applicant. Note: This will only be added to the primary applicant on the application." vehicles: type: array items: type: object properties: make: type: string description: The make of the vehicle model: type: string description: The model of the vehicle year: type: integer description: The year the vehicle was made color: type: string description: The color of the vehicle license_plate_number: type: string description: The license plate number of the vehicle license_plate_state: type: string enum: *a33 description: The issuing state of the license plate required: - make maxItems: 4 default: *a62 description: "A list of vehicles for the application. Note: This will only be added to the primary applicant on the application." pets: type: array items: type: object properties: type: type: string description: The type associated with the applicant pet name: type: string description: The name associated with the applicant pet age_in_years: type: integer minimum: 0 description: The age in years of the applicant pet weight_in_pounds: type: integer minimum: 0 description: The weight in pounds of the applicant pet breed: type: string description: The breed of the applicant pet color: type: string description: The color of the applicant pet gender: type: string description: The raw value for the gender of the applicant pet is_fixed: type: boolean description: Whether the applicant pet is fixed is_service_animal: type: boolean description: Whether the applicant pet is a service animal required: - type maxItems: 6 default: *a63 description: "A list of applicant pets. Note: This will only be added to the primary applicant on the application." concession_fees: type: array items: type: object properties: start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The start date of the applicant's recurring concession fee end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The end date of the applicant's recurring concession fee concession_id: type: string description: The Propexo unique identifier for the concession. This concession must be associated with the unit that the applicant is applying for required: - start_date - end_date - concession_id default: *a64 description: A list of concession fees for the application application_fees: type: array items: type: object properties: charge_code_id: type: string description: The Propexo unique identifier for the charge code. This must be an application fee charge code amount_in_cents: type: integer minimum: 0 description: The application fee amount in cents description: type: string description: Description of the application fee required: - charge_code_id - amount_in_cents default: *a65 description: A list of application fees for the application other_occupants: type: array items: type: object properties: relationship: type: string enum: *a55 description: The relationship of the occupant to the applicant first_name: type: string description: The first name associated with the occupant last_name: type: string description: The last name associated with the occupant third_party_id: type: string description: A unique ID you would like to associate with the occupant. This is not the Yardi occupant ID organization_name: type: string description: The name of your organization. Yardi uses this for associating an occupant email_1: type: string format: email description: The primary email address associated with the occupant phone_1: type: string pattern: ^\d{10}$ description: Primary phone number associated with the occupant phone_1_type: type: string enum: *a16 description: Type of the primary phone number phone_2: type: string pattern: ^\d{10}$ description: Secondary phone number associated with the occupant phone_2_type: type: string enum: *a16 description: Type of the secondary phone number address_1: type: string description: The first address line associated with the occupant city: type: string description: The city associated with the occupant state: type: string enum: *a33 description: The state associated with the occupant zip: type: string description: The zip code associated with the occupant required: - relationship - first_name - last_name - third_party_id - organization_name default: *a66 description: A list of other occupants for the application required: - integration_id - property_id - unit_id _v1_applications_yardi__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration property_id: type: string description: The Propexo unique identifier for the property unit_id: type: string description: The Propexo unique identifier for the unit lead_id: type: - string - "null" description: The Propexo unique identifier for the lead. The lead will be converted to an applicant employee_id: type: - string - "null" description: The Propexo unique identifier for the employee. Employee must have a role of LEASING_AGENT. Required if lead_id is not specified lead_source_id: type: - string - "null" description: The Propexo unique identifier for the lead source. Required if lead_id is not specified third_party_id: type: - string - "null" minLength: 1 description: A unique ID you would like to associate with the applicant. This is not the Yardi applicant ID. Required if lead_id is not specified organization_name: type: - string - "null" description: The name of your organization. Yardi uses this for associating an applicant. Required if lead_id is not specified first_name: type: - string - "null" description: The first name associated with the applicant. Required if lead_id is not specified last_name: type: - string - "null" description: The last name associated with the applicant. Required if lead_id is not specified middle_name: type: - string - "null" description: The middle name associated with the applicant maiden_name: type: - string - "null" description: The maiden name associated with the applicant email_1: type: - string - "null" format: email description: The primary email address associated with the applicant phone_1: type: - string - "null" pattern: ^\d{10}$ description: Primary phone number associated with the applicant phone_1_type: type: - string - "null" enum: *a16 description: Type of the primary phone number phone_2: type: - string - "null" pattern: ^\d{10}$ description: Secondary phone number associated with the applicant phone_2_type: type: - string - "null" enum: *a16 description: Type of the secondary phone number move_in_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" description: The desired move-in date to the unit listed in the application move_out_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" description: The desired move-out date to the unit listed in the application desired_lease_term_in_months: type: - string - "null" description: The desired lease term in months of the applicant date_of_birth: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" description: The date of birth associated with the applicant notes: type: - string - "null" description: Notes associated with the applicant is_evicted: type: - boolean - "null" description: Whether the applicant has been evicted is_felony: type: - boolean - "null" description: Whether the applicant has a felony is_criminal_charge: type: - boolean - "null" description: Whether the applicant has a criminal charge eviction_description: type: - string - "null" description: The description of the eviction felony_description: type: - string - "null" description: The description of the felony criminal_charge_description: type: - string - "null" description: The description of the criminal charge marital_status: type: - string - "null" enum: *a57 description: The marital status of the applicant identification_number: type: - string - "null" description: The social security number of the applicant drivers_license_number: type: - string - "null" description: The driver's license number of the applicant address_history: type: array items: type: object properties: address_1: type: string description: The first address line associated with the applicant's historical address city: type: string description: The city associated with the applicant's historical address state: type: string enum: *a33 description: The state associated with the applicant zip: type: string description: The zip code associated with the applicant's historical address country: anyOf: - type: string enum: *a54 - type: string description: The country associated with the applicant's historical address. If your application needs to support submitting an applicant who resides in another country, please reach out to Propexo Support for help notice_provided: type: boolean description: Whether notice has been given to the applicant's historical address property_name: type: string description: The property name of the applicant's historical address reason_for_leaving: type: string description: The reason the applicant left their historical address monthly_payment_in_cents: type: integer minimum: 0 description: For the applicant's historical address, the applicant's monthly payment for rent or mortgage in cents move_in_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date when the applicant moved into their historical address move_out_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date when the applicant moved out of their historical address. If this is the applicant's current address, omit this field manager_phone: type: string pattern: ^\d{10}$ description: The phone number of a property manager who works at this address manager_email: type: string format: email description: The email of a property manager who works at this address management_company: type: string description: The name of the company who owns the property at this address required: - address_1 - city - state - zip - notice_provided - move_in_date maxItems: 2 default: *a58 description: "The address history of the applicant. Note: This will only be added to the primary applicant on the application." emergency_contacts: type: array items: type: object properties: first_name: type: string description: The first name of the emergency contact last_name: type: string description: The last name of the emergency contact relationship: type: string enum: *a56 description: The relationship of the emergency contact to the applicant address_1: type: string description: The first line of the address of the emergency contact city: type: string description: The city of the address of the emergency contact state: type: string enum: *a33 description: The state of the address of the emergency contact zip: type: string description: The zip code of the address of the emergency contact country: anyOf: - type: string enum: *a54 - type: string description: The country of the address of the emergency contact. If your application needs to support submitting an applicant who resides in another country, please reach out to Propexo Support for help phone_1: type: string pattern: ^\d{10}$ description: The phone number of the emergency contact required: - first_name - last_name - relationship maxItems: 1 default: *a59 description: "A list of emergency contacts for the applicant. Note: This will only be added to the primary applicant on the application." employment_history: type: array items: type: object properties: is_current_employer: type: boolean description: Whether this employment history entry is for a current employer name: type: string description: The name of the employer start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The start date of the applicant's employment at this employer end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The end date of the applicant's employment at this employer. Ignore this field if is_current_employer is set to true address_1: type: string description: The first line of the address of the employer city: type: string description: The city of the address of the employer state: type: string enum: *a33 description: The state of the address of the employer zip: type: string description: The zip code of the address of the employer phone: type: string pattern: ^\d{10}$ description: "The phone number of the employer. DEPRECATED: Use supervisor_phone instead" deprecated: true supervisor_phone: type: string pattern: ^\d{10}$ description: The phone number of the applicant's supervisor supervisor_first_name: type: string description: The first name of the applicant's supervisor at this employer supervisor_last_name: type: string description: The last name of the applicant's supervisor at this employer position: type: string description: The position held at this employer, or the job description of the applicant monthly_income_in_cents: type: integer minimum: 0 description: "The monthly income of the applicant at this employer in cents. DEPRECATED: Use income_in_cents instead" deprecated: true income_in_cents: type: integer minimum: 0 description: The monthly income of the applicant at this employer in cents. deprecated: true required: - is_current_employer - name - start_date maxItems: 2 default: *a60 description: "The employment history of the applicant. Note: This will only be added to the primary applicant on the application." other_income: type: array items: type: object properties: source: type: string description: The source of the income for the applicant monthly_income_in_cents: type: integer minimum: 0 description: The monthly income from this income source in cents required: - source - monthly_income_in_cents maxItems: 2 default: *a61 description: "A list of other income sources for the applicant. Note: This will only be added to the primary applicant on the application." vehicles: type: array items: type: object properties: make: type: string description: The make of the vehicle model: type: string description: The model of the vehicle year: type: integer description: The year the vehicle was made color: type: string description: The color of the vehicle license_plate_number: type: string description: The license plate number of the vehicle license_plate_state: type: string enum: *a33 description: The issuing state of the license plate required: - make maxItems: 4 default: *a62 description: "A list of vehicles for the application. Note: This will only be added to the primary applicant on the application." pets: type: array items: type: object properties: type: type: string description: The type associated with the applicant pet name: type: string description: The name associated with the applicant pet age_in_years: type: integer minimum: 0 description: The age in years of the applicant pet weight_in_pounds: type: integer minimum: 0 description: The weight in pounds of the applicant pet breed: type: string description: The breed of the applicant pet color: type: string description: The color of the applicant pet gender: type: string description: The raw value for the gender of the applicant pet is_fixed: type: boolean description: Whether the applicant pet is fixed is_service_animal: type: boolean description: Whether the applicant pet is a service animal required: - type maxItems: 6 default: *a63 description: "A list of applicant pets. Note: This will only be added to the primary applicant on the application." concession_fees: type: array items: type: object properties: start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The start date of the applicant's recurring concession fee end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The end date of the applicant's recurring concession fee concession_id: type: string description: The Propexo unique identifier for the concession. This concession must be associated with the unit that the applicant is applying for required: - start_date - end_date - concession_id default: *a64 description: A list of concession fees for the application application_fees: type: array items: type: object properties: charge_code_id: type: string description: The Propexo unique identifier for the charge code. This must be an application fee charge code amount_in_cents: type: integer minimum: 0 description: The application fee amount in cents description: type: string description: Description of the application fee required: - charge_code_id - amount_in_cents default: *a65 description: A list of application fees for the application other_occupants: type: - array - "null" items: type: object properties: relationship: type: string enum: *a55 description: The relationship of the occupant to the applicant first_name: type: string description: The first name associated with the occupant last_name: type: string description: The last name associated with the occupant third_party_id: type: string description: A unique ID you would like to associate with the occupant. This is not the Yardi occupant ID organization_name: type: string description: The name of your organization. Yardi uses this for associating an occupant email_1: type: string format: email description: The primary email address associated with the occupant phone_1: type: string pattern: ^\d{10}$ description: Primary phone number associated with the occupant phone_1_type: type: string enum: *a16 description: Type of the primary phone number phone_2: type: string pattern: ^\d{10}$ description: Secondary phone number associated with the occupant phone_2_type: type: string enum: *a16 description: Type of the secondary phone number address_1: type: string description: The first address line associated with the occupant city: type: string description: The city associated with the occupant state: type: string enum: *a33 description: The state associated with the occupant zip: type: string description: The zip code associated with the occupant required: - relationship - first_name - last_name - third_party_id - organization_name default: *a66 required: - integration_id - property_id - unit_id - lead_id - employee_id - lead_source_id - third_party_id - organization_name - first_name - last_name - middle_name - maiden_name - email_1 - phone_1 - phone_1_type - phone_2 - phone_2_type - move_in_date - move_out_date - desired_lease_term_in_months - date_of_birth - notes - is_evicted - is_felony - is_criminal_charge - eviction_description - felony_description - criminal_charge_description - marital_status - identification_number - drivers_license_number required: - meta - result _v1_applications_yardi_{application_id}_put_input: type: object properties: applicant_id: type: string description: The Propexo unique identifier for the applicant first_name: type: string description: The first name associated with the applicant last_name: type: string description: The last name associated with the applicant middle_name: type: string description: The middle name associated with the applicant maiden_name: type: string description: The maiden name associated with the applicant email_1: type: string format: email description: The primary email address associated with the applicant phone_1: type: string pattern: ^\d{10}$ description: Primary phone number associated with the applicant phone_1_type: type: string enum: *a16 description: Type of the primary phone number phone_2: type: string pattern: ^\d{10}$ description: Secondary phone number associated with the applicant phone_2_type: type: string enum: *a16 description: Type of the secondary phone number move_in_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The desired move-in date to the unit listed in the application move_out_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The desired move-out date to the unit listed in the application desired_lease_term_in_months: type: string description: The desired lease term in months of the applicant date_of_birth: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date of birth associated with the applicant notes: type: string description: Notes associated with the applicant is_evicted: type: boolean description: Whether the applicant has been evicted is_felony: type: boolean description: Whether the applicant has a felony is_criminal_charge: type: boolean description: Whether the applicant has a criminal charge eviction_description: type: string description: The description of the eviction felony_description: type: string description: The description of the felony criminal_charge_description: type: string description: The description of the criminal charge marital_status: type: string enum: *a57 description: The marital status of the applicant identification_number: type: string description: The social security number of the applicant drivers_license_number: type: string description: The driver's license number of the applicant address_history: type: array items: type: object properties: address_1: type: string description: The first address line associated with the applicant's historical address city: type: string description: The city associated with the applicant's historical address state: type: string enum: *a33 description: The state associated with the applicant zip: type: string description: The zip code associated with the applicant's historical address country: anyOf: - type: string enum: *a67 - type: string description: The country associated with the applicant's historical address. If your application needs to support submitting an applicant who resides in another country, please reach out to Propexo Support for help notice_provided: type: boolean description: Whether notice has been given to the applicant's historical address property_name: type: string description: The property name of the applicant's historical address reason_for_leaving: type: string description: The reason the applicant left their historical address monthly_payment_in_cents: type: integer minimum: 0 description: For the applicant's historical address, the applicant's monthly payment for rent or mortgage in cents move_in_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date when the applicant moved into their historical address move_out_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date when the applicant moved out of their historical address. If this is the applicant's current address, omit this field manager_phone: type: string pattern: ^\d{10}$ description: The phone number of a property manager who works at this address manager_email: type: string format: email description: The email of a property manager who works at this address management_company: type: string description: The name of the company who owns the property at this address required: - address_1 - city - state - zip - notice_provided - move_in_date maxItems: 2 default: *a68 description: The address history of the applicant emergency_contacts: type: array items: type: object properties: first_name: type: string description: The first name of the emergency contact last_name: type: string description: The last name of the emergency contact relationship: type: string enum: *a56 description: The relationship of the emergency contact to the applicant address_1: type: string description: The first line of the address of the emergency contact city: type: string description: The city of the address of the emergency contact state: type: string enum: *a33 description: The state of the address of the emergency contact zip: type: string description: The zip code of the address of the emergency contact country: anyOf: - type: string enum: *a69 - type: string description: The country of the address of the emergency contact. If your application needs to support submitting an applicant who resides in another country, please reach out to Propexo Support for help phone_1: type: string pattern: ^\d{10}$ description: The phone number of the emergency contact required: - first_name - last_name - relationship maxItems: 1 default: *a70 description: A list of emergency contacts for the applicant employment_history: type: array items: type: object properties: is_current_employer: type: boolean description: Whether this employment history entry is for a current employer name: type: string description: The name of the employer start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The start date of the applicant's employment at this employer end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The end date of the applicant's employment at this employer. Ignore this field if is_current_employer is set to true address_1: type: string description: The first line of the address of the employer city: type: string description: The city of the address of the employer state: type: string enum: *a33 description: The state of the address of the employer zip: type: string description: The zip code of the address of the employer phone: type: string pattern: ^\d{10}$ description: The phone number of the employer supervisor_first_name: type: string description: The first name of the applicant's supervisor at this employer supervisor_last_name: type: string description: The last name of the applicant's supervisor at this employer position: type: string description: The position held at this employer, or the job description of the applicant monthly_income_in_cents: type: integer minimum: 0 description: The monthly income of the applicant at this employer in cents required: - is_current_employer - name - start_date - monthly_income_in_cents maxItems: 2 default: *a71 description: The employment history of the applicant other_income: type: array items: type: object properties: source: type: string description: The source of the income for the applicant monthly_income_in_cents: type: integer minimum: 0 description: The monthly income from this income source in cents required: - source - monthly_income_in_cents maxItems: 2 default: *a72 description: A list of other income sources for the applicant vehicles: type: array items: type: object properties: make: type: string description: The make of the vehicle model: type: string description: The model of the vehicle year: type: integer description: The year the vehicle was made color: type: string description: The color of the vehicle license_plate_number: type: string description: The license plate number of the vehicle license_plate_state: type: string enum: *a33 description: The issuing state of the license plate required: - make maxItems: 4 default: *a73 description: A list of vehicles for the application pets: type: array items: type: object properties: type: type: string description: The type associated with the applicant pet name: type: string description: The name associated with the applicant pet age_in_years: type: integer minimum: 0 description: The age in years of the applicant pet weight_in_pounds: type: integer minimum: 0 description: The weight in pounds of the applicant pet breed: type: string description: The breed of the applicant pet color: type: string description: The color of the applicant pet gender: type: string description: The raw value for the gender of the applicant pet is_fixed: type: boolean description: Whether the applicant pet is fixed is_service_animal: type: boolean description: Whether the applicant pet is a service animal required: - type maxItems: 6 default: *a74 description: A list of applicant pets. If any pets are provided, this list will overwrite the existing list of pets concession_fees: type: array items: type: object properties: start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The start date of the applicant's recurring concession fee end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The end date of the applicant's recurring concession fee concession_id: type: string description: The Propexo unique identifier for the concession. This concession must be associated with the unit that the applicant is applying for required: - start_date - end_date - concession_id default: *a75 description: A list of concession fees for the application application_fees: type: array items: type: object properties: charge_code_id: type: string description: The Propexo unique identifier for the charge code. This must be an application fee charge code amount_in_cents: type: integer minimum: 0 description: The application fee amount in cents description: type: string description: Description of the application fee required: - charge_code_id - amount_in_cents default: *a76 description: A list of application fees for the application. Only new application fees should be passed in, existing fees cannot be updated other_occupants: type: array items: type: object properties: relationship: type: string enum: *a55 description: The relationship of the occupant to the applicant first_name: type: string description: The first name associated with the occupant last_name: type: string description: The last name associated with the occupant third_party_id: type: string minLength: 1 description: A unique ID you would like to associate with the occupant. This is not the Yardi occupant ID organization_name: type: string description: The name of your organization. Yardi uses this for associating an occupant email_1: type: string format: email description: The primary email address associated with the occupant phone_1: type: string pattern: ^\d{10}$ description: Primary phone number associated with the occupant phone_1_type: type: string enum: *a16 description: Type of the primary phone number phone_2: type: string pattern: ^\d{10}$ description: Secondary phone number associated with the occupant phone_2_type: type: string enum: *a16 description: Type of the secondary phone number address_1: type: string description: The first address line associated with the occupant city: type: string description: The city associated with the occupant state: type: string enum: *a33 description: The state associated with the occupant zip: type: string description: The zip code associated with the occupant required: - relationship - first_name - last_name - third_party_id - organization_name default: *a77 description: A list of other occupants for the application. Only new occupants should be passed in, existing occupants cannot be updated required: - applicant_id _v1_applications_yardi_{application_id}_put_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: application_id: type: string description: The Propexo unique identifier for the application applicant_id: type: string description: The Propexo unique identifier for the applicant first_name: type: string description: The first name associated with the applicant last_name: type: string description: The last name associated with the applicant middle_name: type: string description: The middle name associated with the applicant maiden_name: type: string description: The maiden name associated with the applicant email_1: type: string format: email description: The primary email address associated with the applicant phone_1: type: string pattern: ^\d{10}$ description: Primary phone number associated with the applicant phone_1_type: type: string enum: *a16 description: Type of the primary phone number phone_2: type: string pattern: ^\d{10}$ description: Secondary phone number associated with the applicant phone_2_type: type: string enum: *a16 description: Type of the secondary phone number move_in_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The desired move-in date to the unit listed in the application move_out_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The desired move-out date to the unit listed in the application desired_lease_term_in_months: type: string description: The desired lease term in months of the applicant date_of_birth: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date of birth associated with the applicant notes: type: string description: Notes associated with the applicant is_evicted: type: boolean description: Whether the applicant has been evicted is_felony: type: boolean description: Whether the applicant has a felony is_criminal_charge: type: boolean description: Whether the applicant has a criminal charge eviction_description: type: string description: The description of the eviction felony_description: type: string description: The description of the felony criminal_charge_description: type: string description: The description of the criminal charge marital_status: type: string enum: *a57 description: The marital status of the applicant identification_number: type: string description: The social security number of the applicant drivers_license_number: type: string description: The driver's license number of the applicant address_history: type: array items: type: object properties: address_1: type: string description: The first address line associated with the applicant's historical address city: type: string description: The city associated with the applicant's historical address state: type: string enum: *a33 description: The state associated with the applicant zip: type: string description: The zip code associated with the applicant's historical address country: anyOf: - type: string enum: *a67 - type: string description: The country associated with the applicant's historical address. If your application needs to support submitting an applicant who resides in another country, please reach out to Propexo Support for help notice_provided: type: boolean description: Whether notice has been given to the applicant's historical address property_name: type: string description: The property name of the applicant's historical address reason_for_leaving: type: string description: The reason the applicant left their historical address monthly_payment_in_cents: type: integer minimum: 0 description: For the applicant's historical address, the applicant's monthly payment for rent or mortgage in cents move_in_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date when the applicant moved into their historical address move_out_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date when the applicant moved out of their historical address. If this is the applicant's current address, omit this field manager_phone: type: string pattern: ^\d{10}$ description: The phone number of a property manager who works at this address manager_email: type: string format: email description: The email of a property manager who works at this address management_company: type: string description: The name of the company who owns the property at this address required: - address_1 - city - state - zip - notice_provided - move_in_date maxItems: 2 default: *a68 description: The address history of the applicant emergency_contacts: type: array items: type: object properties: first_name: type: string description: The first name of the emergency contact last_name: type: string description: The last name of the emergency contact relationship: type: string enum: *a56 description: The relationship of the emergency contact to the applicant address_1: type: string description: The first line of the address of the emergency contact city: type: string description: The city of the address of the emergency contact state: type: string enum: *a33 description: The state of the address of the emergency contact zip: type: string description: The zip code of the address of the emergency contact country: anyOf: - type: string enum: *a69 - type: string description: The country of the address of the emergency contact. If your application needs to support submitting an applicant who resides in another country, please reach out to Propexo Support for help phone_1: type: string pattern: ^\d{10}$ description: The phone number of the emergency contact required: - first_name - last_name - relationship maxItems: 1 default: *a70 description: A list of emergency contacts for the applicant employment_history: type: array items: type: object properties: is_current_employer: type: boolean description: Whether this employment history entry is for a current employer name: type: string description: The name of the employer start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The start date of the applicant's employment at this employer end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The end date of the applicant's employment at this employer. Ignore this field if is_current_employer is set to true address_1: type: string description: The first line of the address of the employer city: type: string description: The city of the address of the employer state: type: string enum: *a33 description: The state of the address of the employer zip: type: string description: The zip code of the address of the employer phone: type: string pattern: ^\d{10}$ description: The phone number of the employer supervisor_first_name: type: string description: The first name of the applicant's supervisor at this employer supervisor_last_name: type: string description: The last name of the applicant's supervisor at this employer position: type: string description: The position held at this employer, or the job description of the applicant monthly_income_in_cents: type: integer minimum: 0 description: The monthly income of the applicant at this employer in cents required: - is_current_employer - name - start_date - monthly_income_in_cents maxItems: 2 default: *a71 description: The employment history of the applicant other_income: type: array items: type: object properties: source: type: string description: The source of the income for the applicant monthly_income_in_cents: type: integer minimum: 0 description: The monthly income from this income source in cents required: - source - monthly_income_in_cents maxItems: 2 default: *a72 description: A list of other income sources for the applicant vehicles: type: array items: type: object properties: make: type: string description: The make of the vehicle model: type: string description: The model of the vehicle year: type: integer description: The year the vehicle was made color: type: string description: The color of the vehicle license_plate_number: type: string description: The license plate number of the vehicle license_plate_state: type: string enum: *a33 description: The issuing state of the license plate required: - make maxItems: 4 default: *a73 description: A list of vehicles for the application pets: type: array items: type: object properties: type: type: string description: The type associated with the applicant pet name: type: string description: The name associated with the applicant pet age_in_years: type: integer minimum: 0 description: The age in years of the applicant pet weight_in_pounds: type: integer minimum: 0 description: The weight in pounds of the applicant pet breed: type: string description: The breed of the applicant pet color: type: string description: The color of the applicant pet gender: type: string description: The raw value for the gender of the applicant pet is_fixed: type: boolean description: Whether the applicant pet is fixed is_service_animal: type: boolean description: Whether the applicant pet is a service animal required: - type maxItems: 6 default: *a74 description: A list of applicant pets. If any pets are provided, this list will overwrite the existing list of pets concession_fees: type: array items: type: object properties: start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The start date of the applicant's recurring concession fee end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The end date of the applicant's recurring concession fee concession_id: type: string description: The Propexo unique identifier for the concession. This concession must be associated with the unit that the applicant is applying for required: - start_date - end_date - concession_id default: *a75 description: A list of concession fees for the application application_fees: type: array items: type: object properties: charge_code_id: type: string description: The Propexo unique identifier for the charge code. This must be an application fee charge code amount_in_cents: type: integer minimum: 0 description: The application fee amount in cents description: type: string description: Description of the application fee required: - charge_code_id - amount_in_cents default: *a76 description: A list of application fees for the application. Only new application fees should be passed in, existing fees cannot be updated other_occupants: type: array items: type: object properties: relationship: type: string enum: *a55 description: The relationship of the occupant to the applicant first_name: type: string description: The first name associated with the occupant last_name: type: string description: The last name associated with the occupant third_party_id: type: string minLength: 1 description: A unique ID you would like to associate with the occupant. This is not the Yardi occupant ID organization_name: type: string description: The name of your organization. Yardi uses this for associating an occupant email_1: type: string format: email description: The primary email address associated with the occupant phone_1: type: string pattern: ^\d{10}$ description: Primary phone number associated with the occupant phone_1_type: type: string enum: *a16 description: Type of the primary phone number phone_2: type: string pattern: ^\d{10}$ description: Secondary phone number associated with the occupant phone_2_type: type: string enum: *a16 description: Type of the secondary phone number address_1: type: string description: The first address line associated with the occupant city: type: string description: The city associated with the occupant state: type: string enum: *a33 description: The state associated with the occupant zip: type: string description: The zip code associated with the occupant required: - relationship - first_name - last_name - third_party_id - organization_name default: *a77 required: - application_id - applicant_id required: - meta - result _v1_applications_rentvine__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration application_template_id: type: string description: "The Propexo unique identifier for the application template. The Rentvine application template dynamically defines which fields are required for each applicant/application: whether a field is active, disabled, required, or optional. A template may also allow some enums to be modified or for entire fields to be relabeled/repurposed. The functionality of a template is extensive and will likely require that you work with your customer to define a custom template for your application use case" leasing_agent_first_name: type: string description: The first name of the leasing agent. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements leasing_agent_last_name: type: string description: The last name of the leasing agent. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements leasing_agent_contact_info: type: string description: The contact info for the leasing agent. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements rent_amount_in_cents: type: integer minimum: 0 description: The rent amount in cents that the applicant will pay for the unit. This field is not configurable on the Rentvine template and is always required security_deposit_in_cents: type: integer minimum: 0 description: The security deposit in cents that the applicant will pay for the unit. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements move_in_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The desired move-in date to the unit listed in the application. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements lease_period_id: type: string description: The lease period to use for the application. If supplied, this field must be one of the approved lease periods defined on the Rentvine template. You can see a list of available choices for each application template on the appropriate lease period endpoint. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements or to change the list of available lease periods first_name: type: string description: The first name associated with the applicant. This field is not configurable on the Rentvine template and is always required middle_name: type: string description: The middle name associated with the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements last_name: type: string description: The last name associated with the applicant. This field is not configurable on the Rentvine template and is always required type: type: string enum: *a18 description: The type of applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements. Although the field itself can be made optional/required, the value must be one of the available choices and cannot be modified as part of the template marital_status: type: string enum: *a19 description: The marital status of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements. Although the field itself can be made optional/required, the value must be one of the available choices and cannot be modified as part of the template maiden_name: type: string description: The maiden name or birth name of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements height: type: string description: The height of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements weight: type: string description: The weight of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements eye_color: type: string description: The eye color of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements hair_color: type: string description: The hair color of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements phone_1: type: string pattern: ^\+?\d{1,50}$ description: Primary phone number associated with the applicant. An applicant can have no more than one of each phone type. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements phone_1_type: type: string enum: *a45 description: Type of the primary phone number. An applicant can have no more than one of each phone type phone_2: type: string pattern: ^\+?\d{1,50}$ description: Secondary phone number associated with the applicant. An applicant can have no more than one of each phone type. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements phone_2_type: type: string enum: *a46 description: Type of the secondary phone number. An applicant can have no more than one of each phone type. phone_3: type: string pattern: ^\+?\d{1,50}$ description: Third phone number associated with the applicant. An applicant can have no more than one of each phone type. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements phone_3_type: type: string enum: *a20 description: Type of the third phone number. An applicant can have no more than one of each phone type. email_1: type: string format: email description: The primary email address associated with the applicant. This field is not configurable on the Rentvine template and is always required date_of_birth: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date of birth associated with the applicant. This field is not configurable on the Rentvine template and is always required identification_number: type: string description: The Social Security Number or Individual Taxpayer Identification Number associated with the applicant. Rentvine uses a pre-2011 validation scheme for SSN's meaning that some valid SSNs will be incorrectly rejected. Reach out to support if you find that a valid SSN is being rejected. This field is not configurable on the Rentvine template and is always required citizenship: type: string description: The country of citizenship of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements place_of_birth: type: string description: The place of birth of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements passport_number: type: string description: The passport number of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements student_id: type: string description: The student ID number of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements drivers_license_number: type: string description: The driver's license number of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements drivers_license_state: type: string description: The issuing state of the applicant's driver's license. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements lead_source: type: string description: The name of the source of the lead or how the applicant heard of the property management company. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements emergency_contacts: type: array items: type: object properties: first_name: type: string description: The first name of the emergency contact. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements last_name: type: string description: The last name of the emergency contact. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements relationship: type: string description: The relationship of the emergency contact to the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements address_1: type: string description: The first line of the address of the emergency contact. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements address_2: type: string description: The second line of the address of the emergency contact. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements city: type: string description: The city of the address of the emergency contact. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements state: type: string description: The state of the address of the emergency contact. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements zip: type: string description: The zip code of the address of the emergency contact. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements country: type: string description: The country of the address of the emergency contact. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements phone_1: type: string pattern: ^\+?\d{1,50}$ description: The phone number of the emergency contact. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements phone_2: type: string pattern: ^\+?\d{1,50}$ description: The second phone number of the emergency contact. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements email_1: type: string format: email description: The email of the emergency contact. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements description: A list of emergency contacts for the applicant. Depending on the Rentvine template, this array can be customized to be either required or optional. The template may also require a minimum number of items in the array in order to pass validation. You will need to work with your customer directly to configure this field to your application requirements application_references: type: array items: type: object properties: first_name: type: string description: The first name of the applicant's reference. This field is not configurable on the Rentvine template and is always required last_name: type: string description: The last name of the applicant's reference. This field is not configurable on the Rentvine template and is always required relationship: type: string description: The relationship of the applicant's reference to the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements address_1: type: string description: The first line of the address of the applicant's reference. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements address_2: type: string description: The second line of the address of the applicant's reference. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements city: type: string description: The city of the address of the applicant's reference. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements state: type: string description: The state of the address of the applicant's reference. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements zip: type: string description: The zip code of the address of the applicant's reference. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements country: type: string description: The country of the address of the applicant's reference. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements phone_1: type: string pattern: ^\+?\d{1,50}$ description: The phone number of the applicant's reference. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements required: - first_name - last_name description: A list of applicant references for the application. Depending on the Rentvine template, this array can be customized to be either required or optional. The template may also require a minimum number of items in the array in order to pass validation. You will need to work with your customer directly to configure this field to your application requirements vehicles: type: array items: type: object properties: make: type: string description: The make of the vehicle. This field is not configurable on the Rentvine template and is always required model: type: string description: The model of the vehicle. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements year: type: integer description: The year the vehicle was made. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements color: type: string description: The color of the vehicle. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements license_plate_number: type: string description: The license plate number of the vehicle. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements license_plate_state: type: string description: The issuing state of the license plate. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements monthly_payment_in_cents: type: integer minimum: 0 description: If the vehicle is leased or financed, the applicant's monthly payment for the vehicle in cents. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements insurance_carrier: type: string description: The insurance carrier for the applicant's vehicle. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements required: - make description: A list of vehicles for the application. Depending on the Rentvine template, this array can be customized to be either required or optional. The template may also require a minimum number of items in the array in order to pass validation. You will need to work with your customer directly to configure this field to your application requirements other_occupants: type: array items: type: object properties: first_name: type: string description: The first name of the occupant. This field is not configurable on the Rentvine template and is always required last_name: type: string description: The last name of the occupant. This field is not configurable on the Rentvine template and is always required date_of_birth: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date of birth of the occupant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements relationship: type: string enum: *a21 description: The relationship of the occupant to the applicant. The only allowed value is "OTHER" and is used to represent non-applicants under 18 years old. Contact Propexo Support if you need to support a workflow that allows adding additional applicants to an application relationship_detail: type: string description: The relationship detail of the occupant to the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements required: - first_name - last_name - relationship description: A list of other occupants who will live in the unit, such as children, etc. Depending on the Rentvine template, this array can be customized to be either required or optional. The template may also require a minimum number of items in the array in order to pass validation. You will need to work with your customer directly to configure this field to your application requirements. Do not include any applicants in this list. If your application use case requires creating multiple applicants in the same application, please reach out to Propexo Support for help. pets: type: array items: type: object properties: name: type: string description: The name associated with the applicant pet. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements type: type: string description: The type associated with the applicant pet (or breed). This field is not configurable on the Rentvine template and is always required age_in_years: type: integer minimum: 0 description: The age in years of the applicant pet. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements weight_in_pounds: type: integer minimum: 0 description: The weight in pounds of the applicant pet. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements is_trained: type: boolean description: Whether the applicant pet is trained. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements color: type: string description: The color of the applicant pet. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements gender: type: string enum: *a17 description: The gender of the applicant pet. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements is_declawed: type: boolean description: Whether the applicant pet is declawed. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements is_vaccinated: type: boolean description: Whether the applicant pet is vaccinated. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements is_fixed: type: boolean description: Whether the applicant pet is fixed. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements required: - type description: A list of applicant pets. Depending on the Rentvine template, this array can be customized to be either required or optional. The template may also require a minimum number of items in the array in order to pass validation. You will need to work with your customer directly to configure this field to your application requirements address_history: type: array items: type: object properties: address_1: type: string description: The first address line associated with the applicant's historical address. This field is not configurable on the Rentvine template and is always required address_2: type: string description: The second address line associated with the applicant's historical address. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements city: type: string description: The city associated with the applicant's historical address. This field is not configurable on the Rentvine template and is always required state: type: string enum: *a22 description: The state associated with the applicant's historical address. This field is not configurable on the Rentvine template and is always required zip: type: string description: The zip code associated with the applicant's historical address. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements country: type: string enum: *a23 description: The country associated with the applicant's historical address. This field is not configurable on the Rentvine template and is always required. If your application needs to support submitting an applicant who previously or currently reside(s) in another country, please reach out to Propexo Support for help address_type: type: string enum: *a24 description: Whether the applicant previously owned or rented at this address. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements monthly_payment_in_cents: type: integer minimum: 0 description: For the applicant's historical address, the applicant's monthly payment for rent or mortgage in cents. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements move_in_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date when the applicant moved into this historical address. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements move_out_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date when the applicant moved out of this address. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements. Leave out this field to indicate that the given array item is the applicant's current address. At least one address in this array (the current address) is required. manager_name: type: string description: The name of a property manager who works at this address. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements manager_phone: type: string pattern: ^\+?\d{1,50}$ description: The phone number of a property manager who works at this address. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements manager_email: type: string format: email description: The email of a property manager who works at this address. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements reason_for_leaving: type: string description: The reason the applicant decided to leave this address. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements manager_type: type: string enum: *a25 description: The type of property manager who works at this address. This field is ignored for the current address. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements required: - address_1 - city - state - zip - country minItems: 1 description: The address history of the applicant. At least one address (the current address) must be provided. Note that Rentvine allows configuring different application template requirements for the current address vs. historical addresses. Depending on the Rentvine template, this array can be customized to be either required or optional. The template may also require a minimum number of items in the array in order to pass validation. You will need to work with your customer directly to configure this field to your application requirements. Assuming that a minimum number of addresses are required in the application template, the current address does not count towards the minimum number employment_history: type: array items: type: object properties: is_current_employer: type: boolean description: Whether this employment history entry is for a current employer. This field is not configurable on the Rentvine template and is always required name: type: string description: The name of the employer. This field is not configurable on the Rentvine template and is always required phone: type: string pattern: ^\+?\d{1,50}$ description: The phone number of the employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements address_1: type: string description: The first line of the address of the employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements address_2: type: string description: The second line of the address of the employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements city: type: string description: The city of the address of the employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements state: type: string description: The state of the address of the employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements zip: type: string description: The zip code of the address of the employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements country: type: string description: The country of the address of the employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements supervisor_first_name: type: string description: The first name of the applicant's supervisor at this employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements supervisor_last_name: type: string description: The last name of the applicant's supervisor at this employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements supervisor_title: type: string description: The title of the applicant's supervisor at this employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements supervisor_phone: type: string pattern: ^\+?\d{1,50}$ description: The phone number of the applicant's supervisor at this employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements supervisor_email: type: string format: email description: The email of the applicant's supervisor at this employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements position: type: string description: The position held at this employer, or the job description of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements monthly_income_in_cents: type: integer minimum: 0 description: "The monthly income of the applicant at this employer in cents. This field is not configurable on the Rentvine template and is always required. DEPRECATED: Use income_in_cents instead" deprecated: true income_in_cents: type: integer minimum: 0 description: The monthly income of the applicant at this employer in cents. This field is not configurable on the Rentvine template and is always required start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The start date of the applicant's employment at this employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The end date of the applicant's employment at this employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements required: - is_current_employer - name description: The employment history of the applicant. Depending on the Rentvine template, this array can be customized to be either required or optional. The template may also require a minimum number of items in the array in order to pass validation. You will need to work with your customer directly to configure this field to your application requirements other_income: type: array items: type: object properties: source: type: string description: The source of the income for the applicant. This field is not configurable on the Rentvine template and is always required monthly_income_in_cents: type: integer minimum: 0 description: The monthly income from this income source in cents. This field is not configurable on the Rentvine template and is always required phone: type: string pattern: ^\+?\d{1,50}$ description: The phone number related to this income source to use for income verification. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements required: - source - monthly_income_in_cents description: A list of other income sources for the applicant. Depending on the Rentvine template, this array can be customized to be either required or optional. The template may also require a minimum number of items in the array in order to pass validation. You will need to work with your customer directly to configure this field to your application requirements bank_accounts: type: array items: type: object properties: name: type: string description: The name of the bank where the account is held. This field is not configurable on the Rentvine template and is always required account_type: type: string enum: *a26 description: The type of bank account. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements account_number: type: string description: The account number of the bank account. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements balance_in_cents: type: integer minimum: 0 description: The current balance of the bank account in cents. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements required: - name description: A list of bank accounts for the applicant. Depending on the Rentvine template, this array can be customized to be either required or optional. The template may also require a minimum number of items in the array in order to pass validation. You will need to work with your customer directly to configure this field to your application requirements credit_cards: type: array items: type: object properties: name: type: string description: The name of the bank or issuer of the credit card. This field is not configurable on the Rentvine template and is always required balance_in_cents: type: integer minimum: 0 description: The current balance of the credit card in cents. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements required: - name description: A list of credit cards for the applicant. Depending on the Rentvine template, this array can be customized to be either required or optional. The template may also require a minimum number of items in the array in order to pass validation. You will need to work with your customer directly to configure this field to your application requirements assistance: type: object properties: agency_name: type: string description: The name of the agency who is providing assistance for the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements county: type: string description: The county where the agency is located. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements technician_name: type: string description: The name of the agency's contact assigned to support the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements phone: type: string pattern: ^\+?\d{1,50}$ description: The phone number of the agency or of the agency's contact. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements assistance_amount_in_cents: type: integer minimum: 0 description: The amount of assistance for the applicant in cents. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements beds_allowed: type: string description: The number of beds allowed for the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements are_utilities_covered: type: boolean description: Whether utilities are covered for the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements description: Details for payment assistance for the applicant. Depending on the Rentvine template, this array can be customized to be either required or optional. The template may also require a minimum number of items in the array in order to pass validation. You will need to work with your customer directly to configure this field to your application requirements unit_id: type: string description: The Propexo unique identifier for the unit. Rentvine always requires that a unit be specified in order to apply. However, Rentvine supports an alternative method which allows you to apply for a unit which doesn't exist in the Rentvine units list. In the rare event that this is needed for your application, please reach out to Propexo Support to configure this. required: - integration_id - application_template_id - rent_amount_in_cents - first_name - last_name - email_1 - date_of_birth - identification_number - address_history - unit_id _v1_applications_rentvine__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration application_template_id: type: string description: "The Propexo unique identifier for the application template. The Rentvine application template dynamically defines which fields are required for each applicant/application: whether a field is active, disabled, required, or optional. A template may also allow some enums to be modified or for entire fields to be relabeled/repurposed. The functionality of a template is extensive and will likely require that you work with your customer to define a custom template for your application use case" leasing_agent_first_name: type: - string - "null" description: The first name of the leasing agent. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements leasing_agent_last_name: type: - string - "null" description: The last name of the leasing agent. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements leasing_agent_contact_info: type: - string - "null" description: The contact info for the leasing agent. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements rent_amount_in_cents: type: integer minimum: 0 description: The rent amount in cents that the applicant will pay for the unit. This field is not configurable on the Rentvine template and is always required security_deposit_in_cents: type: - integer - "null" minimum: 0 description: The security deposit in cents that the applicant will pay for the unit. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements move_in_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" description: The desired move-in date to the unit listed in the application. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements lease_period_id: type: - string - "null" description: The lease period to use for the application. If supplied, this field must be one of the approved lease periods defined on the Rentvine template. You can see a list of available choices for each application template on the appropriate lease period endpoint. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements or to change the list of available lease periods first_name: type: string description: The first name associated with the applicant. This field is not configurable on the Rentvine template and is always required middle_name: type: - string - "null" description: The middle name associated with the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements last_name: type: string description: The last name associated with the applicant. This field is not configurable on the Rentvine template and is always required type: type: - string - "null" enum: *a18 description: The type of applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements. Although the field itself can be made optional/required, the value must be one of the available choices and cannot be modified as part of the template marital_status: type: - string - "null" enum: *a19 description: The marital status of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements. Although the field itself can be made optional/required, the value must be one of the available choices and cannot be modified as part of the template maiden_name: type: - string - "null" description: The maiden name or birth name of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements height: type: - string - "null" description: The height of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements weight: type: - string - "null" description: The weight of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements eye_color: type: - string - "null" description: The eye color of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements hair_color: type: - string - "null" description: The hair color of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements phone_1: type: - string - "null" pattern: ^\+?\d{1,50}$ description: Primary phone number associated with the applicant. An applicant can have no more than one of each phone type. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements phone_1_type: type: - string - "null" enum: *a45 description: Type of the primary phone number. An applicant can have no more than one of each phone type phone_2: type: - string - "null" pattern: ^\+?\d{1,50}$ description: Secondary phone number associated with the applicant. An applicant can have no more than one of each phone type. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements phone_2_type: type: - string - "null" enum: *a46 description: Type of the secondary phone number. An applicant can have no more than one of each phone type. phone_3: type: - string - "null" pattern: ^\+?\d{1,50}$ description: Third phone number associated with the applicant. An applicant can have no more than one of each phone type. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements phone_3_type: type: - string - "null" enum: *a20 description: Type of the third phone number. An applicant can have no more than one of each phone type. email_1: type: string format: email description: The primary email address associated with the applicant. This field is not configurable on the Rentvine template and is always required date_of_birth: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" identification_number: type: string description: The Social Security Number or Individual Taxpayer Identification Number associated with the applicant. Rentvine uses a pre-2011 validation scheme for SSN's meaning that some valid SSNs will be incorrectly rejected. Reach out to support if you find that a valid SSN is being rejected. This field is not configurable on the Rentvine template and is always required citizenship: type: - string - "null" description: The country of citizenship of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements place_of_birth: type: - string - "null" description: The place of birth of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements passport_number: type: - string - "null" description: The passport number of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements student_id: type: - string - "null" description: The student ID number of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements drivers_license_number: type: - string - "null" description: The driver's license number of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements drivers_license_state: type: - string - "null" description: The issuing state of the applicant's driver's license. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements lead_source: type: - string - "null" description: The name of the source of the lead or how the applicant heard of the property management company. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements emergency_contacts: type: - array - "null" items: type: object properties: first_name: type: string description: The first name of the emergency contact. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements last_name: type: string description: The last name of the emergency contact. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements relationship: type: string description: The relationship of the emergency contact to the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements address_1: type: string description: The first line of the address of the emergency contact. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements address_2: type: string description: The second line of the address of the emergency contact. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements city: type: string description: The city of the address of the emergency contact. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements state: type: string description: The state of the address of the emergency contact. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements zip: type: string description: The zip code of the address of the emergency contact. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements country: type: string description: The country of the address of the emergency contact. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements phone_1: type: string pattern: ^\+?\d{1,50}$ description: The phone number of the emergency contact. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements phone_2: type: string pattern: ^\+?\d{1,50}$ description: The second phone number of the emergency contact. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements email_1: type: string format: email description: The email of the emergency contact. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements application_references: type: - array - "null" items: type: object properties: first_name: type: string description: The first name of the applicant's reference. This field is not configurable on the Rentvine template and is always required last_name: type: string description: The last name of the applicant's reference. This field is not configurable on the Rentvine template and is always required relationship: type: string description: The relationship of the applicant's reference to the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements address_1: type: string description: The first line of the address of the applicant's reference. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements address_2: type: string description: The second line of the address of the applicant's reference. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements city: type: string description: The city of the address of the applicant's reference. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements state: type: string description: The state of the address of the applicant's reference. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements zip: type: string description: The zip code of the address of the applicant's reference. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements country: type: string description: The country of the address of the applicant's reference. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements phone_1: type: string pattern: ^\+?\d{1,50}$ description: The phone number of the applicant's reference. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements required: - first_name - last_name vehicles: type: - array - "null" items: type: object properties: make: type: string description: The make of the vehicle. This field is not configurable on the Rentvine template and is always required model: type: string description: The model of the vehicle. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements year: type: integer description: The year the vehicle was made. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements color: type: string description: The color of the vehicle. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements license_plate_number: type: string description: The license plate number of the vehicle. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements license_plate_state: type: string description: The issuing state of the license plate. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements monthly_payment_in_cents: type: integer minimum: 0 description: If the vehicle is leased or financed, the applicant's monthly payment for the vehicle in cents. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements insurance_carrier: type: string description: The insurance carrier for the applicant's vehicle. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements required: - make other_occupants: type: - array - "null" items: type: object properties: first_name: type: string description: The first name of the occupant. This field is not configurable on the Rentvine template and is always required last_name: type: string description: The last name of the occupant. This field is not configurable on the Rentvine template and is always required date_of_birth: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date of birth of the occupant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements relationship: type: string enum: *a21 description: The relationship of the occupant to the applicant. The only allowed value is "OTHER" and is used to represent non-applicants under 18 years old. Contact Propexo Support if you need to support a workflow that allows adding additional applicants to an application relationship_detail: type: string description: The relationship detail of the occupant to the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements required: - first_name - last_name - relationship pets: type: - array - "null" items: type: object properties: name: type: string description: The name associated with the applicant pet. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements type: type: string description: The type associated with the applicant pet (or breed). This field is not configurable on the Rentvine template and is always required age_in_years: type: integer minimum: 0 description: The age in years of the applicant pet. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements weight_in_pounds: type: integer minimum: 0 description: The weight in pounds of the applicant pet. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements is_trained: type: boolean description: Whether the applicant pet is trained. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements color: type: string description: The color of the applicant pet. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements gender: type: string enum: *a17 description: The gender of the applicant pet. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements is_declawed: type: boolean description: Whether the applicant pet is declawed. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements is_vaccinated: type: boolean description: Whether the applicant pet is vaccinated. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements is_fixed: type: boolean description: Whether the applicant pet is fixed. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements required: - type address_history: type: array items: type: object properties: address_1: type: string description: The first address line associated with the applicant's historical address. This field is not configurable on the Rentvine template and is always required address_2: type: string description: The second address line associated with the applicant's historical address. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements city: type: string description: The city associated with the applicant's historical address. This field is not configurable on the Rentvine template and is always required state: type: string enum: *a22 description: The state associated with the applicant's historical address. This field is not configurable on the Rentvine template and is always required zip: type: string description: The zip code associated with the applicant's historical address. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements country: type: string enum: *a23 description: The country associated with the applicant's historical address. This field is not configurable on the Rentvine template and is always required. If your application needs to support submitting an applicant who previously or currently reside(s) in another country, please reach out to Propexo Support for help address_type: type: string enum: *a24 description: Whether the applicant previously owned or rented at this address. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements monthly_payment_in_cents: type: integer minimum: 0 description: For the applicant's historical address, the applicant's monthly payment for rent or mortgage in cents. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements move_in_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date when the applicant moved into this historical address. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements move_out_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date when the applicant moved out of this address. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements. Leave out this field to indicate that the given array item is the applicant's current address. At least one address in this array (the current address) is required. manager_name: type: string description: The name of a property manager who works at this address. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements manager_phone: type: string pattern: ^\+?\d{1,50}$ description: The phone number of a property manager who works at this address. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements manager_email: type: string format: email description: The email of a property manager who works at this address. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements reason_for_leaving: type: string description: The reason the applicant decided to leave this address. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements manager_type: type: string enum: *a25 description: The type of property manager who works at this address. This field is ignored for the current address. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements required: - address_1 - city - state - zip - country employment_history: type: - array - "null" items: type: object properties: is_current_employer: type: boolean description: Whether this employment history entry is for a current employer. This field is not configurable on the Rentvine template and is always required name: type: string description: The name of the employer. This field is not configurable on the Rentvine template and is always required phone: type: string pattern: ^\+?\d{1,50}$ description: The phone number of the employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements address_1: type: string description: The first line of the address of the employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements address_2: type: string description: The second line of the address of the employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements city: type: string description: The city of the address of the employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements state: type: string description: The state of the address of the employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements zip: type: string description: The zip code of the address of the employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements country: type: string description: The country of the address of the employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements supervisor_first_name: type: string description: The first name of the applicant's supervisor at this employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements supervisor_last_name: type: string description: The last name of the applicant's supervisor at this employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements supervisor_title: type: string description: The title of the applicant's supervisor at this employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements supervisor_phone: type: string pattern: ^\+?\d{1,50}$ description: The phone number of the applicant's supervisor at this employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements supervisor_email: type: string format: email description: The email of the applicant's supervisor at this employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements position: type: string description: The position held at this employer, or the job description of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements monthly_income_in_cents: type: integer minimum: 0 description: "The monthly income of the applicant at this employer in cents. This field is not configurable on the Rentvine template and is always required. DEPRECATED: Use income_in_cents instead" deprecated: true x-fern-availability: deprecated income_in_cents: type: integer minimum: 0 description: The monthly income of the applicant at this employer in cents. This field is not configurable on the Rentvine template and is always required start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The start date of the applicant's employment at this employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The end date of the applicant's employment at this employer. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements required: - is_current_employer - name other_income: type: - array - "null" items: type: object properties: source: type: string description: The source of the income for the applicant. This field is not configurable on the Rentvine template and is always required monthly_income_in_cents: type: integer minimum: 0 description: The monthly income from this income source in cents. This field is not configurable on the Rentvine template and is always required phone: type: string pattern: ^\+?\d{1,50}$ description: The phone number related to this income source to use for income verification. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements required: - source - monthly_income_in_cents bank_accounts: type: - array - "null" items: type: object properties: name: type: string description: The name of the bank where the account is held. This field is not configurable on the Rentvine template and is always required account_type: type: string enum: *a26 description: The type of bank account. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements account_number: type: string description: The account number of the bank account. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements balance_in_cents: type: integer minimum: 0 description: The current balance of the bank account in cents. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements required: - name credit_cards: type: - array - "null" items: type: object properties: name: type: string description: The name of the bank or issuer of the credit card. This field is not configurable on the Rentvine template and is always required balance_in_cents: type: integer minimum: 0 description: The current balance of the credit card in cents. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements required: - name assistance: type: - object - "null" properties: agency_name: type: string description: The name of the agency who is providing assistance for the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements county: type: string description: The county where the agency is located. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements technician_name: type: string description: The name of the agency's contact assigned to support the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements phone: type: string pattern: ^\+?\d{1,50}$ description: The phone number of the agency or of the agency's contact. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements assistance_amount_in_cents: type: integer minimum: 0 description: The amount of assistance for the applicant in cents. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements beds_allowed: type: string description: The number of beds allowed for the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements are_utilities_covered: type: boolean description: Whether utilities are covered for the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements unit_id: type: string description: The Propexo unique identifier for the unit. Rentvine always requires that a unit be specified in order to apply. However, Rentvine supports an alternative method which allows you to apply for a unit which doesn't exist in the Rentvine units list. In the rare event that this is needed for your application, please reach out to Propexo Support to configure this. required: - integration_id - application_template_id - leasing_agent_first_name - leasing_agent_last_name - leasing_agent_contact_info - rent_amount_in_cents - security_deposit_in_cents - move_in_date - lease_period_id - first_name - middle_name - last_name - type - marital_status - maiden_name - height - weight - eye_color - hair_color - phone_1 - phone_1_type - phone_2 - phone_2_type - phone_3 - phone_3_type - email_1 - date_of_birth - identification_number - citizenship - place_of_birth - passport_number - student_id - drivers_license_number - drivers_license_state - lead_source - emergency_contacts - application_references - vehicles - other_occupants - pets - address_history - employment_history - other_income - bank_accounts - credit_cards - assistance - unit_id required: - meta - result _v1_applications_rentvine_{application_id}_put_input: type: object properties: unit_id: type: string description: The Propexo unique identifier for the unit for this application employee_id: type: - string - "null" description: The Propexo unique identifier for the employee who is assigned to process this application, or none to be assigned to nobody application_status_id: type: string description: The Propexo unique identifier for the application status for this application _v1_applications_rentvine_{application_id}_put_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: application_id: type: string description: The Propexo unique identifier for the application unit_id: type: string description: The Propexo unique identifier for the unit for this application employee_id: type: - string - "null" description: The Propexo unique identifier for the employee who is assigned to process this application, or none to be assigned to nobody application_status_id: type: string description: The Propexo unique identifier for the application status for this application required: - application_id required: - meta - result _v1_applications_entrata__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration property_id: type: string description: The Propexo unique identifier for the property lease_period_id: type: string description: The Propexo unique identifier for the lease period lead_source_id: type: string description: The Propexo unique identifier for the lead source unit_id: type: string description: The Propexo unique identifier for the unit application_status: type: string enum: *a78 description: The status associated with the application first_name: type: string description: The first name associated with the application last_name: type: string description: The last name associated with the application address_1: type: string description: The first address line associated with the application address_2: type: string description: The second address line associated with the application city: type: string description: The city associated with the application state: type: string description: The state associated with the application zip: type: string description: The zip code associated with the application attachments: type: array items: type: object properties: file_data: type: string maxLength: 69730304 description: The contents of the file, as a base64 encoded string. The PMS has a max file size of 50 MB. file_name: type: string description: 'The name of the file including the extension. Ex: "image.jpg"' mime_type: type: string description: 'The mime type of the file. Ex: "image/jpeg"' lease_file_type: type: string description: "Deprecated: Use the `file_type_id` field instead. The PMS specific lease file type of the document" file_type_id: type: string description: The Propexo file type ID of the lease file type to upload. Prefer this over the raw input of the lease_file_type. is_private: type: boolean description: If the file should be marked as private. If true the file will not be shown in the resident portal. required: - file_data - file_name - mime_type description: Files to upload for the application date_of_birth: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date of birth associated with the application email_1: type: string format: email description: The primary email address associated with the application move_in_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The move-in date associated with the application phone_1: type: string description: Primary phone number associated with the application pets: type: array items: type: object properties: pet_type_id: type: string description: The Propexo unique identifier for the pet type age_in_years: type: integer minimum: 0 description: The age in years of the applicant pet name: type: string description: The name associated with the applicant pet breed: type: string description: The breed of the applicant pet gender: type: string description: The gender of the applicant pet color: type: string description: The color of the applicant pet weight_in_pounds: type: integer minimum: 0 description: The weight in pounds of the applicant pet description: type: string description: Description of the applicant pet license_city: type: string description: The city where the applicant pet license was issued license_number: type: string description: The license number of the applicant pet is_service_animal: type: boolean description: Whether the applicant pet is a service animal is_fixed: type: boolean description: Whether the applicant pet is fixed pet_spayed_or_neutered_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date when the applicant pet was spayed or neutered is_house_broken: type: boolean description: Whether the applicant pet is house broken special_provisions: type: string description: Special provisions or requirements for the applicant pet required: - pet_type_id description: "Pets of the application. Note: This will only be added to the primary applicant on the application." vehicles: type: array items: type: object properties: vehicle_type: type: string enum: &a79 - PRIMARY - SECONDARY - OTHER description: The type associated with the applicant vehicle make: type: string description: The make of the applicant vehicle model: type: string description: The Propexo data model (e.g. units, residents, applicants, etc.) associated with the applicant vehicle year: type: integer description: The year of the applicant vehicle color: type: string description: The color of the applicant vehicle license_plate_number: type: string description: The license plate number of the applicant vehicle license_plate_state: type: string enum: *a33 description: The state associated with the applicant vehicle country_code: type: string description: The country associated with the applicant vehicle permit_number: type: string description: The permit number of the applicant vehicle notes: type: string description: Notes associated with the applicant vehicle required: - vehicle_type description: "Vehicles of the application. Note: This will only be added to the primary applicant on the application." employment_history: type: array items: type: object properties: income_type: type: string enum: &a80 - CURRENT_EMPLOYER - PREVIOUS_EMPLOYER - OTHER_INCOME description: The name associated with the income type frequency: type: string enum: &a81 - WEEKLY - MONTHLY - YEARLY description: The frequency of the applicant employer position: type: string description: The position of the employee name: type: string description: The name associated with the applicant employer phone: type: string description: Primary phone number associated with the applicant employer address_1: type: string description: The first address line associated with the applicant employer address_2: type: string description: The second address line associated with the applicant employer address_3: type: string description: The third address line associated with the applicant employer city: type: string description: The city associated with the applicant employer state: type: string description: The state associated with the applicant employer province: type: string description: The province associated with the applicant employer zip: type: string description: The zip code associated with the applicant employer country: type: string description: The country associated with the applicant employer income_in_cents: type: integer minimum: 0 description: The total income of the employee, in cents supervisor_first_name: type: string description: The name associated with the employee supervisor_last_name: type: string description: The name associated with the employee supervisor_phone: type: string description: Primary phone number associated with the employee supervisor_email: type: string description: The primary email address associated with the employee income_effective_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The effective date of the income of the employee start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The start date associated with the employee end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The end date associated with the employee required: - income_type - frequency description: "Employment history of the application. Note: This will only be added to the primary applicant on the application." add_ons: type: array items: type: object properties: rentable_item_id: type: string description: The Propexo unique identifier for the rentable item employee_id: type: string description: The Propexo unique identifier for the employee start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The start date associated with the employee end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The end date associated with the employee required: - rentable_item_id - employee_id description: Add-ons of the application other_occupants: type: array items: type: object properties: first_name: type: string description: The first name associated with the occupant last_name: type: string description: The last name associated with the occupant relationship: type: string enum: &a82 - SPOUSE - ROOMMATE - CHILD - OTHER - GUARANTOR description: The relationship of the occupant email_1: type: string format: email description: The primary email address associated with the occupant phone_1: type: string description: Primary phone number associated with the occupant date_of_birth: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date of birth associated with the occupant address_1: type: string description: The first address line associated with the occupant address_2: type: string description: The second address line associated with the occupant city: type: string description: The city associated with the occupant state: type: string description: The state associated with the occupant zip: type: string description: The zip code associated with the occupant required: - first_name - last_name - relationship description: Other occupants of the application required: - integration_id - property_id - lease_period_id - lead_source_id - application_status - first_name - last_name _v1_applications_entrata__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration property_id: type: string description: The Propexo unique identifier for the property lease_period_id: type: string description: The Propexo unique identifier for the lease period lead_source_id: type: string description: The Propexo unique identifier for the lead source unit_id: type: - string - "null" application_status: type: string enum: *a78 description: The status associated with the application first_name: type: string description: The first name associated with the application last_name: type: string description: The last name associated with the application address_1: type: - string - "null" address_2: type: - string - "null" city: type: - string - "null" state: type: - string - "null" zip: type: - string - "null" attachments: type: - array - "null" items: type: object properties: file_data: type: - string - "null" maxLength: 69730304 description: The contents of the file, as a base64 encoded string. The PMS has a max file size of 50 MB. file_name: type: string description: 'The name of the file including the extension. Ex: "image.jpg"' mime_type: type: string description: 'The mime type of the file. Ex: "image/jpeg"' lease_file_type: type: string file_type_id: type: string is_private: type: boolean required: - file_name - mime_type date_of_birth: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" email_1: type: - string - "null" format: email move_in_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" phone_1: type: - string - "null" pets: type: - array - "null" items: type: object properties: pet_type_id: type: string description: The Propexo unique identifier for the pet type age_in_years: type: integer minimum: 0 name: type: string breed: type: string gender: type: string color: type: string weight_in_pounds: type: integer minimum: 0 description: type: string license_city: type: string license_number: type: string is_service_animal: type: boolean is_fixed: type: boolean pet_spayed_or_neutered_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ is_house_broken: type: boolean special_provisions: type: string required: - pet_type_id vehicles: type: - array - "null" items: type: object properties: vehicle_type: type: string enum: *a79 description: The type associated with the applicant vehicle make: type: string model: type: string year: type: integer color: type: string license_plate_number: type: string license_plate_state: type: string enum: *a33 country_code: type: string permit_number: type: string notes: type: string required: - vehicle_type employment_history: type: - array - "null" items: type: object properties: income_type: type: string enum: *a80 description: The name associated with the income type frequency: type: string enum: *a81 description: The frequency of the applicant employer position: type: string name: type: string phone: type: string address_1: type: string address_2: type: string address_3: type: string city: type: string state: type: string province: type: string zip: type: string country: type: string income_in_cents: type: integer minimum: 0 supervisor_first_name: type: string supervisor_last_name: type: string supervisor_phone: type: string supervisor_email: type: string income_effective_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ required: - income_type - frequency add_ons: type: - array - "null" items: type: object properties: rentable_item_id: type: string description: The Propexo unique identifier for the rentable item employee_id: type: string description: The Propexo unique identifier for the employee start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ required: - rentable_item_id - employee_id other_occupants: type: - array - "null" items: type: object properties: first_name: type: string description: The first name associated with the occupant last_name: type: string description: The last name associated with the occupant relationship: type: string enum: *a82 description: The relationship of the occupant email_1: type: string format: email phone_1: type: string date_of_birth: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ address_1: type: string address_2: type: string city: type: string state: type: string zip: type: string required: - first_name - last_name - relationship required: - integration_id - property_id - lease_period_id - lead_source_id - unit_id - application_status - first_name - last_name - address_1 - address_2 - city - state - zip - attachments - date_of_birth - email_1 - move_in_date - phone_1 - pets - vehicles - employment_history - add_ons - other_occupants required: - meta - result _v1_applications_entrata_{application_id}_put_input: type: object properties: applicant_id: type: string description: The Propexo unique identifier for the applicant lease_period_id: type: string description: The Propexo unique identifier for the lease period unit_id: type: string description: The Propexo unique identifier for the unit lead_source_id: type: string description: The Propexo unique identifier for the lead source address_1: type: string description: The first address line associated with the applicant address_2: type: string description: The second address line associated with the applicant application_status: type: string enum: *a83 description: The status associated with the application attachments: type: array items: type: object properties: file_data: type: string maxLength: 69730304 description: The contents of the file, as a base64 encoded string. The PMS has a max file size of 50 MB. file_name: type: string description: 'The name of the file including the extension. Ex: "image.jpg"' mime_type: type: string description: 'The mime type of the file. Ex: "image/jpeg"' lease_file_type: type: string description: "Deprecated: Use the `file_type_id` field instead. The PMS specific lease file type of the document" file_type_id: type: string description: The Propexo file type ID of the lease file type to upload. Prefer this over the raw input of the lease_file_type. is_private: type: boolean description: If the file should be marked as private. If true the file will not be shown in the resident portal. required: - file_data - file_name - mime_type description: Files to upload for the applicant. All the files can have a maximum combined file size of 50 MB city: type: string description: The city associated with the applicant create_new_events_only: anyOf: - type: boolean - type: string description: Whether or not new events should be created on the applicant date_of_birth: type: string format: date-time description: The date of birth associated with the applicant email_1: type: string format: email description: The primary email address associated with the applicant events: type: array items: type: object properties: unit_id: type: string description: The Propexo unique identifier for the unit x_type_id: type: string description: The PMS id for the event type. x_leasing_agent_id: type: string description: The PMS id for the leasing agent. x_sub_type_id: type: string description: The PMS id for the event sub type. x_result_id: type: string description: The PMS id for the event result. event_datetime: type: string format: date-time description: The date and time that the event occured. appointment_datetime: type: string format: date-time description: The date and time that the appointment will occur. Required if using appointment type. time_from: type: string time_to: type: string notes: type: string description: General notes about the event. title: type: string description: Title for the event. reasons_for_event: type: string description: The reason the event occurred. id: type: string description: The Propexo unique identifier for the event. Only required if attempting to update an existing event. required: - x_type_id description: "DEPRECATED: Please use /events endpoints to write events. Array of events associated with this applicant" deprecated: true first_name: type: string description: The first name associated with the applicant last_name: type: string description: The last name associated with the applicant move_in_date: type: string format: date-time description: The move-in date associated with the applicant phone_1_type: type: string enum: &a84 - HOME - WORK - MOBILE - FAX description: Type of the primary phone number phone_1: type: string description: Primary phone number associated with the applicant state: type: string description: The state associated with the applicant zip: type: string description: The zip code associated with the applicant pets: type: array items: type: object properties: pet_type_id: type: string description: The Propexo unique identifier for the pet type age_in_years: type: integer minimum: 0 description: The age in years of the applicant pet name: type: string description: The name associated with the applicant pet breed: type: string description: The breed of the applicant pet gender: type: string description: The gender of the applicant pet color: type: string description: The color of the applicant pet weight_in_pounds: type: integer minimum: 0 description: The weight in pounds of the applicant pet description: type: string description: Description of the applicant pet license_city: type: string description: The city where the applicant pet license was issued license_number: type: string description: The license number of the applicant pet is_service_animal: type: boolean description: Whether the applicant pet is a service animal is_fixed: type: boolean description: Whether the applicant pet is fixed pet_spayed_or_neutered_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date when the applicant pet was spayed or neutered is_house_broken: type: boolean description: Whether the applicant pet is house broken special_provisions: type: string description: Special provisions or requirements for the applicant pet required: - pet_type_id description: Pets of the applicant vehicles: type: array items: type: object properties: vehicle_type: type: string enum: *a32 description: The type associated with the applicant vehicle make: type: string description: The make of the applicant vehicle model: type: string description: The Propexo data model (e.g. units, residents, applicants, etc.) associated with the applicant vehicle year: type: integer description: The year of the applicant vehicle color: type: string description: The color of the applicant vehicle license_plate_number: type: string description: The license plate number of the applicant vehicle license_plate_state: type: string enum: *a33 description: The state associated with the applicant vehicle country_code: type: string description: The country associated with the applicant vehicle permit_number: type: string description: The permit number of the applicant vehicle notes: type: string description: Notes associated with the applicant vehicle required: - vehicle_type description: Vehicles of the applicant employment_history: type: array items: type: object properties: income_type: type: string enum: *a34 description: The name associated with the income type frequency: type: string enum: *a35 description: The frequency of the applicant employer position: type: string description: The position of the employee name: type: string description: The name associated with the applicant employer phone: type: string description: Primary phone number associated with the applicant employer address_1: type: string description: The first address line associated with the applicant employer address_2: type: string description: The second address line associated with the applicant employer address_3: type: string description: The third address line associated with the applicant employer city: type: string description: The city associated with the applicant employer state: type: string description: The state associated with the applicant employer province: type: string description: The province associated with the applicant employer zip: type: string description: The zip code associated with the applicant employer country: type: string description: The country associated with the applicant employer income_in_cents: type: integer minimum: 0 description: The total income of the employee, in cents supervisor_first_name: type: string description: The name associated with the employee supervisor_last_name: type: string description: The name associated with the employee supervisor_phone: type: string description: Primary phone number associated with the employee supervisor_email: type: string description: The primary email address associated with the employee income_effective_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The effective date of the income of the employee start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The start date associated with the employee end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The end date associated with the employee required: - income_type - frequency description: Employment history of the applicant add_ons: type: array items: type: object properties: rentable_item_id: type: string description: The Propexo unique identifier for the rentable item employee_id: type: string description: The Propexo unique identifier for the employee start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The start date associated with the employee end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The end date associated with the employee required: - rentable_item_id - employee_id description: Add-ons of the applicant required: - applicant_id _v1_applications_entrata_{application_id}_put_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: applicant_id: type: string description: The Propexo unique identifier for the applicant application_id: type: string description: The Propexo unique identifier for the application lease_period_id: type: string description: The Propexo unique identifier for the lease period unit_id: type: string description: The Propexo unique identifier for the unit lead_source_id: type: string description: The Propexo unique identifier for the lead source address_1: type: string description: The first address line associated with the applicant address_2: type: string description: The second address line associated with the applicant application_status: type: string enum: *a83 description: The status associated with the application attachments: type: array items: type: object properties: file_data: type: string maxLength: 69730304 description: The contents of the file, as a base64 encoded string. The PMS has a max file size of 50 MB. file_name: type: string description: 'The name of the file including the extension. Ex: "image.jpg"' mime_type: type: string description: 'The mime type of the file. Ex: "image/jpeg"' lease_file_type: type: string description: "Deprecated: Use the `file_type_id` field instead. The PMS specific lease file type of the document" x-fern-availability: deprecated deprecated: true file_type_id: type: string description: The Propexo file type ID of the lease file type to upload. Prefer this over the raw input of the lease_file_type. is_private: type: boolean description: If the file should be marked as private. If true the file will not be shown in the resident portal. required: - file_data - file_name - mime_type city: type: string description: The city associated with the applicant create_new_events_only: anyOf: - type: boolean - type: string description: Whether or not new events should be created on the applicant date_of_birth: type: string format: date-time description: The date of birth associated with the applicant email_1: type: string format: email description: The primary email address associated with the applicant events: type: array items: type: object properties: unit_id: type: string description: The Propexo unique identifier for the unit x_type_id: type: string x_leasing_agent_id: type: string description: The PMS id for the leasing agent. x_sub_type_id: type: string description: The PMS id for the event sub type. x_result_id: type: string description: The PMS id for the event result. event_datetime: type: string format: date-time description: The date and time that the event occured. appointment_datetime: type: string format: date-time description: The date and time that the appointment will occur. Required if using appointment type. time_from: type: string time_to: type: string notes: type: string description: General notes about the event. title: type: string description: Title for the event. reasons_for_event: type: string description: The reason the event occurred. id: type: string description: The Propexo unique identifier for the event. Only required if attempting to update an existing event. required: - x_type_id first_name: type: string description: The first name associated with the applicant last_name: type: string description: The last name associated with the applicant move_in_date: type: string format: date-time description: The move-in date associated with the applicant phone_1_type: type: string enum: *a84 description: Type of the primary phone number phone_1: type: string description: Primary phone number associated with the applicant state: type: string description: The state associated with the applicant zip: type: string description: The zip code associated with the applicant pets: type: array items: type: object properties: pet_type_id: type: string description: The Propexo unique identifier for the pet type age_in_years: type: integer minimum: 0 description: The age in years of the applicant pet name: type: string description: The name associated with the applicant pet breed: type: string description: The breed of the applicant pet gender: type: string description: The gender of the applicant pet color: type: string description: The color of the applicant pet weight_in_pounds: type: integer minimum: 0 description: The weight in pounds of the applicant pet description: type: string description: Description of the applicant pet license_city: type: string description: The city where the applicant pet license was issued license_number: type: string description: The license number of the applicant pet is_service_animal: type: boolean description: Whether the applicant pet is a service animal is_fixed: type: boolean description: Whether the applicant pet is fixed pet_spayed_or_neutered_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date when the applicant pet was spayed or neutered is_house_broken: type: boolean description: Whether the applicant pet is house broken special_provisions: type: string description: Special provisions or requirements for the applicant pet required: - pet_type_id vehicles: type: array items: type: object properties: vehicle_type: type: string enum: *a32 description: The type associated with the applicant vehicle make: type: string description: The make of the applicant vehicle model: type: string description: The Propexo data model (e.g. units, residents, applicants, etc.) associated with the applicant vehicle year: type: integer description: The year of the applicant vehicle color: type: string description: The color of the applicant vehicle license_plate_number: type: string description: The license plate number of the applicant vehicle license_plate_state: type: string enum: *a33 description: The state associated with the applicant vehicle country_code: type: string description: The country associated with the applicant vehicle permit_number: type: string description: The permit number of the applicant vehicle notes: type: string description: Notes associated with the applicant vehicle required: - vehicle_type employment_history: type: array items: type: object properties: income_type: type: string enum: *a34 description: The name associated with the income type frequency: type: string enum: *a35 description: The frequency of the applicant employer position: type: string description: The position of the employee name: type: string description: The name associated with the applicant employer phone: type: string description: Primary phone number associated with the applicant employer address_1: type: string description: The first address line associated with the applicant employer address_2: type: string description: The second address line associated with the applicant employer address_3: type: string description: The third address line associated with the applicant employer city: type: string description: The city associated with the applicant employer state: type: string description: The state associated with the applicant employer province: type: string description: The province associated with the applicant employer zip: type: string description: The zip code associated with the applicant employer country: type: string description: The country associated with the applicant employer income_in_cents: type: integer minimum: 0 description: The total income of the employee, in cents supervisor_first_name: type: string description: The name associated with the employee supervisor_last_name: type: string description: The name associated with the employee supervisor_phone: type: string description: Primary phone number associated with the employee supervisor_email: type: string description: The primary email address associated with the employee income_effective_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The effective date of the income of the employee start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The start date associated with the employee end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The end date associated with the employee required: - income_type - frequency add_ons: type: array items: type: object properties: rentable_item_id: type: string description: The Propexo unique identifier for the rentable item employee_id: type: string description: The Propexo unique identifier for the employee start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The start date associated with the employee end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The end date associated with the employee required: - rentable_item_id - employee_id required: - applicant_id - application_id required: - meta - result _v1_applications_resman__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration property_id: type: string description: The Propexo unique identifier for the property unit_id: type: string description: The Propexo unique identifier for the unit lead_source_id: type: string description: The Propexo unique identifier for the lead source employee_id: type: string description: The Propexo unique identifier for the employee application_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The application date associated with the applicant start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The start date associated with the lease end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The end date associated with the lease status: type: string enum: *a85 description: The status associated with the application first_name: type: string description: The first name associated with the applicant last_name: type: string description: The last name associated with the applicant email_1: type: string description: The primary email address associated with the applicant phone_1: type: string description: Primary phone number associated with the applicant phone_1_type: type: string enum: - FAX - HOME - MOBILE - WORK description: Type of the primary phone number phone_2: type: string description: Secondary phone number associated with the applicant phone_2_type: type: string enum: - FAX - HOME - MOBILE - WORK description: Type of the secondary phone number date_of_birth: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date of birth associated with the applicant address_1: type: string description: The first address line associated with the applicant address_2: type: string description: The second address line associated with the applicant city: type: string description: The city associated with the applicant state: type: string description: The state associated with the applicant zip: type: string description: The zip code associated with the applicant notes: type: string description: Notes associated with the applicant move_in_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The move-in date associated with the applicant rent_amount_in_cents: type: integer minimum: 0 description: The rent amount in cents for the applicant desired_lease_term_in_months: type: number minimum: 0 description: The amount of months for the lease term floor_plan_id: type: string description: The Propexo unique identifier for the floor plan other_occupants: type: array items: type: object properties: first_name: type: string description: The first name associated with the occupant last_name: type: string description: The last name associated with the occupant email_1: type: string description: The primary email address associated with the occupant phone_1: type: string description: Primary phone number associated with the occupant phone_1_type: type: string enum: - FAX - HOME - MOBILE - WORK description: Type of the primary phone number phone_2: type: string description: Secondary phone number associated with the occupant phone_2_type: type: string enum: - FAX - HOME - MOBILE - WORK description: Type of the secondary phone number address_1: type: string description: The first address line associated with the occupant address_2: type: string description: The second address line associated with the occupant city: type: string description: The city associated with the occupant state: type: string description: The state associated with the occupant zip: type: string description: The zip code associated with the occupant date_of_birth: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date of birth associated with the occupant move_in_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The move-in date associated with the lease rent_amount_in_cents: type: integer minimum: 0 description: The market rent amount in cents for the lease required: - first_name - last_name default: &a86 [] description: A list of other occupants for the application emergency_contacts: type: array items: type: object properties: first_name: type: string description: The first name of the emergency contact last_name: type: string description: The last name of the emergency contact relationship: type: string description: The relationship of the emergency contact to the applicant address_1: type: string description: The first line of the address of the emergency contact city: type: string description: The city of the address of the emergency contact state: type: string description: The state of the address of the emergency contact zip: type: string description: The zip code of the address of the emergency contact country: type: string description: The country of the address of the emergency contact phone_1: type: string description: The phone number of the emergency contact required: - first_name - last_name - relationship default: &a87 [] description: "A list of emergency contacts for the applicant. Note: This will only be added to the primary applicant on the application." employment_history: type: array items: type: object properties: name: type: string description: The name of the employer income_in_cents: type: integer minimum: 0 description: The income of the applicant at this employer in cents frequency: type: string enum: &a88 - WEEKLY - BI_WEEKLY - SEMI_MONTHLY - MONTHLY - YEARLY description: The frequency of the income. start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The start date of the applicant's employment at this employer end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The end date of the applicant's employment at this employer position: type: string description: The position held at this employer, or the job description of the applicant address_1: type: string description: The first line of the address of the employer city: type: string description: The city of the address of the employer state: type: string description: The state of the address of the employer zip: type: string description: The zip code of the address of the employer country: type: string description: The country of the address of the employer supervisor_first_name: type: string description: The first name of the applicant's supervisor at this employer supervisor_last_name: type: string description: The last name of the applicant's supervisor at this employer supervisor_phone: type: string description: The phone number of the applicant's supervisor required: - name - income_in_cents - frequency - start_date default: &a89 [] description: "The employment history of the applicant. Note: This will only be added to the primary applicant on the application. Only entries with both income_in_cents and frequency will be included." vehicles: type: array items: type: object properties: make: type: string description: The make of the vehicle model: type: string description: The model of the vehicle color: type: string description: The color of the vehicle license_plate_number: type: string description: The license plate number of the vehicle license_plate_state: type: string description: The issuing state of the license plate permit_number: type: string description: The permit number of the vehicle required: - make - model - color - license_plate_number - license_plate_state default: &a90 [] description: A list of vehicles for the application pets: type: array items: type: object properties: type: type: string description: "The type associated with the applicant pet. Note: This must match one of the pet types from the pick list in Resman" name: type: string description: The name associated with the applicant pet weight_in_pounds: type: integer minimum: 0 description: The weight in pounds of the applicant pet required: - type - name - weight_in_pounds default: &a91 [] description: A list of applicant pets required: - integration_id - property_id - unit_id - lead_source_id - employee_id - application_date - start_date - end_date - status - first_name - last_name _v1_applications_resman__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration property_id: type: string description: The Propexo unique identifier for the property unit_id: type: string description: The Propexo unique identifier for the unit lead_source_id: type: string description: The Propexo unique identifier for the lead source employee_id: type: string description: The Propexo unique identifier for the employee application_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" status: type: string enum: *a85 description: The status associated with the application first_name: type: string description: The first name associated with the applicant last_name: type: string description: The last name associated with the applicant email_1: type: - string - "null" description: The primary email address associated with the applicant phone_1: type: - string - "null" description: Primary phone number associated with the applicant phone_1_type: type: - string - "null" enum: - FAX - HOME - MOBILE - WORK description: Type of the primary phone number phone_2: type: - string - "null" description: Secondary phone number associated with the applicant phone_2_type: type: - string - "null" enum: - FAX - HOME - MOBILE - WORK description: Type of the secondary phone number date_of_birth: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" description: The date of birth associated with the applicant address_1: type: - string - "null" description: The first address line associated with the applicant address_2: type: - string - "null" description: The second address line associated with the applicant city: type: - string - "null" description: The city associated with the applicant state: type: - string - "null" description: The state associated with the applicant zip: type: - string - "null" description: The zip code associated with the applicant notes: type: - string - "null" description: Notes associated with the applicant move_in_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" description: The move-in date associated with the applicant rent_amount_in_cents: type: - integer - "null" minimum: 0 description: The rent amount in cents for the applicant desired_lease_term_in_months: type: - number - "null" minimum: 0 description: The amount of months for the lease term floor_plan_id: type: - string - "null" description: The Propexo unique identifier for the floor plan other_occupants: type: - array - "null" items: type: object properties: first_name: type: string description: The first name associated with the occupant last_name: type: string description: The last name associated with the occupant email_1: type: string description: The primary email address associated with the occupant phone_1: type: string description: Primary phone number associated with the occupant phone_1_type: type: string enum: - FAX - HOME - MOBILE - WORK description: Type of the primary phone number phone_2: type: string description: Secondary phone number associated with the occupant phone_2_type: type: string enum: - FAX - HOME - MOBILE - WORK description: Type of the secondary phone number address_1: type: string description: The first address line associated with the occupant address_2: type: string description: The second address line associated with the occupant city: type: string description: The city associated with the occupant state: type: string description: The state associated with the occupant zip: type: string description: The zip code associated with the occupant date_of_birth: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date of birth associated with the occupant move_in_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The move-in date associated with the lease rent_amount_in_cents: type: integer minimum: 0 description: The market rent amount in cents for the lease required: - first_name - last_name default: *a86 emergency_contacts: type: array items: type: object properties: first_name: type: string description: The first name of the emergency contact last_name: type: string description: The last name of the emergency contact relationship: type: string description: The relationship of the emergency contact to the applicant address_1: type: string description: The first line of the address of the emergency contact city: type: string description: The city of the address of the emergency contact state: type: string description: The state of the address of the emergency contact zip: type: string description: The zip code of the address of the emergency contact country: type: string description: The country of the address of the emergency contact phone_1: type: string description: The phone number of the emergency contact required: - first_name - last_name - relationship default: *a87 description: "A list of emergency contacts for the applicant. Note: This will only be added to the primary applicant on the application." employment_history: type: array items: type: object properties: name: type: string description: The name of the employer income_in_cents: type: integer minimum: 0 description: The income of the applicant at this employer in cents frequency: type: string enum: *a88 description: The frequency of the income. start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The start date of the applicant's employment at this employer end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The end date of the applicant's employment at this employer position: type: string description: The position held at this employer, or the job description of the applicant address_1: type: string description: The first line of the address of the employer city: type: string description: The city of the address of the employer state: type: string description: The state of the address of the employer zip: type: string description: The zip code of the address of the employer country: type: string description: The country of the address of the employer supervisor_first_name: type: string description: The first name of the applicant's supervisor at this employer supervisor_last_name: type: string description: The last name of the applicant's supervisor at this employer supervisor_phone: type: string description: The phone number of the applicant's supervisor required: - name - income_in_cents - frequency - start_date default: *a89 description: "The employment history of the applicant. Note: This will only be added to the primary applicant on the application. Only entries with both income_in_cents and frequency will be included." vehicles: type: array items: type: object properties: make: type: string description: The make of the vehicle model: type: string description: The model of the vehicle color: type: string description: The color of the vehicle license_plate_number: type: string description: The license plate number of the vehicle license_plate_state: type: string description: The issuing state of the license plate permit_number: type: string description: The permit number of the vehicle required: - make - model - color - license_plate_number - license_plate_state default: *a90 description: A list of vehicles for the application pets: type: array items: type: object properties: type: type: string description: "The type associated with the applicant pet. Note: This must match one of the pet types from the pick list in Resman" name: type: string description: The name associated with the applicant pet weight_in_pounds: type: integer minimum: 0 description: The weight in pounds of the applicant pet required: - type - name - weight_in_pounds default: *a91 description: A list of applicant pets required: - integration_id - property_id - unit_id - lead_source_id - employee_id - application_date - start_date - end_date - status - first_name - last_name - email_1 - phone_1 - phone_1_type - phone_2 - phone_2_type - date_of_birth - address_1 - address_2 - city - state - zip - notes - move_in_date - rent_amount_in_cents - desired_lease_term_in_months - floor_plan_id required: - meta - result _v1_applications_resman_{application_id}_put_input: type: object properties: applicant_id: type: string description: The Propexo unique identifier for the applicant unit_id: type: string description: The Propexo unique identifier for the unit lead_source_id: type: string description: The Propexo unique identifier for the lead source employee_id: type: string description: The Propexo unique identifier for the employee application_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The application date associated with the applicant start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The start date associated with the lease end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The end date associated with the lease status: type: string enum: *a92 description: The status associated with the application first_name: type: string description: The first name associated with the applicant last_name: type: string description: The last name associated with the applicant email_1: type: string description: The primary email address associated with the applicant phone_1: type: string description: Primary phone number associated with the applicant phone_1_type: type: string enum: - FAX - HOME - MOBILE - WORK description: Type of the primary phone number phone_2: type: string description: Secondary phone number associated with the applicant phone_2_type: type: string enum: - FAX - HOME - MOBILE - WORK description: Type of the secondary phone number date_of_birth: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date of birth associated with the applicant address_1: type: string description: The first address line associated with the applicant address_2: type: string description: The second address line associated with the applicant city: type: string description: The city associated with the applicant state: type: string description: The state associated with the applicant zip: type: string description: The zip code associated with the applicant notes: type: string description: Notes associated with the applicant move_in_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The move-in date associated with the applicant rent_amount_in_cents: type: integer minimum: 0 description: The rent amount in cents for the applicant desired_lease_term_in_months: type: number minimum: 0 description: The amount of months for the lease term floor_plan_id: type: string description: The Propexo unique identifier for the floor plan other_occupants: type: array items: type: object properties: first_name: type: string description: The first name associated with the occupant last_name: type: string description: The last name associated with the occupant email_1: type: string description: The primary email address associated with the occupant phone_1: type: string description: Primary phone number associated with the occupant phone_1_type: type: string enum: - FAX - HOME - MOBILE - WORK description: Type of the primary phone number phone_2: type: string description: Secondary phone number associated with the occupant phone_2_type: type: string enum: - FAX - HOME - MOBILE - WORK description: Type of the secondary phone number address_1: type: string description: The first address line associated with the occupant address_2: type: string description: The second address line associated with the occupant city: type: string description: The city associated with the occupant state: type: string description: The state associated with the occupant zip: type: string description: The zip code associated with the occupant date_of_birth: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date of birth associated with the occupant move_in_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The move-in date associated with the lease rent_amount_in_cents: type: integer minimum: 0 description: The market rent amount in cents for the lease required: - first_name - last_name default: &a93 [] description: "A list of other occupants for the application. Note: Only new occupants should be passed in, existing occupants cannot be updated" emergency_contacts: type: array items: type: object properties: first_name: type: string description: The first name of the emergency contact last_name: type: string description: The last name of the emergency contact relationship: type: string description: The relationship of the emergency contact to the applicant address_1: type: string description: The first line of the address of the emergency contact city: type: string description: The city of the address of the emergency contact state: type: string description: The state of the address of the emergency contact zip: type: string description: The zip code of the address of the emergency contact country: type: string description: The country of the address of the emergency contact phone_1: type: string description: The phone number of the emergency contact required: - first_name - last_name - relationship default: &a94 [] description: "A list of emergency contacts for the applicant. Note: This will only be added to the primary applicant on the application." employment_history: type: array items: type: object properties: name: type: string description: The name of the employer income_in_cents: type: integer minimum: 0 description: The income of the applicant at this employer in cents frequency: type: string enum: &a95 - WEEKLY - BI_WEEKLY - SEMI_MONTHLY - MONTHLY - YEARLY description: The frequency of the income. start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The start date of the applicant's employment at this employer end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The end date of the applicant's employment at this employer position: type: string description: The position held at this employer, or the job description of the applicant address_1: type: string description: The first line of the address of the employer city: type: string description: The city of the address of the employer state: type: string description: The state of the address of the employer zip: type: string description: The zip code of the address of the employer country: type: string description: The country of the address of the employer supervisor_first_name: type: string description: The first name of the applicant's supervisor at this employer supervisor_last_name: type: string description: The last name of the applicant's supervisor at this employer supervisor_phone: type: string description: The phone number of the applicant's supervisor required: - name - income_in_cents - frequency - start_date default: &a96 [] description: "The employment history of the applicant. Note: This will only be added to the primary applicant on the application. Only entries with both income_in_cents and frequency will be included." vehicles: type: array items: type: object properties: make: type: string description: The make of the vehicle model: type: string description: The model of the vehicle color: type: string description: The color of the vehicle license_plate_number: type: string description: The license plate number of the vehicle license_plate_state: type: string description: The issuing state of the license plate permit_number: type: string description: The permit number of the vehicle required: - make - model - color - license_plate_number - license_plate_state default: &a97 [] description: A list of vehicles for the application pets: type: array items: type: object properties: type: type: string description: "The type associated with the applicant pet. Note: This must match one of the pet types from the pick list in Resman" name: type: string description: The name associated with the applicant pet weight_in_pounds: type: integer minimum: 0 description: The weight in pounds of the applicant pet required: - type - name - weight_in_pounds default: &a98 [] description: A list of applicant pets required: - applicant_id - unit_id - lead_source_id - employee_id - application_date - start_date - end_date - status - first_name - last_name _v1_applications_resman_{application_id}_put_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: application_id: type: string description: The Propexo unique identifier for the application applicant_id: type: string description: The Propexo unique identifier for the applicant unit_id: type: string description: The Propexo unique identifier for the unit lead_source_id: type: string description: The Propexo unique identifier for the lead source employee_id: type: string description: The Propexo unique identifier for the employee application_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The application date associated with the applicant start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The start date associated with the lease end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The end date associated with the lease status: type: string enum: *a92 description: The status associated with the application first_name: type: string description: The first name associated with the applicant last_name: type: string description: The last name associated with the applicant email_1: type: string description: The primary email address associated with the applicant phone_1: type: string description: Primary phone number associated with the applicant phone_1_type: type: string enum: - FAX - HOME - MOBILE - WORK description: Type of the primary phone number phone_2: type: string description: Secondary phone number associated with the applicant phone_2_type: type: string enum: - FAX - HOME - MOBILE - WORK description: Type of the secondary phone number date_of_birth: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date of birth associated with the applicant address_1: type: string description: The first address line associated with the applicant address_2: type: string description: The second address line associated with the applicant city: type: string description: The city associated with the applicant state: type: string description: The state associated with the applicant zip: type: string description: The zip code associated with the applicant notes: type: string description: Notes associated with the applicant move_in_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The move-in date associated with the applicant rent_amount_in_cents: type: integer minimum: 0 description: The rent amount in cents for the applicant desired_lease_term_in_months: type: number minimum: 0 description: The amount of months for the lease term floor_plan_id: type: string description: The Propexo unique identifier for the floor plan other_occupants: type: array items: type: object properties: first_name: type: string description: The first name associated with the occupant last_name: type: string description: The last name associated with the occupant email_1: type: string description: The primary email address associated with the occupant phone_1: type: string description: Primary phone number associated with the occupant phone_1_type: type: string enum: - FAX - HOME - MOBILE - WORK description: Type of the primary phone number phone_2: type: string description: Secondary phone number associated with the occupant phone_2_type: type: string enum: - FAX - HOME - MOBILE - WORK description: Type of the secondary phone number address_1: type: string description: The first address line associated with the occupant address_2: type: string description: The second address line associated with the occupant city: type: string description: The city associated with the occupant state: type: string description: The state associated with the occupant zip: type: string description: The zip code associated with the occupant date_of_birth: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date of birth associated with the occupant move_in_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The move-in date associated with the lease rent_amount_in_cents: type: integer minimum: 0 description: The market rent amount in cents for the lease required: - first_name - last_name default: *a93 emergency_contacts: type: array items: type: object properties: first_name: type: string description: The first name of the emergency contact last_name: type: string description: The last name of the emergency contact relationship: type: string description: The relationship of the emergency contact to the applicant address_1: type: string description: The first line of the address of the emergency contact city: type: string description: The city of the address of the emergency contact state: type: string description: The state of the address of the emergency contact zip: type: string description: The zip code of the address of the emergency contact country: type: string description: The country of the address of the emergency contact phone_1: type: string description: The phone number of the emergency contact required: - first_name - last_name - relationship default: *a94 description: "A list of emergency contacts for the applicant. Note: This will only be added to the primary applicant on the application." employment_history: type: array items: type: object properties: name: type: string description: The name of the employer income_in_cents: type: integer minimum: 0 description: The income of the applicant at this employer in cents frequency: type: string enum: *a95 description: The frequency of the income. start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The start date of the applicant's employment at this employer end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The end date of the applicant's employment at this employer position: type: string description: The position held at this employer, or the job description of the applicant address_1: type: string description: The first line of the address of the employer city: type: string description: The city of the address of the employer state: type: string description: The state of the address of the employer zip: type: string description: The zip code of the address of the employer country: type: string description: The country of the address of the employer supervisor_first_name: type: string description: The first name of the applicant's supervisor at this employer supervisor_last_name: type: string description: The last name of the applicant's supervisor at this employer supervisor_phone: type: string description: The phone number of the applicant's supervisor required: - name - income_in_cents - frequency - start_date default: *a96 description: "The employment history of the applicant. Note: This will only be added to the primary applicant on the application. Only entries with both income_in_cents and frequency will be included." vehicles: type: array items: type: object properties: make: type: string description: The make of the vehicle model: type: string description: The model of the vehicle color: type: string description: The color of the vehicle license_plate_number: type: string description: The license plate number of the vehicle license_plate_state: type: string description: The issuing state of the license plate permit_number: type: string description: The permit number of the vehicle required: - make - model - color - license_plate_number - license_plate_state default: *a97 description: A list of vehicles for the application pets: type: array items: type: object properties: type: type: string description: "The type associated with the applicant pet. Note: This must match one of the pet types from the pick list in Resman" name: type: string description: The name associated with the applicant pet weight_in_pounds: type: integer minimum: 0 description: The weight in pounds of the applicant pet required: - type - name - weight_in_pounds default: *a98 description: A list of applicant pets required: - application_id - applicant_id - unit_id - lead_source_id - employee_id - application_date - start_date - end_date - status - first_name - last_name required: - meta - result _v1_appointments__get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query x_id: type: string description: The external ID of the event from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_type_id: type: string description: The external ID of the type from the integration vendor location_id: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. property_id: type: string description: The Propexo unique identifier for the property lead_id: type: string description: The Propexo unique identifier for the lead applicant_id: type: string description: The Propexo unique identifier for the applicant resident_id: type: string description: The Propexo unique identifier for the resident integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" Event: type: object properties: id: type: string description: The Propexo unique identifier for the event created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_leasing_agent_id: type: - string - "null" description: The external ID of the leasing agent from the integration vendor x_type_id: type: - string - "null" description: The external ID of the type from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. event_name: type: - string - "null" description: The name of the event event_datetime: type: - string - "null" description: The datetime that the event occurred appointment_datetime: type: - string - "null" description: The datetime that the event appointment occurred type_raw: type: - string - "null" description: The type of event notes: type: - string - "null" description: Notes associated with the event agent_name: type: - string - "null" description: The name of the agent associated with the event reasons_for_event: type: - string - "null" description: Reasons that the event occurred associated_lead_ids: type: - array - "null" items: type: string example: cm2jeb8af00042qoza7lcb5cx associated_applicant_ids: type: - array - "null" items: type: string x-propexo: &a306 derivedFromModel: applicants_to_events derivedFromField: applicant_id associated_resident_ids: type: - array - "null" items: type: string example: cm2jebkdu00072qozfa5p9rs7 integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" property_id: type: string description: The Propexo unique identifier for the property required: - id - created_at - updated_at - last_seen - x_id - x_property_id - x_leasing_agent_id - x_type_id - x_location_id - event_name - event_datetime - appointment_datetime - type_raw - notes - agent_name - reasons_for_event - associated_lead_ids - associated_applicant_ids - associated_resident_ids - integration_id - integration_vendor - property_id x-propexo: derivedFromModel: events _v1_appointments__get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: type: array items: $ref: "#/components/schemas/Event" required: - meta - results _v1_appointment-availability__post_input: type: object properties: integration_id: type: string property_id: type: string description: The Propexo unique identifier for the property availability_start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The start date of the availability to query. RealPage Partner Exchange will return results starting at midnight of this date in the local timezone of the property. availability_duration_days: type: integer minimum: 1 maximum: 7 description: The duration of the availability query, in days appointment_duration_minutes: type: integer exclusiveMinimum: 0 default: 30 description: The duration of the appointment, in minutes. RealPage Partner Exchange does not provide a default appointment duration. A value of 30 minutes is assumed if this field is not provided. calendar_types: type: array items: type: string enum: - GENERAL - RESIDENT - LEASING - MAINTENANCE description: The calendar groups to consider when evaluating what availability is possible, defaulting to the Resident and Leasing calendar groups if not provided. Note that Entrata only supports API creation of appointment types for the Leasing group at this time. employee_id: type: string description: The Propexo unique identifier for the employee. The API will only return availability for this employee. If not provided, availability will be returned for all employees. required: - integration_id _v1_appointment-availability__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: array items: type: object properties: last_seen: type: string description: The date the record was last seen from the PMS calendar_type: type: string enum: - AGENT_CALENDAR - PROPERTY_CALENDAR - ENTRATA_SELF_GUIDED_TOUR_CALENDAR description: The type of calendar x_agent_id: type: - string - "null" description: The external ID of the agent from the integration vendor agent_first_name: type: - string - "null" description: The first name associated with the employee agent_last_name: type: - string - "null" description: The last name associated with the employee default_appointment_length: type: - number - "null" description: A default duration for an appointment on this calendar, in minutes minimum_appointment_lead_time: type: - number - "null" description: The minimum lead time before which you can book an appointment on this calendar, in minutes timezone: type: - string - "null" description: The timezone of the calendar, if such metadata is available. Please contact Propexo Support if you are working with properties outside of the United States and Canada as there may be options for populating this field depending on your business case and integration vendor. calendar_days: type: array items: type: object properties: date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: Date of the availability day_of_week: type: string description: Day of the week opening_time: type: - string - "null" pattern: (?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d) description: The routine opening time for when the first appointment can be booked into this calendar closing_time: type: - string - "null" pattern: (?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d) description: The routine closing time for when the last appointment must complete when being booked into this calendar simultaneous_appointment_mode: type: string enum: - SINGLE - MULTIPLE - UNLIMITED - UNKNOWN description: What kind of simultaneous or double booked appointments are allowed on this calendar max_simultaneous_appointments: type: - number - "null" description: The maximum number of simultaneous appointments allowed at the same moment in time on this calendar available_slots: type: array items: type: - object - "null" properties: start: type: string pattern: (?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d) description: The start time of the slot end: type: - string - "null" pattern: (?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d) description: The end time of the slot which may not be available in all cases required: - start - end required: - date - day_of_week - opening_time - closing_time - simultaneous_appointment_mode - max_simultaneous_appointments - available_slots x_property_id: type: - string - "null" description: The external ID of the property from the integration vendor required: - last_seen - calendar_type - x_agent_id - agent_first_name - agent_last_name - default_appointment_length - minimum_appointment_lead_time - timezone - calendar_days - x_property_id required: - meta - result _v1_appointment-availability_entrata__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration property_id: type: string description: The Propexo unique identifier for the property availability_start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The start date of the availability to query. Entrata will return results starting at midnight of this date in Mountain Time which respects daylight savings time. availability_duration_days: type: integer minimum: 1 maximum: 7 description: The duration of the availability query, in days appointment_duration_minutes: type: integer exclusiveMinimum: 0 description: The duration of the appointment, in minutes. Slot availability calculations will be performed using the default appointment duration for each calendar if not provided. calendar_types: type: array items: type: string enum: - GENERAL - RESIDENT - LEASING - MAINTENANCE description: The calendar groups to consider when evaluating what availability is possible, defaulting to the Resident and Leasing calendar groups if not provided. Note that Entrata only supports API creation of appointment types for the Leasing group at this time. required: - integration_id - property_id - availability_start_date - availability_duration_days _v1_appointment-availability_entrata__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: array items: type: object properties: last_seen: type: string description: The date the record was last seen from the PMS calendar_type: type: string enum: - AGENT_CALENDAR - PROPERTY_CALENDAR - ENTRATA_SELF_GUIDED_TOUR_CALENDAR description: The type of calendar x_agent_id: type: - string - "null" description: The external ID of the agent from the integration vendor agent_first_name: type: - string - "null" description: The first name associated with the employee agent_last_name: type: - string - "null" description: The last name associated with the employee default_appointment_length: type: - number - "null" description: A default duration for an appointment on this calendar, in minutes minimum_appointment_lead_time: type: - number - "null" description: The minimum lead time before which you can book an appointment on this calendar, in minutes timezone: type: - string - "null" description: The timezone of the calendar, if such metadata is available. Please contact Propexo Support if you are working with properties outside of the United States and Canada as there may be options for populating this field depending on your business case and integration vendor. calendar_days: type: array items: type: object properties: date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: Date of the availability day_of_week: type: string description: Day of the week opening_time: type: - string - "null" pattern: (?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d) description: The routine opening time for when the first appointment can be booked into this calendar closing_time: type: - string - "null" pattern: (?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d) description: The routine closing time for when the last appointment must complete when being booked into this calendar simultaneous_appointment_mode: type: string enum: - SINGLE - MULTIPLE - UNLIMITED - UNKNOWN description: What kind of simultaneous or double booked appointments are allowed on this calendar max_simultaneous_appointments: type: - number - "null" description: The maximum number of simultaneous appointments allowed at the same moment in time on this calendar available_slots: type: array items: type: - object - "null" properties: start: type: string pattern: (?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d) description: The start time of the slot end: type: - string - "null" pattern: (?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d) description: The end time of the slot which may not be available in all cases required: - start - end required: - date - day_of_week - opening_time - closing_time - simultaneous_appointment_mode - max_simultaneous_appointments - available_slots x_property_id: type: - string - "null" description: The external ID of the property from the integration vendor required: - last_seen - calendar_type - x_agent_id - agent_first_name - agent_last_name - default_appointment_length - minimum_appointment_lead_time - timezone - calendar_days - x_property_id required: - meta - result _v1_appointment-availability_realpage_rpx__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration property_id: type: string description: The Propexo unique identifier for the property employee_id: type: string description: The Propexo unique identifier for the employee. The API will only return availability for this employee. If not provided, availability will be returned for all employees. availability_start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The start date of the availability to query. RealPage Partner Exchange will return results starting at midnight of this date in the local timezone of the property. availability_duration_days: type: integer minimum: 1 maximum: 7 description: The duration of the availability query, in days appointment_duration_minutes: type: integer exclusiveMinimum: 0 default: 30 description: The duration of the appointment, in minutes. RealPage Partner Exchange does not provide a default appointment duration. A value of 30 minutes is assumed if this field is not provided. required: - integration_id - property_id - availability_start_date - availability_duration_days _v1_appointment-availability_realpage_rpx__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: array items: type: object properties: last_seen: type: string description: The date the record was last seen from the PMS calendar_type: type: string enum: - AGENT_CALENDAR - PROPERTY_CALENDAR - ENTRATA_SELF_GUIDED_TOUR_CALENDAR description: The type of calendar x_agent_id: type: - string - "null" description: The external ID of the agent from the integration vendor agent_first_name: type: - string - "null" description: The first name associated with the employee agent_last_name: type: - string - "null" description: The last name associated with the employee default_appointment_length: type: - number - "null" description: A default duration for an appointment on this calendar, in minutes minimum_appointment_lead_time: type: - number - "null" description: The minimum lead time before which you can book an appointment on this calendar, in minutes timezone: type: - string - "null" description: The timezone of the calendar, if such metadata is available. Please contact Propexo Support if you are working with properties outside of the United States and Canada as there may be options for populating this field depending on your business case and integration vendor. calendar_days: type: array items: type: object properties: date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: Date of the availability day_of_week: type: string description: Day of the week opening_time: type: - string - "null" pattern: (?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d) description: The routine opening time for when the first appointment can be booked into this calendar closing_time: type: - string - "null" pattern: (?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d) description: The routine closing time for when the last appointment must complete when being booked into this calendar simultaneous_appointment_mode: type: string enum: - SINGLE - MULTIPLE - UNLIMITED - UNKNOWN description: What kind of simultaneous or double booked appointments are allowed on this calendar max_simultaneous_appointments: type: - number - "null" description: The maximum number of simultaneous appointments allowed at the same moment in time on this calendar available_slots: type: array items: type: - object - "null" properties: start: type: string pattern: (?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d) description: The start time of the slot end: type: - string - "null" pattern: (?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d) description: The end time of the slot which may not be available in all cases required: - start - end required: - date - day_of_week - opening_time - closing_time - simultaneous_appointment_mode - max_simultaneous_appointments - available_slots x_property_id: type: - string - "null" description: The external ID of the property from the integration vendor required: - last_seen - calendar_type - x_agent_id - agent_first_name - agent_last_name - default_appointment_length - minimum_appointment_lead_time - timezone - calendar_days - x_property_id required: - meta - result _v1_appointment-availability_rentmanager__post_input: type: object properties: {} _v1_appointment-availability_rentmanager__post_output: type: object properties: {} _v1_events_appointments_applicants_post_input: type: object properties: integration_id: type: string applicant_id: type: string description: The Propexo unique identifier for the applicant application_id: type: string description: The Propexo unique identifier for the application unit_id: type: string description: The Propexo unique identifier for the unit appointment_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date when the appointment will occur appointment_time: type: string pattern: (?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d) description: The time when the appointment will occur. Please refer to our appointment times section in the docs to see how each individual PMS handles timezones appointment_duration_minutes: type: integer exclusiveMinimum: 0 description: The duration of the appointment, in minutes appointment_type: type: string enum: - LEASING_APPOINTMENT - SELF_GUIDED_TOUR - TOUR - VIRTUAL_TOUR description: The type of appointment. This is specific to Entrata and correlates to the types of calendar appointments available notes: type: string maxLength: 256 description: Notes associated with the event title: type: string maxLength: 50 description: The title associated with the event employee_id: type: string description: The Propexo unique identifier for the employee status: type: string enum: &a99 - COMPLETED - OPEN - REVIEW - DENIED description: The raw status associated with the event priority: type: string enum: - HIGH - MEDIUM - LOW description: The priority of the appointment required: - integration_id _v1_events_appointments_applicants_post_output: type: object properties: job_id: type: string description: The ID of the job created to handle this operation data: type: object properties: {} required: - job_id - data _v1_events_appointments_leads_post_input: type: object properties: integration_id: type: string lead_id: type: string description: The Propexo unique identifier for the lead unit_id: type: string description: The Propexo unique identifier for the unit appointment_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date when the appointment will occur appointment_time: type: string pattern: (?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d) description: The time when the appointment will occur. Please refer to our appointment times section in the docs to see how each individual PMS handles timezones appointment_duration_minutes: type: integer exclusiveMinimum: 0 description: The duration of the appointment, in minutes employee_id: type: string description: The Propexo unique identifier for the employee notes: type: string maxLength: 256 description: Notes associated with the event appointment_type: type: string enum: - LEASING_APPOINTMENT - SELF_GUIDED_TOUR - TOUR - VIRTUAL_TOUR description: The type of appointment. This is specific to Entrata and correlates to the types of calendar appointments available title: type: string maxLength: 50 description: The title associated with the event status: type: string enum: &a101 - COMPLETED - OPEN - REVIEW - DENIED description: The raw status associated with the event priority: type: string enum: - HIGH - MEDIUM - LOW description: The priority of the appointment lead_source_id: type: string description: The Propexo unique identifier for the lead source required: - integration_id _v1_events_appointments_leads_post_output: type: object properties: job_id: type: string description: The ID of the job created to handle this operation data: type: object properties: {} required: - job_id - data _v1_events_appointments_residents_post_input: type: object properties: integration_id: type: string resident_id: type: string description: The Propexo unique identifier for the resident appointment_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date when the appointment will occur appointment_time: type: string pattern: (?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d) description: The time when the appointment will occur. Please refer to our appointment times section in the docs to see how each individual PMS handles timezones. The time is in the local time of the property/location. In Rent Manager, the default timezone is an optional setting that the PMC can set and will be stored on the Propexo Timezone model. You may need to read in this setting and convert to the local timezone for the appointment time to be correct. employee_id: type: string description: The Propexo unique identifier for the employee status: type: string enum: &a103 - COMPLETED - OPEN - REVIEW - DENIED description: The raw status associated with the event notes: type: string description: Notes associated with the event appointment_duration_minutes: type: integer exclusiveMinimum: 0 description: The duration of the appointment, in minutes title: type: string maxLength: 50 description: The title associated with the event required: - integration_id _v1_events_appointments_residents_post_output: type: object properties: job_id: type: string description: The ID of the job created to handle this operation data: type: object properties: {} required: - job_id - data _v1_events_appointments_applicants_{event_id}_put_input: type: object properties: unit_id: type: string description: The Propexo unique identifier for the unit notes: type: string description: Notes associated with the event appointment_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date when the appointment will occur appointment_time: type: string pattern: (?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d) description: The time when the appointment will occur. Please refer to our appointment times section in the docs to see how each individual PMS handles timezones appointment_duration_minutes: type: integer exclusiveMinimum: 0 description: The duration of the appointment, in minutes appointment_type: type: string enum: - LEASING_APPOINTMENT - SELF_GUIDED_TOUR - TOUR - VIRTUAL_TOUR description: The type of appointment. This is specific to Entrata and correlates to the types of calendar appointments available title: type: string maxLength: 50 description: The title associated with the event employee_id: type: string description: The Propexo unique identifier for the employee. Must have a role of LEASING_AGENT status: type: string enum: &a100 - COMPLETED - OPEN - REVIEW - DENIED description: The raw status associated with the event priority: type: string enum: - HIGH - MEDIUM - LOW description: The priority of the appointment _v1_events_appointments_applicants_{event_id}_put_output: type: object properties: job_id: type: string description: The ID of the job created to handle this operation data: type: object properties: {} required: - job_id - data _v1_events_appointments_applicants_cancel_post_input: type: object properties: integration_id: type: string event_id: type: string description: The Propexo unique identifier for the event required: - integration_id _v1_events_appointments_applicants_cancel_post_output: type: object properties: job_id: type: string description: The ID of the job created to handle this operation data: type: object properties: {} required: - job_id - data _v1_events_appointments_leads_{event_id}_put_input: type: object properties: appointment_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date when the appointment will occur appointment_time: type: string pattern: (?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d) description: The time when the appointment will occur. Please refer to our appointment times section in the docs to see how each individual PMS handles timezones appointment_duration_minutes: type: integer exclusiveMinimum: 0 description: The duration of the appointment, in minutes employee_id: type: string description: The Propexo unique identifier for the employee. Must have a role of LEASING_AGENT notes: type: string description: Notes associated with the event unit_id: type: string description: The Propexo unique identifier for the unit appointment_type: type: string enum: - LEASING_APPOINTMENT - SELF_GUIDED_TOUR - TOUR - VIRTUAL_TOUR description: The type of appointment. This is specific to Entrata and correlates to the types of calendar appointments available title: type: string maxLength: 50 description: The title associated with the event status: type: string enum: &a102 - COMPLETED - OPEN - REVIEW - DENIED description: The raw status associated with the event priority: type: string enum: - HIGH - MEDIUM - LOW description: The priority of the appointment _v1_events_appointments_leads_{event_id}_put_output: type: object properties: job_id: type: string description: The ID of the job created to handle this operation data: type: object properties: {} required: - job_id - data _v1_events_appointments_leads_cancel_post_input: type: object properties: integration_id: type: string event_id: type: string description: The Propexo unique identifier for the event required: - integration_id _v1_events_appointments_leads_cancel_post_output: type: object properties: job_id: type: string description: The ID of the job created to handle this operation data: type: object properties: {} required: - job_id - data _v1_events_appointments_residents_{event_id}_put_input: type: object properties: appointment_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date when the appointment will occur appointment_time: type: string pattern: (?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d) description: The time when the appointment will occur. Please refer to our appointment times section in the docs to see how each individual PMS handles timezones. The time is in the local time of the property/location. In Rent Manager, the default timezone is an optional setting that the PMC can set and will be stored on the Propexo Timezone model. You may need to read in this setting and convert to the local timezone for the appointment time to be correct. employee_id: type: string description: The Propexo unique identifier for the employee. Must have a role of LEASING_AGENT status: type: string enum: &a104 - COMPLETED - OPEN - REVIEW - DENIED description: The raw status associated with the event notes: type: string description: Notes associated with the event appointment_duration_minutes: type: integer exclusiveMinimum: 0 description: The duration of the appointment, in minutes title: type: string maxLength: 50 description: The title associated with the event _v1_events_appointments_residents_{event_id}_put_output: type: object properties: job_id: type: string description: The ID of the job created to handle this operation data: type: object properties: {} required: - job_id - data _v1_events_appointments_residents_cancel_post_input: type: object properties: integration_id: type: string event_id: type: string description: The Propexo unique identifier for the event required: - integration_id _v1_events_appointments_residents_cancel_post_output: type: object properties: job_id: type: string description: The ID of the job created to handle this operation data: type: object properties: {} required: - job_id - data _v1_events_appointments_applicants_cancel_yardi_post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration event_id: type: string description: The Propexo unique identifier for the event required: - integration_id - event_id _v1_events_appointments_applicants_cancel_yardi_post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration event_id: type: string description: The Propexo unique identifier for the event required: - integration_id - event_id required: - meta - result _v1_events_appointments_applicants_cancel_entrata_post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration event_id: type: string description: The Propexo unique identifier for the event required: - integration_id - event_id _v1_events_appointments_applicants_cancel_entrata_post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration event_id: type: string description: The Propexo unique identifier for the event required: - integration_id - event_id required: - meta - result _v1_events_appointments_applicants_cancel_realpage_rpx_post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration event_id: type: string description: The Propexo unique identifier for the event required: - integration_id - event_id _v1_events_appointments_applicants_cancel_realpage_rpx_post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration event_id: type: string description: The Propexo unique identifier for the event required: - integration_id - event_id required: - meta - result _v1_events_appointments_applicants_cancel_rentmanager_post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration event_id: type: string description: The Propexo unique identifier for the event required: - integration_id - event_id _v1_events_appointments_applicants_cancel_rentmanager_post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration event_id: type: string description: The Propexo unique identifier for the event required: - integration_id - event_id required: - meta - result _v1_events_appointments_applicants_entrata__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration applicant_id: type: string description: The Propexo unique identifier for the applicant application_id: type: string description: The Propexo unique identifier for the application unit_id: type: string description: The Propexo unique identifier for the unit appointment_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date when the appointment will occur appointment_time: type: string pattern: (?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d) description: The time when the appointment will occur. Please refer to our appointment times section in the docs to see how each individual PMS handles timezones. Entrata expects this time to be in Mountain Time and honor daylight savings time. appointment_duration_minutes: type: integer exclusiveMinimum: 0 description: The duration of the appointment, in minutes appointment_type: type: string enum: - LEASING_APPOINTMENT - SELF_GUIDED_TOUR - TOUR - VIRTUAL_TOUR description: The type of appointment. This is specific to Entrata and correlates to the types of calendar appointments available notes: type: string minLength: 1 description: Notes associated with the event title: type: string description: The title associated with the event required: - integration_id - applicant_id - application_id - appointment_date - appointment_time - appointment_duration_minutes - appointment_type - notes _v1_events_appointments_applicants_entrata__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration applicant_id: type: string description: The Propexo unique identifier for the applicant application_id: type: string description: The Propexo unique identifier for the application unit_id: type: - string - "null" description: The Propexo unique identifier for the unit appointment_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" appointment_time: type: string pattern: (?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d) description: The time when the appointment will occur. Please refer to our appointment times section in the docs to see how each individual PMS handles timezones. Entrata expects this time to be in Mountain Time and honor daylight savings time. appointment_duration_minutes: type: integer exclusiveMinimum: 0 description: The duration of the appointment, in minutes appointment_type: type: string enum: - LEASING_APPOINTMENT - SELF_GUIDED_TOUR - TOUR - VIRTUAL_TOUR description: The type of appointment. This is specific to Entrata and correlates to the types of calendar appointments available notes: type: string minLength: 1 description: Notes associated with the event title: type: - string - "null" description: The title associated with the event required: - integration_id - applicant_id - application_id - unit_id - appointment_date - appointment_time - appointment_duration_minutes - appointment_type - notes - title required: - meta - result _v1_events_appointments_applicants_entrata_{event_id}_put_input: type: object properties: unit_id: type: string description: The Propexo unique identifier for the unit notes: type: string minLength: 1 description: Notes associated with the event appointment_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date when the appointment will occur appointment_time: type: string pattern: (?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d) description: The time when the appointment will occur. Please refer to our appointment times section in the docs to see how each individual PMS handles timezones. Entrata expects this time to be in Mountain Time and honor daylight savings time. appointment_duration_minutes: type: integer exclusiveMinimum: 0 description: The duration of the appointment, in minutes appointment_type: type: string enum: - LEASING_APPOINTMENT - SELF_GUIDED_TOUR - TOUR - VIRTUAL_TOUR description: The type of appointment. This is specific to Entrata and correlates to the types of calendar appointments available title: type: string description: The title associated with the event required: - notes _v1_events_appointments_applicants_entrata_{event_id}_put_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: event_id: type: string description: The Propexo unique identifier for the event unit_id: type: string description: The Propexo unique identifier for the unit notes: type: string minLength: 1 description: Notes associated with the event appointment_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date when the appointment will occur appointment_time: type: string pattern: (?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d) description: The time when the appointment will occur. Please refer to our appointment times section in the docs to see how each individual PMS handles timezones. Entrata expects this time to be in Mountain Time and honor daylight savings time. appointment_duration_minutes: type: integer exclusiveMinimum: 0 description: The duration of the appointment, in minutes appointment_type: type: string enum: - LEASING_APPOINTMENT - SELF_GUIDED_TOUR - TOUR - VIRTUAL_TOUR description: The type of appointment. This is specific to Entrata and correlates to the types of calendar appointments available title: type: string description: The title associated with the event required: - event_id - notes required: - meta - result _v1_events_appointments_applicants_realpage_rpx__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration applicant_id: type: string description: The Propexo unique identifier for the applicant employee_id: type: string description: The Propexo unique identifier for the employee appointment_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date when the appointment will occur appointment_time: type: string pattern: (?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d) description: The time when the appointment will occur. Please refer to our appointment times section in the docs to see how each individual PMS handles timezones appointment_duration_minutes: type: integer exclusiveMinimum: 0 description: The duration of the appointment, in minutes notes: type: string description: Notes associated with the event priority: type: string enum: - HIGH - MEDIUM - LOW description: The priority of the appointment required: - integration_id - applicant_id - employee_id - appointment_date - appointment_time - appointment_duration_minutes _v1_events_appointments_applicants_realpage_rpx__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration applicant_id: type: string description: The Propexo unique identifier for the applicant employee_id: type: string description: The Propexo unique identifier for the employee appointment_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" appointment_time: type: string pattern: (?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d) description: The time when the appointment will occur. Please refer to our appointment times section in the docs to see how each individual PMS handles timezones appointment_duration_minutes: type: integer exclusiveMinimum: 0 description: The duration of the appointment, in minutes notes: type: - string - "null" description: Notes associated with the event priority: type: - string - "null" enum: - HIGH - MEDIUM - LOW description: The priority of the appointment required: - integration_id - applicant_id - employee_id - appointment_date - appointment_time - appointment_duration_minutes - notes - priority required: - meta - result _v1_events_appointments_applicants_realpage_rpx_{event_id}_put_input: type: object properties: appointment_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date when the appointment will occur appointment_time: type: string pattern: (?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d) description: The time when the appointment will occur. Please refer to our appointment times section in the docs to see how each individual PMS handles timezones appointment_duration_minutes: type: integer exclusiveMinimum: 0 description: The duration of the appointment, in minutes notes: type: string description: Notes associated with the event priority: type: string enum: - HIGH - MEDIUM - LOW description: The priority of the appointment required: - appointment_date - appointment_time - appointment_duration_minutes _v1_events_appointments_applicants_realpage_rpx_{event_id}_put_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: event_id: type: string description: The Propexo unique identifier for the event appointment_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date when the appointment will occur appointment_time: type: string pattern: (?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d) description: The time when the appointment will occur. Please refer to our appointment times section in the docs to see how each individual PMS handles timezones appointment_duration_minutes: type: integer exclusiveMinimum: 0 description: The duration of the appointment, in minutes notes: type: string description: Notes associated with the event priority: type: string enum: - HIGH - MEDIUM - LOW description: The priority of the appointment required: - event_id - appointment_date - appointment_time - appointment_duration_minutes required: - meta - result _v1_events_appointments_applicants_rentmanager__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration applicant_id: type: string description: The Propexo unique identifier for the applicant employee_id: type: string description: The Propexo unique identifier for the employee appointment_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date when the appointment will occur appointment_time: type: string pattern: (?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d) description: The time when the appointment will occur. Please refer to our appointment times section in the docs to see how each individual PMS handles timezones. The time is in the local time of the property/location. In Rent Manager, the default timezone is an optional setting that the PMC can set and will be stored on the Propexo Timezone model. You may need to read in this setting and convert to the local timezone for the appointment time to be correct. appointment_duration_minutes: type: integer exclusiveMinimum: 0 description: The duration of the appointment, in minutes title: type: string maxLength: 50 description: The title associated with the event notes: type: string description: Notes associated with the event required: - integration_id - applicant_id - appointment_date - appointment_time - appointment_duration_minutes - title _v1_events_appointments_applicants_rentmanager__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration applicant_id: type: string description: The Propexo unique identifier for the applicant employee_id: type: - string - "null" description: The Propexo unique identifier for the employee appointment_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" appointment_time: type: string pattern: (?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d) description: The time when the appointment will occur. Please refer to our appointment times section in the docs to see how each individual PMS handles timezones. The time is in the local time of the property/location. In Rent Manager, the default timezone is an optional setting that the PMC can set and will be stored on the Propexo Timezone model. You may need to read in this setting and convert to the local timezone for the appointment time to be correct. appointment_duration_minutes: type: integer exclusiveMinimum: 0 description: The duration of the appointment, in minutes title: type: string maxLength: 50 description: The title associated with the event notes: type: - string - "null" description: Notes associated with the event required: - integration_id - applicant_id - employee_id - appointment_date - appointment_time - appointment_duration_minutes - title - notes required: - meta - result _v1_events_appointments_applicants_rentmanager_{event_id}_put_input: type: object properties: appointment_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date when the appointment will occur appointment_time: type: string pattern: (?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d) description: The time when the appointment will occur. Please refer to our appointment times section in the docs to see how each individual PMS handles timezones. The time is in the local time of the property/location. In Rent Manager, the default timezone is an optional setting that the PMC can set and will be stored on the Propexo Timezone model. You may need to read in this setting and convert to the local timezone for the appointment time to be correct. appointment_duration_minutes: type: integer exclusiveMinimum: 0 description: The duration of the appointment, in minutes title: type: string maxLength: 50 description: The title associated with the event notes: type: string description: Notes associated with the event required: - appointment_date - appointment_time - appointment_duration_minutes - title _v1_events_appointments_applicants_rentmanager_{event_id}_put_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: event_id: type: string description: The Propexo unique identifier for the event appointment_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date when the appointment will occur appointment_time: type: string pattern: (?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d) description: The time when the appointment will occur. Please refer to our appointment times section in the docs to see how each individual PMS handles timezones. The time is in the local time of the property/location. In Rent Manager, the default timezone is an optional setting that the PMC can set and will be stored on the Propexo Timezone model. You may need to read in this setting and convert to the local timezone for the appointment time to be correct. appointment_duration_minutes: type: integer exclusiveMinimum: 0 description: The duration of the appointment, in minutes title: type: string maxLength: 50 description: The title associated with the event notes: type: string description: Notes associated with the event required: - event_id - appointment_date - appointment_time - appointment_duration_minutes - title required: - meta - result _v1_events_appointments_applicants_yardi__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration applicant_id: type: string description: The Propexo unique identifier for the applicant unit_id: type: string description: The Propexo unique identifier for the unit employee_id: type: string description: The Propexo unique identifier for the employee appointment_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date when the appointment will occur appointment_time: type: string pattern: (?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d) description: The time when the appointment will occur. Please refer to our appointment times section in the docs to see how each individual PMS handles timezones notes: type: string maxLength: 256 description: Notes associated with the event required: - integration_id - applicant_id - unit_id - employee_id - appointment_date - appointment_time _v1_events_appointments_applicants_yardi__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration applicant_id: type: string description: The Propexo unique identifier for the applicant unit_id: type: string description: The Propexo unique identifier for the unit employee_id: type: string description: The Propexo unique identifier for the employee appointment_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" appointment_time: type: string pattern: (?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d) description: The time when the appointment will occur. Please refer to our appointment times section in the docs to see how each individual PMS handles timezones notes: type: - string - "null" maxLength: 256 description: Notes associated with the event required: - integration_id - applicant_id - unit_id - employee_id - appointment_date - appointment_time - notes required: - meta - result _v1_events_appointments_applicants_yardi_{event_id}_put_input: type: object properties: appointment_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date when the appointment will occur appointment_time: type: string pattern: (?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d) description: The time when the appointment will occur. Please refer to our appointment times section in the docs to see how each individual PMS handles timezones required: - appointment_date - appointment_time _v1_events_appointments_applicants_yardi_{event_id}_put_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: event_id: type: string description: The Propexo unique identifier for the event appointment_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date when the appointment will occur appointment_time: type: string pattern: (?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d) description: The time when the appointment will occur. Please refer to our appointment times section in the docs to see how each individual PMS handles timezones required: - event_id - appointment_date - appointment_time required: - meta - result _v1_events_appointments_applicants_mri__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration applicant_id: type: string description: The Propexo unique identifier for the applicant appointment_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date when the appointment will occur appointment_time: type: string pattern: (?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d) description: The time when the appointment will occur. Please refer to our appointment times section in the docs to see how each individual PMS handles timezones employee_id: type: string description: The Propexo unique identifier for the employee. Must have a role of LEASING_AGENT status: type: string enum: *a99 description: The raw status associated with the event notes: type: string description: Notes associated with the event required: - integration_id - applicant_id - appointment_date _v1_events_appointments_applicants_mri__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration applicant_id: type: string description: The Propexo unique identifier for the applicant appointment_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" appointment_time: type: - string - "null" pattern: (?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d) description: The time when the appointment will occur. Please refer to our appointment times section in the docs to see how each individual PMS handles timezones employee_id: type: - string - "null" description: The Propexo unique identifier for the employee. Must have a role of LEASING_AGENT status: type: - string - "null" enum: *a99 description: The raw status associated with the event notes: type: - string - "null" description: Notes associated with the event required: - integration_id - applicant_id - appointment_date - appointment_time - employee_id - status - notes required: - meta - result _v1_events_appointments_applicants_mri_{event_id}_put_input: type: object properties: appointment_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date when the appointment will occur appointment_time: type: string pattern: (?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d) description: The time when the appointment will occur. Please refer to our appointment times section in the docs to see how each individual PMS handles timezones employee_id: type: string description: The Propexo unique identifier for the employee. Must have a role of LEASING_AGENT status: type: string enum: *a100 description: The raw status associated with the event notes: type: string description: Notes associated with the event required: - appointment_date _v1_events_appointments_applicants_mri_{event_id}_put_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: event_id: type: string description: The Propexo unique identifier for the event appointment_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date when the appointment will occur appointment_time: type: string pattern: (?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d) description: The time when the appointment will occur. Please refer to our appointment times section in the docs to see how each individual PMS handles timezones employee_id: type: string description: The Propexo unique identifier for the employee. Must have a role of LEASING_AGENT status: type: string enum: *a100 description: The raw status associated with the event notes: type: string description: Notes associated with the event required: - event_id - appointment_date required: - meta - result _v1_events_appointments_leads_cancel_appfolio_post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration event_id: type: string description: The Propexo unique identifier for the event required: - integration_id - event_id _v1_events_appointments_leads_cancel_appfolio_post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration event_id: type: string description: The Propexo unique identifier for the event required: - integration_id - event_id required: - meta - result _v1_events_appointments_leads_cancel_yardi_post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration event_id: type: string description: The Propexo unique identifier for the event required: - integration_id - event_id _v1_events_appointments_leads_cancel_yardi_post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration event_id: type: string description: The Propexo unique identifier for the event required: - integration_id - event_id required: - meta - result _v1_events_appointments_leads_cancel_entrata_post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration event_id: type: string description: The Propexo unique identifier for the event required: - integration_id - event_id _v1_events_appointments_leads_cancel_entrata_post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration event_id: type: string description: The Propexo unique identifier for the event required: - integration_id - event_id required: - meta - result _v1_events_appointments_leads_cancel_resman_post_input: type: object properties: {} _v1_events_appointments_leads_cancel_resman_post_output: type: object properties: {} _v1_events_appointments_leads_cancel_realpage_rpx_post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration event_id: type: string description: The Propexo unique identifier for the event required: - integration_id - event_id _v1_events_appointments_leads_cancel_realpage_rpx_post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration event_id: type: string description: The Propexo unique identifier for the event required: - integration_id - event_id required: - meta - result _v1_events_appointments_leads_cancel_rentmanager_post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration event_id: type: string description: The Propexo unique identifier for the event required: - integration_id - event_id _v1_events_appointments_leads_cancel_rentmanager_post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration event_id: type: string description: The Propexo unique identifier for the event required: - integration_id - event_id required: - meta - result _v1_events_appointments_leads_appfolio__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration lead_id: type: string description: The Propexo unique identifier for the lead unit_id: type: string description: The Propexo unique identifier for the unit appointment_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date when the appointment will occur appointment_time: type: string pattern: (?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d) description: The time when the appointment will occur. Please refer to our appointment times section in the docs to see how each individual PMS handles timezones. This time should be sent in UTC. appointment_duration_minutes: type: integer exclusiveMinimum: 0 description: The duration of the appointment, in minutes employee_id: type: string description: The Propexo unique identifier for the employee notes: type: string description: Notes associated with the event required: - integration_id - lead_id - unit_id - appointment_date - appointment_time - appointment_duration_minutes _v1_events_appointments_leads_appfolio__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration lead_id: type: string description: The Propexo unique identifier for the lead unit_id: type: string description: The Propexo unique identifier for the unit appointment_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" appointment_time: type: string pattern: (?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d) description: The time when the appointment will occur. Please refer to our appointment times section in the docs to see how each individual PMS handles timezones. This time should be sent in UTC. appointment_duration_minutes: type: integer exclusiveMinimum: 0 description: The duration of the appointment, in minutes employee_id: type: - string - "null" description: The Propexo unique identifier for the employee notes: type: - string - "null" description: Notes associated with the event required: - integration_id - lead_id - unit_id - appointment_date - appointment_time - appointment_duration_minutes - employee_id - notes required: - meta - result _v1_events_appointments_leads_appfolio_{event_id}_put_input: type: object properties: appointment_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date when the appointment will occur appointment_time: type: string pattern: (?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d) description: The time when the appointment will occur. Please refer to our appointment times section in the docs to see how each individual PMS handles timezones appointment_duration_minutes: type: integer exclusiveMinimum: 0 description: The duration of the appointment, in minutes employee_id: type: string description: The Propexo unique identifier for the employee notes: type: string description: Notes associated with the event _v1_events_appointments_leads_appfolio_{event_id}_put_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: event_id: type: string description: The Propexo unique identifier for the event appointment_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date when the appointment will occur appointment_time: type: string pattern: (?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d) description: The time when the appointment will occur. Please refer to our appointment times section in the docs to see how each individual PMS handles timezones appointment_duration_minutes: type: integer exclusiveMinimum: 0 description: The duration of the appointment, in minutes employee_id: type: string description: The Propexo unique identifier for the employee notes: type: string description: Notes associated with the event required: - event_id required: - meta - result _v1_events_appointments_leads_entrata__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration lead_id: type: string description: The Propexo unique identifier for the lead unit_id: type: string description: The Propexo unique identifier for the unit appointment_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date when the appointment will occur appointment_time: type: string pattern: (?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d) description: The time when the appointment will occur. Please refer to our appointment times section in the docs to see how each individual PMS handles timezones. Entrata expects this time to be in Mountain Time and honor daylight savings time. appointment_duration_minutes: type: integer exclusiveMinimum: 0 description: The duration of the appointment, in minutes appointment_type: type: string enum: - LEASING_APPOINTMENT - SELF_GUIDED_TOUR - TOUR - VIRTUAL_TOUR description: The type of appointment. This is specific to Entrata and correlates to the types of calendar appointments available notes: type: string minLength: 1 description: Notes associated with the event title: type: string description: The title associated with the event required: - integration_id - lead_id - appointment_date - appointment_time - appointment_duration_minutes - appointment_type - notes _v1_events_appointments_leads_entrata__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration lead_id: type: string description: The Propexo unique identifier for the lead unit_id: type: - string - "null" description: The Propexo unique identifier for the unit appointment_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" appointment_time: type: string pattern: (?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d) description: The time when the appointment will occur. Please refer to our appointment times section in the docs to see how each individual PMS handles timezones. Entrata expects this time to be in Mountain Time and honor daylight savings time. appointment_duration_minutes: type: integer exclusiveMinimum: 0 description: The duration of the appointment, in minutes appointment_type: type: string enum: - LEASING_APPOINTMENT - SELF_GUIDED_TOUR - TOUR - VIRTUAL_TOUR description: The type of appointment. This is specific to Entrata and correlates to the types of calendar appointments available notes: type: string minLength: 1 description: Notes associated with the event title: type: - string - "null" description: The title associated with the event required: - integration_id - lead_id - unit_id - appointment_date - appointment_time - appointment_duration_minutes - appointment_type - notes - title required: - meta - result _v1_events_appointments_leads_entrata_{event_id}_put_input: type: object properties: unit_id: type: string description: The Propexo unique identifier for the unit notes: type: string minLength: 1 description: Notes associated with the event appointment_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date when the appointment will occur appointment_time: type: string pattern: (?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d) description: The time when the appointment will occur. Please refer to our appointment times section in the docs to see how each individual PMS handles timezones. Entrata expects this time to be in Mountain Time and honor daylight savings time. appointment_duration_minutes: type: integer exclusiveMinimum: 0 description: The duration of the appointment, in minutes appointment_type: type: string enum: - LEASING_APPOINTMENT - SELF_GUIDED_TOUR - TOUR - VIRTUAL_TOUR description: The type of appointment. This is specific to Entrata and correlates to the types of calendar appointments available title: type: string description: The title associated with the event required: - notes _v1_events_appointments_leads_entrata_{event_id}_put_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: event_id: type: string description: The Propexo unique identifier for the event unit_id: type: string description: The Propexo unique identifier for the unit notes: type: string minLength: 1 description: Notes associated with the event appointment_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date when the appointment will occur appointment_time: type: string pattern: (?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d) description: The time when the appointment will occur. Please refer to our appointment times section in the docs to see how each individual PMS handles timezones. Entrata expects this time to be in Mountain Time and honor daylight savings time. appointment_duration_minutes: type: integer exclusiveMinimum: 0 description: The duration of the appointment, in minutes appointment_type: type: string enum: - LEASING_APPOINTMENT - SELF_GUIDED_TOUR - TOUR - VIRTUAL_TOUR description: The type of appointment. This is specific to Entrata and correlates to the types of calendar appointments available title: type: string description: The title associated with the event required: - event_id - notes required: - meta - result _v1_events_appointments_leads_realpage_rpx__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration lead_id: type: string description: The Propexo unique identifier for the lead employee_id: type: string description: The Propexo unique identifier for the employee appointment_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date when the appointment will occur appointment_time: type: string pattern: (?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d) description: The time when the appointment will occur. Please refer to our appointment times section in the docs to see how each individual PMS handles timezones appointment_duration_minutes: type: integer exclusiveMinimum: 0 description: The duration of the appointment, in minutes notes: type: string description: Notes associated with the event priority: type: string enum: - HIGH - MEDIUM - LOW description: The priority of the appointment required: - integration_id - lead_id - employee_id - appointment_date - appointment_time - appointment_duration_minutes _v1_events_appointments_leads_realpage_rpx__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration lead_id: type: string description: The Propexo unique identifier for the lead employee_id: type: string description: The Propexo unique identifier for the employee appointment_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" appointment_time: type: string pattern: (?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d) description: The time when the appointment will occur. Please refer to our appointment times section in the docs to see how each individual PMS handles timezones appointment_duration_minutes: type: integer exclusiveMinimum: 0 description: The duration of the appointment, in minutes notes: type: - string - "null" description: Notes associated with the event priority: type: - string - "null" enum: - HIGH - MEDIUM - LOW description: The priority of the appointment required: - integration_id - lead_id - employee_id - appointment_date - appointment_time - appointment_duration_minutes - notes - priority required: - meta - result _v1_events_appointments_leads_realpage_rpx_{event_id}_put_input: type: object properties: appointment_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date when the appointment will occur appointment_time: type: string pattern: (?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d) description: The time when the appointment will occur. Please refer to our appointment times section in the docs to see how each individual PMS handles timezones appointment_duration_minutes: type: integer exclusiveMinimum: 0 description: The duration of the appointment, in minutes notes: type: string description: Notes associated with the event priority: type: string enum: - HIGH - MEDIUM - LOW description: The priority of the appointment required: - appointment_date - appointment_time - appointment_duration_minutes _v1_events_appointments_leads_realpage_rpx_{event_id}_put_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: event_id: type: string description: The Propexo unique identifier for the event appointment_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date when the appointment will occur appointment_time: type: string pattern: (?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d) description: The time when the appointment will occur. Please refer to our appointment times section in the docs to see how each individual PMS handles timezones appointment_duration_minutes: type: integer exclusiveMinimum: 0 description: The duration of the appointment, in minutes notes: type: string description: Notes associated with the event priority: type: string enum: - HIGH - MEDIUM - LOW description: The priority of the appointment required: - event_id - appointment_date - appointment_time - appointment_duration_minutes required: - meta - result _v1_events_appointments_leads_rentmanager__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration lead_id: type: string description: The Propexo unique identifier for the lead employee_id: type: string description: The Propexo unique identifier for the employee appointment_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date when the appointment will occur appointment_time: type: string pattern: (?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d) description: The time when the appointment will occur. Please refer to our appointment times section in the docs to see how each individual PMS handles timezones. The time is in the local time of the property/location. In Rent Manager, the default timezone is an optional setting that the PMC can set and will be stored on the Propexo Timezone model. You may need to read in this setting and convert to the local timezone for the appointment time to be correct. appointment_duration_minutes: type: integer exclusiveMinimum: 0 description: The duration of the appointment, in minutes title: type: string maxLength: 50 description: The title associated with the event notes: type: string description: Notes associated with the event required: - integration_id - lead_id - appointment_date - appointment_time - appointment_duration_minutes - title _v1_events_appointments_leads_rentmanager__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration lead_id: type: string description: The Propexo unique identifier for the lead employee_id: type: - string - "null" description: The Propexo unique identifier for the employee appointment_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" appointment_time: type: string pattern: (?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d) description: The time when the appointment will occur. Please refer to our appointment times section in the docs to see how each individual PMS handles timezones. The time is in the local time of the property/location. In Rent Manager, the default timezone is an optional setting that the PMC can set and will be stored on the Propexo Timezone model. You may need to read in this setting and convert to the local timezone for the appointment time to be correct. appointment_duration_minutes: type: integer exclusiveMinimum: 0 description: The duration of the appointment, in minutes title: type: string maxLength: 50 description: The title associated with the event notes: type: - string - "null" description: Notes associated with the event required: - integration_id - lead_id - employee_id - appointment_date - appointment_time - appointment_duration_minutes - title - notes required: - meta - result _v1_events_appointments_leads_rentmanager_{event_id}_put_input: type: object properties: appointment_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date when the appointment will occur appointment_time: type: string pattern: (?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d) description: The time when the appointment will occur. Please refer to our appointment times section in the docs to see how each individual PMS handles timezones. The time is in the local time of the property/location. In Rent Manager, the default timezone is an optional setting that the PMC can set and will be stored on the Propexo Timezone model. You may need to read in this setting and convert to the local timezone for the appointment time to be correct. appointment_duration_minutes: type: integer exclusiveMinimum: 0 description: The duration of the appointment, in minutes title: type: string maxLength: 50 description: The title associated with the event notes: type: string description: Notes associated with the event required: - appointment_date - appointment_time - appointment_duration_minutes - title _v1_events_appointments_leads_rentmanager_{event_id}_put_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: event_id: type: string description: The Propexo unique identifier for the event appointment_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date when the appointment will occur appointment_time: type: string pattern: (?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d) description: The time when the appointment will occur. Please refer to our appointment times section in the docs to see how each individual PMS handles timezones. The time is in the local time of the property/location. In Rent Manager, the default timezone is an optional setting that the PMC can set and will be stored on the Propexo Timezone model. You may need to read in this setting and convert to the local timezone for the appointment time to be correct. appointment_duration_minutes: type: integer exclusiveMinimum: 0 description: The duration of the appointment, in minutes title: type: string maxLength: 50 description: The title associated with the event notes: type: string description: Notes associated with the event required: - event_id - appointment_date - appointment_time - appointment_duration_minutes - title required: - meta - result _v1_events_appointments_leads_resman__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration lead_id: type: string description: The Propexo unique identifier for the lead lead_source_id: type: string description: The Propexo unique identifier for the lead source unit_id: type: string description: The Propexo unique identifier for the unit appointment_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date when the appointment will occur appointment_time: type: string pattern: (?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d) description: The time when the appointment will occur. Please refer to our appointment times section in the docs to see how each individual PMS handles timezones. The time is in the local time of the property/location. notes: type: string description: Notes associated with the event required: - integration_id - lead_id - lead_source_id - appointment_date - appointment_time _v1_events_appointments_leads_resman__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration lead_id: type: string description: The Propexo unique identifier for the lead lead_source_id: type: string description: The Propexo unique identifier for the lead source unit_id: type: - string - "null" description: The Propexo unique identifier for the unit appointment_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" appointment_time: type: string pattern: (?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d) description: The time when the appointment will occur. Please refer to our appointment times section in the docs to see how each individual PMS handles timezones. The time is in the local time of the property/location. notes: type: - string - "null" description: Notes associated with the event required: - integration_id - lead_id - lead_source_id - unit_id - appointment_date - appointment_time - notes required: - meta - result _v1_events_appointments_leads_resman_{event_id}_put_input: type: object properties: unit_id: type: string description: The Propexo unique identifier for the unit appointment_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date when the appointment will occur appointment_time: type: string pattern: (?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d) description: The time when the appointment will occur. Please refer to our appointment times section in the docs to see how each individual PMS handles timezones. The time is in the local time of the property/location. notes: type: string description: Notes associated with the event required: - appointment_date - appointment_time _v1_events_appointments_leads_resman_{event_id}_put_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: event_id: type: string description: The Propexo unique identifier for the lead unit_id: type: string description: The Propexo unique identifier for the unit appointment_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date when the appointment will occur appointment_time: type: string pattern: (?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d) description: The time when the appointment will occur. Please refer to our appointment times section in the docs to see how each individual PMS handles timezones. The time is in the local time of the property/location. notes: type: string description: Notes associated with the event required: - event_id - appointment_date - appointment_time required: - meta - result _v1_events_appointments_leads_yardi__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration lead_id: type: string description: The Propexo unique identifier for the lead unit_id: type: string description: The Propexo unique identifier for the unit employee_id: type: string description: The Propexo unique identifier for the employee appointment_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date when the appointment will occur appointment_time: type: string pattern: (?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d) description: The time when the appointment will occur. Please refer to our appointment times section in the docs to see how each individual PMS handles timezones notes: type: string maxLength: 256 description: Notes associated with the event required: - integration_id - lead_id - unit_id - employee_id - appointment_date - appointment_time _v1_events_appointments_leads_yardi__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration lead_id: type: string description: The Propexo unique identifier for the lead unit_id: type: string description: The Propexo unique identifier for the unit employee_id: type: string description: The Propexo unique identifier for the employee appointment_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" appointment_time: type: string pattern: (?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d) description: The time when the appointment will occur. Please refer to our appointment times section in the docs to see how each individual PMS handles timezones notes: type: - string - "null" maxLength: 256 description: Notes associated with the event required: - integration_id - lead_id - unit_id - employee_id - appointment_date - appointment_time - notes required: - meta - result _v1_events_appointments_leads_yardi_{event_id}_put_input: type: object properties: appointment_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date when the appointment will occur appointment_time: type: string pattern: (?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d) description: The time when the appointment will occur. Please refer to our appointment times section in the docs to see how each individual PMS handles timezones required: - appointment_date - appointment_time _v1_events_appointments_leads_yardi_{event_id}_put_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: event_id: type: string description: The Propexo unique identifier for the event appointment_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date when the appointment will occur appointment_time: type: string pattern: (?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d) description: The time when the appointment will occur. Please refer to our appointment times section in the docs to see how each individual PMS handles timezones required: - event_id - appointment_date - appointment_time required: - meta - result _v1_events_appointments_leads_mri__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration lead_id: type: string description: The Propexo unique identifier for the lead appointment_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date when the appointment will occur appointment_time: type: string pattern: (?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d) description: The time when the appointment will occur. Please refer to our appointment times section in the docs to see how each individual PMS handles timezones employee_id: type: string description: The Propexo unique identifier for the employee. Must have a role of LEASING_AGENT status: type: string enum: *a101 description: The raw status associated with the event notes: type: string description: Notes associated with the event required: - integration_id - lead_id - appointment_date _v1_events_appointments_leads_mri__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration lead_id: type: string description: The Propexo unique identifier for the lead appointment_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" appointment_time: type: - string - "null" pattern: (?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d) description: The time when the appointment will occur. Please refer to our appointment times section in the docs to see how each individual PMS handles timezones employee_id: type: - string - "null" description: The Propexo unique identifier for the employee. Must have a role of LEASING_AGENT status: type: - string - "null" enum: *a101 description: The raw status associated with the event notes: type: - string - "null" description: Notes associated with the event required: - integration_id - lead_id - appointment_date - appointment_time - employee_id - status - notes required: - meta - result _v1_events_appointments_leads_mri_{event_id}_put_input: type: object properties: appointment_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date when the appointment will occur appointment_time: type: string pattern: (?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d) description: The time when the appointment will occur. Please refer to our appointment times section in the docs to see how each individual PMS handles timezones employee_id: type: string description: The Propexo unique identifier for the employee. Must have a role of LEASING_AGENT status: type: string enum: *a102 description: The raw status associated with the event notes: type: string description: Notes associated with the event required: - appointment_date _v1_events_appointments_leads_mri_{event_id}_put_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: event_id: type: string description: The Propexo unique identifier for the event appointment_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date when the appointment will occur appointment_time: type: string pattern: (?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d) description: The time when the appointment will occur. Please refer to our appointment times section in the docs to see how each individual PMS handles timezones employee_id: type: string description: The Propexo unique identifier for the employee. Must have a role of LEASING_AGENT status: type: string enum: *a102 description: The raw status associated with the event notes: type: string description: Notes associated with the event required: - event_id - appointment_date required: - meta - result _v1_events_appointments_residents_cancel_rentmanager_post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration event_id: type: string description: The Propexo unique identifier for the event required: - integration_id - event_id _v1_events_appointments_residents_cancel_rentmanager_post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration event_id: type: string description: The Propexo unique identifier for the event required: - integration_id - event_id required: - meta - result _v1_events_appointments_residents_rentmanager__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration resident_id: type: string description: The Propexo unique identifier for the resident employee_id: type: string description: The Propexo unique identifier for the employee appointment_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date when the appointment will occur appointment_time: type: string pattern: (?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d) description: The time when the appointment will occur. Please refer to our appointment times section in the docs to see how each individual PMS handles timezones. The time is in the local time of the property/location. In Rent Manager, the default timezone is an optional setting that the PMC can set and will be stored on the Propexo Timezone model. You may need to read in this setting and convert to the local timezone for the appointment time to be correct. appointment_duration_minutes: type: integer exclusiveMinimum: 0 description: The duration of the appointment, in minutes title: type: string maxLength: 50 description: The title associated with the event notes: type: string description: Notes associated with the event required: - integration_id - resident_id - appointment_date - appointment_time - appointment_duration_minutes - title _v1_events_appointments_residents_rentmanager__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration resident_id: type: string description: The Propexo unique identifier for the resident employee_id: type: - string - "null" description: The Propexo unique identifier for the employee appointment_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" appointment_time: type: string pattern: (?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d) description: The time when the appointment will occur. Please refer to our appointment times section in the docs to see how each individual PMS handles timezones. The time is in the local time of the property/location. In Rent Manager, the default timezone is an optional setting that the PMC can set and will be stored on the Propexo Timezone model. You may need to read in this setting and convert to the local timezone for the appointment time to be correct. appointment_duration_minutes: type: integer exclusiveMinimum: 0 description: The duration of the appointment, in minutes title: type: string maxLength: 50 description: The title associated with the event notes: type: - string - "null" description: Notes associated with the event required: - integration_id - resident_id - employee_id - appointment_date - appointment_time - appointment_duration_minutes - title - notes required: - meta - result _v1_events_appointments_residents_rentmanager_{event_id}_put_input: type: object properties: appointment_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date when the appointment will occur appointment_time: type: string pattern: (?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d) description: The time when the appointment will occur. Please refer to our appointment times section in the docs to see how each individual PMS handles timezones. The time is in the local time of the property/location. In Rent Manager, the default timezone is an optional setting that the PMC can set and will be stored on the Propexo Timezone model. You may need to read in this setting and convert to the local timezone for the appointment time to be correct. appointment_duration_minutes: type: integer exclusiveMinimum: 0 description: The duration of the appointment, in minutes title: type: string maxLength: 50 description: The title associated with the event notes: type: string description: Notes associated with the event required: - appointment_date - appointment_time - appointment_duration_minutes - title _v1_events_appointments_residents_rentmanager_{event_id}_put_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: event_id: type: string description: The Propexo unique identifier for the event appointment_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date when the appointment will occur appointment_time: type: string pattern: (?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d) description: The time when the appointment will occur. Please refer to our appointment times section in the docs to see how each individual PMS handles timezones. The time is in the local time of the property/location. In Rent Manager, the default timezone is an optional setting that the PMC can set and will be stored on the Propexo Timezone model. You may need to read in this setting and convert to the local timezone for the appointment time to be correct. appointment_duration_minutes: type: integer exclusiveMinimum: 0 description: The duration of the appointment, in minutes title: type: string maxLength: 50 description: The title associated with the event notes: type: string description: Notes associated with the event required: - event_id - appointment_date - appointment_time - appointment_duration_minutes - title required: - meta - result _v1_events_appointments_residents_mri__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration resident_id: type: string description: The Propexo unique identifier for the resident appointment_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date when the appointment will occur appointment_time: type: string pattern: (?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d) description: The time when the appointment will occur. Please refer to our appointment times section in the docs to see how each individual PMS handles timezones employee_id: type: string description: The Propexo unique identifier for the employee. Must have a role of LEASING_AGENT status: type: string enum: *a103 description: The raw status associated with the event notes: type: string description: Notes associated with the event required: - integration_id - resident_id - appointment_date _v1_events_appointments_residents_mri__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration resident_id: type: string description: The Propexo unique identifier for the resident appointment_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" appointment_time: type: - string - "null" pattern: (?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d) description: The time when the appointment will occur. Please refer to our appointment times section in the docs to see how each individual PMS handles timezones employee_id: type: - string - "null" description: The Propexo unique identifier for the employee. Must have a role of LEASING_AGENT status: type: - string - "null" enum: *a103 description: The raw status associated with the event notes: type: - string - "null" description: Notes associated with the event required: - integration_id - resident_id - appointment_date - appointment_time - employee_id - status - notes required: - meta - result _v1_events_appointments_residents_mri_{event_id}_put_input: type: object properties: appointment_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date when the appointment will occur appointment_time: type: string pattern: (?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d) description: The time when the appointment will occur. Please refer to our appointment times section in the docs to see how each individual PMS handles timezones employee_id: type: string description: The Propexo unique identifier for the employee. Must have a role of LEASING_AGENT status: type: string enum: *a104 description: The raw status associated with the event notes: type: string description: Notes associated with the event required: - appointment_date _v1_events_appointments_residents_mri_{event_id}_put_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: event_id: type: string description: The Propexo unique identifier for the event appointment_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date when the appointment will occur appointment_time: type: string pattern: (?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d) description: The time when the appointment will occur. Please refer to our appointment times section in the docs to see how each individual PMS handles timezones employee_id: type: string description: The Propexo unique identifier for the employee. Must have a role of LEASING_AGENT status: type: string enum: *a104 description: The raw status associated with the event notes: type: string description: Notes associated with the event required: - event_id - appointment_date required: - meta - result _v1_charge-codes__get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query property_id: type: string description: The Propexo unique identifier for the property integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" ChargeCode: type: object properties: id: type: string description: The Propexo unique identifier for the charge code created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. debit_gl_account: type: - string - "null" description: The GL account number for debits credit_gl_account: type: - string - "null" description: The GL account number for credits name: type: - string - "null" description: The name of the charge code description: type: - string - "null" description: A description of this charge code custom_data: type: - object - "null" properties: {} property_id: type: string description: The Propexo unique identifier for the property integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" required: - id - created_at - updated_at - last_seen - x_id - x_property_id - x_location_id - debit_gl_account - credit_gl_account - name - description - custom_data - property_id - integration_id - integration_vendor x-propexo: derivedFromModel: charge_codes _v1_charge-codes__get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: type: array items: $ref: "#/components/schemas/ChargeCode" required: - meta - results _v1_charge-codes_{charge_code_id}_get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query _v1_charge-codes_{charge_code_id}_get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: $ref: "#/components/schemas/ChargeCode" required: - meta - results _v1_financial-accounts__get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query property_id: type: string description: The Propexo unique identifier for the property integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" account_number: type: string description: The account number associated with the financial account FinancialAccount: type: object properties: id: type: string description: The Propexo unique identifier for the financial account created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: type: - string - "null" description: The name of the financial account status_raw: type: - string - "null" description: The raw status associated with the financial account account_number: type: - string - "null" description: The account number associated with the financial account custom_data: type: - object - "null" properties: {} property_id: type: string description: The Propexo unique identifier for the property integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" required: - id - created_at - updated_at - last_seen - x_id - x_property_id - x_location_id - name - status_raw - account_number - custom_data - property_id - integration_id - integration_vendor x-propexo: derivedFromModel: financial_accounts _v1_financial-accounts__get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: type: array items: $ref: "#/components/schemas/FinancialAccount" required: - meta - results _v1_financial-accounts_{financial_account_id}_get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query _v1_financial-accounts_{financial_account_id}_get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: $ref: "#/components/schemas/FinancialAccount" required: - meta - results _v1_resident-charges__get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query property_id: type: string description: The Propexo unique identifier for the property integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" resident_id: type: string description: The Propexo unique identifier for the resident lease_id: type: string description: The Propexo unique identifier for the lease transaction_date_start: type: - string - "null" description: The start of the transaction date range to search. Inclusive. transaction_date_end: type: - string - "null" description: The end of the transaction date range to search. Inclusive. ResidentCharge: type: object properties: id: type: string description: The Propexo unique identifier for the resident charge created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_gl_account_id: type: - string - "null" description: The external ID of the general ledger account from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_lease_id: type: - string - "null" description: The external ID of the lease from the integration vendor x_resident_id: type: - string - "null" description: The external ID of the resident from the integration vendor x_unit_id: type: - string - "null" description: The external ID of the unit from the integration vendor x_charge_code_id: type: - string - "null" description: The external ID of the charge code from the integration vendor amount_in_cents: type: &a346 - number - "null" description: The amount of the resident charge, in cents example: 100000 amount_raw: type: - string - "null" description: The raw value for amount from the PMS amount_open_in_cents: type: &a347 - number - "null" description: The amount open on the resident charge, in cents example: 100000 amount_open_raw: type: - string - "null" description: The raw value for open amount from the PMS amount_paid_in_cents: type: &a348 - number - "null" description: The amount paid on the resident charge, in cents example: 100000 amount_paid_raw: type: - string - "null" description: The raw value for amount paid from the PMS due_date: type: - string - "null" description: The due date associated with the resident charge name: type: - string - "null" description: The name associated with the resident charge description: type: - string - "null" description: Description of the resident charge reference_number: type: - string - "null" description: The reference number for the resident charge transaction_date: type: - string - "null" description: The transaction date of the resident charge transaction_source: type: - string - "null" description: The transaction source of the resident charge is_open: type: - boolean - "null" description: Whether the resident charge is open and not yet settled post_month: type: - string - "null" pattern: ^\d{4}-(?:0[1-9]|1[0-2])$ description: The post month for the resident charge custom_data: type: - object - "null" properties: {} integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" property_id: type: string description: The Propexo unique identifier for the property resident_id: type: - string - "null" description: The Propexo unique identifier for the resident financial_account_id: type: - string - "null" description: The Propexo unique identifier for the financial account unit_id: type: - string - "null" description: The Propexo unique identifier for the unit lease_id: type: - string - "null" description: The Propexo unique identifier for the lease charge_code_id: type: - string - "null" description: The Propexo unique identifier for the charge code allocations: type: array items: type: object properties: id: type: string description: The Propexo unique identifier for the resident allocation x_id: type: string description: The external ID from the integration vendor x_source_id: type: - string - "null" description: The external ID of the source transaction from the integration vendor x_destination_id: type: - string - "null" description: The external ID of the destination transaction from the integration vendor financial_account_id: type: - string - "null" description: The Propexo unique identifier for the financial account amount_in_cents: type: &a105 - number - "null" description: The amount of the resident allocation, in cents example: 100000 amount_raw: type: - string - "null" description: The raw value for amount from the PMS resident_charge_id: type: - string - "null" description: The Propexo unique identifier for the resident charge resident_payment_id: type: - string - "null" description: The Propexo unique identifier for the resident payment created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS custom_data: type: - object - "null" properties: {} required: - id - x_id - x_source_id - x_destination_id - financial_account_id - amount_in_cents - amount_raw - resident_charge_id - resident_payment_id - created_at - updated_at - last_seen - custom_data required: - id - created_at - updated_at - last_seen - x_id - x_property_id - x_gl_account_id - x_location_id - x_lease_id - x_resident_id - x_unit_id - x_charge_code_id - amount_in_cents - amount_raw - amount_open_in_cents - amount_open_raw - amount_paid_in_cents - amount_paid_raw - due_date - name - description - reference_number - transaction_date - transaction_source - is_open - post_month - custom_data - integration_id - integration_vendor - property_id - resident_id - financial_account_id - unit_id - lease_id - charge_code_id - allocations x-propexo: derivedFromModel: resident_charges _v1_resident-charges__get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: type: array items: $ref: "#/components/schemas/ResidentCharge" required: - meta - results _v1_resident-charges__post_input: type: object properties: integration_id: type: string lease_id: type: string description: The Propexo unique identifier for the lease financial_account_id: type: string description: The Propexo unique identifier for the financial account amount_in_cents: type: integer description: The amount of the resident charge, in cents transaction_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The transaction date of the resident charge description: type: string description: Description of the resident charge reference_number: type: string description: The reference number for the resident charge charge_code_id: type: string description: The Propexo ID for the charge code associated with this new charge post_month: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The post month for the resident charge. The timestamp and day will be stripped off and only the month and year will be used third_party_charge_id: type: string description: A unique value provided to Entrata to uniquely identify the transaction from your system. This can be an alphanumeric string. This does not become the ID of the transaction in Entrata. If not provided, Propexo will generate one is_approval_required: type: boolean description: Whether or not the resident charge requires approval. This will require the charge be approved first before being posted to the ledger property_id: type: string description: The Propexo unique identifier for the property resident_id: type: string description: The Propexo unique identifier for the resident transaction_batch_id: type: string description: A unique value provided by Realpage to associate a charge with a batch. This can be an alphanumeric string. notes: type: string description: Notes associated with the resident charge batch_id: type: string description: An identifier for the transaction batch. This should be unique to your system. unit_id: type: string description: The Propexo unique identifier for the unit required: - integration_id _v1_resident-charges__post_output: type: object properties: job_id: type: string description: The ID of the job created to handle this operation data: type: object properties: {} required: - job_id - data _v1_resident-charges_{resident_charge_id}_get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query _v1_resident-charges_{resident_charge_id}_get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: $ref: "#/components/schemas/ResidentCharge" required: - meta - results _v1_resident-credits__post_input: type: object properties: integration_id: type: string lease_id: type: string description: The Propexo unique identifier for the lease amount_in_cents: type: integer exclusiveMinimum: 0 description: The amount of the resident credit, in cents transaction_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The transaction date of the resident credit description: type: string description: Description of the resident credit reference_number: type: string description: The reference number for the resident charge resident_id: type: string description: The Propexo unique identifier for the resident charge_code_id: type: string description: The Propexo unique identifier for the charge code notes: type: string description: Notes associated with the resident charge financial_account_id: type: string description: The Propexo unique identifier for the financial account required: - integration_id _v1_resident-credits__post_output: type: object properties: job_id: type: string description: The ID of the job created to handle this operation data: type: object properties: {} required: - job_id - data _v1_recurring-resident-charges__get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query location_id: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. property_id: type: string description: The Propexo unique identifier for the property lease_id: type: string description: The Propexo unique identifier for the lease integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" RecurringResidentCharge: type: object properties: id: type: string description: The Propexo unique identifier for the recurring resident charge created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_charge_code_id: type: - string - "null" description: The external ID of the charge code from the integration vendor x_financial_account_id: type: - string - "null" description: The external ID of the financial account from the integration vendor x_lease_id: type: - string - "null" description: The external ID of the lease from the integration vendor amount_in_cents: type: &a344 - number - "null" description: The total amount of the recurring resident charge example: 100000 amount_raw: type: - string - "null" description: The raw value for amount from the PMS is_active: type: - boolean - "null" description: Whether the recurring resident charge is active description: type: - string - "null" description: Description of the recurring resident charge reference_number: type: - string - "null" description: The reference number for the recurring resident charge start_date: type: - string - "null" description: The start date associated with the recurring resident charge end_date: type: - string - "null" description: The end date associated with the recurring resident charge frequency_raw: type: - string - "null" description: The raw value of the frequency of the recurring resident charge frequency_normalized: type: - string - "null" enum: - OTHER - WEEKLY - MONTHLY - DAILY description: The frequency of the recurring resident charge charge_due_day: type: - integer - "null" minimum: 0 description: The due date associated with the recurring resident charge custom_data: type: - object - "null" properties: {} financial_account_id: type: - string - "null" description: The Propexo unique identifier for the financial account lease_id: type: - string - "null" description: The Propexo unique identifier for the lease charge_code_id: type: - string - "null" description: The Propexo unique identifier for the charge code integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" property_id: type: string description: The Propexo unique identifier for the property required: - id - created_at - updated_at - last_seen - x_id - x_property_id - x_location_id - x_charge_code_id - x_financial_account_id - x_lease_id - amount_in_cents - amount_raw - is_active - description - reference_number - start_date - end_date - frequency_raw - frequency_normalized - charge_due_day - custom_data - financial_account_id - lease_id - charge_code_id - integration_id - integration_vendor - property_id x-propexo: derivedFromModel: recurring_resident_charges _v1_recurring-resident-charges__get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: type: array items: $ref: "#/components/schemas/RecurringResidentCharge" required: - meta - results _v1_recurring-resident-charges__post_input: type: object properties: integration_id: type: string lease_id: type: string description: The Propexo unique identifier for the lease resident_id: type: string description: The Propexo unique identifier for the resident charge_code_id: type: string description: The Propexo unique identifier for the charge code amount_in_cents: type: integer exclusiveMinimum: 0 description: The amount of the recurring resident charge, in cents start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The start date associated with the recurring resident charge description: type: string description: Description of the recurring resident charge end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The end date associated with the recurring resident charge month_to_month_amount_in_cents: type: integer exclusiveMinimum: 0 description: The month-to-month amount for the recurring charge in cents month_to_month_fee_in_cents: type: integer exclusiveMinimum: 0 description: The month-to-month fee for the recurring charge in cents last_posted_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The last date the charge was posted. Format will be converted to MM/DD/YYYY for Entrata charge_timing_id: type: string description: The propexo charge timing ID that defines when the charge should be applied charge_code_type_id: type: string description: The propexo charge code type ID financial_account_id: type: string description: The Propexo unique identifier for the financial account is_active: type: boolean description: Whether the recurring resident charge is active charge_due_day: type: integer minimum: 1 maximum: 31 description: The day of the month the charge is due. When frequency_normalized is set to 'WEEKLY', the charge_due_day must be between 1 and 7 frequency_normalized: type: string enum: &a111 - DAILY - MONTHLY - WEEKLY description: The frequency of the recurring resident charge reference_number: type: string description: The reference number for the recurring resident charge day_due: type: integer exclusiveMinimum: 0 minimum: 1 maximum: 31 description: The day of the month the charge is due frequency_raw: type: integer exclusiveMinimum: 0 minimum: 1 maximum: 24 description: The raw value of the frequency of the recurring resident charge (in months) required: - integration_id _v1_recurring-resident-charges__post_output: type: object properties: job_id: type: string description: The ID of the job created to handle this operation data: type: object properties: {} required: - job_id - data _v1_recurring-resident-charges_{recurring_resident_charge_id}_get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query _v1_recurring-resident-charges_{recurring_resident_charge_id}_get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: $ref: "#/components/schemas/RecurringResidentCharge" required: - meta - results _v1_recurring-resident-charges_{recurring_resident_charge_id}_put_input: type: object properties: financial_account_id: type: string description: The Propexo unique identifier for the financial account is_active: type: boolean description: Whether the recurring resident charge is active amount_in_cents: type: integer exclusiveMinimum: 0 description: The amount of the resident charge, in cents description: type: string description: Description of the recurring resident charge charge_due_day: type: integer minimum: 1 maximum: 31 description: The day of the month the charge is due start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The start date associated with the recurring resident charge. Required if frequency is DAILY or WEEKLY frequency_normalized: type: string enum: &a112 - DAILY - MONTHLY - WEEKLY description: The frequency of the recurring resident charge end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The end date associated with the recurring resident charge reference_number: type: string description: The reference number for the recurring resident charge charge_code_id: type: string description: The Propexo unique identifier for the charge code _v1_recurring-resident-charges_{recurring_resident_charge_id}_put_output: type: object properties: job_id: type: string description: The ID of the job created to handle this operation data: type: object properties: {} required: - job_id - data _v1_resident-payments__get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query property_id: type: string description: The Propexo unique identifier for the property integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" resident_id: type: string description: The Propexo unique identifier for the resident lease_id: type: string description: The Propexo unique identifier for the lease transaction_date_start: type: - string - "null" description: The start of the transaction date range to search. Inclusive. transaction_date_end: type: - string - "null" description: The end of the transaction date range to search. Inclusive. _v1_resident-payments__get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: type: array items: type: object properties: id: type: string description: The Propexo unique identifier for the resident payment created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_gl_account_id: type: - string - "null" description: The external ID of the general ledger account from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_lease_id: type: - string - "null" description: The external ID of the lease from the integration vendor x_resident_id: type: - string - "null" description: The external ID of the resident from the integration vendor x_unit_id: type: - string - "null" description: The external ID of the unit from the integration vendor x_charge_code_id: type: - string - "null" description: The external ID of the charge code from the integration vendor payment_method_normalized: type: - string - "null" description: The normalized method of payment for the resident payment payment_method_raw: type: - string - "null" description: The raw method of payment for the resident payment amount_in_cents: type: &a106 - number - "null" description: The amount of the resident payment, in cents example: 100000 amount_raw: type: - string - "null" description: The raw value for amount from the PMS name: type: - string - "null" description: The name associated with the resident payment description: type: - string - "null" description: Description of the resident payment reference_number: type: - string - "null" description: The reference number for the resident payment transaction_date: type: - string - "null" description: The transaction date of the resident payment is_open: type: - boolean - "null" description: Whether the resident payment is open and not yet settled post_month: type: - string - "null" pattern: ^\d{4}-(?:0[1-9]|1[0-2])$ description: The post month for the resident payment custom_data: type: - object - "null" properties: {} integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" property_id: type: string description: The Propexo unique identifier for the property resident_id: type: - string - "null" description: The Propexo unique identifier for the resident financial_account_id: type: - string - "null" description: The Propexo unique identifier for the financial account unit_id: type: - string - "null" description: The Propexo unique identifier for the unit lease_id: type: - string - "null" description: The Propexo unique identifier for the lease charge_code_id: type: - string - "null" description: The Propexo unique identifier for the charge code allocations: type: array items: type: object properties: id: type: string description: The Propexo unique identifier for the resident allocation x_id: type: string description: The external ID from the integration vendor x_source_id: type: - string - "null" description: The external ID of the source transaction from the integration vendor x_destination_id: type: - string - "null" description: The external ID of the destination transaction from the integration vendor financial_account_id: type: - string - "null" description: The Propexo unique identifier for the financial account amount_in_cents: type: *a105 description: The amount of the resident allocation, in cents example: 100000 amount_raw: type: - string - "null" description: The raw value for amount from the PMS resident_charge_id: type: - string - "null" description: The Propexo unique identifier for the resident charge resident_payment_id: type: - string - "null" description: The Propexo unique identifier for the resident payment created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS custom_data: type: - object - "null" properties: {} required: - id - x_id - x_source_id - x_destination_id - financial_account_id - amount_in_cents - amount_raw - resident_charge_id - resident_payment_id - created_at - updated_at - last_seen - custom_data required: - id - created_at - updated_at - last_seen - x_id - x_property_id - x_gl_account_id - x_location_id - x_lease_id - x_resident_id - x_unit_id - x_charge_code_id - payment_method_normalized - payment_method_raw - amount_in_cents - amount_raw - name - description - reference_number - transaction_date - is_open - post_month - custom_data - integration_id - integration_vendor - property_id - resident_id - financial_account_id - unit_id - lease_id - charge_code_id - allocations x-propexo: &a107 derivedFromModel: resident_payments required: - meta - results _v1_resident-payments__post_input: type: object properties: integration_id: type: string lease_id: type: string description: The Propexo unique identifier for the lease financial_account_id: type: string description: The Propexo unique identifier for the financial account resident_id: type: string description: The Propexo unique identifier for the resident transaction_date: type: string format: date-time description: The transaction date of the resident payment amount_in_cents: type: integer description: The amount of the resident payment, in cents payment_type: type: string enum: &a114 - ACH - Cash - Cashiers Check - Check - Credit Card - Debit Card - eCheck - Money Order description: The method of payment send_email_receipt: type: boolean description: Indicates whether the payee would like to have a receipt emailed description: type: string description: Description of the resident payment reference_number: type: string description: The reference number for the resident payment charge_code_id: type: string description: The Propexo unique identifier for the charge code notes: type: string description: Notes associated with the resident payment allocate_prepays: type: boolean description: Whether to allocate prepays to the resident payment. This is a flag passed directly to Rent Manager batch_id: type: string description: An identifier for the transaction batch. This should be unique to your system. property_id: type: string description: The Propexo unique identifier for the property unit_id: type: string description: The Propexo unique identifier for the unit required: - integration_id _v1_resident-payments__post_output: type: object properties: job_id: type: string description: The ID of the job created to handle this operation data: type: object properties: {} required: - job_id - data _v1_resident-payments_{resident_payment_id}_get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query _v1_resident-payments_{resident_payment_id}_get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: type: object properties: id: type: string description: The Propexo unique identifier for the resident payment created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_gl_account_id: type: - string - "null" description: The external ID of the general ledger account from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_lease_id: type: - string - "null" description: The external ID of the lease from the integration vendor x_resident_id: type: - string - "null" description: The external ID of the resident from the integration vendor x_unit_id: type: - string - "null" description: The external ID of the unit from the integration vendor x_charge_code_id: type: - string - "null" description: The external ID of the charge code from the integration vendor payment_method_normalized: type: - string - "null" description: The normalized method of payment for the resident payment payment_method_raw: type: - string - "null" description: The raw method of payment for the resident payment amount_in_cents: type: *a106 description: The amount of the resident payment, in cents example: 100000 amount_raw: type: - string - "null" description: The raw value for amount from the PMS name: type: - string - "null" description: The name associated with the resident payment description: type: - string - "null" description: Description of the resident payment reference_number: type: - string - "null" description: The reference number for the resident payment transaction_date: type: - string - "null" description: The transaction date of the resident payment is_open: type: - boolean - "null" description: Whether the resident payment is open and not yet settled post_month: type: - string - "null" pattern: ^\d{4}-(?:0[1-9]|1[0-2])$ description: The post month for the resident payment custom_data: type: - object - "null" properties: {} integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" property_id: type: string description: The Propexo unique identifier for the property resident_id: type: - string - "null" description: The Propexo unique identifier for the resident financial_account_id: type: - string - "null" description: The Propexo unique identifier for the financial account unit_id: type: - string - "null" description: The Propexo unique identifier for the unit lease_id: type: - string - "null" description: The Propexo unique identifier for the lease charge_code_id: type: - string - "null" description: The Propexo unique identifier for the charge code allocations: type: array items: type: object properties: id: type: string description: The Propexo unique identifier for the resident allocation x_id: type: string description: The external ID from the integration vendor x_source_id: type: - string - "null" description: The external ID of the source transaction from the integration vendor x_destination_id: type: - string - "null" description: The external ID of the destination transaction from the integration vendor financial_account_id: type: - string - "null" description: The Propexo unique identifier for the financial account amount_in_cents: type: *a105 description: The amount of the resident allocation, in cents example: 100000 amount_raw: type: - string - "null" description: The raw value for amount from the PMS resident_charge_id: type: - string - "null" description: The Propexo unique identifier for the resident charge resident_payment_id: type: - string - "null" description: The Propexo unique identifier for the resident payment created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS custom_data: type: - object - "null" properties: {} required: - id - x_id - x_source_id - x_destination_id - financial_account_id - amount_in_cents - amount_raw - resident_charge_id - resident_payment_id - created_at - updated_at - last_seen - custom_data required: - id - created_at - updated_at - last_seen - x_id - x_property_id - x_gl_account_id - x_location_id - x_lease_id - x_resident_id - x_unit_id - x_charge_code_id - payment_method_normalized - payment_method_raw - amount_in_cents - amount_raw - name - description - reference_number - transaction_date - is_open - post_month - custom_data - integration_id - integration_vendor - property_id - resident_id - financial_account_id - unit_id - lease_id - charge_code_id - allocations x-propexo: *a107 required: - meta - results _v1_fees__get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query integration_id: type: string description: The Propexo unique identifier for the integration property_id: type: string description: The Propexo unique identifier for the property floor_plan_id: type: string description: The Propexo unique identifier for the floor plan unit_id: type: string description: The Propexo unique identifier for the unit charge_code_id: type: string description: The Propexo unique identifier for the charge code Fee: type: object properties: id: type: string description: The Propexo unique identifier for the fee created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_charge_code_id: type: - string - "null" description: The external ID of the charge code from the integration vendor x_floor_plan_id: type: - string - "null" description: The external ID of the floor plan from the integration vendor x_unit_id: type: - string - "null" description: The external ID of the unit from the integration vendor amount_in_cents: type: &a307 - number - "null" description: The amount of the fee, in cents example: 12500 amount_raw: type: - string - "null" description: The raw value for amount from the PMS charge_code_name: type: - string - "null" description: The name of the charge code description: type: - string - "null" description: Description of the fee name: type: - string - "null" description: The name associated with the fee custom_data: type: - object - "null" additionalProperties: {} description: Custom data integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" property_id: type: string description: The Propexo unique identifier for the property floor_plan_id: type: - string - "null" description: The Propexo unique identifier for the floor plan unit_id: type: - string - "null" description: The Propexo unique identifier for the unit charge_code_id: type: - string - "null" description: The Propexo unique identifier for the charge code required: - id - created_at - updated_at - last_seen - x_id - x_property_id - x_location_id - x_charge_code_id - x_floor_plan_id - x_unit_id - amount_in_cents - amount_raw - charge_code_name - description - name - custom_data - integration_id - integration_vendor - property_id - floor_plan_id - unit_id - charge_code_id x-propexo: derivedFromModel: fees _v1_fees__get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: type: array items: $ref: "#/components/schemas/Fee" required: - meta - results _v1_fees_{fee_id}_get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query _v1_fees_{fee_id}_get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: $ref: "#/components/schemas/Fee" required: - meta - results _v1_resident-charges_appfolio__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration lease_id: type: string description: The Propexo unique identifier for the lease financial_account_id: type: string description: The Propexo unique identifier for the financial account amount_in_cents: type: integer description: The amount of the resident charge, in cents transaction_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The transaction date of the resident charge description: type: string description: Description of the resident charge required: - integration_id - lease_id - financial_account_id - amount_in_cents - transaction_date - description _v1_resident-charges_appfolio__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration lease_id: type: string description: The Propexo unique identifier for the lease financial_account_id: type: string description: The Propexo unique identifier for the financial account amount_in_cents: type: integer description: The amount of the resident charge, in cents transaction_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" description: type: string description: Description of the resident charge required: - integration_id - lease_id - financial_account_id - amount_in_cents - transaction_date - description required: - meta - result _v1_resident-charges_buildium__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration lease_id: type: string description: The Propexo unique identifier for the lease financial_account_id: type: string description: The Propexo unique identifier for the financial account amount_in_cents: type: integer description: The amount of the resident charge, in cents reference_number: type: string description: The reference number for the resident charge transaction_date: type: string format: date-time description: The transaction date of the resident charge description: type: string description: Description of the resident charge required: - integration_id - lease_id - financial_account_id - amount_in_cents - transaction_date _v1_resident-charges_buildium__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration lease_id: type: string description: The Propexo unique identifier for the lease financial_account_id: type: string description: The Propexo unique identifier for the financial account amount_in_cents: type: integer description: The amount of the resident charge, in cents reference_number: type: - string - "null" description: The reference number for the resident charge transaction_date: type: string format: date-time description: The transaction date of the resident charge description: type: - string - "null" description: Description of the resident charge required: - integration_id - lease_id - financial_account_id - amount_in_cents - reference_number - transaction_date - description required: - meta - result _v1_resident-charges_entrata__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration lease_id: type: string description: The Propexo unique identifier for the lease charge_code_id: type: string description: The Propexo unique identifier for the charge code transaction_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The transaction date of the resident charge. The timestamp will be stripped off and only the date will be used post_month: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The post month for the resident charge. The timestamp and day will be stripped off and only the month and year will be used amount_in_cents: type: integer description: The amount of the resident charge, in cents. A positive charge represents an increase of money owed. A negative charge represents a reduction of money owed description: type: string description: Description of the resident charge third_party_charge_id: type: string description: A unique value provided to Entrata to uniquely identify the transaction from your system. This can be an alphanumeric string. This does not become the ID of the transaction in Entrata. If not provided, Propexo will generate one is_approval_required: type: boolean description: Whether or not the resident charge requires approval. This will require the charge be approved first before being posted to the ledger required: - integration_id - lease_id - charge_code_id - transaction_date - amount_in_cents - description _v1_resident-charges_entrata__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration lease_id: type: string description: The Propexo unique identifier for the lease charge_code_id: type: string description: The Propexo unique identifier for the charge code transaction_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" post_month: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" description: The post month for the resident charge. The timestamp and day will be stripped off and only the month and year will be used amount_in_cents: type: integer description: The amount of the resident charge, in cents. A positive charge represents an increase of money owed. A negative charge represents a reduction of money owed description: type: string description: Description of the resident charge third_party_charge_id: type: - string - "null" description: A unique value provided to Entrata to uniquely identify the transaction from your system. This can be an alphanumeric string. This does not become the ID of the transaction in Entrata. If not provided, Propexo will generate one is_approval_required: type: - boolean - "null" description: Whether or not the resident charge requires approval. This will require the charge be approved first before being posted to the ledger required: - integration_id - lease_id - charge_code_id - transaction_date - post_month - amount_in_cents - description - third_party_charge_id - is_approval_required required: - meta - result _v1_resident-charges_realpage_rpx__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration property_id: type: string description: The Propexo unique identifier for the property resident_id: type: string description: The Propexo unique identifier for the resident charge_code_id: type: string description: The Propexo charge code to associate with this new charge transaction_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The transaction date of the resident charge. The timestamp will be stripped off and only the date will be used amount_in_cents: type: integer description: The amount of the resident charge, in cents description: type: string description: Description of the resident charge reference_number: type: string description: The reference number for the resident charge transaction_batch_id: type: string description: A unique value provided by Realpage to associate a charge with a batch. This can be an alphanumeric string. required: - integration_id - property_id - resident_id - charge_code_id - transaction_date - amount_in_cents - description - transaction_batch_id _v1_resident-charges_realpage_rpx__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration property_id: type: string description: The Propexo unique identifier for the property resident_id: type: string description: The Propexo unique identifier for the resident charge_code_id: type: string description: The Propexo charge code to associate with this new charge transaction_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" amount_in_cents: type: integer description: The amount of the resident charge, in cents description: type: string description: Description of the resident charge reference_number: type: - string - "null" description: The reference number for the resident charge transaction_batch_id: type: string description: A unique value provided by Realpage to associate a charge with a batch. This can be an alphanumeric string. required: - integration_id - property_id - resident_id - charge_code_id - transaction_date - amount_in_cents - description - reference_number - transaction_batch_id required: - meta - result _v1_resident-charges_rentmanager__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration resident_id: type: string description: The Propexo unique identifier for the resident charge_code_id: type: string description: The Propexo unique identifier for the charge code transaction_date: type: string format: date-time description: The transaction date of the resident charge notes: type: string description: Notes associated with the resident charge amount_in_cents: type: integer description: The amount of the resident charge, in cents reference_number: type: string description: The reference number for the resident charge required: - integration_id - resident_id - charge_code_id - transaction_date - notes - amount_in_cents - reference_number _v1_resident-charges_rentmanager__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration resident_id: type: string description: The Propexo unique identifier for the resident charge_code_id: type: string description: The Propexo unique identifier for the charge code transaction_date: type: string format: date-time description: The transaction date of the resident charge notes: type: string description: Notes associated with the resident charge amount_in_cents: type: integer description: The amount of the resident charge, in cents reference_number: type: string description: The reference number for the resident charge required: - integration_id - resident_id - charge_code_id - transaction_date - notes - amount_in_cents - reference_number required: - meta - result _v1_resident-charges_rentvine__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration lease_id: type: string description: The Propexo unique identifier for the lease financial_account_id: type: string description: The Propexo unique identifier for the financial account amount_in_cents: type: integer exclusiveMinimum: 0 description: The amount of the resident charge, in cents transaction_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The transaction date of the resident charge description: type: string description: Description of the resident charge required: - integration_id - lease_id - financial_account_id - amount_in_cents - transaction_date - description _v1_resident-charges_rentvine__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration lease_id: type: string description: The Propexo unique identifier for the lease financial_account_id: type: string description: The Propexo unique identifier for the financial account amount_in_cents: type: integer exclusiveMinimum: 0 description: The amount of the resident charge, in cents transaction_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" description: type: string description: Description of the resident charge required: - integration_id - lease_id - financial_account_id - amount_in_cents - transaction_date - description required: - meta - result _v1_resident-charges_yardi__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration property_id: type: string description: The Propexo unique identifier for the property resident_id: type: string description: The Propexo unique identifier for the resident unit_id: type: string description: The Propexo unique identifier for the unit financial_account_id: type: string description: The Propexo unique identifier for the financial account charge_code_id: type: string description: The Propexo ID for the charge code associated with this new charge transaction_date: type: string format: date-time description: The transaction date of the resident charge amount_in_cents: type: integer description: The amount of the resident charge, in cents description: type: string description: Description of the resident charge required: - integration_id - property_id - resident_id - unit_id - financial_account_id - charge_code_id - transaction_date - amount_in_cents _v1_resident-charges_yardi__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration property_id: type: string description: The Propexo unique identifier for the property resident_id: type: string description: The Propexo unique identifier for the resident unit_id: type: string description: The Propexo unique identifier for the unit financial_account_id: type: string description: The Propexo unique identifier for the financial account charge_code_id: type: string description: The Propexo ID for the charge code associated with this new charge transaction_date: type: string format: date-time description: The transaction date of the resident charge amount_in_cents: type: integer description: The amount of the resident charge, in cents description: type: - string - "null" description: Description of the resident charge required: - integration_id - property_id - resident_id - unit_id - financial_account_id - charge_code_id - transaction_date - amount_in_cents - description required: - meta - result _v1_resident-charges_yardi_rest__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration property_id: type: string description: The Propexo unique identifier for the property resident_id: type: string description: The Propexo unique identifier for the resident unit_id: type: string description: The Propexo unique identifier for the unit financial_account_id: type: string description: The Propexo unique identifier for the financial account charge_code_id: type: string description: The Propexo ID for the charge code associated with this new charge transaction_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The transaction date of the resident charge amount_in_cents: type: integer description: The amount of the resident charge, in cents description: type: string description: Description of the resident charge required: - integration_id - property_id - resident_id - unit_id - financial_account_id - charge_code_id - transaction_date - amount_in_cents _v1_resident-charges_yardi_rest__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration property_id: type: string description: The Propexo unique identifier for the property resident_id: type: string description: The Propexo unique identifier for the resident unit_id: type: string description: The Propexo unique identifier for the unit financial_account_id: type: string description: The Propexo unique identifier for the financial account charge_code_id: type: string description: The Propexo ID for the charge code associated with this new charge transaction_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" amount_in_cents: type: integer description: The amount of the resident charge, in cents description: type: - string - "null" description: Description of the resident charge required: - integration_id - property_id - resident_id - unit_id - financial_account_id - charge_code_id - transaction_date - amount_in_cents - description required: - meta - result _v1_resident-charges_resman__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration resident_id: type: string description: The Propexo unique identifier for the resident charge_code_id: type: string description: The Propexo unique identifier for the charge code batch_id: type: string description: An identifier for the transaction batch. This should be unique to your system. transaction_date: type: string format: date-time description: The transaction date of the resident charge description: type: string description: Description of the resident charge notes: type: string description: Notes associated with the resident charge amount_in_cents: type: integer description: The amount of the resident charge, in cents reference_number: type: string description: The reference number for the resident charge required: - integration_id - resident_id - charge_code_id - batch_id - transaction_date - description - notes - amount_in_cents - reference_number _v1_resident-charges_resman__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration resident_id: type: string description: The Propexo unique identifier for the resident charge_code_id: type: string description: The Propexo unique identifier for the charge code batch_id: type: string description: An identifier for the transaction batch. This should be unique to your system. transaction_date: type: string format: date-time description: The transaction date of the resident charge description: type: string description: Description of the resident charge notes: type: string description: Notes associated with the resident charge amount_in_cents: type: integer description: The amount of the resident charge, in cents reference_number: type: string description: The reference number for the resident charge required: - integration_id - resident_id - charge_code_id - batch_id - transaction_date - description - notes - amount_in_cents - reference_number required: - meta - result _v1_resident-charges_propertyware__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration lease_id: type: string description: The Propexo unique identifier for the lease financial_account_id: type: string description: The Propexo unique identifier for the financial account amount_in_cents: type: integer description: The amount of the resident charge, in cents transaction_date: type: string format: date-time description: The transaction date of the resident charge description: type: string description: Description of the resident charge reference_number: type: string description: The reference number for the resident charge required: - integration_id - lease_id - financial_account_id - amount_in_cents _v1_resident-charges_propertyware__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration lease_id: type: string description: The Propexo unique identifier for the lease financial_account_id: type: string description: The Propexo unique identifier for the financial account amount_in_cents: type: integer description: The amount of the resident charge, in cents transaction_date: type: - string - "null" format: date-time description: The transaction date of the resident charge description: type: - string - "null" description: Description of the resident charge reference_number: type: - string - "null" description: The reference number for the resident charge required: - integration_id - lease_id - financial_account_id - amount_in_cents - transaction_date - description - reference_number required: - meta - result _v1_resident-charges_propertyware_rest__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration lease_id: type: string description: The Propexo unique identifier for the lease financial_account_id: type: string description: The Propexo unique identifier for the financial account amount_in_cents: type: integer minimum: 0 description: The amount of the resident charge, in cents transaction_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The transaction date of the resident charge description: type: string description: Description of the resident charge reference_number: type: string description: The reference number for the resident charge required: - integration_id - lease_id - financial_account_id - amount_in_cents - transaction_date _v1_resident-charges_propertyware_rest__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration lease_id: type: string description: The Propexo unique identifier for the lease financial_account_id: type: string description: The Propexo unique identifier for the financial account amount_in_cents: type: integer minimum: 0 description: The amount of the resident charge, in cents transaction_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" description: type: - string - "null" description: Description of the resident charge reference_number: type: - string - "null" description: The reference number for the resident charge required: - integration_id - lease_id - financial_account_id - amount_in_cents - transaction_date - description - reference_number required: - meta - result _v1_resident-charges_batch__post_input: type: object properties: integration_id: type: string charges: type: array items: type: object properties: property_id: type: string description: The Propexo unique identifier for the property resident_id: type: string description: The Propexo unique identifier for the resident unit_id: type: string description: The Propexo unique identifier for the unit financial_account_id: type: string description: The Propexo unique identifier for the financial account charge_code_id: type: string description: The Propexo ID for the charge code associated with this new charge transaction_date: type: string format: date-time description: The transaction date of the resident charge amount_in_cents: type: integer description: The amount of the resident charge, in cents description: type: string description: Description of the resident charge required: - property_id - resident_id - unit_id - financial_account_id - charge_code_id - transaction_date - amount_in_cents minItems: 1 description: Array of resident charges to create. All charges will be processed in a single API call to Yardi. required: - integration_id _v1_resident-charges_batch__post_output: type: object properties: job_id: type: string description: The ID of the job created to handle this operation data: type: object properties: {} required: - job_id - data _v1_resident-credits_propertyware_rest__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration lease_id: type: string description: The Propexo unique identifier for the lease amount_in_cents: type: integer minimum: 0 description: The amount of the resident charge, in cents. This value is required to be positive, but is given to Propertyware as a negative transaction_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The transaction date of the resident charge description: type: string description: Description of the resident charge reference_number: type: string description: The reference number for the resident charge required: - integration_id - lease_id - amount_in_cents - transaction_date _v1_resident-credits_propertyware_rest__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration lease_id: type: string description: The Propexo unique identifier for the lease amount_in_cents: type: integer minimum: 0 description: The amount of the resident charge, in cents. This value is required to be positive, but is given to Propertyware as a negative transaction_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" description: type: - string - "null" description: Description of the resident charge reference_number: type: - string - "null" description: The reference number for the resident charge required: - integration_id - lease_id - amount_in_cents - transaction_date - description - reference_number required: - meta - result _v1_resident-credits_rentmanager__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration resident_id: type: string description: The Propexo unique identifier for the resident charge_code_id: type: string description: The Propexo unique identifier for the charge code transaction_date: type: string format: date-time description: The transaction date of the resident charge notes: type: string description: Notes associated with the resident charge amount_in_cents: type: integer description: The amount of the resident charge, in cents reference_number: type: string description: The reference number for the resident charge required: - integration_id - resident_id - charge_code_id - transaction_date - notes - amount_in_cents - reference_number _v1_resident-credits_rentmanager__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration resident_id: type: string description: The Propexo unique identifier for the resident charge_code_id: type: string description: The Propexo unique identifier for the charge code transaction_date: type: string format: date-time description: The transaction date of the resident charge notes: type: string description: Notes associated with the resident charge amount_in_cents: type: integer description: The amount of the resident charge, in cents reference_number: type: string description: The reference number for the resident charge required: - integration_id - resident_id - charge_code_id - transaction_date - notes - amount_in_cents - reference_number required: - meta - result _v1_resident-credits_rentvine__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration lease_id: type: string description: The Propexo unique identifier for the lease financial_account_id: type: string description: The Propexo unique identifier for the financial account amount_in_cents: type: integer exclusiveMinimum: 0 description: The amount of the resident credit, in cents transaction_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The transaction date of the resident credit description: type: string description: Description of the resident credit required: - integration_id - lease_id - financial_account_id - amount_in_cents - transaction_date - description _v1_resident-credits_rentvine__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration lease_id: type: string description: The Propexo unique identifier for the lease financial_account_id: type: string description: The Propexo unique identifier for the financial account amount_in_cents: type: integer exclusiveMinimum: 0 description: The amount of the resident credit, in cents transaction_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" description: type: string description: Description of the resident credit required: - integration_id - lease_id - financial_account_id - amount_in_cents - transaction_date - description required: - meta - result _v1_recurring-resident-charges_entrata__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration lease_id: type: string description: The Propexo unique identifier for the lease resident_id: type: string description: The Propexo unique identifier for the resident charge_code_id: type: string description: The Propexo unique identifier for the charge code amount_in_cents: type: integer exclusiveMinimum: 0 description: The amount of the recurring resident charge, in cents start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The start date associated with the recurring resident charge. Format will be converted to MM/DD/YYYY for Entrata description: type: string description: Description of the recurring resident charge end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The end date associated with the recurring resident charge. Format will be converted to MM/DD/YYYY for Entrata month_to_month_amount_in_cents: type: integer exclusiveMinimum: 0 description: The month-to-month amount for the recurring charge in cents month_to_month_fee_in_cents: type: integer exclusiveMinimum: 0 description: The month-to-month fee for the recurring charge in cents last_posted_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The last date the charge was posted. Format will be converted to MM/DD/YYYY for Entrata charge_timing_id: type: string description: The propexo charge timing ID that defines when the charge should be applied charge_code_type_id: type: string description: The propexo charge code type ID required: - integration_id - lease_id - resident_id - charge_code_id - amount_in_cents - start_date - charge_timing_id - charge_code_type_id _v1_recurring-resident-charges_entrata__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration lease_id: type: string description: The Propexo unique identifier for the lease resident_id: type: string description: The Propexo unique identifier for the resident charge_code_id: type: string description: The Propexo unique identifier for the charge code amount_in_cents: type: integer exclusiveMinimum: 0 description: The amount of the recurring resident charge, in cents start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" description: type: - string - "null" description: Description of the recurring resident charge end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" description: The end date associated with the recurring resident charge. Format will be converted to MM/DD/YYYY for Entrata month_to_month_amount_in_cents: type: - integer - "null" exclusiveMinimum: 0 description: The month-to-month amount for the recurring charge in cents month_to_month_fee_in_cents: type: - integer - "null" exclusiveMinimum: 0 description: The month-to-month fee for the recurring charge in cents last_posted_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" description: The last date the charge was posted. Format will be converted to MM/DD/YYYY for Entrata charge_timing_id: type: string description: The propexo charge timing ID that defines when the charge should be applied charge_code_type_id: type: string description: The propexo charge code type ID required: - integration_id - lease_id - resident_id - charge_code_id - amount_in_cents - start_date - description - end_date - month_to_month_amount_in_cents - month_to_month_fee_in_cents - last_posted_date - charge_timing_id - charge_code_type_id required: - meta - result _v1_recurring-resident-charges_propertyware__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration lease_id: type: string description: The Propexo unique identifier for the lease financial_account_id: type: string description: The Propexo unique identifier for the financial account is_active: type: boolean description: Whether the recurring resident charge is active amount_in_cents: type: integer exclusiveMinimum: 0 description: The amount of the recurring resident charge, in cents description: type: string description: Description of the recurring resident charge charge_due_day: type: integer minimum: 1 maximum: 31 description: The day of the month the charge is due start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The start date associated with the recurring resident charge end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The end date associated with the recurring resident charge frequency_normalized: type: string enum: &a108 - MONTHLY - WEEKLY description: The frequency of the recurring resident charge reference_number: type: string description: The reference number for the recurring resident charge required: - integration_id - lease_id - financial_account_id - is_active - amount_in_cents - description - charge_due_day - start_date - frequency_normalized _v1_recurring-resident-charges_propertyware__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration lease_id: type: string description: The Propexo unique identifier for the lease financial_account_id: type: string description: The Propexo unique identifier for the financial account is_active: type: boolean description: Whether the recurring resident charge is active amount_in_cents: type: integer exclusiveMinimum: 0 description: The amount of the recurring resident charge, in cents description: type: string description: Description of the recurring resident charge charge_due_day: type: integer minimum: 1 maximum: 31 description: The day of the month the charge is due start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" description: The end date associated with the recurring resident charge frequency_normalized: type: string enum: *a108 description: The frequency of the recurring resident charge reference_number: type: - string - "null" description: The reference number for the recurring resident charge required: - integration_id - lease_id - financial_account_id - is_active - amount_in_cents - description - charge_due_day - start_date - end_date - frequency_normalized - reference_number required: - meta - result _v1_recurring-resident-charges_propertyware_{recurring_resident_charge_id}_put_input: type: object properties: financial_account_id: type: string description: The Propexo unique identifier for the financial account is_active: type: boolean description: Whether the recurring resident charge is active amount_in_cents: type: integer exclusiveMinimum: 0 description: The amount of the recurring resident charge, in cents description: type: string description: Description of the recurring resident charge charge_due_day: type: integer minimum: 1 maximum: 31 description: The day of the month the charge is due start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The start date associated with the recurring resident charge frequency_normalized: type: string enum: &a109 - MONTHLY - WEEKLY description: The frequency of the recurring resident charge end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The end date associated with the recurring resident charge reference_number: type: string description: The reference number for the recurring resident charge required: - is_active - amount_in_cents - description - charge_due_day - start_date - frequency_normalized _v1_recurring-resident-charges_propertyware_{recurring_resident_charge_id}_put_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: recurring_resident_charge_id: type: string description: The Propexo unique identifier for the recurring resident charge financial_account_id: type: string description: The Propexo unique identifier for the financial account is_active: type: boolean description: Whether the recurring resident charge is active amount_in_cents: type: integer exclusiveMinimum: 0 description: The amount of the recurring resident charge, in cents description: type: string description: Description of the recurring resident charge charge_due_day: type: integer minimum: 1 maximum: 31 description: The day of the month the charge is due start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The start date associated with the recurring resident charge frequency_normalized: type: string enum: *a109 description: The frequency of the recurring resident charge end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The end date associated with the recurring resident charge reference_number: type: string description: The reference number for the recurring resident charge required: - recurring_resident_charge_id - is_active - amount_in_cents - description - charge_due_day - start_date - frequency_normalized required: - meta - result _v1_recurring-resident-charges_propertyware_rest__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration lease_id: type: string description: The Propexo unique identifier for the lease financial_account_id: type: string description: The Propexo unique identifier for the financial account amount_in_cents: type: integer exclusiveMinimum: 0 description: The amount of the recurring resident charge, in cents charge_due_day: type: integer minimum: 1 maximum: 31 description: The day of the month the charge is due. When frequency_normalized is set to 'WEEKLY', the charge_due_day must be between 1 and 7 start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The start date associated with the recurring resident charge frequency_normalized: type: string enum: &a110 - WEEKLY - MONTHLY - QUARTERLY - SEMIANNUAL - ANNUAL - ANNUAL_ACCRUAL description: The frequency of the recurring resident charge reference_number: type: string description: The reference number for the recurring resident charge description: type: string description: Description of the recurring resident charge end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The end date associated with the recurring resident charge required: - integration_id - lease_id - financial_account_id - amount_in_cents - charge_due_day - start_date - frequency_normalized _v1_recurring-resident-charges_propertyware_rest__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration lease_id: type: string description: The Propexo unique identifier for the lease financial_account_id: type: string description: The Propexo unique identifier for the financial account amount_in_cents: type: integer exclusiveMinimum: 0 description: The amount of the recurring resident charge, in cents charge_due_day: type: integer minimum: 1 maximum: 31 description: The day of the month the charge is due. When frequency_normalized is set to 'WEEKLY', the charge_due_day must be between 1 and 7 start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" frequency_normalized: type: string enum: *a110 description: The frequency of the recurring resident charge reference_number: type: - string - "null" description: The reference number for the recurring resident charge description: type: - string - "null" description: Description of the recurring resident charge end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" description: The end date associated with the recurring resident charge required: - integration_id - lease_id - financial_account_id - amount_in_cents - charge_due_day - start_date - frequency_normalized - reference_number - description - end_date required: - meta - result _v1_recurring-resident-charges_rentvine__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration lease_id: type: string description: The Propexo unique identifier for the lease financial_account_id: type: string description: The Propexo unique identifier for the financial account amount_in_cents: type: integer exclusiveMinimum: 0 description: The amount of the recurring resident charge, in cents description: type: string description: Description of the recurring resident charge day_due: type: integer exclusiveMinimum: 0 minimum: 1 maximum: 31 description: The day of the month the charge is due start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The start date associated with the recurring resident charge end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The end date associated with the recurring resident charge frequency_raw: type: integer exclusiveMinimum: 0 minimum: 1 maximum: 24 description: The raw value of the frequency of the recurring resident charge (in months) required: - integration_id - lease_id - financial_account_id - amount_in_cents - description - day_due - start_date _v1_recurring-resident-charges_rentvine__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration lease_id: type: string description: The Propexo unique identifier for the lease financial_account_id: type: string description: The Propexo unique identifier for the financial account amount_in_cents: type: integer exclusiveMinimum: 0 description: The amount of the recurring resident charge, in cents description: type: string description: Description of the recurring resident charge day_due: type: integer exclusiveMinimum: 0 minimum: 1 maximum: 31 description: The day of the month the charge is due start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" description: The end date associated with the recurring resident charge frequency_raw: type: - integer - "null" exclusiveMinimum: 0 minimum: 1 maximum: 24 description: The raw value of the frequency of the recurring resident charge (in months) required: - integration_id - lease_id - financial_account_id - amount_in_cents - description - day_due - start_date - end_date - frequency_raw required: - meta - result _v1_recurring-resident-charges_rentmanager__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration resident_id: type: string description: The Propexo unique identifier for the resident charge_code_id: type: string description: The Propexo unique identifier for the charge code amount_in_cents: type: integer exclusiveMinimum: 0 description: The amount of the resident charge, in cents frequency_normalized: type: string enum: *a111 description: The frequency of the recurring resident charge description: type: string description: Description of the recurring resident charge start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The start date associated with the recurring resident charge. Required if frequency is DAILY or WEEKLY end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The end date associated with the recurring resident charge required: - integration_id - resident_id - charge_code_id - amount_in_cents - frequency_normalized _v1_recurring-resident-charges_rentmanager__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration resident_id: type: string description: The Propexo unique identifier for the resident charge_code_id: type: string description: The Propexo unique identifier for the charge code amount_in_cents: type: integer exclusiveMinimum: 0 description: The amount of the resident charge, in cents frequency_normalized: type: string enum: *a111 description: The frequency of the recurring resident charge description: type: - string - "null" description: Description of the recurring resident charge start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" description: The start date associated with the recurring resident charge. Required if frequency is DAILY or WEEKLY end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" description: The end date associated with the recurring resident charge required: - integration_id - resident_id - charge_code_id - amount_in_cents - frequency_normalized - description - start_date - end_date required: - meta - result _v1_recurring-resident-charges_rentmanager_{recurring_resident_charge_id}_put_input: type: object properties: charge_code_id: type: string description: The Propexo unique identifier for the charge code amount_in_cents: type: integer exclusiveMinimum: 0 description: The amount of the resident charge, in cents frequency_normalized: type: string enum: *a112 description: The frequency of the recurring resident charge description: type: string description: Description of the recurring resident charge start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The start date associated with the recurring resident charge. Required if frequency is DAILY or WEEKLY end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The end date associated with the recurring resident charge required: - charge_code_id _v1_recurring-resident-charges_rentmanager_{recurring_resident_charge_id}_put_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: recurring_resident_charge_id: type: string description: The Propexo unique identifier for the recurring resident charge charge_code_id: type: string description: The Propexo unique identifier for the charge code amount_in_cents: type: integer exclusiveMinimum: 0 description: The amount of the resident charge, in cents frequency_normalized: type: string enum: *a112 description: The frequency of the recurring resident charge description: type: string description: Description of the recurring resident charge start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The start date associated with the recurring resident charge. Required if frequency is DAILY or WEEKLY end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The end date associated with the recurring resident charge required: - recurring_resident_charge_id - charge_code_id required: - meta - result _v1_resident-payments_buildium__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration lease_id: type: string description: The Propexo unique identifier for the lease financial_account_id: type: string description: The Propexo unique identifier for the financial account resident_id: type: string description: The Propexo unique identifier for the resident transaction_date: type: string format: date-time description: The transaction date of the resident payment amount_in_cents: type: integer description: The amount of the resident payment, in cents payment_type: type: string enum: &a113 - Check - Cash - MoneyOrder - CashierCheck - DirectDeposit - CreditCard - ElectronicPayment description: The type of payment used for the resident payment send_email_receipt: type: boolean description: Indicates whether the payee would like to have a receipt emailed description: type: string description: Description of the resident payment reference_number: type: string description: The reference number for the resident payment required: - integration_id - lease_id - financial_account_id - transaction_date - amount_in_cents - payment_type - send_email_receipt _v1_resident-payments_buildium__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration lease_id: type: string description: The Propexo unique identifier for the lease financial_account_id: type: string description: The Propexo unique identifier for the financial account resident_id: type: - string - "null" description: The Propexo unique identifier for the resident transaction_date: type: string format: date-time description: The transaction date of the resident payment amount_in_cents: type: integer description: The amount of the resident payment, in cents payment_type: type: string enum: *a113 description: The type of payment used for the resident payment send_email_receipt: type: boolean description: Indicates whether the payee would like to have a receipt emailed description: type: - string - "null" description: Description of the resident payment reference_number: type: - string - "null" description: The reference number for the resident payment required: - integration_id - lease_id - financial_account_id - resident_id - transaction_date - amount_in_cents - payment_type - send_email_receipt - description - reference_number required: - meta - result _v1_resident-payments_entrata__post_input: type: object properties: {} _v1_resident-payments_entrata__post_output: type: object properties: {} _v1_resident-payments_rentmanager__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration resident_id: type: string description: The Propexo unique identifier for the resident charge_code_id: type: string description: The Propexo unique identifier for the charge code transaction_date: type: string format: date-time description: The transaction date of the resident payment notes: type: string description: Notes associated with the resident payment amount_in_cents: type: integer description: The amount of the resident payment, in cents reference_number: type: string description: The reference number for the resident payment allocate_prepays: type: boolean description: Whether to allocate prepays to the resident payment. This is a flag passed directly to Rent Manager required: - integration_id - resident_id - transaction_date - notes - amount_in_cents - reference_number _v1_resident-payments_rentmanager__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration resident_id: type: string description: The Propexo unique identifier for the resident charge_code_id: type: - string - "null" description: The Propexo unique identifier for the charge code transaction_date: type: string format: date-time description: The transaction date of the resident payment notes: type: string description: Notes associated with the resident payment amount_in_cents: type: integer description: The amount of the resident payment, in cents reference_number: type: string description: The reference number for the resident payment allocate_prepays: type: - boolean - "null" description: Whether to allocate prepays to the resident payment. This is a flag passed directly to Rent Manager required: - integration_id - resident_id - charge_code_id - transaction_date - notes - amount_in_cents - reference_number - allocate_prepays required: - meta - result _v1_resident-payments_yardi__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration property_id: type: string description: The Propexo unique identifier for the property resident_id: type: string description: The Propexo unique identifier for the resident unit_id: type: string description: The Propexo unique identifier for the unit financial_account_id: type: string description: The Propexo unique identifier for the financial account transaction_date: type: string format: date-time description: The transaction date of the resident payment amount_in_cents: type: integer description: The amount of the resident payment, in cents reference_number: type: string description: The reference number for the resident payment description: type: string description: Description of the resident payment required: - integration_id - property_id - resident_id - unit_id - financial_account_id - transaction_date - amount_in_cents - reference_number _v1_resident-payments_yardi__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration property_id: type: string description: The Propexo unique identifier for the property resident_id: type: string description: The Propexo unique identifier for the resident unit_id: type: string description: The Propexo unique identifier for the unit financial_account_id: type: string description: The Propexo unique identifier for the financial account transaction_date: type: string format: date-time description: The transaction date of the resident payment amount_in_cents: type: integer description: The amount of the resident payment, in cents reference_number: type: string description: The reference number for the resident payment description: type: - string - "null" description: Description of the resident payment required: - integration_id - property_id - resident_id - unit_id - financial_account_id - transaction_date - amount_in_cents - reference_number - description required: - meta - result _v1_resident-payments_yardi_rest__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration property_id: type: string description: The Propexo unique identifier for the property resident_id: type: string description: The Propexo unique identifier for the resident unit_id: type: string description: The Propexo unique identifier for the unit financial_account_id: type: string description: The Propexo unique identifier for the financial account transaction_date: type: string format: date-time description: The transaction date of the resident payment amount_in_cents: type: integer description: The amount of the resident payment, in cents reference_number: type: string description: The reference number for the resident payment description: type: string description: Description of the resident payment required: - integration_id - property_id - resident_id - unit_id - financial_account_id - transaction_date - amount_in_cents - reference_number _v1_resident-payments_yardi_rest__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration property_id: type: string description: The Propexo unique identifier for the property resident_id: type: string description: The Propexo unique identifier for the resident unit_id: type: string description: The Propexo unique identifier for the unit financial_account_id: type: string description: The Propexo unique identifier for the financial account transaction_date: type: string format: date-time description: The transaction date of the resident payment amount_in_cents: type: integer description: The amount of the resident payment, in cents reference_number: type: string description: The reference number for the resident payment description: type: - string - "null" description: Description of the resident payment required: - integration_id - property_id - resident_id - unit_id - financial_account_id - transaction_date - amount_in_cents - reference_number - description required: - meta - result _v1_resident-payments_resman__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration resident_id: type: string description: The Propexo unique identifier for the resident payment_type: type: string enum: *a114 description: The method of payment batch_id: type: string description: An identifier for the transaction batch. This should be unique to your system. transaction_date: type: string format: date-time description: The transaction date of the resident payment description: type: string description: Description of the resident payment notes: type: string description: Notes associated with the resident payment amount_in_cents: type: integer description: The amount of the resident payment, in cents reference_number: type: string description: The reference number for the resident payment required: - integration_id - resident_id - payment_type - batch_id - transaction_date - description - notes - amount_in_cents - reference_number _v1_resident-payments_resman__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration resident_id: type: string description: The Propexo unique identifier for the resident payment_type: type: string enum: *a114 description: The method of payment batch_id: type: string description: An identifier for the transaction batch. This should be unique to your system. transaction_date: type: string format: date-time description: The transaction date of the resident payment description: type: string description: Description of the resident payment notes: type: string description: Notes associated with the resident payment amount_in_cents: type: integer description: The amount of the resident payment, in cents reference_number: type: string description: The reference number for the resident payment required: - integration_id - resident_id - payment_type - batch_id - transaction_date - description - notes - amount_in_cents - reference_number required: - meta - result _v1_resident-payments_realpage_rpx__post_input: type: object properties: {} _v1_resident-payments_realpage_rpx__post_output: type: object properties: {} _v1_resident-payments_propertyware__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration lease_id: type: string description: The Propexo unique identifier for the lease amount_in_cents: type: integer description: The amount of the resident payment, in cents transaction_date: type: string format: date-time description: The transaction date of the resident payment description: type: string description: Description of the resident payment reference_number: type: string description: The reference number for the resident payment required: - integration_id - lease_id - amount_in_cents _v1_resident-payments_propertyware__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration lease_id: type: string description: The Propexo unique identifier for the lease amount_in_cents: type: integer description: The amount of the resident payment, in cents transaction_date: type: - string - "null" format: date-time description: The transaction date of the resident payment description: type: - string - "null" description: Description of the resident payment reference_number: type: - string - "null" description: The reference number for the resident payment required: - integration_id - lease_id - amount_in_cents - transaction_date - description - reference_number required: - meta - result _v1_resident-payments_propertyware_rest__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration lease_id: type: string description: The Propexo unique identifier for the lease resident_id: type: string description: The Propexo unique identifier for the resident financial_account_id: type: string description: The Propexo unique identifier for the financial account amount_in_cents: type: integer description: The amount of the resident payment, in cents transaction_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The transaction date of the resident payment payment_type: type: string enum: &a115 - CHECK - CHECK21 - CASHIERS_CHECK - CREDIT_CARD - CASH - MONEY_ORDER - OTHER - CLICKPAY - SECTION8 - EPAY - ECHECK - NACHA - RENTMONEY - PUBLIC_ASSISTANCE description: The type of payment used for the resident payment reference_number: type: string description: The reference number for the resident payment description: type: string description: Description of the resident payment required: - integration_id - lease_id - resident_id - financial_account_id - amount_in_cents - transaction_date - payment_type - reference_number _v1_resident-payments_propertyware_rest__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration lease_id: type: string description: The Propexo unique identifier for the lease resident_id: type: string description: The Propexo unique identifier for the resident financial_account_id: type: string description: The Propexo unique identifier for the financial account amount_in_cents: type: integer description: The amount of the resident payment, in cents transaction_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" payment_type: type: string enum: *a115 description: The type of payment used for the resident payment reference_number: type: string description: The reference number for the resident payment description: type: - string - "null" description: Description of the resident payment required: - integration_id - lease_id - resident_id - financial_account_id - amount_in_cents - transaction_date - payment_type - reference_number - description required: - meta - result _v1_resident-payments_rentvine__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration lease_id: type: string description: The Propexo unique identifier for the lease financial_account_id: type: string description: The Propexo unique identifier for the financial account. This must be a bank account resident_id: type: string description: The Propexo unique identifier for the resident. The resident must be a primary. amount_in_cents: type: integer exclusiveMinimum: 0 description: The amount of the resident payment, in cents payment_type: type: string enum: - ACH - CREDIT/DEBIT_CARD - CHECK - MONEY_ORDER - CASH - OTHER - CASH_PAY - CASHIER_CHECK description: The type of payment used for the resident payment transaction_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The transaction date of the resident payment send_email_receipt: type: boolean description: Indicates whether the payee would like to have a receipt emailed description: type: string description: Description of the resident payment reference_number: type: string description: The reference number for the resident payment required: - integration_id - lease_id - financial_account_id - resident_id - amount_in_cents - payment_type - transaction_date - send_email_receipt _v1_resident-payments_rentvine__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration lease_id: type: string description: The Propexo unique identifier for the lease financial_account_id: type: string description: The Propexo unique identifier for the financial account. This must be a bank account resident_id: type: string description: The Propexo unique identifier for the resident. The resident must be a primary. amount_in_cents: type: integer exclusiveMinimum: 0 description: The amount of the resident payment, in cents payment_type: type: string enum: - ACH - CREDIT/DEBIT_CARD - CHECK - MONEY_ORDER - CASH - OTHER - CASH_PAY - CASHIER_CHECK description: The type of payment used for the resident payment transaction_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" send_email_receipt: type: boolean description: Indicates whether the payee would like to have a receipt emailed description: type: - string - "null" description: Description of the resident payment reference_number: type: - string - "null" description: The reference number for the resident payment required: - integration_id - lease_id - financial_account_id - resident_id - amount_in_cents - payment_type - transaction_date - send_email_receipt - description - reference_number required: - meta - result _v1_resident-charges_batch_yardi__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration charges: type: array items: type: object properties: property_id: type: string description: The Propexo unique identifier for the property resident_id: type: string description: The Propexo unique identifier for the resident unit_id: type: string description: The Propexo unique identifier for the unit financial_account_id: type: string description: The Propexo unique identifier for the financial account charge_code_id: type: string description: The Propexo ID for the charge code associated with this new charge transaction_date: type: string format: date-time description: The transaction date of the resident charge amount_in_cents: type: integer description: The amount of the resident charge, in cents description: type: string description: Description of the resident charge required: - property_id - resident_id - unit_id - financial_account_id - charge_code_id - transaction_date - amount_in_cents minItems: 1 description: Array of resident charges to create. All charges will be processed in a single API call to Yardi. required: - integration_id - charges _v1_resident-charges_batch_yardi__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string charges: type: array items: type: object properties: property_id: type: string description: The Propexo unique identifier for the property resident_id: type: string description: The Propexo unique identifier for the resident unit_id: type: string description: The Propexo unique identifier for the unit financial_account_id: type: string description: The Propexo unique identifier for the financial account charge_code_id: type: string description: The Propexo ID for the charge code associated with this new charge transaction_date: type: string format: date-time description: The transaction date of the resident charge amount_in_cents: type: integer description: The amount of the resident charge, in cents description: type: string description: Description of the resident charge required: - property_id - resident_id - unit_id - financial_account_id - charge_code_id - transaction_date - amount_in_cents required: - integration_id - charges required: - meta - result _v1_resident-charges_batch_propertyware_rest__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration charges: type: array items: type: object properties: lease_id: type: string description: The Propexo unique identifier for the lease financial_account_id: type: string description: The Propexo unique identifier for the financial account amount_in_cents: type: integer minimum: 0 description: The amount of the resident charge, in cents transaction_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The transaction date of the resident charge description: type: string description: Description of the resident charge reference_number: type: string description: The reference number for the resident charge required: - lease_id - financial_account_id - amount_in_cents - transaction_date minItems: 1 description: Array of resident charges to create. required: - integration_id - charges _v1_resident-charges_batch_propertyware_rest__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string charges: type: array items: type: object properties: lease_id: type: string description: The Propexo unique identifier for the lease financial_account_id: type: string description: The Propexo unique identifier for the financial account amount_in_cents: type: integer minimum: 0 description: The amount of the resident charge, in cents transaction_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The transaction date of the resident charge description: type: string description: Description of the resident charge reference_number: type: string description: The reference number for the resident charge required: - lease_id - financial_account_id - amount_in_cents - transaction_date required: - integration_id - charges required: - meta - result _v1_resident-charges_batch_rentmanager__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration charges: type: array items: type: object properties: resident_id: type: string description: The Propexo unique identifier for the resident charge_code_id: type: string description: The Propexo unique identifier for the charge code transaction_date: type: string format: date-time description: The transaction date of the resident charge notes: type: string description: Notes associated with the resident charge amount_in_cents: type: integer description: The amount of the resident charge, in cents reference_number: type: string description: The reference number for the resident charge required: - resident_id - charge_code_id - transaction_date - notes - amount_in_cents - reference_number minItems: 1 description: Array of resident charges to create. All charges must resolve to the same Rent Manager location. required: - integration_id - charges _v1_resident-charges_batch_rentmanager__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string charges: type: array items: type: object properties: resident_id: type: string description: The Propexo unique identifier for the resident charge_code_id: type: string description: The Propexo unique identifier for the charge code transaction_date: type: string format: date-time description: The transaction date of the resident charge notes: type: string description: Notes associated with the resident charge amount_in_cents: type: integer description: The amount of the resident charge, in cents reference_number: type: string description: The reference number for the resident charge required: - resident_id - charge_code_id - transaction_date - notes - amount_in_cents - reference_number required: - integration_id - charges required: - meta - result _v1_resident-charges_batch_resman__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration charges: type: array items: type: object properties: resident_id: type: string description: The Propexo unique identifier for the resident charge_code_id: type: string description: The Propexo unique identifier for the charge code batch_id: type: string description: An identifier for the transaction batch. This should be unique to your system. transaction_date: type: string format: date-time description: The transaction date of the resident charge description: type: string description: Description of the resident charge notes: type: string description: Notes associated with the resident charge amount_in_cents: type: integer description: The amount of the resident charge, in cents reference_number: type: string description: The reference number for the resident charge required: - resident_id - charge_code_id - batch_id - transaction_date - description - notes - amount_in_cents - reference_number minItems: 1 description: Array of resident charges. Each item includes the resident to post the charge for. All charges must belong to the same ResMan property. required: - integration_id - charges _v1_resident-charges_batch_resman__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string charges: type: array items: type: object properties: resident_id: type: string description: The Propexo unique identifier for the resident charge_code_id: type: string description: The Propexo unique identifier for the charge code batch_id: type: string description: An identifier for the transaction batch. This should be unique to your system. transaction_date: type: string format: date-time description: The transaction date of the resident charge description: type: string description: Description of the resident charge notes: type: string description: Notes associated with the resident charge amount_in_cents: type: integer description: The amount of the resident charge, in cents reference_number: type: string description: The reference number for the resident charge required: - resident_id - charge_code_id - batch_id - transaction_date - description - notes - amount_in_cents - reference_number required: - integration_id - charges required: - meta - result _v1_call-logs__get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query x_id: type: string description: The external call log id location_id: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. property_id: type: string description: The Propexo unique identifier for the property integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" CallLog: type: object properties: id: type: string description: The Propexo unique identifier for the call log created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_lead_source_id: type: - string - "null" description: The external ID of the lead source from the integration vendor custom_data: type: - object - "null" properties: {} lead_source: type: - string - "null" description: The name of the source of the lead origin_phone_number: type: - string - "null" description: The phone number that originated the call for the call log integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" property_id: type: string description: The Propexo unique identifier for the property lead_source_id: type: - string - "null" description: The Propexo unique identifier for the lead source required: - id - created_at - updated_at - last_seen - x_id - x_property_id - x_location_id - x_lead_source_id - custom_data - lead_source - origin_phone_number - integration_id - integration_vendor - property_id - lead_source_id x-propexo: derivedFromModel: call_logs _v1_call-logs__get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: type: array items: $ref: "#/components/schemas/CallLog" required: - meta - results _v1_call-logs_{call_log_id}_get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query _v1_call-logs_{call_log_id}_get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: $ref: "#/components/schemas/CallLog" required: - meta - results _v1_construction-jobs__get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query property_id: type: string description: The Propexo unique identifier for the property integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" ConstructionJob: type: object properties: id: type: string description: The Propexo unique identifier for the construction job created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_gl_account_id: type: - string - "null" description: The external ID of the general ledger account from the integration vendor actual_end_date: type: - string - "null" description: The actual date the construction job ended actual_start_date: type: - string - "null" description: The actual date the construction job started name: type: string description: The name associated with the construction job planned_end_date: type: - string - "null" description: The date the construction job was planned to end planned_start_date: type: - string - "null" description: The date the construction job was planned to start status_normalized: type: - string - "null" description: The normalized status for the construction job status_raw: type: - string - "null" description: The raw status associated with the construction job total_budget_in_cents: type: &a300 - number - "null" description: The total budget for the construction job example: 100000 custom_data: type: - object - "null" properties: {} property_id: type: string description: The Propexo unique identifier for the property integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" required: - id - created_at - updated_at - last_seen - x_id - x_property_id - x_location_id - x_gl_account_id - actual_end_date - actual_start_date - name - planned_end_date - planned_start_date - status_normalized - status_raw - total_budget_in_cents - custom_data - property_id - integration_id - integration_vendor x-propexo: derivedFromModel: construction_jobs _v1_construction-jobs__get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: type: array items: $ref: "#/components/schemas/ConstructionJob" required: - meta - results _v1_construction-jobs__post_input: type: object properties: integration_id: type: string required: - integration_id _v1_construction-jobs__post_output: type: object properties: job_id: type: string description: The ID of the job created to handle this operation data: type: object properties: {} required: - job_id - data _v1_construction-jobs_{construction_job_id}_get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query _v1_construction-jobs_{construction_job_id}_get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: $ref: "#/components/schemas/ConstructionJob" required: - meta - results _v1_construction-jobs_{construction_job_id}_put_input: type: object properties: {} _v1_construction-jobs_{construction_job_id}_put_output: type: object properties: job_id: type: string description: The ID of the job created to handle this operation data: type: object properties: {} required: - job_id - data _v1_contracts__post_input: type: object properties: integration_id: type: string vendor_id: type: string description: The Propexo unique identifier for the vendor start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The start date associated with the contract end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The end date associated with the contract x_id: type: string maxLength: 16 description: The external ID from the integration vendor. This must be a unique value when creating a new contract. notes: type: string description: Notes associated with the contract expense_type: type: string description: The expense type of the contract. You'll have to request this data from your customer retention_percent: type: string description: The retention percent of the contract. Must be a decimal number with only 2 places contract_details: type: array items: type: object properties: construction_job_id: type: string description: The Propexo unique identifier for the construction job property_id: type: string description: The Propexo unique identifier for the property financial_account_id: type: string description: The Propexo unique identifier for the financial account total_amount_in_cents: type: number description: The amount of the contract detail, in cents notes: type: string description: Notes associated with the contract detail cost_code: type: string description: The cost code of the contract detail. You'll have to request this data from your customer category_code: type: string description: The category code for the contract detail. You'll have to request this data from your customer retention_percent: type: string description: The retention percent of the contract detail. Must be a decimal number with only 2 places required: - construction_job_id - property_id - total_amount_in_cents required: - integration_id _v1_contracts__post_output: type: object properties: job_id: type: string description: The ID of the job created to handle this operation data: type: object properties: {} required: - job_id - data _v1_contracts_{contract_id}_put_input: type: object properties: vendor_id: type: string description: The Propexo unique identifier for the vendor start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The start date associated with the contract end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The end date associated with the contract notes: type: string description: Notes associated with the contract expense_type: type: string description: The expense type of the contract. You'll have to request this data from your customer, but you can see a set of allowed values by reviewing the response of integration.configuration_meta_data retention_percent: type: string description: The retention percent of the contract. Must be a decimal number with only 2 places _v1_contracts_{contract_id}_put_output: type: object properties: job_id: type: string description: The ID of the job created to handle this operation data: type: object properties: {} required: - job_id - data _v1_construction-jobs_{construction_job_id}_details_get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query property_id: type: string description: The Propexo unique identifier for the property integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" _v1_construction-jobs_{construction_job_id}_details_get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: type: array items: type: object properties: id: type: string description: The Propexo unique identifier for the construction job created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. category_description: type: - string - "null" description: The description of the category for the construction job detail cost_code: type: - string - "null" description: The cost code of the construction job detail original_budget_in_cents: type: &a297 - number - "null" description: The original budget of the construction job detail example: 100000 revised_budget_in_cents: type: &a298 - number - "null" description: The revised budget of the construction job detail example: 100000 invoiced_total_in_cents: type: &a299 - number - "null" description: The total amount invoiced, in cents, for the construction job detail example: 100000 custom_data: type: - object - "null" properties: {} property_id: type: string description: The Propexo unique identifier for the property integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" required: - id - created_at - updated_at - last_seen - x_id - x_property_id - x_location_id - category_description - cost_code - original_budget_in_cents - revised_budget_in_cents - invoiced_total_in_cents - custom_data - property_id - integration_id - integration_vendor x-propexo: derivedFromModel: construction_job_details required: - meta - results _v1_construction-jobs_{construction_job_id}_contracts_get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query property_id: type: string description: The Propexo unique identifier for the property integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" Contract: type: object properties: id: type: string description: The Propexo unique identifier for the contract created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_construction_job_id: type: - string - "null" description: The external ID of the construction job from the integration vendor x_vendor_id: type: - string - "null" description: The external ID of the vendor from the integration vendor custom_data: type: - object - "null" properties: {} end_date: type: - string - "null" description: The end date associated with the contract expense_type: type: - string - "null" description: The expense type of the contract invoiced_total_in_cents: type: &a303 - number - "null" description: The total amount invoiced, in cents, for the contract example: 100000 notes: type: - string - "null" description: Notes associated with the contract original_amount_in_cents: type: &a304 - number - "null" description: The original amount of the contract example: 100000 retention_percent: type: - string - "null" description: The retention percent of the contract start_date: type: - string - "null" description: The start date associated with the contract status_normalized: type: - string - "null" description: The normalized status for the contract status_raw: type: - string - "null" description: The raw status associated with the contract total_amount_in_cents: type: &a305 - number - "null" description: The total amount of the contract example: 100000 construction_job_id: type: - string - "null" description: The Propexo unique identifier for the construction job vendor_id: type: - string - "null" description: The Propexo unique identifier for the vendor property_id: type: string description: The Propexo unique identifier for the property integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" required: - id - created_at - updated_at - last_seen - x_id - x_property_id - x_location_id - x_construction_job_id - x_vendor_id - custom_data - end_date - expense_type - invoiced_total_in_cents - notes - original_amount_in_cents - retention_percent - start_date - status_normalized - status_raw - total_amount_in_cents - construction_job_id - vendor_id - property_id - integration_id - integration_vendor x-propexo: derivedFromModel: contracts _v1_construction-jobs_{construction_job_id}_contracts_get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: type: array items: $ref: "#/components/schemas/Contract" required: - meta - results _v1_construction-jobs_yardi__post_input: type: object properties: {} _v1_construction-jobs_yardi__post_output: type: object properties: {} _v1_construction-jobs_yardi_{construction_job_id}_put_input: type: object properties: {} _v1_construction-jobs_yardi_{construction_job_id}_put_output: type: object properties: {} _v1_contracts_yardi__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration vendor_id: type: string description: The Propexo unique identifier for the vendor start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The start date associated with the contract end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The end date associated with the contract x_id: type: string maxLength: 16 description: The external ID from the integration vendor. This must be a unique value when creating a new contract. notes: type: string description: Notes associated with the contract expense_type: type: string description: The expense type of the contract. You'll have to request this data from your customer retention_percent: type: string contract_details: type: array items: type: object properties: construction_job_id: type: string description: The Propexo unique identifier for the construction job property_id: type: string description: The Propexo unique identifier for the property financial_account_id: type: string description: The Propexo unique identifier for the financial account total_amount_in_cents: type: number description: The amount of the contract detail, in cents notes: type: string description: Notes associated with the contract detail cost_code: type: string description: The cost code of the contract detail. You'll have to request this data from your customer category_code: type: string description: The category code for the contract detail. You'll have to request this data from your customer retention_percent: type: string required: - construction_job_id - property_id - total_amount_in_cents required: - integration_id - vendor_id - start_date - end_date - contract_details _v1_contracts_yardi__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration vendor_id: type: string description: The Propexo unique identifier for the vendor start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" x_id: type: - string - "null" maxLength: 16 description: The external ID from the integration vendor. This must be a unique value when creating a new contract. notes: type: - string - "null" description: Notes associated with the contract expense_type: type: - string - "null" description: The expense type of the contract. You'll have to request this data from your customer retention_percent: type: - string - "null" description: The retention percent of the contract. Must be a decimal number with only 2 places contract_details: type: array items: type: object properties: construction_job_id: type: string description: The Propexo unique identifier for the construction job property_id: type: string description: The Propexo unique identifier for the property financial_account_id: type: string description: The Propexo unique identifier for the financial account total_amount_in_cents: type: number description: The amount of the contract detail, in cents notes: type: string description: Notes associated with the contract detail cost_code: type: string description: The cost code of the contract detail. You'll have to request this data from your customer category_code: type: string description: The category code for the contract detail. You'll have to request this data from your customer retention_percent: type: string required: - construction_job_id - property_id - total_amount_in_cents required: - integration_id - vendor_id - start_date - end_date - x_id - notes - expense_type - retention_percent - contract_details required: - meta - result _v1_contracts_yardi_{contract_id}_put_input: type: object properties: vendor_id: type: string description: The Propexo unique identifier for the vendor start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The start date associated with the contract end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The end date associated with the contract notes: type: string description: Notes associated with the contract expense_type: type: string description: The expense type of the contract. You'll have to request this data from your customer, but you can see a set of allowed values by reviewing the response of integration.configuration_meta_data retention_percent: type: string description: The retention percent of the contract. Must be a decimal number with only 2 places required: - vendor_id - start_date _v1_contracts_yardi_{contract_id}_put_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: contract_id: type: string description: The Propexo unique identifier for the contract vendor_id: type: string description: The Propexo unique identifier for the vendor start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The start date associated with the contract end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The end date associated with the contract notes: type: string description: Notes associated with the contract expense_type: type: string description: The expense type of the contract. You'll have to request this data from your customer, but you can see a set of allowed values by reviewing the response of integration.configuration_meta_data retention_percent: type: string description: The retention percent of the contract. Must be a decimal number with only 2 places required: - contract_id - vendor_id - start_date required: - meta - result _v1_contracts_yardi_rest__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration vendor_id: type: string description: The Propexo unique identifier for the vendor start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The start date associated with the contract end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The end date associated with the contract notes: type: string description: Notes associated with the contract expense_type: type: string description: The expense type of the contract. You'll have to request this data from your customer retention_percent: type: string description: The retention percent of the contract. Must be a decimal number with only 2 places contract_details: type: array items: type: object properties: construction_job_id: type: string description: The Propexo unique identifier for the construction job property_id: type: string description: The Propexo unique identifier for the property financial_account_id: type: string description: The Propexo unique identifier for the financial account total_amount_in_cents: type: number description: The amount of the contract detail, in cents notes: type: string description: Notes associated with the contract detail cost_code: type: string description: The cost code of the contract detail. You'll have to request this data from your customer category_code: type: string description: The category code for the contract detail. You'll have to request this data from your customer retention_percent: type: string description: The retention percent of the contract detail. Must be a decimal number with only 2 places required: - construction_job_id - property_id - total_amount_in_cents required: - integration_id - vendor_id - start_date - contract_details _v1_contracts_yardi_rest__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration vendor_id: type: string description: The Propexo unique identifier for the vendor start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" description: The end date associated with the contract notes: type: - string - "null" description: Notes associated with the contract expense_type: type: - string - "null" description: The expense type of the contract. You'll have to request this data from your customer retention_percent: type: - string - "null" description: The retention percent of the contract. Must be a decimal number with only 2 places contract_details: type: array items: type: object properties: construction_job_id: type: string description: The Propexo unique identifier for the construction job property_id: type: string description: The Propexo unique identifier for the property financial_account_id: type: string description: The Propexo unique identifier for the financial account total_amount_in_cents: type: number description: The amount of the contract detail, in cents notes: type: string description: Notes associated with the contract detail cost_code: type: string description: The cost code of the contract detail. You'll have to request this data from your customer category_code: type: string description: The category code for the contract detail. You'll have to request this data from your customer retention_percent: type: string description: The retention percent of the contract detail. Must be a decimal number with only 2 places required: - construction_job_id - property_id - total_amount_in_cents required: - integration_id - vendor_id - start_date - end_date - notes - expense_type - retention_percent - contract_details required: - meta - result _v1_contracts_yardi_rest_{contract_id}_put_input: type: object properties: vendor_id: type: string description: The Propexo unique identifier for the vendor start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The start date associated with the contract end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The end date associated with the contract notes: type: string description: Notes associated with the contract expense_type: type: string description: The expense type of the contract. You'll have to request this data from your customer, but you can see a set of allowed values by reviewing the response of integration.configuration_meta_data retention_percent: type: string description: The retention percent of the contract. Must be a decimal number with only 2 places required: - vendor_id - start_date _v1_contracts_yardi_rest_{contract_id}_put_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: contract_id: type: string description: The Propexo unique identifier for the contract vendor_id: type: string description: The Propexo unique identifier for the vendor start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The start date associated with the contract end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The end date associated with the contract notes: type: string description: Notes associated with the contract expense_type: type: string description: The expense type of the contract. You'll have to request this data from your customer, but you can see a set of allowed values by reviewing the response of integration.configuration_meta_data retention_percent: type: string description: The retention percent of the contract. Must be a decimal number with only 2 places required: - contract_id - vendor_id - start_date required: - meta - result _v1_construction-jobs_contracts_{contract_id}_details_get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query property_id: type: string description: The Propexo unique identifier for the property integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" ContractDetail: type: object properties: id: type: string description: The Propexo unique identifier for the contract detail created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_category_id: type: - string - "null" description: The external ID of the category from the integration vendor x_financial_account_id: type: - string - "null" description: The external ID of the financial account from the integration vendor category_description: type: - string - "null" description: The description of the category for the contract detail cost_code: type: - string - "null" description: The cost code of the contract detail custom_data: type: - object - "null" properties: {} invoiced_total_in_cents: type: &a301 - number - "null" description: The total amount invoiced, in cents, for the contract detail example: 100000 notes: type: - string - "null" description: Notes associated with the contract detail retention_percent: type: - string - "null" description: The retention percent of the contract detail total_amount_in_cents: type: &a302 - number - "null" description: The total amount of the contract detail example: 100000 contract_id: type: string description: The Propexo unique identifier for the contract financial_account_id: type: - string - "null" description: The Propexo unique identifier for the financial account property_id: type: string description: The Propexo unique identifier for the property integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" required: - id - created_at - updated_at - last_seen - x_id - x_property_id - x_location_id - x_category_id - x_financial_account_id - category_description - cost_code - custom_data - invoiced_total_in_cents - notes - retention_percent - total_amount_in_cents - contract_id - financial_account_id - property_id - integration_id - integration_vendor x-propexo: derivedFromModel: contract_details _v1_construction-jobs_contracts_{contract_id}_details_get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: type: array items: $ref: "#/components/schemas/ContractDetail" required: - meta - results _v1_deposit-summaries__get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query location_id: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. property_id: type: string description: The Propexo unique identifier for the property resident_id: type: string description: The Propexo unique identifier for the resident integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" x_building_id: type: string description: The external ID of the building (not necessarily the property) from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor lease_id: type: string description: The Propexo unique identifier for the lease invoice_id: type: string description: The Propexo unique identifier for the invoice refund_is_due: anyOf: - type: boolean - type: string description: Whether the refund is due for the deposit summary invoice_id_not_null: anyOf: - type: boolean - type: string description: Filter to only return deposit summaries where the invoice_id is not null _v1_deposit-summaries__get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: type: array items: type: object properties: id: type: string description: The Propexo unique identifier for the deposit summary created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_resident_id: type: string description: The external ID of the resident from the integration vendor x_building_id: type: - string - "null" description: The external ID of the building (not necessarily the property) from the integration vendor x_invoice_id: type: - string - "null" description: The external ID of the invoice from the integration vendor x_lease_id: type: - string - "null" description: The external ID of the lease from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_unit_id: type: - string - "null" description: The external ID of the unit from the integration vendor amount_charged_in_cents: type: &a116 - number - "null" description: The amount charged in cents example: 100000 amount_paid_in_cents: type: &a117 - number - "null" description: The amount paid in cents example: 100000 amount_refunded_in_cents: type: &a118 - number - "null" description: The amount refunded in cents example: 100000 notes: type: - string - "null" description: Notes associated with the deposit summary refund_amount_due_in_cents: type: &a119 - number - "null" description: The refund amount due in cents example: 100000 custom_data: type: - object - "null" properties: {} integration_data: type: - object - "null" properties: {} integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" invoice_id: type: - string - "null" description: The Propexo unique identifier for the invoice lease_id: type: - string - "null" description: The Propexo unique identifier for the lease unit_id: type: - string - "null" description: The Propexo unique identifier for the unit resident_id: type: string description: The Propexo unique identifier for the resident property_id: type: string description: The Propexo unique identifier for the property required: - id - created_at - updated_at - last_seen - x_id - x_property_id - x_resident_id - x_building_id - x_invoice_id - x_lease_id - x_location_id - x_unit_id - amount_charged_in_cents - amount_paid_in_cents - amount_refunded_in_cents - notes - refund_amount_due_in_cents - custom_data - integration_data - integration_id - integration_vendor - invoice_id - lease_id - unit_id - resident_id - property_id required: - meta - results _v1_deposit-summaries_{deposit_summary_id}_get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query _v1_deposit-summaries_{deposit_summary_id}_get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: type: object properties: id: type: string description: The Propexo unique identifier for the deposit summary created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_resident_id: type: string description: The external ID of the resident from the integration vendor x_building_id: type: - string - "null" description: The external ID of the building (not necessarily the property) from the integration vendor x_invoice_id: type: - string - "null" description: The external ID of the invoice from the integration vendor x_lease_id: type: - string - "null" description: The external ID of the lease from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_unit_id: type: - string - "null" description: The external ID of the unit from the integration vendor amount_charged_in_cents: type: *a116 description: The amount charged in cents example: 100000 amount_paid_in_cents: type: *a117 description: The amount paid in cents example: 100000 amount_refunded_in_cents: type: *a118 description: The amount refunded in cents example: 100000 notes: type: - string - "null" description: Notes associated with the deposit summary refund_amount_due_in_cents: type: *a119 description: The refund amount due in cents example: 100000 custom_data: type: - object - "null" properties: {} integration_data: type: - object - "null" properties: {} integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" invoice_id: type: - string - "null" description: The Propexo unique identifier for the invoice lease_id: type: - string - "null" description: The Propexo unique identifier for the lease unit_id: type: - string - "null" description: The Propexo unique identifier for the unit resident_id: type: string description: The Propexo unique identifier for the resident property_id: type: string description: The Propexo unique identifier for the property required: - id - created_at - updated_at - last_seen - x_id - x_property_id - x_resident_id - x_building_id - x_invoice_id - x_lease_id - x_location_id - x_unit_id - amount_charged_in_cents - amount_paid_in_cents - amount_refunded_in_cents - notes - refund_amount_due_in_cents - custom_data - integration_data - integration_id - integration_vendor - invoice_id - lease_id - unit_id - resident_id - property_id required: - meta - results _v1_deposit-summaries_{deposit_summary_id}_put_input: type: object properties: check_number: type: string minLength: 1 description: "The check number. Note: Must be unique per pay out." post_month: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The post month of the check. payment_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The payment date of the check. total_amount_in_cents: type: integer exclusiveMinimum: 0 description: "The total amount in cents paid out to the resident for the deposit refund. Note: Partial payments will be accepted, but the invoice will not be marked as paid until the full amount is paid." x_bank_id: type: string minLength: 1 description: The external ID of the bank from the integration vendor. You'll likely want to work with your customer to find the appropriate value here. payment_method: type: string enum: &a121 - CHECK - EFT description: "The payment method used for the refund payout. Note: To use EFT, the associated bank account must be configured for electronic payments." notes: type: string minLength: 1 description: The notes for the check. check_run_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date the check was run. financial_account_id: type: string description: The Propexo unique identifier for the financial account check_cleared_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date the check was cleared. is_not_reconciled: type: boolean description: Whether the check is not reconciled _v1_deposit-summaries_{deposit_summary_id}_put_output: type: object properties: job_id: type: string description: The ID of the job created to handle this operation data: type: object properties: {} required: - job_id - data _v1_deposit-summaries_yardi_{deposit_summary_id}_put_input: type: object properties: total_amount_in_cents: type: integer exclusiveMinimum: 0 description: "The total amount in cents paid out to the resident for the deposit refund. Note: Partial payments will be accepted, but the invoice will not be marked as paid until the full amount is paid." x_bank_id: type: string minLength: 1 description: The external ID of the bank from the integration vendor. You'll likely want to work with your customer to find the appropriate value here. payment_method: type: string enum: &a120 - CHECK - EFT description: "The payment method used for the refund payout. Note: To use EFT, the associated bank account must be configured for electronic payments." check_number: type: string minLength: 1 description: "The check number. Note: Must be unique per pay out." notes: type: string minLength: 1 description: The notes for the check. post_month: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The post month of the check. check_run_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date the check was run. financial_account_id: type: string description: The Propexo unique identifier for the financial account check_cleared_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date the check was cleared. is_not_reconciled: type: boolean description: Whether the check is not reconciled required: - total_amount_in_cents - x_bank_id - payment_method - check_number - notes - post_month - check_run_date _v1_deposit-summaries_yardi_{deposit_summary_id}_put_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: deposit_summary_id: type: string description: The Propexo unique identifier for the deposit summary total_amount_in_cents: type: integer exclusiveMinimum: 0 description: "The total amount in cents paid out to the resident for the deposit refund. Note: Partial payments will be accepted, but the invoice will not be marked as paid until the full amount is paid." x_bank_id: type: string minLength: 1 description: The external ID of the bank from the integration vendor. You'll likely want to work with your customer to find the appropriate value here. payment_method: type: string enum: *a120 description: "The payment method used for the refund payout. Note: To use EFT, the associated bank account must be configured for electronic payments." check_number: type: string minLength: 1 description: "The check number. Note: Must be unique per pay out." notes: type: string minLength: 1 description: The notes for the check. post_month: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The post month of the check. check_run_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date the check was run. financial_account_id: type: string description: The Propexo unique identifier for the financial account check_cleared_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date the check was cleared. is_not_reconciled: type: boolean description: Whether the check is not reconciled required: - deposit_summary_id - total_amount_in_cents - x_bank_id - payment_method - check_number - notes - post_month - check_run_date required: - meta - result _v1_deposit-summaries_yardi_rest_{deposit_summary_id}_put_input: type: object properties: total_amount_in_cents: type: integer exclusiveMinimum: 0 description: "The total amount in cents paid out to the resident for the deposit refund. Note: Partial payments will be accepted, but the invoice will not be marked as paid until the full amount is paid." x_bank_id: type: string minLength: 1 description: The external ID of the bank from the integration vendor. You'll likely want to work with your customer to find the appropriate value here. payment_method: type: string enum: *a121 description: "The payment method used for the refund payout. Note: To use EFT, the associated bank account must be configured for electronic payments." check_number: type: string minLength: 1 description: "The check number. Note: Must be unique per pay out." notes: type: string minLength: 1 description: The notes for the check. post_month: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The post month of the check. check_run_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date the check was run. financial_account_id: type: string description: The Propexo unique identifier for the financial account check_cleared_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date the check was cleared. is_not_reconciled: type: boolean description: Whether the check is not reconciled required: - total_amount_in_cents - x_bank_id - payment_method - check_number - notes - post_month - check_run_date _v1_deposit-summaries_yardi_rest_{deposit_summary_id}_put_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: deposit_summary_id: type: string description: The Propexo unique identifier for the deposit summary total_amount_in_cents: type: integer exclusiveMinimum: 0 description: "The total amount in cents paid out to the resident for the deposit refund. Note: Partial payments will be accepted, but the invoice will not be marked as paid until the full amount is paid." x_bank_id: type: string minLength: 1 description: The external ID of the bank from the integration vendor. You'll likely want to work with your customer to find the appropriate value here. payment_method: type: string enum: *a121 description: "The payment method used for the refund payout. Note: To use EFT, the associated bank account must be configured for electronic payments." check_number: type: string minLength: 1 description: "The check number. Note: Must be unique per pay out." notes: type: string minLength: 1 description: The notes for the check. post_month: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The post month of the check. check_run_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date the check was run. financial_account_id: type: string description: The Propexo unique identifier for the financial account check_cleared_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date the check was cleared. is_not_reconciled: type: boolean description: Whether the check is not reconciled required: - deposit_summary_id - total_amount_in_cents - x_bank_id - payment_method - check_number - notes - post_month - check_run_date required: - meta - result _v1_deposit-summaries_mri_{deposit_summary_id}_put_input: type: object properties: check_number: type: string minLength: 1 maxLength: 9 description: The check number post_month: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The post month of the check. payment_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The payment date of the check. required: - check_number - post_month - payment_date _v1_deposit-summaries_mri_{deposit_summary_id}_put_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: deposit_summary_id: type: string description: The Propexo unique identifier for the deposit summary check_number: type: string minLength: 1 maxLength: 9 description: The check number post_month: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The post month of the check. payment_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The payment date of the check. required: - deposit_summary_id - check_number - post_month - payment_date required: - meta - result _v1_deposit-summaries_yardi_deposit-refund-account-number__get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query integration_id: type: string description: The Propexo unique identifier for the integration DepositRefundAccountNumber: type: object properties: id: type: string description: The Propexo unique identifier for the deposit refund account number created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo account_number: type: string description: The deposit refund account number integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" required: - id - created_at - updated_at - account_number - integration_id - integration_vendor x-propexo: derivedFromModel: deposit_refund_account_numbers _v1_deposit-summaries_yardi_deposit-refund-account-number__get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: type: array items: $ref: "#/components/schemas/DepositRefundAccountNumber" required: - meta - results _v1_deposit-summaries_yardi_deposit-refund-account-number__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration x_account_number: type: string minLength: 1 description: The deposit refund account number. You'll likely want to work with your customer to find this value. required: - integration_id - x_account_number _v1_deposit-summaries_yardi_deposit-refund-account-number__post_output: type: object properties: result: type: object properties: id: type: string description: The unique identifier for the deposit refund account number created_at: type: string description: The date the deposit refund account number was created updated_at: type: string description: The date the deposit refund account number was last updated integration_id: type: string description: The Propexo unique identifier for the integration account_number: type: string description: "The deposit refund account number. Note: Must match an account number from an existing financial account record in Propexo for this integration." required: - id - created_at - updated_at - integration_id - account_number required: - result _v1_deposit-summaries_yardi_deposit-refund-account-number_{deposit_refund_account_number_id}_get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query _v1_deposit-summaries_yardi_deposit-refund-account-number_{deposit_refund_account_number_id}_get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: $ref: "#/components/schemas/DepositRefundAccountNumber" required: - meta - results _v1_deposit-summaries_yardi_deposit-refund-account-number_{deposit_refund_account_number_id}_delete_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query _v1_deposit-summaries_yardi_deposit-refund-account-number_{deposit_refund_account_number_id}_delete_output: type: object properties: result: type: object properties: id: type: string description: The ID of the deposit refund account number that was deleted required: - id required: - result _v1_deposits__get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query location_id: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. property_id: type: string description: The Propexo unique identifier for the property resident_id: type: string description: The Propexo unique identifier for the resident integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" x_building_id: type: string description: The external ID of the building (not necessarily the property) from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor lease_id: type: string description: The Propexo unique identifier for the lease refund_is_due: anyOf: - type: boolean - type: string description: Whether the refund is due for the deposit _v1_deposits__get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: type: array items: type: object properties: id: type: string description: The Propexo unique identifier for the deposit created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_resident_id: type: string description: The external ID of the resident from the integration vendor x_building_id: type: - string - "null" description: The external ID of the building (not necessarily the property) from the integration vendor x_deposit_type: type: - string - "null" description: The external type of the deposit from the integration vendor x_lease_id: type: - string - "null" description: The external ID of the lease from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. amount_charged_in_cents: type: &a122 - number - "null" description: The amount charged in cents example: 100000 amount_paid_in_cents: type: &a123 - number - "null" description: The amount paid in cents example: 100000 amount_refunded_in_cents: type: &a124 - number - "null" description: The amount refunded in cents example: 100000 notes: type: - string - "null" description: Notes associated with the deposit refund_amount_due_in_cents: type: &a125 - number - "null" description: The refund amount due in cents example: 100000 custom_data: type: - object - "null" properties: {} integration_data: type: - object - "null" properties: {} integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" lease_id: type: - string - "null" description: The Propexo unique identifier for the lease resident_id: type: string description: The Propexo unique identifier for the resident property_id: type: string description: The Propexo unique identifier for the property required: - id - created_at - updated_at - last_seen - x_id - x_property_id - x_resident_id - x_building_id - x_deposit_type - x_lease_id - x_location_id - amount_charged_in_cents - amount_paid_in_cents - amount_refunded_in_cents - notes - refund_amount_due_in_cents - custom_data - integration_data - integration_id - integration_vendor - lease_id - resident_id - property_id required: - meta - results _v1_deposits_{id}_get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query _v1_deposits_{id}_get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: type: object properties: id: type: string description: The Propexo unique identifier for the deposit created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_resident_id: type: string description: The external ID of the resident from the integration vendor x_building_id: type: - string - "null" description: The external ID of the building (not necessarily the property) from the integration vendor x_deposit_type: type: - string - "null" description: The external type of the deposit from the integration vendor x_lease_id: type: - string - "null" description: The external ID of the lease from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. amount_charged_in_cents: type: *a122 description: The amount charged in cents example: 100000 amount_paid_in_cents: type: *a123 description: The amount paid in cents example: 100000 amount_refunded_in_cents: type: *a124 description: The amount refunded in cents example: 100000 notes: type: - string - "null" description: Notes associated with the deposit refund_amount_due_in_cents: type: *a125 description: The refund amount due in cents example: 100000 custom_data: type: - object - "null" properties: {} integration_data: type: - object - "null" properties: {} integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" lease_id: type: - string - "null" description: The Propexo unique identifier for the lease resident_id: type: string description: The Propexo unique identifier for the resident property_id: type: string description: The Propexo unique identifier for the property required: - id - created_at - updated_at - last_seen - x_id - x_property_id - x_resident_id - x_building_id - x_deposit_type - x_lease_id - x_location_id - amount_charged_in_cents - amount_paid_in_cents - amount_refunded_in_cents - notes - refund_amount_due_in_cents - custom_data - integration_data - integration_id - integration_vendor - lease_id - resident_id - property_id required: - meta - results _v1_employees__get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query location_id: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. property_id: type: string description: The Propexo unique identifier for the property integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" Employee: type: object properties: id: type: string description: The Propexo unique identifier for the employee created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: type: - string - "null" description: The name associated with the employee email: type: - string - "null" description: The primary email address associated with the employee is_active: type: - boolean - "null" description: Whether the employee is active roles: type: array items: type: string integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" property_id: type: string description: The Propexo unique identifier for the property required: - id - created_at - updated_at - last_seen - x_id - x_property_id - x_location_id - name - email - is_active - roles - integration_id - integration_vendor - property_id x-propexo: derivedFromModel: employees _v1_employees__get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: type: array items: $ref: "#/components/schemas/Employee" required: - meta - results _v1_employees_{employee_id}_get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query _v1_employees_{employee_id}_get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: $ref: "#/components/schemas/Employee" required: - meta - results _v1_events__get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query x_id: type: string description: The external ID of the event from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_type_id: type: string description: The external ID of the type from the integration vendor location_id: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. property_id: type: string description: The Propexo unique identifier for the property lead_id: type: string description: The Propexo unique identifier for the lead applicant_id: type: string description: The Propexo unique identifier for the applicant resident_id: type: string description: The Propexo unique identifier for the resident integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" _v1_events__get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: type: array items: $ref: "#/components/schemas/Event" required: - meta - results _v1_events_{event_id}_get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query _v1_events_{event_id}_get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: $ref: "#/components/schemas/Event" required: - meta - results _v1_events_applicants_post_input: type: object properties: integration_id: type: string applicant_id: type: string description: The Propexo unique identifier for the applicant event_type: type: string enum: &a128 - Note default: Note description: The type of event notes: type: string maxLength: 256 description: Notes associated with the event application_id: type: string description: The Propexo unique identifier for the application event_type_id: type: string description: The Propexo unique identifier for the event type event_result_id: type: string description: The Propexo unique identifier for the event result event_sub_type_id: type: string description: The Propexo unique identifier for the event sub type employee_id: type: string description: The Propexo unique identifier for the employee. Must have a role of LEASING_AGENT unit_id: type: string description: The Propexo unique identifier for the unit. Only some PMS events use this, including "Show" and "Appointment" event_datetime: type: string format: date-time description: The date when the event will occur reasons_for_event: type: string description: The reasons for the event appointment_datetime: type: string format: date-time description: The date when the appointment will occur time_from: type: string time_to: type: string title: type: string description: The title associated with the event call_phone_number_from: type: string description: The phone number that the call was made from. Required for call event types. call_phone_number_to: type: string description: The phone number that the call was received on. Required for call event types. call_status: type: string enum: &a126 - BUSY - ABANDONED - DISCONNECTED - FAILURE_TO_CONNECT - NO_ANSWER - ANSWER - VOICEMAIL description: The status of the call. Required for call event types. call_duration: type: integer minimum: 0 maximum: 86400 description: The duration of the call in seconds. Required for call event types. call_audio_link: type: string format: uri description: The URL of the audio file for the call. This can be any valid URL and doesn't necessarily need to link to a audio file. Required for call event types. email_body: type: string description: The body of the email. email_subject: type: string description: The subject of the email. email_from: type: string description: The email address that the email was sent from. Required for email outgoing event types. email_to: type: string description: The email address that the email was sent to. If specified, this must be the same email address as the lead's primary email address email_cc: type: string description: The carbon copy email address that the email was sent to. email_bcc: type: string description: The blind carbon copy email address that the email was sent to. email_send: type: boolean description: Whether the email should be sent. status: type: string enum: &a129 - COMPLETED - OPEN - REVIEW - DENIED description: The raw status associated with the event event_name: type: string enum: &a127 - CallToProspect - CallFromProspect - Other - WalkIn - Chat - Email - Webservice - Appointment - Show - Application - SelfGuidedTour - Application - Approve - CancelApplication - ApplicationDenied - Hold - CancelAppointment - LeaseSign - Release - ReturnVisit description: The name or type of event agent_name: type: string description: The name of the leasing agent associated with the event rent_amount_in_cents: type: number minimum: 0 description: The rent amount in cents for the event. Required for LeaseSign event required: - integration_id _v1_events_applicants_post_output: type: object properties: job_id: type: string description: The ID of the job created to handle this operation data: type: object properties: {} required: - job_id - data _v1_events_leads_post_input: type: object properties: integration_id: type: string lead_id: type: string description: The Propexo unique identifier for the lead event_type_id: type: string description: The Propexo unique identifier for the event type event_result_id: type: string description: The Propexo unique identifier for the event result event_sub_type_id: type: string description: The Propexo unique identifier for the event sub type employee_id: type: string description: The Propexo unique identifier for the employee unit_id: type: string description: The Propexo unique identifier for the unit. Only some PMS events use this, including "Show" and "Appointment" event_datetime: type: string format: date-time description: The date when the event will occur reasons_for_event: type: string description: The reasons for the event notes: type: string maxLength: 256 description: Notes associated with the event appointment_datetime: type: string format: date-time description: The date when the appointment will occur time_from: type: string time_to: type: string title: type: string description: The title associated with the event call_phone_number_from: type: string description: The phone number that the call was made from. Required for call event types. call_phone_number_to: type: string description: The phone number that the call was received on. Required for call event types. call_status: type: string enum: *a126 description: The status of the call. Required for call event types. call_duration: type: integer minimum: 0 maximum: 86400 description: The duration of the call in seconds. Required for call event types. call_audio_link: type: string format: uri description: The URL of the audio file for the call. This can be any valid URL and doesn't necessarily need to link to a audio file. Required for call event types. email_body: type: string description: The body of the email. email_subject: type: string description: The subject of the email. email_from: type: string description: The email address that the email was sent from. Required for email outgoing event types. email_to: type: string description: The email address that the email was sent to. If specified, this must be the same email address as the lead's primary email address email_cc: type: string description: The carbon copy email address that the email was sent to. email_bcc: type: string description: The blind carbon copy email address that the email was sent to. email_send: type: boolean description: Whether the email should be sent. status: type: string enum: - LEASED - LOST - UNQUALIFIED - ACTIVE - FUTURE description: The status associated with the event event_name: type: string enum: *a127 description: The name or type of event call_recording_url: type: string format: uri description: Call Recording URL of the appointment lead_source_id: type: string description: The Propexo unique identifier for the lead source agent_name: type: string description: The name of the leasing agent associated with the event rent_amount_in_cents: type: number minimum: 0 description: The rent amount in cents for the event. Required for LeaseSign event required: - integration_id _v1_events_leads_post_output: type: object properties: job_id: type: string description: The ID of the job created to handle this operation data: type: object properties: {} required: - job_id - data _v1_events_residents_post_input: type: object properties: integration_id: type: string resident_id: type: string description: The Propexo unique identifier for the resident event_type: type: string enum: &a136 - Note default: Note description: The type of event notes: type: string description: Notes associated with the event event_type_id: type: string description: The Propexo unique identifier for the event type event_result_id: type: string description: The Propexo unique identifier for the event result event_sub_type_id: type: string description: The Propexo unique identifier for the event sub type employee_id: type: string description: The Propexo unique identifier for the employee. Must have a role of LEASING_AGENT unit_id: type: string description: The Propexo unique identifier for the unit event_datetime: type: string format: date-time description: The date when the event will occur reasons_for_event: type: string description: The reasons for the event appointment_datetime: type: string format: date-time description: The date when the appointment will occur time_from: type: string time_to: type: string title: type: string description: The title associated with the event call_phone_number_from: type: string description: The phone number that the call was made from. Required for call event types. call_phone_number_to: type: string description: The phone number that the call was received on. Required for call event types. call_status: type: string enum: *a126 description: The status of the call. Required for call event types. call_duration: type: integer minimum: 0 maximum: 86400 description: The duration of the call in seconds. Required for call event types. call_audio_link: type: string format: uri description: The URL of the audio file for the call. This can be any valid URL and doesn't necessarily need to link to a audio file. Required for call event types. email_body: type: string description: The body of the email. email_subject: type: string description: The subject of the email. email_from: type: string description: The email address that the email was sent from. Required for email outgoing event types. email_to: type: string description: The email address that the email was sent to. If specified, this must be the same email address as the resident's primary email address email_cc: type: string description: The carbon copy email address that the email was sent to. email_bcc: type: string description: The blind carbon copy email address that the email was sent to. email_send: type: boolean description: Whether the email should be sent. status: type: string enum: &a137 - COMPLETED - OPEN - REVIEW - DENIED description: The raw status associated with the event event_name: type: string description: The name or type of event required: - integration_id _v1_events_residents_post_output: type: object properties: job_id: type: string description: The ID of the job created to handle this operation data: type: object properties: {} required: - job_id - data _v1_event-types__get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor location_id: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. property_id: type: string description: The Propexo unique identifier for the property models: type: array items: type: string description: The Propexo data models (e.g. units, residents, applicants, etc.) associated with the event type integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" EventType: type: object properties: id: type: string description: The Propexo unique identifier for the event type created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. code: type: - string - "null" description: The code associated with the event type models: type: array items: type: string name: type: string description: The name associated with the event type integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" property_id: type: string description: The Propexo unique identifier for the property required: - id - created_at - updated_at - last_seen - x_id - x_property_id - x_location_id - code - models - name - integration_id - integration_vendor - property_id x-propexo: derivedFromModel: event_types _v1_event-types__get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: type: array items: $ref: "#/components/schemas/EventType" required: - meta - results _v1_event-types_{event_type_id}_get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query _v1_event-types_{event_type_id}_get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: $ref: "#/components/schemas/EventType" required: - meta - results _v1_event-sub-types__get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor location_id: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. property_id: type: string description: The Propexo unique identifier for the property integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" event_type_id: type: string description: The Propexo unique identifier for the event type EventSubType: type: object properties: id: type: string description: The Propexo unique identifier for the event sub type created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_event_type_id: type: - string - "null" description: The external ID of the event type from the integration vendor name: type: string description: The name associated with the event sub type integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" property_id: type: string description: The Propexo unique identifier for the property event_type_id: type: - string - "null" description: The Propexo unique identifier for the event type required: - id - created_at - updated_at - last_seen - x_id - x_property_id - x_location_id - x_event_type_id - name - integration_id - integration_vendor - property_id - event_type_id x-propexo: derivedFromModel: event_sub_types _v1_event-sub-types__get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: type: array items: $ref: "#/components/schemas/EventSubType" required: - meta - results _v1_event-sub-types_{event_sub_type_id}_get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query _v1_event-sub-types_{event_sub_type_id}_get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: $ref: "#/components/schemas/EventSubType" required: - meta - results _v1_event-results__get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor location_id: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. property_id: type: string description: The Propexo unique identifier for the property integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" EventResult: type: object properties: id: type: string description: The Propexo unique identifier for the event type created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: type: string description: The name associated with the event type integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" property_id: type: string description: The Propexo unique identifier for the property associated_event_type_ids: type: array items: type: string required: - id - created_at - updated_at - last_seen - x_id - x_property_id - x_location_id - name - integration_id - integration_vendor - property_id - associated_event_type_ids x-propexo: derivedFromModel: event_results _v1_event-results__get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: type: array items: $ref: "#/components/schemas/EventResult" required: - meta - results _v1_event-results_{event_result_id}_get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query _v1_event-results_{event_result_id}_get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: $ref: "#/components/schemas/EventResult" required: - meta - results _v1_events_applicants_{event_id}_put_input: type: object properties: event_datetime: type: string format: date-time description: The date when the event will occur event_type_id: type: string description: The Propexo unique identifier for the event type employee_id: type: string description: The Propexo unique identifier for the employee. Must have a role of LEASING_AGENT status: type: string enum: &a130 - COMPLETED - OPEN - REVIEW - DENIED description: The raw status associated with the event notes: type: string description: Notes associated with the event _v1_events_applicants_{event_id}_put_output: type: object properties: job_id: type: string description: The ID of the job created to handle this operation data: type: object properties: {} required: - job_id - data _v1_events_leads_{event_id}_put_input: type: object properties: event_datetime: type: string format: date-time description: The date when the event will occur event_type_id: type: string description: The Propexo unique identifier for the event type employee_id: type: string description: The Propexo unique identifier for the employee. Must have a role of LEASING_AGENT status: type: string enum: &a135 - COMPLETED - OPEN - REVIEW - DENIED description: The raw status associated with the event notes: type: string description: Notes associated with the event _v1_events_leads_{event_id}_put_output: type: object properties: job_id: type: string description: The ID of the job created to handle this operation data: type: object properties: {} required: - job_id - data _v1_events_residents_{event_id}_put_input: type: object properties: event_datetime: type: string format: date-time description: The date when the event will occur event_type_id: type: string description: The Propexo unique identifier for the event type employee_id: type: string description: The Propexo unique identifier for the employee. Must have a role of LEASING_AGENT status: type: string enum: &a138 - COMPLETED - OPEN - REVIEW - DENIED description: The raw status associated with the event notes: type: string description: Notes associated with the event _v1_events_residents_{event_id}_put_output: type: object properties: job_id: type: string description: The ID of the job created to handle this operation data: type: object properties: {} required: - job_id - data _v1_event-types_mri__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration action_code: type: string minLength: 1 maxLength: 2 description: The action code that you want to create description: type: string description: Description of the event type required: - integration_id - action_code _v1_event-types_mri__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration action_code: type: string minLength: 1 maxLength: 2 description: The action code that you want to create description: type: - string - "null" description: Description of the event type required: - integration_id - action_code - description required: - meta - result _v1_events_applicants_buildium__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration applicant_id: type: string description: The Propexo unique identifier for the applicant event_type: type: string enum: *a128 default: Note description: The type of event notes: type: string description: Notes associated with the event required: - integration_id - applicant_id - notes _v1_events_applicants_buildium__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration applicant_id: type: string description: The Propexo unique identifier for the applicant event_type: type: string enum: *a128 default: Note description: The type of event notes: type: string description: Notes associated with the event required: - integration_id - applicant_id - notes required: - meta - result _v1_events_applicants_entrata__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration applicant_id: type: string description: The Propexo unique identifier for the applicant application_id: type: string description: The Propexo unique identifier for the application event_type_id: type: string description: The Propexo unique identifier for the event type. Not all event types are currently supported. Contact Propexo support if there's an event type you'd like supported. event_result_id: type: string description: The Propexo unique identifier for the event result event_sub_type_id: type: string description: The Propexo unique identifier for the event sub type employee_id: type: string description: The Propexo unique identifier for the employee unit_id: type: string description: The Propexo unique identifier for the unit event_datetime: type: string format: date-time description: The date when the event will occur reasons_for_event: type: string description: The reasons for the event notes: type: string description: Notes associated with the event appointment_datetime: type: string format: date-time description: The date when the appointment will occur time_from: type: string time_to: type: string title: type: string description: The title associated with the event call_phone_number_from: type: string description: The phone number that the call was made from. Required for call event types. call_phone_number_to: type: string description: The phone number that the call was received on. Required for call event types. call_status: type: string enum: *a126 description: The status of the call. Required for call event types. call_duration: type: integer minimum: 0 maximum: 86400 description: The duration of the call in seconds. Required for call event types. call_audio_link: type: string format: uri description: The URL of the audio file for the call. This can be any valid URL and doesn't necessarily need to link to a audio file. Required for call event types. email_body: type: string description: The body of the email. email_subject: type: string description: The subject of the email. email_from: type: string description: The email address that the email was sent from. Required for email outgoing event types. email_to: type: string description: The email address that the email was sent to. If specified, this must be the same email address as the lead's primary email address email_cc: type: string description: The carbon copy email address that the email was sent to. email_bcc: type: string description: The blind carbon copy email address that the email was sent to. email_send: type: boolean description: Whether the email should be sent. required: - integration_id - applicant_id - application_id - event_type_id - event_datetime _v1_events_applicants_entrata__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration applicant_id: type: string description: The Propexo unique identifier for the applicant application_id: type: string description: The Propexo unique identifier for the application event_type_id: type: string description: The Propexo unique identifier for the event type. Not all event types are currently supported. Contact Propexo support if there's an event type you'd like supported. event_result_id: type: - string - "null" description: The Propexo unique identifier for the event result event_sub_type_id: type: - string - "null" description: The Propexo unique identifier for the event sub type employee_id: type: - string - "null" description: The Propexo unique identifier for the employee unit_id: type: - string - "null" description: The Propexo unique identifier for the unit event_datetime: type: string format: date-time description: The date when the event will occur reasons_for_event: type: - string - "null" description: The reasons for the event notes: type: - string - "null" description: Notes associated with the event appointment_datetime: type: - string - "null" format: date-time description: The date when the appointment will occur time_from: type: - string - "null" description: The time that the appointment will start. HH:MM:SS format. Required if using appointment type. time_to: type: - string - "null" description: The time that the appointment will end. HH:MM:SS format. Required if using appointment type. title: type: - string - "null" description: The title associated with the event call_phone_number_from: type: - string - "null" description: The phone number that the call was made from. Required for call event types. call_phone_number_to: type: - string - "null" description: The phone number that the call was received on. Required for call event types. call_status: type: - string - "null" enum: *a126 description: The status of the call. Required for call event types. call_duration: type: - integer - "null" minimum: 0 maximum: 86400 description: The duration of the call in seconds. Required for call event types. call_audio_link: type: - string - "null" format: uri description: The URL of the audio file for the call. This can be any valid URL and doesn't necessarily need to link to a audio file. Required for call event types. email_body: type: - string - "null" description: The body of the email. email_subject: type: - string - "null" description: The subject of the email. email_from: type: - string - "null" description: The email address that the email was sent from. Required for email outgoing event types. email_to: type: - string - "null" description: The email address that the email was sent to. If specified, this must be the same email address as the lead's primary email address email_cc: type: - string - "null" description: The carbon copy email address that the email was sent to. email_bcc: type: - string - "null" description: The blind carbon copy email address that the email was sent to. email_send: type: - boolean - "null" description: Whether the email should be sent. required: - integration_id - applicant_id - application_id - event_type_id - event_result_id - event_sub_type_id - employee_id - unit_id - event_datetime - reasons_for_event - notes - appointment_datetime - time_from - time_to - title - call_phone_number_from - call_phone_number_to - call_status - call_duration - call_audio_link - email_body - email_subject - email_from - email_to - email_cc - email_bcc - email_send required: - meta - result _v1_events_applicants_propertyware__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration applicant_id: type: string description: The Propexo unique identifier for the applicant notes: type: string description: Notes associated with the event event_name: type: string description: The name or type of event event_datetime: type: string format: date-time description: The date when the event will occur required: - integration_id - applicant_id - notes - event_name _v1_events_applicants_propertyware__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration applicant_id: type: string description: The Propexo unique identifier for the applicant notes: type: string description: Notes associated with the event event_name: type: string description: The name or type of event event_datetime: type: - string - "null" format: date-time description: The date when the event will occur required: - integration_id - applicant_id - notes - event_name - event_datetime required: - meta - result _v1_events_applicants_realpage_rpx__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration applicant_id: type: string description: The Propexo unique identifier for the applicant event_type_id: type: string description: The Propexo unique identifier for the event type notes: type: string description: Notes associated with the event required: - integration_id - applicant_id - event_type_id - notes _v1_events_applicants_realpage_rpx__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration applicant_id: type: string description: The Propexo unique identifier for the applicant event_type_id: type: string description: The Propexo unique identifier for the event type notes: type: string description: Notes associated with the event required: - integration_id - applicant_id - event_type_id - notes required: - meta - result _v1_events_applicants_realpage__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration applicant_id: type: string description: The Propexo unique identifier for the applicant event_type_id: type: string description: The Propexo unique identifier for the event type notes: type: string description: Notes associated with the event required: - integration_id - applicant_id - event_type_id - notes _v1_events_applicants_realpage__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration applicant_id: type: string description: The Propexo unique identifier for the applicant event_type_id: type: string description: The Propexo unique identifier for the event type notes: type: string description: Notes associated with the event required: - integration_id - applicant_id - event_type_id - notes required: - meta - result _v1_events_applicants_yardi__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration applicant_id: type: string description: The Propexo unique identifier for the applicant unit_id: type: string description: The Propexo unique identifier for the unit. Only some PMS events use this, including "Show" and "Appointment" event_name: type: string enum: *a127 description: The name or type of event event_datetime: type: string format: date-time description: The date when the event will occur agent_name: type: string description: The name of the leasing agent associated with the event notes: type: string maxLength: 256 description: Notes associated with the event rent_amount_in_cents: type: number minimum: 0 description: The rent amount in cents for the event. Required for LeaseSign event required: - integration_id - applicant_id - event_name - event_datetime - agent_name _v1_events_applicants_yardi__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration applicant_id: type: string description: The Propexo unique identifier for the applicant unit_id: type: - string - "null" description: The Propexo unique identifier for the unit. Only some PMS events use this, including "Show" and "Appointment" event_name: type: string enum: *a127 description: The name or type of event event_datetime: type: string format: date-time description: The date when the event will occur agent_name: type: string description: The name of the leasing agent associated with the event notes: type: - string - "null" maxLength: 256 description: Notes associated with the event rent_amount_in_cents: type: - number - "null" minimum: 0 description: The rent amount in cents for the event. Required for LeaseSign event required: - integration_id - applicant_id - unit_id - event_name - event_datetime - agent_name - notes - rent_amount_in_cents required: - meta - result _v1_events_applicants_mri__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration applicant_id: type: string description: The Propexo unique identifier for the applicant event_type_id: type: string description: The Propexo unique identifier for the event type event_datetime: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date when the event will occur employee_id: type: string description: The Propexo unique identifier for the employee. Must have a role of LEASING_AGENT status: type: string enum: *a129 description: The raw status associated with the event notes: type: string description: Notes associated with the event required: - integration_id - applicant_id - event_type_id - event_datetime _v1_events_applicants_mri__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration applicant_id: type: string description: The Propexo unique identifier for the applicant event_type_id: type: string description: The Propexo unique identifier for the event type event_datetime: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" employee_id: type: - string - "null" description: The Propexo unique identifier for the employee. Must have a role of LEASING_AGENT status: type: - string - "null" enum: *a129 description: The raw status associated with the event notes: type: - string - "null" description: Notes associated with the event required: - integration_id - applicant_id - event_type_id - event_datetime - employee_id - status - notes required: - meta - result _v1_events_applicants_mri_{event_id}_put_input: type: object properties: event_datetime: type: string format: date-time description: The date when the event will occur event_type_id: type: string description: The Propexo unique identifier for the event type employee_id: type: string description: The Propexo unique identifier for the employee. Must have a role of LEASING_AGENT status: type: string enum: *a130 description: The raw status associated with the event notes: type: string description: Notes associated with the event required: - event_datetime - event_type_id _v1_events_applicants_mri_{event_id}_put_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: event_id: type: string description: The Propexo unique identifier for the event event_datetime: type: string format: date-time description: The date when the event will occur event_type_id: type: string description: The Propexo unique identifier for the event type employee_id: type: string description: The Propexo unique identifier for the employee. Must have a role of LEASING_AGENT status: type: string enum: *a130 description: The raw status associated with the event notes: type: string description: Notes associated with the event required: - event_id - event_datetime - event_type_id required: - meta - result _v1_events_leads_entrata__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration lead_id: type: string description: The Propexo unique identifier for the lead event_type_id: type: string description: The Propexo unique identifier for the event type. Not all event types are currently supported. Contact Propexo support if there's an event type you'd like supported. event_result_id: type: string description: The Propexo unique identifier for the event result event_sub_type_id: type: string description: The Propexo unique identifier for the event sub type employee_id: type: string description: The Propexo unique identifier for the employee unit_id: type: string description: The Propexo unique identifier for the unit event_datetime: type: string format: date-time description: The date when the event will occur reasons_for_event: type: string description: The reasons for the event notes: type: string description: Notes associated with the event appointment_datetime: type: string format: date-time description: The date when the appointment will occur time_from: type: string time_to: type: string title: type: string description: The title associated with the event call_phone_number_from: type: string description: The phone number that the call was made from. Required for call event types. call_phone_number_to: type: string description: The phone number that the call was received on. Required for call event types. call_status: type: string enum: *a126 description: The status of the call. Required for call event types. call_duration: type: integer minimum: 0 maximum: 86400 description: The duration of the call in seconds. Required for call event types. call_audio_link: type: string format: uri description: The URL of the audio file for the call. This can be any valid URL and doesn't necessarily need to link to a audio file. Required for call event types. email_body: type: string description: The body of the email. email_subject: type: string description: The subject of the email. email_from: type: string description: The email address that the email was sent from. Required for email outgoing event types. email_to: type: string description: The email address that the email was sent to. If specified, this must be the same email address as the lead's primary email address email_cc: type: string description: The carbon copy email address that the email was sent to. email_bcc: type: string description: The blind carbon copy email address that the email was sent to. email_send: type: boolean description: Whether the email should be sent. required: - integration_id - lead_id - event_type_id - event_datetime _v1_events_leads_entrata__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration lead_id: type: string description: The Propexo unique identifier for the lead event_type_id: type: string description: The Propexo unique identifier for the event type. Not all event types are currently supported. Contact Propexo support if there's an event type you'd like supported. event_result_id: type: - string - "null" description: The Propexo unique identifier for the event result event_sub_type_id: type: - string - "null" description: The Propexo unique identifier for the event sub type employee_id: type: - string - "null" description: The Propexo unique identifier for the employee unit_id: type: - string - "null" description: The Propexo unique identifier for the unit event_datetime: type: string format: date-time description: The date when the event will occur reasons_for_event: type: - string - "null" description: The reasons for the event notes: type: - string - "null" description: Notes associated with the event appointment_datetime: type: - string - "null" format: date-time description: The date when the appointment will occur time_from: type: - string - "null" description: The time that the appointment will start. HH:MM:SS format. Required if using appointment type. time_to: type: - string - "null" description: The time that the appointment will end. HH:MM:SS format. Required if using appointment type. title: type: - string - "null" description: The title associated with the event call_phone_number_from: type: - string - "null" description: The phone number that the call was made from. Required for call event types. call_phone_number_to: type: - string - "null" description: The phone number that the call was received on. Required for call event types. call_status: type: - string - "null" enum: *a126 description: The status of the call. Required for call event types. call_duration: type: - integer - "null" minimum: 0 maximum: 86400 description: The duration of the call in seconds. Required for call event types. call_audio_link: type: - string - "null" format: uri description: The URL of the audio file for the call. This can be any valid URL and doesn't necessarily need to link to a audio file. Required for call event types. email_body: type: - string - "null" description: The body of the email. email_subject: type: - string - "null" description: The subject of the email. email_from: type: - string - "null" description: The email address that the email was sent from. Required for email outgoing event types. email_to: type: - string - "null" description: The email address that the email was sent to. If specified, this must be the same email address as the lead's primary email address email_cc: type: - string - "null" description: The carbon copy email address that the email was sent to. email_bcc: type: - string - "null" description: The blind carbon copy email address that the email was sent to. email_send: type: - boolean - "null" description: Whether the email should be sent. required: - integration_id - lead_id - event_type_id - event_result_id - event_sub_type_id - employee_id - unit_id - event_datetime - reasons_for_event - notes - appointment_datetime - time_from - time_to - title - call_phone_number_from - call_phone_number_to - call_status - call_duration - call_audio_link - email_body - email_subject - email_from - email_to - email_cc - email_bcc - email_send required: - meta - result _v1_events_leads_propertyware__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration lead_id: type: string description: The Propexo unique identifier for the lead notes: type: string description: Notes associated with the event event_name: type: string description: The name or type of event event_datetime: type: string format: date-time description: The date when the event will occur required: - integration_id - lead_id - notes - event_name _v1_events_leads_propertyware__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration lead_id: type: string description: The Propexo unique identifier for the lead notes: type: string description: Notes associated with the event event_name: type: string description: The name or type of event event_datetime: type: - string - "null" format: date-time description: The date when the event will occur required: - integration_id - lead_id - notes - event_name - event_datetime required: - meta - result _v1_events_leads_realpage__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration lead_id: type: string description: The Propexo unique identifier for the lead event_name: type: string enum: &a131 - E-mail - Event - Fax/Letter - Internet - Notes - Phone call - Pre-recorded - Tour - Self-guided - Tour - Signature - Text message - Videotelephony - Tour - Visit - Visit (return) description: The name of the event in the PMS. These are specific to the PMS. event_datetime: type: - string - "null" description: The datetime that the event occured. notes: type: string description: Notes to associate with the event. required: - integration_id - lead_id - event_name _v1_events_leads_realpage__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration lead_id: type: string description: The Propexo unique identifier for the lead event_name: type: string enum: *a131 description: The name of the event in the PMS. These are specific to the PMS. event_datetime: type: - string - "null" description: The datetime that the event occured. notes: type: - string - "null" description: Notes to associate with the event. required: - integration_id - lead_id - event_name - event_datetime - notes required: - meta - result _v1_events_leads_rentmanager__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration lead_id: type: string description: The Propexo unique identifier for the lead event_name: type: string enum: &a132 - CALL - EMAIL - VISIT - NOTE description: The name or type of event notes: type: string description: Notes associated with the event required: - integration_id - lead_id - event_name _v1_events_leads_rentmanager__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration lead_id: type: string description: The Propexo unique identifier for the lead event_name: type: string enum: *a132 description: The name or type of event notes: type: - string - "null" description: Notes associated with the event required: - integration_id - lead_id - event_name - notes required: - meta - result _v1_events_leads_realpage_rpx__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration lead_id: type: string description: The Propexo unique identifier for the lead employee_id: type: string description: The Propexo unique identifier for the employee event_type_id: type: string description: The Propexo unique identifier for the event type unit_id: type: string description: The Propexo unique identifier for the unit event_datetime: type: string format: date-time description: The date when the event will occur status: type: string enum: - LEASED - LOST - UNQUALIFIED - ACTIVE - FUTURE description: The status associated with the event notes: type: string description: Notes associated with the event call_recording_url: type: string format: uri description: Call Recording URL of the appointment required: - integration_id - lead_id - employee_id - event_type_id - event_datetime _v1_events_leads_realpage_rpx__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration lead_id: type: string description: The Propexo unique identifier for the lead employee_id: type: string description: The Propexo unique identifier for the employee event_type_id: type: string description: The Propexo unique identifier for the event type unit_id: type: - string - "null" description: The Propexo unique identifier for the unit event_datetime: type: string format: date-time description: The date when the event will occur status: type: - string - "null" enum: - LEASED - LOST - UNQUALIFIED - ACTIVE - FUTURE description: The status associated with the event notes: type: - string - "null" description: Notes associated with the event call_recording_url: type: - string - "null" format: uri description: Call Recording URL of the appointment required: - integration_id - lead_id - employee_id - event_type_id - unit_id - event_datetime - status - notes - call_recording_url required: - meta - result _v1_events_leads_resman__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration lead_id: type: string description: The Propexo unique identifier for the lead lead_source_id: type: string description: The Propexo unique identifier for the lead source unit_id: type: string description: The Propexo unique identifier for the unit event_name: type: string enum: &a133 - EmailToProspect - EmailFromILS - EmailFromProspect - Email - CallToProspect - CallFromProspect - Phone - Show - WalkIn - Contact - Other - Cancel - ReActivate - TextToProspect - TextFromProspect - Application description: The name or type of event event_datetime: type: string format: date-time description: The date when the event will occur notes: type: string description: Notes associated with the event reasons_for_event: type: string description: The reasons for the event required: - integration_id - lead_id - event_name - event_datetime _v1_events_leads_resman__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration lead_id: type: string description: The Propexo unique identifier for the lead lead_source_id: type: - string - "null" description: The Propexo unique identifier for the lead source unit_id: type: - string - "null" description: The Propexo unique identifier for the unit event_name: type: string enum: *a133 description: The name or type of event event_datetime: type: string format: date-time description: The date when the event will occur notes: type: - string - "null" description: Notes associated with the event reasons_for_event: type: - string - "null" description: The reasons for the event required: - integration_id - lead_id - lead_source_id - unit_id - event_name - event_datetime - notes - reasons_for_event required: - meta - result _v1_events_leads_yardi__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration lead_id: type: string description: The Propexo unique identifier for the lead unit_id: type: string description: The Propexo unique identifier for the unit. Only some PMS events use this, including "Show" and "Appointment" event_name: type: string enum: *a127 description: The name or type of event event_datetime: type: string format: date-time description: The date when the event will occur agent_name: type: string description: The name of the leasing agent associated with the event notes: type: string maxLength: 256 description: Notes associated with the event rent_amount_in_cents: type: number minimum: 0 description: The rent amount in cents for the event. Required for LeaseSign event required: - integration_id - lead_id - event_name - event_datetime - agent_name _v1_events_leads_yardi__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration lead_id: type: string description: The Propexo unique identifier for the lead unit_id: type: - string - "null" description: The Propexo unique identifier for the unit. Only some PMS events use this, including "Show" and "Appointment" event_name: type: string enum: *a127 description: The name or type of event event_datetime: type: string format: date-time description: The date when the event will occur agent_name: type: string description: The name of the leasing agent associated with the event notes: type: - string - "null" maxLength: 256 description: Notes associated with the event rent_amount_in_cents: type: - number - "null" minimum: 0 description: The rent amount in cents for the event. Required for LeaseSign event required: - integration_id - lead_id - unit_id - event_name - event_datetime - agent_name - notes - rent_amount_in_cents required: - meta - result _v1_events_leads_mri__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration lead_id: type: string description: The Propexo unique identifier for the lead event_type_id: type: string description: The Propexo unique identifier for the event type event_datetime: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date when the event will occur employee_id: type: string description: The Propexo unique identifier for the employee. Must have a role of LEASING_AGENT status: type: string enum: &a134 - COMPLETED - OPEN - REVIEW - DENIED description: The raw status associated with the event notes: type: string description: Notes associated with the event required: - integration_id - lead_id - event_type_id - event_datetime _v1_events_leads_mri__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration lead_id: type: string description: The Propexo unique identifier for the lead event_type_id: type: string description: The Propexo unique identifier for the event type event_datetime: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" employee_id: type: - string - "null" description: The Propexo unique identifier for the employee. Must have a role of LEASING_AGENT status: type: - string - "null" enum: *a134 description: The raw status associated with the event notes: type: - string - "null" description: Notes associated with the event required: - integration_id - lead_id - event_type_id - event_datetime - employee_id - status - notes required: - meta - result _v1_events_leads_mri_{event_id}_put_input: type: object properties: event_datetime: type: string format: date-time description: The date when the event will occur event_type_id: type: string description: The Propexo unique identifier for the event type employee_id: type: string description: The Propexo unique identifier for the employee. Must have a role of LEASING_AGENT status: type: string enum: *a135 description: The raw status associated with the event notes: type: string description: Notes associated with the event required: - event_datetime - event_type_id _v1_events_leads_mri_{event_id}_put_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: event_id: type: string description: The Propexo unique identifier for the event event_datetime: type: string format: date-time description: The date when the event will occur event_type_id: type: string description: The Propexo unique identifier for the event type employee_id: type: string description: The Propexo unique identifier for the employee. Must have a role of LEASING_AGENT status: type: string enum: *a135 description: The raw status associated with the event notes: type: string description: Notes associated with the event required: - event_id - event_datetime - event_type_id required: - meta - result _v1_events_residents_buildium__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration resident_id: type: string description: The Propexo unique identifier for the resident event_type: type: string enum: *a136 default: Note description: The type of event notes: type: string description: Notes associated with the event required: - integration_id - resident_id - notes _v1_events_residents_buildium__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration resident_id: type: string description: The Propexo unique identifier for the resident event_type: type: string enum: *a136 default: Note description: The type of event notes: type: string description: Notes associated with the event required: - integration_id - resident_id - notes required: - meta - result _v1_events_residents_entrata__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration resident_id: type: string description: The Propexo unique identifier for the resident event_type_id: type: string description: The Propexo unique identifier for the event type. Not all event types are currently supported. Contact Propexo support if there's an event type you'd like supported. event_result_id: type: string description: The Propexo unique identifier for the event result event_sub_type_id: type: string description: The Propexo unique identifier for the event sub type employee_id: type: string description: The Propexo unique identifier for the employee unit_id: type: string description: The Propexo unique identifier for the unit event_datetime: type: string format: date-time description: The date when the event will occur reasons_for_event: type: string description: The reasons for the event notes: type: string description: Notes associated with the event appointment_datetime: type: string format: date-time description: The date when the appointment will occur time_from: type: string time_to: type: string title: type: string description: The title associated with the event call_phone_number_from: type: string description: The phone number that the call was made from. Required for call event types. call_phone_number_to: type: string description: The phone number that the call was received on. Required for call event types. call_status: type: string enum: *a126 description: The status of the call. Required for call event types. call_duration: type: integer minimum: 0 maximum: 86400 description: The duration of the call in seconds. Required for call event types. call_audio_link: type: string format: uri description: The URL of the audio file for the call. This can be any valid URL and doesn't necessarily need to link to a audio file. Required for call event types. email_body: type: string description: The body of the email. email_subject: type: string description: The subject of the email. email_from: type: string description: The email address that the email was sent from. Required for email outgoing event types. email_to: type: string description: The email address that the email was sent to. If specified, this must be the same email address as the resident's primary email address email_cc: type: string description: The carbon copy email address that the email was sent to. email_bcc: type: string description: The blind carbon copy email address that the email was sent to. email_send: type: boolean description: Whether the email should be sent. required: - integration_id - resident_id - event_type_id - event_datetime _v1_events_residents_entrata__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration resident_id: type: string description: The Propexo unique identifier for the resident event_type_id: type: string description: The Propexo unique identifier for the event type. Not all event types are currently supported. Contact Propexo support if there's an event type you'd like supported. event_result_id: type: - string - "null" description: The Propexo unique identifier for the event result event_sub_type_id: type: - string - "null" description: The Propexo unique identifier for the event sub type employee_id: type: - string - "null" description: The Propexo unique identifier for the employee unit_id: type: - string - "null" description: The Propexo unique identifier for the unit event_datetime: type: string format: date-time description: The date when the event will occur reasons_for_event: type: - string - "null" description: The reasons for the event notes: type: - string - "null" description: Notes associated with the event appointment_datetime: type: - string - "null" format: date-time description: The date when the appointment will occur time_from: type: - string - "null" description: The time that the appointment will start. HH:MM:SS format. Required if using appointment type. time_to: type: - string - "null" description: The time that the appointment will end. HH:MM:SS format. Required if using appointment type. title: type: - string - "null" description: The title associated with the event call_phone_number_from: type: - string - "null" description: The phone number that the call was made from. Required for call event types. call_phone_number_to: type: - string - "null" description: The phone number that the call was received on. Required for call event types. call_status: type: - string - "null" enum: *a126 description: The status of the call. Required for call event types. call_duration: type: - integer - "null" minimum: 0 maximum: 86400 description: The duration of the call in seconds. Required for call event types. call_audio_link: type: - string - "null" format: uri description: The URL of the audio file for the call. This can be any valid URL and doesn't necessarily need to link to a audio file. Required for call event types. email_body: type: - string - "null" description: The body of the email. email_subject: type: - string - "null" description: The subject of the email. email_from: type: - string - "null" description: The email address that the email was sent from. Required for email outgoing event types. email_to: type: - string - "null" description: The email address that the email was sent to. If specified, this must be the same email address as the resident's primary email address email_cc: type: - string - "null" description: The carbon copy email address that the email was sent to. email_bcc: type: - string - "null" description: The blind carbon copy email address that the email was sent to. email_send: type: - boolean - "null" description: Whether the email should be sent. required: - integration_id - resident_id - event_type_id - event_result_id - event_sub_type_id - employee_id - unit_id - event_datetime - reasons_for_event - notes - appointment_datetime - time_from - time_to - title - call_phone_number_from - call_phone_number_to - call_status - call_duration - call_audio_link - email_body - email_subject - email_from - email_to - email_cc - email_bcc - email_send required: - meta - result _v1_events_residents_propertyware__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration resident_id: type: string description: The Propexo unique identifier for the resident notes: type: string description: Notes associated with the event event_name: type: string description: The name or type of event event_datetime: type: string format: date-time description: The date when the event will occur required: - integration_id - resident_id - notes - event_name _v1_events_residents_propertyware__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration resident_id: type: string description: The Propexo unique identifier for the resident notes: type: string description: Notes associated with the event event_name: type: string description: The name or type of event event_datetime: type: - string - "null" format: date-time description: The date when the event will occur required: - integration_id - resident_id - notes - event_name - event_datetime required: - meta - result _v1_events_residents_realpage__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration resident_id: type: string description: The Propexo unique identifier for the resident event_type_id: type: string description: The Propexo unique identifier for the event type notes: type: string description: Notes associated with the event required: - integration_id - resident_id - event_type_id - notes _v1_events_residents_realpage__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration resident_id: type: string description: The Propexo unique identifier for the resident event_type_id: type: string description: The Propexo unique identifier for the event type notes: type: string description: Notes associated with the event required: - integration_id - resident_id - event_type_id - notes required: - meta - result _v1_events_residents_realpage_rpx__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration resident_id: type: string description: The Propexo unique identifier for the resident event_type_id: type: string description: The Propexo unique identifier for the event type notes: type: string description: Notes associated with the event required: - integration_id - resident_id - event_type_id - notes _v1_events_residents_realpage_rpx__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration resident_id: type: string description: The Propexo unique identifier for the resident event_type_id: type: string description: The Propexo unique identifier for the event type notes: type: string description: Notes associated with the event required: - integration_id - resident_id - event_type_id - notes required: - meta - result _v1_events_residents_mri__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration resident_id: type: string description: The Propexo unique identifier for the resident event_type_id: type: string description: The Propexo unique identifier for the event type event_datetime: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date when the event will occur employee_id: type: string description: The Propexo unique identifier for the employee. Must have a role of LEASING_AGENT status: type: string enum: *a137 description: The raw status associated with the event notes: type: string description: Notes associated with the event required: - integration_id - resident_id - event_type_id - event_datetime _v1_events_residents_mri__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration resident_id: type: string description: The Propexo unique identifier for the resident event_type_id: type: string description: The Propexo unique identifier for the event type event_datetime: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" employee_id: type: - string - "null" description: The Propexo unique identifier for the employee. Must have a role of LEASING_AGENT status: type: - string - "null" enum: *a137 description: The raw status associated with the event notes: type: - string - "null" description: Notes associated with the event required: - integration_id - resident_id - event_type_id - event_datetime - employee_id - status - notes required: - meta - result _v1_events_residents_mri_{event_id}_put_input: type: object properties: event_datetime: type: string format: date-time description: The date when the event will occur event_type_id: type: string description: The Propexo unique identifier for the event type employee_id: type: string description: The Propexo unique identifier for the employee. Must have a role of LEASING_AGENT status: type: string enum: *a138 description: The raw status associated with the event notes: type: string description: Notes associated with the event required: - event_datetime - event_type_id _v1_events_residents_mri_{event_id}_put_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: event_id: type: string description: The Propexo unique identifier for the event event_datetime: type: string format: date-time description: The date when the event will occur event_type_id: type: string description: The Propexo unique identifier for the event type employee_id: type: string description: The Propexo unique identifier for the employee. Must have a role of LEASING_AGENT status: type: string enum: *a138 description: The raw status associated with the event notes: type: string description: Notes associated with the event required: - event_id - event_datetime - event_type_id required: - meta - result _v1_file-types__get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor location_id: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. property_id: type: string description: The Propexo unique identifier for the file type type: type: string description: The type associated with the file type models: type: array items: type: string description: The Propexo data models (e.g. units, residents, applicants, etc.) associated with the file type integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" FileType: type: object properties: id: type: string description: The Propexo unique identifier for the file type created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. code: type: - string - "null" description: The code associated with the file type models: type: array items: type: string name: type: string description: The name associated with the file type type: type: string description: The type associated with the file type integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" property_id: type: string description: The Propexo unique identifier for the property required: - id - created_at - updated_at - last_seen - x_id - x_property_id - x_location_id - code - models - name - type - integration_id - integration_vendor - property_id x-propexo: derivedFromModel: file_types _v1_file-types__get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: type: array items: $ref: "#/components/schemas/FileType" required: - meta - results _v1_file-types__post_input: type: object properties: integration_id: type: string location_id: type: string description: The Propexo unique identifier for the location model: type: string enum: &a139 - units - residents - properties description: The Propexo data model (e.g. units, residents, applicants, etc.) for which you are attempting to upload a file name: type: string description: The name associated with the file type required: - integration_id _v1_file-types__post_output: type: object properties: job_id: type: string description: The ID of the job created to handle this operation data: type: object properties: {} required: - job_id - data _v1_file-types_{file_type_id}_get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query _v1_file-types_{file_type_id}_get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: $ref: "#/components/schemas/FileType" required: - meta - results _v1_file-types_rentmanager__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration location_id: type: string description: The Propexo unique identifier for the location model: type: string enum: *a139 description: The Propexo data model (e.g. units, residents, applicants, etc.) for which you are attempting to upload a file name: type: string description: The name associated with the file type required: - integration_id - location_id - model - name _v1_file-types_rentmanager__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration location_id: type: string description: The Propexo unique identifier for the location model: type: string enum: *a139 description: The Propexo data model (e.g. units, residents, applicants, etc.) for which you are attempting to upload a file name: type: string description: The name associated with the file type required: - integration_id - location_id - model - name required: - meta - result _v1_accounting-entities__get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query location_id: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. property_id: type: string description: The Propexo unique identifier for the property integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" _v1_accounting-entities__get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: type: array items: type: object properties: id: type: string description: The Propexo unique identifier for the accounting entity created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor entity_name: type: - string - "null" description: The name of the accounting entity ledger_code: type: string description: The ledger code associated to the accounting entity current_period: type: - string - "null" description: The current period of the accounting entity is_active: type: - boolean - "null" description: Whether the accounting entity is active integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" property_id: type: string description: The Propexo unique identifier for the property required: - id - created_at - updated_at - last_seen - x_id - x_property_id - entity_name - ledger_code - current_period - is_active - integration_id - integration_vendor - property_id required: - meta - results _v1_accounting-entities_{accounting_entity_id}_get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query _v1_accounting-entities_{accounting_entity_id}_get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: type: object properties: id: type: string description: The Propexo unique identifier for the accounting entity created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor entity_name: type: - string - "null" description: The name of the accounting entity ledger_code: type: string description: The ledger code associated to the accounting entity current_period: type: - string - "null" description: The current period of the accounting entity is_active: type: - boolean - "null" description: Whether the accounting entity is active integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" property_id: type: string description: The Propexo unique identifier for the property required: - id - created_at - updated_at - last_seen - x_id - x_property_id - entity_name - ledger_code - current_period - is_active - integration_id - integration_vendor - property_id required: - meta - results _v1_invoices__get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query location_id: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. property_id: type: string description: The Propexo unique identifier for the property integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" _v1_invoices__get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: type: array items: type: object properties: id: type: string description: The Propexo unique identifier for the invoice created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_vendor_id: type: - string - "null" description: The external ID of the vendor from the integration vendor x_financial_account_id: type: - string - "null" description: The external ID of the financial account from the integration vendor x_cash_financial_account_id: type: - string - "null" description: The external ID of the cash financial account from the integration vendor x_ap_financial_account_id: type: - string - "null" description: The external ID of the AP financial account from the integration vendor amount_due_in_cents: type: &a140 - number - "null" description: The amount due on the invoice, in cents example: 100000 amount_paid_in_cents: type: &a141 - number - "null" description: The amount paid on the invoice, in cents example: 100000 custom_data: type: - object - "null" properties: {} due_date: type: - string - "null" description: The due date associated with the invoice discount_amount_in_cents: type: &a142 - number - "null" description: The deposit amount in cents associated with the invoice example: 100000 discount_date: type: - string - "null" description: The date a discount was issued on invoice invoice_date: type: - string - "null" description: The date the invoice was issued invoice_number: type: - string - "null" description: The reference number for the invoice notes: type: - string - "null" description: Notes associated with the invoice post_date: type: - string - "null" description: The date the invoice was posted. Some PMS systems only show the month. post_month: type: - string - "null" description: The month the invoice was posted. post_status_raw: type: - string - "null" description: The raw post status associated with the invoice sub_total_amount_in_cents: type: &a143 - number - "null" description: The sub total amount of the invoice example: 100000 total_amount_in_cents: type: &a144 - number - "null" description: The amount of the invoice, in cents example: 100000 property_id: type: string description: The Propexo unique identifier for the property financial_account_id: type: - string - "null" description: The Propexo unique identifier for the financial account cash_financial_account_id: type: - string - "null" description: The Propexo unique identifier for the cash financial account ap_financial_account_id: type: - string - "null" description: The Propexo unique identifier for the ap financial account integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" invoice_items: type: array items: type: object properties: x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_gl_account_id: type: - string - "null" description: The external ID of the financial account from the integration vendor x_cash_financial_account_id: type: - string - "null" description: The external ID of the cash financial account from the integration vendor invoice_id: type: string description: The Propexo unique identifier for the invoice construction_job_id: type: - string - "null" description: The Propexo unique identifier for the construction job amount_due_in_cents: type: &a145 - number - "null" description: The amount due on the invoice item, in cents example: 100000 notes: type: - string - "null" description: Notes associated with the invoice item total_amount_in_cents: type: &a146 - number - "null" description: The amount of the invoice item, in cents example: 100000 property_id: type: string description: The Propexo unique identifier for the property financial_account_id: type: - string - "null" description: The Propexo unique identifier for the financial account cash_financial_account_id: type: - string - "null" description: The Propexo unique identifier for the cash financial account required: - x_id - x_property_id - x_location_id - x_gl_account_id - x_cash_financial_account_id - invoice_id - construction_job_id - amount_due_in_cents - notes - total_amount_in_cents - property_id - financial_account_id - cash_financial_account_id x-propexo: &a147 derivedFromModel: invoice_items required: - id - created_at - updated_at - last_seen - x_id - x_property_id - x_location_id - x_vendor_id - x_financial_account_id - x_cash_financial_account_id - x_ap_financial_account_id - amount_due_in_cents - amount_paid_in_cents - custom_data - due_date - discount_amount_in_cents - discount_date - invoice_date - invoice_number - notes - post_date - post_month - post_status_raw - sub_total_amount_in_cents - total_amount_in_cents - property_id - financial_account_id - cash_financial_account_id - ap_financial_account_id - integration_id - integration_vendor - invoice_items required: - meta - results _v1_invoices__post_input: type: object properties: integration_id: type: string vendor_id: type: string description: The Propexo unique identifier for the vendor invoice_date: type: string format: date-time description: The date of issuance for the invoice due_date: type: string format: date-time description: The due date associated with the invoice invoice_items: type: array items: type: object properties: property_id: type: string description: The Propexo unique identifier for the property financial_account_id: type: string description: The Propexo unique identifier for the financial account total_amount_in_cents: type: number description: The amount of the invoice item, in cents notes: type: string description: Notes associated with the invoice item required: - property_id - financial_account_id - total_amount_in_cents - notes description: type: string description: Description of the invoice invoice_number: type: string description: The invoice or reference number that the vendor assigned to the service request service_request_id: type: string description: The Propexo unique identifier for the service request vendor_location_id: type: string description: The Propexo unique identifier for the vendor location total_amount_in_cents: type: number description: The amount of the invoice, in cents ap_financial_account_id: type: string description: The Propexo unique identifier for the financial account. You'll likely want to work with your customer to know what value is appropriate here. post_month: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The post month for the invoice. We will strip all data out of the datetime except the year and month. discount_amount_in_cents: type: number description: The discount, in cents, of the invoice. This amount will be applied prior to the total amount being calculated. notes: type: string description: Notes associated with the invoice attachments: type: array items: type: object properties: file_data: type: string maxLength: 69730304 description: The contents of the file, as a base64 encoded string. The PMS has a max file size of 50 MB. file_name: type: string description: 'The name of the file including the extension. Ex: "image.jpg"' mime_type: type: string description: 'The mime type of the file. Ex: "image/jpeg"' required: - file_data - file_name - mime_type description: Files to upload for the invoice. All the files can have a maximum combined file size of 50 MB partner_name: type: string description: The name of your integration with MRI scanned_copy_url: type: string description: The URL assigned to the copy of the original invoice that was imported from a third-party system purchase_order_number: type: string description: Set this parameter to the purchase order number that contains the line items to be invoiced. MRI will validate and link the invoice to the specified purchase order for processing. separate_check: type: boolean description: Whether to group the invoice payment on the same check with other invoices or pay the invoice separately on its own check location_id: type: string description: The Propexo unique identifier for the location post_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The post date for the invoice. property_id: type: string description: The Propexo unique identifier for the property accounting_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The accounting date of the invoice. If this isn't provided, ResMan defaults this to the invoice date. memo: type: string description: Memo of the invoice cash_financial_account_id: type: string description: The Propexo unique identifier for the financial account. You'll likely want to work with your customer to know what value is appropriate here. expense_type: type: string description: The expense type of the invoice. You'll have to request this data from your customer display_type: type: string description: The display type of the invoice. You'll have to request this data from your customer required: - integration_id _v1_invoices__post_output: type: object properties: job_id: type: string description: The ID of the job created to handle this operation data: type: object properties: {} required: - job_id - data _v1_invoices_{invoice_id}_get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query _v1_invoices_{invoice_id}_get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: type: object properties: id: type: string description: The Propexo unique identifier for the invoice created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_vendor_id: type: - string - "null" description: The external ID of the vendor from the integration vendor x_financial_account_id: type: - string - "null" description: The external ID of the financial account from the integration vendor x_cash_financial_account_id: type: - string - "null" description: The external ID of the cash financial account from the integration vendor x_ap_financial_account_id: type: - string - "null" description: The external ID of the AP financial account from the integration vendor amount_due_in_cents: type: *a140 description: The amount due on the invoice, in cents example: 100000 amount_paid_in_cents: type: *a141 description: The amount paid on the invoice, in cents example: 100000 custom_data: type: - object - "null" properties: {} due_date: type: - string - "null" description: The due date associated with the invoice discount_amount_in_cents: type: *a142 description: The deposit amount in cents associated with the invoice example: 100000 discount_date: type: - string - "null" description: The date a discount was issued on invoice invoice_date: type: - string - "null" description: The date the invoice was issued invoice_number: type: - string - "null" description: The reference number for the invoice notes: type: - string - "null" description: Notes associated with the invoice post_date: type: - string - "null" description: The date the invoice was posted. Some PMS systems only show the month. post_month: type: - string - "null" description: The month the invoice was posted. post_status_raw: type: - string - "null" description: The raw post status associated with the invoice sub_total_amount_in_cents: type: *a143 description: The sub total amount of the invoice example: 100000 total_amount_in_cents: type: *a144 description: The amount of the invoice, in cents example: 100000 property_id: type: string description: The Propexo unique identifier for the property financial_account_id: type: - string - "null" description: The Propexo unique identifier for the financial account cash_financial_account_id: type: - string - "null" description: The Propexo unique identifier for the cash financial account ap_financial_account_id: type: - string - "null" description: The Propexo unique identifier for the ap financial account integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" invoice_items: type: array items: type: object properties: x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_gl_account_id: type: - string - "null" description: The external ID of the financial account from the integration vendor x_cash_financial_account_id: type: - string - "null" description: The external ID of the cash financial account from the integration vendor invoice_id: type: string description: The Propexo unique identifier for the invoice construction_job_id: type: - string - "null" description: The Propexo unique identifier for the construction job amount_due_in_cents: type: *a145 description: The amount due on the invoice item, in cents example: 100000 notes: type: - string - "null" description: Notes associated with the invoice item total_amount_in_cents: type: *a146 description: The amount of the invoice item, in cents example: 100000 property_id: type: string description: The Propexo unique identifier for the property financial_account_id: type: - string - "null" description: The Propexo unique identifier for the financial account cash_financial_account_id: type: - string - "null" description: The Propexo unique identifier for the cash financial account required: - x_id - x_property_id - x_location_id - x_gl_account_id - x_cash_financial_account_id - invoice_id - construction_job_id - amount_due_in_cents - notes - total_amount_in_cents - property_id - financial_account_id - cash_financial_account_id x-propexo: *a147 required: - id - created_at - updated_at - last_seen - x_id - x_property_id - x_location_id - x_vendor_id - x_financial_account_id - x_cash_financial_account_id - x_ap_financial_account_id - amount_due_in_cents - amount_paid_in_cents - custom_data - due_date - discount_amount_in_cents - discount_date - invoice_date - invoice_number - notes - post_date - post_month - post_status_raw - sub_total_amount_in_cents - total_amount_in_cents - property_id - financial_account_id - cash_financial_account_id - ap_financial_account_id - integration_id - integration_vendor - invoice_items required: - meta - results _v1_invoices_{invoice_id}_put_input: type: object properties: expense_period: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The expense period associated with the invoice payment_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The payment date associated with the invoice payment_period: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The accounting period in which you want to make the payment check_number: type: string maxLength: 9 description: The check number associated with the invoice status: type: string enum: &a149 - PAY - RELEASE - HOLD description: Status of invoice item_number: type: integer exclusiveMinimum: 0 description: Line Item number of the Invoice record. _v1_invoices_{invoice_id}_put_output: type: object properties: job_id: type: string description: The ID of the job created to handle this operation data: type: object properties: {} required: - job_id - data _v1_payable-registers__get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query location_id: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. property_id: type: string description: The Propexo unique identifier for the property integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" PayableRegister: type: object properties: id: type: string description: The Propexo unique identifier for the payable register created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_financial_account_id: type: - string - "null" description: The external ID of the financial account from the integration vendor x_cash_financial_account_id: type: - string - "null" description: The external ID of the cash financial account from the integration vendor x_ap_financial_account_id: type: - string - "null" description: The external ID of the AP financial account from the integration vendor x_vendor_id: type: - string - "null" description: The external ID of the vendor from the integration vendor x_batch_id: type: - string - "null" description: The external ID of the associated batch amount_due_in_cents: type: &a332 - number - "null" description: The amount due on the payable register, in cents example: 100000 amount_paid_in_cents: type: &a333 - number - "null" description: The amount paid on the payable register, in cents example: 100000 custom_data: type: - object - "null" properties: {} due_date: type: - string - "null" description: The due date associated with the payable register discount_amount_in_cents: type: &a334 - number - "null" description: The discount, in cents, of the payable register example: 100000 discount_date: type: - string - "null" description: The date a discount was issued on payable register invoice_date: type: - string - "null" description: The date the payable register was issued invoice_number: type: - string - "null" description: The reference number for the payable register notes: type: - string - "null" description: Notes associated with the payable register post_date: type: - string - "null" description: The date the payable register was posted. Some PMS systems only show the month. post_month: type: - string - "null" description: The month the payable register was posted. post_status_raw: type: - string - "null" description: The raw post status associated with the payable register sub_total_amount_in_cents: type: &a335 - number - "null" description: The sub total amount of the payable register example: 100000 total_amount_in_cents: type: &a336 - number - "null" description: The amount of the payable register, in cents example: 100000 status: type: - string - "null" description: The status associated with the payable register is_unpaid: type: - boolean - "null" description: Whether the payable register is unpaid or not is_adjustment: type: - boolean - "null" description: Whether the payable register is an adjustment or not is_credit_memo: type: - boolean - "null" description: Whether the payable register is a credit memo or not is_exempt_from_1099: type: - boolean - "null" description: Whether the payable register is exempt from a 1099 or not display_type: type: - string - "null" description: The display type of the payable register expense_type: type: - string - "null" description: The expense type of the payable register property_id: type: string description: The Propexo unique identifier for the property financial_account_id: type: - string - "null" description: The Propexo unique identifier for the financial account cash_financial_account_id: type: - string - "null" description: The Propexo unique identifier for the cash financial account ap_financial_account_id: type: - string - "null" description: The Propexo unique identifier for the ap financial account integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" payable_register_items: type: array items: type: object properties: x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_gl_account_id: type: - string - "null" description: The external ID of the financial account from the integration vendor x_cash_financial_account_id: type: - string - "null" description: The external ID of the cash financial account from the integration vendor payable_register_id: type: string description: The Propexo unique identifier for the payable register construction_job_id: type: - string - "null" description: The Propexo unique identifier for the construction job amount_due_in_cents: type: &a330 - number - "null" description: The amount due on the payable register item, in cents example: 100000 notes: type: - string - "null" description: Notes associated with the payable register item total_amount_in_cents: type: &a331 - number - "null" description: The amount of the payable register item, in cents example: 100000 cost_code: type: - string - "null" description: The cost code of the payable register item property_id: type: string description: The Propexo unique identifier for the property financial_account_id: type: - string - "null" description: The Propexo unique identifier for the financial account cash_financial_account_id: type: - string - "null" description: The Propexo unique identifier for the cash financial account required: - x_id - x_property_id - x_location_id - x_gl_account_id - x_cash_financial_account_id - payable_register_id - construction_job_id - amount_due_in_cents - notes - total_amount_in_cents - cost_code - property_id - financial_account_id - cash_financial_account_id x-propexo: &a337 derivedFromModel: payable_register_items required: - id - created_at - updated_at - last_seen - x_id - x_property_id - x_location_id - x_financial_account_id - x_cash_financial_account_id - x_ap_financial_account_id - x_vendor_id - x_batch_id - amount_due_in_cents - amount_paid_in_cents - custom_data - due_date - discount_amount_in_cents - discount_date - invoice_date - invoice_number - notes - post_date - post_month - post_status_raw - sub_total_amount_in_cents - total_amount_in_cents - status - is_unpaid - is_adjustment - is_credit_memo - is_exempt_from_1099 - display_type - expense_type - property_id - financial_account_id - cash_financial_account_id - ap_financial_account_id - integration_id - integration_vendor - payable_register_items x-propexo: derivedFromModel: payable_registers _v1_payable-registers__get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: type: array items: $ref: "#/components/schemas/PayableRegister" required: - meta - results _v1_payable-registers__post_input: type: object properties: integration_id: type: string vendor_id: type: string description: The Propexo unique identifier for the vendor ap_financial_account_id: type: string description: The Propexo unique identifier for the financial account. You'll likely want to work with your customer to know what value is appropriate here. cash_financial_account_id: type: string description: The Propexo unique identifier for the financial account. Must be the cash account ID associated with the property passed in the payable register items. You'll likely want to work with your customer to know what value is appropriate here. invoice_number: type: string description: The invoice or reference number that the vendor assigned to the service request. Must be unique per vendor. invoice_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date of issuance for the invoice total_amount_in_cents: type: number description: The amount of the payable register, in cents. Total amount must match the sum of the payable register items' amounts discount_amount_in_cents: type: number description: The discount, in cents, of the payable register discount_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date a discount was issued on payable register discount_percent: type: string pattern: ^([1-9]\d?|0\.(0[1-9]|[1-9]\d?)|[1-9]\d?\.\d{1,2})$ description: The discount percentage of the payable register due_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The due date associated with the payable register display_type: type: string description: The display type of the payable register. You'll likely want to work with your customer to know what value is appropriate here. expense_type: type: string description: The expense type of the payable register. This is a customer defined list and you'll likely want to work with your customer to know what value is appropriate here. is_adjustment: type: boolean description: Whether the payable register is an adjustment or not is_credit_memo: type: boolean description: Whether the payable register is a credit memo or not is_consolidate_checks: type: boolean description: Whether the payable register should consolidate checks or not is_exempt_from_1099: type: boolean description: Whether the payable register is exempt from a 1099 or not invoice_status: type: string enum: &a151 - READY - KEYED - WORKFLOW - APPROVED - POSTED - OTHER description: The status of the payable register notes: type: string maxLength: 512 description: Notes associated with the payable register user_defined_field_2: type: string description: The 2nd user defined field of the payable register. You'll likely want to work with your customer to know what value is appropriate here. user_defined_field_3: type: string description: The 3rd user defined field of the payable register. You'll likely want to work with your customer to know what value is appropriate here. user_defined_field_4: type: string description: The 4th user defined field of the payable register. You'll likely want to work with your customer to know what value is appropriate here. user_defined_field_5: type: string description: The 5th user defined field of the payable register. You'll likely want to work with your customer to know what value is appropriate here. user_defined_field_6: type: string description: The 6th user defined field of the payable register. You'll likely want to work with your customer to know what value is appropriate here. payable_register_items: type: array items: type: object properties: property_id: type: string description: The Propexo unique identifier for the property financial_account_id: type: string description: The Propexo unique identifier for the financial account. You'll likely want to work with your customer to know what value is appropriate here. cash_financial_account_id: type: string description: The Propexo unique identifier for the financial account. You'll likely want to work with your customer to know what value is appropriate here. purchase_order_item_id: type: string description: The Propexo unique identifier for the purchase order item. This Purchase Order Item must be associated with the same property. total_amount_in_cents: type: number description: The amount of the payable register item, in cents. If also passing in a purchase order item, the total amount cannot be greater than the associated purchase order. notes: type: string maxLength: 512 description: Notes associated with the payable register item required: - property_id - total_amount_in_cents minItems: 1 description: A list of payable register line items. At least one is required. required: - integration_id _v1_payable-registers__post_output: type: object properties: job_id: type: string description: The ID of the job created to handle this operation data: type: object properties: {} required: - job_id - data _v1_payable-registers_cancel_post_input: type: object properties: integration_id: type: string payable_register_id: type: string description: The Propexo unique identifier for the payable register required: - integration_id _v1_payable-registers_cancel_post_output: type: object properties: job_id: type: string description: The ID of the job created to handle this operation data: type: object properties: {} required: - job_id - data _v1_payable-registers_{payable_register_id}_get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query _v1_payable-registers_{payable_register_id}_get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: $ref: "#/components/schemas/PayableRegister" required: - meta - results _v1_payable-registers_{payable_register_id}_put_input: type: object properties: {} _v1_payable-registers_{payable_register_id}_put_output: type: object properties: job_id: type: string description: The ID of the job created to handle this operation data: type: object properties: {} required: - job_id - data _v1_invoices_buildium__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration vendor_id: type: string description: The Propexo unique identifier for the vendor invoice_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date of issuance for the invoice due_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The due date associated with the invoice invoice_items: type: array items: type: object properties: financial_account_id: type: string description: The Propexo unique identifier for the financial account property_id: type: string description: The Propexo unique identifier for the property total_amount_in_cents: type: integer minimum: 0 description: The amount of the invoice item, in cents unit_id: type: string description: The Propexo unique identifier for the unit notes: type: string maxLength: 240 description: Notes associated with the invoice item total_mark_up_amount_in_cents: type: integer minimum: 0 description: Mark up amount in cents mark_up_percentage: type: number minimum: 0 maximum: 100 description: The mark up percentage mark_up_type: type: string enum: &a148 - Percent - Amount description: The markup type. If "Percent" is passed in we will use the mark_up_percentage value. If "Amount" is passed in we will use the total_mark_up_amount_in_cents value required: - financial_account_id - property_id - total_amount_in_cents description: type: string description: Description of the invoice invoice_number: type: string description: The invoice or reference number that the vendor assigned to the service request service_request_id: type: string description: The Propexo unique identifier for the service request required: - integration_id - vendor_id - invoice_date - due_date - invoice_items _v1_invoices_buildium__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration vendor_id: type: string description: The Propexo unique identifier for the vendor invoice_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" due_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" invoice_items: type: array items: type: object properties: financial_account_id: type: string description: The Propexo unique identifier for the financial account property_id: type: string description: The Propexo unique identifier for the property total_amount_in_cents: type: integer minimum: 0 description: The amount of the invoice item, in cents unit_id: type: string description: The Propexo unique identifier for the unit notes: type: string maxLength: 240 description: Notes associated with the invoice item total_mark_up_amount_in_cents: type: integer minimum: 0 description: Mark up amount in cents mark_up_percentage: type: number minimum: 0 maximum: 100 description: The mark up percentage mark_up_type: type: string enum: *a148 description: The markup type. If "Percent" is passed in we will use the mark_up_percentage value. If "Amount" is passed in we will use the total_mark_up_amount_in_cents value required: - financial_account_id - property_id - total_amount_in_cents description: type: - string - "null" description: Description of the invoice invoice_number: type: - string - "null" description: The invoice or reference number that the vendor assigned to the service request service_request_id: type: - string - "null" description: The Propexo unique identifier for the service request required: - integration_id - vendor_id - invoice_date - due_date - invoice_items - description - invoice_number - service_request_id required: - meta - result _v1_invoices_entrata__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration vendor_id: type: string description: The Propexo unique identifier for the vendor vendor_location_id: type: string description: The Propexo unique identifier for the vendor location invoice_number: type: string description: The invoice or reference number that the vendor assigned to the service request invoice_date: type: string format: date-time description: The date of issuance for the invoice total_amount_in_cents: type: number description: The amount of the invoice, in cents invoice_items: type: array items: type: object properties: property_id: type: string description: The Propexo unique identifier for the property financial_account_id: type: string description: The Propexo unique identifier for the financial account total_amount_in_cents: type: number description: The amount of the invoice item, in cents notes: type: string description: Notes associated with the invoice item purchase_order_item_id: type: string description: The Propexo unique identifier for the purchase order item required: - property_id - financial_account_id - total_amount_in_cents - notes ap_financial_account_id: type: string description: The Propexo unique identifier for the financial account. You'll likely want to work with your customer to know what value is appropriate here. post_month: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The post month for the invoice. We will strip all data out of the datetime except the year and month. discount_amount_in_cents: type: number description: The discount, in cents, of the invoice. This amount will be applied prior to the total amount being calculated. due_date: type: string format: date-time description: The due date associated with the invoice notes: type: string description: Notes associated with the invoice attachments: type: array items: type: object properties: file_data: type: string maxLength: 69730304 description: The contents of the file, as a base64 encoded string. The PMS has a max file size of 50 MB. file_name: type: string description: 'The name of the file including the extension. Ex: "image.jpg"' mime_type: type: string description: 'The mime type of the file. Ex: "image/jpeg"' required: - file_data - file_name - mime_type description: Files to upload for the invoice. All the files can have a maximum combined file size of 50 MB required: - integration_id - vendor_id - vendor_location_id - invoice_number - invoice_date - total_amount_in_cents - invoice_items _v1_invoices_entrata__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration vendor_id: type: string description: The Propexo unique identifier for the vendor vendor_location_id: type: string description: The Propexo unique identifier for the vendor location invoice_number: type: string description: The invoice or reference number that the vendor assigned to the service request invoice_date: type: string format: date-time description: The date of issuance for the invoice total_amount_in_cents: type: number description: The amount of the invoice, in cents invoice_items: type: array items: type: object properties: property_id: type: string description: The Propexo unique identifier for the property financial_account_id: type: string description: The Propexo unique identifier for the financial account total_amount_in_cents: type: number description: The amount of the invoice item, in cents notes: type: string description: Notes associated with the invoice item purchase_order_item_id: type: string required: - property_id - financial_account_id - total_amount_in_cents - notes ap_financial_account_id: type: - string - "null" post_month: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" discount_amount_in_cents: type: - number - "null" due_date: type: - string - "null" format: date-time notes: type: - string - "null" attachments: type: - array - "null" items: type: object properties: file_data: type: - string - "null" maxLength: 69730304 description: The contents of the file, as a base64 encoded string. The PMS has a max file size of 50 MB. file_name: type: string description: 'The name of the file including the extension. Ex: "image.jpg"' mime_type: type: string description: 'The mime type of the file. Ex: "image/jpeg"' required: - file_name - mime_type required: - integration_id - vendor_id - vendor_location_id - invoice_number - invoice_date - total_amount_in_cents - invoice_items - ap_financial_account_id - post_month - discount_amount_in_cents - due_date - notes - attachments required: - meta - result _v1_invoices_entrata_{invoice_id}_put_input: type: object properties: {} _v1_invoices_entrata_{invoice_id}_put_output: type: object properties: {} _v1_invoices_resman__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration property_id: type: string description: The Propexo unique identifier for the property vendor_id: type: string description: The Propexo unique identifier for the vendor invoice_number: type: string description: The invoice or reference number that the vendor assigned to the service request invoice_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date of issuance for the invoice accounting_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The accounting date of the invoice. If this isn't provided, ResMan defaults this to the invoice date. due_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The due date associated with the invoice notes: type: string description: Notes associated with the invoice memo: type: string description: Memo of the invoice total_amount_in_cents: type: integer minimum: 0 description: The amount of the invoice, in cents invoice_items: type: array items: type: object properties: financial_account_id: type: string description: The Propexo unique identifier for the financial account. You'll likely want to work with your customer to know what value is appropriate here. quantity_ordered: type: integer exclusiveMinimum: 0 description: The quantity ordered for the invoice unit_price_in_cents: type: integer minimum: 0 description: The unit price, in cents, of the invoice notes: type: string description: Notes associated with the invoice item required: - financial_account_id - quantity_ordered - unit_price_in_cents - notes required: - integration_id - property_id - vendor_id - invoice_number - invoice_date - due_date - notes - memo - total_amount_in_cents - invoice_items _v1_invoices_resman__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration property_id: type: string description: The Propexo unique identifier for the property vendor_id: type: string description: The Propexo unique identifier for the vendor invoice_number: type: string description: The invoice or reference number that the vendor assigned to the service request invoice_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" accounting_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" description: The accounting date of the invoice. If this isn't provided, ResMan defaults this to the invoice date. due_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" notes: type: string description: Notes associated with the invoice memo: type: string description: Memo of the invoice total_amount_in_cents: type: integer minimum: 0 description: The amount of the invoice, in cents invoice_items: type: array items: type: object properties: financial_account_id: type: string description: The Propexo unique identifier for the financial account. You'll likely want to work with your customer to know what value is appropriate here. quantity_ordered: type: integer exclusiveMinimum: 0 description: The quantity ordered for the invoice unit_price_in_cents: type: integer minimum: 0 description: The unit price, in cents, of the invoice notes: type: string description: Notes associated with the invoice item required: - financial_account_id - quantity_ordered - unit_price_in_cents - notes required: - integration_id - property_id - vendor_id - invoice_number - invoice_date - accounting_date - due_date - notes - memo - total_amount_in_cents - invoice_items required: - meta - result _v1_invoices_resman_{invoice_id}_put_input: type: object properties: {} _v1_invoices_resman_{invoice_id}_put_output: type: object properties: {} _v1_invoices_yardi__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration vendor_id: type: string description: The Propexo unique identifier for the vendor cash_financial_account_id: type: string description: The Propexo unique identifier for the financial account. You'll likely want to work with your customer to know what value is appropriate here. ap_financial_account_id: type: string description: The Propexo unique identifier for the financial account. You'll likely want to work with your customer to know what value is appropriate here. invoice_number: type: string description: The invoice or reference number that the vendor assigned to the service request post_month: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The post month for the invoice. We will strip all data out of the datetime except the year and month. invoice_date: type: string format: date-time description: The date of issuance for the invoice due_date: type: string format: date-time description: The due date associated with the invoice notes: type: string description: Notes associated with the invoice total_amount_in_cents: type: number description: The amount of the invoice, in cents expense_type: type: string description: The expense type of the invoice. You'll have to request this data from your customer display_type: type: string description: The display type of the invoice. You'll have to request this data from your customer invoice_items: type: array items: type: object properties: property_id: type: string description: The Propexo unique identifier for the property financial_account_id: type: string description: The Propexo unique identifier for the financial account total_amount_in_cents: type: number description: The amount of the invoice item, in cents notes: type: string description: Notes associated with the invoice item required: - property_id - financial_account_id - total_amount_in_cents - notes required: - integration_id - vendor_id - cash_financial_account_id - ap_financial_account_id - invoice_number - post_month - invoice_date - due_date - notes - total_amount_in_cents - expense_type - display_type - invoice_items _v1_invoices_yardi__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration vendor_id: type: string description: The Propexo unique identifier for the vendor cash_financial_account_id: type: string description: The Propexo unique identifier for the financial account. You'll likely want to work with your customer to know what value is appropriate here. ap_financial_account_id: type: string description: The Propexo unique identifier for the financial account. You'll likely want to work with your customer to know what value is appropriate here. invoice_number: type: string description: The invoice or reference number that the vendor assigned to the service request post_month: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" invoice_date: type: string format: date-time description: The date of issuance for the invoice due_date: type: string format: date-time description: The due date associated with the invoice notes: type: string description: Notes associated with the invoice total_amount_in_cents: type: number description: The amount of the invoice, in cents expense_type: type: string description: The expense type of the invoice. You'll have to request this data from your customer display_type: type: string description: The display type of the invoice. You'll have to request this data from your customer invoice_items: type: array items: type: object properties: property_id: type: string description: The Propexo unique identifier for the property financial_account_id: type: string description: The Propexo unique identifier for the financial account total_amount_in_cents: type: number description: The amount of the invoice item, in cents notes: type: string description: Notes associated with the invoice item required: - property_id - financial_account_id - total_amount_in_cents - notes required: - integration_id - vendor_id - cash_financial_account_id - ap_financial_account_id - invoice_number - post_month - invoice_date - due_date - notes - total_amount_in_cents - expense_type - display_type - invoice_items required: - meta - result _v1_invoices_yardi_{invoice_id}_put_input: type: object properties: {} _v1_invoices_yardi_{invoice_id}_put_output: type: object properties: {} _v1_invoices_yardi_rest__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration vendor_id: type: string description: The Propexo unique identifier for the vendor cash_financial_account_id: type: string description: The Propexo unique identifier for the financial account. You'll likely want to work with your customer to know what value is appropriate here. ap_financial_account_id: type: string description: The Propexo unique identifier for the financial account. You'll likely want to work with your customer to know what value is appropriate here. invoice_number: type: string description: The invoice or reference number that the vendor assigned to the service request post_month: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The post month for the invoice. We will strip all data out of the datetime except the year and month. invoice_date: type: string format: date-time description: The date of issuance for the invoice due_date: type: string format: date-time description: The due date associated with the invoice notes: type: string description: Notes associated with the invoice total_amount_in_cents: type: number description: The amount of the invoice, in cents expense_type: type: string description: The expense type of the invoice. You'll have to request this data from your customer display_type: type: string description: The display type of the invoice. You'll have to request this data from your customer invoice_items: type: array items: type: object properties: property_id: type: string description: The Propexo unique identifier for the property financial_account_id: type: string description: The Propexo unique identifier for the financial account total_amount_in_cents: type: number description: The amount of the invoice item, in cents notes: type: string description: Notes associated with the invoice item required: - property_id - financial_account_id - total_amount_in_cents - notes required: - integration_id - vendor_id - cash_financial_account_id - ap_financial_account_id - invoice_number - post_month - invoice_date - due_date - notes - total_amount_in_cents - expense_type - display_type - invoice_items _v1_invoices_yardi_rest__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration vendor_id: type: string description: The Propexo unique identifier for the vendor cash_financial_account_id: type: string description: The Propexo unique identifier for the financial account. You'll likely want to work with your customer to know what value is appropriate here. ap_financial_account_id: type: string description: The Propexo unique identifier for the financial account. You'll likely want to work with your customer to know what value is appropriate here. invoice_number: type: string description: The invoice or reference number that the vendor assigned to the service request post_month: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" invoice_date: type: string format: date-time description: The date of issuance for the invoice due_date: type: string format: date-time description: The due date associated with the invoice notes: type: string description: Notes associated with the invoice total_amount_in_cents: type: number description: The amount of the invoice, in cents expense_type: type: string description: The expense type of the invoice. You'll have to request this data from your customer display_type: type: string description: The display type of the invoice. You'll have to request this data from your customer invoice_items: type: array items: type: object properties: property_id: type: string description: The Propexo unique identifier for the property financial_account_id: type: string description: The Propexo unique identifier for the financial account total_amount_in_cents: type: number description: The amount of the invoice item, in cents notes: type: string description: Notes associated with the invoice item required: - property_id - financial_account_id - total_amount_in_cents - notes required: - integration_id - vendor_id - cash_financial_account_id - ap_financial_account_id - invoice_number - post_month - invoice_date - due_date - notes - total_amount_in_cents - expense_type - display_type - invoice_items required: - meta - result _v1_invoices_mri__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration vendor_id: type: string description: The Propexo unique identifier for the vendor partner_name: type: string description: The name of your integration with MRI invoice_number: type: string description: The invoice or reference number that the vendor assigned to the service request post_month: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The post month for the invoice. We will strip all data out of the datetime except the year and month. invoice_items: type: array items: type: object properties: accounting_entity_id: type: string description: The Propexo unique identifier for the accounting entity financial_account_id: type: string description: The Propexo unique identifier for the financial account total_amount_in_cents: type: integer minimum: 0 description: The total amount of the invoice item notes: type: string description: Notes associated with the invoice item item_number: type: integer exclusiveMinimum: 0 description: A numeric identifier that must be unique for each item in the invoice description: type: string description: Description of the invoice item required: - accounting_entity_id - financial_account_id - total_amount_in_cents - notes invoice_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date of issuance for the invoice due_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The due date associated with the invoice total_amount_in_cents: type: integer minimum: 0 description: The total amount of the invoice description: type: string description: Description of the invoice scanned_copy_url: type: string description: The URL assigned to the copy of the original invoice that was imported from a third-party system purchase_order_number: type: string description: Set this parameter to the purchase order number that contains the line items to be invoiced. MRI will validate and link the invoice to the specified purchase order for processing. separate_check: type: boolean description: Whether to group the invoice payment on the same check with other invoices or pay the invoice separately on its own check required: - integration_id - vendor_id - partner_name - invoice_number - post_month - invoice_items _v1_invoices_mri__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration vendor_id: type: string description: The Propexo unique identifier for the vendor partner_name: type: string description: The name of your integration with MRI invoice_number: type: string description: The invoice or reference number that the vendor assigned to the service request post_month: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" invoice_items: type: array items: type: object properties: accounting_entity_id: type: string description: The Propexo unique identifier for the accounting entity financial_account_id: type: string description: The Propexo unique identifier for the financial account total_amount_in_cents: type: integer minimum: 0 description: The total amount of the invoice item notes: type: string description: Notes associated with the invoice item item_number: type: integer exclusiveMinimum: 0 description: A numeric identifier that must be unique for each item in the invoice description: type: string description: Description of the invoice item required: - accounting_entity_id - financial_account_id - total_amount_in_cents - notes invoice_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" description: The date of issuance for the invoice due_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" description: The due date associated with the invoice total_amount_in_cents: type: - integer - "null" minimum: 0 description: The total amount of the invoice description: type: - string - "null" description: Description of the invoice scanned_copy_url: type: - string - "null" description: The URL assigned to the copy of the original invoice that was imported from a third-party system purchase_order_number: type: - string - "null" description: Set this parameter to the purchase order number that contains the line items to be invoiced. MRI will validate and link the invoice to the specified purchase order for processing. separate_check: type: - boolean - "null" description: Whether to group the invoice payment on the same check with other invoices or pay the invoice separately on its own check required: - integration_id - vendor_id - partner_name - invoice_number - post_month - invoice_items - invoice_date - due_date - total_amount_in_cents - description - scanned_copy_url - purchase_order_number - separate_check required: - meta - result _v1_invoices_mri_{invoice_id}_put_input: type: object properties: expense_period: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The expense period associated with the invoice payment_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The payment date associated with the invoice payment_period: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The accounting period in which you want to make the payment check_number: type: string maxLength: 9 description: The check number associated with the invoice status: type: string enum: *a149 description: Status of invoice item_number: type: integer exclusiveMinimum: 0 description: Line Item number of the Invoice record. required: - expense_period - payment_date - payment_period - check_number - status - item_number _v1_invoices_mri_{invoice_id}_put_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: invoice_id: type: string description: The Propexo unique identifier for the invoice expense_period: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The expense period associated with the invoice payment_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The payment date associated with the invoice payment_period: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The accounting period in which you want to make the payment check_number: type: string maxLength: 9 description: The check number associated with the invoice status: type: string enum: *a149 description: Status of invoice item_number: type: integer exclusiveMinimum: 0 description: Line Item number of the Invoice record. required: - invoice_id - expense_period - payment_date - payment_period - check_number - status - item_number required: - meta - result _v1_invoices_rentmanager__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration vendor_id: type: string description: The Propexo unique identifier for the vendor location_id: type: string description: The Propexo unique identifier for the location invoice_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date of issuance for the invoice due_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The due date associated with the invoice post_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The post date for the invoice. total_amount_in_cents: type: integer minimum: 0 description: The total amount of the invoice invoice_number: type: string description: The invoice or reference number that the vendor assigned to the service request notes: type: string description: Notes associated with the invoice invoice_items: type: array items: type: object properties: amount_in_cents: type: integer minimum: 0 description: The amount of the invoice item, in cents property_id: type: string description: The Propexo unique identifier for the property financial_account_id: type: string description: The Propexo unique identifier for the financial account notes: type: string description: Notes associated with the invoice item required: - amount_in_cents - property_id - financial_account_id minItems: 1 description: Line items for the invoice. Each item represents a detail line on the bill in Rent Manager. required: - integration_id - vendor_id - location_id - invoice_date - due_date - post_date - total_amount_in_cents - invoice_items _v1_invoices_rentmanager__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration vendor_id: type: string description: The Propexo unique identifier for the vendor location_id: type: string description: The Propexo unique identifier for the location invoice_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" due_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" post_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" total_amount_in_cents: type: integer minimum: 0 description: The total amount of the invoice invoice_number: type: - string - "null" description: The invoice or reference number that the vendor assigned to the service request notes: type: - string - "null" description: Notes associated with the invoice invoice_items: type: array items: type: object properties: amount_in_cents: type: integer minimum: 0 description: The amount of the invoice item, in cents property_id: type: string description: The Propexo unique identifier for the property financial_account_id: type: string description: The Propexo unique identifier for the financial account notes: type: string description: Notes associated with the invoice item required: - amount_in_cents - property_id - financial_account_id required: - integration_id - vendor_id - location_id - invoice_date - due_date - post_date - total_amount_in_cents - invoice_number - notes - invoice_items required: - meta - result _v1_payable-registers_cancel_yardi_post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration payable_register_id: type: string description: The Propexo unique identifier for the payable register required: - integration_id - payable_register_id _v1_payable-registers_cancel_yardi_post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration payable_register_id: type: string description: The Propexo unique identifier for the payable register required: - integration_id - payable_register_id required: - meta - result _v1_payable-registers_cancel_yardi_rest_post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration payable_register_id: type: string description: The Propexo unique identifier for the payable register required: - integration_id - payable_register_id _v1_payable-registers_cancel_yardi_rest_post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration payable_register_id: type: string description: The Propexo unique identifier for the payable register required: - integration_id - payable_register_id required: - meta - result _v1_payable-registers_yardi__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration vendor_id: type: string description: The Propexo unique identifier for the vendor ap_financial_account_id: type: string description: The Propexo unique identifier for the financial account. You'll likely want to work with your customer to know what value is appropriate here. cash_financial_account_id: type: string description: The Propexo unique identifier for the financial account. Must be the cash account ID associated with the property passed in the payable register items. You'll likely want to work with your customer to know what value is appropriate here. invoice_number: type: string description: The invoice or reference number that the vendor assigned to the service request. Must be unique per vendor. invoice_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date of issuance for the invoice total_amount_in_cents: type: number description: The amount of the payable register, in cents. Total amount must match the sum of the payable register items' amounts discount_amount_in_cents: type: number description: The discount, in cents, of the payable register discount_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date a discount was issued on payable register discount_percent: type: string pattern: ^([1-9]\d?|0\.(0[1-9]|[1-9]\d?)|[1-9]\d?\.\d{1,2})$ description: The discount percentage of the payable register due_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The due date associated with the payable register display_type: type: string description: The display type of the payable register. You'll likely want to work with your customer to know what value is appropriate here. expense_type: type: string description: The expense type of the payable register. This is a customer defined list and you'll likely want to work with your customer to know what value is appropriate here. is_adjustment: type: boolean description: Whether the payable register is an adjustment or not is_credit_memo: type: boolean description: Whether the payable register is a credit memo or not is_consolidate_checks: type: boolean description: Whether the payable register should consolidate checks or not is_exempt_from_1099: type: boolean description: Whether the payable register is exempt from a 1099 or not invoice_status: type: string enum: &a150 - READY - KEYED - WORKFLOW - APPROVED - POSTED - OTHER description: The status of the payable register notes: type: string maxLength: 512 description: Notes associated with the payable register user_defined_field_2: type: string description: The 2nd user defined field of the payable register. You'll likely want to work with your customer to know what value is appropriate here. user_defined_field_3: type: string description: The 3rd user defined field of the payable register. You'll likely want to work with your customer to know what value is appropriate here. user_defined_field_4: type: string description: The 4th user defined field of the payable register. You'll likely want to work with your customer to know what value is appropriate here. user_defined_field_5: type: string description: The 5th user defined field of the payable register. You'll likely want to work with your customer to know what value is appropriate here. user_defined_field_6: type: string description: The 6th user defined field of the payable register. You'll likely want to work with your customer to know what value is appropriate here. payable_register_items: type: array items: type: object properties: property_id: type: string description: The Propexo unique identifier for the property financial_account_id: type: string description: The Propexo unique identifier for the financial account. You'll likely want to work with your customer to know what value is appropriate here. cash_financial_account_id: type: string description: The Propexo unique identifier for the financial account. You'll likely want to work with your customer to know what value is appropriate here. purchase_order_item_id: type: string description: The Propexo unique identifier for the purchase order item. This Purchase Order Item must be associated with the same property. total_amount_in_cents: type: number description: The amount of the payable register item, in cents. If also passing in a purchase order item, the total amount cannot be greater than the associated purchase order. notes: type: string maxLength: 512 description: Notes associated with the payable register item required: - property_id - total_amount_in_cents minItems: 1 description: A list of payable register line items. At least one is required. required: - integration_id - vendor_id - invoice_number - invoice_date - total_amount_in_cents - payable_register_items _v1_payable-registers_yardi__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration vendor_id: type: string description: The Propexo unique identifier for the vendor ap_financial_account_id: type: - string - "null" description: The Propexo unique identifier for the financial account. You'll likely want to work with your customer to know what value is appropriate here. cash_financial_account_id: type: - string - "null" description: The Propexo unique identifier for the financial account. Must be the cash account ID associated with the property passed in the payable register items. You'll likely want to work with your customer to know what value is appropriate here. invoice_number: type: string description: The invoice or reference number that the vendor assigned to the service request. Must be unique per vendor. invoice_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" total_amount_in_cents: type: number description: The amount of the payable register, in cents. Total amount must match the sum of the payable register items' amounts discount_amount_in_cents: type: - number - "null" description: The discount, in cents, of the payable register discount_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" description: The date a discount was issued on payable register discount_percent: type: - string - "null" pattern: ^([1-9]\d?|0\.(0[1-9]|[1-9]\d?)|[1-9]\d?\.\d{1,2})$ description: The discount percentage of the payable register due_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" description: The due date associated with the payable register display_type: type: - string - "null" description: The display type of the payable register. You'll likely want to work with your customer to know what value is appropriate here. expense_type: type: - string - "null" description: The expense type of the payable register. This is a customer defined list and you'll likely want to work with your customer to know what value is appropriate here. is_adjustment: type: - boolean - "null" description: Whether the payable register is an adjustment or not is_credit_memo: type: - boolean - "null" description: Whether the payable register is a credit memo or not is_consolidate_checks: type: - boolean - "null" description: Whether the payable register should consolidate checks or not is_exempt_from_1099: type: - boolean - "null" description: Whether the payable register is exempt from a 1099 or not invoice_status: type: - string - "null" enum: *a150 description: The status of the payable register notes: type: - string - "null" maxLength: 512 description: Notes associated with the payable register user_defined_field_2: type: - string - "null" description: The 2nd user defined field of the payable register. You'll likely want to work with your customer to know what value is appropriate here. user_defined_field_3: type: - string - "null" description: The 3rd user defined field of the payable register. You'll likely want to work with your customer to know what value is appropriate here. user_defined_field_4: type: - string - "null" description: The 4th user defined field of the payable register. You'll likely want to work with your customer to know what value is appropriate here. user_defined_field_5: type: - string - "null" description: The 5th user defined field of the payable register. You'll likely want to work with your customer to know what value is appropriate here. user_defined_field_6: type: - string - "null" description: The 6th user defined field of the payable register. You'll likely want to work with your customer to know what value is appropriate here. payable_register_items: type: array items: type: object properties: property_id: type: string description: The Propexo unique identifier for the property financial_account_id: type: string description: The Propexo unique identifier for the financial account. You'll likely want to work with your customer to know what value is appropriate here. cash_financial_account_id: type: string description: The Propexo unique identifier for the financial account. You'll likely want to work with your customer to know what value is appropriate here. purchase_order_item_id: type: string description: The Propexo unique identifier for the purchase order item. This Purchase Order Item must be associated with the same property. total_amount_in_cents: type: number description: The amount of the payable register item, in cents. If also passing in a purchase order item, the total amount cannot be greater than the associated purchase order. notes: type: string maxLength: 512 description: Notes associated with the payable register item required: - property_id - total_amount_in_cents required: - integration_id - vendor_id - ap_financial_account_id - cash_financial_account_id - invoice_number - invoice_date - total_amount_in_cents - discount_amount_in_cents - discount_date - discount_percent - due_date - display_type - expense_type - is_adjustment - is_credit_memo - is_consolidate_checks - is_exempt_from_1099 - invoice_status - notes - user_defined_field_2 - user_defined_field_3 - user_defined_field_4 - user_defined_field_5 - user_defined_field_6 - payable_register_items required: - meta - result _v1_payable-registers_yardi_{payable_register_id}_put_input: type: object properties: {} _v1_payable-registers_yardi_{payable_register_id}_put_output: type: object properties: {} _v1_payable-registers_yardi_rest__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration vendor_id: type: string description: The Propexo unique identifier for the vendor ap_financial_account_id: type: string description: The Propexo unique identifier for the financial account. You'll likely want to work with your customer to know what value is appropriate here. cash_financial_account_id: type: string description: The Propexo unique identifier for the financial account. Must be the cash account ID associated with the property passed in the payable register items. You'll likely want to work with your customer to know what value is appropriate here. invoice_number: type: string description: The invoice or reference number that the vendor assigned to the service request. Must be unique per vendor. invoice_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date of issuance for the invoice total_amount_in_cents: type: number description: The amount of the payable register, in cents. Total amount must match the sum of the payable register items' amounts discount_amount_in_cents: type: number description: The discount, in cents, of the payable register discount_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date a discount was issued on payable register discount_percent: type: string pattern: ^([1-9]\d?|0\.(0[1-9]|[1-9]\d?)|[1-9]\d?\.\d{1,2})$ description: The discount percentage of the payable register due_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The due date associated with the payable register display_type: type: string description: The display type of the payable register. You'll likely want to work with your customer to know what value is appropriate here. expense_type: type: string description: The expense type of the payable register. This is a customer defined list and you'll likely want to work with your customer to know what value is appropriate here. is_adjustment: type: boolean description: Whether the payable register is an adjustment or not is_credit_memo: type: boolean description: Whether the payable register is a credit memo or not is_consolidate_checks: type: boolean description: Whether the payable register should consolidate checks or not is_exempt_from_1099: type: boolean description: Whether the payable register is exempt from a 1099 or not invoice_status: type: string enum: *a151 description: The status of the payable register notes: type: string maxLength: 512 description: Notes associated with the payable register user_defined_field_2: type: string description: The 2nd user defined field of the payable register. You'll likely want to work with your customer to know what value is appropriate here. user_defined_field_3: type: string description: The 3rd user defined field of the payable register. You'll likely want to work with your customer to know what value is appropriate here. user_defined_field_4: type: string description: The 4th user defined field of the payable register. You'll likely want to work with your customer to know what value is appropriate here. user_defined_field_5: type: string description: The 5th user defined field of the payable register. You'll likely want to work with your customer to know what value is appropriate here. user_defined_field_6: type: string description: The 6th user defined field of the payable register. You'll likely want to work with your customer to know what value is appropriate here. payable_register_items: type: array items: type: object properties: property_id: type: string description: The Propexo unique identifier for the property financial_account_id: type: string description: The Propexo unique identifier for the financial account. You'll likely want to work with your customer to know what value is appropriate here. cash_financial_account_id: type: string description: The Propexo unique identifier for the financial account. You'll likely want to work with your customer to know what value is appropriate here. purchase_order_item_id: type: string description: The Propexo unique identifier for the purchase order item. This Purchase Order Item must be associated with the same property. total_amount_in_cents: type: number description: The amount of the payable register item, in cents. If also passing in a purchase order item, the total amount cannot be greater than the associated purchase order. notes: type: string maxLength: 512 description: Notes associated with the payable register item required: - property_id - total_amount_in_cents minItems: 1 description: A list of payable register line items. At least one is required. required: - integration_id - vendor_id - invoice_number - invoice_date - total_amount_in_cents - payable_register_items _v1_payable-registers_yardi_rest__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration vendor_id: type: string description: The Propexo unique identifier for the vendor ap_financial_account_id: type: - string - "null" description: The Propexo unique identifier for the financial account. You'll likely want to work with your customer to know what value is appropriate here. cash_financial_account_id: type: - string - "null" description: The Propexo unique identifier for the financial account. Must be the cash account ID associated with the property passed in the payable register items. You'll likely want to work with your customer to know what value is appropriate here. invoice_number: type: string description: The invoice or reference number that the vendor assigned to the service request. Must be unique per vendor. invoice_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" total_amount_in_cents: type: number description: The amount of the payable register, in cents. Total amount must match the sum of the payable register items' amounts discount_amount_in_cents: type: - number - "null" description: The discount, in cents, of the payable register discount_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" description: The date a discount was issued on payable register discount_percent: type: - string - "null" pattern: ^([1-9]\d?|0\.(0[1-9]|[1-9]\d?)|[1-9]\d?\.\d{1,2})$ description: The discount percentage of the payable register due_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" description: The due date associated with the payable register display_type: type: - string - "null" description: The display type of the payable register. You'll likely want to work with your customer to know what value is appropriate here. expense_type: type: - string - "null" description: The expense type of the payable register. This is a customer defined list and you'll likely want to work with your customer to know what value is appropriate here. is_adjustment: type: - boolean - "null" description: Whether the payable register is an adjustment or not is_credit_memo: type: - boolean - "null" description: Whether the payable register is a credit memo or not is_consolidate_checks: type: - boolean - "null" description: Whether the payable register should consolidate checks or not is_exempt_from_1099: type: - boolean - "null" description: Whether the payable register is exempt from a 1099 or not invoice_status: type: - string - "null" enum: *a151 description: The status of the payable register notes: type: - string - "null" maxLength: 512 description: Notes associated with the payable register user_defined_field_2: type: - string - "null" description: The 2nd user defined field of the payable register. You'll likely want to work with your customer to know what value is appropriate here. user_defined_field_3: type: - string - "null" description: The 3rd user defined field of the payable register. You'll likely want to work with your customer to know what value is appropriate here. user_defined_field_4: type: - string - "null" description: The 4th user defined field of the payable register. You'll likely want to work with your customer to know what value is appropriate here. user_defined_field_5: type: - string - "null" description: The 5th user defined field of the payable register. You'll likely want to work with your customer to know what value is appropriate here. user_defined_field_6: type: - string - "null" description: The 6th user defined field of the payable register. You'll likely want to work with your customer to know what value is appropriate here. payable_register_items: type: array items: type: object properties: property_id: type: string description: The Propexo unique identifier for the property financial_account_id: type: string description: The Propexo unique identifier for the financial account. You'll likely want to work with your customer to know what value is appropriate here. cash_financial_account_id: type: string description: The Propexo unique identifier for the financial account. You'll likely want to work with your customer to know what value is appropriate here. purchase_order_item_id: type: string description: The Propexo unique identifier for the purchase order item. This Purchase Order Item must be associated with the same property. total_amount_in_cents: type: number description: The amount of the payable register item, in cents. If also passing in a purchase order item, the total amount cannot be greater than the associated purchase order. notes: type: string maxLength: 512 description: Notes associated with the payable register item required: - property_id - total_amount_in_cents required: - integration_id - vendor_id - ap_financial_account_id - cash_financial_account_id - invoice_number - invoice_date - total_amount_in_cents - discount_amount_in_cents - discount_date - discount_percent - due_date - display_type - expense_type - is_adjustment - is_credit_memo - is_consolidate_checks - is_exempt_from_1099 - invoice_status - notes - user_defined_field_2 - user_defined_field_3 - user_defined_field_4 - user_defined_field_5 - user_defined_field_6 - payable_register_items required: - meta - result _v1_payable-registers_yardi_{payable_register_id}_file-upload_post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration vendor_id: type: string description: The Propexo unique identifier for the vendor attachment: type: object properties: file_data: type: string maxLength: 66500000 required: - file_data description: Base64 value for a PNG image to attach to the Payable Register. page_type: type: string enum: &a152 - FRONT - BACK description: The page type of the image to attach to the Payable Register. If not provided, the back page will be used. page_number: type: number minimum: 0 description: The page number of the image to attach to the Payable Register. If not provided, page number 1 will be used. page_count: type: number minimum: 0 description: The page count of the image to attach to the Payable Register. If not provided, page number 1 will be used. required: - integration_id - attachment _v1_payable-registers_yardi_{payable_register_id}_file-upload_post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration payable_register_id: type: string description: The Propexo unique identifier for the payable register vendor_id: type: - string - "null" attachment: type: object properties: file_data: type: - string - "null" maxLength: 66500000 page_type: type: - string - "null" enum: *a152 page_number: type: - number - "null" minimum: 0 page_count: type: - number - "null" minimum: 0 required: - integration_id - payable_register_id - vendor_id - attachment - page_type - page_number - page_count required: - meta - result _v1_payable-registers_yardi_rest_{payable_register_id}_file-upload_post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration vendor_id: type: string description: The Propexo unique identifier for the vendor attachment: type: object properties: file_data: type: string maxLength: 66500000 required: - file_data description: Base64 value for a PNG image to attach to the Payable Register. page_type: type: string enum: *a152 description: The page type of the image to attach to the Payable Register. If not provided, the back page will be used. page_number: type: number minimum: 0 description: The page number of the image to attach to the Payable Register. If not provided, page number 1 will be used. page_count: type: number minimum: 0 description: The page count of the image to attach to the Payable Register. If not provided, page number 1 will be used. required: - integration_id - attachment _v1_payable-registers_yardi_rest_{payable_register_id}_file-upload_post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration payable_register_id: type: string description: The Propexo unique identifier for the payable register vendor_id: type: - string - "null" attachment: type: object properties: file_data: type: - string - "null" maxLength: 66500000 page_type: type: - string - "null" enum: *a152 page_number: type: - number - "null" minimum: 0 page_count: type: - number - "null" minimum: 0 required: - integration_id - payable_register_id - vendor_id - attachment - page_type - page_number - page_count required: - meta - result Enum3: type: string enum: &a289 - APPFOLIO - BUILDIUM - ENTRATA - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The integration vendor for the lead. _v1_leads__get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query x_id: type: string description: The external lead id x_property_id: type: string description: "Deprecated: Use the Propexo property_id instead" deprecated: true location_id: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_unit_id: type: string description: The external unit id email_1: type: string description: Lead email address email_2: type: string description: Lead email address alternate property_id: type: string description: The Propexo property id integration_id: type: string description: The Propexo integration id integration_vendor: $ref: "#/components/schemas/Enum3" phone_1: type: string pattern: ^[2-9]\d{9}$ description: Filter by phone number (10 digit format only) Lead: type: object properties: id: type: string description: The Propexo unique identifier for the lead created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_created_at: type: - string - "null" description: The date the record first entered the integration vendor x_guestcard_id: type: - string - "null" description: The external ID of the guestcard from the integration vendor x_id: type: string description: The external ID from the integration vendor x_leasing_agent_id: type: - string - "null" description: The external ID of the leasing agent from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_unit_id: type: - string - "null" description: "DEPRECATED: Use x_unit_id_preferred instead" deprecated: true x-fern-availability: deprecated x_unit_id_preferred: type: array items: type: string x_updated_at: type: - string - "null" description: The date the record was last updated in the integration vendor x_lead_source_id: type: - string - "null" description: The external ID of the lead source from the integration vendor address_1: type: - string - "null" description: The first address line associated with the lead address_2: type: - string - "null" description: The second address line associated with the lead city: type: - string - "null" description: The city associated with the lead country: type: - string - "null" description: The country associated with the lead custom_data: type: - object - "null" properties: {} date_of_birth: type: - string - "null" description: The date of birth associated with the lead desired_amenities: type: - string - "null" description: The desired amenities associated with the lead desired_floor_plan_id: type: - string - "null" description: The external ID of desired floor plan associated with the lead desired_floor_plan_name: type: - string - "null" description: The desired floor plan name desired_lease_term_in_months: type: - string - "null" description: The desired lease term desired_max_rent_in_cents: type: &a313 - number - "null" description: The desired maximum rent example: 100000 desired_max_square_ft: type: - number - "null" description: The desired maximum square feet desired_min_rent_in_cents: type: &a314 - number - "null" description: The desired minimum rent example: 100000 desired_min_square_ft: type: - number - "null" description: The desired minimum square feet desired_num_bathrooms: type: - number - "null" description: The desired number of bathrooms desired_num_bedrooms: type: - integer - "null" description: The desired number of bedrooms desired_unit_number: type: - string - "null" description: The desired unit number desired_unit_type: type: - string - "null" description: The desired unit type email_1: type: - string - "null" description: The primary email address associated with the lead email_2: type: - string - "null" description: The secondary email address associated with the lead first_name: type: - string - "null" description: The first name associated with the lead ils: type: - string - "null" description: The name of the Internet listing service last_name: type: - string - "null" description: The last name associated with the lead lead_source: type: - string - "null" description: The lead source leasing_agent: type: - string - "null" description: The name of the leasing agent middle_name: type: - string - "null" description: The middle name associated with the lead notes: type: - string - "null" description: Notes associated with the lead number_of_occupants: type: - integer - "null" description: The number of occupants pet_details: type: - string - "null" description: "DEPRECATED: Use the pets array instead" x-fern-availability: deprecated deprecated: true pets: type: array items: type: object properties: id: type: string description: The Propexo unique identifier for the lead pet created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor age_in_years: type: - number - "null" description: The age in years of the lead pet breed: type: - string - "null" description: The breed of the lead pet color: type: - string - "null" description: The color of the lead pet gender_raw: type: - string - "null" description: The raw value for the gender of the lead pet is_fixed: type: - boolean - "null" description: Whether the lead pet is fixed is_service_animal: type: - boolean - "null" description: Whether the lead pet is a service animal name: type: - string - "null" description: The name associated with the lead pet notes: type: - string - "null" description: Notes associated with the lead pet type: type: - string - "null" description: The type associated with the lead pet weight_in_pounds: type: - number - "null" description: The weight in pounds of the lead pet custom_data: type: - object - "null" properties: {} required: - id - created_at - updated_at - last_seen - x_id - age_in_years - breed - color - gender_raw - is_fixed - is_service_animal - name - notes - type - weight_in_pounds - custom_data x-propexo: &a315 derivedFromModel: lead_pets phone_1_type: type: - string - "null" description: Type of the primary phone number phone_1: type: - string - "null" description: Primary phone number associated with the lead phone_2_type: type: - string - "null" description: Type of the secondary phone number phone_2: type: - string - "null" description: Secondary phone number associated with the lead state: type: - string - "null" description: The state associated with the lead status: type: - string - "null" description: The raw status associated with the lead target_move_in_date: type: - string - "null" description: The target move in date zip: type: - string - "null" description: The zip code associated with the lead property_id: type: string description: The Propexo unique identifier for the property lead_source_id: type: - string - "null" description: The Propexo unique identifier for the lead source unit_id_preferred: type: array items: type: string integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" screenings: type: array items: type: object properties: id: type: string description: The Propexo ID of the screening created_at: type: string description: The date record first entered Propexo last_seen: type: string description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor status_raw: type: - string - "null" description: The status/results of the screening screening_date: type: - string - "null" description: The date the screening took place required: - id - created_at - last_seen - x_id - status_raw - screening_date x-propexo: *a153 required: - id - created_at - updated_at - last_seen - x_created_at - x_guestcard_id - x_id - x_leasing_agent_id - x_property_id - x_unit_id - x_unit_id_preferred - x_updated_at - x_lead_source_id - address_1 - address_2 - city - country - custom_data - date_of_birth - desired_amenities - desired_floor_plan_id - desired_floor_plan_name - desired_lease_term_in_months - desired_max_rent_in_cents - desired_max_square_ft - desired_min_rent_in_cents - desired_min_square_ft - desired_num_bathrooms - desired_num_bedrooms - desired_unit_number - desired_unit_type - email_1 - email_2 - first_name - ils - last_name - lead_source - leasing_agent - middle_name - notes - number_of_occupants - pet_details - pets - phone_1_type - phone_1 - phone_2_type - phone_2 - state - status - target_move_in_date - zip - property_id - lead_source_id - unit_id_preferred - integration_id - integration_vendor - screenings _v1_leads__get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: type: array items: $ref: "#/components/schemas/Lead" required: - meta - results _v1_leads__post_input: type: object properties: integration_id: type: string property_id: type: string description: The Propexo unique identifier for the property first_name: type: string description: The first name associated with the lead last_name: type: string description: The last name associated with the lead employee_id: type: string description: The Propexo unique identifier for the employee desired_unit_ids: type: array items: type: string maxItems: 25 description: An array of the Propexo unit IDs that the lead is interested in unit_id: type: string description: The Propexo unique identifier for the unit number_of_additional_occupants: type: integer minimum: 0 description: The number of additional occupants associated with the lead desired_num_bathrooms: type: number minimum: 0 description: The desired number of bathrooms desired_num_bedrooms: type: number description: The desired number of bedrooms credit_score: type: string description: The credit score of the lead target_move_in_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The move-in date associated with the lead. The timestamp will be stripped off and only the date will be used email_1: type: string description: The primary email address associated with the lead has_cats: type: boolean description: Whether or not the lead has cats has_dogs: type: boolean description: Whether or not the lead has dogs has_other_pets: type: boolean description: Whether or not the lead has pets that aren't dogs or cats desired_max_rent_in_cents: type: integer minimum: 0 description: The maximum rent cost the lead is looking to pay, in cents monthly_income_in_cents: type: integer minimum: 0 description: The monthly income of the lead, in cents middle_initial: type: string minLength: 1 maxLength: 1 description: The middle initial of the lead phone_1: type: string description: Primary phone number associated with the lead lead_source: type: string description: The name of the source of the lead status: type: string enum: - ACTIVE - COLD - INACTIVE - WAITLISTED description: The status associated with the lead desired_move_in_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: Deprecated. Use target_move_in_date instead. deprecated: true desired_bathrooms: type: string description: Deprecated. Use desired_num_bathrooms instead. deprecated: true desired_bedrooms: type: integer minimum: 0 description: Deprecated. Use desired_num_bedrooms instead. deprecated: true lead_source_id: type: string description: The Propexo unique identifier for the lead source lease_period_id: type: string description: The Propexo unique identifier for the lease period phone_1_type: type: string enum: *a16 description: Type of the primary phone number middle_name: type: string description: The middle name associated with the lead phone_2: type: string description: Secondary phone number associated with the lead phone_2_type: type: string enum: *a16 description: Type of the secondary phone number address_1: type: string description: The first address line associated with the lead address_2: type: string description: The second address line associated with the lead city: type: string description: The city associated with the lead state: type: string description: The state associated with the lead zip: type: string description: The zip code associated with the lead desired_min_rent_in_cents: type: &a160 - number - "null" description: The minimum rent cost the lead is looking to pay, in cents number_of_occupants: type: integer description: The number of occupants living in the unit notes: type: string description: Notes associated with the lead events: type: array items: type: object properties: employee_id: type: string description: The Propexo unique identifier for the employee lead_source_id: type: string description: The Propexo unique identifier for the lead source unit_id: type: string description: The Propexo unique identifier for the unit. Only some events use this, including "Show" and "Appointment". event_name: type: string enum: *a44 description: The name or type of event. This has to be from a predefined set of events. event_datetime: type: string format: date-time description: The date when the event will occur notes: type: string maxLength: 256 description: Notes associated with the event reasons_for_event: type: string description: The reasons for the event required: - employee_id - event_name - event_datetime description: A list of events to create for the new lead address_type_id: type: string description: The Propexo unique identifier for the address type desired_lease_term_in_months: type: string description: The amount of months for the lease term applicant_status: type: string enum: &a154 - APPLICANT - CO_APPLICANT - OCCUPANT description: The applicant status of the lead. This is optional and defaults to APPLICANT. country: type: string description: The country associated with the lead status_raw: type: string description: The raw status associated with the lead desired_unit_type: type: string description: The desired type of unit lead_relationship_id: type: string description: The Propexo unique identifier for the lead relationship date_of_birth: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date of birth associated with the lead floor_plan_id: type: string description: The Propexo unique identifier for the floor plan third_party_id: type: string minLength: 1 description: A unique value provided to the PMS to uniquely identify the lead from your system. organization_name: type: string description: The name of your organization. Yardi uses this for associating a lead required: - integration_id _v1_leads__post_output: type: object properties: job_id: type: string description: The ID of the job created to handle this operation data: type: object properties: {} required: - job_id - data _v1_leads_{id}_get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query _v1_leads_{id}_get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: $ref: "#/components/schemas/Lead" required: - meta - results _v1_leads_{id}_put_input: type: object properties: lead_id: type: string description: The Propexo unique identifier for the lead employee_id: type: string description: The Propexo unique identifier for the employee desired_unit_ids: type: array items: type: string maxItems: 25 description: An array of the Propexo unit IDs that the lead is interested in unit_id: type: string description: The Propexo unique identifier for the unit first_name: type: string description: The first name associated with the lead last_name: type: string description: The last name associated with the lead number_of_additional_occupants: type: integer minimum: 0 description: The number of additional occupants associated with the lead desired_num_bathrooms: type: number minimum: 0 description: The desired number of bathrooms desired_num_bedrooms: type: number description: The desired number of bedrooms credit_score: type: string description: The credit score of the lead target_move_in_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The move-in date associated with the lead. The timestamp will be stripped off and only the date will be used email_1: type: string description: The primary email address associated with the lead has_cats: type: boolean description: Whether or not the lead has cats has_dogs: type: boolean description: Whether or not the lead has dogs has_other_pets: type: boolean description: Whether or not the lead has pets that aren't dogs or cats desired_max_rent_in_cents: type: number minimum: 0 description: The maximum rent cost the lead is looking to pay, in cents monthly_income_in_cents: type: integer minimum: 0 description: The monthly income of the lead, in cents middle_initial: type: string minLength: 1 maxLength: 1 description: The middle initial of the lead phone_1: type: string description: Primary phone number associated with the lead lead_source: type: string description: The name of the source of the lead status: type: string enum: - ACTIVE - COLD - INACTIVE - WAITLISTED description: The status associated with the lead inactive_reason: type: string enum: - PRICE - LOCATION - AMENITIES - NO_REASON - DECIDED_NOT_TO_MOVE - LEASING_CRITERIA_NOT_MET - LOOKING_FOR_MOVE_IN_SPECIAL - NO_AVAILABILITY - DUPLICATE - OTHER description: The reason the lead is inactive desired_move_in_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: Deprecated. Use target_move_in_date instead. deprecated: true desired_bathrooms: type: string description: Deprecated. Use desired_num_bathrooms instead. deprecated: true desired_bedrooms: type: integer minimum: 0 description: Deprecated. Use desired_num_bedrooms instead. deprecated: true lease_period_id: type: string description: The Propexo unique identifier for the lease period lead_source_id: type: string description: The Propexo unique identifier for the lead source middle_name: type: string description: The middle name associated with the lead phone_1_type: type: string enum: *a16 description: Type of the primary phone number phone_2: type: string description: Secondary phone number associated with the lead phone_2_type: type: string enum: *a16 description: Type of the secondary phone number address_1: type: string description: The first address line associated with the lead address_2: type: string description: The second address line associated with the lead city: type: string description: The city associated with the lead state: type: string description: The state associated with the lead zip: type: string description: The zip code associated with the lead desired_min_rent_in_cents: type: &a162 - number - "null" description: The minimum rent cost the lead is looking to pay, in cents number_of_occupants: type: number description: The number of occupants living in the unit notes: type: string description: Notes associated with the lead events: type: array items: type: object properties: unit_id: type: string description: The Propexo unique identifier for the unit x_type_id: type: string description: The PMS id for the event type. x_leasing_agent_id: type: string description: The PMS id for the leasing agent. x_sub_type_id: type: string description: The PMS id for the event sub type. x_result_id: type: string description: The PMS id for the event result. event_datetime: type: string format: date-time description: The date and time that the event occured. appointment_datetime: type: string format: date-time description: The date and time that the appointment will occur. Required if using appointment type. time_from: type: string time_to: type: string notes: type: string description: General notes about the event. title: type: string description: Title for the event. reasons_for_event: type: string description: The reason the event occurred. id: type: string description: The Propexo unique identifier for the event. Only required if attempting to update an existing event. required: - x_type_id description: "DEPRECATED: Please use /events endpoints to write events. Array of events associated with this lead" deprecated: true address_type_id: type: string description: The Propexo unique identifier for the address type. This is required when updating the address desired_lease_term_in_months: type: string description: The amount of months for the lease term applicant_status: type: string enum: &a155 - APPLICANT - CO_APPLICANT - OCCUPANT description: The status of the lead. This is optional and defaults to ACTIVE. country: type: string description: The country associated with the lead status_raw: type: string description: The raw status associated with the lead desired_unit_type: type: string description: The desired type of unit lead_relationship_id: type: string description: The Propexo unique identifier for the lead relationship date_of_birth: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date of birth associated with the lead floor_plan_id: type: string description: The Propexo unique identifier for the floor plan _v1_leads_{id}_put_output: type: object properties: job_id: type: string description: The ID of the job created to handle this operation data: type: object properties: {} required: - job_id - data _v1_lead-relationships__get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor location_id: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. property_id: type: string description: The Propexo unique identifier for the property integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" LeadRelationship: type: object properties: id: type: string description: The Propexo unique identifier for the lead relationship created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: type: string description: The name associated with the lead relationship integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" property_id: type: string description: The Propexo unique identifier for the property required: - id - created_at - updated_at - last_seen - x_id - x_property_id - x_location_id - name - integration_id - integration_vendor - property_id x-propexo: derivedFromModel: lead_relationships _v1_lead-relationships__get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: type: array items: $ref: "#/components/schemas/LeadRelationship" required: - meta - results _v1_lead-sources__get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query x_id: type: string description: The external ID from the integration vendor location_id: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. property_id: type: string description: The Propexo unique identifier for the property integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" LeadSource: type: object properties: id: type: string description: The Propexo unique identifier for the lead source created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: type: - string - "null" description: The name associated with the lead source integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" property_id: type: string description: The Propexo unique identifier for the property required: - id - created_at - updated_at - last_seen - x_id - x_property_id - x_location_id - name - integration_id - integration_vendor - property_id x-propexo: derivedFromModel: lead_sources _v1_lead-sources__get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: type: array items: $ref: "#/components/schemas/LeadSource" required: - meta - results _v1_lead-sources_{lead_source_id}_get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query _v1_lead-sources_{lead_source_id}_get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: $ref: "#/components/schemas/LeadSource" required: - meta - results _v1_leads_{id}_rentable-items_get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query x_id: type: string description: The external ID from the integration vendor location_id: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. property_id: type: string description: The Propexo unique identifier for the property integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" _v1_leads_{id}_rentable-items_get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: type: array items: $ref: "#/components/schemas/RentableItem" required: - meta - results _v1_leads_appfolio__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration property_id: type: string description: The Propexo unique identifier for the property first_name: type: string description: The first name associated with the lead last_name: type: string description: The last name associated with the lead employee_id: type: string description: The Propexo unique identifier for the employee desired_unit_ids: type: array items: type: string maxItems: 25 description: An array of the Propexo unit IDs that the lead is interested in unit_id: type: string description: The Propexo unique identifier for the unit. If desired_unit_ids is not provided, this will be used as the unit ID. This is inteded to help unify the request payload across all PMSs number_of_additional_occupants: type: integer minimum: 0 description: The number of additional occupants associated with the lead desired_num_bathrooms: type: string description: The desired number of bathrooms desired_num_bedrooms: type: integer minimum: 0 description: The desired number of bedrooms credit_score: type: string description: The credit score of the lead target_move_in_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The target move in date associated with the lead email_1: type: string description: The primary email address associated with the lead has_cats: type: boolean description: Whether or not the lead has cats has_dogs: type: boolean description: Whether or not the lead has dogs has_other_pets: type: boolean description: Whether or not the lead has pets that aren't dogs or cats desired_max_rent_in_cents: type: integer minimum: 0 description: The maximum rent cost the lead is looking to pay, in cents monthly_income_in_cents: type: integer minimum: 0 description: The monthly income of the lead, in cents middle_initial: type: string minLength: 1 maxLength: 1 description: The middle initial of the lead phone_1: type: string description: Primary phone number associated with the lead lead_source: type: string description: The name of the source of the lead status: type: string enum: - ACTIVE - COLD - INACTIVE - WAITLISTED description: The status associated with the lead desired_move_in_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: Deprecated. Use target_move_in_date instead. deprecated: true desired_bathrooms: type: string description: Deprecated. Use desired_num_bathrooms instead. deprecated: true desired_bedrooms: type: integer minimum: 0 description: Deprecated. Use desired_num_bedrooms instead. deprecated: true required: - integration_id - property_id - first_name - last_name _v1_leads_appfolio__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration property_id: type: string description: The Propexo unique identifier for the property first_name: type: string description: The first name associated with the lead last_name: type: string description: The last name associated with the lead employee_id: type: - string - "null" description: The Propexo unique identifier for the employee desired_unit_ids: type: - array - "null" items: type: string unit_id: type: - string - "null" description: The Propexo unique identifier for the unit. If desired_unit_ids is not provided, this will be used as the unit ID. This is inteded to help unify the request payload across all PMSs number_of_additional_occupants: type: - integer - "null" minimum: 0 description: The number of additional occupants associated with the lead desired_num_bathrooms: type: - string - "null" description: The desired number of bathrooms desired_num_bedrooms: type: - integer - "null" minimum: 0 description: The desired number of bedrooms credit_score: type: - string - "null" description: The credit score of the lead target_move_in_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" description: The target move in date associated with the lead email_1: type: - string - "null" description: The primary email address associated with the lead has_cats: type: - boolean - "null" description: Whether or not the lead has cats has_dogs: type: - boolean - "null" description: Whether or not the lead has dogs has_other_pets: type: - boolean - "null" description: Whether or not the lead has pets that aren't dogs or cats desired_max_rent_in_cents: type: - integer - "null" minimum: 0 description: The maximum rent cost the lead is looking to pay, in cents monthly_income_in_cents: type: - integer - "null" minimum: 0 description: The monthly income of the lead, in cents middle_initial: type: - string - "null" minLength: 1 maxLength: 1 description: The middle initial of the lead phone_1: type: - string - "null" description: Primary phone number associated with the lead lead_source: type: - string - "null" description: The name of the source of the lead status: type: - string - "null" enum: - ACTIVE - COLD - INACTIVE - WAITLISTED description: The status associated with the lead desired_move_in_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" description: Deprecated. Use target_move_in_date instead. deprecated: true x-fern-availability: deprecated desired_bathrooms: type: - string - "null" description: Deprecated. Use desired_num_bathrooms instead. deprecated: true x-fern-availability: deprecated desired_bedrooms: type: - integer - "null" minimum: 0 description: Deprecated. Use desired_num_bedrooms instead. deprecated: true x-fern-availability: deprecated required: - integration_id - property_id - first_name - last_name - employee_id - desired_unit_ids - unit_id - number_of_additional_occupants - desired_num_bathrooms - desired_num_bedrooms - credit_score - target_move_in_date - email_1 - has_cats - has_dogs - has_other_pets - desired_max_rent_in_cents - monthly_income_in_cents - middle_initial - phone_1 - lead_source - status - desired_move_in_date - desired_bathrooms - desired_bedrooms required: - meta - result _v1_leads_appfolio_{lead_id}_put_input: type: object properties: employee_id: type: string description: The Propexo unique identifier for the employee desired_unit_ids: type: array items: type: string maxItems: 25 description: An array of the Propexo unit IDs that the lead is interested in unit_id: type: string description: The Propexo unique identifier for the unit. If desired_unit_ids is not provided, this will be used as the unit ID. This is inteded to help unify the request payload across all PMSs first_name: type: string description: The first name associated with the lead last_name: type: string description: The last name associated with the lead number_of_additional_occupants: type: integer minimum: 0 description: The number of additional occupants associated with the lead desired_num_bathrooms: type: string description: The desired number of bathrooms desired_num_bedrooms: type: integer minimum: 0 description: The desired number of bedrooms credit_score: type: string description: The credit score of the lead target_move_in_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The target move in date associated with the lead email_1: type: string description: The primary email address associated with the lead has_cats: type: boolean description: Whether or not the lead has cats has_dogs: type: boolean description: Whether or not the lead has dogs has_other_pets: type: boolean description: Whether or not the lead has pets that aren't dogs or cats desired_max_rent_in_cents: type: integer minimum: 0 description: The maximum rent cost the lead is looking to pay, in cents monthly_income_in_cents: type: integer minimum: 0 description: The monthly income of the lead, in cents middle_initial: type: string minLength: 1 maxLength: 1 description: The middle initial of the lead phone_1: type: string description: Primary phone number associated with the lead lead_source: type: string description: The name of the source of the lead status: type: string enum: - ACTIVE - COLD - INACTIVE - WAITLISTED description: The status associated with the lead inactive_reason: type: string enum: - PRICE - LOCATION - AMENITIES - NO_REASON - DECIDED_NOT_TO_MOVE - LEASING_CRITERIA_NOT_MET - LOOKING_FOR_MOVE_IN_SPECIAL - NO_AVAILABILITY - DUPLICATE - OTHER description: The reason the lead is inactive desired_move_in_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: Deprecated. Use target_move_in_date instead. deprecated: true desired_bathrooms: type: string description: Deprecated. Use desired_num_bathrooms instead. deprecated: true desired_bedrooms: type: integer minimum: 0 description: Deprecated. Use desired_num_bedrooms instead. deprecated: true _v1_leads_appfolio_{lead_id}_put_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: lead_id: type: string description: The Propexo unique identifier for the lead employee_id: type: string description: The Propexo unique identifier for the employee desired_unit_ids: type: array items: type: string unit_id: type: string description: The Propexo unique identifier for the unit. If desired_unit_ids is not provided, this will be used as the unit ID. This is inteded to help unify the request payload across all PMSs first_name: type: string description: The first name associated with the lead last_name: type: string description: The last name associated with the lead number_of_additional_occupants: type: integer minimum: 0 description: The number of additional occupants associated with the lead desired_num_bathrooms: type: string description: The desired number of bathrooms desired_num_bedrooms: type: integer minimum: 0 description: The desired number of bedrooms credit_score: type: string description: The credit score of the lead target_move_in_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The target move in date associated with the lead email_1: type: string description: The primary email address associated with the lead has_cats: type: boolean description: Whether or not the lead has cats has_dogs: type: boolean description: Whether or not the lead has dogs has_other_pets: type: boolean description: Whether or not the lead has pets that aren't dogs or cats desired_max_rent_in_cents: type: integer minimum: 0 description: The maximum rent cost the lead is looking to pay, in cents monthly_income_in_cents: type: integer minimum: 0 description: The monthly income of the lead, in cents middle_initial: type: string minLength: 1 maxLength: 1 description: The middle initial of the lead phone_1: type: string description: Primary phone number associated with the lead lead_source: type: string description: The name of the source of the lead status: type: string enum: - ACTIVE - COLD - INACTIVE - WAITLISTED description: The status associated with the lead inactive_reason: type: string enum: - PRICE - LOCATION - AMENITIES - NO_REASON - DECIDED_NOT_TO_MOVE - LEASING_CRITERIA_NOT_MET - LOOKING_FOR_MOVE_IN_SPECIAL - NO_AVAILABILITY - DUPLICATE - OTHER description: The reason the lead is inactive desired_move_in_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: Deprecated. Use target_move_in_date instead. deprecated: true x-fern-availability: deprecated desired_bathrooms: type: string description: Deprecated. Use desired_num_bathrooms instead. deprecated: true x-fern-availability: deprecated desired_bedrooms: type: integer minimum: 0 description: Deprecated. Use desired_num_bedrooms instead. deprecated: true x-fern-availability: deprecated required: - lead_id required: - meta - result _v1_leads_buildium__post_input: type: object properties: {} _v1_leads_buildium__post_output: type: object properties: {} _v1_leads_buildium_{lead_id}_put_input: type: object properties: {} _v1_leads_buildium_{lead_id}_put_output: type: object properties: {} _v1_leads_mri__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration property_id: type: string description: The Propexo unique identifier for the property last_name: type: string description: The last name associated with the lead address_type_id: type: string description: The Propexo unique identifier for the address type first_name: type: string description: The first name associated with the lead email_1: type: string description: The primary email address associated with the lead address_1: type: string description: The first address line associated with the lead address_2: type: string description: The second address line associated with the lead city: type: string description: The city associated with the lead state: type: string enum: *a39 description: The state associated with the lead zip: type: string description: The zip code associated with the lead target_move_in_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The target move in date associated with the lead desired_num_bedrooms: type: number description: The desired number of bedrooms desired_num_bathrooms: type: string description: The desired number of bathrooms desired_lease_term_in_months: type: number description: The desired lease term in months of the lead number_of_occupants: type: number description: The number of occupants for the lead notes: type: string maxLength: 30 description: Notes associated with the lead phone_1: type: string description: Primary phone number associated with the lead phone_1_type: type: string enum: - FAX - HOME - MOBILE - OTHER - WORK description: Type of the primary phone number phone_2: type: string description: Secondary phone number associated with the lead phone_2_type: type: string enum: - FAX - HOME - MOBILE - OTHER - WORK description: Type of the secondary phone number applicant_status: type: string enum: *a154 description: The applicant status of the lead. This is optional and defaults to APPLICANT. required: - integration_id - property_id - last_name _v1_leads_mri__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration property_id: type: string description: The Propexo unique identifier for the property last_name: type: string description: The last name associated with the lead address_type_id: type: - string - "null" description: The Propexo unique identifier for the address type first_name: type: - string - "null" description: The first name associated with the lead email_1: type: - string - "null" description: The primary email address associated with the lead address_1: type: - string - "null" description: The first address line associated with the lead address_2: type: - string - "null" description: The second address line associated with the lead city: type: - string - "null" description: The city associated with the lead state: type: - string - "null" enum: *a39 description: The state associated with the lead zip: type: - string - "null" description: The zip code associated with the lead target_move_in_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" description: The target move in date associated with the lead desired_num_bedrooms: type: - number - "null" description: The desired number of bedrooms desired_num_bathrooms: type: - string - "null" description: The desired number of bathrooms desired_lease_term_in_months: type: - number - "null" description: The desired lease term in months of the lead number_of_occupants: type: - number - "null" description: The number of occupants for the lead notes: type: - string - "null" maxLength: 30 description: Notes associated with the lead phone_1: type: - string - "null" description: Primary phone number associated with the lead phone_1_type: type: - string - "null" enum: - FAX - HOME - MOBILE - OTHER - WORK description: Type of the primary phone number phone_2: type: - string - "null" description: Secondary phone number associated with the lead phone_2_type: type: - string - "null" enum: - FAX - HOME - MOBILE - OTHER - WORK description: Type of the secondary phone number applicant_status: type: - string - "null" enum: *a154 description: The applicant status of the lead. This is optional and defaults to APPLICANT. required: - integration_id - property_id - last_name - address_type_id - first_name - email_1 - address_1 - address_2 - city - state - zip - target_move_in_date - desired_num_bedrooms - desired_num_bathrooms - desired_lease_term_in_months - number_of_occupants - notes - phone_1 - phone_1_type - phone_2 - phone_2_type - applicant_status required: - meta - result _v1_leads_mri_{lead_id}_put_input: type: object properties: address_type_id: type: string description: The Propexo unique identifier for the address type. This is required when updating the address first_name: type: string description: The first name associated with the lead last_name: type: string description: The last name associated with the lead email_1: type: string description: The primary email address associated with the lead address_1: type: string description: The first address line associated with the lead address_2: type: string description: The second address line associated with the lead city: type: string description: The city associated with the lead state: type: string enum: *a39 description: The state associated with the lead zip: type: string description: The zip code associated with the lead target_move_in_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The target move in date for the lead desired_num_bedrooms: type: number description: The desired number of bedrooms desired_num_bathrooms: type: string description: The desired number of bathrooms desired_lease_term_in_months: type: number description: The desired lease term in months of the lead number_of_occupants: type: number description: The number of occupants for the lead notes: type: string maxLength: 30 description: Notes associated with the lead phone_1: type: string description: Primary phone number associated with the lead phone_1_type: type: string enum: - FAX - HOME - MOBILE - OTHER - WORK description: Type of the primary phone number phone_2: type: string description: Secondary phone number associated with the lead phone_2_type: type: string enum: - FAX - HOME - MOBILE - OTHER - WORK description: Type of the secondary phone number applicant_status: type: string enum: *a155 description: The status of the lead. This is optional and defaults to ACTIVE. _v1_leads_mri_{lead_id}_put_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: lead_id: type: string description: The Propexo unique identifier for the lead address_type_id: type: string description: The Propexo unique identifier for the address type. This is required when updating the address first_name: type: string description: The first name associated with the lead last_name: type: string description: The last name associated with the lead email_1: type: string description: The primary email address associated with the lead address_1: type: string description: The first address line associated with the lead address_2: type: string description: The second address line associated with the lead city: type: string description: The city associated with the lead state: type: string enum: *a39 description: The state associated with the lead zip: type: string description: The zip code associated with the lead target_move_in_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The target move in date for the lead desired_num_bedrooms: type: number description: The desired number of bedrooms desired_num_bathrooms: type: string description: The desired number of bathrooms desired_lease_term_in_months: type: number description: The desired lease term in months of the lead number_of_occupants: type: number description: The number of occupants for the lead notes: type: string maxLength: 30 description: Notes associated with the lead phone_1: type: string description: Primary phone number associated with the lead phone_1_type: type: string enum: - FAX - HOME - MOBILE - OTHER - WORK description: Type of the primary phone number phone_2: type: string description: Secondary phone number associated with the lead phone_2_type: type: string enum: - FAX - HOME - MOBILE - OTHER - WORK description: Type of the secondary phone number applicant_status: type: string enum: *a155 description: The status of the lead. This is optional and defaults to ACTIVE. required: - lead_id required: - meta - result _v1_leads_realpage__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration lead_source_id: type: string description: The Propexo unique identifier for the lead source last_name: type: string maxLength: 30 description: The last name associated with the lead first_name: type: string maxLength: 30 description: The first name associated with the lead email_1: type: string format: email description: The primary email address associated with the lead phone_1: type: string description: Primary phone number associated with the lead phone_1_type: type: string enum: &a156 - HOME - WORK - MOBILE - FAX description: Type of the primary phone number phone_2: type: string description: Secondary phone number associated with the lead phone_2_type: type: string enum: &a157 - HOME - WORK - MOBILE - FAX description: Type of the secondary phone number address_1: type: string description: The first address line associated with the lead address_2: type: string description: The second address line associated with the lead city: type: string description: The city associated with the lead state: type: string description: The state associated with the lead zip: type: string description: The zip code associated with the lead country: type: string description: The country associated with the lead required: - integration_id - last_name - first_name _v1_leads_realpage__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration lead_source_id: type: - string - "null" description: The Propexo unique identifier for the lead source last_name: type: string maxLength: 30 description: The last name associated with the lead first_name: type: string maxLength: 30 description: The first name associated with the lead email_1: type: - string - "null" format: email description: The primary email address associated with the lead phone_1: type: - string - "null" description: Primary phone number associated with the lead phone_1_type: type: - string - "null" enum: *a156 description: Type of the primary phone number phone_2: type: - string - "null" description: Secondary phone number associated with the lead phone_2_type: type: - string - "null" enum: *a157 description: Type of the secondary phone number address_1: type: - string - "null" description: The first address line associated with the lead address_2: type: - string - "null" description: The second address line associated with the lead city: type: - string - "null" description: The city associated with the lead state: type: - string - "null" description: The state associated with the lead zip: type: - string - "null" description: The zip code associated with the lead country: type: - string - "null" description: The country associated with the lead required: - integration_id - lead_source_id - last_name - first_name - email_1 - phone_1 - phone_1_type - phone_2 - phone_2_type - address_1 - address_2 - city - state - zip - country required: - meta - result _v1_leads_realpage_{id}_put_input: type: object properties: last_name: type: string maxLength: 30 description: The last name associated with the lead first_name: type: string maxLength: 30 description: The first name associated with the lead lead_source_id: type: string description: The Propexo unique identifier for the lead source email_1: type: string format: email description: The primary email address associated with the lead phone_1: type: string description: Primary phone number associated with the lead phone_1_type: type: string enum: &a158 - HOME - WORK - MOBILE - FAX description: Type of the primary phone number phone_2: type: string description: Secondary phone number associated with the lead phone_2_type: type: string enum: &a159 - HOME - WORK - MOBILE - FAX description: Type of the secondary phone number address_1: type: string description: The first address line associated with the lead address_2: type: string description: The second address line associated with the lead city: type: string description: The city associated with the lead state: type: string description: The state associated with the lead zip: type: string description: The zip code associated with the lead country: type: string description: The country associated with the lead required: - last_name - first_name _v1_leads_realpage_{id}_put_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: id: type: string description: The Propexo unique identifier for the lead last_name: type: string maxLength: 30 description: The last name associated with the lead first_name: type: string maxLength: 30 description: The first name associated with the lead lead_source_id: type: string description: The Propexo unique identifier for the lead source email_1: type: string format: email description: The primary email address associated with the lead phone_1: type: string description: Primary phone number associated with the lead phone_1_type: type: string enum: *a158 description: Type of the primary phone number phone_2: type: string description: Secondary phone number associated with the lead phone_2_type: type: string enum: *a159 description: Type of the secondary phone number address_1: type: string description: The first address line associated with the lead address_2: type: string description: The second address line associated with the lead city: type: string description: The city associated with the lead state: type: string description: The state associated with the lead zip: type: string description: The zip code associated with the lead country: type: string description: The country associated with the lead required: - id - last_name - first_name required: - meta - result _v1_leads_realpage_rpx__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration property_id: type: string description: The Propexo unique identifier for the property lead_relationship_id: type: string description: The Propexo unique identifier for the lead relationship first_name: type: string maxLength: 30 description: The first name associated with the lead last_name: type: string maxLength: 30 description: The last name associated with the lead middle_name: type: string description: The middle name associated with the lead date_of_birth: type: string format: date-time description: The date of birth associated with the lead employee_id: type: string description: The Propexo unique identifier for the employee lead_source_id: type: string description: The Propexo unique identifier for the lead source phone_1: type: string description: Primary phone number associated with the lead phone_1_type: type: string enum: - FAX - HOME - MOBILE - OTHER - WORK description: Type of the primary phone number phone_2: type: string description: Secondary phone number associated with the lead phone_2_type: type: string enum: - FAX - HOME - MOBILE - OTHER - WORK description: Type of the secondary phone number email_1: type: string description: The primary email address associated with the lead address_1: type: string description: The first address line associated with the lead address_2: type: string description: The second address line associated with the lead city: type: string description: The city associated with the lead state: type: string description: The state associated with the lead zip: type: string description: The zip code associated with the lead country: type: string description: The country associated with the lead target_move_in_date: type: string format: date-time description: The move-in date associated with the lead desired_lease_term_in_months: type: number description: The amount of months for the lease term desired_max_rent_in_cents: type: integer description: The maximum rent cost the lead is looking to pay, in cents number_of_occupants: type: integer description: The number of occupants living in the unit unit_id: type: string description: The Propexo unique identifier for the unit required: - integration_id - property_id - lead_relationship_id - first_name - last_name _v1_leads_realpage_rpx__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration property_id: type: string description: The Propexo unique identifier for the property lead_relationship_id: type: string description: The Propexo unique identifier for the lead relationship first_name: type: string maxLength: 30 description: The first name associated with the lead last_name: type: string maxLength: 30 description: The last name associated with the lead middle_name: type: - string - "null" description: The middle name associated with the lead date_of_birth: type: - string - "null" format: date-time description: The date of birth associated with the lead employee_id: type: - string - "null" description: The Propexo unique identifier for the employee lead_source_id: type: - string - "null" description: The Propexo unique identifier for the lead source phone_1: type: - string - "null" description: Primary phone number associated with the lead phone_1_type: type: - string - "null" enum: - FAX - HOME - MOBILE - OTHER - WORK description: Type of the primary phone number phone_2: type: - string - "null" description: Secondary phone number associated with the lead phone_2_type: type: - string - "null" enum: - FAX - HOME - MOBILE - OTHER - WORK description: Type of the secondary phone number email_1: type: - string - "null" description: The primary email address associated with the lead address_1: type: - string - "null" description: The first address line associated with the lead address_2: type: - string - "null" description: The second address line associated with the lead city: type: - string - "null" description: The city associated with the lead state: type: - string - "null" description: The state associated with the lead zip: type: - string - "null" description: The zip code associated with the lead country: type: - string - "null" description: The country associated with the lead target_move_in_date: type: - string - "null" format: date-time description: The move-in date associated with the lead desired_lease_term_in_months: type: - number - "null" description: The amount of months for the lease term desired_max_rent_in_cents: type: - integer - "null" description: The maximum rent cost the lead is looking to pay, in cents number_of_occupants: type: - integer - "null" description: The number of occupants living in the unit unit_id: type: - string - "null" description: The Propexo unique identifier for the unit required: - integration_id - property_id - lead_relationship_id - first_name - last_name - middle_name - date_of_birth - employee_id - lead_source_id - phone_1 - phone_1_type - phone_2 - phone_2_type - email_1 - address_1 - address_2 - city - state - zip - country - target_move_in_date - desired_lease_term_in_months - desired_max_rent_in_cents - number_of_occupants - unit_id required: - meta - result _v1_leads_realpage_rpx_{lead_id}_put_input: type: object properties: employee_id: type: string description: The Propexo unique identifier for the employee lead_source_id: type: string description: The Propexo unique identifier for the lead source lead_relationship_id: type: string description: The Propexo unique identifier for the lead relationship unit_id: type: string description: The Propexo unique identifier for the unit first_name: type: string maxLength: 30 description: The first name associated with the lead middle_name: type: string maxLength: 30 description: The middle name associated with the lead last_name: type: string maxLength: 30 description: The last name associated with the lead date_of_birth: type: string format: date-time description: The date of birth associated with the lead phone_1: type: string description: Primary phone number associated with the lead phone_1_type: type: string enum: - FAX - HOME - MOBILE - OTHER - WORK description: Type of the primary phone number phone_2: type: string description: Secondary phone number associated with the lead phone_2_type: type: string enum: - FAX - HOME - MOBILE - OTHER - WORK description: Type of the secondary phone number email_1: type: string description: The primary email address associated with the lead address_1: type: string description: The first address line associated with the lead address_2: type: string description: The second address line associated with the lead city: type: string description: The city associated with the lead state: type: string description: The state associated with the lead zip: type: string description: The zip code associated with the lead country: type: string description: The country associated with the lead target_move_in_date: type: string format: date-time description: The move-in date associated with the lead desired_lease_term_in_months: type: number description: The amount of months for the lease term desired_max_rent_in_cents: type: integer description: The maximum rent cost the lead is looking to pay, in cents number_of_occupants: type: number description: The number of occupants living in the unit _v1_leads_realpage_rpx_{lead_id}_put_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: lead_id: type: string description: The Propexo unique identifier for the lead employee_id: type: string description: The Propexo unique identifier for the employee lead_source_id: type: string description: The Propexo unique identifier for the lead source lead_relationship_id: type: string description: The Propexo unique identifier for the lead relationship unit_id: type: string description: The Propexo unique identifier for the unit first_name: type: string maxLength: 30 description: The first name associated with the lead middle_name: type: string maxLength: 30 description: The middle name associated with the lead last_name: type: string maxLength: 30 description: The last name associated with the lead date_of_birth: type: string format: date-time description: The date of birth associated with the lead phone_1: type: string description: Primary phone number associated with the lead phone_1_type: type: string enum: - FAX - HOME - MOBILE - OTHER - WORK description: Type of the primary phone number phone_2: type: string description: Secondary phone number associated with the lead phone_2_type: type: string enum: - FAX - HOME - MOBILE - OTHER - WORK description: Type of the secondary phone number email_1: type: string description: The primary email address associated with the lead address_1: type: string description: The first address line associated with the lead address_2: type: string description: The second address line associated with the lead city: type: string description: The city associated with the lead state: type: string description: The state associated with the lead zip: type: string description: The zip code associated with the lead country: type: string description: The country associated with the lead target_move_in_date: type: string format: date-time description: The move-in date associated with the lead desired_lease_term_in_months: type: number description: The amount of months for the lease term desired_max_rent_in_cents: type: integer description: The maximum rent cost the lead is looking to pay, in cents number_of_occupants: type: number description: The number of occupants living in the unit required: - lead_id required: - meta - result _v1_leads_resman__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration lead_source_id: type: string description: The Propexo unique identifier for the lead source employee_id: type: string description: The Propexo unique identifier for the employee property_id: type: string description: The Propexo unique identifier for the property unit_id: type: string description: The Propexo unique identifier for the unit floor_plan_id: type: string description: The Propexo unique identifier for the floor plan first_name: type: string description: The first name associated with the lead last_name: type: string description: The last name associated with the lead email_1: type: string description: The primary email address associated with the lead phone_1: type: string description: Primary phone number associated with the lead phone_1_type: type: string enum: - FAX - HOME - MOBILE - WORK description: Type of the primary phone number. This will default to HOME if not provided phone_2: type: string description: Secondary phone number associated with the lead phone_2_type: type: string enum: - FAX - HOME - MOBILE - WORK description: Type of the secondary phone number. This will default to MOBILE if not provided city: type: string description: The city associated with the lead address_1: type: string description: The first address line associated with the lead address_2: type: string description: The second address line associated with the lead state: type: string description: The state associated with the lead zip: type: string description: The zip code associated with the lead notes: type: string description: Notes associated with the lead desired_num_bedrooms: type: number minimum: 0 description: The desired number of bedrooms desired_num_bathrooms: type: number minimum: 0 description: The desired number of bathrooms desired_max_rent_in_cents: type: number minimum: 0 description: The maximum rent cost the lead is looking to pay, in cents desired_lease_term_in_months: type: number minimum: 0 description: The amount of months for the lease term target_move_in_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The target move in date associated with the lead required: - integration_id - lead_source_id - employee_id - property_id - first_name - last_name _v1_leads_resman__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration lead_source_id: type: string description: The Propexo unique identifier for the lead source employee_id: type: string description: The Propexo unique identifier for the employee property_id: type: string description: The Propexo unique identifier for the property unit_id: type: - string - "null" description: The Propexo unique identifier for the unit floor_plan_id: type: - string - "null" description: The Propexo unique identifier for the floor plan first_name: type: string description: The first name associated with the lead last_name: type: string description: The last name associated with the lead email_1: type: - string - "null" description: The primary email address associated with the lead phone_1: type: - string - "null" description: Primary phone number associated with the lead phone_1_type: type: - string - "null" enum: - FAX - HOME - MOBILE - WORK description: Type of the primary phone number. This will default to HOME if not provided phone_2: type: - string - "null" description: Secondary phone number associated with the lead phone_2_type: type: - string - "null" enum: - FAX - HOME - MOBILE - WORK description: Type of the secondary phone number. This will default to MOBILE if not provided city: type: - string - "null" description: The city associated with the lead address_1: type: - string - "null" description: The first address line associated with the lead address_2: type: - string - "null" description: The second address line associated with the lead state: type: - string - "null" description: The state associated with the lead zip: type: - string - "null" description: The zip code associated with the lead notes: type: - string - "null" description: Notes associated with the lead desired_num_bedrooms: type: - number - "null" minimum: 0 description: The desired number of bedrooms desired_num_bathrooms: type: - number - "null" minimum: 0 description: The desired number of bathrooms desired_max_rent_in_cents: type: - number - "null" minimum: 0 description: The maximum rent cost the lead is looking to pay, in cents desired_lease_term_in_months: type: - number - "null" minimum: 0 description: The amount of months for the lease term target_move_in_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" description: The target move in date associated with the lead required: - integration_id - lead_source_id - employee_id - property_id - unit_id - floor_plan_id - first_name - last_name - email_1 - phone_1 - phone_1_type - phone_2 - phone_2_type - city - address_1 - address_2 - state - zip - notes - desired_num_bedrooms - desired_num_bathrooms - desired_max_rent_in_cents - desired_lease_term_in_months - target_move_in_date required: - meta - result _v1_leads_resman_{lead_id}_put_input: type: object properties: lead_source_id: type: string description: The Propexo unique identifier for the lead source unit_id: type: string description: The Propexo unique identifier for the unit floor_plan_id: type: string description: The Propexo unique identifier for the floor plan first_name: type: string description: The first name associated with the lead last_name: type: string description: The last name associated with the lead email_1: type: string description: The primary email address associated with the lead phone_1: type: string description: Primary phone number associated with the lead phone_1_type: type: string enum: - FAX - HOME - MOBILE - WORK description: Type of the primary phone number. This will default to HOME if not provided phone_2: type: string description: Secondary phone number associated with the lead phone_2_type: type: string enum: - FAX - HOME - MOBILE - WORK description: Type of the secondary phone number. This will default to MOBILE if not provided city: type: string description: The city associated with the lead address_1: type: string description: The first address line associated with the lead address_2: type: string description: The second address line associated with the lead state: type: string description: The state associated with the lead zip: type: string description: The zip code associated with the lead desired_num_bedrooms: type: number minimum: 0 description: The desired number of bedrooms desired_num_bathrooms: type: number minimum: 0 description: The desired number of bathrooms desired_max_rent_in_cents: type: number minimum: 0 description: The maximum rent cost the lead is looking to pay, in cents desired_lease_term_in_months: type: number minimum: 0 description: The amount of months for the lease term target_move_in_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The target move in date associated with the lead _v1_leads_resman_{lead_id}_put_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: lead_id: type: string description: The Propexo unique identifier for the lead lead_source_id: type: string description: The Propexo unique identifier for the lead source unit_id: type: string description: The Propexo unique identifier for the unit floor_plan_id: type: string description: The Propexo unique identifier for the floor plan first_name: type: string description: The first name associated with the lead last_name: type: string description: The last name associated with the lead email_1: type: string description: The primary email address associated with the lead phone_1: type: string description: Primary phone number associated with the lead phone_1_type: type: string enum: - FAX - HOME - MOBILE - WORK description: Type of the primary phone number. This will default to HOME if not provided phone_2: type: string description: Secondary phone number associated with the lead phone_2_type: type: string enum: - FAX - HOME - MOBILE - WORK description: Type of the secondary phone number. This will default to MOBILE if not provided city: type: string description: The city associated with the lead address_1: type: string description: The first address line associated with the lead address_2: type: string description: The second address line associated with the lead state: type: string description: The state associated with the lead zip: type: string description: The zip code associated with the lead desired_num_bedrooms: type: number minimum: 0 description: The desired number of bedrooms desired_num_bathrooms: type: number minimum: 0 description: The desired number of bathrooms desired_max_rent_in_cents: type: number minimum: 0 description: The maximum rent cost the lead is looking to pay, in cents desired_lease_term_in_months: type: number minimum: 0 description: The amount of months for the lease term target_move_in_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The target move in date associated with the lead required: - lead_id required: - meta - result _v1_leads_yardi__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration property_id: type: string description: The Propexo unique identifier for the property lead_source_id: type: string description: The Propexo unique identifier for the lead source employee_id: type: string description: The Propexo unique identifier for the employee third_party_id: type: string minLength: 1 description: A unique value provided to the PMS to uniquely identify the lead from your system. first_name: type: string description: The first name associated with the lead last_name: type: string description: The last name associated with the lead organization_name: type: string description: The name of your organization. Yardi uses this for associating a lead unit_id: type: string description: The Propexo unique identifier for the unit phone_1: type: string description: Primary phone number associated with the lead phone_1_type: type: string enum: *a16 description: Type of the primary phone number phone_2: type: string description: Secondary phone number associated with the lead phone_2_type: type: string enum: *a16 description: Type of the secondary phone number email_1: type: string description: The primary email address associated with the lead address_1: type: string description: The first address line associated with the lead address_2: type: string description: The second address line associated with the lead city: type: string description: The city associated with the lead state: type: string description: The state associated with the lead zip: type: string description: The zip code associated with the lead target_move_in_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The move-in date associated with the lead. The timestamp will be stripped off and only the date will be used desired_num_bedrooms: type: number description: The desired number of bedrooms desired_lease_term_in_months: type: string description: The amount of months for the lease term notes: type: string description: Notes associated with the lead events: type: array items: type: object properties: employee_id: type: string description: The Propexo unique identifier for the employee lead_source_id: type: string description: The Propexo unique identifier for the lead source unit_id: type: string description: The Propexo unique identifier for the unit. Only some events use this, including "Show" and "Appointment". event_name: type: string enum: *a44 description: The name or type of event. This has to be from a predefined set of events. event_datetime: type: string format: date-time description: The date when the event will occur notes: type: string maxLength: 256 description: Notes associated with the event reasons_for_event: type: string description: The reasons for the event required: - employee_id - event_name - event_datetime description: A list of events to create for the new lead desired_max_rent_in_cents: type: integer minimum: 0 description: The maximum rent cost the lead is looking to pay, in cents required: - integration_id - property_id - lead_source_id - employee_id - third_party_id - first_name - last_name - organization_name _v1_leads_yardi__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration property_id: type: string description: The Propexo unique identifier for the property lead_source_id: type: string description: The Propexo unique identifier for the lead source employee_id: type: string description: The Propexo unique identifier for the employee third_party_id: type: string minLength: 1 description: A unique value provided to the PMS to uniquely identify the lead from your system. first_name: type: string description: The first name associated with the lead last_name: type: string description: The last name associated with the lead organization_name: type: string description: The name of your organization. Yardi uses this for associating a lead unit_id: type: - string - "null" description: The Propexo unique identifier for the unit phone_1: type: - string - "null" description: Primary phone number associated with the lead phone_1_type: type: - string - "null" enum: *a16 description: Type of the primary phone number phone_2: type: - string - "null" description: Secondary phone number associated with the lead phone_2_type: type: - string - "null" enum: *a16 description: Type of the secondary phone number email_1: type: - string - "null" description: The primary email address associated with the lead address_1: type: - string - "null" description: The first address line associated with the lead address_2: type: - string - "null" description: The second address line associated with the lead city: type: - string - "null" description: The city associated with the lead state: type: - string - "null" description: The state associated with the lead zip: type: - string - "null" description: The zip code associated with the lead target_move_in_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" description: The move-in date associated with the lead. The timestamp will be stripped off and only the date will be used desired_num_bedrooms: type: - number - "null" description: The desired number of bedrooms desired_lease_term_in_months: type: - string - "null" description: The amount of months for the lease term notes: type: - string - "null" description: Notes associated with the lead events: type: - array - "null" items: type: object properties: employee_id: type: string description: The Propexo unique identifier for the employee lead_source_id: type: string description: The Propexo unique identifier for the lead source unit_id: type: string description: The Propexo unique identifier for the unit. Only some events use this, including "Show" and "Appointment". event_name: type: string enum: *a44 description: The name or type of event. This has to be from a predefined set of events. event_datetime: type: string format: date-time description: The date when the event will occur notes: type: string maxLength: 256 description: Notes associated with the event reasons_for_event: type: string description: The reasons for the event required: - employee_id - event_name - event_datetime desired_max_rent_in_cents: type: - integer - "null" minimum: 0 description: The maximum rent cost the lead is looking to pay, in cents required: - integration_id - property_id - lead_source_id - employee_id - third_party_id - first_name - last_name - organization_name - unit_id - phone_1 - phone_1_type - phone_2 - phone_2_type - email_1 - address_1 - address_2 - city - state - zip - target_move_in_date - desired_num_bedrooms - desired_lease_term_in_months - notes - events - desired_max_rent_in_cents required: - meta - result _v1_leads_yardi_{lead_id}_put_input: type: object properties: first_name: type: string description: The first name associated with the lead last_name: type: string description: The last name associated with the lead unit_id: type: string description: The Propexo unique identifier for the unit phone_1: type: string description: Primary phone number associated with the lead phone_1_type: type: string enum: *a16 description: Type of the primary phone number phone_2: type: string description: Secondary phone number associated with the lead phone_2_type: type: string enum: *a16 description: Type of the secondary phone number email_1: type: string description: The primary email address associated with the lead address_1: type: string description: The first address line associated with the lead address_2: type: string description: The second address line associated with the lead city: type: string description: The city associated with the lead state: type: string description: The state associated with the lead zip: type: string description: The zip code associated with the lead country: type: string description: The country associated with the lead target_move_in_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The move-in date associated with the lead. The timestamp will be stripped off and only the date will be used desired_num_bedrooms: type: number description: The desired number of bedrooms desired_lease_term_in_months: type: string description: The amount of months for the lease term notes: type: string description: Notes associated with the lead required: - first_name - last_name _v1_leads_yardi_{lead_id}_put_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: lead_id: type: string description: The Propexo unique identifier for the lead first_name: type: string description: The first name associated with the lead last_name: type: string description: The last name associated with the lead unit_id: type: string description: The Propexo unique identifier for the unit phone_1: type: string description: Primary phone number associated with the lead phone_1_type: type: string enum: *a16 description: Type of the primary phone number phone_2: type: string description: Secondary phone number associated with the lead phone_2_type: type: string enum: *a16 description: Type of the secondary phone number email_1: type: string description: The primary email address associated with the lead address_1: type: string description: The first address line associated with the lead address_2: type: string description: The second address line associated with the lead city: type: string description: The city associated with the lead state: type: string description: The state associated with the lead zip: type: string description: The zip code associated with the lead country: type: string description: The country associated with the lead target_move_in_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The move-in date associated with the lead. The timestamp will be stripped off and only the date will be used desired_num_bedrooms: type: number description: The desired number of bedrooms desired_lease_term_in_months: type: string description: The amount of months for the lease term notes: type: string description: Notes associated with the lead required: - lead_id - first_name - last_name required: - meta - result _v1_leads_propertyware__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration first_name: type: string description: The first name associated with the lead last_name: type: string description: The last name associated with the lead middle_name: type: string description: The middle name associated with the lead email_1: type: string description: The primary email address associated with the lead phone_1: type: string description: Primary phone number associated with the lead phone_1_type: type: string enum: - FAX - HOME - MOBILE - OTHER - WORK description: Type of the primary phone number phone_2: type: string description: Secondary phone number associated with the lead phone_2_type: type: string enum: - FAX - HOME - MOBILE - OTHER - WORK description: Type of the secondary phone number city: type: string description: The city associated with the lead address_1: type: string description: The first address line associated with the lead address_2: type: string description: The second address line associated with the lead state: type: string description: The state associated with the lead zip: type: string description: The zip code associated with the lead country: type: string description: The country associated with the lead notes: type: string description: Notes associated with the lead desired_num_bathrooms: type: number description: The desired number of bathrooms desired_num_bedrooms: type: number description: The desired number of bedrooms number_of_occupants: type: integer description: The number of occupants living in the unit desired_max_rent_in_cents: type: &a161 - number - "null" description: The maximum rent cost the lead is looking to pay, in cents desired_min_rent_in_cents: type: *a160 description: The minimum rent cost the lead is looking to pay, in cents status_raw: type: string description: The raw status associated with the lead desired_unit_type: type: string description: The desired type of unit required: - integration_id - first_name - last_name _v1_leads_propertyware__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration first_name: type: string description: The first name associated with the lead last_name: type: string description: The last name associated with the lead middle_name: type: - string - "null" description: The middle name associated with the lead email_1: type: - string - "null" description: The primary email address associated with the lead phone_1: type: - string - "null" description: Primary phone number associated with the lead phone_1_type: type: - string - "null" enum: - FAX - HOME - MOBILE - OTHER - WORK description: Type of the primary phone number phone_2: type: - string - "null" description: Secondary phone number associated with the lead phone_2_type: type: - string - "null" enum: - FAX - HOME - MOBILE - OTHER - WORK description: Type of the secondary phone number city: type: - string - "null" description: The city associated with the lead address_1: type: - string - "null" description: The first address line associated with the lead address_2: type: - string - "null" description: The second address line associated with the lead state: type: - string - "null" description: The state associated with the lead zip: type: - string - "null" description: The zip code associated with the lead country: type: - string - "null" description: The country associated with the lead notes: type: - string - "null" description: Notes associated with the lead desired_num_bathrooms: type: - number - "null" description: The desired number of bathrooms desired_num_bedrooms: type: - number - "null" description: The desired number of bedrooms number_of_occupants: type: - integer - "null" description: The number of occupants living in the unit desired_max_rent_in_cents: type: *a161 description: The maximum rent cost the lead is looking to pay, in cents desired_min_rent_in_cents: type: *a160 description: The minimum rent cost the lead is looking to pay, in cents status_raw: type: - string - "null" description: The raw status associated with the lead desired_unit_type: type: - string - "null" description: The desired type of unit required: - integration_id - first_name - last_name - middle_name - email_1 - phone_1 - phone_1_type - phone_2 - phone_2_type - city - address_1 - address_2 - state - zip - country - notes - desired_num_bathrooms - desired_num_bedrooms - number_of_occupants - desired_max_rent_in_cents - desired_min_rent_in_cents - status_raw - desired_unit_type required: - meta - result _v1_leads_propertyware_{lead_id}_put_input: type: object properties: first_name: type: string description: The first name associated with the lead last_name: type: string description: The last name associated with the lead middle_name: type: string description: The middle name associated with the lead email_1: type: string description: The primary email address associated with the lead phone_1: type: string description: Primary phone number associated with the lead phone_1_type: type: string enum: - FAX - HOME - MOBILE - OTHER - WORK description: Type of the primary phone number phone_2: type: string description: Secondary phone number associated with the lead phone_2_type: type: string enum: - FAX - HOME - MOBILE - OTHER - WORK description: Type of the secondary phone number city: type: string description: The city associated with the lead address_1: type: string description: The first address line associated with the lead address_2: type: string description: The second address line associated with the lead state: type: string description: The state associated with the lead zip: type: string description: The zip code associated with the lead country: type: string description: The country associated with the lead notes: type: string description: Notes associated with the lead desired_num_bathrooms: type: number description: The desired number of bathrooms desired_num_bedrooms: type: number description: The desired number of bedrooms number_of_occupants: type: number description: The number of occupants living in the unit desired_max_rent_in_cents: type: &a163 - number - "null" description: The maximum rent cost the lead is looking to pay, in cents desired_min_rent_in_cents: type: *a162 description: The minimum rent cost the lead is looking to pay, in cents status_raw: type: string description: The raw status associated with the lead desired_unit_type: type: string description: The desired type of unit _v1_leads_propertyware_{lead_id}_put_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: lead_id: type: string description: The Propexo unique identifier for the lead first_name: type: string description: The first name associated with the lead last_name: type: string description: The last name associated with the lead middle_name: type: string description: The middle name associated with the lead email_1: type: string description: The primary email address associated with the lead phone_1: type: string description: Primary phone number associated with the lead phone_1_type: type: string enum: - FAX - HOME - MOBILE - OTHER - WORK description: Type of the primary phone number phone_2: type: string description: Secondary phone number associated with the lead phone_2_type: type: string enum: - FAX - HOME - MOBILE - OTHER - WORK description: Type of the secondary phone number city: type: string description: The city associated with the lead address_1: type: string description: The first address line associated with the lead address_2: type: string description: The second address line associated with the lead state: type: string description: The state associated with the lead zip: type: string description: The zip code associated with the lead country: type: string description: The country associated with the lead notes: type: string description: Notes associated with the lead desired_num_bathrooms: type: number description: The desired number of bathrooms desired_num_bedrooms: type: number description: The desired number of bedrooms number_of_occupants: type: number description: The number of occupants living in the unit desired_max_rent_in_cents: type: *a163 description: The maximum rent cost the lead is looking to pay, in cents desired_min_rent_in_cents: type: *a162 description: The minimum rent cost the lead is looking to pay, in cents status_raw: type: string description: The raw status associated with the lead desired_unit_type: type: string description: The desired type of unit required: - lead_id required: - meta - result _v1_leads_entrata__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration property_id: type: string description: The Propexo unique identifier for the property lead_source_id: type: string description: The Propexo unique identifier for the lead source unit_id: type: string description: The Propexo unique identifier for the unit lease_period_id: type: string description: The Propexo unique identifier for the lease period employee_id: type: string description: The Propexo unique identifier for the employee first_name: type: string description: The first name associated with the lead last_name: type: string description: The last name associated with the lead phone_1: type: string description: Primary phone number associated with the lead. This is often required, but this is configurable to be optional by the property manager. Make sure this is being provided if it's configured to be required for your customer. phone_1_type: type: string enum: - FAX - HOME - MOBILE - OTHER - WORK description: Type of the primary phone number middle_name: type: string description: The middle name associated with the lead phone_2: type: string description: Secondary phone number associated with the lead phone_2_type: type: string enum: - FAX - HOME - MOBILE - OTHER - WORK description: Type of the secondary phone number email_1: type: string description: The primary email address associated with the lead address_1: type: string description: The first address line associated with the lead address_2: type: string description: The second address line associated with the lead city: type: string description: The city associated with the lead state: type: string description: The state associated with the lead zip: type: string description: The zip code associated with the lead target_move_in_date: type: string format: date-time description: The move-in date associated with the lead desired_max_rent_in_cents: type: integer description: The maximum rent cost the lead is looking to pay, in cents desired_min_rent_in_cents: type: integer description: The minimum rent cost the lead is looking to pay, in cents desired_num_bathrooms: type: number description: The desired number of bathrooms desired_num_bedrooms: type: number description: The desired number of bedrooms number_of_occupants: type: integer description: The number of occupants living in the unit notes: type: string description: Notes associated with the lead events: type: array items: type: object properties: unit_id: type: string description: The Propexo unique identifier for the unit x_type_id: type: string description: The PMS id for the event type. x_leasing_agent_id: type: string description: The PMS id for the leasing agent. x_sub_type_id: type: string description: The PMS id for the event sub type. x_result_id: type: string description: The PMS id for the event result. event_datetime: type: string format: date-time description: The date and time that the event occured. appointment_datetime: type: string format: date-time description: The date and time that the appointment will occur. Required if using appointment type. time_from: type: string time_to: type: string notes: type: string description: General notes about the event. title: type: string description: Title for the event. reasons_for_event: type: string description: The reason the event occurred. required: - x_type_id description: "DEPRECATED: Please use /events endpoints to write events. Array of events associated with this lead" deprecated: true required: - integration_id - property_id - lead_source_id - first_name - last_name _v1_leads_entrata__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration property_id: type: string description: The Propexo unique identifier for the property lead_source_id: type: string description: The Propexo unique identifier for the lead source unit_id: type: - string - "null" description: The Propexo unique identifier for the unit lease_period_id: type: - string - "null" description: The Propexo unique identifier for the lease period employee_id: type: - string - "null" description: The Propexo unique identifier for the employee first_name: type: string description: The first name associated with the lead last_name: type: string description: The last name associated with the lead phone_1: type: - string - "null" description: Primary phone number associated with the lead. This is often required, but this is configurable to be optional by the property manager. Make sure this is being provided if it's configured to be required for your customer. phone_1_type: type: - string - "null" enum: - FAX - HOME - MOBILE - OTHER - WORK description: Type of the primary phone number middle_name: type: - string - "null" description: The middle name associated with the lead phone_2: type: - string - "null" description: Secondary phone number associated with the lead phone_2_type: type: - string - "null" enum: - FAX - HOME - MOBILE - OTHER - WORK description: Type of the secondary phone number email_1: type: - string - "null" description: The primary email address associated with the lead address_1: type: - string - "null" description: The first address line associated with the lead address_2: type: - string - "null" description: The second address line associated with the lead city: type: - string - "null" description: The city associated with the lead state: type: - string - "null" description: The state associated with the lead zip: type: - string - "null" description: The zip code associated with the lead target_move_in_date: type: - string - "null" format: date-time description: The move-in date associated with the lead desired_max_rent_in_cents: type: - integer - "null" description: The maximum rent cost the lead is looking to pay, in cents desired_min_rent_in_cents: type: - integer - "null" description: The minimum rent cost the lead is looking to pay, in cents desired_num_bathrooms: type: - number - "null" description: The desired number of bathrooms desired_num_bedrooms: type: - number - "null" description: The desired number of bedrooms number_of_occupants: type: - integer - "null" description: The number of occupants living in the unit notes: type: - string - "null" description: Notes associated with the lead events: type: - array - "null" items: type: object properties: unit_id: type: string description: The Propexo unique identifier for the unit x_type_id: type: string x_leasing_agent_id: type: string description: The PMS id for the leasing agent. x_sub_type_id: type: string description: The PMS id for the event sub type. x_result_id: type: string description: The PMS id for the event result. event_datetime: type: string format: date-time description: The date and time that the event occured. appointment_datetime: type: string format: date-time description: The date and time that the appointment will occur. Required if using appointment type. time_from: type: string time_to: type: string notes: type: string description: General notes about the event. title: type: string description: Title for the event. reasons_for_event: type: string description: The reason the event occurred. required: - x_type_id required: - integration_id - property_id - lead_source_id - unit_id - lease_period_id - employee_id - first_name - last_name - phone_1 - phone_1_type - middle_name - phone_2 - phone_2_type - email_1 - address_1 - address_2 - city - state - zip - target_move_in_date - desired_max_rent_in_cents - desired_min_rent_in_cents - desired_num_bathrooms - desired_num_bedrooms - number_of_occupants - notes - events required: - meta - result _v1_leads_entrata_{lead_id}_put_input: type: object properties: unit_id: type: string description: The Propexo unique identifier for the unit lease_period_id: type: string description: The Propexo unique identifier for the lease period employee_id: type: string description: The Propexo unique identifier for the employee lead_source_id: type: string description: The Propexo unique identifier for the lead source. This can only be set if there is not a current lead source. first_name: type: string description: The first name associated with the lead last_name: type: string description: The last name associated with the lead middle_name: type: string description: The middle name associated with the lead phone_1: type: string description: Primary phone number associated with the lead phone_1_type: type: string enum: - FAX - HOME - MOBILE - OTHER - WORK description: Type of the primary phone number phone_2: type: string description: Secondary phone number associated with the lead phone_2_type: type: string enum: - FAX - HOME - MOBILE - OTHER - WORK description: Type of the secondary phone number email_1: type: string description: The primary email address associated with the lead address_1: type: string description: The first address line associated with the lead address_2: type: string description: The second address line associated with the lead city: type: string description: The city associated with the lead state: type: string description: The state associated with the lead zip: type: string description: The zip code associated with the lead target_move_in_date: type: string format: date-time description: The move-in date associated with the lead desired_num_bedrooms: type: number description: The desired number of bedrooms desired_num_bathrooms: type: number description: The desired number of bathrooms desired_max_rent_in_cents: type: integer description: The maximum rent cost the lead is looking to pay, in cents desired_min_rent_in_cents: type: integer description: The minimum rent cost the lead is looking to pay, in cents number_of_occupants: type: number description: The number of occupants living in the unit notes: type: string description: Notes associated with the lead events: type: array items: type: object properties: unit_id: type: string description: The Propexo unique identifier for the unit x_type_id: type: string description: The PMS id for the event type. x_leasing_agent_id: type: string description: The PMS id for the leasing agent. x_sub_type_id: type: string description: The PMS id for the event sub type. x_result_id: type: string description: The PMS id for the event result. event_datetime: type: string format: date-time description: The date and time that the event occured. appointment_datetime: type: string format: date-time description: The date and time that the appointment will occur. Required if using appointment type. time_from: type: string time_to: type: string notes: type: string description: General notes about the event. title: type: string description: Title for the event. reasons_for_event: type: string description: The reason the event occurred. id: type: string description: The Propexo unique identifier for the event. Only required if attempting to update an existing event. required: - x_type_id description: "DEPRECATED: Please use /events endpoints to write events. Array of events associated with this lead" deprecated: true _v1_leads_entrata_{lead_id}_put_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: lead_id: type: string description: The Propexo unique identifier for the lead unit_id: type: string description: The Propexo unique identifier for the unit lease_period_id: type: string description: The Propexo unique identifier for the lease period employee_id: type: string description: The Propexo unique identifier for the employee lead_source_id: type: string description: The Propexo unique identifier for the lead source. This can only be set if there is not a current lead source. first_name: type: string description: The first name associated with the lead last_name: type: string description: The last name associated with the lead middle_name: type: string description: The middle name associated with the lead phone_1: type: string description: Primary phone number associated with the lead phone_1_type: type: string enum: - FAX - HOME - MOBILE - OTHER - WORK description: Type of the primary phone number phone_2: type: string description: Secondary phone number associated with the lead phone_2_type: type: string enum: - FAX - HOME - MOBILE - OTHER - WORK description: Type of the secondary phone number email_1: type: string description: The primary email address associated with the lead address_1: type: string description: The first address line associated with the lead address_2: type: string description: The second address line associated with the lead city: type: string description: The city associated with the lead state: type: string description: The state associated with the lead zip: type: string description: The zip code associated with the lead target_move_in_date: type: string format: date-time description: The move-in date associated with the lead desired_num_bedrooms: type: number description: The desired number of bedrooms desired_num_bathrooms: type: number description: The desired number of bathrooms desired_max_rent_in_cents: type: integer description: The maximum rent cost the lead is looking to pay, in cents desired_min_rent_in_cents: type: integer description: The minimum rent cost the lead is looking to pay, in cents number_of_occupants: type: number description: The number of occupants living in the unit notes: type: string description: Notes associated with the lead events: type: array items: type: object properties: unit_id: type: string description: The Propexo unique identifier for the unit x_type_id: type: string x_leasing_agent_id: type: string description: The PMS id for the leasing agent. x_sub_type_id: type: string description: The PMS id for the event sub type. x_result_id: type: string description: The PMS id for the event result. event_datetime: type: string format: date-time description: The date and time that the event occured. appointment_datetime: type: string format: date-time description: The date and time that the appointment will occur. Required if using appointment type. time_from: type: string time_to: type: string notes: type: string description: General notes about the event. title: type: string description: Title for the event. reasons_for_event: type: string description: The reason the event occurred. id: type: string description: The Propexo unique identifier for the event. Only required if attempting to update an existing event. required: - x_type_id required: - lead_id required: - meta - result _v1_leads_rentmanager__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration property_id: type: string description: The Propexo unique identifier for the property first_name: type: string description: The first name associated with the lead last_name: type: string description: The last name associated with the lead lead_source_id: type: string description: The Propexo unique identifier for the lead source middle_name: type: string description: The middle name associated with the lead date_of_birth: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date of birth associated with the lead email_1: type: string description: The primary email address associated with the lead phone_1: type: string description: Primary phone number associated with the lead phone_1_type: type: string enum: &a164 - HOME - WORK - MOBILE - FAX - OTHER description: Type of the primary phone number phone_2: type: string description: Secondary phone number associated with the lead phone_2_type: type: string enum: &a165 - HOME - WORK - MOBILE - FAX - OTHER description: Type of the secondary phone number city: type: string description: The city associated with the lead address_1: type: string description: The first address line associated with the lead. If any one of the address fields are provided, they must all be provided state: type: string description: The state associated with the lead zip: type: string description: The zip code associated with the lead country: type: string description: The country associated with the lead notes: type: string description: Notes associated with the lead required: - integration_id - property_id - first_name - last_name _v1_leads_rentmanager__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration property_id: type: string description: The Propexo unique identifier for the property first_name: type: string description: The first name associated with the lead last_name: type: string description: The last name associated with the lead lead_source_id: type: - string - "null" description: The Propexo unique identifier for the lead source middle_name: type: - string - "null" description: The middle name associated with the lead date_of_birth: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" description: The date of birth associated with the lead email_1: type: - string - "null" description: The primary email address associated with the lead phone_1: type: - string - "null" description: Primary phone number associated with the lead phone_1_type: type: - string - "null" enum: *a164 description: Type of the primary phone number phone_2: type: - string - "null" description: Secondary phone number associated with the lead phone_2_type: type: - string - "null" enum: *a165 description: Type of the secondary phone number city: type: - string - "null" description: The city associated with the lead address_1: type: - string - "null" description: The first address line associated with the lead. If any one of the address fields are provided, they must all be provided state: type: - string - "null" description: The state associated with the lead zip: type: - string - "null" description: The zip code associated with the lead country: type: - string - "null" description: The country associated with the lead notes: type: - string - "null" description: Notes associated with the lead required: - integration_id - property_id - first_name - last_name - lead_source_id - middle_name - date_of_birth - email_1 - phone_1 - phone_1_type - phone_2 - phone_2_type - city - address_1 - state - zip - country - notes required: - meta - result _v1_leads_rentmanager_{lead_id}_put_input: type: object properties: first_name: type: string description: The first name associated with the lead middle_name: type: string description: The middle name associated with the lead last_name: type: string description: The last name associated with the lead lead_source_id: type: string description: The Propexo unique identifier for the lead source date_of_birth: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date of birth associated with the lead email_1: type: string description: The primary email address associated with the lead phone_1: type: string description: Primary phone number associated with the lead phone_1_type: type: string enum: &a166 - HOME - WORK - MOBILE - FAX - OTHER description: Type of the primary phone number phone_2: type: string description: Secondary phone number associated with the lead phone_2_type: type: string enum: &a167 - HOME - WORK - MOBILE - FAX - OTHER description: Type of the secondary phone number city: type: string description: The city associated with the lead address_1: type: string description: The first address line associated with the lead. If any one of the address fields are provided, they must all be provided state: type: string description: The state associated with the lead zip: type: string description: The zip code associated with the lead country: type: string description: The country associated with the lead notes: type: string description: Notes associated with the lead _v1_leads_rentmanager_{lead_id}_put_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: lead_id: type: string description: The Propexo unique identifier for the lead first_name: type: string description: The first name associated with the lead middle_name: type: string description: The middle name associated with the lead last_name: type: string description: The last name associated with the lead lead_source_id: type: string description: The Propexo unique identifier for the lead source date_of_birth: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date of birth associated with the lead email_1: type: string description: The primary email address associated with the lead phone_1: type: string description: Primary phone number associated with the lead phone_1_type: type: string enum: *a166 description: Type of the primary phone number phone_2: type: string description: Secondary phone number associated with the lead phone_2_type: type: string enum: *a167 description: Type of the secondary phone number city: type: string description: The city associated with the lead address_1: type: string description: The first address line associated with the lead. If any one of the address fields are provided, they must all be provided state: type: string description: The state associated with the lead zip: type: string description: The zip code associated with the lead country: type: string description: The country associated with the lead notes: type: string description: Notes associated with the lead required: - lead_id required: - meta - result _v1_applicants_rentmanager_{applicant_id}_notes_post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration notes: type: string description: Notes associated with the applicant attachment: type: object properties: file_data: type: string maxLength: 40443576 description: The contents of the file, as a base64 encoded string. The PMS has a max file size of 29 MB. file_name: type: string description: 'The name of the file including the extension. Ex: "resume.pdf"' mime_type: type: string description: 'The mime type of the file. Ex: "application/pdf"' required: - file_data - file_name - mime_type description: Attachment file for the note on the applicant required: - integration_id - notes _v1_applicants_rentmanager_{applicant_id}_notes_post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration applicant_id: type: string description: The Propexo unique identifier for the applicant notes: type: string description: Notes associated with the applicant attachment: type: - object - "null" properties: file_data: type: - string - "null" maxLength: 40443576 description: The contents of the file, as a base64 encoded string. The PMS has a max file size of 29 MB. file_name: type: string description: 'The name of the file including the extension. Ex: "resume.pdf"' mime_type: type: string description: 'The mime type of the file. Ex: "application/pdf"' required: - file_name - mime_type required: - integration_id - applicant_id - notes - attachment required: - meta - result _v1_leads_yardi_{lead_id}_file-upload_post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration attachment: type: object properties: file_type_id: type: string description: The Propexo unique identifier for the file type. The file type provided must be listed as being compatible with the Leads model. file_data: type: string maxLength: 66500000 file_extension: type: string enum: &a168 - pdf - doc - docx - xls - xlsx - jpg - jpeg - png description: The file extension for the attachment being uploaded description: type: string description: A description of the file being uploaded required: - file_type_id - file_data - file_extension - description description: The file to attach to the Lead required: - integration_id - attachment _v1_leads_yardi_{lead_id}_file-upload_post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration lead_id: type: string description: The Propexo unique identifier for the lead attachment: type: object properties: file_type_id: type: string description: The Propexo unique identifier for the file type. The file type provided must be listed as being compatible with the Leads model. file_data: type: - string - "null" maxLength: 66500000 file_extension: type: string enum: *a168 description: The file extension for the attachment being uploaded description: type: string description: A description of the file being uploaded required: - file_type_id - file_extension - description required: - integration_id - lead_id - attachment required: - meta - result _v1_leads_entrata_{lead_id}_file-upload_post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration attachments: type: array items: type: object properties: file_data: type: string maxLength: 69730304 description: The contents of the file, as a base64 encoded string. The PMS has a max file size of 50 MB. file_name: type: string description: 'The name of the file including the extension. Ex: "image.jpg"' mime_type: type: string description: 'The mime type of the file. Ex: "image/jpeg"' file_type_id: type: string description: The Propexo file type ID of the file type to upload is_private: type: boolean description: If the file should be marked as private. If true the file will not be shown in the resident portal. required: - file_data - file_name - mime_type - file_type_id description: Files to upload for the lead. All the files can have a maximum combined file size of 50 MB required: - integration_id - attachments _v1_leads_entrata_{lead_id}_file-upload_post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration lead_id: type: string description: The Propexo unique identifier for the lead attachments: type: array items: type: object properties: file_data: type: - string - "null" maxLength: 69730304 description: The contents of the file, as a base64 encoded string. The PMS has a max file size of 50 MB. file_name: type: string description: 'The name of the file including the extension. Ex: "image.jpg"' mime_type: type: string description: 'The mime type of the file. Ex: "image/jpeg"' file_type_id: type: string description: The Propexo file type ID of the file type to upload is_private: type: boolean required: - file_name - mime_type - file_type_id required: - integration_id - lead_id - attachments required: - meta - result _v1_leads_rentmanager_{lead_id}_notes_post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration notes: type: string description: Notes associated with the lead attachment: type: object properties: file_data: type: string maxLength: 40443576 description: The contents of the file, as a base64 encoded string. The PMS has a max file size of 29 MB. file_name: type: string description: 'The name of the file including the extension. Ex: "resume.pdf"' mime_type: type: string description: 'The mime type of the file. Ex: "application/pdf"' required: - file_data - file_name - mime_type description: Attachment file for the note on the lead required: - integration_id - notes _v1_leads_rentmanager_{lead_id}_notes_post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration lead_id: type: string description: The Propexo unique identifier for the lead notes: type: string description: Notes associated with the lead attachment: type: - object - "null" properties: file_data: type: - string - "null" maxLength: 40443576 description: The contents of the file, as a base64 encoded string. The PMS has a max file size of 29 MB. file_name: type: string description: 'The name of the file including the extension. Ex: "resume.pdf"' mime_type: type: string description: 'The mime type of the file. Ex: "application/pdf"' required: - file_name - mime_type required: - integration_id - lead_id - notes - attachment required: - meta - result _v1_leases__get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query x_id: type: string description: The external lease id x_property_id: type: string description: "Deprecated: Use the Propexo property_id instead" deprecated: true x_unit_id: type: string description: "Deprecated: Use the Propexo unit_id instead" deprecated: true location_id: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. unit_id: type: string description: The Propexo unique identifier for the unit resident_id: type: string description: The Propexo unique identifier for the resident. If you use this filter in conjunction with one of the move-in/move-out date filters, it will not be honored and will be overridden by the date filter. property_id: type: string description: The Propexo unique identifier for the property integration_id: type: string description: The Propexo unique identifier for the integration before_move_in_date: type: - string - "null" description: "Filter to residents moving in before this date. Format: YYYY-MM-DD. Date filter combinations will act with AND logic on a single record." after_move_in_date: type: - string - "null" description: "Filter to residents moving in after this date. Format: YYYY-MM-DD. Date filter combinations will act with AND logic on a single record." before_move_out_date: type: - string - "null" description: "Filter to residents moving out before this date. Format: YYYY-MM-DD. Date filter combinations will act with AND logic on a single record." after_move_out_date: type: - string - "null" description: "Filter to residents moving out after this date. Format: YYYY-MM-DD. Date filter combinations will act with AND logic on a single record." only_null_move_outs: anyOf: - type: boolean - type: string description: Filter to only return leases where the move-out date is null integration_vendor: $ref: "#/components/schemas/Enum1" status_normalized: type: string enum: - ACTIVE - INACTIVE - OTHER - PENDING - EVICTED description: The normalized status for the lease status_raw: type: string description: The raw status associated with the lease unit_number: type: string description: The unit number of the lease. When using this, the Propexo `property_id` filter must be added as well. Lease: type: object properties: id: type: string description: The Propexo unique identifier for the lease created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_resident_id: type: - string - "null" description: Deprecated. Use residents_meta_data instead deprecated: true x-fern-availability: deprecated x_unit_id: type: - string - "null" description: The external ID of the unit from the integration vendor residents_meta_data: type: array items: type: object properties: resident_id: type: string description: The Propexo unique identifier for the resident x_resident_type: type: - string - "null" description: The external type of the resident from the integration vendor resident_type_normalized: anyOf: - type: string - type: string enum: - PRIMARY - SECONDARY - GUARANTOR - OTHER - type: "null" description: Resident type from Propexo move_in_date: type: - string - "null" description: The move-in date associated with the resident example: 2024-01-01 move_out_date: type: - string - "null" description: The move-out date associated with the resident notice_date: type: - string - "null" description: The date the resident gave notice custom_data: type: - object - "null" properties: {} last_seen: type: - string - "null" description: The date the record was last seen from the PMS required: - resident_id - x_resident_type - resident_type_normalized - move_in_date - move_out_date - notice_date - custom_data - last_seen x-propexo: derivedFromModel: residents_to_leases application_date: type: - string - "null" description: The application date associated with the lease custom_data: type: - object - "null" properties: {} deposit_amount: type: - string - "null" description: The deposit amount associated with the lease deposit_amount_in_cents: type: &a316 - number - "null" description: The deposit amount in cents associated with the lease example: 100000 deposit_date: type: - string - "null" description: The deposit date associated with the lease end_date: type: - string - "null" description: The end date associated with the lease realized_move_in_date: type: - string - "null" description: "The realized move-in date associated with the lease. Note: This move in date is at the lease level and could be different per resident. Please use residents_meta_data to view resident move in dates" realized_move_out_date: type: - string - "null" description: "The realized move-out date associated with the lease. Note: This move out date is at the lease level and could be different per resident. Please use residents_meta_data to view resident move out dates" rent_amount_in_cents: type: &a317 - number - "null" description: The rent amount in cents for the lease example: 100000 rent_amount_market_in_cents: type: &a318 - number - "null" description: The market rent amount in cents for the lease example: 100000 rent_due_day: type: - integer - "null" minimum: 0 description: The rent due day associated with the lease rent_due_date: type: - string - "null" description: The rent due date associated with the lease scheduled_move_in_date: type: - string - "null" description: "The scheduled move-in date associated with the lease. Note: This move in date is at the lease level and could be different per resident. Please use residents_meta_data to view resident move in dates" scheduled_move_out_date: type: - string - "null" description: "The scheduled move-out date associated with the lease. Note: This move out date is at the lease level and could be different per resident. Please use residents_meta_data to view resident move out dates" signature_date: type: - string - "null" description: The date the lease was signed start_date: type: - string - "null" description: The start date associated with the lease status: type: - string - "null" description: DEPRECATED. Use status_normalized deprecated: true x-fern-availability: deprecated status_normalized: type: - string - "null" enum: - ACTIVE - INACTIVE - OTHER - PENDING - EVICTED description: The normalized status for the lease. Note that the status may be called "EVICTED" but this can also refer to an active resident undergoing a current eviction. This varies per PMS. status_raw: type: - string - "null" description: The raw status associated with the lease term: type: - string - "null" description: The lease term type: type: - string - "null" description: The type of lease unit_number: type: - string - "null" description: The unit number associated with the lease. This isn't always provided by PMS vendors, but may be the only data provided to identify a unit associated with a service request in some cases. write_off_amount_in_cents: type: &a319 - number - "null" description: The write off amount for the lease, in cents example: 100000 write_off_amount_raw: type: - string - "null" description: The raw write off amount of the lease from the PMS balance_amount_in_cents: type: &a320 - number - "null" description: The balance amount for the lease, in cents example: 100000 balance_amount_raw: type: - string - "null" description: The raw balance amount of the lease from the PMS past_due_balance_in_cents: type: &a321 - number - "null" description: The past due balance for the lease, in cents example: 100000 past_due_balance_raw: type: - string - "null" description: The raw past due balance of the lease from the PMS unit_id: type: - string - "null" description: The Propexo unique identifier for the unit property_id: type: string description: The Propexo unique identifier for the property integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" services: type: array items: type: object properties: id: type: string description: The Propexo unique identifier for the lease service created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: string description: The date the record was last seen from the PMS name: type: string description: The name of the lease service lease_id: type: string description: The Propexo unique identifier for the lease required: - id - created_at - updated_at - last_seen - name - lease_id x-propexo: &a322 derivedFromModel: lease_services required: - id - created_at - updated_at - last_seen - x_id - x_property_id - x_resident_id - x_unit_id - application_date - custom_data - deposit_amount - deposit_amount_in_cents - deposit_date - end_date - realized_move_in_date - realized_move_out_date - rent_amount_in_cents - rent_amount_market_in_cents - rent_due_day - rent_due_date - scheduled_move_in_date - scheduled_move_out_date - signature_date - start_date - status - status_normalized - status_raw - term - type - unit_number - write_off_amount_in_cents - write_off_amount_raw - balance_amount_in_cents - balance_amount_raw - past_due_balance_in_cents - past_due_balance_raw - unit_id - property_id - integration_id - integration_vendor - services _v1_leases__get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: type: array items: $ref: "#/components/schemas/Lease" required: - meta - results _v1_leases__post_input: type: object properties: integration_id: type: string type: type: string enum: &a170 - Fixed - FixedWithRollover - AtWill description: The type associated with the lease unit_id: type: string description: The Propexo unique identifier for the unit start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The start date associated with the lease first_name: type: string description: The first name associated with the applicant. Required if lead_id is not specified last_name: type: string description: The last name associated with the applicant. Required if lead_id is not specified address_1: type: string description: The first address line associated with the resident city: type: string description: The city associated with the resident state: type: string description: The state associated with the resident zip: type: string description: The zip code associated with the resident country: type: string enum: &a169 - US description: The country associated with the resident financial_account_id: type: string description: The Propexo unique identifier for the financial account end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The end date associated with the lease send_welcome_email: type: boolean default: false description: Whether to send a welcome email to the tenant email_1: type: string format: email description: The primary email address associated with the applicant email_2: type: string format: email description: The secondary email address associated with the resident phone_1: type: string pattern: ^\d{10}$ description: Primary phone number associated with the applicant phone_1_type: type: string enum: *a16 description: Type of the primary phone number phone_2: type: string pattern: ^\d{10}$ description: Secondary phone number associated with the applicant phone_2_type: type: string enum: *a16 description: Type of the secondary phone number date_of_birth: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date of birth associated with the applicant address_2: type: string description: The second address line associated with the resident address_1_alternate: type: string maxLength: 100 description: The first alternate address line associated with the resident address_2_alternate: type: string maxLength: 100 description: The second alternate address line associated with the resident city_alternate: type: string maxLength: 100 description: The alternate city associated with the resident state_alternate: type: string description: The alternate state associated with the resident zip_alternate: type: string description: The alternate zip code associated with the resident country_alternate: type: string enum: *a169 description: The alternate country associated with the resident rent_cycle: type: string enum: &a171 - Monthly - Weekly - Every2Weeks - Quarterly - Yearly - Every2Months - Daily - Every6Months - OneTime description: The duration in which rent charges will be automatically appended to the lease ledger rent_amount_in_cents: type: integer exclusiveMinimum: 0 description: The rent amount in cents for the lease rent_due_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The rent due date associated with the lease. The timestamp will be stripped off and only the date will be used property_id: type: string description: The Propexo unique identifier for the property lease_period_id: type: string description: The Propexo unique identifier for the lease period floor_plan_id: type: string description: The Propexo unique identifier for the floor plan scheduled_move_in_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The move-in date associated with the lease primary_contact_id: type: string description: The Propexo unique identifier of the primary contact. This must either be a lead, applicant, or resident in Propexo tenants: type: array items: type: object properties: id: type: string description: The Propexo unique identifier for the lead, applicant, or resident required: - id description: An array of Propexo lead, applicant, or resident IDs. This must also include the primary contact ID scheduled_move_out_date: type: string format: date-time description: The scheduled move-out date associated with the lease status: type: string enum: - PENDING - ACTIVE description: The status associated with the lease resident_id: type: string description: The Propexo unique identifier for the resident realized_move_in_date: type: string format: date-time description: The move-in date associated with the lease realized_move_out_date: type: string format: date-time description: The move-out date associated with the lease employee_id: type: string description: The Propexo unique identifier for the employee. Employee must have a role of LEASING_AGENT. Required if lead_id is not specified nsf_fee_amount_in_cents: type: integer exclusiveMinimum: 0 description: The NSF fee amount in cents for the lease associated_resident_ids: type: array items: type: string minItems: 1 description: A list of Propexo Resident IDs associated with the lease. The resident must be a primary. resident_charges: type: array items: type: object properties: financial_account_id: type: string description: The Propexo unique identifier for the financial account post_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The post date for the resident charge description: type: string description: Description of the resident charge amount_in_cents: type: integer exclusiveMinimum: 0 description: The amount of the resident charge, in cents is_prorated: type: boolean description: Whether or not the resident charge is prorated required: - financial_account_id - post_date - description - amount_in_cents - is_prorated default: &a175 [] description: A list of move in charges for the lease recurring_resident_charges: type: array items: type: object properties: financial_account_id: type: string description: The Propexo unique identifier for the financial account start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The start date associated with the recurring resident charge end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The end date associated with the recurring resident charge description: type: string description: Description of the resident charge amount_in_cents: type: integer exclusiveMinimum: 0 description: The amount of the recurring resident charge, in cents charge_due_day: type: integer exclusiveMinimum: 0 minimum: 1 maximum: 31 description: The day of the month the charge is due frequency_raw: type: integer exclusiveMinimum: 0 minimum: 1 maximum: 12 description: The raw value of the frequency of the recurring resident charge. This will be the frequency (in months) for Rentvine required: - financial_account_id - start_date - description - amount_in_cents - charge_due_day - frequency_raw default: &a176 [] description: A list of recurring charges for the lease other_occupants: type: array items: type: object properties: relationship: type: string enum: *a55 description: The relationship of the occupant to the applicant first_name: type: string description: The first name associated with the occupant last_name: type: string description: The last name associated with the occupant third_party_id: type: string minLength: 1 description: A unique ID you would like to associate with the occupant. This is not the Yardi occupant ID organization_name: type: string description: The name of your organization. Yardi uses this for associating an occupant email_1: type: string format: email description: The primary email address associated with the occupant phone_1: type: string pattern: ^\d{10}$ description: Primary phone number associated with the occupant phone_1_type: type: string enum: *a16 description: Type of the primary phone number phone_2: type: string pattern: ^\d{10}$ description: Secondary phone number associated with the occupant phone_2_type: type: string enum: *a16 description: Type of the secondary phone number address_1: type: string description: The first address line associated with the occupant city: type: string description: The city associated with the occupant state: type: string enum: *a33 description: The state associated with the occupant zip: type: string description: The zip code associated with the occupant required: - relationship - first_name - last_name - third_party_id - organization_name default: &a195 [] description: A list of other occupants for the application lead_id: type: string description: The Propexo unique identifier for the lead. The lead will be converted to an applicant lead_source_id: type: string description: The Propexo unique identifier for the lead source. Required if lead_id is not specified third_party_id: type: string minLength: 1 description: A unique ID you would like to associate with the applicant. This is not the Yardi applicant ID. Required if lead_id is not specified organization_name: type: string description: The name of your organization. Yardi uses this for associating an applicant. Required if lead_id is not specified middle_name: type: string description: The middle name associated with the applicant maiden_name: type: string description: The maiden name associated with the applicant move_in_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The desired move-in date to the unit listed in the application move_out_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The desired move-out date to the unit listed in the application desired_lease_term_in_months: type: string description: The desired lease term in months of the applicant notes: type: string description: Notes associated with the applicant is_evicted: type: boolean description: Whether the applicant has been evicted is_felony: type: boolean description: Whether the applicant has a felony is_criminal_charge: type: boolean description: Whether the applicant has a criminal charge eviction_description: type: string description: The description of the eviction felony_description: type: string description: The description of the felony criminal_charge_description: type: string description: The description of the criminal charge marital_status: type: string enum: *a57 description: The marital status of the applicant identification_number: type: string description: The social security number of the applicant drivers_license_number: type: string description: The driver's license number of the applicant address_history: type: array items: type: object properties: address_1: type: string description: The first address line associated with the applicant's historical address city: type: string description: The city associated with the applicant's historical address state: type: string enum: *a33 description: The state associated with the applicant zip: type: string description: The zip code associated with the applicant's historical address country: anyOf: - type: string enum: *a54 - type: string description: The country associated with the applicant's historical address. If your application needs to support submitting an applicant who resides in another country, please reach out to Propexo Support for help notice_provided: type: boolean description: Whether notice has been given to the applicant's historical address property_name: type: string description: The property name of the applicant's historical address reason_for_leaving: type: string description: The reason the applicant left their historical address monthly_payment_in_cents: type: integer minimum: 0 description: For the applicant's historical address, the applicant's monthly payment for rent or mortgage in cents move_in_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date when the applicant moved into their historical address move_out_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date when the applicant moved out of their historical address. If this is the applicant's current address, omit this field manager_phone: type: string pattern: ^\d{10}$ description: The phone number of a property manager who works at this address manager_email: type: string format: email description: The email of a property manager who works at this address management_company: type: string description: The name of the company who owns the property at this address required: - address_1 - city - state - zip - notice_provided - move_in_date maxItems: 2 default: &a187 [] description: The address history of the applicant emergency_contacts: type: array items: type: object properties: first_name: type: string description: The first name of the emergency contact last_name: type: string description: The last name of the emergency contact relationship: type: string enum: *a56 description: The relationship of the emergency contact to the applicant address_1: type: string description: The first line of the address of the emergency contact city: type: string description: The city of the address of the emergency contact state: type: string enum: *a33 description: The state of the address of the emergency contact zip: type: string description: The zip code of the address of the emergency contact country: anyOf: - type: string enum: *a54 - type: string description: The country of the address of the emergency contact. If your application needs to support submitting an applicant who resides in another country, please reach out to Propexo Support for help phone_1: type: string pattern: ^\d{10}$ description: The phone number of the emergency contact required: - first_name - last_name - relationship maxItems: 1 default: &a188 [] description: A list of emergency contacts for the applicant employment_history: type: array items: type: object properties: is_current_employer: type: boolean description: Whether this employment history entry is for a current employer name: type: string description: The name of the employer start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The start date of the applicant's employment at this employer end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The end date of the applicant's employment at this employer. Ignore this field if is_current_employer is set to true address_1: type: string description: The first line of the address of the employer city: type: string description: The city of the address of the employer state: type: string enum: *a33 description: The state of the address of the employer zip: type: string description: The zip code of the address of the employer phone: type: string pattern: ^\d{10}$ description: The phone number of the employer supervisor_first_name: type: string description: The first name of the applicant's supervisor at this employer supervisor_last_name: type: string description: The last name of the applicant's supervisor at this employer position: type: string description: The position held at this employer, or the job description of the applicant monthly_income_in_cents: type: integer minimum: 0 description: The monthly income of the applicant at this employer in cents required: - is_current_employer - name - start_date - monthly_income_in_cents maxItems: 2 default: &a189 [] description: The employment history of the applicant other_income: type: array items: type: object properties: source: type: string description: The source of the income for the applicant monthly_income_in_cents: type: integer minimum: 0 description: The monthly income from this income source in cents required: - source - monthly_income_in_cents maxItems: 2 default: &a190 [] description: A list of other income sources for the applicant vehicles: type: array items: type: object properties: make: type: string description: The make of the vehicle model: type: string description: The model of the vehicle year: type: integer description: The year the vehicle was made color: type: string description: The color of the vehicle license_plate_number: type: string description: The license plate number of the vehicle license_plate_state: type: string description: The issuing state of the license plate required: - make maxItems: 4 default: &a191 [] description: A list of vehicles for the application pets: type: array items: type: object properties: type: type: string description: The type associated with the applicant pet name: type: string description: The name associated with the applicant pet age_in_years: type: integer minimum: 0 description: The age in years of the applicant pet weight_in_pounds: type: integer minimum: 0 description: The weight in pounds of the applicant pet breed: type: string description: The breed of the applicant pet color: type: string description: The color of the applicant pet gender: type: string description: The raw value for the gender of the applicant pet is_fixed: type: boolean description: Whether the applicant pet is fixed is_service_animal: type: boolean description: Whether the applicant pet is a service animal required: - type maxItems: 6 default: &a192 [] description: A list of applicant pets concession_fees: type: array items: type: object properties: start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The start date of the applicant's recurring concession fee end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The end date of the applicant's recurring concession fee concession_id: type: string description: The Propexo unique identifier for the concession. This concession must be associated with the unit that the applicant is applying for required: - start_date - end_date - concession_id default: &a193 [] description: A list of concession fees for the application application_fees: type: array items: type: object properties: charge_code_id: type: string description: The Propexo unique identifier for the charge code. This must be an application fee charge code amount_in_cents: type: integer minimum: 0 description: The application fee amount in cents description: type: string description: Description of the application fee required: - charge_code_id - amount_in_cents default: &a194 [] description: A list of application fees for the application required: - integration_id _v1_leases__post_output: type: object properties: job_id: type: string description: The ID of the job created to handle this operation data: type: object properties: {} required: - job_id - data _v1_leases_{lease_id}_get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query _v1_leases_{lease_id}_get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: $ref: "#/components/schemas/Lease" required: - meta - results _v1_leases_{lease_id}_put_input: type: object properties: unit_id: type: string description: The Propexo unique identifier for the unit type: type: string enum: &a174 - Fixed - FixedWithRollover - AtWill description: The type associated with the lease start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The start date associated with the applicant end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The end date associated with the applicant is_eviction_pending: type: boolean default: false description: Whether the lease has an eviction pending automatically_move_out_residents: type: boolean default: false description: Whether residents should be set to "past" status automatically at the expiration of the lease property_id: type: string description: The Propexo unique identifier for the property resident_id: type: string description: The Propexo unique identifier for the resident scheduled_move_in_date: type: string format: date-time description: The move-in date associated with the lease first_name: type: string description: The first name associated with the applicant last_name: type: string description: The last name associated with the applicant address_1: type: string description: The first address line associated with the applicant address_2: type: string description: The second address line associated with the resident city: type: string description: The city associated with the applicant state: type: string description: The state associated with the applicant zip: type: string description: The zip code associated with the applicant email_1: type: string format: email description: The primary email address associated with the applicant phone_1: type: string pattern: ^\d{10}$ description: Primary phone number associated with the applicant date_of_birth: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date of birth associated with the applicant primary_contact_id: type: string description: The Propexo unique identifier of the primary contact. This must either be a lead, applicant, or resident in Propexo tenants: type: array items: type: object properties: id: type: string description: The Propexo unique identifier for the lead, applicant, or resident required: - id description: An array of Propexo lead, applicant, or resident IDs. This must also include the primary contact ID scheduled_move_out_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The scheduled move-out date associated with the lease status: type: string enum: &a199 - PENDING - APPROVED - CANCELED - DENIED - SIGNED description: The status associated with the applicant tenant_ids: type: array items: type: string description: An array of Propexo lead, applicant, or resident IDs. This must also include the primary contact ID move_in_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The desired move-in date to the unit listed in the application move_out_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The desired move-out date to the unit listed in the application rent_amount_in_cents: type: integer minimum: 0 description: The rent amount in cents for the lease notes: type: string description: Notes associated with the applicant signature_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The signature date of the lease deposit_amount_in_cents: type: integer minimum: 0 description: The deposit amount in cents associated with the lease deposit_charge_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The deposit date associated with the lease realized_move_in_date: type: string format: date-time description: The move-in date associated with the lease realized_move_out_date: type: string format: date-time description: The move-out date associated with the lease applicant_id: type: string description: The Propexo unique identifier for the applicant application_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The application date associated with the applicant phone_1_type: type: string enum: *a16 description: Type of the primary phone number phone_2: type: string pattern: ^\d{10}$ description: Secondary phone number associated with the applicant phone_2_type: type: string enum: *a16 description: Type of the secondary phone number rent_amount_market_in_cents: type: integer description: The market rent amount in cents for the lease middle_name: type: string description: The middle name associated with the applicant maiden_name: type: string description: The maiden name associated with the applicant desired_lease_term_in_months: type: string description: The desired lease term in months of the applicant is_evicted: type: boolean description: Whether the applicant has been evicted is_felony: type: boolean description: Whether the applicant has a felony is_criminal_charge: type: boolean description: Whether the applicant has a criminal charge eviction_description: type: string description: The description of the eviction felony_description: type: string description: The description of the felony criminal_charge_description: type: string description: The description of the criminal charge marital_status: type: string enum: *a57 description: The marital status of the applicant identification_number: type: string description: The social security number of the applicant drivers_license_number: type: string description: The driver's license number of the applicant address_history: type: array items: type: object properties: address_1: type: string description: The first address line associated with the applicant's historical address city: type: string description: The city associated with the applicant's historical address state: type: string enum: *a33 description: The state associated with the applicant zip: type: string description: The zip code associated with the applicant's historical address country: type: string enum: *a54 description: The country associated with the applicant's historical address. If your application needs to support submitting an applicant who resides in another country, please reach out to Propexo Support for help notice_provided: type: boolean description: Whether notice has been given to the applicant's historical address property_name: type: string description: The property name of the applicant's historical address reason_for_leaving: type: string description: The reason the applicant left their historical address monthly_payment_in_cents: type: integer minimum: 0 description: For the applicant's historical address, the applicant's monthly payment for rent or mortgage in cents move_in_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date when the applicant moved into their historical address move_out_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date when the applicant moved out of their historical address. If this is the applicant's current address, omit this field manager_phone: type: string pattern: ^\d{10}$ description: The phone number of a property manager who works at this address manager_email: type: string format: email description: The email of a property manager who works at this address management_company: type: string description: The name of the company who owns the property at this address required: - address_1 - city - state - zip - notice_provided - move_in_date maxItems: 2 default: &a178 [] description: The address history of the applicant emergency_contacts: type: array items: type: object properties: first_name: type: string description: The first name of the emergency contact last_name: type: string description: The last name of the emergency contact relationship: type: string enum: *a56 description: The relationship of the emergency contact to the applicant address_1: type: string description: The first line of the address of the emergency contact city: type: string description: The city of the address of the emergency contact state: type: string enum: *a33 description: The state of the address of the emergency contact zip: type: string description: The zip code of the address of the emergency contact country: type: string enum: *a54 description: The country of the address of the emergency contact. If your application needs to support submitting an applicant who resides in another country, please reach out to Propexo Support for help phone_1: type: string pattern: ^\d{10}$ description: The phone number of the emergency contact required: - first_name - last_name - relationship maxItems: 1 default: &a179 [] description: A list of emergency contacts for the applicant employment_history: type: array items: type: object properties: is_current_employer: type: boolean description: Whether this employment history entry is for a current employer name: type: string description: The name of the employer start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The start date of the applicant's employment at this employer end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The end date of the applicant's employment at this employer. Ignore this field if is_current_employer is set to true address_1: type: string description: The first line of the address of the employer city: type: string description: The city of the address of the employer state: type: string enum: *a33 description: The state of the address of the employer zip: type: string description: The zip code of the address of the employer phone: type: string pattern: ^\d{10}$ description: The phone number of the employer supervisor_first_name: type: string description: The first name of the applicant's supervisor at this employer supervisor_last_name: type: string description: The last name of the applicant's supervisor at this employer position: type: string description: The position held at this employer, or the job description of the applicant monthly_income_in_cents: type: integer minimum: 0 description: The monthly income of the applicant at this employer in cents required: - is_current_employer - name - start_date - monthly_income_in_cents maxItems: 2 default: &a180 [] description: The employment history of the applicant other_income: type: array items: type: object properties: source: type: string description: The source of the income for the applicant monthly_income_in_cents: type: integer minimum: 0 description: The monthly income from this income source in cents required: - source - monthly_income_in_cents maxItems: 2 default: &a181 [] description: A list of other income sources for the applicant vehicles: type: array items: type: object properties: make: type: string description: The make of the vehicle model: type: string description: The model of the vehicle year: type: integer description: The year the vehicle was made color: type: string description: The color of the vehicle license_plate_number: type: string description: The license plate number of the vehicle license_plate_state: type: string description: The issuing state of the license plate required: - make maxItems: 4 default: &a182 [] description: A list of vehicles for the application pets: type: array items: type: object properties: type: type: string description: The type associated with the applicant pet name: type: string description: The name associated with the applicant pet age_in_years: type: integer minimum: 0 description: The age in years of the applicant pet weight_in_pounds: type: integer minimum: 0 description: The weight in pounds of the applicant pet breed: type: string description: The breed of the applicant pet color: type: string description: The color of the applicant pet gender: type: string description: The raw value for the gender of the applicant pet is_fixed: type: boolean description: Whether the applicant pet is fixed is_service_animal: type: boolean description: Whether the applicant pet is a service animal required: - type maxItems: 6 default: &a183 [] description: A list of applicant pets concession_fees: type: array items: type: object properties: start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The start date of the applicant's recurring concession fee end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The end date of the applicant's recurring concession fee concession_id: type: string description: The Propexo unique identifier for the concession. This concession must be associated with the unit that the applicant is applying for required: - start_date - end_date - concession_id default: &a184 [] description: A list of concession fees for the application application_fees: type: array items: type: object properties: charge_code_id: type: string description: The Propexo unique identifier for the charge code. This must be an application fee charge code amount_in_cents: type: integer minimum: 0 description: The application fee amount in cents description: type: string description: Description of the application fee required: - charge_code_id - amount_in_cents default: &a185 [] description: A list of application fees for the application other_occupants: type: array items: type: object properties: relationship: type: string enum: *a55 description: The relationship of the occupant to the applicant first_name: type: string description: The first name associated with the occupant last_name: type: string description: The last name associated with the occupant third_party_id: type: string minLength: 1 description: A unique ID you would like to associate with the occupant. This is not the Yardi occupant ID organization_name: type: string description: The name of your organization. Yardi uses this for associating an occupant email_1: type: string format: email description: The primary email address associated with the occupant phone_1: type: string pattern: ^\d{10}$ description: Primary phone number associated with the occupant phone_1_type: type: string enum: *a16 description: Type of the primary phone number phone_2: type: string pattern: ^\d{10}$ description: Secondary phone number associated with the occupant phone_2_type: type: string enum: *a16 description: Type of the secondary phone number address_1: type: string description: The first address line associated with the occupant city: type: string description: The city associated with the occupant state: type: string enum: *a33 description: The state associated with the occupant zip: type: string description: The zip code associated with the occupant required: - relationship - first_name - last_name - third_party_id - organization_name default: &a186 [] description: A list of other occupants for the application _v1_leases_{lease_id}_put_output: type: object properties: job_id: type: string description: The ID of the job created to handle this operation data: type: object properties: {} required: - job_id - data _v1_lease-transfers__get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor location_id: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. property_id: type: string description: The Propexo unique identifier for the property resident_id: type: string description: The Propexo unique identifier for the resident lease_id_next: type: string description: The Propexo unique identifier for the next lease lease_id_previous: type: string description: The Propexo unique identifier for the previous lease unit_id_next: type: string description: The Propexo unique identifier for the next unit unit_id_previous: type: string description: The Propexo unique identifier for the previous unit integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" LeaseTransfer: type: object properties: id: type: string description: The Propexo unique identifier for the lease transfer created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_resident_id: type: string description: The external ID of the resident from the integration vendor x_lease_id_next: type: string description: The external ID of the next lease from the integration vendor x_lease_property_id_next: type: - string - "null" description: The external ID of the property associated with the next lease from the integration vendor x_lease_id_previous: type: string description: The external ID of the previous lease from the integration vendor x_lease_property_id_previous: type: - string - "null" description: The external ID of the property associated with the previous lease from the integration vendor x_unit_id_next: type: - string - "null" description: The external ID of the next unit from the integration vendor x_unit_id_previous: type: - string - "null" description: The external ID of the previous unit from the integration vendor resident_type: type: - string - "null" description: The normalized type of the resident resident_type_raw: type: - string - "null" description: The raw type of the resident lease_status_next: type: - string - "null" description: The normalized status of the next lease lease_status_next_raw: type: - string - "null" description: The raw status of the next lease lease_status_previous: type: - string - "null" description: The normalized status of the previous lease lease_status_previous_raw: type: - string - "null" description: The raw status of the previous lease transfer_effective_date: type: - string - "null" description: The effective date of the lease transfer integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" property_id: type: string description: The Propexo unique identifier for the property resident_id: type: string description: The Propexo unique identifier for the resident lease_id_next: type: string description: The Propexo unique identifier for the next lease lease_id_previous: type: string description: The Propexo unique identifier for the previous lease unit_id_next: type: - string - "null" description: The Propexo unique identifier for the next unit unit_id_previous: type: - string - "null" description: The Propexo unique identifier for the previous unit required: - id - created_at - updated_at - last_seen - x_id - x_property_id - x_location_id - x_resident_id - x_lease_id_next - x_lease_property_id_next - x_lease_id_previous - x_lease_property_id_previous - x_unit_id_next - x_unit_id_previous - resident_type - resident_type_raw - lease_status_next - lease_status_next_raw - lease_status_previous - lease_status_previous_raw - transfer_effective_date - integration_id - integration_vendor - property_id - resident_id - lease_id_next - lease_id_previous - unit_id_next - unit_id_previous x-propexo: derivedFromModel: lease_transfers _v1_lease-transfers__get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: type: array items: $ref: "#/components/schemas/LeaseTransfer" required: - meta - results _v1_lease-transfers_{lease_transfer_id}_get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query _v1_lease-transfers_{lease_transfer_id}_get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: $ref: "#/components/schemas/LeaseTransfer" required: - meta - results _v1_lease-periods__get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor location_id: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. property_id: type: string description: The Propexo unique identifier for the property integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" application_template_id: type: string description: The Propexo unique identifier for the application template LeasePeriod: type: object properties: id: type: string description: The Propexo unique identifier for the lease period created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_application_template_id: type: - string - "null" description: The external ID of the application template from the integration vendor name: type: string description: The name associated with the lease period application_template_id: type: - string - "null" description: The Propexo unique identifier for the application template integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" property_id: type: string description: The Propexo unique identifier for the property required: - id - created_at - updated_at - last_seen - x_id - x_property_id - x_location_id - x_application_template_id - name - application_template_id - integration_id - integration_vendor - property_id x-propexo: derivedFromModel: entrata_lease_periods _v1_lease-periods__get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: type: array items: $ref: "#/components/schemas/LeasePeriod" required: - meta - results _v1_lease-periods_{lease_period_id}_get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query _v1_lease-periods_{lease_period_id}_get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: $ref: "#/components/schemas/LeasePeriod" required: - meta - results _v1_leases_buildium__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration type: type: string enum: *a170 description: The type associated with the lease unit_id: type: string description: The Propexo unique identifier for the unit start_date: type: string format: date-time description: The start date associated with the lease first_name: type: string description: The first name associated with the resident last_name: type: string description: The last name associated with the resident address_1: type: string maxLength: 100 description: The first address line associated with the resident city: type: string maxLength: 100 description: The city associated with the resident state: type: string description: The state associated with the resident zip: type: string description: The zip code associated with the resident country: type: string enum: *a169 description: The country associated with the resident financial_account_id: type: string description: The Propexo unique identifier for the financial account end_date: type: string format: date-time description: The end date associated with the lease send_welcome_email: type: boolean default: false description: Whether to send a welcome email to the tenant email_1: type: string format: email description: The primary email address associated with the resident email_2: type: string format: email description: The secondary email address associated with the resident phone_1: type: string description: Primary phone number associated with the resident phone_1_type: type: string enum: &a172 - HOME - WORK - MOBILE - FAX description: Type of the primary phone number phone_2: type: string description: Secondary phone number associated with the resident phone_2_type: type: string enum: &a173 - HOME - WORK - MOBILE - FAX description: Type of the secondary phone number date_of_birth: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date of birth associated with the resident address_2: type: string maxLength: 100 description: The second address line associated with the resident address_1_alternate: type: string maxLength: 100 description: The first alternate address line associated with the resident address_2_alternate: type: string maxLength: 100 description: The second alternate address line associated with the resident city_alternate: type: string maxLength: 100 description: The alternate city associated with the resident state_alternate: type: string description: The alternate state associated with the resident zip_alternate: type: string description: The alternate zip code associated with the resident country_alternate: type: string enum: *a169 description: The alternate country associated with the resident rent_cycle: type: string enum: *a171 description: The duration in which rent charges will be automatically appended to the lease ledger rent_amount_in_cents: type: integer description: The rent amount in cents for the lease rent_due_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The rent due date associated with the lease. The timestamp will be stripped off and only the date will be used required: - integration_id - type - unit_id - start_date - first_name - last_name - address_1 - city - state - zip - country _v1_leases_buildium__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration type: type: string enum: *a170 description: The type associated with the lease unit_id: type: string description: The Propexo unique identifier for the unit start_date: type: string format: date-time description: The start date associated with the lease first_name: type: string description: The first name associated with the resident last_name: type: string description: The last name associated with the resident address_1: type: string maxLength: 100 description: The first address line associated with the resident city: type: string maxLength: 100 description: The city associated with the resident state: type: string description: The state associated with the resident zip: type: string description: The zip code associated with the resident country: type: string enum: *a169 description: The country associated with the resident financial_account_id: type: - string - "null" description: The Propexo unique identifier for the financial account end_date: type: - string - "null" format: date-time description: The end date associated with the lease send_welcome_email: type: - boolean - "null" default: false email_1: type: - string - "null" format: email description: The primary email address associated with the resident email_2: type: - string - "null" format: email description: The secondary email address associated with the resident phone_1: type: - string - "null" description: Primary phone number associated with the resident phone_1_type: type: - string - "null" enum: *a172 description: Type of the primary phone number phone_2: type: - string - "null" description: Secondary phone number associated with the resident phone_2_type: type: - string - "null" enum: *a173 description: Type of the secondary phone number date_of_birth: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" description: The date of birth associated with the resident address_2: type: - string - "null" maxLength: 100 description: The second address line associated with the resident address_1_alternate: type: - string - "null" maxLength: 100 description: The first alternate address line associated with the resident address_2_alternate: type: - string - "null" maxLength: 100 description: The second alternate address line associated with the resident city_alternate: type: - string - "null" maxLength: 100 description: The alternate city associated with the resident state_alternate: type: - string - "null" description: The alternate state associated with the resident zip_alternate: type: - string - "null" description: The alternate zip code associated with the resident country_alternate: type: - string - "null" enum: *a169 description: The alternate country associated with the resident rent_cycle: type: - string - "null" enum: *a171 description: The duration in which rent charges will be automatically appended to the lease ledger rent_amount_in_cents: type: - integer - "null" description: The rent amount in cents for the lease rent_due_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" description: The rent due date associated with the lease. The timestamp will be stripped off and only the date will be used required: - integration_id - type - unit_id - start_date - first_name - last_name - address_1 - city - state - zip - country - financial_account_id - end_date - email_1 - email_2 - phone_1 - phone_1_type - phone_2 - phone_2_type - date_of_birth - address_2 - address_1_alternate - address_2_alternate - city_alternate - state_alternate - zip_alternate - country_alternate - rent_cycle - rent_amount_in_cents - rent_due_date required: - meta - result _v1_leases_buildium_{lease_id}_put_input: type: object properties: unit_id: type: string description: The Propexo unique identifier for the unit type: type: string enum: *a174 description: The type associated with the lease start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The start date associated with the lease end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The end date associated with the lease is_eviction_pending: type: boolean default: false description: Whether the lease has an eviction pending automatically_move_out_residents: type: boolean default: false description: Whether residents should be set to "past" status automatically at the expiration of the lease required: - unit_id - type - start_date _v1_leases_buildium_{lease_id}_put_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: lease_id: type: string description: The Propexo unique identifier for the lease unit_id: type: string description: The Propexo unique identifier for the unit type: type: string enum: *a174 description: The type associated with the lease start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The start date associated with the lease end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The end date associated with the lease is_eviction_pending: type: boolean default: false automatically_move_out_residents: type: boolean default: false required: - lease_id - unit_id - type - start_date required: - meta - result _v1_leases_entrata__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration property_id: type: string description: The Propexo unique identifier for the property unit_id: type: string description: The Propexo unique identifier for the unit lease_period_id: type: string description: The Propexo unique identifier for the lease period floor_plan_id: type: string description: The Propexo unique identifier for the floor plan start_date: type: string format: date-time description: The start date associated with the lease end_date: type: string format: date-time description: The end date associated with the lease scheduled_move_in_date: type: string format: date-time description: The move-in date associated with the lease first_name: type: string description: The first name associated with the resident last_name: type: string description: The last name associated with the resident address_1: type: string description: The first address line associated with the resident city: type: string description: The city associated with the resident state: type: string description: The state associated with the resident zip: type: string description: The zip code associated with the resident address_2: type: string description: The second address line associated with the resident email_1: type: string format: email description: The primary email address associated with the resident phone_1: type: string description: Primary phone number associated with the resident date_of_birth: type: string format: date-time description: The date of birth associated with the resident required: - integration_id - property_id - unit_id - lease_period_id - floor_plan_id - start_date - end_date - scheduled_move_in_date - first_name - last_name - address_1 - city - state - zip _v1_leases_entrata__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration property_id: type: string description: The Propexo unique identifier for the property unit_id: type: string description: The Propexo unique identifier for the unit lease_period_id: type: string description: The Propexo unique identifier for the lease period floor_plan_id: type: string description: The Propexo unique identifier for the floor plan start_date: type: string format: date-time description: The start date associated with the lease end_date: type: string format: date-time description: The end date associated with the lease scheduled_move_in_date: type: string format: date-time description: The move-in date associated with the lease first_name: type: string description: The first name associated with the resident last_name: type: string description: The last name associated with the resident address_1: type: string description: The first address line associated with the resident city: type: string description: The city associated with the resident state: type: string description: The state associated with the resident zip: type: string description: The zip code associated with the resident address_2: type: - string - "null" description: The second address line associated with the resident email_1: type: - string - "null" format: email description: The primary email address associated with the resident phone_1: type: - string - "null" description: Primary phone number associated with the resident date_of_birth: type: - string - "null" format: date-time description: The date of birth associated with the resident required: - integration_id - property_id - unit_id - lease_period_id - floor_plan_id - start_date - end_date - scheduled_move_in_date - first_name - last_name - address_1 - city - state - zip - address_2 - email_1 - phone_1 - date_of_birth required: - meta - result _v1_leases_entrata_{lease_id}_put_input: type: object properties: property_id: type: string description: The Propexo unique identifier for the property unit_id: type: string description: The Propexo unique identifier for the unit resident_id: type: string description: The Propexo unique identifier for the resident scheduled_move_in_date: type: string format: date-time description: The move-in date associated with the lease first_name: type: string description: The first name associated with the resident last_name: type: string description: The last name associated with the resident address_1: type: string description: The first address line associated with the resident address_2: type: string description: The second address line associated with the resident city: type: string description: The city associated with the resident state: type: string description: The state associated with the resident zip: type: string description: The zip code associated with the resident email_1: type: string format: email description: The primary email address associated with the resident phone_1: type: string description: Primary phone number associated with the resident date_of_birth: type: string format: date-time description: The date of birth associated with the resident _v1_leases_entrata_{lease_id}_put_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: lease_id: type: string description: The Propexo unique identifier for the lease property_id: type: string description: The Propexo unique identifier for the property unit_id: type: string description: The Propexo unique identifier for the unit resident_id: type: string description: The Propexo unique identifier for the resident scheduled_move_in_date: type: string format: date-time description: The move-in date associated with the lease first_name: type: string description: The first name associated with the resident last_name: type: string description: The last name associated with the resident address_1: type: string description: The first address line associated with the resident address_2: type: string description: The second address line associated with the resident city: type: string description: The city associated with the resident state: type: string description: The state associated with the resident zip: type: string description: The zip code associated with the resident email_1: type: string format: email description: The primary email address associated with the resident phone_1: type: string description: Primary phone number associated with the resident date_of_birth: type: string format: date-time description: The date of birth associated with the resident required: - lease_id required: - meta - result _v1_leases_realpage__post_input: type: object properties: {} _v1_leases_realpage__post_output: type: object properties: {} _v1_leases_realpage_{lease_id}_put_input: type: object properties: {} _v1_leases_realpage_{lease_id}_put_output: type: object properties: {} _v1_leases_realpage_rpx__post_input: type: object properties: {} _v1_leases_realpage_rpx__post_output: type: object properties: {} _v1_leases_realpage_rpx_{lease_id}_put_input: type: object properties: {} _v1_leases_realpage_rpx_{lease_id}_put_output: type: object properties: {} _v1_leases_rentmanager__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration resident_id: type: string description: The Propexo unique identifier for the resident unit_id: type: string description: The Propexo unique identifier for the unit property_id: type: string description: The Propexo unique identifier for the property start_date: type: string format: date-time description: The start date associated with the lease end_date: type: string format: date-time description: The end date associated with the lease scheduled_move_out_date: type: string format: date-time description: The scheduled move-out date associated with the lease realized_move_in_date: type: string format: date-time description: The move-in date associated with the lease realized_move_out_date: type: string format: date-time description: The move-out date associated with the lease required: - integration_id - resident_id - unit_id _v1_leases_rentmanager__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration resident_id: type: string description: The Propexo unique identifier for the resident unit_id: type: string description: The Propexo unique identifier for the unit property_id: type: - string - "null" description: The Propexo unique identifier for the property start_date: type: - string - "null" format: date-time description: The start date associated with the lease end_date: type: - string - "null" format: date-time description: The end date associated with the lease scheduled_move_out_date: type: - string - "null" format: date-time description: The scheduled move-out date associated with the lease realized_move_in_date: type: - string - "null" format: date-time description: The move-in date associated with the lease realized_move_out_date: type: - string - "null" format: date-time description: The move-out date associated with the lease required: - integration_id - resident_id - unit_id - property_id - start_date - end_date - scheduled_move_out_date - realized_move_in_date - realized_move_out_date required: - meta - result _v1_leases_rentmanager_{lease_id}_put_input: type: object properties: resident_id: type: string description: The Propexo unique identifier for the resident unit_id: type: string description: The Propexo unique identifier for the unit property_id: type: string description: The Propexo unique identifier for the property scheduled_move_out_date: type: string format: date-time description: The scheduled move-out date associated with the lease realized_move_in_date: type: string format: date-time description: The move-in date associated with the lease realized_move_out_date: type: string format: date-time description: The move-out date associated with the lease required: - resident_id - unit_id _v1_leases_rentmanager_{lease_id}_put_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: lease_id: type: string description: The Propexo unique identifier for the lease resident_id: type: string description: The Propexo unique identifier for the resident unit_id: type: string description: The Propexo unique identifier for the unit property_id: type: string description: The Propexo unique identifier for the property scheduled_move_out_date: type: string format: date-time description: The scheduled move-out date associated with the lease realized_move_in_date: type: string format: date-time description: The move-in date associated with the lease realized_move_out_date: type: string format: date-time description: The move-out date associated with the lease required: - lease_id - resident_id - unit_id required: - meta - result _v1_leases_rentvine__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration unit_id: type: string description: The Propexo unique identifier for the unit employee_id: type: string description: The Propexo unique identifier for the employee scheduled_move_in_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The move-in date associated with the lease start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The start date associated with the lease end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The end date associated with the lease rent_amount_in_cents: type: integer exclusiveMinimum: 0 description: The rent amount in cents for the lease nsf_fee_amount_in_cents: type: integer exclusiveMinimum: 0 description: The NSF fee amount in cents for the lease status: type: string enum: - PENDING - ACTIVE description: The status associated with the lease associated_resident_ids: type: array items: type: string minItems: 1 description: A list of Propexo Resident IDs associated with the lease. The resident must be a primary. resident_charges: type: array items: type: object properties: financial_account_id: type: string description: The Propexo unique identifier for the financial account post_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The post date for the resident charge description: type: string description: Description of the resident charge amount_in_cents: type: integer exclusiveMinimum: 0 description: The amount of the resident charge, in cents is_prorated: type: boolean description: Whether or not the resident charge is prorated required: - financial_account_id - post_date - description - amount_in_cents - is_prorated default: *a175 description: A list of move in charges for the lease recurring_resident_charges: type: array items: type: object properties: financial_account_id: type: string description: The Propexo unique identifier for the financial account start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The start date associated with the recurring resident charge end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The end date associated with the recurring resident charge description: type: string description: Description of the resident charge amount_in_cents: type: integer exclusiveMinimum: 0 description: The amount of the recurring resident charge, in cents charge_due_day: type: integer exclusiveMinimum: 0 minimum: 1 maximum: 31 description: The day of the month the charge is due frequency_raw: type: integer exclusiveMinimum: 0 minimum: 1 maximum: 12 description: The raw value of the frequency of the recurring resident charge. This will be the frequency (in months) for Rentvine required: - financial_account_id - start_date - description - amount_in_cents - charge_due_day - frequency_raw default: *a176 description: A list of recurring charges for the lease other_occupants: type: array items: type: object properties: first_name: type: string description: The first name associated with the occupant last_name: type: string description: The last name associated with the occupant date_of_birth: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date of birth associated with the occupant required: - first_name - last_name default: &a177 [] description: A list of other occupants for the lease required: - integration_id - unit_id - scheduled_move_in_date - start_date - rent_amount_in_cents - nsf_fee_amount_in_cents - status - associated_resident_ids _v1_leases_rentvine__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration unit_id: type: string description: The Propexo unique identifier for the unit employee_id: type: - string - "null" description: The Propexo unique identifier for the employee scheduled_move_in_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" description: The end date associated with the lease rent_amount_in_cents: type: integer exclusiveMinimum: 0 description: The rent amount in cents for the lease nsf_fee_amount_in_cents: type: integer exclusiveMinimum: 0 description: The NSF fee amount in cents for the lease status: type: string enum: - PENDING - ACTIVE description: The status associated with the lease associated_resident_ids: type: array items: type: string resident_charges: type: array items: type: object properties: financial_account_id: type: string description: The Propexo unique identifier for the financial account post_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The post date for the resident charge description: type: string description: Description of the resident charge amount_in_cents: type: integer exclusiveMinimum: 0 description: The amount of the resident charge, in cents is_prorated: type: boolean description: Whether or not the resident charge is prorated required: - financial_account_id - post_date - description - amount_in_cents - is_prorated default: *a175 description: A list of move in charges for the lease recurring_resident_charges: type: array items: type: object properties: financial_account_id: type: string description: The Propexo unique identifier for the financial account start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The start date associated with the recurring resident charge end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The end date associated with the recurring resident charge description: type: string description: Description of the resident charge amount_in_cents: type: integer exclusiveMinimum: 0 description: The amount of the recurring resident charge, in cents charge_due_day: type: integer exclusiveMinimum: 0 minimum: 1 maximum: 31 description: The day of the month the charge is due frequency_raw: type: integer exclusiveMinimum: 0 minimum: 1 maximum: 12 description: The raw value of the frequency of the recurring resident charge. This will be the frequency (in months) for Rentvine required: - financial_account_id - start_date - description - amount_in_cents - charge_due_day - frequency_raw default: *a176 description: A list of recurring charges for the lease other_occupants: type: - array - "null" items: type: object properties: first_name: type: string description: The first name associated with the occupant last_name: type: string description: The last name associated with the occupant date_of_birth: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date of birth associated with the occupant required: - first_name - last_name default: *a177 required: - integration_id - unit_id - employee_id - scheduled_move_in_date - start_date - end_date - rent_amount_in_cents - nsf_fee_amount_in_cents - status - associated_resident_ids required: - meta - result _v1_leases_rentvine_{lease_id}_put_input: type: object properties: move_in_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The move-in date associated with the lease move_out_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The move-out date associated with the lease scheduled_move_out_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The scheduled move-out date associated with the lease start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The start date associated with the lease end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The end date associated with the lease _v1_leases_rentvine_{lease_id}_put_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: lease_id: type: string description: The Propexo unique identifier for the lease move_in_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The move-in date associated with the lease move_out_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The move-out date associated with the lease scheduled_move_out_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The scheduled move-out date associated with the lease start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The start date associated with the lease end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The end date associated with the lease required: - lease_id required: - meta - result _v1_leases_yardi_{lease_id}_put_input: type: object properties: resident_id: type: string description: The Propexo unique identifier for the resident first_name: type: string description: The first name associated with the applicant last_name: type: string description: The last name associated with the applicant middle_name: type: string description: The middle name associated with the applicant maiden_name: type: string description: The maiden name associated with the applicant email_1: type: string format: email description: The primary email address associated with the applicant phone_1: type: string pattern: ^\d{10}$ description: Primary phone number associated with the applicant phone_1_type: type: string enum: *a16 description: Type of the primary phone number phone_2: type: string pattern: ^\d{10}$ description: Secondary phone number associated with the applicant phone_2_type: type: string enum: *a16 description: Type of the secondary phone number move_in_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The desired move-in date to the unit listed in the application move_out_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The desired move-out date to the unit listed in the application desired_lease_term_in_months: type: string description: The desired lease term in months of the applicant date_of_birth: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date of birth associated with the applicant notes: type: string description: Notes associated with the applicant is_evicted: type: boolean description: Whether the applicant has been evicted is_felony: type: boolean description: Whether the applicant has a felony is_criminal_charge: type: boolean description: Whether the applicant has a criminal charge eviction_description: type: string description: The description of the eviction felony_description: type: string description: The description of the felony criminal_charge_description: type: string description: The description of the criminal charge marital_status: type: string enum: *a57 description: The marital status of the applicant identification_number: type: string description: The social security number of the applicant drivers_license_number: type: string description: The driver's license number of the applicant address_history: type: array items: type: object properties: address_1: type: string description: The first address line associated with the applicant's historical address city: type: string description: The city associated with the applicant's historical address state: type: string enum: *a33 description: The state associated with the applicant zip: type: string description: The zip code associated with the applicant's historical address country: type: string enum: *a54 description: The country associated with the applicant's historical address. If your application needs to support submitting an applicant who resides in another country, please reach out to Propexo Support for help notice_provided: type: boolean description: Whether notice has been given to the applicant's historical address property_name: type: string description: The property name of the applicant's historical address reason_for_leaving: type: string description: The reason the applicant left their historical address monthly_payment_in_cents: type: integer minimum: 0 description: For the applicant's historical address, the applicant's monthly payment for rent or mortgage in cents move_in_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date when the applicant moved into their historical address move_out_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date when the applicant moved out of their historical address. If this is the applicant's current address, omit this field manager_phone: type: string pattern: ^\d{10}$ description: The phone number of a property manager who works at this address manager_email: type: string format: email description: The email of a property manager who works at this address management_company: type: string description: The name of the company who owns the property at this address required: - address_1 - city - state - zip - notice_provided - move_in_date maxItems: 2 default: *a178 description: The address history of the applicant emergency_contacts: type: array items: type: object properties: first_name: type: string description: The first name of the emergency contact last_name: type: string description: The last name of the emergency contact relationship: type: string enum: *a56 description: The relationship of the emergency contact to the applicant address_1: type: string description: The first line of the address of the emergency contact city: type: string description: The city of the address of the emergency contact state: type: string enum: *a33 description: The state of the address of the emergency contact zip: type: string description: The zip code of the address of the emergency contact country: type: string enum: *a54 description: The country of the address of the emergency contact. If your application needs to support submitting an applicant who resides in another country, please reach out to Propexo Support for help phone_1: type: string pattern: ^\d{10}$ description: The phone number of the emergency contact required: - first_name - last_name - relationship maxItems: 1 default: *a179 description: A list of emergency contacts for the applicant employment_history: type: array items: type: object properties: is_current_employer: type: boolean description: Whether this employment history entry is for a current employer name: type: string description: The name of the employer start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The start date of the applicant's employment at this employer end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The end date of the applicant's employment at this employer. Ignore this field if is_current_employer is set to true address_1: type: string description: The first line of the address of the employer city: type: string description: The city of the address of the employer state: type: string enum: *a33 description: The state of the address of the employer zip: type: string description: The zip code of the address of the employer phone: type: string pattern: ^\d{10}$ description: The phone number of the employer supervisor_first_name: type: string description: The first name of the applicant's supervisor at this employer supervisor_last_name: type: string description: The last name of the applicant's supervisor at this employer position: type: string description: The position held at this employer, or the job description of the applicant monthly_income_in_cents: type: integer minimum: 0 description: The monthly income of the applicant at this employer in cents required: - is_current_employer - name - start_date - monthly_income_in_cents maxItems: 2 default: *a180 description: The employment history of the applicant other_income: type: array items: type: object properties: source: type: string description: The source of the income for the applicant monthly_income_in_cents: type: integer minimum: 0 description: The monthly income from this income source in cents required: - source - monthly_income_in_cents maxItems: 2 default: *a181 description: A list of other income sources for the applicant vehicles: type: array items: type: object properties: make: type: string description: The make of the vehicle model: type: string description: The model of the vehicle year: type: integer description: The year the vehicle was made color: type: string description: The color of the vehicle license_plate_number: type: string description: The license plate number of the vehicle license_plate_state: type: string description: The issuing state of the license plate required: - make maxItems: 4 default: *a182 description: A list of vehicles for the application pets: type: array items: type: object properties: type: type: string description: The type associated with the applicant pet name: type: string description: The name associated with the applicant pet age_in_years: type: integer minimum: 0 description: The age in years of the applicant pet weight_in_pounds: type: integer minimum: 0 description: The weight in pounds of the applicant pet breed: type: string description: The breed of the applicant pet color: type: string description: The color of the applicant pet gender: type: string description: The raw value for the gender of the applicant pet is_fixed: type: boolean description: Whether the applicant pet is fixed is_service_animal: type: boolean description: Whether the applicant pet is a service animal required: - type maxItems: 6 default: *a183 description: A list of applicant pets concession_fees: type: array items: type: object properties: start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The start date of the applicant's recurring concession fee end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The end date of the applicant's recurring concession fee concession_id: type: string description: The Propexo unique identifier for the concession. This concession must be associated with the unit that the applicant is applying for required: - start_date - end_date - concession_id default: *a184 description: A list of concession fees for the application application_fees: type: array items: type: object properties: charge_code_id: type: string description: The Propexo unique identifier for the charge code. This must be an application fee charge code amount_in_cents: type: integer minimum: 0 description: The application fee amount in cents description: type: string description: Description of the application fee required: - charge_code_id - amount_in_cents default: *a185 description: A list of application fees for the application other_occupants: type: array items: type: object properties: relationship: type: string enum: *a55 description: The relationship of the occupant to the applicant first_name: type: string description: The first name associated with the occupant last_name: type: string description: The last name associated with the occupant third_party_id: type: string minLength: 1 description: A unique ID you would like to associate with the occupant. This is not the Yardi occupant ID organization_name: type: string description: The name of your organization. Yardi uses this for associating an occupant email_1: type: string format: email description: The primary email address associated with the occupant phone_1: type: string pattern: ^\d{10}$ description: Primary phone number associated with the occupant phone_1_type: type: string enum: *a16 description: Type of the primary phone number phone_2: type: string pattern: ^\d{10}$ description: Secondary phone number associated with the occupant phone_2_type: type: string enum: *a16 description: Type of the secondary phone number address_1: type: string description: The first address line associated with the occupant city: type: string description: The city associated with the occupant state: type: string enum: *a33 description: The state associated with the occupant zip: type: string description: The zip code associated with the occupant required: - relationship - first_name - last_name - third_party_id - organization_name default: *a186 description: A list of other occupants for the application required: - resident_id _v1_leases_yardi_{lease_id}_put_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: lease_id: type: string description: The Propexo unique identifier for the lease resident_id: type: string description: The Propexo unique identifier for the resident first_name: type: string description: The first name associated with the applicant last_name: type: string description: The last name associated with the applicant middle_name: type: string description: The middle name associated with the applicant maiden_name: type: string description: The maiden name associated with the applicant email_1: type: string format: email description: The primary email address associated with the applicant phone_1: type: string pattern: ^\d{10}$ description: Primary phone number associated with the applicant phone_1_type: type: string enum: *a16 description: Type of the primary phone number phone_2: type: string pattern: ^\d{10}$ description: Secondary phone number associated with the applicant phone_2_type: type: string enum: *a16 description: Type of the secondary phone number move_in_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The desired move-in date to the unit listed in the application move_out_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The desired move-out date to the unit listed in the application desired_lease_term_in_months: type: string description: The desired lease term in months of the applicant date_of_birth: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date of birth associated with the applicant notes: type: string description: Notes associated with the applicant is_evicted: type: boolean description: Whether the applicant has been evicted is_felony: type: boolean description: Whether the applicant has a felony is_criminal_charge: type: boolean description: Whether the applicant has a criminal charge eviction_description: type: string description: The description of the eviction felony_description: type: string description: The description of the felony criminal_charge_description: type: string description: The description of the criminal charge marital_status: type: string enum: *a57 description: The marital status of the applicant identification_number: type: string description: The social security number of the applicant drivers_license_number: type: string description: The driver's license number of the applicant address_history: type: array items: type: object properties: address_1: type: string description: The first address line associated with the applicant's historical address city: type: string description: The city associated with the applicant's historical address state: type: string enum: *a33 description: The state associated with the applicant zip: type: string description: The zip code associated with the applicant's historical address country: type: string enum: *a54 description: The country associated with the applicant's historical address. If your application needs to support submitting an applicant who resides in another country, please reach out to Propexo Support for help notice_provided: type: boolean description: Whether notice has been given to the applicant's historical address property_name: type: string description: The property name of the applicant's historical address reason_for_leaving: type: string description: The reason the applicant left their historical address monthly_payment_in_cents: type: integer minimum: 0 description: For the applicant's historical address, the applicant's monthly payment for rent or mortgage in cents move_in_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date when the applicant moved into their historical address move_out_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date when the applicant moved out of their historical address. If this is the applicant's current address, omit this field manager_phone: type: string pattern: ^\d{10}$ description: The phone number of a property manager who works at this address manager_email: type: string format: email description: The email of a property manager who works at this address management_company: type: string description: The name of the company who owns the property at this address required: - address_1 - city - state - zip - notice_provided - move_in_date maxItems: 2 default: *a178 description: The address history of the applicant emergency_contacts: type: array items: type: object properties: first_name: type: string description: The first name of the emergency contact last_name: type: string description: The last name of the emergency contact relationship: type: string enum: *a56 description: The relationship of the emergency contact to the applicant address_1: type: string description: The first line of the address of the emergency contact city: type: string description: The city of the address of the emergency contact state: type: string enum: *a33 description: The state of the address of the emergency contact zip: type: string description: The zip code of the address of the emergency contact country: type: string enum: *a54 description: The country of the address of the emergency contact. If your application needs to support submitting an applicant who resides in another country, please reach out to Propexo Support for help phone_1: type: string pattern: ^\d{10}$ description: The phone number of the emergency contact required: - first_name - last_name - relationship maxItems: 1 default: *a179 description: A list of emergency contacts for the applicant employment_history: type: array items: type: object properties: is_current_employer: type: boolean description: Whether this employment history entry is for a current employer name: type: string description: The name of the employer start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The start date of the applicant's employment at this employer end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The end date of the applicant's employment at this employer. Ignore this field if is_current_employer is set to true address_1: type: string description: The first line of the address of the employer city: type: string description: The city of the address of the employer state: type: string enum: *a33 description: The state of the address of the employer zip: type: string description: The zip code of the address of the employer phone: type: string pattern: ^\d{10}$ description: The phone number of the employer supervisor_first_name: type: string description: The first name of the applicant's supervisor at this employer supervisor_last_name: type: string description: The last name of the applicant's supervisor at this employer position: type: string description: The position held at this employer, or the job description of the applicant monthly_income_in_cents: type: integer minimum: 0 description: The monthly income of the applicant at this employer in cents required: - is_current_employer - name - start_date - monthly_income_in_cents maxItems: 2 default: *a180 description: The employment history of the applicant other_income: type: array items: type: object properties: source: type: string description: The source of the income for the applicant monthly_income_in_cents: type: integer minimum: 0 description: The monthly income from this income source in cents required: - source - monthly_income_in_cents maxItems: 2 default: *a181 description: A list of other income sources for the applicant vehicles: type: array items: type: object properties: make: type: string description: The make of the vehicle model: type: string description: The model of the vehicle year: type: integer description: The year the vehicle was made color: type: string description: The color of the vehicle license_plate_number: type: string description: The license plate number of the vehicle license_plate_state: type: string description: The issuing state of the license plate required: - make maxItems: 4 default: *a182 description: A list of vehicles for the application pets: type: array items: type: object properties: type: type: string description: The type associated with the applicant pet name: type: string description: The name associated with the applicant pet age_in_years: type: integer minimum: 0 description: The age in years of the applicant pet weight_in_pounds: type: integer minimum: 0 description: The weight in pounds of the applicant pet breed: type: string description: The breed of the applicant pet color: type: string description: The color of the applicant pet gender: type: string description: The raw value for the gender of the applicant pet is_fixed: type: boolean description: Whether the applicant pet is fixed is_service_animal: type: boolean description: Whether the applicant pet is a service animal required: - type maxItems: 6 default: *a183 description: A list of applicant pets concession_fees: type: array items: type: object properties: start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The start date of the applicant's recurring concession fee end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The end date of the applicant's recurring concession fee concession_id: type: string description: The Propexo unique identifier for the concession. This concession must be associated with the unit that the applicant is applying for required: - start_date - end_date - concession_id default: *a184 description: A list of concession fees for the application application_fees: type: array items: type: object properties: charge_code_id: type: string description: The Propexo unique identifier for the charge code. This must be an application fee charge code amount_in_cents: type: integer minimum: 0 description: The application fee amount in cents description: type: string description: Description of the application fee required: - charge_code_id - amount_in_cents default: *a185 description: A list of application fees for the application other_occupants: type: array items: type: object properties: relationship: type: string enum: *a55 description: The relationship of the occupant to the applicant first_name: type: string description: The first name associated with the occupant last_name: type: string description: The last name associated with the occupant third_party_id: type: string minLength: 1 description: A unique ID you would like to associate with the occupant. This is not the Yardi occupant ID organization_name: type: string description: The name of your organization. Yardi uses this for associating an occupant email_1: type: string format: email description: The primary email address associated with the occupant phone_1: type: string pattern: ^\d{10}$ description: Primary phone number associated with the occupant phone_1_type: type: string enum: *a16 description: Type of the primary phone number phone_2: type: string pattern: ^\d{10}$ description: Secondary phone number associated with the occupant phone_2_type: type: string enum: *a16 description: Type of the secondary phone number address_1: type: string description: The first address line associated with the occupant city: type: string description: The city associated with the occupant state: type: string enum: *a33 description: The state associated with the occupant zip: type: string description: The zip code associated with the occupant required: - relationship - first_name - last_name - third_party_id - organization_name default: *a186 required: - lease_id - resident_id required: - meta - result _v1_leases_yardi__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration property_id: type: string description: The Propexo unique identifier for the property unit_id: type: string description: The Propexo unique identifier for the unit lead_id: type: string description: The Propexo unique identifier for the lead. The lead will be converted to an applicant employee_id: type: string description: The Propexo unique identifier for the employee. Employee must have a role of LEASING_AGENT. Required if lead_id is not specified lead_source_id: type: string description: The Propexo unique identifier for the lead source. Required if lead_id is not specified third_party_id: type: string minLength: 1 description: A unique ID you would like to associate with the applicant. This is not the Yardi applicant ID. Required if lead_id is not specified organization_name: type: string description: The name of your organization. Yardi uses this for associating an applicant. Required if lead_id is not specified first_name: type: string description: The first name associated with the applicant. Required if lead_id is not specified last_name: type: string description: The last name associated with the applicant. Required if lead_id is not specified middle_name: type: string description: The middle name associated with the applicant maiden_name: type: string description: The maiden name associated with the applicant email_1: type: string format: email description: The primary email address associated with the applicant phone_1: type: string pattern: ^\d{10}$ description: Primary phone number associated with the applicant phone_1_type: type: string enum: *a16 description: Type of the primary phone number phone_2: type: string pattern: ^\d{10}$ description: Secondary phone number associated with the applicant phone_2_type: type: string enum: *a16 description: Type of the secondary phone number move_in_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The desired move-in date to the unit listed in the application move_out_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The desired move-out date to the unit listed in the application desired_lease_term_in_months: type: string description: The desired lease term in months of the applicant date_of_birth: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date of birth associated with the applicant notes: type: string description: Notes associated with the applicant is_evicted: type: boolean description: Whether the applicant has been evicted is_felony: type: boolean description: Whether the applicant has a felony is_criminal_charge: type: boolean description: Whether the applicant has a criminal charge eviction_description: type: string description: The description of the eviction felony_description: type: string description: The description of the felony criminal_charge_description: type: string description: The description of the criminal charge marital_status: type: string enum: *a57 description: The marital status of the applicant identification_number: type: string description: The social security number of the applicant drivers_license_number: type: string description: The driver's license number of the applicant address_history: type: array items: type: object properties: address_1: type: string description: The first address line associated with the applicant's historical address city: type: string description: The city associated with the applicant's historical address state: type: string enum: *a33 description: The state associated with the applicant zip: type: string description: The zip code associated with the applicant's historical address country: anyOf: - type: string enum: *a54 - type: string description: The country associated with the applicant's historical address. If your application needs to support submitting an applicant who resides in another country, please reach out to Propexo Support for help notice_provided: type: boolean description: Whether notice has been given to the applicant's historical address property_name: type: string description: The property name of the applicant's historical address reason_for_leaving: type: string description: The reason the applicant left their historical address monthly_payment_in_cents: type: integer minimum: 0 description: For the applicant's historical address, the applicant's monthly payment for rent or mortgage in cents move_in_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date when the applicant moved into their historical address move_out_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date when the applicant moved out of their historical address. If this is the applicant's current address, omit this field manager_phone: type: string pattern: ^\d{10}$ description: The phone number of a property manager who works at this address manager_email: type: string format: email description: The email of a property manager who works at this address management_company: type: string description: The name of the company who owns the property at this address required: - address_1 - city - state - zip - notice_provided - move_in_date maxItems: 2 default: *a187 description: The address history of the applicant emergency_contacts: type: array items: type: object properties: first_name: type: string description: The first name of the emergency contact last_name: type: string description: The last name of the emergency contact relationship: type: string enum: *a56 description: The relationship of the emergency contact to the applicant address_1: type: string description: The first line of the address of the emergency contact city: type: string description: The city of the address of the emergency contact state: type: string enum: *a33 description: The state of the address of the emergency contact zip: type: string description: The zip code of the address of the emergency contact country: anyOf: - type: string enum: *a54 - type: string description: The country of the address of the emergency contact. If your application needs to support submitting an applicant who resides in another country, please reach out to Propexo Support for help phone_1: type: string pattern: ^\d{10}$ description: The phone number of the emergency contact required: - first_name - last_name - relationship maxItems: 1 default: *a188 description: A list of emergency contacts for the applicant employment_history: type: array items: type: object properties: is_current_employer: type: boolean description: Whether this employment history entry is for a current employer name: type: string description: The name of the employer start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The start date of the applicant's employment at this employer end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The end date of the applicant's employment at this employer. Ignore this field if is_current_employer is set to true address_1: type: string description: The first line of the address of the employer city: type: string description: The city of the address of the employer state: type: string enum: *a33 description: The state of the address of the employer zip: type: string description: The zip code of the address of the employer phone: type: string pattern: ^\d{10}$ description: The phone number of the employer supervisor_first_name: type: string description: The first name of the applicant's supervisor at this employer supervisor_last_name: type: string description: The last name of the applicant's supervisor at this employer position: type: string description: The position held at this employer, or the job description of the applicant monthly_income_in_cents: type: integer minimum: 0 description: The monthly income of the applicant at this employer in cents required: - is_current_employer - name - start_date - monthly_income_in_cents maxItems: 2 default: *a189 description: The employment history of the applicant other_income: type: array items: type: object properties: source: type: string description: The source of the income for the applicant monthly_income_in_cents: type: integer minimum: 0 description: The monthly income from this income source in cents required: - source - monthly_income_in_cents maxItems: 2 default: *a190 description: A list of other income sources for the applicant vehicles: type: array items: type: object properties: make: type: string description: The make of the vehicle model: type: string description: The model of the vehicle year: type: integer description: The year the vehicle was made color: type: string description: The color of the vehicle license_plate_number: type: string description: The license plate number of the vehicle license_plate_state: type: string description: The issuing state of the license plate required: - make maxItems: 4 default: *a191 description: A list of vehicles for the application pets: type: array items: type: object properties: type: type: string description: The type associated with the applicant pet name: type: string description: The name associated with the applicant pet age_in_years: type: integer minimum: 0 description: The age in years of the applicant pet weight_in_pounds: type: integer minimum: 0 description: The weight in pounds of the applicant pet breed: type: string description: The breed of the applicant pet color: type: string description: The color of the applicant pet gender: type: string description: The raw value for the gender of the applicant pet is_fixed: type: boolean description: Whether the applicant pet is fixed is_service_animal: type: boolean description: Whether the applicant pet is a service animal required: - type maxItems: 6 default: *a192 description: A list of applicant pets concession_fees: type: array items: type: object properties: start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The start date of the applicant's recurring concession fee end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The end date of the applicant's recurring concession fee concession_id: type: string description: The Propexo unique identifier for the concession. This concession must be associated with the unit that the applicant is applying for required: - start_date - end_date - concession_id default: *a193 description: A list of concession fees for the application application_fees: type: array items: type: object properties: charge_code_id: type: string description: The Propexo unique identifier for the charge code. This must be an application fee charge code amount_in_cents: type: integer minimum: 0 description: The application fee amount in cents description: type: string description: Description of the application fee required: - charge_code_id - amount_in_cents default: *a194 description: A list of application fees for the application other_occupants: type: array items: type: object properties: relationship: type: string enum: *a55 description: The relationship of the occupant to the applicant first_name: type: string description: The first name associated with the occupant last_name: type: string description: The last name associated with the occupant third_party_id: type: string minLength: 1 description: A unique ID you would like to associate with the occupant. This is not the Yardi occupant ID organization_name: type: string description: The name of your organization. Yardi uses this for associating an occupant email_1: type: string format: email description: The primary email address associated with the occupant phone_1: type: string pattern: ^\d{10}$ description: Primary phone number associated with the occupant phone_1_type: type: string enum: *a16 description: Type of the primary phone number phone_2: type: string pattern: ^\d{10}$ description: Secondary phone number associated with the occupant phone_2_type: type: string enum: *a16 description: Type of the secondary phone number address_1: type: string description: The first address line associated with the occupant city: type: string description: The city associated with the occupant state: type: string enum: *a33 description: The state associated with the occupant zip: type: string description: The zip code associated with the occupant required: - relationship - first_name - last_name - third_party_id - organization_name default: *a195 description: A list of other occupants for the application required: - integration_id - property_id - unit_id _v1_leases_yardi__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration property_id: type: string description: The Propexo unique identifier for the property unit_id: type: string description: The Propexo unique identifier for the unit lead_id: type: - string - "null" description: The Propexo unique identifier for the lead. The lead will be converted to an applicant employee_id: type: - string - "null" description: The Propexo unique identifier for the employee. Employee must have a role of LEASING_AGENT. Required if lead_id is not specified lead_source_id: type: - string - "null" description: The Propexo unique identifier for the lead source. Required if lead_id is not specified third_party_id: type: - string - "null" minLength: 1 description: A unique ID you would like to associate with the applicant. This is not the Yardi applicant ID. Required if lead_id is not specified organization_name: type: - string - "null" description: The name of your organization. Yardi uses this for associating an applicant. Required if lead_id is not specified first_name: type: - string - "null" description: The first name associated with the applicant. Required if lead_id is not specified last_name: type: - string - "null" description: The last name associated with the applicant. Required if lead_id is not specified middle_name: type: - string - "null" description: The middle name associated with the applicant maiden_name: type: - string - "null" description: The maiden name associated with the applicant email_1: type: - string - "null" format: email description: The primary email address associated with the applicant phone_1: type: - string - "null" pattern: ^\d{10}$ description: Primary phone number associated with the applicant phone_1_type: type: - string - "null" enum: *a16 description: Type of the primary phone number phone_2: type: - string - "null" pattern: ^\d{10}$ description: Secondary phone number associated with the applicant phone_2_type: type: - string - "null" enum: *a16 description: Type of the secondary phone number move_in_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" description: The desired move-in date to the unit listed in the application move_out_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" description: The desired move-out date to the unit listed in the application desired_lease_term_in_months: type: - string - "null" description: The desired lease term in months of the applicant date_of_birth: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" description: The date of birth associated with the applicant notes: type: - string - "null" description: Notes associated with the applicant is_evicted: type: - boolean - "null" description: Whether the applicant has been evicted is_felony: type: - boolean - "null" description: Whether the applicant has a felony is_criminal_charge: type: - boolean - "null" description: Whether the applicant has a criminal charge eviction_description: type: - string - "null" description: The description of the eviction felony_description: type: - string - "null" description: The description of the felony criminal_charge_description: type: - string - "null" description: The description of the criminal charge marital_status: type: - string - "null" enum: *a57 description: The marital status of the applicant identification_number: type: - string - "null" description: The social security number of the applicant drivers_license_number: type: - string - "null" description: The driver's license number of the applicant address_history: type: array items: type: object properties: address_1: type: string description: The first address line associated with the applicant's historical address city: type: string description: The city associated with the applicant's historical address state: type: string enum: *a33 description: The state associated with the applicant zip: type: string description: The zip code associated with the applicant's historical address country: anyOf: - type: string enum: *a54 - type: string description: The country associated with the applicant's historical address. If your application needs to support submitting an applicant who resides in another country, please reach out to Propexo Support for help notice_provided: type: boolean description: Whether notice has been given to the applicant's historical address property_name: type: string description: The property name of the applicant's historical address reason_for_leaving: type: string description: The reason the applicant left their historical address monthly_payment_in_cents: type: integer minimum: 0 description: For the applicant's historical address, the applicant's monthly payment for rent or mortgage in cents move_in_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date when the applicant moved into their historical address move_out_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date when the applicant moved out of their historical address. If this is the applicant's current address, omit this field manager_phone: type: string pattern: ^\d{10}$ description: The phone number of a property manager who works at this address manager_email: type: string format: email description: The email of a property manager who works at this address management_company: type: string description: The name of the company who owns the property at this address required: - address_1 - city - state - zip - notice_provided - move_in_date maxItems: 2 default: *a187 description: The address history of the applicant emergency_contacts: type: array items: type: object properties: first_name: type: string description: The first name of the emergency contact last_name: type: string description: The last name of the emergency contact relationship: type: string enum: *a56 description: The relationship of the emergency contact to the applicant address_1: type: string description: The first line of the address of the emergency contact city: type: string description: The city of the address of the emergency contact state: type: string enum: *a33 description: The state of the address of the emergency contact zip: type: string description: The zip code of the address of the emergency contact country: anyOf: - type: string enum: *a54 - type: string description: The country of the address of the emergency contact. If your application needs to support submitting an applicant who resides in another country, please reach out to Propexo Support for help phone_1: type: string pattern: ^\d{10}$ description: The phone number of the emergency contact required: - first_name - last_name - relationship maxItems: 1 default: *a188 description: A list of emergency contacts for the applicant employment_history: type: array items: type: object properties: is_current_employer: type: boolean description: Whether this employment history entry is for a current employer name: type: string description: The name of the employer start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The start date of the applicant's employment at this employer end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The end date of the applicant's employment at this employer. Ignore this field if is_current_employer is set to true address_1: type: string description: The first line of the address of the employer city: type: string description: The city of the address of the employer state: type: string enum: *a33 description: The state of the address of the employer zip: type: string description: The zip code of the address of the employer phone: type: string pattern: ^\d{10}$ description: The phone number of the employer supervisor_first_name: type: string description: The first name of the applicant's supervisor at this employer supervisor_last_name: type: string description: The last name of the applicant's supervisor at this employer position: type: string description: The position held at this employer, or the job description of the applicant monthly_income_in_cents: type: integer minimum: 0 description: The monthly income of the applicant at this employer in cents required: - is_current_employer - name - start_date - monthly_income_in_cents maxItems: 2 default: *a189 description: The employment history of the applicant other_income: type: array items: type: object properties: source: type: string description: The source of the income for the applicant monthly_income_in_cents: type: integer minimum: 0 description: The monthly income from this income source in cents required: - source - monthly_income_in_cents maxItems: 2 default: *a190 description: A list of other income sources for the applicant vehicles: type: array items: type: object properties: make: type: string description: The make of the vehicle model: type: string description: The model of the vehicle year: type: integer description: The year the vehicle was made color: type: string description: The color of the vehicle license_plate_number: type: string description: The license plate number of the vehicle license_plate_state: type: string description: The issuing state of the license plate required: - make maxItems: 4 default: *a191 description: A list of vehicles for the application pets: type: array items: type: object properties: type: type: string description: The type associated with the applicant pet name: type: string description: The name associated with the applicant pet age_in_years: type: integer minimum: 0 description: The age in years of the applicant pet weight_in_pounds: type: integer minimum: 0 description: The weight in pounds of the applicant pet breed: type: string description: The breed of the applicant pet color: type: string description: The color of the applicant pet gender: type: string description: The raw value for the gender of the applicant pet is_fixed: type: boolean description: Whether the applicant pet is fixed is_service_animal: type: boolean description: Whether the applicant pet is a service animal required: - type maxItems: 6 default: *a192 description: A list of applicant pets concession_fees: type: array items: type: object properties: start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The start date of the applicant's recurring concession fee end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The end date of the applicant's recurring concession fee concession_id: type: string description: The Propexo unique identifier for the concession. This concession must be associated with the unit that the applicant is applying for required: - start_date - end_date - concession_id default: *a193 description: A list of concession fees for the application application_fees: type: array items: type: object properties: charge_code_id: type: string description: The Propexo unique identifier for the charge code. This must be an application fee charge code amount_in_cents: type: integer minimum: 0 description: The application fee amount in cents description: type: string description: Description of the application fee required: - charge_code_id - amount_in_cents default: *a194 description: A list of application fees for the application other_occupants: type: - array - "null" items: type: object properties: relationship: type: string enum: *a55 description: The relationship of the occupant to the applicant first_name: type: string description: The first name associated with the occupant last_name: type: string description: The last name associated with the occupant third_party_id: type: string minLength: 1 description: A unique ID you would like to associate with the occupant. This is not the Yardi occupant ID organization_name: type: string description: The name of your organization. Yardi uses this for associating an occupant email_1: type: string format: email description: The primary email address associated with the occupant phone_1: type: string pattern: ^\d{10}$ description: Primary phone number associated with the occupant phone_1_type: type: string enum: *a16 description: Type of the primary phone number phone_2: type: string pattern: ^\d{10}$ description: Secondary phone number associated with the occupant phone_2_type: type: string enum: *a16 description: Type of the secondary phone number address_1: type: string description: The first address line associated with the occupant city: type: string description: The city associated with the occupant state: type: string enum: *a33 description: The state associated with the occupant zip: type: string description: The zip code associated with the occupant required: - relationship - first_name - last_name - third_party_id - organization_name default: *a195 required: - integration_id - property_id - unit_id - lead_id - employee_id - lead_source_id - third_party_id - organization_name - first_name - last_name - middle_name - maiden_name - email_1 - phone_1 - phone_1_type - phone_2 - phone_2_type - move_in_date - move_out_date - desired_lease_term_in_months - date_of_birth - notes - is_evicted - is_felony - is_criminal_charge - eviction_description - felony_description - criminal_charge_description - marital_status - identification_number - drivers_license_number required: - meta - result _v1_leases_propertyware_{lease_id}_put_input: type: object properties: property_id: type: string description: The Propexo unique identifier for the property unit_id: type: string description: The Propexo unique identifier for the unit primary_contact_id: type: string description: The Propexo unique identifier of the primary contact. This must either be a lead, applicant, or resident in Propexo tenants: type: array items: type: object properties: id: type: string description: The Propexo unique identifier for the lead, applicant, or resident required: - id description: An array of Propexo lead, applicant, or resident IDs. This must also include the primary contact ID start_date: type: string format: date-time description: The start date associated with the lease end_date: type: string format: date-time description: The end date associated with the lease scheduled_move_in_date: type: string format: date-time description: The move-in date associated with the lease scheduled_move_out_date: type: string format: date-time description: The move-out date associated with the lease status: type: string enum: &a196 - Draft - Active - Active - Notice Given - Terminated - Eviction description: The status associated with the lease _v1_leases_propertyware_{lease_id}_put_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: lease_id: type: string description: The Propexo unique identifier for the lease property_id: type: string description: The Propexo unique identifier for the property unit_id: type: string description: The Propexo unique identifier for the unit primary_contact_id: type: string description: The Propexo unique identifier of the primary contact. This must either be a lead, applicant, or resident in Propexo tenants: type: array items: type: object properties: id: type: string description: The Propexo unique identifier for the lead, applicant, or resident required: - id start_date: type: string format: date-time description: The start date associated with the lease end_date: type: string format: date-time description: The end date associated with the lease scheduled_move_in_date: type: string format: date-time description: The move-in date associated with the lease scheduled_move_out_date: type: string format: date-time description: The move-out date associated with the lease status: type: string enum: *a196 description: The status associated with the lease required: - lease_id required: - meta - result _v1_leases_propertyware__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration property_id: type: string description: The Propexo unique identifier for the property unit_id: type: string description: The Propexo unique identifier for the unit primary_contact_id: type: string description: The Propexo unique identifier of the primary contact. This must either be a lead, applicant, or resident in Propexo tenants: type: array items: type: object properties: id: type: string description: The Propexo unique identifier for the lead, applicant, or resident required: - id description: An array of Propexo lead, applicant, or resident IDs. This must also include the primary contact ID start_date: type: string format: date-time description: The start date associated with the lease end_date: type: string format: date-time description: The end date associated with the lease scheduled_move_in_date: type: string format: date-time description: The move-in date associated with the lease scheduled_move_out_date: type: string format: date-time description: The move-out date associated with the lease status: type: string enum: &a197 - Draft - Active - Active - Notice Given - Terminated - Eviction description: The status associated with the lease required: - integration_id - property_id - unit_id - primary_contact_id - tenants - start_date - end_date _v1_leases_propertyware__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration property_id: type: string description: The Propexo unique identifier for the property unit_id: type: string description: The Propexo unique identifier for the unit primary_contact_id: type: string description: The Propexo unique identifier of the primary contact. This must either be a lead, applicant, or resident in Propexo tenants: type: array items: type: object properties: id: type: string description: The Propexo unique identifier for the lead, applicant, or resident required: - id start_date: type: string format: date-time description: The start date associated with the lease end_date: type: string format: date-time description: The end date associated with the lease scheduled_move_in_date: type: - string - "null" format: date-time description: The move-in date associated with the lease scheduled_move_out_date: type: - string - "null" format: date-time description: The move-out date associated with the lease status: type: - string - "null" enum: *a197 description: The status associated with the lease required: - integration_id - property_id - unit_id - primary_contact_id - tenants - start_date - end_date - scheduled_move_in_date - scheduled_move_out_date - status required: - meta - result _v1_leases_propertyware_rest_{lease_id}_put_input: type: object properties: unit_id: type: string description: The Propexo unique identifier for the unit primary_contact_id: type: string description: The Propexo unique identifier of the primary contact. This must either be a lead, applicant, or resident in Propexo tenant_ids: type: array items: type: string description: An array of Propexo lead, applicant, or resident IDs. This must also include the primary contact ID start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The start date associated with the lease end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The end date associated with the lease move_in_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The move-in date associated with the lease. This must come before move_out_date move_out_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The move-out date associated with the lease. This must come before move_in_date scheduled_move_out_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The scheduled move-out date associated with the lease. This must come before move_in_date status: type: string enum: &a198 - Draft - Active - Active - Notice Given - Terminated - Eviction description: The status associated with the lease rent_amount_in_cents: type: integer minimum: 0 description: The rent amount in cents for the lease notes: type: string description: Notes associated with the lease signature_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The signature date of the lease deposit_amount_in_cents: type: integer minimum: 0 description: The deposit amount in cents associated with the lease deposit_charge_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The deposit date associated with the lease _v1_leases_propertyware_rest_{lease_id}_put_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: lease_id: type: string description: The Propexo unique identifier for the lease unit_id: type: string description: The Propexo unique identifier for the unit primary_contact_id: type: string description: The Propexo unique identifier of the primary contact. This must either be a lead, applicant, or resident in Propexo tenant_ids: type: array items: type: string start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The start date associated with the lease end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The end date associated with the lease move_in_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The move-in date associated with the lease. This must come before move_out_date move_out_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The move-out date associated with the lease. This must come before move_in_date scheduled_move_out_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The scheduled move-out date associated with the lease. This must come before move_in_date status: type: string enum: *a198 description: The status associated with the lease rent_amount_in_cents: type: integer minimum: 0 description: The rent amount in cents for the lease notes: type: string description: Notes associated with the lease signature_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The signature date of the lease deposit_amount_in_cents: type: integer minimum: 0 description: The deposit amount in cents associated with the lease deposit_charge_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The deposit date associated with the lease required: - lease_id required: - meta - result _v1_leases_mri__post_input: type: object properties: {} _v1_leases_mri__post_output: type: object properties: {} _v1_leases_mri_{lease_id}_put_input: type: object properties: {} _v1_leases_mri_{lease_id}_put_output: type: object properties: {} _v1_leases_resman__post_input: type: object properties: {} _v1_leases_resman__post_output: type: object properties: {} _v1_leases_resman_{lease_id}_put_input: type: object properties: applicant_id: type: string description: The Propexo unique identifier for the applicant application_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The application date associated with the applicant start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The start date associated with the applicant end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The end date associated with the applicant status: type: string enum: *a199 description: The status associated with the applicant first_name: type: string description: The first name associated with the applicant last_name: type: string description: The last name associated with the applicant date_of_birth: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date of birth associated with the applicant address_1: type: string description: The first address line associated with the applicant city: type: string description: The city associated with the applicant state: type: string description: The state associated with the applicant zip: type: string description: The zip code associated with the applicant phone_1: type: string description: Primary phone number associated with the applicant phone_1_type: type: string enum: &a200 - HOME - MOBILE - WORK description: Type of the primary phone number phone_2: type: string description: Secondary phone number associated with the applicant phone_2_type: type: string enum: &a201 - HOME - MOBILE - WORK description: Type of the secondary phone number rent_amount_market_in_cents: type: integer description: The market rent amount in cents for the lease move_in_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The move-in date associated with the lease required: - applicant_id - application_date - start_date - end_date - status _v1_leases_resman_{lease_id}_put_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: lease_id: type: string description: The Propexo unique identifier for the lease applicant_id: type: string description: The Propexo unique identifier for the applicant application_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The application date associated with the applicant start_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The start date associated with the applicant end_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The end date associated with the applicant status: type: string enum: *a199 description: The status associated with the applicant first_name: type: string description: The first name associated with the applicant last_name: type: string description: The last name associated with the applicant date_of_birth: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date of birth associated with the applicant address_1: type: string description: The first address line associated with the applicant city: type: string description: The city associated with the applicant state: type: string description: The state associated with the applicant zip: type: string description: The zip code associated with the applicant phone_1: type: string description: Primary phone number associated with the applicant phone_1_type: type: string enum: *a200 description: Type of the primary phone number phone_2: type: string description: Secondary phone number associated with the applicant phone_2_type: type: string enum: *a201 description: Type of the secondary phone number rent_amount_market_in_cents: type: integer description: The market rent amount in cents for the lease move_in_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The move-in date associated with the lease required: - lease_id - applicant_id - application_date - start_date - end_date - status required: - meta - result _v1_invoices_resman_{invoice_id}_file-upload_post_input: type: object properties: {} _v1_invoices_resman_{invoice_id}_file-upload_post_output: type: object properties: {} _v1_leases_rentmanager_{lease_id}_custom-data_post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration custom_data: type: object description: A mapping of the fields you want to update and the associated values. Rent Manager has a limit of 10 key/value pairs additionalProperties: &a202 type: object properties: value: type: string required: - value required: - integration_id - custom_data _v1_leases_rentmanager_{lease_id}_custom-data_post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration lease_id: type: string description: The Propexo unique identifier for the lease custom_data: type: object additionalProperties: *a202 required: - integration_id - lease_id - custom_data required: - meta - result _v1_leases_rentmanager_{lease_id}_custom-data_put_input: type: object properties: custom_data: type: object description: A mapping of the fields you want to update and the associated values. Rent Manager has a limit of 10 key/value pairs additionalProperties: *a202 required: - custom_data _v1_leases_rentmanager_{lease_id}_custom-data_put_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: lease_id: type: string description: The Propexo unique identifier for the lease custom_data: type: object description: A mapping of the fields you want to update and the associated values. Rent Manager has a limit of 10 key/value pairs additionalProperties: *a202 required: - lease_id - custom_data required: - meta - result _v1_leases_rentvine_{lease_id}_custom-data_put_input: type: object properties: custom_data: type: object additionalProperties: anyOf: - {} - type: object properties: value: type: string required: - value - type: "null" description: |- A mapping of the fields you want to update and the associated values. The key for each field is the key from the normalized custom data object, not the label of the custom field. Each entry will look something like: ``` "eyJjYXRlZ29yeUlkIjoiMSIsImZpZWxkSWQiOiIxIiwidmVyc2lvbiI6MX0=": { "value": "Yes" } ``` required: - custom_data _v1_leases_rentvine_{lease_id}_custom-data_put_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: lease_id: type: string description: The Propexo unique identifier for the lease custom_data: type: object additionalProperties: anyOf: - {} - type: object properties: value: type: string required: - value - type: "null" description: |- A mapping of the fields you want to update and the associated values. The key for each field is the key from the normalized custom data object, not the label of the custom field. Each entry will look something like: ``` "eyJjYXRlZ29yeUlkIjoiMSIsImZpZWxkSWQiOiIxIiwidmVyc2lvbiI6MX0=": { "value": "Yes" } ``` required: - lease_id - custom_data required: - meta - result _v1_leases_propertyware_rest_{lease_id}_custom-data_put_input: type: object properties: custom_data: type: object additionalProperties: anyOf: - {} - type: object properties: value: type: string required: - value - type: "null" description: A mapping of the fields you want to update and the associated values required: - custom_data _v1_leases_propertyware_rest_{lease_id}_custom-data_put_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: lease_id: type: string description: The Propexo unique identifier for the lease custom_data: type: object additionalProperties: anyOf: - {} - type: object properties: value: type: string required: - value - type: "null" description: A mapping of the fields you want to update and the associated values required: - lease_id - custom_data required: - meta - result _v1_leases_buildium_{lease_id}_file-upload__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration attachments: type: array items: type: object properties: title: type: string maxLength: 255 description: A title for the file file_type_id: type: string description: The Propexo unique identifier for the file type file_data: type: string maxLength: 27892121 description: The contents of the file, as a base64 encoded string. The PMS has a max file size of 20 MB. file_name: type: string description: 'The name of the file including the extension. Ex: "resume.pdf"' mime_type: type: string description: 'The mime type of the file. Ex: "application/pdf"' required: - title - file_type_id - file_data - file_name - mime_type minItems: 1 description: Files w/ metadata for the lease. All the files can have a maximum combined file size of 50 MB required: - integration_id - attachments _v1_leases_buildium_{lease_id}_file-upload__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration lease_id: type: string description: The Propexo unique identifier for the lease attachments: type: array items: type: object properties: title: type: string maxLength: 255 description: A title for the file file_type_id: type: string description: The Propexo unique identifier for the file type file_data: type: - string - "null" maxLength: 27892121 description: The contents of the file, as a base64 encoded string. The PMS has a max file size of 20 MB. file_name: type: string description: 'The name of the file including the extension. Ex: "resume.pdf"' mime_type: type: string description: 'The mime type of the file. Ex: "application/pdf"' required: - title - file_type_id - file_name - mime_type required: - integration_id - lease_id - attachments required: - meta - result _v1_leases_entrata_{lease_id}_file-upload__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration attachments: type: array items: type: object properties: file_data: type: string maxLength: 69730304 description: The contents of the file, as a base64 encoded string. The PMS has a max file size of 50 MB. file_name: type: string description: 'The name of the file including the extension. Ex: "image.jpg"' mime_type: type: string description: 'The mime type of the file. Ex: "image/jpeg"' file_type_id: type: string description: The Propexo file type ID of the file type to upload is_private: type: boolean description: If the file should be marked as private. If true the file will not be shown in the resident portal. required: - file_data - file_name - mime_type - file_type_id description: Files to upload for the lease. All the files can have a maximum combined file size of 50 MB required: - integration_id - attachments _v1_leases_entrata_{lease_id}_file-upload__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration lease_id: type: string description: The Propexo unique identifier for the lease attachments: type: array items: type: object properties: file_data: type: - string - "null" maxLength: 69730304 description: The contents of the file, as a base64 encoded string. The PMS has a max file size of 50 MB. file_name: type: string description: 'The name of the file including the extension. Ex: "image.jpg"' mime_type: type: string description: 'The mime type of the file. Ex: "image/jpeg"' file_type_id: type: string description: The Propexo file type ID of the file type to upload is_private: type: boolean required: - file_name - mime_type - file_type_id required: - integration_id - lease_id - attachments required: - meta - result _v1_leases_rentmanager_{lease_id}_file-upload__post_input: type: object properties: {} _v1_leases_rentmanager_{lease_id}_file-upload__post_output: type: object properties: {} _v1_leases_rentvine_{lease_id}_file-upload__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration attachment: type: object properties: file_data: type: string maxLength: 69730304 description: The contents of the file, as a base64 encoded string. We limit the file upload size to 50 MB. file_name: type: string description: 'The name of the file including the extension. Ex: "resume.pdf"' mime_type: type: string description: 'The mime type of the file. Ex: "application/pdf"' required: - file_data - file_name - mime_type description: The file data for the document upload required: - integration_id - attachment _v1_leases_rentvine_{lease_id}_file-upload__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration lease_id: type: string description: The Propexo unique identifier for the lease attachment: type: object properties: file_data: type: - string - "null" maxLength: 69730304 description: The contents of the file, as a base64 encoded string. We limit the file upload size to 50 MB. file_name: type: string description: 'The name of the file including the extension. Ex: "resume.pdf"' mime_type: type: string description: 'The mime type of the file. Ex: "application/pdf"' required: - file_name - mime_type required: - integration_id - lease_id - attachment required: - meta - result _v1_leases_yardi_{lease_id}_file-upload__post_input: type: object properties: {} _v1_leases_yardi_{lease_id}_file-upload__post_output: type: object properties: {} _v1_leases_propertyware_{lease_id}_file-upload__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration attachment: type: object properties: file_data: type: string maxLength: 16735272 description: The contents of the file, as a base64 encoded string. The PMS has a max file size of 12 MB. file_name: type: string description: 'The name of the file including the extension. Ex: "resume.pdf"' mime_type: type: string description: 'The mime type of the file. Ex: "application/pdf"' required: - file_data - file_name - mime_type description: Attachment file on the lease notes: type: string description: General notes about the file is_private: type: boolean description: If the file should be marked as private required: - integration_id - attachment _v1_leases_propertyware_{lease_id}_file-upload__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration lease_id: type: string description: The Propexo unique identifier for the lease attachment: type: object properties: file_data: type: - string - "null" maxLength: 16735272 description: The contents of the file, as a base64 encoded string. The PMS has a max file size of 12 MB. file_name: type: string description: 'The name of the file including the extension. Ex: "resume.pdf"' mime_type: type: string description: 'The mime type of the file. Ex: "application/pdf"' required: - file_name - mime_type notes: type: - string - "null" is_private: type: - boolean - "null" required: - integration_id - lease_id - attachment - notes - is_private required: - meta - result _v1_leases_propertyware_rest_{lease_id}_file-upload__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration attachment: type: object properties: file_data: type: string maxLength: 66500000 file_name: type: string description: 'The name of the file. Ex: "resume.pdf"' mime_type: type: string pattern: ^[a-zA-Z0-9][a-zA-Z0-9!#$&^_+-]{0,126}\/[a-zA-Z0-9][a-zA-Z0-9!#$&^_+-]{0,126}$ description: 'The mime type of the file. Ex: "application/pdf"' description: type: string description: A description of the file being uploaded required: - file_data - file_name - mime_type description: The file to attach to the lease required: - integration_id - attachment _v1_leases_propertyware_rest_{lease_id}_file-upload__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration lease_id: type: string description: The Propexo unique identifier for the lease attachment: type: object properties: file_data: type: - string - "null" maxLength: 66500000 file_name: type: string description: 'The name of the file. Ex: "resume.pdf"' mime_type: type: string pattern: ^[a-zA-Z0-9][a-zA-Z0-9!#$&^_+-]{0,126}\/[a-zA-Z0-9][a-zA-Z0-9!#$&^_+-]{0,126}$ description: 'The mime type of the file. Ex: "application/pdf"' description: type: string required: - file_name - mime_type required: - integration_id - lease_id - attachment required: - meta - result Enum4: type: string enum: &a290 - APPFOLIO - BUILDIUM - ENTRATA - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The integration vendor for the listing. _v1_listings__get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query x_id: type: string description: The external listing id location_id: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. unit_id: type: string description: The Propexo unique identifier for the unit property_id: type: string description: The Propexo unique identifier for the property integration_id: type: string description: The Propexo integration id integration_vendor: $ref: "#/components/schemas/Enum4" Listing: type: object properties: id: type: string description: The Propexo unique identifier for the listing created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_unit_id: type: - string - "null" description: The external ID of the unit from the integration vendor x_floor_plan_id: type: - string - "null" description: The external ID of the floor plan from the integration vendor is_unit: type: boolean description: True if the listing is for a unit, false if it is not associated with a specific unit available_date: type: - string - "null" description: The date the listing is available application_url: type: - string - "null" description: The application URL for the listing bathrooms: type: - string - "null" description: The number of bathrooms associated with the listing bathrooms_full: type: &a323 - number - "null" description: The number of full bathrooms associated with the listing bathrooms_half: type: &a324 - number - "null" description: The number of half bathrooms associated with the listing bedrooms: type: - string - "null" description: The number of bedrooms associated with the listing building_name: type: - string - "null" description: The building name associated with the listing building_number: type: - string - "null" description: The building number associated with the listing city: type: - string - "null" description: The city associated with the listing country: type: - string - "null" description: The country associated with the listing custom_data: type: - object - "null" properties: {} deposit_amount_in_cents: type: &a325 - number - "null" description: The deposit amount in cents associated with the listing example: 100000 floor_plan_code: type: - string - "null" description: The external ID of the floor plan associated with the listing floor_plan_name: type: - string - "null" description: The floor plan name associated with the listing floor: type: - string - "null" description: The floor number/name associated with the listing image_urls: type: array items: type: string is_available: type: - boolean - "null" description: Whether the listing is available is_furnished: type: - boolean - "null" description: Whether the listing is furnished is_listed: type: - boolean - "null" description: Whether the listing is listed is_managed_external: type: - boolean - "null" description: Whether the listing is managed externally is_vacant: type: - boolean - "null" description: Whether the listing is vacant lease_term: type: - string - "null" description: The term of the lease listing_title: type: - string - "null" description: The title used for the marketing listing listing_date: type: - string - "null" description: The date the listing was created marketing_name: type: - string - "null" description: The marketing name of the unit being listed notes: type: - string - "null" description: Notes associated with the listing number: type: - string - "null" description: The unit number rent_amount_in_cents: type: &a326 - number - "null" description: The rent amount in cents for the listing example: 100000 specials: type: - string - "null" description: Marketing specials or promotions for the listing square_feet: type: - integer - "null" minimum: 0 description: The square footage of the listing state: type: - string - "null" description: The state associated with the listing street_address_1: type: - string - "null" description: "Deprecated: Use address_1" deprecated: true x-fern-availability: deprecated street_address_2: type: - string - "null" description: "Deprecated: Use address_2" deprecated: true x-fern-availability: deprecated address_1: type: - string - "null" description: The first address line associated with the listing x-propexo: &a327 derivedFromField: street_address_1 address_2: type: - string - "null" description: The second address line associated with the listing x-propexo: &a328 derivedFromField: street_address_1 property_description: type: - string - "null" description: Description of the property short_description: type: - string - "null" description: A short description of the listing unit_description: type: - string - "null" description: Description of the unit zip: type: - string - "null" description: The zip code associated with the listing make_ready_date: type: - string - "null" description: The make ready date of the listing vacate_date: type: - string - "null" description: The vacate date of the listing video_urls: type: - array - "null" items: type: string status_raw: type: - string - "null" description: The raw status associated with the listing property_id: type: string description: The Propexo unique identifier for the property unit_id: type: - string - "null" description: The Propexo unique identifier for the unit floor_plan_id: type: - string - "null" description: The Propexo unique identifier for the floor plan integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. unit_type_id: type: - string - "null" description: The Propexo unique identifier for the unit type required: - id - created_at - updated_at - last_seen - x_id - x_property_id - x_unit_id - x_floor_plan_id - is_unit - available_date - application_url - bathrooms - bathrooms_full - bathrooms_half - bedrooms - building_name - building_number - city - country - custom_data - deposit_amount_in_cents - floor_plan_code - floor_plan_name - floor - image_urls - is_available - is_furnished - is_listed - is_managed_external - is_vacant - lease_term - listing_title - listing_date - marketing_name - notes - number - rent_amount_in_cents - specials - square_feet - state - street_address_1 - street_address_2 - address_1 - address_2 - property_description - short_description - unit_description - zip - make_ready_date - vacate_date - video_urls - status_raw - property_id - unit_id - floor_plan_id - integration_id - integration_vendor - x_location_id - unit_type_id _v1_listings__get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: type: array items: $ref: "#/components/schemas/Listing" required: - meta - results _v1_listings__post_input: type: object properties: unit_id: type: string description: The Propexo unit id rent_amount_in_cents: type: integer minimum: 0 description: The rent amount in cents deposit_amount_in_cents: type: integer minimum: 0 description: The deposit amount in cents lease_terms: type: string description: The lease terms available_date: type: string description: The available date contact_id: type: string description: The Propexo contact id is_managed_external: type: boolean description: Whether the listing is managed externally custom_data: type: object properties: {} description: "Deprecated: Field is no longer applicable" deprecated: true required: - unit_id - rent_amount_in_cents - deposit_amount_in_cents - available_date - contact_id - is_managed_external _v1_listings__post_output: type: object properties: job_id: type: string description: The ID of the job created to handle this operation data: type: object properties: {} required: - job_id - data _v1_listings_pricing_get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query x_id: type: string description: The external listing id location_id: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. listing_id: type: string description: The Propexo unique identifier for the listing property_id: type: string description: The Propexo unique identifier for the property integration_id: type: string description: The Propexo integration id integration_vendor: $ref: "#/components/schemas/Enum4" _v1_listings_pricing_get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: type: array items: type: object properties: id: type: string description: The Propexo unique identifier for the listing created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_listing_id: type: - string - "null" description: The external ID of the listing from the integration vendor base_rent_in_cents: type: - number - "null" description: The base rent cost of the listing, in cents example: 100000 concession_in_cents: type: - number - "null" description: The amount of the concession for the listing, in cents example: 100000 effective_rent_in_cents: type: - number - "null" description: The amount of the effective rent for the listing, in cents example: 100000 start_date: type: - string - "null" description: The start date associated with the unit price end_date: type: - string - "null" description: The end date associated with the unit price available_date: type: - string - "null" description: The start date of the availability to query lease_term_in_months: type: - integer - "null" description: The amount of months for the lease term custom_data: type: - object - "null" properties: {} property_id: type: string description: The Propexo unique identifier for the property listing_id: type: - string - "null" description: The Propexo unique identifier for the listing integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" required: - id - created_at - updated_at - last_seen - x_id - x_property_id - x_listing_id - base_rent_in_cents - concession_in_cents - effective_rent_in_cents - start_date - end_date - available_date - lease_term_in_months - custom_data - property_id - listing_id - integration_id - integration_vendor x-propexo: derivedFromModel: unit_pricing required: - meta - results _v1_listings_{listing_id}_get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query _v1_listings_{listing_id}_get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: $ref: "#/components/schemas/Listing" required: - meta - results _v1_listings_{listing_id}_put_input: type: object properties: available_date: type: string format: date-time description: The date the unit is available. bathrooms: type: string description: The number of bathrooms in the unit bedrooms: type: string description: The number of bedrooms in the unit building_name: type: string description: The name of the building city: type: string description: The city associated with the listing country: type: string description: The country associated with the listing deposit_amount_in_cents: type: integer description: The deposit amount in cents floor: type: string description: The floor the unit is on is_available: type: boolean description: Whether the unit is available for rent is_vacant: type: boolean description: Whether the unit is vacant lease_term: type: string description: The lease term notes: type: string description: Additional notes about the unit rent_amount_in_cents: type: integer description: The rent amount in cents state: type: string description: The state associated with the listing street_address_1: type: string description: The first address line associated with the listing street_address_2: type: string description: The second address line associated with the listing zip: type: string description: The zip code associated with the listing _v1_listings_{listing_id}_put_output: type: object properties: job_id: type: string description: The ID of the job created to handle this operation data: type: object properties: {} required: - job_id - data _v1_listings_yardi_{listing_id}_put_input: type: object properties: {} _v1_listings_yardi_{listing_id}_put_output: type: object properties: {} _v1_listings_yardi__post_input: type: object properties: {} _v1_listings_yardi__post_output: type: object properties: {} _v1_listings_realpage_rpx_{listing_id}_put_input: type: object properties: {} _v1_listings_realpage_rpx_{listing_id}_put_output: type: object properties: {} _v1_listings_realpage_rpx__post_input: type: object properties: {} _v1_listings_realpage_rpx__post_output: type: object properties: {} _v1_listings_entrata_{listing_id}_put_input: type: object properties: {} _v1_listings_entrata_{listing_id}_put_output: type: object properties: {} _v1_listings_entrata__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration property_id: type: string description: The Propexo unique identifier for the property lease_period_id: type: string description: The Propexo unique identifier for the lease period floor_plan_id: type: string description: The Propexo unique identifier for the floor plan unit_type_id: type: string description: The Propexo unique identifier for the unit type amenity_ids: type: array items: type: string default: &a203 [] description: The Propexo unique identifier for the amenity bathrooms: type: integer description: The number of bathrooms associated with the listing bedrooms: type: integer description: The number of bedrooms associated with the listing city: type: string description: The city associated with the listing country: type: string description: The country associated with the listing date_available: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date that the listing becomes available is_furnished: type: boolean description: Whether the listing is furnished number: type: string description: The unit number square_feet: type: number description: The square footage of the listing state: type: string description: The state associated with the listing street_address_1: type: string description: The first address line associated with the listing street_address_2: type: string description: The second address line associated with the listing zip: type: string description: The zip code associated with the listing required: - integration_id - property_id - lease_period_id - floor_plan_id - unit_type_id - city - country - date_available - number - state - street_address_1 - zip _v1_listings_entrata__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration property_id: type: string description: The Propexo unique identifier for the property lease_period_id: type: string description: The Propexo unique identifier for the lease period floor_plan_id: type: string description: The Propexo unique identifier for the floor plan unit_type_id: type: string description: The Propexo unique identifier for the unit type amenity_ids: type: array items: type: string default: *a203 description: The Propexo unique identifier for the amenity bathrooms: type: - integer - "null" description: The number of bathrooms associated with the listing bedrooms: type: - integer - "null" description: The number of bedrooms associated with the listing city: type: string description: The city associated with the listing country: type: string description: The country associated with the listing date_available: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" is_furnished: type: - boolean - "null" description: Whether the listing is furnished number: type: string description: The unit number square_feet: type: - number - "null" description: The square footage of the listing state: type: string description: The state associated with the listing street_address_1: type: string description: The first address line associated with the listing street_address_2: type: - string - "null" description: The second address line associated with the listing zip: type: string description: The zip code associated with the listing required: - integration_id - property_id - lease_period_id - floor_plan_id - unit_type_id - bathrooms - bedrooms - city - country - date_available - is_furnished - number - square_feet - state - street_address_1 - street_address_2 - zip required: - meta - result _v1_listings_propertyware_{listing_id}_put_input: type: object properties: available_date: type: string format: date-time description: The date the unit is available. bathrooms: type: string description: The number of bathrooms in the unit bedrooms: type: string description: The number of bedrooms in the unit building_name: type: string description: The name of the building city: type: string description: The city associated with the listing country: type: string description: The country associated with the listing deposit_amount_in_cents: type: integer description: The deposit amount in cents floor: type: string description: The floor the unit is on is_available: type: boolean description: Whether the unit is available for rent is_vacant: type: boolean description: Whether the unit is vacant lease_term: type: string description: The lease term notes: type: string description: Additional notes about the unit rent_amount_in_cents: type: integer description: The rent amount in cents state: type: string description: The state associated with the listing street_address_1: type: string description: The first address line associated with the listing street_address_2: type: string description: The second address line associated with the listing zip: type: string description: The zip code associated with the listing _v1_listings_propertyware_{listing_id}_put_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: listing_id: type: string description: The Propexo unique identifier for the listing available_date: type: string format: date-time description: The date the unit is available. bathrooms: type: string description: The number of bathrooms in the unit bedrooms: type: string description: The number of bedrooms in the unit building_name: type: string description: The name of the building city: type: string description: The city associated with the listing country: type: string description: The country associated with the listing deposit_amount_in_cents: type: integer description: The deposit amount in cents floor: type: string description: The floor the unit is on is_available: type: boolean description: Whether the unit is available for rent is_vacant: type: boolean description: Whether the unit is vacant lease_term: type: string description: The lease term notes: type: string description: Additional notes about the unit rent_amount_in_cents: type: integer description: The rent amount in cents state: type: string description: The state associated with the listing street_address_1: type: string description: The first address line associated with the listing street_address_2: type: string description: The second address line associated with the listing zip: type: string description: The zip code associated with the listing required: - listing_id required: - meta - result _v1_listings_entrata_{listing_id}_file-upload__post_input: type: object properties: {} _v1_listings_entrata_{listing_id}_file-upload__post_output: type: object properties: {} Enum11: type: string enum: &a291 - APPFOLIO - BUILDIUM - ENTRATA - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The integration vendor for the location. _v1_locations_rentmanager__get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query x_id: type: string description: The external location id integration_id: type: string description: The Propexo integration id integration_vendor: $ref: "#/components/schemas/Enum11" Location: type: object properties: id: type: string description: The Propexo unique identifier for the listing created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: string description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: type: - string - "null" description: The name of the location friendly_name: type: - string - "null" description: The friendly name of the location is_main: type: - boolean - "null" description: Specifies whether or not the location is the main location is_twa_enabled: type: - boolean - "null" description: Specifies whether or not TWA is enabled is_owa_enabled: type: - boolean - "null" description: Specifies whether or not OWA is enabled is_echeck_enabled: type: - boolean - "null" description: Specifies whether or not echeck is enabled ndt_username: type: - string - "null" description: The NDT username for the location broadcast_username: type: - string - "null" description: The broadcast username for the location property_id: type: string description: The Propexo unique identifier for the property integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" required: - id - created_at - updated_at - last_seen - x_id - x_property_id - x_location_id - name - friendly_name - is_main - is_twa_enabled - is_owa_enabled - is_echeck_enabled - ndt_username - broadcast_username - property_id - integration_id - integration_vendor x-propexo: derivedFromModel: locations _v1_locations_rentmanager__get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: type: array items: $ref: "#/components/schemas/Location" required: - meta - results _v1_note-categories__get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor location_id: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. property_id: type: string description: The Propexo unique identifier for the property integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" NoteCategory: type: object properties: id: type: string description: The Propexo unique identifier for the note category created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. is_active: type: - boolean - "null" description: Whether the note category is active name: type: string description: The name associated with the note category integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" property_id: type: string description: The Propexo unique identifier for the property required: - id - created_at - updated_at - last_seen - x_id - x_property_id - x_location_id - is_active - name - integration_id - integration_vendor - property_id x-propexo: derivedFromModel: note_categories _v1_note-categories__get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: type: array items: $ref: "#/components/schemas/NoteCategory" required: - meta - results _v1_note-categories_{note_category_id}_get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query _v1_note-categories_{note_category_id}_get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: $ref: "#/components/schemas/NoteCategory" required: - meta - results _v1_owners__get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query location_id: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. property_id: type: string description: The Propexo unique identifier for the property integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" Owner: type: object properties: id: type: string description: The Propexo unique identifier for the owner created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. address_1: type: - string - "null" description: The first address line associated with the owner address_2: type: - string - "null" description: The second address line associated with the owner city: type: - string - "null" description: The city associated with the owner country: type: - string - "null" description: The country associated with the owner state: type: - string - "null" description: The state associated with the owner zip: type: - string - "null" description: The zip code associated with the owner first_name: type: - string - "null" description: The first name associated with the owner middle_name: type: - string - "null" description: The middle name associated with the owner last_name: type: - string - "null" description: The last name associated with the owner company_name: type: - string - "null" description: The name of the company associated with the owner notes: type: - string - "null" description: Notes associated with the owner email_1: type: - string - "null" description: The primary email address associated with the owner email_2: type: - string - "null" description: The secondary email address associated with the owner phone_1: type: - string - "null" description: Primary phone number associated with the owner phone_1_type: type: - string - "null" enum: - FAX - HOME - MOBILE - OTHER - WORK description: Type of the primary phone number phone_2: type: - string - "null" description: Secondary phone number associated with the owner phone_2_type: type: - string - "null" enum: - FAX - HOME - MOBILE - OTHER - WORK description: Type of the secondary phone number associated_property_ids: type: array items: type: string x-propexo: &a329 derivedFromModel: owners_to_properties derivedFromField: property_id integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" property_id: type: string description: The Propexo unique identifier for the property required: - id - created_at - updated_at - last_seen - x_id - x_property_id - x_location_id - address_1 - address_2 - city - country - state - zip - first_name - middle_name - last_name - company_name - notes - email_1 - email_2 - phone_1 - phone_1_type - phone_2 - phone_2_type - associated_property_ids - integration_id - integration_vendor - property_id x-propexo: derivedFromModel: owners _v1_owners__get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: type: array items: $ref: "#/components/schemas/Owner" required: - meta - results _v1_owners_{owner_id}_get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query _v1_owners_{owner_id}_get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: $ref: "#/components/schemas/Owner" required: - meta - results Enum5: type: string enum: &a292 - APPFOLIO - BUILDIUM - ENTRATA - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The integration vendor for the property. _v1_properties__get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query x_id: type: string description: The external property id x_property_id: type: string description: "Deprecated: Use x_id instead" deprecated: true location_id: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. integration_id: type: string description: The Propexo integration id integration_vendor: $ref: "#/components/schemas/Enum5" is_active: anyOf: - type: boolean - type: string - type: "null" description: Active status of the property in the PMS. Please note this is a separate value to the property's status in Propexo which can be fetched using the 'Get all my property configurations' endpoint. PetTypes: type: object properties: name: type: string description: The name associated with the pet type is_allowed: type: - boolean - "null" description: Whether the pet type is allowed or not description: type: - string - "null" description: Description of the pet type notes: type: - string - "null" description: Notes associated with the pet type deposit_raw: type: - string - "null" description: The deposit amount associated with the pet type deposit_in_cents: type: - number - "null" description: The deposit amount in cents associated with the pet type example: 100000 fee_raw: type: - string - "null" description: The raw fee amount for the pet type fee_in_cents: type: - number - "null" description: The fee amount in cents for the pet type example: 100000 fee_min_raw: type: - string - "null" description: The minimum raw fee amount for the pet type fee_min_in_cents: type: - number - "null" description: The minimum fee amount in cents for the pet type example: 100000 fee_max_raw: type: - string - "null" description: The maxmimum raw fee amount for the pet type fee_max_in_cents: type: - number - "null" description: The maxmimum raw fee amount in cents for the pet type example: 100000 rent_amount_raw: type: - string - "null" description: The raw rent amount for the pet type rent_amount_in_cents: type: - number - "null" description: The rent amount in cents for the pet type example: 100000 required: - name - is_allowed - description - notes - deposit_raw - deposit_in_cents - fee_raw - fee_in_cents - fee_min_raw - fee_min_in_cents - fee_max_raw - fee_max_in_cents - rent_amount_raw - rent_amount_in_cents x-propexo: derivedFromModel: pet_types Property: type: object properties: id: type: string description: The Propexo unique identifier for the property property_id: type: string description: The Propexo unique identifier for the property created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_created_at: type: - string - "null" description: The date the record first entered the integration vendor x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_building_id: type: - string - "null" description: The external ID of the building (not necessarily the property) from the integration vendor building_number: type: - string - "null" description: The building number associated with the property city: type: - string - "null" description: The city associated with the property code: type: - string - "null" description: The code associated with the property country: type: - string - "null" description: The country associated with the property county: type: - string - "null" description: The county associated with the property custom_data: type: - object - "null" properties: {} is_active: type: - boolean - "null" description: Whether the property is active. This reflects whether the property is active in the PMS. To see if a property is enabled in Propexo, please use the 'Get all my property configurations' endpoint. manager_email: type: - string - "null" description: The email address of the property manager manager_name: type: - string - "null" description: The name of the property manager manager_phone_1: type: - string - "null" description: The first phone number of the property manager manager_phone_1_type: type: - string - "null" enum: - FAX - HOME - MOBILE - OTHER - WORK description: The type of the first phone number of the property manager manager_phone_2: type: - string - "null" description: The second phone number of the property manager manager_phone_2_type: type: - string - "null" enum: - FAX - HOME - MOBILE - OTHER - WORK description: The type of the second phone number of the property manager name: type: - string - "null" description: The name of the property notes: type: - string - "null" description: Notes associated with the property number_of_units: type: - integer - "null" minimum: 0 description: The number of units in the property square_footage: type: - integer - "null" description: "Deprecated: Use square_feet" deprecated: true x-fern-availability: deprecated square_feet: type: - integer - "null" description: The square footage of the property state: type: - string - "null" description: The state associated with the property street_address_1: type: - string - "null" description: "Deprecated: Use address_1" deprecated: true x-fern-availability: deprecated street_address_2: type: - string - "null" description: "Deprecated: Use address_2" deprecated: true x-fern-availability: deprecated address_1: type: - string - "null" description: The first address line associated with the property x-propexo: &a338 derivedFromField: street_address_1 address_2: type: - string - "null" description: The second address line associated with the property x-propexo: &a339 derivedFromField: street_address_2 type: type: - string - "null" description: "Deprecated: Use type_raw." deprecated: true x-fern-availability: deprecated type_raw: type: - string - "null" description: The raw PMS type of the property type_normalized: anyOf: - type: string enum: - SINGLE_FAMILY - MULTI_FAMILY - STUDENT_HOUSING - VACATION - COMMERCIAL - OTHER - type: string - type: "null" description: The Propexo normalized property type website: type: - string - "null" description: The website URL associated with the property year_built: type: - integer - "null" minimum: 0 description: The year the property was built zip: type: - string - "null" description: The zip code associated with the property long_description: type: - string - "null" description: A long description of the property short_description: type: - string - "null" description: A short description of the property office_hours: type: array items: type: object properties: day_of_week: type: string enum: - SUNDAY - MONDAY - TUESDAY - WEDNESDAY - THURSDAY - FRIDAY - SATURDAY description: The day of the week associated with the office hours open_time: type: string description: The opening time for the office close_time: type: string description: The closing time for the office required: - day_of_week - open_time - close_time pet_types: type: array items: $ref: "#/components/schemas/PetTypes" associated_owner_ids: type: array items: type: string x-propexo: &a340 derivedFromModel: owners_to_properties derivedFromField: owner_id integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" required: - id - property_id - created_at - updated_at - last_seen - x_created_at - x_id - x_property_id - x_building_id - building_number - city - code - country - county - custom_data - is_active - manager_email - manager_name - manager_phone_1 - manager_phone_1_type - manager_phone_2 - manager_phone_2_type - name - notes - number_of_units - square_footage - square_feet - state - street_address_1 - street_address_2 - address_1 - address_2 - type - type_raw - type_normalized - website - year_built - zip - long_description - short_description - office_hours - pet_types - associated_owner_ids - integration_id - integration_vendor x-propexo: derivedFromModel: properties _v1_properties__get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: type: array items: $ref: "#/components/schemas/Property" required: - meta - results _v1_properties__post_input: type: object properties: integration_id: type: string x_portfolio_id: type: string description: The ID of the portfolio to create the property under in the PMS. abbreviation: type: string description: "The abbreviation of the property. Example: PROP1" name: type: string description: "The name of the property. Example: Property 1" square_footage: type: string description: The size of the property in square feet address_1: type: string description: The first address line associated with the property address_2: type: string description: The second address line associated with the property zip: type: string description: The zip code associated with the property city: type: string description: The city associated with the property county: type: string description: The county associated with the property state: type: string description: The state associated with the property country: type: string description: The country associated with the property website: type: string description: The website URL associated with the property is_active: type: string description: Whether or not the property is currently active notes: type: string description: General notes about the property year_built: type: integer description: The year the property was built category: type: string enum: &a207 - Residential - Commercial description: The category of the property. This is from a limited set of data that the PMS requires. type: type: string enum: &a204 - Apartment - Condo - Commercial - Du/Fourplex - House - Section 8/Affordable - Senior - Short-term/vacation - Student - Townhouse - Other description: The type of the property. This is from a limited set of data that the PMS requires. required: - integration_id _v1_properties__post_output: type: object properties: job_id: type: string description: The ID of the job created to handle this operation data: type: object properties: {} required: - job_id - data _v1_properties_{id}_get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query _v1_properties_{id}_get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: $ref: "#/components/schemas/Property" required: - meta - results _v1_properties_{id}_put_input: type: object properties: integration_id: type: string property_id: type: string description: The Propexo unique identifier for the property abbreviation: type: string description: "The abbreviation of the property. Example: PROP1" name: type: string description: The name associated with the property street_address_1: type: string description: The first address line associated with the property street_address_2: type: string description: The second address line associated with the property zip: type: string description: The zip code associated with the property city: type: string description: The city associated with the property county: type: string description: The county associated with the property state: type: string description: The state associated with the property country: type: string description: The country associated with the property website: type: string description: The website URL associated with the property square_footage: type: string description: The size of the property in square feet is_active: type: boolean description: Whether the property is active notes: type: string description: Notes associated with the property year_built: type: integer description: The year the property was built category: type: string enum: &a206 - Residential - Commercial description: The category of the property. This is from a limited set of data that the PMS requires. type: type: string enum: *a204 description: The type of the property. This is from a limited set of data that the PMS requires. short_description: type: string description: A short description of the property manager_name: type: string description: The name of the property manager manager_email: type: string description: The email address of the property manager square_feet: type: string description: The square footage of the property required: - integration_id _v1_properties_{id}_put_output: type: object properties: job_id: type: string description: The ID of the job created to handle this operation data: type: object properties: {} required: - job_id - data _v1_rentable-items__get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query x_id: type: string description: The external ID from the integration vendor location_id: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. property_id: type: string description: The Propexo unique identifier for the property integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" _v1_rentable-items__get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: type: array items: $ref: "#/components/schemas/RentableItem" required: - meta - results _v1_rentable-items_{rentable_item_id}_get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query _v1_rentable-items_{rentable_item_id}_get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: $ref: "#/components/schemas/RentableItem" required: - meta - results _v1_property-lists__get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query location_id: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. associated_property_id: type: string description: "The Propexo unique identifier for the property. Note: This will filter for results only containing property lists that are associated with this property id" integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" _v1_property-lists__get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: type: array items: type: object properties: id: type: string description: The Propexo unique identifier for the property list created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: type: - string - "null" description: The name associated with the property list associated_property_ids: type: - array - "null" items: type: string integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" property_id: type: string description: The Propexo unique identifier for the property required: - id - created_at - updated_at - last_seen - x_id - x_property_id - x_location_id - name - associated_property_ids - integration_id - integration_vendor - property_id x-propexo: &a205 derivedFromModel: property_lists required: - meta - results _v1_property-lists_{property_list_id}_get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query _v1_property-lists_{property_list_id}_get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: type: object properties: id: type: string description: The Propexo unique identifier for the property list created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: type: - string - "null" description: The name associated with the property list associated_property_ids: type: - array - "null" items: type: string integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" property_id: type: string description: The Propexo unique identifier for the property required: - id - created_at - updated_at - last_seen - x_id - x_property_id - x_location_id - name - associated_property_ids - integration_id - integration_vendor - property_id x-propexo: *a205 required: - meta - results _v1_address-types__get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query x_id: type: string description: The external ID from the integration vendor location_id: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. property_id: type: string description: The Propexo unique identifier for the property integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" AddressType: type: object properties: id: type: string description: The Propexo unique identifier for the address type created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: string description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: type: string description: The name associated with the address type description: type: - string - "null" description: Description of the address type integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" property_id: type: string description: The Propexo unique identifier for the property required: - id - created_at - updated_at - last_seen - x_id - x_property_id - x_location_id - name - description - integration_id - integration_vendor - property_id x-propexo: derivedFromModel: address_types _v1_address-types__get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: type: array items: $ref: "#/components/schemas/AddressType" required: - meta - results _v1_address-types_{address_type_id}_get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query _v1_address-types_{address_type_id}_get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: $ref: "#/components/schemas/AddressType" required: - meta - results _v1_properties_entrata__post_input: type: object properties: {} _v1_properties_entrata__post_output: type: object properties: {} _v1_properties_entrata_{property_id}_put_input: type: object properties: {} _v1_properties_entrata_{property_id}_put_output: type: object properties: {} _v1_properties_realpage__post_input: type: object properties: {} _v1_properties_realpage__post_output: type: object properties: {} _v1_properties_realpage_{property_id}_put_input: type: object properties: {} _v1_properties_realpage_{property_id}_put_output: type: object properties: {} _v1_properties_realpage_rpx__post_input: type: object properties: {} _v1_properties_realpage_rpx__post_output: type: object properties: {} _v1_properties_realpage_rpx_{property_id}_put_input: type: object properties: {} _v1_properties_realpage_rpx_{property_id}_put_output: type: object properties: {} _v1_properties_yardi_{id}_put_input: type: object properties: {} _v1_properties_yardi_{id}_put_output: type: object properties: {} _v1_properties_yardi__post_input: type: object properties: {} _v1_properties_yardi__post_output: type: object properties: {} _v1_properties_propertyware_{property_id}_put_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration abbreviation: type: string description: "The abbreviation of the property. Example: PROP1" name: type: string description: "The name of the property. Example: Property 1" street_address_1: type: string description: The first address line associated with the property street_address_2: type: string description: The second address line associated with the property zip: type: string description: The zip code associated with the property city: type: string description: The city associated with the property county: type: string description: The county associated with the property state: type: string description: The state associated with the property country: type: string description: The country associated with the property website: type: string description: The website URL associated with the property square_footage: type: string description: The size of the property in square feet is_active: type: string description: Whether or not the property is currently active notes: type: string description: General notes about the property year_built: type: integer description: The year the property was built category: type: string enum: *a206 description: The category of the property. This is from a limited set of data that the PMS requires. type: type: string enum: *a204 description: The type of the property. This is from a limited set of data that the PMS requires. required: - integration_id - abbreviation - name - street_address_1 - category - type _v1_properties_propertyware_{property_id}_put_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration property_id: type: string description: The Propexo unique identifier for the property abbreviation: type: string description: "The abbreviation of the property. Example: PROP1" name: type: string description: "The name of the property. Example: Property 1" street_address_1: type: string description: The first address line associated with the property street_address_2: type: string description: The second address line associated with the property zip: type: string description: The zip code associated with the property city: type: string description: The city associated with the property county: type: string description: The county associated with the property state: type: string description: The state associated with the property country: type: string description: The country associated with the property website: type: string description: The website URL associated with the property square_footage: type: string description: The size of the property in square feet is_active: type: string description: Whether or not the property is currently active notes: type: string description: General notes about the property year_built: type: integer description: The year the property was built category: type: string enum: *a206 description: The category of the property. This is from a limited set of data that the PMS requires. type: type: string enum: *a204 description: The type of the property. This is from a limited set of data that the PMS requires. required: - integration_id - property_id - abbreviation - name - street_address_1 - category - type required: - meta - result _v1_properties_propertyware__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration x_portfolio_id: type: string description: The ID of the portfolio to create the property under in the PMS. abbreviation: type: string description: "The abbreviation of the property. Example: PROP1" name: type: string description: "The name of the property. Example: Property 1" square_footage: type: string description: The size of the property in square feet address_1: type: string description: The first address line associated with the property address_2: type: string description: The second address line associated with the property zip: type: string description: The zip code associated with the property city: type: string description: The city associated with the property county: type: string description: The county associated with the property state: type: string description: The state associated with the property country: type: string description: The country associated with the property website: type: string description: The website URL associated with the property is_active: type: string description: Whether or not the property is currently active notes: type: string description: General notes about the property year_built: type: integer description: The year the property was built category: type: string enum: *a207 description: The category of the property. This is from a limited set of data that the PMS requires. type: type: string enum: *a204 description: The type of the property. This is from a limited set of data that the PMS requires. required: - integration_id - x_portfolio_id - abbreviation - name - square_footage - address_1 - category - type _v1_properties_propertyware__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration x_portfolio_id: type: string description: The ID of the portfolio to create the property under in the PMS. abbreviation: type: string description: "The abbreviation of the property. Example: PROP1" name: type: string description: "The name of the property. Example: Property 1" square_footage: type: string description: The size of the property in square feet address_1: type: string description: The first address line associated with the property address_2: type: - string - "null" description: The second address line associated with the property zip: type: - string - "null" description: The zip code associated with the property city: type: - string - "null" description: The city associated with the property county: type: - string - "null" description: The county associated with the property state: type: - string - "null" description: The state associated with the property country: type: - string - "null" description: The country associated with the property website: type: - string - "null" description: The website URL associated with the property is_active: type: - string - "null" description: Whether or not the property is currently active notes: type: - string - "null" description: General notes about the property year_built: type: - integer - "null" description: The year the property was built category: type: string enum: *a207 description: The category of the property. This is from a limited set of data that the PMS requires. type: type: string enum: *a204 description: The type of the property. This is from a limited set of data that the PMS requires. required: - integration_id - x_portfolio_id - abbreviation - name - square_footage - address_1 - address_2 - zip - city - county - state - country - website - is_active - notes - year_built - category - type required: - meta - result _v1_properties_rentmanager__post_input: type: object properties: {} _v1_properties_rentmanager__post_output: type: object properties: {} _v1_properties_rentmanager_{property_id}_put_input: type: object properties: name: type: string description: The name associated with the property short_description: type: string description: A short description of the property manager_name: type: string description: The name of the property manager is_active: type: boolean description: Whether the property is active manager_email: type: string description: The email address of the property manager notes: type: string description: Notes associated with the property square_feet: type: string description: The square footage of the property required: - short_description _v1_properties_rentmanager_{property_id}_put_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: property_id: type: string description: The Propexo unique identifier for the property name: type: string description: The name associated with the property short_description: type: string description: A short description of the property manager_name: type: string description: The name of the property manager is_active: type: boolean description: Whether the property is active manager_email: type: string description: The email address of the property manager notes: type: string description: Notes associated with the property square_feet: type: string description: The square footage of the property required: - property_id - short_description required: - meta - result _v1_site-subscriptions_realpage_rpx_{property_id}_put_input: type: object properties: status: type: string enum: - ACTIVE - PENDING - CANCELED - DENIED description: Activates, disables, cancels, or sets a property to pending in RealPage required: - status _v1_site-subscriptions_realpage_rpx_{property_id}_put_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: property_id: type: string description: The Propexo unique identifier for the property status: type: string enum: - ACTIVE - PENDING - CANCELED - DENIED description: Activates, disables, cancels, or sets a property to pending in RealPage required: - property_id - status required: - meta - result _v1_properties_rentvine_{property_id}_custom-data_put_input: type: object properties: custom_data: type: object additionalProperties: anyOf: - {} - type: object properties: value: type: string required: - value - type: "null" description: |- A mapping of the fields you want to update and the associated values. The key for each field is the key from the normalized custom data object, not the label of the custom field. Each entry will look something like: ``` "eyJjYXRlZ29yeUlkIjoiMSIsImZpZWxkSWQiOiIxIiwidmVyc2lvbiI6MX0=": { "value": "Yes" } ``` required: - custom_data _v1_properties_rentvine_{property_id}_custom-data_put_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: property_id: type: string description: The Propexo unique identifier for the property custom_data: type: object additionalProperties: anyOf: - {} - type: object properties: value: type: string required: - value - type: "null" description: |- A mapping of the fields you want to update and the associated values. The key for each field is the key from the normalized custom data object, not the label of the custom field. Each entry will look something like: ``` "eyJjYXRlZ29yeUlkIjoiMSIsImZpZWxkSWQiOiIxIiwidmVyc2lvbiI6MX0=": { "value": "Yes" } ``` required: - property_id - custom_data required: - meta - result _v1_properties_propertyware_rest_{property_id}_custom-data_put_input: type: object properties: custom_data: type: object additionalProperties: anyOf: - {} - type: object properties: value: type: string required: - value - type: "null" description: A mapping of the fields you want to update and the associated values required: - custom_data _v1_properties_propertyware_rest_{property_id}_custom-data_put_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: property_id: type: string description: The Propexo unique identifier for the property custom_data: type: object additionalProperties: anyOf: - {} - type: object properties: value: type: string required: - value - type: "null" description: A mapping of the fields you want to update and the associated values required: - property_id - custom_data required: - meta - result _v1_properties_rentmanager_{property_id}_custom-data_post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration custom_data: type: object description: A mapping of the fields you want to update and the associated values. Rent Manager has a limit of 10 key/value pairs additionalProperties: *a202 required: - integration_id - custom_data _v1_properties_rentmanager_{property_id}_custom-data_post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration property_id: type: string description: The Propexo unique identifier for the property custom_data: type: object additionalProperties: *a202 required: - integration_id - property_id - custom_data required: - meta - result _v1_properties_rentmanager_{property_id}_custom-data_put_input: type: object properties: custom_data: type: object description: A mapping of the fields you want to update and the associated values. Rent Manager has a limit of 10 key/value pairs additionalProperties: *a202 required: - custom_data _v1_properties_rentmanager_{property_id}_custom-data_put_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: property_id: type: string description: The Propexo unique identifier for the property custom_data: type: object description: A mapping of the fields you want to update and the associated values. Rent Manager has a limit of 10 key/value pairs additionalProperties: *a202 required: - property_id - custom_data required: - meta - result _v1_properties_buildium_{property_id}_file-upload__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration attachments: type: array items: type: object properties: title: type: string maxLength: 255 description: A title for the file file_type_id: type: string description: The Propexo unique identifier for the file type file_data: type: string maxLength: 27892121 description: The contents of the file, as a base64 encoded string. The PMS has a max file size of 20 MB. file_name: type: string description: 'The name of the file including the extension. Ex: "resume.pdf"' mime_type: type: string description: 'The mime type of the file. Ex: "application/pdf"' required: - title - file_type_id - file_data - file_name - mime_type minItems: 1 description: Files w/ metadata for the property. All the files can have a maximum combined file size of 50 MB required: - integration_id - attachments _v1_properties_buildium_{property_id}_file-upload__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration property_id: type: string description: The Propexo unique identifier for the property attachments: type: array items: type: object properties: title: type: string maxLength: 255 description: A title for the file file_type_id: type: string description: The Propexo unique identifier for the file type file_data: type: - string - "null" maxLength: 27892121 description: The contents of the file, as a base64 encoded string. The PMS has a max file size of 20 MB. file_name: type: string description: 'The name of the file including the extension. Ex: "resume.pdf"' mime_type: type: string description: 'The mime type of the file. Ex: "application/pdf"' required: - title - file_type_id - file_name - mime_type required: - integration_id - property_id - attachments required: - meta - result _v1_properties_entrata_{property_id}_file-upload__post_input: type: object properties: {} _v1_properties_entrata_{property_id}_file-upload__post_output: type: object properties: {} _v1_properties_rentvine_{property_id}_file-upload__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration attachment: type: object properties: file_data: type: string maxLength: 69730304 description: The contents of the file, as a base64 encoded string. We limit the file upload size to 50 MB. file_name: type: string description: 'The name of the file including the extension. Ex: "resume.pdf"' mime_type: type: string description: 'The mime type of the file. Ex: "application/pdf"' required: - file_data - file_name - mime_type description: The file data for the document upload required: - integration_id - attachment _v1_properties_rentvine_{property_id}_file-upload__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration property_id: type: string description: The Propexo unique identifier for the property attachment: type: object properties: file_data: type: - string - "null" maxLength: 69730304 description: The contents of the file, as a base64 encoded string. We limit the file upload size to 50 MB. file_name: type: string description: 'The name of the file including the extension. Ex: "resume.pdf"' mime_type: type: string description: 'The mime type of the file. Ex: "application/pdf"' required: - file_name - mime_type required: - integration_id - property_id - attachment required: - meta - result _v1_properties_yardi_{id}_file-upload__post_input: type: object properties: {} _v1_properties_yardi_{id}_file-upload__post_output: type: object properties: {} _v1_properties_propertyware_{property_id}_file-upload__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration attachment: type: object properties: file_data: type: string maxLength: 16735272 description: The contents of the file, as a base64 encoded string. The PMS has a max file size of 12 MB. file_name: type: string description: 'The name of the file including the extension. Ex: "resume.pdf"' mime_type: type: string description: 'The mime type of the file. Ex: "application/pdf"' required: - file_data - file_name - mime_type description: Attachment file on the unit notes: type: string description: General notes about the file is_private: type: boolean description: If the file should be marked as private required: - integration_id - attachment _v1_properties_propertyware_{property_id}_file-upload__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration property_id: type: string description: The Propexo unique identifier for the property attachment: type: object properties: file_data: type: - string - "null" maxLength: 16735272 description: The contents of the file, as a base64 encoded string. The PMS has a max file size of 12 MB. file_name: type: string description: 'The name of the file including the extension. Ex: "resume.pdf"' mime_type: type: string description: 'The mime type of the file. Ex: "application/pdf"' required: - file_name - mime_type notes: type: - string - "null" is_private: type: - boolean - "null" required: - integration_id - property_id - attachment - notes - is_private required: - meta - result _v1_properties_rentmanager_{property_id}_file-upload__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration images: type: array items: type: object properties: file_type_id: type: string description: The Propexo unique identifier for the file type. This file_type must contain a "type" value of "image" file_type: type: string enum: &a208 - Image default: Image description: The type of file being uploaded. This defaults to "Image" file_data: type: string maxLength: 1394606 description: The contents of the file, as a base64 encoded string. The PMS has a max file size of 1 MB. file_name: type: string description: 'The name of the file including the extension. Ex: "image.jpg"' mime_type: type: string description: 'The mime type of the file. Ex: "image/jpeg"' name: type: string description: 'The name of the image. Ex: "Balcony View"' description: type: string description: 'A description of the image. Ex: "Stunning ocean view from the master bedroom balcony"' caption: type: string description: A caption for the image. Defaults to the image name if left undefined required: - file_type_id - file_data - file_name - mime_type - name - description description: Image files to upload for the property. attachments: type: array items: type: object properties: file_type_id: type: string description: The Propexo unique identifier for the file type. This file_type must contain a "type" value of "file" file_type: type: string enum: &a209 - Document default: Document description: The type of file being uploaded. This defaults to "Document" file_data: type: string maxLength: 40443576 description: The contents of the file, as a base64 encoded string. The PMS has a max file size of 29 MB. file_name: type: string description: 'The name of the file including the extension. Ex: "resume.pdf"' mime_type: type: string description: 'The mime type of the file. Ex: "application/pdf"' required: - file_type_id - file_data - file_name - mime_type description: Attachment files for user defined fields on the property. All the files can have a maximum combined file size of 50 MB required: - integration_id _v1_properties_rentmanager_{property_id}_file-upload__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration property_id: type: string description: The Propexo unique identifier for the property images: type: - array - "null" items: type: object properties: file_type_id: type: string description: The Propexo unique identifier for the file type. This file_type must contain a "type" value of "image" file_type: type: string enum: *a208 default: Image file_data: type: - string - "null" maxLength: 1394606 description: The contents of the file, as a base64 encoded string. The PMS has a max file size of 1 MB. file_name: type: string description: 'The name of the file including the extension. Ex: "image.jpg"' mime_type: type: string description: 'The mime type of the file. Ex: "image/jpeg"' name: type: string description: 'The name of the image. Ex: "Balcony View"' description: type: string description: 'A description of the image. Ex: "Stunning ocean view from the master bedroom balcony"' caption: type: string required: - file_type_id - file_name - mime_type - name - description attachments: type: - array - "null" items: type: object properties: file_type_id: type: string description: The Propexo unique identifier for the file type. This file_type must contain a "type" value of "file" file_type: type: string enum: *a209 default: Document file_data: type: - string - "null" maxLength: 40443576 description: The contents of the file, as a base64 encoded string. The PMS has a max file size of 29 MB. file_name: type: string description: 'The name of the file including the extension. Ex: "resume.pdf"' mime_type: type: string description: 'The mime type of the file. Ex: "application/pdf"' required: - file_type_id - file_name - mime_type required: - integration_id - property_id - images - attachments required: - meta - result _v1_properties_rentmanager_{property_id}_notes__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration notes: type: string description: Notes associated with the property attachment: type: object properties: file_data: type: string maxLength: 40443576 description: The contents of the file, as a base64 encoded string. The PMS has a max file size of 29 MB. file_name: type: string description: 'The name of the file including the extension. Ex: "resume.pdf"' mime_type: type: string description: 'The mime type of the file. Ex: "application/pdf"' required: - file_data - file_name - mime_type description: Attachment file for the note on the property required: - integration_id - notes _v1_properties_rentmanager_{property_id}_notes__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration property_id: type: string description: The Propexo unique identifier for the property notes: type: string description: Notes associated with the property attachment: type: - object - "null" properties: file_data: type: - string - "null" maxLength: 40443576 description: The contents of the file, as a base64 encoded string. The PMS has a max file size of 29 MB. file_name: type: string description: 'The name of the file including the extension. Ex: "resume.pdf"' mime_type: type: string description: 'The mime type of the file. Ex: "application/pdf"' required: - file_name - mime_type required: - integration_id - property_id - notes - attachment required: - meta - result _v1_purchase-orders__get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query property_id: type: string description: The Propexo unique identifier for the property integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" PurchaseOrder: type: object properties: id: type: string description: The Propexo unique identifier for the purchase order created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_invoice_id: type: - string - "null" description: The external ID of the invoice from the integration vendor x_vendor_id: type: - string - "null" description: The external ID of the vendor from the integration vendor x_parent_purchase_order_id: type: - string - "null" description: The external ID of the purchase order from the integration vendor. This field is not null if this is a change order number: type: - string - "null" description: The number of the purchase order is_closed: type: - boolean - "null" description: Whether the purchase order is closed or not description: type: - string - "null" description: Description of the purchase order total_amount_in_cents: type: &a343 - number - "null" description: The amount of the purchase order, in cents example: 100000 order_date: type: - string - "null" description: The order date for the purchase order expense_type: type: - string - "null" description: The expense type of the purchase order display_type: type: - string - "null" description: The display type of the purchase order status_raw: type: - string - "null" description: The raw status associated with the purchase order shipping_address_1: type: - string - "null" description: The first address line associated with the shipping address for the purchase order shipping_address_2: type: - string - "null" description: The second address line associated with the shipping address for the purchase order shipping_city: type: - string - "null" description: The city associated with the shipping address for the purchase order shipping_state: type: - string - "null" description: The state associated with the shipping address for the purchase order shipping_zip: type: - string - "null" description: The zip code associated with the shipping address for the purchase order shipping_country: type: - string - "null" description: The country associated with the shipping address for the purchase order billing_address_1: type: - string - "null" description: The first address line associated with the billing address for the purchase order billing_address_2: type: - string - "null" description: The second address line associated with the billing address for the purchase order billing_city: type: - string - "null" description: The city associated with the billing address for the purchase order billing_state: type: - string - "null" description: The state associated with the billing address for the purchase order billing_zip: type: - string - "null" description: The zip code associated with the billing address for the purchase order billing_country: type: - string - "null" description: The country associated with the billing address for the purchase order custom_data: type: - object - "null" properties: {} associated_invoice_ids: type: array items: type: string property_id: type: string description: The Propexo unique identifier for the property integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" invoice_id: type: - string - "null" description: The Propexo unique identifier for the invoice vendor_id: type: - string - "null" description: The Propexo unique identifier for the vendor parent_purchase_order_id: type: - string - "null" description: The Propexo unique identifier for the purchase order. This field is not null if this is a change order required: - id - created_at - updated_at - last_seen - x_id - x_property_id - x_location_id - x_invoice_id - x_vendor_id - x_parent_purchase_order_id - number - is_closed - description - total_amount_in_cents - order_date - expense_type - display_type - status_raw - shipping_address_1 - shipping_address_2 - shipping_city - shipping_state - shipping_zip - shipping_country - billing_address_1 - billing_address_2 - billing_city - billing_state - billing_zip - billing_country - custom_data - associated_invoice_ids - property_id - integration_id - integration_vendor - invoice_id - vendor_id - parent_purchase_order_id x-propexo: derivedFromModel: purchase_orders _v1_purchase-orders__get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: type: array items: $ref: "#/components/schemas/PurchaseOrder" required: - meta - results _v1_purchase-orders__post_input: type: object properties: integration_id: type: string vendor_id: type: string description: The Propexo unique identifier for the vendor vendor_location_id: type: string description: The Propexo unique identifier for the vendor location property_id: type: string description: The Propexo unique identifier for the property ap_financial_account_id: type: string description: The Propexo unique identifier for the financial account. You'll likely want to work with your customer to know what value is appropriate here. post_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The post date for the purchase order description: type: string description: Description of the purchase order shipping_amount_in_cents: type: integer description: The cost of shipping, in cents, of the purchase order discount_amount_in_cents: type: integer description: The discount, in cents, of the purchase order purchase_order_items: type: array items: anyOf: - type: object properties: property_id: type: string description: The Propexo unique identifier for the property description: type: string description: Description of the purchase order item construction_job_id: type: string description: The Propexo unique identifier for the construction job financial_account_id: type: string description: The Propexo unique identifier for the financial account stock_code: type: string description: The stock code for the purchase order item. You'll have to request this data from your customer quantity_ordered: type: string description: The quantity ordered for the purchase order item unit_price_in_cents: type: integer description: The unit price, in cents, of the purchase order item total_cost_in_cents: type: integer description: The total cost, in cents, of the purchase order item cost_code: type: string description: The cost code of the purchase order item. You'll have to request this data from your customer category_code: type: string description: The category code for the purchase order item. You'll have to request this data from your customer required: - property_id - description - construction_job_id - stock_code - quantity_ordered - unit_price_in_cents - total_cost_in_cents - cost_code - category_code description: A purchase order item that is associated with a construction job - type: object properties: property_id: type: string description: The Propexo unique identifier for the property description: type: string description: Description of the purchase order item financial_account_id: type: string description: The Propexo unique identifier for the financial account stock_code: type: string description: The stock code for the purchase order item. You'll have to request this data from your customer quantity_ordered: type: string description: The quantity ordered for the purchase order item unit_price_in_cents: type: integer description: The unit price, in cents, of the purchase order item total_cost_in_cents: type: integer description: The total cost, in cents, of the purchase order item required: - property_id - description - financial_account_id - stock_code - quantity_ordered - unit_price_in_cents - total_cost_in_cents description: A purchase order item that's not associated with a construction job minItems: 1 description: A list of the items associated with the purchase orders number: type: string maxLength: 8 description: The number of the purchase order total_amount_in_cents: type: number description: The amount of the purchase order, in cents order_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The order date for the purchase order expense_type: type: string description: The expense type of the purchase order. You'll have to request this data from your customer display_type: type: string description: The display type of the purchase order. You'll have to request this data from your customer shipping_address_1: type: string description: The first address line associated with the shipping address for the purchase order shipping_address_2: type: string description: The second address line associated with the shipping address for the purchase order shipping_city: type: string description: The city associated with the shipping address for the purchase order shipping_state: anyOf: - type: string enum: *a33 - type: string description: The state associated with the shipping address for the purchase order. This must be a state abbreviation shipping_zip: type: string description: The zip code associated with the shipping address for the purchase order shipping_country: type: string description: The country associated with the shipping address for the purchase order billing_address_1: type: string description: The first address line associated with the billing address for the purchase order billing_address_2: type: string description: The second address line associated with the billing address for the purchase order billing_city: type: string description: The city associated with the billing address for the purchase order billing_state: anyOf: - type: string enum: *a33 - type: string description: The state associated with the billing address for the purchase order. This must be a state abbreviation billing_zip: type: string description: The zip code associated with the billing address for the purchase order billing_country: type: string description: The country associated with the billing address for the purchase order required: - integration_id _v1_purchase-orders__post_output: type: object properties: job_id: type: string description: The ID of the job created to handle this operation data: type: object properties: {} required: - job_id - data _v1_purchase-orders_{purchase_order_id}_get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query _v1_purchase-orders_{purchase_order_id}_get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: $ref: "#/components/schemas/PurchaseOrder" required: - meta - results _v1_purchase-orders_{purchase_order_id}_put_input: type: object properties: vendor_id: type: string description: The Propexo unique identifier for the vendor description: type: string description: Description of the purchase order number: type: string minLength: 1 maxLength: 8 description: The number of the purchase order total_amount_in_cents: type: number description: The amount of the purchase order, in cents order_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The order date for the purchase order expense_type: type: string description: The expense type of the purchase order. You'll have to request this data from your customer display_type: type: string description: The display type of the purchase order. You'll have to request this data from your customer shipping_address_1: type: string description: The first address line associated with the shipping address for the purchase order shipping_address_2: type: string description: The second address line associated with the shipping address for the purchase order shipping_city: type: string description: The city associated with the shipping address for the purchase order shipping_state: anyOf: - type: string enum: *a33 - type: string description: The state associated with the shipping address for the purchase order shipping_zip: type: string description: The zip code associated with the shipping address for the purchase order shipping_country: type: string description: The country associated with the shipping address for the purchase order billing_address_1: type: string description: The first address line associated with the billing address for the purchase order billing_address_2: type: string description: The second address line associated with the billing address for the purchase order billing_city: type: string description: The city associated with the billing address for the purchase order billing_state: anyOf: - type: string enum: *a33 - type: string description: The state associated with the billing address for the purchase order billing_zip: type: string description: The zip code associated with the billing address for the purchase order billing_country: type: string description: The country associated with the billing address for the purchase order purchase_order_items: type: array items: type: object properties: property_id: type: string description: The Propexo unique identifier for the property description: type: string description: Description of the purchase order item construction_job_id: type: string description: The Propexo unique identifier for the construction job financial_account_id: type: string description: The Propexo unique identifier for the financial account stock_code: type: string description: The stock code for the purchase order item. You'll have to request this data from your customer quantity_ordered: type: string description: The quantity ordered for the purchase order item unit_price_in_cents: type: integer description: The unit price, in cents, of the purchase order item total_cost_in_cents: type: integer description: The total cost, in cents, of the lead cost_code: type: string description: The cost code of the purchase order item. You'll have to request this data from your customer category_code: type: string description: The category code for the purchase order item. You'll have to request this data from your customer required: - property_id - description - stock_code - quantity_ordered - unit_price_in_cents - total_cost_in_cents - cost_code - category_code minItems: 1 description: A list of the items associated with the purchase orders _v1_purchase-orders_{purchase_order_id}_put_output: type: object properties: job_id: type: string description: The ID of the job created to handle this operation data: type: object properties: {} required: - job_id - data _v1_purchase-orders_{purchase_order_id}_items_get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query property_id: type: string description: The Propexo unique identifier for the property integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" PurchaseOrderItem: type: object properties: id: type: string description: The Propexo unique identifier for the purchase order item created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. description: type: - string - "null" description: Description of the purchase order item stock_code: type: - string - "null" description: The stock code for the purchase order item quantity_ordered: type: - string - "null" description: The quantity ordered for the purchase order item unit_price_in_cents: type: &a341 - number - "null" description: The unit price, in cents, of the purchase order item example: 100000 total_cost_in_cents: type: &a342 - number - "null" description: The total cost, in cents, of the purchase order item example: 100000 cost_code: type: - string - "null" description: The cost code of the purchase order item category_code: type: - string - "null" description: The category code for the purchase order item purchase_order_id: type: string description: The Propexo unique identifier for the purchase order construction_job_id: type: - string - "null" description: The Propexo unique identifier for the construction job financial_account_id: type: - string - "null" description: The Propexo unique identifier for the financial account custom_data: type: - object - "null" properties: {} associated_invoice_ids: type: array items: type: string property_id: type: string description: The Propexo unique identifier for the property integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" required: - id - created_at - updated_at - last_seen - x_id - x_property_id - x_location_id - description - stock_code - quantity_ordered - unit_price_in_cents - total_cost_in_cents - cost_code - category_code - purchase_order_id - construction_job_id - financial_account_id - custom_data - associated_invoice_ids - property_id - integration_id - integration_vendor x-propexo: derivedFromModel: purchase_order_items _v1_purchase-orders_{purchase_order_id}_items_get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: type: array items: $ref: "#/components/schemas/PurchaseOrderItem" required: - meta - results _v1_purchase-orders_entrata__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration vendor_id: type: string description: The Propexo unique identifier for the vendor vendor_location_id: type: string description: The Propexo unique identifier for the vendor location property_id: type: string description: The Propexo unique identifier for the property ap_financial_account_id: type: string description: The Propexo unique identifier for the financial account. You'll likely want to work with your customer to know what value is appropriate here. post_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The post date for the purchase order description: type: string description: Description of the purchase order shipping_amount_in_cents: type: integer description: The cost of shipping, in cents, of the purchase order discount_amount_in_cents: type: integer description: The discount, in cents, of the purchase order purchase_order_items: type: array items: type: object properties: property_id: type: string description: The Propexo unique identifier for the property description: type: string description: Description of the purchase order item financial_account_id: type: string description: The Propexo unique identifier for the financial account unit_id: type: string description: The Propexo unique identifier for the unit quantity_ordered: type: number description: The quantity ordered for the purchase order item unit_price_in_cents: type: integer description: The unit price, in cents, of the purchase order item is_confidential: type: boolean description: Whether the purchase order item is confidential or not is_taxable: type: boolean description: Whether the purchase order item is taxable or not required: - property_id - financial_account_id - unit_price_in_cents default: &a210 [] description: A list of the items associated with the purchase orders required: - integration_id - vendor_id - vendor_location_id - property_id - post_date _v1_purchase-orders_entrata__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration vendor_id: type: string description: The Propexo unique identifier for the vendor vendor_location_id: type: string description: The Propexo unique identifier for the vendor location property_id: type: string description: The Propexo unique identifier for the property ap_financial_account_id: type: - string - "null" description: The Propexo unique identifier for the financial account. You'll likely want to work with your customer to know what value is appropriate here. post_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" description: type: - string - "null" description: Description of the purchase order shipping_amount_in_cents: type: - integer - "null" description: The cost of shipping, in cents, of the purchase order discount_amount_in_cents: type: - integer - "null" description: The discount, in cents, of the purchase order purchase_order_items: type: array items: type: object properties: property_id: type: string description: The Propexo unique identifier for the property description: type: string description: Description of the purchase order item financial_account_id: type: string description: The Propexo unique identifier for the financial account unit_id: type: string description: The Propexo unique identifier for the unit quantity_ordered: type: number description: The quantity ordered for the purchase order item unit_price_in_cents: type: integer description: The unit price, in cents, of the purchase order item is_confidential: type: boolean description: Whether the purchase order item is confidential or not is_taxable: type: boolean description: Whether the purchase order item is taxable or not required: - property_id - financial_account_id - unit_price_in_cents default: *a210 description: A list of the items associated with the purchase orders required: - integration_id - vendor_id - vendor_location_id - property_id - ap_financial_account_id - post_date - description - shipping_amount_in_cents - discount_amount_in_cents required: - meta - result _v1_purchase-orders_entrata_{purchase_order_id}_put_input: type: object properties: {} _v1_purchase-orders_entrata_{purchase_order_id}_put_output: type: object properties: {} _v1_purchase-orders_yardi__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration vendor_id: type: string description: The Propexo unique identifier for the vendor description: type: string description: Description of the purchase order number: type: string maxLength: 8 description: The number of the purchase order total_amount_in_cents: type: number description: The amount of the purchase order, in cents order_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The order date for the purchase order expense_type: type: string description: The expense type of the purchase order. You'll have to request this data from your customer display_type: type: string description: The display type of the purchase order. You'll have to request this data from your customer shipping_address_1: type: string description: The first address line associated with the shipping address for the purchase order shipping_address_2: type: string description: The second address line associated with the shipping address for the purchase order shipping_city: type: string description: The city associated with the shipping address for the purchase order shipping_state: anyOf: - type: string enum: *a33 - type: string description: The state associated with the shipping address for the purchase order. This must be a state abbreviation shipping_zip: type: string description: The zip code associated with the shipping address for the purchase order shipping_country: type: string description: The country associated with the shipping address for the purchase order billing_address_1: type: string description: The first address line associated with the billing address for the purchase order billing_address_2: type: string description: The second address line associated with the billing address for the purchase order billing_city: type: string description: The city associated with the billing address for the purchase order billing_state: anyOf: - type: string enum: *a33 - type: string description: The state associated with the billing address for the purchase order. This must be a state abbreviation billing_zip: type: string description: The zip code associated with the billing address for the purchase order billing_country: type: string description: The country associated with the billing address for the purchase order purchase_order_items: type: array items: anyOf: - type: object properties: property_id: type: string description: The Propexo unique identifier for the property description: type: string description: Description of the purchase order item construction_job_id: type: string description: The Propexo unique identifier for the construction job financial_account_id: type: string description: The Propexo unique identifier for the financial account stock_code: type: string description: The stock code for the purchase order item. You'll have to request this data from your customer quantity_ordered: type: string description: The quantity ordered for the purchase order item unit_price_in_cents: type: integer description: The unit price, in cents, of the purchase order item total_cost_in_cents: type: integer description: The total cost, in cents, of the purchase order item cost_code: type: string description: The cost code of the purchase order item. You'll have to request this data from your customer category_code: type: string description: The category code for the purchase order item. You'll have to request this data from your customer required: - property_id - description - construction_job_id - stock_code - quantity_ordered - unit_price_in_cents - total_cost_in_cents - cost_code - category_code description: A purchase order item that is associated with a construction job - type: object properties: property_id: type: string description: The Propexo unique identifier for the property description: type: string description: Description of the purchase order item financial_account_id: type: string description: The Propexo unique identifier for the financial account stock_code: type: string description: The stock code for the purchase order item. You'll have to request this data from your customer quantity_ordered: type: string description: The quantity ordered for the purchase order item unit_price_in_cents: type: integer description: The unit price, in cents, of the purchase order item total_cost_in_cents: type: integer description: The total cost, in cents, of the purchase order item required: - property_id - description - financial_account_id - stock_code - quantity_ordered - unit_price_in_cents - total_cost_in_cents description: A purchase order item that's not associated with a construction job minItems: 1 description: A list of the items associated with the purchase orders required: - integration_id - vendor_id - description - number - total_amount_in_cents - order_date - expense_type - display_type - shipping_address_1 - shipping_address_2 - shipping_city - shipping_state - shipping_zip - shipping_country - billing_address_1 - billing_address_2 - billing_city - billing_state - billing_zip - billing_country - purchase_order_items _v1_purchase-orders_yardi__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration vendor_id: type: string description: The Propexo unique identifier for the vendor description: type: string description: Description of the purchase order number: type: string maxLength: 8 description: The number of the purchase order total_amount_in_cents: type: number description: The amount of the purchase order, in cents order_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" expense_type: type: string description: The expense type of the purchase order. You'll have to request this data from your customer display_type: type: string description: The display type of the purchase order. You'll have to request this data from your customer shipping_address_1: type: string description: The first address line associated with the shipping address for the purchase order shipping_address_2: type: string description: The second address line associated with the shipping address for the purchase order shipping_city: type: string description: The city associated with the shipping address for the purchase order shipping_state: anyOf: - type: string enum: *a33 - type: string description: The state associated with the shipping address for the purchase order. This must be a state abbreviation shipping_zip: type: string description: The zip code associated with the shipping address for the purchase order shipping_country: type: string description: The country associated with the shipping address for the purchase order billing_address_1: type: string description: The first address line associated with the billing address for the purchase order billing_address_2: type: string description: The second address line associated with the billing address for the purchase order billing_city: type: string description: The city associated with the billing address for the purchase order billing_state: anyOf: - type: string enum: *a33 - type: string description: The state associated with the billing address for the purchase order. This must be a state abbreviation billing_zip: type: string description: The zip code associated with the billing address for the purchase order billing_country: type: string description: The country associated with the billing address for the purchase order purchase_order_items: type: array items: anyOf: - type: object properties: property_id: type: string description: The Propexo unique identifier for the property description: type: string description: Description of the purchase order item construction_job_id: type: string description: The Propexo unique identifier for the construction job financial_account_id: type: string description: The Propexo unique identifier for the financial account stock_code: type: string description: The stock code for the purchase order item. You'll have to request this data from your customer quantity_ordered: type: string description: The quantity ordered for the purchase order item unit_price_in_cents: type: integer description: The unit price, in cents, of the purchase order item total_cost_in_cents: type: integer description: The total cost, in cents, of the purchase order item cost_code: type: string description: The cost code of the purchase order item. You'll have to request this data from your customer category_code: type: string description: The category code for the purchase order item. You'll have to request this data from your customer required: - property_id - description - construction_job_id - stock_code - quantity_ordered - unit_price_in_cents - total_cost_in_cents - cost_code - category_code description: A purchase order item that is associated with a construction job - type: object properties: property_id: type: string description: The Propexo unique identifier for the property description: type: string description: Description of the purchase order item financial_account_id: type: string description: The Propexo unique identifier for the financial account stock_code: type: string description: The stock code for the purchase order item. You'll have to request this data from your customer quantity_ordered: type: string description: The quantity ordered for the purchase order item unit_price_in_cents: type: integer description: The unit price, in cents, of the purchase order item total_cost_in_cents: type: integer description: The total cost, in cents, of the purchase order item required: - property_id - description - financial_account_id - stock_code - quantity_ordered - unit_price_in_cents - total_cost_in_cents description: A purchase order item that's not associated with a construction job required: - integration_id - vendor_id - description - number - total_amount_in_cents - order_date - expense_type - display_type - shipping_address_1 - shipping_address_2 - shipping_city - shipping_state - shipping_zip - shipping_country - billing_address_1 - billing_address_2 - billing_city - billing_state - billing_zip - billing_country - purchase_order_items required: - meta - result _v1_purchase-orders_yardi_{purchase_order_id}_put_input: type: object properties: vendor_id: type: string description: The Propexo unique identifier for the vendor description: type: string description: Description of the purchase order number: type: string minLength: 1 maxLength: 8 description: The number of the purchase order total_amount_in_cents: type: number description: The amount of the purchase order, in cents order_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The order date for the purchase order expense_type: type: string description: The expense type of the purchase order. You'll have to request this data from your customer display_type: type: string description: The display type of the purchase order. You'll have to request this data from your customer shipping_address_1: type: string description: The first address line associated with the shipping address for the purchase order shipping_address_2: type: string description: The second address line associated with the shipping address for the purchase order shipping_city: type: string description: The city associated with the shipping address for the purchase order shipping_state: anyOf: - type: string enum: *a33 - type: string description: The state associated with the shipping address for the purchase order shipping_zip: type: string description: The zip code associated with the shipping address for the purchase order shipping_country: type: string description: The country associated with the shipping address for the purchase order billing_address_1: type: string description: The first address line associated with the billing address for the purchase order billing_address_2: type: string description: The second address line associated with the billing address for the purchase order billing_city: type: string description: The city associated with the billing address for the purchase order billing_state: anyOf: - type: string enum: *a33 - type: string description: The state associated with the billing address for the purchase order billing_zip: type: string description: The zip code associated with the billing address for the purchase order billing_country: type: string description: The country associated with the billing address for the purchase order purchase_order_items: type: array items: type: object properties: property_id: type: string description: The Propexo unique identifier for the property description: type: string description: Description of the purchase order item construction_job_id: type: string description: The Propexo unique identifier for the construction job financial_account_id: type: string description: The Propexo unique identifier for the financial account stock_code: type: string description: The stock code for the purchase order item. You'll have to request this data from your customer quantity_ordered: type: string description: The quantity ordered for the purchase order item unit_price_in_cents: type: integer description: The unit price, in cents, of the purchase order item total_cost_in_cents: type: integer description: The total cost, in cents, of the lead cost_code: type: string description: The cost code of the purchase order item. You'll have to request this data from your customer category_code: type: string description: The category code for the purchase order item. You'll have to request this data from your customer required: - property_id - description - stock_code - quantity_ordered - unit_price_in_cents - total_cost_in_cents - cost_code - category_code minItems: 1 description: A list of the items associated with the purchase orders required: - vendor_id - description - number - total_amount_in_cents - order_date - expense_type - display_type - purchase_order_items _v1_purchase-orders_yardi_{purchase_order_id}_put_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: purchase_order_id: type: string description: The Propexo unique identifier for the purchase order vendor_id: type: string description: The Propexo unique identifier for the vendor description: type: string description: Description of the purchase order number: type: string minLength: 1 maxLength: 8 description: The number of the purchase order total_amount_in_cents: type: number description: The amount of the purchase order, in cents order_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The order date for the purchase order expense_type: type: string description: The expense type of the purchase order. You'll have to request this data from your customer display_type: type: string description: The display type of the purchase order. You'll have to request this data from your customer shipping_address_1: type: string description: The first address line associated with the shipping address for the purchase order shipping_address_2: type: string description: The second address line associated with the shipping address for the purchase order shipping_city: type: string description: The city associated with the shipping address for the purchase order shipping_state: anyOf: - type: string enum: *a33 - type: string description: The state associated with the shipping address for the purchase order shipping_zip: type: string description: The zip code associated with the shipping address for the purchase order shipping_country: type: string description: The country associated with the shipping address for the purchase order billing_address_1: type: string description: The first address line associated with the billing address for the purchase order billing_address_2: type: string description: The second address line associated with the billing address for the purchase order billing_city: type: string description: The city associated with the billing address for the purchase order billing_state: anyOf: - type: string enum: *a33 - type: string description: The state associated with the billing address for the purchase order billing_zip: type: string description: The zip code associated with the billing address for the purchase order billing_country: type: string description: The country associated with the billing address for the purchase order purchase_order_items: type: array items: type: object properties: property_id: type: string description: The Propexo unique identifier for the property description: type: string description: Description of the purchase order item construction_job_id: type: string description: The Propexo unique identifier for the construction job financial_account_id: type: string description: The Propexo unique identifier for the financial account stock_code: type: string description: The stock code for the purchase order item. You'll have to request this data from your customer quantity_ordered: type: string description: The quantity ordered for the purchase order item unit_price_in_cents: type: integer description: The unit price, in cents, of the purchase order item total_cost_in_cents: type: integer description: The total cost, in cents, of the lead cost_code: type: string description: The cost code of the purchase order item. You'll have to request this data from your customer category_code: type: string description: The category code for the purchase order item. You'll have to request this data from your customer required: - property_id - description - stock_code - quantity_ordered - unit_price_in_cents - total_cost_in_cents - cost_code - category_code required: - purchase_order_id - vendor_id - description - number - total_amount_in_cents - order_date - expense_type - display_type - purchase_order_items required: - meta - result _v1_purchase-orders_yardi_rest__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration vendor_id: type: string description: The Propexo unique identifier for the vendor description: type: string description: Description of the purchase order number: type: string maxLength: 8 description: The number of the purchase order total_amount_in_cents: type: number description: The amount of the purchase order, in cents order_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The order date for the purchase order expense_type: type: string description: The expense type of the purchase order. You'll have to request this data from your customer display_type: type: string description: The display type of the purchase order. You'll have to request this data from your customer shipping_address_1: type: string description: The first address line associated with the shipping address for the purchase order shipping_address_2: type: string description: The second address line associated with the shipping address for the purchase order shipping_city: type: string description: The city associated with the shipping address for the purchase order shipping_state: anyOf: - type: string enum: *a33 - type: string description: The state associated with the shipping address for the purchase order. This must be a state abbreviation shipping_zip: type: string description: The zip code associated with the shipping address for the purchase order shipping_country: type: string description: The country associated with the shipping address for the purchase order billing_address_1: type: string description: The first address line associated with the billing address for the purchase order billing_address_2: type: string description: The second address line associated with the billing address for the purchase order billing_city: type: string description: The city associated with the billing address for the purchase order billing_state: anyOf: - type: string enum: *a33 - type: string description: The state associated with the billing address for the purchase order. This must be a state abbreviation billing_zip: type: string description: The zip code associated with the billing address for the purchase order billing_country: type: string description: The country associated with the billing address for the purchase order purchase_order_items: type: array items: anyOf: - type: object properties: property_id: type: string description: The Propexo unique identifier for the property description: type: string description: Description of the purchase order item construction_job_id: type: string description: The Propexo unique identifier for the construction job financial_account_id: type: string description: The Propexo unique identifier for the financial account stock_code: type: string description: The stock code for the purchase order item. You'll have to request this data from your customer quantity_ordered: type: string description: The quantity ordered for the purchase order item unit_price_in_cents: type: integer description: The unit price, in cents, of the purchase order item total_cost_in_cents: type: integer description: The total cost, in cents, of the purchase order item cost_code: type: string description: The cost code of the purchase order item. You'll have to request this data from your customer category_code: type: string description: The category code for the purchase order item. You'll have to request this data from your customer required: - property_id - description - construction_job_id - stock_code - quantity_ordered - unit_price_in_cents - total_cost_in_cents - cost_code - category_code description: A purchase order item that is associated with a construction job - type: object properties: property_id: type: string description: The Propexo unique identifier for the property description: type: string description: Description of the purchase order item financial_account_id: type: string description: The Propexo unique identifier for the financial account stock_code: type: string description: The stock code for the purchase order item. You'll have to request this data from your customer quantity_ordered: type: string description: The quantity ordered for the purchase order item unit_price_in_cents: type: integer description: The unit price, in cents, of the purchase order item total_cost_in_cents: type: integer description: The total cost, in cents, of the purchase order item required: - property_id - description - financial_account_id - stock_code - quantity_ordered - unit_price_in_cents - total_cost_in_cents description: A purchase order item that's not associated with a construction job minItems: 1 description: A list of the items associated with the purchase orders required: - integration_id - vendor_id - description - number - total_amount_in_cents - order_date - expense_type - display_type - shipping_address_1 - shipping_address_2 - shipping_city - shipping_state - shipping_zip - shipping_country - billing_address_1 - billing_address_2 - billing_city - billing_state - billing_zip - billing_country - purchase_order_items _v1_purchase-orders_yardi_rest__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration vendor_id: type: string description: The Propexo unique identifier for the vendor description: type: string description: Description of the purchase order number: type: string maxLength: 8 description: The number of the purchase order total_amount_in_cents: type: number description: The amount of the purchase order, in cents order_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" expense_type: type: string description: The expense type of the purchase order. You'll have to request this data from your customer display_type: type: string description: The display type of the purchase order. You'll have to request this data from your customer shipping_address_1: type: string description: The first address line associated with the shipping address for the purchase order shipping_address_2: type: string description: The second address line associated with the shipping address for the purchase order shipping_city: type: string description: The city associated with the shipping address for the purchase order shipping_state: anyOf: - type: string enum: *a33 - type: string description: The state associated with the shipping address for the purchase order. This must be a state abbreviation shipping_zip: type: string description: The zip code associated with the shipping address for the purchase order shipping_country: type: string description: The country associated with the shipping address for the purchase order billing_address_1: type: string description: The first address line associated with the billing address for the purchase order billing_address_2: type: string description: The second address line associated with the billing address for the purchase order billing_city: type: string description: The city associated with the billing address for the purchase order billing_state: anyOf: - type: string enum: *a33 - type: string description: The state associated with the billing address for the purchase order. This must be a state abbreviation billing_zip: type: string description: The zip code associated with the billing address for the purchase order billing_country: type: string description: The country associated with the billing address for the purchase order purchase_order_items: type: array items: anyOf: - type: object properties: property_id: type: string description: The Propexo unique identifier for the property description: type: string description: Description of the purchase order item construction_job_id: type: string description: The Propexo unique identifier for the construction job financial_account_id: type: string description: The Propexo unique identifier for the financial account stock_code: type: string description: The stock code for the purchase order item. You'll have to request this data from your customer quantity_ordered: type: string description: The quantity ordered for the purchase order item unit_price_in_cents: type: integer description: The unit price, in cents, of the purchase order item total_cost_in_cents: type: integer description: The total cost, in cents, of the purchase order item cost_code: type: string description: The cost code of the purchase order item. You'll have to request this data from your customer category_code: type: string description: The category code for the purchase order item. You'll have to request this data from your customer required: - property_id - description - construction_job_id - stock_code - quantity_ordered - unit_price_in_cents - total_cost_in_cents - cost_code - category_code description: A purchase order item that is associated with a construction job - type: object properties: property_id: type: string description: The Propexo unique identifier for the property description: type: string description: Description of the purchase order item financial_account_id: type: string description: The Propexo unique identifier for the financial account stock_code: type: string description: The stock code for the purchase order item. You'll have to request this data from your customer quantity_ordered: type: string description: The quantity ordered for the purchase order item unit_price_in_cents: type: integer description: The unit price, in cents, of the purchase order item total_cost_in_cents: type: integer description: The total cost, in cents, of the purchase order item required: - property_id - description - financial_account_id - stock_code - quantity_ordered - unit_price_in_cents - total_cost_in_cents description: A purchase order item that's not associated with a construction job required: - integration_id - vendor_id - description - number - total_amount_in_cents - order_date - expense_type - display_type - shipping_address_1 - shipping_address_2 - shipping_city - shipping_state - shipping_zip - shipping_country - billing_address_1 - billing_address_2 - billing_city - billing_state - billing_zip - billing_country - purchase_order_items required: - meta - result _v1_purchase-orders_yardi_rest_{purchase_order_id}_put_input: type: object properties: vendor_id: type: string description: The Propexo unique identifier for the vendor description: type: string description: Description of the purchase order number: type: string minLength: 1 maxLength: 8 description: The number of the purchase order total_amount_in_cents: type: number description: The amount of the purchase order, in cents order_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The order date for the purchase order expense_type: type: string description: The expense type of the purchase order. You'll have to request this data from your customer display_type: type: string description: The display type of the purchase order. You'll have to request this data from your customer shipping_address_1: type: string description: The first address line associated with the shipping address for the purchase order shipping_address_2: type: string description: The second address line associated with the shipping address for the purchase order shipping_city: type: string description: The city associated with the shipping address for the purchase order shipping_state: anyOf: - type: string enum: *a33 - type: string description: The state associated with the shipping address for the purchase order shipping_zip: type: string description: The zip code associated with the shipping address for the purchase order shipping_country: type: string description: The country associated with the shipping address for the purchase order billing_address_1: type: string description: The first address line associated with the billing address for the purchase order billing_address_2: type: string description: The second address line associated with the billing address for the purchase order billing_city: type: string description: The city associated with the billing address for the purchase order billing_state: anyOf: - type: string enum: *a33 - type: string description: The state associated with the billing address for the purchase order billing_zip: type: string description: The zip code associated with the billing address for the purchase order billing_country: type: string description: The country associated with the billing address for the purchase order purchase_order_items: type: array items: type: object properties: property_id: type: string description: The Propexo unique identifier for the property description: type: string description: Description of the purchase order item construction_job_id: type: string description: The Propexo unique identifier for the construction job financial_account_id: type: string description: The Propexo unique identifier for the financial account stock_code: type: string description: The stock code for the purchase order item. You'll have to request this data from your customer quantity_ordered: type: string description: The quantity ordered for the purchase order item unit_price_in_cents: type: integer description: The unit price, in cents, of the purchase order item total_cost_in_cents: type: integer description: The total cost, in cents, of the lead cost_code: type: string description: The cost code of the purchase order item. You'll have to request this data from your customer category_code: type: string description: The category code for the purchase order item. You'll have to request this data from your customer required: - property_id - description - stock_code - quantity_ordered - unit_price_in_cents - total_cost_in_cents - cost_code - category_code minItems: 1 description: A list of the items associated with the purchase orders required: - vendor_id - description - number - total_amount_in_cents - order_date - expense_type - display_type - purchase_order_items _v1_purchase-orders_yardi_rest_{purchase_order_id}_put_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: purchase_order_id: type: string description: The Propexo unique identifier for the purchase order vendor_id: type: string description: The Propexo unique identifier for the vendor description: type: string description: Description of the purchase order number: type: string minLength: 1 maxLength: 8 description: The number of the purchase order total_amount_in_cents: type: number description: The amount of the purchase order, in cents order_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The order date for the purchase order expense_type: type: string description: The expense type of the purchase order. You'll have to request this data from your customer display_type: type: string description: The display type of the purchase order. You'll have to request this data from your customer shipping_address_1: type: string description: The first address line associated with the shipping address for the purchase order shipping_address_2: type: string description: The second address line associated with the shipping address for the purchase order shipping_city: type: string description: The city associated with the shipping address for the purchase order shipping_state: anyOf: - type: string enum: *a33 - type: string description: The state associated with the shipping address for the purchase order shipping_zip: type: string description: The zip code associated with the shipping address for the purchase order shipping_country: type: string description: The country associated with the shipping address for the purchase order billing_address_1: type: string description: The first address line associated with the billing address for the purchase order billing_address_2: type: string description: The second address line associated with the billing address for the purchase order billing_city: type: string description: The city associated with the billing address for the purchase order billing_state: anyOf: - type: string enum: *a33 - type: string description: The state associated with the billing address for the purchase order billing_zip: type: string description: The zip code associated with the billing address for the purchase order billing_country: type: string description: The country associated with the billing address for the purchase order purchase_order_items: type: array items: type: object properties: property_id: type: string description: The Propexo unique identifier for the property description: type: string description: Description of the purchase order item construction_job_id: type: string description: The Propexo unique identifier for the construction job financial_account_id: type: string description: The Propexo unique identifier for the financial account stock_code: type: string description: The stock code for the purchase order item. You'll have to request this data from your customer quantity_ordered: type: string description: The quantity ordered for the purchase order item unit_price_in_cents: type: integer description: The unit price, in cents, of the purchase order item total_cost_in_cents: type: integer description: The total cost, in cents, of the lead cost_code: type: string description: The cost code of the purchase order item. You'll have to request this data from your customer category_code: type: string description: The category code for the purchase order item. You'll have to request this data from your customer required: - property_id - description - stock_code - quantity_ordered - unit_price_in_cents - total_cost_in_cents - cost_code - category_code required: - purchase_order_id - vendor_id - description - number - total_amount_in_cents - order_date - expense_type - display_type - purchase_order_items required: - meta - result Enum6: type: string enum: &a293 - APPFOLIO - BUILDIUM - ENTRATA - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The integration vendor for the resident. _v1_residents__get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query x_id: type: string description: The external resident id x_property_id: type: string description: "Deprecated: Use Propexo property_id instead" deprecated: true location_id: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. property_id: type: string description: The Propexo property id lease_id: type: string description: The Propexo lease id integration_id: type: string description: The Propexo integration id integration_vendor: $ref: "#/components/schemas/Enum6" email_1: type: string description: The primary email address associated with the resident phone_1: type: string pattern: ^[2-9]\d{9}$ description: Filter by phone number (10 digit format only) _v1_residents__get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: type: array items: type: object properties: id: type: string description: The Propexo unique identifier for the resident created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_lease_id: type: - string - "null" description: Deprecated. Use leases_meta_data instead deprecated: true x-fern-availability: deprecated leases_meta_data: type: array items: type: object properties: lease_id: type: string description: The Propexo unique identifier for the lease x_resident_type: type: - string - "null" description: The external type of the resident from the integration vendor resident_type_normalized: anyOf: - type: string - type: string enum: - PRIMARY - SECONDARY - GUARANTOR - OTHER - type: "null" description: Resident type from Propexo move_in_date: type: - string - "null" description: The move-in date associated with the resident move_out_date: type: - string - "null" description: The move-out date associated with the resident notice_date: type: - string - "null" description: The date the resident gave notice custom_data: type: - object - "null" properties: {} last_seen: type: - string - "null" description: The date the record was last seen from the PMS required: - lease_id - x_resident_type - resident_type_normalized - move_in_date - move_out_date - notice_date - custom_data - last_seen x-propexo: &a211 derivedFromModel: residents_to_leases address_1_alternate: type: - string - "null" description: The first alternate address line associated with the resident address_1: type: - string - "null" description: The first address line associated with the resident address_2_alternate: type: - string - "null" description: The second alternate address line associated with the resident address_2: type: - string - "null" description: The second address line associated with the resident balance_in_cents: type: &a212 - number - "null" description: The rent balance owed example: 100000 city_alternate: type: - string - "null" description: The alternate city associated with the resident city: type: - string - "null" description: The city associated with the resident country_alternate: type: - string - "null" description: The alternate country associated with the resident country: type: - string - "null" description: The country associated with the resident custom_data: type: - object - "null" properties: {} date_of_birth: type: - string - "null" description: The date of birth associated with the resident email_1: type: - string - "null" description: The primary email address associated with the resident email_2: type: - string - "null" description: The secondary email address associated with the resident first_name: type: - string - "null" description: The first name associated with the resident is_employee: type: - boolean - "null" description: Is the resident an employee last_name: type: - string - "null" description: The last name associated with the resident late_balance_in_cents: type: &a213 - number - "null" description: The past due rent balance owed example: 100000 middle_name: type: - string - "null" description: The middle name associated with the resident notes: type: - string - "null" description: Notes associated with the resident phone_1_type: type: - string - "null" enum: - FAX - HOME - MOBILE - OTHER - WORK description: Type of the primary phone number phone_1: type: - string - "null" description: Primary phone number associated with the resident phone_2_type: type: - string - "null" enum: - FAX - HOME - MOBILE - OTHER - WORK description: Type of the secondary phone number phone_2: type: - string - "null" description: Secondary phone number associated with the resident state_alternate: type: - string - "null" description: The alternate state associated with the resident state: type: - string - "null" description: The state associated with the resident zip_alternate: type: - string - "null" description: The alternate zip code associated with the resident zip: type: - string - "null" description: The zip code associated with the resident pets: type: array items: type: object properties: id: type: string description: The Propexo unique identifier for the resident pet created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor name: type: - string - "null" description: The name associated with the resident pet type: type: - string - "null" description: The type associated with the resident pet breed: type: - string - "null" description: The breed of the resident pet gender_raw: type: - string - "null" description: The raw value for the gender of the resident pet age_in_years: type: - number - "null" description: The age in years of the resident pet weight_in_pounds: type: - number - "null" description: The weight in pounds of the resident pet is_fixed: type: - boolean - "null" description: Whether the resident pet is fixed is_service_animal: type: - boolean - "null" description: Whether the resident pet is a service animal notes: type: - string - "null" description: Notes associated with the resident pet custom_data: type: - object - "null" properties: {} required: - id - created_at - updated_at - last_seen - x_id - name - type - breed - gender_raw - age_in_years - weight_in_pounds - is_fixed - is_service_animal - notes - custom_data x-propexo: &a214 derivedFromModel: resident_pets vehicles: type: array items: type: object properties: id: type: string description: The Propexo unique identifier for the resident vehicle created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor make: type: - string - "null" description: The make of the resident vehicle model: type: - string - "null" description: The Propexo data model (e.g. units, residents, applicants, etc.) associated with the resident vehicle color: type: - string - "null" description: The color of the resident vehicle year: type: - string - "null" description: The year of the resident vehicle license_plate_number: type: - string - "null" description: The license plate number of the resident vehicle license_plate_state: type: - string - "null" description: The license plate state of the resident vehicle notes: type: - string - "null" description: Notes associated with the resident vehicle custom_data: type: - object - "null" properties: {} required: - id - created_at - updated_at - last_seen - x_id - make - model - color - year - license_plate_number - license_plate_state - notes - custom_data x-propexo: &a215 derivedFromModel: resident_vehicles integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" property_id: type: string description: The Propexo unique identifier for the property required: - id - created_at - updated_at - last_seen - x_id - x_lease_id - address_1_alternate - address_1 - address_2_alternate - address_2 - balance_in_cents - city_alternate - city - country_alternate - country - custom_data - date_of_birth - email_1 - email_2 - first_name - is_employee - last_name - late_balance_in_cents - middle_name - notes - phone_1_type - phone_1 - phone_2_type - phone_2 - state_alternate - state - zip_alternate - zip - pets - vehicles - integration_id - integration_vendor - property_id required: - meta - results _v1_residents__post_input: type: object properties: integration_id: type: string lease_id: type: string description: The Propexo unique identifier for the lease last_name: type: string description: The last name of the resident. This value maps to both the LastName and PrimaryContact.LastName properties of the Tenant object first_name: type: string description: The first name of the resident. This value maps to both the FirstName and PrimaryContact.FirstName properties of the Tenant object email_1: type: string format: email description: The primary email address for the resident. This value maps to the PrimaryContact.Email property of the Tenant object email_2: type: string format: email description: The secondary email address associated with the resident date_of_birth: type: string format: date-time description: The date of birth of the resident. This value maps to the PrimaryContact.DateOfBirth property of the Tenant object. address_1: type: string description: Street address for the resident. This maps to the Street property of the primary address of the Tenant object address_2: type: string description: The second address line associated with the resident city: type: string description: City of the resident's primary address state: type: string description: State of the resident's primary address zip: type: string description: Zip/Postal Code of the resident's primary address country: anyOf: - type: string enum: &a224 - United States - Canada - type: string description: The country associated with the resident address_1_alternate: type: string description: Secondary/alternate street address for the resident. This maps to the Street property of the second address of the Tenant object address_2_alternate: type: string description: Second line of the secondary/alternate street address for the resident. This maps to the AlternateAddress.AddressLine2 property of the Tenant object city_alternate: type: string description: City of the resident's secondary/alternate address state_alternate: type: string description: State of the resident's secondary/alternate address zip_alternate: type: string description: Zip/Postal Code of the resident's secondary/alternate address country_alternate: type: string enum: *a169 description: Country of the resident's secondary/alternate address. notes: type: string description: Notes about the resident phone_1: type: string description: Primary phone number associated with the resident phone_1_type: type: string enum: - FAX - HOME - MOBILE - OTHER - WORK description: Type of the primary phone number phone_2: type: string description: Secondary phone number associated with the resident phone_2_type: type: string enum: - FAX - HOME - MOBILE - OTHER - WORK description: Type of the secondary phone number custom_data: type: object properties: {} description: "Deprecated: Field is no longer applicable" deprecated: true middle_name: type: string description: The middle name of the resident. This value maps to the PrimaryContact.MiddleName property of the Tenant object property_id: type: string description: The Propexo unique identifier for the property rent_period: type: string enum: &a226 - MONTHLY - WEEKLY - DAILY description: How often the resident is expected to pay rent. Allowed values are "monthly", "weekly", and "daily". Maps to the RentPeriod property of the Tenant object. rent_due_day: type: integer minimum: 1 maximum: 31 description: Day of the month on which the tenant's rent is due. Maps to the RentDueDay property of the Tenant object attachments: type: array items: type: object properties: file_type_id: type: string description: The Propexo unique identifier for the file type. This file_type must contain a "type" value of "file" file_type: type: string enum: &a227 - Document default: Document description: The type of file being uploaded. This defaults to "Document" file_data: type: string maxLength: 40443576 description: The contents of the file, as a base64 encoded string. The PMS has a max file size of 29 MB. file_name: type: string description: 'The name of the file including the extension. Ex: "resume.pdf"' mime_type: type: string description: 'The mime type of the file. Ex: "application/pdf"' required: - file_type_id - file_data - file_name - mime_type description: Attachment files for user defined fields on the resident. All the files can have a maximum combined file size of 50 MB required: - integration_id _v1_residents__post_output: type: object properties: job_id: type: string description: The ID of the job created to handle this operation data: type: object properties: {} required: - job_id - data _v1_residents_{id}_get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query _v1_residents_{id}_get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: type: object properties: id: type: string description: The Propexo unique identifier for the resident created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_lease_id: type: - string - "null" description: Deprecated. Use leases_meta_data instead deprecated: true x-fern-availability: deprecated leases_meta_data: type: array items: type: object properties: lease_id: type: string description: The Propexo unique identifier for the lease x_resident_type: type: - string - "null" description: The external type of the resident from the integration vendor resident_type_normalized: anyOf: - type: string - type: string enum: - PRIMARY - SECONDARY - GUARANTOR - OTHER - type: "null" description: Resident type from Propexo move_in_date: type: - string - "null" description: The move-in date associated with the resident move_out_date: type: - string - "null" description: The move-out date associated with the resident notice_date: type: - string - "null" description: The date the resident gave notice custom_data: type: - object - "null" properties: {} last_seen: type: - string - "null" description: The date the record was last seen from the PMS required: - lease_id - x_resident_type - resident_type_normalized - move_in_date - move_out_date - notice_date - custom_data - last_seen x-propexo: *a211 address_1_alternate: type: - string - "null" description: The first alternate address line associated with the resident address_1: type: - string - "null" description: The first address line associated with the resident address_2_alternate: type: - string - "null" description: The second alternate address line associated with the resident address_2: type: - string - "null" description: The second address line associated with the resident balance_in_cents: type: *a212 description: The rent balance owed example: 100000 city_alternate: type: - string - "null" description: The alternate city associated with the resident city: type: - string - "null" description: The city associated with the resident country_alternate: type: - string - "null" description: The alternate country associated with the resident country: type: - string - "null" description: The country associated with the resident custom_data: type: - object - "null" properties: {} date_of_birth: type: - string - "null" description: The date of birth associated with the resident email_1: type: - string - "null" description: The primary email address associated with the resident email_2: type: - string - "null" description: The secondary email address associated with the resident first_name: type: - string - "null" description: The first name associated with the resident is_employee: type: - boolean - "null" description: Is the resident an employee last_name: type: - string - "null" description: The last name associated with the resident late_balance_in_cents: type: *a213 description: The past due rent balance owed example: 100000 middle_name: type: - string - "null" description: The middle name associated with the resident notes: type: - string - "null" description: Notes associated with the resident phone_1_type: type: - string - "null" enum: - FAX - HOME - MOBILE - OTHER - WORK description: Type of the primary phone number phone_1: type: - string - "null" description: Primary phone number associated with the resident phone_2_type: type: - string - "null" enum: - FAX - HOME - MOBILE - OTHER - WORK description: Type of the secondary phone number phone_2: type: - string - "null" description: Secondary phone number associated with the resident state_alternate: type: - string - "null" description: The alternate state associated with the resident state: type: - string - "null" description: The state associated with the resident zip_alternate: type: - string - "null" description: The alternate zip code associated with the resident zip: type: - string - "null" description: The zip code associated with the resident pets: type: array items: type: object properties: id: type: string description: The Propexo unique identifier for the resident pet created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor name: type: - string - "null" description: The name associated with the resident pet type: type: - string - "null" description: The type associated with the resident pet breed: type: - string - "null" description: The breed of the resident pet gender_raw: type: - string - "null" description: The raw value for the gender of the resident pet age_in_years: type: - number - "null" description: The age in years of the resident pet weight_in_pounds: type: - number - "null" description: The weight in pounds of the resident pet is_fixed: type: - boolean - "null" description: Whether the resident pet is fixed is_service_animal: type: - boolean - "null" description: Whether the resident pet is a service animal notes: type: - string - "null" description: Notes associated with the resident pet custom_data: type: - object - "null" properties: {} required: - id - created_at - updated_at - last_seen - x_id - name - type - breed - gender_raw - age_in_years - weight_in_pounds - is_fixed - is_service_animal - notes - custom_data x-propexo: *a214 vehicles: type: array items: type: object properties: id: type: string description: The Propexo unique identifier for the resident vehicle created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor make: type: - string - "null" description: The make of the resident vehicle model: type: - string - "null" description: The Propexo data model (e.g. units, residents, applicants, etc.) associated with the resident vehicle color: type: - string - "null" description: The color of the resident vehicle year: type: - string - "null" description: The year of the resident vehicle license_plate_number: type: - string - "null" description: The license plate number of the resident vehicle license_plate_state: type: - string - "null" description: The license plate state of the resident vehicle notes: type: - string - "null" description: Notes associated with the resident vehicle custom_data: type: - object - "null" properties: {} required: - id - created_at - updated_at - last_seen - x_id - make - model - color - year - license_plate_number - license_plate_state - notes - custom_data x-propexo: *a215 integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" property_id: type: string description: The Propexo unique identifier for the property required: - id - created_at - updated_at - last_seen - x_id - x_lease_id - address_1_alternate - address_1 - address_2_alternate - address_2 - balance_in_cents - city_alternate - city - country_alternate - country - custom_data - date_of_birth - email_1 - email_2 - first_name - is_employee - last_name - late_balance_in_cents - middle_name - notes - phone_1_type - phone_1 - phone_2_type - phone_2 - state_alternate - state - zip_alternate - zip - pets - vehicles - integration_id - integration_vendor - property_id required: - meta - results _v1_residents_{id}_put_input: type: object properties: resident_id: type: string description: The Propexo unique identifier for the resident last_name: type: string description: The last name of the resident. first_name: type: string description: The first name of the resident. email_1: type: string format: email description: The primary email address for the resident. email_2: type: string format: email description: The secondary email address associated with the resident date_of_birth: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date of birth associated with the resident address_1: type: string description: The first address line associated with the resident address_2: type: string description: The second address line associated with the resident city: type: string description: The city associated with the resident state: type: string enum: *a22 description: The state associated with the resident zip: type: string description: The zip code associated with the resident country: type: string enum: *a23 description: The country associated with the resident address_1_alternate: type: string description: Secondary/alternate street address for the resident. This maps to the Street property of the second address of the Tenant object address_2_alternate: type: string description: Second line of the secondary/alternate street address for the resident. This maps to the AlternateAddress.AddressLine2 property of the Tenant object city_alternate: type: string description: City of the resident's secondary/alternate address state_alternate: type: string description: State of the resident's secondary/alternate address zip_alternate: type: string description: Zip/Postal Code of the resident's secondary/alternate address country_alternate: type: string enum: *a169 description: Country of the resident's secondary/alternate address. notes: type: string description: Notes associated with the resident phone_1: type: string description: The primary phone number for the resident. phone_1_type: type: string enum: &a230 - HOME - WORK - MOBILE - FAX description: The primary phone type for the resident. Required when updating phone number. phone_2: type: string description: Secondary phone number associated with the resident phone_2_type: type: string enum: - FAX - HOME - MOBILE - OTHER - WORK description: Type of the secondary phone number custom_data: type: object properties: {} description: "Deprecated: Field is no longer applicable" deprecated: true middle_name: type: string description: The middle name associated with the resident events: type: array items: type: object properties: unit_id: type: string description: The Propexo unique identifier for the unit x_type_id: type: string description: The PMS id for the event type. x_leasing_agent_id: type: string description: The PMS id for the leasing agent. x_sub_type_id: type: string description: The PMS id for the event sub type. x_result_id: type: string description: The PMS id for the event result. event_datetime: type: string format: date-time description: The date and time that the event occured. appointment_datetime: type: string format: date-time description: The date and time that the appointment will occur. Required if using appointment type. time_from: type: string time_to: type: string notes: type: string description: General notes about the event. title: type: string description: Title for the event. reasons_for_event: type: string description: The reason the event occurred. id: type: string description: The Propexo unique identifier for the event. Only required if attempting to update an existing event. required: - x_type_id description: "DEPRECATED: Please use /events endpoints to write events. Array of events associated with this resident" deprecated: true lead_source_id: type: string description: The Propexo unique identifier for the lead source middle_initial: type: string minLength: 1 maxLength: 1 description: The middle initial of the resident qualified: type: boolean description: Whether the resident is qualified gender: type: string enum: &a229 - MALE - FEMALE description: The gender of the resident guarantor: type: boolean description: Indicates if the resident is a guarantor for the primary resident. monthly_income_in_cents: type: integer minimum: 0 description: The monthly income of the resident, in cents no_checks_in_cash_receipts: type: boolean description: To restrict the resident from making payments by check, set this to true. Defaults to false. rent_period: type: string enum: &a228 - MONTHLY - WEEKLY - DAILY description: How often the resident is expected to pay rent. Allowed values are "monthly", "weekly", and "daily". Maps to the RentPeriod property of the Tenant object. rent_due_day: type: integer minimum: 1 maximum: 31 description: Day of the month on which the tenant's rent is due. Maps to the RentDueDay property of the Tenant object is_primary: type: boolean description: Whether the resident is the primary record _v1_residents_{id}_put_output: type: object properties: job_id: type: string description: The ID of the job created to handle this operation data: type: object properties: {} required: - job_id - data _v1_resident-pets__post_input: type: object properties: integration_id: type: string resident_id: type: string description: The Propexo unique identifier for the resident is_service_animal: type: boolean description: Whether the resident pet is a service animal age_in_years: type: integer minimum: 0 description: The age in years of the resident pet color: type: string description: The color of the resident pet gender_raw: type: string description: The raw value for the gender of the resident pet is_fixed: type: boolean description: Whether the resident pet is fixed name: type: string description: The name associated with the resident pet type: type: string description: The type associated with the resident pet weight_in_pounds: type: integer minimum: 0 description: The weight in pounds of the resident pet required: - integration_id _v1_resident-pets__post_output: type: object properties: job_id: type: string description: The ID of the job created to handle this operation data: type: object properties: {} required: - job_id - data _v1_resident-pets_{pet_id}_put_input: type: object properties: is_service_animal: type: boolean description: Whether the resident pet is a service animal age_in_years: type: integer minimum: 0 description: The age in years of the resident pet color: type: string description: The color of the resident pet gender_raw: type: string description: The raw value for the gender of the resident pet is_fixed: type: boolean description: Whether the resident pet is fixed name: type: string description: The name associated with the resident pet type: type: string description: The type associated with the resident pet weight_in_pounds: type: integer minimum: 0 description: The weight in pounds of the resident pet resident_pet_id: type: string description: The Propexo unique identifier for the resident pet required: - resident_pet_id _v1_resident-pets_{pet_id}_put_output: type: object properties: job_id: type: string description: The ID of the job created to handle this operation data: type: object properties: {} required: - job_id - data _v1_resident-insurance__get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query resident_id: type: string description: The Propexo unique identifier for the resident unit_id: type: string description: The Propexo unique identifier for the unit lease_id: type: string description: The Propexo unique identifier for the lease property_id: type: string description: The Propexo unique identifier for the property integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string _v1_resident-insurance__get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: type: array items: type: object properties: id: type: string description: The Propexo unique identifier for the resident insurance created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_unit_id: type: - string - "null" description: The external ID of the unit from the integration vendor x_lease_id: type: - string - "null" description: The external ID of the lease from the integration vendor x_resident_id: type: - string - "null" description: The external ID of the resident from the integration vendor provider: type: - string - "null" description: The insurance provider name insurance_type: type: - string - "null" description: The type of insurance policy_number: type: - string - "null" description: The insurance policy number effective_date: type: - string - "null" description: The date the insurance becomes effective expiration_date: type: - string - "null" description: The date the insurance expires cancellation_date: type: - string - "null" description: The date the insurance was cancelled liability_amount_in_cents: type: &a216 - number - "null" description: The liability amount in cents example: 100000 liability_amount_raw: type: - string - "null" description: The raw liability amount string notes: type: - string - "null" description: Additional notes about the insurance integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" property_id: type: string description: The Propexo unique identifier for the property unit_id: type: - string - "null" description: The Propexo unique identifier for the unit lease_id: type: - string - "null" description: The Propexo unique identifier for the lease resident_id: type: - string - "null" description: The Propexo unique identifier for the resident required: - id - created_at - updated_at - last_seen - x_id - x_property_id - x_location_id - x_unit_id - x_lease_id - x_resident_id - provider - insurance_type - policy_number - effective_date - expiration_date - cancellation_date - liability_amount_in_cents - liability_amount_raw - notes - integration_id - integration_vendor - property_id - unit_id - lease_id - resident_id x-propexo: &a217 derivedFromModel: resident_insurance required: - meta - results _v1_resident-insurance_{resident_insurance_id}_get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query _v1_resident-insurance_{resident_insurance_id}_get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: type: object properties: id: type: string description: The Propexo unique identifier for the resident insurance created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_unit_id: type: - string - "null" description: The external ID of the unit from the integration vendor x_lease_id: type: - string - "null" description: The external ID of the lease from the integration vendor x_resident_id: type: - string - "null" description: The external ID of the resident from the integration vendor provider: type: - string - "null" description: The insurance provider name insurance_type: type: - string - "null" description: The type of insurance policy_number: type: - string - "null" description: The insurance policy number effective_date: type: - string - "null" description: The date the insurance becomes effective expiration_date: type: - string - "null" description: The date the insurance expires cancellation_date: type: - string - "null" description: The date the insurance was cancelled liability_amount_in_cents: type: *a216 description: The liability amount in cents example: 100000 liability_amount_raw: type: - string - "null" description: The raw liability amount string notes: type: - string - "null" description: Additional notes about the insurance integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" property_id: type: string description: The Propexo unique identifier for the property unit_id: type: - string - "null" description: The Propexo unique identifier for the unit lease_id: type: - string - "null" description: The Propexo unique identifier for the lease resident_id: type: - string - "null" description: The Propexo unique identifier for the resident required: - id - created_at - updated_at - last_seen - x_id - x_property_id - x_location_id - x_unit_id - x_lease_id - x_resident_id - provider - insurance_type - policy_number - effective_date - expiration_date - cancellation_date - liability_amount_in_cents - liability_amount_raw - notes - integration_id - integration_vendor - property_id - unit_id - lease_id - resident_id x-propexo: *a217 required: - meta - results _v1_residents_{id}_rentable-items_get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query x_id: type: string description: The external ID from the integration vendor location_id: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. property_id: type: string description: The Propexo unique identifier for the property integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" _v1_residents_{id}_rentable-items_get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: type: array items: $ref: "#/components/schemas/RentableItem" required: - meta - results _v1_residents_buildium__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration lease_id: type: string description: The Propexo unique identifier for the lease last_name: type: string description: The last name of the resident. This value maps to the LastName property of the Tenant object first_name: type: string description: The first name of the resident. This value maps to the FirstName property of the Tenant object email_1: type: string format: email description: The primary email address for the resident. This value maps to the Email property of the Tenant object email_2: type: string format: email description: An alternate email address for the resident. This value maps to the AlternateEmail property of the Tenant object. date_of_birth: type: string format: date-time description: The date of birth of the resident. This value maps to the DateOfBirth property of the Tenant object. address_1: type: string description: First line of the street address for the resident. This maps to the Address.AddressLine1 property of the primary address of the Tenant object address_2: type: string description: Second line of the street address for the resident. This maps to the Address.AddressLine2 property of the Tenant object. city: type: string description: City of the resident's primary address. This maps to the Address.City property of the Tenant object. state: type: string description: State of the resident's primary address. This maps to the Address.State property of the Tenant object. zip: type: string description: Zip/Postal Code of the resident's primary address. This maps to the Address.PostalCode property of the Tenant object. country: type: string enum: *a169 description: Country of the resident's primary address. address_1_alternate: type: string description: First line of the secondary/alternate street address for the resident. This maps to the AlternateAddress.AddressLine1 property of the Tenant object address_2_alternate: type: string description: Second line of the secondary/alternate street address for the resident. This maps to the AlternateAddress.AddressLine2 property of the Tenant object city_alternate: type: string description: City of the resident's secondary/alternate address. This maps to the AlternateAddress.City property of the Tenant object. state_alternate: type: string description: State of the resident's secondary/alternate address. This maps to the AlternateAddress.State property of the Tenant object zip_alternate: type: string description: Zip/Postal Code of the resident's secondary/alternate address. This maps to the AlternateAddress.PostalCode property of the Tenant object country_alternate: type: string enum: *a169 description: Country of the resident's secondary/alternate address. notes: type: string description: Any notes on the resident. This value maps to the Comment property of the Tenant object. phone_1: type: string description: Resident's primary phone number. This will be assumed to be a HOME phone number unless phone_1_type is also set. phone_1_type: type: string enum: &a218 - HOME - WORK - MOBILE - FAX description: The type of the resident's primary phone number. The value passed in here must be one of 'HOME', 'WORK', 'MOBILE', FAX'. phone_2: type: string description: Resident's secondary phone number. This will be assumed to be a MOBILE phone number unless phone_2_type is also set. phone_2_type: type: string enum: &a219 - HOME - WORK - MOBILE - FAX description: The type of the resident's secondary phone number. The value passed in here must be one of 'HOME', 'WORK', 'MOBILE', FAX'. custom_data: type: object properties: {} description: "Deprecated: Field is no longer applicable" deprecated: true required: - integration_id - lease_id - last_name - first_name - address_1 - city - state - zip - country _v1_residents_buildium__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration lease_id: type: string description: The Propexo unique identifier for the lease last_name: type: string description: The last name of the resident. This value maps to the LastName property of the Tenant object first_name: type: string description: The first name of the resident. This value maps to the FirstName property of the Tenant object email_1: type: - string - "null" format: email description: The primary email address for the resident. This value maps to the Email property of the Tenant object email_2: type: - string - "null" format: email description: An alternate email address for the resident. This value maps to the AlternateEmail property of the Tenant object. date_of_birth: type: - string - "null" format: date-time description: The date of birth of the resident. This value maps to the DateOfBirth property of the Tenant object. address_1: type: string description: First line of the street address for the resident. This maps to the Address.AddressLine1 property of the primary address of the Tenant object address_2: type: - string - "null" description: Second line of the street address for the resident. This maps to the Address.AddressLine2 property of the Tenant object. city: type: string description: City of the resident's primary address. This maps to the Address.City property of the Tenant object. state: type: string description: State of the resident's primary address. This maps to the Address.State property of the Tenant object. zip: type: string description: Zip/Postal Code of the resident's primary address. This maps to the Address.PostalCode property of the Tenant object. country: type: string enum: *a169 description: Country of the resident's primary address. address_1_alternate: type: - string - "null" description: First line of the secondary/alternate street address for the resident. This maps to the AlternateAddress.AddressLine1 property of the Tenant object address_2_alternate: type: - string - "null" description: Second line of the secondary/alternate street address for the resident. This maps to the AlternateAddress.AddressLine2 property of the Tenant object city_alternate: type: - string - "null" description: City of the resident's secondary/alternate address. This maps to the AlternateAddress.City property of the Tenant object. state_alternate: type: - string - "null" description: State of the resident's secondary/alternate address. This maps to the AlternateAddress.State property of the Tenant object zip_alternate: type: - string - "null" description: Zip/Postal Code of the resident's secondary/alternate address. This maps to the AlternateAddress.PostalCode property of the Tenant object country_alternate: type: - string - "null" enum: *a169 description: Country of the resident's secondary/alternate address. notes: type: - string - "null" description: Any notes on the resident. This value maps to the Comment property of the Tenant object. phone_1: type: - string - "null" description: Resident's primary phone number. This will be assumed to be a HOME phone number unless phone_1_type is also set. phone_1_type: type: - string - "null" enum: *a218 description: The type of the resident's primary phone number. The value passed in here must be one of 'HOME', 'WORK', 'MOBILE', FAX'. phone_2: type: - string - "null" description: Resident's secondary phone number. This will be assumed to be a MOBILE phone number unless phone_2_type is also set. phone_2_type: type: - string - "null" enum: *a219 description: The type of the resident's secondary phone number. The value passed in here must be one of 'HOME', 'WORK', 'MOBILE', FAX'. custom_data: type: - object - "null" properties: {} deprecated: true x-fern-availability: deprecated required: - integration_id - lease_id - last_name - first_name - email_1 - email_2 - date_of_birth - address_1 - address_2 - city - state - zip - country - address_1_alternate - address_2_alternate - city_alternate - state_alternate - zip_alternate - country_alternate - notes - phone_1 - phone_1_type - phone_2 - phone_2_type - custom_data required: - meta - result _v1_residents_buildium_{resident_id}_put_input: type: object properties: last_name: type: string description: The last name of the resident. This value maps to the LastName property of the Tenant object first_name: type: string description: The first name of the resident. This value maps to the FirstName property of the Tenant object email_1: type: string format: email description: The primary email address for the resident. This value maps to the Email property of the Tenant object email_2: type: string format: email description: An alternate email address for the resident. This value maps to the AlternateEmail property of the Tenant object. date_of_birth: type: string format: date-time description: The date of birth of the resident. This value maps to the DateOfBirth property of the Tenant object. address_1: type: string maxLength: 100 description: First line of the street address for the resident. This maps to the Address.AddressLine1 property of the primary address of the Tenant object address_2: type: string maxLength: 100 description: Second line of the street address for the resident. This maps to the Address.AddressLine2 property of the Tenant object. city: type: string maxLength: 100 description: City of the resident's primary address. This maps to the Address.City property of the Tenant object. state: type: string description: State of the resident's primary address. This maps to the Address.State property of the Tenant object. zip: type: string description: Zip/Postal Code of the resident's primary address. This maps to the Address.PostalCode property of the Tenant object. country: type: string enum: *a169 description: Country of the resident's primary address. address_1_alternate: type: string description: First line of the secondary/alternate street address for the resident. This maps to the AlternateAddress.AddressLine1 property of the Tenant object address_2_alternate: type: string description: Second line of the secondary/alternate street address for the resident. This maps to the AlternateAddress.AddressLine2 property of the Tenant object city_alternate: type: string description: City of the resident's secondary/alternate address. This maps to the AlternateAddress.City property of the Tenant object. state_alternate: type: string description: State of the resident's secondary/alternate address. This maps to the AlternateAddress.State property of the Tenant object zip_alternate: type: string description: Zip/Postal Code of the resident's secondary/alternate address. This maps to the AlternateAddress.PostalCode property of the Tenant object country_alternate: type: string enum: *a169 description: Country of the resident's secondary/alternate address. notes: type: string description: Any notes on the resident. This value maps to the Comment property of the Tenant object. phone_1: type: string description: Resident's primary phone number. This will be assumed to be a HOME phone number unless phone_1_type is also set. phone_1_type: type: string enum: &a220 - HOME - WORK - MOBILE - FAX description: The type of the resident's primary phone number. The value passed in here must be one of 'HOME', 'WORK', 'MOBILE', FAX'. phone_2: type: string description: Resident's secondary phone number. This will be assumed to be a MOBILE phone number unless phone_2_type is also set. phone_2_type: type: string enum: &a221 - HOME - WORK - MOBILE - FAX description: The type of the resident's secondary phone number. The value passed in here must be one of 'HOME', 'WORK', 'MOBILE', FAX'. custom_data: type: object properties: {} description: "Deprecated: Field is no longer applicable" deprecated: true required: - last_name - first_name - address_1 - city - state - zip - country _v1_residents_buildium_{resident_id}_put_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: resident_id: type: string description: The Propexo ID of the resident being updated last_name: type: string description: The last name of the resident. This value maps to the LastName property of the Tenant object first_name: type: string description: The first name of the resident. This value maps to the FirstName property of the Tenant object email_1: type: string format: email description: The primary email address for the resident. This value maps to the Email property of the Tenant object email_2: type: string format: email description: An alternate email address for the resident. This value maps to the AlternateEmail property of the Tenant object. date_of_birth: type: string format: date-time description: The date of birth of the resident. This value maps to the DateOfBirth property of the Tenant object. address_1: type: string maxLength: 100 description: First line of the street address for the resident. This maps to the Address.AddressLine1 property of the primary address of the Tenant object address_2: type: string maxLength: 100 description: Second line of the street address for the resident. This maps to the Address.AddressLine2 property of the Tenant object. city: type: string maxLength: 100 description: City of the resident's primary address. This maps to the Address.City property of the Tenant object. state: type: string description: State of the resident's primary address. This maps to the Address.State property of the Tenant object. zip: type: string description: Zip/Postal Code of the resident's primary address. This maps to the Address.PostalCode property of the Tenant object. country: type: string enum: *a169 description: Country of the resident's primary address. address_1_alternate: type: string description: First line of the secondary/alternate street address for the resident. This maps to the AlternateAddress.AddressLine1 property of the Tenant object address_2_alternate: type: string description: Second line of the secondary/alternate street address for the resident. This maps to the AlternateAddress.AddressLine2 property of the Tenant object city_alternate: type: string description: City of the resident's secondary/alternate address. This maps to the AlternateAddress.City property of the Tenant object. state_alternate: type: string description: State of the resident's secondary/alternate address. This maps to the AlternateAddress.State property of the Tenant object zip_alternate: type: string description: Zip/Postal Code of the resident's secondary/alternate address. This maps to the AlternateAddress.PostalCode property of the Tenant object country_alternate: type: string enum: *a169 description: Country of the resident's secondary/alternate address. notes: type: string description: Any notes on the resident. This value maps to the Comment property of the Tenant object. phone_1: type: string description: Resident's primary phone number. This will be assumed to be a HOME phone number unless phone_1_type is also set. phone_1_type: type: string enum: *a220 description: The type of the resident's primary phone number. The value passed in here must be one of 'HOME', 'WORK', 'MOBILE', FAX'. phone_2: type: string description: Resident's secondary phone number. This will be assumed to be a MOBILE phone number unless phone_2_type is also set. phone_2_type: type: string enum: *a221 description: The type of the resident's secondary phone number. The value passed in here must be one of 'HOME', 'WORK', 'MOBILE', FAX'. custom_data: type: object properties: {} deprecated: true x-fern-availability: deprecated required: - resident_id - last_name - first_name - address_1 - city - state - zip - country required: - meta - result _v1_residents_entrata__post_input: type: object properties: {} _v1_residents_entrata__post_output: type: object properties: {} _v1_residents_entrata_{id}_put_input: type: object properties: first_name: type: string description: The first name of the resident. This value maps to the firstName property of the Customer object middle_name: type: string description: The middle name of the resident. This value maps to the middleName property of the Customer object last_name: type: string description: The last name of the resident. This value maps to the lastName property of the Customer object email_1: type: string format: email description: The primary email address for the resident. This value maps to the email property of the Customer object date_of_birth: type: string format: date-time description: The date of birth of the resident. This value maps to the birthDate property of the Customer object. address_1: type: string description: The first address line associated with the resident address_2: type: string description: The second address line associated with the resident city: type: string description: The city associated with the resident state: type: string description: The state associated with the resident zip: type: string description: The zip code associated with the resident country: type: string description: The country associated with the resident phone_1: type: string description: The primary phone number for the resident. events: type: array items: type: object properties: unit_id: type: string description: The Propexo unique identifier for the unit x_type_id: type: string description: The PMS id for the event type. x_leasing_agent_id: type: string description: The PMS id for the leasing agent. x_sub_type_id: type: string description: The PMS id for the event sub type. x_result_id: type: string description: The PMS id for the event result. event_datetime: type: string format: date-time description: The date and time that the event occured. appointment_datetime: type: string format: date-time description: The date and time that the appointment will occur. Required if using appointment type. time_from: type: string time_to: type: string notes: type: string description: General notes about the event. title: type: string description: Title for the event. reasons_for_event: type: string description: The reason the event occurred. id: type: string description: The Propexo unique identifier for the event. Only required if attempting to update an existing event. required: - x_type_id description: "DEPRECATED: Please use /events endpoints to write events. Array of events associated with this resident" deprecated: true custom_data: type: object properties: {} description: "Deprecated: Field is no longer applicable" deprecated: true _v1_residents_entrata_{id}_put_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: id: type: string description: The Propexo unique identifier for the resident first_name: type: string description: The first name of the resident. This value maps to the firstName property of the Customer object middle_name: type: string description: The middle name of the resident. This value maps to the middleName property of the Customer object last_name: type: string description: The last name of the resident. This value maps to the lastName property of the Customer object email_1: type: string format: email description: The primary email address for the resident. This value maps to the email property of the Customer object date_of_birth: type: string format: date-time description: The date of birth of the resident. This value maps to the birthDate property of the Customer object. address_1: type: string description: The first address line associated with the resident address_2: type: string description: The second address line associated with the resident city: type: string description: The city associated with the resident state: type: string description: The state associated with the resident zip: type: string description: The zip code associated with the resident country: type: string description: The country associated with the resident phone_1: type: string description: The primary phone number for the resident. events: type: array items: type: object properties: unit_id: type: string description: The Propexo unique identifier for the unit x_type_id: type: string x_leasing_agent_id: type: string description: The PMS id for the leasing agent. x_sub_type_id: type: string description: The PMS id for the event sub type. x_result_id: type: string description: The PMS id for the event result. event_datetime: type: string format: date-time description: The date and time that the event occured. appointment_datetime: type: string format: date-time description: The date and time that the appointment will occur. Required if using appointment type. time_from: type: string time_to: type: string notes: type: string description: General notes about the event. title: type: string description: Title for the event. reasons_for_event: type: string description: The reason the event occurred. id: type: string description: The Propexo unique identifier for the event. Only required if attempting to update an existing event. required: - x_type_id custom_data: type: object properties: {} deprecated: true x-fern-availability: deprecated required: - id required: - meta - result _v1_residents_propertyware__post_input: type: object properties: {} _v1_residents_propertyware__post_output: type: object properties: {} _v1_residents_propertyware_{resident_id}_put_input: type: object properties: first_name: type: string description: The first name of the resident. This value maps to the firstName property of the Contact object middle_name: type: string description: The middle name of the resident. This value maps to the middleName property of the Contact object last_name: type: string description: The last name of the resident. This value maps to the lastName property of the Contact object email_1: type: string format: email description: The primary email address for the resident. This value maps to the email property of the Contact object email_2: type: string format: email description: The secondary email address for the resident. This value maps to the altEmail property of the Contact object date_of_birth: type: string format: date-time description: The date of birth of the resident. This value maps to the birthDate property of the Contact object. address_1: type: string description: First line of the street address for the resident. This maps to the address property of Contact object address_2: type: string description: Second line of the street address for the resident. This maps to the address2 property of the Contact object city: type: string description: City of the resident's address. This maps to the city property of the Contact object. state: type: string description: State of the resident's address. This maps to the state property of the Contact object. zip: type: string description: Zip/Postal Code of the resident's address. This maps to the zip property of the Contact object. country: type: string description: Country of the resident's address. This maps to the country property of the Contact object phone_1: type: string description: Primary phone number for the resident. Depending on the value of phone_1_type, this may map to the properties fax, homePhone, mobilePhone, or workPhone. phone_1_type: type: string enum: &a222 - HOME - MOBILE - WORK - FAX description: The type of the primary phone. Must be one of 'HOME', 'MOBILE', 'WORK', or 'FAX' phone_2: type: string description: Secondary phone number for the resident. Depending on the value of phone_1_type, this may map to the properties fax, homePhone, mobilePhone, or workPhone. phone_2_type: type: string enum: &a223 - HOME - MOBILE - WORK - FAX description: The type of the secondary phone. Must be one of 'HOME', 'MOBILE', 'WORK', or 'FAX' notes: type: string description: Any notes about the resident. This maps to the comments property of the Contact object custom_data: type: object properties: {} description: "Deprecated: Field is no longer applicable" deprecated: true _v1_residents_propertyware_{resident_id}_put_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: resident_id: type: string description: The Propexo unique identifier for the resident first_name: type: string description: The first name of the resident. This value maps to the firstName property of the Contact object middle_name: type: string description: The middle name of the resident. This value maps to the middleName property of the Contact object last_name: type: string description: The last name of the resident. This value maps to the lastName property of the Contact object email_1: type: string format: email description: The primary email address for the resident. This value maps to the email property of the Contact object email_2: type: string format: email description: The secondary email address for the resident. This value maps to the altEmail property of the Contact object date_of_birth: type: string format: date-time description: The date of birth of the resident. This value maps to the birthDate property of the Contact object. address_1: type: string description: First line of the street address for the resident. This maps to the address property of Contact object address_2: type: string description: Second line of the street address for the resident. This maps to the address2 property of the Contact object city: type: string description: City of the resident's address. This maps to the city property of the Contact object. state: type: string description: State of the resident's address. This maps to the state property of the Contact object. zip: type: string description: Zip/Postal Code of the resident's address. This maps to the zip property of the Contact object. country: type: string description: Country of the resident's address. This maps to the country property of the Contact object phone_1: type: string description: Primary phone number for the resident. Depending on the value of phone_1_type, this may map to the properties fax, homePhone, mobilePhone, or workPhone. phone_1_type: type: string enum: *a222 description: The type of the primary phone. Must be one of 'HOME', 'MOBILE', 'WORK', or 'FAX' phone_2: type: string description: Secondary phone number for the resident. Depending on the value of phone_1_type, this may map to the properties fax, homePhone, mobilePhone, or workPhone. phone_2_type: type: string enum: *a223 description: The type of the secondary phone. Must be one of 'HOME', 'MOBILE', 'WORK', or 'FAX' notes: type: string description: Any notes about the resident. This maps to the comments property of the Contact object custom_data: type: object properties: {} deprecated: true x-fern-availability: deprecated required: - resident_id required: - meta - result _v1_residents_propertyware_rest__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration first_name: type: string maxLength: 30 description: The first name associated with the resident last_name: type: string maxLength: 30 description: The last name associated with the resident address_1: type: string description: The first address line associated with the resident country: anyOf: - type: string enum: *a224 - type: string description: The country associated with the resident city: type: string description: The city associated with the resident state: type: string description: The state associated with the resident zip: type: string description: The zip code associated with the resident middle_name: type: string maxLength: 30 description: The middle name associated with the resident email_1: type: string format: email description: The primary email address associated with the resident email_2: type: string format: email description: The secondary email address associated with the resident date_of_birth: type: string format: date-time description: The date of birth associated with the resident address_2: type: string description: The second address line associated with the resident phone_1: type: string description: Primary phone number associated with the resident phone_2: type: string description: Secondary phone number associated with the resident phone_1_type: type: string enum: - FAX - HOME - MOBILE - OTHER - WORK description: Type of the primary phone number phone_2_type: type: string enum: - FAX - HOME - MOBILE - OTHER - WORK description: Type of the secondary phone number notes: type: string description: Notes associated with the resident required: - integration_id - first_name - last_name - address_1 - country - city - state - zip _v1_residents_propertyware_rest__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration first_name: type: string maxLength: 30 description: The first name associated with the resident last_name: type: string maxLength: 30 description: The last name associated with the resident address_1: type: string description: The first address line associated with the resident country: anyOf: - type: string enum: *a224 - type: string description: The country associated with the resident city: type: string description: The city associated with the resident state: type: string description: The state associated with the resident zip: type: string description: The zip code associated with the resident middle_name: type: - string - "null" maxLength: 30 description: The middle name associated with the resident email_1: type: - string - "null" format: email description: The primary email address associated with the resident email_2: type: - string - "null" format: email description: The secondary email address associated with the resident date_of_birth: type: - string - "null" format: date-time description: The date of birth associated with the resident address_2: type: - string - "null" description: The second address line associated with the resident phone_1: type: - string - "null" description: Primary phone number associated with the resident phone_2: type: - string - "null" description: Secondary phone number associated with the resident phone_1_type: type: - string - "null" enum: - FAX - HOME - MOBILE - OTHER - WORK description: Type of the primary phone number phone_2_type: type: - string - "null" enum: - FAX - HOME - MOBILE - OTHER - WORK description: Type of the secondary phone number notes: type: - string - "null" description: Notes associated with the resident required: - integration_id - first_name - last_name - address_1 - country - city - state - zip - middle_name - email_1 - email_2 - date_of_birth - address_2 - phone_1 - phone_2 - phone_1_type - phone_2_type - notes required: - meta - result _v1_residents_propertyware_rest_{resident_id}_put_input: type: object properties: first_name: type: string maxLength: 30 description: The first name associated with the resident middle_name: type: string maxLength: 30 description: The middle name associated with the resident last_name: type: string maxLength: 30 description: The last name associated with the resident email_1: type: string format: email description: The primary email address associated with the resident email_2: type: string format: email description: The secondary email address associated with the resident date_of_birth: type: string format: date-time description: The date of birth associated with the resident address_1: type: string description: The first address line associated with the resident address_2: type: string description: The second address line associated with the resident city: type: string description: The city associated with the resident state: type: string description: The state associated with the resident zip: type: string description: The zip code associated with the resident country: anyOf: - type: string enum: &a225 - United States - Canada - type: string description: The country associated with the resident phone_1: type: string description: Primary phone number associated with the resident phone_1_type: type: string enum: - FAX - HOME - MOBILE - OTHER - WORK description: Type of the primary phone number phone_2: type: string description: Secondary phone number associated with the resident phone_2_type: type: string enum: - FAX - HOME - MOBILE - OTHER - WORK description: Type of the secondary phone number notes: type: string description: Notes associated with the resident _v1_residents_propertyware_rest_{resident_id}_put_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: resident_id: type: string description: The Propexo unique identifier for the resident first_name: type: string maxLength: 30 description: The first name associated with the resident middle_name: type: string maxLength: 30 description: The middle name associated with the resident last_name: type: string maxLength: 30 description: The last name associated with the resident email_1: type: string format: email description: The primary email address associated with the resident email_2: type: string format: email description: The secondary email address associated with the resident date_of_birth: type: string format: date-time description: The date of birth associated with the resident address_1: type: string description: The first address line associated with the resident address_2: type: string description: The second address line associated with the resident city: type: string description: The city associated with the resident state: type: string description: The state associated with the resident zip: type: string description: The zip code associated with the resident country: anyOf: - type: string enum: *a225 - type: string description: The country associated with the resident phone_1: type: string description: Primary phone number associated with the resident phone_1_type: type: string enum: - FAX - HOME - MOBILE - OTHER - WORK description: Type of the primary phone number phone_2: type: string description: Secondary phone number associated with the resident phone_2_type: type: string enum: - FAX - HOME - MOBILE - OTHER - WORK description: Type of the secondary phone number notes: type: string description: Notes associated with the resident required: - resident_id required: - meta - result _v1_residents_rentmanager__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration property_id: type: string description: The Propexo unique identifier for the property rent_period: type: string enum: *a226 description: How often the resident is expected to pay rent. Allowed values are "monthly", "weekly", and "daily". Maps to the RentPeriod property of the Tenant object. rent_due_day: type: integer minimum: 1 maximum: 31 description: Day of the month on which the tenant's rent is due. Maps to the RentDueDay property of the Tenant object first_name: type: string description: The first name of the resident. This value maps to both the FirstName and PrimaryContact.FirstName properties of the Tenant object last_name: type: string description: The last name of the resident. This value maps to both the LastName and PrimaryContact.LastName properties of the Tenant object middle_name: type: string description: The middle name of the resident. This value maps to the PrimaryContact.MiddleName property of the Tenant object email_1: type: string format: email description: The primary email address for the resident. This value maps to the PrimaryContact.Email property of the Tenant object date_of_birth: type: string format: date-time description: The date of birth of the resident. This value maps to the PrimaryContact.DateOfBirth property of the Tenant object. notes: type: string description: Notes about the resident address_1: type: string description: Street address for the resident. This maps to the Street property of the primary address of the Tenant object city: type: string description: City of the resident's primary address state: type: string description: State of the resident's primary address zip: type: string description: Zip/Postal Code of the resident's primary address address_1_alternate: type: string description: Secondary/alternate street address for the resident. This maps to the Street property of the second address of the Tenant object city_alternate: type: string description: City of the resident's secondary/alternate address state_alternate: type: string description: State of the resident's secondary/alternate address zip_alternate: type: string description: Zip/Postal Code of the resident's secondary/alternate address custom_data: type: object properties: {} description: "Deprecated: Field is no longer applicable" deprecated: true attachments: type: array items: type: object properties: file_type_id: type: string description: The Propexo unique identifier for the file type. This file_type must contain a "type" value of "file" file_type: type: string enum: *a227 default: Document description: The type of file being uploaded. This defaults to "Document" file_data: type: string maxLength: 40443576 description: The contents of the file, as a base64 encoded string. The PMS has a max file size of 29 MB. file_name: type: string description: 'The name of the file including the extension. Ex: "resume.pdf"' mime_type: type: string description: 'The mime type of the file. Ex: "application/pdf"' required: - file_type_id - file_data - file_name - mime_type description: Attachment files for user defined fields on the resident. All the files can have a maximum combined file size of 50 MB required: - integration_id - property_id - rent_period - rent_due_day - first_name - last_name _v1_residents_rentmanager__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration property_id: type: string description: The Propexo unique identifier for the property rent_period: type: string enum: *a226 description: How often the resident is expected to pay rent. Allowed values are "monthly", "weekly", and "daily". Maps to the RentPeriod property of the Tenant object. rent_due_day: type: integer minimum: 1 maximum: 31 description: Day of the month on which the tenant's rent is due. Maps to the RentDueDay property of the Tenant object first_name: type: string description: The first name of the resident. This value maps to both the FirstName and PrimaryContact.FirstName properties of the Tenant object last_name: type: string description: The last name of the resident. This value maps to both the LastName and PrimaryContact.LastName properties of the Tenant object middle_name: type: - string - "null" description: The middle name of the resident. This value maps to the PrimaryContact.MiddleName property of the Tenant object email_1: type: - string - "null" format: email description: The primary email address for the resident. This value maps to the PrimaryContact.Email property of the Tenant object date_of_birth: type: - string - "null" format: date-time description: The date of birth of the resident. This value maps to the PrimaryContact.DateOfBirth property of the Tenant object. notes: type: - string - "null" description: Notes about the resident address_1: type: - string - "null" description: Street address for the resident. This maps to the Street property of the primary address of the Tenant object city: type: - string - "null" description: City of the resident's primary address state: type: - string - "null" description: State of the resident's primary address zip: type: - string - "null" description: Zip/Postal Code of the resident's primary address address_1_alternate: type: - string - "null" description: Secondary/alternate street address for the resident. This maps to the Street property of the second address of the Tenant object city_alternate: type: - string - "null" description: City of the resident's secondary/alternate address state_alternate: type: - string - "null" description: State of the resident's secondary/alternate address zip_alternate: type: - string - "null" description: Zip/Postal Code of the resident's secondary/alternate address custom_data: type: - object - "null" properties: {} deprecated: true x-fern-availability: deprecated attachments: type: - array - "null" items: type: object properties: file_type_id: type: string description: The Propexo unique identifier for the file type. This file_type must contain a "type" value of "file" file_type: type: string enum: *a227 default: Document file_data: type: string maxLength: 40443576 description: The contents of the file, as a base64 encoded string. The PMS has a max file size of 29 MB. file_name: type: string description: 'The name of the file including the extension. Ex: "resume.pdf"' mime_type: type: string description: 'The mime type of the file. Ex: "application/pdf"' required: - file_type_id - file_data - file_name - mime_type required: - integration_id - property_id - rent_period - rent_due_day - first_name - last_name - middle_name - email_1 - date_of_birth - notes - address_1 - city - state - zip - address_1_alternate - city_alternate - state_alternate - zip_alternate - custom_data - attachments required: - meta - result _v1_residents_rentmanager_{resident_id}_put_input: type: object properties: last_name: type: string description: The last name of the resident. This value maps to both the LastName and PrimaryContact.LastName properties of the Tenant object rent_period: type: string enum: *a228 description: How often the resident is expected to pay rent. Allowed values are "monthly", "weekly", and "daily". Maps to the RentPeriod property of the Tenant object. rent_due_day: type: integer minimum: 1 maximum: 31 description: Day of the month on which the tenant's rent is due. Maps to the RentDueDay property of the Tenant object first_name: type: string description: The first name of the resident. This value maps to both the FirstName and PrimaryContact.FirstName properties of the Tenant object middle_name: type: string description: The middle name of the resident. This value maps to the PrimaryContact.MiddleName property of the Tenant object email_1: type: string format: email description: The primary email address for the resident. This value maps to the PrimaryContact.Email property of the Tenant object date_of_birth: type: string format: date-time description: The date of birth of the resident. This value maps to the PrimaryContact.DateOfBirth property of the Tenant object. address_1: type: string description: Street address for the resident. This maps to the Street property of the primary address of the Tenant object city: type: string description: City of the resident's primary address state: type: string description: State of the resident's primary address zip: type: string description: Zip/Postal Code of the resident's primary address address_1_alternate: type: string description: Secondary/alternate street address for the resident. This maps to the Street property of the second address of the Tenant object city_alternate: type: string description: City of the resident's secondary/alternate address state_alternate: type: string description: State of the resident's secondary/alternate address zip_alternate: type: string description: Zip/Postal Code of the resident's secondary/alternate address notes: type: string description: Notes associated with the resident custom_data: type: object properties: {} description: "Deprecated: Field is no longer applicable" deprecated: true required: - last_name - rent_period - rent_due_day _v1_residents_rentmanager_{resident_id}_put_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: resident_id: type: string description: The Propexo unique identifier for the resident last_name: type: string description: The last name of the resident. This value maps to both the LastName and PrimaryContact.LastName properties of the Tenant object rent_period: type: string enum: *a228 description: How often the resident is expected to pay rent. Allowed values are "monthly", "weekly", and "daily". Maps to the RentPeriod property of the Tenant object. rent_due_day: type: integer minimum: 1 maximum: 31 description: Day of the month on which the tenant's rent is due. Maps to the RentDueDay property of the Tenant object first_name: type: string description: The first name of the resident. This value maps to both the FirstName and PrimaryContact.FirstName properties of the Tenant object middle_name: type: string description: The middle name of the resident. This value maps to the PrimaryContact.MiddleName property of the Tenant object email_1: type: string format: email description: The primary email address for the resident. This value maps to the PrimaryContact.Email property of the Tenant object date_of_birth: type: string format: date-time description: The date of birth of the resident. This value maps to the PrimaryContact.DateOfBirth property of the Tenant object. address_1: type: string description: Street address for the resident. This maps to the Street property of the primary address of the Tenant object city: type: string description: City of the resident's primary address state: type: string description: State of the resident's primary address zip: type: string description: Zip/Postal Code of the resident's primary address address_1_alternate: type: string description: Secondary/alternate street address for the resident. This maps to the Street property of the second address of the Tenant object city_alternate: type: string description: City of the resident's secondary/alternate address state_alternate: type: string description: State of the resident's secondary/alternate address zip_alternate: type: string description: Zip/Postal Code of the resident's secondary/alternate address notes: type: string description: Notes associated with the resident custom_data: type: object properties: {} deprecated: true x-fern-availability: deprecated required: - resident_id - last_name - rent_period - rent_due_day required: - meta - result _v1_residents_mri_{resident_id}_put_input: type: object properties: last_name: type: string description: The last name associated with the resident lead_source_id: type: string description: The Propexo unique identifier for the lead source first_name: type: string description: The first name associated with the resident middle_initial: type: string minLength: 1 maxLength: 1 description: The middle initial of the resident phone_1: type: string description: Primary phone number associated with the resident date_of_birth: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date of birth associated with the resident qualified: type: boolean description: Whether the resident is qualified gender: type: string enum: *a229 description: The gender of the resident guarantor: type: boolean description: Indicates if the resident is a guarantor for the primary resident. monthly_income_in_cents: type: integer minimum: 0 description: The monthly income of the resident, in cents email_1: type: string description: The primary email address associated with the resident no_checks_in_cash_receipts: type: boolean description: To restrict the resident from making payments by check, set this to true. Defaults to false. required: - last_name _v1_residents_mri_{resident_id}_put_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: resident_id: type: string description: The Propexo unique identifier for the resident last_name: type: string description: The last name associated with the resident lead_source_id: type: string description: The Propexo unique identifier for the lead source first_name: type: string description: The first name associated with the resident middle_initial: type: string minLength: 1 maxLength: 1 description: The middle initial of the resident phone_1: type: string description: Primary phone number associated with the resident date_of_birth: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date of birth associated with the resident qualified: type: boolean description: Whether the resident is qualified gender: type: string enum: *a229 description: The gender of the resident guarantor: type: boolean description: Indicates if the resident is a guarantor for the primary resident. monthly_income_in_cents: type: integer minimum: 0 description: The monthly income of the resident, in cents email_1: type: string description: The primary email address associated with the resident no_checks_in_cash_receipts: type: boolean description: To restrict the resident from making payments by check, set this to true. Defaults to false. required: - resident_id - last_name required: - meta - result _v1_residents_realpage_{id}_put_input: type: object properties: last_name: type: string maxLength: 30 description: The last name of the resident. first_name: type: string maxLength: 30 description: The first name of the resident. middle_name: type: string maxLength: 30 description: The middle name of the resident. email_1: type: string format: email description: The primary email address for the resident. address_1: type: string description: Street address for the resident. address_2: type: string description: Street address for the resident. city: type: string description: City of the resident's primary address state: type: string description: State of the resident's primary address zip: type: string description: Zip/Postal Code of the resident's primary address country: type: string description: Country of the resident's primary address _v1_residents_realpage_{id}_put_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: id: type: string description: The Propexo ID associated with this resident last_name: type: string maxLength: 30 description: The last name of the resident. first_name: type: string maxLength: 30 description: The first name of the resident. middle_name: type: string maxLength: 30 description: The middle name of the resident. email_1: type: string format: email description: The primary email address for the resident. address_1: type: string description: Street address for the resident. address_2: type: string description: Street address for the resident. city: type: string description: City of the resident's primary address state: type: string description: State of the resident's primary address zip: type: string description: Zip/Postal Code of the resident's primary address country: type: string description: Country of the resident's primary address required: - id required: - meta - result _v1_residents_rentvine_{resident_id}_put_input: type: object properties: first_name: type: string description: The first name associated with the resident middle_name: type: string description: The middle name associated with the resident last_name: type: string description: The last name associated with the resident email_1: type: string format: email description: The primary email address associated with the resident date_of_birth: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date of birth associated with the resident address_1: type: string description: The first address line associated with the resident address_2: type: string description: The second address line associated with the resident city: type: string description: The city associated with the resident state: type: string enum: *a22 description: The state associated with the resident zip: type: string description: The zip code associated with the resident country: type: string enum: *a23 description: The country associated with the resident phone_1: type: string pattern: ^\+?\d{1,50}$ description: Primary phone number associated with the resident phone_1_type: type: string enum: - MOBILE - HOME - WORK - FAX - OTHER description: Type of the primary phone number is_primary: type: boolean description: Whether the resident is the primary record _v1_residents_rentvine_{resident_id}_put_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: resident_id: type: string description: The Propexo unique identifier for the resident. The resident must be a primary. first_name: type: string description: The first name associated with the resident middle_name: type: string description: The middle name associated with the resident last_name: type: string description: The last name associated with the resident email_1: type: string format: email description: The primary email address associated with the resident date_of_birth: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date of birth associated with the resident address_1: type: string description: The first address line associated with the resident address_2: type: string description: The second address line associated with the resident city: type: string description: The city associated with the resident state: type: string enum: *a22 description: The state associated with the resident zip: type: string description: The zip code associated with the resident country: type: string enum: *a23 description: The country associated with the resident phone_1: type: string pattern: ^\+?\d{1,50}$ description: Primary phone number associated with the resident phone_1_type: type: string enum: - MOBILE - HOME - WORK - FAX - OTHER description: Type of the primary phone number is_primary: type: boolean description: Whether the resident is the primary record required: - resident_id required: - meta - result _v1_residents_yardi_{resident_id}_put_input: type: object properties: first_name: type: string description: The first name of the resident. last_name: type: string description: The last name of the resident. email_1: type: string format: email description: The primary email address for the resident. phone_1: type: string description: The primary phone number for the resident. phone_1_type: type: string enum: *a230 description: The primary phone type for the resident. Required when updating phone number. _v1_residents_yardi_{resident_id}_put_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: resident_id: type: string description: The Propexo unique identifier for the resident first_name: type: string description: The first name of the resident. last_name: type: string description: The last name of the resident. email_1: type: string format: email description: The primary email address for the resident. phone_1: type: string description: The primary phone number for the resident. phone_1_type: type: string enum: *a230 description: The primary phone type for the resident. Required when updating phone number. required: - resident_id required: - meta - result _v1_residents_yardi__post_input: type: object properties: {} _v1_residents_yardi__post_output: type: object properties: {} _v1_resident-pets_rentvine__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration resident_id: type: string description: The Propexo unique identifier for the resident is_service_animal: type: boolean description: Whether the resident pet is a service animal age_in_years: type: integer minimum: 0 description: The age in years of the resident pet color: type: string description: The color of the resident pet gender_raw: type: string description: The raw value for the gender of the resident pet is_fixed: type: boolean description: Whether the resident pet is fixed name: type: string description: The name associated with the resident pet type: type: string description: The type associated with the resident pet weight_in_pounds: type: integer minimum: 0 description: The weight in pounds of the resident pet required: - integration_id - resident_id - type _v1_resident-pets_rentvine__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration resident_id: type: string description: The Propexo unique identifier for the resident is_service_animal: type: - boolean - "null" description: Whether the resident pet is a service animal age_in_years: type: - integer - "null" minimum: 0 description: The age in years of the resident pet color: type: - string - "null" description: The color of the resident pet gender_raw: type: - string - "null" description: The raw value for the gender of the resident pet is_fixed: type: - boolean - "null" description: Whether the resident pet is fixed name: type: - string - "null" description: The name associated with the resident pet type: type: string description: The type associated with the resident pet weight_in_pounds: type: - integer - "null" minimum: 0 description: The weight in pounds of the resident pet required: - integration_id - resident_id - is_service_animal - age_in_years - color - gender_raw - is_fixed - name - type - weight_in_pounds required: - meta - result _v1_resident-pets_rentvine_{pet_id}_put_input: type: object properties: is_service_animal: type: boolean description: Whether the resident pet is a service animal age_in_years: type: integer minimum: 0 description: The age in years of the resident pet color: type: string description: The color of the resident pet gender_raw: type: string description: The raw value for the gender of the resident pet is_fixed: type: boolean description: Whether the resident pet is fixed name: type: string description: The name associated with the resident pet type: type: string description: The type associated with the resident pet weight_in_pounds: type: integer minimum: 0 description: The weight in pounds of the resident pet required: - type _v1_resident-pets_rentvine_{pet_id}_put_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: pet_id: type: string description: The Propexo unique identifier for the resident pet is_service_animal: type: boolean description: Whether the resident pet is a service animal age_in_years: type: integer minimum: 0 description: The age in years of the resident pet color: type: string description: The color of the resident pet gender_raw: type: string description: The raw value for the gender of the resident pet is_fixed: type: boolean description: Whether the resident pet is fixed name: type: string description: The name associated with the resident pet type: type: string description: The type associated with the resident pet weight_in_pounds: type: integer minimum: 0 description: The weight in pounds of the resident pet required: - pet_id - type required: - meta - result _v1_residents_rentmanager_{resident_id}_custom-data_post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration custom_data: type: object description: A mapping of the fields you want to update and the associated values. Rent Manager has a limit of 10 key/value pairs additionalProperties: *a202 required: - integration_id - custom_data _v1_residents_rentmanager_{resident_id}_custom-data_post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration resident_id: type: string description: The Propexo unique identifier for the resident custom_data: type: object additionalProperties: *a202 required: - integration_id - resident_id - custom_data required: - meta - result _v1_residents_rentmanager_{resident_id}_custom-data_put_input: type: object properties: custom_data: type: object description: A mapping of the fields you want to update and the associated values. Rent Manager has a limit of 10 key/value pairs additionalProperties: *a202 required: - custom_data _v1_residents_rentmanager_{resident_id}_custom-data_put_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: resident_id: type: string description: The Propexo unique identifier for the resident custom_data: type: object description: A mapping of the fields you want to update and the associated values. Rent Manager has a limit of 10 key/value pairs additionalProperties: *a202 required: - resident_id - custom_data required: - meta - result _v1_residents_buildium_{resident_id}_file-upload__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration attachments: type: array items: type: object properties: title: type: string maxLength: 255 description: A title for the file file_type_id: type: string description: The Propexo unique identifier for the file type file_data: type: string maxLength: 27892121 description: The contents of the file, as a base64 encoded string. The PMS has a max file size of 20 MB. file_name: type: string description: 'The name of the file including the extension. Ex: "resume.pdf"' mime_type: type: string description: 'The mime type of the file. Ex: "application/pdf"' required: - title - file_type_id - file_data - file_name - mime_type minItems: 1 description: Files w/ metadata for the resident. All the files can have a maximum combined file size of 50 MB required: - integration_id - attachments _v1_residents_buildium_{resident_id}_file-upload__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration resident_id: type: string description: The Propexo unique identifier for the resident attachments: type: array items: type: object properties: title: type: string maxLength: 255 description: A title for the file file_type_id: type: string description: The Propexo unique identifier for the file type file_data: type: - string - "null" maxLength: 27892121 description: The contents of the file, as a base64 encoded string. The PMS has a max file size of 20 MB. file_name: type: string description: 'The name of the file including the extension. Ex: "resume.pdf"' mime_type: type: string description: 'The mime type of the file. Ex: "application/pdf"' required: - title - file_type_id - file_name - mime_type required: - integration_id - resident_id - attachments required: - meta - result _v1_residents_entrata_{id}_file-upload__post_input: type: object properties: {} _v1_residents_entrata_{id}_file-upload__post_output: type: object properties: {} _v1_residents_propertyware_{resident_id}_file-upload__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration attachment: type: object properties: file_data: type: string maxLength: 16735272 description: The contents of the file, as a base64 encoded string. The PMS has a max file size of 12 MB. file_name: type: string description: 'The name of the file including the extension. Ex: "resume.pdf"' mime_type: type: string description: 'The mime type of the file. Ex: "application/pdf"' required: - file_data - file_name - mime_type description: Attachment file on the Resident notes: type: string description: General notes about the file is_private: type: boolean description: If the file should be marked as private required: - integration_id - attachment _v1_residents_propertyware_{resident_id}_file-upload__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration resident_id: type: string description: The Propexo unique identifier for the resident attachment: type: object properties: file_data: type: - string - "null" maxLength: 16735272 description: The contents of the file, as a base64 encoded string. The PMS has a max file size of 12 MB. file_name: type: string description: 'The name of the file including the extension. Ex: "resume.pdf"' mime_type: type: string description: 'The mime type of the file. Ex: "application/pdf"' required: - file_name - mime_type notes: type: - string - "null" is_private: type: - boolean - "null" required: - integration_id - resident_id - attachment - notes - is_private required: - meta - result _v1_residents_rentmanager_{resident_id}_file-upload__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration attachments: type: array items: type: object properties: file_type_id: type: string description: The Propexo unique identifier for the file type. This file_type must contain a "type" value of "file" file_type: type: string enum: *a227 default: Document description: The type of file being uploaded. This defaults to "Document" file_data: type: string maxLength: 40443576 description: The contents of the file, as a base64 encoded string. The PMS has a max file size of 29 MB. file_name: type: string description: 'The name of the file including the extension. Ex: "resume.pdf"' mime_type: type: string description: 'The mime type of the file. Ex: "application/pdf"' required: - file_type_id - file_data - file_name - mime_type description: Attachment files for user defined fields on the resident. All the files can have a maximum combined file size of 50 MB required: - integration_id - attachments _v1_residents_rentmanager_{resident_id}_file-upload__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration resident_id: type: string description: The Propexo unique identifier for the resident attachments: type: array items: type: object properties: file_type_id: type: string description: The Propexo unique identifier for the file type. This file_type must contain a "type" value of "file" file_type: type: string enum: *a227 default: Document file_data: type: - string - "null" maxLength: 40443576 description: The contents of the file, as a base64 encoded string. The PMS has a max file size of 29 MB. file_name: type: string description: 'The name of the file including the extension. Ex: "resume.pdf"' mime_type: type: string description: 'The mime type of the file. Ex: "application/pdf"' required: - file_type_id - file_name - mime_type required: - integration_id - resident_id - attachments required: - meta - result _v1_residents_rentmanager_{resident_id}_notes__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration category_id: type: string description: The Propexo unique identifier for the note category notes: type: string description: Notes associated with the resident attachment: type: object properties: file_data: type: string maxLength: 40443576 description: The contents of the file, as a base64 encoded string. The PMS has a max file size of 29 MB. file_name: type: string description: 'The name of the file including the extension. Ex: "resume.pdf"' mime_type: type: string description: 'The mime type of the file. Ex: "application/pdf"' required: - file_data - file_name - mime_type description: Attachment file for the note on the resident required: - integration_id - notes _v1_residents_rentmanager_{resident_id}_notes__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration resident_id: type: string description: The Propexo unique identifier for the resident category_id: type: - string - "null" notes: type: string description: Notes associated with the resident attachment: type: - object - "null" properties: file_data: type: - string - "null" maxLength: 40443576 description: The contents of the file, as a base64 encoded string. The PMS has a max file size of 29 MB. file_name: type: string description: 'The name of the file including the extension. Ex: "resume.pdf"' mime_type: type: string description: 'The mime type of the file. Ex: "application/pdf"' required: - file_name - mime_type required: - integration_id - resident_id - category_id - notes - attachment required: - meta - result _v1_residents_mri_{resident_id}_notes__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration note_category_id: type: string description: The Propexo unique identifier for the note category notes: type: string description: Notes associated with the resident required: - integration_id - note_category_id - notes _v1_residents_mri_{resident_id}_notes__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration resident_id: type: string description: The Propexo unique identifier for the resident note_category_id: type: string description: The Propexo unique identifier for the note category notes: type: string description: Notes associated with the resident required: - integration_id - resident_id - note_category_id - notes required: - meta - result _v1_residents_mri_{resident_id}_file-upload__post_input: type: object properties: {} _v1_residents_mri_{resident_id}_file-upload__post_output: type: object properties: {} _v1_residents_rentvine_{resident_id}_file-upload__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration attachment: type: object properties: file_data: type: string maxLength: 69730304 description: The contents of the file, as a base64 encoded string. We limit the file upload size to 50 MB. file_name: type: string description: 'The name of the file including the extension. Ex: "resume.pdf"' mime_type: type: string description: 'The mime type of the file. Ex: "application/pdf"' required: - file_data - file_name - mime_type description: The file data for the document upload. required: - integration_id - attachment _v1_residents_rentvine_{resident_id}_file-upload__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration resident_id: type: string description: The Propexo unique identifier for the resident attachment: type: object properties: file_data: type: - string - "null" maxLength: 69730304 description: The contents of the file, as a base64 encoded string. We limit the file upload size to 50 MB. file_name: type: string description: 'The name of the file including the extension. Ex: "resume.pdf"' mime_type: type: string description: 'The mime type of the file. Ex: "application/pdf"' required: - file_name - mime_type required: - integration_id - resident_id - attachment required: - meta - result _v1_residents_yardi_{resident_id}_file-upload__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration attachment: type: object properties: file_type_id: type: string description: The Propexo unique identifier for the file type. The file type provided must be listed as being compatible with the Residents model. file_data: type: string maxLength: 66500000 file_extension: type: string enum: &a231 - pdf - doc - docx - xls - xlsx - jpg - jpeg - png description: The file extension for the attachment being uploaded description: type: string description: A description of the file being uploaded required: - file_type_id - file_data - file_extension - description description: PDF to attach to the Resident required: - integration_id - attachment _v1_residents_yardi_{resident_id}_file-upload__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration resident_id: type: string description: The Propexo unique identifier for the resident attachment: type: object properties: file_type_id: type: string description: The Propexo unique identifier for the file type. The file type provided must be listed as being compatible with the Residents model. file_data: type: - string - "null" maxLength: 66500000 file_extension: type: string enum: *a231 description: The file extension for the attachment being uploaded description: type: string description: A description of the file being uploaded required: - file_type_id - file_extension - description required: - integration_id - resident_id - attachment required: - meta - result _v1_residents_yardi_rest_{resident_id}_file-upload__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration attachment: type: object properties: file_type_id: type: string description: The Propexo unique identifier for the file type. The file type provided must be listed as being compatible with the Residents model. file_data: type: string maxLength: 66500000 file_extension: type: string enum: &a232 - pdf - doc - docx - xls - xlsx - jpg - jpeg - png description: The file extension for the attachment being uploaded description: type: string description: A description of the file being uploaded required: - file_type_id - file_data - file_extension - description description: PDF to attach to the Resident required: - integration_id - attachment _v1_residents_yardi_rest_{resident_id}_file-upload__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration resident_id: type: string description: The Propexo unique identifier for the resident attachment: type: object properties: file_type_id: type: string description: The Propexo unique identifier for the file type. The file type provided must be listed as being compatible with the Residents model. file_data: type: - string - "null" maxLength: 66500000 file_extension: type: string enum: *a232 description: The file extension for the attachment being uploaded description: type: string description: A description of the file being uploaded required: - file_type_id - file_extension - description required: - integration_id - resident_id - attachment required: - meta - result _v1_service-requests__get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query x_id: type: string description: The external ID from the integration vendor location_id: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. unit_id: type: string description: The Propexo unique identifier for the unit employee_id: type: string description: The Propexo unique identifier for the employee vendor_id: type: string description: The Propexo unique identifier for the vendor property_id: type: string description: The Propexo unique identifier for the property integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" unit_number: type: string description: The unit number of the service request. When using this, the Propexo `property_id` filter must be added as well. ServiceRequest: type: object properties: id: type: string description: The Propexo unique identifier for the service request created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_unit_id: type: - string - "null" description: The external ID of the unit from the integration vendor x_sub_task_id: type: - string - "null" description: The external ID of the sub task from the integration vendor access_is_authorized: type: - boolean - "null" description: Whether or not the tenant has granted permission to enter the unit associated with the service request access_notes: type: - string - "null" description: Notes regarding access to the unit associated with the service request building: type: - string - "null" description: The building name associated with the service request completion_notes: type: - string - "null" description: Closing notes associated with the service request date_completed: type: - string - "null" description: The date the service request was completed date_created: type: - string - "null" description: The date the service request was created date_due: type: - string - "null" description: The due date associated with the service request date_scheduled: type: - string - "null" description: The date the service request is scheduled notes: type: - string - "null" description: "DEPRECATED: Please use 'history' for reading notes regarding the service request" deprecated: true x-fern-availability: deprecated service_category: type: - string - "null" description: The category of service request service_description: type: - string - "null" description: A description of the service request service_details: type: - string - "null" description: Details about the service request service_priority: type: - string - "null" description: The priority level associated with the service request status_raw: type: - string - "null" description: The raw status associated with the service request vendor_notes: type: - string - "null" description: Vendor/technician notes associated with the service request unit_number: type: - string - "null" description: The unit number associated with the service request. This isn't always provided by PMS vendors, but may be the only data provided to identify a unit associated with a service request in some cases. order_number: type: - string - "null" description: The order number of the service request integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" property_id: type: string description: The Propexo unique identifier for the property unit_id: type: - string - "null" description: The Propexo unique identifier for the unit employee_id: type: - string - "null" description: The Propexo unique identifier for the employee vendors: type: array items: type: object properties: vendor_id: type: string required: - vendor_id x-propexo: &a350 derivedFromModel: service_requests_to_vendors history: type: array items: type: object properties: id: type: string description: The Propexo unique identifier for the service request history created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: string description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_created_at: type: - string - "null" description: The date the record first entered the integration vendor notes: type: string description: Notes describing the service request history creator_name: type: - string - "null" description: The name of the person or user that created the service request history status_raw: type: - string - "null" description: The raw status from the service request history service_request_id: type: string description: The Propexo unique identifier for the service request required: - id - created_at - updated_at - last_seen - x_id - x_created_at - notes - creator_name - status_raw - service_request_id x-propexo: derivedFromModel: service_request_notes employees: type: array items: type: object properties: id: type: string description: The Propexo unique identifier for the employee created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor name: type: - string - "null" description: The name associated with the employee required: - id - created_at - updated_at - last_seen - x_id - name x-propexo: &a351 derivedFromModel: employees required: - id - created_at - updated_at - last_seen - x_id - x_property_id - x_location_id - x_unit_id - x_sub_task_id - access_is_authorized - access_notes - building - completion_notes - date_completed - date_created - date_due - date_scheduled - notes - service_category - service_description - service_details - service_priority - status_raw - vendor_notes - unit_number - order_number - integration_id - integration_vendor - property_id - unit_id - employee_id - vendors - history - employees _v1_service-requests__get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: type: array items: $ref: "#/components/schemas/ServiceRequest" required: - meta - results _v1_service-requests__post_input: type: object properties: employee_id: type: string description: The Propexo unique identifier for the employee. Please note that due to a lack of proper unique IDs in Resman, multiple duplicate employees may exist for the same actual employee. You may use any one of those duplicate record IDs for this API call. integration_id: type: string vendor_id: type: string description: The Propexo unique identifier for the vendor property_id: type: string description: The Propexo unique identifier for the property resident_id: type: string description: The Propexo unique identifier for the resident unit_id: type: string description: The Propexo unique identifier for the unit service_description: type: string maxLength: 35 description: A description of the service request service_priority: type: string enum: &a234 - High - Low - Med - 24 hours - Emergency description: The priority level associated with the service request service_status: type: string enum: &a236 - New - InProgress - Completed - Deferred - Closed description: The status associated with the service request access_is_authorized: type: boolean description: Whether or not the tenant has granted permission to enter the unit associated with the service request service_details: type: string description: Details about the service request access_notes: type: string description: Notes regarding access to the unit associated with the service request date_due: type: string format: date-time description: The due date associated with the service request invoice_number: type: string description: The invoice or reference number that the vendor assigned to the service request notes: type: string maxLength: 65535 description: Notes associated with the service request service_request_category_id: type: string description: The Propexo unique identifier for the service request category service_request_priority_id: type: string description: The Propexo unique identifier for the service request priority service_request_location_id: type: string description: The Propexo unique identifier for the service request location service_request_problem_id: type: string description: The Propexo unique identifier for the service request problem due_date: type: string format: date-time description: The due date associated with the service request is_floating: type: boolean scheduled_end_date: type: string format: date-time description: The scheduled end date associated with the request. If provided, scheduled_start_date must be provided as well, and they must be the same day (Entrata restriction). scheduled_start_date: type: string format: date-time description: The scheduled start date associated with the request. If provided, scheduled_end_date must be provided as well, and they must be the same day (Entrata restriction). phone_1: type: string lease_id: type: string description: The Propexo unique identifier for the lease date_created: type: string format: date-time description: The date the service request was created status_raw: type: string enum: &a233 - Assessment - Call - Canceled - Completed - Electrical - Emergency - HVAC - In Progress - Inspection - On Hold - Other - Plumbing - Request Reassignment - Scheduled - Service - Web - Work Completed description: The raw status associated with the service request has_pets: type: boolean description: Whether there are pets associated with the unit has_alarm: type: boolean description: Whether there is an alarm associated with the unit completion_notes: type: string description: Closing notes associated with the service request date_entered: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date of entry for the service request date_scheduled: type: string format: date-time description: The date the service request is scheduled service_category: type: string enum: &a235 - Electrical - HVAC - Other - Plumbing - Service description: The category of service request date_completed: type: string format: date-time description: The date the service request was completed access_is_authorized_value: type: string enum: &a244 - ENTER_AT_ANY_TIME - BY_PERMISSION_ONLY - CALL_FOR_ENTRY description: 'Type of permission needed to enter the unit. Possible values: "ENTER_AT_ANY_TIME" - Enter any time, "BY_PERMISSION_ONLY" - By permission only, "CALL_FOR_ENTRY" - Call for entry' service_request_status_id: type: string description: The Propexo unique identifier for the service request status vendor_notes: type: string maxLength: 127 description: Vendor/technician notes associated with the service request reported_by: type: string description: The name of the person who reported this service request required: - integration_id _v1_service-requests__post_output: type: object properties: job_id: type: string description: The ID of the job created to handle this operation data: type: object properties: {} required: - job_id - data _v1_service-requests_{service_request_id}_get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query _v1_service-requests_{service_request_id}_get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: $ref: "#/components/schemas/ServiceRequest" required: - meta - results _v1_service-requests_{service_request_id}_put_input: type: object properties: service_request_category_id: type: string description: The Propexo unique identifier for the service request category service_request_priority_id: type: string description: The Propexo unique identifier for the service request priority service_request_location_id: type: string description: The Propexo unique identifier for the service request location service_request_problem_id: type: string description: The Propexo unique identifier for the service request problem service_description: type: string maxLength: 35 description: A description of the service request phone_1: type: string description: Primary phone number associated with the service request phone_2: type: string description: Secondary phone number associated with the service request email_1: type: string description: The primary email address associated with the service request scheduled_start_date: type: string format: date-time description: The scheduled start date associated with the request. due_date: type: string format: date-time description: The due date associated with the service request resident_id: type: string description: The Propexo unique identifier for the resident service_details: type: string description: Details about the service request date_created: type: string format: date-time description: The date the service request was created status_raw: type: string enum: *a233 description: The raw status associated with the service request access_is_authorized: type: boolean description: Whether or not the tenant has granted permission to enter the unit associated with the service request service_priority: type: string enum: *a234 description: The priority level associated with the service request has_pets: type: boolean description: Whether there are pets associated with the unit has_alarm: type: boolean description: Whether there is an alarm associated with the unit completion_notes: type: string description: Closing notes associated with the service request date_entered: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date of entry for the service request date_scheduled: type: string format: date-time description: The date the service request is scheduled unit_id: type: string description: The Propexo unique identifier for the unit vendor_id: type: string description: The Propexo unique identifier for the vendor lease_id: type: string description: The Propexo unique identifier for the lease service_category: type: string enum: *a235 description: The category of service request date_completed: type: string format: date-time description: The date the service request was completed date_due: type: string format: date-time description: The due date associated with the service request service_request_status_id: type: string description: The Propexo unique identifier for the service request status employee_id: type: string description: The Propexo unique identifier for the employee reported_by: type: string description: The name of the person who reported this service request _v1_service-requests_{service_request_id}_put_output: type: object properties: job_id: type: string description: The ID of the job created to handle this operation data: type: object properties: {} required: - job_id - data _v1_service-request-categories__get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor location_id: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. property_id: type: string description: The Propexo unique identifier for the property integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" ServiceRequestCategory: type: object properties: id: type: string description: The Propexo unique identifier for the service request category created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. code: type: - string - "null" description: The code associated with the service request category description: type: - string - "null" description: Description of the service request category is_active: type: - boolean - "null" description: Whether the service request category is active name: type: - string - "null" description: The name associated with the service request category integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" property_id: type: string description: The Propexo unique identifier for the property required: - id - created_at - updated_at - last_seen - x_id - x_property_id - x_location_id - code - description - is_active - name - integration_id - integration_vendor - property_id x-propexo: derivedFromModel: service_request_categories _v1_service-request-categories__get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: type: array items: $ref: "#/components/schemas/ServiceRequestCategory" required: - meta - results _v1_service-request-categories_{service_request_category_id}_get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query _v1_service-request-categories_{service_request_category_id}_get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: $ref: "#/components/schemas/ServiceRequestCategory" required: - meta - results _v1_service-request-history__get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query service_request_id: type: string description: The Propexo unique identifier for the service request location_id: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. property_id: type: string description: The Propexo unique identifier for the property integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" ServiceRequestHistory: type: object properties: id: type: string description: The Propexo unique identifier for the service request history created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_created_at: type: - string - "null" description: The date the record first entered the integration vendor x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. notes: type: - string - "null" description: Notes associated with the service request history status_raw: type: - string - "null" description: The raw status associated with the service request history creator_name: type: - string - "null" description: The name or username of the person who created the service request history record service_request_id: type: string description: The Propexo unique identifier for the service request integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" property_id: type: string description: The Propexo unique identifier for the property required: - id - created_at - updated_at - last_seen - x_created_at - x_id - x_property_id - x_location_id - notes - status_raw - creator_name - service_request_id - integration_id - integration_vendor - property_id x-propexo: derivedFromModel: service_request_notes _v1_service-request-history__get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: type: array items: $ref: "#/components/schemas/ServiceRequestHistory" required: - meta - results _v1_service-request-history__post_input: type: object properties: integration_id: type: string service_request_id: type: string description: The Propexo unique identifier for the service request employee_id: type: string description: The Propexo unique identifier for the employee status_raw: type: string enum: *a233 description: The raw status associated with the service request history notes: type: string description: Notes associated with the service request history contact_first_name: type: string description: Notes associated with the service request history title: type: string description: The title associated with the service request history attachment: type: object properties: file_data: type: string maxLength: 40443576 description: The contents of the file, as a base64 encoded string. The PMS has a max file size of 29 MB. file_name: type: string description: 'The name of the file including the extension. Ex: "resume.pdf"' mime_type: type: string description: 'The mime type of the file. Ex: "application/pdf"' required: - file_data - file_name - mime_type description: Attachment file associated with the service request history required: - integration_id _v1_service-request-history__post_output: type: object properties: job_id: type: string description: The ID of the job created to handle this operation data: type: object properties: {} required: - job_id - data _v1_service-request-history_{service_request_history_id}_get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query _v1_service-request-history_{service_request_history_id}_get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: $ref: "#/components/schemas/ServiceRequestHistory" required: - meta - results _v1_service-request-priorities__get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor location_id: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. property_id: type: string description: The Propexo unique identifier for the property integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" ServiceRequestPriority: type: object properties: id: type: string description: The Propexo unique identifier for the service request category created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. code: type: - string - "null" description: The code associated with the service request category description: type: - string - "null" description: Description of the service request category is_active: type: - boolean - "null" description: Whether the service request category is active name: type: - string - "null" description: The name associated with the service request category integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" property_id: type: string description: The Propexo unique identifier for the property required: - id - created_at - updated_at - last_seen - x_id - x_property_id - x_location_id - code - description - is_active - name - integration_id - integration_vendor - property_id x-propexo: derivedFromModel: service_request_priorities _v1_service-request-priorities__get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: type: array items: $ref: "#/components/schemas/ServiceRequestPriority" required: - meta - results _v1_service-request-priorities_{service_request_priority_id}_get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query _v1_service-request-priorities_{service_request_priority_id}_get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: $ref: "#/components/schemas/ServiceRequestPriority" required: - meta - results _v1_service-request-statuses__get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor location_id: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. property_id: type: string description: The Propexo unique identifier for the property integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" ServiceRequestStatus: type: object properties: id: type: string description: The Propexo unique identifier for the service request category created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. code: type: - string - "null" description: The code associated with the service request category description: type: - string - "null" description: Description of the service request category is_active: type: - boolean - "null" description: Whether the service request category is active name: type: - string - "null" description: The name associated with the service request category integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" property_id: type: string description: The Propexo unique identifier for the property required: - id - created_at - updated_at - last_seen - x_id - x_property_id - x_location_id - code - description - is_active - name - integration_id - integration_vendor - property_id x-propexo: derivedFromModel: service_request_statuses _v1_service-request-statuses__get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: type: array items: $ref: "#/components/schemas/ServiceRequestStatus" required: - meta - results _v1_service-request-statuses_{service_request_status_id}_get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query _v1_service-request-statuses_{service_request_status_id}_get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: $ref: "#/components/schemas/ServiceRequestStatus" required: - meta - results _v1_service-request-locations__get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query property_id: type: string description: The Propexo unique identifier for the property integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" ServiceRequestLocation: type: object properties: id: type: string description: The Propexo unique identifier for the service request location created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: type: string description: The name of the service request location type: type: - string - "null" description: The type of location integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" property_id: type: string description: The Propexo unique identifier for the property required: - id - created_at - updated_at - last_seen - x_id - x_property_id - x_location_id - name - type - integration_id - integration_vendor - property_id x-propexo: derivedFromModel: service_request_locations _v1_service-request-locations__get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: type: array items: $ref: "#/components/schemas/ServiceRequestLocation" required: - meta - results _v1_service-request-locations_{service_request_location_id}_get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query property_id: type: string description: The Propexo unique identifier for the property integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" _v1_service-request-locations_{service_request_location_id}_get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: $ref: "#/components/schemas/ServiceRequestLocation" required: - meta - results _v1_service-request-problems__get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query property_id: type: string description: The Propexo unique identifier for the property integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" ServiceRequestProblem: type: object properties: id: type: string description: The Propexo unique identifier for the service request location created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: type: string description: The name of the service request problem service_request_category_id: type: - string - "null" description: The Propexo unique identifier for the service request category integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" property_id: type: string description: The Propexo unique identifier for the property required: - id - created_at - updated_at - last_seen - x_id - x_property_id - x_location_id - name - service_request_category_id - integration_id - integration_vendor - property_id x-propexo: derivedFromModel: service_request_problems _v1_service-request-problems__get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: type: array items: $ref: "#/components/schemas/ServiceRequestProblem" required: - meta - results _v1_service-request-problems_{service_request_problem_id}_get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query property_id: type: string description: The Propexo unique identifier for the property integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" _v1_service-request-problems_{service_request_problem_id}_get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: $ref: "#/components/schemas/ServiceRequestProblem" required: - meta - results _v1_service-requests_buildium__post_input: type: object properties: employee_id: type: string description: The Propexo unique identifier for the employee integration_id: type: string description: The Propexo unique identifier for the integration vendor_id: type: string description: The Propexo unique identifier for the vendor property_id: type: string description: The Propexo unique identifier for the property resident_id: type: string description: The Propexo unique identifier for the resident unit_id: type: string description: The Propexo unique identifier for the unit service_description: type: string maxLength: 127 description: A description of the service request service_priority: type: string enum: &a237 - Low - Normal - High description: The priority level associated with the service request service_status: type: string enum: *a236 description: The status associated with the service request access_is_authorized: type: boolean description: Whether or not the tenant has granted permission to enter the unit associated with the service request service_details: type: string maxLength: 65535 description: Details about the service request access_notes: type: string maxLength: 65535 description: Notes regarding access to the unit associated with the service request date_due: type: string format: date-time description: The due date associated with the service request invoice_number: type: string description: The invoice or reference number that the vendor assigned to the service request notes: type: string maxLength: 65535 description: Notes associated with the service request required: - employee_id - integration_id - vendor_id - property_id - service_description - service_priority - service_status _v1_service-requests_buildium__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: employee_id: type: string description: The Propexo unique identifier for the employee integration_id: type: string description: The Propexo unique identifier for the integration vendor_id: type: string description: The Propexo unique identifier for the vendor property_id: type: string description: The Propexo unique identifier for the property resident_id: type: - string - "null" description: The Propexo unique identifier for the resident unit_id: type: - string - "null" description: The Propexo unique identifier for the unit service_description: type: string maxLength: 127 description: A description of the service request service_priority: type: string enum: *a237 description: The priority level associated with the service request service_status: type: string enum: *a236 description: The status associated with the service request access_is_authorized: type: - boolean - "null" description: Whether or not the tenant has granted permission to enter the unit associated with the service request service_details: type: - string - "null" maxLength: 65535 description: Details about the service request access_notes: type: - string - "null" maxLength: 65535 description: Notes regarding access to the unit associated with the service request date_due: type: - string - "null" format: date-time description: The due date associated with the service request invoice_number: type: - string - "null" description: The invoice or reference number that the vendor assigned to the service request notes: type: - string - "null" maxLength: 65535 description: Notes associated with the service request required: - employee_id - integration_id - vendor_id - property_id - resident_id - unit_id - service_description - service_priority - service_status - access_is_authorized - service_details - access_notes - date_due - invoice_number - notes required: - meta - result _v1_service-requests_mri__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration resident_id: type: string description: The Propexo unique identifier for the resident service_description: type: string description: A description of the service request service_details: type: string description: Details about the service request date_created: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date the service request was created status_raw: type: string enum: &a238 - ACCEPTED - ARRIVED - DEPARTED - IN_PROCESS - NO_ACTION - OUTSIDE_CONTRACTOR_CALLED - PARTS_ON_ORDER - PENDING_BOARD_APPROVAL - REJECTED - REPAIRED_TEMPORARILY - SUSPENDED - WORK_COMPLETED - WORK_SCHEDULED description: The status associated with the service request access_is_authorized: type: boolean description: Whether or not the tenant has granted permission to enter the unit associated with the service request service_priority: type: string enum: &a239 - HIGH - MEDIUM - LOW description: The priority level associated with the service request has_pets: type: boolean description: Whether there are pets associated with the unit has_alarm: type: boolean description: Whether there is an alarm associated with the unit completion_notes: type: string description: Closing notes associated with the service request date_entered: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date of entry for the service request date_scheduled: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date the service request is scheduled required: - integration_id - resident_id - service_description - service_details - date_created - status_raw - access_is_authorized _v1_service-requests_mri__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration resident_id: type: string description: The Propexo unique identifier for the resident service_description: type: string description: A description of the service request service_details: type: string description: Details about the service request date_created: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" status_raw: type: string enum: *a238 description: The status associated with the service request access_is_authorized: type: boolean description: Whether or not the tenant has granted permission to enter the unit associated with the service request service_priority: type: - string - "null" enum: *a239 description: The priority level associated with the service request has_pets: type: - boolean - "null" description: Whether there are pets associated with the unit has_alarm: type: - boolean - "null" description: Whether there is an alarm associated with the unit completion_notes: type: - string - "null" description: Closing notes associated with the service request date_entered: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" description: The date of entry for the service request date_scheduled: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" description: The date the service request is scheduled required: - integration_id - resident_id - service_description - service_details - date_created - status_raw - access_is_authorized - service_priority - has_pets - has_alarm - completion_notes - date_entered - date_scheduled required: - meta - result _v1_service-requests_mri_{service_request_id}_put_input: type: object properties: resident_id: type: string description: The Propexo unique identifier for the resident service_description: type: string description: A description of the service request service_details: type: string description: Details about the service request date_created: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date the service request was created status_raw: type: string enum: &a240 - ACCEPTED - ARRIVED - DEPARTED - IN_PROCESS - NO_ACTION - OUTSIDE_CONTRACTOR_CALLED - PARTS_ON_ORDER - PENDING_BOARD_APPROVAL - REJECTED - REPAIRED_TEMPORARILY - SUSPENDED - WORK_COMPLETED - WORK_SCHEDULED description: The status associated with the service request access_is_authorized: type: boolean description: Whether or not the tenant has granted permission to enter the unit associated with the service request service_priority: type: string enum: &a241 - HIGH - MEDIUM - LOW description: The priority level associated with the service request has_pets: type: boolean description: Whether there are pets associated with the unit has_alarm: type: boolean description: Whether there is an alarm associated with the unit completion_notes: type: string description: Closing notes associated with the service request date_entered: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date of entry for the service request date_scheduled: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date the service request is scheduled required: - resident_id _v1_service-requests_mri_{service_request_id}_put_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: service_request_id: type: string description: The Propexo unique identifier for the service request resident_id: type: string description: The Propexo unique identifier for the resident service_description: type: string description: A description of the service request service_details: type: string description: Details about the service request date_created: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date the service request was created status_raw: type: string enum: *a240 description: The status associated with the service request access_is_authorized: type: boolean description: Whether or not the tenant has granted permission to enter the unit associated with the service request service_priority: type: string enum: *a241 description: The priority level associated with the service request has_pets: type: boolean description: Whether there are pets associated with the unit has_alarm: type: boolean description: Whether there is an alarm associated with the unit completion_notes: type: string description: Closing notes associated with the service request date_entered: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date of entry for the service request date_scheduled: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date the service request is scheduled required: - service_request_id - resident_id required: - meta - result _v1_service-requests_rentmanager__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration property_id: type: string description: The Propexo unique identifier for the property service_description: type: string description: A description of the service request service_details: type: string description: Details about the service request access_is_authorized: type: boolean description: Whether or not the tenant has granted permission to enter the unit associated with the service request date_completed: type: string format: date-time description: The date the service request was completed date_due: type: string format: date-time description: The due date associated with the service request date_scheduled: type: string format: date-time description: The date the service request is scheduled service_request_category_id: type: string description: The Propexo unique identifier for the service request category service_request_priority_id: type: string description: The Propexo unique identifier for the service request priority service_request_status_id: type: string description: The Propexo unique identifier for the service request status vendor_id: type: string description: The Propexo unique identifier for the vendor. Must be associated with the property_id passed in unit_id: type: string description: The Propexo unique identifier for the unit employee_id: type: string description: The Propexo unique identifier for the employee required: - integration_id - property_id - service_description - service_details _v1_service-requests_rentmanager__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration property_id: type: string description: The Propexo unique identifier for the property service_description: type: string description: A description of the service request service_details: type: string description: Details about the service request access_is_authorized: type: - boolean - "null" description: Whether or not the tenant has granted permission to enter the unit associated with the service request date_completed: type: - string - "null" format: date-time description: The date the service request was completed date_due: type: - string - "null" format: date-time description: The due date associated with the service request date_scheduled: type: - string - "null" format: date-time description: The date the service request is scheduled service_request_category_id: type: - string - "null" description: The Propexo unique identifier for the service request category service_request_priority_id: type: - string - "null" description: The Propexo unique identifier for the service request priority service_request_status_id: type: - string - "null" description: The Propexo unique identifier for the service request status vendor_id: type: - string - "null" description: The Propexo unique identifier for the vendor. Must be associated with the property_id passed in unit_id: type: - string - "null" description: The Propexo unique identifier for the unit employee_id: type: - string - "null" description: The Propexo unique identifier for the employee required: - integration_id - property_id - service_description - service_details - access_is_authorized - date_completed - date_due - date_scheduled - service_request_category_id - service_request_priority_id - service_request_status_id - vendor_id - unit_id - employee_id required: - meta - result _v1_service-requests_rentmanager_{service_request_id}_put_input: type: object properties: service_description: type: string description: A description of the service request service_details: type: string description: Details about the service request access_is_authorized: type: boolean description: Whether or not the tenant has granted permission to enter the unit associated with the service request date_completed: type: string format: date-time description: The date the service request was completed date_due: type: string format: date-time description: The due date associated with the service request date_scheduled: type: string format: date-time description: The date the service request is scheduled service_request_category_id: type: string description: The Propexo unique identifier for the service request category service_request_priority_id: type: string description: The Propexo unique identifier for the service request priority service_request_status_id: type: string description: The Propexo unique identifier for the service request status vendor_id: type: string description: The Propexo unique identifier for the vendor. Must be associated with the property_id passed in employee_id: type: string description: The Propexo unique identifier for the employee required: - service_description - service_details _v1_service-requests_rentmanager_{service_request_id}_put_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: service_request_id: type: string description: The Propexo unique identifier for the service request service_description: type: string description: A description of the service request service_details: type: string description: Details about the service request access_is_authorized: type: boolean description: Whether or not the tenant has granted permission to enter the unit associated with the service request date_completed: type: string format: date-time description: The date the service request was completed date_due: type: string format: date-time description: The due date associated with the service request date_scheduled: type: string format: date-time description: The date the service request is scheduled service_request_category_id: type: string description: The Propexo unique identifier for the service request category service_request_priority_id: type: string description: The Propexo unique identifier for the service request priority service_request_status_id: type: string description: The Propexo unique identifier for the service request status vendor_id: type: string description: The Propexo unique identifier for the vendor. Must be associated with the property_id passed in employee_id: type: string description: The Propexo unique identifier for the employee required: - service_request_id - service_description - service_details required: - meta - result _v1_service-requests_resman__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration property_id: type: string description: The Propexo unique identifier for the property service_request_category_id: type: string description: The Propexo unique identifier for the service request category unit_id: type: string description: The Propexo unique identifier for the unit employee_id: type: string description: The Propexo unique identifier for the employee. Please note that due to a lack of proper unique IDs in Resman, multiple duplicate employees may exist for the same actual employee. You may use any one of those duplicate record IDs for this API call. date_created: type: string format: date-time description: The date the service request was created service_description: type: string description: A description of the service request reported_by: type: string description: The name of the person who reported this service request date_due: type: string format: date-time description: The due date associated with the service request status_raw: type: string enum: &a242 - Submitted - Not Started - In Progress - Completed - Scheduled - Cancelled - Closed - On Hold description: The status associated with the service request date_completed: type: string format: date-time description: The date the service request was completed required: - integration_id - property_id - service_request_category_id - date_created - service_description - reported_by - status_raw _v1_service-requests_resman__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration property_id: type: string description: The Propexo unique identifier for the property service_request_category_id: type: string description: The Propexo unique identifier for the service request category unit_id: type: - string - "null" description: The Propexo unique identifier for the unit employee_id: type: - string - "null" description: The Propexo unique identifier for the employee. Please note that due to a lack of proper unique IDs in Resman, multiple duplicate employees may exist for the same actual employee. You may use any one of those duplicate record IDs for this API call. date_created: type: string format: date-time description: The date the service request was created service_description: type: string description: A description of the service request reported_by: type: string description: The name of the person who reported this service request date_due: type: - string - "null" format: date-time description: The due date associated with the service request status_raw: type: string enum: *a242 description: The status associated with the service request date_completed: type: - string - "null" format: date-time description: The date the service request was completed required: - integration_id - property_id - service_request_category_id - unit_id - employee_id - date_created - service_description - reported_by - date_due - status_raw - date_completed required: - meta - result _v1_service-requests_resman_{service_request_id}_put_input: type: object properties: service_request_category_id: type: string description: The Propexo unique identifier for the service request category unit_id: type: string description: The Propexo unique identifier for the unit date_created: type: string format: date-time description: The date the service request was created service_description: type: string description: A description of the service request reported_by: type: string description: The name of the person who reported this service request date_due: type: string format: date-time description: The due date associated with the service request status_raw: type: string enum: *a242 description: The status associated with the service request date_completed: type: string format: date-time description: The date the service request was completed _v1_service-requests_resman_{service_request_id}_put_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: service_request_id: type: string description: The Propexo unique identifier for the service request service_request_category_id: type: string description: The Propexo unique identifier for the service request category unit_id: type: string description: The Propexo unique identifier for the unit date_created: type: string format: date-time description: The date the service request was created service_description: type: string description: A description of the service request reported_by: type: string description: The name of the person who reported this service request date_due: type: string format: date-time description: The due date associated with the service request status_raw: type: string enum: *a242 description: The status associated with the service request date_completed: type: string format: date-time description: The date the service request was completed required: - service_request_id required: - meta - result _v1_service-requests_entrata__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration property_id: type: string description: The Propexo unique identifier for the property service_request_category_id: type: string description: The Propexo unique identifier for the service request category service_request_priority_id: type: string description: The Propexo unique identifier for the service request priority service_request_location_id: type: string description: The Propexo unique identifier for the service request location service_request_problem_id: type: string description: The Propexo unique identifier for the service request problem employee_id: type: string description: The Propexo unique identifier for the employee service_description: type: string description: A description of the service request due_date: type: string format: date-time description: The due date associated with the service request access_is_authorized: type: boolean description: Whether or not the tenant has granted permission to enter the unit associated with the service request is_floating: type: boolean scheduled_end_date: type: string format: date-time description: The scheduled end date associated with the request. If provided, scheduled_start_date must be provided as well, and they must be the same day (Entrata restriction). scheduled_start_date: type: string format: date-time description: The scheduled start date associated with the request. If provided, scheduled_end_date must be provided as well, and they must be the same day (Entrata restriction). phone_1: type: string unit_id: type: string description: The Propexo unique identifier for the unit resident_id: type: string description: The Propexo unique identifier for the resident lease_id: type: string description: The Propexo unique identifier for the lease required: - integration_id - property_id - service_request_category_id - service_request_priority_id - service_request_location_id - service_request_problem_id - service_description - access_is_authorized - phone_1 _v1_service-requests_entrata__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration property_id: type: string description: The Propexo unique identifier for the property service_request_category_id: type: string description: The Propexo unique identifier for the service request category service_request_priority_id: type: string description: The Propexo unique identifier for the service request priority service_request_location_id: type: string description: The Propexo unique identifier for the service request location service_request_problem_id: type: string description: The Propexo unique identifier for the service request problem employee_id: type: - string - "null" description: The Propexo unique identifier for the employee service_description: type: string description: A description of the service request due_date: type: - string - "null" format: date-time description: The due date associated with the service request access_is_authorized: type: boolean description: Whether or not the tenant has granted permission to enter the unit associated with the service request is_floating: type: - boolean - "null" scheduled_end_date: type: - string - "null" format: date-time description: The scheduled end date associated with the request. If provided, scheduled_start_date must be provided as well, and they must be the same day (Entrata restriction). scheduled_start_date: type: - string - "null" format: date-time description: The scheduled start date associated with the request. If provided, scheduled_end_date must be provided as well, and they must be the same day (Entrata restriction). phone_1: type: string unit_id: type: - string - "null" description: The Propexo unique identifier for the unit resident_id: type: - string - "null" description: The Propexo unique identifier for the resident lease_id: type: - string - "null" description: The Propexo unique identifier for the lease required: - integration_id - property_id - service_request_category_id - service_request_priority_id - service_request_location_id - service_request_problem_id - employee_id - service_description - due_date - access_is_authorized - is_floating - scheduled_end_date - scheduled_start_date - phone_1 - unit_id - resident_id - lease_id required: - meta - result _v1_service-requests_entrata_{service_request_id}_put_input: type: object properties: service_request_category_id: type: string description: The Propexo unique identifier for the service request category service_request_priority_id: type: string description: The Propexo unique identifier for the service request priority service_request_location_id: type: string description: The Propexo unique identifier for the service request location service_request_problem_id: type: string description: The Propexo unique identifier for the service request problem service_description: type: string description: A description of the service request phone_1: type: string description: Primary phone number associated with the service request phone_2: type: string description: Secondary phone number associated with the service request email_1: type: string description: The primary email address associated with the service request scheduled_start_date: type: string format: date-time description: The scheduled start date associated with the request. due_date: type: string format: date-time description: The due date associated with the service request _v1_service-requests_entrata_{service_request_id}_put_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: service_request_id: type: string description: The Propexo unique identifier for the service request service_request_category_id: type: string description: The Propexo unique identifier for the service request category service_request_priority_id: type: string description: The Propexo unique identifier for the service request priority service_request_location_id: type: string description: The Propexo unique identifier for the service request location service_request_problem_id: type: string description: The Propexo unique identifier for the service request problem service_description: type: string description: A description of the service request phone_1: type: string description: Primary phone number associated with the service request phone_2: type: string description: Secondary phone number associated with the service request email_1: type: string description: The primary email address associated with the service request scheduled_start_date: type: string format: date-time description: The scheduled start date associated with the request. due_date: type: string format: date-time description: The due date associated with the service request required: - service_request_id required: - meta - result _v1_service-requests_yardi_{service_request_id}_put_input: type: object properties: unit_id: type: string description: The Propexo unique identifier for the unit resident_id: type: string description: The Propexo unique identifier for the resident vendor_id: type: string description: The Propexo unique identifier for the vendor access_is_authorized: type: boolean description: Whether or not the tenant has granted permission to enter the unit associated with the service request service_description: type: string maxLength: 35 description: A description of the service request service_details: type: string description: Details about the service request date_created: type: string format: date-time description: The date the service request was created service_category: type: string enum: *a235 description: The category of service request service_priority: type: string enum: *a234 description: The priority level associated with the service request status_raw: type: string enum: *a233 description: The raw status associated with the service request required: - access_is_authorized - service_description _v1_service-requests_yardi_{service_request_id}_put_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: service_request_id: type: string description: The Propexo unique identifier for the service request unit_id: type: string description: The Propexo unique identifier for the unit resident_id: type: string description: The Propexo unique identifier for the resident vendor_id: type: string description: The Propexo unique identifier for the vendor access_is_authorized: type: boolean description: Whether or not the tenant has granted permission to enter the unit associated with the service request service_description: type: string maxLength: 35 description: A description of the service request service_details: type: string description: Details about the service request date_created: type: string format: date-time description: The date the service request was created service_category: type: string enum: *a235 description: The category of service request service_priority: type: string enum: *a234 description: The priority level associated with the service request status_raw: type: string enum: *a233 description: The raw status associated with the service request required: - service_request_id - access_is_authorized - service_description required: - meta - result _v1_service-requests_yardi__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration property_id: type: string description: The Propexo unique identifier for the property unit_id: type: string description: The Propexo unique identifier for the unit resident_id: type: string description: The Propexo unique identifier for the resident vendor_id: type: string description: The Propexo unique identifier for the vendor access_is_authorized: type: boolean description: Whether or not the tenant has granted permission to enter the unit associated with the service request service_description: type: string maxLength: 35 description: A description of the service request service_details: type: string description: Details about the service request date_created: type: string format: date-time description: The date the service request was created service_category: type: string enum: *a235 description: The category of service request service_priority: type: string enum: *a234 description: The priority level associated with the service request status_raw: type: string enum: *a233 description: The raw status associated with the service request required: - integration_id - property_id - access_is_authorized - service_description _v1_service-requests_yardi__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration property_id: type: string description: The Propexo unique identifier for the property unit_id: type: - string - "null" description: The Propexo unique identifier for the unit resident_id: type: - string - "null" description: The Propexo unique identifier for the resident vendor_id: type: - string - "null" description: The Propexo unique identifier for the vendor access_is_authorized: type: boolean description: Whether or not the tenant has granted permission to enter the unit associated with the service request service_description: type: string maxLength: 35 description: A description of the service request service_details: type: - string - "null" description: Details about the service request date_created: type: - string - "null" format: date-time description: The date the service request was created service_category: type: - string - "null" enum: *a235 description: The category of service request service_priority: type: - string - "null" enum: *a234 description: The priority level associated with the service request status_raw: type: - string - "null" enum: *a233 description: The raw status associated with the service request required: - integration_id - property_id - unit_id - resident_id - vendor_id - access_is_authorized - service_description - service_details - date_created - service_category - service_priority - status_raw required: - meta - result _v1_service-requests_rentvine__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration property_id: type: string description: The Propexo unique identifier for the property service_request_status_id: type: string description: The Propexo unique identifier for the service request status vendor_id: type: string description: The Propexo unique identifier for the vendor resident_id: type: string description: The Propexo unique identifier for the resident unit_id: type: string description: The Propexo unique identifier for the unit employee_id: type: string description: The Propexo unique identifier for the employee service_description: type: string maxLength: 127 description: A description of the service request service_priority: type: string enum: - LOW - MEDIUM - HIGH description: The priority level associated with the service request date_scheduled: type: string format: date-time description: The date the service request is scheduled vendor_notes: type: string maxLength: 127 description: Vendor/technician notes associated with the service request required: - integration_id - property_id - service_request_status_id - service_description - service_priority _v1_service-requests_rentvine__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration property_id: type: string description: The Propexo unique identifier for the property service_request_status_id: type: string description: The Propexo unique identifier for the service request status vendor_id: type: - string - "null" description: The Propexo unique identifier for the vendor resident_id: type: - string - "null" description: The Propexo unique identifier for the resident unit_id: type: - string - "null" description: The Propexo unique identifier for the unit employee_id: type: - string - "null" description: The Propexo unique identifier for the employee service_description: type: string maxLength: 127 description: A description of the service request service_priority: type: string enum: - LOW - MEDIUM - HIGH description: The priority level associated with the service request date_scheduled: type: - string - "null" format: date-time description: The date the service request is scheduled vendor_notes: type: - string - "null" maxLength: 127 description: Vendor/technician notes associated with the service request required: - integration_id - property_id - service_request_status_id - vendor_id - resident_id - unit_id - employee_id - service_description - service_priority - date_scheduled - vendor_notes required: - meta - result _v1_service-requests_propertyware_{service_request_id}_put_input: type: object properties: unit_id: type: string description: The Propexo unique identifier for the unit vendor_id: type: string description: The Propexo unique identifier for the vendor lease_id: type: string description: The Propexo unique identifier for the lease access_is_authorized: type: boolean description: Whether or not the tenant has granted permission to enter the unit associated with the service request service_description: type: string description: A description of the service request service_category: type: string description: The category of service request date_completed: type: string format: date-time description: The date the service request was completed date_created: type: string format: date-time description: The date the service request was created service_details: type: string description: Details about the service request date_due: type: string format: date-time description: The due date associated with the service request date_scheduled: type: string format: date-time description: The date the service request is scheduled status_raw: type: string description: The status associated with the service request _v1_service-requests_propertyware_{service_request_id}_put_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: service_request_id: type: string description: The Propexo unique identifier for the service request unit_id: type: string description: The Propexo unique identifier for the unit vendor_id: type: string description: The Propexo unique identifier for the vendor lease_id: type: string description: The Propexo unique identifier for the lease access_is_authorized: type: boolean description: Whether or not the tenant has granted permission to enter the unit associated with the service request service_description: type: string description: A description of the service request service_category: type: string description: The category of service request date_completed: type: string format: date-time description: The date the service request was completed date_created: type: string format: date-time description: The date the service request was created service_details: type: string description: Details about the service request date_due: type: string format: date-time description: The due date associated with the service request date_scheduled: type: string format: date-time description: The date the service request is scheduled status_raw: type: string description: The status associated with the service request required: - service_request_id required: - meta - result _v1_service-requests_propertyware__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration property_id: type: string description: The Propexo unique identifier for the property unit_id: type: string description: The Propexo unique identifier for the unit vendor_id: type: string description: The Propexo unique identifier for the vendor lease_id: type: string description: The Propexo unique identifier for the lease access_is_authorized: type: boolean description: Whether or not the tenant has granted permission to enter the unit associated with the service request service_description: type: string description: A description of the service request service_category: type: string description: The category of service request date_completed: type: string format: date-time description: The date the service request was completed date_created: type: string format: date-time description: The date the service request was created service_details: type: string description: Details about the service request date_due: type: string format: date-time description: The due date associated with the service request date_scheduled: type: string format: date-time description: The date the service request is scheduled status_raw: type: string description: The status associated with the work order required: - integration_id - property_id _v1_service-requests_propertyware__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration property_id: type: string description: The Propexo unique identifier for the property unit_id: type: - string - "null" description: The Propexo unique identifier for the unit vendor_id: type: - string - "null" description: The Propexo unique identifier for the vendor lease_id: type: - string - "null" description: The Propexo unique identifier for the lease access_is_authorized: type: - boolean - "null" description: Whether or not the tenant has granted permission to enter the unit associated with the service request service_description: type: - string - "null" description: A description of the service request service_category: type: - string - "null" description: The category of service request date_completed: type: - string - "null" format: date-time description: The date the service request was completed date_created: type: - string - "null" format: date-time description: The date the service request was created service_details: type: - string - "null" description: Details about the service request date_due: type: - string - "null" format: date-time description: The due date associated with the service request date_scheduled: type: - string - "null" format: date-time description: The date the service request is scheduled status_raw: type: - string - "null" description: The status associated with the work order required: - integration_id - property_id - unit_id - vendor_id - lease_id - access_is_authorized - service_description - service_category - date_completed - date_created - service_details - date_due - date_scheduled - status_raw required: - meta - result _v1_service-requests_realpage_rpx_{service_request_id}_put_input: type: object properties: status_raw: type: string enum: &a243 - In Progress - On Hold - Canceled - Complete description: The raw status associated with the service request completion_notes: type: string description: Closing notes associated with the service request service_details: type: string description: Details about the service request required: - status_raw _v1_service-requests_realpage_rpx_{service_request_id}_put_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: service_request_id: type: string description: The Propexo unique identifier for the service request status_raw: type: string enum: *a243 description: The raw status associated with the service request completion_notes: type: string description: Closing notes associated with the service request service_details: type: string description: Details about the service request required: - service_request_id - status_raw required: - meta - result _v1_service-requests_realpage_rpx__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration unit_id: type: string description: The Propexo unique identifier for the unit service_request_location_id: type: string description: The Propexo unique identifier for the service request location service_request_problem_id: type: string description: The Propexo unique identifier for the service request problem service_request_priority_id: type: string description: The Propexo unique identifier for the service request priority access_is_authorized_value: type: string enum: *a244 description: 'Type of permission needed to enter the unit. Possible values: "ENTER_AT_ANY_TIME" - Enter any time, "BY_PERMISSION_ONLY" - By permission only, "CALL_FOR_ENTRY" - Call for entry' date_due: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The due date associated with the service request access_notes: type: string description: Notes regarding access to the unit associated with the service request date_created: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The date the service request was created service_details: type: string description: Details about the service request access_is_authorized: type: boolean description: "DEPRECATED: Use access_is_authorized_value instead. Whether or not the tenant has granted permission to enter the unit associated with the service request" deprecated: true required: - integration_id - unit_id - service_request_location_id - service_request_problem_id - date_due _v1_service-requests_realpage_rpx__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration unit_id: type: string description: The Propexo unique identifier for the unit service_request_location_id: type: string description: The Propexo unique identifier for the service request location service_request_problem_id: type: string description: The Propexo unique identifier for the service request problem service_request_priority_id: type: - string - "null" description: The Propexo unique identifier for the service request priority access_is_authorized_value: type: - string - "null" enum: *a244 description: 'Type of permission needed to enter the unit. Possible values: "ENTER_AT_ANY_TIME" - Enter any time, "BY_PERMISSION_ONLY" - By permission only, "CALL_FOR_ENTRY" - Call for entry' date_due: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" access_notes: type: - string - "null" description: Notes regarding access to the unit associated with the service request date_created: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" description: The date the service request was created service_details: type: - string - "null" description: Details about the service request access_is_authorized: type: - boolean - "null" description: "DEPRECATED: Use access_is_authorized_value instead. Whether or not the tenant has granted permission to enter the unit associated with the service request" deprecated: true x-fern-availability: deprecated required: - integration_id - unit_id - service_request_location_id - service_request_problem_id - service_request_priority_id - access_is_authorized_value - date_due - access_notes - date_created - service_details - access_is_authorized required: - meta - result _v1_service-requests_yardi_rest__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration property_id: type: string description: The Propexo unique identifier for the property unit_id: type: string description: The Propexo unique identifier for the unit resident_id: type: string description: The Propexo unique identifier for the resident vendor_id: type: string description: The Propexo unique identifier for the vendor access_is_authorized: type: boolean description: Whether or not the tenant has granted permission to enter the unit associated with the service request service_description: type: string maxLength: 35 description: A description of the service request service_details: type: string description: Details about the service request date_created: type: string format: date-time description: The date the service request was created service_category: type: string enum: *a235 description: The category of service request service_priority: type: string enum: *a234 description: The priority level associated with the service request status_raw: type: string enum: *a233 description: The raw status associated with the service request required: - integration_id - property_id - access_is_authorized - service_description _v1_service-requests_yardi_rest__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration property_id: type: string description: The Propexo unique identifier for the property unit_id: type: - string - "null" description: The Propexo unique identifier for the unit resident_id: type: - string - "null" description: The Propexo unique identifier for the resident vendor_id: type: - string - "null" description: The Propexo unique identifier for the vendor access_is_authorized: type: boolean description: Whether or not the tenant has granted permission to enter the unit associated with the service request service_description: type: string maxLength: 35 description: A description of the service request service_details: type: - string - "null" description: Details about the service request date_created: type: - string - "null" format: date-time description: The date the service request was created service_category: type: - string - "null" enum: *a235 description: The category of service request service_priority: type: - string - "null" enum: *a234 description: The priority level associated with the service request status_raw: type: - string - "null" enum: *a233 description: The raw status associated with the service request required: - integration_id - property_id - unit_id - resident_id - vendor_id - access_is_authorized - service_description - service_details - date_created - service_category - service_priority - status_raw required: - meta - result _v1_service-requests_yardi_rest_{service_request_id}_put_input: type: object properties: unit_id: type: string description: The Propexo unique identifier for the unit resident_id: type: string description: The Propexo unique identifier for the resident vendor_id: type: string description: The Propexo unique identifier for the vendor access_is_authorized: type: boolean description: Whether or not the tenant has granted permission to enter the unit associated with the service request service_description: type: string maxLength: 35 description: A description of the service request service_details: type: string description: Details about the service request date_created: type: string format: date-time description: The date the service request was created service_category: type: string enum: *a235 description: The category of service request service_priority: type: string enum: *a234 description: The priority level associated with the service request status_raw: type: string enum: *a233 description: The raw status associated with the service request required: - access_is_authorized - service_description _v1_service-requests_yardi_rest_{service_request_id}_put_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: service_request_id: type: string description: The Propexo unique identifier for the service request unit_id: type: string description: The Propexo unique identifier for the unit resident_id: type: string description: The Propexo unique identifier for the resident vendor_id: type: string description: The Propexo unique identifier for the vendor access_is_authorized: type: boolean description: Whether or not the tenant has granted permission to enter the unit associated with the service request service_description: type: string maxLength: 35 description: A description of the service request service_details: type: string description: Details about the service request date_created: type: string format: date-time description: The date the service request was created service_category: type: string enum: *a235 description: The category of service request service_priority: type: string enum: *a234 description: The priority level associated with the service request status_raw: type: string enum: *a233 description: The raw status associated with the service request required: - service_request_id - access_is_authorized - service_description required: - meta - result _v1_service-request-history_buildium__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration service_request_id: type: string description: The Propexo unique identifier for the service request employee_id: type: string description: The Propexo unique identifier for the employee status_raw: type: string enum: &a245 - New - InProgress - Completed - Deferred - Closed description: The raw status associated with the service request history notes: type: string maxLength: 65500 description: Notes associated with the service request history contact_first_name: type: string description: Notes associated with the service request history required: - integration_id - service_request_id - employee_id - status_raw _v1_service-request-history_buildium__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration service_request_id: type: string description: The Propexo unique identifier for the service request employee_id: type: string description: The Propexo unique identifier for the employee status_raw: type: string enum: *a245 description: The raw status associated with the service request history notes: type: - string - "null" maxLength: 65500 description: Notes associated with the service request history contact_first_name: type: - string - "null" description: Notes associated with the service request history required: - integration_id - service_request_id - employee_id - status_raw - notes - contact_first_name required: - meta - result _v1_service-request-history_entrata__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration service_request_id: type: string description: The Propexo unique identifier for the service request notes: type: string description: Notes associated with the service request history required: - integration_id - service_request_id - notes _v1_service-request-history_entrata__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration service_request_id: type: string description: The Propexo unique identifier for the service request notes: type: string description: Notes associated with the service request history required: - integration_id - service_request_id - notes required: - meta - result _v1_service-request-history_propertyware__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration service_request_id: type: string description: The Propexo unique identifier for the service request notes: type: string description: Notes associated with the service request history title: type: string description: The title associated with the service request history required: - integration_id - service_request_id - notes - title _v1_service-request-history_propertyware__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration service_request_id: type: string description: The Propexo unique identifier for the service request notes: type: string description: Notes associated with the service request history title: type: string description: The title associated with the service request history required: - integration_id - service_request_id - notes - title required: - meta - result _v1_service-request-history_realpage_rpx__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration service_request_id: type: string description: The Propexo unique identifier for the service request status_raw: type: string enum: *a243 description: The raw status associated with the service request history required: - integration_id - service_request_id - status_raw _v1_service-request-history_realpage_rpx__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration service_request_id: type: string description: The Propexo unique identifier for the service request status_raw: type: string enum: *a243 description: The raw status associated with the service request history required: - integration_id - service_request_id - status_raw required: - meta - result _v1_service-request-history_rentmanager__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration service_request_id: type: string description: The Propexo unique identifier for the service request notes: type: string description: Notes associated with the service request history attachment: type: object properties: file_data: type: string maxLength: 40443576 description: The contents of the file, as a base64 encoded string. The PMS has a max file size of 29 MB. file_name: type: string description: 'The name of the file including the extension. Ex: "resume.pdf"' mime_type: type: string description: 'The mime type of the file. Ex: "application/pdf"' required: - file_data - file_name - mime_type description: Attachment file associated with the service request history required: - integration_id - service_request_id - notes _v1_service-request-history_rentmanager__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration service_request_id: type: string description: The Propexo unique identifier for the service request notes: type: string description: Notes associated with the service request history attachment: type: - object - "null" properties: file_data: type: - string - "null" maxLength: 40443576 description: The contents of the file, as a base64 encoded string. The PMS has a max file size of 29 MB. file_name: type: string description: 'The name of the file including the extension. Ex: "resume.pdf"' mime_type: type: string description: 'The mime type of the file. Ex: "application/pdf"' required: - file_name - mime_type required: - integration_id - service_request_id - notes - attachment required: - meta - result _v1_service-request-history_resman__post_input: type: object properties: {} _v1_service-request-history_resman__post_output: type: object properties: {} _v1_service-request-history_yardi__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration service_request_id: type: string description: The Propexo unique identifier for the service request status_raw: type: string enum: *a233 description: The raw status associated with the service request history required: - integration_id - service_request_id - status_raw _v1_service-request-history_yardi__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration service_request_id: type: string description: The Propexo unique identifier for the service request status_raw: type: string enum: *a233 description: The raw status associated with the service request history required: - integration_id - service_request_id - status_raw required: - meta - result _v1_service-requests_yardi_{service_request_id}_file-upload_post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration attachment: type: object properties: file_type_id: type: string description: The Propexo unique identifier for the file type. The file type provided must be listed as being compatible with the Service Requests model. file_data: type: string maxLength: 66500000 file_extension: type: string enum: &a246 - pdf - doc - docx - xls - xlsx - jpg - jpeg - png description: The file extension for the attachment being uploaded description: type: string description: A description of the file being uploaded required: - file_type_id - file_data - file_extension - description description: The file to attach to the Service Request required: - integration_id - attachment _v1_service-requests_yardi_{service_request_id}_file-upload_post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration service_request_id: type: string description: The Propexo unique identifier for the service request attachment: type: object properties: file_type_id: type: string description: The Propexo unique identifier for the file type. The file type provided must be listed as being compatible with the Service Requests model. file_data: type: - string - "null" maxLength: 66500000 file_extension: type: string enum: *a246 description: The file extension for the attachment being uploaded description: type: string description: A description of the file being uploaded required: - file_type_id - file_extension - description required: - integration_id - service_request_id - attachment required: - meta - result _v1_service-requests_yardi_rest_{service_request_id}_file-upload_post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration attachment: type: object properties: file_type_id: type: string description: The Propexo unique identifier for the file type. The file type provided must be listed as being compatible with the Service Requests model. file_data: type: string maxLength: 66500000 file_extension: type: string enum: &a247 - pdf - doc - docx - xls - xlsx - jpg - jpeg - png description: The file extension for the attachment being uploaded description: type: string description: A description of the file being uploaded required: - file_type_id - file_data - file_extension - description description: The file to attach to the Service Request required: - integration_id - attachment _v1_service-requests_yardi_rest_{service_request_id}_file-upload_post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration service_request_id: type: string description: The Propexo unique identifier for the service request attachment: type: object properties: file_type_id: type: string description: The Propexo unique identifier for the file type. The file type provided must be listed as being compatible with the Service Requests model. file_data: type: - string - "null" maxLength: 66500000 file_extension: type: string enum: *a247 description: The file extension for the attachment being uploaded description: type: string description: A description of the file being uploaded required: - file_type_id - file_extension - description required: - integration_id - service_request_id - attachment required: - meta - result _v1_service-requests_buildium_{service_request_id}_file-upload__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration attachments: type: array items: type: object properties: file_data: type: string maxLength: 27892121 description: The contents of the file, as a base64 encoded string. The PMS has a max file size of 20 MB. file_name: type: string description: 'The name of the file including the extension. Ex: "resume.pdf"' mime_type: type: string description: 'The mime type of the file. Ex: "application/pdf"' required: - file_data - file_name - mime_type minItems: 1 description: Files w/ metadata for the service request. All the files can have a maximum combined file size of 50 MB required: - integration_id - attachments _v1_service-requests_buildium_{service_request_id}_file-upload__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration service_request_id: type: string description: The Propexo unique identifier for the service request attachments: type: array items: type: object properties: file_data: type: - string - "null" maxLength: 27892121 description: The contents of the file, as a base64 encoded string. The PMS has a max file size of 20 MB. file_name: type: string description: 'The name of the file including the extension. Ex: "resume.pdf"' mime_type: type: string description: 'The mime type of the file. Ex: "application/pdf"' required: - file_name - mime_type required: - integration_id - service_request_id - attachments required: - meta - result _v1_service-requests_rentmanager_{service_request_id}_file-upload__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration attachments: type: array items: type: object properties: file_type_id: type: string description: The Propexo unique identifier for the file type. This file_type must contain a "type" value of "file" file_type: type: string enum: &a248 - Document default: Document description: The type of file being uploaded. This defaults to "Document" file_data: type: string maxLength: 40443576 description: The contents of the file, as a base64 encoded string. The PMS has a max file size of 29 MB. file_name: type: string description: 'The name of the file including the extension. Ex: "resume.pdf"' mime_type: type: string description: 'The mime type of the file. Ex: "application/pdf"' required: - file_type_id - file_data - file_name - mime_type minItems: 1 description: Files w/ metadata for the service request. All the files can have a maximum combined file size of 50 MB required: - integration_id - attachments _v1_service-requests_rentmanager_{service_request_id}_file-upload__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration service_request_id: type: string description: The Propexo unique identifier for the service request attachments: type: array items: type: object properties: file_type_id: type: string description: The Propexo unique identifier for the file type. This file_type must contain a "type" value of "file" file_type: type: string enum: *a248 default: Document file_data: type: - string - "null" maxLength: 40443576 description: The contents of the file, as a base64 encoded string. The PMS has a max file size of 29 MB. file_name: type: string description: 'The name of the file including the extension. Ex: "resume.pdf"' mime_type: type: string description: 'The mime type of the file. Ex: "application/pdf"' required: - file_type_id - file_name - mime_type required: - integration_id - service_request_id - attachments required: - meta - result _v1_service-requests_rentmanager_{service_request_id}_notes__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration notes: type: string description: Notes associated with the service request attachment: type: object properties: file_data: type: string maxLength: 40443576 description: The contents of the file, as a base64 encoded string. The PMS has a max file size of 29 MB. file_name: type: string description: 'The name of the file including the extension. Ex: "resume.pdf"' mime_type: type: string description: 'The mime type of the file. Ex: "application/pdf"' required: - file_data - file_name - mime_type description: Attachment file for the note on the service request required: - integration_id - notes _v1_service-requests_rentmanager_{service_request_id}_notes__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration service_request_id: type: string description: The Propexo unique identifier for the service request notes: type: string description: Notes associated with the service request attachment: type: - object - "null" properties: file_data: type: - string - "null" maxLength: 40443576 description: The contents of the file, as a base64 encoded string. The PMS has a max file size of 29 MB. file_name: type: string description: 'The name of the file including the extension. Ex: "resume.pdf"' mime_type: type: string description: 'The mime type of the file. Ex: "application/pdf"' required: - file_name - mime_type required: - integration_id - service_request_id - notes - attachment required: - meta - result _v1_service-requests_resman_{service_request_id}_file-upload__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration attachments: type: array items: type: object properties: file_data: type: string maxLength: 34865152 description: The contents of the file, as a base64 encoded string. The PMS has a max file size of 25 MB. file_name: type: string description: The name of the file including the extension mime_type: type: string description: 'The mime type of the file. Ex: "application/pdf"' required: - file_data - file_name - mime_type minItems: 1 description: The files to be uploaded to the service request. All the files can have a maximum combined file size of 50 MB required: - integration_id - attachments _v1_service-requests_resman_{service_request_id}_file-upload__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration service_request_id: type: string description: The Propexo unique identifier for the service request attachments: type: array items: type: object properties: file_data: type: - string - "null" maxLength: 34865152 description: The contents of the file, as a base64 encoded string. The PMS has a max file size of 25 MB. file_name: type: string description: The name of the file including the extension mime_type: type: string description: 'The mime type of the file. Ex: "application/pdf"' required: - file_name - mime_type required: - integration_id - service_request_id - attachments required: - meta - result _v1_service-requests_entrata_{service_request_id}_file-upload__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration attachments: type: array items: type: object properties: file_data: type: string maxLength: 69730304 description: The contents of the file, as a base64 encoded string. The PMS has a max file size of 50 MB. file_name: type: string description: 'The name of the file including the extension. Ex: "image.jpg"' mime_type: type: string description: 'The mime type of the file. Ex: "image/jpeg"' notes: type: string description: Notes about the file required: - file_data - file_name - mime_type - notes minItems: 1 description: The files to be uploaded to the service request. All the files can have a maximum combined file size of 50 MB required: - integration_id - attachments _v1_service-requests_entrata_{service_request_id}_file-upload__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration service_request_id: type: string description: The Propexo unique identifier for the service request attachments: type: array items: type: object properties: file_data: type: - string - "null" maxLength: 69730304 description: The contents of the file, as a base64 encoded string. The PMS has a max file size of 50 MB. file_name: type: string description: 'The name of the file including the extension. Ex: "image.jpg"' mime_type: type: string description: 'The mime type of the file. Ex: "image/jpeg"' notes: type: string description: Notes about the file required: - file_name - mime_type - notes required: - integration_id - service_request_id - attachments required: - meta - result _v1_service-requests_rentvine_{service_request_id}_file-upload__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration attachment: type: object properties: file_data: type: string maxLength: 69730304 description: The contents of the file, as a base64 encoded string. We limit the file upload size to 50 MB. file_name: type: string description: 'The name of the file including the extension. Ex: "resume.pdf"' mime_type: type: string description: 'The mime type of the file. Ex: "application/pdf"' required: - file_data - file_name - mime_type description: The file data for the document upload required: - integration_id - attachment _v1_service-requests_rentvine_{service_request_id}_file-upload__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration service_request_id: type: string description: The Propexo unique identifier for the service request attachment: type: object properties: file_data: type: - string - "null" maxLength: 69730304 description: The contents of the file, as a base64 encoded string. We limit the file upload size to 50 MB. file_name: type: string description: 'The name of the file including the extension. Ex: "resume.pdf"' mime_type: type: string description: 'The mime type of the file. Ex: "application/pdf"' required: - file_name - mime_type required: - integration_id - service_request_id - attachment required: - meta - result _v1_service-requests_propertyware_{service_request_id}_file-upload__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration attachment: type: object properties: file_data: type: string maxLength: 16735272 description: The contents of the file, as a base64 encoded string. The PMS has a max file size of 12 MB. file_name: type: string description: 'The name of the file including the extension. Ex: "resume.pdf"' mime_type: type: string description: 'The mime type of the file. Ex: "application/pdf"' required: - file_data - file_name - mime_type description: Attachment file on the service request notes: type: string description: General notes about the file is_private: type: boolean description: If the file should be marked as private required: - integration_id - attachment _v1_service-requests_propertyware_{service_request_id}_file-upload__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration service_request_id: type: string description: The Propexo unique identifier for the service request attachment: type: object properties: file_data: type: - string - "null" maxLength: 16735272 description: The contents of the file, as a base64 encoded string. The PMS has a max file size of 12 MB. file_name: type: string description: 'The name of the file including the extension. Ex: "resume.pdf"' mime_type: type: string description: 'The mime type of the file. Ex: "application/pdf"' required: - file_name - mime_type notes: type: - string - "null" is_private: type: - boolean - "null" required: - integration_id - service_request_id - attachment - notes - is_private required: - meta - result _v1_timezones__get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query location_id: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. property_id: type: string description: The Propexo unique identifier for the property integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" _v1_timezones__get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: type: array items: type: object properties: id: type: string description: The Propexo unique identifier for the timezone created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. is_active: type: - boolean - "null" description: Whether the timezone is active observes_daylight_savings: type: - boolean - "null" description: Whether or not this timezone should be adjusted for daylight savings time offset: type: - string - "null" pattern: ^[-+]\d{2}:\d{2}$ description: The UTC offset numeric value of the timezone. In the event that daylight savings time is observed, the offset will always represent standard time server_time_error_seconds: type: - number - "null" description: The number of seconds the server is off by integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" property_id: type: string description: The Propexo unique identifier for the property required: - id - created_at - updated_at - last_seen - x_id - x_property_id - x_location_id - is_active - observes_daylight_savings - offset - server_time_error_seconds - integration_id - integration_vendor - property_id required: - meta - results _v1_concessions__get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query x_id: type: string description: The external ID from the integration vendor location_id: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. property_id: type: string description: The Propexo unique identifier for the property integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" Concession: type: object properties: id: type: string description: The Propexo unique identifier for the concession created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_unit_id: type: - string - "null" description: The external ID of the unit from the integration vendor x_floor_plan_id: type: - string - "null" description: The external ID of the floor plan from the integration vendor total_amount_in_cents: type: - integer - "null" description: The total amount of the concession start_date: type: - string - "null" description: The start date associated with the concession end_date: type: - string - "null" description: The end date associated with the concession is_active: type: - boolean - "null" description: Whether the concession is active description: type: - string - "null" description: Description of the concession is_one_time: type: - boolean - "null" description: Whether or not the concession occurs a single time is_recurring: type: - boolean - "null" description: Whether or not the concession is recurring monthly_fixed_amount_in_cents: type: - integer - "null" description: The monthly fixed amount of the concession in cents monthly_percentage_amount: type: - integer - "null" description: The monthly percentage amount of the concession. This is rounded to the nearest percent monthly_percentage_raw: type: - string - "null" description: The raw monthly percentage amount of the concession as a string, preserving decimal precision one_time_fixed_amount_in_cents: type: - integer - "null" description: The one time fixed amount of the concession in cents one_time_percentage_amount: type: - integer - "null" description: The one time percentage amount of the concession. This is rounded to the nearest percent one_time_percentage_raw: type: - string - "null" description: The raw one time percentage amount of the concession as a string, preserving decimal precision number_of_occurrences: type: - integer - "null" description: The number of occurrences of the concession fixed_amount_in_cents: type: - integer - "null" description: The fixed amount of the concession in cents percentage_amount: type: - integer - "null" description: The percentage amount of the concession. This is rounded to the nearest percent percentage_raw: type: - string - "null" description: The raw percentage amount of the concession as a string, preserving decimal precision lease_term_in_months: type: - integer - "null" description: The amount of months for the lease term lease_term_raw: type: - string - "null" description: The raw value for the lease term concession_formula_raw: type: - string - "null" description: The raw formula name used to calculate the concession (e.g., "Fixed Amount", "Percent of Charge Code Group") integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" property_id: type: string description: The Propexo unique identifier for the property unit_id: type: - string - "null" description: The Propexo unique identifier for the unit floor_plan_id: type: - string - "null" description: The Propexo unique identifier for the floor plan required: - id - created_at - updated_at - last_seen - x_id - x_property_id - x_location_id - x_unit_id - x_floor_plan_id - total_amount_in_cents - start_date - end_date - is_active - description - is_one_time - is_recurring - monthly_fixed_amount_in_cents - monthly_percentage_amount - monthly_percentage_raw - one_time_fixed_amount_in_cents - one_time_percentage_amount - one_time_percentage_raw - number_of_occurrences - fixed_amount_in_cents - percentage_amount - percentage_raw - lease_term_in_months - lease_term_raw - concession_formula_raw - integration_id - integration_vendor - property_id - unit_id - floor_plan_id x-propexo: derivedFromModel: concessions _v1_concessions__get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: type: array items: $ref: "#/components/schemas/Concession" required: - meta - results _v1_concessions_{concession_id}_get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query _v1_concessions_{concession_id}_get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: $ref: "#/components/schemas/Concession" required: - meta - results _v1_floor-plans__get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query x_id: type: string description: The external ID from the integration vendor location_id: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. property_id: type: string description: The Propexo unique identifier for the property integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" FloorPlan: type: object properties: id: type: string description: The Propexo unique identifier for the floor plan created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: type: string description: The name associated with the floor plan marketing_name: type: - string - "null" description: The marketing name of the floor plan code: type: - string - "null" description: The code associated with the floor plan description: type: - string - "null" description: Description of the floor plan bedrooms: type: - integer - "null" minimum: 0 description: The number of bedrooms associated with the floor plan bathrooms: type: - string - "null" description: The number of bathrooms associated with the floor plan bathrooms_full: type: - integer - "null" minimum: 0 description: The number of full bathrooms associated with the floor plan bathrooms_half: type: - integer - "null" minimum: 0 description: The number of half bathrooms associated with the floor plan max_occupants: type: - integer - "null" minimum: 0 description: The maximum number of occupants for the floor plan rentable_square_feet: type: - integer - "null" minimum: 0 description: The rentable square footage of the floor plan gross_square_feet: type: - integer - "null" minimum: 0 description: The gross square footage of the floor plan rent_minimum_in_cents: type: &a308 - number - "null" description: The minimum rent of the floor plan example: 100000 rent_maximum_in_cents: type: &a309 - number - "null" description: The maximum rent of the floor plan example: 100000 image_urls: type: array items: type: string unit_count: type: - integer - "null" minimum: 0 description: The number of units associated with the floor plan deposit_amount_in_cents: type: &a310 - number - "null" description: The deposit amount in cents associated with the floor plan example: 100000 deposit_amount_raw: type: - string - "null" description: The raw deposit amount associated with the floor plan deposit_amount_min_in_cents: type: &a311 - number - "null" description: The minimum deposit amount in cents associated with the floor plan example: 100000 deposit_amount_max_in_cents: type: &a312 - number - "null" description: The maximum deposit amount in cents associated with the floor plan example: 100000 deposit_amount_min_raw: type: - string - "null" description: The raw minimum deposit amount associated with the floor plan deposit_amount_max_raw: type: - string - "null" description: The raw maximum deposit amount associated with the floor plan custom_data: type: - object - "null" properties: {} integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" property_id: type: string description: The Propexo unique identifier for the property required: - id - created_at - updated_at - last_seen - x_id - x_property_id - x_location_id - name - marketing_name - code - description - bedrooms - bathrooms - bathrooms_full - bathrooms_half - max_occupants - rentable_square_feet - gross_square_feet - rent_minimum_in_cents - rent_maximum_in_cents - image_urls - unit_count - deposit_amount_in_cents - deposit_amount_raw - deposit_amount_min_in_cents - deposit_amount_max_in_cents - deposit_amount_min_raw - deposit_amount_max_raw - custom_data - integration_id - integration_vendor - property_id x-propexo: derivedFromModel: floor_plans _v1_floor-plans__get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: type: array items: $ref: "#/components/schemas/FloorPlan" required: - meta - results _v1_floor-plans_{floor_plan_id}_get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query _v1_floor-plans_{floor_plan_id}_get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: $ref: "#/components/schemas/FloorPlan" required: - meta - results Enum7: type: string enum: &a294 - APPFOLIO - BUILDIUM - ENTRATA - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The integration vendor for the unit. _v1_units__get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query x_id: type: string description: The external unit id x_property_id: type: string description: "Deprecated: Use the Propexo property_id instead" deprecated: true location_id: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. property_id: type: string description: The Propexo property id integration_id: type: string description: The Propexo integration id integration_vendor: $ref: "#/components/schemas/Enum7" unit_number: type: string description: The number of the unit. When using this, the Propexo `property_id` filter must be added as well. _v1_units__get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: type: array items: type: object properties: id: type: string description: The Propexo unique identifier for the unit created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_floor_plan_id: type: - string - "null" description: The external ID of the floor plan from the integration vendor x_unit_type_id: type: - string - "null" description: The external ID of the unit type from the integration vendor bathrooms: type: - string - "null" description: The number of bathrooms associated with the unit bathrooms_full: type: &a249 - number - "null" description: The number of full bathrooms associated with the unit bathrooms_half: type: &a250 - number - "null" description: The number of half bathrooms associated with the unit bedrooms: type: - string - "null" description: The number of bedrooms associated with the unit building_name: type: - string - "null" description: The building name associated with the unit building_number: type: - string - "null" description: The building number associated with the unit city: type: - string - "null" description: The city associated with the unit country: type: - string - "null" description: The country associated with the unit custom_data: type: - object - "null" properties: {} floor_plan_code: type: - string - "null" description: The external ID of the floor plan associated with the unit floor_plan_name: type: - string - "null" description: The floor plan name associated with the unit floor: type: - string - "null" description: The floor number/name associated with the unit is_available: type: - boolean - "null" description: Whether the unit is available is_furnished: type: - boolean - "null" description: Whether the unit is furnished is_listed: type: - boolean - "null" description: "DEPRECATED: Use listings endpoints." deprecated: true x-fern-availability: deprecated is_vacant: type: - boolean - "null" description: Whether the unit is vacant number: type: - string - "null" description: The unit number rent_amount_market_in_cents: type: &a251 - number - "null" description: The market rent amount in cents for the unit example: 100000 rent_amount_max_in_cents: type: &a252 - number - "null" description: The maximum rent amount in cents example: 100000 rent_amount_min_in_cents: type: &a253 - number - "null" description: The minimum rent amount in cents example: 100000 square_feet: type: - integer - "null" minimum: 0 description: The square footage of the unit state: type: - string - "null" description: The state associated with the unit street_address_1: type: - string - "null" description: "Deprecated: Use address_1" deprecated: true x-fern-availability: deprecated street_address_2: type: - string - "null" description: "Deprecated: Use address_2" deprecated: true x-fern-availability: deprecated address_1: type: - string - "null" description: The first address line associated with the unit x-propexo: &a254 derivedFromField: street_address_1 address_2: type: - string - "null" description: The second address line associated with the unit x-propexo: &a255 derivedFromField: street_address_1 zip: type: - string - "null" description: The zip code associated with the unit pets_allowed: type: - boolean - "null" description: Whether or not pets are allowed dogs_allowed: type: - boolean - "null" description: Whether or not dogs are allowed cats_allowed: type: - boolean - "null" description: Whether or not cats are allowed pet_policy: type: - string - "null" description: The pet policy for the unit floor_plan_id: type: - string - "null" description: The Propexo unique identifier for the floor plan integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" property_id: type: string description: The Propexo unique identifier for the property unit_type_id: type: - string - "null" description: The Propexo unique identifier for the unit type required: - id - created_at - updated_at - last_seen - x_id - x_property_id - x_floor_plan_id - x_unit_type_id - bathrooms - bathrooms_full - bathrooms_half - bedrooms - building_name - building_number - city - country - custom_data - floor_plan_code - floor_plan_name - floor - is_available - is_furnished - is_listed - is_vacant - number - rent_amount_market_in_cents - rent_amount_max_in_cents - rent_amount_min_in_cents - square_feet - state - street_address_1 - street_address_2 - address_1 - address_2 - zip - pets_allowed - dogs_allowed - cats_allowed - pet_policy - floor_plan_id - integration_id - integration_vendor - property_id - unit_type_id required: - meta - results _v1_units__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration property_id: type: string lease_period_id: type: string description: The Propexo unique identifier for the lease period bathrooms: type: - string - "null" description: The number of bathrooms in the unit. bedrooms: type: - string - "null" description: The number of bedrooms in the unit. city: type: string description: The city of the unit. country: type: string description: The country of the unit. date_available: type: string format: date-time description: The date that the unit becomes available is_furnished: type: boolean description: Whether the unit is furnished number: type: string description: The unit number square_feet: type: number description: The size of the unit in square feet. state: type: string description: The state of the unit. street_address_1: type: string description: The first address line associated with the unit street_address_2: type: string description: The second address line associated with the unit zip: type: string description: The zip code of the unit. floor_plan_code: type: string description: The external ID of the floor plan unit_type_id: type: string description: The external ID of the unit type category: type: string enum: &a266 - Residential - Commercial description: The category of the unit. type: type: string enum: &a267 - Apartment - House description: The type of the unit. name: type: string description: 'The name of the unit. Example: "Unit 3".' abbreviation: type: string description: 'The abbreviation of the unit. Example: "UNIT3"' address_1: type: string description: The first address line of the unit. address_2: type: string description: The second address line of the unit. notes: type: string description: Notes about the unit. rent_amount_market_in_cents: type: number description: The market rent cost of the unit, in cents. intgration_id: type: string required: - property_id - intgration_id _v1_units__post_output: type: object properties: job_id: type: string description: The ID of the job created to handle this operation data: type: object properties: {} required: - job_id - data _v1_units_details_get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query x_id: type: string description: The external unit id location_id: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. property_id: type: string description: The Propexo unique identifier for the property integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" _v1_units_details_get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: type: array items: type: object properties: id: type: string description: The Propexo unique identifier for the unit created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_building_id: type: - string - "null" description: The external ID of the building (not necessarily the property) from the integration vendor x_floor_plan_id: type: - string - "null" description: The external ID of the floor plan from the integration vendor building_number: type: - string - "null" description: The building number associated with the unit make_ready_date: type: - string - "null" description: The make ready date of the unit made_ready_date: type: - string - "null" description: The made ready date of the unit reserved_until_date: type: - string - "null" description: The date the unit is reserved until floor_plan_market_rent_in_cents: type: &a260 - number - "null" description: The market rent cost of the floor plan, in cents example: 100000 unit_market_rent_in_cents: type: &a261 - number - "null" description: The market rent cost of the unit, in cents example: 100000 base_rent_in_cents: type: &a262 - number - "null" description: The base rent cost of the unit, in cents example: 100000 unit_number: type: - string - "null" description: The unit number description: type: - string - "null" description: Description of the unit floor_plan_name: type: - string - "null" description: The floor plan name associated with the unit accessible_hearing: type: - boolean - "null" description: Whether or not the unit is accessible for the hearing impaired accessible_mobility: type: - boolean - "null" description: Whether or not the unit is accessible for the mobility impaired accessible_vision: type: - boolean - "null" description: Whether or not the unit is accessible for the vision impaired is_vacant: type: - boolean - "null" description: Whether the unit is vacant is_available: type: - boolean - "null" description: Whether the unit is available is_reserved: type: - boolean - "null" description: Whether the unit is reserved available_date: type: - string - "null" description: The date that the unit becomes available notes: type: - string - "null" description: Notes associated with the unit gross_square_feet: type: integer minimum: 0 description: The gross square footage of the unit rentable_square_feet: type: integer minimum: 0 description: The rentable square footage of the unit city: type: - string - "null" description: The city associated with the unit country: type: - string - "null" description: The country associated with the unit state: type: - string - "null" description: The state associated with the unit address_1: type: - string - "null" description: The first address line associated with the unit address_2: type: - string - "null" description: The second address line associated with the unit zip: type: - string - "null" description: The zip code associated with the unit maximum_potential_lease_term: type: - string - "null" description: The maximum potential lease term of the unit minimum_potential_lease_term: type: - string - "null" description: The minimum potential lease term of the unit integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" property_id: type: string description: The Propexo unique identifier for the property required: - id - created_at - updated_at - last_seen - x_id - x_property_id - x_location_id - x_building_id - x_floor_plan_id - building_number - make_ready_date - made_ready_date - reserved_until_date - floor_plan_market_rent_in_cents - unit_market_rent_in_cents - base_rent_in_cents - unit_number - description - floor_plan_name - accessible_hearing - accessible_mobility - accessible_vision - is_vacant - is_available - is_reserved - available_date - notes - gross_square_feet - rentable_square_feet - city - country - state - address_1 - address_2 - zip - maximum_potential_lease_term - minimum_potential_lease_term - integration_id - integration_vendor - property_id x-propexo: &a263 derivedFromModel: unit_details required: - meta - results _v1_units_{id}_get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query _v1_units_{id}_get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: type: object properties: id: type: string description: The Propexo unique identifier for the unit created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_floor_plan_id: type: - string - "null" description: The external ID of the floor plan from the integration vendor x_unit_type_id: type: - string - "null" description: The external ID of the unit type from the integration vendor bathrooms: type: - string - "null" description: The number of bathrooms associated with the unit bathrooms_full: type: *a249 description: The number of full bathrooms associated with the unit bathrooms_half: type: *a250 description: The number of half bathrooms associated with the unit bedrooms: type: - string - "null" description: The number of bedrooms associated with the unit building_name: type: - string - "null" description: The building name associated with the unit building_number: type: - string - "null" description: The building number associated with the unit city: type: - string - "null" description: The city associated with the unit country: type: - string - "null" description: The country associated with the unit custom_data: type: - object - "null" properties: {} floor_plan_code: type: - string - "null" description: The external ID of the floor plan associated with the unit floor_plan_name: type: - string - "null" description: The floor plan name associated with the unit floor: type: - string - "null" description: The floor number/name associated with the unit is_available: type: - boolean - "null" description: Whether the unit is available is_furnished: type: - boolean - "null" description: Whether the unit is furnished is_listed: type: - boolean - "null" description: "DEPRECATED: Use listings endpoints." deprecated: true x-fern-availability: deprecated is_vacant: type: - boolean - "null" description: Whether the unit is vacant number: type: - string - "null" description: The unit number rent_amount_market_in_cents: type: *a251 description: The market rent amount in cents for the unit example: 100000 rent_amount_max_in_cents: type: *a252 description: The maximum rent amount in cents example: 100000 rent_amount_min_in_cents: type: *a253 description: The minimum rent amount in cents example: 100000 square_feet: type: - integer - "null" minimum: 0 description: The square footage of the unit state: type: - string - "null" description: The state associated with the unit street_address_1: type: - string - "null" description: "Deprecated: Use address_1" deprecated: true x-fern-availability: deprecated street_address_2: type: - string - "null" description: "Deprecated: Use address_2" deprecated: true x-fern-availability: deprecated address_1: type: - string - "null" description: The first address line associated with the unit x-propexo: *a254 address_2: type: - string - "null" description: The second address line associated with the unit x-propexo: *a255 zip: type: - string - "null" description: The zip code associated with the unit pets_allowed: type: - boolean - "null" description: Whether or not pets are allowed dogs_allowed: type: - boolean - "null" description: Whether or not dogs are allowed cats_allowed: type: - boolean - "null" description: Whether or not cats are allowed pet_policy: type: - string - "null" description: The pet policy for the unit floor_plan_id: type: - string - "null" description: The Propexo unique identifier for the floor plan integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" property_id: type: string description: The Propexo unique identifier for the property unit_type_id: type: - string - "null" description: The Propexo unique identifier for the unit type required: - id - created_at - updated_at - last_seen - x_id - x_property_id - x_floor_plan_id - x_unit_type_id - bathrooms - bathrooms_full - bathrooms_half - bedrooms - building_name - building_number - city - country - custom_data - floor_plan_code - floor_plan_name - floor - is_available - is_furnished - is_listed - is_vacant - number - rent_amount_market_in_cents - rent_amount_max_in_cents - rent_amount_min_in_cents - square_feet - state - street_address_1 - street_address_2 - address_1 - address_2 - zip - pets_allowed - dogs_allowed - cats_allowed - pet_policy - floor_plan_id - integration_id - integration_vendor - property_id - unit_type_id required: - meta - results _v1_units_{id}_put_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration unit_id: type: string description: The Propexo unique identifier for the unit category: type: string enum: &a264 - Residential - Commercial description: The category of the unit. type: type: string enum: &a265 - Apartment - House description: The type of the unit. name: type: string description: 'The name of the unit. Example: "Unit 3".' abbreviation: type: string description: 'The abbreviation of the unit. Example: "UNIT3"' address_1: type: string description: The first address line associated with the unit address_2: type: string description: The second address line of the unit. city: type: string description: The city associated with the unit state: type: string description: The state associated with the unit zip: type: string description: The zip code associated with the unit country: type: string description: The country of the unit. notes: type: string description: Notes associated with the unit bathrooms: type: number description: The number of bathrooms associated with the unit. This value is sent directly to Rent Manager as-is. Use decimals for half bathrooms. bedrooms: type: integer description: The number of bedrooms associated with the unit rent_amount_market_in_cents: type: integer description: The market rent amount in cents for the unit square_feet: type: integer description: The square footage of the unit number: type: string description: The unit number is_vacant: type: boolean description: Whether the unit is vacant _v1_units_{id}_put_output: type: object properties: job_id: type: string description: The ID of the job created to handle this operation data: type: object properties: {} required: - job_id - data _v1_unit-types__get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query x_id: type: string description: The external ID from the integration vendor location_id: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. property_id: type: string description: The Propexo unique identifier for the property integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" _v1_unit-types__get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: type: array items: type: object properties: id: type: string description: The Propexo unique identifier for the unit type created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: type: string description: The name associated with the unit type bedrooms: type: - integer - "null" minimum: 0 description: The number of bedrooms associated with the unit type bathrooms: type: - string - "null" description: The number of bathrooms associated with the unit type bathrooms_full: type: - integer - "null" minimum: 0 description: The number of full bathrooms associated with the unit type bathrooms_half: type: - integer - "null" minimum: 0 description: The number of half bathrooms associated with the unit type rentable_square_feet: type: - integer - "null" minimum: 0 description: The rentable square footage of the unit type gross_square_feet: type: - integer - "null" minimum: 0 description: The gross square footage of the unit type rent_minimum_in_cents: type: &a256 - number - "null" description: The minimum rent of the unit type example: 100000 rent_maximum_in_cents: type: &a257 - number - "null" description: The maximum rent of the unit type example: 100000 unit_count: type: - integer - "null" minimum: 0 description: The number of units associated with the unit type deposit_amount_in_cents: type: &a258 - number - "null" description: The deposit amount in cents associated with the unit type example: 100000 deposit_amount_raw: type: - string - "null" description: The raw deposit amount associated with the unit type integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" property_id: type: string description: The Propexo unique identifier for the property required: - id - created_at - updated_at - last_seen - x_id - x_property_id - x_location_id - name - bedrooms - bathrooms - bathrooms_full - bathrooms_half - rentable_square_feet - gross_square_feet - rent_minimum_in_cents - rent_maximum_in_cents - unit_count - deposit_amount_in_cents - deposit_amount_raw - integration_id - integration_vendor - property_id x-propexo: &a259 derivedFromModel: entrata_unit_types required: - meta - results _v1_unit-types_{unit_type_id}_get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query _v1_unit-types_{unit_type_id}_get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: type: object properties: id: type: string description: The Propexo unique identifier for the unit type created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: type: string description: The name associated with the unit type bedrooms: type: - integer - "null" minimum: 0 description: The number of bedrooms associated with the unit type bathrooms: type: - string - "null" description: The number of bathrooms associated with the unit type bathrooms_full: type: - integer - "null" minimum: 0 description: The number of full bathrooms associated with the unit type bathrooms_half: type: - integer - "null" minimum: 0 description: The number of half bathrooms associated with the unit type rentable_square_feet: type: - integer - "null" minimum: 0 description: The rentable square footage of the unit type gross_square_feet: type: - integer - "null" minimum: 0 description: The gross square footage of the unit type rent_minimum_in_cents: type: *a256 description: The minimum rent of the unit type example: 100000 rent_maximum_in_cents: type: *a257 description: The maximum rent of the unit type example: 100000 unit_count: type: - integer - "null" minimum: 0 description: The number of units associated with the unit type deposit_amount_in_cents: type: *a258 description: The deposit amount in cents associated with the unit type example: 100000 deposit_amount_raw: type: - string - "null" description: The raw deposit amount associated with the unit type integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" property_id: type: string description: The Propexo unique identifier for the property required: - id - created_at - updated_at - last_seen - x_id - x_property_id - x_location_id - name - bedrooms - bathrooms - bathrooms_full - bathrooms_half - rentable_square_feet - gross_square_feet - rent_minimum_in_cents - rent_maximum_in_cents - unit_count - deposit_amount_in_cents - deposit_amount_raw - integration_id - integration_vendor - property_id x-propexo: *a259 required: - meta - results _v1_units_details_{unit_detail_id}_get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query _v1_units_details_{unit_detail_id}_get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: type: object properties: id: type: string description: The Propexo unique identifier for the unit created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_building_id: type: - string - "null" description: The external ID of the building (not necessarily the property) from the integration vendor x_floor_plan_id: type: - string - "null" description: The external ID of the floor plan from the integration vendor building_number: type: - string - "null" description: The building number associated with the unit make_ready_date: type: - string - "null" description: The make ready date of the unit made_ready_date: type: - string - "null" description: The made ready date of the unit reserved_until_date: type: - string - "null" description: The date the unit is reserved until floor_plan_market_rent_in_cents: type: *a260 description: The market rent cost of the floor plan, in cents example: 100000 unit_market_rent_in_cents: type: *a261 description: The market rent cost of the unit, in cents example: 100000 base_rent_in_cents: type: *a262 description: The base rent cost of the unit, in cents example: 100000 unit_number: type: - string - "null" description: The unit number description: type: - string - "null" description: Description of the unit floor_plan_name: type: - string - "null" description: The floor plan name associated with the unit accessible_hearing: type: - boolean - "null" description: Whether or not the unit is accessible for the hearing impaired accessible_mobility: type: - boolean - "null" description: Whether or not the unit is accessible for the mobility impaired accessible_vision: type: - boolean - "null" description: Whether or not the unit is accessible for the vision impaired is_vacant: type: - boolean - "null" description: Whether the unit is vacant is_available: type: - boolean - "null" description: Whether the unit is available is_reserved: type: - boolean - "null" description: Whether the unit is reserved available_date: type: - string - "null" description: The date that the unit becomes available notes: type: - string - "null" description: Notes associated with the unit gross_square_feet: type: integer minimum: 0 description: The gross square footage of the unit rentable_square_feet: type: integer minimum: 0 description: The rentable square footage of the unit city: type: - string - "null" description: The city associated with the unit country: type: - string - "null" description: The country associated with the unit state: type: - string - "null" description: The state associated with the unit address_1: type: - string - "null" description: The first address line associated with the unit address_2: type: - string - "null" description: The second address line associated with the unit zip: type: - string - "null" description: The zip code associated with the unit maximum_potential_lease_term: type: - string - "null" description: The maximum potential lease term of the unit minimum_potential_lease_term: type: - string - "null" description: The minimum potential lease term of the unit integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" property_id: type: string description: The Propexo unique identifier for the property required: - id - created_at - updated_at - last_seen - x_id - x_property_id - x_location_id - x_building_id - x_floor_plan_id - building_number - make_ready_date - made_ready_date - reserved_until_date - floor_plan_market_rent_in_cents - unit_market_rent_in_cents - base_rent_in_cents - unit_number - description - floor_plan_name - accessible_hearing - accessible_mobility - accessible_vision - is_vacant - is_available - is_reserved - available_date - notes - gross_square_feet - rentable_square_feet - city - country - state - address_1 - address_2 - zip - maximum_potential_lease_term - minimum_potential_lease_term - integration_id - integration_vendor - property_id x-propexo: *a263 required: - meta - results _v1_units_entrata_{id}_put_input: type: object properties: {} _v1_units_entrata_{id}_put_output: type: object properties: {} _v1_units_entrata__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration property_id: type: string description: The Propexo unique identifier for the property lease_period_id: type: string description: The Propexo unique identifier for the lease period bathrooms: type: string description: The number of bathrooms associated with the unit bedrooms: type: string description: The number of bedrooms associated with the unit city: type: string description: The city associated with the unit country: type: string description: The country associated with the unit date_available: type: string format: date-time description: The date that the unit becomes available is_furnished: type: boolean description: Whether the unit is furnished number: type: string description: The unit number square_feet: type: number description: The square footage of the unit state: type: string description: The state associated with the unit street_address_1: type: string description: The first address line associated with the unit street_address_2: type: string description: The second address line associated with the unit zip: type: string description: The zip code associated with the unit floor_plan_code: type: string description: The external ID of the floor plan unit_type_id: type: string description: The external ID of the unit type required: - integration_id - property_id - lease_period_id - city - country - date_available - number - state - street_address_1 - zip - floor_plan_code - unit_type_id _v1_units_entrata__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration property_id: type: string description: The Propexo unique identifier for the property lease_period_id: type: string description: The Propexo unique identifier for the lease period bathrooms: type: - string - "null" description: The number of bathrooms associated with the unit bedrooms: type: - string - "null" description: The number of bedrooms associated with the unit city: type: string description: The city associated with the unit country: type: string description: The country associated with the unit date_available: type: string format: date-time description: The date that the unit becomes available is_furnished: type: - boolean - "null" description: Whether the unit is furnished number: type: string description: The unit number square_feet: type: - number - "null" description: The square footage of the unit state: type: string description: The state associated with the unit street_address_1: type: string description: The first address line associated with the unit street_address_2: type: - string - "null" description: The second address line associated with the unit zip: type: string description: The zip code associated with the unit floor_plan_code: type: string description: The external ID of the floor plan unit_type_id: type: string description: The external ID of the unit type required: - integration_id - property_id - lease_period_id - bathrooms - bedrooms - city - country - date_available - is_furnished - number - square_feet - state - street_address_1 - street_address_2 - zip - floor_plan_code - unit_type_id required: - meta - result _v1_units_propertyware_{unit_id}_put_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration category: type: string enum: *a264 description: The category of the unit. type: type: string enum: *a265 description: The type of the unit. name: type: string description: 'The name of the unit. Example: "Unit 3".' abbreviation: type: string description: 'The abbreviation of the unit. Example: "UNIT3"' address_1: type: string description: The first address line of the unit. address_2: type: string description: The second address line of the unit. city: type: string description: The city of the unit. state: type: string description: The state of the unit. zip: type: string description: The zip code of the unit. country: type: string description: The country of the unit. notes: type: string description: Notes about the unit. bathrooms: type: - string - "null" description: The number of bathrooms in the unit. bedrooms: type: - string - "null" description: The number of bedrooms in the unit. rent_amount_market_in_cents: type: number description: The market rent cost of the unit, in cents. square_feet: type: number description: The size of the unit in square feet. required: - integration_id - category - type - name - abbreviation - address_1 _v1_units_propertyware_{unit_id}_put_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration unit_id: type: string description: The Propexo unique identifier for the unit category: type: string enum: *a264 description: The category of the unit. type: type: string enum: *a265 description: The type of the unit. name: type: string description: 'The name of the unit. Example: "Unit 3".' abbreviation: type: string description: 'The abbreviation of the unit. Example: "UNIT3"' address_1: type: string description: The first address line of the unit. address_2: type: string description: The second address line of the unit. city: type: string description: The city of the unit. state: type: string description: The state of the unit. zip: type: string description: The zip code of the unit. country: type: string description: The country of the unit. notes: type: string description: Notes about the unit. bathrooms: type: - string - "null" description: The number of bathrooms in the unit. bedrooms: type: - string - "null" description: The number of bedrooms in the unit. rent_amount_market_in_cents: type: number description: The market rent cost of the unit, in cents. square_feet: type: number description: The size of the unit in square feet. required: - integration_id - unit_id - category - type - name - abbreviation - address_1 required: - meta - result _v1_units_propertyware__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration property_id: type: string description: The Propexo unique identifier for the property category: type: string enum: *a266 description: The category of the unit. type: type: string enum: *a267 description: The type of the unit. name: type: string description: 'The name of the unit. Example: "Unit 3".' abbreviation: type: string description: 'The abbreviation of the unit. Example: "UNIT3"' address_1: type: string description: The first address line of the unit. address_2: type: string description: The second address line of the unit. city: type: string description: The city of the unit. state: type: string description: The state of the unit. zip: type: string description: The zip code of the unit. country: type: string description: The country of the unit. notes: type: string description: Notes about the unit. bathrooms: type: - string - "null" description: The number of bathrooms in the unit. bedrooms: type: - string - "null" description: The number of bedrooms in the unit. rent_amount_market_in_cents: type: number description: The market rent cost of the unit, in cents. square_feet: type: number description: The size of the unit in square feet. required: - integration_id - property_id - category - type - name - abbreviation - address_1 _v1_units_propertyware__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration property_id: type: string description: The Propexo unique identifier for the property category: type: string enum: *a266 description: The category of the unit. type: type: string enum: *a267 description: The type of the unit. name: type: string description: 'The name of the unit. Example: "Unit 3".' abbreviation: type: string description: 'The abbreviation of the unit. Example: "UNIT3"' address_1: type: string description: The first address line of the unit. address_2: type: - string - "null" description: The second address line of the unit. city: type: - string - "null" description: The city of the unit. state: type: - string - "null" description: The state of the unit. zip: type: - string - "null" description: The zip code of the unit. country: type: - string - "null" description: The country of the unit. notes: type: - string - "null" description: Notes about the unit. bathrooms: type: - string - "null" description: The number of bathrooms in the unit. bedrooms: type: - string - "null" description: The number of bedrooms in the unit. rent_amount_market_in_cents: type: - number - "null" description: The market rent cost of the unit, in cents. square_feet: type: - number - "null" description: The size of the unit in square feet. required: - integration_id - property_id - category - type - name - abbreviation - address_1 - address_2 - city - state - zip - country - notes - rent_amount_market_in_cents - square_feet required: - meta - result _v1_units_yardi_{id}_put_input: type: object properties: {} _v1_units_yardi_{id}_put_output: type: object properties: {} _v1_units_yardi__post_input: type: object properties: {} _v1_units_yardi__post_output: type: object properties: {} _v1_units_rentmanager_{unit_id}_put_input: type: object properties: number: type: string description: The unit number notes: type: string description: Notes associated with the unit square_feet: type: integer description: The square footage of the unit bathrooms: type: number description: The number of bathrooms associated with the unit. This value is sent directly to Rent Manager as-is. Use decimals for half bathrooms. bedrooms: type: integer description: The number of bedrooms associated with the unit is_vacant: type: boolean description: Whether the unit is vacant address_1: type: string description: The first address line associated with the unit city: type: string description: The city associated with the unit state: type: string description: The state associated with the unit zip: type: string description: The zip code associated with the unit rent_amount_market_in_cents: type: integer description: The market rent amount in cents for the unit _v1_units_rentmanager_{unit_id}_put_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: unit_id: type: string description: The Propexo unique identifier for the unit number: type: string description: The unit number notes: type: string description: Notes associated with the unit square_feet: type: integer description: The square footage of the unit bathrooms: type: number description: The number of bathrooms associated with the unit. This value is sent directly to Rent Manager as-is. Use decimals for half bathrooms. bedrooms: type: integer description: The number of bedrooms associated with the unit is_vacant: type: boolean description: Whether the unit is vacant address_1: type: string description: The first address line associated with the unit city: type: string description: The city associated with the unit state: type: string description: The state associated with the unit zip: type: string description: The zip code associated with the unit rent_amount_market_in_cents: type: integer description: The market rent amount in cents for the unit required: - unit_id required: - meta - result _v1_units_mri_{unit_id}_put_input: type: object properties: {} _v1_units_mri_{unit_id}_put_output: type: object properties: {} _v1_units_rentvine_{unit_id}_custom-data_put_input: type: object properties: custom_data: type: object additionalProperties: anyOf: - {} - type: object properties: value: type: string required: - value - type: "null" description: |- A mapping of the fields you want to update and the associated values. The key for each field is the key from the normalized custom data object, not the label of the custom field. Each entry will look something like: ``` "eyJjYXRlZ29yeUlkIjoiMSIsImZpZWxkSWQiOiIxIiwidmVyc2lvbiI6MX0=": { "value": "Yes" } ``` required: - custom_data _v1_units_rentvine_{unit_id}_custom-data_put_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: unit_id: type: string description: The Propexo unique identifier for the unit custom_data: type: object additionalProperties: anyOf: - {} - type: object properties: value: type: string required: - value - type: "null" description: |- A mapping of the fields you want to update and the associated values. The key for each field is the key from the normalized custom data object, not the label of the custom field. Each entry will look something like: ``` "eyJjYXRlZ29yeUlkIjoiMSIsImZpZWxkSWQiOiIxIiwidmVyc2lvbiI6MX0=": { "value": "Yes" } ``` required: - unit_id - custom_data required: - meta - result _v1_units_propertyware_rest_{unit_id}_custom-data_put_input: type: object properties: custom_data: type: object additionalProperties: anyOf: - {} - type: object properties: value: type: string required: - value - type: "null" description: A mapping of the fields you want to update and the associated values required: - custom_data _v1_units_propertyware_rest_{unit_id}_custom-data_put_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: unit_id: type: string description: The Propexo unique identifier for the unit custom_data: type: object additionalProperties: anyOf: - {} - type: object properties: value: type: string required: - value - type: "null" description: A mapping of the fields you want to update and the associated values required: - unit_id - custom_data required: - meta - result _v1_units_rentmanager_{unit_id}_custom-data_post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration custom_data: type: object description: A mapping of the fields you want to update and the associated values. Rent Manager has a limit of 10 key/value pairs additionalProperties: *a202 required: - integration_id - custom_data _v1_units_rentmanager_{unit_id}_custom-data_post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration unit_id: type: string description: The Propexo unique identifier for the unit custom_data: type: object additionalProperties: *a202 required: - integration_id - unit_id - custom_data required: - meta - result _v1_units_rentmanager_{unit_id}_custom-data_put_input: type: object properties: custom_data: type: object description: A mapping of the fields you want to update and the associated values. Rent Manager has a limit of 10 key/value pairs additionalProperties: *a202 required: - custom_data _v1_units_rentmanager_{unit_id}_custom-data_put_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: unit_id: type: string description: The Propexo unique identifier for the unit custom_data: type: object description: A mapping of the fields you want to update and the associated values. Rent Manager has a limit of 10 key/value pairs additionalProperties: *a202 required: - unit_id - custom_data required: - meta - result _v1_units_buildium_{unit_id}_file-upload__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration attachments: type: array items: type: object properties: title: type: string maxLength: 255 description: A title for the file file_type_id: type: string description: The Propexo unique identifier for the file type file_data: type: string maxLength: 27892121 description: The contents of the file, as a base64 encoded string. The PMS has a max file size of 20 MB. file_name: type: string description: 'The name of the file including the extension. Ex: "resume.pdf"' mime_type: type: string description: 'The mime type of the file. Ex: "application/pdf"' required: - title - file_type_id - file_data - file_name - mime_type minItems: 1 description: Files w/ metadata for the unit. All the files can have a maximum combined file size of 50 MB required: - integration_id - attachments _v1_units_buildium_{unit_id}_file-upload__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration unit_id: type: string description: The Propexo unique identifier for the unit attachments: type: array items: type: object properties: title: type: string maxLength: 255 description: A title for the file file_type_id: type: string description: The Propexo unique identifier for the file type file_data: type: - string - "null" maxLength: 27892121 description: The contents of the file, as a base64 encoded string. The PMS has a max file size of 20 MB. file_name: type: string description: 'The name of the file including the extension. Ex: "resume.pdf"' mime_type: type: string description: 'The mime type of the file. Ex: "application/pdf"' required: - title - file_type_id - file_name - mime_type required: - integration_id - unit_id - attachments required: - meta - result _v1_units_entrata_{id}_file-upload__post_input: type: object properties: {} _v1_units_entrata_{id}_file-upload__post_output: type: object properties: {} _v1_units_rentvine_{unit_id}_file-upload__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration attachment: type: object properties: file_data: type: string maxLength: 69730304 description: The contents of the file, as a base64 encoded string. We limit the file upload size to 50 MB. file_name: type: string description: 'The name of the file including the extension. Ex: "resume.pdf"' mime_type: type: string description: 'The mime type of the file. Ex: "application/pdf"' required: - file_data - file_name - mime_type description: The file data for the document upload required: - integration_id - attachment _v1_units_rentvine_{unit_id}_file-upload__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration unit_id: type: string description: The Propexo unique identifier for the unit attachment: type: object properties: file_data: type: - string - "null" maxLength: 69730304 description: The contents of the file, as a base64 encoded string. We limit the file upload size to 50 MB. file_name: type: string description: 'The name of the file including the extension. Ex: "resume.pdf"' mime_type: type: string description: 'The mime type of the file. Ex: "application/pdf"' required: - file_name - mime_type required: - integration_id - unit_id - attachment required: - meta - result _v1_units_propertyware_{unit_id}_file-upload__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration attachment: type: object properties: file_data: type: string maxLength: 16735272 description: The contents of the file, as a base64 encoded string. The PMS has a max file size of 12 MB. file_name: type: string description: 'The name of the file including the extension. Ex: "resume.pdf"' mime_type: type: string description: 'The mime type of the file. Ex: "application/pdf"' required: - file_data - file_name - mime_type description: Attachment file on the unit notes: type: string description: General notes about the file is_private: type: boolean description: If the file should be marked as private required: - integration_id - attachment _v1_units_propertyware_{unit_id}_file-upload__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration unit_id: type: string description: The Propexo unique identifier for the unit attachment: type: object properties: file_data: type: - string - "null" maxLength: 16735272 description: The contents of the file, as a base64 encoded string. The PMS has a max file size of 12 MB. file_name: type: string description: 'The name of the file including the extension. Ex: "resume.pdf"' mime_type: type: string description: 'The mime type of the file. Ex: "application/pdf"' required: - file_name - mime_type notes: type: - string - "null" is_private: type: - boolean - "null" required: - integration_id - unit_id - attachment - notes - is_private required: - meta - result _v1_units_yardi_{id}_file-upload__post_input: type: object properties: {} _v1_units_yardi_{id}_file-upload__post_output: type: object properties: {} _v1_units_rentmanager_{unit_id}_file-upload__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration images: type: array items: type: object properties: file_data: type: string maxLength: 1394606 description: The contents of the file, as a base64 encoded string. The PMS has a max file size of 29 MB. file_type: type: string enum: &a268 - Image default: Image description: The type of file being uploaded. This defaults to "Image" file_name: type: string description: 'The name of the file including the extension. Ex: "resume.pdf"' mime_type: type: string description: 'The mime type of the file. Ex: "application/pdf"' file_type_id: type: string description: The Propexo unique identifier for the file type. This file_type must contain a "type" value of "image" name: type: string description: 'The name of the image. Ex: "Balcony View"' description: type: string description: 'A description of the image. Ex: "Stunning ocean view from the master bedroom balcony"' caption: type: string description: A caption for the image. Defaults to the image name if left undefined required: - file_data - file_name - mime_type - file_type_id - name - description description: Image files to upload for the unit. attachments: type: array items: type: object properties: file_data: type: string maxLength: 40443576 description: The contents of the file, as a base64 encoded string. The PMS has a max file size of 29 MB. file_type: type: string enum: &a269 - Document default: Document description: The type of file being uploaded. This defaults to "Document" file_name: type: string description: 'The name of the file including the extension. Ex: "resume.pdf"' mime_type: type: string description: 'The mime type of the file. Ex: "application/pdf"' file_type_id: type: string description: The Propexo unique identifier for the file type. This file_type must contain a "type" value of "file" required: - file_data - file_name - mime_type - file_type_id description: Attachment files for user defined fields on the unit. All the files can have a maximum combined file size of 50 MB required: - integration_id _v1_units_rentmanager_{unit_id}_file-upload__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration unit_id: type: string description: The Propexo unique identifier for the unit images: type: - array - "null" items: type: object properties: file_data: type: - string - "null" maxLength: 1394606 description: The contents of the file, as a base64 encoded string. The PMS has a max file size of 29 MB. file_type: type: string enum: *a268 default: Image file_name: type: string description: 'The name of the file including the extension. Ex: "resume.pdf"' mime_type: type: string description: 'The mime type of the file. Ex: "application/pdf"' file_type_id: type: string description: The Propexo unique identifier for the file type. This file_type must contain a "type" value of "image" name: type: string description: 'The name of the image. Ex: "Balcony View"' description: type: string description: 'A description of the image. Ex: "Stunning ocean view from the master bedroom balcony"' caption: type: string required: - file_name - mime_type - file_type_id - name - description attachments: type: - array - "null" items: type: object properties: file_data: type: - string - "null" maxLength: 40443576 description: The contents of the file, as a base64 encoded string. The PMS has a max file size of 29 MB. file_type: type: string enum: *a269 default: Document file_name: type: string description: 'The name of the file including the extension. Ex: "resume.pdf"' mime_type: type: string description: 'The mime type of the file. Ex: "application/pdf"' file_type_id: type: string description: The Propexo unique identifier for the file type. This file_type must contain a "type" value of "file" required: - file_name - mime_type - file_type_id required: - integration_id - unit_id - images - attachments required: - meta - result _v1_units_rentmanager_{unit_id}_notes__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration category_id: type: string description: The Propexo unique identifier for the note category. Some properties may require a category be passed in notes: type: string description: Notes associated with the unit attachment: type: object properties: file_data: type: string maxLength: 40443576 description: The contents of the file, as a base64 encoded string. The PMS has a max file size of 29 MB. file_type: type: string enum: *a269 default: Document description: The type of file being uploaded. This defaults to "Document" file_name: type: string description: 'The name of the file including the extension. Ex: "resume.pdf"' mime_type: type: string description: 'The mime type of the file. Ex: "application/pdf"' required: - file_data - file_name - mime_type description: Attachment files for notes on the unit required: - integration_id - notes _v1_units_rentmanager_{unit_id}_notes__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration unit_id: type: string description: The Propexo unique identifier for the unit category_id: type: - string - "null" notes: type: string description: Notes associated with the unit attachment: type: - object - "null" properties: file_data: type: - string - "null" maxLength: 40443576 description: The contents of the file, as a base64 encoded string. The PMS has a max file size of 29 MB. file_type: type: string enum: *a269 default: Document file_name: type: string description: 'The name of the file including the extension. Ex: "resume.pdf"' mime_type: type: string description: 'The mime type of the file. Ex: "application/pdf"' required: - file_name - mime_type required: - integration_id - unit_id - category_id - notes - attachment required: - meta - result _v1_vendors__get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor property_id: type: string description: The Propexo unique identifier for the property location_id: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" _v1_vendors__get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: type: array items: type: object properties: id: type: string description: The Propexo unique identifier for the vendor created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. account_number: type: - string - "null" description: The account number associated with the vendor is_active: type: - boolean - "null" description: Whether the vendor is active name: type: - string - "null" description: The name associated with the vendor notes: type: - string - "null" description: Notes associated with the vendor tax_id: type: - string - "null" description: The tax payer identification number associated with the vendor third_party_id: type: - string - "null" description: A unique value provided to the PMS to uniquely identify the vendor from your system. type: type: - string - "null" description: The type associated with the vendor contacts: type: array items: type: object properties: address_1: type: - string - "null" description: The first address line associated with the vendor address_2: type: - string - "null" description: The second address line associated with the vendor city: type: - string - "null" description: The city associated with the vendor country: type: - string - "null" description: The country associated with the vendor state: type: - string - "null" description: The state associated with the vendor zip: type: - string - "null" description: The zip code associated with the vendor phone: type: - string - "null" description: Primary phone number associated with the vendor phone_type: type: - string - "null" description: Type of the primary phone number email: type: - string - "null" description: The primary email address associated with the vendor is_primary: type: - boolean - "null" description: Whether the vendor is the primary record name: type: - string - "null" description: The name associated with the vendor required: - address_1 - address_2 - city - country - state - zip - phone - phone_type - email - is_primary - name custom_data: type: - object - "null" properties: {} integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" property_id: type: string description: The Propexo unique identifier for the property required: - id - created_at - updated_at - last_seen - x_id - x_property_id - x_location_id - account_number - is_active - name - notes - tax_id - third_party_id - type - contacts - custom_data - integration_id - integration_vendor - property_id x-propexo: &a270 derivedFromModel: service_request_vendors required: - meta - results _v1_vendors__post_input: type: object properties: integration_id: type: string vendor_category_id: type: string description: The Propexo unique identifier for the vendor category is_company: type: boolean description: Indicates whether the vendor should be considered a company or person first_name: type: string maxLength: 127 description: First name of the vendor. Required if `is_company` is `false` last_name: type: string maxLength: 127 description: Last name of the vendor. Required if `is_company` is `false` name: type: string maxLength: 127 description: Company name of the vendor. Required if `is_company` is `true` email_1: type: string format: email description: Primary email for the vendor email_2: type: string format: email description: Alternate email for the vendor phone_1: type: string minLength: 10 maxLength: 20 description: First phone number phone_1_type: type: string enum: &a271 - HOME - WORK - MOBILE - FAX description: First phone number type phone_2: type: string minLength: 10 maxLength: 20 description: Second phone number phone_2_type: type: string enum: &a272 - HOME - WORK - MOBILE - FAX description: Second phone number type address_1: type: string maxLength: 100 description: The first address line associated with the vendor address_2: type: string maxLength: 100 description: The second address line associated with the vendor city: type: string maxLength: 100 description: The city associated with the vendor state: type: string description: The state associated with the vendor zip: type: string description: The zip code associated with the vendor country: type: string description: The country associated with the vendor account_number: type: string maxLength: 30 description: The account number associated with the vendor website: type: string maxLength: 100 format: uri description: The website URL associated with the vendor insurance_provider: type: string maxLength: 65 description: Vendor insurance provider insurance_policy_number: type: string maxLength: 65 description: Vendor insurance policy number insurance_expire_date: type: string format: date-time description: Vendor insurance policy expiration date notes: type: string maxLength: 65535 description: Notes associated with the vendor tax_id: type: string description: The unique identifier of the tax payer. Required if `tax_payer_type` is set tax_payer_type: type: string enum: &a273 - SSN - EIN description: The tax payer type. Required if `tax_id` is set tax_payer_name_1: type: string maxLength: 40 description: The tax payer name 1 tax_payer_name_2: type: string maxLength: 40 description: The tax payer name 2 tax_address_1: type: string maxLength: 100 description: The tax payer address line 1 tax_address_2: type: string maxLength: 100 description: The tax payer address line 2 tax_city: type: string maxLength: 100 description: The tax payer address city tax_state: type: string description: The tax payer address state tax_zip: type: string description: The tax payer address zip code tax_country: type: string description: The tax payer address country required: - integration_id _v1_vendors__post_output: type: object properties: job_id: type: string description: The ID of the job created to handle this operation data: type: object properties: {} required: - job_id - data _v1_vendors_{vendor_id}_get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query _v1_vendors_{vendor_id}_get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: type: object properties: id: type: string description: The Propexo unique identifier for the vendor created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. account_number: type: - string - "null" description: The account number associated with the vendor is_active: type: - boolean - "null" description: Whether the vendor is active name: type: - string - "null" description: The name associated with the vendor notes: type: - string - "null" description: Notes associated with the vendor tax_id: type: - string - "null" description: The tax payer identification number associated with the vendor third_party_id: type: - string - "null" description: A unique value provided to the PMS to uniquely identify the vendor from your system. type: type: - string - "null" description: The type associated with the vendor contacts: type: array items: type: object properties: address_1: type: - string - "null" description: The first address line associated with the vendor address_2: type: - string - "null" description: The second address line associated with the vendor city: type: - string - "null" description: The city associated with the vendor country: type: - string - "null" description: The country associated with the vendor state: type: - string - "null" description: The state associated with the vendor zip: type: - string - "null" description: The zip code associated with the vendor phone: type: - string - "null" description: Primary phone number associated with the vendor phone_type: type: - string - "null" description: Type of the primary phone number email: type: - string - "null" description: The primary email address associated with the vendor is_primary: type: - boolean - "null" description: Whether the vendor is the primary record name: type: - string - "null" description: The name associated with the vendor required: - address_1 - address_2 - city - country - state - zip - phone - phone_type - email - is_primary - name custom_data: type: - object - "null" properties: {} integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" property_id: type: string description: The Propexo unique identifier for the property required: - id - created_at - updated_at - last_seen - x_id - x_property_id - x_location_id - account_number - is_active - name - notes - tax_id - third_party_id - type - contacts - custom_data - integration_id - integration_vendor - property_id x-propexo: *a270 required: - meta - results _v1_vendors_{vendor_id}_put_input: type: object properties: name: type: string description: The name associated with the vendor is_active: type: boolean description: Whether the vendor is active notes: type: string maxLength: 1998 description: Notes associated with the vendor tax_id: type: string tax_payer_first_name: type: string description: The first name of the tax payer associated with the vendor tax_payer_last_name: type: string description: The last name of the tax payer associated with the vendor workers_comp_expiration_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The expiration date of the workers compensation policy on file for this vendor liability_expiration_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The expiration date of the liability insurance policy on file for this vendor address_1: type: string description: The first address line associated with the vendor address_2: type: string description: The second address line associated with the vendor city: type: string description: The city associated with the vendor state: type: string enum: *a33 description: The state associated with the vendor zip: type: string description: The zip code associated with the vendor country: anyOf: - type: string enum: &a278 - United States - Canada - type: string description: The country associated with the vendor email_1: type: string description: The primary email address associated with the vendor phone_1: type: string description: Primary phone number associated with the vendor phone_2: type: string description: Secondary phone number associated with the vendor _v1_vendors_{vendor_id}_put_output: type: object properties: job_id: type: string description: The ID of the job created to handle this operation data: type: object properties: {} required: - job_id - data _v1_vendor-locations__get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query x_id: type: string description: The external ID from the integration vendor location_id: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. property_id: type: string description: The Propexo unique identifier for the property integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" VendorLocation: type: object properties: id: type: string description: The Propexo unique identifier for the vendor location created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: type: string description: The name associated with the vendor location integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" property_id: type: string description: The Propexo unique identifier for the property required: - id - created_at - updated_at - last_seen - x_id - x_property_id - x_location_id - name - integration_id - integration_vendor - property_id x-propexo: derivedFromModel: entrata_vendor_locations _v1_vendor-locations__get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: type: array items: $ref: "#/components/schemas/VendorLocation" required: - meta - results _v1_vendor-locations_{vendor_location_id}_get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query _v1_vendor-locations_{vendor_location_id}_get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: $ref: "#/components/schemas/VendorLocation" required: - meta - results _v1_vendors_properties_{property_id}_get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query _v1_vendors_properties_{property_id}_get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: type: array items: type: object properties: id: type: string description: The Propexo unique identifier for the vendor created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. account_number: type: - string - "null" description: The account number associated with the vendor is_active: type: - boolean - "null" description: Whether the vendor is active name: type: - string - "null" description: The name associated with the vendor notes: type: - string - "null" description: Notes associated with the vendor tax_id: type: - string - "null" description: The tax payer identification number associated with the vendor third_party_id: type: - string - "null" description: A unique value provided to the PMS to uniquely identify the vendor from your system. type: type: - string - "null" description: The type associated with the vendor contacts: type: array items: type: object properties: address_1: type: - string - "null" description: The first address line associated with the vendor address_2: type: - string - "null" description: The second address line associated with the vendor city: type: - string - "null" description: The city associated with the vendor country: type: - string - "null" description: The country associated with the vendor state: type: - string - "null" description: The state associated with the vendor zip: type: - string - "null" description: The zip code associated with the vendor phone: type: - string - "null" description: Primary phone number associated with the vendor phone_type: type: - string - "null" description: Type of the primary phone number email: type: - string - "null" description: The primary email address associated with the vendor is_primary: type: - boolean - "null" description: Whether the vendor is the primary record name: type: - string - "null" description: The name associated with the vendor required: - address_1 - address_2 - city - country - state - zip - phone - phone_type - email - is_primary - name custom_data: type: - object - "null" properties: {} integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: $ref: "#/components/schemas/Enum1" property_id: type: string description: The Propexo unique identifier for the property required: - id - created_at - updated_at - last_seen - x_id - x_property_id - x_location_id - account_number - is_active - name - notes - tax_id - third_party_id - type - contacts - custom_data - integration_id - integration_vendor - property_id x-propexo: *a270 required: - meta - results _v1_vendors_buildium__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration vendor_category_id: type: string description: The Propexo unique identifier for the vendor category is_company: type: boolean description: Indicates whether the vendor should be considered a company or person first_name: type: string maxLength: 127 description: First name of the vendor. Required if `is_company` is `false` last_name: type: string maxLength: 127 description: Last name of the vendor. Required if `is_company` is `false` name: type: string maxLength: 127 description: Company name of the vendor. Required if `is_company` is `true` email_1: type: string format: email description: Primary email for the vendor email_2: type: string format: email description: Alternate email for the vendor phone_1: type: string minLength: 10 maxLength: 20 description: First phone number phone_1_type: type: string enum: *a271 description: First phone number type phone_2: type: string minLength: 10 maxLength: 20 description: Second phone number phone_2_type: type: string enum: *a272 description: Second phone number type address_1: type: string maxLength: 100 description: The first address line associated with the vendor address_2: type: string maxLength: 100 description: The second address line associated with the vendor city: type: string maxLength: 100 description: The city associated with the vendor state: type: string description: The state associated with the vendor zip: type: string description: The zip code associated with the vendor country: type: string description: The country associated with the vendor account_number: type: string maxLength: 30 description: The account number associated with the vendor website: type: string maxLength: 100 format: uri description: The website URL associated with the vendor insurance_provider: type: string maxLength: 65 description: Vendor insurance provider insurance_policy_number: type: string maxLength: 65 description: Vendor insurance policy number insurance_expire_date: type: string format: date-time description: Vendor insurance policy expiration date notes: type: string maxLength: 65535 description: Notes associated with the vendor tax_id: type: string description: The unique identifier of the tax payer. Required if `tax_payer_type` is set tax_payer_type: type: string enum: *a273 description: The tax payer type. Required if `tax_id` is set tax_payer_name_1: type: string maxLength: 40 description: The tax payer name 1 tax_payer_name_2: type: string maxLength: 40 description: The tax payer name 2 tax_address_1: type: string maxLength: 100 description: The tax payer address line 1 tax_address_2: type: string maxLength: 100 description: The tax payer address line 2 tax_city: type: string maxLength: 100 description: The tax payer address city tax_state: type: string description: The tax payer address state tax_zip: type: string description: The tax payer address zip code tax_country: type: string description: The tax payer address country required: - integration_id - vendor_category_id - is_company _v1_vendors_buildium__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration vendor_category_id: type: string description: The Propexo unique identifier for the vendor category is_company: type: boolean description: Indicates whether the vendor should be considered a company or person first_name: type: - string - "null" maxLength: 127 description: First name of the vendor. Required if `is_company` is `false` last_name: type: - string - "null" maxLength: 127 description: Last name of the vendor. Required if `is_company` is `false` name: type: - string - "null" maxLength: 127 description: Company name of the vendor. Required if `is_company` is `true` email_1: type: - string - "null" format: email description: Primary email for the vendor email_2: type: - string - "null" format: email description: Alternate email for the vendor phone_1: type: - string - "null" minLength: 10 maxLength: 20 description: First phone number phone_1_type: type: - string - "null" enum: *a271 description: First phone number type phone_2: type: - string - "null" minLength: 10 maxLength: 20 description: Second phone number phone_2_type: type: - string - "null" enum: *a272 description: Second phone number type address_1: type: - string - "null" maxLength: 100 description: The first address line associated with the vendor address_2: type: - string - "null" maxLength: 100 description: The second address line associated with the vendor city: type: - string - "null" maxLength: 100 description: The city associated with the vendor state: type: - string - "null" description: The state associated with the vendor zip: type: - string - "null" description: The zip code associated with the vendor country: type: - string - "null" description: The country associated with the vendor account_number: type: - string - "null" maxLength: 30 description: The account number associated with the vendor website: type: - string - "null" maxLength: 100 format: uri description: The website URL associated with the vendor insurance_provider: type: - string - "null" maxLength: 65 description: Vendor insurance provider insurance_policy_number: type: - string - "null" maxLength: 65 description: Vendor insurance policy number insurance_expire_date: type: - string - "null" format: date-time description: Vendor insurance policy expiration date notes: type: - string - "null" maxLength: 65535 description: Notes associated with the vendor tax_id: type: - string - "null" description: The unique identifier of the tax payer. Required if `tax_payer_type` is set tax_payer_type: type: - string - "null" enum: *a273 description: The tax payer type. Required if `tax_id` is set tax_payer_name_1: type: - string - "null" maxLength: 40 description: The tax payer name 1 tax_payer_name_2: type: - string - "null" maxLength: 40 description: The tax payer name 2 tax_address_1: type: - string - "null" maxLength: 100 description: The tax payer address line 1 tax_address_2: type: - string - "null" maxLength: 100 description: The tax payer address line 2 tax_city: type: - string - "null" maxLength: 100 description: The tax payer address city tax_state: type: - string - "null" description: The tax payer address state tax_zip: type: - string - "null" description: The tax payer address zip code tax_country: type: - string - "null" description: The tax payer address country required: - integration_id - vendor_category_id - is_company - first_name - last_name - name - email_1 - email_2 - phone_1 - phone_1_type - phone_2 - phone_2_type - address_1 - address_2 - city - state - zip - country - account_number - website - insurance_provider - insurance_policy_number - insurance_expire_date - notes - tax_id - tax_payer_type - tax_payer_name_1 - tax_payer_name_2 - tax_address_1 - tax_address_2 - tax_city - tax_state - tax_zip - tax_country required: - meta - result _v1_vendors_yardi__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration name: type: string description: The name associated with the vendor is_active: type: boolean description: Whether the vendor is active notes: type: string maxLength: 1998 description: Notes associated with the vendor tax_id: type: string tax_payer_first_name: type: string description: The first name of the tax payer associated with the vendor tax_payer_last_name: type: string description: The last name of the tax payer associated with the vendor workers_comp_expiration_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The expiration date of the workers compensation policy on file for this vendor liability_expiration_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The expiration date of the liability insurance policy on file for this vendor address_1: type: string description: The first address line associated with the vendor address_2: type: string description: The second address line associated with the vendor city: type: string description: The city associated with the vendor state: type: string enum: *a33 description: The state associated with the vendor zip: type: string description: The zip code associated with the vendor country: anyOf: - type: string enum: &a274 - United States - Canada - type: string description: The country associated with the vendor email_1: type: string description: The primary email address associated with the vendor phone_1: type: string description: Primary phone number associated with the vendor phone_2: type: string description: Secondary phone number associated with the vendor required: - integration_id - name _v1_vendors_yardi__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration name: type: string description: The name associated with the vendor is_active: type: - boolean - "null" description: Whether the vendor is active notes: type: - string - "null" maxLength: 1998 description: Notes associated with the vendor tax_id: type: - string - "null" description: The tax payer identification number associated with the vendor tax_payer_first_name: type: - string - "null" description: The first name of the tax payer associated with the vendor tax_payer_last_name: type: - string - "null" description: The last name of the tax payer associated with the vendor workers_comp_expiration_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" description: The expiration date of the workers compensation policy on file for this vendor liability_expiration_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" description: The expiration date of the liability insurance policy on file for this vendor address_1: type: - string - "null" description: The first address line associated with the vendor address_2: type: - string - "null" description: The second address line associated with the vendor city: type: - string - "null" description: The city associated with the vendor state: type: - string - "null" enum: *a33 description: The state associated with the vendor zip: type: - string - "null" description: The zip code associated with the vendor country: anyOf: - type: string enum: *a274 - type: string - type: "null" description: The country associated with the vendor email_1: type: - string - "null" description: The primary email address associated with the vendor phone_1: type: - string - "null" description: Primary phone number associated with the vendor phone_2: type: - string - "null" description: Secondary phone number associated with the vendor required: - integration_id - name - is_active - notes - tax_id - tax_payer_first_name - tax_payer_last_name - workers_comp_expiration_date - liability_expiration_date - address_1 - address_2 - city - state - zip - country - email_1 - phone_1 - phone_2 required: - meta - result _v1_vendors_yardi_{vendor_id}_put_input: type: object properties: name: type: string description: The name associated with the vendor is_active: type: boolean description: Whether the vendor is active notes: type: string maxLength: 1998 description: Notes associated with the vendor tax_id: type: string tax_payer_first_name: type: string description: The first name of the tax payer associated with the vendor tax_payer_last_name: type: string description: The last name of the tax payer associated with the vendor workers_comp_expiration_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The expiration date of the workers compensation policy on file for this vendor liability_expiration_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The expiration date of the liability insurance policy on file for this vendor address_1: type: string description: The first address line associated with the vendor address_2: type: string description: The second address line associated with the vendor city: type: string description: The city associated with the vendor state: type: string enum: *a33 description: The state associated with the vendor zip: type: string description: The zip code associated with the vendor country: anyOf: - type: string enum: &a275 - United States - Canada - type: string description: The country associated with the vendor email_1: type: string description: The primary email address associated with the vendor phone_1: type: string description: Primary phone number associated with the vendor phone_2: type: string description: Secondary phone number associated with the vendor required: - name _v1_vendors_yardi_{vendor_id}_put_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: vendor_id: type: string description: The Propexo unique identifier for the vendor name: type: string description: The name associated with the vendor is_active: type: boolean description: Whether the vendor is active notes: type: string maxLength: 1998 description: Notes associated with the vendor tax_id: type: string tax_payer_first_name: type: string description: The first name of the tax payer associated with the vendor tax_payer_last_name: type: string description: The last name of the tax payer associated with the vendor workers_comp_expiration_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The expiration date of the workers compensation policy on file for this vendor liability_expiration_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The expiration date of the liability insurance policy on file for this vendor address_1: type: string description: The first address line associated with the vendor address_2: type: string description: The second address line associated with the vendor city: type: string description: The city associated with the vendor state: type: string enum: *a33 description: The state associated with the vendor zip: type: string description: The zip code associated with the vendor country: anyOf: - type: string enum: *a275 - type: string description: The country associated with the vendor email_1: type: string description: The primary email address associated with the vendor phone_1: type: string description: Primary phone number associated with the vendor phone_2: type: string description: Secondary phone number associated with the vendor required: - vendor_id - name required: - meta - result _v1_vendors_yardi_rest__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration property_id: type: string description: The Propexo unique identifier for the property name: type: string description: The name associated with the vendor is_active: type: boolean description: Whether the vendor is active notes: type: string maxLength: 1998 description: Notes associated with the vendor tax_id: type: string tax_payer_first_name: type: string description: The first name of the tax payer associated with the vendor tax_payer_last_name: type: string description: The last name of the tax payer associated with the vendor workers_comp_expiration_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The expiration date of the workers compensation policy on file for this vendor liability_expiration_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The expiration date of the liability insurance policy on file for this vendor payment_method: type: string enum: &a276 - Check - EFT description: The payment method for the vendor. address_1: type: string description: The first address line associated with the vendor address_2: type: string description: The second address line associated with the vendor city: type: string description: The city associated with the vendor state: type: string enum: *a33 description: The state associated with the vendor zip: type: string description: The zip code associated with the vendor country: anyOf: - type: string enum: &a277 - United States - Canada - type: string description: The country associated with the vendor email_1: type: string description: The primary email address associated with the vendor phone_1: type: string description: Primary phone number associated with the vendor phone_2: type: string description: Secondary phone number associated with the vendor required: - integration_id - property_id - name _v1_vendors_yardi_rest__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration property_id: type: string description: The Propexo unique identifier for the property name: type: string description: The name associated with the vendor is_active: type: - boolean - "null" description: Whether the vendor is active notes: type: - string - "null" maxLength: 1998 description: Notes associated with the vendor tax_id: type: - string - "null" description: The tax payer identification number associated with the vendor tax_payer_first_name: type: - string - "null" description: The first name of the tax payer associated with the vendor tax_payer_last_name: type: - string - "null" description: The last name of the tax payer associated with the vendor workers_comp_expiration_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" description: The expiration date of the workers compensation policy on file for this vendor liability_expiration_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" description: The expiration date of the liability insurance policy on file for this vendor payment_method: type: - string - "null" enum: *a276 description: The payment method for the vendor. address_1: type: - string - "null" description: The first address line associated with the vendor address_2: type: - string - "null" description: The second address line associated with the vendor city: type: - string - "null" description: The city associated with the vendor state: type: - string - "null" enum: *a33 description: The state associated with the vendor zip: type: - string - "null" description: The zip code associated with the vendor country: anyOf: - type: string enum: *a277 - type: string - type: "null" description: The country associated with the vendor email_1: type: - string - "null" description: The primary email address associated with the vendor phone_1: type: - string - "null" description: Primary phone number associated with the vendor phone_2: type: - string - "null" description: Secondary phone number associated with the vendor required: - integration_id - property_id - name - is_active - notes - tax_id - tax_payer_first_name - tax_payer_last_name - workers_comp_expiration_date - liability_expiration_date - payment_method - address_1 - address_2 - city - state - zip - country - email_1 - phone_1 - phone_2 required: - meta - result _v1_vendors_yardi_rest_{vendor_id}_put_input: type: object properties: name: type: string description: The name associated with the vendor is_active: type: boolean description: Whether the vendor is active notes: type: string maxLength: 1998 description: Notes associated with the vendor tax_id: type: string tax_payer_first_name: type: string description: The first name of the tax payer associated with the vendor tax_payer_last_name: type: string description: The last name of the tax payer associated with the vendor workers_comp_expiration_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The expiration date of the workers compensation policy on file for this vendor liability_expiration_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The expiration date of the liability insurance policy on file for this vendor address_1: type: string description: The first address line associated with the vendor address_2: type: string description: The second address line associated with the vendor city: type: string description: The city associated with the vendor state: type: string enum: *a33 description: The state associated with the vendor zip: type: string description: The zip code associated with the vendor country: anyOf: - type: string enum: *a278 - type: string description: The country associated with the vendor email_1: type: string description: The primary email address associated with the vendor phone_1: type: string description: Primary phone number associated with the vendor phone_2: type: string description: Secondary phone number associated with the vendor required: - name _v1_vendors_yardi_rest_{vendor_id}_put_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: vendor_id: type: string description: The Propexo unique identifier for the vendor name: type: string description: The name associated with the vendor is_active: type: - boolean - "null" description: Whether the vendor is active notes: type: - string - "null" maxLength: 1998 description: Notes associated with the vendor tax_id: type: - string - "null" description: The tax payer identification number associated with the vendor tax_payer_first_name: type: - string - "null" description: The first name of the tax payer associated with the vendor tax_payer_last_name: type: - string - "null" description: The last name of the tax payer associated with the vendor workers_comp_expiration_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" description: The expiration date of the workers compensation policy on file for this vendor liability_expiration_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: "null" description: The expiration date of the liability insurance policy on file for this vendor address_1: type: - string - "null" description: The first address line associated with the vendor address_2: type: - string - "null" description: The second address line associated with the vendor city: type: - string - "null" description: The city associated with the vendor state: type: - string - "null" enum: *a33 description: The state associated with the vendor zip: type: - string - "null" description: The zip code associated with the vendor country: anyOf: - type: string enum: *a278 - type: string - type: "null" description: The country associated with the vendor email_1: type: - string - "null" description: The primary email address associated with the vendor phone_1: type: - string - "null" description: Primary phone number associated with the vendor phone_2: type: - string - "null" description: Secondary phone number associated with the vendor required: - vendor_id - name - is_active - notes - tax_id - tax_payer_first_name - tax_payer_last_name - workers_comp_expiration_date - liability_expiration_date - address_1 - address_2 - city - state - zip - country - email_1 - phone_1 - phone_2 required: - meta - result _v1_vendors_resman__post_input: type: object properties: {} _v1_vendors_resman__post_output: type: object properties: {} _v1_vendors_resman_{vendor_id}_put_input: type: object properties: {} _v1_vendors_resman_{vendor_id}_put_output: type: object properties: {} _v1_vendors_entrata__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration properties: type: array items: type: object properties: property_id: type: string description: The Propexo unique identifier for the property is_compliant: type: boolean description: Whether or not the property is compliant required: - property_id - is_compliant minItems: 1 description: A list of properties that the vendor is approved for name: type: string description: The name associated with the vendor tax_payer_first_name: type: string description: The first name of the tax payer associated with the vendor tax_payer_last_name: type: string description: The last name of the tax payer associated with the vendor payment_type_id: type: string description: The Propexo unique identifier for the vendor payment type location_name: type: string description: The name associated with the vendor location contacts: type: array items: type: object properties: contact_first_name: type: string description: The first name associated with the vendor contact contact_last_name: type: string description: The last name associated with the vendor contact is_primary: type: boolean description: Whether or not this is the primary contact contact_email_1: type: string description: The primary email address associated with the vendor contact contact_phone_1: type: string description: Primary phone number associated with the vendor contact required: - contact_first_name - contact_last_name - is_primary minItems: 1 description: A list of contacts associated with the vendor. At least 1 contact must be marked as the primary contact notes: type: string description: Notes associated with the vendor tax_id: type: string third_party_id: type: string description: A unique value provided to Entrata to uniquely identify the vendor from your system. This can be an alphanumeric string. This does not become the ID of the vendor in Entrata. If not provided, Propexo will generate one financial_account_id: type: string description: The Propexo unique identifier for the financial account payment_name_on_account: type: string description: The name on the account associated with vendor payments. Required if vendor payment type is ACH payment_routing_number: type: string minLength: 9 maxLength: 9 description: The routing number associated with vendor payments. Required if vendor payment type is ACH payment_account_number: type: string description: The account number associated with vendor payments. Required if vendor payment type is ACH payment_address_1: type: string description: The first address line associated with the vendor location payment_address_2: type: string description: The second address line associated with the vendor location payment_city: type: string description: The city associated with the vendor location payment_state: type: string enum: &a279 - AA - AE - AK - AL - AP - AR - AS - AZ - CA - CO - CT - DC - DE - FL - FM - GA - GU - HI - IA - ID - IN - KS - KY - LA - MA - MD - ME - MH - MI - MN - MO - MP - MS - MT - NC - NE - NL - NJ - NM - NV - NY - OH - OK - OR - PA - PR - SD - TN - TX - UT - VA - VI - VT - WA - WI - WV - WY - AB - BC - MB - NB - NL - NT - NS - NU - ON - PE - QC - SK - YT description: The state associated with the vendor location payment_zip: type: string description: The zip code associated with the vendor location payment_country: anyOf: - type: string enum: &a280 - US - CA - type: string description: The country associated with the vendor location location_address_1: type: string description: The first address line associated with the vendor location location_address_2: type: string description: The second address line associated with the vendor location location_city: type: string description: The city associated with the vendor location location_state: type: string enum: *a279 description: The state associated with the vendor location location_zip: type: string description: The zip code associated with the vendor location location_country: anyOf: - type: string enum: &a281 - US - CA - type: string description: The country associated with the vendor location location_email_1: type: string description: The primary email address associated with the vendor location location_phone_1: type: string description: Primary phone number associated with the vendor location location_notes: type: string description: Notes associated with the vendor location insurance_plan: type: object properties: insurance_property_ids: type: array items: type: string minItems: 1 description: An array of Propexo property IDs associated with the insurance policy insurance_attachment: type: object properties: file_data: type: string maxLength: 69730304 description: The contents of the file, as a base64 encoded string. The PMS has a max file size of 50 MB. file_name: type: string description: 'The name of the file including the extension. Ex: "image.jpg"' mime_type: type: string description: 'The mime type of the file. Ex: "image/jpeg"' required: - file_data - file_name - mime_type description: The document of record associated with the insurance policy insurance_coverage_name: type: string description: The name of the coverage associated with the insurance plan insurance_policies: type: array items: type: object properties: insurance_policy_type_id: type: string description: The Propexo unique identifier for the vendor insurance policy type insurance_policy_number: type: string description: The policy number associated with the insurance plan insurance_policy_description: type: string description: The policy description associated with the insurance plan expiration_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: The expiration date of the insurance policy insurance_coverages: type: array items: type: object properties: insurance_coverage_type_id: type: string description: The Propexo unique identifier for the vendor insurance coverage type insurance_coverage_amount_in_cents: type: number description: The coverage amount in cents associated with the insurance policy required: - insurance_coverage_type_id - insurance_coverage_amount_in_cents minItems: 1 description: List of coverages associated with the insurance policy required: - insurance_policy_type_id - insurance_policy_number - insurance_policy_description - expiration_date - insurance_coverages minItems: 1 description: A list of insurance policies associated with the vendor required: - insurance_property_ids - insurance_attachment - insurance_coverage_name - insurance_policies description: The details of an insurance plan associated with the vendor required: - integration_id - properties - name - tax_payer_first_name - tax_payer_last_name - payment_type_id - location_name - contacts _v1_vendors_entrata__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration properties: type: array items: type: object properties: property_id: type: string description: The Propexo unique identifier for the property is_compliant: type: boolean description: Whether or not the property is compliant required: - property_id - is_compliant name: type: string description: The name associated with the vendor tax_payer_first_name: type: string description: The first name of the tax payer associated with the vendor tax_payer_last_name: type: string description: The last name of the tax payer associated with the vendor payment_type_id: type: string description: The Propexo unique identifier for the vendor payment type location_name: type: string description: The name associated with the vendor location contacts: type: array items: type: object properties: contact_first_name: type: string description: The first name associated with the vendor contact contact_last_name: type: string description: The last name associated with the vendor contact is_primary: type: boolean description: Whether or not this is the primary contact contact_email_1: type: string contact_phone_1: type: string required: - contact_first_name - contact_last_name - is_primary notes: type: - string - "null" tax_id: type: - string - "null" third_party_id: type: - string - "null" financial_account_id: type: - string - "null" payment_name_on_account: type: - string - "null" payment_routing_number: type: - string - "null" minLength: 9 maxLength: 9 payment_account_number: type: - string - "null" payment_address_1: type: - string - "null" payment_address_2: type: - string - "null" payment_city: type: - string - "null" payment_state: type: - string - "null" enum: *a279 payment_zip: type: - string - "null" payment_country: anyOf: - type: string enum: *a280 - type: string - type: "null" location_address_1: type: - string - "null" location_address_2: type: - string - "null" location_city: type: - string - "null" location_state: type: - string - "null" enum: *a279 location_zip: type: - string - "null" location_country: anyOf: - type: string enum: *a281 - type: string - type: "null" location_email_1: type: - string - "null" location_phone_1: type: - string - "null" location_notes: type: - string - "null" insurance_plan: type: - object - "null" properties: insurance_property_ids: type: array items: type: string insurance_attachment: type: object properties: file_data: type: - string - "null" maxLength: 69730304 description: The contents of the file, as a base64 encoded string. The PMS has a max file size of 50 MB. file_name: type: string description: 'The name of the file including the extension. Ex: "image.jpg"' mime_type: type: string description: 'The mime type of the file. Ex: "image/jpeg"' required: - file_name - mime_type insurance_coverage_name: type: string description: The name of the coverage associated with the insurance plan insurance_policies: type: array items: type: object properties: insurance_policy_type_id: type: string description: The Propexo unique identifier for the vendor insurance policy type insurance_policy_number: type: string description: The policy number associated with the insurance plan insurance_policy_description: type: string description: The policy description associated with the insurance plan expiration_date: anyOf: - type: string format: date-time - type: string pattern: ^\d{4}-\d{2}-\d{2}$ insurance_coverages: type: array items: type: object properties: insurance_coverage_type_id: type: string description: The Propexo unique identifier for the vendor insurance coverage type insurance_coverage_amount_in_cents: type: number description: The coverage amount in cents associated with the insurance policy required: - insurance_coverage_type_id - insurance_coverage_amount_in_cents required: - insurance_policy_type_id - insurance_policy_number - insurance_policy_description - expiration_date - insurance_coverages required: - insurance_property_ids - insurance_attachment - insurance_coverage_name - insurance_policies required: - integration_id - properties - name - tax_payer_first_name - tax_payer_last_name - payment_type_id - location_name - contacts - notes - tax_id - third_party_id - financial_account_id - payment_name_on_account - payment_routing_number - payment_account_number - payment_address_1 - payment_address_2 - payment_city - payment_state - payment_zip - payment_country - location_address_1 - location_address_2 - location_city - location_state - location_zip - location_country - location_email_1 - location_phone_1 - location_notes - insurance_plan required: - meta - result _v1_vendors_resman_file-upload__post_input: type: object properties: {} _v1_vendors_resman_file-upload__post_output: type: object properties: {} _v1_vendors_propertyware_{vendor_id}_file-upload__post_input: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration attachment: type: object properties: file_data: type: string maxLength: 16735272 description: The contents of the file, as a base64 encoded string. The PMS has a max file size of 12 MB. file_name: type: string description: 'The name of the file including the extension. Ex: "resume.pdf"' mime_type: type: string description: 'The mime type of the file. Ex: "application/pdf"' required: - file_data - file_name - mime_type description: Attachment file on the vendor notes: type: string description: General notes about the file is_private: type: boolean description: If the file should be marked as private required: - integration_id - attachment _v1_vendors_propertyware_{vendor_id}_file-upload__post_output: type: object properties: meta: type: object properties: job_id: type: string required: - job_id result: type: object properties: integration_id: type: string description: The Propexo unique identifier for the integration vendor_id: type: string description: The Propexo unique identifier for the vendor attachment: type: object properties: file_data: type: - string - "null" maxLength: 16735272 description: The contents of the file, as a base64 encoded string. The PMS has a max file size of 12 MB. file_name: type: string description: 'The name of the file including the extension. Ex: "resume.pdf"' mime_type: type: string description: 'The mime type of the file. Ex: "application/pdf"' required: - file_name - mime_type notes: type: - string - "null" is_private: type: - boolean - "null" required: - integration_id - vendor_id - attachment - notes - is_private required: - meta - result _v1_webhooks__get_input: type: object properties: active: type: - boolean - "null" default: true description: Filter by active status order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query _v1_webhooks__get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: type: array items: type: object properties: id: type: string description: The unique identifier for the webhook created_at: type: string description: The date the webhook was created updated_at: type: string description: The date the webhook was last updated url: type: string description: The url to send the webhook to headers: type: array items: type: object properties: header: type: string value: type: string required: - header - value active: type: boolean description: The status of the webhook secret: type: string description: The secret used to sign the webhook system: type: string enum: &a282 - PRODUCTION - SANDBOX description: The environment in which the webhook runs triggers: type: array items: type: object properties: id: type: string description: The ID of the trigger trigger: type: string description: The name of the trigger model: type: - string - "null" description: The model that triggers the webhook required: - id - trigger - model required: - id - created_at - updated_at - url - active - secret - system required: - meta - results _v1_webhooks__post_input: type: object properties: url: type: string format: uri description: The url to send the webhook to headers: type: array items: type: object properties: header: type: string value: type: string required: - header - value description: Optional headers to send with the webhook triggers: type: array items: type: string enum: - DATA_UPDATE - DATA_NEW - JOB_FAILURE - SYNC_COMPLETE - FIRST_SYNC_COMPLETE - WRITE_OPERATION_FAILURE minItems: 1 description: The events that will trigger the webhook active: type: boolean default: false description: Whether the webhook is active secret: type: string minLength: 10 description: The secret to use to sign the webhook payload. If you do not provide a secret, one will be generated for you. model: type: string enum: - accounting_entities - address_types - amenities - ap_codes - ap_codes_to_construction_job - applicant_pets - applicants - applicants_to_applications - applicants_to_events - applicants_to_rentable_items - application_statuses - applications - call_logs - charge_code_types - charge_code_types_to_charge_timings - charge_codes - charge_timings - concessions - construction_job_details - construction_jobs - contract_details - contracts - crm_agents - crm_amenities - crm_attributions - crm_communities - crm_communities_to_agents - crm_communities_to_attributions - crm_events - crm_listings - crm_pet_policies - crm_prospects - deposit_summaries - deposits - employees - entrata_lease_periods - entrata_unit_types - entrata_vendor_locations - event_results - event_results_to_event_types - event_sub_types - event_types - events - fees - file_types - financial_accounts - floor_plans - integration_configuration_meta_data - invoice_items - invoices - lead_pets - lead_relationships - lead_sources - leads - leads_to_events - leads_to_rentable_items - lease_services - lease_transfers - leases - listings - locations - note_categories - owners - owners_to_properties - payable_register_items - payable_registers - pet_types - properties - property_lists - property_lists_to_properties - property_office_hours - purchase_order_items - purchase_order_items_to_invoices - purchase_orders - recurring_resident_charges - rentable_items - rentvine_application_templates - resident_allocations - resident_charges - resident_insurance - resident_payments - resident_pets - resident_vehicles - residents - residents_to_events - residents_to_leases - residents_to_rentable_items - screenings - service_request_access_contacts - service_request_categories - service_request_locations - service_request_notes - service_request_priorities - service_request_problems - service_request_statuses - service_request_vendor_categories - service_request_vendor_contacts - service_request_vendors - service_request_vendors_insurance - service_request_vendors_to_properties - service_requests - service_requests_to_employees - service_requests_to_vendors - timezones - transactions - unit_details - unit_pricing - units - units_to_amenity - vendor_insurance_coverage_types - vendor_insurance_policy_types - vendor_payment_types description: The model for the webhook trigger to monitor. Only applies to DATA_UPDATE and DATA_NEW triggers required: - url - triggers _v1_webhooks__post_output: type: object properties: result: type: object properties: id: type: string description: The unique identifier for the webhook created_at: type: string description: The date the webhook was created updated_at: type: string description: The date the webhook was last updated url: type: string description: The url to send the webhook to headers: type: - array - "null" items: type: object properties: header: type: string value: type: string required: - header - value active: type: boolean description: The status of the webhook secret: type: string description: The secret used to sign the webhook system: type: string enum: - PRODUCTION - SANDBOX description: The environment in which the webhook runs triggers: type: array items: type: object properties: id: type: string description: The ID of the trigger trigger: type: string description: The name of the trigger model: type: - string - "null" description: The model that triggers the webhook required: - id - trigger - model required: - id - created_at - updated_at - url - headers - active - secret - system required: - result _v1_webhooks_{webhook_id}_get_input: type: object properties: order-by: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" offset: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results limit: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query _v1_webhooks_{webhook_id}_get_output: type: object properties: meta: $ref: "#/components/schemas/ResponseMeta" results: type: object properties: id: type: string description: The unique identifier for the webhook created_at: type: string description: The date the webhook was created updated_at: type: string description: The date the webhook was last updated url: type: string description: The url to send the webhook to headers: type: array items: type: object properties: header: type: string value: type: string required: - header - value active: type: boolean description: The status of the webhook secret: type: string description: The secret used to sign the webhook system: type: string enum: *a282 description: The environment in which the webhook runs triggers: type: array items: type: object properties: id: type: string description: The ID of the trigger trigger: type: string description: The name of the trigger model: type: - string - "null" description: The model that triggers the webhook required: - id - trigger - model required: - id - created_at - updated_at - url - active - secret - system required: - meta - results _v1_webhooks_{webhook_id}_put_input: type: object properties: url: type: string format: uri description: The url to send the webhook to headers: type: array items: type: object properties: header: type: string value: type: string required: - header - value description: Optional headers to send with the webhook active: type: boolean description: Whether the webhook is active secret: type: string minLength: 10 description: The secret to use to sign the webhook payload. triggers: type: array items: type: string enum: - DATA_UPDATE - DATA_NEW - JOB_FAILURE - JOB_SUCCESS - SYNC_COMPLETE - FIRST_SYNC_COMPLETE - WRITE_OPERATION_FAILURE minItems: 1 description: The events that will trigger the webhook model: type: string enum: - accounting_entities - address_types - amenities - ap_codes - ap_codes_to_construction_job - applicant_pets - applicants - applicants_to_applications - applicants_to_events - applicants_to_rentable_items - application_statuses - applications - call_logs - charge_code_types - charge_code_types_to_charge_timings - charge_codes - charge_timings - concessions - construction_job_details - construction_jobs - contract_details - contracts - crm_agents - crm_amenities - crm_attributions - crm_communities - crm_communities_to_agents - crm_communities_to_attributions - crm_events - crm_listings - crm_pet_policies - crm_prospects - deposit_summaries - deposits - employees - entrata_lease_periods - entrata_unit_types - entrata_vendor_locations - event_results - event_results_to_event_types - event_sub_types - event_types - events - fees - file_types - financial_accounts - floor_plans - integration_configuration_meta_data - invoice_items - invoices - lead_pets - lead_relationships - lead_sources - leads - leads_to_events - leads_to_rentable_items - lease_services - lease_transfers - leases - listings - locations - note_categories - owners - owners_to_properties - payable_register_items - payable_registers - pet_types - properties - property_lists - property_lists_to_properties - property_office_hours - purchase_order_items - purchase_order_items_to_invoices - purchase_orders - recurring_resident_charges - rentable_items - rentvine_application_templates - resident_allocations - resident_charges - resident_insurance - resident_payments - resident_pets - resident_vehicles - residents - residents_to_events - residents_to_leases - residents_to_rentable_items - screenings - service_request_access_contacts - service_request_categories - service_request_locations - service_request_notes - service_request_priorities - service_request_problems - service_request_statuses - service_request_vendor_categories - service_request_vendor_contacts - service_request_vendors - service_request_vendors_insurance - service_request_vendors_to_properties - service_requests - service_requests_to_employees - service_requests_to_vendors - timezones - transactions - unit_details - unit_pricing - units - units_to_amenity - vendor_insurance_coverage_types - vendor_insurance_policy_types - vendor_payment_types description: The model for the webhook trigger to monitor. Only applies to DATA_UPDATE and DATA_NEW triggers _v1_webhooks_{webhook_id}_put_output: type: object properties: result: type: object properties: id: type: string description: The unique identifier for the webhook created_at: type: string description: The date the webhook was created updated_at: type: string description: The date the webhook was last updated url: type: string description: The url to send the webhook to headers: type: - array - "null" items: type: object properties: header: type: string value: type: string required: - header - value active: type: boolean description: The status of the webhook secret: type: string description: The secret used to sign the webhook system: type: string enum: - PRODUCTION - SANDBOX description: The environment in which the webhook runs triggers: type: array items: type: object properties: id: type: string description: The ID of the trigger trigger: type: string description: The name of the trigger model: type: - string - "null" description: The model that triggers the webhook required: - id - trigger - model required: - id - created_at - updated_at - url - headers - active - secret - system required: - result _v1_webhooks_{webhook_id}_delete_input: type: object properties: {} _v1_webhooks_{webhook_id}_delete_output: type: object properties: result: type: object properties: id: type: string description: The ID of the webhook that was deleted required: - id required: - result OfficeHours: type: array items: type: object properties: day_of_week: type: string enum: - SUNDAY - MONDAY - TUESDAY - WEDNESDAY - THURSDAY - FRIDAY - SATURDAY description: The day of the week associated with the office hours open_time: type: string description: The opening time for the office close_time: type: string description: The closing time for the office required: - day_of_week - open_time - close_time description: The office hours of the property x-propexo: derivedFromModel: property_office_hours parameters: {} paths: /v1/admin/data-diffs/: get: description: Get all data diffs. Data diffs are stored for 30 days. summary: Get all data diffs tags: - admin security: - bearerAuth: [] parameters: - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query - schema: type: string enum: *a283 description: The integration vendor associated with the data diff required: false description: The integration vendor associated with the data diff name: integration_vendor in: query - schema: type: string description: The integration id associated with the data diff required: false description: The integration id associated with the data diff name: integration_id in: query - schema: type: - string - "null" description: Only show data diffs before this timestamp required: false description: Only show data diffs before this timestamp name: before in: query - schema: type: - string - "null" description: Only show data diffs after this timestamp required: false description: Only show data diffs after this timestamp name: after in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_admin_data-diffs__get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/admin/job-logs/{job_log_id}/: get: description: Get a single log record by log ID. A log will only have a single associated job. This is different than querying by job ID, which could have multiple log entries (in the case of retry attempts for failed jobs). summary: Get log by ID tags: - admin security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: job_log_id in: path - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_admin_job-logs_{job_log_id}__get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/admin/job-logs/{job_log_id}/data: get: description: |- Get a link to the job log raw request and response data of a write job. Only POST and PUT job payloads can be viewed. This endpoint will return a 302 status code with a `Location` header that can be followed to download the raw request and response data. Some HTTP clients (including some older versions of cURL) will carry the `Authentication` header when the redirect is followed. This will cause an error conflicting with the authentication in the presigned URL being returned by this endpoint. If you see this error, you will need to make sure your HTTP client isn't passing `Authentication` headers on redirect. If you're using cURL, use the `-L` flag. For other HTTP client, consult their documentation. summary: Get a link to the job log raw request and response data of a write job. tags: - admin security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the job log. required: true description: The ID of the job log. name: job_log_id in: path responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_admin_job-logs_{job_log_id}_data_get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/admin/logs/writes/: get: description: Query write job logs with various filters. Returns the most recent record for each job_id. summary: Query write job logs tags: - admin security: - bearerAuth: [] parameters: - schema: type: integer minimum: 1 maximum: 100 default: 100 description: Number of records to return required: false description: Number of records to return name: limit in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Number of records to skip required: false description: Number of records to skip name: offset in: query - schema: type: string enum: *a284 description: Filter logs by time range required: false description: Filter logs by time range name: time_range in: query - schema: type: string description: Filter logs by integration ID required: false description: Filter logs by integration ID name: integration_id in: query - schema: type: string enum: - SUCCESS - FAILURE description: Filter logs by status required: false description: Filter logs by status name: status in: query - schema: type: string enum: *a285 description: Filter logs by write category required: false description: Filter logs by write category name: write_category in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_admin_logs_writes__get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/admin/logs/jobs/: get: description: Get all logs summary: Get logs tags: - admin security: - bearerAuth: [] parameters: - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query - schema: type: string enum: - SUCCESS - FAILURE required: false name: status in: query - schema: type: string required: false name: integration_id in: query - schema: type: string required: false name: job_type in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_admin_logs_jobs__get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/admin/logs/jobs/{id}: get: description: Get all logs for a job ID. This returns an array because jobs can have multiple log entries (for example, in the case of retries on failed jobs) summary: Get logs by job ID tags: - admin security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: id in: path - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query - schema: type: string default: "true" description: Whether to include job logs from jobs that have spawned from the provided job id. required: false description: Whether to include job logs from jobs that have spawned from the provided job id. name: include_all_jobs in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_admin_logs_jobs_{id}_get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/admin/integrations/: get: description: Get all my integrations summary: Get all my integrations tags: - admin security: - bearerAuth: [] parameters: - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query - schema: type: string enum: *a286 description: The integration vendor required: false description: The integration vendor name: integration_vendor in: query - schema: type: boolean description: Whether or not to include archived integrations required: false description: Whether or not to include archived integrations name: is_archived in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_admin_integrations__get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" post: description: Create an integration summary: Create an integration tags: - admin security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_admin_integrations__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_admin_integrations__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/admin/users/: get: description: Get all my users summary: Get all my users tags: - admin security: - bearerAuth: [] parameters: - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query - schema: type: string description: The unique identifier for the user required: false description: The unique identifier for the user name: id in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_admin_users__get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/admin/users/{id}: get: description: Get user by id summary: Get user by id tags: - admin security: - bearerAuth: [] parameters: - schema: type: string description: The unique identifier for the user required: true description: The unique identifier for the user name: id in: path - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_admin_users_{id}_get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/admin/write-status/{root_job_id}: get: description: Query for the status of a write operation created via the API. The status of the write operation, as well as any encountered errors, is provided. summary: Check the status of a write operation tags: - admin security: - bearerAuth: [] parameters: - schema: type: string description: The job ID of the write job to check the status of required: true description: The job ID of the write job to check the status of name: root_job_id in: path responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_admin_write-status_{root_job_id}_get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/admin/retry-write/{root_job_id}: post: description: Retry a write operation that failed. Only failed write operations can be retried. summary: Retry a write operation tags: - admin security: - bearerAuth: [] parameters: - schema: type: string description: The job ID of the write job retry required: true description: The job ID of the write job retry name: root_job_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_admin_retry-write_{root_job_id}_post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_admin_retry-write_{root_job_id}_post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/admin/integrations/{integration_id}/: get: description: Get integration by id summary: Get integration by id tags: - admin security: - bearerAuth: [] parameters: - schema: type: string description: The integration id required: true description: The integration id name: integration_id in: path - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_admin_integrations_{integration_id}__get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" put: description: Update an integration summary: Update an integration tags: - admin security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: integration_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_admin_integrations_{integration_id}__put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_admin_integrations_{integration_id}__put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" delete: description: Delete an integration summary: Delete an integration tags: - admin security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the integration required: true description: The Propexo unique identifier for the integration name: integration_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_admin_integrations_{integration_id}__delete_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_admin_integrations_{integration_id}__delete_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/admin/integrations/{integration_id}/back-sync: post: description: A backsync operation retrieves historical baseline data for an integration. When executed, the system extends all date ranges for enabled models to January 1, 1970. This operation should be performed only once per integration. Repeated backsync operations will result in significant billing charges to your account. summary: Trigger a backsync on an integration. tags: - admin security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: integration_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_admin_integrations_{integration_id}_back-sync_post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_admin_integrations_{integration_id}_back-sync_post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/admin/integrations/{integration_id}/manual-sync: post: description: A manual sync operation overrides the configured sync schedule for an integration. This operation is typically used during testing phases but may be executed at any time as needed. However, frequent use of manual syncs is not recommended. For questions regarding sync operations, contact Propexo Support. summary: Trigger a manual sync on an integration. tags: - admin security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: integration_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_admin_integrations_{integration_id}_manual-sync_post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_admin_integrations_{integration_id}_manual-sync_post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/admin/integrations/{integration_id}/data-access: post: description: Trigger a data access check on an integration. This will reassess access to various data models. Using this can result in different detected access and can affect the data that is pulled in each sync and pushed during write operations. Only one data access check can be running at a time. summary: Trigger a data access check on an integration. tags: - admin security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the integration required: true description: The Propexo unique identifier for the integration name: integration_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_admin_integrations_{integration_id}_data-access_post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_admin_integrations_{integration_id}_data-access_post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" get: description: Get data access information for an integration. summary: Get data access information for an integration. tags: - admin security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the integration required: true description: The Propexo unique identifier for the integration name: integration_id in: path responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_admin_integrations_{integration_id}_data-access_get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/admin/integrations/{integration_id}/properties: get: description: Get all my property configurations summary: Get all my property configurations tags: - admin security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: integration_id in: path - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_admin_integrations_{integration_id}_properties_get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/admin/integrations/{integration_id}/property-lists: get: description: Get all my property list configurations summary: Get all my property list configurations tags: - admin security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: integration_id in: path - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_admin_integrations_{integration_id}_property-lists_get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" post: description: Create a property list configuration summary: Create a property list configuration tags: - admin security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the integration required: true description: The Propexo unique identifier for the integration name: integration_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_admin_integrations_{integration_id}_property-lists_post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_admin_integrations_{integration_id}_property-lists_post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/admin/integrations/{integration_id}/job-schedules/: get: description: Get job schedules by integration id summary: Get job schedules by integration id tags: - admin security: - bearerAuth: [] parameters: - schema: type: string description: The unique identifier for the integration required: true description: The unique identifier for the integration name: integration_id in: path - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_admin_integrations_{integration_id}_job-schedules__get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/admin/normalization/{model}/{field}: get: description: |- Retrieves the custom enum mappings that normalize PMS-specific enum values to standardized Propexo values. These mappings can be user-customized per integration or use default system mappings. Custom enum fields in the API schema are identified by types beginning with "enum." (e.g., enum.lease_status, enum.applicant_status). Valid model/field combinations: - leases/status → Maps PMS-specific lease status values to normalized lease statuses. Used by the leases.status field. Custom enum type in schema: enum.lease_status Possible normalized values: ACTIVE, INACTIVE, OTHER, PENDING, EVICTED - residents/type → Maps PMS-specific resident type values to normalized resident types. Used by the residents.type field. Custom enum type in schema: enum.resident_type Possible normalized values: PRIMARY, SECONDARY, GUARANTOR, OTHER - billing/payment-method → Maps PMS-specific payment method values to normalized payment methods. Used by the billing.payment-method field (which corresponds to payment_method on transaction records). Custom enum type in schema: enum.transaction_payment_method Possible normalized values: CASH, CASHIERCHECK, CHECK, CREDITCARD, MONEYORDER, DIRECTDEPOSIT, ELECTRONICPAYMENT, OTHER - properties/type → Maps PMS-specific property type values to normalized property types. Used by the properties.type field. Custom enum type in schema: enum.property_type Possible normalized values: SINGLE_FAMILY, MULTI_FAMILY, STUDENT_HOUSING, VACATION, COMMERCIAL, OTHER - applicants/status → Maps PMS-specific applicant status values to normalized applicant statuses. Used by the applicants.status field. Custom enum type in schema: enum.applicant_status Possible normalized values: APPROVED, DENIED, CANCELED, OTHER, PENDING - applicants/type → Maps PMS-specific applicant type values to normalized applicant types. Used by the applicants.type field. Custom enum type in schema: enum.applicant_type Possible normalized values: GUARANTOR, OTHER, PRIMARY, SECONDARY Custom enum mappings allow user-configurable normalization of PMS-specific enum values to standardized Propexo values. You can identify custom enum fields in the schema by looking for types that begin with "enum." prefix (e.g., enum.lease_status, enum.applicant_status). summary: Get custom enum mappings for normalizing PMS-specific field values tags: - admin security: - bearerAuth: [] parameters: - schema: type: string description: "The model name (route parameter). Must be one of: leases, residents, billing, properties, or applicants. See the endpoint description for valid model/field combinations." required: true description: "The model name (route parameter). Must be one of: leases, residents, billing, properties, or applicants. See the endpoint description for valid model/field combinations." name: model in: path - schema: type: string description: "The field name within the model (route parameter). Valid fields depend on the model. For example: leases.status, applicants.status, applicants.type, residents.type, properties.type, billing.payment-method. See the endpoint description for all valid model/field combinations." required: true description: "The field name within the model (route parameter). Valid fields depend on the model. For example: leases.status, applicants.status, applicants.type, residents.type, properties.type, billing.payment-method. See the endpoint description for all valid model/field combinations." name: field in: path - schema: type: string description: The ID of the integration for which to retrieve custom mappings. If provided, returns integration-specific custom mappings (if they exist). If omitted, returns the default system mappings for the vendor. required: false description: The ID of the integration for which to retrieve custom mappings. If provided, returns integration-specific custom mappings (if they exist). If omitted, returns the default system mappings for the vendor. name: integration_id in: query - schema: $ref: "#/components/schemas/Enum10" required: true description: "" name: integration_vendor in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_admin_normalization_{model}_{field}_get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/admin/integrations/{integration_id}/properties/batch: put: description: Updates the enabled flag for many property configuration records for an integration. This is a batch form of updating a single property configuration. summary: Bulk enable or disable property configurations tags: - admin security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the integration required: true description: The Propexo unique identifier for the integration name: integration_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_admin_integrations_{integration_id}_properties_batch_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_admin_integrations_{integration_id}_properties_batch_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/admin/integrations/{integration_id}/properties/{property_configuration_id}: put: description: Update a property configuration summary: Update a property configuration tags: - admin security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the integration required: true description: The Propexo unique identifier for the integration name: integration_id in: path - schema: type: string description: The ID of the property configuration record. required: true description: The ID of the property configuration record. name: property_configuration_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_admin_integrations_{integration_id}_properties_{property_configuration_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_admin_integrations_{integration_id}_properties_{property_configuration_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/admin/integrations/{integration_id}/property-lists/{property_list_configuration_id}: put: description: Update a property list configuration summary: Update a property list configuration tags: - admin security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the integration required: true description: The Propexo unique identifier for the integration name: integration_id in: path - schema: type: string description: The ID of the property list configuration record. required: true description: The ID of the property list configuration record. name: property_list_configuration_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_admin_integrations_{integration_id}_property-lists_{property_list_configuration_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_admin_integrations_{integration_id}_property-lists_{property_list_configuration_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/admin/integrations/{integration_id}/rate-limits/: get: description: The current PMS rate limits associated with your integration. Currently only supported for Rent Manager and Entrata summary: The current PMS rate limits associated with your integration. tags: - admin security: - bearerAuth: [] parameters: - schema: type: string description: The unique identifier for the integration required: true description: The unique identifier for the integration name: integration_id in: path - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_admin_integrations_{integration_id}_rate-limits__get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/admin/integrations/{integration_id}/job-schedules/{job_schedule_id}/: get: description: Get job schedule by id summary: Get job schedule by id tags: - admin security: - bearerAuth: [] parameters: - schema: type: string description: The unique identifier for the integration required: true description: The unique identifier for the integration name: integration_id in: path - schema: type: string description: The unique identifier for the job schedule required: true description: The unique identifier for the job schedule name: job_schedule_id in: path - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_admin_integrations_{integration_id}_job-schedules_{job_schedule_id}__get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/amenities/: get: description: Get all amenities. summary: Get all amenities tags: - amenities security: - bearerAuth: [] parameters: - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query - schema: type: string description: The external ID from the integration vendor required: false description: The external ID from the integration vendor name: x_id in: query - schema: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. required: false description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: location_id in: query - schema: type: string description: The Propexo unique identifier for the property required: false description: The Propexo unique identifier for the property name: property_id in: query - schema: type: string description: The Propexo unique identifier for the integration required: false description: The Propexo unique identifier for the integration name: integration_id in: query - schema: type: string enum: *a287 description: The property management system of record required: false description: The property management system of record name: integration_vendor in: query - schema: type: string description: The Propexo unique identifier for the unit required: false description: The Propexo unique identifier for the unit name: unit_id in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_amenities__get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" post: description: Create an amenity for an integration. summary: Create amenity tags: - amenities security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_amenities__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_amenities__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/amenities/{amenity_id}: put: description: Update an amenity for an integration. summary: Update amenity tags: - amenities security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: amenity_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_amenities_{amenity_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_amenities_{amenity_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" get: description: Get an amenity by ID summary: Get an amenity by ID tags: - amenities security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: amenity_id in: path - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_amenities_{amenity_id}_get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/amenities/units/{id}: post: description: Create a unit amenity for any integration. This is a convenience endpoint that acts as a generic proxy for all amenity creation endpoints. summary: Create Amenities | Units tags: - amenities security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_amenities_units_{id}_post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_amenities_units_{id}_post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" put: description: Update unit amenities for any integration. This is a convenience endpoint that acts as a generic proxy for all amenity creation endpoints. summary: Update amenities for unit tags: - amenities security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_amenities_units_{id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_amenities_units_{id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/amenities/properties/{id}: post: description: Create a property amenity for any integration. This is a convenience endpoint that acts as a generic proxy for all amenity creation endpoints. summary: Create amenity for property tags: - amenities security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_amenities_properties_{id}_post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_amenities_properties_{id}_post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" put: description: Update property amenities for any integration. This is a convenience endpoint that acts as a generic proxy for all amenity creation endpoints. summary: Update amenities for property tags: - amenities security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_amenities_properties_{id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_amenities_properties_{id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/amenities/buildium/: post: description: Buildium does not support creating an amenity via their API. This endpoint will always return a 405, with an error message specifying that creating an amenity in a Buildium integration is not supported due to the lack of upstream support. summary: "Create Amenity: Buildium - Not Supported" tags: - amenities security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_amenities_buildium__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_amenities_buildium__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/amenities/entrata/: post: description: |- Create Amenity: Entrata This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately. summary: "Create Amenity: Entrata" tags: - amenities security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_amenities_entrata__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_amenities_entrata__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/amenities/entrata/{amenity_id}: put: description: "Update Amenity: Entrata" summary: "Update Amenity: Entrata" tags: - amenities security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the amenity required: true description: The Propexo unique identifier for the amenity name: amenity_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_amenities_entrata_{amenity_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_amenities_entrata_{amenity_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/amenities/propertyware/: post: description: Propertyware SOAP does not support creating an amenity via their API. This endpoint will always return a 405, with an error message specifying that creating an amenity in a Propertyware SOAP integration is not supported due to the lack of upstream support. summary: "Create Amenity: Propertyware SOAP - Not Supported" tags: - amenities security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_amenities_propertyware__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_amenities_propertyware__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/amenities/propertyware/{amenity_id}: put: description: Propertyware SOAP does not support updating an amenity via their API. This endpoint will always return a 405, with an error message specifying that updating an amenity in a Propertyware SOAP integration is not supported due to the lack of upstream support. summary: "Update Amenity: Propertyware SOAP - Not Supported" tags: - amenities security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: amenity_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_amenities_propertyware_{amenity_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_amenities_propertyware_{amenity_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/amenities/rentvine/: post: description: Rentvine does not support creating an amenity via their API. This endpoint will always return a 405, with an error message specifying that creating an amenity in a Rentvine integration is not supported due to the lack of upstream support. summary: "Create Amenity: Rentvine - Not Supported" tags: - amenities security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_amenities_rentvine__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_amenities_rentvine__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/amenities/rentvine/{id}: put: description: Rentvine does not support updating an amenity via their API. This endpoint will always return a 405, with an error message specifying that updating an amenity in a Rentvine integration is not supported due to the lack of upstream support. summary: "Update Amenity: Rentvine - Not Supported" tags: - amenities security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_amenities_rentvine_{id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_amenities_rentvine_{id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/amenities/rentmanager/{id}: put: description: Rent Manager does not support updating an amenity via their API. This endpoint will always return a 405, with an error message specifying that updating an amenity in a Rent Manager integration is not supported due to the lack of upstream support. summary: "Update Amenity: Rent Manager - Not Supported" tags: - amenities security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_amenities_rentmanager_{id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_amenities_rentmanager_{id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/amenities/realpage/: post: description: Realpage does not support creating an amenity via their API. This endpoint will always return a 405, with an error message specifying that creating an amenity in a Realpage integration is not supported due to the lack of upstream support. summary: "Create Amenity: Realpage - Not Supported" tags: - amenities security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_amenities_realpage__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_amenities_realpage__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/amenities/realpage/{id}: put: description: Realpage does not support updating an amenity via their API. This endpoint will always return a 405, with an error message specifying that updating an amenity in a Realpage integration is not supported due to the lack of upstream support. summary: "Update Amenity: Realpage - Not Supported" tags: - amenities security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_amenities_realpage_{id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_amenities_realpage_{id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/amenities/realpage_rpx/: post: description: RealPageApp does not support creating an amenity via their API. This endpoint will always return a 405, with an error message specifying that creating an amenity in a RealPageApp integration is not supported due to the lack of upstream support. summary: "Create Amenity: RealPageApp - Not Supported" tags: - amenities security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_amenities_realpage_rpx__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_amenities_realpage_rpx__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/amenities/realpage_rpx/{amenity_id}: put: description: RealPageApp does not support updating an amenity via their API. This endpoint will always return a 405, with an error message specifying that updating an amenity in a RealPageApp integration is not supported due to the lack of upstream support. summary: "Update Amenity: RealPageApp - Not Supported" tags: - amenities security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: amenity_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_amenities_realpage_rpx_{amenity_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_amenities_realpage_rpx_{amenity_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/amenities/yardi/{id}: put: description: Yardi does not support updating an amenity via their API. This endpoint will always return a 405, with an error message specifying that updating an amenity in a Yardi integration is not supported due to the lack of upstream support. summary: "Update Amenity: Yardi - Not Supported" tags: - amenities security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_amenities_yardi_{id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_amenities_yardi_{id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/amenities/yardi/: post: description: Yardi does not support creating an amenity via their API. This endpoint will always return a 405, with an error message specifying that creating an amenity in a Yardi integration is not supported due to the lack of upstream support. summary: "Create Amenity: Yardi - Not Supported" tags: - amenities security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_amenities_yardi__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_amenities_yardi__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/amenities/buildium/properties/{id}: put: description: "Update Property Amenities: Buildium" summary: "Update Property Amenities: Buildium" tags: - amenities security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the property required: true description: The Propexo unique identifier for the property name: id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_amenities_buildium_properties_{id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_amenities_buildium_properties_{id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/amenities/buildium/units/{id}: put: description: "Update Unit Amenities: Buildium" summary: "Update Unit Amenities: Buildium" tags: - amenities security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the unit required: true description: The Propexo unique identifier for the unit name: id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_amenities_buildium_units_{id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_amenities_buildium_units_{id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/amenities/rentmanager/properties/: post: description: |- Create Property Amenity: Rent Manager This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately. summary: "Create Property Amenity: Rent Manager" tags: - amenities security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_amenities_rentmanager_properties__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_amenities_rentmanager_properties__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/amenities/rentmanager/units/: post: description: |- Create Unit Amenity: Rent Manager This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately. summary: "Create Unit Amenity: Rent Manager" tags: - amenities security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_amenities_rentmanager_units__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_amenities_rentmanager_units__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/applicants/: get: description: Get all applicants summary: Get all applicants tags: - applicants security: - bearerAuth: [] parameters: - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query - schema: type: string description: The external ID from the integration vendor required: false description: The external ID from the integration vendor name: x_id in: query - schema: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. required: false description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: location_id in: query - schema: type: string description: The Propexo unique identifier for the property required: false description: The Propexo unique identifier for the property name: property_id in: query - schema: type: string description: The Propexo unique identifier for the integration required: false description: The Propexo unique identifier for the integration name: integration_id in: query - schema: type: string enum: *a287 description: The property management system of record required: false description: The property management system of record name: integration_vendor in: query - schema: type: string description: The primary email address associated with the applicant required: false description: The primary email address associated with the applicant name: email_1 in: query - schema: type: string pattern: ^[2-9]\d{9}$ description: Filter by phone number (10 digit format only) required: false description: Filter by phone number (10 digit format only) name: phone_1 in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_applicants__get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" post: description: Create an applicant for an integration. summary: Create applicant tags: - applicants security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_applicants__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_applicants__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/applicants/{id}: get: description: Get an applicant by ID summary: Get an applicant by ID tags: - applicants security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: id in: path - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_applicants_{id}_get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" put: description: Update an applicant for an integration. summary: Update applicant tags: - applicants security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_applicants_{id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_applicants_{id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/applicants/{id}/rentable-items: get: description: Get all rentable items associated with a specific applicant summary: Get rentable items for an applicant tags: - applicants security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: id in: path - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query - schema: type: string description: The external ID from the integration vendor required: false description: The external ID from the integration vendor name: x_id in: query - schema: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. required: false description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: location_id in: query - schema: type: string description: The Propexo unique identifier for the property required: false description: The Propexo unique identifier for the property name: property_id in: query - schema: type: string description: The Propexo unique identifier for the integration required: false description: The Propexo unique identifier for the integration name: integration_id in: query - schema: type: string enum: *a287 description: The property management system of record required: false description: The property management system of record name: integration_vendor in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_applicants_{id}_rentable-items_get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/applicants/buildium/: post: description: |- Create Applicant: Buildium This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately. summary: "Create Applicant: Buildium" tags: - applicants security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_applicants_buildium__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_applicants_buildium__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/applicants/buildium/{id}: put: description: "Update Applicant: Buildium" summary: "Update Applicant: Buildium" tags: - applicants security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the applicant required: true description: The Propexo unique identifier for the applicant name: id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_applicants_buildium_{id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_applicants_buildium_{id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/applicants/entrata/: post: description: |- Create Applicant: Entrata Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Applicant: Entrata" tags: - applicants security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_applicants_entrata__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_applicants_entrata__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/applicants/entrata/{applicant_id}: put: description: "Update Applicant: Entrata" summary: "Update Applicant: Entrata" tags: - applicants security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the applicant required: true description: The Propexo unique identifier for the applicant name: applicant_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_applicants_entrata_{applicant_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_applicants_entrata_{applicant_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/applicants/mri/: post: description: |- Create an applicant in MRI. This will create a prospect record in MRI with the applicant type. This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately. summary: "Create Applicant: MRI" tags: - applicants security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_applicants_mri__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_applicants_mri__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/applicants/mri/{applicant_id}: put: description: "Update Applicant: MRI" summary: "Update Applicant: MRI" tags: - applicants security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the applicant required: true description: The Propexo unique identifier for the applicant name: applicant_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_applicants_mri_{applicant_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_applicants_mri_{applicant_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/applicants/rentmanager/: post: description: |- Create Applicant: Rent Manager This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately. summary: "Create Applicant: Rent Manager" tags: - applicants security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_applicants_rentmanager__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_applicants_rentmanager__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/applicants/rentmanager/{applicant_id}: put: description: "Update Applicant: Rent Manager" summary: "Update Applicant: Rent Manager" tags: - applicants security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: applicant_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_applicants_rentmanager_{applicant_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_applicants_rentmanager_{applicant_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/applicants/propertyware/: post: description: |- Create Applicant: Propertyware This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately. summary: "Create Applicant: Propertyware" tags: - applicants security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_applicants_propertyware__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_applicants_propertyware__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/applicants/propertyware/{applicant_id}: put: description: "Update Applicant: Propertyware" summary: "Update Applicant: Propertyware" tags: - applicants security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: applicant_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_applicants_propertyware_{applicant_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_applicants_propertyware_{applicant_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/applicants/realpage/{id}: put: description: "Update Applicant: RealPage" summary: "Update Applicant: RealPage" tags: - applicants security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the applicant required: true description: The Propexo unique identifier for the applicant name: id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_applicants_realpage_{id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_applicants_realpage_{id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/applicants/yardi/: post: description: |- Create Applicant: Yardi. When creating an applicant along with an event, Propexo will create a base event of type "Other" as an initial applicant event. If the event is one of the valid "first contact" events in Yardi (such as Other,WalkIn,Chat,Email,Text,Webservice), then Propexo will create the applicant with the associated "first contact" event type. This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately. summary: "Create Applicant: Yardi" tags: - applicants security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_applicants_yardi__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_applicants_yardi__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/applicants/yardi/{applicant_id}: put: description: "Update Applicant: Yardi" summary: "Update Applicant: Yardi" tags: - applicants security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the applicant required: true description: The Propexo unique identifier for the applicant name: applicant_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_applicants_yardi_{applicant_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_applicants_yardi_{applicant_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/applicants/rentvine/: post: description: |- Create Applicant: Rentvine This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately. summary: "Create Applicant: Rentvine" tags: - applicants security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_applicants_rentvine__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_applicants_rentvine__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/applicants/rentvine/{applicant_id}: put: description: "Update Applicant: Rentvine" summary: "Update Applicant: Rentvine" tags: - applicants security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: applicant_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_applicants_rentvine_{applicant_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_applicants_rentvine_{applicant_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/applicants/resman/: post: description: |- Create Applicant: ResMan. When specifying a unit_id, the unit must be available. To check if a unit is available, you can compare it to the listing object with the same property and unit_number. This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately. summary: "Create Applicant: ResMan" tags: - applicants security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_applicants_resman__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_applicants_resman__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/applicants/resman/{applicant_id}: put: description: "Update Applicant: ResMan" summary: "Update Applicant: ResMan" tags: - applicants security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the applicant required: true description: The Propexo unique identifier for the applicant name: applicant_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_applicants_resman_{applicant_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_applicants_resman_{applicant_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/rentable-items/applicants/assign: post: description: Assign a rentable item for an applicant summary: Assign a rentable item for an applicant tags: - applicants security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_rentable-items_applicants_assign_post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_rentable-items_applicants_assign_post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/applicants/entrata/{applicant_id}/file-upload: post: description: |- Create Applicant Files: Entrata Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Applicant Files: Entrata" tags: - applicants security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the applicant required: true description: The Propexo unique identifier for the applicant name: applicant_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_applicants_entrata_{applicant_id}_file-upload_post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_applicants_entrata_{applicant_id}_file-upload_post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/applicants/yardi/{applicant_id}/file-upload: post: description: |- Attach a file to an Applicant. Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Applicant File: Yardi" tags: - applicants security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the applicant required: true description: The Propexo unique identifier for the applicant name: applicant_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_applicants_yardi_{applicant_id}_file-upload_post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_applicants_yardi_{applicant_id}_file-upload_post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/applicants/rentvine/{applicant_id}/file-upload: post: description: |- Create Applicant File: Rentvine Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Applicant File: Rentvine" tags: - applicants security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the applicant required: true description: The Propexo unique identifier for the applicant name: applicant_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_applicants_rentvine_{applicant_id}_file-upload_post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_applicants_rentvine_{applicant_id}_file-upload_post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/applicants/resman/{applicant_id}/file-upload: post: description: |- Create Applicant Files: ResMan Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Applicant Files: ResMan" tags: - applicants security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the applicant required: true description: The Propexo unique identifier for the applicant name: applicant_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_applicants_resman_{applicant_id}_file-upload_post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_applicants_resman_{applicant_id}_file-upload_post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/rentable-items/applicants/assign/yardi: post: description: |- Assign Applicant Rentable Item: Yardi Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Assign Applicant Rentable Item: Yardi" tags: - applicants security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_rentable-items_applicants_assign_yardi_post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_rentable-items_applicants_assign_yardi_post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/applications/: get: description: Get all applications summary: Get all applications tags: - applications security: - bearerAuth: [] parameters: - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query - schema: type: string description: The external applicant id required: false description: The external applicant id name: x_id in: query - schema: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. required: false description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: location_id in: query - schema: type: string description: The Propexo property id required: false description: The Propexo property id name: property_id in: query - schema: type: string description: The Propexo integration id required: false description: The Propexo integration id name: integration_id in: query - schema: type: string enum: *a288 description: The integration vendor for the applicant. required: false description: The integration vendor for the applicant. name: integration_vendor in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_applications__get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" post: description: Create an Application for an integration. summary: Create Application tags: - applications security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_applications__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_applications__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/applications/{id}: get: description: Get an application by ID summary: Get an application by ID tags: - applications security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: id in: path - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_applications_{id}_get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" put: description: Update an Application for an Integration. summary: Update Application tags: - applications security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the application required: true description: The Propexo unique identifier for the application name: id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_applications_{id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_applications_{id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/application-statuses/: get: description: Get all Application Statuses summary: Get all Application Statuses tags: - applications security: - bearerAuth: [] parameters: - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query - schema: type: string description: The Propexo unique identifier for the property required: false description: The Propexo unique identifier for the property name: property_id in: query - schema: type: string description: The Propexo unique identifier for the integration required: false description: The Propexo unique identifier for the integration name: integration_id in: query - schema: type: string enum: *a287 description: The property management system of record required: false description: The property management system of record name: integration_vendor in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_application-statuses__get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/application-statuses/{application_status_id}: get: description: Get an Application Status by ID summary: Get an Application Status by ID tags: - applications security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: application_status_id in: path - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_application-statuses_{application_status_id}_get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/application-templates/: get: description: Get all Application Templates summary: Get all Application Templates tags: - applications security: - bearerAuth: [] parameters: - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query - schema: type: string description: The external ID from the integration vendor required: false description: The external ID from the integration vendor name: x_id in: query - schema: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. required: false description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: location_id in: query - schema: type: string description: The Propexo unique identifier for the property required: false description: The Propexo unique identifier for the property name: property_id in: query - schema: type: string description: The Propexo unique identifier for the integration required: false description: The Propexo unique identifier for the integration name: integration_id in: query - schema: type: string enum: *a287 description: The property management system of record required: false description: The property management system of record name: integration_vendor in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_application-templates__get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/application-templates/{application_template_id}: get: description: Get Application Template by ID summary: Get Application Template by ID tags: - applications security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: application_template_id in: path - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_application-templates_{application_template_id}_get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/applications/yardi/: post: description: |- Create Application: Yardi This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately. summary: "Create Application: Yardi" tags: - applications security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_applications_yardi__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_applications_yardi__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/applications/yardi/{application_id}: put: description: "Update Application: Yardi" summary: "Update Application: Yardi" tags: - applications security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the application required: true description: The Propexo unique identifier for the application name: application_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_applications_yardi_{application_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_applications_yardi_{application_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/applications/rentvine/: post: description: |- Create Application: Rentvine This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately. summary: "Create Application: Rentvine" tags: - applications security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_applications_rentvine__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_applications_rentvine__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/applications/rentvine/{application_id}: put: description: "Update Application: Rentvine" summary: "Update Application: Rentvine" tags: - applications security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: application_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_applications_rentvine_{application_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_applications_rentvine_{application_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/applications/entrata/: post: description: |- Create Application: Entrata Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Application: Entrata" tags: - applications security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_applications_entrata__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_applications_entrata__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/applications/entrata/{application_id}: put: description: "Update Application: Entrata" summary: "Update Application: Entrata" tags: - applications security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the application required: true description: The Propexo unique identifier for the application name: application_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_applications_entrata_{application_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_applications_entrata_{application_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/applications/resman/: post: description: |- Create Application: ResMan. Note: When reading in the newly created application we cannot filter by the application_id, so we must pull in all residents and applicants to save the newly created application.This may result in an increase in the total number of records processed This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately. summary: "Create Application: ResMan" tags: - applications security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_applications_resman__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_applications_resman__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/applications/resman/{application_id}: put: description: "Update Application: ResMan. Note: When reading in the updated application we cannot filter by the application_id, so we must pull in all residents and applicants to save the newly updated application.This may result in an increase in the total number of records processed" summary: "Update Application: ResMan" tags: - applications security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: application_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_applications_resman_{application_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_applications_resman_{application_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/appointments/: get: description: Get all appointments summary: Get all appointments tags: - appointments security: - bearerAuth: [] parameters: - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query - schema: type: string description: The external ID of the event from the integration vendor required: false description: The external ID of the event from the integration vendor name: x_id in: query - schema: type: string description: The external ID of the property from the integration vendor required: false description: The external ID of the property from the integration vendor name: x_property_id in: query - schema: type: string description: The external ID of the type from the integration vendor required: false description: The external ID of the type from the integration vendor name: x_type_id in: query - schema: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. required: false description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: location_id in: query - schema: type: string description: The Propexo unique identifier for the property required: false description: The Propexo unique identifier for the property name: property_id in: query - schema: type: string description: The Propexo unique identifier for the lead required: false description: The Propexo unique identifier for the lead name: lead_id in: query - schema: type: string description: The Propexo unique identifier for the applicant required: false description: The Propexo unique identifier for the applicant name: applicant_id in: query - schema: type: string description: The Propexo unique identifier for the resident required: false description: The Propexo unique identifier for the resident name: resident_id in: query - schema: type: string description: The Propexo unique identifier for the integration required: false description: The Propexo unique identifier for the integration name: integration_id in: query - schema: type: string enum: *a287 description: The property management system of record required: false description: The property management system of record name: integration_vendor in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_appointments__get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/appointment-availability/: post: description: Query Realtime Appointment Availability summary: Query Realtime Appointment Availability tags: - appointments security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_appointment-availability__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_appointment-availability__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/appointment-availability/entrata/: post: description: "Query Realtime Appointment Availability: Entrata" summary: "Query Realtime Appointment Availability: Entrata" tags: - appointments security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_appointment-availability_entrata__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_appointment-availability_entrata__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/appointment-availability/realpage_rpx/: post: description: "Query Realtime Appointment Availability: RealPage Partner Exchange" summary: "Query Realtime Appointment Availability: RealPage Partner Exchange" tags: - appointments security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_appointment-availability_realpage_rpx__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_appointment-availability_realpage_rpx__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/appointment-availability/rentmanager/: post: description: Rent Manager does not support querying an appointment availability via their API. This endpoint will always return a 405, with an error message specifying that querying an appointment availability in a Rent Manager integration is not supported due to the lack of upstream support. summary: "Query Appointment Availability: Rent Manager - Not Supported" tags: - appointments security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_appointment-availability_rentmanager__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_appointment-availability_rentmanager__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/events/appointments/applicants: post: description: Create an appointment for an applicant summary: Create an appointment for an applicant tags: - appointments security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_events_appointments_applicants_post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_events_appointments_applicants_post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/events/appointments/leads: post: description: Create an appointment for a lead summary: Create an appointment for a lead tags: - appointments security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_events_appointments_leads_post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_events_appointments_leads_post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/events/appointments/residents: post: description: Create an appointment for a resident summary: Create an appointment for a resident tags: - appointments security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_events_appointments_residents_post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_events_appointments_residents_post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/events/appointments/applicants/{event_id}: put: description: Update an appointment for an applicant summary: Update an appointment for an applicant tags: - appointments security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the event required: true description: The Propexo unique identifier for the event name: event_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_events_appointments_applicants_{event_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_events_appointments_applicants_{event_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/events/appointments/applicants/cancel: post: description: Cancel an appointment for an applicant summary: Cancel an appointment for an applicant tags: - appointments security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_events_appointments_applicants_cancel_post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_events_appointments_applicants_cancel_post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/events/appointments/leads/{event_id}: put: description: Update an appointment for a lead summary: Update an appointment for a lead tags: - appointments security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the event required: true description: The Propexo unique identifier for the event name: event_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_events_appointments_leads_{event_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_events_appointments_leads_{event_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/events/appointments/leads/cancel: post: description: Cancel an appointment for a lead summary: Cancel an appointment for a lead tags: - appointments security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_events_appointments_leads_cancel_post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_events_appointments_leads_cancel_post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/events/appointments/residents/{event_id}: put: description: Update an appointment for a resident summary: Update an appointment for a resident tags: - appointments security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the event required: true description: The Propexo unique identifier for the event name: event_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_events_appointments_residents_{event_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_events_appointments_residents_{event_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/events/appointments/residents/cancel: post: description: Cancel an appointment for a resident summary: Cancel an appointment for a resident tags: - appointments security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_events_appointments_residents_cancel_post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_events_appointments_residents_cancel_post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/events/appointments/applicants/cancel/yardi: post: description: |- Cancel Applicant Appointment: Yardi Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Cancel Applicant Appointment: Yardi" tags: - appointments security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_events_appointments_applicants_cancel_yardi_post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_events_appointments_applicants_cancel_yardi_post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/events/appointments/applicants/cancel/entrata: post: description: |- These updates will be reflected on the calendar in Entrata, but there's no event for a cancellation that appears in the activity log. Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Cancel Applicant Appointment: Entrata" tags: - appointments security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_events_appointments_applicants_cancel_entrata_post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_events_appointments_applicants_cancel_entrata_post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/events/appointments/applicants/cancel/realpage_rpx: post: description: |- Cancel Applicant Appointment: RealPage Partner Exchange This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately. summary: "Cancel Applicant Appointment: RealPage Partner Exchange" tags: - appointments security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_events_appointments_applicants_cancel_realpage_rpx_post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_events_appointments_applicants_cancel_realpage_rpx_post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/events/appointments/applicants/cancel/rentmanager: post: description: |- Cancel Applicant Appointment: Rent Manager Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Cancel Applicant Appointment: Rent Manager" tags: - appointments security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_events_appointments_applicants_cancel_rentmanager_post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_events_appointments_applicants_cancel_rentmanager_post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/events/appointments/applicants/entrata/: post: description: |- Create an appointment for an applicant in Entrata. Entrata expects all times to be in Mountain Time (UTC-7:00 or UTC-6:00 depending on daylight savings). Times will be automatically converted based on the local time of the property when an end user views the appointment time in the browser. Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Applicant Appointment: Entrata" tags: - appointments security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_events_appointments_applicants_entrata__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_events_appointments_applicants_entrata__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/events/appointments/applicants/entrata/{event_id}: put: description: "Update Applicant Appointment: Entrata" summary: "Update Applicant Appointment: Entrata" tags: - appointments security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: event_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_events_appointments_applicants_entrata_{event_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_events_appointments_applicants_entrata_{event_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/events/appointments/applicants/realpage_rpx/: post: description: |- Create an appointment for an applicant in RealPage Partner Exchange. RealPage interprets the appointment date and time as being local to the timezone of the property the appointment is associated with. Times will not be converted without you intervening. Times will not be automatically adjusted for daylight savings. RealPage has a configuration setting to save the default timezone for a property, but many properties leave this setting unconfigured in our experience. Unfortunately, RealPage does not currently offer an API to query the property's timezone settings. This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately. summary: "Create Applicant Appointment: RealPage Partner Exchange" tags: - appointments security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_events_appointments_applicants_realpage_rpx__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_events_appointments_applicants_realpage_rpx__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/events/appointments/applicants/realpage_rpx/{event_id}: put: description: "Update Applicant Appointment: RealPage Partner Exchange" summary: "Update Applicant Appointment: RealPage Partner Exchange" tags: - appointments security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the event required: true description: The Propexo unique identifier for the event name: event_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_events_appointments_applicants_realpage_rpx_{event_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_events_appointments_applicants_realpage_rpx_{event_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/events/appointments/applicants/rentmanager/: post: description: |- Create an appointment for an applicant in Rent Manager. Rent Manager allows property managers to set both global and property specific timezone settings. These configurations can be pulled in via our [GET /timezones](https://docs.propexo.com/api-reference/api-reference/timezones/get-all-timezones) API endpoint which should be utilized to determine the timezone for which your appointment is set. If no timezone settings are found, Rent Manager suggests by default you send your appointment in Eastern Time (UTC-5:00 or UTC-4:00 depending on daylight savings). This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately. summary: "Create Applicant Appointment: Rent Manager" tags: - appointments security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_events_appointments_applicants_rentmanager__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_events_appointments_applicants_rentmanager__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/events/appointments/applicants/rentmanager/{event_id}: put: description: "Update Applicant Appointment: Rent Manager" summary: "Update Applicant Appointment: Rent Manager" tags: - appointments security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the event required: true description: The Propexo unique identifier for the event name: event_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_events_appointments_applicants_rentmanager_{event_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_events_appointments_applicants_rentmanager_{event_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/events/appointments/applicants/yardi/: post: description: |- Create an appointment for an applicant in Yardi. Yardi interprets appointment date and time as being in the timezone of the property. Those can be read in our `/timezones` endpoint. If the property doesn't have a specific timezone configured, there will be an integration global timezone record that should be used in that case. The time for this record is based on the Yardi server's configured timezone. In the case that the Yardi server time is different than the current time, we provide the `server_time_error_seconds` field on the `/timezones` endpoint as well. This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately. summary: "Create Applicant Appointment: Yardi" tags: - appointments security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_events_appointments_applicants_yardi__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_events_appointments_applicants_yardi__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/events/appointments/applicants/yardi/{event_id}: put: description: "Update Applicant Appointment: Yardi" summary: "Update Applicant Appointment: Yardi" tags: - appointments security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the event required: true description: The Propexo unique identifier for the event name: event_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_events_appointments_applicants_yardi_{event_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_events_appointments_applicants_yardi_{event_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/events/appointments/applicants/mri/: post: description: |- Create Applicant Appointment: MRI This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately. summary: "Create Applicant Appointment: MRI" tags: - appointments security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_events_appointments_applicants_mri__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_events_appointments_applicants_mri__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/events/appointments/applicants/mri/{event_id}: put: description: "Update Applicant Appointment: MRI" summary: "Update Applicant Appointment: MRI" tags: - appointments security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the event required: true description: The Propexo unique identifier for the event name: event_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_events_appointments_applicants_mri_{event_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_events_appointments_applicants_mri_{event_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/events/appointments/leads/cancel/appfolio: post: description: |- Cancel Lead Appointment: AppFolio This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately. summary: "Cancel Lead Appointment: AppFolio" tags: - appointments security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_events_appointments_leads_cancel_appfolio_post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_events_appointments_leads_cancel_appfolio_post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/events/appointments/leads/cancel/yardi: post: description: |- Cancel Lead Appointment: Yardi Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Cancel Lead Appointment: Yardi" tags: - appointments security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_events_appointments_leads_cancel_yardi_post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_events_appointments_leads_cancel_yardi_post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/events/appointments/leads/cancel/entrata: post: description: |- These updates will be reflected on the calendar in Entrata, but there's no event for a cancellation that appears in the activity log. Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Cancel Lead Appointment: Entrata" tags: - appointments security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_events_appointments_leads_cancel_entrata_post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_events_appointments_leads_cancel_entrata_post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/events/appointments/leads/cancel/resman: post: description: ResMan does not support cancelling an appointment (leads) via their API. This endpoint will always return a 405, with an error message specifying that cancelling an appointment (leads) in a ResMan integration is not supported due to the lack of upstream support. summary: "Cancel Appointment (leads): ResMan - Not Supported" tags: - appointments security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_events_appointments_leads_cancel_resman_post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_events_appointments_leads_cancel_resman_post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/events/appointments/leads/cancel/realpage_rpx: post: description: |- Cancel Lead Appointment: RealPage Partner Exchange This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately. summary: "Cancel Lead Appointment: RealPage Partner Exchange" tags: - appointments security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_events_appointments_leads_cancel_realpage_rpx_post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_events_appointments_leads_cancel_realpage_rpx_post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/events/appointments/leads/cancel/rentmanager: post: description: |- Cancel Lead Appointment: Rent Manager Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Cancel Lead Appointment: Rent Manager" tags: - appointments security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_events_appointments_leads_cancel_rentmanager_post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_events_appointments_leads_cancel_rentmanager_post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/events/appointments/leads/appfolio/: post: description: |- Create Lead Appointment: AppFolio This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately. summary: "Create Lead Appointment: AppFolio" tags: - appointments security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_events_appointments_leads_appfolio__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_events_appointments_leads_appfolio__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/events/appointments/leads/appfolio/{event_id}: put: description: "Update Lead Appointment: AppFolio" summary: "Update Lead Appointment: AppFolio" tags: - appointments security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: event_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_events_appointments_leads_appfolio_{event_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_events_appointments_leads_appfolio_{event_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/events/appointments/leads/entrata/: post: description: |- Create an appointment for a lead in Entrata. Entrata expects all times to be in Mountain Time (UTC-7:00 or UTC-6:00 depending on daylight savings). Times will be automatically converted based on the local time of the property when an end user views the appointment time in the browser. Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Lead Appointment: Entrata" tags: - appointments security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_events_appointments_leads_entrata__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_events_appointments_leads_entrata__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/events/appointments/leads/entrata/{event_id}: put: description: "Update Lead Appointment: Entrata" summary: "Update Lead Appointment: Entrata" tags: - appointments security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: event_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_events_appointments_leads_entrata_{event_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_events_appointments_leads_entrata_{event_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/events/appointments/leads/realpage_rpx/: post: description: |- Create an appointment for a lead in RealPage Partner Exchange. RealPage interprets the appointment date and time as being local to the timezone of the property the appointment is associated with. Times will not be converted without you intervening. Times will not be automatically adjusted for daylight savings. RealPage has a configuration setting to save the default timezone for a property, but many properties leave this setting unconfigured in our experience. Unfortunately, RealPage does not currently offer an API to query the property's timezone settings. This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately. summary: "Create Lead Appointment: RealPage Partner Exchange" tags: - appointments security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_events_appointments_leads_realpage_rpx__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_events_appointments_leads_realpage_rpx__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/events/appointments/leads/realpage_rpx/{event_id}: put: description: "Update Lead Appointment: RealPage Partner Exchange" summary: "Update Lead Appointment: RealPage Partner Exchange" tags: - appointments security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the event required: true description: The Propexo unique identifier for the event name: event_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_events_appointments_leads_realpage_rpx_{event_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_events_appointments_leads_realpage_rpx_{event_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/events/appointments/leads/rentmanager/: post: description: |- Create an appointment for a lead in Rent Manager. Rent Manager allows property managers to set both global and property specific timezone settings. These configurations can be pulled in via our [GET /timezones](https://docs.propexo.com/api-reference/api-reference/timezones/get-all-timezones) API endpoint which should be utilized to determine the timezone for which your appointment is set. If no timezone settings are found, Rent Manager suggests by default you send your appointment in Eastern Time (UTC-5:00 or UTC-4:00 depending on daylight savings). This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately. summary: "Create Lead Appointment: Rent Manager" tags: - appointments security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_events_appointments_leads_rentmanager__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_events_appointments_leads_rentmanager__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/events/appointments/leads/rentmanager/{event_id}: put: description: "Update Lead Appointment: Rent Manager" summary: "Update Lead Appointment: Rent Manager" tags: - appointments security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the event required: true description: The Propexo unique identifier for the event name: event_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_events_appointments_leads_rentmanager_{event_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_events_appointments_leads_rentmanager_{event_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/events/appointments/leads/resman/: post: description: |- ResMan interprets the appointment date and time as being UTC (offset of +00:00). The appointment date and time will be displayed in the timezone of the logged in user (not the property or portfolio account) in ResMan's portal. This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately. summary: "Create Lead Appointment: Resman" tags: - appointments security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_events_appointments_leads_resman__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_events_appointments_leads_resman__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/events/appointments/leads/resman/{event_id}: put: description: "Update Lead Appointment: Resman" summary: "Update Lead Appointment: Resman" tags: - appointments security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the lead required: true description: The Propexo unique identifier for the lead name: event_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_events_appointments_leads_resman_{event_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_events_appointments_leads_resman_{event_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/events/appointments/leads/yardi/: post: description: |- Create an appointment for a lead in Yardi. Yardi interprets appointment date and time as being in the timezone of the property. Those can be read in our `/timezones` endpoint. If the property doesn't have a specific timezone configured, there will be an integration global timezone record that should be used in that case. The time for this record is based on the Yardi server's configured timezone. In the case that the Yardi server time is different than the current time, we provide the `server_time_error_seconds` field on the `/timezones` endpoint as well. This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately. summary: "Create Lead Appointment: Yardi" tags: - appointments security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_events_appointments_leads_yardi__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_events_appointments_leads_yardi__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/events/appointments/leads/yardi/{event_id}: put: description: "Update Lead Appointment: Yardi" summary: "Update Lead Appointment: Yardi" tags: - appointments security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the event required: true description: The Propexo unique identifier for the event name: event_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_events_appointments_leads_yardi_{event_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_events_appointments_leads_yardi_{event_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/events/appointments/leads/mri/: post: description: |- Create Lead Appointment: MRI This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately. summary: "Create Lead Appointment: MRI" tags: - appointments security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_events_appointments_leads_mri__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_events_appointments_leads_mri__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/events/appointments/leads/mri/{event_id}: put: description: "Update Lead Appointment: MRI" summary: "Update Lead Appointment: MRI" tags: - appointments security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the event required: true description: The Propexo unique identifier for the event name: event_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_events_appointments_leads_mri_{event_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_events_appointments_leads_mri_{event_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/events/appointments/residents/cancel/rentmanager: post: description: |- Cancel Resident Appointment: Rent Manager Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Cancel Resident Appointment: Rent Manager" tags: - appointments security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_events_appointments_residents_cancel_rentmanager_post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_events_appointments_residents_cancel_rentmanager_post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/events/appointments/residents/rentmanager/: post: description: |- Create an appointment for a resident in Rent Manager. Rent Manager allows property managers to set both global and property specific timezone settings. These configurations can be pulled in via our [GET /timezones](https://docs.propexo.com/api-reference/api-reference/timezones/get-all-timezones) API endpoint which should be utilized to determine the timezone for which your appointment is set. If no timezone settings are found, Rent Manager suggests by default you send your appointment in Eastern Time (UTC-5:00 or UTC-4:00 depending on daylight savings). This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately. summary: "Create Resident Appointment: Rent Manager" tags: - appointments security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_events_appointments_residents_rentmanager__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_events_appointments_residents_rentmanager__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/events/appointments/residents/rentmanager/{event_id}: put: description: "Update Resident Appointment: Rent Manager" summary: "Update Resident Appointment: Rent Manager" tags: - appointments security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the event required: true description: The Propexo unique identifier for the event name: event_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_events_appointments_residents_rentmanager_{event_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_events_appointments_residents_rentmanager_{event_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/events/appointments/residents/mri/: post: description: |- Create Resident Appointment: MRI This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately. summary: "Create Resident Appointment: MRI" tags: - appointments security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_events_appointments_residents_mri__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_events_appointments_residents_mri__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/events/appointments/residents/mri/{event_id}: put: description: "Update Resident Appointment: MRI" summary: "Update Resident Appointment: MRI" tags: - appointments security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the event required: true description: The Propexo unique identifier for the event name: event_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_events_appointments_residents_mri_{event_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_events_appointments_residents_mri_{event_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/charge-codes/: get: description: Get all charge codes summary: Get all charge codes tags: - billing-and-payments security: - bearerAuth: [] parameters: - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query - schema: type: string description: The Propexo unique identifier for the property required: false description: The Propexo unique identifier for the property name: property_id in: query - schema: type: string description: The Propexo unique identifier for the integration required: false description: The Propexo unique identifier for the integration name: integration_id in: query - schema: type: string enum: *a287 description: The property management system of record required: false description: The property management system of record name: integration_vendor in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_charge-codes__get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/charge-codes/{charge_code_id}: get: description: Get a charge code by ID summary: Get a charge code by ID tags: - billing-and-payments security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: charge_code_id in: path - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_charge-codes_{charge_code_id}_get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/financial-accounts/: get: description: Get all financial accounts summary: Get all financial accounts tags: - billing-and-payments security: - bearerAuth: [] parameters: - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query - schema: type: string description: The Propexo unique identifier for the property required: false description: The Propexo unique identifier for the property name: property_id in: query - schema: type: string description: The Propexo unique identifier for the integration required: false description: The Propexo unique identifier for the integration name: integration_id in: query - schema: type: string enum: *a287 description: The property management system of record required: false description: The property management system of record name: integration_vendor in: query - schema: type: string description: The account number associated with the financial account required: false description: The account number associated with the financial account name: account_number in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_financial-accounts__get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/financial-accounts/{financial_account_id}: get: description: Get a financial account by ID summary: Get a financial account by ID tags: - billing-and-payments security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: financial_account_id in: path - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_financial-accounts_{financial_account_id}_get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/resident-charges/: get: description: The Resident Charges model provides a limited, one-sided view of a resident's financial history with a PMC and should not be treated as a comprehensive report of all charges that the resident owes. Credits to a resident's ledger are stored as negative charges. Due to the PMS API structure, this is a naturally high-volume endpoint. Since Propexo pricing is based on records returned, this may result in signficantly higher overall costs. We encourage you to reach out to support before activating. summary: Get all resident charges tags: - billing-and-payments security: - bearerAuth: [] parameters: - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query - schema: type: string description: The Propexo unique identifier for the property required: false description: The Propexo unique identifier for the property name: property_id in: query - schema: type: string description: The Propexo unique identifier for the integration required: false description: The Propexo unique identifier for the integration name: integration_id in: query - schema: type: string enum: *a287 description: The property management system of record required: false description: The property management system of record name: integration_vendor in: query - schema: type: string description: The Propexo unique identifier for the resident required: false description: The Propexo unique identifier for the resident name: resident_id in: query - schema: type: string description: The Propexo unique identifier for the lease required: false description: The Propexo unique identifier for the lease name: lease_id in: query - schema: type: - string - "null" description: The start of the transaction date range to search. Inclusive. required: false description: The start of the transaction date range to search. Inclusive. name: transaction_date_start in: query - schema: type: - string - "null" description: The end of the transaction date range to search. Inclusive. required: false description: The end of the transaction date range to search. Inclusive. name: transaction_date_end in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_resident-charges__get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" post: description: Create a resident charge for an integration. summary: Create resident charge tags: - billing-and-payments security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_resident-charges__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_resident-charges__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/resident-charges/{resident_charge_id}: get: description: The Resident Charges model provides a limited, one-sided view of a resident's financial history with a PMC and should not be treated as a comprehensive report of all charges that the resident owes. Credits to a resident's ledger are stored as negative charges. Due to the PMS API structure, this is a naturally high-volume endpoint. Since Propexo pricing is based on records returned, this may result in signficantly higher overall costs. We encourage you to reach out to support before activating. summary: Get a resident charge by ID tags: - billing-and-payments security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: resident_charge_id in: path - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_resident-charges_{resident_charge_id}_get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/resident-credits/: post: description: Create a resident credit for an integration. summary: Create resident credit tags: - billing-and-payments security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_resident-credits__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_resident-credits__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/recurring-resident-charges/: get: description: Get all recurring resident charges summary: Get all recurring resident charges tags: - billing-and-payments security: - bearerAuth: [] parameters: - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query - schema: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. required: false description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: location_id in: query - schema: type: string description: The Propexo unique identifier for the property required: false description: The Propexo unique identifier for the property name: property_id in: query - schema: type: string description: The Propexo unique identifier for the lease required: false description: The Propexo unique identifier for the lease name: lease_id in: query - schema: type: string description: The Propexo unique identifier for the integration required: false description: The Propexo unique identifier for the integration name: integration_id in: query - schema: type: string enum: *a287 description: The property management system of record required: false description: The property management system of record name: integration_vendor in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_recurring-resident-charges__get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" post: description: Create a recurring resident charge for an integration. summary: Create a recurring resident charge tags: - billing-and-payments security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_recurring-resident-charges__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_recurring-resident-charges__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/recurring-resident-charges/{recurring_resident_charge_id}: get: description: Get recurring resident charge by ID summary: Get recurring resident charge by ID tags: - billing-and-payments security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: recurring_resident_charge_id in: path - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_recurring-resident-charges_{recurring_resident_charge_id}_get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" put: description: Update a recurring resident charge for an integration. summary: Update a recurring resident charge tags: - billing-and-payments security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the recurring resident charge required: true description: The Propexo unique identifier for the recurring resident charge name: recurring_resident_charge_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_recurring-resident-charges_{recurring_resident_charge_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_recurring-resident-charges_{recurring_resident_charge_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/resident-payments/: get: description: The Resident Payments model provides a limited, one-sided view of a resident's financial history with a PMC and should not be treated as a comprehensive report of all payments that the resident has made. Due to the PMS API structure, this is a naturally high-volume endpoint. Since Propexo pricing is based on records returned, this may result in signficantly higher overall costs. We encourage you to reach out to support before activating. summary: Get all resident payments tags: - billing-and-payments security: - bearerAuth: [] parameters: - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query - schema: type: string description: The Propexo unique identifier for the property required: false description: The Propexo unique identifier for the property name: property_id in: query - schema: type: string description: The Propexo unique identifier for the integration required: false description: The Propexo unique identifier for the integration name: integration_id in: query - schema: type: string enum: *a287 description: The property management system of record required: false description: The property management system of record name: integration_vendor in: query - schema: type: string description: The Propexo unique identifier for the resident required: false description: The Propexo unique identifier for the resident name: resident_id in: query - schema: type: string description: The Propexo unique identifier for the lease required: false description: The Propexo unique identifier for the lease name: lease_id in: query - schema: type: - string - "null" description: The start of the transaction date range to search. Inclusive. required: false description: The start of the transaction date range to search. Inclusive. name: transaction_date_start in: query - schema: type: - string - "null" description: The end of the transaction date range to search. Inclusive. required: false description: The end of the transaction date range to search. Inclusive. name: transaction_date_end in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_resident-payments__get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" post: description: Create a resident payment for an integration. summary: Create resident payment tags: - billing-and-payments security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_resident-payments__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_resident-payments__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/resident-payments/{resident_payment_id}: get: description: The Resident Payments model provides a limited, one-sided view of a resident's financial history with a PMC and should not be treated as a comprehensive report of all payments that the resident has made. Due to the PMS API structure, this is a naturally high-volume endpoint. Since Propexo pricing is based on records returned, this may result in signficantly higher overall costs. We encourage you to reach out to support before activating. summary: Get a resident payment by ID tags: - billing-and-payments security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: resident_payment_id in: path - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_resident-payments_{resident_payment_id}_get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/fees/: get: description: Get all fees summary: Get all fees tags: - billing-and-payments security: - bearerAuth: [] parameters: - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query - schema: type: string description: The Propexo unique identifier for the integration required: false description: The Propexo unique identifier for the integration name: integration_id in: query - schema: type: string description: The Propexo unique identifier for the property required: false description: The Propexo unique identifier for the property name: property_id in: query - schema: type: string description: The Propexo unique identifier for the floor plan required: false description: The Propexo unique identifier for the floor plan name: floor_plan_id in: query - schema: type: string description: The Propexo unique identifier for the unit required: false description: The Propexo unique identifier for the unit name: unit_id in: query - schema: type: string description: The Propexo unique identifier for the charge code required: false description: The Propexo unique identifier for the charge code name: charge_code_id in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_fees__get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/fees/{fee_id}: get: description: Get fee by ID summary: Get fee by ID tags: - billing-and-payments security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: fee_id in: path - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_fees_{fee_id}_get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/resident-charges/appfolio/: post: description: |- Due to limitations in AppFolio's APIs, reading back a created transaction requires we read a date range. We limit this range to just the day the transaction was created, but more than one record may be read back in when this is done. This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately. summary: "Create Resident Charge: AppFolio" tags: - billing-and-payments security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_resident-charges_appfolio__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_resident-charges_appfolio__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/resident-charges/buildium/: post: description: |- Create Resident Charge: Buildium This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately. summary: "Create Resident Charge: Buildium" tags: - billing-and-payments security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_resident-charges_buildium__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_resident-charges_buildium__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/resident-charges/entrata/: post: description: |- Create Resident Charge: Entrata Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Resident Charge: Entrata" tags: - billing-and-payments security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_resident-charges_entrata__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_resident-charges_entrata__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/resident-charges/realpage_rpx/: post: description: |- Create Resident Charge: RealPage Partner Exchange Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Resident Charge: RealPage Partner Exchange" tags: - billing-and-payments security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_resident-charges_realpage_rpx__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_resident-charges_realpage_rpx__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/resident-charges/rentmanager/: post: description: |- Create Resident Charge: Rent Manager Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Resident Charge: Rent Manager" tags: - billing-and-payments security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_resident-charges_rentmanager__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_resident-charges_rentmanager__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/resident-charges/rentvine/: post: description: |- Create Resident Charge: Rentvine This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately. summary: "Create Resident Charge: Rentvine" tags: - billing-and-payments security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_resident-charges_rentvine__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_resident-charges_rentvine__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/resident-charges/yardi/: post: description: |- Create Resident Charge: Yardi Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Resident Charge: Yardi" tags: - billing-and-payments security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_resident-charges_yardi__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_resident-charges_yardi__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/resident-charges/yardi_rest/: post: description: |- Create Resident Charge: Yardi REST Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Resident Charge: Yardi REST" tags: - billing-and-payments security: - bearerAuth: [] x-fern-availability: beta requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_resident-charges_yardi_rest__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_resident-charges_yardi_rest__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/resident-charges/resman/: post: description: |- Create Resident Charge: ResMan. Important note: ResMan requires that the property management company approve partner (API) generated charges and payments. To do this, the PMC must go to the "Partner Transactions" tab in the ResMan portal and approve each transaction. Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Resident Charge: ResMan" tags: - billing-and-payments security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_resident-charges_resman__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_resident-charges_resman__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/resident-charges/propertyware/: post: description: |- Create Resident Charge: Propertyware This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately. summary: "Create Resident Charge: Propertyware" tags: - billing-and-payments security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_resident-charges_propertyware__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_resident-charges_propertyware__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/resident-charges/propertyware_rest/: post: description: |- Create Resident Charge: Propertyware REST This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately. summary: "Create Resident Charge: Propertyware REST" tags: - billing-and-payments security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_resident-charges_propertyware_rest__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_resident-charges_propertyware_rest__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/resident-charges/batch/: post: description: Batch create resident charges for an integration. summary: "*Batch Create Resident Charges" tags: - billing-and-payments security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_resident-charges_batch__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_resident-charges_batch__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/resident-credits/propertyware_rest/: post: description: |- Create Resident Credit: Propertyware REST This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately. summary: "Create Resident Credit: Propertyware REST" tags: - billing-and-payments security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_resident-credits_propertyware_rest__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_resident-credits_propertyware_rest__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/resident-credits/rentmanager/: post: description: |- Create Resident Credit: Rent Manager Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Resident Credit: Rent Manager" tags: - billing-and-payments security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_resident-credits_rentmanager__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_resident-credits_rentmanager__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/resident-credits/rentvine/: post: description: |- Note that credits are stored as negative charges when they're read in through Propexo. This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately. summary: "Create Resident Credit: Rentvine" tags: - billing-and-payments security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_resident-credits_rentvine__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_resident-credits_rentvine__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/recurring-resident-charges/entrata/: post: description: |- Create Recurring Charge: Entrata This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately. summary: "Create Recurring Charge: Entrata" tags: - billing-and-payments security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_recurring-resident-charges_entrata__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_recurring-resident-charges_entrata__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/recurring-resident-charges/propertyware/: post: description: |- Create Recurring Resident Charge: Propertyware Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Recurring Resident Charge: Propertyware" tags: - billing-and-payments security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_recurring-resident-charges_propertyware__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_recurring-resident-charges_propertyware__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/recurring-resident-charges/propertyware/{recurring_resident_charge_id}: put: description: "Update Recurring Resident Charge: Propertyware" summary: "Update Recurring Resident Charge: Propertyware" tags: - billing-and-payments security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: recurring_resident_charge_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_recurring-resident-charges_propertyware_{recurring_resident_charge_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_recurring-resident-charges_propertyware_{recurring_resident_charge_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/recurring-resident-charges/propertyware_rest/: post: description: |- Create Recurring Resident Charge: Propertyware REST This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately. summary: "Create Recurring Resident Charge: Propertyware REST" tags: - billing-and-payments security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_recurring-resident-charges_propertyware_rest__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_recurring-resident-charges_propertyware_rest__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/recurring-resident-charges/rentvine/: post: description: |- Create Recurring Resident Charge: Rentvine This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately. summary: "Create Recurring Resident Charge: Rentvine" tags: - billing-and-payments security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_recurring-resident-charges_rentvine__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_recurring-resident-charges_rentvine__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/recurring-resident-charges/rentmanager/: post: description: |- Create Resident Recurring Charge: Rent Manager This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately. summary: "Create Resident Recurring Charge: Rent Manager" tags: - billing-and-payments security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_recurring-resident-charges_rentmanager__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_recurring-resident-charges_rentmanager__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/recurring-resident-charges/rentmanager/{recurring_resident_charge_id}: put: description: "Update Recurring Resident Charge: Rent Manager" summary: "Update Recurring Resident Charge: Rent Manager" tags: - billing-and-payments security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: recurring_resident_charge_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_recurring-resident-charges_rentmanager_{recurring_resident_charge_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_recurring-resident-charges_rentmanager_{recurring_resident_charge_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/resident-payments/buildium/: post: description: |- Create Resident Payment: Buildium This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately. summary: "Create Resident Payment: Buildium" tags: - billing-and-payments security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_resident-payments_buildium__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_resident-payments_buildium__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/resident-payments/entrata/: post: description: Entrata does not support creating a resident payment via their API. This endpoint will always return a 405, with an error message specifying that creating a resident payment in an Entrata integration is not supported due to the lack of upstream support. summary: "Create Resident Payment: Entrata - Not Supported" tags: - billing-and-payments security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_resident-payments_entrata__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_resident-payments_entrata__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/resident-payments/rentmanager/: post: description: |- Create Resident Payment: Rent Manager This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately. summary: "Create Resident Payment: Rent Manager" tags: - billing-and-payments security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_resident-payments_rentmanager__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_resident-payments_rentmanager__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/resident-payments/yardi/: post: description: |- Create Resident Payment: Yardi Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Resident Payment: Yardi" tags: - billing-and-payments security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_resident-payments_yardi__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_resident-payments_yardi__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/resident-payments/yardi_rest/: post: description: |- Create Resident Payment: Yardi REST Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Resident Payment: Yardi REST" tags: - billing-and-payments security: - bearerAuth: [] x-fern-availability: beta requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_resident-payments_yardi_rest__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_resident-payments_yardi_rest__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/resident-payments/resman/: post: description: |- Create Resident Payment: ResMan. Important note: ResMan requires that the property management company approve partner (API) generated charges and payments. To do this, the PMC must go to the "Partner Transactions" tab in the ResMan portal and approve each transaction. Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Resident Payment: ResMan" tags: - billing-and-payments security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_resident-payments_resman__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_resident-payments_resman__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/resident-payments/realpage_rpx/: post: description: RealPageApp does not support creating a resident payment via their API. This endpoint will always return a 405, with an error message specifying that creating a resident payment in a RealPageApp integration is not supported due to the lack of upstream support. summary: "Create Resident Payment: RealPageApp - Not Supported" tags: - billing-and-payments security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_resident-payments_realpage_rpx__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_resident-payments_realpage_rpx__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/resident-payments/propertyware/: post: description: |- Create Resident Payment: Propertyware This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately. summary: "Create Resident Payment: Propertyware" tags: - billing-and-payments security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_resident-payments_propertyware__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_resident-payments_propertyware__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/resident-payments/propertyware_rest/: post: description: |- Create Resident Payment: Propertyware REST This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately. summary: "Create Resident Payment: Propertyware REST" tags: - billing-and-payments security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_resident-payments_propertyware_rest__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_resident-payments_propertyware_rest__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/resident-payments/rentvine/: post: description: |- Rentvine only allows primary residents to have payments assigned to them. This can be seen in the residents_meta_data or leases_meta_data API fields on their resident_type_normalized field. This field must be set to PRIMARY. This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately. summary: "Create Resident Payment: Rentvine" tags: - billing-and-payments security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_resident-payments_rentvine__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_resident-payments_rentvine__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/resident-charges/batch/yardi/: post: description: |- Batch Create Resident Charges: Yardi Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Batch Create Resident Charges: Yardi" tags: - billing-and-payments security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_resident-charges_batch_yardi__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_resident-charges_batch_yardi__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/resident-charges/batch/propertyware_rest/: post: description: |- Create multiple resident charges. Due to API restrictions, we cannot read data back after being written for bulk charge requests. Use the single-charge create endpoint if you need the created record ID or read-after-write functionality. This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately. summary: "Batch Create Resident Charges: Propertyware REST" tags: - billing-and-payments security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_resident-charges_batch_propertyware_rest__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_resident-charges_batch_propertyware_rest__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/resident-charges/batch/rentmanager/: post: description: |- Creates multiple resident charges in one job. All charges must resolve to the same Rent Manager location; use separate requests for charges in different locations. Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Batch Create Resident Charges: Rent Manager" tags: - billing-and-payments security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_resident-charges_batch_rentmanager__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_resident-charges_batch_rentmanager__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/resident-charges/batch/resman/: post: description: |- Creates multiple resident charges in one job. Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Batch Create Resident Charges: ResMan" tags: - billing-and-payments security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_resident-charges_batch_resman__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_resident-charges_batch_resman__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/call-logs/: get: description: Get all call logs. summary: Get all call logs. tags: - call-logs security: - bearerAuth: [] parameters: - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query - schema: type: string description: The external call log id required: false description: The external call log id name: x_id in: query - schema: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. required: false description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: location_id in: query - schema: type: string description: The Propexo unique identifier for the property required: false description: The Propexo unique identifier for the property name: property_id in: query - schema: type: string description: The Propexo unique identifier for the integration required: false description: The Propexo unique identifier for the integration name: integration_id in: query - schema: type: string enum: *a287 description: The property management system of record required: false description: The property management system of record name: integration_vendor in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_call-logs__get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/call-logs/{call_log_id}: get: description: Get a call log by ID. summary: Get a call log by ID. tags: - call-logs security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: call_log_id in: path - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_call-logs_{call_log_id}_get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/construction-jobs/: get: description: Get all construction jobs summary: Get all construction jobs tags: - construction-job-cost security: - bearerAuth: [] parameters: - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query - schema: type: string description: The Propexo unique identifier for the property required: false description: The Propexo unique identifier for the property name: property_id in: query - schema: type: string description: The Propexo unique identifier for the integration required: false description: The Propexo unique identifier for the integration name: integration_id in: query - schema: type: string enum: *a287 description: The property management system of record required: false description: The property management system of record name: integration_vendor in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_construction-jobs__get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" post: description: Create a construction job for an integration. summary: Create construction job tags: - construction-job-cost security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_construction-jobs__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_construction-jobs__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/construction-jobs/{construction_job_id}: get: description: Get construction job by ID summary: Get construction job by ID tags: - construction-job-cost security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the construction job required: true description: The ID of the construction job name: construction_job_id in: path - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_construction-jobs_{construction_job_id}_get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" put: description: Update a construction job for an integration. summary: Update construction job tags: - construction-job-cost security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the construction job required: true description: The Propexo unique identifier for the construction job name: construction_job_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_construction-jobs_{construction_job_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_construction-jobs_{construction_job_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/contracts/: post: description: Create a contract for an integration. summary: Create contract tags: - construction-job-cost security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_contracts__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_contracts__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/contracts/{contract_id}: put: description: Update a contract for an integration. summary: Update contract tags: - construction-job-cost security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the contract required: true description: The Propexo unique identifier for the contract name: contract_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_contracts_{contract_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_contracts_{contract_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/construction-jobs/{construction_job_id}/details: get: description: Get all construction job details for a specific construction job summary: Get all construction job details for a specific construction job tags: - construction-job-cost security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the construction job required: true description: The Propexo unique identifier for the construction job name: construction_job_id in: path - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query - schema: type: string description: The Propexo unique identifier for the property required: false description: The Propexo unique identifier for the property name: property_id in: query - schema: type: string description: The Propexo unique identifier for the integration required: false description: The Propexo unique identifier for the integration name: integration_id in: query - schema: type: string enum: *a287 description: The property management system of record required: false description: The property management system of record name: integration_vendor in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_construction-jobs_{construction_job_id}_details_get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/construction-jobs/{construction_job_id}/contracts: get: description: Get all contracts for a specific construction job summary: Get all contracts for a specific construction job tags: - construction-job-cost security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the construction job required: true description: The Propexo unique identifier for the construction job name: construction_job_id in: path - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query - schema: type: string description: The Propexo unique identifier for the property required: false description: The Propexo unique identifier for the property name: property_id in: query - schema: type: string description: The Propexo unique identifier for the integration required: false description: The Propexo unique identifier for the integration name: integration_id in: query - schema: type: string enum: *a287 description: The property management system of record required: false description: The property management system of record name: integration_vendor in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_construction-jobs_{construction_job_id}_contracts_get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/construction-jobs/yardi/: post: description: Yardi does not support creating a construction job via their API. This endpoint will always return a 405, with an error message specifying that creating a construction job in a Yardi integration is not supported due to the lack of upstream support. summary: "Create Construction Job: Yardi - Not Supported" tags: - construction-job-cost security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_construction-jobs_yardi__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_construction-jobs_yardi__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/construction-jobs/yardi/{construction_job_id}: put: description: Yardi does not support updating a construction job via their API. This endpoint will always return a 405, with an error message specifying that updating a construction job in a Yardi integration is not supported due to the lack of upstream support. summary: "Update Construction Job: Yardi - Not Supported" tags: - construction-job-cost security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: construction_job_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_construction-jobs_yardi_{construction_job_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_construction-jobs_yardi_{construction_job_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/contracts/yardi/: post: description: |- Create Contract: Yardi Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Contract: Yardi" tags: - construction-job-cost security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_contracts_yardi__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_contracts_yardi__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/contracts/yardi/{contract_id}: put: description: "Update Contract: Yardi" summary: "Update Contract: Yardi" tags: - construction-job-cost security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the contract required: true description: The Propexo unique identifier for the contract name: contract_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_contracts_yardi_{contract_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_contracts_yardi_{contract_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/contracts/yardi_rest/: post: description: |- Create Contract: Yardi REST Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Contract: Yardi REST" tags: - construction-job-cost security: - bearerAuth: [] x-fern-availability: beta requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_contracts_yardi_rest__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_contracts_yardi_rest__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/contracts/yardi_rest/{contract_id}: put: description: "Update Contract: Yardi REST" summary: "Update Contract: Yardi REST" tags: - construction-job-cost security: - bearerAuth: [] x-fern-availability: beta parameters: - schema: type: string description: The Propexo unique identifier for the contract required: true description: The Propexo unique identifier for the contract name: contract_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_contracts_yardi_rest_{contract_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_contracts_yardi_rest_{contract_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/construction-jobs/contracts/{contract_id}/details: get: description: Get all contract details for a specific contract summary: Get all contract details for a specific contract tags: - construction-job-cost security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the contract required: true description: The Propexo unique identifier for the contract name: contract_id in: path - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query - schema: type: string description: The Propexo unique identifier for the property required: false description: The Propexo unique identifier for the property name: property_id in: query - schema: type: string description: The Propexo unique identifier for the integration required: false description: The Propexo unique identifier for the integration name: integration_id in: query - schema: type: string enum: *a287 description: The property management system of record required: false description: The property management system of record name: integration_vendor in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_construction-jobs_contracts_{contract_id}_details_get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/deposit-summaries/: get: description: Get all deposit summaries summary: Get all deposit summaries tags: - deposit-summaries security: - bearerAuth: [] x-fern-availability: beta parameters: - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query - schema: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. required: false description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: location_id in: query - schema: type: string description: The Propexo unique identifier for the property required: false description: The Propexo unique identifier for the property name: property_id in: query - schema: type: string description: The Propexo unique identifier for the resident required: false description: The Propexo unique identifier for the resident name: resident_id in: query - schema: type: string description: The Propexo unique identifier for the integration required: false description: The Propexo unique identifier for the integration name: integration_id in: query - schema: type: string enum: *a287 description: The property management system of record required: false description: The property management system of record name: integration_vendor in: query - schema: type: string description: The external ID of the building (not necessarily the property) from the integration vendor required: false description: The external ID of the building (not necessarily the property) from the integration vendor name: x_building_id in: query - schema: type: string description: The external ID of the property from the integration vendor required: false description: The external ID of the property from the integration vendor name: x_property_id in: query - schema: type: string description: The Propexo unique identifier for the lease required: false description: The Propexo unique identifier for the lease name: lease_id in: query - schema: type: string description: The Propexo unique identifier for the invoice required: false description: The Propexo unique identifier for the invoice name: invoice_id in: query - schema: anyOf: - type: boolean - type: string description: Whether the refund is due for the deposit summary required: false description: Whether the refund is due for the deposit summary name: refund_is_due in: query - schema: anyOf: - type: boolean - type: string description: Filter to only return deposit summaries where the invoice_id is not null required: false description: Filter to only return deposit summaries where the invoice_id is not null name: invoice_id_not_null in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_deposit-summaries__get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/deposit-summaries/{deposit_summary_id}: get: description: Get a deposit summary by ID summary: Get a deposit summary by ID tags: - deposit-summaries security: - bearerAuth: [] x-fern-availability: beta parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: deposit_summary_id in: path - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_deposit-summaries_{deposit_summary_id}_get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" put: description: Update a deposit summary for an integration. summary: Update deposit summary tags: - deposit-summaries security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: deposit_summary_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_deposit-summaries_{deposit_summary_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_deposit-summaries_{deposit_summary_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/deposit-summaries/yardi/{deposit_summary_id}: put: description: |- Update Deposit Summary: Yardi. This endpoint will initiate a deposit summary as paid if the total amount of the invoice is passed in. Partial payments will be accepted, but the invoice will not be marked as paid until the full amount is paid. If the deposit summary has already been paid, Yardi will throw an error. summary: "Update Deposit Summary: Yardi" tags: - deposit-summaries security: - bearerAuth: [] x-fern-availability: beta parameters: - schema: type: string description: The Propexo unique identifier for the deposit summary required: true description: The Propexo unique identifier for the deposit summary name: deposit_summary_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_deposit-summaries_yardi_{deposit_summary_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_deposit-summaries_yardi_{deposit_summary_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/deposit-summaries/yardi_rest/{deposit_summary_id}: put: description: |- Update Deposit Summary: Yardi REST. This endpoint will initiate a deposit summary as paid if the total amount of the invoice is passed in. Partial payments will be accepted, but the invoice will not be marked as paid until the full amount is paid. If the deposit summary has already been paid, Yardi will throw an error. summary: "Update Deposit Summary: Yardi REST" tags: - deposit-summaries security: - bearerAuth: [] x-fern-availability: beta parameters: - schema: type: string description: The Propexo unique identifier for the deposit summary required: true description: The Propexo unique identifier for the deposit summary name: deposit_summary_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_deposit-summaries_yardi_rest_{deposit_summary_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_deposit-summaries_yardi_rest_{deposit_summary_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/deposit-summaries/mri/{deposit_summary_id}: put: description: "Update Deposit Summary: MRI. This endpoint will initiate a deposit summary as paid." summary: "Update Deposit Summary: MRI" tags: - deposit-summaries security: - bearerAuth: [] x-fern-availability: beta parameters: - schema: type: string description: The Propexo unique identifier for the deposit summary required: true description: The Propexo unique identifier for the deposit summary name: deposit_summary_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_deposit-summaries_mri_{deposit_summary_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_deposit-summaries_mri_{deposit_summary_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/deposit-summaries/yardi/deposit-refund-account-number/: get: description: Get all deposit refund account numbers summary: Get all deposit refund account numbers tags: - deposit-summaries security: - bearerAuth: [] parameters: - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query - schema: type: string description: The Propexo unique identifier for the integration required: false description: The Propexo unique identifier for the integration name: integration_id in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_deposit-summaries_yardi_deposit-refund-account-number__get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" post: description: Configure a deposit refund account number for your integration to track which charges correspond to deposits. Since this account number varies by customer and integration, you'll need to consult with your customer to determine the correct value for this endpoint. summary: Configure a deposit refund account number for your integration tags: - deposit-summaries security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_deposit-summaries_yardi_deposit-refund-account-number__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_deposit-summaries_yardi_deposit-refund-account-number__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/deposit-summaries/yardi/deposit-refund-account-number/{deposit_refund_account_number_id}: get: description: Get deposit refund account number by ID summary: Get deposit refund account number by ID tags: - deposit-summaries security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: deposit_refund_account_number_id in: path - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_deposit-summaries_yardi_deposit-refund-account-number_{deposit_refund_account_number_id}_get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" delete: description: Delete a deposit refund account number summary: Delete a deposit refund account number tags: - deposit-summaries security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the deposit refund account number to delete required: true description: The ID of the deposit refund account number to delete name: deposit_refund_account_number_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_deposit-summaries_yardi_deposit-refund-account-number_{deposit_refund_account_number_id}_delete_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_deposit-summaries_yardi_deposit-refund-account-number_{deposit_refund_account_number_id}_delete_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/deposits/: get: description: Get all deposits summary: Get all deposits tags: - deposits security: - bearerAuth: [] x-fern-availability: beta parameters: - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query - schema: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. required: false description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: location_id in: query - schema: type: string description: The Propexo unique identifier for the property required: false description: The Propexo unique identifier for the property name: property_id in: query - schema: type: string description: The Propexo unique identifier for the resident required: false description: The Propexo unique identifier for the resident name: resident_id in: query - schema: type: string description: The Propexo unique identifier for the integration required: false description: The Propexo unique identifier for the integration name: integration_id in: query - schema: type: string enum: *a287 description: The property management system of record required: false description: The property management system of record name: integration_vendor in: query - schema: type: string description: The external ID of the building (not necessarily the property) from the integration vendor required: false description: The external ID of the building (not necessarily the property) from the integration vendor name: x_building_id in: query - schema: type: string description: The external ID of the property from the integration vendor required: false description: The external ID of the property from the integration vendor name: x_property_id in: query - schema: type: string description: The Propexo unique identifier for the lease required: false description: The Propexo unique identifier for the lease name: lease_id in: query - schema: anyOf: - type: boolean - type: string description: Whether the refund is due for the deposit required: false description: Whether the refund is due for the deposit name: refund_is_due in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_deposits__get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/deposits/{id}: get: description: Get a deposit by ID summary: Get a deposit by ID tags: - deposits security: - bearerAuth: [] x-fern-availability: beta parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: id in: path - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_deposits_{id}_get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/employees/: get: description: Get all employees summary: Get all employees tags: - employees security: - bearerAuth: [] parameters: - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query - schema: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. required: false description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: location_id in: query - schema: type: string description: The Propexo unique identifier for the property required: false description: The Propexo unique identifier for the property name: property_id in: query - schema: type: string description: The Propexo unique identifier for the integration required: false description: The Propexo unique identifier for the integration name: integration_id in: query - schema: type: string enum: *a287 description: The property management system of record required: false description: The property management system of record name: integration_vendor in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_employees__get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/employees/{employee_id}: get: description: Get an employee by ID summary: Get an employee by ID tags: - employees security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: employee_id in: path - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_employees_{employee_id}_get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/events/: get: description: Get all events summary: Get all events tags: - events security: - bearerAuth: [] parameters: - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query - schema: type: string description: The external ID of the event from the integration vendor required: false description: The external ID of the event from the integration vendor name: x_id in: query - schema: type: string description: The external ID of the property from the integration vendor required: false description: The external ID of the property from the integration vendor name: x_property_id in: query - schema: type: string description: The external ID of the type from the integration vendor required: false description: The external ID of the type from the integration vendor name: x_type_id in: query - schema: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. required: false description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: location_id in: query - schema: type: string description: The Propexo unique identifier for the property required: false description: The Propexo unique identifier for the property name: property_id in: query - schema: type: string description: The Propexo unique identifier for the lead required: false description: The Propexo unique identifier for the lead name: lead_id in: query - schema: type: string description: The Propexo unique identifier for the applicant required: false description: The Propexo unique identifier for the applicant name: applicant_id in: query - schema: type: string description: The Propexo unique identifier for the resident required: false description: The Propexo unique identifier for the resident name: resident_id in: query - schema: type: string description: The Propexo unique identifier for the integration required: false description: The Propexo unique identifier for the integration name: integration_id in: query - schema: type: string enum: *a287 description: The property management system of record required: false description: The property management system of record name: integration_vendor in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_events__get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/events/{event_id}: get: description: Get an event by ID summary: Get an event by ID tags: - events security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: event_id in: path - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_events_{event_id}_get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/events/applicants: post: description: Create an applicant event for an integration. summary: Create event for an applicant tags: - events security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_events_applicants_post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_events_applicants_post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/events/leads: post: description: Create a lead event for an integration. summary: Create event for a lead tags: - events security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_events_leads_post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_events_leads_post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/events/residents: post: description: Create a resident event for an integration. summary: Create event for a resident tags: - events security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_events_residents_post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_events_residents_post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/event-types/: get: description: Get all event types summary: Get all event types tags: - events security: - bearerAuth: [] parameters: - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query - schema: type: string description: The external ID from the integration vendor required: false description: The external ID from the integration vendor name: x_id in: query - schema: type: string description: The external ID of the property from the integration vendor required: false description: The external ID of the property from the integration vendor name: x_property_id in: query - schema: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. required: false description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: location_id in: query - schema: type: string description: The Propexo unique identifier for the property required: false description: The Propexo unique identifier for the property name: property_id in: query - schema: type: array items: type: string description: The Propexo data models (e.g. units, residents, applicants, etc.) associated with the event type required: false description: The Propexo data models (e.g. units, residents, applicants, etc.) associated with the event type name: models in: query - schema: type: string description: The Propexo unique identifier for the integration required: false description: The Propexo unique identifier for the integration name: integration_id in: query - schema: type: string enum: *a287 description: The property management system of record required: false description: The property management system of record name: integration_vendor in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_event-types__get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/event-types/{event_type_id}: get: description: Get event type by ID summary: Get event type by ID tags: - events security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: event_type_id in: path - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_event-types_{event_type_id}_get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/event-sub-types/: get: description: Get all event sub types summary: Get all event sub types tags: - events security: - bearerAuth: [] parameters: - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query - schema: type: string description: The external ID from the integration vendor required: false description: The external ID from the integration vendor name: x_id in: query - schema: type: string description: The external ID of the property from the integration vendor required: false description: The external ID of the property from the integration vendor name: x_property_id in: query - schema: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. required: false description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: location_id in: query - schema: type: string description: The Propexo unique identifier for the property required: false description: The Propexo unique identifier for the property name: property_id in: query - schema: type: string description: The Propexo unique identifier for the integration required: false description: The Propexo unique identifier for the integration name: integration_id in: query - schema: type: string enum: *a287 description: The property management system of record required: false description: The property management system of record name: integration_vendor in: query - schema: type: string description: The Propexo unique identifier for the event type required: false description: The Propexo unique identifier for the event type name: event_type_id in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_event-sub-types__get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/event-sub-types/{event_sub_type_id}: get: description: Get event sub type by ID summary: Get event sub type by ID tags: - events security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: event_sub_type_id in: path - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_event-sub-types_{event_sub_type_id}_get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/event-results/: get: description: Get all event results summary: Get all event results tags: - events security: - bearerAuth: [] parameters: - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query - schema: type: string description: The external ID from the integration vendor required: false description: The external ID from the integration vendor name: x_id in: query - schema: type: string description: The external ID of the property from the integration vendor required: false description: The external ID of the property from the integration vendor name: x_property_id in: query - schema: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. required: false description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: location_id in: query - schema: type: string description: The Propexo unique identifier for the property required: false description: The Propexo unique identifier for the property name: property_id in: query - schema: type: string description: The Propexo unique identifier for the integration required: false description: The Propexo unique identifier for the integration name: integration_id in: query - schema: type: string enum: *a287 description: The property management system of record required: false description: The property management system of record name: integration_vendor in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_event-results__get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/event-results/{event_result_id}: get: description: Get event result by ID summary: Get event result by ID tags: - events security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: event_result_id in: path - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_event-results_{event_result_id}_get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/events/applicants/{event_id}: put: description: Update an event for an applicant summary: Update an event for an applicant tags: - events security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the event required: true description: The Propexo unique identifier for the event name: event_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_events_applicants_{event_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_events_applicants_{event_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/events/leads/{event_id}: put: description: Update an event for a lead summary: Update an event for a lead tags: - events security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the event required: true description: The Propexo unique identifier for the event name: event_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_events_leads_{event_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_events_leads_{event_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/events/residents/{event_id}: put: description: Update an event for a resident summary: Update an event for a resident tags: - events security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the event required: true description: The Propexo unique identifier for the event name: event_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_events_residents_{event_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_events_residents_{event_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/event-types/mri/: post: description: |- Create Event Type: MRI This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately. summary: "Create Event Type: MRI" tags: - events security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_event-types_mri__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_event-types_mri__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/events/applicants/buildium/: post: description: |- Create Applicant Event: Buildium Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Applicant Event: Buildium" tags: - events security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_events_applicants_buildium__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_events_applicants_buildium__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/events/applicants/entrata/: post: description: |- Create an event for an applicant in Entrata. Entrata expects all times to be in Mountain Time (UTC-7:00 or UTC-6:00 depending on daylight savings). Times will be automatically converted based on the local time of the property when an end user views the event time in the browser. Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Applicant Event: Entrata" tags: - events security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_events_applicants_entrata__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_events_applicants_entrata__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/events/applicants/propertyware/: post: description: |- Create Applicant Event: Propertyware Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Applicant Event: Propertyware" tags: - events security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_events_applicants_propertyware__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_events_applicants_propertyware__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/events/applicants/realpage_rpx/: post: description: |- Create Applicant Event: RealPage Partner Exchange Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Applicant Event: RealPage Partner Exchange" tags: - events security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_events_applicants_realpage_rpx__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_events_applicants_realpage_rpx__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/events/applicants/realpage/: post: description: |- Create Applicant Event: Realpage Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Applicant Event: Realpage" tags: - events security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_events_applicants_realpage__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_events_applicants_realpage__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/events/applicants/yardi/: post: description: |- The saved created_record_id for this operation is the applicant_id associated with the event. Yardi doesn't return event_id from their API. This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately. summary: "Create Applicant Event: Yardi" tags: - events security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_events_applicants_yardi__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_events_applicants_yardi__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/events/applicants/mri/: post: description: |- Create Applicant Event: MRI This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately. summary: "Create Applicant Event: MRI" tags: - events security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_events_applicants_mri__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_events_applicants_mri__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/events/applicants/mri/{event_id}: put: description: "Update Applicant Event: MRI" summary: "Update Applicant Event: MRI" tags: - events security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the event required: true description: The Propexo unique identifier for the event name: event_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_events_applicants_mri_{event_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_events_applicants_mri_{event_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/events/leads/entrata/: post: description: |- Create an event for an applicant in Entrata. Entrata expects all times to be in Mountain Time (UTC-7:00 or UTC-6:00 depending on daylight savings). Times will be automatically converted based on the local time of the property when an end user views the event time in the browser. Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Lead Event: Entrata" tags: - events security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_events_leads_entrata__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_events_leads_entrata__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/events/leads/propertyware/: post: description: |- Create Lead Event: Propertyware Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Lead Event: Propertyware" tags: - events security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_events_leads_propertyware__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_events_leads_propertyware__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/events/leads/realpage/: post: description: |- Create Lead Event: Realpage This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately. summary: "Create Lead Event: Realpage" tags: - events security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_events_leads_realpage__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_events_leads_realpage__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/events/leads/rentmanager/: post: description: |- Create Lead Event: RentManager Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Lead Event: RentManager" tags: - events security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_events_leads_rentmanager__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_events_leads_rentmanager__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/events/leads/realpage_rpx/: post: description: |- Create Lead Event: RealPage Partner Exchange Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Lead Event: RealPage Partner Exchange" tags: - events security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_events_leads_realpage_rpx__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_events_leads_realpage_rpx__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/events/leads/resman/: post: description: |- Create Lead Event: Resman This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately. summary: "Create Lead Event: Resman" tags: - events security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_events_leads_resman__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_events_leads_resman__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/events/leads/yardi/: post: description: |- The saved created_record_id for this operation is the lead_id associated with the event. Yardi doesn't return event_id from their API. This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately. summary: "Create Lead Event: Yardi" tags: - events security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_events_leads_yardi__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_events_leads_yardi__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/events/leads/mri/: post: description: |- Create Lead Event: MRI This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately. summary: "Create Lead Event: MRI" tags: - events security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_events_leads_mri__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_events_leads_mri__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/events/leads/mri/{event_id}: put: description: "Update Lead Event: MRI" summary: "Update Lead Event: MRI" tags: - events security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the event required: true description: The Propexo unique identifier for the event name: event_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_events_leads_mri_{event_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_events_leads_mri_{event_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/events/residents/buildium/: post: description: |- Create Resident Event: Buildium Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Resident Event: Buildium" tags: - events security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_events_residents_buildium__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_events_residents_buildium__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/events/residents/entrata/: post: description: |- Create an event for an applicant in Entrata. Entrata expects all times to be in Mountain Time (UTC-7:00 or UTC-6:00 depending on daylight savings). Times will be automatically converted based on the local time of the property when an end user views the event time in the browser. Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Resident Event: Entrata" tags: - events security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_events_residents_entrata__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_events_residents_entrata__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/events/residents/propertyware/: post: description: |- Create Resident Event: Propertyware Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Resident Event: Propertyware" tags: - events security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_events_residents_propertyware__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_events_residents_propertyware__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/events/residents/realpage/: post: description: |- Create Resident Event: Realpage Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Resident Event: Realpage" tags: - events security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_events_residents_realpage__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_events_residents_realpage__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/events/residents/realpage_rpx/: post: description: |- Create Resident Event: RealPage Partner Exchange Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Resident Event: RealPage Partner Exchange" tags: - events security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_events_residents_realpage_rpx__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_events_residents_realpage_rpx__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/events/residents/mri/: post: description: |- Create Resident Event: MRI This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately. summary: "Create Resident Event: MRI" tags: - events security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_events_residents_mri__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_events_residents_mri__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/events/residents/mri/{event_id}: put: description: "Update Resident Event: MRI" summary: "Update Resident Event: MRI" tags: - events security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the event required: true description: The Propexo unique identifier for the event name: event_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_events_residents_mri_{event_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_events_residents_mri_{event_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/file-types/: get: description: Get all file types summary: Get all file types tags: - files security: - bearerAuth: [] parameters: - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query - schema: type: string description: The external ID from the integration vendor required: false description: The external ID from the integration vendor name: x_id in: query - schema: type: string description: The external ID of the property from the integration vendor required: false description: The external ID of the property from the integration vendor name: x_property_id in: query - schema: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. required: false description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: location_id in: query - schema: type: string description: The Propexo unique identifier for the file type required: false description: The Propexo unique identifier for the file type name: property_id in: query - schema: type: string description: The type associated with the file type required: false description: The type associated with the file type name: type in: query - schema: type: array items: type: string description: The Propexo data models (e.g. units, residents, applicants, etc.) associated with the file type required: false description: The Propexo data models (e.g. units, residents, applicants, etc.) associated with the file type name: models in: query - schema: type: string description: The Propexo unique identifier for the integration required: false description: The Propexo unique identifier for the integration name: integration_id in: query - schema: type: string enum: *a287 description: The property management system of record required: false description: The property management system of record name: integration_vendor in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_file-types__get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" post: description: Create a file type for an integration. summary: Create file type tags: - files security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_file-types__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_file-types__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/file-types/{file_type_id}: get: description: Get file type by ID summary: Get file type by ID tags: - files security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: file_type_id in: path - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_file-types_{file_type_id}_get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/file-types/rentmanager/: post: description: |- Create a file type for Rent Manager Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: Create a file type for Rent Manager tags: - files security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_file-types_rentmanager__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_file-types_rentmanager__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/accounting-entities/: get: description: Get all accounting entities summary: Get all accounting entities tags: - invoices security: - bearerAuth: [] parameters: - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query - schema: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. required: false description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: location_id in: query - schema: type: string description: The Propexo unique identifier for the property required: false description: The Propexo unique identifier for the property name: property_id in: query - schema: type: string description: The Propexo unique identifier for the integration required: false description: The Propexo unique identifier for the integration name: integration_id in: query - schema: type: string enum: *a287 description: The property management system of record required: false description: The property management system of record name: integration_vendor in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_accounting-entities__get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/accounting-entities/{accounting_entity_id}: get: description: Get accounting entity by id summary: Get accounting entity by id tags: - invoices security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: accounting_entity_id in: path - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_accounting-entities_{accounting_entity_id}_get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/invoices/: get: description: Get all invoices summary: Get all invoices tags: - invoices security: - bearerAuth: [] parameters: - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query - schema: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. required: false description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: location_id in: query - schema: type: string description: The Propexo unique identifier for the property required: false description: The Propexo unique identifier for the property name: property_id in: query - schema: type: string description: The Propexo unique identifier for the integration required: false description: The Propexo unique identifier for the integration name: integration_id in: query - schema: type: string enum: *a287 description: The property management system of record required: false description: The property management system of record name: integration_vendor in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_invoices__get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" post: description: Create an invoice for an integration. summary: Create invoice tags: - invoices security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_invoices__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_invoices__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/invoices/{invoice_id}: get: description: Get an invoice by ID summary: Get an invoice by ID tags: - invoices security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: invoice_id in: path - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_invoices_{invoice_id}_get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" put: description: Update a invoice for an integration. summary: Update invoice tags: - invoices security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: invoice_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_invoices_{invoice_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_invoices_{invoice_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/payable-registers/: get: description: Get all payable registers summary: Get all payable registers tags: - invoices security: - bearerAuth: [] parameters: - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query - schema: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. required: false description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: location_id in: query - schema: type: string description: The Propexo unique identifier for the property required: false description: The Propexo unique identifier for the property name: property_id in: query - schema: type: string description: The Propexo unique identifier for the integration required: false description: The Propexo unique identifier for the integration name: integration_id in: query - schema: type: string enum: *a287 description: The property management system of record required: false description: The property management system of record name: integration_vendor in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_payable-registers__get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" post: description: Create a payable register for an integration. summary: Create payable register tags: - invoices security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_payable-registers__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_payable-registers__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/payable-registers/cancel: post: description: Cancel a payable register summary: Cancel a payable register tags: - invoices security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_payable-registers_cancel_post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_payable-registers_cancel_post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/payable-registers/{payable_register_id}: get: description: Get a payable register by ID summary: Get a payable register by ID tags: - invoices security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: payable_register_id in: path - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_payable-registers_{payable_register_id}_get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" put: description: Update a payable register for an integration. summary: Update a payable register tags: - invoices security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the payable register required: true description: The Propexo unique identifier for the payable register name: payable_register_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_payable-registers_{payable_register_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_payable-registers_{payable_register_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/invoices/buildium/: post: description: |- Create Invoice: Buildium This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately. summary: "Create Invoice: Buildium" tags: - invoices security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_invoices_buildium__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_invoices_buildium__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/invoices/entrata/: post: description: |- Create Invoice: Entrata Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Invoice: Entrata" tags: - invoices security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_invoices_entrata__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_invoices_entrata__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/invoices/entrata/{invoice_id}: put: description: Entrata does not support updating an invoice via their API. This endpoint will always return a 405, with an error message specifying that updating an invoice in an Entrata integration is not supported due to the lack of upstream support. Entrata allows updating payments and allocations on an invoice, but not the invoice details or the invoice items themselves. summary: "Update Invoice: Entrata - Not Supported" tags: - invoices security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: invoice_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_invoices_entrata_{invoice_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_invoices_entrata_{invoice_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/invoices/resman/: post: description: |- Invoices created via the ResMan API begin in an unapproved state and then have to be approved by the PMC in the ResMan portal. Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Invoice: ResMan" tags: - invoices security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_invoices_resman__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_invoices_resman__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/invoices/resman/{invoice_id}: put: description: ResMan does not support updating an invoice via their API. This endpoint will always return a 405, with an error message specifying that updating an invoice in a ResMan integration is not supported due to the lack of upstream support. summary: "Update Invoice: ResMan - Not Supported" tags: - invoices security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: invoice_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_invoices_resman_{invoice_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_invoices_resman_{invoice_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/invoices/yardi/: post: description: |- Create Invoice: Yardi Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Invoice: Yardi" tags: - invoices security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_invoices_yardi__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_invoices_yardi__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/invoices/yardi/{invoice_id}: put: description: Yardi does not support updating an invoice via their API. This endpoint will always return a 405, with an error message specifying that updating an invoice in a Yardi integration is not supported due to the lack of upstream support. summary: "Update Invoice: Yardi - Not Supported" tags: - invoices security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: invoice_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_invoices_yardi_{invoice_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_invoices_yardi_{invoice_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/invoices/yardi_rest/: post: description: |- Create Invoice: Yardi REST Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Invoice: Yardi REST" tags: - invoices security: - bearerAuth: [] x-fern-availability: beta requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_invoices_yardi_rest__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_invoices_yardi_rest__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/invoices/mri/: post: description: |- Create Invoice: MRI This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately. summary: "Create Invoice: MRI" tags: - invoices security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_invoices_mri__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_invoices_mri__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/invoices/mri/{invoice_id}: put: description: "Update Invoice: MRI" summary: "Update Invoice: MRI" tags: - invoices security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the invoice required: true description: The Propexo unique identifier for the invoice name: invoice_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_invoices_mri_{invoice_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_invoices_mri_{invoice_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/invoices/rentmanager/: post: description: |- Create Invoice: Rent Manager This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately. summary: "Create Invoice: Rent Manager" tags: - invoices security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_invoices_rentmanager__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_invoices_rentmanager__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/payable-registers/cancel/yardi: post: description: |- Cancel Payable Register: Yardi Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Cancel Payable Register: Yardi" tags: - invoices security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_payable-registers_cancel_yardi_post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_payable-registers_cancel_yardi_post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/payable-registers/cancel/yardi_rest: post: description: "Cancel Payable Register: Yardi REST" summary: "Cancel Payable Register: Yardi REST" tags: - invoices security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_payable-registers_cancel_yardi_rest_post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_payable-registers_cancel_yardi_rest_post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/payable-registers/yardi/: post: description: |- Create Payable Register: Yardi Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Payable Register: Yardi" tags: - invoices security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_payable-registers_yardi__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_payable-registers_yardi__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/payable-registers/yardi/{payable_register_id}: put: description: Yardi does not support updating a payable register via their API. This endpoint will always return a 405, with an error message specifying that updating a payable register in a Yardi integration is not supported due to the lack of upstream support. summary: "Update Payable Register: Yardi - Not Supported" tags: - invoices security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: payable_register_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_payable-registers_yardi_{payable_register_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_payable-registers_yardi_{payable_register_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/payable-registers/yardi_rest/: post: description: |- Create Payable Register: Yardi REST Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Payable Register: Yardi REST" tags: - invoices security: - bearerAuth: [] x-fern-availability: beta requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_payable-registers_yardi_rest__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_payable-registers_yardi_rest__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/payable-registers/yardi/{payable_register_id}/file-upload: post: description: |- Create Payable Register File: Yardi. This endpoint will only accept png image files. Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Payable Register File (file upload): Yardi" tags: - invoices security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the payable register required: true description: The Propexo unique identifier for the payable register name: payable_register_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_payable-registers_yardi_{payable_register_id}_file-upload_post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_payable-registers_yardi_{payable_register_id}_file-upload_post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/payable-registers/yardi_rest/{payable_register_id}/file-upload: post: description: |- Create Payable Register File: Yardi REST. This endpoint will only accept png image files. Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Payable Register File (file upload): Yardi REST" tags: - invoices security: - bearerAuth: [] x-fern-availability: beta parameters: - schema: type: string description: The Propexo unique identifier for the payable register required: true description: The Propexo unique identifier for the payable register name: payable_register_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_payable-registers_yardi_rest_{payable_register_id}_file-upload_post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_payable-registers_yardi_rest_{payable_register_id}_file-upload_post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/leads/: get: description: Get all leads summary: Get all leads tags: - leads security: - bearerAuth: [] parameters: - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query - schema: type: string description: The external lead id required: false description: The external lead id name: x_id in: query - schema: type: string description: "Deprecated: Use the Propexo property_id instead" deprecated: true required: false description: "Deprecated: Use the Propexo property_id instead" name: x_property_id in: query - schema: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. required: false description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: location_id in: query - schema: type: string description: The external unit id required: false description: The external unit id name: x_unit_id in: query - schema: type: string description: Lead email address required: false description: Lead email address name: email_1 in: query - schema: type: string description: Lead email address alternate required: false description: Lead email address alternate name: email_2 in: query - schema: type: string description: The Propexo property id required: false description: The Propexo property id name: property_id in: query - schema: type: string description: The Propexo integration id required: false description: The Propexo integration id name: integration_id in: query - schema: type: string enum: *a289 description: The integration vendor for the lead. required: false description: The integration vendor for the lead. name: integration_vendor in: query - schema: type: string pattern: ^[2-9]\d{9}$ description: Filter by phone number (10 digit format only) required: false description: Filter by phone number (10 digit format only) name: phone_1 in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_leads__get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" post: description: Create a lead for an integration. summary: Create lead tags: - leads security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_leads__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_leads__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/leads/{id}: get: description: Get a lead by ID summary: Get a lead by ID tags: - leads security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: id in: path - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_leads_{id}_get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" put: description: Update a lead. summary: Update lead tags: - leads security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_leads_{id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_leads_{id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/lead-relationships/: get: description: Get all lead relationships summary: Get all lead relationships tags: - leads security: - bearerAuth: [] parameters: - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query - schema: type: string description: The external ID from the integration vendor required: false description: The external ID from the integration vendor name: x_id in: query - schema: type: string description: The external ID of the property from the integration vendor required: false description: The external ID of the property from the integration vendor name: x_property_id in: query - schema: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. required: false description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: location_id in: query - schema: type: string description: The Propexo unique identifier for the property required: false description: The Propexo unique identifier for the property name: property_id in: query - schema: type: string description: The Propexo unique identifier for the integration required: false description: The Propexo unique identifier for the integration name: integration_id in: query - schema: type: string enum: *a287 description: The property management system of record required: false description: The property management system of record name: integration_vendor in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_lead-relationships__get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/lead-sources/: get: description: Get all lead sources summary: Get all lead sources tags: - leads security: - bearerAuth: [] parameters: - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query - schema: type: string description: The external ID from the integration vendor required: false description: The external ID from the integration vendor name: x_id in: query - schema: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. required: false description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: location_id in: query - schema: type: string description: The Propexo unique identifier for the property required: false description: The Propexo unique identifier for the property name: property_id in: query - schema: type: string description: The Propexo unique identifier for the integration required: false description: The Propexo unique identifier for the integration name: integration_id in: query - schema: type: string enum: *a287 description: The property management system of record required: false description: The property management system of record name: integration_vendor in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_lead-sources__get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/lead-sources/{lead_source_id}: get: description: Get lead source by ID summary: Get lead source by ID tags: - leads security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: lead_source_id in: path - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_lead-sources_{lead_source_id}_get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/leads/{id}/rentable-items: get: description: Get all rentable items associated with a specific lead summary: Get rentable items for a lead tags: - leads security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: id in: path - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query - schema: type: string description: The external ID from the integration vendor required: false description: The external ID from the integration vendor name: x_id in: query - schema: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. required: false description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: location_id in: query - schema: type: string description: The Propexo unique identifier for the property required: false description: The Propexo unique identifier for the property name: property_id in: query - schema: type: string description: The Propexo unique identifier for the integration required: false description: The Propexo unique identifier for the integration name: integration_id in: query - schema: type: string enum: *a287 description: The property management system of record required: false description: The property management system of record name: integration_vendor in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_leads_{id}_rentable-items_get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/leads/appfolio/: post: description: |- Create Lead: AppFolio This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately. summary: "Create Lead: AppFolio" tags: - leads security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_leads_appfolio__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_leads_appfolio__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/leads/appfolio/{lead_id}: put: description: "Update Lead: AppFolio" summary: "Update Lead: AppFolio" tags: - leads security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: lead_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_leads_appfolio_{lead_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_leads_appfolio_{lead_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/leads/buildium/: post: description: Buildium does not support creating a lead via their API. This endpoint will always return a 405, with an error message specifying that creating a lead in a Buildium integration is not supported due to the lack of upstream support. summary: "Create Lead: Buildium - Not Supported" tags: - leads security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_leads_buildium__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_leads_buildium__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/leads/buildium/{lead_id}: put: description: Buildium does not support updating a lead via their API. This endpoint will always return a 405, with an error message specifying that updating a lead in a Buildium integration is not supported due to the lack of upstream support. summary: "Update Lead: Buildium - Not Supported" tags: - leads security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: lead_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_leads_buildium_{lead_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_leads_buildium_{lead_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/leads/mri/: post: description: |- Create a lead in MRI. This will create a prospect record in MRI with the applicant type. This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately. summary: "Create Lead: MRI" tags: - leads security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_leads_mri__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_leads_mri__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/leads/mri/{lead_id}: put: description: "Update Lead: MRI" summary: "Update Lead: MRI" tags: - leads security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the lead required: true description: The Propexo unique identifier for the lead name: lead_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_leads_mri_{lead_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_leads_mri_{lead_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/leads/realpage/: post: description: |- Create Lead: Realpage This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately. summary: "Create Lead: Realpage" tags: - leads security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_leads_realpage__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_leads_realpage__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/leads/realpage/{id}: put: description: "Update Lead: Realpage" summary: "Update Lead: Realpage" tags: - leads security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the lead required: true description: The Propexo unique identifier for the lead name: id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_leads_realpage_{id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_leads_realpage_{id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/leads/realpage_rpx/: post: description: |- Create Lead: RealPage Partner Exchange Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Lead: RealPage Partner Exchange" tags: - leads security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_leads_realpage_rpx__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_leads_realpage_rpx__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/leads/realpage_rpx/{lead_id}: put: description: "Update Lead: RealPage Partner Exchange" summary: "Update Lead: RealPage Partner Exchange" tags: - leads security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the lead required: true description: The Propexo unique identifier for the lead name: lead_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_leads_realpage_rpx_{lead_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_leads_realpage_rpx_{lead_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/leads/resman/: post: description: |- Create Lead: ResMan This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately. summary: "Create Lead: ResMan" tags: - leads security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_leads_resman__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_leads_resman__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/leads/resman/{lead_id}: put: description: "Update Lead: ResMan" summary: "Update Lead: ResMan" tags: - leads security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the lead required: true description: The Propexo unique identifier for the lead name: lead_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_leads_resman_{lead_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_leads_resman_{lead_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/leads/yardi/: post: description: |- Create Lead: Yardi. When creating an lead along with an event, Propexo will create a base event of type "Other" as an initial lead event. If the event is one of the valid "first contact" events in Yardi (such as Other, WalkIn, Chat, Email, Text, Webservice), then Propexo will create the lead with the associated "first contact" event type. This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately. summary: "Create Lead: Yardi" tags: - leads security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_leads_yardi__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_leads_yardi__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/leads/yardi/{lead_id}: put: description: "Update Lead: Yardi" summary: "Update Lead: Yardi" tags: - leads security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the lead required: true description: The Propexo unique identifier for the lead name: lead_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_leads_yardi_{lead_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_leads_yardi_{lead_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/leads/propertyware/: post: description: |- Create Lead: Propertyware This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately. summary: "Create Lead: Propertyware" tags: - leads security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_leads_propertyware__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_leads_propertyware__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/leads/propertyware/{lead_id}: put: description: "Update Lead: Propertyware" summary: "Update Lead: Propertyware" tags: - leads security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the lead required: true description: The Propexo unique identifier for the lead name: lead_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_leads_propertyware_{lead_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_leads_propertyware_{lead_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/leads/entrata/: post: description: |- Create Lead: Entrata Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Lead: Entrata" tags: - leads security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_leads_entrata__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_leads_entrata__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/leads/entrata/{lead_id}: put: description: "Update Lead: Entrata" summary: "Update Lead: Entrata" tags: - leads security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the lead required: true description: The Propexo unique identifier for the lead name: lead_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_leads_entrata_{lead_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_leads_entrata_{lead_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/leads/rentmanager/: post: description: |- Create Lead: Rent Manager This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately. summary: "Create Lead: Rent Manager" tags: - leads security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_leads_rentmanager__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_leads_rentmanager__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/leads/rentmanager/{lead_id}: put: description: "Update Lead: Rent Manager" summary: "Update Lead: Rent Manager" tags: - leads security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: lead_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_leads_rentmanager_{lead_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_leads_rentmanager_{lead_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/applicants/rentmanager/{applicant_id}/notes: post: description: |- Create Applicant Note: Rent Manager Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Applicant Note: Rent Manager" tags: - leads security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: applicant_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_applicants_rentmanager_{applicant_id}_notes_post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_applicants_rentmanager_{applicant_id}_notes_post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/leads/yardi/{lead_id}/file-upload: post: description: |- Attach a file to a Lead. Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Lead File: Yardi" tags: - leads security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the lead required: true description: The Propexo unique identifier for the lead name: lead_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_leads_yardi_{lead_id}_file-upload_post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_leads_yardi_{lead_id}_file-upload_post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/leads/entrata/{lead_id}/file-upload: post: description: |- Create Lead Files: Entrata Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Lead Files: Entrata" tags: - leads security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the lead required: true description: The Propexo unique identifier for the lead name: lead_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_leads_entrata_{lead_id}_file-upload_post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_leads_entrata_{lead_id}_file-upload_post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/leads/rentmanager/{lead_id}/notes: post: description: |- Note: In the case of a failed file upload, we will attempt to upload the file again if we receive a 500 runtime error from Rent Manager. If the file is still not uploaded, we will return an error. Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Lead Note: Rent Manager" tags: - leads security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: lead_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_leads_rentmanager_{lead_id}_notes_post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_leads_rentmanager_{lead_id}_notes_post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/leases/: get: description: Get all leases summary: Get all leases tags: - leases security: - bearerAuth: [] parameters: - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query - schema: type: string description: The external lease id required: false description: The external lease id name: x_id in: query - schema: type: string description: "Deprecated: Use the Propexo property_id instead" deprecated: true required: false description: "Deprecated: Use the Propexo property_id instead" name: x_property_id in: query - schema: type: string description: "Deprecated: Use the Propexo unit_id instead" deprecated: true required: false description: "Deprecated: Use the Propexo unit_id instead" name: x_unit_id in: query - schema: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. required: false description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: location_id in: query - schema: type: string description: The Propexo unique identifier for the unit required: false description: The Propexo unique identifier for the unit name: unit_id in: query - schema: type: string description: The Propexo unique identifier for the resident. If you use this filter in conjunction with one of the move-in/move-out date filters, it will not be honored and will be overridden by the date filter. required: false description: The Propexo unique identifier for the resident. If you use this filter in conjunction with one of the move-in/move-out date filters, it will not be honored and will be overridden by the date filter. name: resident_id in: query - schema: type: string description: The Propexo unique identifier for the property required: false description: The Propexo unique identifier for the property name: property_id in: query - schema: type: string description: The Propexo unique identifier for the integration required: false description: The Propexo unique identifier for the integration name: integration_id in: query - schema: type: - string - "null" description: "Filter to residents moving in before this date. Format: YYYY-MM-DD. Date filter combinations will act with AND logic on a single record." required: false description: "Filter to residents moving in before this date. Format: YYYY-MM-DD. Date filter combinations will act with AND logic on a single record." name: before_move_in_date in: query - schema: type: - string - "null" description: "Filter to residents moving in after this date. Format: YYYY-MM-DD. Date filter combinations will act with AND logic on a single record." required: false description: "Filter to residents moving in after this date. Format: YYYY-MM-DD. Date filter combinations will act with AND logic on a single record." name: after_move_in_date in: query - schema: type: - string - "null" description: "Filter to residents moving out before this date. Format: YYYY-MM-DD. Date filter combinations will act with AND logic on a single record." required: false description: "Filter to residents moving out before this date. Format: YYYY-MM-DD. Date filter combinations will act with AND logic on a single record." name: before_move_out_date in: query - schema: type: - string - "null" description: "Filter to residents moving out after this date. Format: YYYY-MM-DD. Date filter combinations will act with AND logic on a single record." required: false description: "Filter to residents moving out after this date. Format: YYYY-MM-DD. Date filter combinations will act with AND logic on a single record." name: after_move_out_date in: query - schema: anyOf: - type: boolean - type: string description: Filter to only return leases where the move-out date is null required: false description: Filter to only return leases where the move-out date is null name: only_null_move_outs in: query - schema: type: string enum: *a287 description: The property management system of record required: false description: The property management system of record name: integration_vendor in: query - schema: type: string enum: - ACTIVE - INACTIVE - OTHER - PENDING - EVICTED description: The normalized status for the lease required: false description: The normalized status for the lease name: status_normalized in: query - schema: type: string description: The raw status associated with the lease required: false description: The raw status associated with the lease name: status_raw in: query - schema: type: string description: The unit number of the lease. When using this, the Propexo `property_id` filter must be added as well. required: false description: The unit number of the lease. When using this, the Propexo `property_id` filter must be added as well. name: unit_number in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_leases__get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" post: description: Create a lease for an integration. summary: Create lease tags: - leases security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_leases__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_leases__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/leases/{lease_id}: get: description: Get a lease by ID summary: Get a lease by ID tags: - leases security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: lease_id in: path - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_leases_{lease_id}_get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" put: description: Update a lease for an integration. summary: Update lease tags: - leases security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: lease_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_leases_{lease_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_leases_{lease_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/lease-transfers/: get: description: Get all Lease Transfers summary: Get all Lease Transfers tags: - leases security: - bearerAuth: [] parameters: - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query - schema: type: string description: The external ID from the integration vendor required: false description: The external ID from the integration vendor name: x_id in: query - schema: type: string description: The external ID of the property from the integration vendor required: false description: The external ID of the property from the integration vendor name: x_property_id in: query - schema: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. required: false description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: location_id in: query - schema: type: string description: The Propexo unique identifier for the property required: false description: The Propexo unique identifier for the property name: property_id in: query - schema: type: string description: The Propexo unique identifier for the resident required: false description: The Propexo unique identifier for the resident name: resident_id in: query - schema: type: string description: The Propexo unique identifier for the next lease required: false description: The Propexo unique identifier for the next lease name: lease_id_next in: query - schema: type: string description: The Propexo unique identifier for the previous lease required: false description: The Propexo unique identifier for the previous lease name: lease_id_previous in: query - schema: type: string description: The Propexo unique identifier for the next unit required: false description: The Propexo unique identifier for the next unit name: unit_id_next in: query - schema: type: string description: The Propexo unique identifier for the previous unit required: false description: The Propexo unique identifier for the previous unit name: unit_id_previous in: query - schema: type: string description: The Propexo unique identifier for the integration required: false description: The Propexo unique identifier for the integration name: integration_id in: query - schema: type: string enum: *a287 description: The property management system of record required: false description: The property management system of record name: integration_vendor in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_lease-transfers__get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/lease-transfers/{lease_transfer_id}: get: description: Get Lease Transfer by ID summary: Get Lease Transfer by ID tags: - leases security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: lease_transfer_id in: path - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_lease-transfers_{lease_transfer_id}_get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/lease-periods/: get: description: Get all lease periods summary: Get all lease periods tags: - leases security: - bearerAuth: [] parameters: - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query - schema: type: string description: The external ID from the integration vendor required: false description: The external ID from the integration vendor name: x_id in: query - schema: type: string description: The external ID of the property from the integration vendor required: false description: The external ID of the property from the integration vendor name: x_property_id in: query - schema: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. required: false description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: location_id in: query - schema: type: string description: The Propexo unique identifier for the property required: false description: The Propexo unique identifier for the property name: property_id in: query - schema: type: string description: The Propexo unique identifier for the integration required: false description: The Propexo unique identifier for the integration name: integration_id in: query - schema: type: string enum: *a287 description: The property management system of record required: false description: The property management system of record name: integration_vendor in: query - schema: type: string description: The Propexo unique identifier for the application template required: false description: The Propexo unique identifier for the application template name: application_template_id in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_lease-periods__get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/lease-periods/{lease_period_id}: get: description: Get lease period by ID summary: Get lease period by ID tags: - leases security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: lease_period_id in: path - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_lease-periods_{lease_period_id}_get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/leases/buildium/: post: description: |- Create Lease: Buildium This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately. summary: "Create Lease: Buildium" tags: - leases security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_leases_buildium__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_leases_buildium__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/leases/buildium/{lease_id}: put: description: "Update Lease: Buildium" summary: "Update Lease: Buildium" tags: - leases security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: lease_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_leases_buildium_{lease_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_leases_buildium_{lease_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/leases/entrata/: post: description: |- Create Lease: Entrata This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately. summary: "Create Lease: Entrata" tags: - leases security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_leases_entrata__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_leases_entrata__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/leases/entrata/{lease_id}: put: description: "Update Lease: Entrata" summary: "Update Lease: Entrata" tags: - leases security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the lease required: true description: The Propexo unique identifier for the lease name: lease_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_leases_entrata_{lease_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_leases_entrata_{lease_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/leases/realpage/: post: description: Realpage does not support creating a lease via their API. This endpoint will always return a 405, with an error message specifying that creating a lease in a Realpage integration is not supported due to the lack of upstream support. summary: "Create Lease: Realpage - Not Supported" tags: - leases security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_leases_realpage__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_leases_realpage__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/leases/realpage/{lease_id}: put: description: Realpage does not support updating a lease via their API. This endpoint will always return a 405, with an error message specifying that updating a lease in a Realpage integration is not supported due to the lack of upstream support. summary: "Update Lease: Realpage - Not Supported" tags: - leases security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: lease_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_leases_realpage_{lease_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_leases_realpage_{lease_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/leases/realpage_rpx/: post: description: RealPageApp does not support creating a lease via their API. This endpoint will always return a 405, with an error message specifying that creating a lease in a RealPageApp integration is not supported due to the lack of upstream support. summary: "Create Lease: RealPageApp - Not Supported" tags: - leases security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_leases_realpage_rpx__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_leases_realpage_rpx__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/leases/realpage_rpx/{lease_id}: put: description: RealPageApp does not support updating a lease via their API. This endpoint will always return a 405, with an error message specifying that updating a lease in a RealPageApp integration is not supported due to the lack of upstream support. summary: "Update Lease: RealPageApp - Not Supported" tags: - leases security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: lease_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_leases_realpage_rpx_{lease_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_leases_realpage_rpx_{lease_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/leases/rentmanager/: post: description: |- Create Lease: Rent Manager This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately. summary: "Create Lease: Rent Manager" tags: - leases security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_leases_rentmanager__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_leases_rentmanager__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/leases/rentmanager/{lease_id}: put: description: "Update Lease: Rent Manager" summary: "Update Lease: Rent Manager" tags: - leases security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the lease required: true description: The Propexo unique identifier for the lease name: lease_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_leases_rentmanager_{lease_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_leases_rentmanager_{lease_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/leases/rentvine/: post: description: |- Create Lease: Rentvine This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately. summary: "Create Lease: Rentvine" tags: - leases security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_leases_rentvine__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_leases_rentvine__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/leases/rentvine/{lease_id}: put: description: "Update Lease: Rentvine" summary: "Update Lease: Rentvine" tags: - leases security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the lease required: true description: The Propexo unique identifier for the lease name: lease_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_leases_rentvine_{lease_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_leases_rentvine_{lease_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/leases/yardi/{lease_id}: put: description: "Update Lease: Yardi" summary: "Update Lease: Yardi" tags: - leases security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the lease required: true description: The Propexo unique identifier for the lease name: lease_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_leases_yardi_{lease_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_leases_yardi_{lease_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/leases/yardi/: post: description: |- Create Lease: Yardi This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately. summary: "Create Lease: Yardi" tags: - leases security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_leases_yardi__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_leases_yardi__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/leases/propertyware/{lease_id}: put: description: "Update Lease: Propertyware" summary: "Update Lease: Propertyware" tags: - leases security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the lease required: true description: The Propexo unique identifier for the lease name: lease_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_leases_propertyware_{lease_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_leases_propertyware_{lease_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/leases/propertyware/: post: description: |- Create Lease: Propertyware This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately. summary: "Create Lease: Propertyware" tags: - leases security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_leases_propertyware__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_leases_propertyware__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/leases/propertyware_rest/{lease_id}: put: description: "Update Lease: Propertyware REST" summary: "Update Lease: Propertyware REST" tags: - leases security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: lease_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_leases_propertyware_rest_{lease_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_leases_propertyware_rest_{lease_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/leases/mri/: post: description: MRI does not support creating a lease via their API. This endpoint will always return a 405, with an error message specifying that creating a lease in a MRI integration is not supported due to the lack of upstream support.MRI does not provide a way to create the majority of data on leases with their MIX APIs. This is available through their developer APIs, but the developer APIs are recommended to be avoided by integrating systems due to their unchecked data entry that can lead to system corruption. summary: "Create Lease: MRI - Not Supported" tags: - leases security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_leases_mri__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_leases_mri__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/leases/mri/{lease_id}: put: description: MRI does not support updating a lease via their API. This endpoint will always return a 405, with an error message specifying that updating a lease in a MRI integration is not supported due to the lack of upstream support.MRI does not provide a way to update the majority of data on leases with their MIX APIs. This is available through their developer APIs, but the developer APIs are recommended to be avoided by integrating systems due to their unchecked data entry that can lead to system corruption. summary: "Update Lease: MRI - Not Supported" tags: - leases security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: lease_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_leases_mri_{lease_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_leases_mri_{lease_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/leases/resman/: post: description: ResMan does not support creating a lease via their API. This endpoint will always return a 405, with an error message specifying that creating a lease in a ResMan integration is not supported due to the lack of upstream support. ResMan does not provide a way to create a finalized lease with their API. If you need to create a lease, you must create an application first, and then finalize it in the ResMan portal. summary: "Create Lease: ResMan - Not Supported" tags: - leases security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_leases_resman__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_leases_resman__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/leases/resman/{lease_id}: put: description: "Update Lease: ResMan" summary: "Update Lease: ResMan" tags: - leases security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the lease required: true description: The Propexo unique identifier for the lease name: lease_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_leases_resman_{lease_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_leases_resman_{lease_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/invoices/resman/{invoice_id}/file-upload: post: description: ResMan does not support creating a lease file via their API. This endpoint will always return a 405, with an error message specifying that creating a lease file in a ResMan integration is not supported due to the lack of upstream support. summary: "Create Lease file: ResMan - Not Supported" tags: - leases security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: invoice_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_invoices_resman_{invoice_id}_file-upload_post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_invoices_resman_{invoice_id}_file-upload_post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/leases/rentmanager/{lease_id}/custom-data: post: description: |- Create Lease Custom Data: Rent Manager Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Lease Custom Data: Rent Manager" tags: - leases security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the lease required: true description: The Propexo unique identifier for the lease name: lease_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_leases_rentmanager_{lease_id}_custom-data_post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_leases_rentmanager_{lease_id}_custom-data_post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" put: description: The custom data fields given in this payload must already exist on the lease. summary: "Update Lease Custom Data: Rent Manager" tags: - leases security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the lease required: true description: The Propexo unique identifier for the lease name: lease_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_leases_rentmanager_{lease_id}_custom-data_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_leases_rentmanager_{lease_id}_custom-data_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/leases/rentvine/{lease_id}/custom-data: put: description: The custom data fields must first be provisioned by the customer on the property object before they can be set by this API route. At this time, Propexo does not support a way to provision new custom fields or modify the schema for existing custom fields via an API. Please contact Propexo support if this is required for your business case. summary: "Update Lease Custom Data: Rentvine" tags: - leases security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the lease required: true description: The Propexo unique identifier for the lease name: lease_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_leases_rentvine_{lease_id}_custom-data_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_leases_rentvine_{lease_id}_custom-data_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/leases/propertyware_rest/{lease_id}/custom-data: put: description: The custom data fields given in this payload must already exist on the lease. At this time, Propertyware REST does not support a way to create custom fields initially via the API. summary: "Update Lease Custom Data: Propertyware REST" tags: - leases security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the lease required: true description: The Propexo unique identifier for the lease name: lease_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_leases_propertyware_rest_{lease_id}_custom-data_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_leases_propertyware_rest_{lease_id}_custom-data_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/leases/buildium/{lease_id}/file-upload/: post: description: |- Create Lease Files: Buildium Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Lease Files: Buildium" tags: - leases security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: lease_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_leases_buildium_{lease_id}_file-upload__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_leases_buildium_{lease_id}_file-upload__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/leases/entrata/{lease_id}/file-upload/: post: description: |- Create Lease Files: Entrata Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Lease Files: Entrata" tags: - leases security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the lease required: true description: The Propexo unique identifier for the lease name: lease_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_leases_entrata_{lease_id}_file-upload__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_leases_entrata_{lease_id}_file-upload__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/leases/rentmanager/{lease_id}/file-upload/: post: description: Rent Manager does not support creating a lease file via their API. This endpoint will always return a 405, with an error message specifying that creating a lease file in a Rent Manager integration is not supported due to the lack of upstream support. summary: "Create Lease file: Rent Manager - Not Supported" tags: - leases security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: lease_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_leases_rentmanager_{lease_id}_file-upload__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_leases_rentmanager_{lease_id}_file-upload__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/leases/rentvine/{lease_id}/file-upload/: post: description: |- Create Lease File: Rentvine Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Lease File: Rentvine" tags: - leases security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the lease required: true description: The Propexo unique identifier for the lease name: lease_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_leases_rentvine_{lease_id}_file-upload__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_leases_rentvine_{lease_id}_file-upload__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/leases/yardi/{lease_id}/file-upload/: post: description: Yardi does not support creating a lease file via their API. This endpoint will always return a 405, with an error message specifying that creating a lease file in a Yardi integration is not supported due to the lack of upstream support. Fortunately, due to the way that Yardi represents Residents and Leases in the UI, we would recommend you instead use the Create Resident File endpoint as the next best option. summary: "Create Lease file: Yardi - Not Supported" tags: - leases security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: lease_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_leases_yardi_{lease_id}_file-upload__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_leases_yardi_{lease_id}_file-upload__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/leases/propertyware/{lease_id}/file-upload/: post: description: |- Create Lease File: Propertyware Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Lease File: Propertyware" tags: - leases security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: lease_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_leases_propertyware_{lease_id}_file-upload__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_leases_propertyware_{lease_id}_file-upload__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/leases/propertyware_rest/{lease_id}/file-upload/: post: description: |- Attach a file to a lease. Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Lease File: Propertyware REST" tags: - leases security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the lease required: true description: The Propexo unique identifier for the lease name: lease_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_leases_propertyware_rest_{lease_id}_file-upload__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_leases_propertyware_rest_{lease_id}_file-upload__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/listings/: get: description: Get all listings summary: Get all listings tags: - listings security: - bearerAuth: [] parameters: - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query - schema: type: string description: The external listing id required: false description: The external listing id name: x_id in: query - schema: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. required: false description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: location_id in: query - schema: type: string description: The Propexo unique identifier for the unit required: false description: The Propexo unique identifier for the unit name: unit_id in: query - schema: type: string description: The Propexo unique identifier for the property required: false description: The Propexo unique identifier for the property name: property_id in: query - schema: type: string description: The Propexo integration id required: false description: The Propexo integration id name: integration_id in: query - schema: type: string enum: *a290 description: The integration vendor for the listing. required: false description: The integration vendor for the listing. name: integration_vendor in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_listings__get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" post: description: Create a listing for an integration. summary: "*Create listing" tags: - listings security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_listings__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_listings__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/listings/pricing: get: description: Get all pricing summary: Get all pricing tags: - listings security: - bearerAuth: [] parameters: - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query - schema: type: string description: The external listing id required: false description: The external listing id name: x_id in: query - schema: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. required: false description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: location_id in: query - schema: type: string description: The Propexo unique identifier for the listing required: false description: The Propexo unique identifier for the listing name: listing_id in: query - schema: type: string description: The Propexo unique identifier for the property required: false description: The Propexo unique identifier for the property name: property_id in: query - schema: type: string description: The Propexo integration id required: false description: The Propexo integration id name: integration_id in: query - schema: type: string enum: *a290 description: The integration vendor for the listing. required: false description: The integration vendor for the listing. name: integration_vendor in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_listings_pricing_get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/listings/{listing_id}: get: description: Get a listing by ID summary: Get a listing by ID tags: - listings security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: listing_id in: path - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_listings_{listing_id}_get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" put: description: Update a listing for an integration. summary: Update listing tags: - listings security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: listing_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_listings_{listing_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_listings_{listing_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/listings/yardi/{listing_id}: put: description: Yardi does not support updating a listing via their API. This endpoint will always return a 405, with an error message specifying that updating a listing in a Yardi integration is not supported due to the lack of upstream support. summary: "Update Listing: Yardi - Not Supported" tags: - listings security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: listing_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_listings_yardi_{listing_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_listings_yardi_{listing_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/listings/yardi/: post: description: Yardi does not support creating a listing via their API. This endpoint will always return a 405, with an error message specifying that creating a listing in a Yardi integration is not supported due to the lack of upstream support. summary: "Create Listing: Yardi - Not Supported" tags: - listings security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_listings_yardi__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_listings_yardi__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/listings/realpage_rpx/{listing_id}: put: description: RealPageApp does not support updating a listing via their API. This endpoint will always return a 405, with an error message specifying that updating a listing in a RealPageApp integration is not supported due to the lack of upstream support. summary: "Update Listing: RealPageApp - Not Supported" tags: - listings security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: listing_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_listings_realpage_rpx_{listing_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_listings_realpage_rpx_{listing_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/listings/realpage_rpx/: post: description: RealPageApp does not support creating a listing via their API. This endpoint will always return a 405, with an error message specifying that creating a listing in a RealPageApp integration is not supported due to the lack of upstream support. summary: "Create Listing: RealPageApp - Not Supported" tags: - listings security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_listings_realpage_rpx__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_listings_realpage_rpx__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/listings/entrata/{listing_id}: put: description: Entrata does not support updating a listing via their API. This endpoint will always return a 405, with an error message specifying that updating a listing in an Entrata integration is not supported due to the lack of upstream support. summary: "Update Listing: Entrata - Not Supported" tags: - listings security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: listing_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_listings_entrata_{listing_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_listings_entrata_{listing_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/listings/entrata/: post: description: |- Create Listing: Entrata This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately. summary: "Create Listing: Entrata" tags: - listings security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_listings_entrata__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_listings_entrata__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/listings/propertyware/{listing_id}: put: description: "Update Listing: Propertyware" summary: "Update Listing: Propertyware" tags: - listings security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the listing required: true description: The Propexo unique identifier for the listing name: listing_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_listings_propertyware_{listing_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_listings_propertyware_{listing_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/listings/entrata/{listing_id}/file-upload/: post: description: Entrata does not support creating a listing via their API. This endpoint will always return a 405, with an error message specifying that creating a listing in an Entrata integration is not supported due to the lack of upstream support. summary: "Create Listing: Entrata - Not Supported" tags: - listings security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: listing_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_listings_entrata_{listing_id}_file-upload__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_listings_entrata_{listing_id}_file-upload__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/locations/rentmanager/: get: description: "Get all locations: Rent Manager" summary: "Get all locations: Rent Manager" tags: - locations security: - bearerAuth: [] parameters: - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query - schema: type: string description: The external location id required: false description: The external location id name: x_id in: query - schema: type: string description: The Propexo integration id required: false description: The Propexo integration id name: integration_id in: query - schema: type: string enum: *a291 description: The integration vendor for the location. required: false description: The integration vendor for the location. name: integration_vendor in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_locations_rentmanager__get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/note-categories/: get: description: Get all Note Categories summary: Get all Note Categories tags: - note-categories security: - bearerAuth: [] parameters: - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query - schema: type: string description: The external ID from the integration vendor required: false description: The external ID from the integration vendor name: x_id in: query - schema: type: string description: The external ID of the property from the integration vendor required: false description: The external ID of the property from the integration vendor name: x_property_id in: query - schema: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. required: false description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: location_id in: query - schema: type: string description: The Propexo unique identifier for the property required: false description: The Propexo unique identifier for the property name: property_id in: query - schema: type: string description: The Propexo unique identifier for the integration required: false description: The Propexo unique identifier for the integration name: integration_id in: query - schema: type: string enum: *a287 description: The property management system of record required: false description: The property management system of record name: integration_vendor in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_note-categories__get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/note-categories/{note_category_id}: get: description: Get Note Category by ID summary: Get Note Category by ID tags: - note-categories security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: note_category_id in: path - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_note-categories_{note_category_id}_get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/owners/: get: description: Get all owners summary: Get all owners tags: - owners security: - bearerAuth: [] parameters: - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query - schema: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. required: false description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: location_id in: query - schema: type: string description: The Propexo unique identifier for the property required: false description: The Propexo unique identifier for the property name: property_id in: query - schema: type: string description: The Propexo unique identifier for the integration required: false description: The Propexo unique identifier for the integration name: integration_id in: query - schema: type: string enum: *a287 description: The property management system of record required: false description: The property management system of record name: integration_vendor in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_owners__get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/owners/{owner_id}: get: description: Get an owner by ID summary: Get an owner by ID tags: - owners security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: owner_id in: path - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_owners_{owner_id}_get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/properties/: get: description: Get all properties summary: Get all properties tags: - properties security: - bearerAuth: [] parameters: - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query - schema: type: string description: The external property id required: false description: The external property id name: x_id in: query - schema: type: string description: "Deprecated: Use x_id instead" deprecated: true required: false description: "Deprecated: Use x_id instead" name: x_property_id in: query - schema: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. required: false description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: location_id in: query - schema: type: string description: The Propexo integration id required: false description: The Propexo integration id name: integration_id in: query - schema: type: string enum: *a292 description: The integration vendor for the property. required: false description: The integration vendor for the property. name: integration_vendor in: query - schema: anyOf: - type: boolean - type: string - type: "null" description: Active status of the property in the PMS. Please note this is a separate value to the property's status in Propexo which can be fetched using the 'Get all my property configurations' endpoint. required: false description: Active status of the property in the PMS. Please note this is a separate value to the property's status in Propexo which can be fetched using the 'Get all my property configurations' endpoint. name: is_active in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_properties__get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" post: description: Create a property for an integration. summary: Create property tags: - properties security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_properties__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_properties__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/properties/{id}: get: description: Get a property by ID summary: Get a property by ID tags: - properties security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: id in: path - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_properties_{id}_get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" put: description: Update a property for an integration. summary: Update property tags: - properties security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_properties_{id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_properties_{id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/rentable-items/: get: description: Get all rentable items summary: Get all rentable items tags: - properties security: - bearerAuth: [] parameters: - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query - schema: type: string description: The external ID from the integration vendor required: false description: The external ID from the integration vendor name: x_id in: query - schema: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. required: false description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: location_id in: query - schema: type: string description: The Propexo unique identifier for the property required: false description: The Propexo unique identifier for the property name: property_id in: query - schema: type: string description: The Propexo unique identifier for the integration required: false description: The Propexo unique identifier for the integration name: integration_id in: query - schema: type: string enum: *a287 description: The property management system of record required: false description: The property management system of record name: integration_vendor in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_rentable-items__get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/rentable-items/{rentable_item_id}: get: description: Get rentable item by ID summary: Get rentable item by ID tags: - properties security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: rentable_item_id in: path - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_rentable-items_{rentable_item_id}_get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/property-lists/: get: description: Get all property lists summary: Get all property lists tags: - properties security: - bearerAuth: [] parameters: - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query - schema: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. required: false description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: location_id in: query - schema: type: string description: "The Propexo unique identifier for the property. Note: This will filter for results only containing property lists that are associated with this property id" required: false description: "The Propexo unique identifier for the property. Note: This will filter for results only containing property lists that are associated with this property id" name: associated_property_id in: query - schema: type: string description: The Propexo unique identifier for the integration required: false description: The Propexo unique identifier for the integration name: integration_id in: query - schema: type: string enum: *a287 description: The property management system of record required: false description: The property management system of record name: integration_vendor in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_property-lists__get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/property-lists/{property_list_id}: get: description: Get a property list by ID summary: Get a property list by ID tags: - properties security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: property_list_id in: path - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_property-lists_{property_list_id}_get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/address-types/: get: description: Get all address types summary: Get all address types tags: - properties security: - bearerAuth: [] parameters: - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query - schema: type: string description: The external ID from the integration vendor required: false description: The external ID from the integration vendor name: x_id in: query - schema: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. required: false description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: location_id in: query - schema: type: string description: The Propexo unique identifier for the property required: false description: The Propexo unique identifier for the property name: property_id in: query - schema: type: string description: The Propexo unique identifier for the integration required: false description: The Propexo unique identifier for the integration name: integration_id in: query - schema: type: string enum: *a287 description: The property management system of record required: false description: The property management system of record name: integration_vendor in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_address-types__get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/address-types/{address_type_id}: get: description: Get address type by ID summary: Get address type by ID tags: - properties security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: address_type_id in: path - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_address-types_{address_type_id}_get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/properties/entrata/: post: description: Entrata does not support creating a property via their API. This endpoint will always return a 405, with an error message specifying that creating a property in an Entrata integration is not supported due to the lack of upstream support. summary: "Create Property: Entrata - Not Supported" tags: - properties security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_properties_entrata__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_properties_entrata__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/properties/entrata/{property_id}: put: description: Entrata does not support updating a property via their API. This endpoint will always return a 405, with an error message specifying that updating a property in an Entrata integration is not supported due to the lack of upstream support. summary: "Update Property: Entrata - Not Supported" tags: - properties security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: property_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_properties_entrata_{property_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_properties_entrata_{property_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/properties/realpage/: post: description: Realpage does not support creating a property via their API. This endpoint will always return a 405, with an error message specifying that creating a property in a Realpage integration is not supported due to the lack of upstream support. summary: "Create Property: Realpage - Not Supported" tags: - properties security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_properties_realpage__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_properties_realpage__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/properties/realpage/{property_id}: put: description: Realpage does not support updating a property via their API. This endpoint will always return a 405, with an error message specifying that updating a property in a Realpage integration is not supported due to the lack of upstream support. summary: "Update Property: Realpage - Not Supported" tags: - properties security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: property_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_properties_realpage_{property_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_properties_realpage_{property_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/properties/realpage_rpx/: post: description: RealPageApp does not support creating a property via their API. This endpoint will always return a 405, with an error message specifying that creating a property in a RealPageApp integration is not supported due to the lack of upstream support. summary: "Create Property: RealPageApp - Not Supported" tags: - properties security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_properties_realpage_rpx__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_properties_realpage_rpx__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/properties/realpage_rpx/{property_id}: put: description: RealPageApp does not support updating a property via their API. This endpoint will always return a 405, with an error message specifying that updating a property in a RealPageApp integration is not supported due to the lack of upstream support. summary: "Update Property: RealPageApp - Not Supported" tags: - properties security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: property_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_properties_realpage_rpx_{property_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_properties_realpage_rpx_{property_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/properties/yardi/{id}: put: description: Yardi does not support updating a property via their API. This endpoint will always return a 405, with an error message specifying that updating a property in a Yardi integration is not supported due to the lack of upstream support. summary: "Update Property: Yardi - Not Supported" tags: - properties security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_properties_yardi_{id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_properties_yardi_{id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/properties/yardi/: post: description: Yardi does not support creating a property via their API. This endpoint will always return a 405, with an error message specifying that creating a property in a Yardi integration is not supported due to the lack of upstream support. summary: "Create Property: Yardi - Not Supported" tags: - properties security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_properties_yardi__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_properties_yardi__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/properties/propertyware/{property_id}: put: description: "Update Property: Propertyware" summary: "Update Property: Propertyware" tags: - properties security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the property required: true description: The Propexo unique identifier for the property name: property_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_properties_propertyware_{property_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_properties_propertyware_{property_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/properties/propertyware/: post: description: |- Create Property: Propertyware Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Property: Propertyware" tags: - properties security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_properties_propertyware__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_properties_propertyware__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/properties/rentmanager/: post: description: Rent Manager does not support creating a property via their API. This endpoint will always return a 405, with an error message specifying that creating a property in a Rent Manager integration is not supported due to the lack of upstream support. summary: "Create Property: Rent Manager - Not Supported" tags: - properties security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_properties_rentmanager__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_properties_rentmanager__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/properties/rentmanager/{property_id}: put: description: Update a property in Rent Manager summary: "Update Property: Rent Manager" tags: - properties security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the property required: true description: The Propexo unique identifier for the property name: property_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_properties_rentmanager_{property_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_properties_rentmanager_{property_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/site-subscriptions/realpage_rpx/{property_id}: put: description: Update the subscription of a RealPage integration to a property. This modifies whether or not a property is being ingested during syncs. Only properties set to "ACTIVE" have data associated with them synced, aside from some minimal property specific data. This is only applicable to integrations that contain multiple properties. summary: "Update Site Subscription: RealPage Partner Exchange" tags: - properties security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the property required: true description: The Propexo unique identifier for the property name: property_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_site-subscriptions_realpage_rpx_{property_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_site-subscriptions_realpage_rpx_{property_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/properties/rentvine/{property_id}/custom-data: put: description: The custom data fields must first be provisioned by the customer on the property object before they can be set by this API route. At this time, Propexo does not support a way to provision new custom fields or modify the schema for existing custom fields via an API. Please contact Propexo support if this is required for your business case. summary: "Update Property Custom Data: Rentvine" tags: - properties security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the property required: true description: The Propexo unique identifier for the property name: property_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_properties_rentvine_{property_id}_custom-data_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_properties_rentvine_{property_id}_custom-data_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/properties/propertyware_rest/{property_id}/custom-data: put: description: The custom data fields given in this payload must already exist on the property. At this time, Propertyware REST does not support a way to create custom fields initially via the API. summary: "Update Property Custom Data: Propertyware REST" tags: - properties security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the property required: true description: The Propexo unique identifier for the property name: property_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_properties_propertyware_rest_{property_id}_custom-data_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_properties_propertyware_rest_{property_id}_custom-data_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/properties/rentmanager/{property_id}/custom-data: post: description: |- Create Property Custom Data: Rent Manager Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Property Custom Data: Rent Manager" tags: - properties security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the property required: true description: The Propexo unique identifier for the property name: property_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_properties_rentmanager_{property_id}_custom-data_post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_properties_rentmanager_{property_id}_custom-data_post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" put: description: The custom data fields given in this payload must already exist on the property. summary: "Update Property Custom Data: Rent Manager" tags: - properties security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the property required: true description: The Propexo unique identifier for the property name: property_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_properties_rentmanager_{property_id}_custom-data_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_properties_rentmanager_{property_id}_custom-data_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/properties/buildium/{property_id}/file-upload/: post: description: |- Create Property Files: Buildium Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Property Files: Buildium" tags: - properties security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: property_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_properties_buildium_{property_id}_file-upload__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_properties_buildium_{property_id}_file-upload__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/properties/entrata/{property_id}/file-upload/: post: description: Entrata does not support creating a property via their API. This endpoint will always return a 405, with an error message specifying that creating a property in an Entrata integration is not supported due to the lack of upstream support. summary: "Create Property: Entrata - Not Supported" tags: - properties security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: property_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_properties_entrata_{property_id}_file-upload__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_properties_entrata_{property_id}_file-upload__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/properties/rentvine/{property_id}/file-upload/: post: description: |- Create Property File: Rentvine Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Property File: Rentvine" tags: - properties security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the property required: true description: The Propexo unique identifier for the property name: property_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_properties_rentvine_{property_id}_file-upload__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_properties_rentvine_{property_id}_file-upload__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/properties/yardi/{id}/file-upload/: post: description: Yardi does not support creating a property file via their API. This endpoint will always return a 405, with an error message specifying that creating a property file in a Yardi integration is not supported due to the lack of upstream support. summary: "Create Property file: Yardi - Not Supported" tags: - properties security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_properties_yardi_{id}_file-upload__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_properties_yardi_{id}_file-upload__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/properties/propertyware/{property_id}/file-upload/: post: description: |- Create Property File: Propertyware. Note that due to limitations on Propertyware, files will be uploaded to the "Multimedia" tab on the building's view instead of the "Notes&Docs" tab that other files are viewable from. This can still contains any type of file, whether an image or a PDF. Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Property File: Propertyware" tags: - properties security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: property_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_properties_propertyware_{property_id}_file-upload__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_properties_propertyware_{property_id}_file-upload__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/properties/rentmanager/{property_id}/file-upload/: post: description: |- Create Property Files: Rent Manager Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Property Files: Rent Manager" tags: - properties security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: property_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_properties_rentmanager_{property_id}_file-upload__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_properties_rentmanager_{property_id}_file-upload__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/properties/rentmanager/{property_id}/notes/: post: description: |- Note: In the case of a failed file upload, we will attempt to upload the file again if we receive a 500 runtime error from Rent Manager. If the file is still not uploaded, we will return an error. Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Property Note: Rent Manager" tags: - properties security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: property_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_properties_rentmanager_{property_id}_notes__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_properties_rentmanager_{property_id}_notes__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/purchase-orders/: get: description: Get all purchase orders summary: Get all purchase orders tags: - purchase-orders security: - bearerAuth: [] parameters: - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query - schema: type: string description: The Propexo unique identifier for the property required: false description: The Propexo unique identifier for the property name: property_id in: query - schema: type: string description: The Propexo unique identifier for the integration required: false description: The Propexo unique identifier for the integration name: integration_id in: query - schema: type: string enum: *a287 description: The property management system of record required: false description: The property management system of record name: integration_vendor in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_purchase-orders__get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" post: description: Create a purchase order for an integration. summary: Create a purchase order tags: - purchase-orders security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_purchase-orders__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_purchase-orders__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/purchase-orders/{purchase_order_id}: get: description: Get purchase order by ID summary: Get purchase order by ID tags: - purchase-orders security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the purchase order required: true description: The Propexo unique identifier for the purchase order name: purchase_order_id in: path - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_purchase-orders_{purchase_order_id}_get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" put: description: Update a purchase order for an integration. summary: Update a purchase order tags: - purchase-orders security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the purchase order required: true description: The Propexo unique identifier for the purchase order name: purchase_order_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_purchase-orders_{purchase_order_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_purchase-orders_{purchase_order_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/purchase-orders/{purchase_order_id}/items: get: description: Get all purchase order items for a specific purchase order summary: Get all purchase order items for a specific purchase order tags: - purchase-orders security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the purchase order required: true description: The Propexo unique identifier for the purchase order name: purchase_order_id in: path - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query - schema: type: string description: The Propexo unique identifier for the property required: false description: The Propexo unique identifier for the property name: property_id in: query - schema: type: string description: The Propexo unique identifier for the integration required: false description: The Propexo unique identifier for the integration name: integration_id in: query - schema: type: string enum: *a287 description: The property management system of record required: false description: The property management system of record name: integration_vendor in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_purchase-orders_{purchase_order_id}_items_get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/purchase-orders/entrata/: post: description: |- Create Purchase Order: Entrata Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Purchase Order: Entrata" tags: - purchase-orders security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_purchase-orders_entrata__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_purchase-orders_entrata__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/purchase-orders/entrata/{purchase_order_id}: put: description: Entrata does not support updating a purchase order via their API. This endpoint will always return a 405, with an error message specifying that updating a purchase order in an Entrata integration is not supported due to the lack of upstream support. summary: "Update Purchase Order: Entrata - Not Supported" tags: - purchase-orders security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: purchase_order_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_purchase-orders_entrata_{purchase_order_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_purchase-orders_entrata_{purchase_order_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/purchase-orders/yardi/: post: description: |- Create Purchase Order: Yardi Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Purchase Order: Yardi" tags: - purchase-orders security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_purchase-orders_yardi__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_purchase-orders_yardi__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/purchase-orders/yardi/{purchase_order_id}: put: description: "Update Purchase Order: Yardi. This API call does not modify the purchase order in place in Yardi. It creates a change order that is attached to the existing parent purchase order specified." summary: "Update Purchase Order: Yardi" tags: - purchase-orders security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the purchase order required: true description: The Propexo unique identifier for the purchase order name: purchase_order_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_purchase-orders_yardi_{purchase_order_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_purchase-orders_yardi_{purchase_order_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/purchase-orders/yardi_rest/: post: description: |- Create Purchase Order: Yardi REST This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately. summary: "Create Purchase Order: Yardi REST" tags: - purchase-orders security: - bearerAuth: [] x-fern-availability: beta requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_purchase-orders_yardi_rest__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_purchase-orders_yardi_rest__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/purchase-orders/yardi_rest/{purchase_order_id}: put: description: "Update Purchase Order: Yardi REST. This API call does not modify the purchase order in place in Yardi. It creates a change order that is attached to the existing parent purchase order specified." summary: "Update Purchase Order: Yardi REST" tags: - purchase-orders security: - bearerAuth: [] x-fern-availability: beta parameters: - schema: type: string description: The Propexo unique identifier for the purchase order required: true description: The Propexo unique identifier for the purchase order name: purchase_order_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_purchase-orders_yardi_rest_{purchase_order_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_purchase-orders_yardi_rest_{purchase_order_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/residents/: get: description: Get all residents summary: Get all residents tags: - residents security: - bearerAuth: [] parameters: - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query - schema: type: string description: The external resident id required: false description: The external resident id name: x_id in: query - schema: type: string description: "Deprecated: Use Propexo property_id instead" deprecated: true required: false description: "Deprecated: Use Propexo property_id instead" name: x_property_id in: query - schema: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. required: false description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: location_id in: query - schema: type: string description: The Propexo property id required: false description: The Propexo property id name: property_id in: query - schema: type: string description: The Propexo lease id required: false description: The Propexo lease id name: lease_id in: query - schema: type: string description: The Propexo integration id required: false description: The Propexo integration id name: integration_id in: query - schema: type: string enum: *a293 description: The integration vendor for the resident. required: false description: The integration vendor for the resident. name: integration_vendor in: query - schema: type: string description: The primary email address associated with the resident required: false description: The primary email address associated with the resident name: email_1 in: query - schema: type: string pattern: ^[2-9]\d{9}$ description: Filter by phone number (10 digit format only) required: false description: Filter by phone number (10 digit format only) name: phone_1 in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_residents__get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" post: description: Create a resident for an integration. summary: Create resident tags: - residents security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_residents__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_residents__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/residents/{id}: get: description: Get a resident by ID summary: Get a resident by ID tags: - residents security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: id in: path - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_residents_{id}_get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" put: description: Update a resident for an integration. summary: Update resident tags: - residents security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_residents_{id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_residents_{id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/resident-pets/: post: description: Create a resident pet for an integration. summary: Create resident pet tags: - residents security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_resident-pets__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_resident-pets__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/resident-pets/{pet_id}: put: description: Update a resident pet for an integration. summary: Update resident pet tags: - residents security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the resident pet required: false description: The Propexo unique identifier for the resident pet name: pet_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_resident-pets_{pet_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_resident-pets_{pet_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/resident-insurance/: get: description: Get all resident insurance summary: Get all resident insurance tags: - residents security: - bearerAuth: [] parameters: - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query - schema: type: string description: The Propexo unique identifier for the resident required: false description: The Propexo unique identifier for the resident name: resident_id in: query - schema: type: string description: The Propexo unique identifier for the unit required: false description: The Propexo unique identifier for the unit name: unit_id in: query - schema: type: string description: The Propexo unique identifier for the lease required: false description: The Propexo unique identifier for the lease name: lease_id in: query - schema: type: string description: The Propexo unique identifier for the property required: false description: The Propexo unique identifier for the property name: property_id in: query - schema: type: string description: The Propexo unique identifier for the integration required: false description: The Propexo unique identifier for the integration name: integration_id in: query - schema: type: string required: false name: integration_vendor in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_resident-insurance__get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/resident-insurance/{resident_insurance_id}: get: description: Get resident insurance by ID summary: Get resident insurance by ID tags: - residents security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: resident_insurance_id in: path - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_resident-insurance_{resident_insurance_id}_get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/residents/{id}/rentable-items: get: description: Get all rentable items associated with a specific resident summary: Get rentable items for a resident tags: - residents security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: id in: path - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query - schema: type: string description: The external ID from the integration vendor required: false description: The external ID from the integration vendor name: x_id in: query - schema: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. required: false description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: location_id in: query - schema: type: string description: The Propexo unique identifier for the property required: false description: The Propexo unique identifier for the property name: property_id in: query - schema: type: string description: The Propexo unique identifier for the integration required: false description: The Propexo unique identifier for the integration name: integration_id in: query - schema: type: string enum: *a287 description: The property management system of record required: false description: The property management system of record name: integration_vendor in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_residents_{id}_rentable-items_get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/residents/buildium/: post: description: |- Create Resident: Buildium This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately. summary: "Create Resident: Buildium" tags: - residents security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_residents_buildium__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_residents_buildium__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/residents/buildium/{resident_id}: put: description: "Update Resident: Buildium" summary: "Update Resident: Buildium" tags: - residents security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: resident_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_residents_buildium_{resident_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_residents_buildium_{resident_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/residents/entrata/: post: description: Entrata does not support creating a resident via their API. This endpoint will always return a 405, with an error message specifying that creating a resident in an Entrata integration is not supported due to the lack of upstream support. summary: "Create Resident: Entrata - Not Supported" tags: - residents security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_residents_entrata__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_residents_entrata__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/residents/entrata/{id}: put: description: "Update Resident: Entrata" summary: "Update Resident: Entrata" tags: - residents security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the resident required: true description: The Propexo unique identifier for the resident name: id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_residents_entrata_{id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_residents_entrata_{id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/residents/propertyware/: post: description: Propertyware SOAP does not support creating a resident via their API. This endpoint will always return a 405, with an error message specifying that creating a resident in a Propertyware SOAP integration is not supported due to the lack of upstream support. summary: "Create Resident: Propertyware SOAP - Not Supported" tags: - residents security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_residents_propertyware__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_residents_propertyware__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/residents/propertyware/{resident_id}: put: description: "Update Resident: Propertyware" summary: "Update Resident: Propertyware" tags: - residents security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the resident required: true description: The Propexo unique identifier for the resident name: resident_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_residents_propertyware_{resident_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_residents_propertyware_{resident_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/residents/propertyware_rest/: post: description: |- Create Resident: Propertyware REST This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately. summary: "Create Resident: Propertyware REST" tags: - residents security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_residents_propertyware_rest__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_residents_propertyware_rest__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/residents/propertyware_rest/{resident_id}: put: description: "Update Resident: Propertyware REST" summary: "Update Resident: Propertyware REST" tags: - residents security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the resident required: true description: The Propexo unique identifier for the resident name: resident_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_residents_propertyware_rest_{resident_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_residents_propertyware_rest_{resident_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/residents/rentmanager/: post: description: |- Create Resident: Rent Manager This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately. summary: "Create Resident: Rent Manager" tags: - residents security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_residents_rentmanager__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_residents_rentmanager__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/residents/rentmanager/{resident_id}: put: description: "Update Resident: Rent Manager" summary: "Update Resident: Rent Manager" tags: - residents security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: resident_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_residents_rentmanager_{resident_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_residents_rentmanager_{resident_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/residents/mri/{resident_id}: put: description: "Update Resident: MRI" summary: "Update Resident: MRI" tags: - residents security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the resident required: true description: The Propexo unique identifier for the resident name: resident_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_residents_mri_{resident_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_residents_mri_{resident_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/residents/realpage/{id}: put: description: "Update Resident: RealPage" summary: "Update Resident: RealPage" tags: - residents security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo ID associated with this resident required: true description: The Propexo ID associated with this resident name: id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_residents_realpage_{id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_residents_realpage_{id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/residents/rentvine/{resident_id}: put: description: "Note: If you'd like to update the resident's address, phone number, or email address, this will require additional configuration to read in required metadata. If you'd like to update these fields, please contact support." summary: "Update Resident: Rentvine" tags: - residents security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: resident_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_residents_rentvine_{resident_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_residents_rentvine_{resident_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/residents/yardi/{resident_id}: put: description: "Update Resident: Yardi" summary: "Update Resident: Yardi" tags: - residents security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the resident required: true description: The Propexo unique identifier for the resident name: resident_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_residents_yardi_{resident_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_residents_yardi_{resident_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/residents/yardi/: post: description: Yardi does not support creating a resident via their API. This endpoint will always return a 405, with an error message specifying that creating a resident in a Yardi integration is not supported due to the lack of upstream support. summary: "Create Resident: Yardi - Not Supported" tags: - residents security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_residents_yardi__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_residents_yardi__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/resident-pets/rentvine/: post: description: |- Create Resident Pet: Rentvine This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately. summary: "Create Resident Pet: Rentvine" tags: - residents security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_resident-pets_rentvine__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_resident-pets_rentvine__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/resident-pets/rentvine/{pet_id}: put: description: "Update Resident Pet: Rentvine" summary: "Update Resident Pet: Rentvine" tags: - residents security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the resident pet required: true description: The Propexo unique identifier for the resident pet name: pet_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_resident-pets_rentvine_{pet_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_resident-pets_rentvine_{pet_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/residents/rentmanager/{resident_id}/custom-data: post: description: |- Create Resident Custom Data: Rent Manager Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Resident Custom Data: Rent Manager" tags: - residents security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the resident required: true description: The Propexo unique identifier for the resident name: resident_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_residents_rentmanager_{resident_id}_custom-data_post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_residents_rentmanager_{resident_id}_custom-data_post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" put: description: The custom data fields given in this payload must already exist on the resident. summary: "Update Resident Custom Data: Rent Manager" tags: - residents security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the resident required: true description: The Propexo unique identifier for the resident name: resident_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_residents_rentmanager_{resident_id}_custom-data_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_residents_rentmanager_{resident_id}_custom-data_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/residents/buildium/{resident_id}/file-upload/: post: description: |- Create Resident Files: Buildium Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Resident Files: Buildium" tags: - residents security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: resident_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_residents_buildium_{resident_id}_file-upload__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_residents_buildium_{resident_id}_file-upload__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/residents/entrata/{id}/file-upload/: post: description: Entrata does not support creating a resident via their API. This endpoint will always return a 405, with an error message specifying that creating a resident in an Entrata integration is not supported due to the lack of upstream support. summary: "Create Resident: Entrata - Not Supported" tags: - residents security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_residents_entrata_{id}_file-upload__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_residents_entrata_{id}_file-upload__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/residents/propertyware/{resident_id}/file-upload/: post: description: "Create Resident File: Propertyware" summary: "Create Resident File: Propertyware" tags: - residents security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: resident_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_residents_propertyware_{resident_id}_file-upload__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_residents_propertyware_{resident_id}_file-upload__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/residents/rentmanager/{resident_id}/file-upload/: post: description: |- Create Resident Files: Rent Manager Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Resident Files: Rent Manager" tags: - residents security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: resident_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_residents_rentmanager_{resident_id}_file-upload__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_residents_rentmanager_{resident_id}_file-upload__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/residents/rentmanager/{resident_id}/notes/: post: description: |- Note: In the case of a failed file upload, we will attempt to upload the file again if we receive a 500 runtime error from Rent Manager. If the file is still not uploaded, we will return an error. Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Resident Note: RentManager" tags: - residents security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: resident_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_residents_rentmanager_{resident_id}_notes__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_residents_rentmanager_{resident_id}_notes__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/residents/mri/{resident_id}/notes/: post: description: |- Create Resident Note: MRI. Note: You can only create one note per note category per resident per day. Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Resident Note: MRI" tags: - residents security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the resident required: true description: The Propexo unique identifier for the resident name: resident_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_residents_mri_{resident_id}_notes__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_residents_mri_{resident_id}_notes__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/residents/mri/{resident_id}/file-upload/: post: description: MRI does not support creating a resident file via their API. This endpoint will always return a 405, with an error message specifying that creating a resident file in a MRI integration is not supported due to the lack of upstream support. summary: "Create Resident file: MRI - Not Supported" tags: - residents security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: resident_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_residents_mri_{resident_id}_file-upload__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_residents_mri_{resident_id}_file-upload__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/residents/rentvine/{resident_id}/file-upload/: post: description: |- Attach a new file to a Resident. Note that Residents with a Resident Type of Occupant cannot have files attached. Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Resident File: Rentvine" tags: - residents security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the resident required: true description: The Propexo unique identifier for the resident name: resident_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_residents_rentvine_{resident_id}_file-upload__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_residents_rentvine_{resident_id}_file-upload__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/residents/yardi/{resident_id}/file-upload/: post: description: |- Create Resident File: Yardi Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Resident File: Yardi" tags: - residents security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the resident required: true description: The Propexo unique identifier for the resident name: resident_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_residents_yardi_{resident_id}_file-upload__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_residents_yardi_{resident_id}_file-upload__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/residents/yardi_rest/{resident_id}/file-upload/: post: description: |- Create Resident File (File Upload): Yardi REST Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Resident File (File Upload): Yardi REST" tags: - residents security: - bearerAuth: [] x-fern-availability: beta parameters: - schema: type: string description: The Propexo unique identifier for the resident required: true description: The Propexo unique identifier for the resident name: resident_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_residents_yardi_rest_{resident_id}_file-upload__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_residents_yardi_rest_{resident_id}_file-upload__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/service-requests/: get: description: Get all service requests summary: Get all service requests tags: - service-requests security: - bearerAuth: [] parameters: - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query - schema: type: string description: The external ID from the integration vendor required: false description: The external ID from the integration vendor name: x_id in: query - schema: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. required: false description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: location_id in: query - schema: type: string description: The Propexo unique identifier for the unit required: false description: The Propexo unique identifier for the unit name: unit_id in: query - schema: type: string description: The Propexo unique identifier for the employee required: false description: The Propexo unique identifier for the employee name: employee_id in: query - schema: type: string description: The Propexo unique identifier for the vendor required: false description: The Propexo unique identifier for the vendor name: vendor_id in: query - schema: type: string description: The Propexo unique identifier for the property required: false description: The Propexo unique identifier for the property name: property_id in: query - schema: type: string description: The Propexo unique identifier for the integration required: false description: The Propexo unique identifier for the integration name: integration_id in: query - schema: type: string enum: *a287 description: The property management system of record required: false description: The property management system of record name: integration_vendor in: query - schema: type: string description: The unit number of the service request. When using this, the Propexo `property_id` filter must be added as well. required: false description: The unit number of the service request. When using this, the Propexo `property_id` filter must be added as well. name: unit_number in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_service-requests__get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" post: description: Create a service request for an integration. summary: Create service request tags: - service-requests security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_service-requests__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_service-requests__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/service-requests/{service_request_id}: get: description: Get a service request by ID summary: Get a service request by ID tags: - service-requests security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: service_request_id in: path - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_service-requests_{service_request_id}_get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" put: description: Update a service request for an integration. summary: Update service request tags: - service-requests security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the service request required: true description: The Propexo unique identifier for the service request name: service_request_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_service-requests_{service_request_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_service-requests_{service_request_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/service-request-categories/: get: description: Get all service request categories summary: Get all service request categories tags: - service-requests security: - bearerAuth: [] parameters: - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query - schema: type: string description: The external ID from the integration vendor required: false description: The external ID from the integration vendor name: x_id in: query - schema: type: string description: The external ID of the property from the integration vendor required: false description: The external ID of the property from the integration vendor name: x_property_id in: query - schema: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. required: false description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: location_id in: query - schema: type: string description: The Propexo unique identifier for the property required: false description: The Propexo unique identifier for the property name: property_id in: query - schema: type: string description: The Propexo unique identifier for the integration required: false description: The Propexo unique identifier for the integration name: integration_id in: query - schema: type: string enum: *a287 description: The property management system of record required: false description: The property management system of record name: integration_vendor in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_service-request-categories__get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/service-request-categories/{service_request_category_id}: get: description: Get service request category by ID summary: Get service request category by ID tags: - service-requests security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: service_request_category_id in: path - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_service-request-categories_{service_request_category_id}_get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/service-request-history/: get: description: Get all service request history summary: Get all service request history tags: - service-requests security: - bearerAuth: [] parameters: - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query - schema: type: string description: The Propexo unique identifier for the service request required: false description: The Propexo unique identifier for the service request name: service_request_id in: query - schema: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. required: false description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: location_id in: query - schema: type: string description: The Propexo unique identifier for the property required: false description: The Propexo unique identifier for the property name: property_id in: query - schema: type: string description: The Propexo unique identifier for the integration required: false description: The Propexo unique identifier for the integration name: integration_id in: query - schema: type: string enum: *a287 description: The property management system of record required: false description: The property management system of record name: integration_vendor in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_service-request-history__get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" post: description: Generate service request history for an integration. summary: Create service request history tags: - service-requests security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_service-request-history__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_service-request-history__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/service-request-history/{service_request_history_id}: get: description: Get service request history by ID summary: Get service request history by ID tags: - service-requests security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: service_request_history_id in: path - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_service-request-history_{service_request_history_id}_get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/service-request-priorities/: get: description: Get all service request priorities summary: Get all service request priorities tags: - service-requests security: - bearerAuth: [] parameters: - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query - schema: type: string description: The external ID from the integration vendor required: false description: The external ID from the integration vendor name: x_id in: query - schema: type: string description: The external ID of the property from the integration vendor required: false description: The external ID of the property from the integration vendor name: x_property_id in: query - schema: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. required: false description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: location_id in: query - schema: type: string description: The Propexo unique identifier for the property required: false description: The Propexo unique identifier for the property name: property_id in: query - schema: type: string description: The Propexo unique identifier for the integration required: false description: The Propexo unique identifier for the integration name: integration_id in: query - schema: type: string enum: *a287 description: The property management system of record required: false description: The property management system of record name: integration_vendor in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_service-request-priorities__get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/service-request-priorities/{service_request_priority_id}: get: description: Get service request priority by ID summary: Get service request priority by ID tags: - service-requests security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: service_request_priority_id in: path - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_service-request-priorities_{service_request_priority_id}_get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/service-request-statuses/: get: description: Get all service request statuses summary: Get all service request statuses tags: - service-requests security: - bearerAuth: [] parameters: - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query - schema: type: string description: The external ID from the integration vendor required: false description: The external ID from the integration vendor name: x_id in: query - schema: type: string description: The external ID of the property from the integration vendor required: false description: The external ID of the property from the integration vendor name: x_property_id in: query - schema: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. required: false description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: location_id in: query - schema: type: string description: The Propexo unique identifier for the property required: false description: The Propexo unique identifier for the property name: property_id in: query - schema: type: string description: The Propexo unique identifier for the integration required: false description: The Propexo unique identifier for the integration name: integration_id in: query - schema: type: string enum: *a287 description: The property management system of record required: false description: The property management system of record name: integration_vendor in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_service-request-statuses__get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/service-request-statuses/{service_request_status_id}: get: description: Get service request status by ID summary: Get service request status by ID tags: - service-requests security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: service_request_status_id in: path - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_service-request-statuses_{service_request_status_id}_get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/service-request-locations/: get: description: Get all service request locations summary: Get all service request locations tags: - service-requests security: - bearerAuth: [] parameters: - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query - schema: type: string description: The Propexo unique identifier for the property required: false description: The Propexo unique identifier for the property name: property_id in: query - schema: type: string description: The Propexo unique identifier for the integration required: false description: The Propexo unique identifier for the integration name: integration_id in: query - schema: type: string enum: *a287 description: The property management system of record required: false description: The property management system of record name: integration_vendor in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_service-request-locations__get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/service-request-locations/{service_request_location_id}: get: description: Get a service request location by ID summary: Get a service request location by ID tags: - service-requests security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: service_request_location_id in: path - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query - schema: type: string description: The Propexo unique identifier for the property required: false description: The Propexo unique identifier for the property name: property_id in: query - schema: type: string description: The Propexo unique identifier for the integration required: false description: The Propexo unique identifier for the integration name: integration_id in: query - schema: type: string enum: *a287 description: The property management system of record required: false description: The property management system of record name: integration_vendor in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_service-request-locations_{service_request_location_id}_get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/service-request-problems/: get: description: Get all service request problems summary: Get all service request problems tags: - service-requests security: - bearerAuth: [] parameters: - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query - schema: type: string description: The Propexo unique identifier for the property required: false description: The Propexo unique identifier for the property name: property_id in: query - schema: type: string description: The Propexo unique identifier for the integration required: false description: The Propexo unique identifier for the integration name: integration_id in: query - schema: type: string enum: *a287 description: The property management system of record required: false description: The property management system of record name: integration_vendor in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_service-request-problems__get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/service-request-problems/{service_request_problem_id}: get: description: Get a service request problem by ID summary: Get a service request problem by ID tags: - service-requests security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: service_request_problem_id in: path - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query - schema: type: string description: The Propexo unique identifier for the property required: false description: The Propexo unique identifier for the property name: property_id in: query - schema: type: string description: The Propexo unique identifier for the integration required: false description: The Propexo unique identifier for the integration name: integration_id in: query - schema: type: string enum: *a287 description: The property management system of record required: false description: The property management system of record name: integration_vendor in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_service-request-problems_{service_request_problem_id}_get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/service-requests/buildium/: post: description: |- Create a service request for Buildium This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately. summary: Create a service request for Buildium tags: - service-requests security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_service-requests_buildium__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_service-requests_buildium__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/service-requests/mri/: post: description: |- Create a service request in MRI. This will create a residential service request in MRI. This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately. summary: "Create Service Request: MRI" tags: - service-requests security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_service-requests_mri__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_service-requests_mri__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/service-requests/mri/{service_request_id}: put: description: "Update Service Request: MRI" summary: "Update Service Request: MRI" tags: - service-requests security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the service request required: true description: The Propexo unique identifier for the service request name: service_request_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_service-requests_mri_{service_request_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_service-requests_mri_{service_request_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/service-requests/rentmanager/: post: description: |- Create Service Request: Rent Manager This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately. summary: "Create Service Request: Rent Manager" tags: - service-requests security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_service-requests_rentmanager__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_service-requests_rentmanager__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/service-requests/rentmanager/{service_request_id}: put: description: Update a service request for Rent Manager summary: Update a service request for Rent Manager tags: - service-requests security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the service request required: true description: The Propexo unique identifier for the service request name: service_request_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_service-requests_rentmanager_{service_request_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_service-requests_rentmanager_{service_request_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/service-requests/resman/: post: description: |- Create Service Request: ResMan Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Service Request: ResMan" tags: - service-requests security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_service-requests_resman__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_service-requests_resman__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/service-requests/resman/{service_request_id}: put: description: "Update Service Request: ResMan" summary: "Update Service Request: ResMan" tags: - service-requests security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the service request required: true description: The Propexo unique identifier for the service request name: service_request_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_service-requests_resman_{service_request_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_service-requests_resman_{service_request_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/service-requests/entrata/: post: description: |- Create a service request for Entrata This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately. summary: Create a service request for Entrata tags: - service-requests security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_service-requests_entrata__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_service-requests_entrata__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/service-requests/entrata/{service_request_id}: put: description: "Update Service Request: Entrata" summary: "Update Service Request: Entrata" tags: - service-requests security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the service request required: true description: The Propexo unique identifier for the service request name: service_request_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_service-requests_entrata_{service_request_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_service-requests_entrata_{service_request_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/service-requests/yardi/{service_request_id}: put: description: "Update Service Request: Yardi" summary: "Update Service Request: Yardi" tags: - service-requests security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the service request required: true description: The Propexo unique identifier for the service request name: service_request_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_service-requests_yardi_{service_request_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_service-requests_yardi_{service_request_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/service-requests/yardi/: post: description: |- Create Service Request: Yardi This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately. summary: "Create Service Request: Yardi" tags: - service-requests security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_service-requests_yardi__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_service-requests_yardi__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/service-requests/rentvine/: post: description: |- Create Service Request: Rentvine This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately. summary: "Create Service Request: Rentvine" tags: - service-requests security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_service-requests_rentvine__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_service-requests_rentvine__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/service-requests/propertyware/{service_request_id}: put: description: "Update Service Request: Propertyware" summary: "Update Service Request: Propertyware" tags: - service-requests security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the service request required: true description: The Propexo unique identifier for the service request name: service_request_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_service-requests_propertyware_{service_request_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_service-requests_propertyware_{service_request_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/service-requests/propertyware/: post: description: |- Create Service Request: Propertyware Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Service Request: Propertyware" tags: - service-requests security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_service-requests_propertyware__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_service-requests_propertyware__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/service-requests/realpage_rpx/{service_request_id}: put: description: When updating a service request, a new service request history record will also be created. summary: "Update Service Request: RealPage Partner Exchange" tags: - service-requests security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the service request required: true description: The Propexo unique identifier for the service request name: service_request_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_service-requests_realpage_rpx_{service_request_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_service-requests_realpage_rpx_{service_request_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/service-requests/realpage_rpx/: post: description: |- Create Service Request: RealPage Partner Exchange Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Service Request: RealPage Partner Exchange" tags: - service-requests security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_service-requests_realpage_rpx__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_service-requests_realpage_rpx__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/service-requests/yardi_rest/: post: description: |- Create Service Request: Yardi REST This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately. summary: "Create Service Request: Yardi REST" tags: - service-requests security: - bearerAuth: [] x-fern-availability: beta requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_service-requests_yardi_rest__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_service-requests_yardi_rest__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/service-requests/yardi_rest/{service_request_id}: put: description: "Update Service Request: Yardi REST" summary: "Update Service Request: Yardi REST" tags: - service-requests security: - bearerAuth: [] x-fern-availability: beta parameters: - schema: type: string description: The Propexo unique identifier for the service request required: true description: The Propexo unique identifier for the service request name: service_request_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_service-requests_yardi_rest_{service_request_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_service-requests_yardi_rest_{service_request_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/service-request-history/buildium/: post: description: |- Create Service Request History: Buildium Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Service Request History: Buildium" tags: - service-requests security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_service-request-history_buildium__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_service-request-history_buildium__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/service-request-history/entrata/: post: description: |- Create Service Request History: Entrata Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Service Request History: Entrata" tags: - service-requests security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_service-request-history_entrata__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_service-request-history_entrata__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/service-request-history/propertyware/: post: description: |- Create Service Request History: Propertyware Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Service Request History: Propertyware" tags: - service-requests security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_service-request-history_propertyware__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_service-request-history_propertyware__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/service-request-history/realpage_rpx/: post: description: |- Create Service Request History: RealPage Partner Exchange. The only field we can add on a service request history record is the status change. RealPage Partner Exchange only allows adding notes to a service request history record via their UI. Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Service Request History: RealPage Partner Exchange" tags: - service-requests security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_service-request-history_realpage_rpx__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_service-request-history_realpage_rpx__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/service-request-history/rentmanager/: post: description: |- Create Service Request History: Rent Manager Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Service Request History: Rent Manager" tags: - service-requests security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_service-request-history_rentmanager__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_service-request-history_rentmanager__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/service-request-history/resman/: post: description: ResMan does not support creating a service request history via their API. This endpoint will always return a 405, with an error message specifying that creating a service request history in a ResMan integration is not supported due to the lack of upstream support. summary: "Create Service Request History: ResMan - Not Supported" tags: - service-requests security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_service-request-history_resman__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_service-request-history_resman__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/service-request-history/yardi/: post: description: |- Create Service Request History: Yardi Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Service Request History: Yardi" tags: - service-requests security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_service-request-history_yardi__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_service-request-history_yardi__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/service-requests/yardi/{service_request_id}/file-upload: post: description: |- Create Service Request File: Yardi Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Service Request File: Yardi" tags: - service-requests security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the service request required: true description: The Propexo unique identifier for the service request name: service_request_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_service-requests_yardi_{service_request_id}_file-upload_post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_service-requests_yardi_{service_request_id}_file-upload_post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/service-requests/yardi_rest/{service_request_id}/file-upload: post: description: |- Create Service Request File (File Upload): Yardi REST Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Service Request File (File Upload): Yardi REST" tags: - service-requests security: - bearerAuth: [] x-fern-availability: beta parameters: - schema: type: string description: The Propexo unique identifier for the service request required: true description: The Propexo unique identifier for the service request name: service_request_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_service-requests_yardi_rest_{service_request_id}_file-upload_post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_service-requests_yardi_rest_{service_request_id}_file-upload_post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/service-requests/buildium/{service_request_id}/file-upload/: post: description: |- Create Service Request Files: Buildium Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Service Request Files: Buildium" tags: - service-requests security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: service_request_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_service-requests_buildium_{service_request_id}_file-upload__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_service-requests_buildium_{service_request_id}_file-upload__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/service-requests/rentmanager/{service_request_id}/file-upload/: post: description: |- Create Service Request Files: Rent Manager Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Service Request Files: Rent Manager" tags: - service-requests security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: service_request_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_service-requests_rentmanager_{service_request_id}_file-upload__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_service-requests_rentmanager_{service_request_id}_file-upload__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/service-requests/rentmanager/{service_request_id}/notes/: post: description: |- Note: In the case of a failed file upload, we will attempt to upload the file again if we receive a 500 runtime error from Rent Manager. If the file is still not uploaded, we will return an error. Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Service Request Note: Rent Manager" tags: - service-requests security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: service_request_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_service-requests_rentmanager_{service_request_id}_notes__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_service-requests_rentmanager_{service_request_id}_notes__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/service-requests/resman/{service_request_id}/file-upload/: post: description: |- Create Service Request Files: ResMan Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Service Request Files: ResMan" tags: - service-requests security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the service request required: true description: The Propexo unique identifier for the service request name: service_request_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_service-requests_resman_{service_request_id}_file-upload__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_service-requests_resman_{service_request_id}_file-upload__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/service-requests/entrata/{service_request_id}/file-upload/: post: description: |- Create Service Request Files: Entrata Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Service Request Files: Entrata" tags: - service-requests security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the service request required: true description: The Propexo unique identifier for the service request name: service_request_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_service-requests_entrata_{service_request_id}_file-upload__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_service-requests_entrata_{service_request_id}_file-upload__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/service-requests/rentvine/{service_request_id}/file-upload/: post: description: |- Create Service Request File: Rentvine Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Service Request File: Rentvine" tags: - service-requests security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the service request required: true description: The Propexo unique identifier for the service request name: service_request_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_service-requests_rentvine_{service_request_id}_file-upload__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_service-requests_rentvine_{service_request_id}_file-upload__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/service-requests/propertyware/{service_request_id}/file-upload/: post: description: |- Create Service Request File: Propertyware Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Service Request File: Propertyware" tags: - service-requests security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: service_request_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_service-requests_propertyware_{service_request_id}_file-upload__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_service-requests_propertyware_{service_request_id}_file-upload__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/timezones/: get: description: Get all timezones summary: Get all timezones tags: - timezones security: - bearerAuth: [] parameters: - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query - schema: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. required: false description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: location_id in: query - schema: type: string description: The Propexo unique identifier for the property required: false description: The Propexo unique identifier for the property name: property_id in: query - schema: type: string description: The Propexo unique identifier for the integration required: false description: The Propexo unique identifier for the integration name: integration_id in: query - schema: type: string enum: *a287 description: The property management system of record required: false description: The property management system of record name: integration_vendor in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_timezones__get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/concessions/: get: description: Get all concessions summary: Get all concessions tags: - units security: - bearerAuth: [] parameters: - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query - schema: type: string description: The external ID from the integration vendor required: false description: The external ID from the integration vendor name: x_id in: query - schema: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. required: false description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: location_id in: query - schema: type: string description: The Propexo unique identifier for the property required: false description: The Propexo unique identifier for the property name: property_id in: query - schema: type: string description: The Propexo unique identifier for the integration required: false description: The Propexo unique identifier for the integration name: integration_id in: query - schema: type: string enum: *a287 description: The property management system of record required: false description: The property management system of record name: integration_vendor in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_concessions__get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/concessions/{concession_id}: get: description: Get concession by ID summary: Get concession by ID tags: - units security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: concession_id in: path - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_concessions_{concession_id}_get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/floor-plans/: get: description: Get all floor plans summary: Get all floor plans tags: - units security: - bearerAuth: [] parameters: - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query - schema: type: string description: The external ID from the integration vendor required: false description: The external ID from the integration vendor name: x_id in: query - schema: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. required: false description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: location_id in: query - schema: type: string description: The Propexo unique identifier for the property required: false description: The Propexo unique identifier for the property name: property_id in: query - schema: type: string description: The Propexo unique identifier for the integration required: false description: The Propexo unique identifier for the integration name: integration_id in: query - schema: type: string enum: *a287 description: The property management system of record required: false description: The property management system of record name: integration_vendor in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_floor-plans__get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/floor-plans/{floor_plan_id}: get: description: Get floor plan by ID summary: Get floor plan by ID tags: - units security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: floor_plan_id in: path - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_floor-plans_{floor_plan_id}_get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/units/: get: description: Get all units summary: Get all units tags: - units security: - bearerAuth: [] parameters: - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query - schema: type: string description: The external unit id required: false description: The external unit id name: x_id in: query - schema: type: string description: "Deprecated: Use the Propexo property_id instead" deprecated: true required: false description: "Deprecated: Use the Propexo property_id instead" name: x_property_id in: query - schema: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. required: false description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: location_id in: query - schema: type: string description: The Propexo property id required: false description: The Propexo property id name: property_id in: query - schema: type: string description: The Propexo integration id required: false description: The Propexo integration id name: integration_id in: query - schema: type: string enum: *a294 description: The integration vendor for the unit. required: false description: The integration vendor for the unit. name: integration_vendor in: query - schema: type: string description: The number of the unit. When using this, the Propexo `property_id` filter must be added as well. required: false description: The number of the unit. When using this, the Propexo `property_id` filter must be added as well. name: unit_number in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_units__get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" post: description: Create a unit for a property. summary: Create unit tags: - units security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_units__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_units__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/units/details: get: description: 'Note: "Unit Details" are not units themselves, but rather details regarding application/listing information on a unit. This is a separate concept from generic units data, and is required to be enabled as its own model. It is uncommon for customers to require this data. Please contact support with questions' summary: Get all unit details. tags: - units security: - bearerAuth: [] parameters: - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query - schema: type: string description: The external unit id required: false description: The external unit id name: x_id in: query - schema: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. required: false description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: location_id in: query - schema: type: string description: The Propexo unique identifier for the property required: false description: The Propexo unique identifier for the property name: property_id in: query - schema: type: string description: The Propexo unique identifier for the integration required: false description: The Propexo unique identifier for the integration name: integration_id in: query - schema: type: string enum: *a287 description: The property management system of record required: false description: The property management system of record name: integration_vendor in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_units_details_get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/units/{id}: get: description: Get a unit by ID summary: Get a unit by ID tags: - units security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: id in: path - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_units_{id}_get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" put: description: Update a unit for a property. summary: Update unit tags: - units security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_units_{id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_units_{id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/unit-types/: get: description: Get all unit types summary: Get all unit types tags: - units security: - bearerAuth: [] parameters: - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query - schema: type: string description: The external ID from the integration vendor required: false description: The external ID from the integration vendor name: x_id in: query - schema: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. required: false description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: location_id in: query - schema: type: string description: The Propexo unique identifier for the property required: false description: The Propexo unique identifier for the property name: property_id in: query - schema: type: string description: The Propexo unique identifier for the integration required: false description: The Propexo unique identifier for the integration name: integration_id in: query - schema: type: string enum: *a287 description: The property management system of record required: false description: The property management system of record name: integration_vendor in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_unit-types__get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/unit-types/{unit_type_id}: get: description: Get unit type by ID summary: Get unit type by ID tags: - units security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: unit_type_id in: path - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_unit-types_{unit_type_id}_get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/units/details/{unit_detail_id}: get: description: 'Note: "Unit Details" are not units themselves, but rather details regarding application/listing information on a unit. This is a separate concept from generic units data, and is required to be enabled as its own model. It is uncommon for customers to require this data. Please contact support with questions' summary: Get a unit detail by ID. tags: - units security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: unit_detail_id in: path - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_units_details_{unit_detail_id}_get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/units/entrata/{id}: put: description: Entrata does not support updating a unit via their API. This endpoint will always return a 405, with an error message specifying that updating a unit in an Entrata integration is not supported due to the lack of upstream support. summary: "Update Unit: Entrata - Not Supported" tags: - units security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_units_entrata_{id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_units_entrata_{id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/units/entrata/: post: description: |- Create Unit: Entrata This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately. summary: "Create Unit: Entrata" tags: - units security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_units_entrata__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_units_entrata__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/units/propertyware/{unit_id}: put: description: "Update Unit: Propertyware" summary: "Update Unit: Propertyware" tags: - units security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the unit required: true description: The Propexo unique identifier for the unit name: unit_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_units_propertyware_{unit_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_units_propertyware_{unit_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/units/propertyware/: post: description: |- Create Unit: Propertyware Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Unit: Propertyware" tags: - units security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_units_propertyware__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_units_propertyware__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/units/yardi/{id}: put: description: Yardi does not support updating a unit via their API. This endpoint will always return a 405, with an error message specifying that updating a unit in a Yardi integration is not supported due to the lack of upstream support. summary: "Update Unit: Yardi - Not Supported" tags: - units security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_units_yardi_{id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_units_yardi_{id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/units/yardi/: post: description: Yardi does not support creating a unit via their API. This endpoint will always return a 405, with an error message specifying that creating a unit in a Yardi integration is not supported due to the lack of upstream support. summary: "Create Unit: Yardi - Not Supported" tags: - units security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_units_yardi__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_units_yardi__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/units/rentmanager/{unit_id}: put: description: Update a unit in Rent Manager. This endpoint supports updating basic unit information, addresses, market rent, floor plan details, marketing data, and building information. Some fields require specific embeds to be enabled in Rent Manager. summary: "Update Unit: Rent Manager" tags: - units security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the unit required: true description: The Propexo unique identifier for the unit name: unit_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_units_rentmanager_{unit_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_units_rentmanager_{unit_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/units/mri/{unit_id}: put: description: MRI does not support updating a unit via their API. This endpoint will always return a 405, with an error message specifying that updating a unit in a MRI integration is not supported due to the lack of upstream support.MRI does not provide a way to update the majority of data on units with their MIX APIs. This is available through their developer APIs, but the developer APIs are recommended to be avoided by integrating systems due to their unchecked data entry that can lead to system corruption. summary: "Update Unit: MRI - Not Supported" tags: - units security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: unit_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_units_mri_{unit_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_units_mri_{unit_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/units/rentvine/{unit_id}/custom-data: put: description: The custom data fields must first be provisioned by the customer on the property object before they can be set by this API route. At this time, Propexo does not support a way to provision new custom fields or modify the schema for existing custom fields via an API. Please contact Propexo support if this is required for your business case. summary: "Update Unit Custom Data: Rentvine" tags: - units security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the unit required: true description: The Propexo unique identifier for the unit name: unit_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_units_rentvine_{unit_id}_custom-data_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_units_rentvine_{unit_id}_custom-data_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/units/propertyware_rest/{unit_id}/custom-data: put: description: The custom data fields given in this payload must already exist on the unit. At this time, Propertyware REST does not support a way to create custom fields initially via the API. summary: "Update Unit Custom Data: Propertyware REST" tags: - units security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the unit required: true description: The Propexo unique identifier for the unit name: unit_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_units_propertyware_rest_{unit_id}_custom-data_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_units_propertyware_rest_{unit_id}_custom-data_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/units/rentmanager/{unit_id}/custom-data: post: description: |- Create Unit Custom Data: Rent Manager Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Unit Custom Data: Rent Manager" tags: - units security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the unit required: true description: The Propexo unique identifier for the unit name: unit_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_units_rentmanager_{unit_id}_custom-data_post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_units_rentmanager_{unit_id}_custom-data_post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" put: description: The custom data fields given in this payload must already exist on the unit. summary: "Update Unit Custom Data: Rent Manager" tags: - units security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the unit required: true description: The Propexo unique identifier for the unit name: unit_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_units_rentmanager_{unit_id}_custom-data_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_units_rentmanager_{unit_id}_custom-data_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/units/buildium/{unit_id}/file-upload/: post: description: |- Create Unit Files: Buildium Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Unit Files: Buildium" tags: - units security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: unit_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_units_buildium_{unit_id}_file-upload__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_units_buildium_{unit_id}_file-upload__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/units/entrata/{id}/file-upload/: post: description: Entrata does not support creating a unit file via their API. This endpoint will always return a 405, with an error message specifying that creating a unit file in an Entrata integration is not supported due to the lack of upstream support. summary: "Create Unit file: Entrata - Not Supported" tags: - units security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_units_entrata_{id}_file-upload__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_units_entrata_{id}_file-upload__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/units/rentvine/{unit_id}/file-upload/: post: description: |- Create Unit File: Rentvine Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Unit File: Rentvine" tags: - units security: - bearerAuth: [] parameters: - schema: type: string description: The Propexo unique identifier for the unit required: true description: The Propexo unique identifier for the unit name: unit_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_units_rentvine_{unit_id}_file-upload__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_units_rentvine_{unit_id}_file-upload__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/units/propertyware/{unit_id}/file-upload/: post: description: |- Create Unit File: Propertyware Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Unit File: Propertyware" tags: - units security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: unit_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_units_propertyware_{unit_id}_file-upload__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_units_propertyware_{unit_id}_file-upload__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/units/yardi/{id}/file-upload/: post: description: Yardi does not support creating a unit file via their API. This endpoint will always return a 405, with an error message specifying that creating a unit file in a Yardi integration is not supported due to the lack of upstream support. summary: "Create Unit file: Yardi - Not Supported" tags: - units security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_units_yardi_{id}_file-upload__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_units_yardi_{id}_file-upload__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/units/rentmanager/{unit_id}/file-upload/: post: description: |- Create Unit Files: Rent Manager Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Unit Files: Rent Manager" tags: - units security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: unit_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_units_rentmanager_{unit_id}_file-upload__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_units_rentmanager_{unit_id}_file-upload__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/units/rentmanager/{unit_id}/notes/: post: description: |- Note: In the case of a failed file upload, we will attempt to upload the file again if we receive a 500 runtime error from Rent Manager. If the file is still not uploaded, we will return an error. Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Unit Note: Rent Manager" tags: - units security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: unit_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_units_rentmanager_{unit_id}_notes__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_units_rentmanager_{unit_id}_notes__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/vendors/: get: description: Get all vendors summary: Get all vendors tags: - vendors security: - bearerAuth: [] parameters: - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query - schema: type: string description: The external ID from the integration vendor required: false description: The external ID from the integration vendor name: x_id in: query - schema: type: string description: The external ID of the property from the integration vendor required: false description: The external ID of the property from the integration vendor name: x_property_id in: query - schema: type: string description: The Propexo unique identifier for the property required: false description: The Propexo unique identifier for the property name: property_id in: query - schema: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. required: false description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: location_id in: query - schema: type: string description: The Propexo unique identifier for the integration required: false description: The Propexo unique identifier for the integration name: integration_id in: query - schema: type: string enum: *a287 description: The property management system of record required: false description: The property management system of record name: integration_vendor in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_vendors__get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" post: description: Create a vendor for an integration. summary: Create a vendor tags: - vendors security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_vendors__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_vendors__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/vendors/{vendor_id}: get: description: Get vendor by ID summary: Get vendor by ID tags: - vendors security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: vendor_id in: path - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_vendors_{vendor_id}_get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" put: description: Update a vendor for an integration. summary: Update vendor tags: - vendors security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: vendor_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_vendors_{vendor_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_vendors_{vendor_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/vendor-locations/: get: description: Get all vendor locations summary: Get all vendor locations tags: - vendors security: - bearerAuth: [] parameters: - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query - schema: type: string description: The external ID from the integration vendor required: false description: The external ID from the integration vendor name: x_id in: query - schema: type: string description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. required: false description: The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: location_id in: query - schema: type: string description: The Propexo unique identifier for the property required: false description: The Propexo unique identifier for the property name: property_id in: query - schema: type: string description: The Propexo unique identifier for the integration required: false description: The Propexo unique identifier for the integration name: integration_id in: query - schema: type: string enum: *a287 description: The property management system of record required: false description: The property management system of record name: integration_vendor in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_vendor-locations__get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/vendor-locations/{vendor_location_id}: get: description: Get vendor location by ID summary: Get vendor location by ID tags: - vendors security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: vendor_location_id in: path - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_vendor-locations_{vendor_location_id}_get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/vendors/properties/{property_id}: get: description: Get all vendors by property ID summary: Get all vendors by property ID tags: - vendors security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: property_id in: path - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_vendors_properties_{property_id}_get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/vendors/buildium/: post: description: |- Create a vendor for Buildium This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately. summary: Create a vendor for Buildium tags: - vendors security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_vendors_buildium__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_vendors_buildium__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/vendors/yardi/: post: description: |- Create Vendor: Yardi Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Vendor: Yardi" tags: - vendors security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_vendors_yardi__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_vendors_yardi__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/vendors/yardi/{vendor_id}: put: description: "Update Vendor: Yardi" summary: "Update Vendor: Yardi" tags: - vendors security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: vendor_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_vendors_yardi_{vendor_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_vendors_yardi_{vendor_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/vendors/yardi_rest/: post: description: |- Create Vendor: Yardi REST This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately. summary: "Create Vendor: Yardi REST" tags: - vendors security: - bearerAuth: [] x-fern-availability: beta requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_vendors_yardi_rest__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_vendors_yardi_rest__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/vendors/yardi_rest/{vendor_id}: put: description: "Update Vendor: Yardi REST" summary: "Update Vendor: Yardi REST" tags: - vendors security: - bearerAuth: [] x-fern-availability: beta parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: vendor_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_vendors_yardi_rest_{vendor_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_vendors_yardi_rest_{vendor_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/vendors/resman/: post: description: ResMan does not support creating a service request vendor via their API. This endpoint will always return a 405, with an error message specifying that creating a service request vendor in a ResMan integration is not supported due to the lack of upstream support. summary: "Create Service Request Vendor: ResMan - Not Supported" tags: - vendors security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_vendors_resman__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_vendors_resman__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/vendors/resman/{vendor_id}: put: description: ResMan does not support updating a service request vendor via their API. This endpoint will always return a 405, with an error message specifying that updating a service request vendor in a ResMan integration is not supported due to the lack of upstream support. summary: "Update Service Request Vendor: ResMan - Not Supported" tags: - vendors security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: vendor_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_vendors_resman_{vendor_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_vendors_resman_{vendor_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/vendors/entrata/: post: description: |- Create a vendor for Entrata This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately. summary: Create a vendor for Entrata tags: - vendors security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_vendors_entrata__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_vendors_entrata__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/vendors/resman/file-upload/: post: description: ResMan does not support creating a service request vendor file via their API. This endpoint will always return a 405, with an error message specifying that creating a service request vendor file in a ResMan integration is not supported due to the lack of upstream support. summary: "Create Service Request Vendor file: ResMan - Not Supported" tags: - vendors security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_vendors_resman_file-upload__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_vendors_resman_file-upload__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/vendors/propertyware/{vendor_id}/file-upload/: post: description: |- Create Vendor File: Propertyware Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync. summary: "Create Vendor File: Propertyware" tags: - vendors security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: vendor_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_vendors_propertyware_{vendor_id}_file-upload__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_vendors_propertyware_{vendor_id}_file-upload__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/webhooks/: get: description: Get all webhooks summary: Get all webhooks tags: - webhooks-configuration security: - bearerAuth: [] parameters: - schema: type: - boolean - "null" default: true description: Filter by active status required: false description: Filter by active status name: active in: query - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_webhooks__get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" post: description: Create a webhook summary: Create a webhook tags: - webhooks-configuration security: - bearerAuth: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_webhooks__post_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_webhooks__post_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /v1/webhooks/{webhook_id}: get: description: Get a webhook by ID summary: Get a webhook by ID tags: - webhooks-configuration security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: webhook_id in: path - schema: type: string default: created_at:desc description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" required: false description: "Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc" name: order-by in: query - schema: type: - integer - "null" minimum: 0 default: 0 description: Can be used for paginating results required: false description: Can be used for paginating results name: offset in: query - schema: type: - integer - "null" minimum: 0 maximum: 250 default: 100 description: A number between 1 and 250 to determine the number of results to return in a single query required: false description: A number between 1 and 250 to determine the number of results to return in a single query name: limit in: query responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_webhooks_{webhook_id}_get_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" put: description: Update a webhook summary: Update a webhook tags: - webhooks-configuration security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the resource. required: true description: The ID of the resource. name: webhook_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_webhooks_{webhook_id}_put_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_webhooks_{webhook_id}_put_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" delete: description: Delete a webhook summary: Delete a webhook tags: - webhooks-configuration security: - bearerAuth: [] parameters: - schema: type: string description: The ID of the webhook to delete required: true description: The ID of the webhook to delete name: webhook_id in: path requestBody: content: application/json: schema: $ref: "#/components/schemas/_v1_webhooks_{webhook_id}_delete_input" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/_v1_webhooks_{webhook_id}_delete_output" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/errorResponse" /data_new: post: operationId: _v1_webhooks_data_new tags: - webhooks x-fern-webhook: true requestBody: content: application/json: schema: type: object properties: trigger: type: string enum: - DATA_NEW data: type: object properties: job_id: type: string root_job_id: type: string integration_id: type: string job_type: type: string vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST event: type: string enum: - DATA_NEW record_id: type: string object: type: string enum: &a352 - accounting-entities - address-types - amenities - ap-codes - ap-codes-to-construction-job - applicant-pets - applicants - applicants-to-applications - applicants-to-events - applicants-to-rentable-items - application-statuses - applications - call-logs - charge-code-types - charge-code-types-to-charge-timings - charge-codes - charge-timings - concessions - construction-job-details - construction-jobs - contract-details - contracts - crm-agents - crm-amenities - crm-attributions - crm-communities - crm-communities-to-agents - crm-communities-to-attributions - crm-events - crm-listings - crm-pet-policies - crm-prospects - deposit-summaries - deposits - employees - entrata-lease-periods - entrata-unit-types - entrata-vendor-locations - event-results - event-results-to-event-types - event-sub-types - event-types - events - fees - file-types - financial-accounts - floor-plans - integration-configuration-meta-data - invoice-items - invoices - lead-pets - lead-relationships - lead-sources - leads - leads-to-events - leads-to-rentable-items - lease-services - lease-transfers - leases - listings - locations - note-categories - owners - owners-to-properties - payable-register-items - payable-registers - pet-types - properties - property-lists - property-lists-to-properties - property-office-hours - purchase-order-items - purchase-order-items-to-invoices - purchase-orders - recurring-resident-charges - rentable-items - rentvine-application-templates - resident-allocations - resident-charges - resident-insurance - resident-payments - resident-pets - resident-vehicles - residents - residents-to-events - residents-to-leases - residents-to-rentable-items - screenings - service-request-access-contacts - service-request-categories - service-request-locations - service-request-notes - service-request-priorities - service-request-problems - service-request-statuses - service-request-vendor-categories - service-request-vendor-contacts - service-request-vendors - service-request-vendors-insurance - service-request-vendors-to-properties - service-requests - service-requests-to-employees - service-requests-to-vendors - timezones - transactions - unit-details - unit-pricing - units - units-to-amenity - vendor-insurance-coverage-types - vendor-insurance-policy-types - vendor-payment-types payload: anyOf: - type: object properties: {} title: accounting-entities - type: object properties: id: type: string description: The Propexo unique identifier for the address type created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: string description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: type: string description: The name associated with the address type description: type: - string - "null" description: Description of the address type integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property title: address-types - type: object properties: id: type: string description: The Propexo unique identifier for the amenity created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_listing_id: type: - string - "null" description: The external ID of the listing from the integration vendor x_parent_amenity_id: type: - string - "null" description: The external ID from the integration vendor of the amenity this unit and/or property amenity is associated with x_property_id: type: string description: The external ID of the property from the integration vendor x_unit_id: type: - string - "null" description: 'DEPRECATED: Please use the "units" field to see the associated units with this amenity' deprecated: true cost_in_cents: type: *a9 description: Cost in cents for the amenity example: 100000 custom_data: type: - object - "null" properties: {} description: Custom data description: type: - string - "null" description: Description of the amenity image_urls: type: array items: type: string example: https://loremflickr.com/640/480/apartment description: A list of image urls associated with the amenity is_unit_amenity: type: - boolean - "null" description: Whether the amenity is a unit amenity meta_data: type: - object - "null" properties: {} description: Meta data for the amenity name_normalized: type: - string - "null" enum: *a10 description: The name associated with the amenity name: type: string description: The name associated with the amenity units: type: array items: type: object properties: amenity_id: type: string description: The Propexo unique identifier for the amenity example: cm2j4ivcv0000eioz6rd365se unit_id: type: string description: The Propexo unique identifier for the unit example: cm2j4jbzf0002eiozdudz9bda cost_in_cents: type: *a11 description: Cost in cents for the amenity on a particular unit example: 100000 required: - amenity_id - unit_id - cost_in_cents x-propexo: *a12 description: List of unit ids associated with the amenity integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property cost_in_cents_int: type: number title: amenities - type: object properties: {} title: ap-codes - type: object properties: {} title: ap-codes-to-construction-job - type: object properties: {} title: applicant-pets - type: object properties: id: type: string description: The Propexo unique identifier for the applicant created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_unit_id: type: - string - "null" description: "DEPRECATED: Use x_unit_id_preferred instead" deprecated: true x_lease_id: type: - string - "null" description: "DEPRECATED: Not in use." deprecated: true x_lead_id: type: - string - "null" description: The external ID of the lead from the integration vendor x_unit_id_preferred: type: array items: type: string description: The external IDs of the units from the integration vendor that the applicant is interested in address_1_alternate: type: - string - "null" description: The first alternate address line associated with the applicant address_1: type: - string - "null" description: The first address line associated with the applicant address_2_alternate: type: - string - "null" description: The second alternate address line associated with the applicant address_2: type: - string - "null" description: The second address line associated with the applicant applications: type: array items: type: object properties: applicant_id: type: string application_id: type: string status: type: - string - "null" description: DEPRECATED. Use status_raw or status_normalized deprecated: true status_raw: type: - string - "null" description: The raw status associated with the applicant status_normalized: anyOf: - type: string enum: - APPROVED - DENIED - CANCELED - OTHER - PENDING - type: string - type: "null" description: The normalized status associated with the applicant. Confirm these derived values before using them in production. custom_data: type: - object - "null" properties: {} description: Custom data required: - applicant_id - application_id x-propexo: *a295 description: Applications that the applicant has submitted city_alternate: type: - string - "null" description: The alternate city associated with the applicant city: type: - string - "null" description: The city associated with the applicant country_alternate: type: - string - "null" description: The alternate country associated with the applicant country: type: - string - "null" description: The country associated with the applicant custom_data: type: - object - "null" properties: {} description: Custom data date_of_birth: type: - string - "null" description: The date of birth associated with the applicant email_1: type: - string - "null" description: The primary email address associated with the applicant email_2: type: - string - "null" description: The secondary email address associated with the applicant first_name: type: - string - "null" description: The first name associated with the applicant self_reported_income: type: array items: $ref: "#/components/schemas/IncomeSource" description: Self reported income sources for the applicant last_name: type: - string - "null" description: The last name associated with the applicant middle_name: type: - string - "null" description: The middle name associated with the applicant notes: type: - string - "null" description: Notes associated with the applicant phone_1_type: type: - string - "null" enum: - FAX - HOME - MOBILE - OTHER - WORK description: Type of the primary phone number phone_1: type: - string - "null" description: Primary phone number associated with the applicant phone_2_type: type: - string - "null" enum: - FAX - HOME - MOBILE - OTHER - WORK description: Type of the secondary phone number phone_2: type: - string - "null" description: Secondary phone number associated with the applicant state_alternate: type: - string - "null" description: The alternate state associated with the applicant state: type: - string - "null" description: The state associated with the applicant type_normalized: type: - string - "null" description: The normalized type associated with the applicant type_raw: type: - string - "null" description: The raw type associated with the applicant zip_alternate: type: - string - "null" description: The alternate zip code associated with the applicant zip: type: - string - "null" description: The zip code associated with the applicant pets: type: array items: type: object properties: id: type: string description: The Propexo unique identifier for the applicant pet created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor age_in_years: type: - number - "null" description: The age in years of the applicant pet breed: type: - string - "null" description: The breed of the applicant pet color: type: - string - "null" description: The color of the applicant pet gender_raw: type: - string - "null" description: The raw value for the gender of the applicant pet is_declawed: type: - boolean - "null" description: Whether the applicant pet is declawed is_fixed: type: - boolean - "null" description: Whether the applicant pet is fixed is_service_animal: type: - boolean - "null" description: Whether the applicant pet is a service animal is_trained: type: - boolean - "null" description: Whether the applicant pet is trained is_vaccinated: type: - boolean - "null" description: Whether the applicant pet is vaccinated name: type: - string - "null" description: The name associated with the applicant pet notes: type: - string - "null" description: Notes associated with the applicant pet type: type: - string - "null" description: The type associated with the applicant pet weight_in_pounds: type: - number - "null" description: The weight in pounds of the applicant pet custom_data: type: - object - "null" properties: {} description: Custom data required: - id - created_at - updated_at - last_seen - x_id - age_in_years - breed - color - gender_raw - is_declawed - is_fixed - is_service_animal - is_trained - is_vaccinated - name - notes - type - weight_in_pounds - custom_data x-propexo: *a296 integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property unit_id_preferred: type: array items: type: string description: The Propexo unique identifiers for the units that the applicant is interested in screenings: type: array items: type: object properties: id: type: string description: The Propexo ID of the screening created_at: type: string description: The date record first entered Propexo last_seen: type: string description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor status_raw: type: - string - "null" description: The status/results of the screening screening_date: type: - string - "null" description: The date the screening took place required: - id - created_at - last_seen - x_id - status_raw - screening_date x-propexo: *a153 title: applicants - type: object properties: applicant_id: type: string application_id: type: string status: type: - string - "null" description: DEPRECATED. Use status_raw or status_normalized deprecated: true status_raw: type: - string - "null" description: The raw status associated with the applicant status_normalized: anyOf: - type: string enum: - APPROVED - DENIED - CANCELED - OTHER - PENDING - type: string - type: "null" description: The normalized status associated with the applicant. Confirm these derived values before using them in production. custom_data: type: - object - "null" properties: {} description: Custom data title: applicants-to-applications - type: object properties: {} title: applicants-to-events - type: object properties: {} title: applicants-to-rentable-items - type: object properties: id: type: string description: The Propexo unique identifier for the application status created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: type: string description: The name associated with the application status property_id: type: string description: The Propexo unique identifier for the property integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record title: application-statuses - type: object properties: id: type: string description: The Propexo unique identifier for the application created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_property_id: type: string description: The external ID of the property from the integration vendor x_unit_id: type: - string - "null" description: The external ID of the unit from the integration vendor status: type: string description: The raw status associated with the application custom_data: type: - object - "null" properties: {} description: Custom data integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property unit_id: type: - string - "null" description: The Propexo unique identifier for the unit title: applications - type: object properties: id: type: string description: The Propexo unique identifier for the call log created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_lead_source_id: type: - string - "null" description: The external ID of the lead source from the integration vendor custom_data: type: - object - "null" properties: {} description: Custom data lead_source: type: - string - "null" description: The name of the source of the lead origin_phone_number: type: - string - "null" description: The phone number that originated the call for the call log integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property lead_source_id: type: - string - "null" description: The Propexo unique identifier for the lead source title: call-logs - type: object properties: {} title: charge-code-types - type: object properties: {} title: charge-code-types-to-charge-timings - type: object properties: id: type: string description: The Propexo unique identifier for the charge code created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. debit_gl_account: type: - string - "null" description: The GL account number for debits credit_gl_account: type: - string - "null" description: The GL account number for credits name: type: - string - "null" description: The name of the charge code description: type: - string - "null" description: A description of this charge code custom_data: type: - object - "null" properties: {} description: Custom data property_id: type: string description: The Propexo unique identifier for the property integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record title: charge-codes - type: object properties: {} title: charge-timings - type: object properties: id: type: string description: The Propexo unique identifier for the concession created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_unit_id: type: - string - "null" description: The external ID of the unit from the integration vendor x_floor_plan_id: type: - string - "null" description: The external ID of the floor plan from the integration vendor total_amount_in_cents: type: - integer - "null" description: The total amount of the concession start_date: type: - string - "null" description: The start date associated with the concession end_date: type: - string - "null" description: The end date associated with the concession is_active: type: - boolean - "null" description: Whether the concession is active description: type: - string - "null" description: Description of the concession is_one_time: type: - boolean - "null" description: Whether or not the concession occurs a single time is_recurring: type: - boolean - "null" description: Whether or not the concession is recurring monthly_fixed_amount_in_cents: type: - integer - "null" description: The monthly fixed amount of the concession in cents monthly_percentage_amount: type: - integer - "null" description: The monthly percentage amount of the concession. This is rounded to the nearest percent monthly_percentage_raw: type: - string - "null" description: The raw monthly percentage amount of the concession as a string, preserving decimal precision one_time_fixed_amount_in_cents: type: - integer - "null" description: The one time fixed amount of the concession in cents one_time_percentage_amount: type: - integer - "null" description: The one time percentage amount of the concession. This is rounded to the nearest percent one_time_percentage_raw: type: - string - "null" description: The raw one time percentage amount of the concession as a string, preserving decimal precision number_of_occurrences: type: - integer - "null" description: The number of occurrences of the concession fixed_amount_in_cents: type: - integer - "null" description: The fixed amount of the concession in cents percentage_amount: type: - integer - "null" description: The percentage amount of the concession. This is rounded to the nearest percent percentage_raw: type: - string - "null" description: The raw percentage amount of the concession as a string, preserving decimal precision lease_term_in_months: type: - integer - "null" description: The amount of months for the lease term lease_term_raw: type: - string - "null" description: The raw value for the lease term concession_formula_raw: type: - string - "null" description: The raw formula name used to calculate the concession (e.g., "Fixed Amount", "Percent of Charge Code Group") integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property unit_id: type: - string - "null" description: The Propexo unique identifier for the unit floor_plan_id: type: - string - "null" description: The Propexo unique identifier for the floor plan title: concessions - type: object properties: id: type: string description: The Propexo unique identifier for the construction job created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. category_description: type: - string - "null" description: The description of the category for the construction job detail cost_code: type: - string - "null" description: The cost code of the construction job detail original_budget_in_cents: type: *a297 description: The original budget of the construction job detail example: 100000 revised_budget_in_cents: type: *a298 description: The revised budget of the construction job detail example: 100000 invoiced_total_in_cents: type: *a299 description: The total amount invoiced, in cents, for the construction job detail example: 100000 custom_data: type: - object - "null" properties: {} description: Custom data property_id: type: string description: The Propexo unique identifier for the property integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record original_budget_in_cents_int: type: number revised_budget_in_cents_int: type: number invoiced_total_in_cents_int: type: number title: construction-job-details - type: object properties: id: type: string description: The Propexo unique identifier for the construction job created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_gl_account_id: type: - string - "null" description: The external ID of the general ledger account from the integration vendor actual_end_date: type: - string - "null" description: The actual date the construction job ended actual_start_date: type: - string - "null" description: The actual date the construction job started name: type: string description: The name associated with the construction job planned_end_date: type: - string - "null" description: The date the construction job was planned to end planned_start_date: type: - string - "null" description: The date the construction job was planned to start status_normalized: type: - string - "null" description: The normalized status for the construction job status_raw: type: - string - "null" description: The raw status associated with the construction job total_budget_in_cents: type: *a300 description: The total budget for the construction job example: 100000 custom_data: type: - object - "null" properties: {} description: Custom data property_id: type: string description: The Propexo unique identifier for the property integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record total_budget_in_cents_int: type: number title: construction-jobs - type: object properties: id: type: string description: The Propexo unique identifier for the contract detail created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_category_id: type: - string - "null" description: The external ID of the category from the integration vendor x_financial_account_id: type: - string - "null" description: The external ID of the financial account from the integration vendor category_description: type: - string - "null" description: The description of the category for the contract detail cost_code: type: - string - "null" description: The cost code of the contract detail custom_data: type: - object - "null" properties: {} description: Custom data invoiced_total_in_cents: type: *a301 description: The total amount invoiced, in cents, for the contract detail example: 100000 notes: type: - string - "null" description: Notes associated with the contract detail retention_percent: type: - string - "null" description: The retention percent of the contract detail total_amount_in_cents: type: *a302 description: The total amount of the contract detail example: 100000 contract_id: type: string description: The Propexo unique identifier for the contract financial_account_id: type: - string - "null" description: The Propexo unique identifier for the financial account property_id: type: string description: The Propexo unique identifier for the property integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record invoiced_total_in_cents_int: type: number total_amount_in_cents_int: type: number title: contract-details - type: object properties: id: type: string description: The Propexo unique identifier for the contract created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_construction_job_id: type: - string - "null" description: The external ID of the construction job from the integration vendor x_vendor_id: type: - string - "null" description: The external ID of the vendor from the integration vendor custom_data: type: - object - "null" properties: {} description: Custom data end_date: type: - string - "null" description: The end date associated with the contract expense_type: type: - string - "null" description: The expense type of the contract invoiced_total_in_cents: type: *a303 description: The total amount invoiced, in cents, for the contract example: 100000 notes: type: - string - "null" description: Notes associated with the contract original_amount_in_cents: type: *a304 description: The original amount of the contract example: 100000 retention_percent: type: - string - "null" description: The retention percent of the contract start_date: type: - string - "null" description: The start date associated with the contract status_normalized: type: - string - "null" description: The normalized status for the contract status_raw: type: - string - "null" description: The raw status associated with the contract total_amount_in_cents: type: *a305 description: The total amount of the contract example: 100000 construction_job_id: type: - string - "null" description: The Propexo unique identifier for the construction job vendor_id: type: - string - "null" description: The Propexo unique identifier for the vendor property_id: type: string description: The Propexo unique identifier for the property integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record invoiced_total_in_cents_int: type: number original_amount_in_cents_int: type: number total_amount_in_cents_int: type: number title: contracts - type: object properties: id: type: string description: The Propexo unique identifier for the agent created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor custom_data: type: - object - "null" properties: {} description: Custom data name: type: - string - "null" description: The name associated with the agent email: type: - string - "null" description: The primary email address associated with the agent phone: type: - string - "null" description: Primary phone number associated with the agent is_active: type: - boolean - "null" description: Whether the agent is active roles: type: - array - "null" items: type: string description: The roles associated with the agent integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record title: crm-agents - type: object properties: {} title: crm-amenities - type: object properties: id: type: string description: The Propexo unique identifier for the attribution created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor custom_data: type: - object - "null" properties: {} description: Custom data name: type: - string - "null" description: The name associated with the attribution email: type: - string - "null" description: The primary email address associated with the attribution url: type: - string - "null" description: The primary url associated with the attribution is_active: type: - boolean - "null" description: Whether the attribution is active integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The CRM system of record title: crm-attributions - type: object properties: id: type: string description: The Propexo unique identifier for the community created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor custom_data: type: - object - "null" properties: {} description: Custom data address_1: type: - string - "null" description: The first address line associated with the community address_2: type: - string - "null" description: The second address line associated with the community city: type: - string - "null" description: The city associated with the community state: type: - string - "null" description: The state associated with the community zip: type: - string - "null" description: The zip code associated with the community url: type: - string - "null" description: The primary url associated with the community email: type: - string - "null" description: The primary email address associated with the community phone: type: - string - "null" description: Primary phone number associated with the community coordinates: type: object properties: lat: type: - string - "null" description: The latitude associated with the community x-propexo: &a353 derivedFromField: lat_string long: type: - string - "null" description: The longitude associated with the community x-propexo: &a354 derivedFromField: long_string required: - lat - long description: The coordinates associated with the community x-propexo: &a355 derivedFromModel: crm_communities integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The CRM system of record title: crm-communities - type: object properties: {} title: crm-communities-to-agents - type: object properties: {} title: crm-communities-to-attributions - type: object properties: id: type: string description: The Propexo unique identifier for the event created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_agent_id: type: - string - "null" description: The external ID of the agent from the integration vendor x_community_id: type: string description: The external ID of the community from the integration vendor x_created_at: type: - string - "null" description: The date the record first entered the integration vendor x_id: type: string description: The external ID from the integration vendor x_prospect_id: type: string description: The external ID of the prospect from the integration vendor appointment_datetime: type: - string - "null" description: The date when the appointment will occur appointment_duration_minutes: type: - number - "null" description: The duration of the appointment, in minutes custom_data: type: - object - "null" properties: {} description: Custom data event_datetime: type: - string - "null" description: The date when the event will occur notes: type: - string - "null" description: Notes associated with the event type_raw: type: - string - "null" description: The raw type associated with the event agent_id: type: - string - "null" description: The Propexo unique identifier for the agent community_id: type: string description: The Propexo unique identifier for the community prospect_id: type: string description: The Propexo unique identifier for the prospect integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The CRM system of record title: crm-events - type: object properties: id: type: string description: The Propexo unique identifier for the listing created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_community_id: type: - string - "null" description: The external ID of the community from the integration vendor available_date: type: - string - "null" description: The date that the listing becomes available bathrooms: type: - string - "null" description: The number of bathrooms associated with the listing bathrooms_full: type: - number - "null" description: The number of full bathrooms associated with the listing bathrooms_half: type: - number - "null" description: The number of half bathrooms associated with the listing bedrooms: type: - string - "null" description: The number of bedrooms associated with the listing building_name: type: - string - "null" description: The building name associated with the listing city: type: - string - "null" description: The city associated with the listing custom_data: type: - object - "null" properties: {} description: Custom data floor: type: - string - "null" description: The floor number/name associated with the listing image_urls_array: type: - array - "null" items: type: string description: A list of image urls associated with the listing is_furnished: type: - boolean - "null" description: Whether the listing is furnished is_listed: type: - boolean - "null" description: Whether the listing is listed notes: type: - string - "null" description: Notes associated with the listing number: type: - string - "null" description: The unit number property_description: type: - string - "null" description: Description of the property publish_date: type: - string - "null" description: The date the listing was published rent_amount_in_cents: type: &a356 - number - "null" description: The rent amount in cents for the listing example: 100000 square_feet: type: - number - "null" description: The square footage of the listing state: type: - string - "null" description: The state associated with the listing status_raw: type: - string - "null" description: The raw status associated with the listing street_address_1: type: - string - "null" description: The first address line associated with the listing street_address_2: type: - string - "null" description: The second address line associated with the listing title: type: - string - "null" description: The title associated with the listing url: type: - string - "null" description: The application url associated with the listing video_urls: type: - array - "null" items: type: string description: A list of video urls associated with the listing zip: type: - string - "null" description: The zip code associated with the listing community_id: type: - string - "null" description: The Propexo unique identifier for the community integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The CRM system of record rent_amount_in_cents_int: type: number title: crm-listings - type: object properties: {} title: crm-pet-policies - type: object properties: id: type: string description: The Propexo unique identifier for the prospect created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_community_id: type: - string - "null" description: The external ID of the community from the integration vendor custom_data: type: - object - "null" properties: {} description: Custom data first_name: type: - string - "null" description: The first name associated with the prospect last_name: type: - string - "null" description: The last name associated with the prospect address_raw: type: - string - "null" description: The raw address associated with the prospect address_1: type: - string - "null" description: The first address line associated with the prospect address_2: type: - string - "null" description: The second address line associated with the prospect city: type: - string - "null" description: The city associated with the prospect state: type: - string - "null" description: The state associated with the prospect zip: type: - string - "null" description: The zip code associated with the prospect email: type: - string - "null" description: The primary email address associated with the prospect phone_1: type: - string - "null" description: Primary phone number associated with the prospect phone_2: type: - string - "null" description: Secondary phone number associated with the prospect move_in_date: type: - string - "null" description: The move-in date associated with the prospect minimum_budget_in_cents: type: &a357 - number - "null" description: The minimum budget, in cents, of the prospect example: 100000 maximum_budget_in_cents: type: &a358 - number - "null" description: The maximum budget, in cents, of the prospect example: 100000 community_id: type: - string - "null" description: The Propexo unique identifier for the community integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The CRM system of record minimum_budget_in_cents_int: type: number maximum_budget_in_cents_int: type: number title: crm-prospects - type: object properties: id: type: string description: The Propexo unique identifier for the deposit summary created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_resident_id: type: string description: The external ID of the resident from the integration vendor x_building_id: type: - string - "null" description: The external ID of the building (not necessarily the property) from the integration vendor x_invoice_id: type: - string - "null" description: The external ID of the invoice from the integration vendor x_lease_id: type: - string - "null" description: The external ID of the lease from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_unit_id: type: - string - "null" description: The external ID of the unit from the integration vendor amount_charged_in_cents: type: *a116 description: The amount charged in cents example: 100000 amount_paid_in_cents: type: *a117 description: The amount paid in cents example: 100000 amount_refunded_in_cents: type: *a118 description: The amount refunded in cents example: 100000 notes: type: - string - "null" description: Notes associated with the deposit summary refund_amount_due_in_cents: type: *a119 description: The refund amount due in cents example: 100000 custom_data: type: - object - "null" properties: {} description: Custom data integration_data: type: - object - "null" properties: {} description: Integration-specific data integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record invoice_id: type: - string - "null" description: The Propexo unique identifier for the invoice lease_id: type: - string - "null" description: The Propexo unique identifier for the lease unit_id: type: - string - "null" description: The Propexo unique identifier for the unit resident_id: type: string description: The Propexo unique identifier for the resident property_id: type: string description: The Propexo unique identifier for the property amount_charged_in_cents_int: type: number amount_paid_in_cents_int: type: number amount_refunded_in_cents_int: type: number refund_amount_due_in_cents_int: type: number title: deposit-summaries - type: object properties: id: type: string description: The Propexo unique identifier for the deposit created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_resident_id: type: string description: The external ID of the resident from the integration vendor x_building_id: type: - string - "null" description: The external ID of the building (not necessarily the property) from the integration vendor x_deposit_type: type: - string - "null" description: The external type of the deposit from the integration vendor x_lease_id: type: - string - "null" description: The external ID of the lease from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. amount_charged_in_cents: type: *a122 description: The amount charged in cents example: 100000 amount_paid_in_cents: type: *a123 description: The amount paid in cents example: 100000 amount_refunded_in_cents: type: *a124 description: The amount refunded in cents example: 100000 notes: type: - string - "null" description: Notes associated with the deposit refund_amount_due_in_cents: type: *a125 description: The refund amount due in cents example: 100000 custom_data: type: - object - "null" properties: {} description: Custom data integration_data: type: - object - "null" properties: {} description: Integration-specific data integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record lease_id: type: - string - "null" description: The Propexo unique identifier for the lease resident_id: type: string description: The Propexo unique identifier for the resident property_id: type: string description: The Propexo unique identifier for the property amount_charged_in_cents_int: type: number amount_paid_in_cents_int: type: number amount_refunded_in_cents_int: type: number refund_amount_due_in_cents_int: type: number title: deposits - type: object properties: id: type: string description: The Propexo unique identifier for the employee created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: type: - string - "null" description: The name associated with the employee email: type: - string - "null" description: The primary email address associated with the employee is_active: type: - boolean - "null" description: Whether the employee is active roles: type: array items: type: string description: The roles associated with the employee integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property title: employees - type: object properties: id: type: string description: The Propexo unique identifier for the lease period created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_application_template_id: type: - string - "null" description: The external ID of the application template from the integration vendor name: type: string description: The name associated with the lease period application_template_id: type: - string - "null" description: The Propexo unique identifier for the application template integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property title: entrata-lease-periods - type: object properties: id: type: string description: The Propexo unique identifier for the unit type created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: type: string description: The name associated with the unit type bedrooms: type: - integer - "null" minimum: 0 description: The number of bedrooms associated with the unit type bathrooms: type: - string - "null" description: The number of bathrooms associated with the unit type bathrooms_full: type: - integer - "null" minimum: 0 description: The number of full bathrooms associated with the unit type bathrooms_half: type: - integer - "null" minimum: 0 description: The number of half bathrooms associated with the unit type rentable_square_feet: type: - integer - "null" minimum: 0 description: The rentable square footage of the unit type gross_square_feet: type: - integer - "null" minimum: 0 description: The gross square footage of the unit type rent_minimum_in_cents: type: *a256 description: The minimum rent of the unit type example: 100000 rent_maximum_in_cents: type: *a257 description: The maximum rent of the unit type example: 100000 unit_count: type: - integer - "null" minimum: 0 description: The number of units associated with the unit type deposit_amount_in_cents: type: *a258 description: The deposit amount in cents associated with the unit type example: 100000 deposit_amount_raw: type: - string - "null" description: The raw deposit amount associated with the unit type integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property rent_minimum_in_cents_int: type: number rent_maximum_in_cents_int: type: number deposit_amount_in_cents_int: type: number title: entrata-unit-types - type: object properties: id: type: string description: The Propexo unique identifier for the vendor location created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: type: string description: The name associated with the vendor location integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property title: entrata-vendor-locations - type: object properties: id: type: string description: The Propexo unique identifier for the event type created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: type: string description: The name associated with the event type integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property associated_event_type_ids: type: array items: type: string description: The Propexo unique identifier for the event type x-propexo: &a359 derivedFromModel: event_results_to_event_types title: event-results - type: object properties: {} title: event-results-to-event-types - type: object properties: id: type: string description: The Propexo unique identifier for the event sub type created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_event_type_id: type: - string - "null" description: The external ID of the event type from the integration vendor name: type: string description: The name associated with the event sub type integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property event_type_id: type: - string - "null" description: The Propexo unique identifier for the event type title: event-sub-types - type: object properties: id: type: string description: The Propexo unique identifier for the event type created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. code: type: - string - "null" description: The code associated with the event type models: type: array items: type: string description: The Propexo data models (e.g. units, residents, applicants, etc.) associated with the event type name: type: string description: The name associated with the event type integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property title: event-types - type: object properties: id: type: string description: The Propexo unique identifier for the event created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_leasing_agent_id: type: - string - "null" description: The external ID of the leasing agent from the integration vendor x_type_id: type: - string - "null" description: The external ID of the type from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. event_name: type: - string - "null" description: The name of the event event_datetime: type: - string - "null" description: The datetime that the event occurred appointment_datetime: type: - string - "null" description: The datetime that the event appointment occurred type_raw: type: - string - "null" description: The type of event notes: type: - string - "null" description: Notes associated with the event agent_name: type: - string - "null" description: The name of the agent associated with the event reasons_for_event: type: - string - "null" description: Reasons that the event occurred associated_lead_ids: type: - array - "null" items: type: string example: cm2jeb8af00042qoza7lcb5cx description: The lead IDs associated with the event associated_applicant_ids: type: - array - "null" items: type: string x-propexo: *a306 description: The applicant IDs associated with the event associated_resident_ids: type: - array - "null" items: type: string example: cm2jebkdu00072qozfa5p9rs7 description: The resident IDs associated with the event integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property title: events - type: object properties: id: type: string description: The Propexo unique identifier for the fee created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_charge_code_id: type: - string - "null" description: The external ID of the charge code from the integration vendor x_floor_plan_id: type: - string - "null" description: The external ID of the floor plan from the integration vendor x_unit_id: type: - string - "null" description: The external ID of the unit from the integration vendor amount_in_cents: type: *a307 description: The amount of the fee, in cents example: 12500 amount_raw: type: - string - "null" description: The raw value for amount from the PMS charge_code_name: type: - string - "null" description: The name of the charge code description: type: - string - "null" description: Description of the fee name: type: - string - "null" description: The name associated with the fee custom_data: type: - object - "null" additionalProperties: {} description: Custom data integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property floor_plan_id: type: - string - "null" description: The Propexo unique identifier for the floor plan unit_id: type: - string - "null" description: The Propexo unique identifier for the unit charge_code_id: type: - string - "null" description: The Propexo unique identifier for the charge code amount_in_cents_int: type: number title: fees - type: object properties: id: type: string description: The Propexo unique identifier for the file type created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. code: type: - string - "null" description: The code associated with the file type models: type: array items: type: string description: The Propexo data models (e.g. units, residents, applicants, etc.) associated with the file type name: type: string description: The name associated with the file type type: type: string description: The type associated with the file type integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property title: file-types - type: object properties: id: type: string description: The Propexo unique identifier for the financial account created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: type: - string - "null" description: The name of the financial account status_raw: type: - string - "null" description: The raw status associated with the financial account account_number: type: - string - "null" description: The account number associated with the financial account custom_data: type: - object - "null" properties: {} description: Custom data property_id: type: string description: The Propexo unique identifier for the property integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record title: financial-accounts - type: object properties: id: type: string description: The Propexo unique identifier for the floor plan created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: type: string description: The name associated with the floor plan marketing_name: type: - string - "null" description: The marketing name of the floor plan code: type: - string - "null" description: The code associated with the floor plan description: type: - string - "null" description: Description of the floor plan bedrooms: type: - integer - "null" minimum: 0 description: The number of bedrooms associated with the floor plan bathrooms: type: - string - "null" description: The number of bathrooms associated with the floor plan bathrooms_full: type: - integer - "null" minimum: 0 description: The number of full bathrooms associated with the floor plan bathrooms_half: type: - integer - "null" minimum: 0 description: The number of half bathrooms associated with the floor plan max_occupants: type: - integer - "null" minimum: 0 description: The maximum number of occupants for the floor plan rentable_square_feet: type: - integer - "null" minimum: 0 description: The rentable square footage of the floor plan gross_square_feet: type: - integer - "null" minimum: 0 description: The gross square footage of the floor plan rent_minimum_in_cents: type: *a308 description: The minimum rent of the floor plan example: 100000 rent_maximum_in_cents: type: *a309 description: The maximum rent of the floor plan example: 100000 image_urls: type: array items: type: string description: A list of image urls associated with the floor plan x-propexo: &a360 derivedFromField: image_urls_array unit_count: type: - integer - "null" minimum: 0 description: The number of units associated with the floor plan deposit_amount_in_cents: type: *a310 description: The deposit amount in cents associated with the floor plan example: 100000 deposit_amount_raw: type: - string - "null" description: The raw deposit amount associated with the floor plan deposit_amount_min_in_cents: type: *a311 description: The minimum deposit amount in cents associated with the floor plan example: 100000 deposit_amount_max_in_cents: type: *a312 description: The maximum deposit amount in cents associated with the floor plan example: 100000 deposit_amount_min_raw: type: - string - "null" description: The raw minimum deposit amount associated with the floor plan deposit_amount_max_raw: type: - string - "null" description: The raw maximum deposit amount associated with the floor plan custom_data: type: - object - "null" properties: {} description: Custom data integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property rent_minimum_in_cents_int: type: number rent_maximum_in_cents_int: type: number deposit_amount_in_cents_int: type: number deposit_amount_min_in_cents_int: type: number deposit_amount_max_in_cents_int: type: number title: floor-plans - type: object properties: {} title: integration-configuration-meta-data - type: object properties: x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_gl_account_id: type: - string - "null" description: The external ID of the financial account from the integration vendor x_cash_financial_account_id: type: - string - "null" description: The external ID of the cash financial account from the integration vendor invoice_id: type: string description: The Propexo unique identifier for the invoice construction_job_id: type: - string - "null" description: The Propexo unique identifier for the construction job amount_due_in_cents: type: *a145 description: The amount due on the invoice item, in cents example: 100000 notes: type: - string - "null" description: Notes associated with the invoice item total_amount_in_cents: type: *a146 description: The amount of the invoice item, in cents example: 100000 property_id: type: string description: The Propexo unique identifier for the property financial_account_id: type: - string - "null" description: The Propexo unique identifier for the financial account cash_financial_account_id: type: - string - "null" description: The Propexo unique identifier for the cash financial account amount_due_in_cents_int: type: number total_amount_in_cents_int: type: number title: invoice-items - type: object properties: id: type: string description: The Propexo unique identifier for the invoice created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_vendor_id: type: - string - "null" description: The external ID of the vendor from the integration vendor x_financial_account_id: type: - string - "null" description: The external ID of the financial account from the integration vendor x_cash_financial_account_id: type: - string - "null" description: The external ID of the cash financial account from the integration vendor x_ap_financial_account_id: type: - string - "null" description: The external ID of the AP financial account from the integration vendor amount_due_in_cents: type: *a140 description: The amount due on the invoice, in cents example: 100000 amount_paid_in_cents: type: *a141 description: The amount paid on the invoice, in cents example: 100000 custom_data: type: - object - "null" properties: {} description: Custom data due_date: type: - string - "null" description: The due date associated with the invoice discount_amount_in_cents: type: *a142 description: The deposit amount in cents associated with the invoice example: 100000 discount_date: type: - string - "null" description: The date a discount was issued on invoice invoice_date: type: - string - "null" description: The date the invoice was issued invoice_number: type: - string - "null" description: The reference number for the invoice notes: type: - string - "null" description: Notes associated with the invoice post_date: type: - string - "null" description: The date the invoice was posted. Some PMS systems only show the month. post_month: type: - string - "null" description: The month the invoice was posted. post_status_raw: type: - string - "null" description: The raw post status associated with the invoice sub_total_amount_in_cents: type: *a143 description: The sub total amount of the invoice example: 100000 total_amount_in_cents: type: *a144 description: The amount of the invoice, in cents example: 100000 property_id: type: string description: The Propexo unique identifier for the property financial_account_id: type: - string - "null" description: The Propexo unique identifier for the financial account cash_financial_account_id: type: - string - "null" description: The Propexo unique identifier for the cash financial account ap_financial_account_id: type: - string - "null" description: The Propexo unique identifier for the ap financial account integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record invoice_items: type: array items: type: object properties: x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_gl_account_id: type: - string - "null" description: The external ID of the financial account from the integration vendor x_cash_financial_account_id: type: - string - "null" description: The external ID of the cash financial account from the integration vendor invoice_id: type: string description: The Propexo unique identifier for the invoice construction_job_id: type: - string - "null" description: The Propexo unique identifier for the construction job amount_due_in_cents: type: *a145 description: The amount due on the invoice item, in cents example: 100000 notes: type: - string - "null" description: Notes associated with the invoice item total_amount_in_cents: type: *a146 description: The amount of the invoice item, in cents example: 100000 property_id: type: string description: The Propexo unique identifier for the property financial_account_id: type: - string - "null" description: The Propexo unique identifier for the financial account cash_financial_account_id: type: - string - "null" description: The Propexo unique identifier for the cash financial account required: - x_id - x_property_id - x_location_id - x_gl_account_id - x_cash_financial_account_id - invoice_id - construction_job_id - amount_due_in_cents - notes - total_amount_in_cents - property_id - financial_account_id - cash_financial_account_id x-propexo: *a147 description: The invoice list items associated with the invoice amount_due_in_cents_int: type: number amount_paid_in_cents_int: type: number discount_amount_in_cents_int: type: number sub_total_amount_in_cents_int: type: number total_amount_in_cents_int: type: number title: invoices - type: object properties: id: type: string description: The Propexo unique identifier for the lead pet created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor age_in_years: type: - number - "null" description: The age in years of the lead pet breed: type: - string - "null" description: The breed of the lead pet color: type: - string - "null" description: The color of the lead pet gender_raw: type: - string - "null" description: The raw value for the gender of the lead pet is_fixed: type: - boolean - "null" description: Whether the lead pet is fixed is_service_animal: type: - boolean - "null" description: Whether the lead pet is a service animal name: type: - string - "null" description: The name associated with the lead pet notes: type: - string - "null" description: Notes associated with the lead pet type: type: - string - "null" description: The type associated with the lead pet weight_in_pounds: type: - number - "null" description: The weight in pounds of the lead pet custom_data: type: - object - "null" properties: {} description: Custom data title: lead-pets - type: object properties: id: type: string description: The Propexo unique identifier for the lead relationship created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: type: string description: The name associated with the lead relationship integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property title: lead-relationships - type: object properties: id: type: string description: The Propexo unique identifier for the lead source created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: type: - string - "null" description: The name associated with the lead source integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property title: lead-sources - type: object properties: id: type: string description: The Propexo unique identifier for the lead created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_created_at: type: - string - "null" description: The date the record first entered the integration vendor x_guestcard_id: type: - string - "null" description: The external ID of the guestcard from the integration vendor x_id: type: string description: The external ID from the integration vendor x_leasing_agent_id: type: - string - "null" description: The external ID of the leasing agent from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_unit_id: type: - string - "null" description: "DEPRECATED: Use x_unit_id_preferred instead" deprecated: true x_unit_id_preferred: type: array items: type: string description: The external IDs of the units from the integration vendor that the lead is interested in x_updated_at: type: - string - "null" description: The date the record was last updated in the integration vendor x_lead_source_id: type: - string - "null" description: The external ID of the lead source from the integration vendor address_1: type: - string - "null" description: The first address line associated with the lead address_2: type: - string - "null" description: The second address line associated with the lead city: type: - string - "null" description: The city associated with the lead country: type: - string - "null" description: The country associated with the lead custom_data: type: - object - "null" properties: {} description: Custom data date_of_birth: type: - string - "null" description: The date of birth associated with the lead desired_amenities: type: - string - "null" description: The desired amenities associated with the lead desired_floor_plan_id: type: - string - "null" description: The external ID of desired floor plan associated with the lead desired_floor_plan_name: type: - string - "null" description: The desired floor plan name desired_lease_term_in_months: type: - string - "null" description: The desired lease term desired_max_rent_in_cents: type: *a313 description: The desired maximum rent example: 100000 desired_max_square_ft: type: - number - "null" description: The desired maximum square feet desired_min_rent_in_cents: type: *a314 description: The desired minimum rent example: 100000 desired_min_square_ft: type: - number - "null" description: The desired minimum square feet desired_num_bathrooms: type: - number - "null" description: The desired number of bathrooms desired_num_bedrooms: type: - integer - "null" description: The desired number of bedrooms desired_unit_number: type: - string - "null" description: The desired unit number desired_unit_type: type: - string - "null" description: The desired unit type email_1: type: - string - "null" description: The primary email address associated with the lead email_2: type: - string - "null" description: The secondary email address associated with the lead first_name: type: - string - "null" description: The first name associated with the lead ils: type: - string - "null" description: The name of the Internet listing service last_name: type: - string - "null" description: The last name associated with the lead lead_source: type: - string - "null" description: The lead source leasing_agent: type: - string - "null" description: The name of the leasing agent middle_name: type: - string - "null" description: The middle name associated with the lead notes: type: - string - "null" description: Notes associated with the lead number_of_occupants: type: - integer - "null" description: The number of occupants pet_details: type: - string - "null" description: "DEPRECATED: Use the pets array instead" pets: type: array items: type: object properties: id: type: string description: The Propexo unique identifier for the lead pet created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor age_in_years: type: - number - "null" description: The age in years of the lead pet breed: type: - string - "null" description: The breed of the lead pet color: type: - string - "null" description: The color of the lead pet gender_raw: type: - string - "null" description: The raw value for the gender of the lead pet is_fixed: type: - boolean - "null" description: Whether the lead pet is fixed is_service_animal: type: - boolean - "null" description: Whether the lead pet is a service animal name: type: - string - "null" description: The name associated with the lead pet notes: type: - string - "null" description: Notes associated with the lead pet type: type: - string - "null" description: The type associated with the lead pet weight_in_pounds: type: - number - "null" description: The weight in pounds of the lead pet custom_data: type: - object - "null" properties: {} description: Custom data required: - id - created_at - updated_at - last_seen - x_id - age_in_years - breed - color - gender_raw - is_fixed - is_service_animal - name - notes - type - weight_in_pounds - custom_data x-propexo: *a315 description: The pets associated with the lead phone_1_type: type: - string - "null" description: Type of the primary phone number phone_1: type: - string - "null" description: Primary phone number associated with the lead phone_2_type: type: - string - "null" description: Type of the secondary phone number phone_2: type: - string - "null" description: Secondary phone number associated with the lead state: type: - string - "null" description: The state associated with the lead status: type: - string - "null" description: The raw status associated with the lead target_move_in_date: type: - string - "null" description: The target move in date zip: type: - string - "null" description: The zip code associated with the lead property_id: type: string description: The Propexo unique identifier for the property lead_source_id: type: - string - "null" description: The Propexo unique identifier for the lead source unit_id_preferred: type: array items: type: string description: The Propexo unique identifiers for the units that the lead is interested in integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record screenings: type: array items: type: object properties: id: type: string description: The Propexo ID of the screening created_at: type: string description: The date record first entered Propexo last_seen: type: string description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor status_raw: type: - string - "null" description: The status/results of the screening screening_date: type: - string - "null" description: The date the screening took place required: - id - created_at - last_seen - x_id - status_raw - screening_date x-propexo: *a153 desired_max_rent_in_cents_int: type: number desired_min_rent_in_cents_int: type: number title: leads - type: object properties: {} title: leads-to-events - type: object properties: {} title: leads-to-rentable-items - type: object properties: id: type: string description: The Propexo unique identifier for the lease service created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: string description: The date the record was last seen from the PMS name: type: string description: The name of the lease service lease_id: type: string description: The Propexo unique identifier for the lease title: lease-services - type: object properties: id: type: string description: The Propexo unique identifier for the lease transfer created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_resident_id: type: string description: The external ID of the resident from the integration vendor x_lease_id_next: type: string description: The external ID of the next lease from the integration vendor x_lease_property_id_next: type: - string - "null" description: The external ID of the property associated with the next lease from the integration vendor x_lease_id_previous: type: string description: The external ID of the previous lease from the integration vendor x_lease_property_id_previous: type: - string - "null" description: The external ID of the property associated with the previous lease from the integration vendor x_unit_id_next: type: - string - "null" description: The external ID of the next unit from the integration vendor x_unit_id_previous: type: - string - "null" description: The external ID of the previous unit from the integration vendor resident_type: type: - string - "null" description: The normalized type of the resident resident_type_raw: type: - string - "null" description: The raw type of the resident lease_status_next: type: - string - "null" description: The normalized status of the next lease lease_status_next_raw: type: - string - "null" description: The raw status of the next lease lease_status_previous: type: - string - "null" description: The normalized status of the previous lease lease_status_previous_raw: type: - string - "null" description: The raw status of the previous lease transfer_effective_date: type: - string - "null" description: The effective date of the lease transfer integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property resident_id: type: string description: The Propexo unique identifier for the resident lease_id_next: type: string description: The Propexo unique identifier for the next lease lease_id_previous: type: string description: The Propexo unique identifier for the previous lease unit_id_next: type: - string - "null" description: The Propexo unique identifier for the next unit unit_id_previous: type: - string - "null" description: The Propexo unique identifier for the previous unit title: lease-transfers - type: object properties: id: type: string description: The Propexo unique identifier for the lease created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_resident_id: type: - string - "null" description: Deprecated. Use residents_meta_data instead deprecated: true x_unit_id: type: - string - "null" description: The external ID of the unit from the integration vendor application_date: type: - string - "null" description: The application date associated with the lease custom_data: type: - object - "null" properties: {} description: Custom data deposit_amount: type: - string - "null" description: The deposit amount associated with the lease deposit_amount_in_cents: type: *a316 description: The deposit amount in cents associated with the lease example: 100000 deposit_date: type: - string - "null" description: The deposit date associated with the lease end_date: type: - string - "null" description: The end date associated with the lease realized_move_in_date: type: - string - "null" description: "The realized move-in date associated with the lease. Note: This move in date is at the lease level and could be different per resident. Please use residents_meta_data to view resident move in dates" realized_move_out_date: type: - string - "null" description: "The realized move-out date associated with the lease. Note: This move out date is at the lease level and could be different per resident. Please use residents_meta_data to view resident move out dates" rent_amount_in_cents: type: *a317 description: The rent amount in cents for the lease example: 100000 rent_amount_market_in_cents: type: *a318 description: The market rent amount in cents for the lease example: 100000 rent_due_day: type: - integer - "null" minimum: 0 description: The rent due day associated with the lease rent_due_date: type: - string - "null" description: The rent due date associated with the lease scheduled_move_in_date: type: - string - "null" description: "The scheduled move-in date associated with the lease. Note: This move in date is at the lease level and could be different per resident. Please use residents_meta_data to view resident move in dates" scheduled_move_out_date: type: - string - "null" description: "The scheduled move-out date associated with the lease. Note: This move out date is at the lease level and could be different per resident. Please use residents_meta_data to view resident move out dates" signature_date: type: - string - "null" description: The date the lease was signed start_date: type: - string - "null" description: The start date associated with the lease status: type: - string - "null" description: DEPRECATED. Use status_normalized deprecated: true status_normalized: type: - string - "null" enum: - ACTIVE - INACTIVE - OTHER - PENDING - EVICTED description: The normalized status for the lease. Note that the status may be called "EVICTED" but this can also refer to an active resident undergoing a current eviction. This varies per PMS. status_raw: type: - string - "null" description: The raw status associated with the lease term: type: - string - "null" description: The lease term type: type: - string - "null" description: The type of lease unit_number: type: - string - "null" description: The unit number associated with the lease. This isn't always provided by PMS vendors, but may be the only data provided to identify a unit associated with a service request in some cases. write_off_amount_in_cents: type: *a319 description: The write off amount for the lease, in cents example: 100000 write_off_amount_raw: type: - string - "null" description: The raw write off amount of the lease from the PMS balance_amount_in_cents: type: *a320 description: The balance amount for the lease, in cents example: 100000 balance_amount_raw: type: - string - "null" description: The raw balance amount of the lease from the PMS past_due_balance_in_cents: type: *a321 description: The past due balance for the lease, in cents example: 100000 past_due_balance_raw: type: - string - "null" description: The raw past due balance of the lease from the PMS unit_id: type: - string - "null" description: The Propexo unique identifier for the unit property_id: type: string description: The Propexo unique identifier for the property integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record services: type: array items: type: object properties: id: type: string description: The Propexo unique identifier for the lease service created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: string description: The date the record was last seen from the PMS name: type: string description: The name of the lease service lease_id: type: string description: The Propexo unique identifier for the lease required: - id - created_at - updated_at - last_seen - name - lease_id x-propexo: *a322 description: List of services related to the lease x-propexo: &a361 derivedFromModel: lease_services deposit_amount_in_cents_int: type: number rent_amount_in_cents_int: type: number rent_amount_market_in_cents_int: type: number write_off_amount_in_cents_int: type: number balance_amount_in_cents_int: type: number past_due_balance_in_cents_int: type: number title: leases - type: object properties: id: type: string description: The Propexo unique identifier for the listing created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_unit_id: type: - string - "null" description: The external ID of the unit from the integration vendor x_floor_plan_id: type: - string - "null" description: The external ID of the floor plan from the integration vendor is_unit: type: boolean description: True if the listing is for a unit, false if it is not associated with a specific unit available_date: type: - string - "null" description: The date the listing is available application_url: type: - string - "null" description: The application URL for the listing bathrooms: type: - string - "null" description: The number of bathrooms associated with the listing bathrooms_full: type: *a323 description: The number of full bathrooms associated with the listing bathrooms_half: type: *a324 description: The number of half bathrooms associated with the listing bedrooms: type: - string - "null" description: The number of bedrooms associated with the listing building_name: type: - string - "null" description: The building name associated with the listing building_number: type: - string - "null" description: The building number associated with the listing city: type: - string - "null" description: The city associated with the listing country: type: - string - "null" description: The country associated with the listing custom_data: type: - object - "null" properties: {} description: Custom data deposit_amount_in_cents: type: *a325 description: The deposit amount in cents associated with the listing example: 100000 floor_plan_code: type: - string - "null" description: The external ID of the floor plan associated with the listing floor_plan_name: type: - string - "null" description: The floor plan name associated with the listing floor: type: - string - "null" description: The floor number/name associated with the listing image_urls: type: array items: type: string description: A list of image urls associated with the listing x-propexo: &a362 derivedFromField: image_urls_array is_available: type: - boolean - "null" description: Whether the listing is available is_furnished: type: - boolean - "null" description: Whether the listing is furnished is_listed: type: - boolean - "null" description: Whether the listing is listed is_managed_external: type: - boolean - "null" description: Whether the listing is managed externally is_vacant: type: - boolean - "null" description: Whether the listing is vacant lease_term: type: - string - "null" description: The term of the lease listing_title: type: - string - "null" description: The title used for the marketing listing listing_date: type: - string - "null" description: The date the listing was created marketing_name: type: - string - "null" description: The marketing name of the unit being listed notes: type: - string - "null" description: Notes associated with the listing number: type: - string - "null" description: The unit number rent_amount_in_cents: type: *a326 description: The rent amount in cents for the listing example: 100000 specials: type: - string - "null" description: Marketing specials or promotions for the listing square_feet: type: - integer - "null" minimum: 0 description: The square footage of the listing state: type: - string - "null" description: The state associated with the listing street_address_1: type: - string - "null" description: "Deprecated: Use address_1" deprecated: true street_address_2: type: - string - "null" description: "Deprecated: Use address_2" deprecated: true address_1: type: - string - "null" description: The first address line associated with the listing x-propexo: *a327 address_2: type: - string - "null" description: The second address line associated with the listing x-propexo: *a328 property_description: type: - string - "null" description: Description of the property short_description: type: - string - "null" description: A short description of the listing unit_description: type: - string - "null" description: Description of the unit zip: type: - string - "null" description: The zip code associated with the listing make_ready_date: type: - string - "null" description: The make ready date of the listing vacate_date: type: - string - "null" description: The vacate date of the listing video_urls: type: - array - "null" items: type: string description: A list of video urls associated with the listing status_raw: type: - string - "null" description: The raw status associated with the listing property_id: type: string description: The Propexo unique identifier for the property unit_id: type: - string - "null" description: The Propexo unique identifier for the unit floor_plan_id: type: - string - "null" description: The Propexo unique identifier for the floor plan integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. unit_type_id: type: - string - "null" description: The Propexo unique identifier for the unit type deposit_amount_in_cents_int: type: number rent_amount_in_cents_int: type: number title: listings - type: object properties: id: type: string description: The Propexo unique identifier for the listing created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: string description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: type: - string - "null" description: The name of the location friendly_name: type: - string - "null" description: The friendly name of the location is_main: type: - boolean - "null" description: Specifies whether or not the location is the main location is_twa_enabled: type: - boolean - "null" description: Specifies whether or not TWA is enabled is_owa_enabled: type: - boolean - "null" description: Specifies whether or not OWA is enabled is_echeck_enabled: type: - boolean - "null" description: Specifies whether or not echeck is enabled ndt_username: type: - string - "null" description: The NDT username for the location broadcast_username: type: - string - "null" description: The broadcast username for the location property_id: type: string description: The Propexo unique identifier for the property integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record title: locations - type: object properties: id: type: string description: The Propexo unique identifier for the note category created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. is_active: type: - boolean - "null" description: Whether the note category is active name: type: string description: The name associated with the note category integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property title: note-categories - type: object properties: id: type: string description: The Propexo unique identifier for the owner created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. address_1: type: - string - "null" description: The first address line associated with the owner address_2: type: - string - "null" description: The second address line associated with the owner city: type: - string - "null" description: The city associated with the owner country: type: - string - "null" description: The country associated with the owner state: type: - string - "null" description: The state associated with the owner zip: type: - string - "null" description: The zip code associated with the owner first_name: type: - string - "null" description: The first name associated with the owner middle_name: type: - string - "null" description: The middle name associated with the owner last_name: type: - string - "null" description: The last name associated with the owner company_name: type: - string - "null" description: The name of the company associated with the owner notes: type: - string - "null" description: Notes associated with the owner email_1: type: - string - "null" description: The primary email address associated with the owner email_2: type: - string - "null" description: The secondary email address associated with the owner phone_1: type: - string - "null" description: Primary phone number associated with the owner phone_1_type: type: - string - "null" enum: - FAX - HOME - MOBILE - OTHER - WORK description: Type of the primary phone number phone_2: type: - string - "null" description: Secondary phone number associated with the owner phone_2_type: type: - string - "null" enum: - FAX - HOME - MOBILE - OTHER - WORK description: Type of the secondary phone number associated_property_ids: type: array items: type: string x-propexo: *a329 description: The property IDs associated with the owner integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property title: owners - type: object properties: {} title: owners-to-properties - type: object properties: x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_gl_account_id: type: - string - "null" description: The external ID of the financial account from the integration vendor x_cash_financial_account_id: type: - string - "null" description: The external ID of the cash financial account from the integration vendor payable_register_id: type: string description: The Propexo unique identifier for the payable register construction_job_id: type: - string - "null" description: The Propexo unique identifier for the construction job amount_due_in_cents: type: *a330 description: The amount due on the payable register item, in cents example: 100000 notes: type: - string - "null" description: Notes associated with the payable register item total_amount_in_cents: type: *a331 description: The amount of the payable register item, in cents example: 100000 cost_code: type: - string - "null" description: The cost code of the payable register item property_id: type: string description: The Propexo unique identifier for the property financial_account_id: type: - string - "null" description: The Propexo unique identifier for the financial account cash_financial_account_id: type: - string - "null" description: The Propexo unique identifier for the cash financial account amount_due_in_cents_int: type: number total_amount_in_cents_int: type: number title: payable-register-items - type: object properties: id: type: string description: The Propexo unique identifier for the payable register created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_financial_account_id: type: - string - "null" description: The external ID of the financial account from the integration vendor x_cash_financial_account_id: type: - string - "null" description: The external ID of the cash financial account from the integration vendor x_ap_financial_account_id: type: - string - "null" description: The external ID of the AP financial account from the integration vendor x_vendor_id: type: - string - "null" description: The external ID of the vendor from the integration vendor x_batch_id: type: - string - "null" description: The external ID of the associated batch amount_due_in_cents: type: *a332 description: The amount due on the payable register, in cents example: 100000 amount_paid_in_cents: type: *a333 description: The amount paid on the payable register, in cents example: 100000 custom_data: type: - object - "null" properties: {} description: Custom data due_date: type: - string - "null" description: The due date associated with the payable register discount_amount_in_cents: type: *a334 description: The discount, in cents, of the payable register example: 100000 discount_date: type: - string - "null" description: The date a discount was issued on payable register invoice_date: type: - string - "null" description: The date the payable register was issued invoice_number: type: - string - "null" description: The reference number for the payable register notes: type: - string - "null" description: Notes associated with the payable register post_date: type: - string - "null" description: The date the payable register was posted. Some PMS systems only show the month. post_month: type: - string - "null" description: The month the payable register was posted. post_status_raw: type: - string - "null" description: The raw post status associated with the payable register sub_total_amount_in_cents: type: *a335 description: The sub total amount of the payable register example: 100000 total_amount_in_cents: type: *a336 description: The amount of the payable register, in cents example: 100000 status: type: - string - "null" description: The status associated with the payable register is_unpaid: type: - boolean - "null" description: Whether the payable register is unpaid or not is_adjustment: type: - boolean - "null" description: Whether the payable register is an adjustment or not is_credit_memo: type: - boolean - "null" description: Whether the payable register is a credit memo or not is_exempt_from_1099: type: - boolean - "null" description: Whether the payable register is exempt from a 1099 or not display_type: type: - string - "null" description: The display type of the payable register expense_type: type: - string - "null" description: The expense type of the payable register property_id: type: string description: The Propexo unique identifier for the property financial_account_id: type: - string - "null" description: The Propexo unique identifier for the financial account cash_financial_account_id: type: - string - "null" description: The Propexo unique identifier for the cash financial account ap_financial_account_id: type: - string - "null" description: The Propexo unique identifier for the ap financial account integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record payable_register_items: type: array items: type: object properties: x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_gl_account_id: type: - string - "null" description: The external ID of the financial account from the integration vendor x_cash_financial_account_id: type: - string - "null" description: The external ID of the cash financial account from the integration vendor payable_register_id: type: string description: The Propexo unique identifier for the payable register construction_job_id: type: - string - "null" description: The Propexo unique identifier for the construction job amount_due_in_cents: type: *a330 description: The amount due on the payable register item, in cents example: 100000 notes: type: - string - "null" description: Notes associated with the payable register item total_amount_in_cents: type: *a331 description: The amount of the payable register item, in cents example: 100000 cost_code: type: - string - "null" description: The cost code of the payable register item property_id: type: string description: The Propexo unique identifier for the property financial_account_id: type: - string - "null" description: The Propexo unique identifier for the financial account cash_financial_account_id: type: - string - "null" description: The Propexo unique identifier for the cash financial account required: - x_id - x_property_id - x_location_id - x_gl_account_id - x_cash_financial_account_id - payable_register_id - construction_job_id - amount_due_in_cents - notes - total_amount_in_cents - cost_code - property_id - financial_account_id - cash_financial_account_id x-propexo: *a337 description: The payable register list items associated with the payable register amount_due_in_cents_int: type: number amount_paid_in_cents_int: type: number discount_amount_in_cents_int: type: number sub_total_amount_in_cents_int: type: number total_amount_in_cents_int: type: number title: payable-registers - type: object properties: {} title: pet-types - type: object properties: id: type: string description: The Propexo unique identifier for the property property_id: type: string description: The Propexo unique identifier for the property created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_created_at: type: - string - "null" description: The date the record first entered the integration vendor x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_building_id: type: - string - "null" description: The external ID of the building (not necessarily the property) from the integration vendor building_number: type: - string - "null" description: The building number associated with the property city: type: - string - "null" description: The city associated with the property code: type: - string - "null" description: The code associated with the property country: type: - string - "null" description: The country associated with the property county: type: - string - "null" description: The county associated with the property custom_data: type: - object - "null" properties: {} description: Custom data is_active: type: - boolean - "null" description: Whether the property is active. This reflects whether the property is active in the PMS. To see if a property is enabled in Propexo, please use the 'Get all my property configurations' endpoint. manager_email: type: - string - "null" description: The email address of the property manager manager_name: type: - string - "null" description: The name of the property manager manager_phone_1: type: - string - "null" description: The first phone number of the property manager manager_phone_1_type: type: - string - "null" enum: - FAX - HOME - MOBILE - OTHER - WORK description: The type of the first phone number of the property manager manager_phone_2: type: - string - "null" description: The second phone number of the property manager manager_phone_2_type: type: - string - "null" enum: - FAX - HOME - MOBILE - OTHER - WORK description: The type of the second phone number of the property manager name: type: - string - "null" description: The name of the property notes: type: - string - "null" description: Notes associated with the property number_of_units: type: - integer - "null" minimum: 0 description: The number of units in the property square_footage: type: - integer - "null" description: "Deprecated: Use square_feet" deprecated: true square_feet: type: - integer - "null" description: The square footage of the property state: type: - string - "null" description: The state associated with the property street_address_1: type: - string - "null" description: "Deprecated: Use address_1" deprecated: true street_address_2: type: - string - "null" description: "Deprecated: Use address_2" deprecated: true address_1: type: - string - "null" description: The first address line associated with the property x-propexo: *a338 address_2: type: - string - "null" description: The second address line associated with the property x-propexo: *a339 type: type: - string - "null" description: "Deprecated: Use type_raw." deprecated: true type_raw: type: - string - "null" description: The raw PMS type of the property type_normalized: anyOf: - type: string enum: - SINGLE_FAMILY - MULTI_FAMILY - STUDENT_HOUSING - VACATION - COMMERCIAL - OTHER - type: string - type: "null" description: The Propexo normalized property type website: type: - string - "null" description: The website URL associated with the property year_built: type: - integer - "null" minimum: 0 description: The year the property was built zip: type: - string - "null" description: The zip code associated with the property long_description: type: - string - "null" description: A long description of the property short_description: type: - string - "null" description: A short description of the property office_hours: $ref: "#/components/schemas/OfficeHours" pet_types: type: array items: allOf: - $ref: "#/components/schemas/PetTypes" - description: The pet policies for the property associated_owner_ids: type: array items: type: string x-propexo: *a340 description: The property IDs associated with the owner integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record title: properties - type: object properties: id: type: string description: The Propexo unique identifier for the property list created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: type: - string - "null" description: The name associated with the property list associated_property_ids: type: - array - "null" items: type: string description: The property IDs associated with the property list integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property title: property-lists - type: object properties: {} title: property-lists-to-properties - type: object properties: {} title: property-office-hours - type: object properties: id: type: string description: The Propexo unique identifier for the purchase order item created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. description: type: - string - "null" description: Description of the purchase order item stock_code: type: - string - "null" description: The stock code for the purchase order item quantity_ordered: type: - string - "null" description: The quantity ordered for the purchase order item unit_price_in_cents: type: *a341 description: The unit price, in cents, of the purchase order item example: 100000 total_cost_in_cents: type: *a342 description: The total cost, in cents, of the purchase order item example: 100000 cost_code: type: - string - "null" description: The cost code of the purchase order item category_code: type: - string - "null" description: The category code for the purchase order item purchase_order_id: type: string description: The Propexo unique identifier for the purchase order construction_job_id: type: - string - "null" description: The Propexo unique identifier for the construction job financial_account_id: type: - string - "null" description: The Propexo unique identifier for the financial account custom_data: type: - object - "null" properties: {} description: Custom data associated_invoice_ids: type: array items: type: string description: The IDs for invoices that are associated with the purchase order item property_id: type: string description: The Propexo unique identifier for the property integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record unit_price_in_cents_int: type: number total_cost_in_cents_int: type: number title: purchase-order-items - type: object properties: {} title: purchase-order-items-to-invoices - type: object properties: id: type: string description: The Propexo unique identifier for the purchase order created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_invoice_id: type: - string - "null" description: The external ID of the invoice from the integration vendor x_vendor_id: type: - string - "null" description: The external ID of the vendor from the integration vendor x_parent_purchase_order_id: type: - string - "null" description: The external ID of the purchase order from the integration vendor. This field is not null if this is a change order number: type: - string - "null" description: The number of the purchase order is_closed: type: - boolean - "null" description: Whether the purchase order is closed or not description: type: - string - "null" description: Description of the purchase order total_amount_in_cents: type: *a343 description: The amount of the purchase order, in cents example: 100000 order_date: type: - string - "null" description: The order date for the purchase order expense_type: type: - string - "null" description: The expense type of the purchase order display_type: type: - string - "null" description: The display type of the purchase order status_raw: type: - string - "null" description: The raw status associated with the purchase order shipping_address_1: type: - string - "null" description: The first address line associated with the shipping address for the purchase order shipping_address_2: type: - string - "null" description: The second address line associated with the shipping address for the purchase order shipping_city: type: - string - "null" description: The city associated with the shipping address for the purchase order shipping_state: type: - string - "null" description: The state associated with the shipping address for the purchase order shipping_zip: type: - string - "null" description: The zip code associated with the shipping address for the purchase order shipping_country: type: - string - "null" description: The country associated with the shipping address for the purchase order billing_address_1: type: - string - "null" description: The first address line associated with the billing address for the purchase order billing_address_2: type: - string - "null" description: The second address line associated with the billing address for the purchase order billing_city: type: - string - "null" description: The city associated with the billing address for the purchase order billing_state: type: - string - "null" description: The state associated with the billing address for the purchase order billing_zip: type: - string - "null" description: The zip code associated with the billing address for the purchase order billing_country: type: - string - "null" description: The country associated with the billing address for the purchase order custom_data: type: - object - "null" properties: {} description: Custom data associated_invoice_ids: type: array items: type: string description: An array of all other invoices associated with a purchase order. This includes invoices that associated with specific purchase order items. property_id: type: string description: The Propexo unique identifier for the property integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record invoice_id: type: - string - "null" description: The Propexo unique identifier for the invoice vendor_id: type: - string - "null" description: The Propexo unique identifier for the vendor parent_purchase_order_id: type: - string - "null" description: The Propexo unique identifier for the purchase order. This field is not null if this is a change order total_amount_in_cents_int: type: number title: purchase-orders - type: object properties: id: type: string description: The Propexo unique identifier for the recurring resident charge created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_charge_code_id: type: - string - "null" description: The external ID of the charge code from the integration vendor x_financial_account_id: type: - string - "null" description: The external ID of the financial account from the integration vendor x_lease_id: type: - string - "null" description: The external ID of the lease from the integration vendor amount_in_cents: type: *a344 description: The total amount of the recurring resident charge example: 100000 amount_raw: type: - string - "null" description: The raw value for amount from the PMS is_active: type: - boolean - "null" description: Whether the recurring resident charge is active description: type: - string - "null" description: Description of the recurring resident charge reference_number: type: - string - "null" description: The reference number for the recurring resident charge start_date: type: - string - "null" description: The start date associated with the recurring resident charge end_date: type: - string - "null" description: The end date associated with the recurring resident charge frequency_raw: type: - string - "null" description: The raw value of the frequency of the recurring resident charge frequency_normalized: type: - string - "null" enum: - OTHER - WEEKLY - MONTHLY - DAILY description: The frequency of the recurring resident charge charge_due_day: type: - integer - "null" minimum: 0 description: The due date associated with the recurring resident charge custom_data: type: - object - "null" properties: {} description: Custom data financial_account_id: type: - string - "null" description: The Propexo unique identifier for the financial account lease_id: type: - string - "null" description: The Propexo unique identifier for the lease charge_code_id: type: - string - "null" description: The Propexo unique identifier for the charge code integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property amount_in_cents_int: type: number title: recurring-resident-charges - type: object properties: id: type: string description: The Propexo unique identifier for the rentable item created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_applicant_id: type: - string - "null" description: The external ID of the applicant from the integration vendor x_lead_id: type: - string - "null" description: The external ID of the lead from the integration vendor x_resident_id: type: - string - "null" description: The external ID of the resident from the integration vendor x_type_id: type: - string - "null" description: The external ID of the type from the integration vendor x_charge_code_id: type: - string - "null" description: The external ID of the charge code from the integration vendor amount_in_cents: type: *a345 description: The amount of the rentable item, in cents example: 100000 description: type: - string - "null" description: Description of the rentable item name: type: - string - "null" description: The name of the rentable item is_available: type: - boolean - "null" description: Whether the rentable item is available reserved_until_date: type: - string - "null" description: The date the rentable item is reserved until type: type: - string - "null" description: The type associated with the rentable item integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property applicant_id: type: - string - "null" description: "Deprecated: Use the /applicants/:id/rentable-items endpoint instead." deprecated: true lead_id: type: - string - "null" description: "Deprecated: Use the /leads/:id/rentable-items endpoint instead." deprecated: true resident_id: type: - string - "null" description: "Deprecated: Use the /residents/:id/rentable-items endpoint instead." deprecated: true charge_code_id: type: - string - "null" description: The Propexo unique identifier for the charge code amount_in_cents_int: type: number title: rentable-items - type: object properties: id: type: string description: The Propexo unique identifier for the application template created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: type: string description: The name associated with the application template is_active: type: - boolean - "null" description: Whether the application template is active is_default: type: - boolean - "null" description: Whether this record is the default application template integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property title: rentvine-application-templates - type: object properties: {} title: resident-allocations - type: object properties: id: type: string description: The Propexo unique identifier for the resident charge created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_gl_account_id: type: - string - "null" description: The external ID of the general ledger account from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_lease_id: type: - string - "null" description: The external ID of the lease from the integration vendor x_resident_id: type: - string - "null" description: The external ID of the resident from the integration vendor x_unit_id: type: - string - "null" description: The external ID of the unit from the integration vendor x_charge_code_id: type: - string - "null" description: The external ID of the charge code from the integration vendor amount_in_cents: type: *a346 description: The amount of the resident charge, in cents example: 100000 amount_raw: type: - string - "null" description: The raw value for amount from the PMS amount_open_in_cents: type: *a347 description: The amount open on the resident charge, in cents example: 100000 amount_open_raw: type: - string - "null" description: The raw value for open amount from the PMS amount_paid_in_cents: type: *a348 description: The amount paid on the resident charge, in cents example: 100000 amount_paid_raw: type: - string - "null" description: The raw value for amount paid from the PMS due_date: type: - string - "null" description: The due date associated with the resident charge name: type: - string - "null" description: The name associated with the resident charge description: type: - string - "null" description: Description of the resident charge reference_number: type: - string - "null" description: The reference number for the resident charge transaction_date: type: - string - "null" description: The transaction date of the resident charge transaction_source: type: - string - "null" description: The transaction source of the resident charge is_open: type: - boolean - "null" description: Whether the resident charge is open and not yet settled post_month: type: - string - "null" pattern: ^\d{4}-(?:0[1-9]|1[0-2])$ description: The post month for the resident charge custom_data: type: - object - "null" properties: {} description: Custom data integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property resident_id: type: - string - "null" description: The Propexo unique identifier for the resident financial_account_id: type: - string - "null" description: The Propexo unique identifier for the financial account unit_id: type: - string - "null" description: The Propexo unique identifier for the unit lease_id: type: - string - "null" description: The Propexo unique identifier for the lease charge_code_id: type: - string - "null" description: The Propexo unique identifier for the charge code allocations: type: array items: type: object properties: id: type: string description: The Propexo unique identifier for the resident allocation x_id: type: string description: The external ID from the integration vendor x_source_id: type: - string - "null" description: The external ID of the source transaction from the integration vendor x_destination_id: type: - string - "null" description: The external ID of the destination transaction from the integration vendor financial_account_id: type: - string - "null" description: The Propexo unique identifier for the financial account amount_in_cents: type: *a105 description: The amount of the resident allocation, in cents example: 100000 amount_raw: type: - string - "null" description: The raw value for amount from the PMS resident_charge_id: type: - string - "null" description: The Propexo unique identifier for the resident charge resident_payment_id: type: - string - "null" description: The Propexo unique identifier for the resident payment created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS custom_data: type: - object - "null" properties: {} description: Custom data required: - id - x_id - x_source_id - x_destination_id - financial_account_id - amount_in_cents - amount_raw - resident_charge_id - resident_payment_id - created_at - updated_at - last_seen - custom_data description: Array of payment allocations, splits, and related transactions associated with the resident charge x-propexo: &a349 derivedFromModel: resident_allocations amount_in_cents_int: type: number amount_open_in_cents_int: type: number amount_paid_in_cents_int: type: number title: resident-charges - type: object properties: id: type: string description: The Propexo unique identifier for the resident insurance created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_unit_id: type: - string - "null" description: The external ID of the unit from the integration vendor x_lease_id: type: - string - "null" description: The external ID of the lease from the integration vendor x_resident_id: type: - string - "null" description: The external ID of the resident from the integration vendor provider: type: - string - "null" description: The insurance provider name insurance_type: type: - string - "null" description: The type of insurance policy_number: type: - string - "null" description: The insurance policy number effective_date: type: - string - "null" description: The date the insurance becomes effective expiration_date: type: - string - "null" description: The date the insurance expires cancellation_date: type: - string - "null" description: The date the insurance was cancelled liability_amount_in_cents: type: *a216 description: The liability amount in cents example: 100000 liability_amount_raw: type: - string - "null" description: The raw liability amount string notes: type: - string - "null" description: Additional notes about the insurance integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property unit_id: type: - string - "null" description: The Propexo unique identifier for the unit lease_id: type: - string - "null" description: The Propexo unique identifier for the lease resident_id: type: - string - "null" description: The Propexo unique identifier for the resident liability_amount_in_cents_int: type: number title: resident-insurance - type: object properties: id: type: string description: The Propexo unique identifier for the resident payment created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_gl_account_id: type: - string - "null" description: The external ID of the general ledger account from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_lease_id: type: - string - "null" description: The external ID of the lease from the integration vendor x_resident_id: type: - string - "null" description: The external ID of the resident from the integration vendor x_unit_id: type: - string - "null" description: The external ID of the unit from the integration vendor x_charge_code_id: type: - string - "null" description: The external ID of the charge code from the integration vendor payment_method_normalized: type: - string - "null" description: The normalized method of payment for the resident payment payment_method_raw: type: - string - "null" description: The raw method of payment for the resident payment amount_in_cents: type: *a106 description: The amount of the resident payment, in cents example: 100000 amount_raw: type: - string - "null" description: The raw value for amount from the PMS name: type: - string - "null" description: The name associated with the resident payment description: type: - string - "null" description: Description of the resident payment reference_number: type: - string - "null" description: The reference number for the resident payment transaction_date: type: - string - "null" description: The transaction date of the resident payment is_open: type: - boolean - "null" description: Whether the resident payment is open and not yet settled post_month: type: - string - "null" pattern: ^\d{4}-(?:0[1-9]|1[0-2])$ description: The post month for the resident payment custom_data: type: - object - "null" properties: {} description: Custom data integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property resident_id: type: - string - "null" description: The Propexo unique identifier for the resident financial_account_id: type: - string - "null" description: The Propexo unique identifier for the financial account unit_id: type: - string - "null" description: The Propexo unique identifier for the unit lease_id: type: - string - "null" description: The Propexo unique identifier for the lease charge_code_id: type: - string - "null" description: The Propexo unique identifier for the charge code allocations: type: array items: type: object properties: id: type: string description: The Propexo unique identifier for the resident allocation x_id: type: string description: The external ID from the integration vendor x_source_id: type: - string - "null" description: The external ID of the source transaction from the integration vendor x_destination_id: type: - string - "null" description: The external ID of the destination transaction from the integration vendor financial_account_id: type: - string - "null" description: The Propexo unique identifier for the financial account amount_in_cents: type: *a105 description: The amount of the resident allocation, in cents example: 100000 amount_raw: type: - string - "null" description: The raw value for amount from the PMS resident_charge_id: type: - string - "null" description: The Propexo unique identifier for the resident charge resident_payment_id: type: - string - "null" description: The Propexo unique identifier for the resident payment created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS custom_data: type: - object - "null" properties: {} description: Custom data required: - id - x_id - x_source_id - x_destination_id - financial_account_id - amount_in_cents - amount_raw - resident_charge_id - resident_payment_id - created_at - updated_at - last_seen - custom_data description: Array of payment allocations, splits, and related transactions associated with the resident payment x-propexo: *a349 amount_in_cents_int: type: number title: resident-payments - type: object properties: id: type: string description: The Propexo unique identifier for the resident pet created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor name: type: - string - "null" description: The name associated with the resident pet type: type: - string - "null" description: The type associated with the resident pet breed: type: - string - "null" description: The breed of the resident pet gender_raw: type: - string - "null" description: The raw value for the gender of the resident pet age_in_years: type: - number - "null" description: The age in years of the resident pet weight_in_pounds: type: - number - "null" description: The weight in pounds of the resident pet is_fixed: type: - boolean - "null" description: Whether the resident pet is fixed is_service_animal: type: - boolean - "null" description: Whether the resident pet is a service animal notes: type: - string - "null" description: Notes associated with the resident pet custom_data: type: - object - "null" properties: {} description: Custom data title: resident-pets - type: object properties: id: type: string description: The Propexo unique identifier for the resident vehicle created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor make: type: - string - "null" description: The make of the resident vehicle model: type: - string - "null" description: The Propexo data model (e.g. units, residents, applicants, etc.) associated with the resident vehicle color: type: - string - "null" description: The color of the resident vehicle year: type: - string - "null" description: The year of the resident vehicle license_plate_number: type: - string - "null" description: The license plate number of the resident vehicle license_plate_state: type: - string - "null" description: The license plate state of the resident vehicle notes: type: - string - "null" description: Notes associated with the resident vehicle custom_data: type: - object - "null" properties: {} description: Custom data title: resident-vehicles - type: object properties: id: type: string description: The Propexo unique identifier for the resident created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_lease_id: type: - string - "null" description: Deprecated. Use leases_meta_data instead deprecated: true address_1_alternate: type: - string - "null" description: The first alternate address line associated with the resident address_1: type: - string - "null" description: The first address line associated with the resident address_2_alternate: type: - string - "null" description: The second alternate address line associated with the resident address_2: type: - string - "null" description: The second address line associated with the resident balance_in_cents: type: *a212 description: The rent balance owed example: 100000 city_alternate: type: - string - "null" description: The alternate city associated with the resident city: type: - string - "null" description: The city associated with the resident country_alternate: type: - string - "null" description: The alternate country associated with the resident country: type: - string - "null" description: The country associated with the resident custom_data: type: - object - "null" properties: {} description: Custom data date_of_birth: type: - string - "null" description: The date of birth associated with the resident email_1: type: - string - "null" description: The primary email address associated with the resident email_2: type: - string - "null" description: The secondary email address associated with the resident first_name: type: - string - "null" description: The first name associated with the resident is_employee: type: - boolean - "null" description: Is the resident an employee last_name: type: - string - "null" description: The last name associated with the resident late_balance_in_cents: type: *a213 description: The past due rent balance owed example: 100000 middle_name: type: - string - "null" description: The middle name associated with the resident notes: type: - string - "null" description: Notes associated with the resident phone_1_type: type: - string - "null" enum: - FAX - HOME - MOBILE - OTHER - WORK description: Type of the primary phone number phone_1: type: - string - "null" description: Primary phone number associated with the resident phone_2_type: type: - string - "null" enum: - FAX - HOME - MOBILE - OTHER - WORK description: Type of the secondary phone number phone_2: type: - string - "null" description: Secondary phone number associated with the resident state_alternate: type: - string - "null" description: The alternate state associated with the resident state: type: - string - "null" description: The state associated with the resident zip_alternate: type: - string - "null" description: The alternate zip code associated with the resident zip: type: - string - "null" description: The zip code associated with the resident pets: type: array items: type: object properties: id: type: string description: The Propexo unique identifier for the resident pet created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor name: type: - string - "null" description: The name associated with the resident pet type: type: - string - "null" description: The type associated with the resident pet breed: type: - string - "null" description: The breed of the resident pet gender_raw: type: - string - "null" description: The raw value for the gender of the resident pet age_in_years: type: - number - "null" description: The age in years of the resident pet weight_in_pounds: type: - number - "null" description: The weight in pounds of the resident pet is_fixed: type: - boolean - "null" description: Whether the resident pet is fixed is_service_animal: type: - boolean - "null" description: Whether the resident pet is a service animal notes: type: - string - "null" description: Notes associated with the resident pet custom_data: type: - object - "null" properties: {} description: Custom data required: - id - created_at - updated_at - last_seen - x_id - name - type - breed - gender_raw - age_in_years - weight_in_pounds - is_fixed - is_service_animal - notes - custom_data x-propexo: *a214 vehicles: type: array items: type: object properties: id: type: string description: The Propexo unique identifier for the resident vehicle created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor make: type: - string - "null" description: The make of the resident vehicle model: type: - string - "null" description: The Propexo data model (e.g. units, residents, applicants, etc.) associated with the resident vehicle color: type: - string - "null" description: The color of the resident vehicle year: type: - string - "null" description: The year of the resident vehicle license_plate_number: type: - string - "null" description: The license plate number of the resident vehicle license_plate_state: type: - string - "null" description: The license plate state of the resident vehicle notes: type: - string - "null" description: Notes associated with the resident vehicle custom_data: type: - object - "null" properties: {} description: Custom data required: - id - created_at - updated_at - last_seen - x_id - make - model - color - year - license_plate_number - license_plate_state - notes - custom_data x-propexo: *a215 integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property balance_in_cents_int: type: number late_balance_in_cents_int: type: number title: residents - type: object properties: {} title: residents-to-events - type: object properties: lease_id: type: string description: The Propexo unique identifier for the lease x_resident_type: type: - string - "null" description: The external type of the resident from the integration vendor resident_type_normalized: anyOf: - type: string - type: string enum: - PRIMARY - SECONDARY - GUARANTOR - OTHER - type: "null" description: Resident type from Propexo move_in_date: type: - string - "null" description: The move-in date associated with the resident example: 2024-01-01 move_out_date: type: - string - "null" description: The move-out date associated with the resident notice_date: type: - string - "null" description: The date the resident gave notice custom_data: type: - object - "null" properties: {} description: Custom data last_seen: type: - string - "null" description: The date the record was last seen from the PMS resident_id: type: string description: The Propexo unique identifier for the resident title: residents-to-leases - type: object properties: {} title: residents-to-rentable-items - type: object properties: id: type: string description: The Propexo ID of the screening created_at: type: string description: The date record first entered Propexo last_seen: type: string description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor status_raw: type: - string - "null" description: The status/results of the screening screening_date: type: - string - "null" description: The date the screening took place title: screenings - type: object properties: {} title: service-request-access-contacts - type: object properties: id: type: string description: The Propexo unique identifier for the service request category created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. code: type: - string - "null" description: The code associated with the service request category description: type: - string - "null" description: Description of the service request category is_active: type: - boolean - "null" description: Whether the service request category is active name: type: - string - "null" description: The name associated with the service request category integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property title: service-request-categories - type: object properties: id: type: string description: The Propexo unique identifier for the service request location created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: type: string description: The name of the service request location type: type: - string - "null" description: The type of location integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property title: service-request-locations - type: object properties: id: type: string description: The Propexo unique identifier for the service request history created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_created_at: type: - string - "null" description: The date the record first entered the integration vendor x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. notes: type: - string - "null" description: Notes associated with the service request history status_raw: type: - string - "null" description: The raw status associated with the service request history creator_name: type: - string - "null" description: The name or username of the person who created the service request history record service_request_id: type: string description: The Propexo unique identifier for the service request integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property title: service-request-notes - type: object properties: id: type: string description: The Propexo unique identifier for the service request category created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. code: type: - string - "null" description: The code associated with the service request category description: type: - string - "null" description: Description of the service request category is_active: type: - boolean - "null" description: Whether the service request category is active name: type: - string - "null" description: The name associated with the service request category integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property title: service-request-priorities - type: object properties: id: type: string description: The Propexo unique identifier for the service request location created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: type: string description: The name of the service request problem service_request_category_id: type: - string - "null" description: The Propexo unique identifier for the service request category integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property title: service-request-problems - type: object properties: id: type: string description: The Propexo unique identifier for the service request category created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. code: type: - string - "null" description: The code associated with the service request category description: type: - string - "null" description: Description of the service request category is_active: type: - boolean - "null" description: Whether the service request category is active name: type: - string - "null" description: The name associated with the service request category integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property title: service-request-statuses - type: object properties: {} title: service-request-vendor-categories - type: object properties: {} title: service-request-vendor-contacts - type: object properties: id: type: string description: The Propexo unique identifier for the vendor created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. account_number: type: - string - "null" description: The account number associated with the vendor is_active: type: - boolean - "null" description: Whether the vendor is active name: type: - string - "null" description: The name associated with the vendor notes: type: - string - "null" description: Notes associated with the vendor tax_id: type: - string - "null" description: The tax payer identification number associated with the vendor third_party_id: type: - string - "null" description: A unique value provided to the PMS to uniquely identify the vendor from your system. type: type: - string - "null" description: The type associated with the vendor contacts: type: array items: type: object properties: address_1: type: - string - "null" description: The first address line associated with the vendor address_2: type: - string - "null" description: The second address line associated with the vendor city: type: - string - "null" description: The city associated with the vendor country: type: - string - "null" description: The country associated with the vendor state: type: - string - "null" description: The state associated with the vendor zip: type: - string - "null" description: The zip code associated with the vendor phone: type: - string - "null" description: Primary phone number associated with the vendor phone_type: type: - string - "null" description: Type of the primary phone number email: type: - string - "null" description: The primary email address associated with the vendor is_primary: type: - boolean - "null" description: Whether the vendor is the primary record name: type: - string - "null" description: The name associated with the vendor required: - address_1 - address_2 - city - country - state - zip - phone - phone_type - email - is_primary - name custom_data: type: - object - "null" properties: {} description: Custom data integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property title: service-request-vendors - type: object properties: {} title: service-request-vendors-insurance - type: object properties: {} title: service-request-vendors-to-properties - type: object properties: id: type: string description: The Propexo unique identifier for the service request created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_unit_id: type: - string - "null" description: The external ID of the unit from the integration vendor x_sub_task_id: type: - string - "null" description: The external ID of the sub task from the integration vendor access_is_authorized: type: - boolean - "null" description: Whether or not the tenant has granted permission to enter the unit associated with the service request access_notes: type: - string - "null" description: Notes regarding access to the unit associated with the service request building: type: - string - "null" description: The building name associated with the service request completion_notes: type: - string - "null" description: Closing notes associated with the service request date_completed: type: - string - "null" description: The date the service request was completed date_created: type: - string - "null" description: The date the service request was created date_due: type: - string - "null" description: The due date associated with the service request date_scheduled: type: - string - "null" description: The date the service request is scheduled notes: type: - string - "null" description: "DEPRECATED: Please use 'history' for reading notes regarding the service request" deprecated: true service_category: type: - string - "null" description: The category of service request service_description: type: - string - "null" description: A description of the service request service_details: type: - string - "null" description: Details about the service request service_priority: type: - string - "null" description: The priority level associated with the service request status_raw: type: - string - "null" description: The raw status associated with the service request vendor_notes: type: - string - "null" description: Vendor/technician notes associated with the service request unit_number: type: - string - "null" description: The unit number associated with the service request. This isn't always provided by PMS vendors, but may be the only data provided to identify a unit associated with a service request in some cases. order_number: type: - string - "null" description: The order number of the service request integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property unit_id: type: - string - "null" description: The Propexo unique identifier for the unit employee_id: type: - string - "null" description: The Propexo unique identifier for the employee vendors: type: array items: type: object properties: vendor_id: type: string required: - vendor_id x-propexo: *a350 description: List of vendor IDs associated with the service request employees: type: array items: type: object properties: id: type: string description: The Propexo unique identifier for the employee created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor name: type: - string - "null" description: The name associated with the employee required: - id - created_at - updated_at - last_seen - x_id - name description: An array of all employees assigned to the service request x-propexo: *a351 title: service-requests - type: object properties: {} title: service-requests-to-employees - type: object properties: {} title: service-requests-to-vendors - type: object properties: id: type: string description: The Propexo unique identifier for the timezone created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. is_active: type: - boolean - "null" description: Whether the timezone is active observes_daylight_savings: type: - boolean - "null" description: Whether or not this timezone should be adjusted for daylight savings time offset: type: - string - "null" pattern: ^[-+]\d{2}:\d{2}$ description: The UTC offset numeric value of the timezone. In the event that daylight savings time is observed, the offset will always represent standard time server_time_error_seconds: type: - number - "null" description: The number of seconds the server is off by integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property title: timezones - type: object properties: id: type: string description: The Propexo unique identifier for the transaction created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_gl_account_id: type: - string - "null" description: The external ID of the general ledger account from the integration vendor x_id: type: string description: The external ID from the integration vendor x_lease_id: type: - string - "null" description: The external ID of the lease from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_resident_id: type: - string - "null" description: The external ID of the resident from the integration vendor x_unit_id: type: - string - "null" description: The external ID of the unit from the integration vendor x_vendor_id: type: - string - "null" description: The external ID of the vendor from the integration vendor x_work_order_id: type: - string - "null" description: The external ID of the work order from the integration vendor amount_in_cents: type: &a363 - number - "null" description: The amount of the transaction in cents. example: 100000 approval_status: type: - string - "null" enum: - APPROVAL_REQUIRED - APPROVED - NOT_NEEDED - PENDING - REJECTED description: DEPRECATED. Use approval_status_normalized. deprecated: true approval_status_normalized: type: - string - "null" enum: - APPROVAL_REQUIRED - APPROVED - NOT_NEEDED - PENDING - REJECTED description: The approval status of the transaction approval_status_raw: type: - string - "null" description: The raw approval status of the transaction from the PMS. bill_date: type: - string - "null" description: The bill date of the transaction custom_data: type: - object - "null" properties: {} description: Custom data due_date: type: - string - "null" description: The due date associated with the transaction gl_account_id_1: type: - string - "null" description: The first general ledger account ID associated with the transaction gl_account_id_2: type: - string - "null" description: The second general ledger account ID associated with the transaction notes: type: - string - "null" description: Notes associated with the transaction payee_name: type: - string - "null" description: The payee name associated with the transaction payment_method: type: - string - "null" description: DEPRECATED. Use payment_method_normalized. deprecated: true payment_method_normalized: type: - string - "null" description: The payment method used in the transaction. payment_method_raw: type: - string - "null" description: The raw payment method used in the transaction from the PMS. reference_number: type: - string - "null" description: The reference number associated with the transaction transaction_date: type: - string - "null" description: The date the transaction was received. transaction_type: type: - string - "null" enum: - CHARGE - CREDIT - OTHER - PAYMENT description: DEPRECATED. Use transaction_type_normalized. deprecated: true transaction_type_normalized: type: - string - "null" enum: - CHARGE - CREDIT - OTHER - PAYMENT description: The type of transaction. transaction_type_raw: type: - string - "null" description: The raw type of transaction from the PMS. transaction_source: type: - string - "null" enum: - OTHER - RESIDENT - VENDOR description: The source of the transaction integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property amount_in_cents_int: type: number title: transactions - type: object properties: id: type: string description: The Propexo unique identifier for the unit created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_building_id: type: - string - "null" description: The external ID of the building (not necessarily the property) from the integration vendor x_floor_plan_id: type: - string - "null" description: The external ID of the floor plan from the integration vendor building_number: type: - string - "null" description: The building number associated with the unit make_ready_date: type: - string - "null" description: The make ready date of the unit made_ready_date: type: - string - "null" description: The made ready date of the unit reserved_until_date: type: - string - "null" description: The date the unit is reserved until floor_plan_market_rent_in_cents: type: *a260 description: The market rent cost of the floor plan, in cents example: 100000 unit_market_rent_in_cents: type: *a261 description: The market rent cost of the unit, in cents example: 100000 base_rent_in_cents: type: *a262 description: The base rent cost of the unit, in cents example: 100000 unit_number: type: - string - "null" description: The unit number description: type: - string - "null" description: Description of the unit floor_plan_name: type: - string - "null" description: The floor plan name associated with the unit accessible_hearing: type: - boolean - "null" description: Whether or not the unit is accessible for the hearing impaired accessible_mobility: type: - boolean - "null" description: Whether or not the unit is accessible for the mobility impaired accessible_vision: type: - boolean - "null" description: Whether or not the unit is accessible for the vision impaired is_vacant: type: - boolean - "null" description: Whether the unit is vacant is_available: type: - boolean - "null" description: Whether the unit is available is_reserved: type: - boolean - "null" description: Whether the unit is reserved available_date: type: - string - "null" description: The date that the unit becomes available notes: type: - string - "null" description: Notes associated with the unit gross_square_feet: type: integer minimum: 0 description: The gross square footage of the unit rentable_square_feet: type: integer minimum: 0 description: The rentable square footage of the unit city: type: - string - "null" description: The city associated with the unit country: type: - string - "null" description: The country associated with the unit state: type: - string - "null" description: The state associated with the unit address_1: type: - string - "null" description: The first address line associated with the unit address_2: type: - string - "null" description: The second address line associated with the unit zip: type: - string - "null" description: The zip code associated with the unit maximum_potential_lease_term: type: - string - "null" description: The maximum potential lease term of the unit minimum_potential_lease_term: type: - string - "null" description: The minimum potential lease term of the unit integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property floor_plan_market_rent_in_cents_int: type: number unit_market_rent_in_cents_int: type: number base_rent_in_cents_int: type: number title: unit-details - type: object properties: {} title: unit-pricing - type: object properties: id: type: string description: The Propexo unique identifier for the unit created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_floor_plan_id: type: - string - "null" description: The external ID of the floor plan from the integration vendor x_unit_type_id: type: - string - "null" description: The external ID of the unit type from the integration vendor bathrooms: type: - string - "null" description: The number of bathrooms associated with the unit bathrooms_full: type: *a249 description: The number of full bathrooms associated with the unit bathrooms_half: type: *a250 description: The number of half bathrooms associated with the unit bedrooms: type: - string - "null" description: The number of bedrooms associated with the unit building_name: type: - string - "null" description: The building name associated with the unit building_number: type: - string - "null" description: The building number associated with the unit city: type: - string - "null" description: The city associated with the unit country: type: - string - "null" description: The country associated with the unit custom_data: type: - object - "null" properties: {} description: Custom data floor_plan_code: type: - string - "null" description: The external ID of the floor plan associated with the unit floor_plan_name: type: - string - "null" description: The floor plan name associated with the unit floor: type: - string - "null" description: The floor number/name associated with the unit is_available: type: - boolean - "null" description: Whether the unit is available is_furnished: type: - boolean - "null" description: Whether the unit is furnished is_listed: type: - boolean - "null" description: "DEPRECATED: Use listings endpoints." deprecated: true is_vacant: type: - boolean - "null" description: Whether the unit is vacant number: type: - string - "null" description: The unit number rent_amount_market_in_cents: type: *a251 description: The market rent amount in cents for the unit example: 100000 rent_amount_max_in_cents: type: *a252 description: The maximum rent amount in cents example: 100000 rent_amount_min_in_cents: type: *a253 description: The minimum rent amount in cents example: 100000 square_feet: type: - integer - "null" minimum: 0 description: The square footage of the unit state: type: - string - "null" description: The state associated with the unit street_address_1: type: - string - "null" description: "Deprecated: Use address_1" deprecated: true street_address_2: type: - string - "null" description: "Deprecated: Use address_2" deprecated: true address_1: type: - string - "null" description: The first address line associated with the unit x-propexo: *a254 address_2: type: - string - "null" description: The second address line associated with the unit x-propexo: *a255 zip: type: - string - "null" description: The zip code associated with the unit pets_allowed: type: - boolean - "null" description: Whether or not pets are allowed dogs_allowed: type: - boolean - "null" description: Whether or not dogs are allowed cats_allowed: type: - boolean - "null" description: Whether or not cats are allowed pet_policy: type: - string - "null" description: The pet policy for the unit floor_plan_id: type: - string - "null" description: The Propexo unique identifier for the floor plan integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property unit_type_id: type: - string - "null" description: The Propexo unique identifier for the unit type rent_amount_market_in_cents_int: type: number rent_amount_max_in_cents_int: type: number rent_amount_min_in_cents_int: type: number title: units - type: object properties: {} title: units-to-amenity - type: object properties: {} title: vendor-insurance-coverage-types - type: object properties: {} title: vendor-insurance-policy-types - type: object properties: {} title: vendor-payment-types description: Payloads for the DATA_NEW event only include new data. For missing/incomplete data, the keys will be absent from the payload. This means that the payload shape could change for the same model between events. context: type: object additionalProperties: {} required: - job_id - root_job_id - integration_id - job_type - vendor - event - record_id - object - payload - context meta: type: object properties: object: type: string enum: *a352 integration_id: type: string required: - object - integration_id required: - trigger - data - meta description: Payload of the webhook that fires for the DATA_NEW event. title: DATA_NEW responses: "200": description: Return a 200 status to indicate that the webhook was received successfully /data_update: post: operationId: _v1_webhooks_data_update tags: - webhooks x-fern-webhook: true requestBody: content: application/json: schema: type: object properties: trigger: type: string enum: - DATA_UPDATE data: type: object properties: job_id: type: string root_job_id: type: string integration_id: type: string job_type: type: string vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST event: type: string enum: - DATA_UPDATE record_id: type: string object: type: string enum: *a352 diff: type: object properties: new: anyOf: - type: object properties: {} title: accounting-entities - type: object properties: id: type: string description: The Propexo unique identifier for the address type created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: string description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: type: string description: The name associated with the address type description: type: - string - "null" description: Description of the address type integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property title: address-types - type: object properties: id: type: string description: The Propexo unique identifier for the amenity created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_listing_id: type: - string - "null" description: The external ID of the listing from the integration vendor x_parent_amenity_id: type: - string - "null" description: The external ID from the integration vendor of the amenity this unit and/or property amenity is associated with x_property_id: type: string description: The external ID of the property from the integration vendor x_unit_id: type: - string - "null" description: 'DEPRECATED: Please use the "units" field to see the associated units with this amenity' deprecated: true cost_in_cents: type: *a9 description: Cost in cents for the amenity example: 100000 custom_data: type: - object - "null" properties: {} description: Custom data description: type: - string - "null" description: Description of the amenity image_urls: type: array items: type: string example: https://loremflickr.com/640/480/apartment description: A list of image urls associated with the amenity is_unit_amenity: type: - boolean - "null" description: Whether the amenity is a unit amenity meta_data: type: - object - "null" properties: {} description: Meta data for the amenity name_normalized: type: - string - "null" enum: *a10 description: The name associated with the amenity name: type: string description: The name associated with the amenity units: type: array items: type: object properties: amenity_id: type: string description: The Propexo unique identifier for the amenity example: cm2j4ivcv0000eioz6rd365se unit_id: type: string description: The Propexo unique identifier for the unit example: cm2j4jbzf0002eiozdudz9bda cost_in_cents: type: *a11 description: Cost in cents for the amenity on a particular unit example: 100000 required: - amenity_id - unit_id - cost_in_cents x-propexo: *a12 description: List of unit ids associated with the amenity integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property cost_in_cents_int: type: number title: amenities - type: object properties: {} title: ap-codes - type: object properties: {} title: ap-codes-to-construction-job - type: object properties: {} title: applicant-pets - type: object properties: id: type: string description: The Propexo unique identifier for the applicant created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_unit_id: type: - string - "null" description: "DEPRECATED: Use x_unit_id_preferred instead" deprecated: true x_lease_id: type: - string - "null" description: "DEPRECATED: Not in use." deprecated: true x_lead_id: type: - string - "null" description: The external ID of the lead from the integration vendor x_unit_id_preferred: type: array items: type: string description: The external IDs of the units from the integration vendor that the applicant is interested in address_1_alternate: type: - string - "null" description: The first alternate address line associated with the applicant address_1: type: - string - "null" description: The first address line associated with the applicant address_2_alternate: type: - string - "null" description: The second alternate address line associated with the applicant address_2: type: - string - "null" description: The second address line associated with the applicant applications: type: array items: type: object properties: applicant_id: type: string application_id: type: string status: type: - string - "null" description: DEPRECATED. Use status_raw or status_normalized deprecated: true status_raw: type: - string - "null" description: The raw status associated with the applicant status_normalized: anyOf: - type: string enum: - APPROVED - DENIED - CANCELED - OTHER - PENDING - type: string - type: "null" description: The normalized status associated with the applicant. Confirm these derived values before using them in production. custom_data: type: - object - "null" properties: {} description: Custom data required: - applicant_id - application_id x-propexo: *a295 description: Applications that the applicant has submitted city_alternate: type: - string - "null" description: The alternate city associated with the applicant city: type: - string - "null" description: The city associated with the applicant country_alternate: type: - string - "null" description: The alternate country associated with the applicant country: type: - string - "null" description: The country associated with the applicant custom_data: type: - object - "null" properties: {} description: Custom data date_of_birth: type: - string - "null" description: The date of birth associated with the applicant email_1: type: - string - "null" description: The primary email address associated with the applicant email_2: type: - string - "null" description: The secondary email address associated with the applicant first_name: type: - string - "null" description: The first name associated with the applicant self_reported_income: type: array items: $ref: "#/components/schemas/IncomeSource" description: Self reported income sources for the applicant last_name: type: - string - "null" description: The last name associated with the applicant middle_name: type: - string - "null" description: The middle name associated with the applicant notes: type: - string - "null" description: Notes associated with the applicant phone_1_type: type: - string - "null" enum: - FAX - HOME - MOBILE - OTHER - WORK description: Type of the primary phone number phone_1: type: - string - "null" description: Primary phone number associated with the applicant phone_2_type: type: - string - "null" enum: - FAX - HOME - MOBILE - OTHER - WORK description: Type of the secondary phone number phone_2: type: - string - "null" description: Secondary phone number associated with the applicant state_alternate: type: - string - "null" description: The alternate state associated with the applicant state: type: - string - "null" description: The state associated with the applicant type_normalized: type: - string - "null" description: The normalized type associated with the applicant type_raw: type: - string - "null" description: The raw type associated with the applicant zip_alternate: type: - string - "null" description: The alternate zip code associated with the applicant zip: type: - string - "null" description: The zip code associated with the applicant pets: type: array items: type: object properties: id: type: string description: The Propexo unique identifier for the applicant pet created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor age_in_years: type: - number - "null" description: The age in years of the applicant pet breed: type: - string - "null" description: The breed of the applicant pet color: type: - string - "null" description: The color of the applicant pet gender_raw: type: - string - "null" description: The raw value for the gender of the applicant pet is_declawed: type: - boolean - "null" description: Whether the applicant pet is declawed is_fixed: type: - boolean - "null" description: Whether the applicant pet is fixed is_service_animal: type: - boolean - "null" description: Whether the applicant pet is a service animal is_trained: type: - boolean - "null" description: Whether the applicant pet is trained is_vaccinated: type: - boolean - "null" description: Whether the applicant pet is vaccinated name: type: - string - "null" description: The name associated with the applicant pet notes: type: - string - "null" description: Notes associated with the applicant pet type: type: - string - "null" description: The type associated with the applicant pet weight_in_pounds: type: - number - "null" description: The weight in pounds of the applicant pet custom_data: type: - object - "null" properties: {} description: Custom data required: - id - created_at - updated_at - last_seen - x_id - age_in_years - breed - color - gender_raw - is_declawed - is_fixed - is_service_animal - is_trained - is_vaccinated - name - notes - type - weight_in_pounds - custom_data x-propexo: *a296 integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property unit_id_preferred: type: array items: type: string description: The Propexo unique identifiers for the units that the applicant is interested in screenings: type: array items: type: object properties: id: type: string description: The Propexo ID of the screening created_at: type: string description: The date record first entered Propexo last_seen: type: string description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor status_raw: type: - string - "null" description: The status/results of the screening screening_date: type: - string - "null" description: The date the screening took place required: - id - created_at - last_seen - x_id - status_raw - screening_date x-propexo: *a153 title: applicants - type: object properties: applicant_id: type: string application_id: type: string status: type: - string - "null" description: DEPRECATED. Use status_raw or status_normalized deprecated: true status_raw: type: - string - "null" description: The raw status associated with the applicant status_normalized: anyOf: - type: string enum: - APPROVED - DENIED - CANCELED - OTHER - PENDING - type: string - type: "null" description: The normalized status associated with the applicant. Confirm these derived values before using them in production. custom_data: type: - object - "null" properties: {} description: Custom data title: applicants-to-applications - type: object properties: {} title: applicants-to-events - type: object properties: {} title: applicants-to-rentable-items - type: object properties: id: type: string description: The Propexo unique identifier for the application status created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: type: string description: The name associated with the application status property_id: type: string description: The Propexo unique identifier for the property integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record title: application-statuses - type: object properties: id: type: string description: The Propexo unique identifier for the application created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_property_id: type: string description: The external ID of the property from the integration vendor x_unit_id: type: - string - "null" description: The external ID of the unit from the integration vendor status: type: string description: The raw status associated with the application custom_data: type: - object - "null" properties: {} description: Custom data integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property unit_id: type: - string - "null" description: The Propexo unique identifier for the unit title: applications - type: object properties: id: type: string description: The Propexo unique identifier for the call log created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_lead_source_id: type: - string - "null" description: The external ID of the lead source from the integration vendor custom_data: type: - object - "null" properties: {} description: Custom data lead_source: type: - string - "null" description: The name of the source of the lead origin_phone_number: type: - string - "null" description: The phone number that originated the call for the call log integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property lead_source_id: type: - string - "null" description: The Propexo unique identifier for the lead source title: call-logs - type: object properties: {} title: charge-code-types - type: object properties: {} title: charge-code-types-to-charge-timings - type: object properties: id: type: string description: The Propexo unique identifier for the charge code created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. debit_gl_account: type: - string - "null" description: The GL account number for debits credit_gl_account: type: - string - "null" description: The GL account number for credits name: type: - string - "null" description: The name of the charge code description: type: - string - "null" description: A description of this charge code custom_data: type: - object - "null" properties: {} description: Custom data property_id: type: string description: The Propexo unique identifier for the property integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record title: charge-codes - type: object properties: {} title: charge-timings - type: object properties: id: type: string description: The Propexo unique identifier for the concession created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_unit_id: type: - string - "null" description: The external ID of the unit from the integration vendor x_floor_plan_id: type: - string - "null" description: The external ID of the floor plan from the integration vendor total_amount_in_cents: type: - integer - "null" description: The total amount of the concession start_date: type: - string - "null" description: The start date associated with the concession end_date: type: - string - "null" description: The end date associated with the concession is_active: type: - boolean - "null" description: Whether the concession is active description: type: - string - "null" description: Description of the concession is_one_time: type: - boolean - "null" description: Whether or not the concession occurs a single time is_recurring: type: - boolean - "null" description: Whether or not the concession is recurring monthly_fixed_amount_in_cents: type: - integer - "null" description: The monthly fixed amount of the concession in cents monthly_percentage_amount: type: - integer - "null" description: The monthly percentage amount of the concession. This is rounded to the nearest percent monthly_percentage_raw: type: - string - "null" description: The raw monthly percentage amount of the concession as a string, preserving decimal precision one_time_fixed_amount_in_cents: type: - integer - "null" description: The one time fixed amount of the concession in cents one_time_percentage_amount: type: - integer - "null" description: The one time percentage amount of the concession. This is rounded to the nearest percent one_time_percentage_raw: type: - string - "null" description: The raw one time percentage amount of the concession as a string, preserving decimal precision number_of_occurrences: type: - integer - "null" description: The number of occurrences of the concession fixed_amount_in_cents: type: - integer - "null" description: The fixed amount of the concession in cents percentage_amount: type: - integer - "null" description: The percentage amount of the concession. This is rounded to the nearest percent percentage_raw: type: - string - "null" description: The raw percentage amount of the concession as a string, preserving decimal precision lease_term_in_months: type: - integer - "null" description: The amount of months for the lease term lease_term_raw: type: - string - "null" description: The raw value for the lease term concession_formula_raw: type: - string - "null" description: The raw formula name used to calculate the concession (e.g., "Fixed Amount", "Percent of Charge Code Group") integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property unit_id: type: - string - "null" description: The Propexo unique identifier for the unit floor_plan_id: type: - string - "null" description: The Propexo unique identifier for the floor plan title: concessions - type: object properties: id: type: string description: The Propexo unique identifier for the construction job created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. category_description: type: - string - "null" description: The description of the category for the construction job detail cost_code: type: - string - "null" description: The cost code of the construction job detail original_budget_in_cents: type: *a297 description: The original budget of the construction job detail example: 100000 revised_budget_in_cents: type: *a298 description: The revised budget of the construction job detail example: 100000 invoiced_total_in_cents: type: *a299 description: The total amount invoiced, in cents, for the construction job detail example: 100000 custom_data: type: - object - "null" properties: {} description: Custom data property_id: type: string description: The Propexo unique identifier for the property integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record original_budget_in_cents_int: type: number revised_budget_in_cents_int: type: number invoiced_total_in_cents_int: type: number title: construction-job-details - type: object properties: id: type: string description: The Propexo unique identifier for the construction job created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_gl_account_id: type: - string - "null" description: The external ID of the general ledger account from the integration vendor actual_end_date: type: - string - "null" description: The actual date the construction job ended actual_start_date: type: - string - "null" description: The actual date the construction job started name: type: string description: The name associated with the construction job planned_end_date: type: - string - "null" description: The date the construction job was planned to end planned_start_date: type: - string - "null" description: The date the construction job was planned to start status_normalized: type: - string - "null" description: The normalized status for the construction job status_raw: type: - string - "null" description: The raw status associated with the construction job total_budget_in_cents: type: *a300 description: The total budget for the construction job example: 100000 custom_data: type: - object - "null" properties: {} description: Custom data property_id: type: string description: The Propexo unique identifier for the property integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record total_budget_in_cents_int: type: number title: construction-jobs - type: object properties: id: type: string description: The Propexo unique identifier for the contract detail created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_category_id: type: - string - "null" description: The external ID of the category from the integration vendor x_financial_account_id: type: - string - "null" description: The external ID of the financial account from the integration vendor category_description: type: - string - "null" description: The description of the category for the contract detail cost_code: type: - string - "null" description: The cost code of the contract detail custom_data: type: - object - "null" properties: {} description: Custom data invoiced_total_in_cents: type: *a301 description: The total amount invoiced, in cents, for the contract detail example: 100000 notes: type: - string - "null" description: Notes associated with the contract detail retention_percent: type: - string - "null" description: The retention percent of the contract detail total_amount_in_cents: type: *a302 description: The total amount of the contract detail example: 100000 contract_id: type: string description: The Propexo unique identifier for the contract financial_account_id: type: - string - "null" description: The Propexo unique identifier for the financial account property_id: type: string description: The Propexo unique identifier for the property integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record invoiced_total_in_cents_int: type: number total_amount_in_cents_int: type: number title: contract-details - type: object properties: id: type: string description: The Propexo unique identifier for the contract created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_construction_job_id: type: - string - "null" description: The external ID of the construction job from the integration vendor x_vendor_id: type: - string - "null" description: The external ID of the vendor from the integration vendor custom_data: type: - object - "null" properties: {} description: Custom data end_date: type: - string - "null" description: The end date associated with the contract expense_type: type: - string - "null" description: The expense type of the contract invoiced_total_in_cents: type: *a303 description: The total amount invoiced, in cents, for the contract example: 100000 notes: type: - string - "null" description: Notes associated with the contract original_amount_in_cents: type: *a304 description: The original amount of the contract example: 100000 retention_percent: type: - string - "null" description: The retention percent of the contract start_date: type: - string - "null" description: The start date associated with the contract status_normalized: type: - string - "null" description: The normalized status for the contract status_raw: type: - string - "null" description: The raw status associated with the contract total_amount_in_cents: type: *a305 description: The total amount of the contract example: 100000 construction_job_id: type: - string - "null" description: The Propexo unique identifier for the construction job vendor_id: type: - string - "null" description: The Propexo unique identifier for the vendor property_id: type: string description: The Propexo unique identifier for the property integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record invoiced_total_in_cents_int: type: number original_amount_in_cents_int: type: number total_amount_in_cents_int: type: number title: contracts - type: object properties: id: type: string description: The Propexo unique identifier for the agent created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor custom_data: type: - object - "null" properties: {} description: Custom data name: type: - string - "null" description: The name associated with the agent email: type: - string - "null" description: The primary email address associated with the agent phone: type: - string - "null" description: Primary phone number associated with the agent is_active: type: - boolean - "null" description: Whether the agent is active roles: type: - array - "null" items: type: string description: The roles associated with the agent integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record title: crm-agents - type: object properties: {} title: crm-amenities - type: object properties: id: type: string description: The Propexo unique identifier for the attribution created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor custom_data: type: - object - "null" properties: {} description: Custom data name: type: - string - "null" description: The name associated with the attribution email: type: - string - "null" description: The primary email address associated with the attribution url: type: - string - "null" description: The primary url associated with the attribution is_active: type: - boolean - "null" description: Whether the attribution is active integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The CRM system of record title: crm-attributions - type: object properties: id: type: string description: The Propexo unique identifier for the community created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor custom_data: type: - object - "null" properties: {} description: Custom data address_1: type: - string - "null" description: The first address line associated with the community address_2: type: - string - "null" description: The second address line associated with the community city: type: - string - "null" description: The city associated with the community state: type: - string - "null" description: The state associated with the community zip: type: - string - "null" description: The zip code associated with the community url: type: - string - "null" description: The primary url associated with the community email: type: - string - "null" description: The primary email address associated with the community phone: type: - string - "null" description: Primary phone number associated with the community coordinates: type: object properties: lat: type: - string - "null" description: The latitude associated with the community x-propexo: *a353 long: type: - string - "null" description: The longitude associated with the community x-propexo: *a354 required: - lat - long description: The coordinates associated with the community x-propexo: *a355 integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The CRM system of record title: crm-communities - type: object properties: {} title: crm-communities-to-agents - type: object properties: {} title: crm-communities-to-attributions - type: object properties: id: type: string description: The Propexo unique identifier for the event created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_agent_id: type: - string - "null" description: The external ID of the agent from the integration vendor x_community_id: type: string description: The external ID of the community from the integration vendor x_created_at: type: - string - "null" description: The date the record first entered the integration vendor x_id: type: string description: The external ID from the integration vendor x_prospect_id: type: string description: The external ID of the prospect from the integration vendor appointment_datetime: type: - string - "null" description: The date when the appointment will occur appointment_duration_minutes: type: - number - "null" description: The duration of the appointment, in minutes custom_data: type: - object - "null" properties: {} description: Custom data event_datetime: type: - string - "null" description: The date when the event will occur notes: type: - string - "null" description: Notes associated with the event type_raw: type: - string - "null" description: The raw type associated with the event agent_id: type: - string - "null" description: The Propexo unique identifier for the agent community_id: type: string description: The Propexo unique identifier for the community prospect_id: type: string description: The Propexo unique identifier for the prospect integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The CRM system of record title: crm-events - type: object properties: id: type: string description: The Propexo unique identifier for the listing created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_community_id: type: - string - "null" description: The external ID of the community from the integration vendor available_date: type: - string - "null" description: The date that the listing becomes available bathrooms: type: - string - "null" description: The number of bathrooms associated with the listing bathrooms_full: type: - number - "null" description: The number of full bathrooms associated with the listing bathrooms_half: type: - number - "null" description: The number of half bathrooms associated with the listing bedrooms: type: - string - "null" description: The number of bedrooms associated with the listing building_name: type: - string - "null" description: The building name associated with the listing city: type: - string - "null" description: The city associated with the listing custom_data: type: - object - "null" properties: {} description: Custom data floor: type: - string - "null" description: The floor number/name associated with the listing image_urls_array: type: - array - "null" items: type: string description: A list of image urls associated with the listing is_furnished: type: - boolean - "null" description: Whether the listing is furnished is_listed: type: - boolean - "null" description: Whether the listing is listed notes: type: - string - "null" description: Notes associated with the listing number: type: - string - "null" description: The unit number property_description: type: - string - "null" description: Description of the property publish_date: type: - string - "null" description: The date the listing was published rent_amount_in_cents: type: *a356 description: The rent amount in cents for the listing example: 100000 square_feet: type: - number - "null" description: The square footage of the listing state: type: - string - "null" description: The state associated with the listing status_raw: type: - string - "null" description: The raw status associated with the listing street_address_1: type: - string - "null" description: The first address line associated with the listing street_address_2: type: - string - "null" description: The second address line associated with the listing title: type: - string - "null" description: The title associated with the listing url: type: - string - "null" description: The application url associated with the listing video_urls: type: - array - "null" items: type: string description: A list of video urls associated with the listing zip: type: - string - "null" description: The zip code associated with the listing community_id: type: - string - "null" description: The Propexo unique identifier for the community integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The CRM system of record rent_amount_in_cents_int: type: number title: crm-listings - type: object properties: {} title: crm-pet-policies - type: object properties: id: type: string description: The Propexo unique identifier for the prospect created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_community_id: type: - string - "null" description: The external ID of the community from the integration vendor custom_data: type: - object - "null" properties: {} description: Custom data first_name: type: - string - "null" description: The first name associated with the prospect last_name: type: - string - "null" description: The last name associated with the prospect address_raw: type: - string - "null" description: The raw address associated with the prospect address_1: type: - string - "null" description: The first address line associated with the prospect address_2: type: - string - "null" description: The second address line associated with the prospect city: type: - string - "null" description: The city associated with the prospect state: type: - string - "null" description: The state associated with the prospect zip: type: - string - "null" description: The zip code associated with the prospect email: type: - string - "null" description: The primary email address associated with the prospect phone_1: type: - string - "null" description: Primary phone number associated with the prospect phone_2: type: - string - "null" description: Secondary phone number associated with the prospect move_in_date: type: - string - "null" description: The move-in date associated with the prospect minimum_budget_in_cents: type: *a357 description: The minimum budget, in cents, of the prospect example: 100000 maximum_budget_in_cents: type: *a358 description: The maximum budget, in cents, of the prospect example: 100000 community_id: type: - string - "null" description: The Propexo unique identifier for the community integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The CRM system of record minimum_budget_in_cents_int: type: number maximum_budget_in_cents_int: type: number title: crm-prospects - type: object properties: id: type: string description: The Propexo unique identifier for the deposit summary created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_resident_id: type: string description: The external ID of the resident from the integration vendor x_building_id: type: - string - "null" description: The external ID of the building (not necessarily the property) from the integration vendor x_invoice_id: type: - string - "null" description: The external ID of the invoice from the integration vendor x_lease_id: type: - string - "null" description: The external ID of the lease from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_unit_id: type: - string - "null" description: The external ID of the unit from the integration vendor amount_charged_in_cents: type: *a116 description: The amount charged in cents example: 100000 amount_paid_in_cents: type: *a117 description: The amount paid in cents example: 100000 amount_refunded_in_cents: type: *a118 description: The amount refunded in cents example: 100000 notes: type: - string - "null" description: Notes associated with the deposit summary refund_amount_due_in_cents: type: *a119 description: The refund amount due in cents example: 100000 custom_data: type: - object - "null" properties: {} description: Custom data integration_data: type: - object - "null" properties: {} description: Integration-specific data integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record invoice_id: type: - string - "null" description: The Propexo unique identifier for the invoice lease_id: type: - string - "null" description: The Propexo unique identifier for the lease unit_id: type: - string - "null" description: The Propexo unique identifier for the unit resident_id: type: string description: The Propexo unique identifier for the resident property_id: type: string description: The Propexo unique identifier for the property amount_charged_in_cents_int: type: number amount_paid_in_cents_int: type: number amount_refunded_in_cents_int: type: number refund_amount_due_in_cents_int: type: number title: deposit-summaries - type: object properties: id: type: string description: The Propexo unique identifier for the deposit created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_resident_id: type: string description: The external ID of the resident from the integration vendor x_building_id: type: - string - "null" description: The external ID of the building (not necessarily the property) from the integration vendor x_deposit_type: type: - string - "null" description: The external type of the deposit from the integration vendor x_lease_id: type: - string - "null" description: The external ID of the lease from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. amount_charged_in_cents: type: *a122 description: The amount charged in cents example: 100000 amount_paid_in_cents: type: *a123 description: The amount paid in cents example: 100000 amount_refunded_in_cents: type: *a124 description: The amount refunded in cents example: 100000 notes: type: - string - "null" description: Notes associated with the deposit refund_amount_due_in_cents: type: *a125 description: The refund amount due in cents example: 100000 custom_data: type: - object - "null" properties: {} description: Custom data integration_data: type: - object - "null" properties: {} description: Integration-specific data integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record lease_id: type: - string - "null" description: The Propexo unique identifier for the lease resident_id: type: string description: The Propexo unique identifier for the resident property_id: type: string description: The Propexo unique identifier for the property amount_charged_in_cents_int: type: number amount_paid_in_cents_int: type: number amount_refunded_in_cents_int: type: number refund_amount_due_in_cents_int: type: number title: deposits - type: object properties: id: type: string description: The Propexo unique identifier for the employee created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: type: - string - "null" description: The name associated with the employee email: type: - string - "null" description: The primary email address associated with the employee is_active: type: - boolean - "null" description: Whether the employee is active roles: type: array items: type: string description: The roles associated with the employee integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property title: employees - type: object properties: id: type: string description: The Propexo unique identifier for the lease period created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_application_template_id: type: - string - "null" description: The external ID of the application template from the integration vendor name: type: string description: The name associated with the lease period application_template_id: type: - string - "null" description: The Propexo unique identifier for the application template integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property title: entrata-lease-periods - type: object properties: id: type: string description: The Propexo unique identifier for the unit type created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: type: string description: The name associated with the unit type bedrooms: type: - integer - "null" minimum: 0 description: The number of bedrooms associated with the unit type bathrooms: type: - string - "null" description: The number of bathrooms associated with the unit type bathrooms_full: type: - integer - "null" minimum: 0 description: The number of full bathrooms associated with the unit type bathrooms_half: type: - integer - "null" minimum: 0 description: The number of half bathrooms associated with the unit type rentable_square_feet: type: - integer - "null" minimum: 0 description: The rentable square footage of the unit type gross_square_feet: type: - integer - "null" minimum: 0 description: The gross square footage of the unit type rent_minimum_in_cents: type: *a256 description: The minimum rent of the unit type example: 100000 rent_maximum_in_cents: type: *a257 description: The maximum rent of the unit type example: 100000 unit_count: type: - integer - "null" minimum: 0 description: The number of units associated with the unit type deposit_amount_in_cents: type: *a258 description: The deposit amount in cents associated with the unit type example: 100000 deposit_amount_raw: type: - string - "null" description: The raw deposit amount associated with the unit type integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property rent_minimum_in_cents_int: type: number rent_maximum_in_cents_int: type: number deposit_amount_in_cents_int: type: number title: entrata-unit-types - type: object properties: id: type: string description: The Propexo unique identifier for the vendor location created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: type: string description: The name associated with the vendor location integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property title: entrata-vendor-locations - type: object properties: id: type: string description: The Propexo unique identifier for the event type created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: type: string description: The name associated with the event type integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property associated_event_type_ids: type: array items: type: string description: The Propexo unique identifier for the event type x-propexo: *a359 title: event-results - type: object properties: {} title: event-results-to-event-types - type: object properties: id: type: string description: The Propexo unique identifier for the event sub type created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_event_type_id: type: - string - "null" description: The external ID of the event type from the integration vendor name: type: string description: The name associated with the event sub type integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property event_type_id: type: - string - "null" description: The Propexo unique identifier for the event type title: event-sub-types - type: object properties: id: type: string description: The Propexo unique identifier for the event type created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. code: type: - string - "null" description: The code associated with the event type models: type: array items: type: string description: The Propexo data models (e.g. units, residents, applicants, etc.) associated with the event type name: type: string description: The name associated with the event type integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property title: event-types - type: object properties: id: type: string description: The Propexo unique identifier for the event created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_leasing_agent_id: type: - string - "null" description: The external ID of the leasing agent from the integration vendor x_type_id: type: - string - "null" description: The external ID of the type from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. event_name: type: - string - "null" description: The name of the event event_datetime: type: - string - "null" description: The datetime that the event occurred appointment_datetime: type: - string - "null" description: The datetime that the event appointment occurred type_raw: type: - string - "null" description: The type of event notes: type: - string - "null" description: Notes associated with the event agent_name: type: - string - "null" description: The name of the agent associated with the event reasons_for_event: type: - string - "null" description: Reasons that the event occurred associated_lead_ids: type: - array - "null" items: type: string example: cm2jeb8af00042qoza7lcb5cx description: The lead IDs associated with the event associated_applicant_ids: type: - array - "null" items: type: string x-propexo: *a306 description: The applicant IDs associated with the event associated_resident_ids: type: - array - "null" items: type: string example: cm2jebkdu00072qozfa5p9rs7 description: The resident IDs associated with the event integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property title: events - type: object properties: id: type: string description: The Propexo unique identifier for the fee created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_charge_code_id: type: - string - "null" description: The external ID of the charge code from the integration vendor x_floor_plan_id: type: - string - "null" description: The external ID of the floor plan from the integration vendor x_unit_id: type: - string - "null" description: The external ID of the unit from the integration vendor amount_in_cents: type: *a307 description: The amount of the fee, in cents example: 12500 amount_raw: type: - string - "null" description: The raw value for amount from the PMS charge_code_name: type: - string - "null" description: The name of the charge code description: type: - string - "null" description: Description of the fee name: type: - string - "null" description: The name associated with the fee custom_data: type: - object - "null" additionalProperties: {} description: Custom data integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property floor_plan_id: type: - string - "null" description: The Propexo unique identifier for the floor plan unit_id: type: - string - "null" description: The Propexo unique identifier for the unit charge_code_id: type: - string - "null" description: The Propexo unique identifier for the charge code amount_in_cents_int: type: number title: fees - type: object properties: id: type: string description: The Propexo unique identifier for the file type created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. code: type: - string - "null" description: The code associated with the file type models: type: array items: type: string description: The Propexo data models (e.g. units, residents, applicants, etc.) associated with the file type name: type: string description: The name associated with the file type type: type: string description: The type associated with the file type integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property title: file-types - type: object properties: id: type: string description: The Propexo unique identifier for the financial account created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: type: - string - "null" description: The name of the financial account status_raw: type: - string - "null" description: The raw status associated with the financial account account_number: type: - string - "null" description: The account number associated with the financial account custom_data: type: - object - "null" properties: {} description: Custom data property_id: type: string description: The Propexo unique identifier for the property integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record title: financial-accounts - type: object properties: id: type: string description: The Propexo unique identifier for the floor plan created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: type: string description: The name associated with the floor plan marketing_name: type: - string - "null" description: The marketing name of the floor plan code: type: - string - "null" description: The code associated with the floor plan description: type: - string - "null" description: Description of the floor plan bedrooms: type: - integer - "null" minimum: 0 description: The number of bedrooms associated with the floor plan bathrooms: type: - string - "null" description: The number of bathrooms associated with the floor plan bathrooms_full: type: - integer - "null" minimum: 0 description: The number of full bathrooms associated with the floor plan bathrooms_half: type: - integer - "null" minimum: 0 description: The number of half bathrooms associated with the floor plan max_occupants: type: - integer - "null" minimum: 0 description: The maximum number of occupants for the floor plan rentable_square_feet: type: - integer - "null" minimum: 0 description: The rentable square footage of the floor plan gross_square_feet: type: - integer - "null" minimum: 0 description: The gross square footage of the floor plan rent_minimum_in_cents: type: *a308 description: The minimum rent of the floor plan example: 100000 rent_maximum_in_cents: type: *a309 description: The maximum rent of the floor plan example: 100000 image_urls: type: array items: type: string description: A list of image urls associated with the floor plan x-propexo: *a360 unit_count: type: - integer - "null" minimum: 0 description: The number of units associated with the floor plan deposit_amount_in_cents: type: *a310 description: The deposit amount in cents associated with the floor plan example: 100000 deposit_amount_raw: type: - string - "null" description: The raw deposit amount associated with the floor plan deposit_amount_min_in_cents: type: *a311 description: The minimum deposit amount in cents associated with the floor plan example: 100000 deposit_amount_max_in_cents: type: *a312 description: The maximum deposit amount in cents associated with the floor plan example: 100000 deposit_amount_min_raw: type: - string - "null" description: The raw minimum deposit amount associated with the floor plan deposit_amount_max_raw: type: - string - "null" description: The raw maximum deposit amount associated with the floor plan custom_data: type: - object - "null" properties: {} description: Custom data integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property rent_minimum_in_cents_int: type: number rent_maximum_in_cents_int: type: number deposit_amount_in_cents_int: type: number deposit_amount_min_in_cents_int: type: number deposit_amount_max_in_cents_int: type: number title: floor-plans - type: object properties: {} title: integration-configuration-meta-data - type: object properties: x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_gl_account_id: type: - string - "null" description: The external ID of the financial account from the integration vendor x_cash_financial_account_id: type: - string - "null" description: The external ID of the cash financial account from the integration vendor invoice_id: type: string description: The Propexo unique identifier for the invoice construction_job_id: type: - string - "null" description: The Propexo unique identifier for the construction job amount_due_in_cents: type: *a145 description: The amount due on the invoice item, in cents example: 100000 notes: type: - string - "null" description: Notes associated with the invoice item total_amount_in_cents: type: *a146 description: The amount of the invoice item, in cents example: 100000 property_id: type: string description: The Propexo unique identifier for the property financial_account_id: type: - string - "null" description: The Propexo unique identifier for the financial account cash_financial_account_id: type: - string - "null" description: The Propexo unique identifier for the cash financial account amount_due_in_cents_int: type: number total_amount_in_cents_int: type: number title: invoice-items - type: object properties: id: type: string description: The Propexo unique identifier for the invoice created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_vendor_id: type: - string - "null" description: The external ID of the vendor from the integration vendor x_financial_account_id: type: - string - "null" description: The external ID of the financial account from the integration vendor x_cash_financial_account_id: type: - string - "null" description: The external ID of the cash financial account from the integration vendor x_ap_financial_account_id: type: - string - "null" description: The external ID of the AP financial account from the integration vendor amount_due_in_cents: type: *a140 description: The amount due on the invoice, in cents example: 100000 amount_paid_in_cents: type: *a141 description: The amount paid on the invoice, in cents example: 100000 custom_data: type: - object - "null" properties: {} description: Custom data due_date: type: - string - "null" description: The due date associated with the invoice discount_amount_in_cents: type: *a142 description: The deposit amount in cents associated with the invoice example: 100000 discount_date: type: - string - "null" description: The date a discount was issued on invoice invoice_date: type: - string - "null" description: The date the invoice was issued invoice_number: type: - string - "null" description: The reference number for the invoice notes: type: - string - "null" description: Notes associated with the invoice post_date: type: - string - "null" description: The date the invoice was posted. Some PMS systems only show the month. post_month: type: - string - "null" description: The month the invoice was posted. post_status_raw: type: - string - "null" description: The raw post status associated with the invoice sub_total_amount_in_cents: type: *a143 description: The sub total amount of the invoice example: 100000 total_amount_in_cents: type: *a144 description: The amount of the invoice, in cents example: 100000 property_id: type: string description: The Propexo unique identifier for the property financial_account_id: type: - string - "null" description: The Propexo unique identifier for the financial account cash_financial_account_id: type: - string - "null" description: The Propexo unique identifier for the cash financial account ap_financial_account_id: type: - string - "null" description: The Propexo unique identifier for the ap financial account integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record invoice_items: type: array items: type: object properties: x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_gl_account_id: type: - string - "null" description: The external ID of the financial account from the integration vendor x_cash_financial_account_id: type: - string - "null" description: The external ID of the cash financial account from the integration vendor invoice_id: type: string description: The Propexo unique identifier for the invoice construction_job_id: type: - string - "null" description: The Propexo unique identifier for the construction job amount_due_in_cents: type: *a145 description: The amount due on the invoice item, in cents example: 100000 notes: type: - string - "null" description: Notes associated with the invoice item total_amount_in_cents: type: *a146 description: The amount of the invoice item, in cents example: 100000 property_id: type: string description: The Propexo unique identifier for the property financial_account_id: type: - string - "null" description: The Propexo unique identifier for the financial account cash_financial_account_id: type: - string - "null" description: The Propexo unique identifier for the cash financial account required: - x_id - x_property_id - x_location_id - x_gl_account_id - x_cash_financial_account_id - invoice_id - construction_job_id - amount_due_in_cents - notes - total_amount_in_cents - property_id - financial_account_id - cash_financial_account_id x-propexo: *a147 description: The invoice list items associated with the invoice amount_due_in_cents_int: type: number amount_paid_in_cents_int: type: number discount_amount_in_cents_int: type: number sub_total_amount_in_cents_int: type: number total_amount_in_cents_int: type: number title: invoices - type: object properties: id: type: string description: The Propexo unique identifier for the lead pet created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor age_in_years: type: - number - "null" description: The age in years of the lead pet breed: type: - string - "null" description: The breed of the lead pet color: type: - string - "null" description: The color of the lead pet gender_raw: type: - string - "null" description: The raw value for the gender of the lead pet is_fixed: type: - boolean - "null" description: Whether the lead pet is fixed is_service_animal: type: - boolean - "null" description: Whether the lead pet is a service animal name: type: - string - "null" description: The name associated with the lead pet notes: type: - string - "null" description: Notes associated with the lead pet type: type: - string - "null" description: The type associated with the lead pet weight_in_pounds: type: - number - "null" description: The weight in pounds of the lead pet custom_data: type: - object - "null" properties: {} description: Custom data title: lead-pets - type: object properties: id: type: string description: The Propexo unique identifier for the lead relationship created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: type: string description: The name associated with the lead relationship integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property title: lead-relationships - type: object properties: id: type: string description: The Propexo unique identifier for the lead source created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: type: - string - "null" description: The name associated with the lead source integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property title: lead-sources - type: object properties: id: type: string description: The Propexo unique identifier for the lead created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_created_at: type: - string - "null" description: The date the record first entered the integration vendor x_guestcard_id: type: - string - "null" description: The external ID of the guestcard from the integration vendor x_id: type: string description: The external ID from the integration vendor x_leasing_agent_id: type: - string - "null" description: The external ID of the leasing agent from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_unit_id: type: - string - "null" description: "DEPRECATED: Use x_unit_id_preferred instead" deprecated: true x_unit_id_preferred: type: array items: type: string description: The external IDs of the units from the integration vendor that the lead is interested in x_updated_at: type: - string - "null" description: The date the record was last updated in the integration vendor x_lead_source_id: type: - string - "null" description: The external ID of the lead source from the integration vendor address_1: type: - string - "null" description: The first address line associated with the lead address_2: type: - string - "null" description: The second address line associated with the lead city: type: - string - "null" description: The city associated with the lead country: type: - string - "null" description: The country associated with the lead custom_data: type: - object - "null" properties: {} description: Custom data date_of_birth: type: - string - "null" description: The date of birth associated with the lead desired_amenities: type: - string - "null" description: The desired amenities associated with the lead desired_floor_plan_id: type: - string - "null" description: The external ID of desired floor plan associated with the lead desired_floor_plan_name: type: - string - "null" description: The desired floor plan name desired_lease_term_in_months: type: - string - "null" description: The desired lease term desired_max_rent_in_cents: type: *a313 description: The desired maximum rent example: 100000 desired_max_square_ft: type: - number - "null" description: The desired maximum square feet desired_min_rent_in_cents: type: *a314 description: The desired minimum rent example: 100000 desired_min_square_ft: type: - number - "null" description: The desired minimum square feet desired_num_bathrooms: type: - number - "null" description: The desired number of bathrooms desired_num_bedrooms: type: - integer - "null" description: The desired number of bedrooms desired_unit_number: type: - string - "null" description: The desired unit number desired_unit_type: type: - string - "null" description: The desired unit type email_1: type: - string - "null" description: The primary email address associated with the lead email_2: type: - string - "null" description: The secondary email address associated with the lead first_name: type: - string - "null" description: The first name associated with the lead ils: type: - string - "null" description: The name of the Internet listing service last_name: type: - string - "null" description: The last name associated with the lead lead_source: type: - string - "null" description: The lead source leasing_agent: type: - string - "null" description: The name of the leasing agent middle_name: type: - string - "null" description: The middle name associated with the lead notes: type: - string - "null" description: Notes associated with the lead number_of_occupants: type: - integer - "null" description: The number of occupants pet_details: type: - string - "null" description: "DEPRECATED: Use the pets array instead" pets: type: array items: type: object properties: id: type: string description: The Propexo unique identifier for the lead pet created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor age_in_years: type: - number - "null" description: The age in years of the lead pet breed: type: - string - "null" description: The breed of the lead pet color: type: - string - "null" description: The color of the lead pet gender_raw: type: - string - "null" description: The raw value for the gender of the lead pet is_fixed: type: - boolean - "null" description: Whether the lead pet is fixed is_service_animal: type: - boolean - "null" description: Whether the lead pet is a service animal name: type: - string - "null" description: The name associated with the lead pet notes: type: - string - "null" description: Notes associated with the lead pet type: type: - string - "null" description: The type associated with the lead pet weight_in_pounds: type: - number - "null" description: The weight in pounds of the lead pet custom_data: type: - object - "null" properties: {} description: Custom data required: - id - created_at - updated_at - last_seen - x_id - age_in_years - breed - color - gender_raw - is_fixed - is_service_animal - name - notes - type - weight_in_pounds - custom_data x-propexo: *a315 description: The pets associated with the lead phone_1_type: type: - string - "null" description: Type of the primary phone number phone_1: type: - string - "null" description: Primary phone number associated with the lead phone_2_type: type: - string - "null" description: Type of the secondary phone number phone_2: type: - string - "null" description: Secondary phone number associated with the lead state: type: - string - "null" description: The state associated with the lead status: type: - string - "null" description: The raw status associated with the lead target_move_in_date: type: - string - "null" description: The target move in date zip: type: - string - "null" description: The zip code associated with the lead property_id: type: string description: The Propexo unique identifier for the property lead_source_id: type: - string - "null" description: The Propexo unique identifier for the lead source unit_id_preferred: type: array items: type: string description: The Propexo unique identifiers for the units that the lead is interested in integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record screenings: type: array items: type: object properties: id: type: string description: The Propexo ID of the screening created_at: type: string description: The date record first entered Propexo last_seen: type: string description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor status_raw: type: - string - "null" description: The status/results of the screening screening_date: type: - string - "null" description: The date the screening took place required: - id - created_at - last_seen - x_id - status_raw - screening_date x-propexo: *a153 desired_max_rent_in_cents_int: type: number desired_min_rent_in_cents_int: type: number title: leads - type: object properties: {} title: leads-to-events - type: object properties: {} title: leads-to-rentable-items - type: object properties: id: type: string description: The Propexo unique identifier for the lease service created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: string description: The date the record was last seen from the PMS name: type: string description: The name of the lease service lease_id: type: string description: The Propexo unique identifier for the lease title: lease-services - type: object properties: id: type: string description: The Propexo unique identifier for the lease transfer created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_resident_id: type: string description: The external ID of the resident from the integration vendor x_lease_id_next: type: string description: The external ID of the next lease from the integration vendor x_lease_property_id_next: type: - string - "null" description: The external ID of the property associated with the next lease from the integration vendor x_lease_id_previous: type: string description: The external ID of the previous lease from the integration vendor x_lease_property_id_previous: type: - string - "null" description: The external ID of the property associated with the previous lease from the integration vendor x_unit_id_next: type: - string - "null" description: The external ID of the next unit from the integration vendor x_unit_id_previous: type: - string - "null" description: The external ID of the previous unit from the integration vendor resident_type: type: - string - "null" description: The normalized type of the resident resident_type_raw: type: - string - "null" description: The raw type of the resident lease_status_next: type: - string - "null" description: The normalized status of the next lease lease_status_next_raw: type: - string - "null" description: The raw status of the next lease lease_status_previous: type: - string - "null" description: The normalized status of the previous lease lease_status_previous_raw: type: - string - "null" description: The raw status of the previous lease transfer_effective_date: type: - string - "null" description: The effective date of the lease transfer integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property resident_id: type: string description: The Propexo unique identifier for the resident lease_id_next: type: string description: The Propexo unique identifier for the next lease lease_id_previous: type: string description: The Propexo unique identifier for the previous lease unit_id_next: type: - string - "null" description: The Propexo unique identifier for the next unit unit_id_previous: type: - string - "null" description: The Propexo unique identifier for the previous unit title: lease-transfers - type: object properties: id: type: string description: The Propexo unique identifier for the lease created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_resident_id: type: - string - "null" description: Deprecated. Use residents_meta_data instead deprecated: true x_unit_id: type: - string - "null" description: The external ID of the unit from the integration vendor application_date: type: - string - "null" description: The application date associated with the lease custom_data: type: - object - "null" properties: {} description: Custom data deposit_amount: type: - string - "null" description: The deposit amount associated with the lease deposit_amount_in_cents: type: *a316 description: The deposit amount in cents associated with the lease example: 100000 deposit_date: type: - string - "null" description: The deposit date associated with the lease end_date: type: - string - "null" description: The end date associated with the lease realized_move_in_date: type: - string - "null" description: "The realized move-in date associated with the lease. Note: This move in date is at the lease level and could be different per resident. Please use residents_meta_data to view resident move in dates" realized_move_out_date: type: - string - "null" description: "The realized move-out date associated with the lease. Note: This move out date is at the lease level and could be different per resident. Please use residents_meta_data to view resident move out dates" rent_amount_in_cents: type: *a317 description: The rent amount in cents for the lease example: 100000 rent_amount_market_in_cents: type: *a318 description: The market rent amount in cents for the lease example: 100000 rent_due_day: type: - integer - "null" minimum: 0 description: The rent due day associated with the lease rent_due_date: type: - string - "null" description: The rent due date associated with the lease scheduled_move_in_date: type: - string - "null" description: "The scheduled move-in date associated with the lease. Note: This move in date is at the lease level and could be different per resident. Please use residents_meta_data to view resident move in dates" scheduled_move_out_date: type: - string - "null" description: "The scheduled move-out date associated with the lease. Note: This move out date is at the lease level and could be different per resident. Please use residents_meta_data to view resident move out dates" signature_date: type: - string - "null" description: The date the lease was signed start_date: type: - string - "null" description: The start date associated with the lease status: type: - string - "null" description: DEPRECATED. Use status_normalized deprecated: true status_normalized: type: - string - "null" enum: - ACTIVE - INACTIVE - OTHER - PENDING - EVICTED description: The normalized status for the lease. Note that the status may be called "EVICTED" but this can also refer to an active resident undergoing a current eviction. This varies per PMS. status_raw: type: - string - "null" description: The raw status associated with the lease term: type: - string - "null" description: The lease term type: type: - string - "null" description: The type of lease unit_number: type: - string - "null" description: The unit number associated with the lease. This isn't always provided by PMS vendors, but may be the only data provided to identify a unit associated with a service request in some cases. write_off_amount_in_cents: type: *a319 description: The write off amount for the lease, in cents example: 100000 write_off_amount_raw: type: - string - "null" description: The raw write off amount of the lease from the PMS balance_amount_in_cents: type: *a320 description: The balance amount for the lease, in cents example: 100000 balance_amount_raw: type: - string - "null" description: The raw balance amount of the lease from the PMS past_due_balance_in_cents: type: *a321 description: The past due balance for the lease, in cents example: 100000 past_due_balance_raw: type: - string - "null" description: The raw past due balance of the lease from the PMS unit_id: type: - string - "null" description: The Propexo unique identifier for the unit property_id: type: string description: The Propexo unique identifier for the property integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record services: type: array items: type: object properties: id: type: string description: The Propexo unique identifier for the lease service created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: string description: The date the record was last seen from the PMS name: type: string description: The name of the lease service lease_id: type: string description: The Propexo unique identifier for the lease required: - id - created_at - updated_at - last_seen - name - lease_id x-propexo: *a322 description: List of services related to the lease x-propexo: *a361 deposit_amount_in_cents_int: type: number rent_amount_in_cents_int: type: number rent_amount_market_in_cents_int: type: number write_off_amount_in_cents_int: type: number balance_amount_in_cents_int: type: number past_due_balance_in_cents_int: type: number title: leases - type: object properties: id: type: string description: The Propexo unique identifier for the listing created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_unit_id: type: - string - "null" description: The external ID of the unit from the integration vendor x_floor_plan_id: type: - string - "null" description: The external ID of the floor plan from the integration vendor is_unit: type: boolean description: True if the listing is for a unit, false if it is not associated with a specific unit available_date: type: - string - "null" description: The date the listing is available application_url: type: - string - "null" description: The application URL for the listing bathrooms: type: - string - "null" description: The number of bathrooms associated with the listing bathrooms_full: type: *a323 description: The number of full bathrooms associated with the listing bathrooms_half: type: *a324 description: The number of half bathrooms associated with the listing bedrooms: type: - string - "null" description: The number of bedrooms associated with the listing building_name: type: - string - "null" description: The building name associated with the listing building_number: type: - string - "null" description: The building number associated with the listing city: type: - string - "null" description: The city associated with the listing country: type: - string - "null" description: The country associated with the listing custom_data: type: - object - "null" properties: {} description: Custom data deposit_amount_in_cents: type: *a325 description: The deposit amount in cents associated with the listing example: 100000 floor_plan_code: type: - string - "null" description: The external ID of the floor plan associated with the listing floor_plan_name: type: - string - "null" description: The floor plan name associated with the listing floor: type: - string - "null" description: The floor number/name associated with the listing image_urls: type: array items: type: string description: A list of image urls associated with the listing x-propexo: *a362 is_available: type: - boolean - "null" description: Whether the listing is available is_furnished: type: - boolean - "null" description: Whether the listing is furnished is_listed: type: - boolean - "null" description: Whether the listing is listed is_managed_external: type: - boolean - "null" description: Whether the listing is managed externally is_vacant: type: - boolean - "null" description: Whether the listing is vacant lease_term: type: - string - "null" description: The term of the lease listing_title: type: - string - "null" description: The title used for the marketing listing listing_date: type: - string - "null" description: The date the listing was created marketing_name: type: - string - "null" description: The marketing name of the unit being listed notes: type: - string - "null" description: Notes associated with the listing number: type: - string - "null" description: The unit number rent_amount_in_cents: type: *a326 description: The rent amount in cents for the listing example: 100000 specials: type: - string - "null" description: Marketing specials or promotions for the listing square_feet: type: - integer - "null" minimum: 0 description: The square footage of the listing state: type: - string - "null" description: The state associated with the listing street_address_1: type: - string - "null" description: "Deprecated: Use address_1" deprecated: true street_address_2: type: - string - "null" description: "Deprecated: Use address_2" deprecated: true address_1: type: - string - "null" description: The first address line associated with the listing x-propexo: *a327 address_2: type: - string - "null" description: The second address line associated with the listing x-propexo: *a328 property_description: type: - string - "null" description: Description of the property short_description: type: - string - "null" description: A short description of the listing unit_description: type: - string - "null" description: Description of the unit zip: type: - string - "null" description: The zip code associated with the listing make_ready_date: type: - string - "null" description: The make ready date of the listing vacate_date: type: - string - "null" description: The vacate date of the listing video_urls: type: - array - "null" items: type: string description: A list of video urls associated with the listing status_raw: type: - string - "null" description: The raw status associated with the listing property_id: type: string description: The Propexo unique identifier for the property unit_id: type: - string - "null" description: The Propexo unique identifier for the unit floor_plan_id: type: - string - "null" description: The Propexo unique identifier for the floor plan integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. unit_type_id: type: - string - "null" description: The Propexo unique identifier for the unit type deposit_amount_in_cents_int: type: number rent_amount_in_cents_int: type: number title: listings - type: object properties: id: type: string description: The Propexo unique identifier for the listing created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: string description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: type: - string - "null" description: The name of the location friendly_name: type: - string - "null" description: The friendly name of the location is_main: type: - boolean - "null" description: Specifies whether or not the location is the main location is_twa_enabled: type: - boolean - "null" description: Specifies whether or not TWA is enabled is_owa_enabled: type: - boolean - "null" description: Specifies whether or not OWA is enabled is_echeck_enabled: type: - boolean - "null" description: Specifies whether or not echeck is enabled ndt_username: type: - string - "null" description: The NDT username for the location broadcast_username: type: - string - "null" description: The broadcast username for the location property_id: type: string description: The Propexo unique identifier for the property integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record title: locations - type: object properties: id: type: string description: The Propexo unique identifier for the note category created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. is_active: type: - boolean - "null" description: Whether the note category is active name: type: string description: The name associated with the note category integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property title: note-categories - type: object properties: id: type: string description: The Propexo unique identifier for the owner created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. address_1: type: - string - "null" description: The first address line associated with the owner address_2: type: - string - "null" description: The second address line associated with the owner city: type: - string - "null" description: The city associated with the owner country: type: - string - "null" description: The country associated with the owner state: type: - string - "null" description: The state associated with the owner zip: type: - string - "null" description: The zip code associated with the owner first_name: type: - string - "null" description: The first name associated with the owner middle_name: type: - string - "null" description: The middle name associated with the owner last_name: type: - string - "null" description: The last name associated with the owner company_name: type: - string - "null" description: The name of the company associated with the owner notes: type: - string - "null" description: Notes associated with the owner email_1: type: - string - "null" description: The primary email address associated with the owner email_2: type: - string - "null" description: The secondary email address associated with the owner phone_1: type: - string - "null" description: Primary phone number associated with the owner phone_1_type: type: - string - "null" enum: - FAX - HOME - MOBILE - OTHER - WORK description: Type of the primary phone number phone_2: type: - string - "null" description: Secondary phone number associated with the owner phone_2_type: type: - string - "null" enum: - FAX - HOME - MOBILE - OTHER - WORK description: Type of the secondary phone number associated_property_ids: type: array items: type: string x-propexo: *a329 description: The property IDs associated with the owner integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property title: owners - type: object properties: {} title: owners-to-properties - type: object properties: x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_gl_account_id: type: - string - "null" description: The external ID of the financial account from the integration vendor x_cash_financial_account_id: type: - string - "null" description: The external ID of the cash financial account from the integration vendor payable_register_id: type: string description: The Propexo unique identifier for the payable register construction_job_id: type: - string - "null" description: The Propexo unique identifier for the construction job amount_due_in_cents: type: *a330 description: The amount due on the payable register item, in cents example: 100000 notes: type: - string - "null" description: Notes associated with the payable register item total_amount_in_cents: type: *a331 description: The amount of the payable register item, in cents example: 100000 cost_code: type: - string - "null" description: The cost code of the payable register item property_id: type: string description: The Propexo unique identifier for the property financial_account_id: type: - string - "null" description: The Propexo unique identifier for the financial account cash_financial_account_id: type: - string - "null" description: The Propexo unique identifier for the cash financial account amount_due_in_cents_int: type: number total_amount_in_cents_int: type: number title: payable-register-items - type: object properties: id: type: string description: The Propexo unique identifier for the payable register created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_financial_account_id: type: - string - "null" description: The external ID of the financial account from the integration vendor x_cash_financial_account_id: type: - string - "null" description: The external ID of the cash financial account from the integration vendor x_ap_financial_account_id: type: - string - "null" description: The external ID of the AP financial account from the integration vendor x_vendor_id: type: - string - "null" description: The external ID of the vendor from the integration vendor x_batch_id: type: - string - "null" description: The external ID of the associated batch amount_due_in_cents: type: *a332 description: The amount due on the payable register, in cents example: 100000 amount_paid_in_cents: type: *a333 description: The amount paid on the payable register, in cents example: 100000 custom_data: type: - object - "null" properties: {} description: Custom data due_date: type: - string - "null" description: The due date associated with the payable register discount_amount_in_cents: type: *a334 description: The discount, in cents, of the payable register example: 100000 discount_date: type: - string - "null" description: The date a discount was issued on payable register invoice_date: type: - string - "null" description: The date the payable register was issued invoice_number: type: - string - "null" description: The reference number for the payable register notes: type: - string - "null" description: Notes associated with the payable register post_date: type: - string - "null" description: The date the payable register was posted. Some PMS systems only show the month. post_month: type: - string - "null" description: The month the payable register was posted. post_status_raw: type: - string - "null" description: The raw post status associated with the payable register sub_total_amount_in_cents: type: *a335 description: The sub total amount of the payable register example: 100000 total_amount_in_cents: type: *a336 description: The amount of the payable register, in cents example: 100000 status: type: - string - "null" description: The status associated with the payable register is_unpaid: type: - boolean - "null" description: Whether the payable register is unpaid or not is_adjustment: type: - boolean - "null" description: Whether the payable register is an adjustment or not is_credit_memo: type: - boolean - "null" description: Whether the payable register is a credit memo or not is_exempt_from_1099: type: - boolean - "null" description: Whether the payable register is exempt from a 1099 or not display_type: type: - string - "null" description: The display type of the payable register expense_type: type: - string - "null" description: The expense type of the payable register property_id: type: string description: The Propexo unique identifier for the property financial_account_id: type: - string - "null" description: The Propexo unique identifier for the financial account cash_financial_account_id: type: - string - "null" description: The Propexo unique identifier for the cash financial account ap_financial_account_id: type: - string - "null" description: The Propexo unique identifier for the ap financial account integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record payable_register_items: type: array items: type: object properties: x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_gl_account_id: type: - string - "null" description: The external ID of the financial account from the integration vendor x_cash_financial_account_id: type: - string - "null" description: The external ID of the cash financial account from the integration vendor payable_register_id: type: string description: The Propexo unique identifier for the payable register construction_job_id: type: - string - "null" description: The Propexo unique identifier for the construction job amount_due_in_cents: type: *a330 description: The amount due on the payable register item, in cents example: 100000 notes: type: - string - "null" description: Notes associated with the payable register item total_amount_in_cents: type: *a331 description: The amount of the payable register item, in cents example: 100000 cost_code: type: - string - "null" description: The cost code of the payable register item property_id: type: string description: The Propexo unique identifier for the property financial_account_id: type: - string - "null" description: The Propexo unique identifier for the financial account cash_financial_account_id: type: - string - "null" description: The Propexo unique identifier for the cash financial account required: - x_id - x_property_id - x_location_id - x_gl_account_id - x_cash_financial_account_id - payable_register_id - construction_job_id - amount_due_in_cents - notes - total_amount_in_cents - cost_code - property_id - financial_account_id - cash_financial_account_id x-propexo: *a337 description: The payable register list items associated with the payable register amount_due_in_cents_int: type: number amount_paid_in_cents_int: type: number discount_amount_in_cents_int: type: number sub_total_amount_in_cents_int: type: number total_amount_in_cents_int: type: number title: payable-registers - type: object properties: {} title: pet-types - type: object properties: id: type: string description: The Propexo unique identifier for the property property_id: type: string description: The Propexo unique identifier for the property created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_created_at: type: - string - "null" description: The date the record first entered the integration vendor x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_building_id: type: - string - "null" description: The external ID of the building (not necessarily the property) from the integration vendor building_number: type: - string - "null" description: The building number associated with the property city: type: - string - "null" description: The city associated with the property code: type: - string - "null" description: The code associated with the property country: type: - string - "null" description: The country associated with the property county: type: - string - "null" description: The county associated with the property custom_data: type: - object - "null" properties: {} description: Custom data is_active: type: - boolean - "null" description: Whether the property is active. This reflects whether the property is active in the PMS. To see if a property is enabled in Propexo, please use the 'Get all my property configurations' endpoint. manager_email: type: - string - "null" description: The email address of the property manager manager_name: type: - string - "null" description: The name of the property manager manager_phone_1: type: - string - "null" description: The first phone number of the property manager manager_phone_1_type: type: - string - "null" enum: - FAX - HOME - MOBILE - OTHER - WORK description: The type of the first phone number of the property manager manager_phone_2: type: - string - "null" description: The second phone number of the property manager manager_phone_2_type: type: - string - "null" enum: - FAX - HOME - MOBILE - OTHER - WORK description: The type of the second phone number of the property manager name: type: - string - "null" description: The name of the property notes: type: - string - "null" description: Notes associated with the property number_of_units: type: - integer - "null" minimum: 0 description: The number of units in the property square_footage: type: - integer - "null" description: "Deprecated: Use square_feet" deprecated: true square_feet: type: - integer - "null" description: The square footage of the property state: type: - string - "null" description: The state associated with the property street_address_1: type: - string - "null" description: "Deprecated: Use address_1" deprecated: true street_address_2: type: - string - "null" description: "Deprecated: Use address_2" deprecated: true address_1: type: - string - "null" description: The first address line associated with the property x-propexo: *a338 address_2: type: - string - "null" description: The second address line associated with the property x-propexo: *a339 type: type: - string - "null" description: "Deprecated: Use type_raw." deprecated: true type_raw: type: - string - "null" description: The raw PMS type of the property type_normalized: anyOf: - type: string enum: - SINGLE_FAMILY - MULTI_FAMILY - STUDENT_HOUSING - VACATION - COMMERCIAL - OTHER - type: string - type: "null" description: The Propexo normalized property type website: type: - string - "null" description: The website URL associated with the property year_built: type: - integer - "null" minimum: 0 description: The year the property was built zip: type: - string - "null" description: The zip code associated with the property long_description: type: - string - "null" description: A long description of the property short_description: type: - string - "null" description: A short description of the property office_hours: $ref: "#/components/schemas/OfficeHours" pet_types: type: array items: allOf: - $ref: "#/components/schemas/PetTypes" - description: The pet policies for the property associated_owner_ids: type: array items: type: string x-propexo: *a340 description: The property IDs associated with the owner integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record title: properties - type: object properties: id: type: string description: The Propexo unique identifier for the property list created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: type: - string - "null" description: The name associated with the property list associated_property_ids: type: - array - "null" items: type: string description: The property IDs associated with the property list integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property title: property-lists - type: object properties: {} title: property-lists-to-properties - type: object properties: {} title: property-office-hours - type: object properties: id: type: string description: The Propexo unique identifier for the purchase order item created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. description: type: - string - "null" description: Description of the purchase order item stock_code: type: - string - "null" description: The stock code for the purchase order item quantity_ordered: type: - string - "null" description: The quantity ordered for the purchase order item unit_price_in_cents: type: *a341 description: The unit price, in cents, of the purchase order item example: 100000 total_cost_in_cents: type: *a342 description: The total cost, in cents, of the purchase order item example: 100000 cost_code: type: - string - "null" description: The cost code of the purchase order item category_code: type: - string - "null" description: The category code for the purchase order item purchase_order_id: type: string description: The Propexo unique identifier for the purchase order construction_job_id: type: - string - "null" description: The Propexo unique identifier for the construction job financial_account_id: type: - string - "null" description: The Propexo unique identifier for the financial account custom_data: type: - object - "null" properties: {} description: Custom data associated_invoice_ids: type: array items: type: string description: The IDs for invoices that are associated with the purchase order item property_id: type: string description: The Propexo unique identifier for the property integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record unit_price_in_cents_int: type: number total_cost_in_cents_int: type: number title: purchase-order-items - type: object properties: {} title: purchase-order-items-to-invoices - type: object properties: id: type: string description: The Propexo unique identifier for the purchase order created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_invoice_id: type: - string - "null" description: The external ID of the invoice from the integration vendor x_vendor_id: type: - string - "null" description: The external ID of the vendor from the integration vendor x_parent_purchase_order_id: type: - string - "null" description: The external ID of the purchase order from the integration vendor. This field is not null if this is a change order number: type: - string - "null" description: The number of the purchase order is_closed: type: - boolean - "null" description: Whether the purchase order is closed or not description: type: - string - "null" description: Description of the purchase order total_amount_in_cents: type: *a343 description: The amount of the purchase order, in cents example: 100000 order_date: type: - string - "null" description: The order date for the purchase order expense_type: type: - string - "null" description: The expense type of the purchase order display_type: type: - string - "null" description: The display type of the purchase order status_raw: type: - string - "null" description: The raw status associated with the purchase order shipping_address_1: type: - string - "null" description: The first address line associated with the shipping address for the purchase order shipping_address_2: type: - string - "null" description: The second address line associated with the shipping address for the purchase order shipping_city: type: - string - "null" description: The city associated with the shipping address for the purchase order shipping_state: type: - string - "null" description: The state associated with the shipping address for the purchase order shipping_zip: type: - string - "null" description: The zip code associated with the shipping address for the purchase order shipping_country: type: - string - "null" description: The country associated with the shipping address for the purchase order billing_address_1: type: - string - "null" description: The first address line associated with the billing address for the purchase order billing_address_2: type: - string - "null" description: The second address line associated with the billing address for the purchase order billing_city: type: - string - "null" description: The city associated with the billing address for the purchase order billing_state: type: - string - "null" description: The state associated with the billing address for the purchase order billing_zip: type: - string - "null" description: The zip code associated with the billing address for the purchase order billing_country: type: - string - "null" description: The country associated with the billing address for the purchase order custom_data: type: - object - "null" properties: {} description: Custom data associated_invoice_ids: type: array items: type: string description: An array of all other invoices associated with a purchase order. This includes invoices that associated with specific purchase order items. property_id: type: string description: The Propexo unique identifier for the property integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record invoice_id: type: - string - "null" description: The Propexo unique identifier for the invoice vendor_id: type: - string - "null" description: The Propexo unique identifier for the vendor parent_purchase_order_id: type: - string - "null" description: The Propexo unique identifier for the purchase order. This field is not null if this is a change order total_amount_in_cents_int: type: number title: purchase-orders - type: object properties: id: type: string description: The Propexo unique identifier for the recurring resident charge created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_charge_code_id: type: - string - "null" description: The external ID of the charge code from the integration vendor x_financial_account_id: type: - string - "null" description: The external ID of the financial account from the integration vendor x_lease_id: type: - string - "null" description: The external ID of the lease from the integration vendor amount_in_cents: type: *a344 description: The total amount of the recurring resident charge example: 100000 amount_raw: type: - string - "null" description: The raw value for amount from the PMS is_active: type: - boolean - "null" description: Whether the recurring resident charge is active description: type: - string - "null" description: Description of the recurring resident charge reference_number: type: - string - "null" description: The reference number for the recurring resident charge start_date: type: - string - "null" description: The start date associated with the recurring resident charge end_date: type: - string - "null" description: The end date associated with the recurring resident charge frequency_raw: type: - string - "null" description: The raw value of the frequency of the recurring resident charge frequency_normalized: type: - string - "null" enum: - OTHER - WEEKLY - MONTHLY - DAILY description: The frequency of the recurring resident charge charge_due_day: type: - integer - "null" minimum: 0 description: The due date associated with the recurring resident charge custom_data: type: - object - "null" properties: {} description: Custom data financial_account_id: type: - string - "null" description: The Propexo unique identifier for the financial account lease_id: type: - string - "null" description: The Propexo unique identifier for the lease charge_code_id: type: - string - "null" description: The Propexo unique identifier for the charge code integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property amount_in_cents_int: type: number title: recurring-resident-charges - type: object properties: id: type: string description: The Propexo unique identifier for the rentable item created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_applicant_id: type: - string - "null" description: The external ID of the applicant from the integration vendor x_lead_id: type: - string - "null" description: The external ID of the lead from the integration vendor x_resident_id: type: - string - "null" description: The external ID of the resident from the integration vendor x_type_id: type: - string - "null" description: The external ID of the type from the integration vendor x_charge_code_id: type: - string - "null" description: The external ID of the charge code from the integration vendor amount_in_cents: type: *a345 description: The amount of the rentable item, in cents example: 100000 description: type: - string - "null" description: Description of the rentable item name: type: - string - "null" description: The name of the rentable item is_available: type: - boolean - "null" description: Whether the rentable item is available reserved_until_date: type: - string - "null" description: The date the rentable item is reserved until type: type: - string - "null" description: The type associated with the rentable item integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property applicant_id: type: - string - "null" description: "Deprecated: Use the /applicants/:id/rentable-items endpoint instead." deprecated: true lead_id: type: - string - "null" description: "Deprecated: Use the /leads/:id/rentable-items endpoint instead." deprecated: true resident_id: type: - string - "null" description: "Deprecated: Use the /residents/:id/rentable-items endpoint instead." deprecated: true charge_code_id: type: - string - "null" description: The Propexo unique identifier for the charge code amount_in_cents_int: type: number title: rentable-items - type: object properties: id: type: string description: The Propexo unique identifier for the application template created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: type: string description: The name associated with the application template is_active: type: - boolean - "null" description: Whether the application template is active is_default: type: - boolean - "null" description: Whether this record is the default application template integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property title: rentvine-application-templates - type: object properties: {} title: resident-allocations - type: object properties: id: type: string description: The Propexo unique identifier for the resident charge created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_gl_account_id: type: - string - "null" description: The external ID of the general ledger account from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_lease_id: type: - string - "null" description: The external ID of the lease from the integration vendor x_resident_id: type: - string - "null" description: The external ID of the resident from the integration vendor x_unit_id: type: - string - "null" description: The external ID of the unit from the integration vendor x_charge_code_id: type: - string - "null" description: The external ID of the charge code from the integration vendor amount_in_cents: type: *a346 description: The amount of the resident charge, in cents example: 100000 amount_raw: type: - string - "null" description: The raw value for amount from the PMS amount_open_in_cents: type: *a347 description: The amount open on the resident charge, in cents example: 100000 amount_open_raw: type: - string - "null" description: The raw value for open amount from the PMS amount_paid_in_cents: type: *a348 description: The amount paid on the resident charge, in cents example: 100000 amount_paid_raw: type: - string - "null" description: The raw value for amount paid from the PMS due_date: type: - string - "null" description: The due date associated with the resident charge name: type: - string - "null" description: The name associated with the resident charge description: type: - string - "null" description: Description of the resident charge reference_number: type: - string - "null" description: The reference number for the resident charge transaction_date: type: - string - "null" description: The transaction date of the resident charge transaction_source: type: - string - "null" description: The transaction source of the resident charge is_open: type: - boolean - "null" description: Whether the resident charge is open and not yet settled post_month: type: - string - "null" pattern: ^\d{4}-(?:0[1-9]|1[0-2])$ description: The post month for the resident charge custom_data: type: - object - "null" properties: {} description: Custom data integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property resident_id: type: - string - "null" description: The Propexo unique identifier for the resident financial_account_id: type: - string - "null" description: The Propexo unique identifier for the financial account unit_id: type: - string - "null" description: The Propexo unique identifier for the unit lease_id: type: - string - "null" description: The Propexo unique identifier for the lease charge_code_id: type: - string - "null" description: The Propexo unique identifier for the charge code allocations: type: array items: type: object properties: id: type: string description: The Propexo unique identifier for the resident allocation x_id: type: string description: The external ID from the integration vendor x_source_id: type: - string - "null" description: The external ID of the source transaction from the integration vendor x_destination_id: type: - string - "null" description: The external ID of the destination transaction from the integration vendor financial_account_id: type: - string - "null" description: The Propexo unique identifier for the financial account amount_in_cents: type: *a105 description: The amount of the resident allocation, in cents example: 100000 amount_raw: type: - string - "null" description: The raw value for amount from the PMS resident_charge_id: type: - string - "null" description: The Propexo unique identifier for the resident charge resident_payment_id: type: - string - "null" description: The Propexo unique identifier for the resident payment created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS custom_data: type: - object - "null" properties: {} description: Custom data required: - id - x_id - x_source_id - x_destination_id - financial_account_id - amount_in_cents - amount_raw - resident_charge_id - resident_payment_id - created_at - updated_at - last_seen - custom_data description: Array of payment allocations, splits, and related transactions associated with the resident charge x-propexo: *a349 amount_in_cents_int: type: number amount_open_in_cents_int: type: number amount_paid_in_cents_int: type: number title: resident-charges - type: object properties: id: type: string description: The Propexo unique identifier for the resident insurance created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_unit_id: type: - string - "null" description: The external ID of the unit from the integration vendor x_lease_id: type: - string - "null" description: The external ID of the lease from the integration vendor x_resident_id: type: - string - "null" description: The external ID of the resident from the integration vendor provider: type: - string - "null" description: The insurance provider name insurance_type: type: - string - "null" description: The type of insurance policy_number: type: - string - "null" description: The insurance policy number effective_date: type: - string - "null" description: The date the insurance becomes effective expiration_date: type: - string - "null" description: The date the insurance expires cancellation_date: type: - string - "null" description: The date the insurance was cancelled liability_amount_in_cents: type: *a216 description: The liability amount in cents example: 100000 liability_amount_raw: type: - string - "null" description: The raw liability amount string notes: type: - string - "null" description: Additional notes about the insurance integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property unit_id: type: - string - "null" description: The Propexo unique identifier for the unit lease_id: type: - string - "null" description: The Propexo unique identifier for the lease resident_id: type: - string - "null" description: The Propexo unique identifier for the resident liability_amount_in_cents_int: type: number title: resident-insurance - type: object properties: id: type: string description: The Propexo unique identifier for the resident payment created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_gl_account_id: type: - string - "null" description: The external ID of the general ledger account from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_lease_id: type: - string - "null" description: The external ID of the lease from the integration vendor x_resident_id: type: - string - "null" description: The external ID of the resident from the integration vendor x_unit_id: type: - string - "null" description: The external ID of the unit from the integration vendor x_charge_code_id: type: - string - "null" description: The external ID of the charge code from the integration vendor payment_method_normalized: type: - string - "null" description: The normalized method of payment for the resident payment payment_method_raw: type: - string - "null" description: The raw method of payment for the resident payment amount_in_cents: type: *a106 description: The amount of the resident payment, in cents example: 100000 amount_raw: type: - string - "null" description: The raw value for amount from the PMS name: type: - string - "null" description: The name associated with the resident payment description: type: - string - "null" description: Description of the resident payment reference_number: type: - string - "null" description: The reference number for the resident payment transaction_date: type: - string - "null" description: The transaction date of the resident payment is_open: type: - boolean - "null" description: Whether the resident payment is open and not yet settled post_month: type: - string - "null" pattern: ^\d{4}-(?:0[1-9]|1[0-2])$ description: The post month for the resident payment custom_data: type: - object - "null" properties: {} description: Custom data integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property resident_id: type: - string - "null" description: The Propexo unique identifier for the resident financial_account_id: type: - string - "null" description: The Propexo unique identifier for the financial account unit_id: type: - string - "null" description: The Propexo unique identifier for the unit lease_id: type: - string - "null" description: The Propexo unique identifier for the lease charge_code_id: type: - string - "null" description: The Propexo unique identifier for the charge code allocations: type: array items: type: object properties: id: type: string description: The Propexo unique identifier for the resident allocation x_id: type: string description: The external ID from the integration vendor x_source_id: type: - string - "null" description: The external ID of the source transaction from the integration vendor x_destination_id: type: - string - "null" description: The external ID of the destination transaction from the integration vendor financial_account_id: type: - string - "null" description: The Propexo unique identifier for the financial account amount_in_cents: type: *a105 description: The amount of the resident allocation, in cents example: 100000 amount_raw: type: - string - "null" description: The raw value for amount from the PMS resident_charge_id: type: - string - "null" description: The Propexo unique identifier for the resident charge resident_payment_id: type: - string - "null" description: The Propexo unique identifier for the resident payment created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS custom_data: type: - object - "null" properties: {} description: Custom data required: - id - x_id - x_source_id - x_destination_id - financial_account_id - amount_in_cents - amount_raw - resident_charge_id - resident_payment_id - created_at - updated_at - last_seen - custom_data description: Array of payment allocations, splits, and related transactions associated with the resident payment x-propexo: *a349 amount_in_cents_int: type: number title: resident-payments - type: object properties: id: type: string description: The Propexo unique identifier for the resident pet created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor name: type: - string - "null" description: The name associated with the resident pet type: type: - string - "null" description: The type associated with the resident pet breed: type: - string - "null" description: The breed of the resident pet gender_raw: type: - string - "null" description: The raw value for the gender of the resident pet age_in_years: type: - number - "null" description: The age in years of the resident pet weight_in_pounds: type: - number - "null" description: The weight in pounds of the resident pet is_fixed: type: - boolean - "null" description: Whether the resident pet is fixed is_service_animal: type: - boolean - "null" description: Whether the resident pet is a service animal notes: type: - string - "null" description: Notes associated with the resident pet custom_data: type: - object - "null" properties: {} description: Custom data title: resident-pets - type: object properties: id: type: string description: The Propexo unique identifier for the resident vehicle created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor make: type: - string - "null" description: The make of the resident vehicle model: type: - string - "null" description: The Propexo data model (e.g. units, residents, applicants, etc.) associated with the resident vehicle color: type: - string - "null" description: The color of the resident vehicle year: type: - string - "null" description: The year of the resident vehicle license_plate_number: type: - string - "null" description: The license plate number of the resident vehicle license_plate_state: type: - string - "null" description: The license plate state of the resident vehicle notes: type: - string - "null" description: Notes associated with the resident vehicle custom_data: type: - object - "null" properties: {} description: Custom data title: resident-vehicles - type: object properties: id: type: string description: The Propexo unique identifier for the resident created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_lease_id: type: - string - "null" description: Deprecated. Use leases_meta_data instead deprecated: true address_1_alternate: type: - string - "null" description: The first alternate address line associated with the resident address_1: type: - string - "null" description: The first address line associated with the resident address_2_alternate: type: - string - "null" description: The second alternate address line associated with the resident address_2: type: - string - "null" description: The second address line associated with the resident balance_in_cents: type: *a212 description: The rent balance owed example: 100000 city_alternate: type: - string - "null" description: The alternate city associated with the resident city: type: - string - "null" description: The city associated with the resident country_alternate: type: - string - "null" description: The alternate country associated with the resident country: type: - string - "null" description: The country associated with the resident custom_data: type: - object - "null" properties: {} description: Custom data date_of_birth: type: - string - "null" description: The date of birth associated with the resident email_1: type: - string - "null" description: The primary email address associated with the resident email_2: type: - string - "null" description: The secondary email address associated with the resident first_name: type: - string - "null" description: The first name associated with the resident is_employee: type: - boolean - "null" description: Is the resident an employee last_name: type: - string - "null" description: The last name associated with the resident late_balance_in_cents: type: *a213 description: The past due rent balance owed example: 100000 middle_name: type: - string - "null" description: The middle name associated with the resident notes: type: - string - "null" description: Notes associated with the resident phone_1_type: type: - string - "null" enum: - FAX - HOME - MOBILE - OTHER - WORK description: Type of the primary phone number phone_1: type: - string - "null" description: Primary phone number associated with the resident phone_2_type: type: - string - "null" enum: - FAX - HOME - MOBILE - OTHER - WORK description: Type of the secondary phone number phone_2: type: - string - "null" description: Secondary phone number associated with the resident state_alternate: type: - string - "null" description: The alternate state associated with the resident state: type: - string - "null" description: The state associated with the resident zip_alternate: type: - string - "null" description: The alternate zip code associated with the resident zip: type: - string - "null" description: The zip code associated with the resident pets: type: array items: type: object properties: id: type: string description: The Propexo unique identifier for the resident pet created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor name: type: - string - "null" description: The name associated with the resident pet type: type: - string - "null" description: The type associated with the resident pet breed: type: - string - "null" description: The breed of the resident pet gender_raw: type: - string - "null" description: The raw value for the gender of the resident pet age_in_years: type: - number - "null" description: The age in years of the resident pet weight_in_pounds: type: - number - "null" description: The weight in pounds of the resident pet is_fixed: type: - boolean - "null" description: Whether the resident pet is fixed is_service_animal: type: - boolean - "null" description: Whether the resident pet is a service animal notes: type: - string - "null" description: Notes associated with the resident pet custom_data: type: - object - "null" properties: {} description: Custom data required: - id - created_at - updated_at - last_seen - x_id - name - type - breed - gender_raw - age_in_years - weight_in_pounds - is_fixed - is_service_animal - notes - custom_data x-propexo: *a214 vehicles: type: array items: type: object properties: id: type: string description: The Propexo unique identifier for the resident vehicle created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor make: type: - string - "null" description: The make of the resident vehicle model: type: - string - "null" description: The Propexo data model (e.g. units, residents, applicants, etc.) associated with the resident vehicle color: type: - string - "null" description: The color of the resident vehicle year: type: - string - "null" description: The year of the resident vehicle license_plate_number: type: - string - "null" description: The license plate number of the resident vehicle license_plate_state: type: - string - "null" description: The license plate state of the resident vehicle notes: type: - string - "null" description: Notes associated with the resident vehicle custom_data: type: - object - "null" properties: {} description: Custom data required: - id - created_at - updated_at - last_seen - x_id - make - model - color - year - license_plate_number - license_plate_state - notes - custom_data x-propexo: *a215 integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property balance_in_cents_int: type: number late_balance_in_cents_int: type: number title: residents - type: object properties: {} title: residents-to-events - type: object properties: lease_id: type: string description: The Propexo unique identifier for the lease x_resident_type: type: - string - "null" description: The external type of the resident from the integration vendor resident_type_normalized: anyOf: - type: string - type: string enum: - PRIMARY - SECONDARY - GUARANTOR - OTHER - type: "null" description: Resident type from Propexo move_in_date: type: - string - "null" description: The move-in date associated with the resident example: 2024-01-01 move_out_date: type: - string - "null" description: The move-out date associated with the resident notice_date: type: - string - "null" description: The date the resident gave notice custom_data: type: - object - "null" properties: {} description: Custom data last_seen: type: - string - "null" description: The date the record was last seen from the PMS resident_id: type: string description: The Propexo unique identifier for the resident title: residents-to-leases - type: object properties: {} title: residents-to-rentable-items - type: object properties: id: type: string description: The Propexo ID of the screening created_at: type: string description: The date record first entered Propexo last_seen: type: string description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor status_raw: type: - string - "null" description: The status/results of the screening screening_date: type: - string - "null" description: The date the screening took place title: screenings - type: object properties: {} title: service-request-access-contacts - type: object properties: id: type: string description: The Propexo unique identifier for the service request category created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. code: type: - string - "null" description: The code associated with the service request category description: type: - string - "null" description: Description of the service request category is_active: type: - boolean - "null" description: Whether the service request category is active name: type: - string - "null" description: The name associated with the service request category integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property title: service-request-categories - type: object properties: id: type: string description: The Propexo unique identifier for the service request location created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: type: string description: The name of the service request location type: type: - string - "null" description: The type of location integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property title: service-request-locations - type: object properties: id: type: string description: The Propexo unique identifier for the service request history created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_created_at: type: - string - "null" description: The date the record first entered the integration vendor x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. notes: type: - string - "null" description: Notes associated with the service request history status_raw: type: - string - "null" description: The raw status associated with the service request history creator_name: type: - string - "null" description: The name or username of the person who created the service request history record service_request_id: type: string description: The Propexo unique identifier for the service request integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property title: service-request-notes - type: object properties: id: type: string description: The Propexo unique identifier for the service request category created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. code: type: - string - "null" description: The code associated with the service request category description: type: - string - "null" description: Description of the service request category is_active: type: - boolean - "null" description: Whether the service request category is active name: type: - string - "null" description: The name associated with the service request category integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property title: service-request-priorities - type: object properties: id: type: string description: The Propexo unique identifier for the service request location created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: type: string description: The name of the service request problem service_request_category_id: type: - string - "null" description: The Propexo unique identifier for the service request category integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property title: service-request-problems - type: object properties: id: type: string description: The Propexo unique identifier for the service request category created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. code: type: - string - "null" description: The code associated with the service request category description: type: - string - "null" description: Description of the service request category is_active: type: - boolean - "null" description: Whether the service request category is active name: type: - string - "null" description: The name associated with the service request category integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property title: service-request-statuses - type: object properties: {} title: service-request-vendor-categories - type: object properties: {} title: service-request-vendor-contacts - type: object properties: id: type: string description: The Propexo unique identifier for the vendor created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. account_number: type: - string - "null" description: The account number associated with the vendor is_active: type: - boolean - "null" description: Whether the vendor is active name: type: - string - "null" description: The name associated with the vendor notes: type: - string - "null" description: Notes associated with the vendor tax_id: type: - string - "null" description: The tax payer identification number associated with the vendor third_party_id: type: - string - "null" description: A unique value provided to the PMS to uniquely identify the vendor from your system. type: type: - string - "null" description: The type associated with the vendor contacts: type: array items: type: object properties: address_1: type: - string - "null" description: The first address line associated with the vendor address_2: type: - string - "null" description: The second address line associated with the vendor city: type: - string - "null" description: The city associated with the vendor country: type: - string - "null" description: The country associated with the vendor state: type: - string - "null" description: The state associated with the vendor zip: type: - string - "null" description: The zip code associated with the vendor phone: type: - string - "null" description: Primary phone number associated with the vendor phone_type: type: - string - "null" description: Type of the primary phone number email: type: - string - "null" description: The primary email address associated with the vendor is_primary: type: - boolean - "null" description: Whether the vendor is the primary record name: type: - string - "null" description: The name associated with the vendor required: - address_1 - address_2 - city - country - state - zip - phone - phone_type - email - is_primary - name custom_data: type: - object - "null" properties: {} description: Custom data integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property title: service-request-vendors - type: object properties: {} title: service-request-vendors-insurance - type: object properties: {} title: service-request-vendors-to-properties - type: object properties: id: type: string description: The Propexo unique identifier for the service request created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_unit_id: type: - string - "null" description: The external ID of the unit from the integration vendor x_sub_task_id: type: - string - "null" description: The external ID of the sub task from the integration vendor access_is_authorized: type: - boolean - "null" description: Whether or not the tenant has granted permission to enter the unit associated with the service request access_notes: type: - string - "null" description: Notes regarding access to the unit associated with the service request building: type: - string - "null" description: The building name associated with the service request completion_notes: type: - string - "null" description: Closing notes associated with the service request date_completed: type: - string - "null" description: The date the service request was completed date_created: type: - string - "null" description: The date the service request was created date_due: type: - string - "null" description: The due date associated with the service request date_scheduled: type: - string - "null" description: The date the service request is scheduled notes: type: - string - "null" description: "DEPRECATED: Please use 'history' for reading notes regarding the service request" deprecated: true service_category: type: - string - "null" description: The category of service request service_description: type: - string - "null" description: A description of the service request service_details: type: - string - "null" description: Details about the service request service_priority: type: - string - "null" description: The priority level associated with the service request status_raw: type: - string - "null" description: The raw status associated with the service request vendor_notes: type: - string - "null" description: Vendor/technician notes associated with the service request unit_number: type: - string - "null" description: The unit number associated with the service request. This isn't always provided by PMS vendors, but may be the only data provided to identify a unit associated with a service request in some cases. order_number: type: - string - "null" description: The order number of the service request integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property unit_id: type: - string - "null" description: The Propexo unique identifier for the unit employee_id: type: - string - "null" description: The Propexo unique identifier for the employee vendors: type: array items: type: object properties: vendor_id: type: string required: - vendor_id x-propexo: *a350 description: List of vendor IDs associated with the service request employees: type: array items: type: object properties: id: type: string description: The Propexo unique identifier for the employee created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor name: type: - string - "null" description: The name associated with the employee required: - id - created_at - updated_at - last_seen - x_id - name description: An array of all employees assigned to the service request x-propexo: *a351 title: service-requests - type: object properties: {} title: service-requests-to-employees - type: object properties: {} title: service-requests-to-vendors - type: object properties: id: type: string description: The Propexo unique identifier for the timezone created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. is_active: type: - boolean - "null" description: Whether the timezone is active observes_daylight_savings: type: - boolean - "null" description: Whether or not this timezone should be adjusted for daylight savings time offset: type: - string - "null" pattern: ^[-+]\d{2}:\d{2}$ description: The UTC offset numeric value of the timezone. In the event that daylight savings time is observed, the offset will always represent standard time server_time_error_seconds: type: - number - "null" description: The number of seconds the server is off by integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property title: timezones - type: object properties: id: type: string description: The Propexo unique identifier for the transaction created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_gl_account_id: type: - string - "null" description: The external ID of the general ledger account from the integration vendor x_id: type: string description: The external ID from the integration vendor x_lease_id: type: - string - "null" description: The external ID of the lease from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_resident_id: type: - string - "null" description: The external ID of the resident from the integration vendor x_unit_id: type: - string - "null" description: The external ID of the unit from the integration vendor x_vendor_id: type: - string - "null" description: The external ID of the vendor from the integration vendor x_work_order_id: type: - string - "null" description: The external ID of the work order from the integration vendor amount_in_cents: type: *a363 description: The amount of the transaction in cents. example: 100000 approval_status: type: - string - "null" enum: - APPROVAL_REQUIRED - APPROVED - NOT_NEEDED - PENDING - REJECTED description: DEPRECATED. Use approval_status_normalized. deprecated: true approval_status_normalized: type: - string - "null" enum: - APPROVAL_REQUIRED - APPROVED - NOT_NEEDED - PENDING - REJECTED description: The approval status of the transaction approval_status_raw: type: - string - "null" description: The raw approval status of the transaction from the PMS. bill_date: type: - string - "null" description: The bill date of the transaction custom_data: type: - object - "null" properties: {} description: Custom data due_date: type: - string - "null" description: The due date associated with the transaction gl_account_id_1: type: - string - "null" description: The first general ledger account ID associated with the transaction gl_account_id_2: type: - string - "null" description: The second general ledger account ID associated with the transaction notes: type: - string - "null" description: Notes associated with the transaction payee_name: type: - string - "null" description: The payee name associated with the transaction payment_method: type: - string - "null" description: DEPRECATED. Use payment_method_normalized. deprecated: true payment_method_normalized: type: - string - "null" description: The payment method used in the transaction. payment_method_raw: type: - string - "null" description: The raw payment method used in the transaction from the PMS. reference_number: type: - string - "null" description: The reference number associated with the transaction transaction_date: type: - string - "null" description: The date the transaction was received. transaction_type: type: - string - "null" enum: - CHARGE - CREDIT - OTHER - PAYMENT description: DEPRECATED. Use transaction_type_normalized. deprecated: true transaction_type_normalized: type: - string - "null" enum: - CHARGE - CREDIT - OTHER - PAYMENT description: The type of transaction. transaction_type_raw: type: - string - "null" description: The raw type of transaction from the PMS. transaction_source: type: - string - "null" enum: - OTHER - RESIDENT - VENDOR description: The source of the transaction integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property amount_in_cents_int: type: number title: transactions - type: object properties: id: type: string description: The Propexo unique identifier for the unit created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_building_id: type: - string - "null" description: The external ID of the building (not necessarily the property) from the integration vendor x_floor_plan_id: type: - string - "null" description: The external ID of the floor plan from the integration vendor building_number: type: - string - "null" description: The building number associated with the unit make_ready_date: type: - string - "null" description: The make ready date of the unit made_ready_date: type: - string - "null" description: The made ready date of the unit reserved_until_date: type: - string - "null" description: The date the unit is reserved until floor_plan_market_rent_in_cents: type: *a260 description: The market rent cost of the floor plan, in cents example: 100000 unit_market_rent_in_cents: type: *a261 description: The market rent cost of the unit, in cents example: 100000 base_rent_in_cents: type: *a262 description: The base rent cost of the unit, in cents example: 100000 unit_number: type: - string - "null" description: The unit number description: type: - string - "null" description: Description of the unit floor_plan_name: type: - string - "null" description: The floor plan name associated with the unit accessible_hearing: type: - boolean - "null" description: Whether or not the unit is accessible for the hearing impaired accessible_mobility: type: - boolean - "null" description: Whether or not the unit is accessible for the mobility impaired accessible_vision: type: - boolean - "null" description: Whether or not the unit is accessible for the vision impaired is_vacant: type: - boolean - "null" description: Whether the unit is vacant is_available: type: - boolean - "null" description: Whether the unit is available is_reserved: type: - boolean - "null" description: Whether the unit is reserved available_date: type: - string - "null" description: The date that the unit becomes available notes: type: - string - "null" description: Notes associated with the unit gross_square_feet: type: integer minimum: 0 description: The gross square footage of the unit rentable_square_feet: type: integer minimum: 0 description: The rentable square footage of the unit city: type: - string - "null" description: The city associated with the unit country: type: - string - "null" description: The country associated with the unit state: type: - string - "null" description: The state associated with the unit address_1: type: - string - "null" description: The first address line associated with the unit address_2: type: - string - "null" description: The second address line associated with the unit zip: type: - string - "null" description: The zip code associated with the unit maximum_potential_lease_term: type: - string - "null" description: The maximum potential lease term of the unit minimum_potential_lease_term: type: - string - "null" description: The minimum potential lease term of the unit integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property floor_plan_market_rent_in_cents_int: type: number unit_market_rent_in_cents_int: type: number base_rent_in_cents_int: type: number title: unit-details - type: object properties: {} title: unit-pricing - type: object properties: id: type: string description: The Propexo unique identifier for the unit created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_floor_plan_id: type: - string - "null" description: The external ID of the floor plan from the integration vendor x_unit_type_id: type: - string - "null" description: The external ID of the unit type from the integration vendor bathrooms: type: - string - "null" description: The number of bathrooms associated with the unit bathrooms_full: type: *a249 description: The number of full bathrooms associated with the unit bathrooms_half: type: *a250 description: The number of half bathrooms associated with the unit bedrooms: type: - string - "null" description: The number of bedrooms associated with the unit building_name: type: - string - "null" description: The building name associated with the unit building_number: type: - string - "null" description: The building number associated with the unit city: type: - string - "null" description: The city associated with the unit country: type: - string - "null" description: The country associated with the unit custom_data: type: - object - "null" properties: {} description: Custom data floor_plan_code: type: - string - "null" description: The external ID of the floor plan associated with the unit floor_plan_name: type: - string - "null" description: The floor plan name associated with the unit floor: type: - string - "null" description: The floor number/name associated with the unit is_available: type: - boolean - "null" description: Whether the unit is available is_furnished: type: - boolean - "null" description: Whether the unit is furnished is_listed: type: - boolean - "null" description: "DEPRECATED: Use listings endpoints." deprecated: true is_vacant: type: - boolean - "null" description: Whether the unit is vacant number: type: - string - "null" description: The unit number rent_amount_market_in_cents: type: *a251 description: The market rent amount in cents for the unit example: 100000 rent_amount_max_in_cents: type: *a252 description: The maximum rent amount in cents example: 100000 rent_amount_min_in_cents: type: *a253 description: The minimum rent amount in cents example: 100000 square_feet: type: - integer - "null" minimum: 0 description: The square footage of the unit state: type: - string - "null" description: The state associated with the unit street_address_1: type: - string - "null" description: "Deprecated: Use address_1" deprecated: true street_address_2: type: - string - "null" description: "Deprecated: Use address_2" deprecated: true address_1: type: - string - "null" description: The first address line associated with the unit x-propexo: *a254 address_2: type: - string - "null" description: The second address line associated with the unit x-propexo: *a255 zip: type: - string - "null" description: The zip code associated with the unit pets_allowed: type: - boolean - "null" description: Whether or not pets are allowed dogs_allowed: type: - boolean - "null" description: Whether or not dogs are allowed cats_allowed: type: - boolean - "null" description: Whether or not cats are allowed pet_policy: type: - string - "null" description: The pet policy for the unit floor_plan_id: type: - string - "null" description: The Propexo unique identifier for the floor plan integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property unit_type_id: type: - string - "null" description: The Propexo unique identifier for the unit type rent_amount_market_in_cents_int: type: number rent_amount_max_in_cents_int: type: number rent_amount_min_in_cents_int: type: number title: units - type: object properties: {} title: units-to-amenity - type: object properties: {} title: vendor-insurance-coverage-types - type: object properties: {} title: vendor-insurance-policy-types - type: object properties: {} title: vendor-payment-types previous: anyOf: - type: object properties: {} title: accounting-entities - type: object properties: id: type: string description: The Propexo unique identifier for the address type created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: string description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: type: string description: The name associated with the address type description: type: - string - "null" description: Description of the address type integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property title: address-types - type: object properties: id: type: string description: The Propexo unique identifier for the amenity created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_listing_id: type: - string - "null" description: The external ID of the listing from the integration vendor x_parent_amenity_id: type: - string - "null" description: The external ID from the integration vendor of the amenity this unit and/or property amenity is associated with x_property_id: type: string description: The external ID of the property from the integration vendor x_unit_id: type: - string - "null" description: 'DEPRECATED: Please use the "units" field to see the associated units with this amenity' deprecated: true cost_in_cents: type: *a9 description: Cost in cents for the amenity example: 100000 custom_data: type: - object - "null" properties: {} description: Custom data description: type: - string - "null" description: Description of the amenity image_urls: type: array items: type: string example: https://loremflickr.com/640/480/apartment description: A list of image urls associated with the amenity is_unit_amenity: type: - boolean - "null" description: Whether the amenity is a unit amenity meta_data: type: - object - "null" properties: {} description: Meta data for the amenity name_normalized: type: - string - "null" enum: *a10 description: The name associated with the amenity name: type: string description: The name associated with the amenity units: type: array items: type: object properties: amenity_id: type: string description: The Propexo unique identifier for the amenity example: cm2j4ivcv0000eioz6rd365se unit_id: type: string description: The Propexo unique identifier for the unit example: cm2j4jbzf0002eiozdudz9bda cost_in_cents: type: *a11 description: Cost in cents for the amenity on a particular unit example: 100000 required: - amenity_id - unit_id - cost_in_cents x-propexo: *a12 description: List of unit ids associated with the amenity integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property cost_in_cents_int: type: number title: amenities - type: object properties: {} title: ap-codes - type: object properties: {} title: ap-codes-to-construction-job - type: object properties: {} title: applicant-pets - type: object properties: id: type: string description: The Propexo unique identifier for the applicant created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_unit_id: type: - string - "null" description: "DEPRECATED: Use x_unit_id_preferred instead" deprecated: true x_lease_id: type: - string - "null" description: "DEPRECATED: Not in use." deprecated: true x_lead_id: type: - string - "null" description: The external ID of the lead from the integration vendor x_unit_id_preferred: type: array items: type: string description: The external IDs of the units from the integration vendor that the applicant is interested in address_1_alternate: type: - string - "null" description: The first alternate address line associated with the applicant address_1: type: - string - "null" description: The first address line associated with the applicant address_2_alternate: type: - string - "null" description: The second alternate address line associated with the applicant address_2: type: - string - "null" description: The second address line associated with the applicant applications: type: array items: type: object properties: applicant_id: type: string application_id: type: string status: type: - string - "null" description: DEPRECATED. Use status_raw or status_normalized deprecated: true status_raw: type: - string - "null" description: The raw status associated with the applicant status_normalized: anyOf: - type: string enum: - APPROVED - DENIED - CANCELED - OTHER - PENDING - type: string - type: "null" description: The normalized status associated with the applicant. Confirm these derived values before using them in production. custom_data: type: - object - "null" properties: {} description: Custom data required: - applicant_id - application_id x-propexo: *a295 description: Applications that the applicant has submitted city_alternate: type: - string - "null" description: The alternate city associated with the applicant city: type: - string - "null" description: The city associated with the applicant country_alternate: type: - string - "null" description: The alternate country associated with the applicant country: type: - string - "null" description: The country associated with the applicant custom_data: type: - object - "null" properties: {} description: Custom data date_of_birth: type: - string - "null" description: The date of birth associated with the applicant email_1: type: - string - "null" description: The primary email address associated with the applicant email_2: type: - string - "null" description: The secondary email address associated with the applicant first_name: type: - string - "null" description: The first name associated with the applicant self_reported_income: type: array items: $ref: "#/components/schemas/IncomeSource" description: Self reported income sources for the applicant last_name: type: - string - "null" description: The last name associated with the applicant middle_name: type: - string - "null" description: The middle name associated with the applicant notes: type: - string - "null" description: Notes associated with the applicant phone_1_type: type: - string - "null" enum: - FAX - HOME - MOBILE - OTHER - WORK description: Type of the primary phone number phone_1: type: - string - "null" description: Primary phone number associated with the applicant phone_2_type: type: - string - "null" enum: - FAX - HOME - MOBILE - OTHER - WORK description: Type of the secondary phone number phone_2: type: - string - "null" description: Secondary phone number associated with the applicant state_alternate: type: - string - "null" description: The alternate state associated with the applicant state: type: - string - "null" description: The state associated with the applicant type_normalized: type: - string - "null" description: The normalized type associated with the applicant type_raw: type: - string - "null" description: The raw type associated with the applicant zip_alternate: type: - string - "null" description: The alternate zip code associated with the applicant zip: type: - string - "null" description: The zip code associated with the applicant pets: type: array items: type: object properties: id: type: string description: The Propexo unique identifier for the applicant pet created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor age_in_years: type: - number - "null" description: The age in years of the applicant pet breed: type: - string - "null" description: The breed of the applicant pet color: type: - string - "null" description: The color of the applicant pet gender_raw: type: - string - "null" description: The raw value for the gender of the applicant pet is_declawed: type: - boolean - "null" description: Whether the applicant pet is declawed is_fixed: type: - boolean - "null" description: Whether the applicant pet is fixed is_service_animal: type: - boolean - "null" description: Whether the applicant pet is a service animal is_trained: type: - boolean - "null" description: Whether the applicant pet is trained is_vaccinated: type: - boolean - "null" description: Whether the applicant pet is vaccinated name: type: - string - "null" description: The name associated with the applicant pet notes: type: - string - "null" description: Notes associated with the applicant pet type: type: - string - "null" description: The type associated with the applicant pet weight_in_pounds: type: - number - "null" description: The weight in pounds of the applicant pet custom_data: type: - object - "null" properties: {} description: Custom data required: - id - created_at - updated_at - last_seen - x_id - age_in_years - breed - color - gender_raw - is_declawed - is_fixed - is_service_animal - is_trained - is_vaccinated - name - notes - type - weight_in_pounds - custom_data x-propexo: *a296 integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property unit_id_preferred: type: array items: type: string description: The Propexo unique identifiers for the units that the applicant is interested in screenings: type: array items: type: object properties: id: type: string description: The Propexo ID of the screening created_at: type: string description: The date record first entered Propexo last_seen: type: string description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor status_raw: type: - string - "null" description: The status/results of the screening screening_date: type: - string - "null" description: The date the screening took place required: - id - created_at - last_seen - x_id - status_raw - screening_date x-propexo: *a153 title: applicants - type: object properties: applicant_id: type: string application_id: type: string status: type: - string - "null" description: DEPRECATED. Use status_raw or status_normalized deprecated: true status_raw: type: - string - "null" description: The raw status associated with the applicant status_normalized: anyOf: - type: string enum: - APPROVED - DENIED - CANCELED - OTHER - PENDING - type: string - type: "null" description: The normalized status associated with the applicant. Confirm these derived values before using them in production. custom_data: type: - object - "null" properties: {} description: Custom data title: applicants-to-applications - type: object properties: {} title: applicants-to-events - type: object properties: {} title: applicants-to-rentable-items - type: object properties: id: type: string description: The Propexo unique identifier for the application status created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: type: string description: The name associated with the application status property_id: type: string description: The Propexo unique identifier for the property integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record title: application-statuses - type: object properties: id: type: string description: The Propexo unique identifier for the application created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_property_id: type: string description: The external ID of the property from the integration vendor x_unit_id: type: - string - "null" description: The external ID of the unit from the integration vendor status: type: string description: The raw status associated with the application custom_data: type: - object - "null" properties: {} description: Custom data integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property unit_id: type: - string - "null" description: The Propexo unique identifier for the unit title: applications - type: object properties: id: type: string description: The Propexo unique identifier for the call log created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_lead_source_id: type: - string - "null" description: The external ID of the lead source from the integration vendor custom_data: type: - object - "null" properties: {} description: Custom data lead_source: type: - string - "null" description: The name of the source of the lead origin_phone_number: type: - string - "null" description: The phone number that originated the call for the call log integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property lead_source_id: type: - string - "null" description: The Propexo unique identifier for the lead source title: call-logs - type: object properties: {} title: charge-code-types - type: object properties: {} title: charge-code-types-to-charge-timings - type: object properties: id: type: string description: The Propexo unique identifier for the charge code created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. debit_gl_account: type: - string - "null" description: The GL account number for debits credit_gl_account: type: - string - "null" description: The GL account number for credits name: type: - string - "null" description: The name of the charge code description: type: - string - "null" description: A description of this charge code custom_data: type: - object - "null" properties: {} description: Custom data property_id: type: string description: The Propexo unique identifier for the property integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record title: charge-codes - type: object properties: {} title: charge-timings - type: object properties: id: type: string description: The Propexo unique identifier for the concession created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_unit_id: type: - string - "null" description: The external ID of the unit from the integration vendor x_floor_plan_id: type: - string - "null" description: The external ID of the floor plan from the integration vendor total_amount_in_cents: type: - integer - "null" description: The total amount of the concession start_date: type: - string - "null" description: The start date associated with the concession end_date: type: - string - "null" description: The end date associated with the concession is_active: type: - boolean - "null" description: Whether the concession is active description: type: - string - "null" description: Description of the concession is_one_time: type: - boolean - "null" description: Whether or not the concession occurs a single time is_recurring: type: - boolean - "null" description: Whether or not the concession is recurring monthly_fixed_amount_in_cents: type: - integer - "null" description: The monthly fixed amount of the concession in cents monthly_percentage_amount: type: - integer - "null" description: The monthly percentage amount of the concession. This is rounded to the nearest percent monthly_percentage_raw: type: - string - "null" description: The raw monthly percentage amount of the concession as a string, preserving decimal precision one_time_fixed_amount_in_cents: type: - integer - "null" description: The one time fixed amount of the concession in cents one_time_percentage_amount: type: - integer - "null" description: The one time percentage amount of the concession. This is rounded to the nearest percent one_time_percentage_raw: type: - string - "null" description: The raw one time percentage amount of the concession as a string, preserving decimal precision number_of_occurrences: type: - integer - "null" description: The number of occurrences of the concession fixed_amount_in_cents: type: - integer - "null" description: The fixed amount of the concession in cents percentage_amount: type: - integer - "null" description: The percentage amount of the concession. This is rounded to the nearest percent percentage_raw: type: - string - "null" description: The raw percentage amount of the concession as a string, preserving decimal precision lease_term_in_months: type: - integer - "null" description: The amount of months for the lease term lease_term_raw: type: - string - "null" description: The raw value for the lease term concession_formula_raw: type: - string - "null" description: The raw formula name used to calculate the concession (e.g., "Fixed Amount", "Percent of Charge Code Group") integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property unit_id: type: - string - "null" description: The Propexo unique identifier for the unit floor_plan_id: type: - string - "null" description: The Propexo unique identifier for the floor plan title: concessions - type: object properties: id: type: string description: The Propexo unique identifier for the construction job created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. category_description: type: - string - "null" description: The description of the category for the construction job detail cost_code: type: - string - "null" description: The cost code of the construction job detail original_budget_in_cents: type: *a297 description: The original budget of the construction job detail example: 100000 revised_budget_in_cents: type: *a298 description: The revised budget of the construction job detail example: 100000 invoiced_total_in_cents: type: *a299 description: The total amount invoiced, in cents, for the construction job detail example: 100000 custom_data: type: - object - "null" properties: {} description: Custom data property_id: type: string description: The Propexo unique identifier for the property integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record original_budget_in_cents_int: type: number revised_budget_in_cents_int: type: number invoiced_total_in_cents_int: type: number title: construction-job-details - type: object properties: id: type: string description: The Propexo unique identifier for the construction job created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_gl_account_id: type: - string - "null" description: The external ID of the general ledger account from the integration vendor actual_end_date: type: - string - "null" description: The actual date the construction job ended actual_start_date: type: - string - "null" description: The actual date the construction job started name: type: string description: The name associated with the construction job planned_end_date: type: - string - "null" description: The date the construction job was planned to end planned_start_date: type: - string - "null" description: The date the construction job was planned to start status_normalized: type: - string - "null" description: The normalized status for the construction job status_raw: type: - string - "null" description: The raw status associated with the construction job total_budget_in_cents: type: *a300 description: The total budget for the construction job example: 100000 custom_data: type: - object - "null" properties: {} description: Custom data property_id: type: string description: The Propexo unique identifier for the property integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record total_budget_in_cents_int: type: number title: construction-jobs - type: object properties: id: type: string description: The Propexo unique identifier for the contract detail created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_category_id: type: - string - "null" description: The external ID of the category from the integration vendor x_financial_account_id: type: - string - "null" description: The external ID of the financial account from the integration vendor category_description: type: - string - "null" description: The description of the category for the contract detail cost_code: type: - string - "null" description: The cost code of the contract detail custom_data: type: - object - "null" properties: {} description: Custom data invoiced_total_in_cents: type: *a301 description: The total amount invoiced, in cents, for the contract detail example: 100000 notes: type: - string - "null" description: Notes associated with the contract detail retention_percent: type: - string - "null" description: The retention percent of the contract detail total_amount_in_cents: type: *a302 description: The total amount of the contract detail example: 100000 contract_id: type: string description: The Propexo unique identifier for the contract financial_account_id: type: - string - "null" description: The Propexo unique identifier for the financial account property_id: type: string description: The Propexo unique identifier for the property integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record invoiced_total_in_cents_int: type: number total_amount_in_cents_int: type: number title: contract-details - type: object properties: id: type: string description: The Propexo unique identifier for the contract created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_construction_job_id: type: - string - "null" description: The external ID of the construction job from the integration vendor x_vendor_id: type: - string - "null" description: The external ID of the vendor from the integration vendor custom_data: type: - object - "null" properties: {} description: Custom data end_date: type: - string - "null" description: The end date associated with the contract expense_type: type: - string - "null" description: The expense type of the contract invoiced_total_in_cents: type: *a303 description: The total amount invoiced, in cents, for the contract example: 100000 notes: type: - string - "null" description: Notes associated with the contract original_amount_in_cents: type: *a304 description: The original amount of the contract example: 100000 retention_percent: type: - string - "null" description: The retention percent of the contract start_date: type: - string - "null" description: The start date associated with the contract status_normalized: type: - string - "null" description: The normalized status for the contract status_raw: type: - string - "null" description: The raw status associated with the contract total_amount_in_cents: type: *a305 description: The total amount of the contract example: 100000 construction_job_id: type: - string - "null" description: The Propexo unique identifier for the construction job vendor_id: type: - string - "null" description: The Propexo unique identifier for the vendor property_id: type: string description: The Propexo unique identifier for the property integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record invoiced_total_in_cents_int: type: number original_amount_in_cents_int: type: number total_amount_in_cents_int: type: number title: contracts - type: object properties: id: type: string description: The Propexo unique identifier for the agent created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor custom_data: type: - object - "null" properties: {} description: Custom data name: type: - string - "null" description: The name associated with the agent email: type: - string - "null" description: The primary email address associated with the agent phone: type: - string - "null" description: Primary phone number associated with the agent is_active: type: - boolean - "null" description: Whether the agent is active roles: type: - array - "null" items: type: string description: The roles associated with the agent integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record title: crm-agents - type: object properties: {} title: crm-amenities - type: object properties: id: type: string description: The Propexo unique identifier for the attribution created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor custom_data: type: - object - "null" properties: {} description: Custom data name: type: - string - "null" description: The name associated with the attribution email: type: - string - "null" description: The primary email address associated with the attribution url: type: - string - "null" description: The primary url associated with the attribution is_active: type: - boolean - "null" description: Whether the attribution is active integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The CRM system of record title: crm-attributions - type: object properties: id: type: string description: The Propexo unique identifier for the community created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor custom_data: type: - object - "null" properties: {} description: Custom data address_1: type: - string - "null" description: The first address line associated with the community address_2: type: - string - "null" description: The second address line associated with the community city: type: - string - "null" description: The city associated with the community state: type: - string - "null" description: The state associated with the community zip: type: - string - "null" description: The zip code associated with the community url: type: - string - "null" description: The primary url associated with the community email: type: - string - "null" description: The primary email address associated with the community phone: type: - string - "null" description: Primary phone number associated with the community coordinates: type: object properties: lat: type: - string - "null" description: The latitude associated with the community x-propexo: *a353 long: type: - string - "null" description: The longitude associated with the community x-propexo: *a354 required: - lat - long description: The coordinates associated with the community x-propexo: *a355 integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The CRM system of record title: crm-communities - type: object properties: {} title: crm-communities-to-agents - type: object properties: {} title: crm-communities-to-attributions - type: object properties: id: type: string description: The Propexo unique identifier for the event created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_agent_id: type: - string - "null" description: The external ID of the agent from the integration vendor x_community_id: type: string description: The external ID of the community from the integration vendor x_created_at: type: - string - "null" description: The date the record first entered the integration vendor x_id: type: string description: The external ID from the integration vendor x_prospect_id: type: string description: The external ID of the prospect from the integration vendor appointment_datetime: type: - string - "null" description: The date when the appointment will occur appointment_duration_minutes: type: - number - "null" description: The duration of the appointment, in minutes custom_data: type: - object - "null" properties: {} description: Custom data event_datetime: type: - string - "null" description: The date when the event will occur notes: type: - string - "null" description: Notes associated with the event type_raw: type: - string - "null" description: The raw type associated with the event agent_id: type: - string - "null" description: The Propexo unique identifier for the agent community_id: type: string description: The Propexo unique identifier for the community prospect_id: type: string description: The Propexo unique identifier for the prospect integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The CRM system of record title: crm-events - type: object properties: id: type: string description: The Propexo unique identifier for the listing created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_community_id: type: - string - "null" description: The external ID of the community from the integration vendor available_date: type: - string - "null" description: The date that the listing becomes available bathrooms: type: - string - "null" description: The number of bathrooms associated with the listing bathrooms_full: type: - number - "null" description: The number of full bathrooms associated with the listing bathrooms_half: type: - number - "null" description: The number of half bathrooms associated with the listing bedrooms: type: - string - "null" description: The number of bedrooms associated with the listing building_name: type: - string - "null" description: The building name associated with the listing city: type: - string - "null" description: The city associated with the listing custom_data: type: - object - "null" properties: {} description: Custom data floor: type: - string - "null" description: The floor number/name associated with the listing image_urls_array: type: - array - "null" items: type: string description: A list of image urls associated with the listing is_furnished: type: - boolean - "null" description: Whether the listing is furnished is_listed: type: - boolean - "null" description: Whether the listing is listed notes: type: - string - "null" description: Notes associated with the listing number: type: - string - "null" description: The unit number property_description: type: - string - "null" description: Description of the property publish_date: type: - string - "null" description: The date the listing was published rent_amount_in_cents: type: *a356 description: The rent amount in cents for the listing example: 100000 square_feet: type: - number - "null" description: The square footage of the listing state: type: - string - "null" description: The state associated with the listing status_raw: type: - string - "null" description: The raw status associated with the listing street_address_1: type: - string - "null" description: The first address line associated with the listing street_address_2: type: - string - "null" description: The second address line associated with the listing title: type: - string - "null" description: The title associated with the listing url: type: - string - "null" description: The application url associated with the listing video_urls: type: - array - "null" items: type: string description: A list of video urls associated with the listing zip: type: - string - "null" description: The zip code associated with the listing community_id: type: - string - "null" description: The Propexo unique identifier for the community integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The CRM system of record rent_amount_in_cents_int: type: number title: crm-listings - type: object properties: {} title: crm-pet-policies - type: object properties: id: type: string description: The Propexo unique identifier for the prospect created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_community_id: type: - string - "null" description: The external ID of the community from the integration vendor custom_data: type: - object - "null" properties: {} description: Custom data first_name: type: - string - "null" description: The first name associated with the prospect last_name: type: - string - "null" description: The last name associated with the prospect address_raw: type: - string - "null" description: The raw address associated with the prospect address_1: type: - string - "null" description: The first address line associated with the prospect address_2: type: - string - "null" description: The second address line associated with the prospect city: type: - string - "null" description: The city associated with the prospect state: type: - string - "null" description: The state associated with the prospect zip: type: - string - "null" description: The zip code associated with the prospect email: type: - string - "null" description: The primary email address associated with the prospect phone_1: type: - string - "null" description: Primary phone number associated with the prospect phone_2: type: - string - "null" description: Secondary phone number associated with the prospect move_in_date: type: - string - "null" description: The move-in date associated with the prospect minimum_budget_in_cents: type: *a357 description: The minimum budget, in cents, of the prospect example: 100000 maximum_budget_in_cents: type: *a358 description: The maximum budget, in cents, of the prospect example: 100000 community_id: type: - string - "null" description: The Propexo unique identifier for the community integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The CRM system of record minimum_budget_in_cents_int: type: number maximum_budget_in_cents_int: type: number title: crm-prospects - type: object properties: id: type: string description: The Propexo unique identifier for the deposit summary created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_resident_id: type: string description: The external ID of the resident from the integration vendor x_building_id: type: - string - "null" description: The external ID of the building (not necessarily the property) from the integration vendor x_invoice_id: type: - string - "null" description: The external ID of the invoice from the integration vendor x_lease_id: type: - string - "null" description: The external ID of the lease from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_unit_id: type: - string - "null" description: The external ID of the unit from the integration vendor amount_charged_in_cents: type: *a116 description: The amount charged in cents example: 100000 amount_paid_in_cents: type: *a117 description: The amount paid in cents example: 100000 amount_refunded_in_cents: type: *a118 description: The amount refunded in cents example: 100000 notes: type: - string - "null" description: Notes associated with the deposit summary refund_amount_due_in_cents: type: *a119 description: The refund amount due in cents example: 100000 custom_data: type: - object - "null" properties: {} description: Custom data integration_data: type: - object - "null" properties: {} description: Integration-specific data integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record invoice_id: type: - string - "null" description: The Propexo unique identifier for the invoice lease_id: type: - string - "null" description: The Propexo unique identifier for the lease unit_id: type: - string - "null" description: The Propexo unique identifier for the unit resident_id: type: string description: The Propexo unique identifier for the resident property_id: type: string description: The Propexo unique identifier for the property amount_charged_in_cents_int: type: number amount_paid_in_cents_int: type: number amount_refunded_in_cents_int: type: number refund_amount_due_in_cents_int: type: number title: deposit-summaries - type: object properties: id: type: string description: The Propexo unique identifier for the deposit created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_resident_id: type: string description: The external ID of the resident from the integration vendor x_building_id: type: - string - "null" description: The external ID of the building (not necessarily the property) from the integration vendor x_deposit_type: type: - string - "null" description: The external type of the deposit from the integration vendor x_lease_id: type: - string - "null" description: The external ID of the lease from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. amount_charged_in_cents: type: *a122 description: The amount charged in cents example: 100000 amount_paid_in_cents: type: *a123 description: The amount paid in cents example: 100000 amount_refunded_in_cents: type: *a124 description: The amount refunded in cents example: 100000 notes: type: - string - "null" description: Notes associated with the deposit refund_amount_due_in_cents: type: *a125 description: The refund amount due in cents example: 100000 custom_data: type: - object - "null" properties: {} description: Custom data integration_data: type: - object - "null" properties: {} description: Integration-specific data integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record lease_id: type: - string - "null" description: The Propexo unique identifier for the lease resident_id: type: string description: The Propexo unique identifier for the resident property_id: type: string description: The Propexo unique identifier for the property amount_charged_in_cents_int: type: number amount_paid_in_cents_int: type: number amount_refunded_in_cents_int: type: number refund_amount_due_in_cents_int: type: number title: deposits - type: object properties: id: type: string description: The Propexo unique identifier for the employee created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: type: - string - "null" description: The name associated with the employee email: type: - string - "null" description: The primary email address associated with the employee is_active: type: - boolean - "null" description: Whether the employee is active roles: type: array items: type: string description: The roles associated with the employee integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property title: employees - type: object properties: id: type: string description: The Propexo unique identifier for the lease period created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_application_template_id: type: - string - "null" description: The external ID of the application template from the integration vendor name: type: string description: The name associated with the lease period application_template_id: type: - string - "null" description: The Propexo unique identifier for the application template integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property title: entrata-lease-periods - type: object properties: id: type: string description: The Propexo unique identifier for the unit type created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: type: string description: The name associated with the unit type bedrooms: type: - integer - "null" minimum: 0 description: The number of bedrooms associated with the unit type bathrooms: type: - string - "null" description: The number of bathrooms associated with the unit type bathrooms_full: type: - integer - "null" minimum: 0 description: The number of full bathrooms associated with the unit type bathrooms_half: type: - integer - "null" minimum: 0 description: The number of half bathrooms associated with the unit type rentable_square_feet: type: - integer - "null" minimum: 0 description: The rentable square footage of the unit type gross_square_feet: type: - integer - "null" minimum: 0 description: The gross square footage of the unit type rent_minimum_in_cents: type: *a256 description: The minimum rent of the unit type example: 100000 rent_maximum_in_cents: type: *a257 description: The maximum rent of the unit type example: 100000 unit_count: type: - integer - "null" minimum: 0 description: The number of units associated with the unit type deposit_amount_in_cents: type: *a258 description: The deposit amount in cents associated with the unit type example: 100000 deposit_amount_raw: type: - string - "null" description: The raw deposit amount associated with the unit type integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property rent_minimum_in_cents_int: type: number rent_maximum_in_cents_int: type: number deposit_amount_in_cents_int: type: number title: entrata-unit-types - type: object properties: id: type: string description: The Propexo unique identifier for the vendor location created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: type: string description: The name associated with the vendor location integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property title: entrata-vendor-locations - type: object properties: id: type: string description: The Propexo unique identifier for the event type created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: type: string description: The name associated with the event type integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property associated_event_type_ids: type: array items: type: string description: The Propexo unique identifier for the event type x-propexo: *a359 title: event-results - type: object properties: {} title: event-results-to-event-types - type: object properties: id: type: string description: The Propexo unique identifier for the event sub type created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_event_type_id: type: - string - "null" description: The external ID of the event type from the integration vendor name: type: string description: The name associated with the event sub type integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property event_type_id: type: - string - "null" description: The Propexo unique identifier for the event type title: event-sub-types - type: object properties: id: type: string description: The Propexo unique identifier for the event type created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. code: type: - string - "null" description: The code associated with the event type models: type: array items: type: string description: The Propexo data models (e.g. units, residents, applicants, etc.) associated with the event type name: type: string description: The name associated with the event type integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property title: event-types - type: object properties: id: type: string description: The Propexo unique identifier for the event created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_leasing_agent_id: type: - string - "null" description: The external ID of the leasing agent from the integration vendor x_type_id: type: - string - "null" description: The external ID of the type from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. event_name: type: - string - "null" description: The name of the event event_datetime: type: - string - "null" description: The datetime that the event occurred appointment_datetime: type: - string - "null" description: The datetime that the event appointment occurred type_raw: type: - string - "null" description: The type of event notes: type: - string - "null" description: Notes associated with the event agent_name: type: - string - "null" description: The name of the agent associated with the event reasons_for_event: type: - string - "null" description: Reasons that the event occurred associated_lead_ids: type: - array - "null" items: type: string example: cm2jeb8af00042qoza7lcb5cx description: The lead IDs associated with the event associated_applicant_ids: type: - array - "null" items: type: string x-propexo: *a306 description: The applicant IDs associated with the event associated_resident_ids: type: - array - "null" items: type: string example: cm2jebkdu00072qozfa5p9rs7 description: The resident IDs associated with the event integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property title: events - type: object properties: id: type: string description: The Propexo unique identifier for the fee created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_charge_code_id: type: - string - "null" description: The external ID of the charge code from the integration vendor x_floor_plan_id: type: - string - "null" description: The external ID of the floor plan from the integration vendor x_unit_id: type: - string - "null" description: The external ID of the unit from the integration vendor amount_in_cents: type: *a307 description: The amount of the fee, in cents example: 12500 amount_raw: type: - string - "null" description: The raw value for amount from the PMS charge_code_name: type: - string - "null" description: The name of the charge code description: type: - string - "null" description: Description of the fee name: type: - string - "null" description: The name associated with the fee custom_data: type: - object - "null" additionalProperties: {} description: Custom data integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property floor_plan_id: type: - string - "null" description: The Propexo unique identifier for the floor plan unit_id: type: - string - "null" description: The Propexo unique identifier for the unit charge_code_id: type: - string - "null" description: The Propexo unique identifier for the charge code amount_in_cents_int: type: number title: fees - type: object properties: id: type: string description: The Propexo unique identifier for the file type created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. code: type: - string - "null" description: The code associated with the file type models: type: array items: type: string description: The Propexo data models (e.g. units, residents, applicants, etc.) associated with the file type name: type: string description: The name associated with the file type type: type: string description: The type associated with the file type integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property title: file-types - type: object properties: id: type: string description: The Propexo unique identifier for the financial account created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: type: - string - "null" description: The name of the financial account status_raw: type: - string - "null" description: The raw status associated with the financial account account_number: type: - string - "null" description: The account number associated with the financial account custom_data: type: - object - "null" properties: {} description: Custom data property_id: type: string description: The Propexo unique identifier for the property integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record title: financial-accounts - type: object properties: id: type: string description: The Propexo unique identifier for the floor plan created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: type: string description: The name associated with the floor plan marketing_name: type: - string - "null" description: The marketing name of the floor plan code: type: - string - "null" description: The code associated with the floor plan description: type: - string - "null" description: Description of the floor plan bedrooms: type: - integer - "null" minimum: 0 description: The number of bedrooms associated with the floor plan bathrooms: type: - string - "null" description: The number of bathrooms associated with the floor plan bathrooms_full: type: - integer - "null" minimum: 0 description: The number of full bathrooms associated with the floor plan bathrooms_half: type: - integer - "null" minimum: 0 description: The number of half bathrooms associated with the floor plan max_occupants: type: - integer - "null" minimum: 0 description: The maximum number of occupants for the floor plan rentable_square_feet: type: - integer - "null" minimum: 0 description: The rentable square footage of the floor plan gross_square_feet: type: - integer - "null" minimum: 0 description: The gross square footage of the floor plan rent_minimum_in_cents: type: *a308 description: The minimum rent of the floor plan example: 100000 rent_maximum_in_cents: type: *a309 description: The maximum rent of the floor plan example: 100000 image_urls: type: array items: type: string description: A list of image urls associated with the floor plan x-propexo: *a360 unit_count: type: - integer - "null" minimum: 0 description: The number of units associated with the floor plan deposit_amount_in_cents: type: *a310 description: The deposit amount in cents associated with the floor plan example: 100000 deposit_amount_raw: type: - string - "null" description: The raw deposit amount associated with the floor plan deposit_amount_min_in_cents: type: *a311 description: The minimum deposit amount in cents associated with the floor plan example: 100000 deposit_amount_max_in_cents: type: *a312 description: The maximum deposit amount in cents associated with the floor plan example: 100000 deposit_amount_min_raw: type: - string - "null" description: The raw minimum deposit amount associated with the floor plan deposit_amount_max_raw: type: - string - "null" description: The raw maximum deposit amount associated with the floor plan custom_data: type: - object - "null" properties: {} description: Custom data integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property rent_minimum_in_cents_int: type: number rent_maximum_in_cents_int: type: number deposit_amount_in_cents_int: type: number deposit_amount_min_in_cents_int: type: number deposit_amount_max_in_cents_int: type: number title: floor-plans - type: object properties: {} title: integration-configuration-meta-data - type: object properties: x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_gl_account_id: type: - string - "null" description: The external ID of the financial account from the integration vendor x_cash_financial_account_id: type: - string - "null" description: The external ID of the cash financial account from the integration vendor invoice_id: type: string description: The Propexo unique identifier for the invoice construction_job_id: type: - string - "null" description: The Propexo unique identifier for the construction job amount_due_in_cents: type: *a145 description: The amount due on the invoice item, in cents example: 100000 notes: type: - string - "null" description: Notes associated with the invoice item total_amount_in_cents: type: *a146 description: The amount of the invoice item, in cents example: 100000 property_id: type: string description: The Propexo unique identifier for the property financial_account_id: type: - string - "null" description: The Propexo unique identifier for the financial account cash_financial_account_id: type: - string - "null" description: The Propexo unique identifier for the cash financial account amount_due_in_cents_int: type: number total_amount_in_cents_int: type: number title: invoice-items - type: object properties: id: type: string description: The Propexo unique identifier for the invoice created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_vendor_id: type: - string - "null" description: The external ID of the vendor from the integration vendor x_financial_account_id: type: - string - "null" description: The external ID of the financial account from the integration vendor x_cash_financial_account_id: type: - string - "null" description: The external ID of the cash financial account from the integration vendor x_ap_financial_account_id: type: - string - "null" description: The external ID of the AP financial account from the integration vendor amount_due_in_cents: type: *a140 description: The amount due on the invoice, in cents example: 100000 amount_paid_in_cents: type: *a141 description: The amount paid on the invoice, in cents example: 100000 custom_data: type: - object - "null" properties: {} description: Custom data due_date: type: - string - "null" description: The due date associated with the invoice discount_amount_in_cents: type: *a142 description: The deposit amount in cents associated with the invoice example: 100000 discount_date: type: - string - "null" description: The date a discount was issued on invoice invoice_date: type: - string - "null" description: The date the invoice was issued invoice_number: type: - string - "null" description: The reference number for the invoice notes: type: - string - "null" description: Notes associated with the invoice post_date: type: - string - "null" description: The date the invoice was posted. Some PMS systems only show the month. post_month: type: - string - "null" description: The month the invoice was posted. post_status_raw: type: - string - "null" description: The raw post status associated with the invoice sub_total_amount_in_cents: type: *a143 description: The sub total amount of the invoice example: 100000 total_amount_in_cents: type: *a144 description: The amount of the invoice, in cents example: 100000 property_id: type: string description: The Propexo unique identifier for the property financial_account_id: type: - string - "null" description: The Propexo unique identifier for the financial account cash_financial_account_id: type: - string - "null" description: The Propexo unique identifier for the cash financial account ap_financial_account_id: type: - string - "null" description: The Propexo unique identifier for the ap financial account integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record invoice_items: type: array items: type: object properties: x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_gl_account_id: type: - string - "null" description: The external ID of the financial account from the integration vendor x_cash_financial_account_id: type: - string - "null" description: The external ID of the cash financial account from the integration vendor invoice_id: type: string description: The Propexo unique identifier for the invoice construction_job_id: type: - string - "null" description: The Propexo unique identifier for the construction job amount_due_in_cents: type: *a145 description: The amount due on the invoice item, in cents example: 100000 notes: type: - string - "null" description: Notes associated with the invoice item total_amount_in_cents: type: *a146 description: The amount of the invoice item, in cents example: 100000 property_id: type: string description: The Propexo unique identifier for the property financial_account_id: type: - string - "null" description: The Propexo unique identifier for the financial account cash_financial_account_id: type: - string - "null" description: The Propexo unique identifier for the cash financial account required: - x_id - x_property_id - x_location_id - x_gl_account_id - x_cash_financial_account_id - invoice_id - construction_job_id - amount_due_in_cents - notes - total_amount_in_cents - property_id - financial_account_id - cash_financial_account_id x-propexo: *a147 description: The invoice list items associated with the invoice amount_due_in_cents_int: type: number amount_paid_in_cents_int: type: number discount_amount_in_cents_int: type: number sub_total_amount_in_cents_int: type: number total_amount_in_cents_int: type: number title: invoices - type: object properties: id: type: string description: The Propexo unique identifier for the lead pet created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor age_in_years: type: - number - "null" description: The age in years of the lead pet breed: type: - string - "null" description: The breed of the lead pet color: type: - string - "null" description: The color of the lead pet gender_raw: type: - string - "null" description: The raw value for the gender of the lead pet is_fixed: type: - boolean - "null" description: Whether the lead pet is fixed is_service_animal: type: - boolean - "null" description: Whether the lead pet is a service animal name: type: - string - "null" description: The name associated with the lead pet notes: type: - string - "null" description: Notes associated with the lead pet type: type: - string - "null" description: The type associated with the lead pet weight_in_pounds: type: - number - "null" description: The weight in pounds of the lead pet custom_data: type: - object - "null" properties: {} description: Custom data title: lead-pets - type: object properties: id: type: string description: The Propexo unique identifier for the lead relationship created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: type: string description: The name associated with the lead relationship integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property title: lead-relationships - type: object properties: id: type: string description: The Propexo unique identifier for the lead source created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: type: - string - "null" description: The name associated with the lead source integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property title: lead-sources - type: object properties: id: type: string description: The Propexo unique identifier for the lead created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_created_at: type: - string - "null" description: The date the record first entered the integration vendor x_guestcard_id: type: - string - "null" description: The external ID of the guestcard from the integration vendor x_id: type: string description: The external ID from the integration vendor x_leasing_agent_id: type: - string - "null" description: The external ID of the leasing agent from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_unit_id: type: - string - "null" description: "DEPRECATED: Use x_unit_id_preferred instead" deprecated: true x_unit_id_preferred: type: array items: type: string description: The external IDs of the units from the integration vendor that the lead is interested in x_updated_at: type: - string - "null" description: The date the record was last updated in the integration vendor x_lead_source_id: type: - string - "null" description: The external ID of the lead source from the integration vendor address_1: type: - string - "null" description: The first address line associated with the lead address_2: type: - string - "null" description: The second address line associated with the lead city: type: - string - "null" description: The city associated with the lead country: type: - string - "null" description: The country associated with the lead custom_data: type: - object - "null" properties: {} description: Custom data date_of_birth: type: - string - "null" description: The date of birth associated with the lead desired_amenities: type: - string - "null" description: The desired amenities associated with the lead desired_floor_plan_id: type: - string - "null" description: The external ID of desired floor plan associated with the lead desired_floor_plan_name: type: - string - "null" description: The desired floor plan name desired_lease_term_in_months: type: - string - "null" description: The desired lease term desired_max_rent_in_cents: type: *a313 description: The desired maximum rent example: 100000 desired_max_square_ft: type: - number - "null" description: The desired maximum square feet desired_min_rent_in_cents: type: *a314 description: The desired minimum rent example: 100000 desired_min_square_ft: type: - number - "null" description: The desired minimum square feet desired_num_bathrooms: type: - number - "null" description: The desired number of bathrooms desired_num_bedrooms: type: - integer - "null" description: The desired number of bedrooms desired_unit_number: type: - string - "null" description: The desired unit number desired_unit_type: type: - string - "null" description: The desired unit type email_1: type: - string - "null" description: The primary email address associated with the lead email_2: type: - string - "null" description: The secondary email address associated with the lead first_name: type: - string - "null" description: The first name associated with the lead ils: type: - string - "null" description: The name of the Internet listing service last_name: type: - string - "null" description: The last name associated with the lead lead_source: type: - string - "null" description: The lead source leasing_agent: type: - string - "null" description: The name of the leasing agent middle_name: type: - string - "null" description: The middle name associated with the lead notes: type: - string - "null" description: Notes associated with the lead number_of_occupants: type: - integer - "null" description: The number of occupants pet_details: type: - string - "null" description: "DEPRECATED: Use the pets array instead" pets: type: array items: type: object properties: id: type: string description: The Propexo unique identifier for the lead pet created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor age_in_years: type: - number - "null" description: The age in years of the lead pet breed: type: - string - "null" description: The breed of the lead pet color: type: - string - "null" description: The color of the lead pet gender_raw: type: - string - "null" description: The raw value for the gender of the lead pet is_fixed: type: - boolean - "null" description: Whether the lead pet is fixed is_service_animal: type: - boolean - "null" description: Whether the lead pet is a service animal name: type: - string - "null" description: The name associated with the lead pet notes: type: - string - "null" description: Notes associated with the lead pet type: type: - string - "null" description: The type associated with the lead pet weight_in_pounds: type: - number - "null" description: The weight in pounds of the lead pet custom_data: type: - object - "null" properties: {} description: Custom data required: - id - created_at - updated_at - last_seen - x_id - age_in_years - breed - color - gender_raw - is_fixed - is_service_animal - name - notes - type - weight_in_pounds - custom_data x-propexo: *a315 description: The pets associated with the lead phone_1_type: type: - string - "null" description: Type of the primary phone number phone_1: type: - string - "null" description: Primary phone number associated with the lead phone_2_type: type: - string - "null" description: Type of the secondary phone number phone_2: type: - string - "null" description: Secondary phone number associated with the lead state: type: - string - "null" description: The state associated with the lead status: type: - string - "null" description: The raw status associated with the lead target_move_in_date: type: - string - "null" description: The target move in date zip: type: - string - "null" description: The zip code associated with the lead property_id: type: string description: The Propexo unique identifier for the property lead_source_id: type: - string - "null" description: The Propexo unique identifier for the lead source unit_id_preferred: type: array items: type: string description: The Propexo unique identifiers for the units that the lead is interested in integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record screenings: type: array items: type: object properties: id: type: string description: The Propexo ID of the screening created_at: type: string description: The date record first entered Propexo last_seen: type: string description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor status_raw: type: - string - "null" description: The status/results of the screening screening_date: type: - string - "null" description: The date the screening took place required: - id - created_at - last_seen - x_id - status_raw - screening_date x-propexo: *a153 desired_max_rent_in_cents_int: type: number desired_min_rent_in_cents_int: type: number title: leads - type: object properties: {} title: leads-to-events - type: object properties: {} title: leads-to-rentable-items - type: object properties: id: type: string description: The Propexo unique identifier for the lease service created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: string description: The date the record was last seen from the PMS name: type: string description: The name of the lease service lease_id: type: string description: The Propexo unique identifier for the lease title: lease-services - type: object properties: id: type: string description: The Propexo unique identifier for the lease transfer created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_resident_id: type: string description: The external ID of the resident from the integration vendor x_lease_id_next: type: string description: The external ID of the next lease from the integration vendor x_lease_property_id_next: type: - string - "null" description: The external ID of the property associated with the next lease from the integration vendor x_lease_id_previous: type: string description: The external ID of the previous lease from the integration vendor x_lease_property_id_previous: type: - string - "null" description: The external ID of the property associated with the previous lease from the integration vendor x_unit_id_next: type: - string - "null" description: The external ID of the next unit from the integration vendor x_unit_id_previous: type: - string - "null" description: The external ID of the previous unit from the integration vendor resident_type: type: - string - "null" description: The normalized type of the resident resident_type_raw: type: - string - "null" description: The raw type of the resident lease_status_next: type: - string - "null" description: The normalized status of the next lease lease_status_next_raw: type: - string - "null" description: The raw status of the next lease lease_status_previous: type: - string - "null" description: The normalized status of the previous lease lease_status_previous_raw: type: - string - "null" description: The raw status of the previous lease transfer_effective_date: type: - string - "null" description: The effective date of the lease transfer integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property resident_id: type: string description: The Propexo unique identifier for the resident lease_id_next: type: string description: The Propexo unique identifier for the next lease lease_id_previous: type: string description: The Propexo unique identifier for the previous lease unit_id_next: type: - string - "null" description: The Propexo unique identifier for the next unit unit_id_previous: type: - string - "null" description: The Propexo unique identifier for the previous unit title: lease-transfers - type: object properties: id: type: string description: The Propexo unique identifier for the lease created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_resident_id: type: - string - "null" description: Deprecated. Use residents_meta_data instead deprecated: true x_unit_id: type: - string - "null" description: The external ID of the unit from the integration vendor application_date: type: - string - "null" description: The application date associated with the lease custom_data: type: - object - "null" properties: {} description: Custom data deposit_amount: type: - string - "null" description: The deposit amount associated with the lease deposit_amount_in_cents: type: *a316 description: The deposit amount in cents associated with the lease example: 100000 deposit_date: type: - string - "null" description: The deposit date associated with the lease end_date: type: - string - "null" description: The end date associated with the lease realized_move_in_date: type: - string - "null" description: "The realized move-in date associated with the lease. Note: This move in date is at the lease level and could be different per resident. Please use residents_meta_data to view resident move in dates" realized_move_out_date: type: - string - "null" description: "The realized move-out date associated with the lease. Note: This move out date is at the lease level and could be different per resident. Please use residents_meta_data to view resident move out dates" rent_amount_in_cents: type: *a317 description: The rent amount in cents for the lease example: 100000 rent_amount_market_in_cents: type: *a318 description: The market rent amount in cents for the lease example: 100000 rent_due_day: type: - integer - "null" minimum: 0 description: The rent due day associated with the lease rent_due_date: type: - string - "null" description: The rent due date associated with the lease scheduled_move_in_date: type: - string - "null" description: "The scheduled move-in date associated with the lease. Note: This move in date is at the lease level and could be different per resident. Please use residents_meta_data to view resident move in dates" scheduled_move_out_date: type: - string - "null" description: "The scheduled move-out date associated with the lease. Note: This move out date is at the lease level and could be different per resident. Please use residents_meta_data to view resident move out dates" signature_date: type: - string - "null" description: The date the lease was signed start_date: type: - string - "null" description: The start date associated with the lease status: type: - string - "null" description: DEPRECATED. Use status_normalized deprecated: true status_normalized: type: - string - "null" enum: - ACTIVE - INACTIVE - OTHER - PENDING - EVICTED description: The normalized status for the lease. Note that the status may be called "EVICTED" but this can also refer to an active resident undergoing a current eviction. This varies per PMS. status_raw: type: - string - "null" description: The raw status associated with the lease term: type: - string - "null" description: The lease term type: type: - string - "null" description: The type of lease unit_number: type: - string - "null" description: The unit number associated with the lease. This isn't always provided by PMS vendors, but may be the only data provided to identify a unit associated with a service request in some cases. write_off_amount_in_cents: type: *a319 description: The write off amount for the lease, in cents example: 100000 write_off_amount_raw: type: - string - "null" description: The raw write off amount of the lease from the PMS balance_amount_in_cents: type: *a320 description: The balance amount for the lease, in cents example: 100000 balance_amount_raw: type: - string - "null" description: The raw balance amount of the lease from the PMS past_due_balance_in_cents: type: *a321 description: The past due balance for the lease, in cents example: 100000 past_due_balance_raw: type: - string - "null" description: The raw past due balance of the lease from the PMS unit_id: type: - string - "null" description: The Propexo unique identifier for the unit property_id: type: string description: The Propexo unique identifier for the property integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record services: type: array items: type: object properties: id: type: string description: The Propexo unique identifier for the lease service created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: string description: The date the record was last seen from the PMS name: type: string description: The name of the lease service lease_id: type: string description: The Propexo unique identifier for the lease required: - id - created_at - updated_at - last_seen - name - lease_id x-propexo: *a322 description: List of services related to the lease x-propexo: *a361 deposit_amount_in_cents_int: type: number rent_amount_in_cents_int: type: number rent_amount_market_in_cents_int: type: number write_off_amount_in_cents_int: type: number balance_amount_in_cents_int: type: number past_due_balance_in_cents_int: type: number title: leases - type: object properties: id: type: string description: The Propexo unique identifier for the listing created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_unit_id: type: - string - "null" description: The external ID of the unit from the integration vendor x_floor_plan_id: type: - string - "null" description: The external ID of the floor plan from the integration vendor is_unit: type: boolean description: True if the listing is for a unit, false if it is not associated with a specific unit available_date: type: - string - "null" description: The date the listing is available application_url: type: - string - "null" description: The application URL for the listing bathrooms: type: - string - "null" description: The number of bathrooms associated with the listing bathrooms_full: type: *a323 description: The number of full bathrooms associated with the listing bathrooms_half: type: *a324 description: The number of half bathrooms associated with the listing bedrooms: type: - string - "null" description: The number of bedrooms associated with the listing building_name: type: - string - "null" description: The building name associated with the listing building_number: type: - string - "null" description: The building number associated with the listing city: type: - string - "null" description: The city associated with the listing country: type: - string - "null" description: The country associated with the listing custom_data: type: - object - "null" properties: {} description: Custom data deposit_amount_in_cents: type: *a325 description: The deposit amount in cents associated with the listing example: 100000 floor_plan_code: type: - string - "null" description: The external ID of the floor plan associated with the listing floor_plan_name: type: - string - "null" description: The floor plan name associated with the listing floor: type: - string - "null" description: The floor number/name associated with the listing image_urls: type: array items: type: string description: A list of image urls associated with the listing x-propexo: *a362 is_available: type: - boolean - "null" description: Whether the listing is available is_furnished: type: - boolean - "null" description: Whether the listing is furnished is_listed: type: - boolean - "null" description: Whether the listing is listed is_managed_external: type: - boolean - "null" description: Whether the listing is managed externally is_vacant: type: - boolean - "null" description: Whether the listing is vacant lease_term: type: - string - "null" description: The term of the lease listing_title: type: - string - "null" description: The title used for the marketing listing listing_date: type: - string - "null" description: The date the listing was created marketing_name: type: - string - "null" description: The marketing name of the unit being listed notes: type: - string - "null" description: Notes associated with the listing number: type: - string - "null" description: The unit number rent_amount_in_cents: type: *a326 description: The rent amount in cents for the listing example: 100000 specials: type: - string - "null" description: Marketing specials or promotions for the listing square_feet: type: - integer - "null" minimum: 0 description: The square footage of the listing state: type: - string - "null" description: The state associated with the listing street_address_1: type: - string - "null" description: "Deprecated: Use address_1" deprecated: true street_address_2: type: - string - "null" description: "Deprecated: Use address_2" deprecated: true address_1: type: - string - "null" description: The first address line associated with the listing x-propexo: *a327 address_2: type: - string - "null" description: The second address line associated with the listing x-propexo: *a328 property_description: type: - string - "null" description: Description of the property short_description: type: - string - "null" description: A short description of the listing unit_description: type: - string - "null" description: Description of the unit zip: type: - string - "null" description: The zip code associated with the listing make_ready_date: type: - string - "null" description: The make ready date of the listing vacate_date: type: - string - "null" description: The vacate date of the listing video_urls: type: - array - "null" items: type: string description: A list of video urls associated with the listing status_raw: type: - string - "null" description: The raw status associated with the listing property_id: type: string description: The Propexo unique identifier for the property unit_id: type: - string - "null" description: The Propexo unique identifier for the unit floor_plan_id: type: - string - "null" description: The Propexo unique identifier for the floor plan integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. unit_type_id: type: - string - "null" description: The Propexo unique identifier for the unit type deposit_amount_in_cents_int: type: number rent_amount_in_cents_int: type: number title: listings - type: object properties: id: type: string description: The Propexo unique identifier for the listing created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: string description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: type: - string - "null" description: The name of the location friendly_name: type: - string - "null" description: The friendly name of the location is_main: type: - boolean - "null" description: Specifies whether or not the location is the main location is_twa_enabled: type: - boolean - "null" description: Specifies whether or not TWA is enabled is_owa_enabled: type: - boolean - "null" description: Specifies whether or not OWA is enabled is_echeck_enabled: type: - boolean - "null" description: Specifies whether or not echeck is enabled ndt_username: type: - string - "null" description: The NDT username for the location broadcast_username: type: - string - "null" description: The broadcast username for the location property_id: type: string description: The Propexo unique identifier for the property integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record title: locations - type: object properties: id: type: string description: The Propexo unique identifier for the note category created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. is_active: type: - boolean - "null" description: Whether the note category is active name: type: string description: The name associated with the note category integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property title: note-categories - type: object properties: id: type: string description: The Propexo unique identifier for the owner created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. address_1: type: - string - "null" description: The first address line associated with the owner address_2: type: - string - "null" description: The second address line associated with the owner city: type: - string - "null" description: The city associated with the owner country: type: - string - "null" description: The country associated with the owner state: type: - string - "null" description: The state associated with the owner zip: type: - string - "null" description: The zip code associated with the owner first_name: type: - string - "null" description: The first name associated with the owner middle_name: type: - string - "null" description: The middle name associated with the owner last_name: type: - string - "null" description: The last name associated with the owner company_name: type: - string - "null" description: The name of the company associated with the owner notes: type: - string - "null" description: Notes associated with the owner email_1: type: - string - "null" description: The primary email address associated with the owner email_2: type: - string - "null" description: The secondary email address associated with the owner phone_1: type: - string - "null" description: Primary phone number associated with the owner phone_1_type: type: - string - "null" enum: - FAX - HOME - MOBILE - OTHER - WORK description: Type of the primary phone number phone_2: type: - string - "null" description: Secondary phone number associated with the owner phone_2_type: type: - string - "null" enum: - FAX - HOME - MOBILE - OTHER - WORK description: Type of the secondary phone number associated_property_ids: type: array items: type: string x-propexo: *a329 description: The property IDs associated with the owner integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property title: owners - type: object properties: {} title: owners-to-properties - type: object properties: x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_gl_account_id: type: - string - "null" description: The external ID of the financial account from the integration vendor x_cash_financial_account_id: type: - string - "null" description: The external ID of the cash financial account from the integration vendor payable_register_id: type: string description: The Propexo unique identifier for the payable register construction_job_id: type: - string - "null" description: The Propexo unique identifier for the construction job amount_due_in_cents: type: *a330 description: The amount due on the payable register item, in cents example: 100000 notes: type: - string - "null" description: Notes associated with the payable register item total_amount_in_cents: type: *a331 description: The amount of the payable register item, in cents example: 100000 cost_code: type: - string - "null" description: The cost code of the payable register item property_id: type: string description: The Propexo unique identifier for the property financial_account_id: type: - string - "null" description: The Propexo unique identifier for the financial account cash_financial_account_id: type: - string - "null" description: The Propexo unique identifier for the cash financial account amount_due_in_cents_int: type: number total_amount_in_cents_int: type: number title: payable-register-items - type: object properties: id: type: string description: The Propexo unique identifier for the payable register created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_financial_account_id: type: - string - "null" description: The external ID of the financial account from the integration vendor x_cash_financial_account_id: type: - string - "null" description: The external ID of the cash financial account from the integration vendor x_ap_financial_account_id: type: - string - "null" description: The external ID of the AP financial account from the integration vendor x_vendor_id: type: - string - "null" description: The external ID of the vendor from the integration vendor x_batch_id: type: - string - "null" description: The external ID of the associated batch amount_due_in_cents: type: *a332 description: The amount due on the payable register, in cents example: 100000 amount_paid_in_cents: type: *a333 description: The amount paid on the payable register, in cents example: 100000 custom_data: type: - object - "null" properties: {} description: Custom data due_date: type: - string - "null" description: The due date associated with the payable register discount_amount_in_cents: type: *a334 description: The discount, in cents, of the payable register example: 100000 discount_date: type: - string - "null" description: The date a discount was issued on payable register invoice_date: type: - string - "null" description: The date the payable register was issued invoice_number: type: - string - "null" description: The reference number for the payable register notes: type: - string - "null" description: Notes associated with the payable register post_date: type: - string - "null" description: The date the payable register was posted. Some PMS systems only show the month. post_month: type: - string - "null" description: The month the payable register was posted. post_status_raw: type: - string - "null" description: The raw post status associated with the payable register sub_total_amount_in_cents: type: *a335 description: The sub total amount of the payable register example: 100000 total_amount_in_cents: type: *a336 description: The amount of the payable register, in cents example: 100000 status: type: - string - "null" description: The status associated with the payable register is_unpaid: type: - boolean - "null" description: Whether the payable register is unpaid or not is_adjustment: type: - boolean - "null" description: Whether the payable register is an adjustment or not is_credit_memo: type: - boolean - "null" description: Whether the payable register is a credit memo or not is_exempt_from_1099: type: - boolean - "null" description: Whether the payable register is exempt from a 1099 or not display_type: type: - string - "null" description: The display type of the payable register expense_type: type: - string - "null" description: The expense type of the payable register property_id: type: string description: The Propexo unique identifier for the property financial_account_id: type: - string - "null" description: The Propexo unique identifier for the financial account cash_financial_account_id: type: - string - "null" description: The Propexo unique identifier for the cash financial account ap_financial_account_id: type: - string - "null" description: The Propexo unique identifier for the ap financial account integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record payable_register_items: type: array items: type: object properties: x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_gl_account_id: type: - string - "null" description: The external ID of the financial account from the integration vendor x_cash_financial_account_id: type: - string - "null" description: The external ID of the cash financial account from the integration vendor payable_register_id: type: string description: The Propexo unique identifier for the payable register construction_job_id: type: - string - "null" description: The Propexo unique identifier for the construction job amount_due_in_cents: type: *a330 description: The amount due on the payable register item, in cents example: 100000 notes: type: - string - "null" description: Notes associated with the payable register item total_amount_in_cents: type: *a331 description: The amount of the payable register item, in cents example: 100000 cost_code: type: - string - "null" description: The cost code of the payable register item property_id: type: string description: The Propexo unique identifier for the property financial_account_id: type: - string - "null" description: The Propexo unique identifier for the financial account cash_financial_account_id: type: - string - "null" description: The Propexo unique identifier for the cash financial account required: - x_id - x_property_id - x_location_id - x_gl_account_id - x_cash_financial_account_id - payable_register_id - construction_job_id - amount_due_in_cents - notes - total_amount_in_cents - cost_code - property_id - financial_account_id - cash_financial_account_id x-propexo: *a337 description: The payable register list items associated with the payable register amount_due_in_cents_int: type: number amount_paid_in_cents_int: type: number discount_amount_in_cents_int: type: number sub_total_amount_in_cents_int: type: number total_amount_in_cents_int: type: number title: payable-registers - type: object properties: {} title: pet-types - type: object properties: id: type: string description: The Propexo unique identifier for the property property_id: type: string description: The Propexo unique identifier for the property created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_created_at: type: - string - "null" description: The date the record first entered the integration vendor x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_building_id: type: - string - "null" description: The external ID of the building (not necessarily the property) from the integration vendor building_number: type: - string - "null" description: The building number associated with the property city: type: - string - "null" description: The city associated with the property code: type: - string - "null" description: The code associated with the property country: type: - string - "null" description: The country associated with the property county: type: - string - "null" description: The county associated with the property custom_data: type: - object - "null" properties: {} description: Custom data is_active: type: - boolean - "null" description: Whether the property is active. This reflects whether the property is active in the PMS. To see if a property is enabled in Propexo, please use the 'Get all my property configurations' endpoint. manager_email: type: - string - "null" description: The email address of the property manager manager_name: type: - string - "null" description: The name of the property manager manager_phone_1: type: - string - "null" description: The first phone number of the property manager manager_phone_1_type: type: - string - "null" enum: - FAX - HOME - MOBILE - OTHER - WORK description: The type of the first phone number of the property manager manager_phone_2: type: - string - "null" description: The second phone number of the property manager manager_phone_2_type: type: - string - "null" enum: - FAX - HOME - MOBILE - OTHER - WORK description: The type of the second phone number of the property manager name: type: - string - "null" description: The name of the property notes: type: - string - "null" description: Notes associated with the property number_of_units: type: - integer - "null" minimum: 0 description: The number of units in the property square_footage: type: - integer - "null" description: "Deprecated: Use square_feet" deprecated: true square_feet: type: - integer - "null" description: The square footage of the property state: type: - string - "null" description: The state associated with the property street_address_1: type: - string - "null" description: "Deprecated: Use address_1" deprecated: true street_address_2: type: - string - "null" description: "Deprecated: Use address_2" deprecated: true address_1: type: - string - "null" description: The first address line associated with the property x-propexo: *a338 address_2: type: - string - "null" description: The second address line associated with the property x-propexo: *a339 type: type: - string - "null" description: "Deprecated: Use type_raw." deprecated: true type_raw: type: - string - "null" description: The raw PMS type of the property type_normalized: anyOf: - type: string enum: - SINGLE_FAMILY - MULTI_FAMILY - STUDENT_HOUSING - VACATION - COMMERCIAL - OTHER - type: string - type: "null" description: The Propexo normalized property type website: type: - string - "null" description: The website URL associated with the property year_built: type: - integer - "null" minimum: 0 description: The year the property was built zip: type: - string - "null" description: The zip code associated with the property long_description: type: - string - "null" description: A long description of the property short_description: type: - string - "null" description: A short description of the property office_hours: $ref: "#/components/schemas/OfficeHours" pet_types: type: array items: allOf: - $ref: "#/components/schemas/PetTypes" - description: The pet policies for the property associated_owner_ids: type: array items: type: string x-propexo: *a340 description: The property IDs associated with the owner integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record title: properties - type: object properties: id: type: string description: The Propexo unique identifier for the property list created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: type: - string - "null" description: The name associated with the property list associated_property_ids: type: - array - "null" items: type: string description: The property IDs associated with the property list integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property title: property-lists - type: object properties: {} title: property-lists-to-properties - type: object properties: {} title: property-office-hours - type: object properties: id: type: string description: The Propexo unique identifier for the purchase order item created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. description: type: - string - "null" description: Description of the purchase order item stock_code: type: - string - "null" description: The stock code for the purchase order item quantity_ordered: type: - string - "null" description: The quantity ordered for the purchase order item unit_price_in_cents: type: *a341 description: The unit price, in cents, of the purchase order item example: 100000 total_cost_in_cents: type: *a342 description: The total cost, in cents, of the purchase order item example: 100000 cost_code: type: - string - "null" description: The cost code of the purchase order item category_code: type: - string - "null" description: The category code for the purchase order item purchase_order_id: type: string description: The Propexo unique identifier for the purchase order construction_job_id: type: - string - "null" description: The Propexo unique identifier for the construction job financial_account_id: type: - string - "null" description: The Propexo unique identifier for the financial account custom_data: type: - object - "null" properties: {} description: Custom data associated_invoice_ids: type: array items: type: string description: The IDs for invoices that are associated with the purchase order item property_id: type: string description: The Propexo unique identifier for the property integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record unit_price_in_cents_int: type: number total_cost_in_cents_int: type: number title: purchase-order-items - type: object properties: {} title: purchase-order-items-to-invoices - type: object properties: id: type: string description: The Propexo unique identifier for the purchase order created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_invoice_id: type: - string - "null" description: The external ID of the invoice from the integration vendor x_vendor_id: type: - string - "null" description: The external ID of the vendor from the integration vendor x_parent_purchase_order_id: type: - string - "null" description: The external ID of the purchase order from the integration vendor. This field is not null if this is a change order number: type: - string - "null" description: The number of the purchase order is_closed: type: - boolean - "null" description: Whether the purchase order is closed or not description: type: - string - "null" description: Description of the purchase order total_amount_in_cents: type: *a343 description: The amount of the purchase order, in cents example: 100000 order_date: type: - string - "null" description: The order date for the purchase order expense_type: type: - string - "null" description: The expense type of the purchase order display_type: type: - string - "null" description: The display type of the purchase order status_raw: type: - string - "null" description: The raw status associated with the purchase order shipping_address_1: type: - string - "null" description: The first address line associated with the shipping address for the purchase order shipping_address_2: type: - string - "null" description: The second address line associated with the shipping address for the purchase order shipping_city: type: - string - "null" description: The city associated with the shipping address for the purchase order shipping_state: type: - string - "null" description: The state associated with the shipping address for the purchase order shipping_zip: type: - string - "null" description: The zip code associated with the shipping address for the purchase order shipping_country: type: - string - "null" description: The country associated with the shipping address for the purchase order billing_address_1: type: - string - "null" description: The first address line associated with the billing address for the purchase order billing_address_2: type: - string - "null" description: The second address line associated with the billing address for the purchase order billing_city: type: - string - "null" description: The city associated with the billing address for the purchase order billing_state: type: - string - "null" description: The state associated with the billing address for the purchase order billing_zip: type: - string - "null" description: The zip code associated with the billing address for the purchase order billing_country: type: - string - "null" description: The country associated with the billing address for the purchase order custom_data: type: - object - "null" properties: {} description: Custom data associated_invoice_ids: type: array items: type: string description: An array of all other invoices associated with a purchase order. This includes invoices that associated with specific purchase order items. property_id: type: string description: The Propexo unique identifier for the property integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record invoice_id: type: - string - "null" description: The Propexo unique identifier for the invoice vendor_id: type: - string - "null" description: The Propexo unique identifier for the vendor parent_purchase_order_id: type: - string - "null" description: The Propexo unique identifier for the purchase order. This field is not null if this is a change order total_amount_in_cents_int: type: number title: purchase-orders - type: object properties: id: type: string description: The Propexo unique identifier for the recurring resident charge created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_charge_code_id: type: - string - "null" description: The external ID of the charge code from the integration vendor x_financial_account_id: type: - string - "null" description: The external ID of the financial account from the integration vendor x_lease_id: type: - string - "null" description: The external ID of the lease from the integration vendor amount_in_cents: type: *a344 description: The total amount of the recurring resident charge example: 100000 amount_raw: type: - string - "null" description: The raw value for amount from the PMS is_active: type: - boolean - "null" description: Whether the recurring resident charge is active description: type: - string - "null" description: Description of the recurring resident charge reference_number: type: - string - "null" description: The reference number for the recurring resident charge start_date: type: - string - "null" description: The start date associated with the recurring resident charge end_date: type: - string - "null" description: The end date associated with the recurring resident charge frequency_raw: type: - string - "null" description: The raw value of the frequency of the recurring resident charge frequency_normalized: type: - string - "null" enum: - OTHER - WEEKLY - MONTHLY - DAILY description: The frequency of the recurring resident charge charge_due_day: type: - integer - "null" minimum: 0 description: The due date associated with the recurring resident charge custom_data: type: - object - "null" properties: {} description: Custom data financial_account_id: type: - string - "null" description: The Propexo unique identifier for the financial account lease_id: type: - string - "null" description: The Propexo unique identifier for the lease charge_code_id: type: - string - "null" description: The Propexo unique identifier for the charge code integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property amount_in_cents_int: type: number title: recurring-resident-charges - type: object properties: id: type: string description: The Propexo unique identifier for the rentable item created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_applicant_id: type: - string - "null" description: The external ID of the applicant from the integration vendor x_lead_id: type: - string - "null" description: The external ID of the lead from the integration vendor x_resident_id: type: - string - "null" description: The external ID of the resident from the integration vendor x_type_id: type: - string - "null" description: The external ID of the type from the integration vendor x_charge_code_id: type: - string - "null" description: The external ID of the charge code from the integration vendor amount_in_cents: type: *a345 description: The amount of the rentable item, in cents example: 100000 description: type: - string - "null" description: Description of the rentable item name: type: - string - "null" description: The name of the rentable item is_available: type: - boolean - "null" description: Whether the rentable item is available reserved_until_date: type: - string - "null" description: The date the rentable item is reserved until type: type: - string - "null" description: The type associated with the rentable item integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property applicant_id: type: - string - "null" description: "Deprecated: Use the /applicants/:id/rentable-items endpoint instead." deprecated: true lead_id: type: - string - "null" description: "Deprecated: Use the /leads/:id/rentable-items endpoint instead." deprecated: true resident_id: type: - string - "null" description: "Deprecated: Use the /residents/:id/rentable-items endpoint instead." deprecated: true charge_code_id: type: - string - "null" description: The Propexo unique identifier for the charge code amount_in_cents_int: type: number title: rentable-items - type: object properties: id: type: string description: The Propexo unique identifier for the application template created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: type: string description: The name associated with the application template is_active: type: - boolean - "null" description: Whether the application template is active is_default: type: - boolean - "null" description: Whether this record is the default application template integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property title: rentvine-application-templates - type: object properties: {} title: resident-allocations - type: object properties: id: type: string description: The Propexo unique identifier for the resident charge created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_gl_account_id: type: - string - "null" description: The external ID of the general ledger account from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_lease_id: type: - string - "null" description: The external ID of the lease from the integration vendor x_resident_id: type: - string - "null" description: The external ID of the resident from the integration vendor x_unit_id: type: - string - "null" description: The external ID of the unit from the integration vendor x_charge_code_id: type: - string - "null" description: The external ID of the charge code from the integration vendor amount_in_cents: type: *a346 description: The amount of the resident charge, in cents example: 100000 amount_raw: type: - string - "null" description: The raw value for amount from the PMS amount_open_in_cents: type: *a347 description: The amount open on the resident charge, in cents example: 100000 amount_open_raw: type: - string - "null" description: The raw value for open amount from the PMS amount_paid_in_cents: type: *a348 description: The amount paid on the resident charge, in cents example: 100000 amount_paid_raw: type: - string - "null" description: The raw value for amount paid from the PMS due_date: type: - string - "null" description: The due date associated with the resident charge name: type: - string - "null" description: The name associated with the resident charge description: type: - string - "null" description: Description of the resident charge reference_number: type: - string - "null" description: The reference number for the resident charge transaction_date: type: - string - "null" description: The transaction date of the resident charge transaction_source: type: - string - "null" description: The transaction source of the resident charge is_open: type: - boolean - "null" description: Whether the resident charge is open and not yet settled post_month: type: - string - "null" pattern: ^\d{4}-(?:0[1-9]|1[0-2])$ description: The post month for the resident charge custom_data: type: - object - "null" properties: {} description: Custom data integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property resident_id: type: - string - "null" description: The Propexo unique identifier for the resident financial_account_id: type: - string - "null" description: The Propexo unique identifier for the financial account unit_id: type: - string - "null" description: The Propexo unique identifier for the unit lease_id: type: - string - "null" description: The Propexo unique identifier for the lease charge_code_id: type: - string - "null" description: The Propexo unique identifier for the charge code allocations: type: array items: type: object properties: id: type: string description: The Propexo unique identifier for the resident allocation x_id: type: string description: The external ID from the integration vendor x_source_id: type: - string - "null" description: The external ID of the source transaction from the integration vendor x_destination_id: type: - string - "null" description: The external ID of the destination transaction from the integration vendor financial_account_id: type: - string - "null" description: The Propexo unique identifier for the financial account amount_in_cents: type: *a105 description: The amount of the resident allocation, in cents example: 100000 amount_raw: type: - string - "null" description: The raw value for amount from the PMS resident_charge_id: type: - string - "null" description: The Propexo unique identifier for the resident charge resident_payment_id: type: - string - "null" description: The Propexo unique identifier for the resident payment created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS custom_data: type: - object - "null" properties: {} description: Custom data required: - id - x_id - x_source_id - x_destination_id - financial_account_id - amount_in_cents - amount_raw - resident_charge_id - resident_payment_id - created_at - updated_at - last_seen - custom_data description: Array of payment allocations, splits, and related transactions associated with the resident charge x-propexo: *a349 amount_in_cents_int: type: number amount_open_in_cents_int: type: number amount_paid_in_cents_int: type: number title: resident-charges - type: object properties: id: type: string description: The Propexo unique identifier for the resident insurance created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_unit_id: type: - string - "null" description: The external ID of the unit from the integration vendor x_lease_id: type: - string - "null" description: The external ID of the lease from the integration vendor x_resident_id: type: - string - "null" description: The external ID of the resident from the integration vendor provider: type: - string - "null" description: The insurance provider name insurance_type: type: - string - "null" description: The type of insurance policy_number: type: - string - "null" description: The insurance policy number effective_date: type: - string - "null" description: The date the insurance becomes effective expiration_date: type: - string - "null" description: The date the insurance expires cancellation_date: type: - string - "null" description: The date the insurance was cancelled liability_amount_in_cents: type: *a216 description: The liability amount in cents example: 100000 liability_amount_raw: type: - string - "null" description: The raw liability amount string notes: type: - string - "null" description: Additional notes about the insurance integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property unit_id: type: - string - "null" description: The Propexo unique identifier for the unit lease_id: type: - string - "null" description: The Propexo unique identifier for the lease resident_id: type: - string - "null" description: The Propexo unique identifier for the resident liability_amount_in_cents_int: type: number title: resident-insurance - type: object properties: id: type: string description: The Propexo unique identifier for the resident payment created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_gl_account_id: type: - string - "null" description: The external ID of the general ledger account from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_lease_id: type: - string - "null" description: The external ID of the lease from the integration vendor x_resident_id: type: - string - "null" description: The external ID of the resident from the integration vendor x_unit_id: type: - string - "null" description: The external ID of the unit from the integration vendor x_charge_code_id: type: - string - "null" description: The external ID of the charge code from the integration vendor payment_method_normalized: type: - string - "null" description: The normalized method of payment for the resident payment payment_method_raw: type: - string - "null" description: The raw method of payment for the resident payment amount_in_cents: type: *a106 description: The amount of the resident payment, in cents example: 100000 amount_raw: type: - string - "null" description: The raw value for amount from the PMS name: type: - string - "null" description: The name associated with the resident payment description: type: - string - "null" description: Description of the resident payment reference_number: type: - string - "null" description: The reference number for the resident payment transaction_date: type: - string - "null" description: The transaction date of the resident payment is_open: type: - boolean - "null" description: Whether the resident payment is open and not yet settled post_month: type: - string - "null" pattern: ^\d{4}-(?:0[1-9]|1[0-2])$ description: The post month for the resident payment custom_data: type: - object - "null" properties: {} description: Custom data integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property resident_id: type: - string - "null" description: The Propexo unique identifier for the resident financial_account_id: type: - string - "null" description: The Propexo unique identifier for the financial account unit_id: type: - string - "null" description: The Propexo unique identifier for the unit lease_id: type: - string - "null" description: The Propexo unique identifier for the lease charge_code_id: type: - string - "null" description: The Propexo unique identifier for the charge code allocations: type: array items: type: object properties: id: type: string description: The Propexo unique identifier for the resident allocation x_id: type: string description: The external ID from the integration vendor x_source_id: type: - string - "null" description: The external ID of the source transaction from the integration vendor x_destination_id: type: - string - "null" description: The external ID of the destination transaction from the integration vendor financial_account_id: type: - string - "null" description: The Propexo unique identifier for the financial account amount_in_cents: type: *a105 description: The amount of the resident allocation, in cents example: 100000 amount_raw: type: - string - "null" description: The raw value for amount from the PMS resident_charge_id: type: - string - "null" description: The Propexo unique identifier for the resident charge resident_payment_id: type: - string - "null" description: The Propexo unique identifier for the resident payment created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS custom_data: type: - object - "null" properties: {} description: Custom data required: - id - x_id - x_source_id - x_destination_id - financial_account_id - amount_in_cents - amount_raw - resident_charge_id - resident_payment_id - created_at - updated_at - last_seen - custom_data description: Array of payment allocations, splits, and related transactions associated with the resident payment x-propexo: *a349 amount_in_cents_int: type: number title: resident-payments - type: object properties: id: type: string description: The Propexo unique identifier for the resident pet created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor name: type: - string - "null" description: The name associated with the resident pet type: type: - string - "null" description: The type associated with the resident pet breed: type: - string - "null" description: The breed of the resident pet gender_raw: type: - string - "null" description: The raw value for the gender of the resident pet age_in_years: type: - number - "null" description: The age in years of the resident pet weight_in_pounds: type: - number - "null" description: The weight in pounds of the resident pet is_fixed: type: - boolean - "null" description: Whether the resident pet is fixed is_service_animal: type: - boolean - "null" description: Whether the resident pet is a service animal notes: type: - string - "null" description: Notes associated with the resident pet custom_data: type: - object - "null" properties: {} description: Custom data title: resident-pets - type: object properties: id: type: string description: The Propexo unique identifier for the resident vehicle created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor make: type: - string - "null" description: The make of the resident vehicle model: type: - string - "null" description: The Propexo data model (e.g. units, residents, applicants, etc.) associated with the resident vehicle color: type: - string - "null" description: The color of the resident vehicle year: type: - string - "null" description: The year of the resident vehicle license_plate_number: type: - string - "null" description: The license plate number of the resident vehicle license_plate_state: type: - string - "null" description: The license plate state of the resident vehicle notes: type: - string - "null" description: Notes associated with the resident vehicle custom_data: type: - object - "null" properties: {} description: Custom data title: resident-vehicles - type: object properties: id: type: string description: The Propexo unique identifier for the resident created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_lease_id: type: - string - "null" description: Deprecated. Use leases_meta_data instead deprecated: true address_1_alternate: type: - string - "null" description: The first alternate address line associated with the resident address_1: type: - string - "null" description: The first address line associated with the resident address_2_alternate: type: - string - "null" description: The second alternate address line associated with the resident address_2: type: - string - "null" description: The second address line associated with the resident balance_in_cents: type: *a212 description: The rent balance owed example: 100000 city_alternate: type: - string - "null" description: The alternate city associated with the resident city: type: - string - "null" description: The city associated with the resident country_alternate: type: - string - "null" description: The alternate country associated with the resident country: type: - string - "null" description: The country associated with the resident custom_data: type: - object - "null" properties: {} description: Custom data date_of_birth: type: - string - "null" description: The date of birth associated with the resident email_1: type: - string - "null" description: The primary email address associated with the resident email_2: type: - string - "null" description: The secondary email address associated with the resident first_name: type: - string - "null" description: The first name associated with the resident is_employee: type: - boolean - "null" description: Is the resident an employee last_name: type: - string - "null" description: The last name associated with the resident late_balance_in_cents: type: *a213 description: The past due rent balance owed example: 100000 middle_name: type: - string - "null" description: The middle name associated with the resident notes: type: - string - "null" description: Notes associated with the resident phone_1_type: type: - string - "null" enum: - FAX - HOME - MOBILE - OTHER - WORK description: Type of the primary phone number phone_1: type: - string - "null" description: Primary phone number associated with the resident phone_2_type: type: - string - "null" enum: - FAX - HOME - MOBILE - OTHER - WORK description: Type of the secondary phone number phone_2: type: - string - "null" description: Secondary phone number associated with the resident state_alternate: type: - string - "null" description: The alternate state associated with the resident state: type: - string - "null" description: The state associated with the resident zip_alternate: type: - string - "null" description: The alternate zip code associated with the resident zip: type: - string - "null" description: The zip code associated with the resident pets: type: array items: type: object properties: id: type: string description: The Propexo unique identifier for the resident pet created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor name: type: - string - "null" description: The name associated with the resident pet type: type: - string - "null" description: The type associated with the resident pet breed: type: - string - "null" description: The breed of the resident pet gender_raw: type: - string - "null" description: The raw value for the gender of the resident pet age_in_years: type: - number - "null" description: The age in years of the resident pet weight_in_pounds: type: - number - "null" description: The weight in pounds of the resident pet is_fixed: type: - boolean - "null" description: Whether the resident pet is fixed is_service_animal: type: - boolean - "null" description: Whether the resident pet is a service animal notes: type: - string - "null" description: Notes associated with the resident pet custom_data: type: - object - "null" properties: {} description: Custom data required: - id - created_at - updated_at - last_seen - x_id - name - type - breed - gender_raw - age_in_years - weight_in_pounds - is_fixed - is_service_animal - notes - custom_data x-propexo: *a214 vehicles: type: array items: type: object properties: id: type: string description: The Propexo unique identifier for the resident vehicle created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor make: type: - string - "null" description: The make of the resident vehicle model: type: - string - "null" description: The Propexo data model (e.g. units, residents, applicants, etc.) associated with the resident vehicle color: type: - string - "null" description: The color of the resident vehicle year: type: - string - "null" description: The year of the resident vehicle license_plate_number: type: - string - "null" description: The license plate number of the resident vehicle license_plate_state: type: - string - "null" description: The license plate state of the resident vehicle notes: type: - string - "null" description: Notes associated with the resident vehicle custom_data: type: - object - "null" properties: {} description: Custom data required: - id - created_at - updated_at - last_seen - x_id - make - model - color - year - license_plate_number - license_plate_state - notes - custom_data x-propexo: *a215 integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property balance_in_cents_int: type: number late_balance_in_cents_int: type: number title: residents - type: object properties: {} title: residents-to-events - type: object properties: lease_id: type: string description: The Propexo unique identifier for the lease x_resident_type: type: - string - "null" description: The external type of the resident from the integration vendor resident_type_normalized: anyOf: - type: string - type: string enum: - PRIMARY - SECONDARY - GUARANTOR - OTHER - type: "null" description: Resident type from Propexo move_in_date: type: - string - "null" description: The move-in date associated with the resident example: 2024-01-01 move_out_date: type: - string - "null" description: The move-out date associated with the resident notice_date: type: - string - "null" description: The date the resident gave notice custom_data: type: - object - "null" properties: {} description: Custom data last_seen: type: - string - "null" description: The date the record was last seen from the PMS resident_id: type: string description: The Propexo unique identifier for the resident title: residents-to-leases - type: object properties: {} title: residents-to-rentable-items - type: object properties: id: type: string description: The Propexo ID of the screening created_at: type: string description: The date record first entered Propexo last_seen: type: string description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor status_raw: type: - string - "null" description: The status/results of the screening screening_date: type: - string - "null" description: The date the screening took place title: screenings - type: object properties: {} title: service-request-access-contacts - type: object properties: id: type: string description: The Propexo unique identifier for the service request category created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. code: type: - string - "null" description: The code associated with the service request category description: type: - string - "null" description: Description of the service request category is_active: type: - boolean - "null" description: Whether the service request category is active name: type: - string - "null" description: The name associated with the service request category integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property title: service-request-categories - type: object properties: id: type: string description: The Propexo unique identifier for the service request location created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: type: string description: The name of the service request location type: type: - string - "null" description: The type of location integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property title: service-request-locations - type: object properties: id: type: string description: The Propexo unique identifier for the service request history created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_created_at: type: - string - "null" description: The date the record first entered the integration vendor x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. notes: type: - string - "null" description: Notes associated with the service request history status_raw: type: - string - "null" description: The raw status associated with the service request history creator_name: type: - string - "null" description: The name or username of the person who created the service request history record service_request_id: type: string description: The Propexo unique identifier for the service request integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property title: service-request-notes - type: object properties: id: type: string description: The Propexo unique identifier for the service request category created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. code: type: - string - "null" description: The code associated with the service request category description: type: - string - "null" description: Description of the service request category is_active: type: - boolean - "null" description: Whether the service request category is active name: type: - string - "null" description: The name associated with the service request category integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property title: service-request-priorities - type: object properties: id: type: string description: The Propexo unique identifier for the service request location created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. name: type: string description: The name of the service request problem service_request_category_id: type: - string - "null" description: The Propexo unique identifier for the service request category integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property title: service-request-problems - type: object properties: id: type: string description: The Propexo unique identifier for the service request category created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. code: type: - string - "null" description: The code associated with the service request category description: type: - string - "null" description: Description of the service request category is_active: type: - boolean - "null" description: Whether the service request category is active name: type: - string - "null" description: The name associated with the service request category integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property title: service-request-statuses - type: object properties: {} title: service-request-vendor-categories - type: object properties: {} title: service-request-vendor-contacts - type: object properties: id: type: string description: The Propexo unique identifier for the vendor created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. account_number: type: - string - "null" description: The account number associated with the vendor is_active: type: - boolean - "null" description: Whether the vendor is active name: type: - string - "null" description: The name associated with the vendor notes: type: - string - "null" description: Notes associated with the vendor tax_id: type: - string - "null" description: The tax payer identification number associated with the vendor third_party_id: type: - string - "null" description: A unique value provided to the PMS to uniquely identify the vendor from your system. type: type: - string - "null" description: The type associated with the vendor contacts: type: array items: type: object properties: address_1: type: - string - "null" description: The first address line associated with the vendor address_2: type: - string - "null" description: The second address line associated with the vendor city: type: - string - "null" description: The city associated with the vendor country: type: - string - "null" description: The country associated with the vendor state: type: - string - "null" description: The state associated with the vendor zip: type: - string - "null" description: The zip code associated with the vendor phone: type: - string - "null" description: Primary phone number associated with the vendor phone_type: type: - string - "null" description: Type of the primary phone number email: type: - string - "null" description: The primary email address associated with the vendor is_primary: type: - boolean - "null" description: Whether the vendor is the primary record name: type: - string - "null" description: The name associated with the vendor required: - address_1 - address_2 - city - country - state - zip - phone - phone_type - email - is_primary - name custom_data: type: - object - "null" properties: {} description: Custom data integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property title: service-request-vendors - type: object properties: {} title: service-request-vendors-insurance - type: object properties: {} title: service-request-vendors-to-properties - type: object properties: id: type: string description: The Propexo unique identifier for the service request created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_unit_id: type: - string - "null" description: The external ID of the unit from the integration vendor x_sub_task_id: type: - string - "null" description: The external ID of the sub task from the integration vendor access_is_authorized: type: - boolean - "null" description: Whether or not the tenant has granted permission to enter the unit associated with the service request access_notes: type: - string - "null" description: Notes regarding access to the unit associated with the service request building: type: - string - "null" description: The building name associated with the service request completion_notes: type: - string - "null" description: Closing notes associated with the service request date_completed: type: - string - "null" description: The date the service request was completed date_created: type: - string - "null" description: The date the service request was created date_due: type: - string - "null" description: The due date associated with the service request date_scheduled: type: - string - "null" description: The date the service request is scheduled notes: type: - string - "null" description: "DEPRECATED: Please use 'history' for reading notes regarding the service request" deprecated: true service_category: type: - string - "null" description: The category of service request service_description: type: - string - "null" description: A description of the service request service_details: type: - string - "null" description: Details about the service request service_priority: type: - string - "null" description: The priority level associated with the service request status_raw: type: - string - "null" description: The raw status associated with the service request vendor_notes: type: - string - "null" description: Vendor/technician notes associated with the service request unit_number: type: - string - "null" description: The unit number associated with the service request. This isn't always provided by PMS vendors, but may be the only data provided to identify a unit associated with a service request in some cases. order_number: type: - string - "null" description: The order number of the service request integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property unit_id: type: - string - "null" description: The Propexo unique identifier for the unit employee_id: type: - string - "null" description: The Propexo unique identifier for the employee vendors: type: array items: type: object properties: vendor_id: type: string required: - vendor_id x-propexo: *a350 description: List of vendor IDs associated with the service request employees: type: array items: type: object properties: id: type: string description: The Propexo unique identifier for the employee created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor name: type: - string - "null" description: The name associated with the employee required: - id - created_at - updated_at - last_seen - x_id - name description: An array of all employees assigned to the service request x-propexo: *a351 title: service-requests - type: object properties: {} title: service-requests-to-employees - type: object properties: {} title: service-requests-to-vendors - type: object properties: id: type: string description: The Propexo unique identifier for the timezone created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. is_active: type: - boolean - "null" description: Whether the timezone is active observes_daylight_savings: type: - boolean - "null" description: Whether or not this timezone should be adjusted for daylight savings time offset: type: - string - "null" pattern: ^[-+]\d{2}:\d{2}$ description: The UTC offset numeric value of the timezone. In the event that daylight savings time is observed, the offset will always represent standard time server_time_error_seconds: type: - number - "null" description: The number of seconds the server is off by integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property title: timezones - type: object properties: id: type: string description: The Propexo unique identifier for the transaction created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_gl_account_id: type: - string - "null" description: The external ID of the general ledger account from the integration vendor x_id: type: string description: The external ID from the integration vendor x_lease_id: type: - string - "null" description: The external ID of the lease from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_resident_id: type: - string - "null" description: The external ID of the resident from the integration vendor x_unit_id: type: - string - "null" description: The external ID of the unit from the integration vendor x_vendor_id: type: - string - "null" description: The external ID of the vendor from the integration vendor x_work_order_id: type: - string - "null" description: The external ID of the work order from the integration vendor amount_in_cents: type: *a363 description: The amount of the transaction in cents. example: 100000 approval_status: type: - string - "null" enum: - APPROVAL_REQUIRED - APPROVED - NOT_NEEDED - PENDING - REJECTED description: DEPRECATED. Use approval_status_normalized. deprecated: true approval_status_normalized: type: - string - "null" enum: - APPROVAL_REQUIRED - APPROVED - NOT_NEEDED - PENDING - REJECTED description: The approval status of the transaction approval_status_raw: type: - string - "null" description: The raw approval status of the transaction from the PMS. bill_date: type: - string - "null" description: The bill date of the transaction custom_data: type: - object - "null" properties: {} description: Custom data due_date: type: - string - "null" description: The due date associated with the transaction gl_account_id_1: type: - string - "null" description: The first general ledger account ID associated with the transaction gl_account_id_2: type: - string - "null" description: The second general ledger account ID associated with the transaction notes: type: - string - "null" description: Notes associated with the transaction payee_name: type: - string - "null" description: The payee name associated with the transaction payment_method: type: - string - "null" description: DEPRECATED. Use payment_method_normalized. deprecated: true payment_method_normalized: type: - string - "null" description: The payment method used in the transaction. payment_method_raw: type: - string - "null" description: The raw payment method used in the transaction from the PMS. reference_number: type: - string - "null" description: The reference number associated with the transaction transaction_date: type: - string - "null" description: The date the transaction was received. transaction_type: type: - string - "null" enum: - CHARGE - CREDIT - OTHER - PAYMENT description: DEPRECATED. Use transaction_type_normalized. deprecated: true transaction_type_normalized: type: - string - "null" enum: - CHARGE - CREDIT - OTHER - PAYMENT description: The type of transaction. transaction_type_raw: type: - string - "null" description: The raw type of transaction from the PMS. transaction_source: type: - string - "null" enum: - OTHER - RESIDENT - VENDOR description: The source of the transaction integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property amount_in_cents_int: type: number title: transactions - type: object properties: id: type: string description: The Propexo unique identifier for the unit created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_location_id: type: - string - "null" description: The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations. x_building_id: type: - string - "null" description: The external ID of the building (not necessarily the property) from the integration vendor x_floor_plan_id: type: - string - "null" description: The external ID of the floor plan from the integration vendor building_number: type: - string - "null" description: The building number associated with the unit make_ready_date: type: - string - "null" description: The make ready date of the unit made_ready_date: type: - string - "null" description: The made ready date of the unit reserved_until_date: type: - string - "null" description: The date the unit is reserved until floor_plan_market_rent_in_cents: type: *a260 description: The market rent cost of the floor plan, in cents example: 100000 unit_market_rent_in_cents: type: *a261 description: The market rent cost of the unit, in cents example: 100000 base_rent_in_cents: type: *a262 description: The base rent cost of the unit, in cents example: 100000 unit_number: type: - string - "null" description: The unit number description: type: - string - "null" description: Description of the unit floor_plan_name: type: - string - "null" description: The floor plan name associated with the unit accessible_hearing: type: - boolean - "null" description: Whether or not the unit is accessible for the hearing impaired accessible_mobility: type: - boolean - "null" description: Whether or not the unit is accessible for the mobility impaired accessible_vision: type: - boolean - "null" description: Whether or not the unit is accessible for the vision impaired is_vacant: type: - boolean - "null" description: Whether the unit is vacant is_available: type: - boolean - "null" description: Whether the unit is available is_reserved: type: - boolean - "null" description: Whether the unit is reserved available_date: type: - string - "null" description: The date that the unit becomes available notes: type: - string - "null" description: Notes associated with the unit gross_square_feet: type: integer minimum: 0 description: The gross square footage of the unit rentable_square_feet: type: integer minimum: 0 description: The rentable square footage of the unit city: type: - string - "null" description: The city associated with the unit country: type: - string - "null" description: The country associated with the unit state: type: - string - "null" description: The state associated with the unit address_1: type: - string - "null" description: The first address line associated with the unit address_2: type: - string - "null" description: The second address line associated with the unit zip: type: - string - "null" description: The zip code associated with the unit maximum_potential_lease_term: type: - string - "null" description: The maximum potential lease term of the unit minimum_potential_lease_term: type: - string - "null" description: The minimum potential lease term of the unit integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property floor_plan_market_rent_in_cents_int: type: number unit_market_rent_in_cents_int: type: number base_rent_in_cents_int: type: number title: unit-details - type: object properties: {} title: unit-pricing - type: object properties: id: type: string description: The Propexo unique identifier for the unit created_at: type: string description: The date record first entered Propexo updated_at: type: string description: The date record was last updated in Propexo last_seen: type: - string - "null" description: The date the record was last seen from the PMS x_id: type: string description: The external ID from the integration vendor x_property_id: type: string description: The external ID of the property from the integration vendor x_floor_plan_id: type: - string - "null" description: The external ID of the floor plan from the integration vendor x_unit_type_id: type: - string - "null" description: The external ID of the unit type from the integration vendor bathrooms: type: - string - "null" description: The number of bathrooms associated with the unit bathrooms_full: type: *a249 description: The number of full bathrooms associated with the unit bathrooms_half: type: *a250 description: The number of half bathrooms associated with the unit bedrooms: type: - string - "null" description: The number of bedrooms associated with the unit building_name: type: - string - "null" description: The building name associated with the unit building_number: type: - string - "null" description: The building number associated with the unit city: type: - string - "null" description: The city associated with the unit country: type: - string - "null" description: The country associated with the unit custom_data: type: - object - "null" properties: {} description: Custom data floor_plan_code: type: - string - "null" description: The external ID of the floor plan associated with the unit floor_plan_name: type: - string - "null" description: The floor plan name associated with the unit floor: type: - string - "null" description: The floor number/name associated with the unit is_available: type: - boolean - "null" description: Whether the unit is available is_furnished: type: - boolean - "null" description: Whether the unit is furnished is_listed: type: - boolean - "null" description: "DEPRECATED: Use listings endpoints." deprecated: true is_vacant: type: - boolean - "null" description: Whether the unit is vacant number: type: - string - "null" description: The unit number rent_amount_market_in_cents: type: *a251 description: The market rent amount in cents for the unit example: 100000 rent_amount_max_in_cents: type: *a252 description: The maximum rent amount in cents example: 100000 rent_amount_min_in_cents: type: *a253 description: The minimum rent amount in cents example: 100000 square_feet: type: - integer - "null" minimum: 0 description: The square footage of the unit state: type: - string - "null" description: The state associated with the unit street_address_1: type: - string - "null" description: "Deprecated: Use address_1" deprecated: true street_address_2: type: - string - "null" description: "Deprecated: Use address_2" deprecated: true address_1: type: - string - "null" description: The first address line associated with the unit x-propexo: *a254 address_2: type: - string - "null" description: The second address line associated with the unit x-propexo: *a255 zip: type: - string - "null" description: The zip code associated with the unit pets_allowed: type: - boolean - "null" description: Whether or not pets are allowed dogs_allowed: type: - boolean - "null" description: Whether or not dogs are allowed cats_allowed: type: - boolean - "null" description: Whether or not cats are allowed pet_policy: type: - string - "null" description: The pet policy for the unit floor_plan_id: type: - string - "null" description: The Propexo unique identifier for the floor plan integration_id: type: string description: The Propexo unique identifier for the integration integration_vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST description: The property management system of record property_id: type: string description: The Propexo unique identifier for the property unit_type_id: type: - string - "null" description: The Propexo unique identifier for the unit type rent_amount_market_in_cents_int: type: number rent_amount_max_in_cents_int: type: number rent_amount_min_in_cents_int: type: number title: units - type: object properties: {} title: units-to-amenity - type: object properties: {} title: vendor-insurance-coverage-types - type: object properties: {} title: vendor-insurance-policy-types - type: object properties: {} title: vendor-payment-types required: - new - previous description: Payloads for the DATA_UPDATE event only include data that has changed. For unchanged data, the keys will be absent from the payload. This means that the payload shape could change for the same model between events. context: type: object additionalProperties: {} required: - job_id - root_job_id - integration_id - job_type - vendor - event - record_id - object - diff - context meta: type: object properties: object: type: string enum: *a352 integration_id: type: string required: - object - integration_id required: - trigger - data - meta description: Payload of the webhook that fires for the DATA_UPDATE event. title: DATA_UPDATE responses: "200": description: Return a 200 status to indicate that the webhook was received successfully /first_sync_complete: post: operationId: _v1_webhooks_first_sync_complete tags: - webhooks x-fern-webhook: true requestBody: content: application/json: schema: type: object properties: trigger: type: string enum: - FIRST_SYNC_COMPLETE data: type: object properties: event: type: string enum: - FIRST_SYNC_COMPLETE integration_id: type: string vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST is_backsync: type: boolean successful_job_count: type: number failed_job_count: type: number is_sync_finished: type: boolean job_schedule_id: type: - string - "null" description: The ID of the job schedule associated with the sync. This is null for manual syncs. models_synced: type: array items: type: string description: Array of model names that were enabled for this sync required: - event - integration_id - vendor - is_backsync - successful_job_count - failed_job_count - is_sync_finished - job_schedule_id - models_synced required: - trigger - data description: Payload of the webhook that fires for the FIRST_SYNC_COMPLETE event. title: FIRST_SYNC_COMPLETE responses: "200": description: Return a 200 status to indicate that the webhook was received successfully /sync_complete: post: operationId: _v1_webhooks_sync_complete tags: - webhooks x-fern-webhook: true requestBody: content: application/json: schema: type: object properties: trigger: type: string enum: - SYNC_COMPLETE data: type: object properties: event: type: string enum: - SYNC_COMPLETE integration_id: type: string vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST is_backsync: type: boolean successful_job_count: type: number failed_job_count: type: number is_sync_finished: type: boolean job_schedule_id: type: - string - "null" description: The ID of the job schedule associated with the sync. This is null for manual syncs. models_synced: type: array items: type: string description: Array of model names that were enabled for this sync. required: - event - integration_id - vendor - is_backsync - successful_job_count - failed_job_count - is_sync_finished - job_schedule_id - models_synced required: - trigger - data description: Payload of the webhook that fires for the SYNC_COMPLETE event. title: SYNC_COMPLETE responses: "200": description: Return a 200 status to indicate that the webhook was received successfully /job_failure: post: operationId: _v1_webhooks_job_failure tags: - webhooks x-fern-webhook: true requestBody: content: application/json: schema: type: object properties: trigger: type: string enum: - JOB_FAILURE data: type: object properties: job_id: type: string root_job_id: type: string integration_id: type: string job_type: type: string vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST event: type: string enum: - JOB_FAILURE required: - job_id - root_job_id - integration_id - job_type - vendor - event required: - trigger - data description: Payload of the webhook that fires for the JOB_FAILURE event. title: JOB_FAILURE responses: "200": description: Return a 200 status to indicate that the webhook was received successfully /write_operation_failure: post: operationId: _v1_webhooks_write_operation_failure tags: - webhooks x-fern-webhook: true requestBody: content: application/json: schema: type: object properties: trigger: type: string enum: - WRITE_OPERATION_FAILURE data: type: object properties: event: type: string enum: - WRITE_OPERATION_FAILURE integration_id: type: string vendor: type: string enum: - APPFOLIO - BUILDIUM - ENTRATA - FUNNEL - KNOCK - MRI - PROPERTYWARE - PROPERTYWARE_REST - REALPAGE - REALPAGE_RPX - RENTCAFE - RENTMANAGER - RENTVINE - RESMAN - YARDI - YARDI_REST root_job_id: type: string write_status: type: string enum: - PARTIAL_SUCCESS - FAILURE errors: type: array items: type: string required: - event - integration_id - vendor - root_job_id - write_status - errors required: - trigger - data description: Payload of the webhook that fires for the WRITE_OPERATION_FAILURE event. title: WRITE_OPERATION_FAILURE responses: "200": description: Return a 200 status to indicate that the webhook was received successfully webhooks: {}