propertyware

Propertyware - the Ruby gem for the Open API, powered by Propertyware

Introduction

Welcome to Propertyware’s API—a powerful, RESTful programming interface that lets you leverage valuable Propertyware data.

Account Configuration

Before you can use Propertyware’s API, you’ll need to make some tweaks to your account settings.

Enabling the API

In order to start creating your keys and making requests, you’ll need to enable the API.

Tip: You’ll need an administrator user role with access to Administration Setup > API Keys to set things up properly.

Let's Begin!

Sign in to your Propertyware account from your browser.
Open the Setup page
On the left navigation bar, expand Administration Setup and then click API Keys.

If you are having issues accessing the API keys page within your account you can submit a Support request for assistance.

API Keys

Account-level API keys authenticate every request and keep things secure.

API keys have two components: a “client ID” and a “secret”.

Client IDs are similar to usernames. They’re used to identify your Propertyware API key and are safe to share.
Secrets are similar to passwords. They must be kept confidential.

Whenever 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.

Tip: We compiled a list of best practices that detail how securely store API keys. Give it a read!

Creating API Keys

Now that the Open API is enabled, you’ll be able to create API keys. You’re almost there!

How to create an API key

On the API Keys page, click Create API Key. A modal will appear.

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.
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.
You have successfully created an API key! The client id and secret associated to this key will be presented.

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.

You have now successfully created an API key and have everything you need to send requests to the Propertyware API!

Before moving on to making your first request please review Keeping API Keys Safe for an overview on securely storing your API keys.

If you are having issues creating API keys you can submit a Support request for assistance.

Keeping API Keys Safe

Based 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.

Recommended Practices

Avoid hard-coding client IDs and secrets inside source files.
Avoid storing client IDs and secrets in any files that may be committed to source control, particularly cloud-based source control platforms.
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).
Avoid sharing client IDs and secrets across public, insecure platforms.
Establish a process to regularly recreate your client IDs and secrets from your Propertyware account.

How to Make a Request

You’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!

Tip: Looking for the right HTTP client? If you’re just getting started, we recommend Postman.

Let's Get Started!

Step 1: Get Your API Key

If 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.

Step 2: Install a HTTP client

The Propertyware API supports any standard HTTP client. If you're looking for a user-friendly HTTP client application, we recommend Postman – 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.

Step 3: Make a Sample Request

Let's dive in and make a simple request to get all the Buildings 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.

Open the Postman application.
Open the verb menu and select GET.
Enter the request endpoint in the field next to GET.
- Here’s the endpoint to get all buildings: https://api.propertyware.com/pw/api/rest/v1/buildings.
To authenticate the request, enter your client ID, your secret and your organization iD respectively in these request headers:
- x-propertyware-client-id
- x-propertyware-client-secret
- x-propertyware-system-id (organization id)

The 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.

Your full request should look similar to the image below. <img src="request_example.png" />

Review the parameters of your request on last time. Once finished, click Send.
If successful, you should see a JSON response and a 200 HTTP status code. Congratulations! You've connected to the Propertyware API.

You now have the knowledge required to make requests for any of our resources.

If 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. If you are still having trouble making a request after reviewing these sections please submit a Support request.

API Overview

The 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.

Base URL

The base URL for production environment API requests is: https://api.propertyware.com/pw/api/v1/rest

In 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.

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.

API Versioning

The Propertyware API is version controlled. Versioning ensures backwards-incompatible changes to the API don’t impact any existing integrations.

Propertyware 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:

https://api.propertyware.com/pw/api/rest/v1/leases

Any request submitted without the version in the URL path will result in a 404 error response code.

Releasing Changes to the API

The 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.

We’ll provide advance notice for all API releases–regardless of the type of modifications being made.

Backward-compatible Changes

Backward-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.

It'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.

Adding new API resources and/or endpoints.
Adding new optional request parameters to existing API methods.
Adding new properties to existing API responses and non-required properties for request messages.
Changing property order in existing API responses.

All backward-compatible changes to the API will be documented in the Changelog.

Backwards-incompatible Changes

When 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.

Backwards-incompatible changes include:

Removing a property from a request and/or response message.
Changing the name of a property in a message.
Adding a required parameter to a request message.
Changing existing enumeration values.

New versions of the API will have full reference documentation and an upgrade guide.

Authentication

The Propertyware API uses API key’s client IDs and secrets to authenticate requests.

An organization ID, an API key client ID and secret must be passed in every request header using the following parameters:

x-propertyware-client-id
x-propertyware-client-secret
x-propertyware-system-id

Failing to provide both of them in the request header will cause the API to return a 401 HTTP status code.

Bulk Request Options

All top-level API resources support bulk fetches. For instance, you can retrieve all Portfolios. These resources also allow for filtering criteria. Each resource has descriptions of the filter criteria available.

In addition to filtering, our API gives you the ability to control the returned data’s pagination and the sort order.

Pagination

Endpoints that return result sets allow for pagination using limit and offset request parameters to reduce the amount of data returned.

The 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.

The 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.

The total resultset count is returned in the HTTP Header X-Total-Count

Pagination Example

As 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.

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.

Sorting Results

You can specify the sort order of returned data by assigning properties from the returned object to the orderby parameter in the querystring. For example:

orderby=name

By default, the sort is performed in ascending order. To specify sort order, use "asc" for ascending or "desc" for descending. For example:

orderby=name desc

Additionally, you can sort by multiple properties by comma separating the properties. For example:

orderby=abbreviation asc,name desc

Note: While the orderby parameter is case-sensitive, the properties specified in the orderby value aren't.

Response Codes

The Propertyware API supports standard HTTP status codes.

Response Code	Description
200 OK	Everything worked as expected.
400 Bad Request	The request was unacceptable, often due to missing a required parameter.
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.
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).
404 Not Found	The requested resource doesn't exist.
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.
429 Too Many Requests	Too many requests against the API too quickly. We recommend an exponential backoff of your requests.
500 and above - Server Errors	Something went wrong on Propertyware's end. Review the JSON response message for more details about the error.

API Date Format

For all request and response date fields allowing ISO date format: YYYY-MM-DD (e.g.2019-08-24).
For all request and response dateAndTime fields format is allowing: YYYY-MM-dd'T'HH:mm:ssXXX (e.g.2022-06-28T08:47:13Z).

Support

If you are unable to resolve your issue after reviewing the API documentation our support team can assist you.

Changelog

2024-12-11

New API introduced to add comments to existing task in workorder.
URL : /workorders//{workOrderId}/tasks/{taskId}/comments (POST)
Access Permissions : WorkOrder - Write
New fields "baseYear","baseYearOperatingExpenses","baseYearPropertyInsurance","baseYearPropertyTaxes" are added to Building request/response for Below End Points
- Get Building (Get - /buildings/{buildingID})
- Create Building (Post - /buildings)
- Update Building (Put - /buildings/{buildingID})
- Get All Buildings (Get - /buildings)
New fields "syndicate" ,"moveInDays", "featuredForRent" are added to Building request/response for Below End Points
- Create Building (Post - /buildings)
- moveInDays field must be with in these days given here "1 to 30,45,60,75,90" added validation.

2024-11-13

New fields "reasonForLeaving","noticeGivenDate","paymentRestriction" is added to response of
(1) Create a Lease - POST /leases
(2) Update a Lease - GET /leases/{leaseID}
New field "chargeAmountPaid" is added to lease charges payments entity. indicates the amount paid for current charge.
(1) Get a Lease - GET /leases/charges (charge.payments.chargeAmountPaid)

2024-09-25

New API introduced to close existing workorder.
URL : /workorders/closeworkorder/{workorderID} (PUT)
Access Permissions : WorkOrder - Write
A new fields "managementContractStartDate" and "managementContractEndDate" are added to update Building request/response for below end points
- Update Building ( PUT - buildings/{buildingID} )

2024-09-11

A new field "unitIDs"(Unit ID list associated to a Work Order) is added to response of
(1) Retrieve a Work Order - GET /workorders/{workorderID}
(2) Retrieve All Work Orders - GET /workorders

2024-06-09

A new field "unitID" is added to response of
(1) Retrieve a Work Order - GET /workorders/{workorderID}
(2) Retrieve All Work Orders - GET /workorders
Building and Unit targetDeposit data type changed from double to String and the impacted end points are all POST/GET/PUT.

2024-05-22

API documentation is corrected to show 'file' field in request body for 'Upload a Document' API.

2024-05-12

A new filed "arBalance" is added to Lease response for below end points
- Retrieve a lease ( GET - /leases/{leaseID} - set query parameter "includeOtherBalances = true" to include lease arBalance)
- Retrieve all leases ( GET - /leases )
- Create a lease (POST - /leases)
- Update a lease (PUT - /leases/{leaseID})

2024-04-23

Beta has been removed to facilitate Update an owner draw ( PUT - /accounting/ownerdraws/{drawID} )

2024-04-10

Beta has been removed to facilitate Update a Credit ( PUT - /bills/credit/{creditID} )
Beta has been removed to facilitate Update a Bill ( PUT - /bills/{billId} )
Beta has been removed to facilitate Create word orders in bulk. ( POST - /workorders/bulk )
A new field "amount" is added to Bill response for below end points
- Retrieve a bill ( GET - /bills/{billID} )
- Retrieve all bills ( GET - /bills/ )
- Create a Bill ( POST - /bills/ )
- Update Bill ( PUT - /bills/{billId} )
- Create a Credit ( POST - /bills/credit )
- Update a Credit ( PUT - /bills/credit/{creditID} )
Update a Contact ( PUT - /contacts/{contactID} ) is allowed to update any Contact Type
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.
Few fields from CREATE building are not updating with a POST request. Resolved the issue and impacted fields are targetDeposit, targetRentUnits.
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.
The 'account' field has been removed, and the data type for the 'dueDay' field has been changed from String to Integer in the response for the ( POST - /leases/autocharges ) endpoint.
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.
Work order id validation is implemented for Create Bill, Update Bill, Create Credit, Update Credit APIs.

2024-03-24

New API introduced to update existing workorder custom fields.
URL : /workorders/customfields (PUT)
Access Permissions : WorkOrder - Write
A new field "role" is added to GET lease contacts end point (/leases/{leaseID}/contacts)
A new field "role" is added to "contact" in GET lease end point (/leases/{leaseID})
A new field "role" is added to "contact" in GET All leases end point (/leases)

2024-03-11

New API introduced to update existing contact custom fields.
URL : /contacts/customfields (PUT)
Access Permissions : Contacts - Write
Beta has been removed to facilitate create a bank deposit, create an owner contribution, create an owner draw requests.
New API introduced to update existing portfolio custom fields.
URL : /portfolios/customfields (PUT)
Access Permissions : Portfolio - Write
New API introduced to update existing vendor custom fields.
URL : /vendors/customfields (PUT)
Access Permissions : Vendor - Write
Beta has been removed to facilitate 'Create a bill', 'Create bills in bulk', 'Create a credit' Rest API's.

2024-02-25

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'.
Create/update/Retrieve VendorCheck endpoint change from bills/vendorChecks to bills/vendorChecks.
A new API has been introduced to enable adding multiple automatic charges to leases.
URL : /leases/autocharges (POST)
General ledger GET end point('/accounting/generalledger') is updated to filter only 7 days duration of transactions earlier it is 30 days.
New field added "referenceNumber" in "rentAutoCharge" of create lease request.
New API introduced to update unit custom fields
URL : /units/customfields (PUT)
Access Permissions : Unit - Write
New API introduced to update building custom fields
URL : /buildings/customfields (PUT)
Access Permissions : Building - Write

2024-02-11

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.
New filed "description" is added in General ledger account(accounting/glaccounts - GET & accounting/glaccounts/{glAccountID} - GET) endpoint response.
New field "specificLocation" is added in Workorder create/update request.
New field "requiredMaterials" is added in Workorder create/update request.
New field "publishToTenantPortal" is added in Workorder create/update request.
New field "publishToOwnerPortal" is added in Workorder create/update request.
New field "publishToTenantPortal" is added in Workorder GET response.
New field "publishToOwnerPortal" is added in Workorder GET response.
New API introduced to update lease custom fields
URL : /leases/customfields (PUT)
Access Permissions : Lease - Write (An additional permission is required "Custom Field - write" will be introduced with 2024-02-25 release)
New API introduced to update prospect custom fields
URL : /prospects/customfields (PUT)
Access Permissions : prospect - Write (An additional permission is required "Custom Field - write" will be introduced with 2024-02-25 release)

2024-01-24

Beta has been removed to facilitate WorkOrder task update.
Beta has been removed to facilitate retrieve vendor general ledger account.
New field "source" is added in Workorder create/update request.
Beta has been removed to facilitate Unit update.

2024-01-09

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.
Beta has been removed to facilitate building updates and creation in bulk for Building APi.
"Retrieve all lease journal entries". this is an extension for existing endpoint. leaseID will be part of the request params in new endpoint.
existing url: https://api.propertyware.com/pw/api/rest/v1/leases/journalentries/{leaseID} (Will be discontinued in future once new URL is being used)
New url: https://api.propertyware.com/pw/api/rest/v1/leases/journalentries (leaseID can be sent as a request parameters)
"Retrieve all lease auto charges". this is an extension for existing endpoint. leaseID will be part of the request params in new endpoint.
existing url: https://api.propertyware.com/pw/api/rest/v1/{leaseID}/autocharges (Will be discontinued in future once new URL is being used)
New url: https://api.propertyware.com/pw/api/rest/v1/leases/autocharges (leaseID can be sent as a request parameters)
New field "publishedForRent" is added in Building and Unit responses.
New field "role" is added in prospect contact response.
Beta has been removed to facilitate Contact update.
Allowed GET Lease charges/payments/refunds/creditmemos/adjustments, filtered by "glAccountId"

2023-10-24

Retrieve a General Ledger Account

2023-08-28

Update a document

2023-07-11

Delete a document

2023-07-11

Retrieve all documents
Retrieve a document
Download a document

2023-06-10

Lease contacts are included in Retrieve all leases API response
Lease contacts are included in Retrieve a lease API response

2023-04-24

Bulk Insertion: Prospects
Bulk Insertion: Bill Payments

2023-04-11

Bulk Insertion: Portfolios
Bulk Insertion: Buildings
Bulk Insertion: Units

2023-03-19

Bulk insertion: contacts

2023-03-08

Bulk insertion: bills

2023-01-24

Custom fields in "Get all" endpoints
Prospect creation
Bill removals

2022-10-25

API Read operations for non-financial data

2022-09-21

API Read operations available

This SDK is automatically generated by the OpenAPI Generator project:

API version: 1.0
Package version: 1.3.3
Build package: org.openapitools.codegen.languages.RubyClientCodegen

Installation

Build a gem

To build the Ruby code into a gem:

gem build propertyware.gemspec

Then either install the gem locally:

gem install ./propertyware-1.3.3.gem

(for development, run gem install --dev ./propertyware-1.3.3.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'propertyware', '~> 1.3.3'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:

gem 'propertyware', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'propertyware'

# Setup authorization
Propertyware.configure do |config|
  # Configure API key authorization: organizationId
  config.api_key['organizationId'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['organizationId'] = 'Bearer'
  # Configure faraday connection
  config.configure_faraday_connection { |connection| 'YOUR CONNECTION CONFIG PROC' }

  # Configure API key authorization: clientId
  config.api_key['clientId'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['clientId'] = 'Bearer'
  # Configure faraday connection
  config.configure_faraday_connection { |connection| 'YOUR CONNECTION CONFIG PROC' }

  # Configure API key authorization: clientSecret
  config.api_key['clientSecret'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['clientSecret'] = 'Bearer'
  # Configure faraday connection
  config.configure_faraday_connection { |connection| 'YOUR CONNECTION CONFIG PROC' }
end

api_instance = Propertyware::AccountingApi.new
save_bank_deposit = Propertyware::SaveBankDeposit.new({bank_gl_account_id: 3.56, date_opened: Date.today, list_of_tx_ids: 'list_of_tx_ids_example'}) # SaveBankDeposit | saveBankDeposit

begin
  #Create a bank deposit
  result = api_instance.create_bank_deposit(save_bank_deposit)
  p result
rescue Propertyware::ApiError => e
  puts "Exception when calling AccountingApi->create_bank_deposit: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://api.propertyware.com/pw/api/rest/v1

Class	Method	HTTP request	Description
Propertyware::AccountingApi	create_bank_deposit	POST /accounting/bankdeposits	Create a bank deposit
Propertyware::AccountingApi	create_bill_payments	POST /accounting/glaccounts/bulk	Create general ledger accounts in bulk (BETA)
Propertyware::AccountingApi	create_gl_account	POST /accounting/glaccounts	Create a general ledger account (BETA)
Propertyware::AccountingApi	create_owner_contribution	POST /accounting/ownercontributions	Create an owner contribution
Propertyware::AccountingApi	create_owner_draw	POST /accounting/ownerdraws	Create an owner draw
Propertyware::AccountingApi	delete_bank_deposit	DELETE /accounting/bankdeposits/{bankDepositID}	Delete a Bank Deposit (BETA)
Propertyware::AccountingApi	delete_gl_account	DELETE /accounting/glaccounts/{glAccount}	Delete a general ledger account (BETA)
Propertyware::AccountingApi	delete_owner_contribution	DELETE /accounting/ownercontributions/{ownerContributionID}	Delete Owner Contribution (BETA)
Propertyware::AccountingApi	get_account	GET /accounting/glaccounts/{glAccountID}	Retrieve a general ledger account
Propertyware::AccountingApi	get_accounts	GET /accounting/glaccounts	Retrieve all the general ledger accounts
Propertyware::AccountingApi	get_general_ledger_transactions	GET /accounting/generalledger	Retrieve all general ledger transactions (BETA)
Propertyware::AccountingApi	get_owner_contributions	GET /accounting/ownercontributions	Retrieve all the owner contributions
Propertyware::AccountingApi	get_owner_draws	GET /accounting/ownerdraws	Retrieve all the owner draws
Propertyware::AccountingApi	update_gl_account	PUT /accounting/glaccounts/{glAccountID}	Update a general ledger account (BETA)
Propertyware::AccountingApi	update_owner_draw	PUT /accounting/ownerdraws/{drawID}	Update an owner draw
Propertyware::BillsApi	create_bill	POST /bills	Create a bill
Propertyware::BillsApi	create_bill_payment	POST /bills/payment	Create a Bill Payment (BETA)
Propertyware::BillsApi	create_bill_payments_using_post1	POST /bills/payments/bulk	Create bill payments in bulk (BETA)
Propertyware::BillsApi	create_bills	POST /bills/bulk	Create bills in bulk
Propertyware::BillsApi	create_credit	POST /bills/credit	Create a credit
Propertyware::BillsApi	create_vendor_check	POST /bills/vendorchecks	Create a Vendor check (BETA)
Propertyware::BillsApi	delete_bill	DELETE /bills/{billID}	Delete a Bill (BETA)
Propertyware::BillsApi	get_bill	GET /bills/{billID}	Retrieve a bill
Propertyware::BillsApi	get_bill_payment	GET /bills/payments/{billPaymentID}	Retrieve a bill payment
Propertyware::BillsApi	get_bill_payments	GET /bills/payments	Retrieve all bill payments
Propertyware::BillsApi	get_bills	GET /bills	Retrieve all bills
Propertyware::BillsApi	get_vendor_checks	GET /bills/vendorchecks	Retrieve all Vendor checks (BETA)
Propertyware::BillsApi	update_bill	PUT /bills/{billId}	Update a Bill
Propertyware::BillsApi	update_bill_payment	PUT /bills/payment/{billPaymentID}	Update a Bill Payment (BETA)
Propertyware::BillsApi	update_credit	PUT /bills/credit/{creditID}	Update a Credit
Propertyware::BillsApi	update_vendor_check	PUT /bills/vendorchecks/{vendorCheckID}	Update a Vendor check (BETA)
Propertyware::BuildingsApi	create_building	POST /buildings	Create a building
Propertyware::BuildingsApi	create_contacts	POST /buildings/bulk	Create buildings in bulk
Propertyware::BuildingsApi	delete_building	DELETE /buildings/{buildingID}	Delete a building (BETA)
Propertyware::BuildingsApi	delete_building_conversation	DELETE /buildings/{buildingID}/conversations/{conversationID}	Delete a building conversation (BETA)
Propertyware::BuildingsApi	get_building	GET /buildings/{buildingID}	Retrieve a building
Propertyware::BuildingsApi	get_building_conversation	GET /buildings/{buildingID}/conversations/{conversationID}	Retrieve a building conversation
Propertyware::BuildingsApi	get_building_conversations	GET /buildings/{buildingID}/conversations	Retrieve all building conversations
Propertyware::BuildingsApi	get_building_management_fee	GET /buildings/{buildingID}/managementfees	Retrieves all the management fee rules of a building. (BETA)
Propertyware::BuildingsApi	get_building_managers	GET /buildings/{buildingID}/managers	Retrieves all the property managers of a building
Propertyware::BuildingsApi	get_building_notes	GET /buildings/{buildingID}/notes	Retrieves all the notes of a building.
Propertyware::BuildingsApi	get_buildings	GET /buildings	Retrieve all buildings
Propertyware::BuildingsApi	update_building	PUT /buildings/customfields	Update a building custom fields (BETA)
Propertyware::BuildingsApi	update_building_using_put1	PUT /buildings/{buildingID}	Update a building
Propertyware::ContactsApi	create_contact	POST /contacts	Create a contact
Propertyware::ContactsApi	create_contacts_using_post1	POST /contacts/bulk	Create contacts in bulk
Propertyware::ContactsApi	delete_contact	DELETE /contacts/{contactID}	Delete a contact (BETA)
Propertyware::ContactsApi	delete_contact_conversation	DELETE /contacts/{contactID}/conversations/{conversationID}	Delete a contact conversation (BETA)
Propertyware::ContactsApi	get_contact	GET /contacts/{contactID}	Retrieve a contact
Propertyware::ContactsApi	get_contact_categories	GET /contacts/categories	Retrieve all contact categories
Propertyware::ContactsApi	get_contact_conversation	GET /contacts/{contactID}/conversations/{conversationID}	Retrieve a contact conversation
Propertyware::ContactsApi	get_contact_conversations	GET /contacts/{contactID}/conversations	Retrieve all contact conversations
Propertyware::ContactsApi	get_contacts	GET /contacts	Retrieve all contacts
Propertyware::ContactsApi	update_contact	PUT /contacts/customfields	Update a contact custom fields (BETA)
Propertyware::ContactsApi	update_contact_using_put1	PUT /contacts/{contactID}	Update a contact
Propertyware::CustomFieldDefinitionsApi	retrieve_custom_field_definitions	GET /customfields/{entityType}/definitions	Retrieve list of custom field definitions.
Propertyware::DocumentsApi	delete_document	DELETE /docs/{documentId}	Delete a document (BETA)
Propertyware::DocumentsApi	download_document	GET /docs/{documentId}/download	Download a document
Propertyware::DocumentsApi	retrieve_all_documents	GET /docs	Retrieve all documents
Propertyware::DocumentsApi	retrieve_document	GET /docs/{documentId}	Retrieve a document
Propertyware::DocumentsApi	update_document	PUT /docs/{documentId}	Update a document
Propertyware::DocumentsApi	upload_document	POST /docs	Upload a document
Propertyware::HealthCheckApi	health	GET /health	Health check
Propertyware::InspectionsApi	get_inspection	GET /inspections/{inspectionId}	Retrieve a inspection
Propertyware::InspectionsApi	get_inspections	GET /inspections	Retrieve all inspections
Propertyware::LeasesApi	add_comment_to_lease_conversation	POST /leases/{leaseID}/conversations/{conversationID}/comments	Add comment to a lease conversation
Propertyware::LeasesApi	create_journal_entry	POST /leases/journalentries	Create a lease journal entry (BETA)
Propertyware::LeasesApi	create_lease	POST /leases	Create a lease
Propertyware::LeasesApi	create_lease_adjustment	POST /leases/adjustments	Create a lease adjustment (BETA)
Propertyware::LeasesApi	create_lease_auto_charges	POST /leases/autocharges	Create lease auto charges (BETA)
Propertyware::LeasesApi	create_lease_charge	POST /leases/charges	Create a lease charge (BETA)
Propertyware::LeasesApi	create_lease_charges	POST /leases/charges/bulk	Create lease charges in bulk (BETA)
Propertyware::LeasesApi	create_lease_conversation	POST /leases/{leaseID}/conversations	Create a lease conversation
Propertyware::LeasesApi	create_lease_discount	POST /leases/discounts	Create a lease discount (BETA)
Propertyware::LeasesApi	create_lease_payment	POST /leases/payments	Create a lease payment (BETA)
Propertyware::LeasesApi	create_lease_refund	POST /leases/refunds	Create a lease refund (BETA)
Propertyware::LeasesApi	delete_lease	DELETE /leases/{leaseID}	Delete a lease (BETA)
Propertyware::LeasesApi	delete_lease_charge	DELETE /leases/charges/{chargeID}	Delete a lease charge (BETA)
Propertyware::LeasesApi	delete_lease_conversation	DELETE /leases/{leaseID}/conversations/{conversationID}	Delete a lease conversation (BETA)
Propertyware::LeasesApi	get_all_lease_statuses	GET /leases/statuses	Retrieve all lease statuses (BETA)
Propertyware::LeasesApi	get_lease	GET /leases/{leaseId}	Retrieve a lease
Propertyware::LeasesApi	get_lease_adjustments	GET /leases/adjustments	Retrieve all the adjustments
Propertyware::LeasesApi	get_lease_auto_charges	GET /leases/autocharges	Retrieve all lease auto charges (New)
Propertyware::LeasesApi	get_lease_auto_charges_using_get1	GET /leases/{leaseId}/autocharges	Retrieve all lease auto charges
Propertyware::LeasesApi	get_lease_auto_e_payments	GET /leases/{leaseId}/autoepayments	Retrieve all lease auto ePayments (BETA)
Propertyware::LeasesApi	get_lease_auto_journal_entries	GET /leases/{leaseId}/autojournalentries	Retrieve all lease auto journal entries (BETA)
Propertyware::LeasesApi	get_lease_charges	GET /leases/charges	Retrieve all the lease charges
Propertyware::LeasesApi	get_lease_contacts	GET /leases/{leaseId}/contacts	Retrieve all lease contacts
Propertyware::LeasesApi	get_lease_conversation	GET /leases/{leaseID}/conversations/{conversationID}	Retrieve a lease conversation
Propertyware::LeasesApi	get_lease_conversations	GET /leases/{leaseID}/conversations	Retrieve all lease conversations
Propertyware::LeasesApi	get_lease_credit_memos	GET /leases/creditmemos	Retrieve all the credit memos
Propertyware::LeasesApi	get_lease_custom_fields	GET /leases/{leaseId}/customfields	Retrieve all lease custom fields
Propertyware::LeasesApi	get_lease_discounts	GET /leases/discounts	Retrieve all the lease discounts
Propertyware::LeasesApi	get_lease_documents	GET /leases/{leaseId}/document	Retrieve all lease documents
Propertyware::LeasesApi	get_lease_journal_entry	GET /leases/journalentries/{leaseID}	Retrieve all lease journal entries
Propertyware::LeasesApi	get_lease_journal_entry_using_get1	GET /leases/journalentries	Retrieve all lease journal entries (New)
Propertyware::LeasesApi	get_lease_late_fee	GET /leases/{leaseId}/latefeerule	Retrieve the lease late fee rule
Propertyware::LeasesApi	get_lease_notes	GET /leases/{leaseId}/notes	Retrieve all lease notes
Propertyware::LeasesApi	get_lease_payments	GET /leases/payments	Retrieve all the lease payments
Propertyware::LeasesApi	get_lease_refunds	GET /leases/refunds	Retrieve all the tenant refunds
Propertyware::LeasesApi	get_lease_work_orders	GET /leases/{leaseId}/workorders	Retrieve all lease work orders
Propertyware::LeasesApi	get_leases	GET /leases	Retrieve all leases
Propertyware::LeasesApi	update_lease	PUT /leases/customfields	Update a lease custom fields (BETA)
Propertyware::LeasesApi	update_lease_adjustment	PUT /leases/adjustments/{adjustmentID}	Update a lease adjustment (BETA)
Propertyware::LeasesApi	update_lease_charge	PUT /leases/charges/{chargeID}	Update a lease charge (BETA)
Propertyware::LeasesApi	update_lease_discount	PUT /leases/discounts/{discountID}	Updates a lease Discount (BETA)
Propertyware::LeasesApi	update_lease_journal_entry	PUT /leases/journalentries/{journalentryID}	Update a lease journal entry (BETA)
Propertyware::LeasesApi	update_lease_payment	PUT /leases/payments/{entityID}	Update a lease payment (BETA)
Propertyware::LeasesApi	update_lease_refund	PUT /leases/refunds/{refundID}	Update a lease refund (BETA)
Propertyware::LeasesApi	update_lease_using_put1	PUT /leases/{leaseId}	Update a lease
Propertyware::PortfoliosApi	create_portfolio	POST /portfolios	Create a portfolio
Propertyware::PortfoliosApi	create_portfolios	POST /portfolios/bulk	Create Portfolios in bulk
Propertyware::PortfoliosApi	delete_portfolio_conversation	DELETE /portfolios/{portfolioID}/conversations/{conversationID}	Delete a portfolio conversation (BETA)
Propertyware::PortfoliosApi	get_portfolio	GET /portfolios/{portfolioID}	Retrieve a portfolio
Propertyware::PortfoliosApi	get_portfolio_conversation	GET /portfolios/{portfolioID}/conversations/{conversationID}	Retrieve a portfolio conversation
Propertyware::PortfoliosApi	get_portfolio_conversations	GET /portfolios/{portfolioID}/conversations	Retrieve all portfolio conversations
Propertyware::PortfoliosApi	get_portfolios	GET /portfolios	Retrieve all portfolios
Propertyware::PortfoliosApi	update_portfolio	PUT /portfolios/customfields	Update a portfolio custom fields (BETA)
Propertyware::PortfoliosApi	update_portfolio_using_put1	PUT /portfolios/{portfolioID}	Update a portfolio
Propertyware::ProspectsApi	create_contacts_using_post2	POST /prospects/bulk	Create prospects in bulk
Propertyware::ProspectsApi	create_prospect	POST /prospects	Create a prospect
Propertyware::ProspectsApi	create_prospect_conversation	POST /prospects/{prospectID}/conversations	Create a prospect conversation
Propertyware::ProspectsApi	delete_prospect_conversation	DELETE /prospects/{prospectID}/conversations/{conversationID}	Delete a prospect conversation (BETA)
Propertyware::ProspectsApi	get_prospect	GET /prospects/{prospectID}	Retrieve a prospect
Propertyware::ProspectsApi	get_prospect_campaign	GET /prospects/{prospectID}/campaign	Retrieve prospect campaign
Propertyware::ProspectsApi	get_prospect_conversation	GET /prospects/{prospectID}/conversations/{conversationID}	Retrieve a prospect conversation
Propertyware::ProspectsApi	get_prospect_conversations	GET /prospects/{prospectID}/conversations	Retrieve all prospect conversations
Propertyware::ProspectsApi	get_prospect_statuses	GET /prospects/statuses	Retrieve all prospect statuses
Propertyware::ProspectsApi	get_prospects	GET /prospects	Retrieve all prospects
Propertyware::ProspectsApi	update_lease_using_put2	PUT /prospects/customfields	Update a prospect custom fields (BETA)
Propertyware::UnitsApi	create_unit	POST /units	Create a unit
Propertyware::UnitsApi	create_units	POST /units/bulk	Create units in bulk
Propertyware::UnitsApi	delete_unit	DELETE /units/{unitID}	Delete a unit (BETA)
Propertyware::UnitsApi	delete_unit_conversation	DELETE /units/{unitID}/conversations/{conversationID}	Delete a unit conversation (BETA)
Propertyware::UnitsApi	get_lease_custom_fields_using_get1	GET /units/{unitID}/customFields	Retrieve all unit custom fields
Propertyware::UnitsApi	get_unit	GET /units/{unitID}	Retrieve a unit
Propertyware::UnitsApi	get_unit_conversation	GET /units/{unitID}/conversations/{conversationID}	Retrieve a unit conversation
Propertyware::UnitsApi	get_unit_conversations	GET /units/{unitID}/conversations	Retrieve all unit conversations
Propertyware::UnitsApi	get_units	GET /units	Retrieve all units
Propertyware::UnitsApi	update_unit	PUT /units/customfields	Update a unit custom fields (BETA)
Propertyware::UnitsApi	update_unit_using_put1	PUT /units/{unitID}	Update a unit
Propertyware::VendorsApi	create_vendor	POST /vendors	Create a vendor
Propertyware::VendorsApi	create_vendors	POST /vendors/bulk	Create Vendors in bulk
Propertyware::VendorsApi	get_vendor	GET /vendors/{vendorID}	Retrieve a vendor
Propertyware::VendorsApi	get_vendor_account	GET /vendors/{vendorID}/account	Retrieve vendor GL account
Propertyware::VendorsApi	get_vendor_conversation	GET /vendors/{vendorID}/conversations/{conversationID}	Retrieve a vendor conversation
Propertyware::VendorsApi	get_vendor_conversations	GET /vendors/{vendorID}/conversations	Retrieve all vendor conversations
Propertyware::VendorsApi	get_vendors	GET /vendors	Retrieve all vendors
Propertyware::VendorsApi	update_vendor	PUT /vendors/customfields	Update a vendor custom fields (BETA)
Propertyware::WorkOrdersApi	add_work_order_task_comments	POST /workorders/{workOrderId}/tasks/{taskId}/comments	Add Comments to task for a workOrder
Propertyware::WorkOrdersApi	close_work_order	PUT /workorders/closeworkorder/{workOrderID}	Close a Workorder (BETA)
Propertyware::WorkOrdersApi	create_work_order	POST /workorders	Create a work order
Propertyware::WorkOrdersApi	create_work_order_task	POST /workorders/{workOrderId}/tasks	Create a task to workOrder
Propertyware::WorkOrdersApi	create_work_orders	POST /workorders/bulk	Create work orders in bulk
Propertyware::WorkOrdersApi	delete_work_order	DELETE /workorders/{workOrderID}	Delete a Work Order (BETA)
Propertyware::WorkOrdersApi	delete_work_order_task	DELETE /workorders/{workOrderID}/tasks/{taskID}	Delete a work order task (BETA)
Propertyware::WorkOrdersApi	get_work_order	GET /workorders/{workOrderId}	Retrieve a work order
Propertyware::WorkOrdersApi	get_work_order_task	GET /workorders/{workOrderID}/tasks/{taskID}	Retrieve a work order task
Propertyware::WorkOrdersApi	get_work_order_tasks	GET /workorders/{workOrderId}/tasks	Retrieve all work order tasks
Propertyware::WorkOrdersApi	get_work_orders	GET /workorders	Retrieve all work orders
Propertyware::WorkOrdersApi	update_work_order	PUT /workorders/customfields	Update a workorder custom fields (BETA)
Propertyware::WorkOrdersApi	update_work_order_task	PUT /workorders/{workOrderId}/tasks/{taskId}	Update a task in workOrder

Documentation for Models

Propertyware::Account
Propertyware::Address
Propertyware::Adjustment
Propertyware::Amenity
Propertyware::AutoCharge
Propertyware::AutoJournalEntry
Propertyware::AutoPayment
Propertyware::Bank
Propertyware::BankDeposit
Propertyware::BasicVendor
Propertyware::Bill
Propertyware::BillPaid
Propertyware::BillPay
Propertyware::BillPayment
Propertyware::BillSplit
Propertyware::Building
Propertyware::Campaign
Propertyware::CampaignSource
Propertyware::Charge
Propertyware::ChargeTx
Propertyware::Check
Propertyware::CheckSplit
Propertyware::CloseWorkOrder
Propertyware::Comment
Propertyware::Contact
Propertyware::ContactCategory
Propertyware::ContactExtension
Propertyware::Conversation
Propertyware::CreditCardAccount
Propertyware::CreditMemo
Propertyware::CurrentAsset
Propertyware::CurrentLiability
Propertyware::CustomField
Propertyware::CustomFieldDefinition
Propertyware::CustomFieldSet
Propertyware::Discount
Propertyware::Document
Propertyware::Entry
Propertyware::Equity
Propertyware::ErrorResponse
Propertyware::Expense
Propertyware::ExpenseRecoveryCharge
Propertyware::GLItem
Propertyware::Income
Propertyware::Inspection
Propertyware::InspectionArea
Propertyware::InspectionItem
Propertyware::JournalEntry
Propertyware::JournalEntrySplit
Propertyware::JournalEntrySplitResponse
Propertyware::LateFeeRule
Propertyware::Lease
Propertyware::LeaseClause
Propertyware::LeaseContact
Propertyware::LeaseStatus
Propertyware::LineItem
Propertyware::ManagementFee
Propertyware::ManagementSettings
Propertyware::Marketing
Propertyware::NonCurrentAsset
Propertyware::NonCurrentLiability
Propertyware::NonOperatingExpense
Propertyware::NonOperatingInome
Propertyware::Note
Propertyware::Owner
Propertyware::OwnerContribution
Propertyware::OwnerDraw
Propertyware::Payment
Propertyware::PaymentCharge
Propertyware::Portfolio
Propertyware::PropertyManager
Propertyware::Prospect
Propertyware::ProspectContact
Propertyware::ProspectStatus
Propertyware::RESTAPIBulkErrorResponse
Propertyware::RESTAPIBulkSuccessResponse
Propertyware::RESTAPIError
Propertyware::Refund
Propertyware::ResponseEntity
Propertyware::SaveAccount
Propertyware::SaveAddress
Propertyware::SaveAdjustment
Propertyware::SaveAutoCharge
Propertyware::SaveBankDeposit
Propertyware::SaveBill
Propertyware::SaveBillPayment
Propertyware::SaveBillSplit
Propertyware::SaveBuilding
Propertyware::SaveCharge
Propertyware::SaveCheck
Propertyware::SaveCheckSplit
Propertyware::SaveComment
Propertyware::SaveContact
Propertyware::SaveConversation
Propertyware::SaveCredit
Propertyware::SaveCustomField
Propertyware::SaveDiscount
Propertyware::SaveJournalEntrySplit
Propertyware::SaveLease
Propertyware::SaveLeaseJournalEntry
Propertyware::SaveOwner
Propertyware::SaveOwnerContribution
Propertyware::SaveOwnerDraw
Propertyware::SavePayment
Propertyware::SavePortfolio
Propertyware::SaveProspect
Propertyware::SaveProspectContact
Propertyware::SaveRefund
Propertyware::SaveUnit
Propertyware::SaveVendor
Propertyware::SaveWorkOrder
Propertyware::SaveWorkOrderTask
Propertyware::SplitPaid
Propertyware::SplitPay
Propertyware::Task
Propertyware::TimeCardEntry
Propertyware::Unit
Propertyware::UpdateBuilding
Propertyware::UpdateDocument
Propertyware::UpdateLeaseJournalEntry
Propertyware::Vendor
Propertyware::WorkOrder

Documentation for Authorization

Authentication schemes defined for the API:

clientId

Type: API key
API key parameter name: x-propertyware-client-id
Location: HTTP header

clientSecret

Type: API key
API key parameter name: x-propertyware-client-secret
Location: HTTP header

organizationId

Type: API key
API key parameter name: x-propertyware-system-id
Location: HTTP header

Files

DOCS.md

Latest commit

History

DOCS.md

File metadata and controls

propertyware

Introduction

Account Configuration

Enabling the API

API Keys

Creating API Keys

Keeping API Keys Safe

Recommended Practices

How to Make a Request

Let's Get Started!

Step 1: Get Your API Key

Step 2: Install a HTTP client

Step 3: Make a Sample Request

API Overview

Base URL

API Versioning

Releasing Changes to the API

Backward-compatible Changes

Backwards-incompatible Changes

Authentication

Bulk Request Options

Pagination

Pagination Example

Sorting Results

Response Codes

API Date Format

Support

Changelog

2024-12-11

2024-11-13

2024-09-25

2024-09-11

2024-06-09

2024-05-22

2024-05-12

2024-04-23

2024-04-10

2024-03-24

2024-03-11

2024-02-25

2024-02-11

2024-01-24

2024-01-09

2023-10-24

2023-08-28

2023-07-11

2023-07-11

2023-06-10

2023-04-24

2023-04-11

2023-03-19

2023-03-08

2023-01-24

2022-10-25

2022-09-21

Installation

Build a gem

Install from Git

Include the Ruby code directly

Getting Started

Documentation for API Endpoints

Documentation for Models

Documentation for Authorization

clientId

clientSecret

organizationId