Rentvine Logo
API docs by Redocly

Rentvine API Docs (1.0.0)

Download OpenAPI specification:Download

Authentication

Requests are made using HTTP Basic Authentication with the access key as the username and secret as the password. 

# Use the -u flag with {access key}:{secret}
curl https://example.rentvine.com/api/manager/properties \
  -u eba2c5e402e1476cb8ce5083a671d528:bd804fe81fd043598600939b9a257b2e

Obtaining API Keys

  1. In your Rentvine dashboard navigate to Settings > Users, Roles and API > API
  2. Select New API Key
  3. Enter a reference name in the Name field and select a predefined role in the Role dropdown

    ℹ️ Roles need to be setup before creating an API key. Create Roles via the Roles tab.

  4. Copy the generated Access Key and Secret. You will not be able to view the Secret again after closing this form.

Leases

Export Leases

List Leases for Export

The Last Modified Timestamp on Leases is updated by multiple actions including, but not limited to, the following.

  • Updating lease detaila in the manager portal
  • Taking actions such as activate, renewal, move out, rent increase etc.
  • Residents initiating move out process
  • Disabling or enabling portal or portal payment access actions.
  • Lease Transactions such as charges, credit, and payment are created, updated, or voided.
  • When tenant, occupant, pet, or vehicle information is added, updated or deleted.
Authorizations:
basicAuth
query Parameters
leaseIDs[]
Array of integers

Filter by Lease IDs

primaryLeaseStatusIDs[]
Array of integers (primary_lease_statuses)
Items Enum: 1 2 3

Filter by Primary Lease Status

leaseStatusIDs[]
Array of integers

Filter by Lease Status

dateTimeModifiedMin
date-time

Filter by minimum dateTimeModified

dateTimeModifiedMax
date-time

Filter by maximum dateTimeModified

page
integer
Default: 1

The page number for pagination

pageSize
integer
Default: 25

Number of items per page

Responses

Response Schema: application/json
Array
object (lease_export)
object (balances)
object (unpaid_charges)
object (property_export)
object (unit_export)
object (portfolio_export)

Response samples

Content type
application/json
[
  • {
    }
]

Properties

Export Properties

List Properties for Export

The Last Modified Timestamp on Properties is updated by multiple actions including, but not limited to, the following.

  • Updating property details in the manager portal
  • Updating groups and associations
  • Activating or deactivating property or portfolio
Authorizations:
basicAuth
query Parameters
isActive
boolean
dateTimeModifiedMin
date-time

Filter by minimum dateTimeModified

dateTimeModifiedMax
date-time

Filter by maximum dateTimeModified

page
integer
Default: 1

The page number for pagination

pageSize
integer
Default: 25

Number of items per page

Responses

Response Schema: application/json
Array
object
object (portfolio_export)

Response samples

Content type
application/json
[
  • {
    }
]

Units

Export Units

List Units for Export

The Last Modified Timestamp on Units is updated by multiple actions including, but not limited to, the following.

  • Updating unit details in the manager portal
  • Creating or updating listings
  • Updating Appliance information
Authorizations:
basicAuth
query Parameters
isActive
boolean
dateTimeModifiedMin
date-time

Filter by minimum dateTimeModified

dateTimeModifiedMax
date-time

Filter by maximum dateTimeModified

page
integer
Default: 1

The page number for pagination

pageSize
integer
Default: 25

Number of items per page

Responses

Response Schema: application/json
Array
object (property_export)
object

Response samples

Content type
application/json
[
  • {
    }
]

Applications

Export Applications

List Applications for Export

The Last Modified Timestamp on Applications is set on creation and updated when applications are modified by the manager portal user.

Authorizations:
basicAuth
query Parameters
primaryApplicationStatusIDs[]
Array of integers (primary_application_statuses)
Items Enum: 1 2 3 4 5 6 7 8

Filter by Primary Application Status

applicationStatusIDs[]
Array of integers

Filter by Application Status

hasLease
boolean

Filter by if there is a Lease Attached

dateTimeModifiedMin
date-time

Filter by minimum dateTimeModified

dateTimeModifiedMax
date-time

Filter by maximum dateTimeModified

page
integer
Default: 1

The page number for pagination

pageSize
integer
Default: 25

Number of items per page

Responses

Response Schema: application/json
Array
object (application_export)
object (unit_export)
object

Response samples

Content type
application/json
[
  • {
    }
]

Accounts

List

Shows chart of accounts

Authorizations:
basicAuth

Responses

Response Schema: application/json
Array
object (account)
object (account_category)

Response samples

Content type
application/json
[
  • {
    }
]

Bills

List

Lists bills

Authorizations:
basicAuth

Responses

Response Schema: application/json
Array
payeeContactID
required
integer
billDate
required
string <date>
dateDue
required
string <date>
billID
required
integer
billTypeID
required
integer
isVoided
required
boolean
isDiscount
required
boolean
isMarkup
required
boolean
managementFeeMode
required
integer
parentBillID
integer or null
reference
string or null
paymentMemo
string or null
workOrderID
integer or null
discountPercent
number or null <double>
markupPercent
number or null <double>
managementFeeBatchID
integer or null

Response samples

Content type
application/json
[
  • {
    }
]

Create

Creates a bill.

Authorizations:
basicAuth
Request Body schema: application/json
payeeContactID
required
integer
billDate
required
string <date>
dateDue
required
string <date>
billTypeID
required
integer
isVoided
required
boolean
isDiscount
required
boolean
isMarkup
required
boolean
managementFeeMode
required
integer
parentBillID
integer or null
reference
string or null
paymentMemo
string or null
workOrderID
integer or null
discountPercent
number or null <double>
markupPercent
number or null <double>
managementFeeBatchID
integer or null
Array of objects
Array of objects

Responses

Response Schema: application/json
object (bill)

Request samples

Content type
application/json
{
  • "payeeContactID": "379",
  • "billDate": "2022-07-06",
  • "dateDue": "2022-07-06",
  • "reference": null,
  • "paymentMemo": null,
  • "description": null,
  • "discountPercent": "10.0000",
  • "markupPercent": null,
  • "charges": [
    ],
  • "leaseCharges": null,
  • "attachments": [ ]
}

Response samples

Content type
application/json
{
  • "bill": {
    }
}

View

Authorizations:
basicAuth
path Parameters
billID
required
integer
Example: 1213

Responses

Response Schema: application/json
payeeContactID
required
integer
billDate
required
string <date>
dateDue
required
string <date>
billID
required
integer
billTypeID
required
integer
isVoided
required
boolean
isDiscount
required
boolean
isMarkup
required
boolean
managementFeeMode
required
integer
parentBillID
integer or null
reference
string or null
paymentMemo
string or null
workOrderID
integer or null
discountPercent
number or null <double>
markupPercent
number or null <double>
managementFeeBatchID
integer or null

Response samples

Content type
application/json
{
  • "parentBillID": 0,
  • "payeeContactID": 0,
  • "billDate": "2019-08-24",
  • "dateDue": "2019-08-24",
  • "reference": "string",
  • "paymentMemo": "string",
  • "workOrderID": 0,
  • "discountPercent": 0,
  • "markupPercent": 0,
  • "billID": 0,
  • "billTypeID": 0,
  • "isVoided": true,
  • "managementFeeBatchID": 0,
  • "isDiscount": true,
  • "isMarkup": true,
  • "managementFeeMode": 0
}

Ledgers

List

Lists ledgers

Authorizations:
basicAuth
query Parameters
search
required
string

Search string to match against the ledger name

Responses

Response Schema: application/json
Array
ledgerID
required
integer
ledgerTypeID
required
integer (ledger_types)
Enum: 1 2 3 4
  • 1 - Manager
  • 2 - Portfolio
  • 3 - Property
  • 4 - Unit
objectID
required
integer
name
required
string
isActive
required
boolean

Response samples

Content type
application/json
[
  • {
    }
]

Search

Searches ledgers

Authorizations:
basicAuth
query Parameters
search
search

Filter by term in description, name, amount, or address

isActive
boolean
ledgerTypeIDs[]
Array of arrays

Filter by an array of ledgerTypeIDs

dateTimeModifiedMin
date-time

Filter by minimum dateTimeModified

dateTimeModifiedMax
date-time

Filter by maximum dateTimeModified

Responses

Response Schema: application/json
Array
object

Response samples

Content type
application/json
[
  • {
    }
]

Transactions

Search

Searches transactions

Authorizations:
basicAuth
query Parameters
search
search

Filter by term in description, name, amount, or address

isVoided
boolean

Filter by isVoided

amountMin
number <double>

Filter by minumum amount

amountMax
number <double>

Filter by maximum amount

datePostedMin
date

Filter by minumum datePosted

datePostedMax
date

Filter by maximum datePosted

dateTimeModifiedMin
date-time

Filter by minimum dateTimeModified

dateTimeModifiedMax
date-time

Filter by maximum dateTimeModified

transactionTypeIDs[]
Array of arrays

Filter by an array of transactionTypeIDs

propertyIDs[]
Array of arrays

Filter by an array of propertyIDs

transactionEntriesLedgerIDs[]
Array of arrays

Filter by an array of transactionEntriesLedgerIDs

primaryLedgerIDs[]
Array of arrays

Filter by an array of primaryLedgerIDs

page
integer
Default: 1

The page number for pagination

pageSize
integer
Default: 15

Number of items per page

Responses

Response Schema: application/json
Array
object (transaction)
object
object
object
object

Response samples

Content type
application/json
[
  • {
    }
]

Transaction Entries

Search

Searches transactions

Authorizations:
basicAuth
query Parameters
search
search

Filter by term in description, name, amount, or address

isVoided
boolean

Filter by isVoided

isSuppressed
boolean

Filter by isSuppressed

isCash
boolean

Filter by isCash

isAccrual
boolean

Filter by isAccrual

amountMin
number <double>

Filter by minumum amount

amountMax
number <double>

Filter by maximum amount

datePostedMin
date

Filter by minumum datePosted

datePostedMax
date

Filter by maximum datePosted

dateTimeModifiedMin
date-time

Filter by minimum dateTimeModified

dateTimeModifiedMax
date-time

Filter by maximum dateTimeModified

transactionTypeIDs[]
Array of arrays

Filter by an array of transactionTypeIDs

propertyIDs[]
Array of arrays

Filter by an array of propertyIDs

ledgerIDs[]
Array of arrays

Filter by an array of ledgerIDs

page
integer
Default: 1

The page number for pagination

pageSize
integer
Default: 15

Number of items per page

Responses

Response Schema: application/json
Array
object (transaction_entry)
object (transaction)
object
object
object
object
object

Response samples

Content type
application/json
[
  • {
    }
]

Diagnostics

Unused Vendor Credits

Authorizations:
basicAuth

Responses

Response Schema: application/json
Array
transactionID
integer
primaryLedgerID
integer
portfolioID
integer
ledgerName
string
propertyID
integer
propertyAddress
string
propertyAddress2
string or null
propertyCity
string
propertyStateID
string
propertyPostalCode
string
chargeAccountID
integer
contactID
integer
contactTypeID
integer (contact_types)
Enum: 1 2 3 4 5 6
  • 1 - Owner
  • 2 - Tenant
  • 3 - Vendor
  • 4 - Manager
  • 5 - Association
  • 6 - Applicant
contactName
string
amount
number <double>
amountAllocated
number <double>
description
string
isSuppressed
integer
datePosted
string <date>

Response samples

Content type
application/json
[
  • {
    }
]

Suppressed Fee Balance Mismatch

Authorizations:
basicAuth

Responses

Response Schema: application/json
Array
propertyID
integer
propertyName
string or null
propertyStreetName
string
propertyStreetNumber
string
propertyAddress
string
propertyAddress2
string or null
propertyCity
string
propertyStateID
string
propertyPostalCode
string
accountID
integer
balance
number <double>
managerLedgerID
integer

Response samples

Content type
application/json
[
  • {
    }
]

Negative Bank Accounts

Authorizations:
basicAuth

Responses

Response Schema: application/json
Array
ledgerID
integer
ledgerName
string
ledgerTypeID
integer (ledger_types)
Enum: 1 2 3 4
  • 1 - Manager
  • 2 - Portfolio
  • 3 - Property
  • 4 - Unit
ledgerObjectID
integer
accountID
integer
accountName
string
accountNumber
string
balance
number <double>

Response samples

Content type
application/json
[
  • {
    }
]

Reserve Not Met By Ledger

Authorizations:
basicAuth

Responses

Response Schema: application/json
Array
ledgerID
integer
ledgerName
string
ledgerTypeID
integer (ledger_types)
Enum: 1 2 3 4
  • 1 - Manager
  • 2 - Portfolio
  • 3 - Property
  • 4 - Unit
ledgerObjectID
integer
operatingBalance
number <double>
reserveAmount
number <double>

Response samples

Content type
application/json
[
  • {
    }
]

Escrow Mismatch By Ledger

Authorizations:
basicAuth

Responses

Response Schema: application/json
Array
ledgerID
integer
ledgerName
string
ledgerTypeID
integer (ledger_types)
Enum: 1 2 3 4
  • 1 - Manager
  • 2 - Portfolio
  • 3 - Property
  • 4 - Unit
ledgerObjectID
integer
depositBalance
number <double>
escrowBalance
number <double>

Response samples

Content type
application/json
[
  • {
    }
]

Prepayment Mismatch By Ledger

Authorizations:
basicAuth

Responses

Response Schema: application/json
Array
ledgerID
integer
ledgerName
string
ledgerTypeID
integer (ledger_types)
Enum: 1 2 3 4
  • 1 - Manager
  • 2 - Portfolio
  • 3 - Property
  • 4 - Unit
ledgerObjectID
integer
operatingBalance
number <double>
prepaymentBalance
number <double>

Response samples

Content type
application/json
[
  • {
    }
]

Unused Prepayments

Authorizations:
basicAuth

Responses

Response Schema: application/json
Array
leaseID
integer
tenants
Array of strings
unitID
integer
unitAddress
string
unitAddress2
string
unitCity
string
unitStateID
string
unitPostalCode
string
unitName
string
propertyID
integer
propertyAddress
string
propertyAddress2
string
propertyCity
string
propertyStateID
string
propertyPostalCode
string
propertyName
string
prepaymentBalance
number <double>

Response samples

Content type
application/json
[
  • {
    }
]

Bank Account Reconcialiation Lapse

Authorizations:
basicAuth

Responses

Response Schema: application/json
Array
accountID
integer
name
string
number
string
lastReconciliationDate
string <date>

Response samples

Content type
application/json
[
  • {
    }
]

Vendor Insurance Lapse

Authorizations:
basicAuth

Responses

Response Schema: application/json
Array
contactID
integer
name
string
contactTypeID
integer (contact_types)
Enum: 1 2 3 4 5 6
  • 1 - Owner
  • 2 - Tenant
  • 3 - Vendor
  • 4 - Manager
  • 5 - Association
  • 6 - Applicant
liabilityInsuranceExpiresDate
string <date>
workersCompInsuranceExpiresDate
string <date>

Response samples

Content type
application/json
[
  • {
    }
]

Credit Debit Mismatch

Authorizations:
basicAuth

Responses

Response Schema: application/json
Array
transactionID
integer
transactionTypeID
integer
primaryLedgerID
integer
primaryLedgerName
string
portfolioID
integer
propertyID
integer
propertyName
string
propertyAddress
string
propertyAddress2
string
propertyCity
string
propertyStateID
string
propertyPostalCode
string
unitAddress
string
unitAddress2
string
unitCity
string
unitStateID
string
unitPostalCode
string
unitName
string
unitID
integer
leaseID
integer
billID
integer
datePosted
string <date>
cashCredits
number <double>
cashDebits
number <double>
accrualCredits
number <double>
accrualDebits
number <double>

Response samples

Content type
application/json
[
  • {
    }
]

Manager Ledger Balances

Authorizations:
basicAuth

Responses

Response Schema: application/json
Array
ledgerID
integer
ledgerName
string
ledgerTypeID
integer (ledger_types)
Enum: 1 2 3 4
  • 1 - Manager
  • 2 - Portfolio
  • 3 - Property
  • 4 - Unit
objectID
integer
reserveAmount
number <double>
additionalReserveAmount
number <double>
overdraftOverrideAmount
number <double>
cashBalance
number <double>
escrowBalance
number <double>
prepaymentBalance
number <double>
depositBalance
number <double>
nonHeldDepositBalance
number <double>
accountsReceivableBalance
number <double>
accountsPayableBalance
number <double>
creditBalance
number <double>
currentCreditBalance
number <double>
currentAccountsPayableBalance
number <double>
liabilityBalance
number <double>
nonHeldLiabilityBalance
number <double>
undepositedReceiptsBalance
number <double>
undepositedEscrowReceiptsBalance
number <double>
workOrderEstimateBalance
number <double>
operatingBalance
number <double>
availableFunds
number <double>

Response samples

Content type
application/json
[
  • {
    }
]

Owners

List

Lists owners

Authorizations:
basicAuth

Responses

Response Schema: application/json
Array
object (contact)

Response samples

Content type
application/json
[
  • {
    }
]

Tenants

List

Lists tenants

Authorizations:
basicAuth

Responses

Response Schema: application/json
Array
object (contact)

Response samples

Content type
application/json
[
  • {
    }
]

Vendors

List

Lists vendors

Authorizations:
basicAuth

Responses

Response Schema: application/json
Array
object (contact)

Response samples

Content type
application/json
[
  • {
    }
]

Associations

List

Lists associations

Authorizations:
basicAuth

Responses

Response Schema: application/json
Array
object (contact)

Response samples

Content type
application/json
[
  • {
    }
]

Files

Upload

Uploading a file in Rentvine is generally a 2-step process.

  1. Upload the file to store within Rentvine
  2. Attach the file to an object, e.g. Unit, Lease, etc.

To upload the file and attach it to an object in one step, provide the objectID and objectTypeID as query parameters.

E.g. if you uploaded the file using the path /files?objectTypeID=7&objectID=123, the file would be uploaded and attached to the Unit (object type id for Unit is 7) with unitID of 123.

Authorizations:
basicAuth
query Parameters
objectID
integer

The primary key of the object

objectTypeID
integer

The id of the Object Type

includes
string
Value: "attachment"
  • attachment - Includes the attachment object in the response
Request Body schema: multipart/form-data
file
string <binary>

Responses

Response Schema: application/json
required
object (file)
object (attachment)

Included if attachment provided in includes query parameter

Response samples

Content type
application/json
{
  • "file": {
    },
  • "attachment": {
    }
}

Leases

List

Lists leases

Authorizations:
basicAuth

Responses

Response Schema: application/json
Array
object (lease)
object (unit)

Response samples

Content type
application/json
[
  • {
    }
]

View

Authorizations:
basicAuth

Responses

Response Schema: application/json
leaseID
required
integer
propertyID
required
integer
unitID
required
integer
primaryLeaseStatusID
required
integer (primary_lease_statuses)
Enum: 1 2 3
  • 1 - Pending
  • 2 - Active
  • 3 - Closed
leaseStatusID
required
integer
moveOutStatusID
required
integer (move_out_statuses)
Enum: 1 2 3
  • 1 - None
  • 2 - Active
  • 3 - Completed
moveInDate
required
string <date>
startDate
required
string <date>
dateTimeCreated
required
string <date-time>
lateFeeSettingID
required
integer
isPortalDisabled
required
integer
isPortalPaymentDisabled
required
integer
isLateFeesActive
required
integer
leaseReturnChargeAmount
required
number <double>
isLeaseAgreementViolated
required
integer
tenantRefundPayoutTypeID
required
integer (tenant_refund_payout_types)
Enum: 1 2
  • 1 - Check
  • 2 - ACH
isFromImport
required
integer
isTenantPastDueNoticeEnabled
required
integer
applicationID
integer or null
tenants
string or null
endDate
string or null <date>
tenantLiabilityInsuranceProviderID
integer or null
tenantLiabilityInsuranceEffectiveDate
string or null <date>
rentersInsuranceCompany
string or null
rentersInsurancePolicyNumber
string or null
rentersInsuranceExpirationDate
string or null <date>
rentersInsuranceFileID
integer or null
leaseFeeTransactionID
integer or null
leaseFeeBillID
integer or null
allowedPaymentAmountTypeID
integer or null
isAchDisabled
integer or null
isCreditCardDisabled
integer or null
closedDate
string or null <date>
closedDescription
string or null
noticeDate
string or null <date>
expectedMoveOutDate
string or null <date>
moveOutDate
string or null <date>
depositRefundDueDate
string or null <date>
moveOutReasonID
integer or null
moveOutUnitAvailabilityDate
string or null <date>
moveOutTenantRemarks
string or null
moveOutLeaseTenantID
integer or null
forwardingName
string or null
forwardingCountryID
string or null
forwardingAddress
string or null
forwardingAddress2
string or null
forwardingCity
string or null
forwardingStateID
string or null
forwardingPostalCode
string or null
forwardingEmail
string or null
forwardingPhone
string or null
moveOutTenantReason
string or null
importSourceKey
string or null
rentvineInsuranceEnrollmentID
integer or null
rentvineInsuranceEnrollmentStatusID
integer or null
rentvineInsurancePackageID
integer or null

Response samples

Content type
application/json
{
  • "leaseID": 0,
  • "propertyID": 0,
  • "unitID": 0,
  • "primaryLeaseStatusID": 1,
  • "leaseStatusID": 0,
  • "moveOutStatusID": 1,
  • "applicationID": 0,
  • "tenants": "string",
  • "moveInDate": "2019-08-24",
  • "startDate": "2019-08-24",
  • "endDate": "2019-08-24",
  • "tenantLiabilityInsuranceProviderID": 0,
  • "tenantLiabilityInsuranceEffectiveDate": "2019-08-24",
  • "rentersInsuranceCompany": "string",
  • "rentersInsurancePolicyNumber": "string",
  • "rentersInsuranceExpirationDate": "2019-08-24",
  • "rentersInsuranceFileID": 0,
  • "leaseFeeTransactionID": 0,
  • "leaseFeeBillID": 0,
  • "dateTimeCreated": "2019-08-24T14:15:22Z",
  • "lateFeeSettingID": 0,
  • "isPortalDisabled": 0,
  • "isPortalPaymentDisabled": 0,
  • "isLateFeesActive": 0,
  • "allowedPaymentAmountTypeID": 0,
  • "isAchDisabled": 0,
  • "isCreditCardDisabled": 0,
  • "closedDate": "2019-08-24",
  • "closedDescription": "string",
  • "noticeDate": "2019-08-24",
  • "expectedMoveOutDate": "2019-08-24",
  • "moveOutDate": "2019-08-24",
  • "depositRefundDueDate": "2019-08-24",
  • "leaseReturnChargeAmount": 0,
  • "moveOutReasonID": 0,
  • "moveOutUnitAvailabilityDate": "2019-08-24",
  • "moveOutTenantRemarks": "string",
  • "moveOutLeaseTenantID": 0,
  • "isLeaseAgreementViolated": 0,
  • "forwardingName": "string",
  • "forwardingCountryID": "string",
  • "forwardingAddress": "string",
  • "forwardingAddress2": "string",
  • "forwardingCity": "string",
  • "forwardingStateID": "string",
  • "forwardingPostalCode": "string",
  • "forwardingEmail": "string",
  • "forwardingPhone": "string",
  • "moveOutTenantReason": "string",
  • "tenantRefundPayoutTypeID": 1,
  • "isFromImport": 0,
  • "importSourceKey": "string",
  • "isTenantPastDueNoticeEnabled": 0,
  • "rentvineInsuranceEnrollmentID": 0,
  • "rentvineInsuranceEnrollmentStatusID": 0,
  • "rentvineInsurancePackageID": 0
}

Work Orders

Create

Authorizations:
basicAuth
Request Body schema: application/json
propertyID
required
integer
workOrderStatusID
required
integer

Unique id of the work order status. See Work Order Status API for more information.

priorityID
required
integer (priorities)
Enum: 1 2 3
  • 1 - Low
  • 2 - Medium
  • 3 - High
isOwnerApproved
required
boolean
isVacant
required
boolean
description
required
string
isSharedWithTenant
required
integer
isSharedWithOwner
required
integer
workOrderProjectID
integer or null
unitID
integer or null (unit_id_optional)

The unique id of the Unit object. See the Unit API for more information.

leaseID
integer or null
vendorContactID
integer or null (vendor_contact_id)

The contact id of the vendor contact that the work order has been assigned to.

assignedToUserID
integer or null (assigned_to_user_id)

The Rentvine user id of the user assigned to object.

requestedByContactID
integer or null (requested_by_contact_id)

The contact id of the resident that requested the work order.

estimatedAmount
number or null <double>
scheduledStartDate
string or null <date>
scheduledEndDate
string or null <date>
vendorInstructions
string or null
sourceTypeID
integer (source_types)
Enum: 1 2 3 4 5 6

The method used to create the Work Order. E.g. sourceTypeID 1 indicates that the Work Order was created from the Portal.

  • 1 - Portal
  • 2 - In Person
  • 3 - Email
  • 4 - Text Message
  • 5 - Phone
  • 6 - Recurring
vendorTradeID
integer or null

The unique id of the vendor trade. See Vendor Trades API for more information.

Responses

Response Schema: application/json
workOrderID
required
integer
workOrderNumber
required
integer
portfolioID
required
integer
primaryWorkOrderStatusID
required
integer (primary_statuses)
Enum: 1 2 3 4
  • 1 - Pending
  • 2 - Open
  • 3 - Closed
  • 4 - On Hold
createdByUserID
required
integer (created_by_user_id)

The Rentvine user id of the user that created the object.

dateTimeCreated
required
string <date-time>
modifiedByUserID
required
integer
dateTimeModified
required
string <date-time>
orderIndex
required
integer
propertyID
required
integer
workOrderStatusID
required
integer

Unique id of the work order status. See Work Order Status API for more information.

priorityID
required
integer (priorities)
Enum: 1 2 3
  • 1 - Low
  • 2 - Medium
  • 3 - High
isOwnerApproved
required
boolean
isVacant
required
boolean
description
required
string
isSharedWithTenant
required
integer
isSharedWithOwner
required
integer
actualStartDate
string or null <date>
actualEndDate
string or null <date>
dateClosed
string or null <date>
closingDescription
string or null
inspectionID
integer or null
incidentLocation
string or null
appointmentWindowStartDateTime
string or null <date-time>
appointmentWindowEndDateTime
string or null <date-time>
workOrderProjectID
integer or null
unitID
integer or null (unit_id_optional)

The unique id of the Unit object. See the Unit API for more information.

leaseID
integer or null
vendorContactID
integer or null (vendor_contact_id)

The contact id of the vendor contact that the work order has been assigned to.

assignedToUserID
integer or null (assigned_to_user_id)

The Rentvine user id of the user assigned to object.

requestedByContactID
integer or null (requested_by_contact_id)

The contact id of the resident that requested the work order.

estimatedAmount
number or null <double>
scheduledStartDate
string or null <date>
scheduledEndDate
string or null <date>
vendorInstructions
string or null
sourceTypeID
integer (source_types)
Enum: 1 2 3 4 5 6

The method used to create the Work Order. E.g. sourceTypeID 1 indicates that the Work Order was created from the Portal.

  • 1 - Portal
  • 2 - In Person
  • 3 - Email
  • 4 - Text Message
  • 5 - Phone
  • 6 - Recurring
vendorTradeID
integer or null

The unique id of the vendor trade. See Vendor Trades API for more information.

Request samples

Content type
application/json
{
  • "workOrderProjectID": 0,
  • "propertyID": 0,
  • "unitID": 0,
  • "leaseID": 0,
  • "vendorContactID": 0,
  • "workOrderStatusID": 0,
  • "priorityID": 1,
  • "isOwnerApproved": true,
  • "isVacant": true,
  • "assignedToUserID": 0,
  • "requestedByContactID": 0,
  • "estimatedAmount": 0,
  • "scheduledStartDate": "2019-08-24",
  • "scheduledEndDate": "2019-08-24",
  • "description": "string",
  • "vendorInstructions": "string",
  • "isSharedWithTenant": 0,
  • "isSharedWithOwner": 0,
  • "sourceTypeID": 1,
  • "vendorTradeID": 0
}

Response samples

Content type
application/json
{
  • "workOrderID": 0,
  • "workOrderNumber": 0,
  • "portfolioID": 0,
  • "primaryWorkOrderStatusID": 1,
  • "actualStartDate": "2019-08-24",
  • "actualEndDate": "2019-08-24",
  • "dateClosed": "2019-08-24",
  • "closingDescription": "string",
  • "createdByUserID": 0,
  • "dateTimeCreated": "2019-08-24T14:15:22Z",
  • "modifiedByUserID": 0,
  • "dateTimeModified": "2019-08-24T14:15:22Z",
  • "inspectionID": 0,
  • "incidentLocation": "string",
  • "appointmentWindowStartDateTime": "2019-08-24T14:15:22Z",
  • "appointmentWindowEndDateTime": "2019-08-24T14:15:22Z",
  • "orderIndex": 0,
  • "workOrderProjectID": 0,
  • "propertyID": 0,
  • "unitID": 0,
  • "leaseID": 0,
  • "vendorContactID": 0,
  • "workOrderStatusID": 0,
  • "priorityID": 1,
  • "isOwnerApproved": true,
  • "isVacant": true,
  • "assignedToUserID": 0,
  • "requestedByContactID": 0,
  • "estimatedAmount": 0,
  • "scheduledStartDate": "2019-08-24",
  • "scheduledEndDate": "2019-08-24",
  • "description": "string",
  • "vendorInstructions": "string",
  • "isSharedWithTenant": 0,
  • "isSharedWithOwner": 0,
  • "sourceTypeID": 1,
  • "vendorTradeID": 0
}

List

List work orders

Authorizations:
basicAuth
query Parameters
page
integer
Default: 1

The page number for pagination

pageSize
integer
Default: 15

Number of items per page

Responses

Response Schema: application/json
Array
workOrderID
required
integer
workOrderNumber
required
integer
portfolioID
required
integer
primaryWorkOrderStatusID
required
integer (primary_statuses)
Enum: 1 2 3 4
  • 1 - Pending
  • 2 - Open
  • 3 - Closed
  • 4 - On Hold
createdByUserID
required
integer (created_by_user_id)

The Rentvine user id of the user that created the object.

dateTimeCreated
required
string <date-time>
modifiedByUserID
required
integer
dateTimeModified
required
string <date-time>
orderIndex
required
integer
propertyID
required
integer
workOrderStatusID
required
integer

Unique id of the work order status. See Work Order Status API for more information.

priorityID
required
integer (priorities)
Enum: 1 2 3
  • 1 - Low
  • 2 - Medium
  • 3 - High
isOwnerApproved
required
boolean
isVacant
required
boolean
description
required
string
isSharedWithTenant
required
integer
isSharedWithOwner
required
integer
actualStartDate
string or null <date>
actualEndDate
string or null <date>
dateClosed
string or null <date>
closingDescription
string or null
inspectionID
integer or null
incidentLocation
string or null
appointmentWindowStartDateTime
string or null <date-time>
appointmentWindowEndDateTime
string or null <date-time>
workOrderProjectID
integer or null
unitID
integer or null (unit_id_optional)

The unique id of the Unit object. See the Unit API for more information.

leaseID
integer or null
vendorContactID
integer or null (vendor_contact_id)

The contact id of the vendor contact that the work order has been assigned to.

assignedToUserID
integer or null (assigned_to_user_id)

The Rentvine user id of the user assigned to object.

requestedByContactID
integer or null (requested_by_contact_id)

The contact id of the resident that requested the work order.

estimatedAmount
number or null <double>
scheduledStartDate
string or null <date>
scheduledEndDate
string or null <date>
vendorInstructions
string or null
sourceTypeID
integer (source_types)
Enum: 1 2 3 4 5 6

The method used to create the Work Order. E.g. sourceTypeID 1 indicates that the Work Order was created from the Portal.

  • 1 - Portal
  • 2 - In Person
  • 3 - Email
  • 4 - Text Message
  • 5 - Phone
  • 6 - Recurring
vendorTradeID
integer or null

The unique id of the vendor trade. See Vendor Trades API for more information.

Response samples

Content type
application/json
[
  • {
    }
]

View

View work order

Authorizations:
basicAuth
path Parameters
workOrderID
required
integer

Responses

Response Schema: application/json
workOrderID
required
integer
workOrderNumber
required
integer
portfolioID
required
integer
primaryWorkOrderStatusID
required
integer (primary_statuses)
Enum: 1 2 3 4
  • 1 - Pending
  • 2 - Open
  • 3 - Closed
  • 4 - On Hold
createdByUserID
required
integer (created_by_user_id)

The Rentvine user id of the user that created the object.

dateTimeCreated
required
string <date-time>
modifiedByUserID
required
integer
dateTimeModified
required
string <date-time>
orderIndex
required
integer
propertyID
required
integer
workOrderStatusID
required
integer

Unique id of the work order status. See Work Order Status API for more information.

priorityID
required
integer (priorities)
Enum: 1 2 3
  • 1 - Low
  • 2 - Medium
  • 3 - High
isOwnerApproved
required
boolean
isVacant
required
boolean
description
required
string
isSharedWithTenant
required
integer
isSharedWithOwner
required
integer
actualStartDate
string or null <date>
actualEndDate
string or null <date>
dateClosed
string or null <date>
closingDescription
string or null
inspectionID
integer or null
incidentLocation
string or null
appointmentWindowStartDateTime
string or null <date-time>
appointmentWindowEndDateTime
string or null <date-time>
workOrderProjectID
integer or null
unitID
integer or null (unit_id_optional)

The unique id of the Unit object. See the Unit API for more information.

leaseID
integer or null
vendorContactID
integer or null (vendor_contact_id)

The contact id of the vendor contact that the work order has been assigned to.

assignedToUserID
integer or null (assigned_to_user_id)

The Rentvine user id of the user assigned to object.

requestedByContactID
integer or null (requested_by_contact_id)

The contact id of the resident that requested the work order.

estimatedAmount
number or null <double>
scheduledStartDate
string or null <date>
scheduledEndDate
string or null <date>
vendorInstructions
string or null
sourceTypeID
integer (source_types)
Enum: 1 2 3 4 5 6

The method used to create the Work Order. E.g. sourceTypeID 1 indicates that the Work Order was created from the Portal.

  • 1 - Portal
  • 2 - In Person
  • 3 - Email
  • 4 - Text Message
  • 5 - Phone
  • 6 - Recurring
vendorTradeID
integer or null

The unique id of the vendor trade. See Vendor Trades API for more information.

Response samples

Content type
application/json
{
  • "workOrderID": 0,
  • "workOrderNumber": 0,
  • "portfolioID": 0,
  • "primaryWorkOrderStatusID": 1,
  • "actualStartDate": "2019-08-24",
  • "actualEndDate": "2019-08-24",
  • "dateClosed": "2019-08-24",
  • "closingDescription": "string",
  • "createdByUserID": 0,
  • "dateTimeCreated": "2019-08-24T14:15:22Z",
  • "modifiedByUserID": 0,
  • "dateTimeModified": "2019-08-24T14:15:22Z",
  • "inspectionID": 0,
  • "incidentLocation": "string",
  • "appointmentWindowStartDateTime": "2019-08-24T14:15:22Z",
  • "appointmentWindowEndDateTime": "2019-08-24T14:15:22Z",
  • "orderIndex": 0,
  • "workOrderProjectID": 0,
  • "propertyID": 0,
  • "unitID": 0,
  • "leaseID": 0,
  • "vendorContactID": 0,
  • "workOrderStatusID": 0,
  • "priorityID": 1,
  • "isOwnerApproved": true,
  • "isVacant": true,
  • "assignedToUserID": 0,
  • "requestedByContactID": 0,
  • "estimatedAmount": 0,
  • "scheduledStartDate": "2019-08-24",
  • "scheduledEndDate": "2019-08-24",
  • "description": "string",
  • "vendorInstructions": "string",
  • "isSharedWithTenant": 0,
  • "isSharedWithOwner": 0,
  • "sourceTypeID": 1,
  • "vendorTradeID": 0
}

Work Order Statuses

Create

Authorizations:
basicAuth
Request Body schema: application/json
primaryWorkOrderStatusID
required
integer (primary_statuses)
Enum: 1 2 3 4
  • 1 - Pending
  • 2 - Open
  • 3 - Closed
  • 4 - On Hold
name
required
string

The name of the status

Responses

Response Schema: application/json
primaryWorkOrderStatusID
required
integer (primary_statuses)
Enum: 1 2 3 4
  • 1 - Pending
  • 2 - Open
  • 3 - Closed
  • 4 - On Hold
name
required
string

The name of the status

workOrderStatusID
required
integer
isSystemStatus
required
integer

Indicates if the status is one of the 7 system statuses (Open, Completed, Cancelled, Requested, On Hold, Estimating, Rejected). Statuses created by user will not be a system status.

orderIndex
integer

Request samples

Content type
application/json
{
  • "primaryWorkOrderStatusID": 1,
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "primaryWorkOrderStatusID": 1,
  • "name": "string",
  • "workOrderStatusID": 0,
  • "isSystemStatus": 0,
  • "orderIndex": 0
}

List

List work order statuses

Authorizations:
basicAuth

Responses

Response Schema: application/json
primaryWorkOrderStatusID
required
integer (primary_statuses)
Enum: 1 2 3 4
  • 1 - Pending
  • 2 - Open
  • 3 - Closed
  • 4 - On Hold
name
required
string

The name of the status

workOrderStatusID
required
integer
isSystemStatus
required
integer

Indicates if the status is one of the 7 system statuses (Open, Completed, Cancelled, Requested, On Hold, Estimating, Rejected). Statuses created by user will not be a system status.

orderIndex
integer

Response samples

Content type
application/json
{
  • "primaryWorkOrderStatusID": 1,
  • "name": "string",
  • "workOrderStatusID": 0,
  • "isSystemStatus": 0,
  • "orderIndex": 0
}

View

View work order status

Authorizations:
basicAuth
path Parameters
workOrderStatusID
required
integer

Responses

Response Schema: application/json
primaryWorkOrderStatusID
required
integer (primary_statuses)
Enum: 1 2 3 4
  • 1 - Pending
  • 2 - Open
  • 3 - Closed
  • 4 - On Hold
name
required
string

The name of the status

workOrderStatusID
required
integer
isSystemStatus
required
integer

Indicates if the status is one of the 7 system statuses (Open, Completed, Cancelled, Requested, On Hold, Estimating, Rejected). Statuses created by user will not be a system status.

orderIndex
integer

Response samples

Content type
application/json
{
  • "primaryWorkOrderStatusID": 1,
  • "name": "string",
  • "workOrderStatusID": 0,
  • "isSystemStatus": 0,
  • "orderIndex": 0
}

Vendor Trades

Create

Authorizations:
basicAuth
Request Body schema: application/json
name
required
string

Name of the vendor trade

isVisibleTenantPortal
required
boolean

Indicates whether the trade is visible to the resident when they are creating work orders.

Responses

Response Schema: application/json
vendorTradeID
required
integer
name
required
string

Name of the vendor trade

isVisibleTenantPortal
required
boolean

Indicates whether the trade is visible to the resident when they are creating work orders.

Request samples

Content type
application/json
{
  • "name": "string",
  • "isVisibleTenantPortal": true
}

Response samples

Content type
application/json
{
  • "vendorTradeID": 0,
  • "name": "string",
  • "isVisibleTenantPortal": true
}

List

List vendor trades

Authorizations:
basicAuth

Responses

Response Schema: application/json
Array
vendorTradeID
required
integer
name
required
string

Name of the vendor trade

isVisibleTenantPortal
required
boolean

Indicates whether the trade is visible to the resident when they are creating work orders.

Response samples

Content type
application/json
[
  • {
    }
]

View

View vendor trade

Authorizations:
basicAuth
path Parameters
vendorTradeID
required
integer

Responses

Response Schema: application/json
vendorTradeID
required
integer
name
required
string

Name of the vendor trade

isVisibleTenantPortal
required
boolean

Indicates whether the trade is visible to the resident when they are creating work orders.

Response samples

Content type
application/json
{
  • "vendorTradeID": 0,
  • "name": "string",
  • "isVisibleTenantPortal": true
}

Inspections

Create

Authorizations:
basicAuth
Request Body schema: application/json
unitID
required
integer (unit_id_required)

The unique id of the Unit object. See the Unit API for more information.

inspectionTypeID
required
integer (inspection_types)
Enum: 1 2 3 4
  • 1 - Pre-Inspection
  • 2 - Move In
  • 3 - Move Out
  • 4 - Inspection
inspectionStatusID
required
integer (inspection_statuses)
Enum: 1 2 3 4
  • 1 - Pending
  • 2 - In Progress
  • 3 - Pending Maintenance
  • 4 - Completed
description
string or null
scheduledDate
string or null <date>
inspectionDate
string or null <date>

Responses

Response Schema: application/json
inspectionID
required
integer
propertyID
required
integer
dateTimeCreated
required
string <date>
unitID
required
integer (unit_id_required)

The unique id of the Unit object. See the Unit API for more information.

inspectionTypeID
required
integer (inspection_types)
Enum: 1 2 3 4
  • 1 - Pre-Inspection
  • 2 - Move In
  • 3 - Move Out
  • 4 - Inspection
inspectionStatusID
required
integer (inspection_statuses)
Enum: 1 2 3 4
  • 1 - Pending
  • 2 - In Progress
  • 3 - Pending Maintenance
  • 4 - Completed
leaseID
integer or null
assignedToUserID
integer or null (assigned_to_user_id)

The Rentvine user id of the user assigned to object.

description
string or null
scheduledDate
string or null <date>
inspectionDate
string or null <date>

Request samples

Content type
application/json
{
  • "unitID": 0,
  • "inspectionTypeID": 1,
  • "inspectionStatusID": 1,
  • "description": "string",
  • "scheduledDate": "2019-08-24",
  • "inspectionDate": "2019-08-24"
}

Response samples

Content type
application/json
{
  • "inspectionID": 0,
  • "propertyID": 0,
  • "leaseID": 0,
  • "assignedToUserID": 0,
  • "dateTimeCreated": "2019-08-24",
  • "unitID": 0,
  • "inspectionTypeID": 1,
  • "inspectionStatusID": 1,
  • "description": "string",
  • "scheduledDate": "2019-08-24",
  • "inspectionDate": "2019-08-24"
}

List

List of inspections

Authorizations:
basicAuth
query Parameters
page
integer
Default: 1

The page number for pagination

pageSize
integer
Default: 15

Number of items per page

Responses

Response Schema: application/json
Array
inspectionID
required
integer
propertyID
required
integer
dateTimeCreated
required
string <date>
unitID
required
integer (unit_id_required)

The unique id of the Unit object. See the Unit API for more information.

inspectionTypeID
required
integer (inspection_types)
Enum: 1 2 3 4
  • 1 - Pre-Inspection
  • 2 - Move In
  • 3 - Move Out
  • 4 - Inspection
inspectionStatusID
required
integer (inspection_statuses)
Enum: 1 2 3 4
  • 1 - Pending
  • 2 - In Progress
  • 3 - Pending Maintenance
  • 4 - Completed
leaseID
integer or null
assignedToUserID
integer or null (assigned_to_user_id)

The Rentvine user id of the user assigned to object.

description
string or null
scheduledDate
string or null <date>
inspectionDate
string or null <date>

Response samples

Content type
application/json
[
  • {
    }
]

View

View inspection

Authorizations:
basicAuth
path Parameters
inspectionID
required
integer

Responses

Response Schema: application/json
inspectionID
required
integer
propertyID
required
integer
dateTimeCreated
required
string <date>
unitID
required
integer (unit_id_required)

The unique id of the Unit object. See the Unit API for more information.

inspectionTypeID
required
integer (inspection_types)
Enum: 1 2 3 4
  • 1 - Pre-Inspection
  • 2 - Move In
  • 3 - Move Out
  • 4 - Inspection
inspectionStatusID
required
integer (inspection_statuses)
Enum: 1 2 3 4
  • 1 - Pending
  • 2 - In Progress
  • 3 - Pending Maintenance
  • 4 - Completed
leaseID
integer or null
assignedToUserID
integer or null (assigned_to_user_id)

The Rentvine user id of the user assigned to object.

description
string or null
scheduledDate
string or null <date>
inspectionDate
string or null <date>

Response samples

Content type
application/json
{
  • "inspectionID": 0,
  • "propertyID": 0,
  • "leaseID": 0,
  • "assignedToUserID": 0,
  • "dateTimeCreated": "2019-08-24",
  • "unitID": 0,
  • "inspectionTypeID": 1,
  • "inspectionStatusID": 1,
  • "description": "string",
  • "scheduledDate": "2019-08-24",
  • "inspectionDate": "2019-08-24"
}

Portfolios

List

Lists portfolios

Authorizations:
basicAuth
query Parameters
isActive
boolean
pageSize
integer
Default: 25

Number of items per page

Responses

Response Schema: application/json
Array
object (portfolio)
object (statement_setting)

Response samples

Content type
application/json
[
  • {
    }
]

Properties

List

Lists properties

Authorizations:
basicAuth
query Parameters
page
integer
Default: 1

The page number for pagination

pageSize
integer
Default: 25

Number of items per page

Responses

Response Schema: application/json
Array
propertyID
required
integer
propertyImageID
required
integer
propertyTypeID
required
integer (property_types)
Enum: 1 2 3 4 5 6 7 8 9 10
  • 1 - Single Family Home
  • 2 - Apartment
  • 3 - Condo
  • 4 - Townhouse
  • 5 - Duplex
  • 6 - Multiplex
  • 7 - Loft
  • 8 - MobileHome
  • 9 - Commercial
  • 10 - Garage
isMultiUnit
required
boolean
portfolioID
required
integer

Unique id of the portfolio the property belongs to

managementFeeSettingID
required
integer

Unique id of the management fee setting to use for this property

countryID
required
string

2-digit country code for the property, ex. US

address
required
string
stateID
required
string

2-digit state code for the property, ex. FL

city
required
string
latitude
required
number <double>

The latitude for the property address. If not given, it will be calculated based on the property address.

longitude
required
number <double>

The longitude for the property address. If not given, it will be calculated based on the property address.

dateTimeCreated
required
string <date-time>
reserveAmount
required
number <double>
isActive
required
boolean
isFromImport
required
integer
name
string or null
streetNumber
integer or null
streetName
string or null
address2
string or null
postalCode
string or null
county
string or null
maintenanceLimitAmount
number or null <double>
yearBuilt
integer or null
dateInsuranceExpires
string or null <date>
dateWarrantyExpires
string or null <date>
dateContractBegins
string or null <date>
dateContractEnds
string or null <date>
legalDescription
string or null
maintenanceNotes
string or null
applicationTemplateID
integer or null
commercialClassTypeID
integer or null
salesTaxSettingID
integer or null
insuranceCompany
string or null
insuranceAgent
string or null
insurancePolicyNumber
string or null
insuranceContactDetails
string or null
leaseReturnChargeAmount
number or null <double>
propertyShowingProviderID
integer or null
importSourceKey
string or null

Response samples

Content type
application/json
[
  • {
    }
]

Create

Creating a property will also create the associated Unit record.

Authorizations:
basicAuth
Request Body schema: application/json
One of
object (property)
object (unit_for_property_create)

Responses

Response Schema: application/json
propertyID
required
integer
propertyImageID
required
integer
propertyTypeID
required
integer (property_types)
Enum: 1 2 3 4 5 6 7 8 9 10
  • 1 - Single Family Home
  • 2 - Apartment
  • 3 - Condo
  • 4 - Townhouse
  • 5 - Duplex
  • 6 - Multiplex
  • 7 - Loft
  • 8 - MobileHome
  • 9 - Commercial
  • 10 - Garage
isMultiUnit
required
boolean
portfolioID
required
integer

Unique id of the portfolio the property belongs to

managementFeeSettingID
required
integer

Unique id of the management fee setting to use for this property

countryID
required
string

2-digit country code for the property, ex. US

address
required
string
stateID
required
string

2-digit state code for the property, ex. FL

city
required
string
latitude
required
number <double>

The latitude for the property address. If not given, it will be calculated based on the property address.

longitude
required
number <double>

The longitude for the property address. If not given, it will be calculated based on the property address.

dateTimeCreated
required
string <date-time>
reserveAmount
required
number <double>
isActive
required
boolean
isFromImport
required
integer
name
string or null
streetNumber
integer or null
streetName
string or null
address2
string or null
postalCode
string or null
county
string or null
maintenanceLimitAmount
number or null <double>
yearBuilt
integer or null
dateInsuranceExpires
string or null <date>
dateWarrantyExpires
string or null <date>
dateContractBegins
string or null <date>
dateContractEnds
string or null <date>
legalDescription
string or null
maintenanceNotes
string or null
applicationTemplateID
integer or null
commercialClassTypeID
integer or null
salesTaxSettingID
integer or null
insuranceCompany
string or null
insuranceAgent
string or null
insurancePolicyNumber
string or null
insuranceContactDetails
string or null
leaseReturnChargeAmount
number or null <double>
propertyShowingProviderID
integer or null
importSourceKey
string or null

Request samples

Content type
application/json
Example
{
  • "property": {
    },
  • "unit": {
    },
  • "attachments": [ ]
}

Response samples

Content type
application/json
{
  • "propertyID": 0,
  • "propertyTypeID": 1,
  • "isMultiUnit": true,
  • "portfolioID": 0,
  • "managementFeeSettingID": 0,
  • "name": "string",
  • "countryID": "US",
  • "address": "string",
  • "streetNumber": 0,
  • "streetName": "string",
  • "address2": "string",
  • "stateID": "FL",
  • "city": "string",
  • "postalCode": "string",
  • "latitude": 0,
  • "longitude": 0,
  • "county": "string",
  • "dateTimeCreated": "2019-08-24T14:15:22Z",
  • "maintenanceLimitAmount": 0,
  • "yearBuilt": 0,
  • "dateInsuranceExpires": "2019-08-24",
  • "dateWarrantyExpires": "2019-08-24",
  • "reserveAmount": 0,
  • "dateContractBegins": "2019-08-24",
  • "dateContractEnds": "2019-08-24",
  • "propertyImageID": 0,
  • "isActive": true,
  • "legalDescription": "string",
  • "maintenanceNotes": "string",
  • "applicationTemplateID": 0,
  • "commercialClassTypeID": 0,
  • "salesTaxSettingID": 0,
  • "insuranceCompany": "string",
  • "insuranceAgent": "string",
  • "insurancePolicyNumber": "string",
  • "insuranceContactDetails": "string",
  • "leaseReturnChargeAmount": 0,
  • "propertyShowingProviderID": 0,
  • "isFromImport": 0,
  • "importSourceKey": "string"
}

View

Retrieves a single property.

Authorizations:
basicAuth
path Parameters
propertyID
required
string

The Unique Property ID

Responses

Response Schema: application/json
propertyID
required
integer
propertyImageID
required
integer
propertyTypeID
required
integer (property_types)
Enum: 1 2 3 4 5 6 7 8 9 10
  • 1 - Single Family Home
  • 2 - Apartment
  • 3 - Condo
  • 4 - Townhouse
  • 5 - Duplex
  • 6 - Multiplex
  • 7 - Loft
  • 8 - MobileHome
  • 9 - Commercial
  • 10 - Garage
isMultiUnit
required
boolean
portfolioID
required
integer

Unique id of the portfolio the property belongs to

managementFeeSettingID
required
integer

Unique id of the management fee setting to use for this property

countryID
required
string

2-digit country code for the property, ex. US

address
required
string
stateID
required
string

2-digit state code for the property, ex. FL

city
required
string
latitude
required
number <double>

The latitude for the property address. If not given, it will be calculated based on the property address.

longitude
required
number <double>

The longitude for the property address. If not given, it will be calculated based on the property address.

dateTimeCreated
required
string <date-time>
reserveAmount
required
number <double>
isActive
required
boolean
isFromImport
required
integer
name
string or null
streetNumber
integer or null
streetName
string or null
address2
string or null
postalCode
string or null
county
string or null
maintenanceLimitAmount
number or null <double>
yearBuilt
integer or null
dateInsuranceExpires
string or null <date>
dateWarrantyExpires
string or null <date>
dateContractBegins
string or null <date>
dateContractEnds
string or null <date>
legalDescription
string or null
maintenanceNotes
string or null
applicationTemplateID
integer or null
commercialClassTypeID
integer or null
salesTaxSettingID
integer or null
insuranceCompany
string or null
insuranceAgent
string or null
insurancePolicyNumber
string or null
insuranceContactDetails
string or null
leaseReturnChargeAmount
number or null <double>
propertyShowingProviderID
integer or null
importSourceKey
string or null

Response samples

Content type
application/json
{
  • "propertyID": 0,
  • "propertyTypeID": 1,
  • "isMultiUnit": true,
  • "portfolioID": 0,
  • "managementFeeSettingID": 0,
  • "name": "string",
  • "countryID": "US",
  • "address": "string",
  • "streetNumber": 0,
  • "streetName": "string",
  • "address2": "string",
  • "stateID": "FL",
  • "city": "string",
  • "postalCode": "string",
  • "latitude": 0,
  • "longitude": 0,
  • "county": "string",
  • "dateTimeCreated": "2019-08-24T14:15:22Z",
  • "maintenanceLimitAmount": 0,
  • "yearBuilt": 0,
  • "dateInsuranceExpires": "2019-08-24",
  • "dateWarrantyExpires": "2019-08-24",
  • "reserveAmount": 0,
  • "dateContractBegins": "2019-08-24",
  • "dateContractEnds": "2019-08-24",
  • "propertyImageID": 0,
  • "isActive": true,
  • "legalDescription": "string",
  • "maintenanceNotes": "string",
  • "applicationTemplateID": 0,
  • "commercialClassTypeID": 0,
  • "salesTaxSettingID": 0,
  • "insuranceCompany": "string",
  • "insuranceAgent": "string",
  • "insurancePolicyNumber": "string",
  • "insuranceContactDetails": "string",
  • "leaseReturnChargeAmount": 0,
  • "propertyShowingProviderID": 0,
  • "isFromImport": 0,
  • "importSourceKey": "string"
}

Update

Authorizations:
basicAuth
path Parameters
propertyID
required
integer
Example: 707
Request Body schema: application/json
propertyTypeID
required
integer (property_types)
Enum: 1 2 3 4 5 6 7 8 9 10
  • 1 - Single Family Home
  • 2 - Apartment
  • 3 - Condo
  • 4 - Townhouse
  • 5 - Duplex
  • 6 - Multiplex
  • 7 - Loft
  • 8 - MobileHome
  • 9 - Commercial
  • 10 - Garage
isMultiUnit
required
boolean
portfolioID
required
integer

Unique id of the portfolio the property belongs to

managementFeeSettingID
required
integer

Unique id of the management fee setting to use for this property

countryID
required
string

2-digit country code for the property, ex. US

address
required
string
stateID
required
string

2-digit state code for the property, ex. FL

city
required
string
latitude
required
number <double>

The latitude for the property address. If not given, it will be calculated based on the property address.

longitude
required
number <double>

The longitude for the property address. If not given, it will be calculated based on the property address.

reserveAmount
required
number <double>
name
string or null
address2
string or null
postalCode
string or null
county
string or null
maintenanceLimitAmount
number or null <double>
yearBuilt
integer or null
dateInsuranceExpires
string or null <date>
dateWarrantyExpires
string or null <date>
dateContractBegins
string or null <date>
dateContractEnds
string or null <date>

Responses

Response Schema: application/json
propertyID
required
integer
propertyImageID
required
integer
propertyTypeID
required
integer (property_types)
Enum: 1 2 3 4 5 6 7 8 9 10
  • 1 - Single Family Home
  • 2 - Apartment
  • 3 - Condo
  • 4 - Townhouse
  • 5 - Duplex
  • 6 - Multiplex
  • 7 - Loft
  • 8 - MobileHome
  • 9 - Commercial
  • 10 - Garage
isMultiUnit
required
boolean
portfolioID
required
integer

Unique id of the portfolio the property belongs to

managementFeeSettingID
required
integer

Unique id of the management fee setting to use for this property

countryID
required
string

2-digit country code for the property, ex. US

address
required
string
stateID
required
string

2-digit state code for the property, ex. FL

city
required
string
latitude
required
number <double>

The latitude for the property address. If not given, it will be calculated based on the property address.

longitude
required
number <double>

The longitude for the property address. If not given, it will be calculated based on the property address.

dateTimeCreated
required
string <date-time>
reserveAmount
required
number <double>
isActive
required
boolean
isFromImport
required
integer
name
string or null
streetNumber
integer or null
streetName
string or null
address2
string or null
postalCode
string or null
county
string or null
maintenanceLimitAmount
number or null <double>
yearBuilt
integer or null
dateInsuranceExpires
string or null <date>
dateWarrantyExpires
string or null <date>
dateContractBegins
string or null <date>
dateContractEnds
string or null <date>
legalDescription
string or null
maintenanceNotes
string or null
applicationTemplateID
integer or null
commercialClassTypeID
integer or null
salesTaxSettingID
integer or null
insuranceCompany
string or null
insuranceAgent
string or null
insurancePolicyNumber
string or null
insuranceContactDetails
string or null
leaseReturnChargeAmount
number or null <double>
propertyShowingProviderID
integer or null
importSourceKey
string or null

Request samples

Content type
application/json
{
  • "propertyTypeID": 1,
  • "isMultiUnit": true,
  • "portfolioID": 0,
  • "managementFeeSettingID": 0,
  • "name": "string",
  • "countryID": "US",
  • "address": "string",
  • "address2": "string",
  • "stateID": "FL",
  • "city": "string",
  • "postalCode": "string",
  • "latitude": 0,
  • "longitude": 0,
  • "county": "string",
  • "maintenanceLimitAmount": 0,
  • "yearBuilt": 0,
  • "dateInsuranceExpires": "2019-08-24",
  • "dateWarrantyExpires": "2019-08-24",
  • "reserveAmount": 0,
  • "dateContractBegins": "2019-08-24",
  • "dateContractEnds": "2019-08-24"
}

Response samples

Content type
application/json
{
  • "propertyID": 0,
  • "propertyTypeID": 1,
  • "isMultiUnit": true,
  • "portfolioID": 0,
  • "managementFeeSettingID": 0,
  • "name": "string",
  • "countryID": "US",
  • "address": "string",
  • "streetNumber": 0,
  • "streetName": "string",
  • "address2": "string",
  • "stateID": "FL",
  • "city": "string",
  • "postalCode": "string",
  • "latitude": 0,
  • "longitude": 0,
  • "county": "string",
  • "dateTimeCreated": "2019-08-24T14:15:22Z",
  • "maintenanceLimitAmount": 0,
  • "yearBuilt": 0,
  • "dateInsuranceExpires": "2019-08-24",
  • "dateWarrantyExpires": "2019-08-24",
  • "reserveAmount": 0,
  • "dateContractBegins": "2019-08-24",
  • "dateContractEnds": "2019-08-24",
  • "propertyImageID": 0,
  • "isActive": true,
  • "legalDescription": "string",
  • "maintenanceNotes": "string",
  • "applicationTemplateID": 0,
  • "commercialClassTypeID": 0,
  • "salesTaxSettingID": 0,
  • "insuranceCompany": "string",
  • "insuranceAgent": "string",
  • "insurancePolicyNumber": "string",
  • "insuranceContactDetails": "string",
  • "leaseReturnChargeAmount": 0,
  • "propertyShowingProviderID": 0,
  • "isFromImport": 0,
  • "importSourceKey": "string"
}

Delete

Authorizations:
basicAuth
path Parameters
propertyID
required
integer
Example: 707

Responses

Response Schema: application/json
propertyID
required
integer
propertyImageID
required
integer
propertyTypeID
required
integer (property_types)
Enum: 1 2 3 4 5 6 7 8 9 10
  • 1 - Single Family Home
  • 2 - Apartment
  • 3 - Condo
  • 4 - Townhouse
  • 5 - Duplex
  • 6 - Multiplex
  • 7 - Loft
  • 8 - MobileHome
  • 9 - Commercial
  • 10 - Garage
isMultiUnit
required
boolean
portfolioID
required
integer

Unique id of the portfolio the property belongs to

managementFeeSettingID
required
integer

Unique id of the management fee setting to use for this property

countryID
required
string

2-digit country code for the property, ex. US

address
required
string
stateID
required
string

2-digit state code for the property, ex. FL

city
required
string
latitude
required
number <double>

The latitude for the property address. If not given, it will be calculated based on the property address.

longitude
required
number <double>

The longitude for the property address. If not given, it will be calculated based on the property address.

dateTimeCreated
required
string <date-time>
reserveAmount
required
number <double>
isActive
required
boolean
isFromImport
required
integer
name
string or null
streetNumber
integer or null
streetName
string or null
address2
string or null
postalCode
string or null
county
string or null
maintenanceLimitAmount
number or null <double>
yearBuilt
integer or null
dateInsuranceExpires
string or null <date>
dateWarrantyExpires
string or null <date>
dateContractBegins
string or null <date>
dateContractEnds
string or null <date>
legalDescription
string or null
maintenanceNotes
string or null
applicationTemplateID
integer or null
commercialClassTypeID
integer or null
salesTaxSettingID
integer or null
insuranceCompany
string or null
insuranceAgent
string or null
insurancePolicyNumber
string or null
insuranceContactDetails
string or null
leaseReturnChargeAmount
number or null <double>
propertyShowingProviderID
integer or null
importSourceKey
string or null

Response samples

Content type
application/json
{
  • "propertyID": 0,
  • "propertyTypeID": 1,
  • "isMultiUnit": true,
  • "portfolioID": 0,
  • "managementFeeSettingID": 0,
  • "name": "string",
  • "countryID": "US",
  • "address": "string",
  • "streetNumber": 0,
  • "streetName": "string",
  • "address2": "string",
  • "stateID": "FL",
  • "city": "string",
  • "postalCode": "string",
  • "latitude": 0,
  • "longitude": 0,
  • "county": "string",
  • "dateTimeCreated": "2019-08-24T14:15:22Z",
  • "maintenanceLimitAmount": 0,
  • "yearBuilt": 0,
  • "dateInsuranceExpires": "2019-08-24",
  • "dateWarrantyExpires": "2019-08-24",
  • "reserveAmount": 0,
  • "dateContractBegins": "2019-08-24",
  • "dateContractEnds": "2019-08-24",
  • "propertyImageID": 0,
  • "isActive": true,
  • "legalDescription": "string",
  • "maintenanceNotes": "string",
  • "applicationTemplateID": 0,
  • "commercialClassTypeID": 0,
  • "salesTaxSettingID": 0,
  • "insuranceCompany": "string",
  • "insuranceAgent": "string",
  • "insurancePolicyNumber": "string",
  • "insuranceContactDetails": "string",
  • "leaseReturnChargeAmount": 0,
  • "propertyShowingProviderID": 0,
  • "isFromImport": 0,
  • "importSourceKey": "string"
}

Deactivate

Authorizations:
basicAuth
path Parameters
propertyID
required
integer
Example: 707

Responses

Response Schema: application/json
propertyID
required
integer
propertyImageID
required
integer
propertyTypeID
required
integer (property_types)
Enum: 1 2 3 4 5 6 7 8 9 10
  • 1 - Single Family Home
  • 2 - Apartment
  • 3 - Condo
  • 4 - Townhouse
  • 5 - Duplex
  • 6 - Multiplex
  • 7 - Loft
  • 8 - MobileHome
  • 9 - Commercial
  • 10 - Garage
isMultiUnit
required
boolean
portfolioID
required
integer

Unique id of the portfolio the property belongs to

managementFeeSettingID
required
integer

Unique id of the management fee setting to use for this property

countryID
required
string

2-digit country code for the property, ex. US

address
required
string
stateID
required
string

2-digit state code for the property, ex. FL

city
required
string
latitude
required
number <double>

The latitude for the property address. If not given, it will be calculated based on the property address.

longitude
required
number <double>

The longitude for the property address. If not given, it will be calculated based on the property address.

dateTimeCreated
required
string <date-time>
reserveAmount
required
number <double>
isActive
required
boolean
isFromImport
required
integer
name
string or null
streetNumber
integer or null
streetName
string or null
address2
string or null
postalCode
string or null
county
string or null
maintenanceLimitAmount
number or null <double>
yearBuilt
integer or null
dateInsuranceExpires
string or null <date>
dateWarrantyExpires
string or null <date>
dateContractBegins
string or null <date>
dateContractEnds
string or null <date>
legalDescription
string or null
maintenanceNotes
string or null
applicationTemplateID
integer or null
commercialClassTypeID
integer or null
salesTaxSettingID
integer or null
insuranceCompany
string or null
insuranceAgent
string or null
insurancePolicyNumber
string or null
insuranceContactDetails
string or null
leaseReturnChargeAmount
number or null <double>
propertyShowingProviderID
integer or null
importSourceKey
string or null

Response samples

Content type
application/json
{
  • "propertyID": 0,
  • "propertyTypeID": 1,
  • "isMultiUnit": true,
  • "portfolioID": 0,
  • "managementFeeSettingID": 0,
  • "name": "string",
  • "countryID": "US",
  • "address": "string",
  • "streetNumber": 0,
  • "streetName": "string",
  • "address2": "string",
  • "stateID": "FL",
  • "city": "string",
  • "postalCode": "string",
  • "latitude": 0,
  • "longitude": 0,
  • "county": "string",
  • "dateTimeCreated": "2019-08-24T14:15:22Z",
  • "maintenanceLimitAmount": 0,
  • "yearBuilt": 0,
  • "dateInsuranceExpires": "2019-08-24",
  • "dateWarrantyExpires": "2019-08-24",
  • "reserveAmount": 0,
  • "dateContractBegins": "2019-08-24",
  • "dateContractEnds": "2019-08-24",
  • "propertyImageID": 0,
  • "isActive": true,
  • "legalDescription": "string",
  • "maintenanceNotes": "string",
  • "applicationTemplateID": 0,
  • "commercialClassTypeID": 0,
  • "salesTaxSettingID": 0,
  • "insuranceCompany": "string",
  • "insuranceAgent": "string",
  • "insurancePolicyNumber": "string",
  • "insuranceContactDetails": "string",
  • "leaseReturnChargeAmount": 0,
  • "propertyShowingProviderID": 0,
  • "isFromImport": 0,
  • "importSourceKey": "string"
}

Activate

Authorizations:
basicAuth
path Parameters
propertyID
required
integer
Example: 707

Responses

Response Schema: application/json
propertyID
required
integer
propertyImageID
required
integer
propertyTypeID
required
integer (property_types)
Enum: 1 2 3 4 5 6 7 8 9 10
  • 1 - Single Family Home
  • 2 - Apartment
  • 3 - Condo
  • 4 - Townhouse
  • 5 - Duplex
  • 6 - Multiplex
  • 7 - Loft
  • 8 - MobileHome
  • 9 - Commercial
  • 10 - Garage
isMultiUnit
required
boolean
portfolioID
required
integer

Unique id of the portfolio the property belongs to

managementFeeSettingID
required
integer

Unique id of the management fee setting to use for this property

countryID
required
string

2-digit country code for the property, ex. US

address
required
string
stateID
required
string

2-digit state code for the property, ex. FL

city
required
string
latitude
required
number <double>

The latitude for the property address. If not given, it will be calculated based on the property address.

longitude
required
number <double>

The longitude for the property address. If not given, it will be calculated based on the property address.

dateTimeCreated
required
string <date-time>
reserveAmount
required
number <double>
isActive
required
boolean
isFromImport
required
integer
name
string or null
streetNumber
integer or null
streetName
string or null
address2
string or null
postalCode
string or null
county
string or null
maintenanceLimitAmount
number or null <double>
yearBuilt
integer or null
dateInsuranceExpires
string or null <date>
dateWarrantyExpires
string or null <date>
dateContractBegins
string or null <date>
dateContractEnds
string or null <date>
legalDescription
string or null
maintenanceNotes
string or null
applicationTemplateID
integer or null
commercialClassTypeID
integer or null
salesTaxSettingID
integer or null
insuranceCompany
string or null
insuranceAgent
string or null
insurancePolicyNumber
string or null
insuranceContactDetails
string or null
leaseReturnChargeAmount
number or null <double>
propertyShowingProviderID
integer or null
importSourceKey
string or null

Response samples

Content type
application/json
{
  • "propertyID": 0,
  • "propertyTypeID": 1,
  • "isMultiUnit": true,
  • "portfolioID": 0,
  • "managementFeeSettingID": 0,
  • "name": "string",
  • "countryID": "US",
  • "address": "string",
  • "streetNumber": 0,
  • "streetName": "string",
  • "address2": "string",
  • "stateID": "FL",
  • "city": "string",
  • "postalCode": "string",
  • "latitude": 0,
  • "longitude": 0,
  • "county": "string",
  • "dateTimeCreated": "2019-08-24T14:15:22Z",
  • "maintenanceLimitAmount": 0,
  • "yearBuilt": 0,
  • "dateInsuranceExpires": "2019-08-24",
  • "dateWarrantyExpires": "2019-08-24",
  • "reserveAmount": 0,
  • "dateContractBegins": "2019-08-24",
  • "dateContractEnds": "2019-08-24",
  • "propertyImageID": 0,
  • "isActive": true,
  • "legalDescription": "string",
  • "maintenanceNotes": "string",
  • "applicationTemplateID": 0,
  • "commercialClassTypeID": 0,
  • "salesTaxSettingID": 0,
  • "insuranceCompany": "string",
  • "insuranceAgent": "string",
  • "insurancePolicyNumber": "string",
  • "insuranceContactDetails": "string",
  • "leaseReturnChargeAmount": 0,
  • "propertyShowingProviderID": 0,
  • "isFromImport": 0,
  • "importSourceKey": "string"
}

Units

List

Authorizations:
basicAuth
path Parameters
propertyID
required
integer
Example: 707

Responses

Response Schema: application/json
Array
unitID
required
integer
propertyID
required
integer
propertyImageID
required
integer
isActive
required
boolean
address
required
string
stateID
required
string
city
required
string
latitude
required
number <double>
longitude
required
number <double>
rent
required
number <double>
dateTimeCreated
required
string <date-time>
isNonRevenue
required
integer
isFromImport
required
integer
name
string or null
streetNumber
integer or null
streetName
string or null
address2
string or null
postalCode
string or null
deposit
number or null <double>
size
integer or null
beds
integer or null
fullBaths
integer or null
halfBaths
integer or null
leaseID
integer or null
propertyManagerID
integer or null
commercialSpaceTypeID
integer or null
nonRevenueTypeID
integer or null
nonRevenueStartDate
string or null <date>
importSourceKey
string or null

Response samples

Content type
application/json
[
  • {
    }
]

View

Authorizations:
basicAuth
path Parameters
propertyID
required
integer
Example: 707
unitID
required
integer
Example: 585

Responses

Response Schema: application/json
unitID
required
integer
propertyID
required
integer
propertyImageID
required
integer
isActive
required
boolean
address
required
string
stateID
required
string
city
required
string
latitude
required
number <double>
longitude
required
number <double>
rent
required
number <double>
dateTimeCreated
required
string <date-time>
isNonRevenue
required
integer
isFromImport
required
integer
name
string or null
streetNumber
integer or null
streetName
string or null
address2
string or null
postalCode
string or null
deposit
number or null <double>
size
integer or null
beds
integer or null
fullBaths
integer or null
halfBaths
integer or null
leaseID
integer or null
propertyManagerID
integer or null
commercialSpaceTypeID
integer or null
nonRevenueTypeID
integer or null
nonRevenueStartDate
string or null <date>
importSourceKey
string or null

Response samples

Content type
application/json
{
  • "unitID": 0,
  • "propertyID": 0,
  • "propertyImageID": 0,
  • "isActive": true,
  • "name": "string",
  • "address": "string",
  • "streetNumber": 0,
  • "streetName": "string",
  • "address2": "string",
  • "stateID": "string",
  • "city": "string",
  • "postalCode": "string",
  • "latitude": 0,
  • "longitude": 0,
  • "rent": 0,
  • "deposit": 0,
  • "size": 0,
  • "beds": 0,
  • "fullBaths": 0,
  • "halfBaths": 0,
  • "leaseID": 0,
  • "dateTimeCreated": "2019-08-24T14:15:22Z",
  • "propertyManagerID": 0,
  • "commercialSpaceTypeID": 0,
  • "isNonRevenue": 0,
  • "nonRevenueTypeID": 0,
  • "nonRevenueStartDate": "2019-08-24",
  • "isFromImport": 0,
  • "importSourceKey": "string"
}

Object Types

Rentvine uses Object Types to label different objects in the system. Object types, along with the primary key of the object given as objectID, are commonly used to identify objects that use a shared resource.

For example, when uploading a file for a unit, the unitID would be used for the objectID and an objectTypeID of 7 would given with the file when uploading a file to the files endpoint.

ID Object Type
1Account
2User
3Contact
4Lease
5Bill
6Property
7Unit
8Deposit
9Accounting Transaction
10Accounting Transaction Entry
11Portfolio
12Payout
13Bank Adjustment
14Company
15Statement
16Work Order
17Inspection
18Inspection Area
19Inspection Item
20Application
21Applicant
22Bank Transfer
23Listing
24Appliance
25Text Message
26Email Message
27Work Order Estimate
28Settlement
29Lease Tenant
30Email Template
31Note
32File Attachment
33Vendor Bill
34Document Transaction
35Document Envelope
36Application Template
37Recurring Bill
38Chat Message
39Reconciliation
40Path
41Payout Return
42Management Fee Setting
43Additional Management Fee Setting
44Accounting Setting
45Posting Setting
46Late Fee Setting
47Statement Setting
48Payout Batch
49Letter
50Reminder
51Review