Method: Propertyware::DocumentsApi#upload_document

Defined in:
lib/propertyware/api/documents_api.rb

#upload_document(entity_id, entity_type, body, opts = {}) ⇒ Document

Upload a document (BETA) <p class="betaError">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.</p> Upload a document<br/><br/>Required permission:<br/><span class="permissionBlock">DOCUMENTS</span> - Write

Parameters:

  • entity_id (Integer) —

    Unique identifier of an entity document is attached to.

  • entity_type (String) —

    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 (File)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :publish_to_tenant_portal (Boolean) —

    Indicates if the document is published to the tenant portal.

  • :publish_to_owner_portal (Boolean) —

    Indicates if the document is published to the owner portal.

Returns:



381
382
383
384
 
# File 'lib/propertyware/api/documents_api.rb', line 381

def upload_document(entity_id, entity_type, body, opts = {})
  data, _status_code, _headers = upload_document_with_http_info(entity_id, entity_type, body, opts)
  data
end