Rentvine API

https://docs.rentvine.com
Admin
Rentvine is a property management platform that provides an API for programmatic access to manage...
Tokens:61,812
Snippets:122
Trust Score:9.9
Update:9 months ago
Show doc for...
Tokens:
Raw
### Create Bill - Request Payload Example

Source: https://docs.rentvine.com/index

An example JSON payload for creating a new bill via the Rentvine API. This includes payee information, dates, discount percentages, and nested charge details.

```json
{
  "payeeContactID": "379",
  "billDate": "2022-07-06",
  "dateDue": "2022-07-06",
  "reference": null,
  "paymentMemo": null,
  "description": null,
  "discountPercent": "10.0000",
  "markupPercent": null,
  "charges": [
    {
      "ledgerID": "83",
      "description": null,
      "chargeAccountID": "29",
      "amount": "275.00"
    }
  ],
  "leaseCharges": null,
  "attachments": [ ]
}
```

--------------------------------

### GET /api/manager/leases

Source: https://docs.rentvine.com/index

Retrieves a list of leases.

```APIDOC
## GET /api/manager/leases

### Description
Lists all leases associated with the account.

### Method
GET

### Endpoint
https://{account}.rentvine.com/api/manager/leases

### Parameters
*No specific parameters are documented for this endpoint.*

### Request Example
*No request body is expected for this GET request.*

### Response
#### Success Response (200)
- **lease** (array of objects) - An array of lease objects, where each object contains details about a lease and its associated unit.

#### Response Example
```json
[
  {
    "lease": {
      "someLeaseField": "value"
    },
    "unit": {
      "someUnitField": "value"
    }
  }
]
```
```

--------------------------------

### GET /api/manager/accounting/diagnostics/prepayment-mismatch

Source: https://docs.rentvine.com/index

Retrieves ledgers with discrepancies between operating balances and prepayment balances.

```APIDOC
## GET /api/manager/accounting/diagnostics/prepayment-mismatch

### Description
Retrieves a list of ledgers that show a mismatch between the operating balance and the prepayment balance. This endpoint is useful for tracking and reconciling prepayment amounts.

### Method
GET

### Endpoint
`https://{account}.rentvine.com/api/manager/accounting/diagnostics/prepayment-mismatch`

### Parameters
#### Query Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **Array** of ledger objects, detailing ledger information and the operating and prepayment balances.

#### Response Example
```json
[
  {
    "ledgerID": 0,
    "ledgerName": "string",
    "ledgerTypeID": 1,
    "ledgerObjectID": 0,
    "operatingBalance": 0.0,
    "prepaymentBalance": 0.0
  }
]
```
```

--------------------------------

### GET /api/manager/accounting/diagnostics/unused-prepaments

Source: https://docs.rentvine.com/index

Retrieves information about unused prepayments.

```APIDOC
## GET /api/manager/accounting/diagnostics/unused-prepaments

### Description
Retrieves information regarding unused prepayments within the system. This endpoint helps in identifying funds that have been prepaid but not yet applied to relevant charges or accounts.

### Method
GET

### Endpoint
`https://{account}.rentvine.com/api/manager/accounting/diagnostics/unused-prepaments`

### Parameters
#### Query Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- The schema for this response is not detailed in the provided text, but it is expected to return data related to unused prepayments.
```

--------------------------------

### GET /api/manager/screening/applications/export

Source: https://docs.rentvine.com/index

Exports screening application data, including application, unit, and lease details.

```APIDOC
## GET /api/manager/screening/applications/export

### Description
Retrieves a list of screening applications with their associated unit and lease information. This endpoint is useful for exporting application data for further analysis or record-keeping.

### Method
GET

### Endpoint
https://{account}.rentvine.com/api/manager/screening/applications/export

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **application** (object) - Details of the screening application.
- **unit** (object) - Details of the unit associated with the application.
- **lease** (object) - Details of the lease associated with the application.

#### Response Example
```json
[
  {
    "application": {
      "applicationID": 0,
      "number": "string",
      "primaryApplicationStatusID": 1,
      "applicationStatusID": 0,
      "unitID": 0,
      "address": "string",
      "address2": "string",
      "city": "string",
      "stateID": "string",
      "postalCode": "string",
      "applicants": [
        {
          "applicantID": 0,
          "name": "string",
          "email": "string",
          "phone": "string"
        }
      ],
      "dateTimeCreated": "2019-08-24T14:15:22Z",
      "dateTimeModified": "2019-08-24T14:15:22Z"
    },
    "unit": {
      "unitID": 0,
      "isActive": true,
      "name": "string",
      "address": "string",
      "streetNumber": "string",
      "streetName": "string",
      "address2": "string",
      "city": "string",
      "stateID": "string",
      "postalCode": "string",
      "latitude": 0,
      "longitude": 0,
      "rent": 0,
      "deposit": 0,
      "size": 0,
      "beds": 0,
      "fullBaths": 0,
      "halfBaths": 0
    },
    "lease": {
      "leaseID": 0,
      "startDate": "2019-08-24",
      "endDate": "2019-08-24",
      "tenants": [
        {
          "name": "string",
          "email": "string",
          "phone": "string",
          "isActive": true,
          "contactID": 0
        }
      ]
    }
  }
]
```
```

--------------------------------

### GET /websites/rentvine/lease

Source: https://docs.rentvine.com/index

Retrieves lease and associated unit information.

```APIDOC
## GET /websites/rentvine/lease

### Description
Retrieves detailed information about a lease, including associated unit data.

### Method
GET

### Endpoint
/websites/rentvine/lease

### Parameters
#### Query Parameters
* **leaseID** (integer) - Required - The unique identifier for the lease.
* **unitID** (integer) - Required - The unique identifier for the unit associated with the lease.

### Request Example
```json
{
  "leaseID": 12345,
  "unitID": 67890
}
```

### Response
#### Success Response (200)
- **lease** (object) - Contains detailed lease information.
  - **leaseID** (integer) - The unique identifier for the lease.
  - **propertyID** (integer) - The unique identifier for the property.
  - **unitID** (integer) - The unique identifier for the unit.
  - **primaryLeaseStatusID** (integer) - The primary status ID of the lease.
  - **leaseStatusID** (integer) - The current status ID of the lease.
  - **moveOutStatusID** (integer) - The move-out status ID.
  - **applicationID** (integer) - The application ID associated with the lease.
  - **tenants** (string) - Information about the tenants.
  - **moveInDate** (string) - The date the tenant moved in (YYYY-MM-DD).
  - **startDate** (string) - The lease start date (YYYY-MM-DD).
  - **endDate** (string) - The lease end date (YYYY-MM-DD).
  - **tenantLiabilityInsuranceProviderID** (integer) - ID of the tenant liability insurance provider.
  - **tenantLiabilityInsuranceEffectiveDate** (string) - Effective date of tenant liability insurance (YYYY-MM-DD).
  - **rentersInsuranceCompany** (string) - Name of the renters insurance company.
  - **rentersInsurancePolicyNumber** (string) - Policy number for renters insurance.
  - **rentersInsuranceExpirationDate** (string) - Expiration date of renters insurance (YYYY-MM-DD).
  - **rentersInsuranceFileID** (integer) - File ID for renters insurance documents.
  - **leaseFeeTransactionID** (integer) - Transaction ID for lease fees.
  - **leaseFeeBillID** (integer) - Bill ID for lease fees.
  - **dateTimeCreated** (string) - Date and time the lease was created (ISO 8601 format).
  - **lateFeeSettingID** (integer) - ID of the late fee settings.
  - **isPortalDisabled** (integer) - Flag indicating if the portal is disabled (0 or 1).
  - **isPortalPaymentDisabled** (integer) - Flag indicating if portal payments are disabled (0 or 1).
  - **isLateFeesActive** (integer) - Flag indicating if late fees are active (0 or 1).
  - **allowedPaymentAmountTypeID** (integer) - ID for allowed payment amount types.
  - **isAchDisabled** (integer) - Flag indicating if ACH payments are disabled (0 or 1).
  - **isCreditCardDisabled** (integer) - Flag indicating if credit card payments are disabled (0 or 1).
  - **closedDate** (string) - The date the lease was closed (YYYY-MM-DD).
  - **closedDescription** (string) - Description for the lease closure.
  - **noticeDate** (string) - Date of notice given (YYYY-MM-DD).
  - **expectedMoveOutDate** (string) - Expected move-out date (YYYY-MM-DD).
  - **moveOutDate** (string) - Actual move-out date (YYYY-MM-DD).
  - **depositRefundDueDate** (string) - Due date for deposit refund (YYYY-MM-DD).
  - **leaseReturnChargeAmount** (number) - Amount charged for lease return.
  - **moveOutReasonID** (integer) - ID of the move-out reason.
  - **moveOutUnitAvailabilityDate** (string) - Date the unit becomes available after move-out (YYYY-MM-DD).
  - **moveOutTenantRemarks** (string) - Tenant remarks regarding move-out.
  - **moveOutLeaseTenantID** (integer) - Tenant ID associated with move-out.
  - **isLeaseAgreementViolated** (integer) - Flag indicating if lease agreement was violated (0 or 1).
  - **forwardingName** (string) - Forwarding name for tenant.
  - **forwardingCountryID** (string) - Country ID for forwarding address.
  - **forwardingAddress** (string) - Forwarding address line 1.
  - **forwardingAddress2** (string) - Forwarding address line 2.
  - **forwardingCity** (string) - Forwarding city.
  - **forwardingStateID** (string) - State ID for forwarding address.
  - **forwardingPostalCode** (string) - Postal code for forwarding address.
  - **forwardingEmail** (string) - Forwarding email address.
  - **forwardingPhone** (string) - Forwarding phone number.
  - **moveOutTenantReason** (string) - Tenant's reason for moving out.
  - **tenantRefundPayoutTypeID** (integer) - Payout type ID for tenant refunds.
  - **isFromImport** (integer) - Flag indicating if data is from an import (0 or 1).
  - **importSourceKey** (string) - Key for the import source.
  - **isTenantPastDueNoticeEnabled** (integer) - Flag indicating if past due notices are enabled for tenants (0 or 1).
  - **rentvineInsuranceEnrollmentID** (integer) - RentVine insurance enrollment ID.
  - **rentvineInsuranceEnrollmentStatusID** (integer) - RentVine insurance enrollment status ID.
  - **rentvineInsurancePackageID** (integer) - RentVine insurance package ID.
- **unit** (object) - Contains detailed unit information.
  - **unitID** (integer) - The unique identifier for the unit.
  - **propertyID** (integer) - The unique identifier for the property.
  - **propertyImageID** (integer) - The ID of the property image.
  - **isActive** (boolean) - Indicates if the unit is active.
  - **name** (string) - The name or number of the unit.
  - **address** (string) - The street address of the unit.
  - **streetNumber** (integer) - The street number of the unit's address.
  - **streetName** (string) - The street name of the unit's address.
  - **address2** (string) - Secondary address line for the unit.
  - **stateID** (string) - State ID of the unit's location.
  - **city** (string) - The city of the unit's location.
  - **postalCode** (string) - The postal code of the unit's location.
  - **latitude** (number) - Latitude coordinate of the unit.
  - **longitude** (number) - Longitude coordinate of the unit.
  - **rent** (number) - The monthly rent amount for the unit.
  - **deposit** (number) - The security deposit amount for the unit.
  - **size** (number) - The size of the unit (e.g., square footage).
  - **beds** (number) - The number of bedrooms in the unit.
  - **fullBaths** (number) - The number of full bathrooms.
  - **halfBaths** (number) - The number of half bathrooms.
  - **leaseID** (integer) - The ID of the lease associated with the unit.
  - **dateTimeCreated** (string) - Date and time the unit was created (ISO 8601 format).
  - **propertyManagerID** (integer) - The ID of the property manager.
  - **commercialSpaceTypeID** (integer) - ID for commercial space type.
  - **isNonRevenue** (integer) - Flag indicating if the unit is non-revenue (0 or 1).
  - **nonRevenueTypeID** (integer) - ID for non-revenue type.
  - **nonRevenueStartDate** (string) - Start date for non-revenue status (YYYY-MM-DD).
  - **isFromImport** (integer) - Flag indicating if data is from an import (0 or 1).
  - **importSourceKey** (string) - Key for the import source.

#### Response Example
```json
{
  "lease": {
    "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
  },
  "unit": {
    "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"
  }
}
```
```

--------------------------------

### GET /api/manager/portfolios/search

Source: https://docs.rentvine.com/index

Lists portfolios available in the system. This endpoint supports filtering and pagination for portfolios.

```APIDOC
## GET /api/manager/portfolios/search

### Description
Lists portfolios available in the system.

### Method
GET

### Endpoint
https://{account}.rentvine.com/api/manager/portfolios/search

### Parameters
#### Query Parameters
- **isActive** (boolean) - Optional - Filters portfolios by their active status.
- **pageSize** (integer) - Optional - Specifies the number of items to return per page. Defaults to 25.

### Request Example
(No request body for GET requests)

### Response
#### Success Response (200)
- **portfolio** (object) - Details of the portfolio.
  - **portfolioID** (integer)
  - **name** (string)
  - **contacts** (string)
  - **postingSettingID** (integer)
  - **minimumDistributionAmount** (number)
  - **maximumDistributionAmount** (number)
  - **reserveAmount** (number)
  - **additionalReserveAmount** (number)
  - **additionalReserveDescription** (string)
  - **overdraftOverrideAmount** (number)
  - **fiscalYearEndMonth** (integer)
  - **statementSettingID** (integer)
  - **sendStatements** (integer)
  - **holdDistributions** (integer)
  - **holdDistributionsDescription** (string)
  - **isActive** (boolean)
  - **isLiveLedgerEnabled** (boolean)
  - **dateTimeCreated** (string <date-time>)
  - **isFromImport** (boolean)
  - **importSourceKey** (string)
- **statementSetting** (object) - Details of the statement setting.
  - **statementSettingID** (integer)
  - **name** (string)
  - **isActive** (boolean)

#### Response Example
```json
[
  {
    "portfolio": {
      "portfolioID": 0,
      "name": "string",
      "contacts": "string",
      "postingSettingID": 0,
      "minimumDistributionAmount": 0,
      "maximumDistributionAmount": 0,
      "reserveAmount": 0,
      "additionalReserveAmount": 0,
      "additionalReserveDescription": "string",
      "overdraftOverrideAmount": 0,
      "fiscalYearEndMonth": 0,
      "statementSettingID": 0,
      "sendStatements": 0,
      "holdDistributions": 0,
      "holdDistributionsDescription": "string",
      "isActive": true,
      "isLiveLedgerEnabled": true,
      "dateTimeCreated": "2019-08-24T14:15:22Z",
      "isFromImport": true,
      "importSourceKey": "string"
    },
    "statementSetting": {
      "statementSettingID": 0,
      "name": "string",
      "isActive": true
    }
  }
]
```
```

--------------------------------

### GET /leases/{leaseID}

Source: https://docs.rentvine.com/index

Retrieves detailed information about a specific lease using its unique identifier.

```APIDOC
## GET /leases/{leaseID}

### Description
Retrieves detailed information about a specific lease using its unique identifier.

### Method
GET

### Endpoint
`https://{account}.rentvine.com/api/manager/leases/{leaseID}`

### Parameters
#### Path Parameters
- **leaseID** (integer) - Required - The unique identifier of the lease to retrieve.

### Response
#### Success Response (200)
- **leaseID** (integer) - Unique identifier for the lease.
- **propertyID** (integer) - Unique identifier for the property associated with the lease.
- **unitID** (integer) - Unique identifier for the unit associated with the lease.
- **primaryLeaseStatusID** (integer) - The primary status of the lease (e.g., Pending, Active, Closed). Enum: 1, 2, 3.
- **leaseStatusID** (integer) - The general status ID for the lease.
- **moveOutStatusID** (integer) - The status ID related to the move-out process. Enum: 1, 2, 3.
- **applicationID** (integer or null) - The ID of the application associated with the lease, if any.
- **tenants** (string or null) - Information about the tenants associated with the lease.
- **moveInDate** (string <date>) - The official move-in date for the lease.
- **startDate** (string <date>) - The start date of the lease term.
- **endDate** (string or null <date>) - The end date of the lease term, if applicable.
- **tenantLiabilityInsuranceProviderID** (integer or null) - The ID of the tenant's liability insurance provider.
- **tenantLiabilityInsuranceEffectiveDate** (string or null <date>) - The effective date of the tenant's liability insurance.
- **rentersInsuranceCompany** (string or null) - The name of the renter's insurance company.
- **rentersInsurancePolicyNumber** (string or null) - The policy number for the renter's insurance.
- **rentersInsuranceExpirationDate** (string or null <date>) - The expiration date of the renter's insurance.
- **rentersInsuranceFileID** (integer or null) - The file ID associated with the renter's insurance document.
- **leaseFeeTransactionID** (integer or null) - The transaction ID for any lease fees.
- **leaseFeeBillID** (integer or null) - The bill ID for any lease fees.
- **dateTimeCreated** (string <date-time>) - The date and time when the lease record was created.
- **lateFeeSettingID** (integer) - The ID of the late fee settings applicable to the lease.
- **isPortalDisabled** (integer) - Flag indicating if the tenant portal is disabled (0 for false, 1 for true).
- **isPortalPaymentDisabled** (integer) - Flag indicating if payments are disabled in the tenant portal.
- **isLateFeesActive** (integer) - Flag indicating if late fees are active for the lease.
- **allowedPaymentAmountTypeID** (integer or null) - The ID determining the allowed payment amount type.
- **isAchDisabled** (integer or null) - Flag indicating if ACH payments are disabled.
- **isCreditCardDisabled** (integer or null) - Flag indicating if credit card payments are disabled.
- **closedDate** (string or null <date>) - The date when the lease was closed.
- **closedDescription** (string or null) - A description related to the lease closure.
- **noticeDate** (string or null <date>) - The date a notice was issued regarding the lease.
- **expectedMoveOutDate** (string or null <date>) - The expected date of move-out.
- **moveOutDate** (string or null <date>) - The actual date of move-out.
- **depositRefundDueDate** (string or null <date>) - The due date for refunding any deposits.
- **leaseReturnChargeAmount** (number <double>) - The amount charged for lease return.
- **moveOutReasonID** (integer or null) - The ID of the reason for the move-out.
- **moveOutUnitAvailabilityDate** (string or null <date>) - The date the unit becomes available after move-out.
- **moveOutTenantRemarks** (string or null) - Remarks made by the tenant regarding the move-out.
- **moveOutLeaseTenantID** (integer or null) - The tenant ID related to the move-out.
- **isLeaseAgreementViolated** (integer) - Flag indicating if the lease agreement was violated.
- **forwardingName** (string or null) - The forwarding name for mail.
- **forwardingCountryID** (string or null) - The country ID for the forwarding address.
- **forwardingAddress** (string or null) - The forwarding street address.
- **forwardingAddress2** (string or null) - The second line of the forwarding street address.
- **forwardingCity** (string or null) - The city for the forwarding address.
- **forwardingStateID** (string or null) - The state ID for the forwarding address.
- **forwardingPostalCode** (string or null) - The postal code for the forwarding address.
- **forwardingEmail** (string or null) - The email address for forwarding communications.
- **forwardingPhone** (string or null) - The phone number for forwarding communications.
- **moveOutTenantReason** (string or null) - The tenant's stated reason for moving out.
- **tenantRefundPayoutTypeID** (integer) - The type of payout for tenant refunds. Enum: 1, 2.
- **isFromImport** (integer) - Flag indicating if the lease data was imported.
- **importSourceKey** (string or null) - The key identifying the source of imported data.
- **isTenantPastDueNoticeEnabled** (integer) - Flag indicating if past due notices are enabled for the tenant.
- **rentvineInsuranceEnrollmentID** (integer or null) - The enrollment ID for RentVine insurance.
- **rentvineInsuranceEnrollmentStatusID** (integer or null) - The status ID for RentVine insurance enrollment.
- **rentvineInsurancePackageID** (integer or null) - The package ID for RentVine insurance.

#### Response Example
```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
}
```
```

--------------------------------

### GET /api/manager/maintenance/work-order/statuses

Source: https://docs.rentvine.com/index

Retrieves a list of all work order statuses. Requires basic authorization.

```APIDOC
## GET /api/manager/maintenance/work-order/statuses

### Description
Retrieves a list of all work order statuses.

### Method
GET

### Endpoint
https://{account}.rentvine.com/api/manager/maintenance/work-order/statuses

### Response
#### Success Response (200)
- **primaryWorkOrderStatusID** (integer) - The primary status category.
- **name** (string) - The name of the status.
- **workOrderStatusID** (integer) - The unique identifier for the work order status.
- **isSystemStatus** (integer) - Indicates if the status is a system status.
- **orderIndex** (integer) - The order index for the status.

#### Response Example
```json
{
  "primaryWorkOrderStatusID": 1,
  "name": "string",
  "workOrderStatusID": 0,
  "isSystemStatus": 0,
  "orderIndex": 0
}
```
```

--------------------------------

### GET /api/manager/maintenance/inspections/{inspectionID}

Source: https://docs.rentvine.com/index

Retrieves a specific maintenance inspection by its ID. Use this endpoint to get detailed information about a single inspection.

```APIDOC
## GET /api/manager/maintenance/inspections/{inspectionID}

### Description
Retrieves a specific maintenance inspection by its ID.

### Method
GET

### Endpoint
https://{account}.rentvine.com/api/manager/maintenance/inspections/{inspectionID}

### Parameters
#### Path Parameters
- **inspectionID** (integer) - Required - The unique identifier for the inspection.

### Request Example
(No request body for GET requests)

### Response
#### Success Response (200)
- **inspectionID** (integer) - Required
- **propertyID** (integer) - Required
- **dateTimeCreated** (string <date>) - Required
- **unitID** (integer) - Required
- **inspectionTypeID** (integer) - Required (Enum: 1, 2, 3, 4)
- **inspectionStatusID** (integer) - Required (Enum: 1, 2, 3, 4)
- **leaseID** (integer or null)
- **assignedToUserID** (integer or null)
- **description** (string or null)
- **scheduledDate** (string or null <date>)
- **inspectionDate** (string or null <date>)

#### Response Example
```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"
}
```
```

--------------------------------

### Work Order Creation Sample Payload

Source: https://docs.rentvine.com/index

An example JSON payload demonstrating how to construct a request to create a maintenance work order. This sample includes values for most of the required and some optional fields, providing a practical illustration of the API usage.

```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
}
```

--------------------------------

### GET /maintenance/vendor-trades/{vendorTradeID}

Source: https://docs.rentvine.com/index

Retrieves a specific vendor trade by its ID. Use this endpoint to get details for a single vendor trade.

```APIDOC
## GET /maintenance/vendor-trades/{vendorTradeID}

### Description
Retrieves a specific vendor trade by its ID. Use this endpoint to get details for a single vendor trade.

### Method
GET

### Endpoint
https://{account}.rentvine.com/api/manager/maintenance/vendor-trades/{vendorTradeID}

### Parameters
#### Path Parameters
- **vendorTradeID** (integer) - Required - The unique identifier of the vendor trade to retrieve.

### Response
#### Success Response (200)
- **vendorTradeID** (integer) - Unique identifier for the vendor trade.
- **name** (string) - Name of the vendor trade.
- **isVisibleTenantPortal** (boolean) - Indicates whether the trade is visible to the resident when they are creating work orders.

#### Response Example
```json
{
  "vendorTradeID": 0,
  "name": "string",
  "isVisibleTenantPortal": true
}
```
```

--------------------------------

### POST /api/manager/files

Source: https://docs.rentvine.com/index

Uploads a file and optionally attaches it to an object (e.g., Unit, Lease) in a single step.

```APIDOC
## POST /api/manager/files

### Description
Uploads a file to Rentvine and optionally attaches it to a specified object.

### Method
POST

### Endpoint
https://{account}.rentvine.com/api/manager/files

### Parameters
#### Query Parameters
- **objectID** (integer) - Required - The primary key of the object to attach the file to.
- **objectTypeID** (integer) - Required - The id of the Object Type to attach the file to.
- **includes** (string) - Optional - Value: "attachment" - Includes the attachment object in the response.

#### Request Body
- **file** (binary) - Required - The file to upload.

### Request Example
```json
{
  "file": "<binary>"
}
```

### Response
#### Success Response (200)
- **file** (object) - Contains details about the uploaded file.
- **attachment** (object) - Included if `attachment` is provided in the `includes` query parameter. Contains details about the file attachment.

#### Response Example
```json
{
  "file": {
    "fileID": 0,
    "fileName": "string",
    "fileSize": 0,
    "fileSourceID": 1,
    "fileType": "string",
    "isAttachable": true,
    "isImage": true,
    "previewFileName": "string",
    "title": "string",
    "userID": 0
  },
  "attachment": {
    "fileAttachmentID": 0,
    "fileID": 0,
    "isSharedWithOwner": true,
    "isSharedWithTenant": true,
    "isSharedWithVendor": true,
    "objectID": 0,
    "objectTypeID": 0,
    "pathID": 0,
    "portalTypeID": 0,
    "subObjectTypeID": 0
  }
}
```
```

--------------------------------

### Authenticate API Requests with Basic Auth using curl

Source: https://docs.rentvine.com/index

Demonstrates how to authenticate API requests using HTTP Basic Authentication with your Rentvine access key and secret. Replace `{access key}:{secret}` with your actual credentials. This method is common for server-to-server integrations.

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

```

--------------------------------

### POST /api/manager/properties

Source: https://docs.rentvine.com/index

Creates a new property. This action also creates an associated Unit record. Requires proper authorization.

```APIDOC
## POST /api/manager/properties

### Description
Creates a new property. This action also creates an associated Unit record.

### Method
POST

### Endpoint
https://{account}.rentvine.com/api/manager/properties

### Parameters
#### Path Parameters
* **None specified**

#### Query Parameters
* **None specified**

#### Request Body
* **property** (object) - The main property details. See schema below.
* **unit** (object) - The unit details associated with the property. See schema below.

### Request Example
```json
{
  "property": {
    "propertyTypeID": 1,
    "isMultiUnit": false,
    "portfolioID": 1,
    "managementFeeSettingID": 1,
    "countryID": "US",
    "address": "123 Main St",
    "stateID": "CA",
    "city": "Anytown",
    "postalCode": "90210",
    "reserveAmount": 1000,
    "isActive": true,
    "latitude": 34.0522,
    "longitude": -118.2437
  },
  "unit": {
    "unitNumber": "A",
    "rentAmount": 1500,
    "bedrooms": 2,
    "bathrooms": 1,
    "squareFootage": 1200
  }
}
```

### Response
#### Success Response (200)
* **propertyID** (integer) - The ID of the newly created property.

#### Response Example
```json
{
  "propertyID": 123
}
```

### Error Handling
* **401 Unauthorized**: If the user does not have the necessary permissions.
* **400 Bad Request**: If the request body is invalid or missing required fields.
```

--------------------------------

### GET /api/manager/accounting/accounts

Source: https://docs.rentvine.com/index

Retrieves a list of accounts and their categories for accounting purposes.

```APIDOC
## GET /api/manager/accounting/accounts

### Description
Fetches a list of all accounts and their associated account categories within the Rentvine system. This endpoint is used to access financial account data.

### Method
GET

### Endpoint
https://{account}.rentvine.com/api/manager/accounting/accounts

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **account** (object) - Detailed information about the account.
- **accountCategory** (object) - Information about the category the account belongs to.

#### Response Example
```json
[
  {
    "account": {
      "accountID": 0,
      "parentAccountID": 0,
      "accountTypeID": 0,
      "accountCategoryID": 0,
      "number": "string",
      "name": "string",
      "isActive": true,
      "isSubjectToManagementFees": true,
      "isSubjectToLateFees": true,
      "isDeposit": true,
      "isEscrow": true,
      "isRent": true,
      "isTaxable": true,
      "isSubjectToSalesTax": true,
      "isPrepayment": true,
      "isManagementFee": true,
      "isBudgetEnabled": true,
      "isHeld": true,
      "bankName": "string",
      "bankAccountTypeID": 0,
      "bankAccountCiphertextID": 0,
      "bankAccountNumberTruncated": "string",
      "bankAccountAddress": "string",
      "bankAccountAddress2": "string",
      "bankAccountCity": "string",
      "bankAccountStateID": "string",
      "bankAccountPostalCode": "string",
      "bankAccountCountryID": "string",
      "isCheckingEnabled": true,
      "checkCompanyName": "string",
      "checkSignatory": "string",
      "checkAddress": "string",
      "checkAddress2": "string",
      "checkCity": "string",
      "checkStateID": "string",
      "checkPostalCode": "string",
      "checkCountryID": "string",
      "bankAccountNextCheckNumber": "string",
      "bankAccountNextDepositNumber": "string",
      "checkTemplateID": 0,
      "creditCardGatewayID": 0,
      "achGatewayID": 0,
      "cashCardGatewayID": 0,
      "remoteCheckGatewayID": 0,
      "isFromImport": true,
      "importSourceKey": "string",
      "isNachaEnabled": true,
      "isNachaFileBalanced": true,
      "nachaOriginName": "string",
      "nachaOriginNumber": "string",
      "nachaDestinationName": "string",
      "nachaDestinationNumber": "string",
      "nachaCompanyIdentification": "string",
      "nachaCompanyName": "string",
      "nachaOriginatingFinancialInstitutionID": "string",
      "nachaAdapterID": 0
    },
    "accountCategory": {
      "accountCategoryID": 0,
      "accountTypeID": 0,
      "name": "string"
    }
  }
]
```
```

--------------------------------

### POST /api/manager/vendor-trades

Source: https://docs.rentvine.com/index

Creates a new vendor trade. Requires basic authorization.

```APIDOC
## POST /api/manager/vendor-trades

### Description
Creates a new vendor trade.

### Method
POST

### Endpoint
https://{account}.rentvine.com/api/manager/vendor-trades

### Parameters
#### Request Body
- **name** (string) - Required - Name of the vendor trade.
- **isVisibleTenantPortal** (boolean) - Required - Indicates whether the trade is visible to the resident when they are creating work orders.

### Response
#### Success Response (200)
OK

*Note: The response schema for this endpoint was not fully provided in the input.*
```

--------------------------------

### Create Bill - Successful Response Example

Source: https://docs.rentvine.com/index

The JSON structure returned upon successful creation of a bill using the Rentvine API. It mirrors the bill object schema, confirming the bill's details.

```json
{
  "bill": {
    "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
  }
}
```
Tokens:
Raw