{
  "opencollection": "1.0.0",
  "info": {
    "name": "Open API, powered by Propertyware Accounting Documents API",
    "version": "1.0"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "x-propertyware-client-id",
      "value": "{{x-propertyware-client-id}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Documents",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Retrieve all documents",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.propertyware.com/pw/api/rest/v1/docs",
            "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": "entityType",
                "value": "",
                "type": "query",
                "description": "Filters results to documents associated with a specific entity type."
              },
              {
                "name": "entityId",
                "value": "",
                "type": "query",
                "description": "Filters results to documents associated with a specific entity id. entity ID is not required for “DESKTOP” and “OTHER”. Remaining entities need “entity ID”."
              }
            ]
          },
          "docs": "Retrieves a list of documents associated with a specific entity.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">DOCUMENTS</span> - <code>Read</code>\n<br/><br/><b>Sortable by:</b> <code>createddate</code>, <code>lastmodifieddatetime</code>, <code>id</code>"
        },
        {
          "info": {
            "name": "Upload a document",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.propertyware.com/pw/api/rest/v1/docs",
            "params": [
              {
                "name": "entityId",
                "value": "",
                "type": "query",
                "description": "Unique identifier of an entity document is attached to."
              },
              {
                "name": "publishToTenantPortal",
                "value": "",
                "type": "query",
                "description": "Indicates if the document is published to the tenant portal."
              },
              {
                "name": "publishToOwnerPortal",
                "value": "",
                "type": "query",
                "description": "Indicates if the document is published to the owner portal."
              },
              {
                "name": "entityType",
                "value": "",
                "type": "query",
                "description": "Entity type Document is attached to (Asset, Bill, Bank Deposit, Building, Desktop, Lease, Owner, Portfolio, Prospect, Prospect Contact, Tenant, Unit, Vendor, Check, Credit, Service Agreement, Journal Entry, Work Order)"
              }
            ],
            "body": {
              "type": "multipart-form",
              "data": [
                {
                  "name": "file",
                  "type": "text",
                  "value": ""
                }
              ]
            }
          },
          "docs": "Upload a document<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">DOCUMENTS</span> - <code>Write</code>\n"
        },
        {
          "info": {
            "name": "Retrieve a document",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.propertyware.com/pw/api/rest/v1/docs/:documentId",
            "params": [
              {
                "name": "documentId",
                "value": "",
                "type": "path",
                "description": "ID of the document to retrieve"
              }
            ]
          },
          "docs": "Retrieves the metadata of a specific document.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">DOCUMENTS</span> - <code>Read</code>\n"
        },
        {
          "info": {
            "name": "Update a document",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.propertyware.com/pw/api/rest/v1/docs/:documentId",
            "params": [
              {
                "name": "documentId",
                "value": "",
                "type": "path",
                "description": "ID of the document to be updated"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates the metadata of a specific document.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">DOCUMENTS</span> - <code>Write</code>\n"
        },
        {
          "info": {
            "name": "Delete a document (BETA)",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.propertyware.com/pw/api/rest/v1/docs/:documentId",
            "params": [
              {
                "name": "documentId",
                "value": "",
                "type": "path",
                "description": "ID of the document to delete"
              }
            ]
          },
          "docs": "<p class=\"betaError\"><b>Note: </b>Write access is only available to customers who have opted in to our beta program. Please reach out to support if you'd like to be included.</p>\nDeletes a specific document and its associated content.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">DOCUMENTS</span> - <code>Delete</code>\n"
        },
        {
          "info": {
            "name": "Download a document",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.propertyware.com/pw/api/rest/v1/docs/:documentId/download",
            "params": [
              {
                "name": "documentId",
                "value": "",
                "type": "path",
                "description": "ID of the document to download"
              }
            ]
          },
          "docs": "Retrieve a temporary download URL for a specific document.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">DOCUMENTS</span> - <code>Read</code>\n"
        }
      ]
    }
  ],
  "bundled": true
}