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 Prospects 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: Prospects
  description: Resources providing access to prospects.
paths:
  /prospects:
    get:
      tags:
      - Prospects
      summary: Retrieve all prospects
      description: 'Retrieves a list of prospects.<br/><br/><b>Required permission:</b><br/><span class="permissionBlock">PROSPECTS</span> - <code>Read</code>

        <br/><br/><b>Sortable by:</b> <code>createddate</code>, <code>type</code>, <code>lastmodifieddatetime</code>, <code>status</code>, <code>id</code>'
      operationId: getProspects
      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: status
        in: query
        description: Filters results to prospects with a specific status.
        required: false
        schema:
          type: string
      - name: portfolioID
        in: query
        description: Filters results to prospects associated with a specific portfolio.
        required: false
        schema:
          type: integer
          format: int64
      - name: buildingID
        in: query
        description: Filters results to prospects associated with a specific building.
        required: false
        schema:
          type: integer
          format: int64
      - name: type
        in: query
        description: Filters results to prospects with a specific type.
        required: false
        schema:
          type: string
      - name: includeCustomFields
        in: query
        description: includeCustomFields
        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/Prospect'
        '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:
      - Prospects
      summary: Create a prospect
      description: 'Creates a specific prospect.<br/><br/><b>Required permission:</b><br/><span class="permissionBlock">PROSPECTS</span> - <code>Write</code>

        '
      operationId: createProspect
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SaveProspect'
        description: saveProspect
        required: true
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Prospect'
        '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.
  /prospects/bulk:
    post:
      tags:
      - Prospects
      summary: Create prospects in bulk
      description: 'Creates prospects in bulk.<br/><br/><b>Required permission:</b><br/><span class="permissionBlock">UNITS</span> - <code>Write</code>

        '
      operationId: createContactsUsingPOST_2
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/SaveProspect'
        description: saveProspect
        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'
  /prospects/customfields:
    put:
      tags:
      - Prospects
      summary: Update a prospect 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 prospect custom fields<br/><br/><b>Required permission:</b><br/><span class="permissionBlock">PROSPECTS</span> - <code>Write</code>

        '
      operationId: updateLeaseUsingPUT_2
      requestBody:
        $ref: '#/components/requestBodies/SaveCustomField'
      responses:
        '200':
          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.
  /prospects/statuses:
    get:
      tags:
      - Prospects
      summary: Retrieve all prospect statuses
      description: 'Retrieves a list of all prospect statuses<br/><br/><b>Required permission:</b><br/><span class="permissionBlock">PROSPECTS</span> - <code>Read</code>

        '
      operationId: getProspectStatuses
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ProspectStatus'
        '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.
  /prospects/{prospectID}:
    get:
      tags:
      - Prospects
      summary: Retrieve a prospect
      description: 'Retrieves a specific prospect.<br/><br/><b>Required permission:</b><br/><span class="permissionBlock">PROSPECTS</span> - <code>Read</code>

        '
      operationId: getProspect
      parameters:
      - name: prospectID
        in: path
        description: Prospect ID
        required: true
        schema:
          type: integer
          format: int64
      - name: includeCustomFields
        in: query
        description: includeCustomFields
        required: false
        schema:
          type: boolean
          default: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Prospect'
        '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.
  /prospects/{prospectID}/campaign:
    get:
      tags:
      - Prospects
      summary: Retrieve prospect campaign
      description: 'Retrieves the campaign details of a prospect.<br/><br/><b>Required permission:</b><br/><span class="permissionBlock">PROSPECTS</span> - <code>Read</code>

        '
      operationId: getProspectCampaign
      parameters:
      - name: prospectID
        in: path
        description: Prospect ID
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Campaign'
        '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.
  /prospects/{prospectID}/conversations:
    get:
      tags:
      - Prospects
      summary: Retrieve all prospect conversations
      description: 'Retrieves all the conversations of a prospect.<br/><br/><b>Required permission:</b><br/><span class="permissionBlock">PROSPECTS</span> - <code>Read</code>

        <br/><br/><b>Sortable by:</b> <code>createddate</code>, <code>lastmodifieddatetime</code>, <code>id</code>'
      operationId: getProspectConversations
      parameters:
      - name: prospectID
        in: path
        description: Prospect 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:
      - Prospects
      summary: Create a prospect conversation
      description: 'Creates a specific prospect conversation.<br/><br/><b>Required permission:</b><br/><span class="permissionBlock">PROSPECTS</span> - <code>Write</code>

        '
      operationId: createProspectConversation
      parameters:
      - name: prospectID
        in: path
        description: Prospect 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.
  /prospects/{prospectID}/conversations/{conversationID}:
    get:
      tags:
      - Prospects
      summary: Retrieve a prospect conversation
      description: 'Retrieves a specific prospect conversation.<br/><br/><b>Required permission:</b><br/><span class="permissionBlock">PROSPECTS</span> - <code>Read</code>

        '
      operationId: getProspectConversation
      parameters:
      - name: prospectID
        in: path
        description: Prospect 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:
      - Prospects
      summary: Delete a prospect 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 prospect conversation.<br/><br/><b>Required permission:</b><br/><span class="permissionBlock">PROSPECTS</span> - <code>Delete</code>

        '
      operationId: deleteProspectConversation
      parameters:
      - name: prospectID
        in: path
        description: Prospect 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.
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'
    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
    Prospect:
      type: object
      properties:
        applicationFeePaid:
          type: boolean
          example: false
          description: Indicates if the application fee has been paid by the prospect.
        assigneFullName:
          type: string
          description: Name of the assigned prospect.
        buildingID:
          type: integer
          format: int64
          description: Id of the building associated with the prospect.
        cityDesired:
          type: string
          description: Desired city.
        comments:
          type: string
          description: Indicates if the prospect has any comments.
        contacts:
          type: array
          description: Contacts of the prospect
          items:
            $ref: '#/components/schemas/ProspectContact'
        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)'
        currentHomeType:
          type: string
          description: Current home type.
        currentRentMortgage:
          type: number
          format: double
          description: Current home mortgage.
        customFields:
          type: array
          description: Custom fields.
          items:
            $ref: '#/components/schemas/CustomField'
        hasPets:
          type: boolean
          example: false
          description: Indicates if the prospect has pets.
        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)'
        leaseEndDate:
          type: string
          format: date
          description: Confirmed lease end date.
        leaseStartDate:
          type: string
          format: date
          description: Confirmed lease start date.
        moveInDate:
          type: string
          format: date
          description: Desired move-in date.
        neighborhoodDesired:
          type: string
          description: Desired neighborhood.
        numberBathrooms:
          type: number
          format: double
          description: Number of bathrooms desired by the prospect.
        numberBedrooms:
          type: integer
          format: int32
          description: Number of bedrooms desired by the prospect.
        numberOfPets:
          type: integer
          format: int32
          description: Number of pets.
        petType:
          type: string
          description: Pet type.
        petWeights:
          type: string
          description: Pet weights.
        portfolioID:
          type: integer
          format: int64
          description: Id of the portfolio associated with the prospect.
        preferredContactMethod:
          type: string
          description: Preferred contact method.
        propertyAddress:
          type: string
          description: Address of the property.
        propertyAddress2:
          type: string
          description: Additional address information of the property.
        propertyArea:
          type: number
          format: double
          description: Area of the property.
        propertyAreaUnits:
          type: string
          description: Unit of measurement for the area of the property.
        propertyCity:
          type: string
          description: City of the property.
        propertyCountry:
          type: string
          description: Country of the property.
        propertyNumberBathrooms:
          type: number
          format: double
          description: Number of bathrooms.
        propertyNumberBedrooms:
          type: integer
          format: int32
          description: Number of bedrooms.
        propertyState:
          type: string
          description: State of the property.
        propertyZip:
          type: string
          description: Zip code of the property.
        reasonForMoving:
          type: string
          description: Reason for moving.
        rent:
          type: number
          format: double
          description: Confirmed lease rent.
        rentMax:
          type: number
          format: double
          description: Maximum desired rent.
        rentMin:
          type: number
          format: double
          description: Minimum desired rent.
        securityDeposit:
          type: number
          format: double
          description: Confirmed lease security deposit.
        source:
          type: string
          description: Prospect source.
        stateDesired:
          type: string
          description: Desired state.
        status:
          type: string
          description: Status.
        timeAtCurrentResidence:
          type: string
          description: Time the prospect is living at the current residence.
        type:
          type: string
          description: Prospect type.
        typeOfInquiry:
          type: string
          description: Type of inquiry made by the prospect.
        unitDesired:
          type: string
          description: Desired unit.
        unitID:
          type: integer
          format: int64
          description: Id of the unit associated with the prospect.
        unitTypeDesired:
          type: string
          description: Desired unit type.
        zipDesired:
          type: string
          description: Desired zip code.
      description: Prospect
    RESTAPIBulkSuccessResponse:
      type: object
      properties:
        id:
          type: integer
          format: int64
    RESTAPIBulkErrorResponse:
      type: object
      properties:
        error:
          type: array
          items:
            $ref: '#/components/schemas/RESTAPIError'
        index:
          type: integer
          format: int32
        success:
          type: boolean
    CampaignSource:
      type: object
      properties:
        callTrackingGroupID:
          type: string
          description: Call tracking group id.
        default:
          type: boolean
        id:
          type: integer
          format: int64
          description: Unique identifier.
        name:
          type: string
          description: Name of the campaign source.
        referrerDomain:
          type: string
          description: Referrer domain.
      description: CampaignSource
    ErrorResponse:
      type: object
      properties:
        errorCode:
          type: string
        errors:
          type: array
          items:
            $ref: '#/components/schemas/RESTAPIError'
        userMessage:
          type: string
    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
    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.
    ProspectContact:
      type: object
      properties:
        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.
        role:
          type: string
          description: Role.
        workPhone:
          type: string
          description: Work phone.
      description: Contact of the prospect
    SaveAddress:
      type: object
      required:
      - country
      properties:
        address:
          type: string
          description: Primary street and/or unit address. Required only if country is USA or Canada.
          minLength: 0
          maxLength: 50
        addressCont:
          type: string
          description: Address continuation.
          minLength: 0
          maxLength: 20
        city:
          type: string
          description: City. Required only if Country is United States / Canada.
          minLength: 0
          maxLength: 30
        country:
          type: string
          description: Country. For US addresses, this value should be "United States". For other countries, this should be the full country name (Canada, United Kingdom, ...)
          minLength: 0
          maxLength: 30
        postalCode:
          type: string
          description: Zip. Required only if Country is United States / Canada.
          minLength: 0
          maxLength: 20
        stateRegion:
          type: string
          description: State. Required only if Country is United States / Canada.
          minLength: 0
          maxLength: 20
      description: Address.
    SaveProspectContact:
      type: object
      required:
      - firstName
      - lastName
      properties:
        address:
          $ref: '#/components/schemas/SaveAddress'
        email:
          type: string
          description: ' EMail.'
        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.'
        otherPhone:
          type: string
          description: ' Other Phone.'
        percentageship:
          type: number
          format: double
          description: ship percentage.
        workPhone:
          type: string
          description: ' Work Phone.'
      description: Save Prospect Contact
    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
    SaveProspect:
      type: object
      properties:
        buildingID:
          type: integer
          format: int64
          description: Unique identifier of the building associated with the prospect.
        comments:
          type: string
          description: This is a description of the Prospect.
        contacts:
          type: array
          description: Prospect contacts.
          items:
            $ref: '#/components/schemas/SaveProspectContact'
        currentHomeType:
          type: string
          description: Prospect Current Home Type.
        currentRentMortgage:
          type: number
          format: double
          description: Prospect Current Home Mortgage.
        hasPets:
          type: boolean
          example: false
          description: Prospect Has Pets.
        moveInDate:
          type: string
          format: date
          description: Prospect Move In Date.
        neighborhoodDesired:
          type: string
          description: Prospect Neighborhood Desired.
        numberBathrooms:
          type: number
          format: double
          description: Prospect Number Of Bathrooms.
        numberBedrooms:
          type: integer
          format: int32
          description: Prospect Number Of Bedrooms.
        numberOfPets:
          type: integer
          format: int32
          description: Prospect Number Of Pets.
        petType:
          type: string
          description: Prospect Pet Type.
        petWeights:
          type: string
          description: Prospect Pet Weights.
        preferredContactMethod:
          type: string
          description: Prospect Preferred Contact Method.
        propertyAddress:
          type: string
          description: Property Address.
        propertyAddress2:
          type: string
          description: Property Address Continued.
        propertyCity:
          type: string
          description: Property City.
        propertyCountry:
          type: string
          description: Property Country.
        propertyNumberBathrooms:
          type: number
          format: double
          description: Property Number Of Bath rooms.
        propertyNumberBedrooms:
          type: integer
          format: int32
          description: Property Number Of Bedrooms.
        propertyState:
          type: string
          description: Property State.
        propertyZip:
          type: string
          description: Property Zip.
        reasonForMoving:
          type: string
          description: Prospect Reason For Moving.
        rentMax:
          type: number
          format: double
          description: Prospect Rent Maximum.
        rentMin:
          type: number
          format: double
          description: Prospect Rent Minimum.
        source:
          type: string
          description: Prospect Source.
        status:
          type: string
          description: Prospect Status.
        timeAtCurrentResidence:
          type: string
          description: Prospect Time At Current Residence.
        type:
          type: string
          description: Prospect Type.
        typeOfInquiry:
          type: string
          description: Prospect Type Of Inquiry.
      description: 'Save Prospect '
    Campaign:
      type: object
      properties:
        acceptedCallTrackingTerms:
          type: boolean
          example: false
          description: Indicates if the call tracking terms have been accepted.
        callTrackingCampaignID:
          type: string
          description: Campaign ID used for call tracking.
        callTrackingEnabled:
          type: boolean
          example: false
          description: Indicates if call tracking is enabled for the campaign.
        callTrackingForwar:
          type: string
          description: Number to which call tracking calls are forwarded.
        callTrackingForwarAfterHours:
          type: string
          description: Number to which call tracking calls are forwarded after hours.
        callTrackingPhoneNumber:
          type: string
          description: Phone number used for call tracking.
        callTrackingReferrer:
          type: string
          description: Referrer for call tracking.
        callTrackingSearchPhrase:
          type: string
          description: Search phrase for call tracking.
        campaignSource:
          $ref: '#/components/schemas/CampaignSource'
        code:
          type: string
          description: Code of the campaign.
        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'
        description:
          type: string
          description: Description of the campaign.
        endDate:
          type: string
          format: date
          description: End date of the campaign.
        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 of the campaign.
        startDate:
          type: string
          format: date
          description: Start date of the campaign.
        targetProspectType:
          type: string
          description: Type of the targeted prospect.
        timezone:
          type: string
          description: Time zone of the campaign.
      description: Campaign
    ProspectStatus:
      type: object
      properties:
        id:
          type: integer
          format: int64
          description: Unique identifier.
        readonly:
          type: boolean
          example: false
          description: Read Only
        status:
          type: string
          description: Status
        visibleOnPortal:
          type: boolean
          example: false
          description: Status visible On Portal
      description: Prospect Status
    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:
    SaveConversation:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SaveConversation'
      description: saveConversation
      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