Skip to main content
Vesta API
SLINKY avatar
Written by SLINKY
Updated over 4 months ago

Set-Up

The Vesta API requires authentication between STAFFLINK and Vesta. Please allow up to two weeks for set up to be performed. Contact your Customer Success Manager to implement this.

If there are multiple Vesta accounts, they can all be fed into the same base, or separate bases if that is preferred, each account will need to be authenticated one by one.

Once implemented, please do not change the names of any tables used by the API. Consequently, please also do not change any of the fields that the API feeds data into for each record. If you change data in any of the fields, the API will also overwrite it on the next run.

Not all data is available from Vesta, only selected data that is provided by the Vesta API.

The following jobs run to syncronise data.

Properties

The Properties job feeds Properties from Vesta. The job runs every 10 minutes updating any records that have been modified in Vesta since the last run time. Note Vesta supplies both residential and commercial property information.

Fields For Properties Table

Vesta Data

Field Name

Field Type

Is the property archived

Is_Archived

Checkbox

The address

Address

Text

Internal record ID

Record_Id

Text

Link to Vesta Property

VESTA_Link

URL

Property Manager

Property_Manager

Single Select

Strata Manager

Strata_Manager

Single Select

Internal listing ID if up for rent

ActiveListingId

Text

Owner names

Owners

Text

Number of bedrooms

Beds

Number

Number of bathrooms

Baths

Number

Number of car spaces

Cars

Number

Land area

Land_Area

Number

Property notes

Notes

Text

Next inspection date

Next_Inspection

Date

Property primary type

Primary_Type

Single Select

Property type

Property_Type

Single Select

To be relet?

ReLet

Checkbox

Owner agreement start date

Owner_Agreement_Start

Date

When the agreement finishes

Owner_Agreement_End

Date

Archived_Date

Date

Group_Code

Text

Management_Fee

Percentage

Area

Number

Rate_Per_M2

Currency

Rent_Commencement

Date

Option

Text

Terms

Text

Review_At_Option

Checkbox

Review_Type

Single Select

Review_CPI

Number

Review_Fixed_Percentage

Percentage

Review_Fixed_Amount

Currency

Yearly_Review

Date

Review_Description

Text

First_Exercise

Text

Last_Exercise

Text

Demo_Date

Date

Notice_Period

Single Select

Other_Info

Text

Holding_Over_Review_Type

Text

Holding_Over_Review_CPI

Text

Holding_Over_Review_Fixed_Percentage

Text

Holding_Over_Review_Fixed_Amount

Text

CommercialRentReviews

Text

CommercialOutgoings

Text

Asbestos_Survey

Text

Cooling_Tower_Registration

Text

Lift_Registration

Text

Sump_Pump_Maintenance

Text

Anchor_Points

Text

Commercial_Compliance_Manager

Text

Pool_Compliance

Text

Pool_Compliance_Next_Date

Text

Electrical_Switching_Upgrades

Text

Last_Inspection_Date

Date

Next_Inspection_Date

Date

Water_Efficiency_Testing

Text

Insurance_Renewal

Text

Smoke_Alarm_Subscription

Text

Smoke_Alarm_Service_Done

Text

Waiver_Signed_By_Owner

Checkbox

Strata_Responsible_For_Smoke

Checkbox

Inspection_Frequency_Type

Single Select

Labels

Multiple Select

Keys

The Keys job feeds Properties from Vesta. The job runs every 10 minutes updating any records that have been modified in Vesta since the last run time.

Fields For Keys Table

Vesta Data

Field Name

Field Type

Key Numbers

Registered_Keys

Text

Always "Management Set"

Key_Type

Single Select

Internal Record Id

Record_Id

Text

Tasks

The Tasks job feeds Tasks from Vesta. The job runs every 10 minutes updating any records that have been modified in Vesta since the last run time.

Fields For Tasks Table

Vesta Data

Field Name

Field Type

Task due date

Due_Date

Date

Task description

Description

Text

Internal Record Id

Record_Id

Text

Task type

Task_Type

Single Select

Property Manager

Property_Manager

Single Select

Maintenance

The Maintenance job feeds Maintenance from Vesta. The job runs every 10 minutes updating any records that have been modified in Vesta since the last run time.

Fields For Maintenance Table

Vesta Data

Field Name

Field Type

Status of job

Status

Single Select

Job number

Job_Number

Text

Property Manager

Property_Manager

Single Select

Property owners

Related_Owner

Text

Property tenants

Related_Tenant

Text

Access required?

Access

Checkbox

Description of job

Description

Text

Summary of job

Summary

Text

Related property Id

Related_Property_Id

Text

Internal record Id

Record_Id

Text

Tenancy

The Tenancy job feeds Tenancy & Arrears from Vesta. The job runs every 10 minutes updating any records that have been modified in Vesta since the last run time.

Fields For Arrears Table

Vesta Data

Field Name

Field Type

Internal Record Id

Record_Id

Text

Internal property record Id

Property_Record_Id

Text

Tenant names

Tenant_Names

Text

Is the tenancy active

Is_Active

Checkbox

Is the tenancy closed

Is_Closed

Checkbox

Number of days in rental arrears

Days_In_Arrears

Number

Total arrears amount

Total_Arrears

Currency

Rent arrears amount

Rent_Arrears

Currency

Deposited amount

Deposit_Amount

Currency

Days in arrears for invoices

Invoice_Days_In_Arrears

Number

Invoice amount in arrears

Invoice_In_Arrears

Currency

Start of tenancy

Tenancy_Start

Date

End of tenancy

Tenancy_End

Date

Termination

Termination_Date

Date

Break lease date

Break_Lease_Date

Date

Tenancy document start date

Agreement_Start

Date

Tenancy document end date

Agreement_End

Date

Rent amount

Rent_Amount

Currency

Bond amount

Bond_Amount

Currency

Rent period

Rent_Period

Single Select

Reference for bond to RTA

Bond_Reference

Text

Reference for bank transfer

Bank_Reference

Text

Paid to date

Paid_To

Date

How much is part paid

Part_Paid

Currency

How often rent is reviewed

Review_Frequency

Single Select

When rent is next reviewed

Next_Review_Date

Date

When tenancy was created

Created_On

Date

Next date to follow up tenants

Next_Tenant_Follow_Up

Date

Next date to follow up owners

Next_Owner_Update

Date

Follow up bind date

Bond_Arrears_Follow_Up

Date

Invoice follow up date

Invoice_Arrears_Follow_Up

Date

Deposit follow up date

Tenancy_Deposit_Follow_Up

Date

Part payment follow up date

Part_Payment_Follow_Up

Date

Lease start date

Lease_Start

Date

Lease end date

Lease_End

Date

Vacate Date

Vacate_Date

Date

Linking Jobs

Linking jobs link data between tables. There are four fields that are involved, two ID fields and two link fields. The API will match records based on the ID fields and link the data using the corresponding link fields for that record. The following links are available, defined by the link between Table A and (->) Table B. Linking threads run every five hours.

Properties -> Keys

Data

Field Name

Field Type

Id of Table A

Record_Id

Text

Id of Table B

Record_Id

Text

Link in Table A

Keys

Link

Link in Table B

Property

Link

Properties -> Maintenance

Data

Field Name

Field Type

Id of Table A

Related_Property_Id

Text

Id of Table B

Record_Id

Text

Link in Table A

Maintenance

Link

Link in Table B

Related_Property

Link

Properties -> Arrears

Data

Field Name

Field Type

Id of Table A

Record_Id

Text

Id of Table B

Related_Property_Id

Text

Link in Table A

Arrears

Link

Link in Table B

Property_Address

Link

Properties -> Tasks

Data

Field Name

Field Type

Id of Table A

Record_Id

Text

Id of Table B

Property_Id

Text

Link in Table A

Tasks

Link

Link in Table B

Property

Link

Did this answer your question?