{ "opencollection": "1.0.0", "info": { "name": "Open API, powered by Propertyware Accounting API", "version": "1.0" }, "request": { "auth": { "type": "apikey", "key": "x-propertyware-client-id", "value": "{{x-propertyware-client-id}}", "placement": "header" } }, "items": [ { "info": { "name": "Accounting", "type": "folder" }, "items": [ { "info": { "name": "Create a bank deposit", "type": "http" }, "http": { "method": "POST", "url": "https://api.propertyware.com/pw/api/rest/v1/accounting/bankdeposits", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a bank deposit.

Required permission:
GENERAL LEDGER - Write\n" }, { "info": { "name": "Delete a Bank Deposit (BETA)", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.propertyware.com/pw/api/rest/v1/accounting/bankdeposits/:bankDepositID", "params": [ { "name": "bankDepositID", "value": "", "type": "path", "description": "Bank Deposit 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.

\nDelete a Bank Deposit.

Required permission:
GENERAL LEDGER - Delete\n" }, { "info": { "name": "Retrieve all general ledger transactions (BETA)", "type": "http" }, "http": { "method": "GET", "url": "https://api.propertyware.com/pw/api/rest/v1/accounting/generalledger", "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": "ownerID", "value": "", "type": "query", "description": "Filters results to transactions associated with a specific owner." }, { "name": "vendorID", "value": "", "type": "query", "description": "Filters results to transactions associated with a specific vendor." }, { "name": "portfolioID", "value": "", "type": "query", "description": "Filters results to transactions associated with a specific Portfolio." }, { "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": "

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 general ledger transactions.

At least of the following date ranges must be passed as a filter: \n * `lastModifiedDateStart`-`lastModifiedDateEnd` \n * `createdDateStart`-`createdDateEnd`

Required permission:
GENERAL LEDGER - Read\n" }, { "info": { "name": "Retrieve all the general ledger accounts", "type": "http" }, "http": { "method": "GET", "url": "https://api.propertyware.com/pw/api/rest/v1/accounting/glaccounts", "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": "accountNumber", "value": "", "type": "query", "description": "Filters results to accounts with a specific number." }, { "name": "includeDeactivated", "value": "", "type": "query", "description": "Include deactivated results if a `true` value is passed. If no value is specified, only active accounts will be returned." }, { "name": "accountCode", "value": "", "type": "query", "description": "Filters results to accounts with a specific code." }, { "name": "parentGLAccountId", "value": "", "type": "query", "description": "Filters results to accounts that are a children of a specific parent account." } ] }, "docs": "Retrieves a list of general ledger accounts.

Required permission:
GL ACCOUNTS - Read\n

Sortable by: accountcode, id, accountnumber" }, { "info": { "name": "Create a general ledger account (BETA)", "type": "http" }, "http": { "method": "POST", "url": "https://api.propertyware.com/pw/api/rest/v1/accounting/glaccounts", "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.

\nCreate a general ledger account.

Required permission:
GL ACCOUNTS - Write\n" }, { "info": { "name": "Create general ledger accounts in bulk (BETA)", "type": "http" }, "http": { "method": "POST", "url": "https://api.propertyware.com/pw/api/rest/v1/accounting/glaccounts/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 general ledger accounts in bulk.

Required permission:
GL ACCOUNTS - Write\n" }, { "info": { "name": "Retrieve a general ledger account", "type": "http" }, "http": { "method": "GET", "url": "https://api.propertyware.com/pw/api/rest/v1/accounting/glaccounts/:glAccountID", "params": [ { "name": "glAccountID", "value": "", "type": "path", "description": "GL Account ID" } ] }, "docs": "Retrieves a general ledger account.

Required permission:
GL ACCOUNTS - Read\n" }, { "info": { "name": "Update a general ledger account (BETA)", "type": "http" }, "http": { "method": "PUT", "url": "https://api.propertyware.com/pw/api/rest/v1/accounting/glaccounts/:glAccountID", "params": [ { "name": "glAccountID", "value": "", "type": "path", "description": "GL Account 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 general ledger account.

Required permission:
GL ACCOUNTS - Write\n" }, { "info": { "name": "Delete a general ledger account (BETA)", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.propertyware.com/pw/api/rest/v1/accounting/glaccounts/:glAccount", "params": [ { "name": "glAccount", "value": "", "type": "path", "description": "GL Account 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.

\nDelete a general ledger account.

Required permission:
GL ACCOUNTS - Delete\n" }, { "info": { "name": "Retrieve all the owner contributions", "type": "http" }, "http": { "method": "GET", "url": "https://api.propertyware.com/pw/api/rest/v1/accounting/ownercontributions", "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 to with portfolioID." } ] }, "docs": "Retrieves a list of owner contributions.

Required permission:
PORTFOLIOS - Read\n

Sortable by: postdate, createddate, lastmodifieddatetime, id" }, { "info": { "name": "Create an owner contribution", "type": "http" }, "http": { "method": "POST", "url": "https://api.propertyware.com/pw/api/rest/v1/accounting/ownercontributions", "body": { "type": "json", "data": "{}" } }, "docs": "Creates an owner contribution for a specified owner contact.

Required permission:
PORTFOLIOS - Write\n" }, { "info": { "name": "Delete Owner Contribution (BETA)", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.propertyware.com/pw/api/rest/v1/accounting/ownercontributions/:ownerContributionID", "params": [ { "name": "ownerContributionID", "value": "", "type": "path", "description": "Owner Contribution 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.

\nDelete Owner Contribution.

Required permission:
PORTFOLIOS - Delete\n" }, { "info": { "name": "Retrieve all the owner draws", "type": "http" }, "http": { "method": "GET", "url": "https://api.propertyware.com/pw/api/rest/v1/accounting/ownerdraws", "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 to with portfolioID." } ] }, "docs": "Retrieves a list of owner draws.

Required permission:
PORTFOLIOS - Read\n

Sortable by: postdate, createddate, lastmodifieddatetime, portfolioid, id" }, { "info": { "name": "Create an owner draw", "type": "http" }, "http": { "method": "POST", "url": "https://api.propertyware.com/pw/api/rest/v1/accounting/ownerdraws", "body": { "type": "json", "data": "{}" } }, "docs": "Creates an owner draw for a specified owner contact.

Required permission:
PORTFOLIOS - Write\n" }, { "info": { "name": "Update an owner draw", "type": "http" }, "http": { "method": "PUT", "url": "https://api.propertyware.com/pw/api/rest/v1/accounting/ownerdraws/:drawID", "params": [ { "name": "drawID", "value": "", "type": "path", "description": "Owner Draw ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an owner draw for a specified owner contact.

Required permission:
PORTFOLIOS - Write\n" } ] } ], "bundled": true }