/v2/customer/{shortName}/branch/branches

All branches defined for a company

• shortName (path, required) — The unique client short-name
• offset (query, required, offset) — The index of the first item to return
• count (query, required, limit) — The maximum number of items to return (up to 1000 per request)

/v2/customer/{shortName}/branch/branches/{branchID}

Get a specific branch given its unique Object ID (OID)

• shortName (path, required) — The unique client short-name
• branchID (path, required) — The unique ID of the Branch

/v2/customer/{shortName}/landlord/accounting

Get the accounting details for the landlord.

• shortName (path, required) — The unique client short-name
• token (query, required) — The login token returned from the /session POST call

/v2/customer/{shortName}/landlord/document

Download a Document

• shortName (path, required) — The unique client short-name
• token (query, required) — The login token returned from the /session POST call
• ID (query, required) — The Document ID

/v2/customer/{shortName}/landlord/inventory

Generate a Inventory PDF for a tenancy

• shortName (path, required) — The unique client short-name
• token (query, required) — The login token returned from the /session POST call
• tenancyID (query, required) — The Tenancy ID

/v2/customer/{shortName}/landlord/invoice

Get an invoice pdf belonging to the landlord.

• shortName (path, required) — The unique client short-name
• token (query, required) — The login token returned from the /session POST call
• invoiceID (query, required) — The invoice ID to load.

/v2/customer/{shortName}/landlord/landlordcrmentries

Retrieve landlord's CRM ID

• shortName (path, required) — The unique client short-name
• token (query, required) — The login token returned from the /session POST call

/v2/customer/{shortName}/landlord/maintenance

Get Active maintenance jobs.

• shortName (path, required) — The unique client short-name
• token (query, required) — The login token returned from the /session POST call

/v2/customer/{shortName}/landlord/profitloss

Generate a Profit and Loss Report

• shortName (path, required) — The unique client short-name
• token (query, required) — The login token returned from the /session POST call

/v2/customer/{shortName}/landlord/rentarrears

Rent Arrears

• shortName (path, required) — The unique client short-name
• token (query, required) — The login token returned from the /session POST call

/v2/customer/{shortName}/landlord/sas

Generate a Self Assessment Tax Report

• shortName (path, required) — The unique client short-name
• token (query, required) — The login token returned from the /session POST call
• yearEnd (query, required) — The Tax Year End.

/v2/customer/{shortName}/landlord/settings

Get contact details of all linked landlords.

• shortName (path, required) — The unique client short-name
• token (query, required) — The login token returned from the /session POST call

/v2/customer/{shortName}/landlord/summary

Get the summary details for the landlord.

• shortName (path, required) — The unique client short-name
• token (query, required) — The login token returned from the /session POST call

/v2/customer/{shortName}/landlord/tenancy

Get tenancy details.

• shortName (path, required) — The unique client short-name
• token (query, required) — The login token returned from the /session POST call
• tenancyID (query, required) — The Tenancy ID

/v2/customer/{shortName}/landlord/tenancy/maintenance/preference

Post tenancy maintenance preferences:-

• shortName (path, required) — The unique client short-name
• token (query, required) — The login token returned from the /session POST call
• tenancyID (query, required) — The Tenancy ID
• name (query, required) — Name of the maintenance preference to add
• notes (query, required) — Notes of the maintenance preference to add

/v2/customer/{shortName}/landlord/tenancyagreement

Generate a Tenancy Agreement Copy (PDF)

• shortName (path, required) — The unique client short-name
• token (query, required) — The login token returned from the /session POST call
• tenancyID (query, required) — The Tenancy ID

/v2/customer/{shortName}/photo/download

Downloads the photo of a property given the photo ID.

• shortName (path, required) — The unique client short-name
• token (query, required) — The login token returned from the /session POST call
• photoID (query, required) — The unique ID of the photo on the property
• width (query) — An optional parameter specifying the image width
• height (query) — An optional parameter specifying the image height

/v2/customer/{shortName}/property/{propertyID}/photos

A collection showing all the photos linked to a specific block, property or room

• shortName (path, required) — The unique client short-name
• token (query, required) — The login token returned from the /session POST call
• propertyID (path, required) — The unique ID of the Property
• offset (query, required, offset) — The index of the first item to return
• count (query, required, limit) — The maximum number of items to return (up to 1000 per request)

/v2/customer/{shortName}/session

Logout a customer previously logged in via the Login endpoint.

• shortName (path, required) — The unique client short-name
• token (query, required) — The login token returned from the /session POST call

/v2/customer/{shortName}/session

Gets information about the currently logged on customer.

• shortName (path, required) — The unique client short-name
• token (query, required) — The login token returned from the /session POST call

/v2/customer/{shortName}/session

Login as a customer given their username and password.

• shortName (path, required) — The unique client short-name
• username (query, required) — The user's username.
• password (query, required) — The user's password.

/v2/customer/{shortName}/session/createlandlordlogin

Send a request to the in-tray to create a landlord login.

• shortName (path, required) — The unique client short-name
• email (query, required) — The email address of the landlord
• title (query, required) — The title of the landlord
• forename (query, required) — The forename of the landlord
• surname (query, required) — The surname of the landlord
• propertyAddress (query, required) — Address of the property linked to the landlord
• contactDetails (query, required) — Contact details of the landlord
• branchID (query) — (Optional) The branch ID linked to the login. This will determine which in tray the request display in

/v2/customer/{shortName}/session/password

Change the password of a customer given their existing and new password.

• shortName (path, required) — The unique client short-name
• token (query, required) — The login token returned from the /session POST call
• oldPassword (query, required) — The customer's existing password.
• newPassword (query, required) — The customer's new password.

/v2/customer/{shortName}/session/resetpassword

Reset the customer's password. An email will be sent out to reset.

• shortName (path, required) — The unique client short-name
• email (query, required) — The login Email Address.