openapi: 3.0.0
info:
  description: "\uFEFF\r\n\r\n# Introduction\r\n\r\nWelcome to Propertyware’s API—a powerful, RESTful programming interface that lets you leverage valuable Propertyware data.\r\n\r\n## Account Configuration\r\nBefore you can use Propertyware’s API, you’ll need to make some tweaks to your account settings. \r\n\r\n<br />\r\n\r\n### Enabling the API \r\nIn order to start creating your keys and making requests, you’ll need to enable the API.\r\n\r\n>  **Tip:** You’ll need an administrator user role with access to ***Administration Setup > API Keys*** to set things up properly. \r\n\r\n**Let's Begin!** \r\n\r\n1. Sign in to your [Propertyware](https://app.propertyware.com/pw/login.jsp) account from your browser. \r\n\r\n2. Open the ***Setup*** page\r\n\r\n3. On the left navigation bar, expand ***Administration Setup*** and then click ***API Keys***. \r\n\r\nIf you are having issues accessing the API keys page within your account you can submit a [Support](#section/API-Overview/Support) request for assistance.\r\n\r\n## API Keys\r\nAccount-level API keys authenticate every request and keep things secure. \r\n\r\nAPI keys have two components: a “client ID” and a “secret”.\r\n\r\n* **Client IDs** are similar to usernames. They’re used to identify your Propertyware API key and are safe to share.\r\n* **Secrets** are similar to passwords. They must be kept confidential. \r\n\r\nWhenever you make a request, you’ll need the API key’s client ID and secret. If you forget it, make a mistake, or try to use information that’s linked to a deleted key, the API will return a `401` response code.\r\n\r\n>  **Tip:** We compiled a list of best practices that detail how securely store API keys. [Give it a read](#section/Getting-Started/Keeping-API-Keys-Safe)!\r\n\r\n## Creating API Keys \r\n\r\nNow that the Open API is enabled, you’ll be able to create API keys. You’re almost there!\r\n\r\n**How to create an API key** \r\n\r\n1. On the API Keys page, click ***Create API Key***. A modal will appear.\r\n\r\n<p>\r\n    <img src=\"APIKey_Page.JPG\"/>\r\n</p>\r\n\r\n<p>\r\n    <img src=\"APIKey_New.JPG\"/>\r\n</p>\r\n\r\n2. Enter a clear, memorable name and description for your API key. It’ll make it easier to locate the right key when you make a request.\r\n\r\n3. Now, choose which pieces of Propertyware data you want this API key to have access to by selecting the corresponding radio buttons. Once finished, click **GENERATE KEY**.\r\n\r\n4. You have successfully created an API key! The client id and secret associated to this key will be presented. \r\n\r\n<p>\r\n    <img src=\"APIKey_Generate.JPG\"/>\r\n</p>\r\n\r\n> **Important:** This is your only chance to record the secret. Make sure it’s stored somewhere secure! If it’s forgotten, you’ll need to delete this key and start from scratch.\r\n\r\n\r\nYou have now successfully created an API key and have everything you need to  send requests to the Propertyware API! \r\n\r\nBefore moving on to [making your first request](#section/Getting-Started/How-to-Make-a-Request) please review [Keeping API Keys Safe](#section/Getting-Started/Keeping-API-Keys-Safe) for an overview on securely storing your API keys.  \r\n<br />\r\nIf you are having issues creating API keys you can submit a [Support](#section/API-Overview/Support) request for assistance.\r\n\r\n## Keeping API Keys Safe\r\n\r\nBased on their permissions, API keys could have full access to your account’s Propertyware data. It’s important that you only grant access to trusted applications, securely record secrets, and consider a password manager to stay organized.\r\n\r\n### Recommended Practices\r\n\r\n- Avoid hard-coding client IDs and secrets inside source files.\r\n- Avoid storing client IDs and secrets in any files that may be committed to source control, particularly cloud-based source control platforms.\r\n- Apply restrictions to client IDs and secrets shared with your staff. You can restrict a key to particular Propertyware entities or to read-only access (GET resources only).\r\n- Avoid sharing client IDs and secrets across public, insecure platforms.\r\n- Establish a process to regularly recreate your client IDs and secrets from your Propertyware account.\r\n<br />\r\n<br />\r\n\r\n## How to Make a Request \r\n\r\nYou’ve done a great job setting up your account, Now, we’ll walk you through how to access your data. It’s very straightforward and should only take a few minutes!\r\n\r\n> **Tip:** Looking for the right HTTP client? If you’re just getting started, we recommend Postman. \r\n\r\n### Let's Get Started!\r\n\r\n#### Step 1: Get Your API Key\r\n\r\nIf you haven't yet done so, obtain your API key client ID and secret from your Propertyware account. Your API key is how the Propertyware API authenticates requests and ensures only you can access your data.\r\n\r\n#### Step 2: Install a HTTP client\r\n\r\nThe Propertyware API supports any standard HTTP client. If you're looking for a user-friendly HTTP client application, we recommend [Postman](https://www.postman.com/product/api-client) – it allows you to access the Propertyware API without writing code. We’ll use Postman for our example below to demonstrate sending an API request.\r\n\r\n#### Step 3: Make a Sample Request\r\n\r\nLet's dive in and make a simple request to get all the [Buildings](#operation/getBuildingsUsingGET) in your account. This will confirm your connectivity to our platform and validate the keys you created on our website. Simply follow the instructions below.\r\n\r\n1. Open the Postman application. \r\n2. Open the *verb* menu and select **GET**.\r\n3. Enter the request endpoint in the field next to GET. \r\n   - Here’s the endpoint to get all buildings: https://api.propertyware.com/pw/api/rest/v1/buildings.\r\n4. To authenticate the request, enter your `client ID`, your `secret` and your `organization iD` respectively in these request headers: \r\n   - `x-propertyware-client-id`\r\n   - `x-propertyware-client-secret`\r\n   - `x-propertyware-system-id` _(organization id)_\r\n\r\nThe organization id uniquely identifies your Propertyware account and is an additional measure to enforce proper access to the correct data. ___Your client id and secret pair will only work with the organization it belongs to___.\r\n\r\nYour full request should look similar to the image below.\r\n<kbd><img src=\"request_example.png\" /></kbd>\r\n\r\n5. Review the parameters of your request on last time. Once finished, click **Send**.\r\n\r\n6. If successful, you should see a JSON response and a `200` HTTP status code. Congratulations! You've connected to the Propertyware API.\r\n\r\nYou now have the knowledge required to make requests for any of our resources.\r\n\r\nIf you've received an error response please review the JSON response message for a description of how to resolve the issue. You can also see more information about HTTP status codes in the [Response Codes](#section/API-Overview/Response-Codes) section. If you are still having trouble making a request after reviewing these sections please submit a [Support](#section/API-Overview/Support) request.\r\n\r\n# API Overview\r\nThe Propertyware API is built upon standard REST conventions. It's designed to use consistent resource-oriented URLs, accept and return JSON-encoded messages, and use standard HTTP status codes and verbs.\r\n\r\n## Base URL\r\nThe base URL for production environment API requests is: `https://api.propertyware.com/pw/api/v1/rest`\r\n\r\nIn order to ensure all requests and responses are secure between the API consumer and Propertyware servers, requests must be made using the `https` protocol. Any requests not made with the `https` protocol will be refused by the Propertyware API platform. \r\n\r\n> **Note:** URL paths are case-sensitive to stay consistent with common REST standards. If your request doesn’t align with the documented URL path, you’ll receive a `404` response code reminding you of this constraint.\r\n\r\n## API Versioning\r\nThe Propertyware API is version controlled. Versioning ensures backwards-incompatible changes to the API don’t impact any existing integrations.\r\n\r\nPropertyware uses only a major version nomenclature to manage changes. The current version of the Propertyware API is version 1. By specifying a version in the resource request URL, you'll get expected responses regardless of future changes to the API. Here's an example of calling version 1 of the retrieve all leases resource:\r\n\r\n`https://api.propertyware.com/pw/api/rest/v1/leases`\r\n\r\nAny request submitted without the version in the URL path will result in a `404` error response code. \r\n\r\n### Releasing Changes to the API\r\nThe Propertyware API will continue to evolve to ensure it meets the needs of our customers. Changes will be defined as either backwards-compatible or backwards-incompatible. \r\n\r\nWe’ll provide advance notice for all API releases–regardless of the type of modifications being made. \r\n\r\n#### Backward-compatible Changes\r\nBackward-compatible changes are modifications to the API that shouldn't impact existing integrations. They'll apply to the current version of the API. Simply put: you won’t need to change the version to consume new changes like these. \r\n\r\nIt's important as you develop against the Propertyware API that you ensure  these types of changes don't impact your integration. Here's are examples of backward-compatible modifications. \r\n\r\n* Adding new API resources and/or endpoints.\r\n* Adding new optional request parameters to existing API methods.\r\n* Adding new properties to existing API responses and non-required properties for request messages.\r\n* Changing property order in existing API responses.\r\n\r\nAll backward-compatible changes to the API will be documented in the [Changelog](#section/Changelog).\r\n\r\n#### Backwards-incompatible Changes\r\n\r\nWhen backwards-incompatible changes to the API occur, a new version of the API will be released. You’ll need to update the URL path  to consume resources under the new API version. \r\n\r\nBackwards-incompatible changes include:\r\n\r\n* Removing a property from a request and/or response message.\r\n* Changing the name of a property in a message.\r\n* Adding a required parameter to a request message.\r\n* Changing existing enumeration values.\r\n\r\nNew versions of the API will have full reference documentation and an upgrade guide. \r\n\r\n## Authentication\r\n\r\nThe Propertyware API uses API key’s client IDs and secrets to authenticate requests. \r\n\r\nAn organization ID, an API key client ID and secret must be passed in every request header using the following parameters: \r\n\r\n- `x-propertyware-client-id`\r\n- `x-propertyware-client-secret`\r\n- `x-propertyware-system-id`\r\n\r\nFailing to provide both of them in the request header will cause the API to return a `401` HTTP status code.\r\n<!--\r\n## Rate Limiting (FUTURE)\r\nRate limits help us ensure consistent and reliable performance for all users, even during peak loads. That’s why we limit clients to **10 concurrent requests per second**.\r\n\r\nIf your request rate violates that limit, a response code of `429` is returned. Simply retry the request after a short interval (~200ms).\r\n-->\r\n\r\n## Bulk Request Options\r\nAll top-level API resources support bulk fetches. For instance, you can retrieve all [Portfolios](#operation/getPortfoliosUsingGET). These resources also allow for filtering criteria. Each resource has descriptions of the filter criteria available.\r\n\r\nIn addition to filtering, our API gives you the ability to control the returned data’s pagination and the sort order. \r\n\r\n### Pagination\r\nEndpoints that return result sets allow for pagination using `limit` and `offset` request parameters to reduce the amount of data returned.\r\n\r\nThe `limit` request parameter will cap the number of results that come back in the response. If you don't specify a `limit` value, a **default of 100 results** are returned. The maximum `limit` value is 500. If a `limit` value is specified greater than 500, it will be overridden to the default to 500. \r\n\r\nThe `offset` request parameter indicates the record position within the resultset to start at when returning the results. The `offset` is zero-based and is inclusive. If no `offset` value is submitted it will default to 0. \r\n\r\n\r\nThe total resultset count is returned in the HTTP Header `X-Total-Count`\r\n\r\n\r\n#### Pagination Example\r\n\r\nAs an example, let's say we make a request to retrieve all rental properties with no paging parameters. Our response indicates in the `X-Total-Count` header that there are 150 total rental properties. We want to get only the last 50 results so we would submit a request with the `offset` set to 100 and the `limit` set to 50.\r\n\r\n> **Note:** The `limit` and `offset` parameter names are case-sensitive. If they aren't formatted correctly, the API will return a `404` HTTP status code.\r\n\r\n### Sorting Results\r\n\r\nYou can specify the sort order of returned data by assigning properties from the returned object to the `orderby` parameter in the querystring. For example:\r\n```\r\norderby=name\r\n```\r\nBy default, the sort is performed in ascending order. To specify sort order, use \"asc\" for ascending or \"desc\" for descending. For example:\r\n```\r\norderby=name desc\r\n```\r\nAdditionally, you can sort by multiple properties by comma separating the properties. For example:\r\n```\r\norderby=abbreviation asc,name desc\r\n```\r\n\r\n> **Note:** While the `orderby` parameter is case-sensitive, the properties specified in the `orderby` value aren't. \r\n\r\n## Response Codes\r\nThe Propertyware API supports standard HTTP status codes.\r\n\r\n|Response Code          |Description  |\r\n|--|--|\r\n|200 OK | Everything worked as expected. |\r\n|400 Bad Request | The request was unacceptable, often due to missing a required parameter.|\r\n|401 Unauthorized|The API client ID and secret weren’t provided or they’re no longer valid. Be sure that the client ID and secret combination are correct and they are still active.|\r\n|403 Forbidden|The API key doesn't have permission to perform the request. This could be due to authorization for the given endpoint or an inability to access given entities within the platform (e.g. properties).\r\n|404 Not Found|The requested resource doesn't exist.|\r\n|415 Unsupported Media Type |Ensure you have the appropriate content-type header value set on your request. Each resource is documented with media type(s) that are accepted.|\r\n|429 Too Many Requests |Too many requests against the API too quickly. We recommend an exponential backoff of your requests.|\r\n|500 and above - Server Errors|Something went wrong on Propertyware's end. Review the JSON response message for more details about the error.|\r\n\r\n## API Date Format\r\n* For all request and response date fields allowing ISO date format: YYYY-MM-DD (e.g.2019-08-24).\r\n* For all request and response dateAndTime fields format is allowing: YYYY-MM-dd'T'HH:mm:ssXXX (e.g.2022-06-28T08:47:13Z).\r\n\r\n## Support\r\nIf you are unable to resolve your issue after reviewing the API documentation our support team can assist you.\r\n\r\n# Changelog\r\n\r\n### 2024-12-11\r\n\r\n* New API introduced to add comments to existing task in workorder.<br/>\r\n  URL : /workorders//{workOrderId}/tasks/{taskId}/comments (POST) <br/>\r\n  Access Permissions : WorkOrder - Write\r\n*  New fields \"baseYear\",\"baseYearOperatingExpenses\",\"baseYearPropertyInsurance\",\"baseYearPropertyTaxes\" are added to  Building request/response for Below End Points<br/>\r\n    *  Get Building (Get - /buildings/{buildingID})\r\n    *  Create Building (Post - /buildings)\r\n    *  Update Building (Put - /buildings/{buildingID})\r\n    *  Get All Buildings (Get - /buildings)\r\n*  New fields \"syndicate\" ,\"moveInDays\", \"featuredForRent\" are added to Building request/response for Below End Points<br/>\r\n    *  Create Building (Post - /buildings)\r\n    *  moveInDays field must be with in these days given here \"1 to 30,45,60,75,90\" added validation.\r\n\r\n\r\n\r\n\r\n### 2024-11-13\r\n* New fields \"reasonForLeaving\",\"noticeGivenDate\",\"paymentRestriction\"  is added to response of<br/>\r\n  (1) Create a Lease - POST /leases<br/>\r\n  (2) Update a Lease - GET /leases/{leaseID}\r\n* New field \"chargeAmountPaid\" is added to lease charges payments entity. indicates the amount paid for current charge.<br/>\r\n  (1) Get a Lease - GET /leases/charges (charge.payments.chargeAmountPaid)<br/>\r\n\r\n### 2024-09-25\r\n* New API introduced to close existing workorder.<br/>\r\n    URL : /workorders/closeworkorder/{workorderID} (PUT) <br/>\r\n    Access Permissions : WorkOrder - Write\r\n* A new fields \"managementContractStartDate\" and \"managementContractEndDate\" are added to update Building request/response for below end points\r\n   * Update Building ( PUT - buildings/{buildingID} ) \r\n    \r\n### 2024-09-11\r\n* A new field \"unitIDs\"(Unit ID list associated to a Work Order) is added to response of<br/>\r\n  (1) Retrieve a Work Order - GET /workorders/{workorderID}<br/>\r\n  (2) Retrieve All Work Orders - GET /workorders\r\n\r\n### 2024-06-09\r\n* A new field \"unitID\" is added to response of<br/>\r\n  (1) Retrieve a Work Order - GET /workorders/{workorderID}<br/>\r\n  (2) Retrieve All Work Orders - GET /workorders\r\n* Building and Unit targetDeposit data type changed from double to String and the impacted end points are all POST/GET/PUT. \r\n\r\n### 2024-05-22\r\n* API documentation is corrected to show 'file' field in request body for 'Upload a Document' API.\r\n\r\n### 2024-05-12\r\n* A new filed \"arBalance\" is added to Lease response for below end points\r\n  * Retrieve a lease ( GET - /leases/{leaseID} - set query parameter \"includeOtherBalances = true\" to include lease arBalance)\r\n  * Retrieve all leases ( GET - /leases )\r\n  * Create a lease (POST - /leases)\r\n  * Update a lease (PUT - /leases/{leaseID})\r\n\r\n### 2024-04-23\r\n* Beta has been removed to facilitate Update an owner draw ( PUT - /accounting/ownerdraws/{drawID} )\r\n\r\n### 2024-04-10\r\n\r\n* Beta has been removed to facilitate Update a Credit ( PUT - /bills/credit/{creditID} )\r\n* Beta has been removed to facilitate Update a Bill ( PUT - /bills/{billId} )\r\n* Beta has been removed to facilitate Create word orders in bulk. ( POST - /workorders/bulk )\r\n* A new field \"amount\" is added to Bill response for below end points\r\n  * Retrieve a bill ( GET - /bills/{billID} )\r\n  * Retrieve all bills ( GET - /bills/ )\r\n  * Create a Bill ( POST - /bills/ )\r\n  * Update Bill ( PUT - /bills/{billId} )\r\n  * Create a Credit ( POST - /bills/credit )\r\n  * Update a Credit ( PUT - /bills/credit/{creditID} )\r\n* Update a Contact ( PUT - /contacts/{contactID} ) is allowed to update any Contact Type\r\n* A new field \"managementFeesType\" is added to CREATE building(POST), UPDATE building(PUT), GET buildings(GET) end points. Existing \"managementFeeType\" is deprecated and should not be used.\r\n* Few fields from CREATE building are not updating with a POST request. Resolved the issue and impacted fields are targetDeposit, targetRentUnits.\r\n* Few fields from UPDATE building are not updating with a PUT request. Resolved the issue and impacted fields are numberOfBathrooms, numberOfBedRooms, targetRent, targetDeposit, targetRentUnits, marketingName, managementFlatFee, managementFeeType, petsAllowed, postingTitle, shortDescription, yearBuilt.\r\n* The 'account' field has been removed, and the data type for the 'dueDay' field has been changed \r\nfrom String to Integer in the response for the ( POST - /leases/autocharges ) endpoint.\r\n* Fixed the issue - date field value getting saved as today date for Create Lease Charge, Update Lease Charge, Create Bulk Charges, Create a Lease Payment, Update a Lease Payment, Create a Lease Refund APs.\r\n* Work order id validation is implemented for Create Bill, Update Bill, Create Credit, Update Credit APIs.\r\n\r\n### 2024-03-24\r\n\r\n* New API introduced to update existing workorder custom fields.<br/>\r\n  URL : /workorders/customfields (PUT) <br/>\r\n  Access Permissions : WorkOrder - Write\r\n* A new field \"role\" is added to GET lease contacts end point (/leases/{leaseID}/contacts) \r\n* A new field \"role\" is added to \"contact\" in GET lease end point (/leases/{leaseID})\r\n* A new field \"role\" is added to \"contact\" in GET All leases end point (/leases)\r\n\r\n### 2024-03-11\r\n\r\n* New API introduced to update existing contact custom fields.<br/>\r\n  URL : /contacts/customfields (PUT) <br/>\r\n  Access Permissions : Contacts - Write\r\n* Beta has been removed to facilitate create a bank deposit, create an owner contribution, create an owner draw requests.\r\n* New API introduced to update existing portfolio custom fields.<br/>\r\n  URL : /portfolios/customfields (PUT) <br/>\r\n  Access Permissions : Portfolio - Write\r\n* New API introduced to update existing vendor custom fields.<br/>\r\n  URL : /vendors/customfields (PUT) <br/>\r\n  Access Permissions : Vendor - Write\r\n* Beta has been removed to facilitate 'Create a bill', 'Create bills in bulk', 'Create a credit' Rest API's.\r\n\r\n### 2024-02-25\r\n* Beta has been removed to facilitate 'Retrieve all bills','Retrieve all bill payments','Retrieve a bill payment','Retrieve all vendor checks' and 'Retrieve a bill'.\r\n* Create/update/Retrieve VendorCheck endpoint change from bills/vendorChecks to bills/vendorChecks.\r\n* A new API has been introduced to enable adding multiple automatic charges to leases.\r\n  </br>URL : /leases/autocharges (POST)\r\n* General ledger GET end point('/accounting/generalledger') is updated to filter only 7 days duration of transactions earlier it is 30 days.\r\n* New field added \"referenceNumber\" in \"rentAutoCharge\" of create lease request.\r\n* New API introduced to update unit custom fields\r\n  </br>URL : /units/customfields (PUT)\r\n  </br>Access Permissions : Unit - Write\r\n\r\n* New API introduced to update building custom fields\r\n  </br>URL : /buildings/customfields (PUT)\r\n  </br>Access Permissions : Building - Write\r\n\r\n### 2024-02-11\r\n\r\n* Beta has been removed to facilitate Retrieves a list of owner draws,Retrieves a list of owner contributions,Retrieves a list of general ledger accounts  and Retrieves a general ledger account.\r\n* New filed \"description\" is added in General ledger account(accounting/glaccounts - GET & accounting/glaccounts/{glAccountID} - GET) endpoint response.\r\n* New field \"specificLocation\" is added in Workorder create/update request.\r\n* New field \"requiredMaterials\" is added in Workorder create/update request.\r\n* New field \"publishToTenantPortal\" is added in Workorder create/update request.\r\n* New field \"publishToOwnerPortal\" is added in Workorder create/update request.\r\n* New field \"publishToTenantPortal\" is added in Workorder GET response.\r\n* New field \"publishToOwnerPortal\" is added in Workorder GET response.\r\n* New API introduced to update lease custom fields \r\n  </br>URL : /leases/customfields (PUT)\r\n  </br>Access Permissions : Lease - Write (An additional permission is required \"Custom Field - write\" will be introduced with 2024-02-25 release)\r\n* New API introduced to update prospect custom fields\r\n  </br>URL : /prospects/customfields (PUT)\r\n  </br>Access Permissions : prospect - Write (An additional permission is required \"Custom Field - write\" will be introduced with 2024-02-25 release)\r\n\r\n### 2024-01-24\r\n\r\n* Beta has been removed to facilitate WorkOrder task update.\r\n* Beta has been removed to facilitate retrieve vendor general ledger account.\r\n* New field \"source\" is added in Workorder create/update request.\r\n* Beta has been removed to facilitate Unit update.\r\n\r\n### 2024-01-09\r\n\r\n* An additional property , 'ready' (indicating ready to lease), has been added to create the building API. However, the 'unitCount' property value is incorrect when using the create building API.\r\n\r\n* Beta has been removed to facilitate building updates and creation in bulk for Building APi.\r\n  \r\n* \"Retrieve all lease journal entries\". this is an extension for existing endpoint. leaseID will be part of the request params in new endpoint.\r\n<br/>existing url: https://api.propertyware.com/pw/api/rest/v1/leases/journalentries/{leaseID} (Will be discontinued in future once new URL is being used)\r\n<br/>New url: https://api.propertyware.com/pw/api/rest/v1/leases/journalentries\r\n  (leaseID can be sent as a request parameters)\r\n\r\n* \"Retrieve all lease auto charges\". this is an extension for existing endpoint. leaseID will be part of the request params in new endpoint.\r\n  <br/>existing url: https://api.propertyware.com/pw/api/rest/v1/{leaseID}/autocharges (Will be discontinued in future once new URL is being used)\r\n  <br/>New url: https://api.propertyware.com/pw/api/rest/v1/leases/autocharges\r\n  (leaseID can be sent as a request parameters)\r\n  \r\n* New field \"publishedForRent\" is added in Building and Unit responses.\r\n* New field \"role\" is added in prospect contact response.\r\n* Beta has been removed to facilitate Contact update.\r\n* Allowed GET Lease charges/payments/refunds/creditmemos/adjustments, filtered by \"glAccountId\"\r\n\r\n### 2023-10-24\r\n* Retrieve a General Ledger Account\r\n\r\n### 2023-08-28\r\n* Update a document\r\n\r\n### 2023-07-11\r\n* Delete a document\r\n\r\n### 2023-07-11\r\n* Retrieve all documents\r\n* Retrieve a document\r\n* Download a document\r\n\r\n### 2023-06-10\r\n* Lease contacts are included in Retrieve all leases API response\r\n* Lease contacts are included in Retrieve a lease API response\r\n\r\n### 2023-04-24\r\n* Bulk Insertion: Prospects\r\n* Bulk Insertion: Bill Payments\r\n\r\n### 2023-04-11\r\n\r\n* Bulk Insertion: Portfolios\r\n* Bulk Insertion: Buildings\r\n* Bulk Insertion: Units\r\n\r\n### 2023-03-19\r\n\r\n* Bulk insertion: contacts\r\n\r\n### 2023-03-08\r\n\r\n* Bulk insertion: bills\r\n\r\n### 2023-01-24\r\n\r\n* Custom fields in \"Get all\" endpoints\r\n* Prospect creation\r\n* Bill removals \r\n \r\n### 2022-10-25\r\n\r\n* API Read operations for non-financial data\r\n\r\n### 2022-09-21\r\n\r\n* API Read operations available"
  version: '1.0'
  title: Open API, powered by Propertyware Accounting Leases API
  contact:
    name: Propertyware
    email: support@propertyware.com
  x-logo:
    url: logo.png
    backgroundColor: '#fff'
    altText: Propertyware, A RealPage Company
    href: https://www.propertyware.com
servers:
- url: https://api.propertyware.com/pw/api/rest/v1
security:
- clientId: []
- clientSecret: []
- organizationId: []
tags:
- name: Leases
  description: Resources providing access to rental property leases.
paths:
  /leases:
    get:
      tags:
      - Leases
      summary: Retrieve all leases
      description: 'Retrieves a list of leases.<br/><br/><b>Required permission:</b><br/><span class="permissionBlock">LEASES</span> - <code>Read</code>

        <br/><br/><b>Sortable by:</b> <code>startdate</code>, <code>idnumber</code>, <code>scheduledmoveoutdate</code>, <code>enddate</code>, <code>lastmodifieddatetime</code>, <code>status</code>, <code>moveoutdate</code>, <code>id</code>, <code>moveindate</code>'
      operationId: getLeases
      parameters:
      - name: offset
        in: query
        description: '`offset` indicates the position of the first record to return. The offset is zero-based and the default is 0.'
        required: false
        schema:
          type: integer
          format: int32
      - name: limit
        in: query
        description: '`limit` indicates the maximum number of results to be returned in the response. `limit` can range between 1 and 500 and the default is 100.'
        required: false
        schema:
          type: integer
          format: int32
          default: 100
      - name: lastModifiedDateTimeStart
        in: query
        description: 'Filters results to any item modified on or after the date time specified. '
        required: false
        schema:
          type: string
          format: date-time
      - name: lastModifiedDateTimeEnd
        in: query
        description: 'Filters results to any item modified on or prior to the date time specified. '
        required: false
        schema:
          type: string
          format: date-time
      - name: orderby
        in: query
        description: Indicates the field(s) and direction to sort the results in the response.
        required: false
        schema:
          type: string
      - name: startDateStart
        in: query
        description: Filters results to any lease with a start date on or after the date specified.
        required: false
        schema:
          type: string
          format: date
      - name: startDateEnd
        in: query
        description: Filters results to any lease with a start date on or prior to the date specified.
        required: false
        schema:
          type: string
          format: date
      - name: endDateStart
        in: query
        description: Filters results to any lease with a end date on or after the date specified.
        required: false
        schema:
          type: string
          format: date
      - name: endDateEnd
        in: query
        description: Filters results to any lease with a end date on or prior to the date specified.
        required: false
        schema:
          type: string
          format: date
      - name: moveInDateStart
        in: query
        description: Filters results to any lease with a move-in date on or after the date specified.
        required: false
        schema:
          type: string
          format: date
      - name: moveInDateEnd
        in: query
        description: Filters results to any lease with a move-in date on or prior to the date specified.
        required: false
        schema:
          type: string
          format: date
      - name: scheduleMoveOutDateStart
        in: query
        description: Filters results to any lease with a move-out date on or after the date specified.
        required: false
        schema:
          type: string
          format: date
      - name: scheduleMoveOutDateEnd
        in: query
        description: Filters results to any lease with a move-out date on or prior to the date specified.
        required: false
        schema:
          type: string
          format: date
      - name: portfolioID
        in: query
        description: Filters results to leases associated with a specific portfolio.
        required: false
        schema:
          type: integer
          format: int64
      - name: buildingID
        in: query
        description: Filters results to leases associated with a specific building.
        required: false
        schema:
          type: integer
          format: int64
      - name: unitID
        in: query
        description: Filters results to leases associated with a specific unit.
        required: false
        schema:
          type: integer
          format: int64
      - name: status
        in: query
        description: Filters results to inspections with a specific status.
        required: false
        schema:
          type: string
      - name: includeCustomFields
        in: query
        description: includeCustomFields
        required: false
        schema:
          type: boolean
          default: false
      - name: includeOtherBalances
        in: query
        description: includeOtherBalances
        required: false
        schema:
          type: boolean
          default: false
      responses:
        '200':
          description: OK
          headers:
            X-Total-Count:
              description: The total resultset count
              schema:
                type: integer
                format: int64
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Lease'
        '400':
          description: Unable to process the request due to malformed request syntax or invalid parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: The API key couldn't be authorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: The supplied credentials don't have permissions to access the resources.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    post:
      tags:
      - Leases
      summary: Create a lease
      description: 'Creates a new lease.<br/><br/><b>Required permission:</b><br/><span class="permissionBlock">LEASES</span> - <code>Write</code>

        '
      operationId: createLease
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SaveLease'
        description: saveLease
        required: true
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Lease'
        '400':
          description: Unable to process the request due to malformed request syntax or invalid parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: The API key couldn't be authorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: The supplied credentials don't have permissions to access the resources.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Entity not found.
  /leases/adjustments:
    get:
      tags:
      - Leases
      summary: Retrieve all the adjustments
      description: 'Retrieves a list of adjustments.<br/><br/><b>Required permission:</b><br/><span class="permissionBlock">LEASES</span> - <code>Read</code>

        <br/><br/><b>Sortable by:</b> <code>leaseid</code>, <code>postdate</code>, <code>id</code>'
      operationId: getLeaseAdjustments
      parameters:
      - name: offset
        in: query
        description: '`offset` indicates the position of the first record to return. The offset is zero-based and the default is 0.'
        required: false
        schema:
          type: integer
          format: int32
      - name: limit
        in: query
        description: '`limit` indicates the maximum number of results to be returned in the response. `limit` can range between 1 and 500 and the default is 100.'
        required: false
        schema:
          type: integer
          format: int32
          default: 100
      - name: lastModifiedDateTimeStart
        in: query
        description: 'Filters results to any item modified on or after the date time specified. '
        required: false
        schema:
          type: string
          format: date-time
      - name: lastModifiedDateTimeEnd
        in: query
        description: 'Filters results to any item modified on or prior to the date time specified. '
        required: false
        schema:
          type: string
          format: date-time
      - name: orderby
        in: query
        description: Indicates the field(s) and direction to sort the results in the response.
        required: false
        schema:
          type: string
      - name: postDateStart
        in: query
        description: Filters results to any transaction with a start date on or after the date specified.
        required: false
        schema:
          type: string
          format: date
      - name: postDateEnd
        in: query
        description: Filters results to any transaction with a start date on or prior to the date specified.
        required: false
        schema:
          type: string
          format: date
      - name: portfolioID
        in: query
        description: Filters results associated with a specific portfolio.
        required: false
        schema:
          type: integer
          format: int64
      - name: leaseID
        in: query
        description: Filters results with Lease ID.
        required: false
        schema:
          type: integer
          format: int64
      - name: status
        in: query
        description: Filters results to with Lease Status.
        required: false
        schema:
          type: string
      - name: glAccountID
        in: query
        description: Filters results with GLAccount ID.
        required: false
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: OK
          headers:
            X-Total-Count:
              description: The total resultset count
              schema:
                type: integer
                format: int64
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Adjustment'
        '400':
          description: Unable to process the request due to malformed request syntax or invalid parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: The API key couldn't be authorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: The supplied credentials don't have permissions to access the resources.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    post:
      tags:
      - Leases
      summary: Create a lease adjustment (BETA)
      description: '<p class="betaError"><b>Note: </b>Write access is only available to customers who have opted in to our beta program. Please reach out to support if you''d like to be included.</p>

        Creates a lease adjustment.<br/><br/><b>Required permission:</b><br/><span class="permissionBlock">LEASES</span> - <code>Write</code>

        '
      operationId: createLeaseAdjustment
      requestBody:
        $ref: '#/components/requestBodies/SaveAdjustment'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Adjustment'
        '400':
          description: Unable to process the request due to malformed request syntax or invalid parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: The API key couldn't be authorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: The supplied credentials don't have permissions to access the resources.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /leases/adjustments/{adjustmentID}:
    put:
      tags:
      - Leases
      summary: Update a lease adjustment (BETA)
      description: '<p class="betaError"><b>Note: </b>Write access is only available to customers who have opted in to our beta program. Please reach out to support if you''d like to be included.</p>

        Updates an lease adjustment.<br/><br/><b>Required permission:</b><br/><span class="permissionBlock">LEASES</span> - <code>Write</code>

        '
      operationId: updateLeaseAdjustment
      parameters:
      - name: adjustmentID
        in: path
        description: Adjustment ID
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        $ref: '#/components/requestBodies/SaveAdjustment'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Adjustment'
        '400':
          description: Unable to process the request due to malformed request syntax or invalid parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: The API key couldn't be authorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: The supplied credentials don't have permissions to access the resources.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Entity not found.
  /leases/autocharges:
    get:
      tags:
      - Leases
      summary: Retrieve all lease auto charges (New)
      description: 'Retrieves all the auto charges of a lease.<br/><br/><b>Required permission:</b><br/><span class="permissionBlock">LEASES</span> - <code>Read</code>

        <br/><br/><b>Sortable by:</b> <code>createddate</code>, <code>lastmodifieddatetime</code>, <code>id</code>'
      operationId: getLeaseAutoCharges
      parameters:
      - name: offset
        in: query
        description: '`offset` indicates the position of the first record to return. The offset is zero-based and the default is 0.'
        required: false
        schema:
          type: integer
          format: int32
      - name: limit
        in: query
        description: '`limit` indicates the maximum number of results to be returned in the response. `limit` can range between 1 and 500 and the default is 100.'
        required: false
        schema:
          type: integer
          format: int32
          default: 100
      - name: lastModifiedDateTimeStart
        in: query
        description: 'Filters results to any item modified on or after the date time specified. '
        required: false
        schema:
          type: string
          format: date-time
      - name: lastModifiedDateTimeEnd
        in: query
        description: 'Filters results to any item modified on or prior to the date time specified. '
        required: false
        schema:
          type: string
          format: date-time
      - name: orderby
        in: query
        description: Indicates the field(s) and direction to sort the results in the response.
        required: false
        schema:
          type: string
      - name: leaseID
        in: query
        description: Filters results with Lease ID.
        required: false
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Charge'
        '400':
          description: Unable to process the request due to malformed request syntax or invalid parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: The API key couldn't be authorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: The supplied credentials don't have permissions to access the resources.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Entity not found.
    post:
      tags:
      - Leases
      summary: Create lease auto charges (BETA)
      description: '<p class="betaError"><b>Note: </b>Write access is only available to customers who have opted in to our beta program. Please reach out to support if you''d like to be included.</p>

        Creates lease auto charges.<br/><br/><b>Required permission:</b><br/><span class="permissionBlock">LEASES</span> - <code>Write</code>

        '
      operationId: createLeaseAutoCharges
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AutoCharge'
        description: autoCharge
        required: true
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Charge'
        '400':
          description: Unable to process the request due to malformed request syntax or invalid parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: The API key couldn't be authorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: The supplied credentials don't have permissions to access the resources.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /leases/charges:
    get:
      tags:
      - Leases
      summary: Retrieve all the lease charges
      description: 'Retrieves a list of lease charges.<br/><br/><b>Required permission:</b><br/><span class="permissionBlock">LEASES</span> - <code>Read</code>

        <br/><br/><b>Sortable by:</b> <code>leaseid</code>, <code>postdate</code>, <code>createddate</code>, <code>lastmodifieddatetime</code>, <code>id</code>'
      operationId: getLeaseCharges
      parameters:
      - name: offset
        in: query
        description: '`offset` indicates the position of the first record to return. The offset is zero-based and the default is 0.'
        required: false
        schema:
          type: integer
          format: int32
      - name: limit
        in: query
        description: '`limit` indicates the maximum number of results to be returned in the response. `limit` can range between 1 and 500 and the default is 100.'
        required: false
        schema:
          type: integer
          format: int32
          default: 100
      - name: lastModifiedDateTimeStart
        in: query
        description: 'Filters results to any item modified on or after the date time specified. '
        required: false
        schema:
          type: string
          format: date-time
      - name: lastModifiedDateTimeEnd
        in: query
        description: 'Filters results to any item modified on or prior to the date time specified. '
        required: false
        schema:
          type: string
          format: date-time
      - name: orderby
        in: query
        description: Indicates the field(s) and direction to sort the results in the response.
        required: false
        schema:
          type: string
      - name: postDateStart
        in: query
        description: Filters results to any transaction with a start date on or after the date specified.
        required: false
        schema:
          type: string
          format: date
      - name: postDateEnd
        in: query
        description: Filters results to any transaction with a start date on or prior to the date specified.
        required: false
        schema:
          type: string
          format: date
      - name: portfolioID
        in: query
        description: Filters results associated with a specific portfolio.
        required: false
        schema:
          type: integer
          format: int64
      - name: leaseID
        in: query
        description: Filters results with Lease ID.
        required: false
        schema:
          type: integer
          format: int64
      - name: status
        in: query
        description: Filters results to with Lease Status.
        required: false
        schema:
          type: string
      - name: glAccountID
        in: query
        description: Filters results with GLAccount ID.
        required: false
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: OK
          headers:
            X-Total-Count:
              description: The total resultset count
              schema:
                type: integer
                format: int64
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ChargeTx'
        '400':
          description: Unable to process the request due to malformed request syntax or invalid parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: The API key couldn't be authorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: The supplied credentials don't have permissions to access the resources.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    post:
      tags:
      - Leases
      summary: Create a lease charge (BETA)
      description: '<p class="betaError"><b>Note: </b>Write access is only available to customers who have opted in to our beta program. Please reach out to support if you''d like to be included.</p>

        Creates a lease charge.<br/><br/><b>Required permission:</b><br/><span class="permissionBlock">LEASES</span> - <code>Write</code>

        '
      operationId: createLeaseCharge
      requestBody:
        $ref: '#/components/requestBodies/SaveCharge'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChargeTx'
        '400':
          description: Unable to process the request due to malformed request syntax or invalid parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: The API key couldn't be authorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: The supplied credentials don't have permissions to access the resources.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /leases/charges/bulk:
    post:
      tags:
      - Leases
      summary: Create lease charges in bulk (BETA)
      description: '<p class="betaError"><b>Note: </b>Write access is only available to customers who have opted in to our beta program. Please reach out to support if you''d like to be included.</p>

        Creates lease charges in bulk.<br/><br/><b>Required permission:</b><br/><span class="permissionBlock">LEASES</span> - <code>Write</code>

        '
      operationId: createLeaseCharges
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/SaveCharge'
        description: saveCharge
        required: true
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RESTAPIBulkSuccessResponse'
        '400':
          description: Unable to process the request due to malformed request syntax or invalid parameters.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RESTAPIBulkErrorResponse'
        '401':
          description: The API key couldn't be authorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: The supplied credentials don't have permissions to access the resources.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /leases/charges/{chargeID}:
    put:
      tags:
      - Leases
      summary: Update a lease charge (BETA)
      description: '<p class="betaError"><b>Note: </b>Write access is only available to customers who have opted in to our beta program. Please reach out to support if you''d like to be included.</p>

        Updates a lease charge.<br/><br/><b>Required permission:</b><br/><span class="permissionBlock">LEASES</span> - <code>Write</code>

        '
      operationId: updateLeaseCharge
      parameters:
      - name: chargeID
        in: path
        description: Charge ID
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        $ref: '#/components/requestBodies/SaveCharge'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChargeTx'
        '400':
          description: Unable to process the request due to malformed request syntax or invalid parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: The API key couldn't be authorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: The supplied credentials don't have permissions to access the resources.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Entity not found.
    delete:
      tags:
      - Leases
      summary: Delete a lease charge (BETA)
      description: '<p class="betaError"><b>Note: </b>Write access is only available to customers who have opted in to our beta program. Please reach out to support if you''d like to be included.</p>

        Deletes a specific lease charge.<br/><br/><b>Required permission:</b><br/><span class="permissionBlock">LEASES</span> - <code>Delete</code>

        '
      operationId: deleteLeaseCharge
      parameters:
      - name: chargeID
        in: path
        description: Charge ID
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '204':
          description: No Content
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseEntity'
        '400':
          description: Unable to process the request due to malformed request syntax or invalid parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: The API key couldn't be authorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: The supplied credentials don't have permissions to access the resources.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Entity not found.
  /leases/creditmemos:
    get:
      tags:
      - Leases
      summary: Retrieve all the credit memos
      description: 'Retrieves a list of credit memos.<br/><br/><b>Required permission:</b><br/><span class="permissionBlock">LEASES</span> - <code>Read</code>

        <br/><br/><b>Sortable by:</b> <code>leaseid</code>, <code>postdate</code>, <code>createddate</code>, <code>lastmodifieddatetime</code>, <code>id</code>'
      operationId: getLeaseCreditMemos
      parameters:
      - name: offset
        in: query
        description: '`offset` indicates the position of the first record to return. The offset is zero-based and the default is 0.'
        required: false
        schema:
          type: integer
          format: int32
      - name: limit
        in: query
        description: '`limit` indicates the maximum number of results to be returned in the response. `limit` can range between 1 and 500 and the default is 100.'
        required: false
        schema:
          type: integer
          format: int32
          default: 100
      - name: lastModifiedDateTimeStart
        in: query
        description: 'Filters results to any item modified on or after the date time specified. '
        required: false
        schema:
          type: string
          format: date-time
      - name: lastModifiedDateTimeEnd
        in: query
        description: 'Filters results to any item modified on or prior to the date time specified. '
        required: false
        schema:
          type: string
          format: date-time
      - name: orderby
        in: query
        description: Indicates the field(s) and direction to sort the results in the response.
        required: false
        schema:
          type: string
      - name: postDateStart
        in: query
        description: Filters results to any transaction with a start date on or after the date specified.
        required: false
        schema:
          type: string
          format: date
      - name: postDateEnd
        in: query
        description: Filters results to any transaction with a start date on or prior to the date specified.
        required: false
        schema:
          type: string
          format: date
      - name: portfolioID
        in: query
        description: Filters results associated with a specific portfolio.
        required: false
        schema:
          type: integer
          format: int64
      - name: leaseID
        in: query
        description: Filters results with Lease ID.
        required: false
        schema:
          type: integer
          format: int64
      - name: status
        in: query
        description: Filters results to with Lease Status.
        required: false
        schema:
          type: string
      - name: glAccountID
        in: query
        description: Filters results with GLAccount ID.
        required: false
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CreditMemo'
        '400':
          description: Unable to process the request due to malformed request syntax or invalid parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: The API key couldn't be authorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: The supplied credentials don't have permissions to access the resources.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Entity not found.
  /leases/customfields:
    put:
      tags:
      - Leases
      summary: Update a lease custom fields (BETA)
      description: '<p class="betaError"><b>Note: </b>Write access is only available to customers who have opted in to our beta program. Please reach out to support if you''d like to be included.</p>

        Updates an existing lease custom fields<br/><br/><b>Required permission:</b><br/><span class="permissionBlock">LEASES</span> - <code>Write</code>

        '
      operationId: updateLease
      requestBody:
        $ref: '#/components/requestBodies/SaveCustomField'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseEntity'
        '400':
          description: Unable to process the request due to malformed request syntax or invalid parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: The API key couldn't be authorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: The supplied credentials don't have permissions to access the resources.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Entity not found.
  /leases/discounts:
    get:
      tags:
      - Leases
      summary: Retrieve all the lease discounts
      description: 'Retrieves a list of lease discounts<br/><br/><b>Required permission:</b><br/><span class="permissionBlock">LEASES</span> - <code>Read</code>

        <br/><br/><b>Sortable by:</b> <code>leaseid</code>, <code>postdate</code>, <code>createddate</code>, <code>lastmodifieddatetime</code>, <code>id</code>'
      operationId: getLeaseDiscounts
      parameters:
      - name: offset
        in: query
        description: '`offset` indicates the position of the first record to return. The offset is zero-based and the default is 0.'
        required: false
        schema:
          type: integer
          format: int32
      - name: limit
        in: query
        description: '`limit` indicates the maximum number of results to be returned in the response. `limit` can range between 1 and 500 and the default is 100.'
        required: false
        schema:
          type: integer
          format: int32
          default: 100
      - name: lastModifiedDateTimeStart
        in: query
        description: 'Filters results to any item modified on or after the date time specified. '
        required: false
        schema:
          type: string
          format: date-time
      - name: lastModifiedDateTimeEnd
        in: query
        description: 'Filters results to any item modified on or prior to the date time specified. '
        required: false
        schema:
          type: string
          format: date-time
      - name: orderby
        in: query
        description: Indicates the field(s) and direction to sort the results in the response.
        required: false
        schema:
          type: string
      - name: leaseID
        in: query
        description: Filters results to any LeaseID.
        required: false
        schema:
          type: integer
          format: int64
      - name: postDateStart
        in: query
        description: Filters results to any discount with a start date on or after the date specified.
        required: false
        schema:
          type: string
          format: date
      - name: postDateEnd
        in: query
        description: Filters results to any discount with a start date on or prior to the date specified.
        required: false
        schema:
          type: string
          format: date
      responses:
        '200':
          description: OK
          headers:
            X-Total-Count:
              description: The total resultset count
              schema:
                type: integer
                format: int64
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Discount'
        '400':
          description: Unable to process the request due to malformed request syntax or invalid parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: The API key couldn't be authorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: The supplied credentials don't have permissions to access the resources.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    post:
      tags:
      - Leases
      summary: Create a lease discount (BETA)
      description: '<p class="betaError"><b>Note: </b>Write access is only available to customers who have opted in to our beta program. Please reach out to support if you''d like to be included.</p>

        Creates a lease discount.<br/><br/><b>Required permission:</b><br/><span class="permissionBlock">LEASES</span> - <code>Write</code>

        '
      operationId: createLeaseDiscount
      requestBody:
        $ref: '#/components/requestBodies/SaveDiscount'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Discount'
        '400':
          description: Unable to process the request due to malformed request syntax or invalid parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: The API key couldn't be authorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: The supplied credentials don't have permissions to access the resources.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /leases/discounts/{discountID}:
    put:
      tags:
      - Leases
      summary: Updates a lease Discount (BETA)
      description: '<p class="betaError"><b>Note: </b>Write access is only available to customers who have opted in to our beta program. Please reach out to support if you''d like to be included.</p>

        Updates a lease Discount.<br/><br/><b>Required permission:</b><br/><span class="permissionBlock">LEASES</span> - <code>Write</code>

        '
      operationId: updateLeaseDiscount
      parameters:
      - name: discountID
        in: path
        description: Discount ID
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        $ref: '#/components/requestBodies/SaveDiscount'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Discount'
        '400':
          description: Unable to process the request due to malformed request syntax or invalid parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: The API key couldn't be authorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: The supplied credentials don't have permissions to access the resources.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Entity not found.
  /leases/journalentries:
    get:
      tags:
      - Leases
      summary: Retrieve all lease journal entries (New)
      description: 'Retrieves a list of lease journal entries.<br/><br/><b>Required permission:</b><br/><span class="permissionBlock">LEASES</span> - <code>Read</code>

        <br/><br/><b>Sortable by:</b> <code>postdate</code>, <code>createddate</code>, <code>lastmodifieddatetime</code>, <code>id</code>'
      operationId: getLeaseJournalEntryUsingGET_1
      parameters:
      - name: offset
        in: query
        description: '`offset` indicates the position of the first record to return. The offset is zero-based and the default is 0.'
        required: false
        schema:
          type: integer
          format: int32
      - name: limit
        in: query
        description: '`limit` indicates the maximum number of results to be returned in the response. `limit` can range between 1 and 500 and the default is 100.'
        required: false
        schema:
          type: integer
          format: int32
          default: 100
      - name: lastModifiedDateTimeStart
        in: query
        description: 'Filters results to any item modified on or after the date time specified. '
        required: false
        schema:
          type: string
          format: date-time
      - name: lastModifiedDateTimeEnd
        in: query
        description: 'Filters results to any item modified on or prior to the date time specified. '
        required: false
        schema:
          type: string
          format: date-time
      - name: orderby
        in: query
        description: Indicates the field(s) and direction to sort the results in the response.
        required: false
        schema:
          type: string
      - name: leaseID
        in: query
        description: Filters results to transactions associated with a specific lease.
        required: false
        schema:
          type: integer
          format: int64
      - name: postDateStart
        in: query
        description: Filters results to any transaction with post date on or after to the date specified.
        required: false
        schema:
          type: string
          format: date
      - name: postDateEnd
        in: query
        description: Filters results to any transaction with post date on or prior to the date specified.
        required: false
        schema:
          type: string
          format: date
      responses:
        '200':
          description: OK
          headers:
            X-Total-Count:
              description: The total resultset count
              schema:
                type: integer
                format: int64
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JournalEntry'
        '400':
          description: Unable to process the request due to malformed request syntax or invalid parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: The API key couldn't be authorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: The supplied credentials don't have permissions to access the resources.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Entity not found.
    post:
      tags:
      - Leases
      summary: Create a lease journal entry (BETA)
      description: '<p class="betaError"><b>Note: </b>Write access is only available to customers who have opted in to our beta program. Please reach out to support if you''d like to be included.</p>

        Creates a lease journal entry.<br/><br/><b>Required permission:</b><br/><span class="permissionBlock">LEASES</span> - <code>Write</code>

        '
      operationId: createJournalEntry
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SaveLeaseJournalEntry'
        description: saveLeaseJournalEntry
        required: true
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JournalEntry'
        '400':
          description: Unable to process the request due to malformed request syntax or invalid parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: The API key couldn't be authorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: The supplied credentials don't have permissions to access the resources.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /leases/journalentries/{journalentryID}:
    put:
      tags:
      - Leases
      summary: Update a lease journal entry (BETA)
      description: '<p class="betaError"><b>Note: </b>Write access is only available to customers who have opted in to our beta program. Please reach out to support if you''d like to be included.</p>

        Updates a lease journal entry.<br/><br/><b>Required permission:</b><br/><span class="permissionBlock">LEASES</span> - <code>Write</code>

        '
      operationId: updateLeaseJournalEntry
      parameters:
      - name: journalentryID
        in: path
        description: Journal Entry ID
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateLeaseJournalEntry'
        description: updateLeaseJournalEntry
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JournalEntry'
        '400':
          description: Unable to process the request due to malformed request syntax or invalid parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: The API key couldn't be authorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: The supplied credentials don't have permissions to access the resources.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Entity not found.
  /leases/journalentries/{leaseID}:
    get:
      tags:
      - Leases
      summary: 'Retrieve all lease journal entries '
      description: 'Retrieves a specific lease journal entries.<br/><br/><b>Required permission:</b><br/><span class="permissionBlock">LEASES</span> - <code>Read</code>

        <br/><br/><b>Sortable by:</b> <code>postdate</code>, <code>createddate</code>, <code>lastmodifieddatetime</code>, <code>id</code>'
      operationId: getLeaseJournalEntry
      parameters:
      - name: leaseID
        in: path
        description: Lease ID
        required: true
        schema:
          type: integer
          format: int64
      - name: offset
        in: query
        description: '`offset` indicates the position of the first record to return. The offset is zero-based and the default is 0.'
        required: false
        schema:
          type: integer
          format: int32
      - name: limit
        in: query
        description: '`limit` indicates the maximum number of results to be returned in the response. `limit` can range between 1 and 500 and the default is 100.'
        required: false
        schema:
          type: integer
          format: int32
          default: 100
      - name: lastModifiedDateTimeStart
        in: query
        description: 'Filters results to any item modified on or after the date time specified. '
        required: false
        schema:
          type: string
          format: date-time
      - name: lastModifiedDateTimeEnd
        in: query
        description: 'Filters results to any item modified on or prior to the date time specified. '
        required: false
        schema:
          type: string
          format: date-time
      - name: orderby
        in: query
        description: Indicates the field(s) and direction to sort the results in the response.
        required: false
        schema:
          type: string
      - name: leaseID
        in: query
        description: Filters results to transactions associated with a specific lease.
        required: false
        schema:
          type: integer
          format: int64
      - name: postDateStart
        in: query
        description: Filters results to any transaction with post date on or after to the date specified.
        required: false
        schema:
          type: string
          format: date
      - name: postDateEnd
        in: query
        description: Filters results to any transaction with post date on or prior to the date specified.
        required: false
        schema:
          type: string
          format: date
      responses:
        '200':
          description: OK
          headers:
            X-Total-Count:
              description: The total resultset count
              schema:
                type: integer
                format: int64
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JournalEntry'
        '400':
          description: Unable to process the request due to malformed request syntax or invalid parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: The API key couldn't be authorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: The supplied credentials don't have permissions to access the resources.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Entity not found.
  /leases/payments:
    get:
      tags:
      - Leases
      summary: Retrieve all the lease payments
      description: 'Retrieves a list of lease payments.<br/><br/><b>Required permission:</b><br/><span class="permissionBlock">LEASES</span> - <code>Read</code>

        <br/><br/><b>Sortable by:</b> <code>leaseid</code>, <code>postdate</code>, <code>createddate</code>, <code>lastmodifieddatetime</code>, <code>id</code>'
      operationId: getLeasePayments
      parameters:
      - name: offset
        in: query
        description: '`offset` indicates the position of the first record to return. The offset is zero-based and the default is 0.'
        required: false
        schema:
          type: integer
          format: int32
      - name: limit
        in: query
        description: '`limit` indicates the maximum number of results to be returned in the response. `limit` can range between 1 and 500 and the default is 100.'
        required: false
        schema:
          type: integer
          format: int32
          default: 100
      - name: lastModifiedDateTimeStart
        in: query
        description: 'Filters results to any item modified on or after the date time specified. '
        required: false
        schema:
          type: string
          format: date-time
      - name: lastModifiedDateTimeEnd
        in: query
        description: 'Filters results to any item modified on or prior to the date time specified. '
        required: false
        schema:
          type: string
          format: date-time
      - name: orderby
        in: query
        description: Indicates the field(s) and direction to sort the results in the response.
        required: false
        schema:
          type: string
      - name: postDateStart
        in: query
        description: Filters results to any transaction with a start date on or after the date specified.
        required: false
        schema:
          type: string
          format: date
      - name: postDateEnd
        in: query
        description: Filters results to any transaction with a start date on or prior to the date specified.
        required: false
        schema:
          type: string
          format: date
      - name: portfolioID
        in: query
        description: Filters results associated with a specific portfolio.
        required: false
        schema:
          type: integer
          format: int64
      - name: leaseID
        in: query
        description: Filters results with Lease ID.
        required: false
        schema:
          type: integer
          format: int64
      - name: status
        in: query
        description: Filters results to with Lease Status.
        required: false
        schema:
          type: string
      - name: glAccountID
        in: query
        description: Filters results with GLAccount ID.
        required: false
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: OK
          headers:
            X-Total-Count:
              description: The total resultset count
              schema:
                type: integer
                format: int64
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Payment'
        '400':
          description: Unable to process the request due to malformed request syntax or invalid parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: The API key couldn't be authorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: The supplied credentials don't have permissions to access the resources.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    post:
      tags:
      - Leases
      summary: Create a lease payment (BETA)
      description: '<p class="betaError"><b>Note: </b>Write access is only available to customers who have opted in to our beta program. Please reach out to support if you''d like to be included.</p>

        Creates a lease payment.<br/><br/><b>Required permission:</b><br/><span class="permissionBlock">LEASES</span> - <code>Write</code>

        '
      operationId: createLeasePayment
      requestBody:
        $ref: '#/components/requestBodies/SavePayment'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Payment'
        '400':
          description: Unable to process the request due to malformed request syntax or invalid parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: The API key couldn't be authorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: The supplied credentials don't have permissions to access the resources.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /leases/payments/{entityID}:
    put:
      tags:
      - Leases
      summary: Update a lease payment (BETA)
      description: '<p class="betaError"><b>Note: </b>Write access is only available to customers who have opted in to our beta program. Please reach out to support if you''d like to be included.</p>

        Updates a lease payment.<br/><br/><b>Required permission:</b><br/><span class="permissionBlock">LEASES</span> - <code>Write</code>

        '
      operationId: updateLeasePayment
      parameters:
      - name: entityID
        in: path
        description: Lease Payment ID
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        $ref: '#/components/requestBodies/SavePayment'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Payment'
        '400':
          description: Unable to process the request due to malformed request syntax or invalid parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: The API key couldn't be authorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: The supplied credentials don't have permissions to access the resources.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Entity not found.
  /leases/refunds:
    get:
      tags:
      - Leases
      summary: Retrieve all the tenant refunds
      description: 'Retrieves a list of tenant refunds.<br/><br/><b>Required permission:</b><br/><span class="permissionBlock">LEASES</span> - <code>Read</code>

        <br/><br/><b>Sortable by:</b> <code>leaseid</code>, <code>postdate</code>, <code>createddate</code>, <code>lastmodifieddatetime</code>, <code>id</code>'
      operationId: getLeaseRefunds
      parameters:
      - name: offset
        in: query
        description: '`offset` indicates the position of the first record to return. The offset is zero-based and the default is 0.'
        required: false
        schema:
          type: integer
          format: int32
      - name: limit
        in: query
        description: '`limit` indicates the maximum number of results to be returned in the response. `limit` can range between 1 and 500 and the default is 100.'
        required: false
        schema:
          type: integer
          format: int32
          default: 100
      - name: lastModifiedDateTimeStart
        in: query
        description: 'Filters results to any item modified on or after the date time specified. '
        required: false
        schema:
          type: string
          format: date-time
      - name: lastModifiedDateTimeEnd
        in: query
        description: 'Filters results to any item modified on or prior to the date time specified. '
        required: false
        schema:
          type: string
          format: date-time
      - name: orderby
        in: query
        description: Indicates the field(s) and direction to sort the results in the response.
        required: false
        schema:
          type: string
      - name: postDateStart
        in: query
        description: Filters results to any transaction with a start date on or after the date specified.
        required: false
        schema:
          type: string
          format: date
      - name: postDateEnd
        in: query
        description: Filters results to any transaction with a start date on or prior to the date specified.
        required: false
        schema:
          type: string
          format: date
      - name: portfolioID
        in: query
        description: Filters results associated with a specific portfolio.
        required: false
        schema:
          type: integer
          format: int64
      - name: leaseID
        in: query
        description: Filters results with Lease ID.
        required: false
        schema:
          type: integer
          format: int64
      - name: status
        in: query
        description: Filters results to with Lease Status.
        required: false
        schema:
          type: string
      - name: glAccountID
        in: query
        description: Filters results with GLAccount ID.
        required: false
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: OK
          headers:
            X-Total-Count:
              description: The total resultset count
              schema:
                type: integer
                format: int64
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Refund'
        '400':
          description: Unable to process the request due to malformed request syntax or invalid parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: The API key couldn't be authorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: The supplied credentials don't have permissions to access the resources.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    post:
      tags:
      - Leases
      summary: Create a lease refund (BETA)
      description: '<p class="betaError"><b>Note: </b>Write access is only available to customers who have opted in to our beta program. Please reach out to support if you''d like to be included.</p>

        Creates a lease refund.<br/><br/><b>Required permission:</b><br/><span class="permissionBlock">LEASES</span> - <code>Write</code>

        '
      operationId: createLeaseRefund
      requestBody:
        $ref: '#/components/requestBodies/SaveRefund'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Refund'
        '400':
          description: Unable to process the request due to malformed request syntax or invalid parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: The API key couldn't be authorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: The supplied credentials don't have permissions to access the resources.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /leases/refunds/{refundID}:
    put:
      tags:
      - Leases
      summary: Update a lease refund (BETA)
      description: '<p class="betaError"><b>Note: </b>Write access is only available to customers who have opted in to our beta program. Please reach out to support if you''d like to be included.</p>

        Update an lease refund.<br/><br/><b>Required permission:</b><br/><span class="permissionBlock">LEASES</span> - <code>Write</code>

        '
      operationId: updateLeaseRefund
      parameters:
      - name: refundID
        in: path
        description: Refund ID
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        $ref: '#/components/requestBodies/SaveRefund'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Refund'
        '400':
          description: Unable to process the request due to malformed request syntax or invalid parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: The API key couldn't be authorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: The supplied credentials don't have permissions to access the resources.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Entity not found.
  /leases/statuses:
    get:
      tags:
      - Leases
      summary: Retrieve all lease statuses (BETA)
      description: '<p class="betaWarning"><b>Note: </b>This operation is still in beta and might be subject to breaking changes. Production integrations should be avoided at this stage.</p>

        Retrieves a list of all lease statuses<br/><br/><b>Required permission:</b><br/><span class="permissionBlock">LEASES</span> - <code>Read</code>

        '
      operationId: getAllLeaseStatuses
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/LeaseStatus'
        '400':
          description: Unable to process the request due to malformed request syntax or invalid parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: The API key couldn't be authorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: The supplied credentials don't have permissions to access the resources.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Entity not found.
  /leases/{leaseID}:
    delete:
      tags:
      - Leases
      summary: Delete a lease (BETA)
      description: '<p class="betaError"><b>Note: </b>Write access is only available to customers who have opted in to our beta program. Please reach out to support if you''d like to be included.</p>

        Deletes a lease<br/><br/><b>Required permission:</b><br/><span class="permissionBlock">LEASES</span> - <code>Delete</code>

        '
      operationId: deleteLease
      parameters:
      - name: leaseID
        in: path
        description: Lease ID
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '204':
          description: No Content
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ResponseEntity'
        '400':
          description: Unable to process the request due to malformed request syntax or invalid parameters.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: The API key couldn't be authorized.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: The supplied credentials don't have permissions to access the resources.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Entity not found.
  /leases/{leaseID}/conversations:
    get:
      tags:
      - Leases
      summary: Retrieve all lease conversations
      description: 'Retrieves all the conversations of a lease.<br/><br/><b>Required permission:</b><br/><span class="permissionBlock">LEASES</span> - <code>Read</code>

        <br/><br/><b>Sortable by:</b> <code>createddate</code>, <code>lastmodifieddatetime</code>, <code>id</code>'
      operationId: getLeaseConversations
      parameters:
      - name: leaseID
        in: path
        description: Lease ID
        required: true
        schema:
          type: integer
          format: int64
      - name: offset
        in: query
        description: '`offset` indicates the position of the first record to return. The offset is zero-based and the default is 0.'
        required: false
        schema:
          type: integer
          format: int32
      - name: limit
        in: query
        description: '`limit` indicates the maximum number of results to be returned in the response. `limit` can range between 1 and 500 and the default is 100.'
        required: false
        schema:
          type: integer
          format: int32
          default: 100
      - name: lastModifiedDateTimeStart
        in: query
        description: 'Filters results to any item modified on or after the date time specified. '
        required: false
        schema:
          type: string
          format: date-time
      - name: lastModifiedDateTimeEnd
        in: query
        description: 'Filters results to any item modified on or prior to the date time specified. '
        required: false
        schema:
          type: string
          format: date-time
      - name: orderby
        in: query
        description: Indicates the field(s) and direction to sort the results in the response.
        required: false
        schema:
          type: string
      - name: type
        in: query
        description: Filters results by the conversation type.
        required: false
        schema:
          type: string
          enum:
          - MANAGEMENT_TEAM
          - OWNER
          - TENANT
      responses:
        '200':
          description: OK
          headers:
            X-Total-Count:
              description: The total resultset count
              schema:
                type: integer
                format: int64
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Conversation'
        '400':
          description: Unable to process the request due to malformed request syntax or invalid parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: The API key couldn't be authorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: The supplied credentials don't have permissions to access the resources.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Entity not found.
    post:
      tags:
      - Leases
      summary: Create a lease conversation
      description: 'Creates a specific lease conversation.<br/><br/><b>Required permission:</b><br/><span class="permissionBlock">LEASES</span> - <code>Write</code>

        '
      operationId: createLeaseConversation
      parameters:
      - name: leaseID
        in: path
        description: Lease ID
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        $ref: '#/components/requestBodies/SaveConversation'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Conversation'
        '400':
          description: Unable to process the request due to malformed request syntax or invalid parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: The API key couldn't be authorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: The supplied credentials don't have permissions to access the resources.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Entity not found.
  /leases/{leaseID}/conversations/{conversationID}:
    get:
      tags:
      - Leases
      summary: Retrieve a lease conversation
      description: 'Retrieves a specific lease conversation.<br/><br/><b>Required permission:</b><br/><span class="permissionBlock">LEASES</span> - <code>Read</code>

        '
      operationId: getLeaseConversation
      parameters:
      - name: leaseID
        in: path
        description: Lease ID
        required: true
        schema:
          type: integer
          format: int64
      - name: conversationID
        in: path
        description: Conversation ID
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Conversation'
        '400':
          description: Unable to process the request due to malformed request syntax or invalid parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: The API key couldn't be authorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: The supplied credentials don't have permissions to access the resources.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Entity not found.
    delete:
      tags:
      - Leases
      summary: Delete a lease conversation (BETA)
      description: '<p class="betaError"><b>Note: </b>Write access is only available to customers who have opted in to our beta program. Please reach out to support if you''d like to be included.</p>

        Deletes a specific lease conversation.<br/><br/><b>Required permission:</b><br/><span class="permissionBlock">LEASES</span> - <code>Delete</code>

        '
      operationId: deleteLeaseConversation
      parameters:
      - name: leaseID
        in: path
        description: Lease ID
        required: true
        schema:
          type: integer
          format: int64
      - name: conversationID
        in: path
        description: Conversation ID
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '204':
          description: No Content
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseEntity'
        '400':
          description: Unable to process the request due to malformed request syntax or invalid parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: The API key couldn't be authorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: The supplied credentials don't have permissions to access the resources.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Entity not found.
  /leases/{leaseID}/conversations/{conversationID}/comments:
    post:
      tags:
      - Leases
      summary: Add comment to a lease conversation
      description: 'Adds comment to a lease conversation.<br/><br/><b>Required permission:</b><br/><span class="permissionBlock">LEASES</span> - <code>Write</code>

        '
      operationId: addCommentToLeaseConversation
      parameters:
      - name: leaseID
        in: path
        description: Lease ID
        required: true
        schema:
          type: integer
          format: int64
      - name: conversationID
        in: path
        description: Conversation ID
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        $ref: '#/components/requestBodies/SaveComment'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Comment'
        '400':
          description: Unable to process the request due to malformed request syntax or invalid parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: The API key couldn't be authorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: The supplied credentials don't have permissions to access the resources.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Entity not found.
  /leases/{leaseId}:
    get:
      tags:
      - Leases
      summary: Retrieve a lease
      description: 'Retrieves a specific lease.<br/><br/><b>Required permission:</b><br/><span class="permissionBlock">LEASES</span> - <code>Read</code>

        '
      operationId: getLease
      parameters:
      - name: leaseId
        in: path
        description: Lease ID
        required: true
        schema:
          type: integer
          format: int64
      - name: includeCustomFields
        in: query
        description: includeCustomFields
        required: false
        schema:
          type: boolean
          default: true
      - name: includeOtherBalances
        in: query
        description: includeOtherBalances
        required: false
        schema:
          type: boolean
          default: false
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Lease'
        '400':
          description: Unable to process the request due to malformed request syntax or invalid parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: The API key couldn't be authorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: The supplied credentials don't have permissions to access the resources.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Entity not found.
    put:
      tags:
      - Leases
      summary: Update a lease
      description: 'Updates an existing lease.<br/><br/><b>Required permission:</b><br/><span class="permissionBlock">LEASES</span> - <code>Write</code>

        '
      operationId: updateLeaseUsingPUT_1
      parameters:
      - name: leaseId
        in: path
        description: Lease ID
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SaveLease'
        description: lease
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Lease'
        '400':
          description: Unable to process the request due to malformed request syntax or invalid parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: The API key couldn't be authorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: The supplied credentials don't have permissions to access the resources.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Entity not found.
  /leases/{leaseId}/autocharges:
    get:
      tags:
      - Leases
      summary: Retrieve all lease auto charges
      description: 'Retrieves all the auto charges of a lease.<br/><br/><b>Required permission:</b><br/><span class="permissionBlock">LEASES</span> - <code>Read</code>

        '
      operationId: getLeaseAutoChargesUsingGET_1
      parameters:
      - name: leaseId
        in: path
        description: Lease ID
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Charge'
        '400':
          description: Unable to process the request due to malformed request syntax or invalid parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: The API key couldn't be authorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: The supplied credentials don't have permissions to access the resources.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Entity not found.
  /leases/{leaseId}/autoepayments:
    get:
      tags:
      - Leases
      summary: Retrieve all lease auto ePayments (BETA)
      description: '<p class="betaWarning"><b>Note: </b>This operation is still in beta and might be subject to breaking changes. Production integrations should be avoided at this stage.</p>

        Retrieves all the auto ePayments of a lease.<br/><br/><b>Required permission:</b><br/><span class="permissionBlock">LEASES</span> - <code>Read</code>

        '
      operationId: getLeaseAutoEPayments
      parameters:
      - name: leaseId
        in: path
        description: Lease ID
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AutoPayment'
        '400':
          description: Unable to process the request due to malformed request syntax or invalid parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: The API key couldn't be authorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: The supplied credentials don't have permissions to access the resources.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Entity not found.
  /leases/{leaseId}/autojournalentries:
    get:
      tags:
      - Leases
      summary: Retrieve all lease auto journal entries (BETA)
      description: '<p class="betaWarning"><b>Note: </b>This operation is still in beta and might be subject to breaking changes. Production integrations should be avoided at this stage.</p>

        Retrieves all the auto journal entries of a lease.<br/><br/><b>Required permission:</b><br/><span class="permissionBlock">LEASES</span> - <code>Read</code>

        '
      operationId: getLeaseAutoJournalEntries
      parameters:
      - name: leaseId
        in: path
        description: Lease ID
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AutoJournalEntry'
        '400':
          description: Unable to process the request due to malformed request syntax or invalid parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: The API key couldn't be authorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: The supplied credentials don't have permissions to access the resources.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Entity not found.
  /leases/{leaseId}/contacts:
    get:
      tags:
      - Leases
      summary: Retrieve all lease contacts
      description: 'Retrieves all the contacts of a lease.<br/><br/><b>Required permission:</b><br/><span class="permissionBlock">LEASES</span> - <code>Read</code>

        '
      operationId: getLeaseContacts
      parameters:
      - name: leaseId
        in: path
        description: Lease ID
        required: true
        schema:
          type: integer
          format: int64
      - name: includeCustomFields
        in: query
        description: includeCustomFields
        required: false
        schema:
          type: boolean
          default: false
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ContactExtension'
        '400':
          description: Unable to process the request due to malformed request syntax or invalid parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: The API key couldn't be authorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: The supplied credentials don't have permissions to access the resources.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Entity not found.
  /leases/{leaseId}/customfields:
    get:
      tags:
      - Leases
      summary: Retrieve all lease custom fields
      description: 'Retrieves all the custom fields of a lease.<br/><br/><b>Required permission:</b><br/><span class="permissionBlock">LEASES</span> - <code>Read</code>

        '
      operationId: getLeaseCustomFields
      parameters:
      - name: leaseId
        in: path
        description: Lease ID
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CustomField'
        '400':
          description: Unable to process the request due to malformed request syntax or invalid parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: The API key couldn't be authorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: The supplied credentials don't have permissions to access the resources.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Entity not found.
  /leases/{leaseId}/document:
    get:
      tags:
      - Leases
      summary: Retrieve all lease documents
      description: 'Retrieves all the documents of a lease.<br/><br/><b>Required permission:</b><br/><span class="permissionBlock">LEASES</span> - <code>Read</code>

        '
      operationId: getLeaseDocuments
      parameters:
      - name: leaseId
        in: path
        description: Lease ID
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Document'
        '400':
          description: Unable to process the request due to malformed request syntax or invalid parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: The API key couldn't be authorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: The supplied credentials don't have permissions to access the resources.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Entity not found.
  /leases/{leaseId}/latefeerule:
    get:
      tags:
      - Leases
      summary: Retrieve the lease late fee rule
      description: 'Retrieves the lease late fee rule.<br/><br/><b>Required permission:</b><br/><span class="permissionBlock">LEASES</span> - <code>Read</code>

        '
      operationId: getLeaseLateFee
      parameters:
      - name: leaseId
        in: path
        description: Lease ID
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LateFeeRule'
        '400':
          description: Unable to process the request due to malformed request syntax or invalid parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: The API key couldn't be authorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: The supplied credentials don't have permissions to access the resources.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Entity not found.
  /leases/{leaseId}/notes:
    get:
      tags:
      - Leases
      summary: Retrieve all lease notes
      description: 'Retrieves all the notes of a lease.<br/><br/><b>Required permission:</b><br/><span class="permissionBlock">LEASES</span> - <code>Read</code>

        '
      operationId: getLeaseNotes
      parameters:
      - name: leaseId
        in: path
        description: Lease ID
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Note'
        '400':
          description: Unable to process the request due to malformed request syntax or invalid parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: The API key couldn't be authorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: The supplied credentials don't have permissions to access the resources.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Entity not found.
  /leases/{leaseId}/workorders:
    get:
      tags:
      - Leases
      summary: Retrieve all lease work orders
      description: 'Retrieves all the work orders of a lease.<br/><br/><b>Required permission:</b><br/><span class="permissionBlock">LEASES</span> - <code>Read</code>

        '
      operationId: getLeaseWorkOrders
      parameters:
      - name: leaseId
        in: path
        description: Lease ID
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/WorkOrder'
        '400':
          description: Unable to process the request due to malformed request syntax or invalid parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: The API key couldn't be authorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: The supplied credentials don't have permissions to access the resources.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Entity not found.
components:
  schemas:
    ResponseEntity:
      type: object
      properties:
        body:
          type: object
        statusCode:
          type: string
          enum:
          - '100'
          - '101'
          - '102'
          - '103'
          - '200'
          - '201'
          - '202'
          - '203'
          - '204'
          - '205'
          - '206'
          - '207'
          - '208'
          - '226'
          - '300'
          - '301'
          - '302'
          - '303'
          - '304'
          - '305'
          - '307'
          - '308'
          - '400'
          - '401'
          - '402'
          - '403'
          - '404'
          - '405'
          - '406'
          - '407'
          - '408'
          - '409'
          - '410'
          - '411'
          - '412'
          - '413'
          - '414'
          - '415'
          - '416'
          - '417'
          - '418'
          - '419'
          - '420'
          - '421'
          - '422'
          - '423'
          - '424'
          - '426'
          - '428'
          - '429'
          - '431'
          - '500'
          - '501'
          - '502'
          - '503'
          - '504'
          - '505'
          - '506'
          - '507'
          - '508'
          - '509'
          - '510'
          - '511'
    LineItem:
      type: object
      properties:
        buildingID:
          type: integer
          format: int64
          description: Id of the building associated with this entry.
        credit:
          type: number
          format: double
          description: Credit amount.
        debit:
          type: number
          format: double
          description: Debit amount.
        glAccountID:
          type: integer
          format: int64
          description: Id of the general ledger account associated with this entry.
        id:
          type: integer
          format: int64
          description: Unique identifier.
        portfolioID:
          type: integer
          format: int64
          description: Id of the portfolio associated with this entry.
        unitID:
          type: integer
          format: int64
          description: Id of the unit associated with this entry.
      description: Payment line items
    SaveConversation:
      type: object
      required:
      - text
      - type
      properties:
        text:
          type: string
          description: Comment text.
        type:
          type: string
          description: Conversation type.
          enum:
          - MANAGEMENT_TEAM
          - OWNER
          - TENANT
      description: Conversation for Request
    LateFeeRule:
      type: object
      properties:
        dueDay:
          type: integer
          format: int32
          description: Fee due day.
        feeType:
          type: string
          description: Late fee type.
        id:
          type: integer
          format: int64
          description: Unique identifier.
        minimumDue:
          type: number
          format: double
          description: Minimum amount due to trigger the late fee process.
        summary:
          type: string
          description: Textual description of the late fee calculation.
    SaveLeaseJournalEntry:
      type: object
      required:
      - comments
      - date
      - leaseID
      properties:
        comments:
          type: string
          description: Comments.
        date:
          type: string
          format: date
          description: Journal entry date.
        journalEntrySplit:
          type: array
          description: Journal Entry Splits.
          items:
            $ref: '#/components/schemas/SaveJournalEntrySplit'
        leaseID:
          type: integer
          format: int64
          description: Lease id to apply journal entry.
        refNo:
          type: string
          description: Journal entry reference number.
      description: Lease Journal Entry for Request
    Collection_long_:
      type: object
    RESTAPIBulkSuccessResponse:
      type: object
      properties:
        id:
          type: integer
          format: int64
    Document:
      type: object
      properties:
        createdBy:
          type: string
          description: User who created the record.
        createdDateTime:
          type: string
          format: date-time
          description: 'Date and time the record was created. (Timezone: UTC)'
        description:
          type: string
          description: Description of a document.
        entityId:
          type: integer
          format: int64
          description: Unique identifier of an entity document is attached to.
        entityType:
          type: string
          description: Type of an entity document is attached to.
          enum:
          - APPOINTMENT
          - ASSET
          - BILL
          - BANK_DEPOSIT
          - BILL_PAYMENT
          - BUILDING
          - CONTACT
          - FLOOR_PLAN
          - DESKTOP
          - EMAIL_TEMPLATE
          - INSPECTION
          - LEASE
          - OTHER
          - PORTFOLIO
          - PROSPECT
          - RECONCILIATION
          - TASK
          - TRANSACTION
          - UNIT
          - VENDOR
          - WORK_ORDER
        fileName:
          type: string
          description: File name.
        fileType:
          type: string
          description: File type.
        id:
          type: integer
          format: int64
          description: Unique identifier.
        lastModifiedBy:
          type: string
          description: User who last modified the record.
        lastModifiedDateTime:
          type: string
          format: date-time
          description: 'Date and time the record was last modified. (Timezone: UTC)'
        publishToOwnerPortal:
          type: boolean
          example: false
          description: Indicates if the document is published to the owner portal.
        publishToTenantPortal:
          type: boolean
          example: false
          description: Indicates if the document is published to the tenant portal.
    BasicVendor:
      type: object
      properties:
        address:
          type: string
          description: Address.
        createdBy:
          type: string
          description: User who created the record.
        createdDateTime:
          type: string
          format: date-time
          description: 'Date and time the record was created. (Timezone: UTC)'
        customFields:
          type: array
          description: Custom fields.
          items:
            $ref: '#/components/schemas/CustomField'
        email:
          type: string
          description: Email address.
        fax:
          type: string
          description: Fax number.
        id:
          type: integer
          format: int64
          description: Unique identifier.
        lastModifiedBy:
          type: string
          description: User who last modified the record.
        lastModifiedDateTime:
          type: string
          format: date-time
          description: 'Date and time the record was last modified. (Timezone: UTC)'
        name:
          type: string
          description: Name.
        otherPhone:
          type: string
          description: Other phone number.
        phone:
          type: string
          description: Phone number.
    RESTAPIBulkErrorResponse:
      type: object
      properties:
        error:
          type: array
          items:
            $ref: '#/components/schemas/RESTAPIError'
        index:
          type: integer
          format: int32
        success:
          type: boolean
    Discount:
      type: object
      required:
      - amount
      - date
      properties:
        amount:
          type: number
          format: double
          description: Amount.
        comments:
          type: string
          description: Comments.
        createdBy:
          type: string
          description: User who created the record.
        createdDateTime:
          type: string
          format: date-time
          description: 'Date and time the record was created. (Timezone: UTC)'
        date:
          type: string
          format: date
          description: Post date.
        glAccountID:
          type: integer
          format: int64
          description: Id of the general ledger account associated with this discount.
        id:
          type: integer
          format: int64
          description: Unique identifier.
        lastModifiedBy:
          type: string
          description: User who last modified the record.
        lastModifiedDateTime:
          type: string
          format: date-time
          description: 'Date and time the record was last modified. (Timezone: UTC)'
        leaseID:
          type: integer
          format: int64
          description: Id of the lease associated with this discount.
        portfolioID:
          type: integer
          format: int64
          description: Id of the portfolio associated with this transaction.
        refNo:
          type: string
          description: Reference number.
      description: Discount
    SaveDiscount:
      type: object
      required:
      - amount
      - date
      - discountAccountID
      - leaseID
      properties:
        amount:
          type: number
          format: double
          description: Amount, should be negative.
        comments:
          type: string
          description: Comments.
        date:
          type: string
          format: date
          description: Date.
        discountAccountID:
          type: integer
          format: int64
          description: Discount GL Account ID.
        leaseID:
          type: integer
          format: int64
          description: Id of the lease associated with this discount.
        refNo:
          type: string
          description: Ref No.
      description: Discount for Request
    SaveComment:
      type: object
      required:
      - text
      properties:
        text:
          type: string
          description: Comment text.
      description: Comment for Request
    CreditMemo:
      type: object
      required:
      - amount
      - date
      properties:
        amount:
          type: number
          format: double
          description: Amount.
        comments:
          type: string
          description: Comments
        createdBy:
          type: string
          description: User who created the record.
        createdDateTime:
          type: string
          format: date-time
          description: 'Date and time the record was created. (Timezone: UTC)'
        date:
          type: string
          format: date
          description: Post date.
        glAccountID:
          type: integer
          format: int64
          description: Id of the general ledger account associated with this credit memo.
        id:
          type: integer
          format: int64
          description: Unique identifier.
        lastModifiedBy:
          type: string
          description: User who last modified the record.
        lastModifiedDateTime:
          type: string
          format: date-time
          description: 'Date and time the record was last modified. (Timezone: UTC)'
        leaseID:
          type: integer
          format: int64
          description: Id of the lease associated with this credit memo.
        parentTxID:
          type: integer
          format: int64
          description: Id of the payment causing this prepay application.
        portfolioID:
          type: integer
          format: int64
          description: Id of the portfolio associated with this credit memo.
        refNo:
          type: string
          description: Reference number.
      description: Transaction
    UpdateLeaseJournalEntry:
      type: object
      required:
      - comments
      - date
      - leaseID
      properties:
        comments:
          type: string
          description: Comments.
        date:
          type: string
          format: date
          description: Journal entry date.
        journalEntrySplit:
          type: array
          description: Journal Entry Splits.
          items:
            $ref: '#/components/schemas/JournalEntrySplit'
        leaseID:
          type: integer
          format: int64
          description: Lease id to apply journal entry.
        refNo:
          type: string
          description: Journal entry reference number.
      description: Update Lease Journal Entry
    JournalEntrySplit:
      type: object
      required:
      - creditAmount
      - debitAmount
      - glAccountID
      properties:
        creditAmount:
          type: number
          format: double
          description: Credit amount.
        debitAmount:
          type: number
          format: double
          description: Debit amount.
        glAccountID:
          type: integer
          format: int64
          description: Id of the general ledger account associated with this journal entry split.
        id:
          type: integer
          format: int64
          description: Unique identifier.
      description: Journal Entry Split
    Refund:
      type: object
      required:
      - amount
      - date
      properties:
        amount:
          type: number
          format: double
          description: Amount.
        createdBy:
          type: string
          description: User who created the record.
        createdDateTime:
          type: string
          format: date-time
          description: 'Date and time the record was created. (Timezone: UTC)'
        date:
          type: string
          format: date
          description: Post date.
        destinationAccountID:
          type: integer
          format: int64
          description: Id of the bank account to send the refund from.
        glAccountID:
          type: integer
          format: int64
          description: Id of the general ledger account associated with the refund.
        id:
          type: integer
          format: int64
          description: Unique identifier.
        lastModifiedBy:
          type: string
          description: User who last modified the record.
        lastModifiedDateTime:
          type: string
          format: date-time
          description: 'Date and time the record was last modified. (Timezone: UTC)'
        leaseID:
          type: integer
          format: int64
          description: Id of the lease associated with the refund.
        payeePayer:
          type: string
          description: Name of the payee.
        portfolioID:
          type: integer
          format: int64
          description: Id of the portfolio associated with the refund.
        refNo:
          type: string
          description: Reference number.
        toBePrinted:
          type: boolean
          example: false
          description: Indicates if the check is to be printed.
      description: Tenant Refund
    SavePayment:
      type: object
      required:
      - amount
      - contactID
      - date
      - depositDate
      - destinationAccountID
      - leaseID
      - paymentType
      - refNo
      properties:
        amount:
          type: number
          format: double
          description: Amount.
        comments:
          type: string
          description: Comments.
        contactID:
          type: integer
          format: int64
          description: Id of the contact associated with lease payment
        date:
          type: string
          format: date
          description: Post Date.
        depositDate:
          type: string
          format: date
          description: Payment deposit date.
        destinationAccountID:
          type: integer
          format: int64
          description: Bank GL account ID to deposit.
        leaseID:
          type: integer
          format: int64
          description: Id of the lease associated with this payment.
        paymentType:
          type: string
          description: Payment type.
          enum:
          - CHECK
          - CHECK21
          - CASHIERS_CHECK
          - CREDIT_CARD
          - CASH
          - MONEY_ORDER
          - OTHER
          - CLICKPAY
          - SECTION8
          - EPAY
          - ECHECK
          - NACHA
          - RENTMONEY
          - PUBLIC_ASSISTANCE
          - PAYMENT_TYPE_NA
        refNo:
          type: string
          description: Payment reference number
      description: Tenant Payment for Request
    LeaseStatus:
      type: object
      properties:
        defineActive:
          type: boolean
        id:
          type: integer
          format: int64
        orderIndex:
          type: integer
          format: int32
        portalLoginEnabled:
          type: boolean
        readonly:
          type: boolean
        status:
          type: string
      description: Lease Status
    Adjustment:
      type: object
      required:
      - amount
      - date
      properties:
        amount:
          type: number
          format: double
          description: Amount.
        comments:
          type: string
          description: Comments.
        createdBy:
          type: string
          description: User who created the record.
        createdDateTime:
          type: string
          format: date-time
          description: 'Date and time the record was created. (Timezone: UTC)'
        date:
          type: string
          format: date
          description: Post date.
        glAccountID:
          type: integer
          format: int64
          description: Id of the general ledger account associated with this charge.
        id:
          type: integer
          format: int64
          description: Unique identifier.
        lastModifiedBy:
          type: string
          description: User who last modified the record.
        lastModifiedDateTime:
          type: string
          format: date-time
          description: 'Date and time the record was last modified. (Timezone: UTC)'
        leaseID:
          type: integer
          format: int64
          description: Id of the lease associated with this charge.
        portfolioID:
          type: integer
          format: int64
          description: Id of the portfolio associated with this charge.
        refNo:
          type: string
          description: Reference number.
      description: Adjustment
    ErrorResponse:
      type: object
      properties:
        errorCode:
          type: string
        errors:
          type: array
          items:
            $ref: '#/components/schemas/RESTAPIError'
        userMessage:
          type: string
    SaveLease:
      type: object
      required:
      - endDate
      - moveInDate
      - primaryContactID
      - startDate
      - tenantIDs
      - unitID
      properties:
        baseRent:
          type: number
          format: double
          description: Property base rent.
        comments:
          type: string
          description: Comments.
        endDate:
          type: string
          format: date
          description: End date of the lease term.
        leasingFeeAmount:
          type: number
          format: double
          description: Move in leasing fee amount.
        leasingFeeDate:
          type: string
          format: date
          description: Move in leasing fee post date.
        leasingFeeRefNo:
          type: string
          description: Move in leasing fee reference number.
        moveInDate:
          type: string
          format: date
          description: Move In Date.
        moveOutDate:
          type: string
          format: date
          description: Move Out Date.
        noticeGivenDate:
          type: string
          format: date
          description: Day that the tenant(s) turned in a notice to vacate. Used only for Updating a Lease.
        paymentRestriction:
          type: string
          description: Indicates if the lease has any payment types that they are prevented from using. For example, a lease with several bounced checks may be restricted from paying with checks for future payments.</br>Allowed values are <br/>(1) None<br/>(2) No Payment Allowed<br/>(3) One or more values separated by comma - Check/Credit Card/Cash/Cashiers Check/Money Order/Section 8/Public Assistance/EPay/RentMoneyOther
        postFirstCharge:
          type: boolean
          example: false
          description: Indicates how to post first rent charge while move in.
        primaryContactID:
          type: integer
          format: int64
          description: Primary contact ID, Should be one of tenant IDs.
        prorateMonth:
          type: string
          description: Indicates how to post first rent charge while move in.
          enum:
          - DO_NOT_PRORATE
          - FIRST_MONTH_PRORATE
          - SECOND_MONTH_PRORATE
        publicAssistanceProgram:
          type: string
          description: 'Public assistance program. Allowed values are ''None'', ''Section 8'', ''SCRIE'', ''Rent Control'', ''EDEN INC. - Shelter Care Plus'', ''CLC'', ''DHAP'', ''FEMA'', ''Harris County'' etc. '
        reasonForLeaving:
          type: string
          description: 'Reason for vacating the property. Used only for Updating a Lease.<Br> Allowed values: BOUGHT HOUSE, DECEASED, EVICTION, HEALTH, MOVE CITY, PERSONAL, TOO EXPENSIVE, TRANSFER UNIT, UNKNOWN etc.'
        rentAutoCharge:
          $ref: '#/components/schemas/SaveAutoCharge'
        scheduleMoveOutDate:
          type: string
          format: date
          description: Scheduled move out date.
        searchTag:
          type: string
          description: Search tag.
        secDepAmount:
          type: number
          format: double
          description: Move in security deposit amount.
        secDepChargeDate:
          type: string
          format: date
          description: Move in security deposit charge date.
        signedDate:
          type: string
          format: date
          description: Lease signed date.
        startDate:
          type: string
          format: date
          description: Start date of the lease term.
        status:
          type: string
          description: 'Indicates lease status. Allowed values are ''Active'', ''Active - Notice Given'', ''Draft'', ''Eviction'', ''Terminated'' etc. '
        tenantIDs:
          type: array
          description: List of tenant IDs.
          items:
            type: integer
            format: int64
        unitID:
          type: integer
          format: int64
          description: Unit/Building ID associated with this lease.
      description: Lease for Request
    Conversation:
      type: object
      properties:
        comments:
          type: array
          description: List of comments in the conversation.
          items:
            $ref: '#/components/schemas/Comment'
        createdBy:
          type: string
          description: User who created the record.
        createdDateTime:
          type: string
          format: date-time
          description: 'Date and time the record was created. (Timezone: UTC)'
        entityID:
          type: integer
          format: int64
          description: Id of the entity related to this conversation.
        entityType:
          type: string
          description: Type of the entity related to this conversation.
        id:
          type: integer
          format: int64
          description: Unique identifier.
        lastModifiedBy:
          type: string
          description: User who last modified the record.
        lastModifiedDateTime:
          type: string
          format: date-time
          description: 'Date and time the record was last modified. (Timezone: UTC)'
        subject:
          type: string
          description: Conversation subject.
        type:
          type: string
          description: Conversation type.
          enum:
          - MANAGEMENT_TEAM
          - OWNER
          - TENANT
      description: Conversation
    RESTAPIError:
      type: object
      properties:
        key:
          type: string
        message:
          type: string
    Payment:
      type: object
      required:
      - amount
      - date
      properties:
        amount:
          type: number
          format: double
          description: Amount.
        comments:
          type: string
          description: Comments.
        contactID:
          type: integer
          format: int64
          description: Id of the contact associated with this payment.
        createdBy:
          type: string
          description: User who created the record.
        createdDateTime:
          type: string
          format: date-time
          description: 'Date and time the record was created. (Timezone: UTC)'
        date:
          type: string
          format: date
          description: Post date.
        depositDate:
          type: string
          format: date
          description: Date the payment was deposited.
        destinationAccountID:
          type: integer
          format: int64
          description: Id of the bank account where the payment was deposited.
        glAccountID:
          type: integer
          format: int64
          description: General Ledger Account ID.
        id:
          type: integer
          format: int64
          description: Unique identifier.
        isDeposited:
          type: boolean
          example: false
          description: Indicates if the payment has been deposited.
        lastModifiedBy:
          type: string
          description: User who last modified the record.
        lastModifiedDateTime:
          type: string
          format: date-time
          description: 'Date and time the record was last modified. (Timezone: UTC)'
        leaseID:
          type: integer
          format: int64
          description: Id of the lease associated with this payment.
        lines:
          type: array
          description: A collection of payment line items.
          items:
            $ref: '#/components/schemas/LineItem'
        paymentType:
          type: string
          description: Payment type.
          enum:
          - CHECK
          - CHECK21
          - CASHIERS_CHECK
          - CREDIT_CARD
          - CASH
          - MONEY_ORDER
          - OTHER
          - CLICKPAY
          - SECTION8
          - EPAY
          - ECHECK
          - NACHA
          - RENTMONEY
          - PUBLIC_ASSISTANCE
          - PAYMENT_TYPE_NA
        portfolioID:
          type: integer
          format: int64
          description: Id of the portfolio associated with this transaction.
        refNo:
          type: string
          description: Reference number.
        status:
          type: string
          description: Lease status.
      description: Tenant Payment
    SaveAdjustment:
      type: object
      required:
      - amount
      - leaseID
      properties:
        amount:
          type: number
          format: double
          description: Amount, should be negative.
        comments:
          type: string
          description: Comments.
        date:
          type: string
          format: date
          description: Lease Adjustment date.
        leaseID:
          type: integer
          format: int64
          description: Id of the lease associated with the Adjustment.
        refNo:
          type: string
          description: Reference number.
      description: Adjustment for Request
    SaveRefund:
      type: object
      required:
      - amount
      - date
      - destinationAccountID
      - glAccountID
      - leaseID
      properties:
        amount:
          type: number
          format: double
          description: Amount.
        comments:
          type: string
          description: Comments.
        date:
          type: string
          format: date
          description: Post Date.
        destinationAccountID:
          type: integer
          format: int64
          description: Id of the bank account to send the refund from.
        glAccountID:
          type: integer
          format: int64
          description: Id of the general ledger account associated with the refund.
        leaseID:
          type: integer
          format: int64
          description: Id of the lease associated with the refund.
        refNo:
          type: string
          description: Reference number.
        toBePrinted:
          type: boolean
          example: false
          description: Indicates if the check is to be printed.
        toPrimaryTenant:
          type: boolean
          example: false
          description: Indicates if refund is for primary contact only
      description: Refund for Request
    WorkOrder:
      type: object
      properties:
        age:
          type: integer
          format: int64
          description: Number of days that have passed since the work order was created.
        approved:
          type: boolean
          example: false
          description: Indicates if work order is approved.
        approvedDate:
          type: string
          format: date
          description: Work order approved Date.
        assignedVendors:
          type: array
          description: List of vendors attached to the work order.
          items:
            $ref: '#/components/schemas/BasicVendor'
        authorizeEnter:
          type: string
          description: Indicates if the tenant has granted your management staff access to enter his or her buildings and/or units.
          enum:
          - 'NO'
          - ANYTIME
          - SPECIFIEDTIME
        buildingID:
          type: integer
          format: int64
          description: Id of the building associated with this work order.
        category:
          type: string
          description: This classifies the work order into a category.
        completedDate:
          type: string
          format: date
          description: Date on which the work was completed.
        contractNumber:
          type: string
          description: Contract number.
        costEstimate:
          type: number
          format: double
          description: This indicates the estimated cost as entered by a person, the actual cost as determined by the work order bills, and the invoiced amount is the amount the owner will see on his or her statement based on the bill and markup/discount amount.
        createdBy:
          type: string
          description: User who created the record.
        createdDateTime:
          type: string
          format: date-time
          description: 'Date and time the record was created. (Timezone: UTC)'
        customFields:
          type: array
          description: Custom fields.
          items:
            $ref: '#/components/schemas/CustomField'
        dateToEnter:
          type: string
          format: date-time
          description: Authorized date to enter unit.
        description:
          type: string
          description: This is a detailed description of the problem.
        hourEstimate:
          type: number
          format: double
          description: Expected number of hours to complete the work order.
        id:
          type: integer
          format: int64
          description: Unique identifier.
        lastModifiedBy:
          type: string
          description: User who last modified the record.
        lastModifiedDateTime:
          type: string
          format: date-time
          description: 'Date and time the record was last modified. (Timezone: UTC)'
        lease:
          type: string
          description: If the work order is attached to an occupied building or unit, this is the lease name of that lease.
        location:
          type: string
          description: Buildings and/or units associated with this work order.
        maintenanceNotice:
          type: string
          description: Maintenance notice defined for the building that the work order is attached to.
        managedBy:
          type: string
          description: Name of the person who is responsible for managing the work order.
        number:
          type: integer
          format: int32
          description: Number assigned to this work order.
        portfolioID:
          type: integer
          format: int64
          description: Id of the portfolio associated with this work order.
        priority:
          type: string
          description: This identifies the priority of the work order as low, medium, or high.
          enum:
          - HIGH
          - MEDIUM
          - LOW
        publishToOwnerPortal:
          type: boolean
          example: false
          description: Publish To Owner Portal.
        publishToTenantPortal:
          type: boolean
          example: false
          description: Publish To Tenant Portal.
        requestedBy:
          type: string
          description: This identifies the person that reported the problem, typically the tenant or owner associated with the buildings or units.
        requiredMaterials:
          type: string
          description: List of materials required to complete the work order.
        scheduledEndDate:
          type: string
          format: date
          description: Date on which the work is scheduled to be completed.
        searchTag:
          type: string
          description: Search tag name.
        source:
          type: string
          description: This identifies how the problem was reported, such as telephone, in person, email, etc.
        specificLocation:
          type: string
          description: This describes the location in the buildings or units where the work is needed.
        startDate:
          type: string
          format: date
          description: Date on which the work was started.
        status:
          type: string
          description: Current status of the work order.
        type:
          type: string
          description: 'This classifies the work order into one of the following types: general, service request, turnover, inspection, estimate etc.'
        unitID:
          type: integer
          format: int64
          description: Id of the unit associated with this work order.
        unitIDs:
          $ref: '#/components/schemas/Collection_long_'
      description: Work Order
    CustomField:
      type: object
      properties:
        dataType:
          type: string
          description: Data type of the custom field.
        definitionID:
          type: integer
          format: int64
          description: Id of the custom field definition.
        fieldName:
          type: string
          description: Name of the custom field.
        value:
          type: string
          description: Value of the custom field.
      description: Custom field.
    JournalEntrySplitResponse:
      type: object
      required:
      - creditAmount
      - debitAmount
      - glAccountID
      properties:
        creditAmount:
          type: number
          format: double
          description: Credit amount.
        debitAmount:
          type: number
          format: double
          description: Debit amount.
        glAccountID:
          type: integer
          format: int64
          description: Id of the general ledger account associated with this journal entry split.
        id:
          type: integer
          format: int64
          description: Unique identifier.
    Address:
      type: object
      properties:
        address:
          type: string
          description: Primary street and/or unit address.
        addressCont:
          type: string
          description: Address continuation.
        city:
          type: string
          description: City.
        country:
          type: string
          description: Country.
        postalCode:
          type: string
          description: Postal code.
        stateRegion:
          type: string
          description: State/region.
      description: Address
    Note:
      type: object
      properties:
        body:
          type: string
          description: Content of the note.
        createdBy:
          type: string
          description: User who created the record.
        createdDateTime:
          type: string
          format: date-time
          description: 'Date and time the record was created. (Timezone: UTC)'
        date:
          type: string
          format: date
          description: Date the note was created.
        id:
          type: integer
          format: int64
          description: Unique identifier.
        lastModifiedBy:
          type: string
          description: User who last modified the record.
        lastModifiedDateTime:
          type: string
          format: date-time
          description: 'Date and time the record was last modified. (Timezone: UTC)'
        private:
          type: boolean
        subject:
          type: string
          description: Subject.
    JournalEntry:
      type: object
      properties:
        comments:
          type: string
          description: Comments.
        createdBy:
          type: string
          description: User who created the record.
        createdDateTime:
          type: string
          format: date-time
          description: 'Date and time the record was created. (Timezone: UTC)'
        date:
          type: string
          description: Journal entry post date.
        id:
          type: integer
          format: int64
          description: Unique identifier.
        journalEntrySplit:
          type: array
          description: List of journal entry splits.
          items:
            $ref: '#/components/schemas/JournalEntrySplitResponse'
        lastModifiedBy:
          type: string
          description: User who last modified the record.
        lastModifiedDateTime:
          type: string
          format: date-time
          description: 'Date and time the record was last modified. (Timezone: UTC)'
        leaseID:
          type: integer
          format: int64
          description: Id of the lease associated with this journal entry.
        refNo:
          type: string
          description: Journal entry reference number.
      description: Journal Entry
    PaymentCharge:
      type: object
      required:
      - amount
      - chargeAmountPaid
      - date
      - settledDate
      properties:
        accountID:
          type: integer
          format: int64
          description: Id of the bank account where the payment was deposited.
        amount:
          type: number
          format: double
          description: Total payment Amount.
        chargeAmountPaid:
          type: number
          format: double
          description: Amount paid for this charge
        comments:
          type: string
          description: Comments.
        date:
          type: string
          format: date
          description: Payment applied date.
        id:
          type: integer
          format: int64
          description: Payment ID
        payeePayer:
          type: string
          description: Payer name.
        paymentType:
          type: string
          description: Payment type. Electronic payments are only for book keeping.
          enum:
          - CHECK
          - CHECK21
          - CASHIERS_CHECK
          - CREDIT_CARD
          - CASH
          - MONEY_ORDER
          - OTHER
          - CLICKPAY
          - SECTION8
          - EPAY
          - ECHECK
          - NACHA
          - RENTMONEY
          - PUBLIC_ASSISTANCE
          - PAYMENT_TYPE_NA
        receiptNumber:
          type: integer
          format: int64
          description: Payment receipt number.
        refNo:
          type: string
          description: Payment reference number.
        settledDate:
          type: string
          format: date
          description: Payment settlement date.
        status:
          type: string
          description: Charge payment status.
      description: Tenant Payment
    Charge:
      type: object
      required:
      - frequency
      - startDate
      properties:
        amount:
          type: number
          format: double
          description: Auto charge amount.
        createdBy:
          type: string
          description: User who created the record.
        createdDateTime:
          type: string
          format: date-time
          description: 'Date and time the record was created. (Timezone: UTC)'
        description:
          type: string
          description: Description of the auto charge.
        dueDay:
          type: integer
          format: int32
          description: Description of the day when the auto charge is due.
        endDate:
          type: string
          format: date
          description: End date of auto charge.
        frequency:
          type: string
          description: Frequency of the auto charge.
          enum:
          - WEEKLY
          - MONTHLY
          - QUARTERLY
          - SEMIANUUAL
          - ANUUAL
          - ANUUAL_ACCRUAL
        glAccountID:
          type: integer
          format: int64
          description: ID of the General Ledger Account associated to this auto charge.
        id:
          type: integer
          format: int64
          description: Unique identifier.
        lastModifiedBy:
          type: string
          description: User who last modified the record.
        lastModifiedDateTime:
          type: string
          format: date-time
          description: 'Date and time the record was last modified. (Timezone: UTC)'
        lastPostDate:
          type: string
          format: date
          description: Last post date.
        leaseID:
          type: integer
          format: int64
          description: ID of the lease associated to auto charge
        referenceNumber:
          type: string
          description: Reference number.
        startDate:
          type: string
          format: date
          description: Start date of auto charge.
    SaveAutoCharge:
      type: object
      required:
      - amount
      - dueDay
      - frequency
      - glAccountID
      - startDate
      properties:
        amount:
          type: number
          format: double
          description: Auto charge amount.
        description:
          type: string
          description: Description of the auto charge.
        dueDay:
          type: integer
          format: int32
          description: 'Charge due day. Allowed values : For frequency "Weekly" (1 to 7) , for other frequency (1 to 31)'
        endDate:
          type: string
          format: date
          description: Auto charge end date.
        frequency:
          type: string
          description: Charge frequency.
          enum:
          - WEEKLY
          - MONTHLY
          - QUARTERLY
          - SEMIANUUAL
          - ANUUAL
          - ANUUAL_ACCRUAL
        glAccountID:
          type: integer
          format: int64
          description: GL Account ID.
        referenceNumber:
          type: string
          description: Reference number.
          minLength: 0
          maxLength: 35
        startDate:
          type: string
          format: date
          description: Auto charge start date.
      description: Auto charge request
    AutoPayment:
      type: object
      properties:
        account:
          type: string
          description: Payment general ledger account.
        amount:
          type: number
          format: double
          description: Payment amount.
        createdBy:
          type: string
          description: User who created the record.
        createdDateTime:
          type: string
          format: date-time
          description: 'Date and time the record was created. (Timezone: UTC)'
        description:
          type: string
          description: Description.
        endDate:
          type: string
          format: date
          description: End date.
        feeAmount:
          type: number
          format: double
          description: Fee amount.
        frequency:
          type: string
          description: Payment frequency.
          enum:
          - WEEKLY
          - MONTHLY
          - QUARTERLY
          - SEMIANNUAL
          - YEARLY
        glAccountID:
          type: integer
          format: int64
          description: Payment general ledger account ID.
        id:
          type: integer
          format: int64
          description: Unique identifier.
        lastModifiedBy:
          type: string
          description: User who last modified the record.
        lastModifiedDateTime:
          type: string
          format: date-time
          description: 'Date and time the record was last modified. (Timezone: UTC)'
        lastPostDate:
          type: string
          format: date
          description: Last post date.
        startDate:
          type: string
          format: date
          description: Start date.
    CustomFieldSet:
      type: object
      required:
      - name
      - value
      properties:
        name:
          type: string
          description: Custom Field name
        value:
          type: string
          description: Custom Field value
      description: Custom field set for Request
    SaveCustomField:
      type: object
      required:
      - entityId
      - fieldSet
      properties:
        entityId:
          type: integer
          format: int64
          description: Unique identifier of an entity custom field associated to.
        fieldSet:
          type: array
          description: List of Custom fields to update
          items:
            $ref: '#/components/schemas/CustomFieldSet'
      description: Custom field for Request
    LeaseClause:
      type: object
      properties:
        description:
          type: string
          description: Description of the clause.
        id:
          type: integer
          format: int64
          description: Unique identifier.
        name:
          type: string
          description: Name of the clause.
    AutoJournalEntry:
      type: object
      properties:
        comments:
          type: string
          description: Comments.
        createdBy:
          type: string
          description: User who created the record.
        createdDateTime:
          type: string
          format: date-time
          description: 'Date and time the record was created. (Timezone: UTC)'
        credit:
          type: string
          description: Credit amount.
        debit:
          type: string
          description: Debit amount.
        endDate:
          type: string
          format: date
          description: End date.
        frequency:
          type: string
          description: Frequency.
          enum:
          - WEEKLY
          - MONTHLY
          - YEARLY
          - MANUALLY
        id:
          type: integer
          format: int64
          description: Unique identifier.
        lastModifiedBy:
          type: string
          description: User who last modified the record.
        lastModifiedDateTime:
          type: string
          format: date-time
          description: 'Date and time the record was last modified. (Timezone: UTC)'
        lastPostDate:
          type: string
          format: date
          description: Last post date.
        name:
          type: string
          description: Auto journal entry name.
        nextPostDate:
          type: string
          format: date
          description: Next post date.
        payDay:
          type: string
          description: Pay day.
        startDate:
          type: string
          format: date
          description: Start date.
    ChargeTx:
      type: object
      required:
      - amount
      - date
      properties:
        amount:
          type: number
          format: double
          description: Amount.
        amountDue:
          type: number
          format: double
          description: The amount due for the charge.
        amountPaid:
          type: number
          format: double
          description: The amount paid for the charge.
        comments:
          type: string
          description: Comments.
        createdBy:
          type: string
          description: User who created the record.
        createdDateTime:
          type: string
          format: date-time
          description: 'Date and time the record was created. (Timezone: UTC)'
        date:
          type: string
          format: date
          description: Post date.
        glAccountID:
          type: integer
          format: int64
          description: Id of the general ledger account associated with this charge.
        id:
          type: integer
          format: int64
          description: Unique identifier.
        lastModifiedBy:
          type: string
          description: User who last modified the record.
        lastModifiedDateTime:
          type: string
          format: date-time
          description: 'Date and time the record was last modified. (Timezone: UTC)'
        leaseID:
          type: integer
          format: int64
          description: Id of the lease associated with this charge.
        parentTxID:
          type: integer
          format: int64
          description: Parent Charge ID. If parent charge date and recharge date are same consider it as a hidden recharge and do not include it in ledger balance calculation.
        payments:
          type: array
          description: List of payment charge history.
          items:
            $ref: '#/components/schemas/PaymentCharge'
        portfolioID:
          type: integer
          format: int64
          description: Id of the portfolio associated with this charge.
        refNo:
          type: string
          description: Reference number.
      description: Charge Transaction
    ContactExtension:
      type: object
      properties:
        address:
          $ref: '#/components/schemas/Address'
        allowESignature:
          type: boolean
          example: false
          description: Indicates if the contact can receive eSignature request e-mail messages sent through Propertyware.
        altEmail:
          type: string
          description: Alternate e-mail address.
        birthDate:
          type: string
          format: date
          description: Date of birth.
        category:
          type: string
          description: Contact category.
        comments:
          type: string
          description: Comments.
        company:
          type: string
          description: Company where the contact is employed.
        createdBy:
          type: string
          description: User who created the record.
        createdDateTime:
          type: string
          format: date-time
          description: 'Date and time the record was created. (Timezone: UTC)'
        customFields:
          type: array
          description: Custom fields.
          items:
            $ref: '#/components/schemas/CustomField'
        email:
          type: string
          description: E-mail address.
        fax:
          type: string
          description: Fax.
        firstName:
          type: string
          description: First name.
        gender:
          type: string
          description: Gender.
          enum:
          - UNKNOWN
          - MALE
          - FEMALE
          - DECLINE_TO_STATE
        homePhone:
          type: string
          description: Home phone.
        id:
          type: integer
          format: int64
          description: Unique identifier.
        jobTitle:
          type: string
          description: Professional title or position for the contact.
        lastModifiedBy:
          type: string
          description: User who last modified the record.
        lastModifiedDateTime:
          type: string
          format: date-time
          description: 'Date and time the record was last modified. (Timezone: UTC)'
        lastName:
          type: string
          description: Last name.
        middleName:
          type: string
          description: Middle name.
        mobilePhone:
          type: string
          description: Mobile phone.
        nameOnCheck:
          type: string
          description: Name on check.
        namedOnLease:
          type: boolean
          example: false
          description: Indicates if contact is named on lease.
        otherPhone:
          type: string
          description: Other phone.
        role:
          type: string
          description: Role.
        salutation:
          type: string
          description: Salutation.
        suffix:
          type: string
          description: Suffix.
        type:
          type: string
          description: Contact type.
          enum:
          - TENANT
          - PROSPECT
          - OWNER
          - VENDOR
          - OTHER
        workPhone:
          type: string
          description: Work phone.
      description: Contact Response
    SaveCharge:
      type: object
      required:
      - amount
      - date
      - glAccountID
      - leaseID
      properties:
        amount:
          type: number
          format: double
          description: Amount.
        comments:
          type: string
          description: Comments.
        date:
          type: string
          format: date
          description: Post Date.
        glAccountID:
          type: integer
          format: int64
          description: GL Account ID.
        leaseID:
          type: integer
          format: int64
          description: Lease ID.
        refNo:
          type: string
          description: Charge reference No.
      description: Charge for Request
    LeaseContact:
      type: object
      properties:
        company:
          type: string
          description: Company where the contact is employed.
        email:
          type: string
          description: E-mail address.
        firstName:
          type: string
          description: First name.
        homePhone:
          type: string
          description: Home phone.
        id:
          type: integer
          format: int64
          description: Unique identifier.
        lastName:
          type: string
          description: Last name.
        mobilePhone:
          type: string
          description: Mobile phone.
        namedOnLease:
          type: boolean
          example: false
          description: Indicates if contact is named on lease.
        primary:
          type: boolean
          example: false
          description: Indicates if contact is primary contact of the lease.
        role:
          type: string
          description: Role.
        workPhone:
          type: string
          description: Work phone.
      description: Contact of the lease
    AutoCharge:
      type: object
      required:
      - charges
      - leaseID
      properties:
        charges:
          type: array
          description: List of Auto charges.
          items:
            $ref: '#/components/schemas/SaveAutoCharge'
        leaseID:
          type: integer
          format: int64
          description: Lease ID.
      description: Auto charge request
    SaveJournalEntrySplit:
      type: object
      required:
      - creditAmount
      - debitAmount
      - glAccountID
      properties:
        creditAmount:
          type: number
          format: double
          description: Credit Amount.
        debitAmount:
          type: number
          format: double
          description: Debit Amount.
        glAccountID:
          type: integer
          format: int64
          description: GL Account ID.
      description: Journal Entry Split for Request
    Lease:
      type: object
      properties:
        active:
          type: boolean
          example: false
          description: Indicates if lease is Active.
        addendums:
          type: array
          description: Lease addendum(s).
          items:
            $ref: '#/components/schemas/LeaseClause'
        arBalance:
          type: number
          format: double
          description: Lease Accounts Receivable Balance
        baseRent:
          type: number
          format: double
          description: Property base rent.
        buildingID:
          type: integer
          format: int64
          description: Id of the building associated with this lease.
        comments:
          type: string
          description: Description of the lease.
        contacts:
          type: array
          description: List of the current tenants on the lease.
          items:
            $ref: '#/components/schemas/LeaseContact'
        createdBy:
          type: string
          description: User who created the record.
        createdDateTime:
          type: string
          format: date-time
          description: 'Date and time the record was created. (Timezone: UTC)'
        customFields:
          type: array
          description: Custom fields.
          items:
            $ref: '#/components/schemas/CustomField'
        endDate:
          type: string
          format: date
          description: End date of the lease term.
        id:
          type: integer
          format: int64
          description: Unique identifier.
        idNumber:
          type: integer
          format: int32
          description: Lease identification number.
        lastModifiedBy:
          type: string
          description: User who last modified the record.
        lastModifiedDateTime:
          type: string
          format: date-time
          description: 'Date and time the record was last modified. (Timezone: UTC)'
        lateFeeRule:
          type: string
          description: Textual description of the late fee rule applied to delinquent or unpaid lease charges.
        leaseBalance:
          type: number
          format: double
          description: Lease Balance.
        leaseName:
          type: string
          description: Lease Name.
        location:
          type: string
          description: Building and/or units the lease is currently attached to.
        moveInDate:
          type: string
          format: date
          description: Day that the tenant(s) moved into the property.
        moveOutDate:
          type: string
          format: date
          description: Day that the tenant(s) vacated the property.
        noticeGivenDate:
          type: string
          format: date
          description: Day that the tenant(s) turned in a notice to vacate.
        paymentRestriction:
          type: string
          description: Indicates if the lease has any payment types that they are prevented from using. For example, a lease with several bounced checks may be restricted from paying with checks for future payments.
        portfolioID:
          type: integer
          format: int64
          description: Id of the portfolio associated with this lease.
        publicAssistanceProgram:
          type: string
          description: Indicates if the tenant(s) of the lease receive any aid from a Public Assistance Program.
        reasonForLeaving:
          type: string
          description: Reason for vacating the property.
        scheduleMoveOutDate:
          type: string
          format: date
          description: Day that the tenant(s) are expected to vacate the property.
        searchTag:
          type: string
          description: Search tag.
        signedDate:
          type: string
          format: date
          description: Lease signed date.
        startDate:
          type: string
          format: date
          description: Start date of the lease term.
        status:
          type: string
          description: Lease's current status.
        tenantsOptsIntoAssetProtectionPlan:
          type: string
          description: Indicates if the tenants opted into Asset Protection Plan.
        terminatedDate:
          type: string
          format: date
          description: Lease Terminated Date.
        unitID:
          type: integer
          format: int64
          description: Id of the unit associated with this lease.
      description: Lease
    Comment:
      type: object
      properties:
        createdBy:
          type: string
          description: User who created the record.
        createdDateTime:
          type: string
          format: date-time
          description: 'Date and time the record was created. (Timezone: UTC)'
        id:
          type: integer
          format: int64
          description: Unique identifier.
        lastModifiedBy:
          type: string
          description: User who last modified the record.
        lastModifiedDateTime:
          type: string
          format: date-time
          description: 'Date and time the record was last modified. (Timezone: UTC)'
        text:
          type: string
          description: Comment text.
      description: Comment
  requestBodies:
    SaveRefund:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SaveRefund'
      description: saveRefund
      required: true
    SaveAdjustment:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SaveAdjustment'
      description: saveAdjustment
      required: true
    SavePayment:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SavePayment'
      description: savePayment
      required: true
    SaveCharge:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SaveCharge'
      description: saveCharge
      required: true
    SaveConversation:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SaveConversation'
      description: saveConversation
      required: true
    SaveDiscount:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SaveDiscount'
      description: saveDiscount
      required: true
    SaveComment:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SaveComment'
      description: saveComment
      required: true
    SaveCustomField:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SaveCustomField'
      description: saveCustomField
      required: true
  securitySchemes:
    clientId:
      type: apiKey
      in: header
      name: x-propertyware-client-id
    clientSecret:
      type: apiKey
      in: header
      name: x-propertyware-client-secret
    organizationId:
      type: apiKey
      in: header
      name: x-propertyware-system-id