{ "opencollection": "1.0.0", "info": { "name": "Open API, powered by Propertyware Accounting Leases API", "version": "1.0" }, "request": { "auth": { "type": "apikey", "key": "x-propertyware-client-id", "value": "{{x-propertyware-client-id}}", "placement": "header" } }, "items": [ { "info": { "name": "Leases", "type": "folder" }, "items": [ { "info": { "name": "Retrieve all leases", "type": "http" }, "http": { "method": "GET", "url": "https://api.propertyware.com/pw/api/rest/v1/leases", "params": [ { "name": "offset", "value": "", "type": "query", "description": "`offset` indicates the position of the first record to return. The offset is zero-based and the default is 0." }, { "name": "limit", "value": "", "type": "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." }, { "name": "lastModifiedDateTimeStart", "value": "", "type": "query", "description": "Filters results to any item modified on or after the date time specified. " }, { "name": "lastModifiedDateTimeEnd", "value": "", "type": "query", "description": "Filters results to any item modified on or prior to the date time specified. " }, { "name": "orderby", "value": "", "type": "query", "description": "Indicates the field(s) and direction to sort the results in the response." }, { "name": "startDateStart", "value": "", "type": "query", "description": "Filters results to any lease with a start date on or after the date specified." }, { "name": "startDateEnd", "value": "", "type": "query", "description": "Filters results to any lease with a start date on or prior to the date specified." }, { "name": "endDateStart", "value": "", "type": "query", "description": "Filters results to any lease with a end date on or after the date specified." }, { "name": "endDateEnd", "value": "", "type": "query", "description": "Filters results to any lease with a end date on or prior to the date specified." }, { "name": "moveInDateStart", "value": "", "type": "query", "description": "Filters results to any lease with a move-in date on or after the date specified." }, { "name": "moveInDateEnd", "value": "", "type": "query", "description": "Filters results to any lease with a move-in date on or prior to the date specified." }, { "name": "scheduleMoveOutDateStart", "value": "", "type": "query", "description": "Filters results to any lease with a move-out date on or after the date specified." }, { "name": "scheduleMoveOutDateEnd", "value": "", "type": "query", "description": "Filters results to any lease with a move-out date on or prior to the date specified." }, { "name": "portfolioID", "value": "", "type": "query", "description": "Filters results to leases associated with a specific portfolio." }, { "name": "buildingID", "value": "", "type": "query", "description": "Filters results to leases associated with a specific building." }, { "name": "unitID", "value": "", "type": "query", "description": "Filters results to leases associated with a specific unit." }, { "name": "status", "value": "", "type": "query", "description": "Filters results to inspections with a specific status." }, { "name": "includeCustomFields", "value": "", "type": "query", "description": "includeCustomFields" }, { "name": "includeOtherBalances", "value": "", "type": "query", "description": "includeOtherBalances" } ] }, "docs": "Retrieves a list of leases.

Required permission:
LEASES - Read\n

Sortable by: startdate, idnumber, scheduledmoveoutdate, enddate, lastmodifieddatetime, status, moveoutdate, id, moveindate" }, { "info": { "name": "Create a lease", "type": "http" }, "http": { "method": "POST", "url": "https://api.propertyware.com/pw/api/rest/v1/leases", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new lease.

Required permission:
LEASES - Write\n" }, { "info": { "name": "Retrieve all the adjustments", "type": "http" }, "http": { "method": "GET", "url": "https://api.propertyware.com/pw/api/rest/v1/leases/adjustments", "params": [ { "name": "offset", "value": "", "type": "query", "description": "`offset` indicates the position of the first record to return. The offset is zero-based and the default is 0." }, { "name": "limit", "value": "", "type": "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." }, { "name": "lastModifiedDateTimeStart", "value": "", "type": "query", "description": "Filters results to any item modified on or after the date time specified. " }, { "name": "lastModifiedDateTimeEnd", "value": "", "type": "query", "description": "Filters results to any item modified on or prior to the date time specified. " }, { "name": "orderby", "value": "", "type": "query", "description": "Indicates the field(s) and direction to sort the results in the response." }, { "name": "postDateStart", "value": "", "type": "query", "description": "Filters results to any transaction with a start date on or after the date specified." }, { "name": "postDateEnd", "value": "", "type": "query", "description": "Filters results to any transaction with a start date on or prior to the date specified." }, { "name": "portfolioID", "value": "", "type": "query", "description": "Filters results associated with a specific portfolio." }, { "name": "leaseID", "value": "", "type": "query", "description": "Filters results with Lease ID." }, { "name": "status", "value": "", "type": "query", "description": "Filters results to with Lease Status." }, { "name": "glAccountID", "value": "", "type": "query", "description": "Filters results with GLAccount ID." } ] }, "docs": "Retrieves a list of adjustments.

Required permission:
LEASES - Read\n

Sortable by: leaseid, postdate, id" }, { "info": { "name": "Create a lease adjustment (BETA)", "type": "http" }, "http": { "method": "POST", "url": "https://api.propertyware.com/pw/api/rest/v1/leases/adjustments", "body": { "type": "json", "data": "{}" } }, "docs": "

Note: 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.

\nCreates a lease adjustment.

Required permission:
LEASES - Write\n" }, { "info": { "name": "Update a lease adjustment (BETA)", "type": "http" }, "http": { "method": "PUT", "url": "https://api.propertyware.com/pw/api/rest/v1/leases/adjustments/:adjustmentID", "params": [ { "name": "adjustmentID", "value": "", "type": "path", "description": "Adjustment ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "

Note: 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.

\nUpdates an lease adjustment.

Required permission:
LEASES - Write\n" }, { "info": { "name": "Retrieve all lease auto charges (New)", "type": "http" }, "http": { "method": "GET", "url": "https://api.propertyware.com/pw/api/rest/v1/leases/autocharges", "params": [ { "name": "offset", "value": "", "type": "query", "description": "`offset` indicates the position of the first record to return. The offset is zero-based and the default is 0." }, { "name": "limit", "value": "", "type": "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." }, { "name": "lastModifiedDateTimeStart", "value": "", "type": "query", "description": "Filters results to any item modified on or after the date time specified. " }, { "name": "lastModifiedDateTimeEnd", "value": "", "type": "query", "description": "Filters results to any item modified on or prior to the date time specified. " }, { "name": "orderby", "value": "", "type": "query", "description": "Indicates the field(s) and direction to sort the results in the response." }, { "name": "leaseID", "value": "", "type": "query", "description": "Filters results with Lease ID." } ] }, "docs": "Retrieves all the auto charges of a lease.

Required permission:
LEASES - Read\n

Sortable by: createddate, lastmodifieddatetime, id" }, { "info": { "name": "Create lease auto charges (BETA)", "type": "http" }, "http": { "method": "POST", "url": "https://api.propertyware.com/pw/api/rest/v1/leases/autocharges", "body": { "type": "json", "data": "{}" } }, "docs": "

Note: 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.

\nCreates lease auto charges.

Required permission:
LEASES - Write\n" }, { "info": { "name": "Retrieve all the lease charges", "type": "http" }, "http": { "method": "GET", "url": "https://api.propertyware.com/pw/api/rest/v1/leases/charges", "params": [ { "name": "offset", "value": "", "type": "query", "description": "`offset` indicates the position of the first record to return. The offset is zero-based and the default is 0." }, { "name": "limit", "value": "", "type": "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." }, { "name": "lastModifiedDateTimeStart", "value": "", "type": "query", "description": "Filters results to any item modified on or after the date time specified. " }, { "name": "lastModifiedDateTimeEnd", "value": "", "type": "query", "description": "Filters results to any item modified on or prior to the date time specified. " }, { "name": "orderby", "value": "", "type": "query", "description": "Indicates the field(s) and direction to sort the results in the response." }, { "name": "postDateStart", "value": "", "type": "query", "description": "Filters results to any transaction with a start date on or after the date specified." }, { "name": "postDateEnd", "value": "", "type": "query", "description": "Filters results to any transaction with a start date on or prior to the date specified." }, { "name": "portfolioID", "value": "", "type": "query", "description": "Filters results associated with a specific portfolio." }, { "name": "leaseID", "value": "", "type": "query", "description": "Filters results with Lease ID." }, { "name": "status", "value": "", "type": "query", "description": "Filters results to with Lease Status." }, { "name": "glAccountID", "value": "", "type": "query", "description": "Filters results with GLAccount ID." } ] }, "docs": "Retrieves a list of lease charges.

Required permission:
LEASES - Read\n

Sortable by: leaseid, postdate, createddate, lastmodifieddatetime, id" }, { "info": { "name": "Create a lease charge (BETA)", "type": "http" }, "http": { "method": "POST", "url": "https://api.propertyware.com/pw/api/rest/v1/leases/charges", "body": { "type": "json", "data": "{}" } }, "docs": "

Note: 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.

\nCreates a lease charge.

Required permission:
LEASES - Write\n" }, { "info": { "name": "Create lease charges in bulk (BETA)", "type": "http" }, "http": { "method": "POST", "url": "https://api.propertyware.com/pw/api/rest/v1/leases/charges/bulk", "body": { "type": "json", "data": "{}" } }, "docs": "

Note: 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.

\nCreates lease charges in bulk.

Required permission:
LEASES - Write\n" }, { "info": { "name": "Update a lease charge (BETA)", "type": "http" }, "http": { "method": "PUT", "url": "https://api.propertyware.com/pw/api/rest/v1/leases/charges/:chargeID", "params": [ { "name": "chargeID", "value": "", "type": "path", "description": "Charge ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "

Note: 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.

\nUpdates a lease charge.

Required permission:
LEASES - Write\n" }, { "info": { "name": "Delete a lease charge (BETA)", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.propertyware.com/pw/api/rest/v1/leases/charges/:chargeID", "params": [ { "name": "chargeID", "value": "", "type": "path", "description": "Charge ID" } ] }, "docs": "

Note: 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.

\nDeletes a specific lease charge.

Required permission:
LEASES - Delete\n" }, { "info": { "name": "Retrieve all the credit memos", "type": "http" }, "http": { "method": "GET", "url": "https://api.propertyware.com/pw/api/rest/v1/leases/creditmemos", "params": [ { "name": "offset", "value": "", "type": "query", "description": "`offset` indicates the position of the first record to return. The offset is zero-based and the default is 0." }, { "name": "limit", "value": "", "type": "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." }, { "name": "lastModifiedDateTimeStart", "value": "", "type": "query", "description": "Filters results to any item modified on or after the date time specified. " }, { "name": "lastModifiedDateTimeEnd", "value": "", "type": "query", "description": "Filters results to any item modified on or prior to the date time specified. " }, { "name": "orderby", "value": "", "type": "query", "description": "Indicates the field(s) and direction to sort the results in the response." }, { "name": "postDateStart", "value": "", "type": "query", "description": "Filters results to any transaction with a start date on or after the date specified." }, { "name": "postDateEnd", "value": "", "type": "query", "description": "Filters results to any transaction with a start date on or prior to the date specified." }, { "name": "portfolioID", "value": "", "type": "query", "description": "Filters results associated with a specific portfolio." }, { "name": "leaseID", "value": "", "type": "query", "description": "Filters results with Lease ID." }, { "name": "status", "value": "", "type": "query", "description": "Filters results to with Lease Status." }, { "name": "glAccountID", "value": "", "type": "query", "description": "Filters results with GLAccount ID." } ] }, "docs": "Retrieves a list of credit memos.

Required permission:
LEASES - Read\n

Sortable by: leaseid, postdate, createddate, lastmodifieddatetime, id" }, { "info": { "name": "Update a lease custom fields (BETA)", "type": "http" }, "http": { "method": "PUT", "url": "https://api.propertyware.com/pw/api/rest/v1/leases/customfields", "body": { "type": "json", "data": "{}" } }, "docs": "

Note: 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.

\nUpdates an existing lease custom fields

Required permission:
LEASES - Write\n" }, { "info": { "name": "Retrieve all the lease discounts", "type": "http" }, "http": { "method": "GET", "url": "https://api.propertyware.com/pw/api/rest/v1/leases/discounts", "params": [ { "name": "offset", "value": "", "type": "query", "description": "`offset` indicates the position of the first record to return. The offset is zero-based and the default is 0." }, { "name": "limit", "value": "", "type": "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." }, { "name": "lastModifiedDateTimeStart", "value": "", "type": "query", "description": "Filters results to any item modified on or after the date time specified. " }, { "name": "lastModifiedDateTimeEnd", "value": "", "type": "query", "description": "Filters results to any item modified on or prior to the date time specified. " }, { "name": "orderby", "value": "", "type": "query", "description": "Indicates the field(s) and direction to sort the results in the response." }, { "name": "leaseID", "value": "", "type": "query", "description": "Filters results to any LeaseID." }, { "name": "postDateStart", "value": "", "type": "query", "description": "Filters results to any discount with a start date on or after the date specified." }, { "name": "postDateEnd", "value": "", "type": "query", "description": "Filters results to any discount with a start date on or prior to the date specified." } ] }, "docs": "Retrieves a list of lease discounts

Required permission:
LEASES - Read\n

Sortable by: leaseid, postdate, createddate, lastmodifieddatetime, id" }, { "info": { "name": "Create a lease discount (BETA)", "type": "http" }, "http": { "method": "POST", "url": "https://api.propertyware.com/pw/api/rest/v1/leases/discounts", "body": { "type": "json", "data": "{}" } }, "docs": "

Note: 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.

\nCreates a lease discount.

Required permission:
LEASES - Write\n" }, { "info": { "name": "Updates a lease Discount (BETA)", "type": "http" }, "http": { "method": "PUT", "url": "https://api.propertyware.com/pw/api/rest/v1/leases/discounts/:discountID", "params": [ { "name": "discountID", "value": "", "type": "path", "description": "Discount ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "

Note: 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.

\nUpdates a lease Discount.

Required permission:
LEASES - Write\n" }, { "info": { "name": "Retrieve all lease journal entries (New)", "type": "http" }, "http": { "method": "GET", "url": "https://api.propertyware.com/pw/api/rest/v1/leases/journalentries", "params": [ { "name": "offset", "value": "", "type": "query", "description": "`offset` indicates the position of the first record to return. The offset is zero-based and the default is 0." }, { "name": "limit", "value": "", "type": "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." }, { "name": "lastModifiedDateTimeStart", "value": "", "type": "query", "description": "Filters results to any item modified on or after the date time specified. " }, { "name": "lastModifiedDateTimeEnd", "value": "", "type": "query", "description": "Filters results to any item modified on or prior to the date time specified. " }, { "name": "orderby", "value": "", "type": "query", "description": "Indicates the field(s) and direction to sort the results in the response." }, { "name": "leaseID", "value": "", "type": "query", "description": "Filters results to transactions associated with a specific lease." }, { "name": "postDateStart", "value": "", "type": "query", "description": "Filters results to any transaction with post date on or after to the date specified." }, { "name": "postDateEnd", "value": "", "type": "query", "description": "Filters results to any transaction with post date on or prior to the date specified." } ] }, "docs": "Retrieves a list of lease journal entries.

Required permission:
LEASES - Read\n

Sortable by: postdate, createddate, lastmodifieddatetime, id" }, { "info": { "name": "Create a lease journal entry (BETA)", "type": "http" }, "http": { "method": "POST", "url": "https://api.propertyware.com/pw/api/rest/v1/leases/journalentries", "body": { "type": "json", "data": "{}" } }, "docs": "

Note: 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.

\nCreates a lease journal entry.

Required permission:
LEASES - Write\n" }, { "info": { "name": "Update a lease journal entry (BETA)", "type": "http" }, "http": { "method": "PUT", "url": "https://api.propertyware.com/pw/api/rest/v1/leases/journalentries/:journalentryID", "params": [ { "name": "journalentryID", "value": "", "type": "path", "description": "Journal Entry ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "

Note: 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.

\nUpdates a lease journal entry.

Required permission:
LEASES - Write\n" }, { "info": { "name": "Retrieve all lease journal entries ", "type": "http" }, "http": { "method": "GET", "url": "https://api.propertyware.com/pw/api/rest/v1/leases/journalentries/:leaseID", "params": [ { "name": "leaseID", "value": "", "type": "path", "description": "Lease ID" }, { "name": "offset", "value": "", "type": "query", "description": "`offset` indicates the position of the first record to return. The offset is zero-based and the default is 0." }, { "name": "limit", "value": "", "type": "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." }, { "name": "lastModifiedDateTimeStart", "value": "", "type": "query", "description": "Filters results to any item modified on or after the date time specified. " }, { "name": "lastModifiedDateTimeEnd", "value": "", "type": "query", "description": "Filters results to any item modified on or prior to the date time specified. " }, { "name": "orderby", "value": "", "type": "query", "description": "Indicates the field(s) and direction to sort the results in the response." }, { "name": "leaseID", "value": "", "type": "query", "description": "Filters results to transactions associated with a specific lease." }, { "name": "postDateStart", "value": "", "type": "query", "description": "Filters results to any transaction with post date on or after to the date specified." }, { "name": "postDateEnd", "value": "", "type": "query", "description": "Filters results to any transaction with post date on or prior to the date specified." } ] }, "docs": "Retrieves a specific lease journal entries.

Required permission:
LEASES - Read\n

Sortable by: postdate, createddate, lastmodifieddatetime, id" }, { "info": { "name": "Retrieve all the lease payments", "type": "http" }, "http": { "method": "GET", "url": "https://api.propertyware.com/pw/api/rest/v1/leases/payments", "params": [ { "name": "offset", "value": "", "type": "query", "description": "`offset` indicates the position of the first record to return. The offset is zero-based and the default is 0." }, { "name": "limit", "value": "", "type": "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." }, { "name": "lastModifiedDateTimeStart", "value": "", "type": "query", "description": "Filters results to any item modified on or after the date time specified. " }, { "name": "lastModifiedDateTimeEnd", "value": "", "type": "query", "description": "Filters results to any item modified on or prior to the date time specified. " }, { "name": "orderby", "value": "", "type": "query", "description": "Indicates the field(s) and direction to sort the results in the response." }, { "name": "postDateStart", "value": "", "type": "query", "description": "Filters results to any transaction with a start date on or after the date specified." }, { "name": "postDateEnd", "value": "", "type": "query", "description": "Filters results to any transaction with a start date on or prior to the date specified." }, { "name": "portfolioID", "value": "", "type": "query", "description": "Filters results associated with a specific portfolio." }, { "name": "leaseID", "value": "", "type": "query", "description": "Filters results with Lease ID." }, { "name": "status", "value": "", "type": "query", "description": "Filters results to with Lease Status." }, { "name": "glAccountID", "value": "", "type": "query", "description": "Filters results with GLAccount ID." } ] }, "docs": "Retrieves a list of lease payments.

Required permission:
LEASES - Read\n

Sortable by: leaseid, postdate, createddate, lastmodifieddatetime, id" }, { "info": { "name": "Create a lease payment (BETA)", "type": "http" }, "http": { "method": "POST", "url": "https://api.propertyware.com/pw/api/rest/v1/leases/payments", "body": { "type": "json", "data": "{}" } }, "docs": "

Note: 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.

\nCreates a lease payment.

Required permission:
LEASES - Write\n" }, { "info": { "name": "Update a lease payment (BETA)", "type": "http" }, "http": { "method": "PUT", "url": "https://api.propertyware.com/pw/api/rest/v1/leases/payments/:entityID", "params": [ { "name": "entityID", "value": "", "type": "path", "description": "Lease Payment ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "

Note: 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.

\nUpdates a lease payment.

Required permission:
LEASES - Write\n" }, { "info": { "name": "Retrieve all the tenant refunds", "type": "http" }, "http": { "method": "GET", "url": "https://api.propertyware.com/pw/api/rest/v1/leases/refunds", "params": [ { "name": "offset", "value": "", "type": "query", "description": "`offset` indicates the position of the first record to return. The offset is zero-based and the default is 0." }, { "name": "limit", "value": "", "type": "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." }, { "name": "lastModifiedDateTimeStart", "value": "", "type": "query", "description": "Filters results to any item modified on or after the date time specified. " }, { "name": "lastModifiedDateTimeEnd", "value": "", "type": "query", "description": "Filters results to any item modified on or prior to the date time specified. " }, { "name": "orderby", "value": "", "type": "query", "description": "Indicates the field(s) and direction to sort the results in the response." }, { "name": "postDateStart", "value": "", "type": "query", "description": "Filters results to any transaction with a start date on or after the date specified." }, { "name": "postDateEnd", "value": "", "type": "query", "description": "Filters results to any transaction with a start date on or prior to the date specified." }, { "name": "portfolioID", "value": "", "type": "query", "description": "Filters results associated with a specific portfolio." }, { "name": "leaseID", "value": "", "type": "query", "description": "Filters results with Lease ID." }, { "name": "status", "value": "", "type": "query", "description": "Filters results to with Lease Status." }, { "name": "glAccountID", "value": "", "type": "query", "description": "Filters results with GLAccount ID." } ] }, "docs": "Retrieves a list of tenant refunds.

Required permission:
LEASES - Read\n

Sortable by: leaseid, postdate, createddate, lastmodifieddatetime, id" }, { "info": { "name": "Create a lease refund (BETA)", "type": "http" }, "http": { "method": "POST", "url": "https://api.propertyware.com/pw/api/rest/v1/leases/refunds", "body": { "type": "json", "data": "{}" } }, "docs": "

Note: 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.

\nCreates a lease refund.

Required permission:
LEASES - Write\n" }, { "info": { "name": "Update a lease refund (BETA)", "type": "http" }, "http": { "method": "PUT", "url": "https://api.propertyware.com/pw/api/rest/v1/leases/refunds/:refundID", "params": [ { "name": "refundID", "value": "", "type": "path", "description": "Refund ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "

Note: 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.

\nUpdate an lease refund.

Required permission:
LEASES - Write\n" }, { "info": { "name": "Retrieve all lease statuses (BETA)", "type": "http" }, "http": { "method": "GET", "url": "https://api.propertyware.com/pw/api/rest/v1/leases/statuses" }, "docs": "

Note: This operation is still in beta and might be subject to breaking changes. Production integrations should be avoided at this stage.

\nRetrieves a list of all lease statuses

Required permission:
LEASES - Read\n" }, { "info": { "name": "Delete a lease (BETA)", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.propertyware.com/pw/api/rest/v1/leases/:leaseID", "params": [ { "name": "leaseID", "value": "", "type": "path", "description": "Lease ID" } ] }, "docs": "

Note: 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.

\nDeletes a lease

Required permission:
LEASES - Delete\n" }, { "info": { "name": "Retrieve all lease conversations", "type": "http" }, "http": { "method": "GET", "url": "https://api.propertyware.com/pw/api/rest/v1/leases/:leaseID/conversations", "params": [ { "name": "leaseID", "value": "", "type": "path", "description": "Lease ID" }, { "name": "offset", "value": "", "type": "query", "description": "`offset` indicates the position of the first record to return. The offset is zero-based and the default is 0." }, { "name": "limit", "value": "", "type": "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." }, { "name": "lastModifiedDateTimeStart", "value": "", "type": "query", "description": "Filters results to any item modified on or after the date time specified. " }, { "name": "lastModifiedDateTimeEnd", "value": "", "type": "query", "description": "Filters results to any item modified on or prior to the date time specified. " }, { "name": "orderby", "value": "", "type": "query", "description": "Indicates the field(s) and direction to sort the results in the response." }, { "name": "type", "value": "", "type": "query", "description": "Filters results by the conversation type." } ] }, "docs": "Retrieves all the conversations of a lease.

Required permission:
LEASES - Read\n

Sortable by: createddate, lastmodifieddatetime, id" }, { "info": { "name": "Create a lease conversation", "type": "http" }, "http": { "method": "POST", "url": "https://api.propertyware.com/pw/api/rest/v1/leases/:leaseID/conversations", "params": [ { "name": "leaseID", "value": "", "type": "path", "description": "Lease ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a specific lease conversation.

Required permission:
LEASES - Write\n" }, { "info": { "name": "Retrieve a lease conversation", "type": "http" }, "http": { "method": "GET", "url": "https://api.propertyware.com/pw/api/rest/v1/leases/:leaseID/conversations/:conversationID", "params": [ { "name": "leaseID", "value": "", "type": "path", "description": "Lease ID" }, { "name": "conversationID", "value": "", "type": "path", "description": "Conversation ID" } ] }, "docs": "Retrieves a specific lease conversation.

Required permission:
LEASES - Read\n" }, { "info": { "name": "Delete a lease conversation (BETA)", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.propertyware.com/pw/api/rest/v1/leases/:leaseID/conversations/:conversationID", "params": [ { "name": "leaseID", "value": "", "type": "path", "description": "Lease ID" }, { "name": "conversationID", "value": "", "type": "path", "description": "Conversation ID" } ] }, "docs": "

Note: 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.

\nDeletes a specific lease conversation.

Required permission:
LEASES - Delete\n" }, { "info": { "name": "Add comment to a lease conversation", "type": "http" }, "http": { "method": "POST", "url": "https://api.propertyware.com/pw/api/rest/v1/leases/:leaseID/conversations/:conversationID/comments", "params": [ { "name": "leaseID", "value": "", "type": "path", "description": "Lease ID" }, { "name": "conversationID", "value": "", "type": "path", "description": "Conversation ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds comment to a lease conversation.

Required permission:
LEASES - Write\n" }, { "info": { "name": "Retrieve a lease", "type": "http" }, "http": { "method": "GET", "url": "https://api.propertyware.com/pw/api/rest/v1/leases/:leaseId", "params": [ { "name": "leaseId", "value": "", "type": "path", "description": "Lease ID" }, { "name": "includeCustomFields", "value": "", "type": "query", "description": "includeCustomFields" }, { "name": "includeOtherBalances", "value": "", "type": "query", "description": "includeOtherBalances" } ] }, "docs": "Retrieves a specific lease.

Required permission:
LEASES - Read\n" }, { "info": { "name": "Update a lease", "type": "http" }, "http": { "method": "PUT", "url": "https://api.propertyware.com/pw/api/rest/v1/leases/:leaseId", "params": [ { "name": "leaseId", "value": "", "type": "path", "description": "Lease ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an existing lease.

Required permission:
LEASES - Write\n" }, { "info": { "name": "Retrieve all lease auto charges", "type": "http" }, "http": { "method": "GET", "url": "https://api.propertyware.com/pw/api/rest/v1/leases/:leaseId/autocharges", "params": [ { "name": "leaseId", "value": "", "type": "path", "description": "Lease ID" } ] }, "docs": "Retrieves all the auto charges of a lease.

Required permission:
LEASES - Read\n" }, { "info": { "name": "Retrieve all lease auto ePayments (BETA)", "type": "http" }, "http": { "method": "GET", "url": "https://api.propertyware.com/pw/api/rest/v1/leases/:leaseId/autoepayments", "params": [ { "name": "leaseId", "value": "", "type": "path", "description": "Lease ID" } ] }, "docs": "

Note: This operation is still in beta and might be subject to breaking changes. Production integrations should be avoided at this stage.

\nRetrieves all the auto ePayments of a lease.

Required permission:
LEASES - Read\n" }, { "info": { "name": "Retrieve all lease auto journal entries (BETA)", "type": "http" }, "http": { "method": "GET", "url": "https://api.propertyware.com/pw/api/rest/v1/leases/:leaseId/autojournalentries", "params": [ { "name": "leaseId", "value": "", "type": "path", "description": "Lease ID" } ] }, "docs": "

Note: This operation is still in beta and might be subject to breaking changes. Production integrations should be avoided at this stage.

\nRetrieves all the auto journal entries of a lease.

Required permission:
LEASES - Read\n" }, { "info": { "name": "Retrieve all lease contacts", "type": "http" }, "http": { "method": "GET", "url": "https://api.propertyware.com/pw/api/rest/v1/leases/:leaseId/contacts", "params": [ { "name": "leaseId", "value": "", "type": "path", "description": "Lease ID" }, { "name": "includeCustomFields", "value": "", "type": "query", "description": "includeCustomFields" } ] }, "docs": "Retrieves all the contacts of a lease.

Required permission:
LEASES - Read\n" }, { "info": { "name": "Retrieve all lease custom fields", "type": "http" }, "http": { "method": "GET", "url": "https://api.propertyware.com/pw/api/rest/v1/leases/:leaseId/customfields", "params": [ { "name": "leaseId", "value": "", "type": "path", "description": "Lease ID" } ] }, "docs": "Retrieves all the custom fields of a lease.

Required permission:
LEASES - Read\n" }, { "info": { "name": "Retrieve all lease documents", "type": "http" }, "http": { "method": "GET", "url": "https://api.propertyware.com/pw/api/rest/v1/leases/:leaseId/document", "params": [ { "name": "leaseId", "value": "", "type": "path", "description": "Lease ID" } ] }, "docs": "Retrieves all the documents of a lease.

Required permission:
LEASES - Read\n" }, { "info": { "name": "Retrieve the lease late fee rule", "type": "http" }, "http": { "method": "GET", "url": "https://api.propertyware.com/pw/api/rest/v1/leases/:leaseId/latefeerule", "params": [ { "name": "leaseId", "value": "", "type": "path", "description": "Lease ID" } ] }, "docs": "Retrieves the lease late fee rule.

Required permission:
LEASES - Read\n" }, { "info": { "name": "Retrieve all lease notes", "type": "http" }, "http": { "method": "GET", "url": "https://api.propertyware.com/pw/api/rest/v1/leases/:leaseId/notes", "params": [ { "name": "leaseId", "value": "", "type": "path", "description": "Lease ID" } ] }, "docs": "Retrieves all the notes of a lease.

Required permission:
LEASES - Read\n" }, { "info": { "name": "Retrieve all lease work orders", "type": "http" }, "http": { "method": "GET", "url": "https://api.propertyware.com/pw/api/rest/v1/leases/:leaseId/workorders", "params": [ { "name": "leaseId", "value": "", "type": "path", "description": "Lease ID" } ] }, "docs": "Retrieves all the work orders of a lease.

Required permission:
LEASES - Read\n" } ] } ], "bundled": true }