Rezi API Help

Save. Processes this charges description API request. The parameter and response sections describe the data exchanged with the API.

Delete Description. Processes this charges description API request. The parameter and response sections describe the data exchanged with the API.

Get charges description. Processes this charges description API request. The parameter and response sections describe the data exchanged with the API.

Gets the config back for a screen with a guid that was registered against a branch Processes this screenz API request. The parameter and response sections describe the data exchanged with the API.

Gets the config back for a screen with a guid that was registered against a branch Processes this screenz API request. The parameter and response sections describe the data exchanged with the API.

Gets Creates a new screenz display for the branch Processes this screenz API request. The parameter and response sections describe the data exchanged with the API.

Gets Creates a new screenz display for the branch Processes this screenz API request. The parameter and response sections describe the data exchanged with the API.

Instructs a role to be let Processes this lettings progression API request. The parameter and response sections describe the data exchanged with the API.

Set Marketing Role as Fallen Through Processes this lettings progression API request. The parameter and response sections describe the data exchanged with the API.

Set letting to Let (Occupied) Processes this lettings progression API request. The parameter and response sections describe the data exchanged with the API.

Remarket a Letting. Completes the PropertyLettingRole and the TenantRole and creates a new PropertyLettingRole Processes this lettings progression API request. The parameter and response sections describe the data exchanged with the API.

Withdraw a letting at the end of let Processes this lettings progression API request. The parameter and response sections describe the data exchanged with the API.

Withdraw a letting at the end of let Processes this lettings progression API request. The parameter and response sections describe the data exchanged with the API.

Set the head tenant of a tenant role Processes this lettings progression API request. The parameter and response sections describe the data exchanged with the API.

Set the head tenant of a tenant role Processes this lettings progression API request. The parameter and response sections describe the data exchanged with the API.

Sets the deposit on a letting role Processes this lettings progression API request. The parameter and response sections describe the data exchanged with the API.

Sets the deposit on a letting role Processes this lettings progression API request. The parameter and response sections describe the data exchanged with the API.

Reference a tenant on a tenant role Processes this lettings progression API request. The parameter and response sections describe the data exchanged with the API.

Reference a guarantor on a tenant role Processes this lettings progression API request. The parameter and response sections describe the data exchanged with the API.

Assign guarantor to a tenant and vice versa Processes this lettings progression API request. The parameter and response sections describe the data exchanged with the API.

Change the estimated move in date for the tenancy. Processes this lettings progression API request. The parameter and response sections describe the data exchanged with the API.

Add Tenant to the tenant group and create relevant tenant info for them. Processes this lettings progression API request. The parameter and response sections describe the data exchanged with the API.

Add Tenant to the tenant group and create relevant tenant info for them. Processes this lettings progression API request. The parameter and response sections describe the data exchanged with the API.

Add Guarantor to the letting group. Processes this lettings progression API request. The parameter and response sections describe the data exchanged with the API.

Allows you to upload a document and attach it directly to a tenant. Processes this lettings progression API request. The parameter and response sections describe the data exchanged with the API.

Allows you to upload a document and attach it directly to a tenant. Processes this lettings progression API request. The parameter and response sections describe the data exchanged with the API.

Allows you to upload a lettings document and attach it directly to a guarantor group. Processes this lettings progression API request. The parameter and response sections describe the data exchanged with the API.

Detatch a document from a landlord. Processes this lettings progression API request. The parameter and response sections describe the data exchanged with the API.

Detatch a document from a landlord. Processes this lettings progression API request. The parameter and response sections describe the data exchanged with the API.

Detatch a document from a landlord. Processes this lettings progression API request. The parameter and response sections describe the data exchanged with the API.

Detatch a document from a reference. Processes this lettings progression API request. The parameter and response sections describe the data exchanged with the API.

Add Guarantor to the letting group. Processes this lettings progression API request. The parameter and response sections describe the data exchanged with the API.

Add Guarantor to the letting group. Processes this lettings progression API request. The parameter and response sections describe the data exchanged with the API.

Allows you to upload a document and attach it directly to a guarantor. Processes this lettings progression API request. The parameter and response sections describe the data exchanged with the API.

Allows you to upload a document and attach it directly to a guarantor. Processes this lettings progression API request. The parameter and response sections describe the data exchanged with the API.

Allows you to upload a document and attach it directly to a r ight to rent. Processes this lettings progression API request. The parameter and response sections describe the data exchanged with the API.

Detach Processes this lettings progression API request. The parameter and response sections describe the data exchanged with the API.

Allows you to upload a document and attach it directly to a guarantor. Processes this lettings progression API request. The parameter and response sections describe the data exchanged with the API.

Uploads an inventory document for a tenant role Processes this lettings progression API request. The parameter and response sections describe the data exchanged with the API.

Sets whether inventory is needed on tenant role Processes this lettings progression API request. The parameter and response sections describe the data exchanged with the API.

Sets whether inventory is agreed with tenants Processes this lettings progression API request. The parameter and response sections describe the data exchanged with the API.

Add a note to a tenant role inventory Processes this lettings progression API request. The parameter and response sections describe the data exchanged with the API.

Add Tenant Deposit. Processes this lettings progression API request. The parameter and response sections describe the data exchanged with the API.

Add Tenant Fee. Processes this lettings progression API request. The parameter and response sections describe the data exchanged with the API.

Add Tenant Charge. Processes this lettings progression API request. The parameter and response sections describe the data exchanged with the API.

Get all charges for tenant. Processes this lettings progression API request. The parameter and response sections describe the data exchanged with the API.

Remove charges from a tenant role Processes this lettings progression API request. The parameter and response sections describe the data exchanged with the API.

Add Tenant Payment Processes this lettings progression API request. The parameter and response sections describe the data exchanged with the API.

Update Tenant Charge Info. Processes this lettings progression API request. The parameter and response sections describe the data exchanged with the API.

Un Pay Charge. Processes this lettings progression API request. The parameter and response sections describe the data exchanged with the API.

Get Tenant Statement. Processes this lettings progression API request. The parameter and response sections describe the data exchanged with the API.

Remove Payment. Processes this lettings progression API request. The parameter and response sections describe the data exchanged with the API.

Add Pet. Processes this lettings progression API request. The parameter and response sections describe the data exchanged with the API.

Edit Pet. Processes this lettings progression API request. The parameter and response sections describe the data exchanged with the API.

Remove Pet. Processes this lettings progression API request. The parameter and response sections describe the data exchanged with the API.

Add Permitted Occupier. Processes this lettings progression API request. The parameter and response sections describe the data exchanged with the API.

Update Permitted Occupier. Processes this lettings progression API request. The parameter and response sections describe the data exchanged with the API.

Remove Permitted Occupier. Processes this lettings progression API request. The parameter and response sections describe the data exchanged with the API.

Mark ID Received. Processes this lettings progression API request. The parameter and response sections describe the data exchanged with the API.

Set Registration Scheme. Processes this lettings progression API request. The parameter and response sections describe the data exchanged with the API.

Mark Right Rent Received. Processes this lettings progression API request. The parameter and response sections describe the data exchanged with the API.

Set Tenant Housing Benefit. Processes this lettings progression API request. The parameter and response sections describe the data exchanged with the API.

Set Tenant Bill. Processes this lettings progression API request. The parameter and response sections describe the data exchanged with the API.

Remove Tenant Bill. Processes this lettings progression API request. The parameter and response sections describe the data exchanged with the API.

Get Guarantors. Processes this lettings progression API request. The parameter and response sections describe the data exchanged with the API.

Set the guaranteed rent a landlord will receive for a roles tenancies Processes this lettings progression API request. The parameter and response sections describe the data exchanged with the API.

Set tenant role milestones as the defaults for agency Processes this lettings progression API request. The parameter and response sections describe the data exchanged with the API.

Reset tenant role milestones back to agency defaults Processes this lettings progression API request. The parameter and response sections describe the data exchanged with the API.

Reset agency default milestones back to global defaults Processes this lettings progression API request. The parameter and response sections describe the data exchanged with the API.

Create a tenant role Processes this lettings progression API request. The parameter and response sections describe the data exchanged with the API.

Get a list of documents belonging to a lettings progression role Processes this lettings progression API request. The parameter and response sections describe the data exchanged with the API.

creates an event when a envelope is bounced by sendgrid Processes this send grid API request. The parameter and response sections describe the data exchanged with the API.

Save or update a RightsRestrictions Description Processes this rights restrictions description API request. The parameter and response sections describe the data exchanged with the API.

Delete a RightsRestrictions Description by its Id Processes this rights restrictions description API request. The parameter and response sections describe the data exchanged with the API.

Get a RightsRestrictions Description by its Id Processes this rights restrictions description API request. The parameter and response sections describe the data exchanged with the API.

Get branding. Processes this branding API request. The parameter and response sections describe the data exchanged with the API.

Get all brands with details for an agency Processes this branding API request. The parameter and response sections describe the data exchanged with the API.

Gets back the enum data to fill the dropdown menus Processes this branding API request. The parameter and response sections describe the data exchanged with the API.

Gets a sumary all of the brands for a branch Processes this branding API request. The parameter and response sections describe the data exchanged with the API.

Attaches an external document to brand. Processes this branding API request. The parameter and response sections describe the data exchanged with the API.

Uploads and attaches a document to a brand. Processes this branding API request. The parameter and response sections describe the data exchanged with the API.

Uploads and attaches a document to a brand. Processes this branding API request. The parameter and response sections describe the data exchanged with the API.

Attaches a document to a brand. Processes this branding API request. The parameter and response sections describe the data exchanged with the API.

Detaches a document from a brand. Processes this branding API request. The parameter and response sections describe the data exchanged with the API.

Upload the data to customise a Brand Document. Processes this branding API request. The parameter and response sections describe the data exchanged with the API.

Get Customisation Data. Processes this branding API request. The parameter and response sections describe the data exchanged with the API.

Upload the data to create a SMS Document Template for a Brand. Processes this branding API request. The parameter and response sections describe the data exchanged with the API.

Upload the data to create a Email Document Template for a Brand. Processes this branding API request. The parameter and response sections describe the data exchanged with the API.

Get files and details that can be used to customize a website Processes this branding API request. The parameter and response sections describe the data exchanged with the API.

Upload the a html advert for a brand. Processes this branding API request. The parameter and response sections describe the data exchanged with the API.

Upload the a html advert for a brand. Processes this branding API request. The parameter and response sections describe the data exchanged with the API.

Gets a sumary all of the brands for a agency Processes this branding API request. The parameter and response sections describe the data exchanged with the API.

Set start date, terms, end date and notice period for tenancy. assertions Processes this tenancy API request. The parameter and response sections describe the data exchanged with the API.

Set Tenancy End Date. Processes this tenancy API request. The parameter and response sections describe the data exchanged with the API.

Set Agreement type for the tenancy. Processes this tenancy API request. The parameter and response sections describe the data exchanged with the API.

Set parking details for the tenancy. Processes this tenancy API request. The parameter and response sections describe the data exchanged with the API.

Set Rent Schedule. Processes this tenancy API request. The parameter and response sections describe the data exchanged with the API.

Get Rent Dates. Processes this tenancy API request. The parameter and response sections describe the data exchanged with the API.

Set Tenant Requirements. Processes this tenancy API request. The parameter and response sections describe the data exchanged with the API.

Get Tenant Clauses. Processes this tenancy API request. The parameter and response sections describe the data exchanged with the API.

Add Tenant Clause. Processes this tenancy API request. The parameter and response sections describe the data exchanged with the API.

Set Break Clause. Processes this tenancy API request. The parameter and response sections describe the data exchanged with the API.

Set Special Clause. Processes this tenancy API request. The parameter and response sections describe the data exchanged with the API.

Update Tenant Clause. Processes this tenancy API request. The parameter and response sections describe the data exchanged with the API.

Remove Tenant Clause. Processes this tenancy API request. The parameter and response sections describe the data exchanged with the API.

Renew Tenancy. Processes this tenancy API request. The parameter and response sections describe the data exchanged with the API.

Renew Tenancy. Processes this tenancy API request. The parameter and response sections describe the data exchanged with the API.

Set Rent Amount. Processes this tenancy API request. The parameter and response sections describe the data exchanged with the API.

Set Notice Period. Processes this tenancy API request. The parameter and response sections describe the data exchanged with the API.

Get Historic Changes. Processes this tenancy API request. The parameter and response sections describe the data exchanged with the API.

Get Historic Agreements. Processes this tenancy API request. The parameter and response sections describe the data exchanged with the API.

Get Signed Documents. Processes this tenancy API request. The parameter and response sections describe the data exchanged with the API.

Set Tenancy Info. Processes this tenancy API request. The parameter and response sections describe the data exchanged with the API.

Sign Document. Processes this tenancy API request. The parameter and response sections describe the data exchanged with the API.

Book Check Out Appointment. Processes this tenancy API request. The parameter and response sections describe the data exchanged with the API.

Record Checkout Feedback. Processes this tenancy API request. The parameter and response sections describe the data exchanged with the API.

Next Action. Processes this tenancy API request. The parameter and response sections describe the data exchanged with the API.

Cancel Next Action. Processes this tenancy API request. The parameter and response sections describe the data exchanged with the API.

Set Renewal Options. Processes this tenancy API request. The parameter and response sections describe the data exchanged with the API.

End Tenancy. Processes this tenancy API request. The parameter and response sections describe the data exchanged with the API.

Reopen Tenancy. Processes this tenancy API request. The parameter and response sections describe the data exchanged with the API.

Add Forward Address. Processes this tenancy API request. The parameter and response sections describe the data exchanged with the API.

Remove Forward Address. Processes this tenancy API request. The parameter and response sections describe the data exchanged with the API.

Detaches a document from a tenancy role Processes this tenancy API request. The parameter and response sections describe the data exchanged with the API.

Updated tenancy type Processes this tenancy API request. The parameter and response sections describe the data exchanged with the API.

Gets the rent split/consolidate summary for determining next rent amounts. Processes this tenancy API request. The parameter and response sections describe the data exchanged with the API.

Create next rent demand for the tenancy Processes this tenancy API request. The parameter and response sections describe the data exchanged with the API.

Create custom rent demand for the tenancy Processes this tenancy API request. The parameter and response sections describe the data exchanged with the API.

Generate Rent Demand Simulation. Processes this tenancy API request. The parameter and response sections describe the data exchanged with the API.

Create/Update additional service on tenancy Processes this tenancy API request. The parameter and response sections describe the data exchanged with the API.

Remove additional service from tenancy Processes this tenancy API request. The parameter and response sections describe the data exchanged with the API.

Create/Update additional service on tenancy Processes this tenancy API request. The parameter and response sections describe the data exchanged with the API.

Create/Update additional service on tenancy Processes this tenancy API request. The parameter and response sections describe the data exchanged with the API.

Get rent demands for the tenant role Processes this tenancy API request. The parameter and response sections describe the data exchanged with the API.

Get rent demands for the tenant role Processes this tenancy API request. The parameter and response sections describe the data exchanged with the API.

Get financial overview for tenancies in particular status Processes this tenancy API request. The parameter and response sections describe the data exchanged with the API.

Updates a tenancies key information Processes this tenancy API request. The parameter and response sections describe the data exchanged with the API.

Sends a basic email to any specified party. Processes this job API request. The parameter and response sections describe the data exchanged with the API.

Normalises phone numbers for agency Processes this job API request. The parameter and response sections describe the data exchanged with the API.

Normalises phone numbers for agency Processes this job API request. The parameter and response sections describe the data exchanged with the API.

Issues a request that a job be cancelled if possbile Not all jobs are cancellable.

Starts a test job that send notifications with file links. This is used to test signalr and the docs system. Processes this job API request. The parameter and response sections describe the data exchanged with the API.

Gets the status for a job given its reference Processes this job API request. The parameter and response sections describe the data exchanged with the API.

Returns a list of possible values for an enum if you just specify . Returns a an enum if you specify and . Processes this enum API request. The parameter and response sections describe the data exchanged with the API.

Get enum suggestions for value Processes this enum API request. The parameter and response sections describe the data exchanged with the API.

Get an enum by its type and system name Processes this enum API request. The parameter and response sections describe the data exchanged with the API.

Gets EPC from the supplied propertyRoleId Processes this sales role API request. The parameter and response sections describe the data exchanged with the API.

Creates/Overrides the EPC for the supplied propertyRoleId Processes this sales role API request. The parameter and response sections describe the data exchanged with the API.

Clears EPC numbers and Expiry Date and marks all EPC documents as private for the supplied propertyRoleId Processes this sales role API request. The parameter and response sections describe the data exchanged with the API.

Book a Viewing. Processes this viewing API request. The parameter and response sections describe the data exchanged with the API.

Record the feedback against a Viewing. Processes this viewing API request. The parameter and response sections describe the data exchanged with the API.

Edit the feedback against a Viewing. Processes this viewing API request. The parameter and response sections describe the data exchanged with the API.

Record that the feedback for a Viewing was notified to the vendor. Processes this viewing API request. The parameter and response sections describe the data exchanged with the API.

Edit that the feedback for a Viewing was notified to the vendor. Processes this viewing API request. The parameter and response sections describe the data exchanged with the API.

Edit whether the vendor feedback for the viewing has been reviewed. Processes this viewing API request. The parameter and response sections describe the data exchanged with the API.

Book multiple viewings appointment Processes this viewing API request. The parameter and response sections describe the data exchanged with the API.

Set approval status of viewing slot on multi viewing appointment Processes this viewing API request. The parameter and response sections describe the data exchanged with the API.

Endpoint to complete the multi viewing container once individual appointments have been booked. Processes this viewing API request. The parameter and response sections describe the data exchanged with the API.

Endpoint to Complete feedback for multiple viewing follow ups. Processes this viewing API request. The parameter and response sections describe the data exchanged with the API.

Get an Viewing by its id. Processes this viewing API request. The parameter and response sections describe the data exchanged with the API.

Cancel a viewing appointment by id if it exists. Processes this viewing API request. The parameter and response sections describe the data exchanged with the API.

Syncronise Email with Rezi Events, attach documents etc Processes this sync API request. The parameter and response sections describe the data exchanged with the API.

Initially Setup the Calendar, create Rezi Calendar, copy upto 16 Days prior into calendar, create a subscription channel for the callback Processes this sync API request. The parameter and response sections describe the data exchanged with the API.

Get the oauth url for the calendar sync service Processes this sync API request. The parameter and response sections describe the data exchanged with the API.

Get the oauth url for the email sync service from a provider Processes this sync API request. The parameter and response sections describe the data exchanged with the API.

Get the oauth url for the google analytics integration service Processes this sync API request. The parameter and response sections describe the data exchanged with the API.

check if the calendar sync is enabled for this user this could be used to enabled/disable the calendar setup button Processes this sync API request. The parameter and response sections describe the data exchanged with the API.

check if they user has setup their credentials for smap services this could be used to enabled/disable the mail sync button Processes this sync API request. The parameter and response sections describe the data exchanged with the API.

check if the user has setup their credientials for smtp services Processes this sync API request. The parameter and response sections describe the data exchanged with the API.

Forces a call to get updates from Cronofy for the rezi calendar Processes this sync API request. The parameter and response sections describe the data exchanged with the API.

Forces a call to get updates from Cronofy for the rezi calendar Processes this sync API request. The parameter and response sections describe the data exchanged with the API.

Create Generic Event For External companies to log items on the timeline Processes this sync API request. The parameter and response sections describe the data exchanged with the API.

callback from credas to notify us of updates to a case Processes this sync API request. The parameter and response sections describe the data exchanged with the API.

Forces a call to get updates from Cronofy for the rezi calendar Processes this sync API request. The parameter and response sections describe the data exchanged with the API.

Creates or Updates Email Sync Security Credentials This also uses the credentials to do a quick check and see if they are working it will throw an internal server error if there is an issue with the connection but this may be the server address (set in admin centre) or the username/password Processes this sync API request. The parameter and response sections describe the data exchanged with the API.

check if the user has setup their credientials for imap services Processes this sync API request. The parameter and response sections describe the data exchanged with the API.

callback from credas to notify us of process updates to a case Processes this sync API request. The parameter and response sections describe the data exchanged with the API.

callback from credas to notify us of actor updates to a case Processes this sync API request. The parameter and response sections describe the data exchanged with the API.

callback from credas to notify us of status updates to a case Processes this sync API request. The parameter and response sections describe the data exchanged with the API.

callback from credas to notify us of status updates to a case Processes this sync API request. The parameter and response sections describe the data exchanged with the API.

Returns Dezrez Enums updated since the given date. Processes this sync API request. The parameter and response sections describe the data exchanged with the API.

Returns Dezrez Enums updated since the given date. Processes this sync API request. The parameter and response sections describe the data exchanged with the API.

Returns Dezrez Enums updated since the given date. Processes this sync API request. The parameter and response sections describe the data exchanged with the API.

Returns Appointments updated since the given date. Processes this sync API request. The parameter and response sections describe the data exchanged with the API.

Returns Event updated since the given date. Processes this sync API request. The parameter and response sections describe the data exchanged with the API.

Returns Event updated since the given date. Processes this sync API request. The parameter and response sections describe the data exchanged with the API.

Returns Negotiators updated since the given date. Processes this sync API request. The parameter and response sections describe the data exchanged with the API.

Record offer on a sale Processes this offer API request. The parameter and response sections describe the data exchanged with the API.

Record a note against on a offer Processes this offer API request. The parameter and response sections describe the data exchanged with the API.

Revise offer price Processes this offer API request. The parameter and response sections describe the data exchanged with the API.

Record offer on a letting Processes this offer API request. The parameter and response sections describe the data exchanged with the API.

Record a sale/auction offer response Processes this offer API request. The parameter and response sections describe the data exchanged with the API.

Record a letting offer response Processes this offer API request. The parameter and response sections describe the data exchanged with the API.

Record a auction offer Response Processes this offer API request. The parameter and response sections describe the data exchanged with the API.

Get an offer by its id. Processes this offer API request. The parameter and response sections describe the data exchanged with the API.

Gets a paged amount of offerss. Processes this offer API request. The parameter and response sections describe the data exchanged with the API.

Delete an offers by id if it exists. Processes this offer API request. The parameter and response sections describe the data exchanged with the API.

Allows you to upload a document and attach it directly to a milestone. Processes this milestone API request. The parameter and response sections describe the data exchanged with the API.

Attaches an existing document to a milestone Processes this milestone API request. The parameter and response sections describe the data exchanged with the API.

Detaches a document from a milestone Processes this milestone API request. The parameter and response sections describe the data exchanged with the API.

Create and run as search sync request Processes this search sync API request. The parameter and response sections describe the data exchanged with the API.

Create and run as search sync request Processes this search sync API request. The parameter and response sections describe the data exchanged with the API.

Get an EventListDataContract by event Id. Processes this list API request. The parameter and response sections describe the data exchanged with the API.

Events. Processes this list API request. The parameter and response sections describe the data exchanged with the API.

Returns a list of Events in PM Processes this list API request. The parameter and response sections describe the data exchanged with the API.

Get Event List Filters. Processes this list API request. The parameter and response sections describe the data exchanged with the API.

Get Appointment Event List. Processes this list API request. The parameter and response sections describe the data exchanged with the API.

Save Event Filter. Processes this list API request. The parameter and response sections describe the data exchanged with the API.

Marks Event List Filter as deleted Processes this list API request. The parameter and response sections describe the data exchanged with the API.

Marks Property List Filter as deleted Processes this list API request. The parameter and response sections describe the data exchanged with the API.

Marks Groups List Filter as deleted Processes this list API request. The parameter and response sections describe the data exchanged with the API.

Groups. Processes this list API request. The parameter and response sections describe the data exchanged with the API.

Negotiators. Processes this list API request. The parameter and response sections describe the data exchanged with the API.

Teams. Processes this list API request. The parameter and response sections describe the data exchanged with the API.

Get list of group ids Processes this list API request. The parameter and response sections describe the data exchanged with the API.

Get Group List Filters. Processes this list API request. The parameter and response sections describe the data exchanged with the API.

Save Group List Filter. Processes this list API request. The parameter and response sections describe the data exchanged with the API.

Get list of groups and what they are interested in. Processes this list API request. The parameter and response sections describe the data exchanged with the API.

Get list of groups and what they are interested in. Processes this list API request. The parameter and response sections describe the data exchanged with the API.

Get Group Interests List Filters. Processes this list API request. The parameter and response sections describe the data exchanged with the API.

Save Group Interest List Filter. Processes this list API request. The parameter and response sections describe the data exchanged with the API.

Marks Groups List Filter as deleted Processes this list API request. The parameter and response sections describe the data exchanged with the API.

Property. Processes this list API request. The parameter and response sections describe the data exchanged with the API.

Get list of RoleIds for property marketing roles Processes this list API request. The parameter and response sections describe the data exchanged with the API.

Property Sales Pipeline. Processes this list API request. The parameter and response sections describe the data exchanged with the API.

Searches for properties that are within a polygon Processes this list API request. The parameter and response sections describe the data exchanged with the API.

Save Property Filter. Processes this list API request. The parameter and response sections describe the data exchanged with the API.

Get Property List Filters. Processes this list API request. The parameter and response sections describe the data exchanged with the API.

Generates a csv file from selected property list items Processes this list API request. The parameter and response sections describe the data exchanged with the API.

Generates a csv file from selected letting property list items Processes this list API request. The parameter and response sections describe the data exchanged with the API.

Generates a csv file from selected property list items Processes this list API request. The parameter and response sections describe the data exchanged with the API.

Generates a csv file from selected event list items Processes this list API request. The parameter and response sections describe the data exchanged with the API.

Generates a csv file from selected event list items Processes this list API request. The parameter and response sections describe the data exchanged with the API.

Generates a csv file from selected group list items Processes this list API request. The parameter and response sections describe the data exchanged with the API.

Generates a csv file from selected group interest list items Processes this list API request. The parameter and response sections describe the data exchanged with the API.

Generates a csv file from selected group list items Processes this list API request. The parameter and response sections describe the data exchanged with the API.

Generates a csv file from group matches by property role id Processes this list API request. The parameter and response sections describe the data exchanged with the API.

Generates a csv file from selected group list items Processes this list API request. The parameter and response sections describe the data exchanged with the API.

Generates a csv file from selected property list items Processes this list API request. The parameter and response sections describe the data exchanged with the API.

Generates a csv file from selected viewings. Processes this list API request. The parameter and response sections describe the data exchanged with the API.

Get list of todos Processes this list API request. The parameter and response sections describe the data exchanged with the API.

Get Todos List Filters. Processes this list API request. The parameter and response sections describe the data exchanged with the API.

Save Todo List Filter. Processes this list API request. The parameter and response sections describe the data exchanged with the API.

Marks Todo List Filter as deleted Processes this list API request. The parameter and response sections describe the data exchanged with the API.

Get list of todos tasks. Processes this list API request. The parameter and response sections describe the data exchanged with the API.

Get Todo Tasks List Filters. Processes this list API request. The parameter and response sections describe the data exchanged with the API.

Save Todo Task List Filter. Processes this list API request. The parameter and response sections describe the data exchanged with the API.

Marks Todos task List Filter as deleted Processes this list API request. The parameter and response sections describe the data exchanged with the API.

Gets a list of group followups Processes this list API request. The parameter and response sections describe the data exchanged with the API.

Save follow up filter Processes this list API request. The parameter and response sections describe the data exchanged with the API.

Get all saved follow up list filters Processes this list API request. The parameter and response sections describe the data exchanged with the API.

Marks Follow Up List Filter as deleted Processes this list API request. The parameter and response sections describe the data exchanged with the API.

Gets a list of group followups Processes this list API request. The parameter and response sections describe the data exchanged with the API.

Save feedback follow up filter Processes this list API request. The parameter and response sections describe the data exchanged with the API.

Get all saved feedback follow up list filters Processes this list API request. The parameter and response sections describe the data exchanged with the API.

Marks Feedback Follow Up List Filter as deleted Processes this list API request. The parameter and response sections describe the data exchanged with the API.

Certificates And Licences. Processes this list API request. The parameter and response sections describe the data exchanged with the API.

Used to return a list of properties in PM Processes this list API request. The parameter and response sections describe the data exchanged with the API.

Returns a list of companies in PM Processes this list API request. The parameter and response sections describe the data exchanged with the API.

Returns a list of landlords in PM Processes this list API request. The parameter and response sections describe the data exchanged with the API.

Returns a list of Tenants in PM Processes this list API request. The parameter and response sections describe the data exchanged with the API.

Returns a list of Appointments in PM Processes this list API request. The parameter and response sections describe the data exchanged with the API.

Returns a list of Inspections in PM from a particular Property Processes this list API request. The parameter and response sections describe the data exchanged with the API.

Returns a list of Tenancies in PM Processes this list API request. The parameter and response sections describe the data exchanged with the API.

Filter for follow ups Processes this list API request. The parameter and response sections describe the data exchanged with the API.

Get all tax held by agent Processes this tax API request. The parameter and response sections describe the data exchanged with the API.

Pay tax out of tax held account Processes this tax API request. The parameter and response sections describe the data exchanged with the API.

Set default tax rate for the accounting system Processes this tax API request. The parameter and response sections describe the data exchanged with the API.

Create a new tax rate for the system Processes this tax API request. The parameter and response sections describe the data exchanged with the API.

Get Tax rates Processes this tax API request. The parameter and response sections describe the data exchanged with the API.

Gets an existing template from the system and appends the webextension data into it before returning it. so that word will open the rezi post addin automatically and know details of the template it has opened. Processes this rezi post API request. The parameter and response sections describe the data exchanged with the API.

Creates a new template appends the webextension data into it before returning it. so that word will open the rezi post addin automatically and know details of the template it has opened. Processes this rezi post API request. The parameter and response sections describe the data exchanged with the API.

Get a tag by its name Processes this tag API request. The parameter and response sections describe the data exchanged with the API.

Get a list of tags by a list of ids Processes this tag API request. The parameter and response sections describe the data exchanged with the API.

Get All Tags. Processes this tag API request. The parameter and response sections describe the data exchanged with the API.

Get tag suggestions for value Processes this tag API request. The parameter and response sections describe the data exchanged with the API.

Save. Processes this tag API request. The parameter and response sections describe the data exchanged with the API.

Get a feature by its name Processes this feature API request. The parameter and response sections describe the data exchanged with the API.

Get a list of features by a list of ids Processes this feature API request. The parameter and response sections describe the data exchanged with the API.

Get feature suggestions for value Processes this feature API request. The parameter and response sections describe the data exchanged with the API.

Gets a summary of all keys in an agency. Processes this key API request. The parameter and response sections describe the data exchanged with the API.

Add funds to an account/group by id or suspense account Processes this receipt API request. The parameter and response sections describe the data exchanged with the API.

Add agent funds into the system Processes this receipt API request. The parameter and response sections describe the data exchanged with the API.

Add interest earned to suspense account Processes this receipt API request. The parameter and response sections describe the data exchanged with the API.

Make uncleared funds as cleared. Processes this receipt API request. The parameter and response sections describe the data exchanged with the API.

Make cleared funds as uncleared. Processes this receipt API request. The parameter and response sections describe the data exchanged with the API.

Withdraw funds for the agent Processes this receipt API request. The parameter and response sections describe the data exchanged with the API.

Makes payment to supplied account. Processes this receipt API request. The parameter and response sections describe the data exchanged with the API.

Saves a payment item to be processed Processes this receipt API request. The parameter and response sections describe the data exchanged with the API.

Get saved payment items Processes this receipt API request. The parameter and response sections describe the data exchanged with the API.

Get saved payment item for specific bank account Processes this receipt API request. The parameter and response sections describe the data exchanged with the API.

Delete a payment item Processes this receipt API request. The parameter and response sections describe the data exchanged with the API.

Process payment items Processes this receipt API request. The parameter and response sections describe the data exchanged with the API.

Records funds from office account into client account and then to client if necessary. Processes this receipt API request. The parameter and response sections describe the data exchanged with the API.

Web-API endpoint for Rezi Post Processes this receipt API request. The parameter and response sections describe the data exchanged with the API.

Gets the payment item details as a Processes this receipt API request. The parameter and response sections describe the data exchanged with the API.

Gets the payment item document id/> Processes this receipt API request. The parameter and response sections describe the data exchanged with the API.

Gets bulk payments details/> Processes this receipt API request. The parameter and response sections describe the data exchanged with the API.

Detaches preview doc from a payment item Processes this receipt API request. The parameter and response sections describe the data exchanged with the API.

Withdraw funds from NRL accounts Processes this receipt API request. The parameter and response sections describe the data exchanged with the API.

Save or Updates a Property ToDo and and its tasks Processes this property to do API request. The parameter and response sections describe the data exchanged with the API.

Add tasks to a Property ToDo Processes this property to do API request. The parameter and response sections describe the data exchanged with the API.

Get the profile infos for a propery task Processes this property to do API request. The parameter and response sections describe the data exchanged with the API.

Save or update an Local Authority Description Processes this local authority description API request. The parameter and response sections describe the data exchanged with the API.

Get an Local Authority Description by its Id Processes this local authority description API request. The parameter and response sections describe the data exchanged with the API.

Delete an Local Authority Description by its Id Processes this local authority description API request. The parameter and response sections describe the data exchanged with the API.

Save or Updates a Event ToDo and and its tasks Processes this event to do API request. The parameter and response sections describe the data exchanged with the API.

Add tasks to a Event ToDo Processes this event to do API request. The parameter and response sections describe the data exchanged with the API.

Gets all tasks for a particular event / appointment Processes this event to do API request. The parameter and response sections describe the data exchanged with the API.

Updates the due date of an event task Processes this event to do API request. The parameter and response sections describe the data exchanged with the API.

Save. Processes this tag description API request. The parameter and response sections describe the data exchanged with the API.

Delete Description. Processes this tag description API request. The parameter and response sections describe the data exchanged with the API.

Get tag description. Processes this tag description API request. The parameter and response sections describe the data exchanged with the API.

Get account by group id Processes this account group API request. The parameter and response sections describe the data exchanged with the API.

Get account by group id and account type Processes this account group API request. The parameter and response sections describe the data exchanged with the API.

Get accounts by group id and account types Processes this account group API request. The parameter and response sections describe the data exchanged with the API.

Get all property accounts by group id Processes this account group API request. The parameter and response sections describe the data exchanged with the API.

Get cash account unallocated balance by group id Processes this account group API request. The parameter and response sections describe the data exchanged with the API.

Enrolls an agency into a feature Processes this feature provisioning API request. The parameter and response sections describe the data exchanged with the API.

Saves or Updates a Group ToDo and its tasks Processes this group to do API request. The parameter and response sections describe the data exchanged with the API.

Save Next Call Date. Processes this group to do API request. The parameter and response sections describe the data exchanged with the API.

Add task to a Group ToDo Processes this group to do API request. The parameter and response sections describe the data exchanged with the API.

Get the profile infos for a task Processes this group to do API request. The parameter and response sections describe the data exchanged with the API.

Get the todo and latest task for a group Processes this group to do API request. The parameter and response sections describe the data exchanged with the API.

Get the todo and tasks for a group Do not include the from parameter if you want all of the outstanding todotasks Processes this group to do API request. The parameter and response sections describe the data exchanged with the API.

Get historical prices for a property by its Id Processes this historical price API request. The parameter and response sections describe the data exchanged with the API.

Get historical prices for a property by its Id Processes this historical price API request. The parameter and response sections describe the data exchanged with the API.

Get historical prices within a radius of a location Processes this historical price API request. The parameter and response sections describe the data exchanged with the API.

Add a note to a purchasing role Processes this progression API request. The parameter and response sections describe the data exchanged with the API.

Edits a note from the sales progression role without deleting the original one. Processes this progression API request. The parameter and response sections describe the data exchanged with the API.

Add withdrawalvaluation to a property sales role Processes this progression API request. The parameter and response sections describe the data exchanged with the API.

Add WithdrawVal to a property sales role Processes this progression API request. The parameter and response sections describe the data exchanged with the API.

Add a new contact to the given progression Role or edit an existing contact Processes this progression API request. The parameter and response sections describe the data exchanged with the API.

Remove an existing progression contact from the progression role Processes this progression API request. The parameter and response sections describe the data exchanged with the API.

Get all progression contacts for the given progression role Processes this progression API request. The parameter and response sections describe the data exchanged with the API.

Get all progression milestones for the given progression role Processes this progression API request. The parameter and response sections describe the data exchanged with the API.

Get a progression milestone summary for the given progression role Processes this progression API request. The parameter and response sections describe the data exchanged with the API.

Get progression. Processes this progression API request. The parameter and response sections describe the data exchanged with the API.

Save Progression Milestone. Processes this progression API request. The parameter and response sections describe the data exchanged with the API.

Delete milestone on Progression role Processes this progression API request. The parameter and response sections describe the data exchanged with the API.

Add a note to an individual progression milestone Processes this progression API request. The parameter and response sections describe the data exchanged with the API.

Add a milestone to a role. Processes this progression API request. The parameter and response sections describe the data exchanged with the API.

Reset all progression milestones Processes this progression API request. The parameter and response sections describe the data exchanged with the API.

Set milestone orders Processes this progression API request. The parameter and response sections describe the data exchanged with the API.

Save a new milestone Processes this progression API request. The parameter and response sections describe the data exchanged with the API.

Remove a new milestone Processes this progression API request. The parameter and response sections describe the data exchanged with the API.

Bulk withdrawal valuations from a property role Processes this progression API request. The parameter and response sections describe the data exchanged with the API.

Search for People across the system. Processes this global search API request. The parameter and response sections describe the data exchanged with the API.

Search for Properties across the system. Processes this global search API request. The parameter and response sections describe the data exchanged with the API.

Search for Groups across the system. Processes this global search API request. The parameter and response sections describe the data exchanged with the API.

Search for Actions across the system. Processes this global search API request. The parameter and response sections describe the data exchanged with the API.

Auto complete global search Processes this global search API request. The parameter and response sections describe the data exchanged with the API.

The main endpoint for a global search across all entities in the system. Processes this global search API request. The parameter and response sections describe the data exchanged with the API.

Update Step Status. Processes this rezi migration API request. The parameter and response sections describe the data exchanged with the API.

Update Status. Processes this rezi migration API request. The parameter and response sections describe the data exchanged with the API.

Queue Negotiator Migration. Processes this rezi migration API request. The parameter and response sections describe the data exchanged with the API.

Queue People Migration. Processes this rezi migration API request. The parameter and response sections describe the data exchanged with the API.

Queue Property Migration. Processes this rezi migration API request. The parameter and response sections describe the data exchanged with the API.

Queue Event Migration. Processes this rezi migration API request. The parameter and response sections describe the data exchanged with the API.

Queue Files Migration. Processes this rezi migration API request. The parameter and response sections describe the data exchanged with the API.

Run Realtime Report. Processes this reporting API request. The parameter and response sections describe the data exchanged with the API.

Run Realtime Chart Report. Processes this reporting API request. The parameter and response sections describe the data exchanged with the API.

Request Csv for either set of negotiators or set of branches, with specified set of ReportFacets. Processes this reporting API request. The parameter and response sections describe the data exchanged with the API.

Neg Report. Processes this reporting API request. The parameter and response sections describe the data exchanged with the API.

Branch Report. Processes this reporting API request. The parameter and response sections describe the data exchanged with the API.

Branch CSV Report. Processes this reporting API request. The parameter and response sections describe the data exchanged with the API.

Report Types. Processes this reporting API request. The parameter and response sections describe the data exchanged with the API.

Report Config. Processes this reporting API request. The parameter and response sections describe the data exchanged with the API.

Report Data. Processes this reporting API request. The parameter and response sections describe the data exchanged with the API.

Report CSV. Processes this reporting API request. The parameter and response sections describe the data exchanged with the API.

Report State. Processes this reporting API request. The parameter and response sections describe the data exchanged with the API.

Add Report State. Processes this reporting API request. The parameter and response sections describe the data exchanged with the API.

Save. Processes this room description API request. The parameter and response sections describe the data exchanged with the API.

Attaches an externally hosted document to a room within a room description. Processes this room description API request. The parameter and response sections describe the data exchanged with the API.

Uploads and attaches a document to room description room - the new document is appended to the current list. Processes this room description API request. The parameter and response sections describe the data exchanged with the API.

Attaches the document to room. Processes this room description API request. The parameter and response sections describe the data exchanged with the API.

Detaches a document from a room description room. Processes this room description API request. The parameter and response sections describe the data exchanged with the API.

Delete Description. Processes this room description API request. The parameter and response sections describe the data exchanged with the API.

Allows you to specify a list of documentIds for a roomDescriptions room - this list will overwrite any existing list of documents on that room, and order will be honoured. Processes this room description API request. The parameter and response sections describe the data exchanged with the API.

Attach a RoomDescription to a PropertyMarketingRole Processes this room description API request. The parameter and response sections describe the data exchanged with the API.

Get room description. Processes this room description API request. The parameter and response sections describe the data exchanged with the API.

Save. Processes this furnishing description API request. The parameter and response sections describe the data exchanged with the API.

Delete Description. Processes this furnishing description API request. The parameter and response sections describe the data exchanged with the API.

Get furnishing description. Processes this furnishing description API request. The parameter and response sections describe the data exchanged with the API.

Get a person by its Id Processes this people API request. The parameter and response sections describe the data exchanged with the API.

Get Searching Roles for a Person Processes this people API request. The parameter and response sections describe the data exchanged with the API.

Get Selling Roles for a Person Processes this people API request. The parameter and response sections describe the data exchanged with the API.

Get Letting Roles for a Person Processes this people API request. The parameter and response sections describe the data exchanged with the API.

Add a ContactItem to a Person Processes this people API request. The parameter and response sections describe the data exchanged with the API.

Remove a ContactItem from a Person Processes this people API request. The parameter and response sections describe the data exchanged with the API.

Get All contact items for a person, but obscure the details Processes this people API request. The parameter and response sections describe the data exchanged with the API.

Unsubscribe/Subscribe All contact items for a person Processes this people API request. The parameter and response sections describe the data exchanged with the API.

Update a Persons Details Processes this people API request. The parameter and response sections describe the data exchanged with the API.

Add an Address to a Person Processes this people API request. The parameter and response sections describe the data exchanged with the API.

Remove an Address from a Person Processes this people API request. The parameter and response sections describe the data exchanged with the API.

Update a Person's detailsCommand Processes this people API request. The parameter and response sections describe the data exchanged with the API.

Update a Person's detailsCommand Processes this people API request. The parameter and response sections describe the data exchanged with the API.

Add a Note to a Person Processes this people API request. The parameter and response sections describe the data exchanged with the API.

Sends a user notification to the specified user Processes this people API request. The parameter and response sections describe the data exchanged with the API.

Send a notification to log out a personId from the SPA Processes this people API request. The parameter and response sections describe the data exchanged with the API.

Search contacts based on the phone number provided Processes this people API request. The parameter and response sections describe the data exchanged with the API.

Set the payment details for a person Processes this people API request. The parameter and response sections describe the data exchanged with the API.

Set the primary payment details for a person Processes this people API request. The parameter and response sections describe the data exchanged with the API.

Deletes the persons bank account details Processes this people API request. The parameter and response sections describe the data exchanged with the API.

Get the bank details for a person Processes this people API request. The parameter and response sections describe the data exchanged with the API.

Returns a list of people that have the supplied email address. Processes this people API request. The parameter and response sections describe the data exchanged with the API.

Searches people based on the fields provided. Processes this people API request. The parameter and response sections describe the data exchanged with the API.

Gets the person by an identity reference Processes this people API request. The parameter and response sections describe the data exchanged with the API.

Get basic role infomation for a Person by PersonId Processes this people API request. The parameter and response sections describe the data exchanged with the API.

Redaction Status for a Person by PersonId Processes this people API request. The parameter and response sections describe the data exchanged with the API.

Redact a Person by PersonId First request is just logged as an event Second request must be by a branch admin and actually redacts the person Only set sendEmail to false for internal bulk redact requests, the normal process requires an email. This will also suppress notifications to the negotiator. Processes this people API request. The parameter and response sections describe the data exchanged with the API.

Redact every member of a group by groupid Each first request for a group member is just logged as an event Second request for each member must be by a branch admin and actually redacts the person Only set sendEmail to false for internal bulk redact requests, the normal process requires an email. This will also suppress notifications to the negotiator Processes this people API request. The parameter and response sections describe the data exchanged with the API.

Update the service types by PersonId This cannot be used internally as they do not have the right to move status up to to approved Only the client does Processes this people API request. The parameter and response sections describe the data exchanged with the API.

Update a markerting preference by PersonId This cannot be used internally as they do not have the right to move status up to to approved Only the client does Processes this people API request. The parameter and response sections describe the data exchanged with the API.

Get a list of documents belonging to a group Processes this people API request. The parameter and response sections describe the data exchanged with the API.

Allows you to upload a document and attach it directly to a person. Processes this people API request. The parameter and response sections describe the data exchanged with the API.

Detatch a document from a person. Processes this people API request. The parameter and response sections describe the data exchanged with the API.

Get a list of persons by its group id Processes this people API request. The parameter and response sections describe the data exchanged with the API.

Gets the Bank References for a person Processes this people API request. The parameter and response sections describe the data exchanged with the API.

Creates a bank reference for a person Processes this people API request. The parameter and response sections describe the data exchanged with the API.

Updates a bank reference for a person Processes this people API request. The parameter and response sections describe the data exchanged with the API.

Deletes a bank reference for a person Processes this people API request. The parameter and response sections describe the data exchanged with the API.

Update the NRL (Non-Resident Landlord) data for a person Processes this people API request. The parameter and response sections describe the data exchanged with the API.

Get a ToDo by Id Processes this default to do API request. The parameter and response sections describe the data exchanged with the API.

Get the list of all ToDo's if no parameter is sent; if provided will filter by ToDo type Processes this default to do API request. The parameter and response sections describe the data exchanged with the API.

Get Claimed Task by id Processes this default to do API request. The parameter and response sections describe the data exchanged with the API.

Get the list of active tasks of a Todo Processes this default to do API request. The parameter and response sections describe the data exchanged with the API.

Get the list of completed tasks of a Todo Processes this default to do API request. The parameter and response sections describe the data exchanged with the API.

Get the list of completed tasks of a Todo Processes this default to do API request. The parameter and response sections describe the data exchanged with the API.

Update the date of recurrence of a task Processes this default to do API request. The parameter and response sections describe the data exchanged with the API.

If Due Date is not populated a complete flag is set or if Due Date is populated a recurrence is set Processes this default to do API request. The parameter and response sections describe the data exchanged with the API.

Sets the claiming negotiator for the task Processes this default to do API request. The parameter and response sections describe the data exchanged with the API.

Reassign a todo to different negotiator(s) Processes this default to do API request. The parameter and response sections describe the data exchanged with the API.

Cancel a to-do list from the tile overview of to-dos Processes this default to do API request. The parameter and response sections describe the data exchanged with the API.

Cancel a single or multiple tasks from a to-do bucket Processes this default to do API request. The parameter and response sections describe the data exchanged with the API.

Reassign a list of tasks to different negotiator(s) Processes this default to do API request. The parameter and response sections describe the data exchanged with the API.

Release task Processes this default to do API request. The parameter and response sections describe the data exchanged with the API.

Snooze task Processes this default to do API request. The parameter and response sections describe the data exchanged with the API.

Add note for a task Processes this default to do API request. The parameter and response sections describe the data exchanged with the API.

Get notes for a task Processes this default to do API request. The parameter and response sections describe the data exchanged with the API.

Add note for a ToDo Processes this default to do API request. The parameter and response sections describe the data exchanged with the API.

Returns all notes for todo Processes this default to do API request. The parameter and response sections describe the data exchanged with the API.

Get the list of all InboundLead ToDo's Processes this default to do API request. The parameter and response sections describe the data exchanged with the API.

Cancel the Task. Used for cancelling the Lead Requests. Processes this default to do API request. The parameter and response sections describe the data exchanged with the API.

Cancel the Task. Used for cancelling the Lead Requests. Processes this default to do API request. The parameter and response sections describe the data exchanged with the API.

Assign InboundLead Todos to the owning Negotiators of the property. Processes this default to do API request. The parameter and response sections describe the data exchanged with the API.

Assign a task to a negotiator by its Id. Processes this default to do API request. The parameter and response sections describe the data exchanged with the API.

Assign InboundLead Todos to the predefined neg teams. e.g. Sales Valuers, Sales Viewings, Lettings Viewings etc etc Processes this default to do API request. The parameter and response sections describe the data exchanged with the API.

Assign InboundLead Todos to all the specified Negs using round-robin assignement. Processes this default to do API request. The parameter and response sections describe the data exchanged with the API.

Return list of tasks, corresponding to task ids passed in. Processes this default to do API request. The parameter and response sections describe the data exchanged with the API.

Gets all of the identities for the logged in person Processes this identity API request. The parameter and response sections describe the data exchanged with the API.

Adds a new identity (E.g. Facebook Identity, Twitter identity etc.) to a person Processes this identity API request. The parameter and response sections describe the data exchanged with the API.

Removes an identity (E.g. Facebook Identity, Twitter identity etc.) from a person Processes this identity API request. The parameter and response sections describe the data exchanged with the API.

Generate a text description using AI based on the stored data for the provided property Id. Processes this brainz description API request. The parameter and response sections describe the data exchanged with the API.

Generate a text description using AI based on the stored data for the provided role Id. This endpoint is intended for roles that have UMP enabled. Processes this brainz description API request. The parameter and response sections describe the data exchanged with the API.

Get All Valid Enlisted Features For Role. Processes this enlisted feature API request. The parameter and response sections describe the data exchanged with the API.

Gets all the active features for an agency Processes this enlisted feature API request. The parameter and response sections describe the data exchanged with the API.

Save Enlisted Feature Configuration. Processes this enlisted feature API request. The parameter and response sections describe the data exchanged with the API.

Execute Step. Processes this enlisted feature API request. The parameter and response sections describe the data exchanged with the API.

Gets a summarised version of a maintenance job Processes this maintenance job API request. The parameter and response sections describe the data exchanged with the API.

Transfer funds between bank accounts (also Deposit Cash/Cheques from Cash Held) Processes this transfer API request. The parameter and response sections describe the data exchanged with the API.

Contra funds between ledgers Processes this transfer API request. The parameter and response sections describe the data exchanged with the API.

Move funds to suspense account to another ledger Processes this transfer API request. The parameter and response sections describe the data exchanged with the API.

Move funds from suspense account to another ledger Processes this transfer API request. The parameter and response sections describe the data exchanged with the API.

Transfer property account funds Processes this transfer API request. The parameter and response sections describe the data exchanged with the API.

Performs a search using the specified criteria Please note, you should not use a page size over 50, if you need all of your properties, please do multiple requests and page through the data The page size will be capped if the size is too big. Also, do not poll for data at specific times or intervals, add some randomness to the calls to spread the load. If you are attempting to keep your own data in sync, please contact Dezrez and ask for details of the PropertyUpdate Webhook This will send a message to a url of your choosing to notify you of new or updated properties, this would reduce the load on both your system and ours, and will make your data absolutely live. Processes this simple property role API request. The parameter and response sections describe the data exchanged with the API.

Get a property with an associated role by their Id's Processes this simple property role API request. The parameter and response sections describe the data exchanged with the API.

Get a a custom property from a custom field group with an associated role by their Id's Processes this simple property role API request. The parameter and response sections describe the data exchanged with the API.

Get a room by its Id Processes this room API request. The parameter and response sections describe the data exchanged with the API.

Gets a region by it's Id Processes this region API request. The parameter and response sections describe the data exchanged with the API.

Save region Processes this region API request. The parameter and response sections describe the data exchanged with the API.

Save or update a region alias Processes this region API request. The parameter and response sections describe the data exchanged with the API.

Gets the nearby regions for a region Processes this region API request. The parameter and response sections describe the data exchanged with the API.

Suggest. Processes this region API request. The parameter and response sections describe the data exchanged with the API.

Returns favorite regions Processes this region API request. The parameter and response sections describe the data exchanged with the API.

Returns favorite regions Processes this region API request. The parameter and response sections describe the data exchanged with the API.

Add a region to your list of favourites Processes this region API request. The parameter and response sections describe the data exchanged with the API.

Remove a region from your favourites Processes this region API request. The parameter and response sections describe the data exchanged with the API.

Creates a new webhook in the system (scoped to agency) Processes this webhook API request. The parameter and response sections describe the data exchanged with the API.

Deletes an existing webhook. Processes this webhook API request. The parameter and response sections describe the data exchanged with the API.

Lists all of the webhooks currently set up. Processes this webhook API request. The parameter and response sections describe the data exchanged with the API.

Gets a webhook by its ID Processes this webhook API request. The parameter and response sections describe the data exchanged with the API.

List all webhook triggers Processes this webhook API request. The parameter and response sections describe the data exchanged with the API.

Gets all the apps Processes this app API request. The parameter and response sections describe the data exchanged with the API.

Gets all the apps that are able to be a widget Processes this app API request. The parameter and response sections describe the data exchanged with the API.

Gets the settings for a particular widget Processes this app API request. The parameter and response sections describe the data exchanged with the API.

Creates Or Updates Processes this app API request. The parameter and response sections describe the data exchanged with the API.

Deletes/Resets Settings Processes this app API request. The parameter and response sections describe the data exchanged with the API.

Gets An Authorization Url for a brand Based on the External Provider the widget is associated with Processes this app API request. The parameter and response sections describe the data exchanged with the API.

Gets An Authorization Url for a brand By provider name Processes this app API request. The parameter and response sections describe the data exchanged with the API.

Gets An Authorization Url for a agency Based on the External Provider the widget is associated with Processes this app API request. The parameter and response sections describe the data exchanged with the API.

Gets An Authorization Url for a agency By provider name Processes this app API request. The parameter and response sections describe the data exchanged with the API.

Gets An Authorization Url for a branch Based on the External Provider the widget is associated with Processes this app API request. The parameter and response sections describe the data exchanged with the API.

Gets An Authorization Url for a branch By provider name Processes this app API request. The parameter and response sections describe the data exchanged with the API.

Gets An Authorization Url for a person By provider name Processes this app API request. The parameter and response sections describe the data exchanged with the API.

Gets An Token Package Based on the External Provider the app is associated with Processes this app API request. The parameter and response sections describe the data exchanged with the API.

Proxy Endpoint For Authenticated Requests To External Providers Based on the External Provider the app is associated with, Authentication is taken care of by the service Processes this app API request. The parameter and response sections describe the data exchanged with the API.

Update Auth key for a provider Add the provider name (provided by rezi for your app), the agency, branch or brand id you would like to attach this too. And specify the authKey as a string "abcdefg" in the body of the request Processes this app API request. The parameter and response sections describe the data exchanged with the API.

Gets An Token Package Based on the External Provider the app is associated with Processes this app API request. The parameter and response sections describe the data exchanged with the API.

Gets An Token Package Based on the External Provider the app is associated with Processes this app API request. The parameter and response sections describe the data exchanged with the API.

Record a Referral Based on the External Provider the app is associated with Processes this app API request. The parameter and response sections describe the data exchanged with the API.

Gets event details for referred groups This is for a workflow arrangement, fired from a webhook Processes this app API request. The parameter and response sections describe the data exchanged with the API.

Bubble requires data to be initialised to create an internal map for subsequent workflow steps It cannot do this unless the data is returned from an api call, with data arriving in apps from postmessage, the complex context structure is difficult to traverse, this will mean non coders can access all elements using a drop down selection process, similar to zapier This just returns the posted contract to allow this mapping to happen, for client side json conversion Processes this app API request. The parameter and response sections describe the data exchanged with the API.

This allows app developers to get custom fields against an entity Rezi Post can send this information to clients by means of the customFields merge field Processes this app API request. The parameter and response sections describe the data exchanged with the API.

This allows app developers to store custom values against an entity Processes this app API request. The parameter and response sections describe the data exchanged with the API.

Meta Data Get. Processes this app API request. The parameter and response sections describe the data exchanged with the API.

This allows app developers to store custom metadata against an entity Processes this app API request. The parameter and response sections describe the data exchanged with the API.

Allows apps to access readonly stored proceedures for reporting These stored procs are only written by rezi, and will have to be approved before adding to the system, the stored procs must return a json string Processes this app API request. The parameter and response sections describe the data exchanged with the API.

Proxy for RSS Feeds, to get around Cors issues Processes this app API request. The parameter and response sections describe the data exchanged with the API.

Total Money Due In Processes this accounting stats API request. The parameter and response sections describe the data exchanged with the API.

Total Rent Due Processes this accounting stats API request. The parameter and response sections describe the data exchanged with the API.

Will put a toast on a list of negotiators desktops Processes this notification API request. The parameter and response sections describe the data exchanged with the API.

Get a count of unread chat messages for the negotiator plus a list of corresponding message id's which are unread. Processes this chat API request. The parameter and response sections describe the data exchanged with the API.

Save a new chat message. Processes this chat API request. The parameter and response sections describe the data exchanged with the API.

This will update the cache with a new timestamp for when this chat message was last read. Processes this chat API request. The parameter and response sections describe the data exchanged with the API.

Get a previous chat message to append to. Processes this chat API request. The parameter and response sections describe the data exchanged with the API.

Get all chat messages for the negotiatorId. Processes this chat API request. The parameter and response sections describe the data exchanged with the API.

Put - to update a chat message. Processes this chat API request. The parameter and response sections describe the data exchanged with the API.

returns the json file containing localization for the app based on a culture string, and any custom values for the agent Processes this locale API request. The parameter and response sections describe the data exchanged with the API.

Create/Update dashboard Processes this dashboard API request. The parameter and response sections describe the data exchanged with the API.

Delete dashboard Processes this dashboard API request. The parameter and response sections describe the data exchanged with the API.

Remove widgets from a dashboard Processes this dashboard API request. The parameter and response sections describe the data exchanged with the API.

Share dashboard Processes this dashboard API request. The parameter and response sections describe the data exchanged with the API.

Get widget Processes this dashboard API request. The parameter and response sections describe the data exchanged with the API.

Add widget to dashboard Processes this dashboard API request. The parameter and response sections describe the data exchanged with the API.

Delete widget on dashboard Processes this dashboard API request. The parameter and response sections describe the data exchanged with the API.

Move widget onto another dashboard Processes this dashboard API request. The parameter and response sections describe the data exchanged with the API.

Adds the dashboard to the authenticated negotiator's active dashboards. The dashboard remains available to other negotiators. This operation only updates the authenticated negotiator's active-dashboard selection.

Removes the dashboard from the authenticated negotiator's active dashboards. The dashboard itself is not deleted. This operation only removes it from the authenticated negotiator's active-dashboard selection.

Set widget layout on dashboards Processes this dashboard API request. The parameter and response sections describe the data exchanged with the API.

Get all shared dashboards Processes this dashboard API request. The parameter and response sections describe the data exchanged with the API.

Get all shared dashboards Processes this dashboard API request. The parameter and response sections describe the data exchanged with the API.

Get all available dashboards Processes this dashboard API request. The parameter and response sections describe the data exchanged with the API.

Create default dashboard. Processes this dashboard API request. The parameter and response sections describe the data exchanged with the API.

Get LeadPulse Filter Processes this lead pulse API request. The parameter and response sections describe the data exchanged with the API.

Get all leadpulse filters Processes this lead pulse API request. The parameter and response sections describe the data exchanged with the API.

Create a Leadpulse Filter Processes this lead pulse API request. The parameter and response sections describe the data exchanged with the API.

Update a Leadpulse filter Processes this lead pulse API request. The parameter and response sections describe the data exchanged with the API.

Deletes a Leadpulse Filter Processes this lead pulse API request. The parameter and response sections describe the data exchanged with the API.

Get a Campaign item Processes this lead pulse API request. The parameter and response sections describe the data exchanged with the API.

Get All campaigns for a filter Processes this lead pulse API request. The parameter and response sections describe the data exchanged with the API.

Create a Leadpulse campaign item Processes this lead pulse API request. The parameter and response sections describe the data exchanged with the API.

Update a leadpulse campaign item Processes this lead pulse API request. The parameter and response sections describe the data exchanged with the API.

Delete a leadpulse campaign item Processes this lead pulse API request. The parameter and response sections describe the data exchanged with the API.

Preview a lead pulse filter, use this before creating the item in the database to see exactly what you might get. Processes this lead pulse API request. The parameter and response sections describe the data exchanged with the API.

Get a list of the agent names currently listing on the system, so that you can exclude them in the agents parameter Processes this lead pulse API request. The parameter and response sections describe the data exchanged with the API.

Gets the logs for a particular filter Processes this lead pulse API request. The parameter and response sections describe the data exchanged with the API.

Gets the logs for a particular campaign Processes this lead pulse API request. The parameter and response sections describe the data exchanged with the API.

Gets the logs in the last n days Processes this lead pulse API request. The parameter and response sections describe the data exchanged with the API.

Gets thumbnails of all of the packs of type LeadPulse Processes this lead pulse API request. The parameter and response sections describe the data exchanged with the API.

Gets the leadpulse agency config for this agency Processes this lead pulse API request. The parameter and response sections describe the data exchanged with the API.

Create the leadpulse agency config for this agency Processes this lead pulse API request. The parameter and response sections describe the data exchanged with the API.

Update the leadpulse agency config for this agency Processes this lead pulse API request. The parameter and response sections describe the data exchanged with the API.

Delete the leadpulse agency config for this agency Processes this lead pulse API request. The parameter and response sections describe the data exchanged with the API.

Gets the leadpulse Branch config for a branch Processes this lead pulse API request. The parameter and response sections describe the data exchanged with the API.

Create the leadpulse Branch config for a branch Processes this lead pulse API request. The parameter and response sections describe the data exchanged with the API.

Update the leadpulse Branch config for a branch Processes this lead pulse API request. The parameter and response sections describe the data exchanged with the API.

Delete the leadpulse Branch config for a branch Processes this lead pulse API request. The parameter and response sections describe the data exchanged with the API.

Get a list of all of the exclusions for a particular filter Processes this lead pulse API request. The parameter and response sections describe the data exchanged with the API.

Exclude a property from LeadPulse, this will stop it from being included in the leadpulse filter. Processes this lead pulse API request. The parameter and response sections describe the data exchanged with the API.

Exclude a property from LeadPulse, this will stop it from being included in the leadpulse filter. Processes this lead pulse API request. The parameter and response sections describe the data exchanged with the API.

Include a property back into LeadPulse, allowing it to be included in the leadpulse filter again. Processes this lead pulse API request. The parameter and response sections describe the data exchanged with the API.

Gets a list of the leadpulse previews Processes this lead pulse API request. The parameter and response sections describe the data exchanged with the API.

Gets the details of the sack, so that it can be modified/cancelled or completed Processes this lead pulse API request. The parameter and response sections describe the data exchanged with the API.

Processes the lead pulse preview by updating or removing cached data based on the provided input. This method updates the cached CSV data for a lead pulse preview associated with the specified and . If the provided contains no data rows, the cache entry is removed. If the cache entry or the associated lead pulse preview does not exist, the method returns a corresponding error response.

Get the Homesearch id for an address Processes this homesearch API request. The parameter and response sections describe the data exchanged with the API.

Retrieve the Homesearch pre-valuation report for an address Processes this homesearch API request. The parameter and response sections describe the data exchanged with the API.

Retrieve a list of addresses and Homesearch ids for a postcode Processes this homesearch API request. The parameter and response sections describe the data exchanged with the API.

Retrieve the material information values from Homesearch and save them to the property/role Processes this homesearch API request. The parameter and response sections describe the data exchanged with the API.

Get an address by its Id Processes this address API request. The parameter and response sections describe the data exchanged with the API.

Update the Center Point for an Address Processes this address API request. The parameter and response sections describe the data exchanged with the API.

Adds one or more View Points for an Address Processes this address API request. The parameter and response sections describe the data exchanged with the API.

Edits one or more ViewPoints of an address Processes this address API request. The parameter and response sections describe the data exchanged with the API.

Removes one or more ViewPoints of an address Processes this address API request. The parameter and response sections describe the data exchanged with the API.

Find. Processes this leads API request. The parameter and response sections describe the data exchanged with the API.

Update Lead Group. Processes this leads API request. The parameter and response sections describe the data exchanged with the API.

Update Lead Property. Processes this leads API request. The parameter and response sections describe the data exchanged with the API.

Get the branches for an agency Processes this agency API request. The parameter and response sections describe the data exchanged with the API.

Get the milestone configurations for an agency Processes this agency API request. The parameter and response sections describe the data exchanged with the API.

Get the administrators for an agency Processes this agency API request. The parameter and response sections describe the data exchanged with the API.

Get the account manager for an agency Processes this agency API request. The parameter and response sections describe the data exchanged with the API.

Get meeting places for an agency Processes this agency API request. The parameter and response sections describe the data exchanged with the API.

Saves a new meeting place to that particular agency Processes this agency API request. The parameter and response sections describe the data exchanged with the API.

Get fees for logged in agency Processes this agency API request. The parameter and response sections describe the data exchanged with the API.

Add or update fee for logged in agency. Processes this agency API request. The parameter and response sections describe the data exchanged with the API.

Delete fee for logged in agency. Processes this agency API request. The parameter and response sections describe the data exchanged with the API.

Returns a list of team groups for the agency. Processes this agency API request. The parameter and response sections describe the data exchanged with the API.

Get a list of portal configurations for the brand within a branch. Processes this agency API request. The parameter and response sections describe the data exchanged with the API.

THIS IS A TEMPORARY ENDPOINT TO Update a portal customisation against a brand within a branch. PLEASE NOTE: This will be replaced by a FE Tool in future. If not, Security must be improved. Processes this agency API request. The parameter and response sections describe the data exchanged with the API.

Issues an API key for use with the simple role/search endpoints Processes this agency API request. The parameter and response sections describe the data exchanged with the API.

Issues an API key for use with azure endpoints Processes this agency API request. The parameter and response sections describe the data exchanged with the API.

Gets the fee structure of the agency Processes this agency API request. The parameter and response sections describe the data exchanged with the API.

Gets the current VAT rate unless the date is specified Processes this agency API request. The parameter and response sections describe the data exchanged with the API.

Get a specific brand by brandId or default agency brand if brandId is not supplied. Processes this agency API request. The parameter and response sections describe the data exchanged with the API.

Get meeting places for an agency Processes this agency API request. The parameter and response sections describe the data exchanged with the API.

Creates a bank account for the agency. Processes this agency API request. The parameter and response sections describe the data exchanged with the API.

Given a external provider type, return all preferred companies for the agency Processes this agency API request. The parameter and response sections describe the data exchanged with the API.

Get a Particular Agency Setting Processes this agency API request. The parameter and response sections describe the data exchanged with the API.

Get details of the current users agency Processes this agency API request. The parameter and response sections describe the data exchanged with the API.

Gets a document by its id. Processes this document API request. The parameter and response sections describe the data exchanged with the API.

Save the document description. Used for the image caption for the portals. Processes this document API request. The parameter and response sections describe the data exchanged with the API.

Sets the document privacy for an existing document. This is used to change a document from being publicly accessible to being private, and vice versa. Processes this document API request. The parameter and response sections describe the data exchanged with the API.

Sets the document privacy for existing documents. This is used to change a document from being publicly accessible to being private, and vice versa. Documents that fail validation will be skipped Processes this document API request. The parameter and response sections describe the data exchanged with the API.

Approves a document. Processes this document API request. The parameter and response sections describe the data exchanged with the API.

Rejects a document. Processes this document API request. The parameter and response sections describe the data exchanged with the API.

Gets the Url from a document given its Id. Processes this document API request. The parameter and response sections describe the data exchanged with the API.

Updates the filename of an existing document. Processes this document API request. The parameter and response sections describe the data exchanged with the API.

Upload a document. Processes this document API request. The parameter and response sections describe the data exchanged with the API.

Download a document by its id. Processes this document API request. The parameter and response sections describe the data exchanged with the API.

Adds an event to show the document has been viewed. Processes this document API request. The parameter and response sections describe the data exchanged with the API.

Get documents by their ids Processes this document API request. The parameter and response sections describe the data exchanged with the API.

Save a new fee into the system Processes this fee API request. The parameter and response sections describe the data exchanged with the API.

Get list of all fees stored Processes this fee API request. The parameter and response sections describe the data exchanged with the API.

Save. Processes this occupier allowance description API request. The parameter and response sections describe the data exchanged with the API.

Delete Description. Processes this occupier allowance description API request. The parameter and response sections describe the data exchanged with the API.

Get occupier allowance description. Processes this occupier allowance description API request. The parameter and response sections describe the data exchanged with the API.

Get an event by its Id Processes this event API request. The parameter and response sections describe the data exchanged with the API.

Create Generic Event For External companies to log items on the timeline Processes this event API request. The parameter and response sections describe the data exchanged with the API.

Put - to update a note on an event. Processes this event API request. The parameter and response sections describe the data exchanged with the API.

This endpoint is deprecated. Use PUT /event/editeventnote instead. Put - to update an event note. Processes this event API request. The parameter and response sections describe the data exchanged with the API.

Edit an EventNote. Processes this event API request. The parameter and response sections describe the data exchanged with the API.

Update Status on an event. Processes this event API request. The parameter and response sections describe the data exchanged with the API.

Adds a note to the provided role Processes this event API request. The parameter and response sections describe the data exchanged with the API.

Get the chain of editions for a given original edited note. Processes this event API request. The parameter and response sections describe the data exchanged with the API.

Edits a note while keeping the original version Processes this event API request. The parameter and response sections describe the data exchanged with the API.

Pin a Note Processes this event API request. The parameter and response sections describe the data exchanged with the API.

Unpin a Note Processes this event API request. The parameter and response sections describe the data exchanged with the API.

Records an event on the role representing a neg being in contact for a property they own Processes this event API request. The parameter and response sections describe the data exchanged with the API.

Adds a message to the property Processes this event API request. The parameter and response sections describe the data exchanged with the API.

Records an event on the role representing a neg being in contact for an owner Processes this event API request. The parameter and response sections describe the data exchanged with the API.

Records an event on the role representing a neg being in contact with a person Processes this event API request. The parameter and response sections describe the data exchanged with the API.

Changes the negotiators for an event Processes this event API request. The parameter and response sections describe the data exchanged with the API.

Changes the owning team of an event Processes this event API request. The parameter and response sections describe the data exchanged with the API.

Get the roles for an event by its Id Processes this event API request. The parameter and response sections describe the data exchanged with the API.

Save. Processes this room count description API request. The parameter and response sections describe the data exchanged with the API.

Delete Description. Processes this room count description API request. The parameter and response sections describe the data exchanged with the API.

Get room count description. Processes this room count description API request. The parameter and response sections describe the data exchanged with the API.

Returns a paged list of events for the main diary view, based on the provided filter and pagination parameters. Submit a page size of 0 to get a total count without any data, as for performance reasons the total count is not populated in the paged collection response when page size is greater than 0. Processes this diary API request. The parameter and response sections describe the data exchanged with the API.

Returns the extra event data required for the summary view. Processes this diary API request. The parameter and response sections describe the data exchanged with the API.

Suggest. Processes this location API request. The parameter and response sections describe the data exchanged with the API.

Gets a location Processes this location API request. The parameter and response sections describe the data exchanged with the API.

Resolves country for a postcode Processes this location API request. The parameter and response sections describe the data exchanged with the API.

Saves a tag to location match This will start a process that updates all of the searching roles to use location matching and removes the tags

Gets a Team Processes this teams API request. The parameter and response sections describe the data exchanged with the API.

Add a new Team Processes this teams API request. The parameter and response sections describe the data exchanged with the API.

Gets the members of a team Processes this teams API request. The parameter and response sections describe the data exchanged with the API.

Adds a member to a team Processes this teams API request. The parameter and response sections describe the data exchanged with the API.

Remove a member from a team Processes this teams API request. The parameter and response sections describe the data exchanged with the API.

Sets the responsibilties for a team group Processes this teams API request. The parameter and response sections describe the data exchanged with the API.

Return detail of the service that has been connected with linkz Processes this crm connect API request. The parameter and response sections describe the data exchanged with the API.

Api to search the crm for property and return values in a format acceptable by the rezi global search Processes this crm connect API request. The parameter and response sections describe the data exchanged with the API.

Api to search the crm for people and return values in a format acceptable by the rezi global search Processes this crm connect API request. The parameter and response sections describe the data exchanged with the API.

Api to search the crm for companies and return values in a format acceptable by the rezi global search Processes this crm connect API request. The parameter and response sections describe the data exchanged with the API.

Select sets of people x at a time, for the migration assistant widget Processes this crm connect API request. The parameter and response sections describe the data exchanged with the API.

Select sets of companies x at a time, for the migration assistant widget Processes this crm connect API request. The parameter and response sections describe the data exchanged with the API.

Select sets of events x at a time, for the migration assistant widget Processes this crm connect API request. The parameter and response sections describe the data exchanged with the API.

Select sets of properties x at a time, for the migration assistant widget Processes this crm connect API request. The parameter and response sections describe the data exchanged with the API.

Get a group from the crm in the json format required to create a group in rezi Processes this crm connect API request. The parameter and response sections describe the data exchanged with the API.

Get a Company from the crm in the json format required to create a company in rezi Processes this crm connect API request. The parameter and response sections describe the data exchanged with the API.

get the display settings for a group, this must be submitted with the group when creating it Processes this crm connect API request. The parameter and response sections describe the data exchanged with the API.

get owning negotiator of the group, this must be submitted with the group when creating it Processes this crm connect API request. The parameter and response sections describe the data exchanged with the API.

Get a solcitor for a grouo context from the old crm as a CrmConnectGroupDataContract so that it can be added to rezi Processes this crm connect API request. The parameter and response sections describe the data exchanged with the API.

Get the vendor details in the datacontract format required to add a group to a property in rezi Processes this crm connect API request. The parameter and response sections describe the data exchanged with the API.

Get all the sales progression notes for a property as a list Processes this crm connect API request. The parameter and response sections describe the data exchanged with the API.

Get the marketing flags for a group in a format that can be submitted when creating a group in rezi Processes this crm connect API request. The parameter and response sections describe the data exchanged with the API.

get a groups sales searching role in the save SaveGroupSalesSearchingRoleDataContract format so that it can be created with a group in rezi Processes this crm connect API request. The parameter and response sections describe the data exchanged with the API.

Get a document as a stream, so that i can be copied to the browser and then saved back into rezi as a stream. Processes this crm connect API request. The parameter and response sections describe the data exchanged with the API.

Record that the document was imported successfully Processes this crm connect API request. The parameter and response sections describe the data exchanged with the API.

Get a list of documents from the old crm for a group Processes this crm connect API request. The parameter and response sections describe the data exchanged with the API.

get a groups lettings searching role in the save SaveGroupLettingsSearchingRoleDataContract format so that it can be created with a group in rezi Processes this crm connect API request. The parameter and response sections describe the data exchanged with the API.

Mark as group as to be imported later. Processes this crm connect API request. The parameter and response sections describe the data exchanged with the API.

Mark as event as to be imported later. Processes this crm connect API request. The parameter and response sections describe the data exchanged with the API.

Mark as property as to be imported later. Processes this crm connect API request. The parameter and response sections describe the data exchanged with the API.

Mark as company as to be imported later. Processes this crm connect API request. The parameter and response sections describe the data exchanged with the API.

Mark as the group as imported Processes this crm connect API request. The parameter and response sections describe the data exchanged with the API.

Mark as the company as imported Processes this crm connect API request. The parameter and response sections describe the data exchanged with the API.

Mark as the property as imported Processes this crm connect API request. The parameter and response sections describe the data exchanged with the API.

Mark as the event as imported Processes this crm connect API request. The parameter and response sections describe the data exchanged with the API.

Get a list of images as CrmConnectPropertyImageDataContract that can be saved to rezi for a property in the old crm Processes this crm connect API request. The parameter and response sections describe the data exchanged with the API.

Get the tags for a property Processes this crm connect API request. The parameter and response sections describe the data exchanged with the API.

Get a list of virtual tours as ExternalDocumentSaveDataContract that can be saved to rezi for a property in the old crm Processes this crm connect API request. The parameter and response sections describe the data exchanged with the API.

Get the marketing status as a datacontract from the old crm in a format that can be saved with a property in rezi Processes this crm connect API request. The parameter and response sections describe the data exchanged with the API.

Get the withdrawn valuation as a WithdrawValuationDataContract from the old crm, so that it can be created with a property in rezi Processes this crm connect API request. The parameter and response sections describe the data exchanged with the API.

Get a withdrawn instruction as a WithdrawInstructionDataContract so that the status of the property can be updated when creating a property in rezi Processes this crm connect API request. The parameter and response sections describe the data exchanged with the API.

Get a Fall through for a lettings instruction as a FallenThroughCommandDataContract so that the status of the property can be updated when creating a property in rezi Processes this crm connect API request. The parameter and response sections describe the data exchanged with the API.

Get a exchange as a ExchangeCommandDataContract so that the status of the property can be updated when creating a property in rezi Processes this crm connect API request. The parameter and response sections describe the data exchanged with the API.

Get a completion as a CompleteCommandDataContract so that the status of the property can be updated when creating a property in rezi Processes this crm connect API request. The parameter and response sections describe the data exchanged with the API.

Get the rooms as a RoomDescriptionSaveDataContract so that they can be added to a property after creation in rezi Processes this crm connect API request. The parameter and response sections describe the data exchanged with the API.

Get the epc details a EPCCommandDataContract so that it can be added and a job started when a property is created in rezi Processes this crm connect API request. The parameter and response sections describe the data exchanged with the API.

Get the descriptions as a CrmConnectDescriptionSetDataContract so that they can be added to a property after creation in rezi Processes this crm connect API request. The parameter and response sections describe the data exchanged with the API.

Utility: translate a string into a FeatureDescriptionSaveDataContract Processes this crm connect API request. The parameter and response sections describe the data exchanged with the API.

Get an image as a stream from the old crm, so that it can be pulled to the browser and subsequently pushed into rezi with a property Processes this crm connect API request. The parameter and response sections describe the data exchanged with the API.

Get the timeline for a group from the old crm in a structure that is acceptable by the timeline displays TIME RELATED STUFF NEEDS DIFFERENT SERIALIZATION Processes this crm connect API request. The parameter and response sections describe the data exchanged with the API.

Get the timeline for a company from the old crm in a structure that is acceptable by the timeline displays TIME RELATED STUFF NEEDS DIFFERENT SERIALIZATION Processes this crm connect API request. The parameter and response sections describe the data exchanged with the API.

Events are sometimes made of multiple steps in rezi, this will create a event as a series of steps for the api to create For example an accepted offer, is an offer, that is subsequently accepted, ie 2 steps Processes this crm connect API request. The parameter and response sections describe the data exchanged with the API.

An event in the old crm may link properties and people, determine which items are already imported into rezi, and return the remaining items as a CrmConnectMissingEventInfoDataContract Processes this crm connect API request. The parameter and response sections describe the data exchanged with the API.

Get a property from the old crm as a AddPropertyCommandDataContract so that it can be added to rezi Processes this crm connect API request. The parameter and response sections describe the data exchanged with the API.

Get a vendor for a property context from the old crm as a CrmConnectGroupDataContract so that it can be added to rezi Processes this crm connect API request. The parameter and response sections describe the data exchanged with the API.

Get a solcitor for a property context from the old crm as a CrmConnectGroupDataContract so that it can be added to rezi Processes this crm connect API request. The parameter and response sections describe the data exchanged with the API.

Get a purchaser for a property context from the old crm as a CrmConnectGroupDataContract so that it can be added to rezi Processes this crm connect API request. The parameter and response sections describe the data exchanged with the API.

Get a tenant for a property context from the old crm as a CrmConnectGroupDataContract so that it can be added to rezi Processes this crm connect API request. The parameter and response sections describe the data exchanged with the API.

Get a tenant for a property context from the old crm as a CrmConnectGroupDataContract so that it can be added to rezi Processes this crm connect API request. The parameter and response sections describe the data exchanged with the API.

Get the accepted offer for a property as a RecordOfferCommandDataContract so that it can be added to the event timeline for rezi when creating a property Processes this crm connect API request. The parameter and response sections describe the data exchanged with the API.

Get the accepted offer for a property as a RecordOfferCommandDataContract so that it can be added to the event timeline for rezi when creating a property Processes this crm connect API request. The parameter and response sections describe the data exchanged with the API.

Get the accepted offer for a property as a RecordOfferCommandDataContract so that it can be added to the event timeline for rezi when creating a property Processes this crm connect API request. The parameter and response sections describe the data exchanged with the API.

Get the sales valuation for a property as a RecordValuationDataContract so that it can be added to the event timeline for rezi when creating a property Processes this crm connect API request. The parameter and response sections describe the data exchanged with the API.

Get the sales valuation for a property as a RecordValuationDataContract so that it can be added to the event timeline for rezi when creating a property Processes this crm connect API request. The parameter and response sections describe the data exchanged with the API.

Get the lettings valuation for a property as a RecordValuationDataContract so that it can be added to the event timeline for rezi when creating a property Processes this crm connect API request. The parameter and response sections describe the data exchanged with the API.

Get the instruction to sell event for a property as a InstructToSellCommandDataContract so that it can be added to the event timeline for rezi when creating a property Processes this crm connect API request. The parameter and response sections describe the data exchanged with the API.

Get the instruction to sell event for a property as a InstructToSellCommandDataContract so that it can be added to the event timeline for rezi when creating a property Processes this crm connect API request. The parameter and response sections describe the data exchanged with the API.

Get Property Marketing Flags Processes this crm connect API request. The parameter and response sections describe the data exchanged with the API.

Get the occupier allowance for a property as a InstructToSellCommandDataContract so that it can be added to the event timeline for rezi when creating a property Processes this crm connect API request. The parameter and response sections describe the data exchanged with the API.

Get the lettings info for a property as a InstructToSellCommandDataContract so that it can be added to the event timeline for rezi when creating a property Processes this crm connect API request. The parameter and response sections describe the data exchanged with the API.

Get the keys for a property as a PropertyKeyAddDataContract so that it can be added to the event timeline for rezi when creating a property Processes this crm connect API request. The parameter and response sections describe the data exchanged with the API.

Get the special arrangements so that it can be added to the event timeline for rezi when creating a property Processes this crm connect API request. The parameter and response sections describe the data exchanged with the API.

Get the alarm codes for a property as a PropertyAlarmAddDataContract so that it can be added to the event timeline for rezi when creating a property Processes this crm connect API request. The parameter and response sections describe the data exchanged with the API.

Get the timeline for a group from the old crm in a structure that is acceptable by the timeline displays TIME RELATED STUFF NEEDS DIFFERENT SERIALIZATION Processes this crm connect API request. The parameter and response sections describe the data exchanged with the API.

Get a list of documents from the old crm for a property Processes this crm connect API request. The parameter and response sections describe the data exchanged with the API.

Creates a job that would either attach property history to a property, if a propertyid is supplied or notify the user with a link to the generated document. This is so people can see the history for a property without importing it into rezi Processes this crm connect API request. The parameter and response sections describe the data exchanged with the API.

create the link between rezi and the old crm... secret data contract format! Processes this crm connect API request. The parameter and response sections describe the data exchanged with the API.

Resets the connection string etc which is cached Processes this crm connect API request. The parameter and response sections describe the data exchanged with the API.

Check if a feature is enabled or not Processes this feature toggling API request. The parameter and response sections describe the data exchanged with the API.

Sets the deposit on a letting role Processes this letting role API request. The parameter and response sections describe the data exchanged with the API.

Sets the core information on a letting role Processes this letting role API request. The parameter and response sections describe the data exchanged with the API.

Sets the fee structure on a letting role Processes this letting role API request. The parameter and response sections describe the data exchanged with the API.

Gets the fee structure on a letting role Processes this letting role API request. The parameter and response sections describe the data exchanged with the API.

Set the head landlord for PropertyLettingRole Processes this letting role API request. The parameter and response sections describe the data exchanged with the API.

Set the rent share for landlords on PropertyLettingRole Processes this letting role API request. The parameter and response sections describe the data exchanged with the API.

Checks if a landlord has an active rent share on PropertyLettingRole Processes this letting role API request. The parameter and response sections describe the data exchanged with the API.

Set the terms of business for a landlord on a PropertyLettingRole Processes this letting role API request. The parameter and response sections describe the data exchanged with the API.

Set the NRL details for a landlord on a PropertyLettingRole Processes this letting role API request. The parameter and response sections describe the data exchanged with the API.

Add Landlord Info. Processes this letting role API request. The parameter and response sections describe the data exchanged with the API.

Set ID Received. Processes this letting role API request. The parameter and response sections describe the data exchanged with the API.

Add or Update a utility for the letting role Processes this letting role API request. The parameter and response sections describe the data exchanged with the API.

Remove a utility for the letting role Processes this letting role API request. The parameter and response sections describe the data exchanged with the API.

Create/Update additional service on lettings role Processes this letting role API request. The parameter and response sections describe the data exchanged with the API.

Remove additional service to lettings role tenancy Processes this letting role API request. The parameter and response sections describe the data exchanged with the API.

Gets a reconciliation by its reconciliation identifier. Processes this reconciliation API request. The parameter and response sections describe the data exchanged with the API.

Gets unreconciled ledger items eligible for reconciliation for a system bank account. The end date is inclusive. Incoming, outgoing and batch-payment items can be excluded, although incoming and outgoing items cannot both be excluded. Cash deposits, unsuspended funds, adjustments, reversals and lines without a positive adjusted total are not eligible.

Gets eligible items that are neither cleared nor part of a batch payment. The shared reconciliation filters are applied first. Batch-payment items are then removed regardless of the value of the batch-item exclusion in the request.

Gets the cleared and uncleared ledger items stored against a reconciliation. Only the reconciliation identifier in the request is used. Uncleared items are marked as uncleared and adjustments created after completion are removed from their returned amounts.

Starts or resumes a reconciliation for a system bank account. The previous closing balance must match the submitted opening balance. An existing unlocked, incomplete reconciliation is resumed; a locked reconciliation is rejected. The returned reconciliation is locked to the current user.

Completes a started reconciliation and marks the selected ledger lines as reconciled. The reconciliation must exist, be locked and be incomplete. Selected identifiers are de-duplicated, non-positive identifiers are ignored, and the selected net total must move the opening balance to the closing balance.

Saves selected ledger items against an incomplete reconciliation. The supplied ledger-line identifiers are appended to the saved items. Only the current lock holder can save a locked reconciliation. Saving for later releases the lock; otherwise the current user retains or acquires it.

Gets the detailed statement for a reconciliation. The statement contains the reconciliation's selected reconciliation items. Items retained as uncleared are not included in the statement item collection.

Gets the latest active reconciliation for a system bank account. No value is returned when the account has not been reconciled. The request is rejected when the active reconciliation is locked by another user.

Lists reconciliation summaries for a system bank account. Results are ordered by end date and then start date, newest first. Archived reconciliations may be present, so consumers should inspect each result's system status.

Cancels an incomplete reconciliation by archiving it. The reconciliation is not deleted. Completed reconciliations cannot be cancelled.

Get invoice by Id Processes this invoice API request. The parameter and response sections describe the data exchanged with the API.

Get filtered list of invoices This endpoint is deprecated, avoid using unless absolutely necesary Processes this invoice API request. The parameter and response sections describe the data exchanged with the API.

Get all invoice details needed for Yapily transaction matching on money due in Processes this invoice API request. The parameter and response sections describe the data exchanged with the API.

Get filtered list of invoice totals Processes this invoice API request. The parameter and response sections describe the data exchanged with the API.

Get agent fees invoices earned Processes this invoice API request. The parameter and response sections describe the data exchanged with the API.

Create a new invoice Processes this invoice API request. The parameter and response sections describe the data exchanged with the API.

Edit a draft invoice Processes this invoice API request. The parameter and response sections describe the data exchanged with the API.

Edit regarding tenancy property in invoice Processes this invoice API request. The parameter and response sections describe the data exchanged with the API.

Add a fee to an existing invoice Processes this invoice API request. The parameter and response sections describe the data exchanged with the API.

Remove fee from existing invoice Processes this invoice API request. The parameter and response sections describe the data exchanged with the API.

Make an allocation against an existing invoice Processes this invoice API request. The parameter and response sections describe the data exchanged with the API.

Raise a credit note against invoice items on an invoice Processes this invoice API request. The parameter and response sections describe the data exchanged with the API.

Reverse a refunded credit note and its refund. Processes this invoice API request. The parameter and response sections describe the data exchanged with the API.

Save expected receipts progress Processes this invoice API request. The parameter and response sections describe the data exchanged with the API.

Return list of receipts progress amounts Processes this invoice API request. The parameter and response sections describe the data exchanged with the API.

Save receipt list item Processes this invoice API request. The parameter and response sections describe the data exchanged with the API.

Return list of receipts to process Processes this invoice API request. The parameter and response sections describe the data exchanged with the API.

Remove a receipt list item allocation Processes this invoice API request. The parameter and response sections describe the data exchanged with the API.

Remove a single receipt list item without and invoice or allocations Processes this invoice API request. The parameter and response sections describe the data exchanged with the API.

Process receipt list items for a specific negotiator. Processes this invoice API request. The parameter and response sections describe the data exchanged with the API.

Remove Save For Later. Processes this invoice API request. The parameter and response sections describe the data exchanged with the API.

Update properties on invoice Processes this invoice API request. The parameter and response sections describe the data exchanged with the API.

Formalise a draft invoice and create relevant ledger entries. Processes this invoice API request. The parameter and response sections describe the data exchanged with the API.

Get a summary of invoices outstanding, paid and funds available for an account. Processes this invoice API request. The parameter and response sections describe the data exchanged with the API.

Sets the invoice status to cancelled Processes this invoice API request. The parameter and response sections describe the data exchanged with the API.

Allows you to upload a document and attach it directly to an invoice. Processes this invoice API request. The parameter and response sections describe the data exchanged with the API.

Detaches a document from a invoice Processes this invoice API request. The parameter and response sections describe the data exchanged with the API.

Gets the invoice details Processes this invoice API request. The parameter and response sections describe the data exchanged with the API.

Gets the TransactionAudit information Processes this invoice API request. The parameter and response sections describe the data exchanged with the API.

Gets the next predicted invoice number to show in the UI Checks existing invoices for provided custom invoice number Processes this invoice API request. The parameter and response sections describe the data exchanged with the API.

Create recurring invoice schedule Processes this invoice API request. The parameter and response sections describe the data exchanged with the API.

Get recurring invoice schedules. If invoiceId is provided, returns only schedules for that invoice. If agencyId is provided, returns only schedules for that agency. Otherwise, returns all schedules. Processes this invoice API request. The parameter and response sections describe the data exchanged with the API.

Delete a specific recurring invoice schedule Processes this invoice API request. The parameter and response sections describe the data exchanged with the API.

Manually run the recurring invoices nightly job Processes this invoice API request. The parameter and response sections describe the data exchanged with the API.

Get invoice details for a specific invoice Processes this invoice API request. The parameter and response sections describe the data exchanged with the API.

Get original recurring invoices for datagrids. Processes this invoice API request. The parameter and response sections describe the data exchanged with the API.

Record and edit the feedback against a Valuation. Processes this valuation API request. The parameter and response sections describe the data exchanged with the API.

Record that the feedback for a Valuation was notified to the vendor. Processes this valuation API request. The parameter and response sections describe the data exchanged with the API.

Get an Valuation by its id. Processes this valuation API request. The parameter and response sections describe the data exchanged with the API.

Cancel a valuation appointment by id if it exists. Processes this valuation API request. The parameter and response sections describe the data exchanged with the API.

Does a simple merge of the selected envelopeTemplatePack using the data supplied will only use certain merge functions, and the correspondence can only contain one envelope and the envelope can only contain one document. Processes this stationary API request. The parameter and response sections describe the data exchanged with the API.

Does a simple merge of the selected envelopeTemplatePack using the data supplied will only use certain merge functions, and the correspondence can only contain one envelope and the envelope can only contain one document. Processes this stationary API request. The parameter and response sections describe the data exchanged with the API.

Save. Processes this text description API request. The parameter and response sections describe the data exchanged with the API.

Delete Description. Processes this text description API request. The parameter and response sections describe the data exchanged with the API.

Get text description. Processes this text description API request. The parameter and response sections describe the data exchanged with the API.

Gets a POI Processes this poi API request. The parameter and response sections describe the data exchanged with the API.

Adds POI's Processes this poi API request. The parameter and response sections describe the data exchanged with the API.

Delete a Poi by its Id Processes this poi API request. The parameter and response sections describe the data exchanged with the API.

Search for POI's in a radius from a point Processes this poi API request. The parameter and response sections describe the data exchanged with the API.

Search for POI's inside a bounding box Processes this poi API request. The parameter and response sections describe the data exchanged with the API.

Is User Allowed To View Vendor ID. Processes this authorization API request. The parameter and response sections describe the data exchanged with the API.

Is User Allowed To Access Reporting Area. Processes this authorization API request. The parameter and response sections describe the data exchanged with the API.

Is User Allowed To Bulk Archive Groups. Processes this authorization API request. The parameter and response sections describe the data exchanged with the API.

Is User Allowed To Bulk Reassign Ownership Groups. Processes this authorization API request. The parameter and response sections describe the data exchanged with the API.

Is User Allowed To Bulk Reassign Ownership Marketing Roles. Processes this authorization API request. The parameter and response sections describe the data exchanged with the API.

Is User Allowed To Export Groups. Processes this authorization API request. The parameter and response sections describe the data exchanged with the API.

Is User Allowed To Bulk Transfer. Processes this authorization API request. The parameter and response sections describe the data exchanged with the API.

Is User Allowed To Generate Sales AI Descriptions. Processes this authorization API request. The parameter and response sections describe the data exchanged with the API.

Is User Allowed To Generate Lettings AI Descriptions. Processes this authorization API request. The parameter and response sections describe the data exchanged with the API.

Is User Allowed To Read Only Financial Details. Processes this authorization API request. The parameter and response sections describe the data exchanged with the API.

Is User Allowed To Read Write Financial Details. Processes this authorization API request. The parameter and response sections describe the data exchanged with the API.

Rectify. Processes this rectification API request. The parameter and response sections describe the data exchanged with the API.

Get a Branch by its id. Processes this branch API request. The parameter and response sections describe the data exchanged with the API.

Get a Branch brandings by its id. Processes this branch API request. The parameter and response sections describe the data exchanged with the API.

Get Branch administrators by its id. Processes this branch API request. The parameter and response sections describe the data exchanged with the API.

Get Branch members by its id. Processes this branch API request. The parameter and response sections describe the data exchanged with the API.

Adds a negoatiator to a branch Processes this branch API request. The parameter and response sections describe the data exchanged with the API.

Get a specific brand by brandId or default brand within a branch if brandId is not supplied. Processes this branch API request. The parameter and response sections describe the data exchanged with the API.

Add or update fee for logged in branch. Processes this branch API request. The parameter and response sections describe the data exchanged with the API.

Delete fee for logged in branch. Processes this branch API request. The parameter and response sections describe the data exchanged with the API.

Get fees for logged in branch. Processes this branch API request. The parameter and response sections describe the data exchanged with the API.

Update the Fee Level Setting for branch Processes this branch API request. The parameter and response sections describe the data exchanged with the API.

Save a scheduled mail merge. Processes this branch API request. The parameter and response sections describe the data exchanged with the API.

Get all scheduled mail merges for the logged in branch. Processes this branch API request. The parameter and response sections describe the data exchanged with the API.

Update SystemStatus of ScheduledTask to Active, Inactive, Deleted or Archived. Processes this branch API request. The parameter and response sections describe the data exchanged with the API.

Check specified key codes exist in branch Processes this branch API request. The parameter and response sections describe the data exchanged with the API.

Given a external provider type, return all preferred companies for the branch Processes this branch API request. The parameter and response sections describe the data exchanged with the API.

Save or update an Amenity Description Processes this amenity description API request. The parameter and response sections describe the data exchanged with the API.

Delete an Amenity Description by its Id Processes this amenity description API request. The parameter and response sections describe the data exchanged with the API.

Get an Amenity Description by its Id Processes this amenity description API request. The parameter and response sections describe the data exchanged with the API.

Get ledger entry details by Id Processes this posting API request. The parameter and response sections describe the data exchanged with the API.

Get all ledger postings in the suspense account Processes this posting API request. The parameter and response sections describe the data exchanged with the API.

Get all postings in the cash account for the agent Processes this posting API request. The parameter and response sections describe the data exchanged with the API.

Add adjustment to ledger entry Processes this posting API request. The parameter and response sections describe the data exchanged with the API.

Get uncleared items for account/ledger Processes this posting API request. The parameter and response sections describe the data exchanged with the API.

Get uncleared items in accounting system Processes this posting API request. The parameter and response sections describe the data exchanged with the API.

Get a group by its Id Processes this group API request. The parameter and response sections describe the data exchanged with the API.

Delete a group Processes this group API request. The parameter and response sections describe the data exchanged with the API.

Delete a contact from a group Processes this group API request. The parameter and response sections describe the data exchanged with the API.

Get notes for Group Processes this group API request. The parameter and response sections describe the data exchanged with the API.

Get group note editions chains by their Ids Processes this group API request. The parameter and response sections describe the data exchanged with the API.

Adds a Group Processes this group API request. The parameter and response sections describe the data exchanged with the API.

Add a new contact to an existing group Processes this group API request. The parameter and response sections describe the data exchanged with the API.

Saves Search Criteria to a Group Processes this group API request. The parameter and response sections describe the data exchanged with the API.

Saves Lettings Search Criteria to a group Processes this group API request. The parameter and response sections describe the data exchanged with the API.

Set the Team Group for a searching role Processes this group API request. The parameter and response sections describe the data exchanged with the API.

Set the Team Group for multiple searching roles Processes this group API request. The parameter and response sections describe the data exchanged with the API.

Bulk reassign Group ownership Processes this group API request. The parameter and response sections describe the data exchanged with the API.

Deletes Search Criteria from a Group Processes this group API request. The parameter and response sections describe the data exchanged with the API.

Get Sales Searching Roles for a Group Processes this group API request. The parameter and response sections describe the data exchanged with the API.

Get Lettings Searching Roles for a Group Processes this group API request. The parameter and response sections describe the data exchanged with the API.

Get property matches for a Searching Role for a Group Processes this group API request. The parameter and response sections describe the data exchanged with the API.

Get property matches for a Searching Role for a Group Processes this group API request. The parameter and response sections describe the data exchanged with the API.

Returns property matches using their Id Processes this group API request. The parameter and response sections describe the data exchanged with the API.

Get group events by its Id Processes this group API request. The parameter and response sections describe the data exchanged with the API.

Get group events by its Id Processes this group API request. The parameter and response sections describe the data exchanged with the API.

Edit Display settings for the Group. Primarily shown in the GroupHub e.g. the icon and background image. Processes this group API request. The parameter and response sections describe the data exchanged with the API.

Attaches an existing document to a group Processes this group API request. The parameter and response sections describe the data exchanged with the API.

Detaches a document from a group Processes this group API request. The parameter and response sections describe the data exchanged with the API.

Uploads a new document and attaches it to the specified group. Processes this group API request. The parameter and response sections describe the data exchanged with the API.

Attaches the external document. Processes this group API request. The parameter and response sections describe the data exchanged with the API.

Sets the description of the specified group Processes this group API request. The parameter and response sections describe the data exchanged with the API.

Set the Groups home Branch Changes the Group's Branch, will only allow to change to a branch in same agency

Set the Groups owning team Changes the Group's owning team

returns a list of the property role ids that should be excluded from mailouts to this role id because the have been sent before Processes this group API request. The parameter and response sections describe the data exchanged with the API.

Get a list of documents belonging to a group Processes this group API request. The parameter and response sections describe the data exchanged with the API.

Get a list of documents belonging to a group and it's related roles Processes this group API request. The parameter and response sections describe the data exchanged with the API.

Get a list of documents belonging to a group Processes this group API request. The parameter and response sections describe the data exchanged with the API.

Get a list of documents belonging to a group Processes this group API request. The parameter and response sections describe the data exchanged with the API.

Return all background images. Processes this group API request. The parameter and response sections describe the data exchanged with the API.

Return the Groups with appointments between a given date range, ordered by appointments Count Processes this group API request. The parameter and response sections describe the data exchanged with the API.

Return the Groups with the most viewings between a given date range, ordered by viewing Count Processes this group API request. The parameter and response sections describe the data exchanged with the API.

Return the lat and longs for every applicant in the system Processes this group API request. The parameter and response sections describe the data exchanged with the API.

Return a list of properties that the group owns Processes this group API request. The parameter and response sections describe the data exchanged with the API.

To save or edit the Group additional info i.e. the Origin and Grade. Processes this group API request. The parameter and response sections describe the data exchanged with the API.

To edit the Group additional questions Processes this group API request. The parameter and response sections describe the data exchanged with the API.

To send an adhoc email to a group Processes this group API request. The parameter and response sections describe the data exchanged with the API.

To send an adhoc sms to a group Processes this group API request. The parameter and response sections describe the data exchanged with the API.

Returns GeoAggregations of all searching groups Processes this group API request. The parameter and response sections describe the data exchanged with the API.

Sets members Active/Inactive system status Processes this group API request. The parameter and response sections describe the data exchanged with the API.

Sets order for members of a group Processes this group API request. The parameter and response sections describe the data exchanged with the API.

Get the roles for a Group by Group id Processes this group API request. The parameter and response sections describe the data exchanged with the API.

Records an event on the group representing a neg being in contact Processes this group API request. The parameter and response sections describe the data exchanged with the API.

Sets the interest flags on groups interest role. Processes this group API request. The parameter and response sections describe the data exchanged with the API.

Undelete a group Processes this group API request. The parameter and response sections describe the data exchanged with the API.

Add a preferred company to a group Processes this group API request. The parameter and response sections describe the data exchanged with the API.

Remove a preferred company to a group Processes this group API request. The parameter and response sections describe the data exchanged with the API.

Archive groups in bulk Processes this group API request. The parameter and response sections describe the data exchanged with the API.

Update the fee for a given group. Processes this group API request. The parameter and response sections describe the data exchanged with the API.

Stores the in the cache subsystem. Processes this cache API request. The parameter and response sections describe the data exchanged with the API.

Retrieves an object stored in the cache system by its Processes this cache API request. The parameter and response sections describe the data exchanged with the API.

Retrieves a list of objects stored in the cache system by its Processes this cache API request. The parameter and response sections describe the data exchanged with the API.

Adds to the tail of an existing list, or creates a new list with the object in it. Processes this cache API request. The parameter and response sections describe the data exchanged with the API.

Adds to the head of an existing list, or creates a new list with the object in it. Processes this cache API request. The parameter and response sections describe the data exchanged with the API.

Removes a given item from the list. Processes this cache API request. The parameter and response sections describe the data exchanged with the API.

Pops an items from the list head. Processes this cache API request. The parameter and response sections describe the data exchanged with the API.

Deletes the item stored at Processes this cache API request. The parameter and response sections describe the data exchanged with the API.

Generate a guid for use as a key Processes this cache API request. The parameter and response sections describe the data exchanged with the API.

Saves or Updates a General ToDo This is currently used to save quick reminders Processes this general to do API request. The parameter and response sections describe the data exchanged with the API.

Get the profile infos for a task Processes this general to do API request. The parameter and response sections describe the data exchanged with the API.

Sets the fee structure on an agency Processes this agency admin API request. The parameter and response sections describe the data exchanged with the API.

Get an auction by its id. Processes this auction API request. The parameter and response sections describe the data exchanged with the API.

Save or update an auction. Processes this auction API request. The parameter and response sections describe the data exchanged with the API.

To confirm or unconfirm a list of lots for the auction Processes this auction API request. The parameter and response sections describe the data exchanged with the API.

To withdraw a list of properties from the auction Processes this auction API request. The parameter and response sections describe the data exchanged with the API.

To postpone a list of lots for the auction Processes this auction API request. The parameter and response sections describe the data exchanged with the API.

Add a new contact to the given auction Role or edit an existing contact Processes this auction API request. The parameter and response sections describe the data exchanged with the API.

Remove an existing auction contact from the auction role Processes this auction API request. The parameter and response sections describe the data exchanged with the API.

Record auction bid details Processes this auction API request. The parameter and response sections describe the data exchanged with the API.

Save or update a FloodErosion Description Processes this flood erosion description API request. The parameter and response sections describe the data exchanged with the API.

Delete a FloodErosion Description by its Id Processes this flood erosion description API request. The parameter and response sections describe the data exchanged with the API.

Get a FloodErosion Description by its Id Processes this flood erosion description API request. The parameter and response sections describe the data exchanged with the API.

Get Accounts Deposits. Processes this deposit API request. The parameter and response sections describe the data exchanged with the API.

Get Unprotected Overview. Processes this deposit API request. The parameter and response sections describe the data exchanged with the API.

Releases the deposit money back to the user. If invoices are supplied these are created for DepositDeductions Processes this deposit API request. The parameter and response sections describe the data exchanged with the API.

Protect In Scheme. Processes this deposit API request. The parameter and response sections describe the data exchanged with the API.

Create Scheme. Processes this deposit API request. The parameter and response sections describe the data exchanged with the API.

Get All Schemes. Processes this deposit API request. The parameter and response sections describe the data exchanged with the API.

Get Scheme Groupings. Processes this deposit API request. The parameter and response sections describe the data exchanged with the API.

Transfer To Landlord. Processes this deposit API request. The parameter and response sections describe the data exchanged with the API.

Get deposit collections Processes this deposit API request. The parameter and response sections describe the data exchanged with the API.

Returns a list of invoice deductions linked to the deposit invoice Processes this deposit API request. The parameter and response sections describe the data exchanged with the API.

Returns an invoice linked to Tenant Deposit Processes this deposit API request. The parameter and response sections describe the data exchanged with the API.

Events. Processes this list stats API request. The parameter and response sections describe the data exchanged with the API.

Groups. Processes this list stats API request. The parameter and response sections describe the data exchanged with the API.

Property. Processes this list stats API request. The parameter and response sections describe the data exchanged with the API.

Group Interests. Processes this list stats API request. The parameter and response sections describe the data exchanged with the API.

Todos. Processes this list stats API request. The parameter and response sections describe the data exchanged with the API.

Todo Tasks. Processes this list stats API request. The parameter and response sections describe the data exchanged with the API.

Follow Ups. Processes this list stats API request. The parameter and response sections describe the data exchanged with the API.

Invoice. Processes this list stats API request. The parameter and response sections describe the data exchanged with the API.

Returns a list of values of the queries sent through Processes this list stats API request. The parameter and response sections describe the data exchanged with the API.

Tenancy Rent Demands Stats. Processes this list stats API request. The parameter and response sections describe the data exchanged with the API.

Returns a list of totals for tenants with missing information Processes this list stats API request. The parameter and response sections describe the data exchanged with the API.

Returns a list of totals for landlords with missing information Processes this list stats API request. The parameter and response sections describe the data exchanged with the API.

Returns a list of totals for properties with expiring information Processes this list stats API request. The parameter and response sections describe the data exchanged with the API.

Returns a list of totals for certificates stats Processes this list stats API request. The parameter and response sections describe the data exchanged with the API.

Get the oauth url for the twitter integration service Processes this twitter API request. The parameter and response sections describe the data exchanged with the API.

Get the oauth url for the twitter integration service Processes this twitter API request. The parameter and response sections describe the data exchanged with the API.

Sends a direct message to a screen name Processes this twitter API request. The parameter and response sections describe the data exchanged with the API.

Sends a direct message to a screen name Processes this twitter API request. The parameter and response sections describe the data exchanged with the API.

Set the performance level of a database node Processes this database API request. The parameter and response sections describe the data exchanged with the API.

Get all the live portal uploads associated with a property marketing role Processes this portal API request. The parameter and response sections describe the data exchanged with the API.

creates an event when a envelope is bounced by signable Processes this digital signature API request. The parameter and response sections describe the data exchanged with the API.

creates an event when a document is opened Processes this digital signature API request. The parameter and response sections describe the data exchanged with the API.

creates an event when a document is cancelled Processes this digital signature API request. The parameter and response sections describe the data exchanged with the API.

creates an event when a document is sent out by signable Processes this digital signature API request. The parameter and response sections describe the data exchanged with the API.

creates an event when a document is signed Processes this digital signature API request. The parameter and response sections describe the data exchanged with the API.

creates an event when a document is completed Processes this digital signature API request. The parameter and response sections describe the data exchanged with the API.

creates a new account on signable Processes this digital signature API request. The parameter and response sections describe the data exchanged with the API.

Signable Enabled. Processes this digital signature API request. The parameter and response sections describe the data exchanged with the API.

delete a sub account on signable Processes this digital signature API request. The parameter and response sections describe the data exchanged with the API.

Cancel an Envelope Processes this digital signature API request. The parameter and response sections describe the data exchanged with the API.

Expire an Envelope Processes this digital signature API request. The parameter and response sections describe the data exchanged with the API.

Send a reminder for an Envelope Processes this digital signature API request. The parameter and response sections describe the data exchanged with the API.

Gets accounting system for a legal entity Processes this accounting system API request. The parameter and response sections describe the data exchanged with the API.

Gets accounting system balance Processes this accounting system API request. The parameter and response sections describe the data exchanged with the API.

Archives the accounting system Processes this accounting system API request. The parameter and response sections describe the data exchanged with the API.

Get Tax Status of Accounting System Processes this accounting system API request. The parameter and response sections describe the data exchanged with the API.

Get amount of funds held in suspense account of the accounting system Processes this accounting system API request. The parameter and response sections describe the data exchanged with the API.

Gets overview of the agent cash account Processes this accounting system API request. The parameter and response sections describe the data exchanged with the API.

Get Accounting Enums. Processes this accounting system API request. The parameter and response sections describe the data exchanged with the API.

Sets office account as primary office account Processes this accounting system API request. The parameter and response sections describe the data exchanged with the API.

Create an office account for the accounting system Processes this accounting system API request. The parameter and response sections describe the data exchanged with the API.

Delete office account Processes this accounting system API request. The parameter and response sections describe the data exchanged with the API.

Get list of office accounts associated with the accounting system Processes this accounting system API request. The parameter and response sections describe the data exchanged with the API.

Set Primary Bank Account for Accounting System Processes this accounting system API request. The parameter and response sections describe the data exchanged with the API.

Creates or Updates Security Credentials Processes this credentials API request. The parameter and response sections describe the data exchanged with the API.

Gets Email Sync Security Credentials Processes this credentials API request. The parameter and response sections describe the data exchanged with the API.

Creates or Updates Email Sync Security Credentials This also uses the credentials to do a quick check and see if they are working it will throw an internal server error if there is an issue with the connection but this may be the server address (set in admin centre) or the username/password Processes this credentials API request. The parameter and response sections describe the data exchanged with the API.

Delete Security Credentials Processes this credentials API request. The parameter and response sections describe the data exchanged with the API.

Delete Email Sync For a User Processes this credentials API request. The parameter and response sections describe the data exchanged with the API.

Create chain for sales progression role Processes this progression chain API request. The parameter and response sections describe the data exchanged with the API.

Add node to progression chain Processes this progression chain API request. The parameter and response sections describe the data exchanged with the API.

Add node to progression chain Processes this progression chain API request. The parameter and response sections describe the data exchanged with the API.

Add node to progression chain Processes this progression chain API request. The parameter and response sections describe the data exchanged with the API.

Add node to progression chain Processes this progression chain API request. The parameter and response sections describe the data exchanged with the API.

Add node to progression chain Processes this progression chain API request. The parameter and response sections describe the data exchanged with the API.

Create chain for sales progression role Processes this progression chain API request. The parameter and response sections describe the data exchanged with the API.

Get the progression chain for purchasing role Processes this progression chain API request. The parameter and response sections describe the data exchanged with the API.

Update a node in a progression chain Processes this progression chain API request. The parameter and response sections describe the data exchanged with the API.

Instructs a role to be let Processes this auction progression API request. The parameter and response sections describe the data exchanged with the API.

Retrieve Material Information Audit Logs for Role . Processes this audit API request. The parameter and response sections describe the data exchanged with the API.

Retrieve Audit Logs for a specific entity. Processes this audit API request. The parameter and response sections describe the data exchanged with the API.

Instructs a role to be sold Processes this sales progression API request. The parameter and response sections describe the data exchanged with the API.

Exchanges a sales role Processes this sales progression API request. The parameter and response sections describe the data exchanged with the API.

Completes a sales role Processes this sales progression API request. The parameter and response sections describe the data exchanged with the API.

Set the estimated completion date on a purchasing role Processes this sales progression API request. The parameter and response sections describe the data exchanged with the API.

Set the estimated exchange date on a purchasing role Processes this sales progression API request. The parameter and response sections describe the data exchanged with the API.

Set the completion date on a purchasing role Processes this sales progression API request. The parameter and response sections describe the data exchanged with the API.

Set the exchange date on a purchasing role Processes this sales progression API request. The parameter and response sections describe the data exchanged with the API.

Set Marketing Role as Fallen Through Processes this sales progression API request. The parameter and response sections describe the data exchanged with the API.

Get a list of documents belonging to a sales progression role Processes this sales progression API request. The parameter and response sections describe the data exchanged with the API.

Discard the Lead. Processes this inbound lead API request. The parameter and response sections describe the data exchanged with the API.

Check for Matching groups for the given leads based on contact item values i.e. Emails and Phones. Processes this inbound lead API request. The parameter and response sections describe the data exchanged with the API.

Endpoint to update group on inbound lead task Processes this inbound lead API request. The parameter and response sections describe the data exchanged with the API.

Creates a lead in the system, optinally assigning the lead to a negotiator Processes this inbound lead API request. The parameter and response sections describe the data exchanged with the API.

Gets a lead by its id Processes this inbound lead API request. The parameter and response sections describe the data exchanged with the API.

Gets all leads that are awaiting to be processed Processes this inbound lead API request. The parameter and response sections describe the data exchanged with the API.

Get legacy. Processes this legacy API request. The parameter and response sections describe the data exchanged with the API.

Create Referral. Processes this legal API request. The parameter and response sections describe the data exchanged with the API.

Create Third Party Referrals. Processes this legal API request. The parameter and response sections describe the data exchanged with the API.

Get Referrer Case. Processes this legal API request. The parameter and response sections describe the data exchanged with the API.

Get Referrer Cases. Processes this legal API request. The parameter and response sections describe the data exchanged with the API.

Save a custom field within a predefinied custom field group. Processes this custom field API request. The parameter and response sections describe the data exchanged with the API.

Update the System Status of custom field. i.e. Active or Deleted Processes this custom field API request. The parameter and response sections describe the data exchanged with the API.

Save Value. Processes this custom field API request. The parameter and response sections describe the data exchanged with the API.

Saving a list of custom fields to an entity Processes this custom field API request. The parameter and response sections describe the data exchanged with the API.

Save Custom Field Value. Processes this custom field API request. The parameter and response sections describe the data exchanged with the API.

Gets a temporary document stored by document generation, so that it can be previewed. Processes this preview API request. The parameter and response sections describe the data exchanged with the API.

Save a file sent in native word format, and convert it to the right file format to be saved to disk Processes this preview API request. The parameter and response sections describe the data exchanged with the API.

Gets a html document from public storage and returns the html body Processes this preview API request. The parameter and response sections describe the data exchanged with the API.

Save a file html format Processes this preview API request. The parameter and response sections describe the data exchanged with the API.

Gets a text document from public storage and returns Processes this preview API request. The parameter and response sections describe the data exchanged with the API.

Save a file in text format Processes this preview API request. The parameter and response sections describe the data exchanged with the API.

returns a list of all of the campaigns for an agency Processes this analytics API request. The parameter and response sections describe the data exchanged with the API.

Updates or Creates a Campaign Processes this analytics API request. The parameter and response sections describe the data exchanged with the API.

Updates or Creates a Campaign Processes this analytics API request. The parameter and response sections describe the data exchanged with the API.

Updates or Creates a Campaign Processes this analytics API request. The parameter and response sections describe the data exchanged with the API.

Get a person by its Id Processes this negotiator API request. The parameter and response sections describe the data exchanged with the API.

Gets negotiators online / offline status. Processes this negotiator API request. The parameter and response sections describe the data exchanged with the API.

Get negotiators online / offline status. Processes this negotiator API request. The parameter and response sections describe the data exchanged with the API.

Get all archived Negotiators for the Agency's branch. Processes this negotiator API request. The parameter and response sections describe the data exchanged with the API.

Used for the Property Sales Dashboard to return a list of the negotiator's properties. Processes this negotiator API request. The parameter and response sections describe the data exchanged with the API.

Lists favourited properties Processes this negotiator API request. The parameter and response sections describe the data exchanged with the API.

Add property to Negotiators favourite list Processes this negotiator API request. The parameter and response sections describe the data exchanged with the API.

Remove a property from a Negotiators favourite list. Processes this negotiator API request. The parameter and response sections describe the data exchanged with the API.

Returns a list of the logged in negotiators favourite groups. Processes this negotiator API request. The parameter and response sections describe the data exchanged with the API.

Add a favourite group to the negotiators list of favourites. Processes this negotiator API request. The parameter and response sections describe the data exchanged with the API.

Remove a group from a Negotiators favourite list. Processes this negotiator API request. The parameter and response sections describe the data exchanged with the API.

Return all Negotiator keys for the side bar display. Processes this negotiator API request. The parameter and response sections describe the data exchanged with the API.

Return interval based event counts for negotiators. Processes this negotiator API request. The parameter and response sections describe the data exchanged with the API.

Set the online/offline status of the logged in negotiator Processes this negotiator API request. The parameter and response sections describe the data exchanged with the API.

Gets the preferences for current negotiator Processes this negotiator API request. The parameter and response sections describe the data exchanged with the API.

Save or Update Negotiator Preferences Processes this negotiator API request. The parameter and response sections describe the data exchanged with the API.

Allows you to upload a document for use as email signature Processes this negotiator API request. The parameter and response sections describe the data exchanged with the API.

Gets a list of the logged in users responsibilities Processes this negotiator API request. The parameter and response sections describe the data exchanged with the API.

Create New Negotiator Processes this negotiator API request. The parameter and response sections describe the data exchanged with the API.

Update My Biography Processes this negotiator API request. The parameter and response sections describe the data exchanged with the API.

Get a Negotiators Timeline Preferences Processes this negotiator API request. The parameter and response sections describe the data exchanged with the API.

Save or Update Negotiator Timeline Preferences Processes this negotiator API request. The parameter and response sections describe the data exchanged with the API.

Get a Negotiator by its id. Processes this negotiator API request. The parameter and response sections describe the data exchanged with the API.

Get negotiators online / offline status. Processes this negotiator API request. The parameter and response sections describe the data exchanged with the API.

Record and timestamp a visit to a 'page' on Rezi. Processes this stats API request. The parameter and response sections describe the data exchanged with the API.

Get all recent history of 'pages' visited on Rezi for a given entity type. Processes this stats API request. The parameter and response sections describe the data exchanged with the API.

Rightmove. Processes this stats API request. The parameter and response sections describe the data exchanged with the API.

Portals. Processes this stats API request. The parameter and response sections describe the data exchanged with the API.

Set the requested lot number for a property auction role. Processes this auction role API request. The parameter and response sections describe the data exchanged with the API.

Set the lot number for a property auction role. Processes this auction role API request. The parameter and response sections describe the data exchanged with the API.

Add a property auction role to an existing auction Processes this auction role API request. The parameter and response sections describe the data exchanged with the API.

Add a property auction role to an existing auction Processes this auction role API request. The parameter and response sections describe the data exchanged with the API.

Set the reserve for a property auction role. Processes this auction role API request. The parameter and response sections describe the data exchanged with the API.

Set the type of auction role (Commercial or Residential) Processes this auction role API request. The parameter and response sections describe the data exchanged with the API.

Get auction role milestones Processes this auction role API request. The parameter and response sections describe the data exchanged with the API.

Update an auction role milestone Processes this auction role API request. The parameter and response sections describe the data exchanged with the API.

Add a new auction role milestone Processes this auction role API request. The parameter and response sections describe the data exchanged with the API.

Delete a custom auction milestone Processes this auction role API request. The parameter and response sections describe the data exchanged with the API.

Create default milestones for role if they dont exist Processes this auction role API request. The parameter and response sections describe the data exchanged with the API.

Reports that a data migration has been shedueled. Processes this core platform state API request. The parameter and response sections describe the data exchanged with the API.

Reports that a data migration has been shedueled - used by workflow Processes this core platform state API request. The parameter and response sections describe the data exchanged with the API.

Clears a state item. Processes this core platform state API request. The parameter and response sections describe the data exchanged with the API.

Allows business workflows to post system issues to the platform state service. Processes this core platform state API request. The parameter and response sections describe the data exchanged with the API.

Gets core platform master health status, returns 200 if everything is fine and 500 if a system is down. Processes this core platform state API request. The parameter and response sections describe the data exchanged with the API.

Gets the api instance timestamp, returns 200 if everything is fine and 500 if the timestamp cannot be retrieved. Processes this core platform state API request. The parameter and response sections describe the data exchanged with the API.

Resets the current health state in the cache, this doesn't fix anything but helps if you have agency specific keys stuck in the cache. Processes this core platform state API request. The parameter and response sections describe the data exchanged with the API.

Validates a posted token Processes this core platform state API request. The parameter and response sections describe the data exchanged with the API.

Sets a reminder Processes this reminder API request. The parameter and response sections describe the data exchanged with the API.

Find. Processes this tasks API request. The parameter and response sections describe the data exchanged with the API.

Get the latest task for a group Processes this tasks API request. The parameter and response sections describe the data exchanged with the API.

Add note to a task Processes this tasks API request. The parameter and response sections describe the data exchanged with the API.

Get a list of note events for a task Processes this tasks API request. The parameter and response sections describe the data exchanged with the API.

Returns a list of the distinct defined custom descriptions for a property Processes this custom text description API request. The parameter and response sections describe the data exchanged with the API.

Updates the metadata for document generation merge fields Processes this system API request. The parameter and response sections describe the data exchanged with the API.

Sends a message to the LivePortalJobHandler that says the specified property marketing role has changed Processes this system API request. The parameter and response sections describe the data exchanged with the API.

Send a live notification to all active users in an agency Processes this system API request. The parameter and response sections describe the data exchanged with the API.

Creates a new system wide feature available for activation. Processes this system API request. The parameter and response sections describe the data exchanged with the API.

Lists the name and ID of all agencies in the system. Processes this system API request. The parameter and response sections describe the data exchanged with the API.

Save. Processes this style age description API request. The parameter and response sections describe the data exchanged with the API.

Delete Description. Processes this style age description API request. The parameter and response sections describe the data exchanged with the API.

Get style age description. Processes this style age description API request. The parameter and response sections describe the data exchanged with the API.

Given an agreement id, gets the tenancy agreement. Processes this tenancy agreement API request. The parameter and response sections describe the data exchanged with the API.

Add Serve Notice. Processes this tenancy agreement API request. The parameter and response sections describe the data exchanged with the API.

Update Serve Notice. Processes this tenancy agreement API request. The parameter and response sections describe the data exchanged with the API.

Get a role by its Id Processes this role API request. The parameter and response sections describe the data exchanged with the API.

Gets the compliance country for the role using the configured compliance level preference. Processes this role API request. The parameter and response sections describe the data exchanged with the API.

Pauses searching roles in bulk (by GroupFilter) Processes this role API request. The parameter and response sections describe the data exchanged with the API.

UnPauses searching roles in bulk (by Id) Processes this role API request. The parameter and response sections describe the data exchanged with the API.

Get role events by its Id Processes this role API request. The parameter and response sections describe the data exchanged with the API.

Cancels all future viewing appointments for a role. Processes this role API request. The parameter and response sections describe the data exchanged with the API.

Get role events inspections by its Id Processes this role API request. The parameter and response sections describe the data exchanged with the API.

Get role events by its Id Processes this role API request. The parameter and response sections describe the data exchanged with the API.

Get role events by its Id Processes this role API request. The parameter and response sections describe the data exchanged with the API.

Get role note editions chains by their Ids Processes this role API request. The parameter and response sections describe the data exchanged with the API.

Get role note editions chains by their Ids for Sales Progression Hub, Activity tab. Processes this role API request. The parameter and response sections describe the data exchanged with the API.

Gets role events for every role within the sales chain Processes this role API request. The parameter and response sections describe the data exchanged with the API.

Get the descriptions for a role by role id Processes this role API request. The parameter and response sections describe the data exchanged with the API.

Detaches a description from a role Processes this role API request. The parameter and response sections describe the data exchanged with the API.

Get the members of a role by the role Id Processes this role API request. The parameter and response sections describe the data exchanged with the API.

Get the tenants of a lettings role by the role Id Processes this role API request. The parameter and response sections describe the data exchanged with the API.

Get a list of groups that may be interested in this property role Processes this role API request. The parameter and response sections describe the data exchanged with the API.

Get a list of groups that may be interested in this property role Processes this role API request. The parameter and response sections describe the data exchanged with the API.

Get list of role ids Processes this role API request. The parameter and response sections describe the data exchanged with the API.

Get a list of documents belonging to a role Processes this role API request. The parameter and response sections describe the data exchanged with the API.

Get a list of documents belonging to a role and its related roles and group Processes this role API request. The parameter and response sections describe the data exchanged with the API.

Get a single DocumentPlaceholder which is the 'slot' the particular document of type+source exists within. Processes this role API request. The parameter and response sections describe the data exchanged with the API.

Set Placeholder Document. Processes this role API request. The parameter and response sections describe the data exchanged with the API.

Get a list of ordered images belonging to a role Processes this role API request. The parameter and response sections describe the data exchanged with the API.

Get a list of ordered brochures belonging to a role Processes this role API request. The parameter and response sections describe the data exchanged with the API.

Updates the image order on a role Processes this role API request. The parameter and response sections describe the data exchanged with the API.

Gets the image order for the role Processes this role API request. The parameter and response sections describe the data exchanged with the API.

Updates the brochure order on a role Processes this role API request. The parameter and response sections describe the data exchanged with the API.

Attaches an existing document to a role Processes this role API request. The parameter and response sections describe the data exchanged with the API.

Detaches a document from a role Processes this role API request. The parameter and response sections describe the data exchanged with the API.

Detaches multiple documents from a role Processes this role API request. The parameter and response sections describe the data exchanged with the API.

Detaches a document from a document placeholder Processes this role API request. The parameter and response sections describe the data exchanged with the API.

Allows you to upload a document and attach it directly to a role. Processes this role API request. The parameter and response sections describe the data exchanged with the API.

Approve a document Processes this role API request. The parameter and response sections describe the data exchanged with the API.

Reject a document Processes this role API request. The parameter and response sections describe the data exchanged with the API.

Attaches an externally hosted document to a role Processes this role API request. The parameter and response sections describe the data exchanged with the API.

Update price for a given PropertySalesRole. Processes this role API request. The parameter and response sections describe the data exchanged with the API.

Gets the valuation for a property marketing role Processes this role API request. The parameter and response sections describe the data exchanged with the API.

Gets the valuation for a property marketing role Processes this role API request. The parameter and response sections describe the data exchanged with the API.

Get all of the offers associated to the current property marketing role. Processes this role API request. The parameter and response sections describe the data exchanged with the API.

Rejects all pending offers associated to the current property marketing role. Processes this role API request. The parameter and response sections describe the data exchanged with the API.

Get a basic list of offers associated to the current property marketing role. Processes this role API request. The parameter and response sections describe the data exchanged with the API.

Get an object of all synced areas to the current property marketing role. Processes this role API request. The parameter and response sections describe the data exchanged with the API.

Toggle sync area for a given PropertyMarketingRole. Processes this role API request. The parameter and response sections describe the data exchanged with the API.

Get a basic list of all viewings for a particular marketing role. Processes this role API request. The parameter and response sections describe the data exchanged with the API.

Get all of the viewings associated to the current property marketing role. Processes this role API request. The parameter and response sections describe the data exchanged with the API.

Update the fee for a given PropertyMarketingRole. Processes this role API request. The parameter and response sections describe the data exchanged with the API.

Add a fee for a given PropertyMarketingRole. Processes this role API request. The parameter and response sections describe the data exchanged with the API.

Remove a fee from a given PropertyMarketingRole. Processes this role API request. The parameter and response sections describe the data exchanged with the API.

Sets the role closing date Processes this role API request. The parameter and response sections describe the data exchanged with the API.

Sets the default image of a property marketing role Processes this role API request. The parameter and response sections describe the data exchanged with the API.

Confirms the compliance checks have been carried out on a marketing role Processes this role API request. The parameter and response sections describe the data exchanged with the API.

Sets a flag on a property marketing role Processes this role API request. The parameter and response sections describe the data exchanged with the API.

Set the compliance checks on a property marketing role i.e. Valid Epc, Proof of ID or Proof of Ownership. Processes this role API request. The parameter and response sections describe the data exchanged with the API.

Change the owining team of a Role Processes this role API request. The parameter and response sections describe the data exchanged with the API.

Change the branch of a role Processes this role API request. The parameter and response sections describe the data exchanged with the API.

Change the branch of a role Processes this role API request. The parameter and response sections describe the data exchanged with the API.

Creates/Adds a group to the supplied roleId Processes this role API request. The parameter and response sections describe the data exchanged with the API.

Search for property marketing roles that match the specified search criteria Query = Search query to execute PageSize = Number of results to show on each page PageNumber = Which page to return SuggestType = AgencyOnly, ViewableOnly IsOnMarket = Return only on market property roles

Search for property marketing roles that are in OfferAccepted or Exchanged status Query = Search query to execute PageSize = Number of results to show on each page PageNumber = Which page to return SuggestType = AgencyOnly, ViewableOnly IsOnMarket = Return only on market property roles RoleStatus = List of role statuses the property role is in

Set portal configuration exclusivity overrides Processes this role API request. The parameter and response sections describe the data exchanged with the API.

Notes. Processes this role API request. The parameter and response sections describe the data exchanged with the API.

To send an board request email to a external provider Processes this role API request. The parameter and response sections describe the data exchanged with the API.

Get all brands with details for an agency Processes this role API request. The parameter and response sections describe the data exchanged with the API.

Get all brands with details for an agency Processes this role API request. The parameter and response sections describe the data exchanged with the API.

Creates a referral event on the role Processes this role API request. The parameter and response sections describe the data exchanged with the API.

Clones a property marketing role Processes this role API request. The parameter and response sections describe the data exchanged with the API.

Set holding deposit for marketing role Processes this role API request. The parameter and response sections describe the data exchanged with the API.

Pay funds against holding deposit Processes this role API request. The parameter and response sections describe the data exchanged with the API.

Remove holding deposit from role Processes this role API request. The parameter and response sections describe the data exchanged with the API.

Reset the holding deposit for a role Processes this role API request. The parameter and response sections describe the data exchanged with the API.

Starts the job which will eventually return a PDF with all sales progression activity Processes this role API request. The parameter and response sections describe the data exchanged with the API.

Endpoint to Bulk reassign . Processes this role API request. The parameter and response sections describe the data exchanged with the API.

Save a custom field group for a predefined type. Processes this custom field group API request. The parameter and response sections describe the data exchanged with the API.

Update the System Status of custom field group. i.e. Active or Deleted Processes this custom field group API request. The parameter and response sections describe the data exchanged with the API.

Get a list of custom field groups for a type and optional group name specified. Processes this custom field group API request. The parameter and response sections describe the data exchanged with the API.

Gets the available products for tenant referencing Processes this tenant referencing API request. The parameter and response sections describe the data exchanged with the API.

Gets a tenancy referencing case based on the role id supplied Processes this tenant referencing API request. The parameter and response sections describe the data exchanged with the API.

Gets all tenancy referencing applications for the caseId provided Processes this tenant referencing API request. The parameter and response sections describe the data exchanged with the API.

Creates a tenancy referencing case using the role id supplied Processes this tenant referencing API request. The parameter and response sections describe the data exchanged with the API.

Creates a tenancy referencing application for a case using the details supplied Processes this tenant referencing API request. The parameter and response sections describe the data exchanged with the API.

Adds a Guarantor to a tenancy referencing application for a case using the details supplied Processes this tenant referencing API request. The parameter and response sections describe the data exchanged with the API.

Submits a tenant referencing case for processing Processes this tenant referencing API request. The parameter and response sections describe the data exchanged with the API.

Submits an individual referencing application for processing Processes this tenant referencing API request. The parameter and response sections describe the data exchanged with the API.

Get the details of an individual application referencing result Processes this tenant referencing API request. The parameter and response sections describe the data exchanged with the API.

Register agency with Van mildert, and all of their branches for the 7 day free trial. Processes this tenant referencing API request. The parameter and response sections describe the data exchanged with the API.

Get a html form element and hidden fields, which can then be submitted to an iframe Containing the references information for a new application Processes this tenant referencing API request. The parameter and response sections describe the data exchanged with the API.

Get a html form element and hidden fields, which can then be submitted to an iframe for the tracking page Containing the references information for a new application Processes this tenant referencing API request. The parameter and response sections describe the data exchanged with the API.

Posted via the incomming gateway, this records the oid against the tenancy role so that we know it is is ordered Processes this tenant referencing API request. The parameter and response sections describe the data exchanged with the API.

Posted via the incomming gateway, this updates the tenancy referening status for this tenancy and maybe in the future will download documents from vm, store them in our system and attach the documents to the role Processes this tenant referencing API request. The parameter and response sections describe the data exchanged with the API.

Get Account By Id Processes this account API request. The parameter and response sections describe the data exchanged with the API.

Get all accounts paginated Processes this account API request. The parameter and response sections describe the data exchanged with the API.

Retrieve ledger posting details for an account Processes this account API request. The parameter and response sections describe the data exchanged with the API.

Retrive ledger postings without account id Processes this account API request. The parameter and response sections describe the data exchanged with the API.

Create account for groupId provided Processes this account API request. The parameter and response sections describe the data exchanged with the API.

Set an accounts status Processes this account API request. The parameter and response sections describe the data exchanged with the API.

Update account details Processes this account API request. The parameter and response sections describe the data exchanged with the API.

Get a statement for an account Processes this account API request. The parameter and response sections describe the data exchanged with the API.

Get a statement for an account Processes this account API request. The parameter and response sections describe the data exchanged with the API.

Generate a landlord income report Processes this account API request. The parameter and response sections describe the data exchanged with the API.

Create a new System account eg. new client account Processes this account API request. The parameter and response sections describe the data exchanged with the API.

Get list of all system accounts Processes this account API request. The parameter and response sections describe the data exchanged with the API.

Get balance of an account Processes this account API request. The parameter and response sections describe the data exchanged with the API.

Get list of accounts with sorting and searching and by type of group for the accounts Processes this account API request. The parameter and response sections describe the data exchanged with the API.

Get list of accounts with sorting and searching and by type of group for the accounts Processes this account API request. The parameter and response sections describe the data exchanged with the API.

Get an overview of customer accounts Processes this account API request. The parameter and response sections describe the data exchanged with the API.

Get an overview of customer nrl accounts Processes this account API request. The parameter and response sections describe the data exchanged with the API.

Get an overview of customer nrl accounts Processes this account API request. The parameter and response sections describe the data exchanged with the API.

Get an overview of account amounts and totals Processes this account API request. The parameter and response sections describe the data exchanged with the API.

Get Receipts for account Processes this account API request. The parameter and response sections describe the data exchanged with the API.

Get Deposits processed for an Account Processes this account API request. The parameter and response sections describe the data exchanged with the API.

Get summary of an account based on invoice amounts allocated Processes this account API request. The parameter and response sections describe the data exchanged with the API.

Get payment overview for an account Processes this account API request. The parameter and response sections describe the data exchanged with the API.

Get payment overview for a property account Processes this account API request. The parameter and response sections describe the data exchanged with the API.

Get System Account for the Accounting System Processes this account API request. The parameter and response sections describe the data exchanged with the API.

Get property accounts with transactions which aren't part of a payment Processes this account API request. The parameter and response sections describe the data exchanged with the API.

Get a list of basic property account information and balances for accounts associated with a group Processes this account API request. The parameter and response sections describe the data exchanged with the API.

Get a list of tenancies for a group Processes this account API request. The parameter and response sections describe the data exchanged with the API.

This returns security permissions that a group has on other groups Processes this team group security API request. The parameter and response sections describe the data exchanged with the API.

This returns security permissions that other groups have on specified group Processes this team group security API request. The parameter and response sections describe the data exchanged with the API.

Save a new security permission for a group Processes this team group security API request. The parameter and response sections describe the data exchanged with the API.

Get a property by its Id Processes this property API request. The parameter and response sections describe the data exchanged with the API.

Checks if the owning group for a property is archived Processes this property API request. The parameter and response sections describe the data exchanged with the API.

A command driven endpoint to Book a Valuation. Processes this property API request. The parameter and response sections describe the data exchanged with the API.

A command driven endpoint to Record a Valuation. Processes this property API request. The parameter and response sections describe the data exchanged with the API.

A command driven endpoint to Update a property address. Processes this property API request. The parameter and response sections describe the data exchanged with the API.

A command driven endpoint to Update a Valuation. Processes this property API request. The parameter and response sections describe the data exchanged with the API.

Get property events for the current owner by its Id Processes this property API request. The parameter and response sections describe the data exchanged with the API.

Get property events by its Id Processes this property API request. The parameter and response sections describe the data exchanged with the API.

Get property timeline by its Id Processes this property API request. The parameter and response sections describe the data exchanged with the API.

Get property note editions chains by their Ids Processes this property API request. The parameter and response sections describe the data exchanged with the API.

Get the descriptions for a property by property id Processes this property API request. The parameter and response sections describe the data exchanged with the API.

Get the roles for a property by property id Processes this property API request. The parameter and response sections describe the data exchanged with the API.

Get the documents of a property by the property Id Processes this property API request. The parameter and response sections describe the data exchanged with the API.

Search for properties/addresses that match the specified search criteria Query = Search query to execute PageSize = Number of results to show on each page PageNumber = Which page to return SuggestType = All, AgencyOnly, ViewableOnly

For a given property, will return all comparable property's nearby. Processes this property API request. The parameter and response sections describe the data exchanged with the API.

Attaches an existing document to a property Processes this property API request. The parameter and response sections describe the data exchanged with the API.

Detaches a document from a property Processes this property API request. The parameter and response sections describe the data exchanged with the API.

Detaches multiple documents from a property Processes this property API request. The parameter and response sections describe the data exchanged with the API.

Allows you to upload a document and attach it directly to a property. Processes this property API request. The parameter and response sections describe the data exchanged with the API.

Attaches an externally hosted document to a property Processes this property API request. The parameter and response sections describe the data exchanged with the API.

Get all of the valuations associated to the current owner of the property. Processes this property API request. The parameter and response sections describe the data exchanged with the API.

Get all of the valued for current owner of the property. Set currentOwnersOnly to false if you want all valued events on the property regardless of owner Processes this property API request. The parameter and response sections describe the data exchanged with the API.

Returns GeoAggregations of all properties Processes this property API request. The parameter and response sections describe the data exchanged with the API.

For a given property, will return owning PeopleGroup Processes this property API request. The parameter and response sections describe the data exchanged with the API.

Get a list of keys for a property Processes this property API request. The parameter and response sections describe the data exchanged with the API.

Get a property for a key code Processes this property API request. The parameter and response sections describe the data exchanged with the API.

Get a list of alarms for a property Processes this property API request. The parameter and response sections describe the data exchanged with the API.

Get a list of special arrangements for a property Processes this property API request. The parameter and response sections describe the data exchanged with the API.

Add keys for a property Processes this property API request. The parameter and response sections describe the data exchanged with the API.

Add alarm codes for a property Processes this property API request. The parameter and response sections describe the data exchanged with the API.

Add special arrangements for a property Processes this property API request. The parameter and response sections describe the data exchanged with the API.

Remove keys from a property Processes this property API request. The parameter and response sections describe the data exchanged with the API.

Remove alarm codes from a property Processes this property API request. The parameter and response sections describe the data exchanged with the API.

Remove special arrangements from a property Processes this property API request. The parameter and response sections describe the data exchanged with the API.

Checkout a collection of keys for a property Processes this property API request. The parameter and response sections describe the data exchanged with the API.

Checkin a collection of keys for a property Processes this property API request. The parameter and response sections describe the data exchanged with the API.

Creates/Adds a group to the CurrentOwners of the supplied PropertyId Processes this property API request. The parameter and response sections describe the data exchanged with the API.

Add Property. Processes this property API request. The parameter and response sections describe the data exchanged with the API.

Get a list of certificates for a property Processes this property API request. The parameter and response sections describe the data exchanged with the API.

Add certificate for a property Processes this property API request. The parameter and response sections describe the data exchanged with the API.

Update certificate for a property Processes this property API request. The parameter and response sections describe the data exchanged with the API.

Remove certificate from a property Processes this property API request. The parameter and response sections describe the data exchanged with the API.

Allows you to upload a document and attach it directly to a certificate. Processes this property API request. The parameter and response sections describe the data exchanged with the API.

Detaches a document from a certificate Processes this property API request. The parameter and response sections describe the data exchanged with the API.

Get a list of all current and ended tenant roles from a property id. Processes this property API request. The parameter and response sections describe the data exchanged with the API.

Get a URL for a property for a brand. Processes this property API request. The parameter and response sections describe the data exchanged with the API.

Gets a list of AdditionalServices added to the property or any of it's tenancies Processes this property API request. The parameter and response sections describe the data exchanged with the API.

Create/Update additional service on a property. Defaults to Landlord liability Processes this property API request. The parameter and response sections describe the data exchanged with the API.

Removes the additional service from the property Processes this property API request. The parameter and response sections describe the data exchanged with the API.

Gets EPC from the supplied propertyId Processes this property API request. The parameter and response sections describe the data exchanged with the API.

Creates/Overrides the EPC for the supplied propertyId Processes this property API request. The parameter and response sections describe the data exchanged with the API.

Clears EPC numbers and Expiry Date and marks all EPC documents as private for the supplied propertyId Processes this property API request. The parameter and response sections describe the data exchanged with the API.

Gets all appointments related with a property Processes this property API request. The parameter and response sections describe the data exchanged with the API.

Gets the image order for the property Processes this property API request. The parameter and response sections describe the data exchanged with the API.

Sets the image order for the property Processes this property API request. The parameter and response sections describe the data exchanged with the API.

Sets the default image of a property Processes this property API request. The parameter and response sections describe the data exchanged with the API.

Clone role descriptions to property Processes this property API request. The parameter and response sections describe the data exchanged with the API.

Get visited value or the property Processes this property API request. The parameter and response sections describe the data exchanged with the API.

Toggle visited field for property Processes this property API request. The parameter and response sections describe the data exchanged with the API.

Set retention amount field for property Processes this property API request. The parameter and response sections describe the data exchanged with the API.

Set pre approved spend amount field for property Processes this property API request. The parameter and response sections describe the data exchanged with the API.

Detaches a description from a property Processes this property API request. The parameter and response sections describe the data exchanged with the API.

Clones a property Processes this property API request. The parameter and response sections describe the data exchanged with the API.

Get details for batch payment export Processes this accounting export API request. The parameter and response sections describe the data exchanged with the API.

Remove an individual payment from batch export Processes this accounting export API request. The parameter and response sections describe the data exchanged with the API.

Delete batch payment export Processes this accounting export API request. The parameter and response sections describe the data exchanged with the API.

Get list of batch exports Processes this accounting export API request. The parameter and response sections describe the data exchanged with the API.

Record the processed status of a batch payment Processes this accounting export API request. The parameter and response sections describe the data exchanged with the API.

Get batch export csv in a given template Processes this accounting export API request. The parameter and response sections describe the data exchanged with the API.

Get an appointment by its id. Processes this appointment API request. The parameter and response sections describe the data exchanged with the API.

Get details of a calculated appointment using it's id and date. Processes this appointment API request. The parameter and response sections describe the data exchanged with the API.

Obsolete. Use cancel instead. Processes this appointment API request. The parameter and response sections describe the data exchanged with the API.

Cancel an appointment by id if it exists. Processes this appointment API request. The parameter and response sections describe the data exchanged with the API.

Cancel calculated appointment by id and datetime, if it exists. Processes this appointment API request. The parameter and response sections describe the data exchanged with the API.

Set the status of the appointment to NoShow Processes this appointment API request. The parameter and response sections describe the data exchanged with the API.

Appointment Confirmation. Processes this appointment API request. The parameter and response sections describe the data exchanged with the API.

Save or update an appointment. Processes this appointment API request. The parameter and response sections describe the data exchanged with the API.

Returns Free/Busy information regarding multiple people. Processes this appointment API request. The parameter and response sections describe the data exchanged with the API.

Auto-picks attendees and the next available appointment slot given the parameters in the request. Processes this appointment API request. The parameter and response sections describe the data exchanged with the API.

Appointments Overview. Processes this appointment API request. The parameter and response sections describe the data exchanged with the API.

Allows you to upload a document and attach it to an appointment. Processes this appointment API request. The parameter and response sections describe the data exchanged with the API.

Detaches a document from a role Processes this appointment API request. The parameter and response sections describe the data exchanged with the API.

Returns the data contract to configure the word plugin for creating templates Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Generates any correspondence and can allow you to overpost information to the correspondence Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Generates a pack using the first selected group/property of a type to get a quick preview of the pack Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Generates an board ordering New correspondence Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Generates an board ordering Replace correspondence Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Generates an board ordering Takedown correspondence Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Generates an board ordering Update correspondence Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Generates a correspondence confirming the booking of a valuation appointment. Uses default values where possible. Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Generates a correspondence confirming the result of a valuation appointment. Uses default values where possible. Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Generates a Instruction letter correspondence to the vendor of a particular marketing role Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Generates Tenancy Agreement correspondence Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Generates Maintenance Job correspondence Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Generates Payment Statement correspondence Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Generates Payment Reminder correspondence Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Generates Bulk Payment Reminder correspondence Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Generates Account Statement correspondence Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Generates Bulk Account Statement correspondence Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Generates Invoice correspondence Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Generates Tenancy Guarantor correspondence Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Generates a Withdrawn Instruction letter correspondence to the vendor of a particular marketing role Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Generates a Reschedule Valuation letter correspondence Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Generates a Valuation Lost letter correspondence to the vendor of a particular marketing role Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Generates a EPC Appointment letter correspondence Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Generates a meeting letter correspondence Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Generates a cancel a valuation letter correspondence Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Generates a cancel an epc appointment letter correspondence Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Generates a confirm an epc appointment letter correspondence Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Generates a cancel a meeting letter correspondence Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Generates a confirm a meeting letter correspondence Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Generates a confirm general appointment letter correspondence Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Generates a cancel general appointment letter correspondence Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Generates a reschedule general appointment letter correspondence Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Generates a correspondence notifying the vendor of an offer. Uses default values where possible. Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Generates a correspondence any parties of the acceptance of an offer. Uses default values where possible. Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Generates a correspondence any parties of the rejection of an offer. Uses default values where possible. Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Generates a correspondence to notify any parties of the withdrawl of an offer. Uses default values where possible. Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Generates a correspondence to notify any parties of completion. Uses default values where possible. Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Generates a correspondence to notify any parties of exchanged. Uses default values where possible. Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Generates an open house correspondence Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Generates a correspondence to notify all parties of a scheduled viewing. Uses default values where possible. Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Generates a correspondence to notify parties of a cancellation of a viewing. Uses default values where possible. Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Generates a correspondence to notify parties involved of a rescheduling of a viewing. Uses default values where possible. Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Generates a correspondence to notify all parties of a scheduled inspection. Uses default values where possible. Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Generates a correspondence to notify parties of a cancellation of a inspection. Uses default values where possible. Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Generates a correspondence to notify parties involved of a rescheduling of a inspection. Uses default values where possible. Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Generates a correspondence to multiple applicants, sending them all the same property role Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Generates a correspondence to addresses based on the properties postcode, merging details of the supplied property role Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Generates a correspondence to multiple applicants, sending them all the same letting property role Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Generates a printable property list, it is targetless so there is no reference to applicants or owners Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Generates a correspondence to a single applicant, sending them user selected property roles Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Generates a correspondence to a single letting applicant, sending them user selected property roles Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Generates a correspondence to multiple applicants, sending them a filtered set of the matching property roles Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Generates a correspondence to multiple letting applicants, sending them a filtered set of the matching letting property roles Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Generates a correspondence to multiple letting applicants, sending them a filtered set of the matching letting property roles Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Generates a correspondence to a single group, sending them a single report for multiple properties Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Generates a correspondence to a an sales applicant Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Generates a correspondence to a an lettings applicant Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Generates a correspondence to a an lettings applicant Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Sends viewing feedback to Owner / Landlord Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Generates a bulk communication pack out to multiple clients in a list. Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Generates a bulk communication pack out to multiple clients with interest roles. Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Generates a bulk communication pack out to multiple vendors of properties. This will ignore the target type set, as the document could only ever find the vendor as the contact item, so it always defaults to a target type of vendor/owner Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Create a pack that will forward onto the print fulfilment service a static template to addresses created from a homesearch search using the filterid supplied, excluding certain addresses. Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Uploads a new letter template Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Uploads a new header template Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Updates a merge letter template Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Rename a letter template and change the description Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Update the properties of a template, but not its content. Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Updates a header letter template Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Saves or updates the envelope template for an agency Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Saves or updates the envelope template for an agency Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Saves or updates the envelope template for an agency Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Saves or updates envelope template correspondence for a an agency Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Returns a list of lettertemplates associated to this agency Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Returns a list of lettertemplates associated to this agency Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Returns a list of lettertemplates associated to this agency that are not currently used in any envelope templates Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Returns a list of lettertemplates associated to this agency and to a particular google analyitics campaign Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Returns the detail of the sack of correspondence that has just been prepared Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Returns the detail of the all outstanding sacks Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

deletes an envelope from the the content of a sack Deprecated in favour of the DELETE verb Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

deletes an envelope from the the content of a sack Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

deletes an document from an envelope Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

deletes an envelope from the the content of a sack Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Prints an envelope from a sack Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

processes the content of the sack Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

updates the content of a sack Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

updates the content of a sack Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

updates the content of a sack Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Returns a list of insertable templates associated to this agency Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Returns a list of insertable templates associated to this agency Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Returns a list of header templates associated to this agency with their associated brand info Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Returns a list of envelope templates associated to this agency Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Returns a envelope template Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Returns a envelope template pack Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Returns a list of envelope template packs associated to this agency Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Returns a list of envelope template packs associated to this agency Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Gets a list of the packs for a particular packtype Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Gets a list of the packs for a particular packtype Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Gets a list of the packs for a particular packtype Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Returns a list of email templates associated to this agency Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Returns a list of mergable templates for any type associated to this agency Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Returns a list of sms templates associated to this agency Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Get an enum by its type and system name Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Get a list of the packs required types (ie all of the types required by each document in each envelope) Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Get a list of the supported sending methods for a correspondence (ie all of the types required by each document in each envelope) Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Show or hide a envelope template pack in rezi post Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Deletes a Envelope Template Correspondence Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Deletes a Envelope Template Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Deletes a Letter Template Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Creates a new pdf document. Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Creates a new epc document. Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Creates a new Property Market Report document. Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Print all printback contents. Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Outstanding Print Bag Count. Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Get all printable envelopes and their content. Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Print specific back contents. Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.