Skip to main content
Property Me API
SLINKY avatar
Written by SLINKY
Updated over a week ago

Set-Up

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

If there are multiple PropertyMe 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 PropertyMe, only selected data that is provided by the PropertyMe API.

The following jobs run to syncronise data.

Properties

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

Fields For Properties Table

Property Me Data

Field Name

Field Type

The portfolio office name

Office

Single Select

Is the property archived?

Is_Archived

Checkbox

Is it a rental?

Is_Rental

Checkbox

When was it archived

Archived_Date

Date

How often for inspections

Inspection_Frequency

number

How often for inspections frequency

Inspection_Frequency_Type

Single Select

Labels from PME

Labels

Multiple Select

The address

Address

Text

Internal record ID

Record_Id

Text

Link to PME Property

PropertyMe_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

Tenant names

Tenants

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

Reason for relet

ReLetReason

Text

Owner agreement start date

Owner_Agreement_Start

Date

When the agreement finishes

Owner_Agreement_End

Date

Internal gained reason ID

Gained_Reason_Id

Text

Internal lost reason ID

Lost_Reason_Id

Text

Comment for gain of management

Gained_Comment

Text

Comment for loss

Lost_Comment

Text

Internal owner contact Id

Owner_Contact_Id

Text

Keys

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

Fields For Keys Table

Property Me 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 Property Me. The job runs every 10 minutes updating any records that have been modified in Property Me since the last run time.

Fields For Tasks Table

Property Me Data

Field Name

Field Type

Internal Record Id

Record_Id

Text

Internal Property Id

Property_Id

Text

Tenant names

Tenants

Text

Owner names

Owners

Text

Supplier names

Suppliers

Text

Property Manager

Property_Manager

Single Select

Task type

Task_Type

Single Select

Due date

Due_Date

Date

When it was created

Created_Date

Date

When it was closed

Closed_On

Date

The task title

Task

Text

Task description

Description

Text

Labels

Labels

Multiple Select

Maintenance

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

Fields For Maintenance Table

Property Me Data

Field Name

Field Type

Internal Record Id

Record_Id

Text

Internal Property Id

Related_Property_Id

Text

Job status

Status

Single Select

Related supplier

Related_Supplier

Text

Property owner

Related_Owner

Text

Property tenants

Related_Tenant

Text

Job description

Description

Text

Property manager

Property_Manager

Single Select

Job manager

Maintenance_Manager

Single Select

Job Summary

Summary

Text

When it was created

Created_On

Date

When it was closed

Closed_On

Date

When it's due

Due_Date

Date

When it was last modified

Last_Modified

Date

Job labels

Labels

Multiple Select

Job number

Job_Number

Text

Requires access?

Access

Checkbox

Manager name

Manager_Name

Single Select

Tenancies

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

Fields For Arrears Table

Property Me Data

Field Name

Field Type

Internal Record Id

Record_Id

Text

Internal tenant record Id

Tenant_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

Deposited

Currency

Days in arrears for invoices

Invoice_Days_In_Arrears

Number

Invoice amount in arrears

Invoice_In_Arrears

Currency

Bond in arrears

Bond_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

Notes for tenancy end

Tenancy_End_Notes

Text

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

Arrear types tenancy is in

Arrears_Types

Multiple Select

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

Routines

The Routines job feeds Routines from Property Me. The job runs every week, updating updated records every hour.

Fields For Routines Table

Property Tree Data

Field Name

Field Type

When the inspection was closed

Closed_On

Date

How long the inspection is for

Duration

Duration

When the due date of the inspection is

Due_Date

Date

When the inspection starts

Start_Time

Date

When the inspection was created in PME

Created_On

Date

The status of the inspection

Routine_Status

Single Select

Is the inspection published

Is_Published

Checkbox

Internal Tenancy Id from PME

Arrears_Id

Single Select

Internal Property Id from PME

Property_Id

Text

Internal record Id

Record_Id

Text

When the inspection was last updated

Updated_On

Date

The status of the inspection when it was closed

Status_Prior_To_Closing

Single Select

The property manager allocated

Property_Manager

Single Select

The recorded water meter reading

Water_Meter

Text

When the inspection was published

Published_On

Date

Any labels for the inspection

Labels

Multiple Select

The description of the inspection

Description

Text

Any notes from the inspection

Notes

Long Text

Actions to complete after

Follow_Up_Actions

Long Text

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

Properties -> Routines

Data

Field Name

Field Type

Id of Table A

Record_Id

Text

Id of Table B

Property_Id

Text

Link in Table A

Routines

Link

Link in Table B

Property

Link

Arrears -> Routines

Data

Field Name

Field Type

Id of Table A

Record_Id

Text

Id of Table B

Arrears_Id

Text

Link in Table A

Routines

Link

Link in Table B

Arrears

Link

Did this answer your question?