RoomDescription

Rezi Room Description Api

APIDescription
POST api/roomdescription/Save

PUT api/roomdescription/{id}/attachexternaldocumenttoroom?roomId={roomId}

Attaches an externally hosted document to a room within a room description.

PUT api/roomdescription/{id}/uploadandattachdocumenttoroom?roomId={roomId}

Uploads and attaches a document to room description room - the new document is appended to the current list.

PUT api/roomdescription/{id}/attachdocumentoroom?documentId={documentId}&roomId={roomId}&insertAtIndex={insertAtIndex}

Attaches the document to room.

PUT api/roomdescription/{id}/detachdocumentfromroom?documentId={documentId}&roomId={roomId}

Detaches a document from a room description room.

DELETE api/roomdescription/Delete?id={id}

POST api/roomdescription/setimages

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.

PUT api/roomdescription/{id}/attachtorole?roleId={roleId}

Attach a RoomDescription to a PropertyMarketingRole

GET api/RoomDescription/{id}

RoomCountDescription

Rezi RoomCount Description Api

APIDescription
POST api/roomcountdescription/Save

DELETE api/roomcountdescription/Delete?id={id}

GET api/RoomCountDescription/{id}

Stats

Rezi Stats for Property Api.

APIDescription
POST api/stats/RecordVisit/{pageType}/{entityId}?roleId={roleId}

Record and timestamp a visit to a 'page' on Rezi.

GET api/stats/visited/{entityType}

Get all recent history of 'pages' visited on Rezi for a given entity type.

GET api/stats/rightmove/{roleId}

AccountingExport

Rezi Accounting Api - Exports

APIDescription
POST api/accounting/exports/batchexport

Get details for batch payment export

PUT api/accounting/exports/batch/{id}/removepayment?paymentId={paymentId}

Remove an individual payment from batch export

PUT api/accounting/exports/batch/{id}/delete

Delete batch payment export

GET api/accounting/exports/list/batches?bankAccountId={bankAccountId}&includeProcessed={includeProcessed}

Get list of batch exports

POST api/accounting/exports/batchpaymentcsv

Get details formatted for batch payment csv

POST api/accounting/exports/ledgerentriescsv

Get ledger items formatted for export csv

POST api/AccountingExport/{id}?processed={processed}

Record the processed status of a batch payment

DefaultToDo

Rezi Default ToDo Api.

APIDescription
GET api/todo/{id}

Get a ToDo by Id

GET api/todo/getall?pageSize={pageSize}&pageNumber={pageNumber}

Get the list of all ToDo's if no parameter is sent; if provided will filter by ToDo type

GET api/todo/getclaimedtask?taskId={taskId}

Get Claimed Task by id

GET api/todo/activetasks?toDoId={toDoId}&ignoreDueDate={ignoreDueDate}&pageSize={pageSize}&pageNumber={pageNumber}

Get the list of active tasks of a Todo

GET api/todo/completedtasks?toDoId={toDoId}

Get the list of completed tasks of a Todo

GET api/todo/teamtodos?branchId={branchId}

Get the list of completed tasks of a Todo

PUT api/todo/updatetaskrecurrence

Update the date of recurrence of a task

PUT api/todo/completetask

If Due Date is not populated a complete flag is set or if Due Date is populated a recurrence is set

PUT api/todo/claimtask

Sets the claiming negotiator for the task

PUT api/todo/reassigntodo

Reassign a todo to different negotiator(s)

PUT api/todo/canceltodo

Cancel a to-do list from the tile overview of to-dos

PUT api/todo/canceltasks

Cancel a single or multiple tasks from a to-do bucket

PUT api/todo/reassigntodotasks

Reassign a list of tasks to different negotiator(s)

PUT api/todo/releasetask?taskId={taskId}

Release task

PUT api/todo/snoozetask

Snooze task

POST api/todo/addtasknote

Add note for a task

GET api/todo/gettasknotes/{id}

Get notes for a task

POST api/todo/addtodonote?toDoId={toDoId}

Add note for a ToDo

GET api/todo/gettodonotes?todoId={todoId}

Returns all notes for todo

GET api/todo/getleads?branchId={branchId}&excludeTasks={excludeTasks}

Get the list of all InboundLead ToDo's

PUT api/todo/canceltask

Cancel the Task. Used for cancelling the Lead Requests.

PUT api/todo/cancelleadandtask

Cancel the Task. Used for cancelling the Lead Requests.

PUT api/todo/assignleadstoowningnegotiators?toDoId={toDoId}

Assign InboundLead Todos to the owning Negotiators of the property.

PUT api/todo/assigntasktonegotiator?taskId={taskId}&negotiatorId={negotiatorId}

Assign a task to a negotiator by its Id.

PUT api/todo/assignleadstopredefinedteams?toDoId={toDoId}

Assign InboundLead Todos to the predefined neg teams. e.g. Sales Valuers, Sales Viewings, Lettings Viewings etc etc

PUT api/todo/assignleadsforspecifiednegs

Assign InboundLead Todos to all the specified Negs using round-robin assignement.

GET api/todo/gettodosbyid?ids[0]={ids[0]}&ids[1]={ids[1]}

Return list of tasks, corresponding to task ids passed in.

Receipt

APIDescription
POST api/receipt/addfunds

Add funds to an account/group by id or suspense account

POST api/receipt/agentdeposit

Add agent funds into the system

POST api/receipt/interestearned

Add interest earned to suspense account

PUT api/receipt/clearfunds

Make uncleared funds as cleared.

PUT api/receipt/unclearfunds

Make cleared funds as uncleared.

POST api/receipt/withdrawfunds

Withdraw funds for the agent

POST api/receipt/recordpayment

Makes payment to supplied account.

POST api/receipt/paymentitem

Saves a payment item to be processed

GET api/receipt/paymentitem

Get saved payment items

GET api/receipt/paymentitem/{bankaccountid}

Get saved payment item for specific bank account

DELETE api/receipt/paymentitem?id={id}

Delete a payment item

PUT api/receipt/paymentitem?negotiatorId={negotiatorId}

Process payment items

POST api/receipt/payment/{id}/setexportstatus

Change status export status of payment

POST api/receipt/fundsshortfall

Records funds from office account into client account and then to client if necessary.

AccountingSystem

Rezi Agency Api.

APIDescription
GET api/accountingsystem

Gets accounting system for a legal entity

GET api/accountingsystem/systembalance

Gets accounting system balance

PUT api/accountingsystem/systembalance?force={force}

Archives the accounting system

GET api/accountingsystem/taxstatus

Get Tax Status of Accounting System

GET api/accountingsystem/suspense

Get amount of funds held in suspense account of the accounting system

GET api/accountingsystem/agentcash

Gets overview of the agent cash account

GET api/accountingsystem/enum/{enumType}

POST api/accountingsystem/createofficeaccount

Create an office account for the accounting system

GET api/accountingsystem/officeaccounts

Get list of office accounts associated with the accounting system

POST api/accountingsystem/setprimaryaccount?id={id}

Set Primary Bank Account for Accounting System

PropertyToDo

Rezi Property ToDo Api.

APIDescription
POST api/todo/property/savetodo

Save or Updates a Property ToDo and and its tasks

PUT api/todo/property/addtasks

Add tasks to a Property ToDo

GET api/todo/property/taskprofile?taskId={taskId}

Get the profile infos for a propery task

Fee

APIDescription
POST api/fee/save

Save a new fee into the system

GET api/fee/getall?pageSize={pageSize}&pageNumber={pageNumber}

Get list of all fees stored

Event

Rezi Event Api.

APIDescription
GET api/event/{id}

Get an event by its Id

POST api/event/{id}/addnotetoevent

Put - to update a note on an event.

PUT api/event/{id}/seteventnote?note={note}

Put - to update an event note.

POST api/event/{id}/setstatus

Update Status on an event.

POST api/event/noteevent/add

Adds a note to the provided role

POST api/event/noteevent/unpin/{noteId}

Unpin a Note

POST api/event/recordpropertyownercontact

Records an event on the role representing a neg being in contact for a property they own

POST api/event/addchatmessage

Adds a message to the property

POST api/event/recordownercontact

Records an event on the role representing a neg being in contact for an owner

POST api/event/recordenquiry

Records an event on the role representing a neg being in contact with a person

POST api/event/{id}/setnegotiators

Changes the negotiators for an event

PUT api/event/{id}/setowningteam?teamId={teamId}

Changes the owning team of an event

GET api/event/{id}/roles

Get the roles for an event by its Id

Room

Rezi Room Api.

APIDescription
GET api/room/{id}

Get a room by its Id

FeatureProvisioning

APIDescription
POST api/featureprovisioning/enrollagency?featureSystemName={featureSystemName}

Enrolls an agency into a feature

OccupierAllowanceDescription

Rezi OccupierAllowance Description Api

APIDescription
POST api/occupierallowancedescription/Save

DELETE api/occupierallowancedescription/Delete?id={id}

GET api/OccupierAllowanceDescription/{id}

People

Rezi People Api.

APIDescription
GET api/people/{id}

Get a person by its Id

GET api/people/{id}/searching

Get Searching Roles for a Person

GET api/people/{id}/selling

Get Selling Roles for a Person

GET api/people/{id}/letting

Get Letting Roles for a Person

POST api/people/{id}/addcontactitem

Add a ContactItem to a Person

PUT api/people/{id}/removecontactitem/{contactItemid}

Remove a ContactItem from a Person

GET api/people/unsubscribe/{id}

Get All contact items for a person, but obscure the details

POST api/people/unsubscribe/{id}

Unsubscribe/Subscribe All contact items for a person

PUT api/people/{id}/updatedetails

Update a Persons Details

PUT api/people/{id}/addaddress

Add an Address to a Person

PUT api/people/{id}/removeaddress/{addressId}

Remove an Address from a Person

PUT api/people/updateperson

Update a Person's detailsCommand

PUT api/people/updatepeople

Update a Person's detailsCommand

POST api/people/{id}/savenote?note={note}

Add a Note to a Person

POST api/people/sendnotification

Sends a user notification to the specified user

POST api/people/searchcontacts

Search contacts based on the phone number provided

PUT api/people/setpaymentdetails

Set the payment details for a person

PUT api/people/setprimarypaymentdetails?id={id}&accountId={accountId}&tenantRoleId={tenantRoleId}

Set the primary payment details for a person

PUT api/people/removebankaccount?id={id}&accountId={accountId}

Deletes the persons bank account details

GET api/people/{id}/accounts

Get the bank details for a person

GET api/people/findbyemail?emailAddress={emailAddress}

Returns a list of people that have the supplied email address.

GET api/people/findbyidentity?issuer={issuer}&nameidentifier={nameidentifier}

Gets the person by an identity reference

GET api/people/{id}/roles?pageSize={pageSize}&pageNumber={pageNumber}

Get basic role infomation for a Person by PersonId

GET api/people/{id}/redactionstatus

Redaction Status for a Person by PersonId

POST api/people/{id}/redact?note={note}

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

POST api/people/{id}/updateservicetypes

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

GET api/people/{id}/documents?subTypes[0]={subTypes[0]}&subTypes[1]={subTypes[1]}&pageSize={pageSize}&pageNumber={pageNumber}&type={type}&orderDesc={orderDesc}

Get a list of documents belonging to a group

POST api/people/{id}/uploadandattachdocument

Allows you to upload a document and attach it directly to a person.

PUT api/people/{id}/detachdocument?documentId={documentId}

Detatch a document from a person.

StyleAgeDescription

Rezi StyleAge Description Api

APIDescription
POST api/styleagedescription/Save

DELETE api/styleagedescription/Delete?id={id}

GET api/StyleAgeDescription/{id}

Chat

Rezi Chat Api.

APIDescription
GET api/chat/unreadsummary

Get a count of unread chat messages for the negotiator plus a list of corresponding message id's which are unread.

POST api/chat/savemessage

Save a new chat message.

PUT api/chat/message/markasread/{messageId}

This will update the cache with a new timestamp for when this chat message was last read.

GET api/Chat?messageId={messageId}

Get a previous chat message to append to.

GET api/Chat?pageSize={pageSize}&pageNumber={pageNumber}&from={from}&to={to}&messageStatus={messageStatus}

Get all chat messages for the negotiatorId.

PUT api/Chat

Put - to update a chat message.

CustomFieldGroup

Rezi Custom Field Group Api

APIDescription
POST api/customfieldgroup/{save}

Save a custom field group for a predefined type.

GET api/customfieldgroup/{typeName}?groupName={groupName}

Get a list of custom field groups for a type and optional group name specified.

Credentials

Rezi Group Api.

APIDescription
POST api/credentials/upsertusernamepassword

Creates or Updates Security Credentials

GET api/credentials/emailsync/usernamepassword

Gets Email Sync Security Credentials

POST api/credentials/emailsync/usernamepassword

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

DELETE api/credentials/deleteusernamepassword/{name}

Delete Security Credentials

DELETE api/credentials/emailsync/usernamepassword

Delete Email Sync For a User

ReziPost

Rezi Post Template Api.

APIDescription
GET api/rezipost/wordtemplate/{documentId}

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.

GET api/rezipost/newwordtemplate/{envelopeId}

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.

TeamGroupSecurity

Rezi Tag Api.

APIDescription
GET api/teamsecurity/permissionsforgroup?teamId={teamId}

This returns security permissions that a group has on other groups

GET api/teamsecurity/permissionsongroup?teamId={teamId}

This returns security permissions that other groups have on specified group

POST api/teamsecurity/savepermission

Save a new security permission for a group

Transfer

APIDescription
POST api/transfer/interaccount

Transfer funds between bank accounts (also Deposit Cash/Cheques from Cash Held)

POST api/transfer/contra

Contra funds between ledgers

POST api/transfer/suspend

Move funds to suspense account to another ledger

POST api/transfer/unsuspend

Move funds from suspense account to another ledger

Reporting

Rezi Reporting Api.

APIDescription
POST api/reporting/realtime

POST api/reporting/chart

POST api/reporting/csv

Request Csv for either set of negotiators or set of branches, with specified set of ReportFacets.

POST api/reporting/negotiator

POST api/reporting/branch

POST api/reporting/branches/csv

GET api/reporting/v2/reporttypes

No documentation available.

GET api/reporting/v2/configure?reportClass={reportClass}

No documentation available.

GET api/reporting/v2/json?ReportClass={ReportClass}&From={From}&To={To}&BranchId={BranchId}&FilterId={FilterId}&UseAskingPrice={UseAskingPrice}&ExcludeDuplicatePropertyRoles={ExcludeDuplicatePropertyRoles}&UseEventPrices={UseEventPrices}&TimezoneOffset={TimezoneOffset}

No documentation available.

GET api/reporting/v2/csv?ReportClass={ReportClass}&From={From}&To={To}&BranchId={BranchId}&FilterId={FilterId}&UseAskingPrice={UseAskingPrice}&ExcludeDuplicatePropertyRoles={ExcludeDuplicatePropertyRoles}&UseEventPrices={UseEventPrices}&TimezoneOffset={TimezoneOffset}

No documentation available.

GET api/reporting/v2/state?reportId={reportId}&stateId={stateId}

No documentation available.

POST api/reporting/v2/state

No documentation available.

GroupToDo

Rezi Group ToDo Api.

APIDescription
POST api/todo/group/savetodo

Saves or Updates a Group ToDo and its tasks

POST api/todo/group/savenextcalldate

No documentation available.

PUT api/todo/group/addtasks

Add task to a Group ToDo

GET api/todo/group/taskprofile?taskId={taskId}

Get the profile infos for a task

GET api/todo/group/getupcomingtask?groupId={groupId}

Get the todo and latest task for a group

CostDescription

Rezi Cost Description Api

APIDescription
POST api/costdescription/Save

DELETE api/costdescription/Delete?id={id}

GET api/CostDescription/{id}

SalesProgression

Rezi Progression Api.

APIDescription
POST api/progression/sales/instructtosell

Instructs a role to be sold

POST api/progression/sales/exchange

Exchanges a sales role

POST api/progression/sales/complete

Completes a sales role

PUT api/progression/sales/setestimatedcompletiondate

Set the estimated completion date on a purchasing role

PUT api/progression/sales/setestimatedexchangedate

Set the estimated exchange date on a purchasing role

POST api/progression/sales/fallenthrough

Set Marketing Role as Fallen Through

LettingsProgression

Rezi Lettings Progression Api.

APIDescription
POST api/progression/lettings/instructtolet

Instructs a role to be let

POST api/progression/lettings/fallenthrough

Set Marketing Role as Fallen Through

POST api/progression/lettings/let

Set letting to Let (Occupied)

POST api/progression/lettings/remarket

Remarket a Letting. Completes the PropertyLettingRole and the TenantRole and creates a new PropertyLettingRole

POST api/progression/lettings/withdrawInstruction

Withdraw a letting at the end of let

POST api/progression/lettings/completeletting

Withdraw a letting at the end of let

POST api/progression/lettings/setheadtenant?id={id}&tenantPersonId={tenantPersonId}&groupId={groupId}

Set the head tenant of a tenant role

PUT api/progression/lettings/signunsigndeed?guarantorId={guarantorId}&signed={signed}

Set the head tenant of a tenant role

POST api/progression/lettings/{id}/setdeposit

Sets the deposit on a letting role

POST api/progression/lettings/{id}/setfurnishinglevel

Sets the deposit on a letting role

POST api/progression/lettings/referencetenant?id={id}&tenantPersonId={tenantPersonId}&referenceStatus={referenceStatus}&referenceType={referenceType}&name={name}&notes={notes}&referenceDate={referenceDate}

Reference a tenant on a tenant role

POST api/progression/lettings/referenceguarantor?id={id}&guarantorPersonId={guarantorPersonId}&referenceStatus={referenceStatus}&name={name}&notes={notes}&referenceDate={referenceDate}

Reference a guarantor on a tenant role

POST api/progression/lettings/assignguarantortotenant?id={id}

Assign guarantor to a tenant and vice versa

PUT api/progression/lettings/setestimatedmoveindate

Change the estimated move in date for the tenancy.

PUT api/progression/lettings/addtenant?tenantRoleId={tenantRoleId}

Add Tenant to the tenant group and create relevant tenant info for them.

PUT api/progression/lettings/addlandlord?roleId={roleId}

Add Tenant to the tenant group and create relevant tenant info for them.

PUT api/progression/lettings/addguarantor?tenantRoleId={tenantRoleId}&groupId={groupId}

Add Guarantor to the letting group.

POST api/progression/lettings/uploadandattachtenantdocument?tenantInfoId={tenantInfoId}

Allows you to upload a document and attach it directly to a tenant.

POST api/progression/lettings/uploadandattachlandlorddocument?landlordInfoId={landlordInfoId}

Allows you to upload a document and attach it directly to a tenant.

POST api/progression/lettings/uploadandattachguarantorgroupdocument?guarantorGroupId={guarantorGroupId}&tenancyId={tenancyId}

Allows you to upload a lettings document and attach it directly to a guarantor group.

POST api/progression/lettings/detatchdocumentfromlandlord?landlordInfoId={landlordInfoId}&documentId={documentId}

Detatch a document from a landlord.

POST api/progression/lettings/detatchdocumentfromtenant?tenantInfoId={tenantInfoId}&documentId={documentId}

Detatch a document from a landlord.

POST api/progression/lettings/detatchdocumentfromguarantor?guarantorId={guarantorId}&documentId={documentId}&personId={personId}

Detatch a document from a landlord.

POST api/progression/lettings/detatchdocumentfromreference?referenceId={referenceId}&documentId={documentId}

Detatch a document from a reference.

PUT api/progression/lettings/removeguarantor?tenantRoleId={tenantRoleId}&guarantorGroupId={guarantorGroupId}

Add Guarantor to the letting group.

PUT api/progression/lettings/removeguarantors?tenantRoleId={tenantRoleId}

Add Guarantor to the letting group.

POST api/progression/lettings/uploadandattachguarantordocument?guarantorId={guarantorId}

Allows you to upload a document and attach it directly to a guarantor.

POST api/progression/lettings/uploadandattachguarantorreferencedocument?guarantorId={guarantorId}&referenceId={referenceId}

Allows you to upload a document and attach it directly to a guarantor.

POST api/progression/lettings/uploadandattachrighttorentdocument?tenantInfoId={tenantInfoId}

Allows you to upload a document and attach it directly to a r ight to rent.

PUT api/progression/lettings/{tenantInfoId}/detachrighttorentdocument/{documentId}

Detach

POST api/progression/lettings/uploadandattachtenantreferencedocument?tenantInfoId={tenantInfoId}&referenceId={referenceId}&tenantRoleId={tenantRoleId}

Allows you to upload a document and attach it directly to a guarantor.

POST api/progression/lettings/{roleId}/inventory/uploaddocument

Uploads an inventory document for a tenant role

POST api/progression/lettings/{roleId}/inventory/setrequired?required={required}

Sets whether inventory is needed on tenant role

POST api/progression/lettings/{roleId}/inventory/setagreed?agreed={agreed}

Sets whether inventory is agreed with tenants

POST api/progression/lettings/{roleId}/inventory/savenote?note={note}

Add a note to a tenant role inventory

POST api/progression/lettings/{roleId}/addtenantdeposit

No documentation available.

POST api/progression/lettings/{roleId}/addtenantfee

No documentation available.

POST api/progression/lettings/{roleId}/addtenantcharge

No documentation available.

GET api/progression/lettings/{roleId}/tenantcharges

Get all charges for tenant.

DELETE api/progression/lettings/{roleId}/removetenantcharge?chargeIds[0]={chargeIds[0]}&chargeIds[1]={chargeIds[1]}

Remove charges from a tenant role

POST api/progression/lettings/{roleId}/addpayment

Add Tenant Payment

POST api/progression/lettings/{tenantRoleId}/makepayment

No documentation available.

POST api/progression/lettings/{roleId}/unpaytenantcharge?paymentIds[0]={paymentIds[0]}&paymentIds[1]={paymentIds[1]}

No documentation available.

GET api/progression/lettings/{id}/tenantstatement

PUT api/progression/lettings/{id}/removepayment/{paymentId}

POST api/progression/lettings/{id}/addpet

PUT api/progression/lettings/editpet

PUT api/progression/lettings/{id}/removepet/{petId}

POST api/progression/lettings/{id}/addpermittedoccupier

POST api/progression/lettings/{id}/updatepermittedoccupier

PUT api/progression/lettings/{id}/removepermittedoccupier/{permittedOccupierId}

PUT api/progression/lettings/{id}/markidreceived

PUT api/progression/lettings/{id}/registrationscheme

POST api/progression/lettings/{id}/markrighttorentreceived?tenantPersonId={tenantPersonId}&received={received}&rightToRentType={rightToRentType}

PUT api/progression/lettings/{id}/settenanthousingbenefits

PUT api/progression/lettings/{id}/settenantbill

DELETE api/progression/lettings/{id}/removetenantbill?tenantBillId={tenantBillId}

GET api/progression/lettings/{tenantRoleId}/getguarantors

POST api/progression/lettings/{id}/setguaranteedrent?amount={amount}

Set the guaranteed rent a landlord will receive for a roles tenancies

POST api/progression/lettings/{id}/setdefaultmilestones

Set tenant role milestones as the defaults for agency

POST api/progression/lettings/{id}/resetmilestones

Reset tenant role milestones back to agency defaults

POST api/progression/lettings/resetdefaultmilestones

Reset agency default milestones back to global defaults

POST api/progression/lettings/{id}/createtenantrole?groupId={groupId}

Create a tenant role for a group and a letting role.

Progression

Rezi Progression Api.

APIDescription
POST api/progression/addprogressionnote

Add a note to a purchasing role

PUT api/progression/withdrawinstruction

Add withdrawalvaluation to a property sales role

PUT api/progression/withdrawvaluation

Add WithdrawVal to a property sales role

POST api/progression/savecontact

Add a new contact to the given progression Role or edit an existing contact

POST api/progression/removecontact

Remove an existing progression contact from the progression role

GET api/progression/getallcontacts?progressionRoleId={progressionRoleId}&pageSize={pageSize}&pageNumber={pageNumber}&progressionRoleType={progressionRoleType}

Get all progression contacts for the given progression role

GET api/progression/getallmilestones?progressionRoleId={progressionRoleId}&pageSize={pageSize}&pageNumber={pageNumber}&milestoneLeaseType={milestoneLeaseType}&progressionRoleType={progressionRoleType}&milestoneStatus={milestoneStatus}&milestoneCategoryType={milestoneCategoryType}

Get all progression milestones for the given progression role

GET api/progression/milestonessummary?progressionRoleId={progressionRoleId}&milestoneLeaseType={milestoneLeaseType}&milestoneCategoryType={milestoneCategoryType}

Get a progression milestone summary for the given progression role

GET api/progression/milestone/{id}

POST api/progression/milestone/save

DELETE api/progression/{id}/deletemilestone/{milestoneId}

Delete milestone on Progression role

POST api/progression/milestone/addnote

Add a note to an individual progression milestone

POST api/progression/milestone/{roleId}/add

Add a milestone to a role.

PUT api/progression/milestones/reset?purchasingRoleId={purchasingRoleId}&roleId={roleId}

Add a note to an individual progression milestone

PUT api/progression/milestones/order?purchasingRoleId={purchasingRoleId}

Set milestone orders

PUT api/progression/milestones/add?purchasingRoleId={purchasingRoleId}

Save a new milestone

PUT api/progression/milestones/remove?purchasingRoleId={purchasingRoleId}&milestoneId={milestoneId}

Remove a new milestone

POST api/progression/bulkwithdrawvaluations

Bulk withdrawal valuations from a property role

Region

Rezi Region Controller

APIDescription
GET api/region/{id}?source={source}

Gets a region by it's Id

POST api/region/save

Save region

POST api/region/alias/save

Save or update a region alias

GET api/region/{id}/nearby

Gets the nearby regions for a region

POST api/region/suggest

GET api/region/favourites

Returns favorite regions

GET api/region/favourites/{favouriteRegionId}

Returns favorite regions

POST api/region/favourites/add

Add a region to your list of favourites

DELETE api/region/favourites/{favouriteRegionId}

Remove a region from your favourites

System

Manages system wide configuration options and include system wide commands

APIDescription
POST api/admin/system/updateDocumentGenerationMetadataFile

Updates the metadata for document generation merge fields

POST api/admin/system/sendliveportalupdatemessage?propertyMarketingRoleId={propertyMarketingRoleId}

Sends a message to the LivePortalJobHandler that says the specified property marketing role has changed

POST api/admin/system/sendNotificationToAllUsersInAgency?agencyId={agencyId}

Send a live notification to all active users in an agency

POST api/admin/system/CreateNewSystemFeature

Creates a new system wide feature available for activation.

GET api/admin/system/ListAgencies?includeSuspended={includeSuspended}

Lists the name and ID of all agencies in the system.

Legacy

Rezi Legacy Api

APIDescription
GET api/legacy/{typeName}/{id}

HistoricalPrice

Rezi Property Historical Price Api.

APIDescription
GET api/property/{id}/historicalprices?pageNumber={pageNumber}&pageSize={pageSize}

Get historical prices for a property by its Id

GET api/property/historicalprices/postcode/{postcode}?propertyType={propertyType}&styleType={styleType}&leaseType={leaseType}&pageNumber={pageNumber}&pageSize={pageSize}

Get historical prices for a property by its Id

GET api/property/historicalprices/radius?propertyId={propertyId}&latitude={latitude}&longitude={longitude}&mileRadius={mileRadius}&propertyType={propertyType}&styleType={styleType}&leaseType={leaseType}&pageNumber={pageNumber}&pageSize={pageSize}

Get historical prices within a radius of a location

Role

Rezi Role Api.

APIDescription
GET api/role/{id}

Get a role by its Id

POST api/role/pausesearchingroles

Pauses searching roles in bulk (by GroupFilter)

POST api/role/unpausesearchingroles

UnPauses searching roles in bulk (by Id)

GET api/role/{id}/events?pageSize={pageSize}&pageNumber={pageNumber}&branchId={branchId}&from={from}&to={to}&type[0]={type[0]}&type[1]={type[1]}&eventCategoryType={eventCategoryType}&excludedTypes[0]={excludedTypes[0]}&excludedTypes[1]={excludedTypes[1]}&includeDrafts={includeDrafts}&excludeRevised={excludeRevised}

Get role events by its Id

GET api/role/{id}/salesprogressionactivityevents?pageSize={pageSize}&pageNumber={pageNumber}&branchId={branchId}&from={from}&to={to}&type[0]={type[0]}&type[1]={type[1]}&eventCategoryType={eventCategoryType}&excludedTypes[0]={excludedTypes[0]}&excludedTypes[1]={excludedTypes[1]}&includeDrafts={includeDrafts}&excludeRevised={excludeRevised}

Gets role events for every role within the sales chain

GET api/role/{id}/descriptions?pageSize={pageSize}&pageNumber={pageNumber}&types[0]={types[0]}&types[1]={types[1]}

Get the descriptions for a role by role id

PUT api/role/{id}/detachdescription?descriptionId={descriptionId}

Detaches a description from a role

GET api/role/{id}/vendors

Get the members of a role by the role Id

GET api/role/{id}/tenants

Get the tenants of a lettings role by the role Id

GET api/role/{id}/matches?pageSize={pageSize}&pageNumber={pageNumber}&adjustedAskingPrice={adjustedAskingPrice}&sort={sort}&minScore={minScore}

Get a list of groups that may be interested in this property role

POST api/role/{id}/matches?pageSize={pageSize}&pageNumber={pageNumber}&adjustedAskingPrice={adjustedAskingPrice}&sort={sort}

Get a list of groups that may be interested in this property role

POST api/role/{id}/matchidsfiltered

Get list of role ids

GET api/role/{id}/documents?subTypes[0]={subTypes[0]}&subTypes[1]={subTypes[1]}&pageSize={pageSize}&pageNumber={pageNumber}&type={type}&orderDesc={orderDesc}

Get a list of documents belonging to a role

GET api/role/{id}/documentfromplaceholder?placeholderType={placeholderType}&placeholderSourceType={placeholderSourceType}&groupId={groupId}

Get a single DocumentPlaceholder which is the 'slot' the particular document of type+source exists within.

POST api/role/{id}/setdocumentplaceholder

GET api/role/{id}/images?pageSize={pageSize}&pageNumber={pageNumber}&subtype={subtype}

Get a list of ordered images belonging to a role

GET api/role/{id}/brochures?pageSize={pageSize}&pageNumber={pageNumber}

Get a list of ordered brochures belonging to a role

PUT api/role/{id}/SetRoleImageOrder

Updates the image order on a role

PUT api/role/{id}/setbrochureorder

Updates the brochure order on a role

PUT api/role/{id}/attachdocument?documentId={documentId}

Attaches an existing document to a role

PUT api/role/{id}/detachdocument?documentId={documentId}

Detaches a document from a role

PUT api/role/{id}/detachdocumentfromplaceholder?documentPlaceholderId={documentPlaceholderId}

Detaches a document from a document placeholder

POST api/role/{id}/uploadandattachdocument

Allows you to upload a document and attach it directly to a role.

POST api/role/{id}/attachexternaldocument

Attaches an externally hosted document to a role

PUT api/role/{id}/updateprice

Update price for a given PropertySalesRole.

GET api/role/{id}/valuation

Gets the valuation for a property marketing role

GET api/role/{id}/valued

Gets the valuation for a property marketing role

GET api/role/{id}/offers?pageSize={pageSize}&pageNumber={pageNumber}&excludeDrafts={excludeDrafts}

Get all of the offers associated to the current property marketing role.

GET api/role/{id}/offersbasic

Get a basic list of offers associated to the current property marketing role.

GET api/role/{roleId}/viewingsbasic?showCancelled={showCancelled}

Get a basic list of all viewings for a particular marketing role.

GET api/role/{id}/viewings?pageSize={pageSize}&pageNumber={pageNumber}&excludeDrafts={excludeDrafts}

Get all of the viewings associated to the current property marketing role.

PUT api/role/{id}/updatefees

Update the fee for a given PropertyMarketingRole.

PUT api/role/{id}/addfee

Add a fee for a given PropertyMarketingRole.

PUT api/role/{id}/removefee?feeId={feeId}

Remove a fee from a given PropertyMarketingRole.

POST api/role/{id}/setclosingdate

Sets the role closing date

PUT api/role/{id}/setdefaultimage?documentId={documentId}

Sets the default image of a property marketing role

PUT api/role/{id}/confirmcompliancechecks?negotiatorId={negotiatorId}

Confirms the compliance checks have been carried out on a marketing role

PUT api/role/{id}/setflag

Sets a flag on a property marketing role

PUT api/role/{id}/setcompliancechecks

Set the compliance checks on a property marketing role i.e. Valid Epc, Proof of ID or Proof of Ownership.

PUT api/role/{id}/changeteam?teamId={teamId}

Change the owining team of a Role

POST api/role/{id}/changebranch?branchId={branchId}

Change the branch of a role

POST api/role/{roleId}/setcontractenddate

Change the branch of a role

PUT api/role/{id}/addgrouptopropertyrole

Creates/Adds a group to the supplied roleId

GET api/role/suggest?IsOnMarket={IsOnMarket}&PageNumber={PageNumber}&PageSize={PageSize}&Query={Query}&RoleType={RoleType}&RoleStatus={RoleStatus}&SuggestType={SuggestType}

Search for property marketing roles that match the specified search criteria

GET api/role/propertychainsuggest?IsOnMarket={IsOnMarket}&PageNumber={PageNumber}&PageSize={PageSize}&Query={Query}&RoleType={RoleType}&RoleStatus={RoleStatus}&SuggestType={SuggestType}

Search for property marketing roles that are in OfferAccepted or Exchanged status

PUT api/role/{id}/setportaloverrides

Set portal configuration exclusivity overrides

GET api/role/{id}/notes?pinned={pinned}&pageNumber={pageNumber}&pageSize={pageSize}

POST api/role/{id}/boardrequest

To send an board request email to a external provider

GET api/role/{id}/getbrandportalexclusions

Get all brands with details for an agency

POST api/role/{id}/savebrandportalexclusions

Get all brands with details for an agency

POST api/role/createreferralevent

Creates a referral event on the role

POST api/role/{id}/copy

Clones a property marketing role

POST api/role/{id}/setholdingdeposit

Set holding deposit for marketing role

POST api/role/{id}/payholdingdeposit

Pay funds against holding deposit

POST api/role/{id}/removeholdingdeposit?relatedRoleId={relatedRoleId}

Remove holding deposit from role

POST api/role/{id}/releaseholdingdeposit?relatedRoleId={relatedRoleId}

Reset the holding deposit for a role

POST api/role/printactivityevents/pdf/{id}

Starts the job which will eventually return a PDF with all sales progression activity

AuctionProgression

Rezi Auction Progression Api.

APIDescription
POST api/progression/auction/instructforauction

Instructs a role to be let

Document

Rezi Document Api.

APIDescription
GET api/document/{id}

Gets a document by its id.

PUT api/document/{id}/savedescription?description={description}

Save the document description. Used for the image caption for the portals.

PUT api/document/setprivacy

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.

PUT api/document/rename

Updates the filename of an existing document.

POST api/document/upload

Upload a document.

GET api/document/{id}/download

Download a document by its id.

GET api/Document?ids[0]={ids[0]}&ids[1]={ids[1]}

Get documents by their ids

Viewing

Rezi Viewing Api.

APIDescription
POST api/viewing/bookviewing

Book a Viewing.

POST api/viewing/{id}/recordfeedback

Record the feedback against a Viewing.

PUT api/viewing/{id}/editfeedback

Edit the feedback against a Viewing.

POST api/viewing/{viewingFeedbackId}/feedbacknotified?type={type}&notifiedDate={notifiedDate}&negIds[0]={negIds[0]}&negIds[1]={negIds[1]}

Record that the feedback for a Viewing was notified to the vendor.

PUT api/viewing/{viewingFeedbackId}/editfeedbacknotified?vendorNotifiedId={vendorNotifiedId}&type={type}&notifiedDate={notifiedDate}&negIds[0]={negIds[0]}&negIds[1]={negIds[1]}

Edit that the feedback for a Viewing was notified to the vendor.

PUT api/viewing/{viewingFeedbackId}/editfeedbackreviewed?markAsReviewed={markAsReviewed}

Edit whether the vendor feedback for the viewing has been reviewed.

POST api/viewing/bookmultiviewing

Book multiple viewings appointment

PUT api/viewing/{id}/recordslotapproval/{viewingSlotId}?status={status}

Set approval status of viewing slot on multi viewing appointment

DELETE api/viewing/{id}/delete

Endpoint to complete the multi viewing container once individual appointments have been booked.

POST api/viewing/bulkcompleteviewingfollowups

Endpoint to Complete feedback for multiple viewing follow ups.

GET api/Viewing/{id}

Get an Viewing by its id.

DELETE api/Viewing/{id}

Cancel a viewing appointment by id if it exists.

Posting

Rezi Core Accounts Api Postings

APIDescription
GET api/posting/transaction/{ledgerEntryId}?accountId={accountId}

Get ledger entry details by Id

GET api/posting/suspense?pageSize={pageSize}&pageNumber={pageNumber}

Get all ledger postings in the suspense account

GET api/posting/cash

Get all postings in the cash account for the agent

POST api/posting/addadjustmentitem

Add adjustment to ledger entry

POST api/posting/{accountId}/uncleared

Get uncleared items for account/ledger

POST api/posting/uncleared

Get uncleared items in accounting system

Webhook

Manage webhooks in the core API

APIDescription
POST api/webhook/create/{triggerName}

Creates a new webhook in the system (scoped to agency)

DELETE api/webhook/{webhookId}

Deletes an existing webhook.

GET api/webhook/list?triggerFilterName={triggerFilterName}

Lists all of the webhooks currently set up.

GET api/webhook/{webhookId}

Gets a webhook by its ID

List

Rezi List Api.

APIDescription
GET api/list/event/{id}

Get an EventListDataContract by event Id.

POST api/list/events?pageSize={pageSize}&pageNumber={pageNumber}

GET api/list/events/filters?context={context}&eventTypes[0]={eventTypes[0]}&eventTypes[1]={eventTypes[1]}&roleTypes[0]={roleTypes[0]}&roleTypes[1]={roleTypes[1]}

POST api/list/events/savefilter

DELETE api/list/events/filters/{id}

Marks Event List Filter as deleted

DELETE api/list/property/filters/{id}

Marks Property List Filter as deleted

DELETE api/list/groups/filters/{id}

Marks Groups List Filter as deleted

POST api/list/groups?pageSize={pageSize}&pageNumber={pageNumber}

POST api/list/negotiators?pageSize={pageSize}&pageNumber={pageNumber}

POST api/list/teams?pageSize={pageSize}&pageNumber={pageNumber}

POST api/list/groups/groupidsfiltered

Get list of group ids

GET api/list/groups/filters?context={context}&roleType={roleType}

PUT api/list/groups/savefilter

POST api/list/groupinterests?pageSize={pageSize}&pageNumber={pageNumber}

Get list of groups and what they are interested in.

POST api/list/groupinterests/groupinterestidsfiltered

Get list of groups and what they are interested in.

GET api/list/groupinterests/filters?context={context}

PUT api/list/groupinterests/savefilter

DELETE api/list/groupinterests/filters/{id}

Marks Groups List Filter as deleted

POST api/list/property?pageSize={pageSize}&pageNumber={pageNumber}

POST api/list/property/propertyidsfiltered

Get list of RoleIds for property marketing roles

POST api/list/property/salespipeline?pageSize={pageSize}&pageNumber={pageNumber}

POST api/list/property/polygon?pageSize={pageSize}&pageNumber={pageNumber}

Searches for properties that are within a polygon

POST api/list/property/savefilter

GET api/list/property/filters?context={context}&roleType={roleType}

POST api/list/property/csv

Generates a csv file from selected property list items

POST api/list/lettingproperty/csv

Generates a csv file from selected letting property list items

POST api/list/propertypipeline/csv

Generates a csv file from selected property list items

POST api/list/events/csv

Generates a csv file from selected event list items

POST api/list/groups/csv

Generates a csv file from selected group list items

POST api/list/groupinterests/csv

Generates a csv file from selected group interest list items

POST api/list/activesearches/csv

Generates a csv file from selected group list items

POST api/list/groupmatches/csv

Generates a csv file from group matches by property role id

POST api/list/propertyfinancial/csv

Generates a csv file from selected group list items

POST api/list/propertynewbusiness/csv

Generates a csv file from selected property list items

POST api/list/todos?pageSize={pageSize}&pageNumber={pageNumber}

Get list of todos

GET api/list/todos/filters?context={context}

PUT api/list/todos/savefilter

DELETE api/list/todos/filters/{id}

Marks Todo List Filter as deleted

POST api/list/todotasks?pageSize={pageSize}&pageNumber={pageNumber}

Get list of todos tasks.

GET api/list/todotasks/filters?context={context}

PUT api/list/todotasks/savefilter

DELETE api/list/todotasks/filters/{id}

Marks Todos task List Filter as deleted

POST api/list/followups?pageSize={pageSize}&pageNumber={pageNumber}

Gets a list of group followups

PUT api/list/followups/savefilter

Save follow up filter

GET api/list/followups/filters?roleType={roleType}&context={context}

Get all saved follow up list filters

DELETE api/list/followups/filters/{id}

Marks Follow Up List Filter as deleted

POST api/list/feedback/followups?pageSize={pageSize}&pageNumber={pageNumber}

Gets a list of group followups

PUT api/list/feedback/followups/savefilter

Save feedback follow up filter

GET api/list/feedback/followups/filters?roleType={roleType}&context={context}

Get all saved feedback follow up list filters

DELETE api/list/feedbackfollowups/filters/{id}

Marks Feedback Follow Up List Filter as deleted

POST api/list/tenancy?pageSize={pageSize}&pageNumber={pageNumber}

POST api/list/pm/certificatesandlicences

POST api/list/pm/properties

Used to return a list of properties in PM

POST api/list/pm/companies

Returns a list of companies in PM

POST api/list/pm/landlords

Returns a list of landlords in PM

POST api/list/pm/tenants

Returns a list of Tenants in PM

POST api/list/pm/tenancy

Returns a list of Tenancies in PM

GET api/list/listsearchschema?filterName={filterName}

Filter for follow ups

POST api/list/schemasearch

Sync

Rezi Group Api.

APIDescription
POST api/sync/mailsync

Syncronise Email with Rezi Events, attach documents etc

GET api/sync/calendarsetup/{personId}

Initially Setup the Calendar, create Rezi Calendar, copy upto 16 Days prior into calendar, create a subscription channel for the callback

GET api/sync/calendarsyncoauthurl/{personId}?sendEmail={sendEmail}

Get the oauth url for the calendar sync service

GET api/sync/googleanalyticsoauthurl/{brandId}/{personId}

Get the oauth url for the google analytics integration service

GET api/sync/calendarsyncenabled

check if the calendar sync is enabled for this user this could be used to enabled/disable the calendar setup button

GET api/sync/mailsyncanddraftenabled

check if they user has setup their credentials for smap services this could be used to enabled/disable the mail sync button

GET api/sync/mailsendenabled

check if the user has setup their credientials for smtp services

POST api/sync/cronofycallback/{negotiatorId}/{uniqueIdentifier}

Forces a call to get updates from Cronofy for the rezi calendar

DELETE api/sync/deletecalendar

Forces a call to get updates from Cronofy for the rezi calendar

GET api/sync/imapserversetup

check if the user has setup their credientials for smtp services

Offer

Rezi Offer Api.

APIDescription
POST api/offer/recordoffer

Record offer on a sale

POST api/offer/progressnoteofinterest?offerId={offerId}

Record a note against on a offer

POST api/offer/reviseoffer

Revise offer price

POST api/offer/recordlettingoffer

Record offer on a letting

POST api/offer/recordofferresponse

Record a sale/auction offer response

POST api/offer/recordlettingofferresponse

Record a letting offer response

POST api/offer/recordauctionofferresponse

Record a auction offer Response

GET api/Offer/{id}

Get an offer by its id.

GET api/Offer?pageSize={pageSize}&pageNumber={pageNumber}

Gets a paged amount of offerss.

DELETE api/Offer/{id}

Delete an offers by id if it exists.

Negotiator

Rezi Negotiator Api.

APIDescription
GET api/negotiator/me

Get a person by its Id

POST api/negotiator/statuses

Gets negotiators online / offline status.

GET api/negotiator/getbasic?teamId={teamId}&pageSize={pageSize}&pageNumber={pageNumber}

Get negotiators online / offline status.

GET api/negotiator/getarchived?teamId={teamId}&pageSize={pageSize}&pageNumber={pageNumber}

Get all archived Negotiators for the Agency's branch.

GET api/negotiator/my/properties/{roleType}?pageSize={pageSize}&pageNumber={pageNumber}

Used for the Property Sales Dashboard to return a list of the negotiator's properties.

GET api/negotiator/my/properties/favourite?pageSize={pageSize}&pageNumber={pageNumber}

Lists favourited properties

POST api/negotiator/my/properties/favourite/add/{propertyId}?roleId={roleId}

Add property to Negotiators favourite list

DELETE api/negotiator/my/properties/favourite/remove/{propertyId}?roleId={roleId}

Remove a property from a Negotiators favourite list.

GET api/negotiator/my/groups/favourite?pageSize={pageSize}&pageNumber={pageNumber}

Returns a list of the logged in negotiators favourite groups.

POST api/negotiator/my/groups/favourite/add/{groupId}

Add a favourite group to the negotiators list of favourites.

DELETE api/negotiator/my/groups/favourite/remove/{groupId}

Remove a group from a Negotiators favourite list.

GET api/negotiator/my/keys?pageSize={pageSize}&pageNumber={pageNumber}&checkedOutOnly={checkedOutOnly}

Return all Negotiator keys for the side bar display.

POST api/negotiator/intervaleventcounts

Return interval based event counts for negotiators.

POST api/negotiator/me/setstatus?status={status}

Set the online/offline status of the logged in negotiator

GET api/negotiator/my/preferences

Gets the preferences for current negotiator

POST api/negotiator/my/preferences

Save or Update Negotiator Preferences

POST api/negotiator/my/preferences/emailsignature

Allows you to upload a document for use as email signature

GET api/negotiator/my/responsibilities

Gets a list of the logged in users responsibilities

POST api/negotiator/create

Create New Negotiator

POST api/negotiator/my/biography?text={text}

Update My Biography

GET api/negotiator/my/preferences/timeline

Get a Negotiators Timeline Preferences

POST api/negotiator/my/preferences/timeline

Save or Update Negotiator Timeline Preferences

GET api/Negotiator/{id}

Get a Negotiator by its id.

GET api/Negotiator?teamId={teamId}&pageSize={pageSize}&pageNumber={pageNumber}

Get negotiators online / offline status.

ProgressionChain

Rezi Progression Chain Api.

APIDescription
POST api/progressionchain/{id}/createchain

Create chain for sales progression role

POST api/progressionchain/{id}/addchainnode

Add node to progression chain

POST api/progressionchain/{id}/addchainlink

Add node to progression chain

PUT api/progressionchain/{id}/deletenode

Add node to progression chain

PUT api/progressionchain/{id}/deletechainlink?linkId={linkId}

Add node to progression chain

PUT api/progressionchain/{id}/resetchain

Add node to progression chain

GET api/progressionchain/{id}/getchain

Create chain for sales progression role

GET api/progressionchain/{id}

Get the progression chain for purchasing role

Branding

Rezi Brand Api.

APIDescription
GET api/branding/{id}

No documentation available.

GET api/branding/getallbrands

Get all brands with details for an agency

GET api/branding/getbranddocuments?brandid={brandid}

Gets back the enum data to fill the dropdown menus

GET api/branding/branch

Gets a sumary all of the brands for a branch

PUT api/branding/{id}/attachexternaldocument

Attaches an external document to brand.

PUT api/branding/{id}/uploadandattachdocument

Uploads and attaches a document to a brand.

PUT api/branding/{id}/uploadandattachdocumenttodefault

Uploads and attaches a document to a brand.

PUT api/branding/{id}/attachdocument?documentId={documentId}

Attaches a document to a brand.

PUT api/branding/{id}/detachdocument?documentId={documentId}

Detaches a document from a brand.

PUT api/branding/{id}/uploaddocumentcustomisation

Upload the data to customise a Brand Document.

GET api/branding/{id}/getcustomisationdata?roleId={roleId}&documentId={documentId}

POST api/branding/uploadsmstemplate

Upload the data to create a SMS Document Template for a Brand.

POST api/branding/uploademailtemplate

Upload the data to create a Email Document Template for a Brand.

GET api/branding/websitesetup/{brandId}

Get files and details that can be used to customize a website

POST api/branding/htmladvert/{brandId}

Upload the a html advert for a brand.

GET api/branding/htmladverts/{brandId}

Upload the a html advert for a brand.

GET api/Branding

Gets a sumary all of the brands for a agency

Twitter

Rezi Group Api.

APIDescription
GET api/twitter/oauthurl/{brandId}/{personId}

Get the oauth url for the twitter integration service

GET api/twitter/handle/{brandId}

Get the oauth url for the twitter integration service

POST api/twitter/directmessage

Sends a direct message to a screen name

POST api/twitter/tweet

Sends a direct message to a screen name

ListStats

Rezi List Stats Api.

APIDescription
POST api/list/stats/events

POST api/list/stats/groups

POST api/list/stats/property

POST api/list/stats/groupinterests

POST api/list/stats/todos

POST api/list/stats/todotasks

POST api/list/stats/followups

POST api/list/stats/tenancy

POST api/list/stats/invoice

POST api/list/stats/tenancystats

Returns a list of values of the queries sent through

POST api/list/stats/tenantstats

Returns a list of totals for tenants with missing information

POST api/list/stats/propertystats

Returns a list of totals for properties with expiring information

POST api/list/stats/certificatestats

Returns a list of totals for certificates stats

Stationary

Default Text Generation

APIDescription
GET api/stationary/html/{brandId}

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.

GET api/stationary/sms/{brandId}

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.

Teams

Manage Teams

APIDescription
GET api/teams/{id}

Gets a Team

POST api/teams/add

Add a new Team

GET api/teams/{id}/members

Gets the members of a team

POST api/teams/{id}/members/add

Adds a member to a team

POST api/teams/{id}/members/remove

Remove a member from a team

PUT api/teams/{id}/setteamresponsibilities

Sets the responsibilties for a team group

ChargesDescription

Rezi Charges Description Api

APIDescription
POST api/chargesdescription/Save

DELETE api/chargesdescription/Delete?id={id}

GET api/ChargesDescription/{id}

Milestone

Rezi Milestone Api

APIDescription
POST api/milestone/{id}/uploadandattachdocument

Allows you to upload a document and attach it directly to a milestone.

PUT api/milestone/{id}/attachdocument?documentId={documentId}

Attaches an existing document to a milestone

PUT api/milestone/{id}/detachdocument?documentId={documentId}

Detaches a document from a milestone

Legal Endpoints for managing referals to legal providers

APIDescription
POST api/legal/referrals

DocumentGeneration

Document Generations System (Rezi Post) controller

APIDescription
GET api/documentgeneration/metadata/{major}/{minor}/{build}/{revision}

Returns the data contract to configure the word plugin for creating templates

POST api/documentgeneration/custompack

Generates any correspondence and can allow you to overpost information to the correspondence

POST api/documentgeneration/previewpack

Generates a pack using the first selected group/property of a type to get a quick preview of the pack

POST api/documentgeneration/boardordernew

Generates an board ordering New correspondence

POST api/documentgeneration/boardorderreplace

Generates an board ordering Replace correspondence

POST api/documentgeneration/boardordertakedown

Generates an board ordering Takedown correspondence

POST api/documentgeneration/boardorderupdate

Generates an board ordering Update correspondence

POST api/documentgeneration/confirmvaluation

Generates a correspondence confirming the booking of a valuation appointment. Uses default values where possible.

POST api/documentgeneration/valuationresult

Generates a correspondence confirming the result of a valuation appointment. Uses default values where possible.

POST api/documentgeneration/instruction

Generates a Instruction letter correspondence to the vendor of a particular marketing role

POST api/documentgeneration/tenancyagreementast

Generates Tenancy Agreement correspondence

POST api/documentgeneration/tenancyguarantor

Generates Tenancy Guarantor correspondence

POST api/documentgeneration/withdrawninstruction

Generates a Withdrawn Instruction letter correspondence to the vendor of a particular marketing role

POST api/documentgeneration/reschedulevaluation

Generates a Reschedule Valuation letter correspondence

POST api/documentgeneration/valuationlost

Generates a Valuation Lost letter correspondence to the vendor of a particular marketing role

POST api/documentgeneration/rescheduleepcappointment

Generates a EPC Appointment letter correspondence

POST api/documentgeneration/reschedulemeeting

Generates a meeting letter correspondence

POST api/documentgeneration/cancelvaluation

Generates a cancel a valuation letter correspondence

POST api/documentgeneration/cancelepcappointment

Generates a cancel an epc appointment letter correspondence

POST api/documentgeneration/confirmepcappointment

Generates a confirm an epc appointment letter correspondence

POST api/documentgeneration/cancelmeeting

Generates a cancel a meeting letter correspondence

POST api/documentgeneration/confirmmeeting

Generates a confirm a meeting letter correspondence

POST api/documentgeneration/confirmgeneralappointment

Generates a confirm general appointment letter correspondence

POST api/documentgeneration/cancelgeneralappointment

Generates a cancel general appointment letter correspondence

POST api/documentgeneration/reschedulegeneralappointment

Generates a reschedule general appointment letter correspondence

POST api/documentgeneration/offer

Generates a correspondence notifying the vendor of an offer. Uses default values where possible.

POST api/documentgeneration/offeraccepted

Generates a correspondence any parties of the acceptance of an offer. Uses default values where possible.

POST api/documentgeneration/offerrejected

Generates a correspondence any parties of the rejection of an offer. Uses default values where possible.

POST api/documentgeneration/offerwithdrawn

Generates a correspondence to notify any parties of the withdrawl of an offer. Uses default values where possible.

POST api/documentgeneration/completed

Generates a correspondence to notify any parties of completion. Uses default values where possible.

POST api/documentgeneration/exchanged

Generates a correspondence to notify any parties of exchanged. Uses default values where possible.

POST api/documentgeneration/openhouse

Generates an open house correspondence

POST api/documentgeneration/confirmationofviewing

Generates a correspondence to notify all parties of a scheduled viewing. Uses default values where possible.

POST api/documentgeneration/cancellationofviewing

Generates a correspondence to notify parties of a cancellation of a viewing. Uses default values where possible.

POST api/documentgeneration/reschedulingofviewing

Generates a correspondence to notify parties involved of a rescheduling of a viewing. Uses default values where possible.

POST api/documentgeneration/singlepropertymatch

Generates a correspondence to multiple applicants, sending them all the same property role

POST api/documentgeneration/singlelettingspropertymatch

Generates a correspondence to multiple applicants, sending them all the same letting property role

POST api/documentgeneration/printablepropertylist

Generates a printable property list, it is targetless so there is no reference to applicants or owners

POST api/documentgeneration/selectedpropertiesmatch

Generates a correspondence to a single applicant, sending them user selected property roles

POST api/documentgeneration/selectedlettingspropertiesmatch

Generates a correspondence to a single letting applicant, sending them user selected property roles

POST api/documentgeneration/multipropertymatch

Generates a correspondence to multiple applicants, sending them a filtered set of the matching property roles

POST api/documentgeneration/multilettingspropertymatch

Generates a correspondence to multiple letting applicants, sending them a filtered set of the matching letting property roles

POST api/documentgeneration/vendorreport

Generates a correspondence to a single group, sending them a single report for multiple properties

POST api/documentgeneration/salesapplicantwelcomepack

Generates a correspondence to a an sales applicant

POST api/documentgeneration/lettingsapplicantwelcomepack

Generates a correspondence to a an lettings applicant

POST api/documentgeneration/vendorwelcomepack

Generates a correspondence to a an lettings applicant

POST api/documentgeneration/viewing/feedback

Sends viewing feedback to Owner / Landlord

POST api/documentgeneration/bulkgrouplistcommunication

Generates a bulk communication pack out to multiple clients in a list.

POST api/documentgeneration/bulkinterestrolecommunication

Generates a bulk communication pack out to multiple clients with interest roles.

POST api/documentgeneration/bulkpropertyownercommunication

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

POST api/documentgeneration/createlettertemplate

Uploads a new letter template

POST api/documentgeneration/createheadertemplate/{brandId}

Uploads a new header template

POST api/documentgeneration/updatelettertemplate/{id}

Updates a merge letter template

POST api/documentgeneration/renamelettertemplate/{id}

Rename a letter template and change the description

POST api/documentgeneration/lettertemplate/properties/{id}

Update the properties of a template, but not its content.

POST api/documentgeneration/updateheadertemplate/{id}/{brandId}

Updates a header letter template

POST api/documentgeneration/saveenvelopetemplate

Saves or updates the envelope template for an agency

PUT api/documentgeneration/signableOrder/{envelopeId}

Saves or updates the envelope template for an agency

GET api/documentgeneration/signableOrder/{envelopeId}

Saves or updates the envelope template for an agency

POST api/documentgeneration/saveenvelopetemplatepack

Saves or updates envelope template correspondence for a an agency

GET api/documentgeneration/lettertemplate/{letterTemplateId}

Returns a list of lettertemplates associated to this agency

GET api/documentgeneration/mergetemplates

Returns a list of lettertemplates associated to this agency

GET api/documentgeneration/unusedmergetemplates

Returns a list of lettertemplates associated to this agency that are not currently used in any envelope templates

GET api/documentgeneration/templatesusinganalytics/{analyticsId}

Returns a list of lettertemplates associated to this agency and to a particular google analyitics campaign

GET api/documentgeneration/bagcontent

Returns the detail of the sack of correspondence that has just been prepared

GET api/documentgeneration/sackcontent/{sackReference}

Returns the detail of the all outstanding sacks

GET api/documentgeneration/deletesackcontent/{sackReference}/{envelopereference}

deletes an envelope from the the content of a sack Deprecated in favour of the DELETE verb

DELETE api/documentgeneration/sackcontent/{sackReference}/{envelopereference}

deletes an envelope from the the content of a sack

DELETE api/documentgeneration/envelopecontent/{sackReference}/{envelopereference}/{documentreference}

deletes an document from an envelope

DELETE api/documentgeneration/sack/{sackReference}

deletes an envelope from the the content of a sack

GET api/documentgeneration/printsackcontent/{sackReference}/{envelopereference}

Prints an envelope from a sack

GET api/documentgeneration/processsackcontent/{sackReference}

processes the content of the sack

POST api/documentgeneration/updateemailsackcontent/{sackReference}

updates the content of a sack

POST api/documentgeneration/updatetextsackcontent/{sackReference}

updates the content of a sack

POST api/documentgeneration/updateprintsackcontent/{sackReference}

updates the content of a sack

GET api/documentgeneration/insertabletemplates

Returns a list of insertable templates associated to this agency

GET api/documentgeneration/headertemplates

Returns a list of header templates associated to this agency with their associated brand info

GET api/documentgeneration/envelopetemplates

Returns a list of envelope templates associated to this agency

GET api/documentgeneration/envelopetemplate/{id}

Returns a envelope template

GET api/documentgeneration/envelopetemplatepack/{id}

Returns a envelope template pack

GET api/documentgeneration/envelopetemplatepacks

Returns a list of envelope template packs associated to this agency

GET api/documentgeneration/envelopetemplatepacktypes?inUseOnly={inUseOnly}&showHidden={showHidden}

Returns a list of envelope template packs associated to this agency

GET api/documentgeneration/envelopetemplatepacks/{systemName}

Gets a list of the packs for a particular packtype

GET api/documentgeneration/envelopetemplatepacksummarys/{systemName}?showHidden={showHidden}

Gets a list of the packs for a particular packtype

GET api/documentgeneration/envelopetemplatepacksummary/{envelopeTemplatePackId}

Gets a list of the packs for a particular packtype

GET api/documentgeneration/emailtemplates

Returns a list of email templates associated to this agency

GET api/documentgeneration/templates/{templateType}

Returns a list of mergable templates for any type associated to this agency

GET api/documentgeneration/smstemplates

Returns a list of sms templates associated to this agency

GET api/documentgeneration/targetgroups

Get an enum by its type and system name

GET api/documentgeneration/packrequiredtypes/{packid}

Get a list of the packs required types (ie all of the types required by each document in each envelope)

GET api/documentgeneration/packsupportedsendmethods/{packid}

Get a list of the supported sending methods for a correspondence (ie all of the types required by each document in each envelope)

PUT api/documentgeneration/showhideenvelopetemplatepack/{id}?hide={hide}

Show or hide a envelope template pack in rezi post

DELETE api/documentgeneration/deleteenvelopetemplatepack/{id}

Deletes a Envelope Template Correspondence

DELETE api/documentgeneration/deleteenvelopetemplate/{id}

Deletes a Envelope Template

DELETE api/documentgeneration/deletelettertemplate/{id}/{useageLimit}

Deletes a Letter Template

POST api/documentgeneration/createpdf

Creates a new pdf document.

POST api/documentgeneration/recreateepc

Creates a new epc document.

POST api/documentgeneration/recreatepropertymarketreport/{propertyId}

Creates a new Property Market Report document.

GET api/documentgeneration/outstandingprintbag?take={take}

Print all printback contents.

GET api/documentgeneration/outstandingprintbagcount

Outstanding Print Bag Count.

GET api/documentgeneration/printbagcontents

Get all printable envelopes and their content.

POST api/documentgeneration/print

Print specific back contents.

DELETE api/documentgeneration/deleteprintenvelopes

Delete Print Envelopes from the print bags

GET api/documentgeneration/searchmergefields?partialName={partialName}

Search Merge Fields

GET api/documentgeneration/documentSubTypes?DocumentTypeSystemName={DocumentTypeSystemName}

Get the appropriate document sub types for a document type

GET api/documentgeneration/templateusagecount?templateId={templateId}

Get the usage count for a template in envelopes

GeneralToDo

Rezi General ToDo Api.

APIDescription
POST api/todo/general/savetodo

Saves or Updates a General ToDo This is currently used to save quick reminders

GET api/todo/general/taskprofile?taskId={taskId}

Get the profile infos for a task

Branch

Rezi Branch

APIDescription
GET api/branch/{id}

Get a Branch by its id.

GET api/branch/{id}/Brandings

Get a Branch brandings by its id.

GET api/branch/{id}/administrators

Get Branch administrators by its id.

GET api/branch/{id}/members

Get Branch members by its id.

POST api/branch/{id}/addnegotiator

Adds a negoatiator to a branch

GET api/branch/{id}/getbrand?brandId={brandId}

Get a specific brand by brandId or default brand within a branch if brandId is not supplied.

PUT api/branch/updatefee

Add or update fee for logged in branch.

DELETE api/branch/deletefee/{defaultFeeId}

Delete fee for logged in branch.

GET api/branch/fees?transactionType={transactionType}&defaultOnly={defaultOnly}

Get fees for logged in branch.

PUT api/branch/updatefeelevel?feeLevel={feeLevel}

Update the Fee Level Setting for branch

POST api/branch/createscheduledmailmerge

Save a scheduled mail merge.

GET api/branch/scheduledmailmerges?pageSize={pageSize}&pageNumber={pageNumber}

Get all scheduled mail merges for the logged in branch.

POST api/branch/updatescheduledtaskstatus/{id}?systemStatus={systemStatus}

Update SystemStatus of ScheduledTask to Active, Inactive, Deleted or Archived.

GET api/branch/checkkeycodesexist

Check specified key codes exist in branch

Address

Rezi Address Api.

APIDescription
GET api/address/{id}

Get an address by its Id

PUT api/address/{id}/centerpoint

Update the Center Point for an Address

PUT api/address/{id}/viewpoints/add

Adds one or more View Points for an Address

PUT api/address/{id}/viewpoints/edit

Edits one or more ViewPoints of an address

PUT api/address/{id}/viewpoints/remove

Removes one or more ViewPoints of an address

Account

Rezi API Accounts

APIDescription
GET api/account/{id}

Get Account By Id

GET api/account/all?pageSize={pageSize}&pageNumber={pageNumber}

Get all accounts paginated

POST api/account/{id}/ledger

Retrieve ledger posting details for an account

POST api/account/ledger

Retrive ledger postings without account id

POST api/account/create

Create account for groupId provided

POST api/account/setstatus

Set an accounts status

PUT api/account/{id}/update

Update account details

POST api/account/{id}/statement

Get a statement for an account

POST api/account/statement/overview/{ledgerEntryId}

Get a statement for an account

POST api/account/statement/csv

Get a statement for an account

POST api/account/createsystemaccount

Create a new System account eg. new client account

GET api/account/systemaccounts

Get list of all system accounts

GET api/account/{id}/balances?startDate={startDate}&endDate={endDate}

Get balance of an account

POST api/account/pm/list?pageSize={pageSize}&pageNumber={pageNumber}

Get list of accounts with sorting and searching and by type of group for the accounts

GET api/account/customer/overview

Get an overview of customer accounts

GET api/account/payments/overview

Get an overview of account amounts and totals

POST api/account/{id}/setbank

GET api/account/{id}/receipts?depositId={depositId}

Get Receipts for account

GET api/account/{id}/deposits

Get Deposits processed for an Account

POST api/account/{id}/invoiceoverview

Get summary of an account based on invoice amounts allocated

POST api/account/{id}/paymentoverview

Get payment overview for an account

GET api/account/systemaccount

Get System Account for the Accounting System

Reminder

Reminder Controller

APIDescription
POST api/reminder/remindme

Sets a reminder

FurnishingDescription

Rezi Furnishing Description Api

APIDescription
POST api/furnishingdescription/Save

DELETE api/furnishingdescription/Delete?id={id}

GET api/FurnishingDescription/{id}

CustomTextDescription

Rezi Text Description Api

APIDescription
GET api/customtextdescription/distinctcustompropertydescriptions

Returns a list of the distinct defined custom descriptions for a property

Locale

Locale Controller for localisation, and estateagentization

APIDescription
GET api/locale/{culture}

returns the json file containing localization for the app based on a culture string, and any custom values for the agent

Cache

Acts as a persistence mechanism for ad-hoc data contracts. Also supports Lists. The default storage time is 1 hour.

APIDescription
PUT api/cache/{itemKey}?timeToLive={timeToLive}

Stores the in the cache subsystem.

GET api/cache/{itemKey}

Retrieves an object stored in the cache system by its

GET api/cache/List/{listKey}

Retrieves a list of objects stored in the cache system by its

PUT api/cache/List/{listKey}/Append?timeToLive={timeToLive}

Adds to the tail of an existing list, or creates a new list with the object in it.

PUT api/cache/List/{listKey}/Prepend?timeToLive={timeToLive}

Adds to the head of an existing list, or creates a new list with the object in it.

DELETE api/cache/List/{listKey}/Item

Removes a given item from the list.

GET api/cache/List/{listKey}/Pop

Pops an items from the list head.

DELETE api/cache/{itemKey}

Deletes the item stored at

GET api/cache/Key

Generate a guid for use as a key

DigitalSignature

Rezi Digital Signature Api.

APIDescription
POST api/digitalsignature/signable/bounced/{fingerprint}

creates an event when a envelope is bounced by signable

POST api/digitalsignature/signable/opened/{fingerprint}

creates an event when a document is opened

POST api/digitalsignature/signable/cancelled/{fingerprint}

creates an event when a document is cancelled

POST api/digitalsignature/signable/sent/{fingerprint}

creates an event when a document is sent out by signable

POST api/digitalsignature/signable/signed/{fingerprint}

creates an event when a document is signed

POST api/digitalsignature/signable/completed/{fingerprint}

creates an event when a document is completed

GET api/digitalsignature/signable/setup/{brandId}/{logoId}/{colour}?emailAddress={emailAddress}

creates a new account on signable

GET api/digitalsignature/signable/{brandId}

No documentation available.

DELETE api/digitalsignature/signable/delete/{brandId}

delete a sub account on signable

GET api/digitalsignature/signable/cancel/{eventId}

Cancel an Envelope

GET api/digitalsignature/signable/expire/{eventId}

Expire an Envelope

GET api/digitalsignature/signable/remind/{eventId}

Send a reminder for an Envelope

Notification

APIDescription
POST api/notifications/register

No documentation available.

DELETE api/notifications/unregister?connectionId={connectionId}

No documentation available.

SendGrid

Rezi Digital Signature Api.

APIDescription
POST api/sendgrid/bounce

creates an event when a envelope is bounced by sendgrid

TenantReferencing

Tenant Referencing api

APIDescription
GET api/tenantreferncing/products

Gets the available products for tenant referencing

GET api/tenantreferncing/case/{tenancyRoleId}

Gets a tenancy referencing case based on the role id supplied

GET api/tenantreferncing/applications/{caseId}

Gets all tenancy referencing applications for the caseId provided

POST api/tenantreferncing/case/{tenancyRoleId}

Creates a tenancy referencing case using the role id supplied

POST api/tenantreferncing/addapplication/{caseId}/{tenancyRoleId}/{personId}/{productId}

Creates a tenancy referencing application for a case using the details supplied

POST api/tenantreferncing/addguarantor/{caseId}/{tenancyRoleId}/{personId}

Adds a Guarantor to a tenancy referencing application for a case using the details supplied

PUT api/tenantreferncing/submitcase/{tenancyRoleId}/{caseId}

Submits a tenant referencing case for processing

PUT api/tenantreferncing/submitapplication/{caseId}

Submits an individual referencing application for processing

GET api/tenantreferncing/application/{applicationId}/referencingresult

Get the details of an individual application referencing result

AgencyAdmin

APIDescription
POST api/admin/agency/{id}/setfeestructure

Sets the fee structure on an agency

Tenancy

Rezi API Tenancy

APIDescription
POST api/tenancy/{id}/setdates

Set start date, terms, end date and notice period for tenancy. assertions

POST api/tenancy/{id}/setenddate

POST api/tenancy/{id}/setagreement

Set Agreement type for the tenancy.

POST api/tenancy/{id}/setparking

Set parking details for the tenancy.

POST api/tenancy/{id}/setrentschedule

GET api/tenancy/{id}/rentdates?overrideEndDate={overrideEndDate}

POST api/tenancy/{id}/settenantrequirements

GET api/tenancy/{id}/tenantclauses

POST api/tenancy/{id}/addtenantclause

POST api/tenancy/{id}/addbreakclause?systemName={systemName}

PUT api/tenancy/{id}/updatetenantclause

DELETE api/tenancy/{id}/removetenantclause/{clauseId}

GET api/tenancy/suggest?Query={Query}&PageSize={PageSize}&PageNumber={PageNumber}

Search for tenancies/tennets/landlords that match the specified search criteria

POST api/tenancy/{id}/renew

POST api/tenancy/renewtenancy

No documentation available.

POST api/tenancy/{id}/setrent

POST api/tenancy/{id}/setnoticeperiod

GET api/tenancy/{id}/historicchanges?from={from}

GET api/tenancy/{id}/signeddocuments

POST api/tenancy/{id}/settenancyinfo

POST api/tenancy/{id}/signdocument

POST api/tenancy/{id}/bookcheckout

POST api/tenancy/checkout/{id}/feedback

POST api/tenancy/{id}/servenotice

POST api/tenancy/{id}/nextaction

POST api/tenancy/{id}/setrenewaloptions

POST api/tenancy/endtenancy

PUT api/tenancy/{id}/addforwardaddress

DELETE api/tenancy/{id}/removeforwardaddress

PUT api/tenancy/{id}/detachdocument?documentId={documentId}

Detaches a document from a tenancy role

POST api/tenancy/{id}/settenancytype?tenancyTypeName={tenancyTypeName}

Updated tenancy type

POST api/tenancy/{id}/rentdifferencewithschedule

Gets the rent split/consolidate summary for determining next rent amounts.

POST api/tenancy/{id}/generaterentdemand?dueDate={dueDate}&futureDemand={futureDemand}

Create next rent demand for the tenancy

POST api/tenancy/{id}/setadditionalservice

Create/Update additional service on tenancy

POST api/tenancy/{id}/removeadditionalservice/{additionalServiceId}

Remove additional service from tenancy

GET api/tenancy/{id}/rentdemands?startDate={startDate}&endDate={endDate}&includeOpen={includeOpen}&includePaid={includePaid}&includeForecast={includeForecast}&pageSize={pageSize}&pageNumber={pageNumber}

Get rent demands for the tenant role

POST api/tenancy/tenanciesoverview?tenancyRoleStatus={tenancyRoleStatus}&pageSize={pageSize}&pageNumber={pageNumber}

Get financial overview for tenancies in particular status

POST api/tenancy/addtenancy

Add a new tenancy

POST api/tenancy/{id}/updatetenancykeyinformation

Updates a tenancies key information

Reconcile

Rezi Accounts API

APIDescription
GET api/reconcile/{id}

Get a reconcile by id

POST api/reconcile/items

Get all items eligible for reconcile

POST api/reconcile/start

Start a new reconcile

POST api/reconcile/complete

Complete a reconcile

PUT api/reconcile/save

Save current reconcile progress

GET api/reconcile/{id}/statement

Get statement of a reconcile

GET api/reconcile/getcurrent?id={id}

Get the current reconcile

GET api/reconcile/account/{id}/statements?onlyCompleted={onlyCompleted}

Get reconcile statements for bank account

PUT api/reconcile/cancel?id={id}

Cancel the current reconcile

Job

Controller for long running jobs

APIDescription
POST api/job/SendSystemEmail

Sends a basic email to any specified party.

POST api/job/NormalisePhoneNumbers

Normalises phone numbers for agency

POST api/job/throwMeAnErrorGeoff

Normalises phone numbers for agency

POST api/Job

Issues a request that a job be cancelled if possbile

POST api/Job?email={email}

Starts a test job that send notifications with file links. This is used to test signalr and the docs system.

GET api/Job?jobReference={jobReference}

Gets the status for a job given its reference

AmenityDescription

Rezi Amenity Description Api

APIDescription
POST api/amenitydescription/Save

Save or update an Amenity Description

DELETE api/amenitydescription/Delete?id={id}

Delete an Amenity Description by its Id

GET api/AmenityDescription/{id}

Get an Amenity Description by its Id

LocalAuthorityDescription

Rezi Local Authority Description API

APIDescription
POST api/localauthoritydescription/Save

Save or update an Local Authority Description

GET api/LocalAuthorityDescription/{id}

Get an Local Authority Description by its Id

DELETE api/LocalAuthorityDescription/{id}

Delete an Local Authority Description by its Id

GlobalSearch

Rezi GlobalSearch Api.

APIDescription
GET api/globalsearch/people

Search for People across the system.

GET api/globalsearch/properties

Search for Properties across the system.

GET api/globalsearch/groups

Search for Groups across the system.

GET api/globalsearch/auctions

Search for Actions across the system.

GET api/globalsearch/suggest?text={text}&suggestSize={suggestSize}

Auto complete global search

GET api/GlobalSearch?term={term}&excludeDeleted={excludeDeleted}&excludeArchived={excludeArchived}&lastUpdated={lastUpdated}

The main endpoint for a global search across all entities in the system.

Property

Rezi Property Api.

APIDescription
GET api/property/{id}

Get a property by its Id

POST api/property/bookvaluation

A command driven endpoint to Book a Valuation.

POST api/property/recordvaluation

A command driven endpoint to Record a Valuation.

PUT api/property/{id}/updateaddress

A command driven endpoint to Update a property address.

PUT api/property/updatevaluation

A command driven endpoint to Update a Valuation.

GET api/property/{id}/owners/events?pageSize={pageSize}&pageNumber={pageNumber}&branchId={branchId}&from={from}&to={to}&type[0]={type[0]}&type[1]={type[1]}&eventCategoryType={eventCategoryType}

Get property events for the current owner by its Id

GET api/property/{id}/events?pageSize={pageSize}&pageNumber={pageNumber}&branchId={branchId}&from={from}&to={to}&type[0]={type[0]}&type[1]={type[1]}&excludedTypes[0]={excludedTypes[0]}&excludedTypes[1]={excludedTypes[1]}&eventCategoryType={eventCategoryType}

Get property events by its Id

GET api/property/{id}/descriptions?pageSize={pageSize}&pageNumber={pageNumber}&types[0]={types[0]}&types[1]={types[1]}

Get the descriptions for a property by property id

GET api/property/{id}/roles?pageSize={pageSize}&pageNumber={pageNumber}&roleTypes[0]={roleTypes[0]}&roleTypes[1]={roleTypes[1]}&roleStatuses[0]={roleStatuses[0]}&roleStatuses[1]={roleStatuses[1]}

Get the roles for a property by property id

GET api/property/{id}/documents?subTypes[0]={subTypes[0]}&subTypes[1]={subTypes[1]}&pageSize={pageSize}&pageNumber={pageNumber}&type={type}

Get the documents of a property by the property Id

GET api/property/suggest?Query={Query}&PageSize={PageSize}&PageNumber={PageNumber}&SuggestType={SuggestType}

Search for properties/addresses that match the specified search criteria

GET api/property/comparables?propertyId={propertyId}&latitude={latitude}&longitude={longitude}&mileRadius={mileRadius}&pageSize={pageSize}&pageNumber={pageNumber}&branchId={branchId}&isForLetting={isForLetting}

For a given property, will return all comparable property's nearby.

PUT api/property/{id}/attachdocument?documentId={documentId}

Attaches an existing document to a property

PUT api/property/{id}/detachdocument?documentId={documentId}

Detaches a document from a property

POST api/property/{id}/uploadandattachdocument

Allows you to upload a document and attach it directly to a property.

POST api/property/{id}/attachexternaldocument

Attaches an externally hosted document to a property

GET api/property/{id}/valuations?pageSize={pageSize}&pageNumber={pageNumber}

Get all of the valuations associated to the current owner of the property.

GET api/property/{id}/valued?pageSize={pageSize}&pageNumber={pageNumber}

Get all of the valued for current owner of the property.

POST api/property/geoaggregation/{zoom}

Returns GeoAggregations of all properties

GET api/property/{id}/owners

For a given property, will return owning PeopleGroup

GET api/property/{id}/keys

Get a list of keys for a property

GET api/property/withkey?code={code}

Get a property for a key code

GET api/property/{id}/alarms

Get a list of alarms for a property

GET api/property/{id}/specialarrangements

Get a list of special arrangements for a property

POST api/property/{id}/keys/add

Add keys for a property

POST api/property/{id}/alarms/add

Add alarm codes for a property

POST api/property/{id}/specialarrangements/add

Add special arrangements for a property

DELETE api/property/{id}/keys/remove?keyIds[0]={keyIds[0]}&keyIds[1]={keyIds[1]}

Remove keys from a property

DELETE api/property/{id}/alarms/remove?alarmIds[0]={alarmIds[0]}&alarmIds[1]={alarmIds[1]}

Remove alarm codes from a property

DELETE api/property/{id}/specialarrangements/remove?arrangementIds[0]={arrangementIds[0]}&arrangementIds[1]={arrangementIds[1]}

Remove special arrangements from a property

PUT api/property/{id}/keys/checkout

Checkout a collection of keys for a property

PUT api/property/{id}/keys/checkin

Checkin a collection of keys for a property

PUT api/property/{id}/addgrouptoproperty

Creates/Adds a group to the CurrentOwners of the supplied PropertyId

POST api/property/add

GET api/property/{id}/certificate

Get a list of certificates for a property

POST api/property/{id}/certificate/add

Add certificate for a property

POST api/property/certificate/update

Update certificate for a property

DELETE api/property/{id}/certificate/remove?certificateId={certificateId}

Remove certificate from a property

POST api/property/uploadandattachcertificatedocument?certificateId={certificateId}

Allows you to upload a document and attach it directly to a guarantor.

GET api/property/{id}/tenantroles

Get a list of all current and ended tenant roles from a property id.

GET api/property/{brandId}/{marketingRoleId}/url

Get a URL for a property for a brand.

GET api/property/{id}/propertyadditionalservices

Gets a list of AdditionalServices added to the property or any of it's tenancies

POST api/property/{id}/setadditionalservice

Create/Update additional service on a property. Defaults to Landlord liability

DELETE api/property/{id}/removeadditionalservice?additionalServiceId={additionalServiceId}

Removes the additional service from the property

Auction

Rezi Appointment Api.

APIDescription
GET api/auction/{id}

Get an auction by its id.

PUT api/auction/saveauction

Save or update an auction.

POST api/auction/{id}/confirmlots

To confirm or unconfirm a list of lots for the auction

POST api/auction/{id}/withdrawlots

To withdraw a list of properties from the auction

POST api/auction/{id}/postponelots

To postpone a list of lots for the auction

POST api/auction/savecontact

Add a new contact to the given auction Role or edit an existing contact

POST api/auction/removecontact

Remove an existing auction contact from the auction role

POST api/auction/{id}/recordbid

Record auction bid details

Enum

Rezi Enum Api.

APIDescription
GET api/enum?typeName={typeName}&systemName={systemName}&eventCategoryType={eventCategoryType}

Returns a list of possible values for an enum if you just specify . Returns a an enum if you specify and .

GET api/enum/suggest/{typeName}/{systemName}

Get enum suggestions for value

GET api/enum/marketingrolestatus?transactionType={transactionType}

Get an enum by its type and system name

Appointment

Rezi Appointment Api.

APIDescription
GET api/appointment/{id}

Get an appointment by its id.

GET api/appointment/{id}/Date/{date}

Get details of a calculated appointment using it's id and date.

PUT api/appointment/delete/{id}

Delete an appointment by id if it exists.

PUT api/appointment/cancel/{id}

Cancel an appointment by id if it exists.

PUT api/appointment/cancel/{id}/Date/{date}

Cancel calculated appointment by id and datetime, if it exists.

PUT api/appointment/noshow/{id}

Set the status of the appointment to NoShow

PUT api/appointment/appointmentstatus/{id}

No documentation available.

PUT api/appointment/saveappointment

Save or update an appointment.

POST api/appointment/freebusy

Returns Free/Busy information regarding multiple people.

POST api/appointment/suggest

Auto-picks attendees and the next available appointment slot given the parameters in the request.

EventToDo

Rezi Event ToDo Api.

APIDescription
POST api/todo/event/savetodo

Save or Updates a Event ToDo and and its tasks

PUT api/todo/event/addtasks

Add tasks to a Event ToDo

GET api/todo/event/task/{eventId}?pageSize={pageSize}&pageNumber={pageNumber}

Gets all tasks for a particular event / appointment

POST api/todo/event/task/duedate

Updates the due date of an event task

Portal

Portal Admin Controller

APIDescription
GET api/admin/portal/getportaluploadsforrole?roleId={roleId}

Get all the live portal uploads associated with a property marketing role

Valuation

Rezi Valuation Api.

APIDescription
POST api/valuation/{valuationId}/recordfeedback?feedback={feedback}&impression={impression}&feedbackDate={feedbackDate}&negIds[0]={negIds[0]}&negIds[1]={negIds[1]}

Record and edit the feedback against a Valuation.

POST api/valuation/{valuationId}/feedbacknotified?notifiedDate={notifiedDate}&negotiatorIds[0]={negotiatorIds[0]}&negotiatorIds[1]={negotiatorIds[1]}&vendorNotified={vendorNotified}

Record that the feedback for a Valuation was notified to the vendor.

GET api/Valuation/{id}

Get an Valuation by its id.

DELETE api/Valuation/{id}

Cancel a valuation appointment by id if it exists.

Analytics

Analytics integration controller

APIDescription
GET api/analytics/campaigns

returns a list of all of the campaigns for an agency

POST api/analytics/saveorupdategoogle

Updates or Creates a Campaign

POST api/analytics/unlinktemplate/{templateId}

Updates or Creates a Campaign

DELETE api/analytics/delete/{id}

Updates or Creates a Campaign

AuctionRole

Rezi Auction Role Api.

APIDescription
POST api/role/auction/{id}/setrequestedlotnumber?lotNumber={lotNumber}

Set the requested lot number for a property auction role.

POST api/role/auction/{id}/setlotnumber?auctionId={auctionId}&lotNumber={lotNumber}

Set the lot number for a property auction role.

POST api/role/auction/{id}/addtoauction?auctionId={auctionId}&lotNumber={lotNumber}

Add a property auction role to an existing auction

POST api/role/auction/{id}/removefromauction

Add a property auction role to an existing auction

POST api/role/auction/{id}/setreserve

Set the reserve for a property auction role.

POST api/role/auction/{id}/settype?auctionRoleTypeSystemName={auctionRoleTypeSystemName}

Set the type of auction role (Commercial or Residential)

GET api/role/auction/milestone/{roleId}

Get auction role milestones

PUT api/role/auction/milestone/{roleId}

Update an auction role milestone

POST api/role/auction/milestone/{roleId}

Add a new auction role milestone

DELETE api/role/auction/milestone/{roleId}/{milestoneId}

Delete a custom auction milestone

PUT api/role/auction/milestone/{roleId}/create

Create default milestones for role if they dont exist

Deposit

Rezi API Deposit

APIDescription
GET api/deposit/unprotected?pageSize={pageSize}&pageNumber={pageNumber}&sort={sort}&ascending={ascending}

GET api/deposit/unprotected/overview

POST api/deposit/allocate

Receipt (optional) and allocate deposit funds to holding account

POST api/deposit/release

POST api/deposit/schemes/transfer

POST api/deposit/schemes/create

GET api/deposit/schemes/list

GET api/deposit/schemes/{id}/groupings?searchText={searchText}&searchType={searchType}&pageSize={pageSize}&pageNumber={pageNumber}

POST api/deposit/landlord/transfer

POST api/deposit/collections

Get deposit collections

FeatureDescription

Rezi Feature Description Api

APIDescription
POST api/featuredescription/Save

DELETE api/featuredescription/Delete?id={id}

GET api/FeatureDescription/{id}

SearchSync

Rezi API Search Sync Endpoints

APIDescription
POST api/admin/searchsync/start?migrationId={migrationId}

Create and run as search sync request

EnlistedFeature

Rezi Enlisted Feature Api.

APIDescription
GET api/enlistedfeature/getvalidforrole/{roleId}

GET api/enlistedfeature/getvalidforagency

Gets all the active features for an agency

POST api/enlistedfeature/save

POST api/enlistedfeature/executestep/featureConfiguration/{featureConfigurationId}/step/{stepId}/role/{roleId}?chosenExternalProviderId={chosenExternalProviderId}

ReziMigration

APIDescription
POST api/admin/migrations/updatestepstatus?id={id}&stepType={stepType}&status={status}

POST api/admin/migrations/updatestatus?id={id}&status={status}

POST api/admin/migrations/queue/negotiator

POST api/admin/migrations/queue/people

POST api/admin/migrations/queue/property

POST api/admin/migrations/queue/events

POST api/admin/migrations/queue/files

Dashboard

Rezi Dashboard Api

APIDescription
POST api/dashboard/create

Create/Update dashboard

DELETE api/dashboard/{id}/delete

Delete dashboard

PUT api/dashboard/{id}/removewidgets

Remove widgets from a dashboard

PUT api/dashboard/{id}/share

Share dashboard

PUT api/dashboard/{id}/setwidget

Add widget to dashboard

DELETE api/dashboard/{id}/deletewidget/{widgetId}

Delete widget on dashboard

PUT api/dashboard/movewidget

Move widget onto another dashboard

PUT api/dashboard/{id}/addnegotiator

Add negotiator to dashboard id

PUT api/dashboard/{id}/setlayout

Set widget layout on dashboards

GET api/dashboard/getshared

Get all shared dashboards

GET api/dashboard/my

Get all shared dashboards

GET api/dashboard/available

Get all available dashboards

POST api/dashboard/createdefault

Create default dashboard.

Group

Rezi Group Api.

APIDescription
GET api/group/{id}

Get a group by its Id

POST api/group/delete

Delete a group

DELETE api/group/{id}/deletegroupmember

Delete a contact from a group

GET api/group/{id}/notes?pinned={pinned}&pageNumber={pageNumber}&pageSize={pageSize}

Get notes for Group

POST api/group/addgroup

Adds a Group

PUT api/group/{id}/addgroupmember

Add a new contact to an existing group

POST api/group/{id}/savesalessearch

Saves Search Criteria to a Group

POST api/group/{id}/savelettingssearch

Saves Lettings Search Criteria to a group

POST api/group/{id}/setsearchteam

Set the Team Group for a searching role

DELETE api/group/{id}/deletesearch/{searchingRoleId}

Deletes Search Criteria from a Group

GET api/group/{id}/salessearching?pageSize={pageSize}&pageNumber={pageNumber}

Get Sales Searching Roles for a Group

GET api/group/{id}/lettingssearching?pageSize={pageSize}&pageNumber={pageNumber}

Get Lettings Searching Roles for a Group

GET api/group/{id}/searching/{roleId}/matches?pageSize={pageSize}&pageNumber={pageNumber}&sort={sort}

Get property matches for a Searching Role for a Group

POST api/group/{id}/searching/{roleId}/matches?pageSize={pageSize}&pageNumber={pageNumber}&sort={sort}

Get property matches for a Searching Role for a Group

POST api/group/matches/find

Returns property matches using their Id

GET api/group/{id}/events?pageSize={pageSize}&pageNumber={pageNumber}&branchId={branchId}&from={from}&to={to}&type[0]={type[0]}&type[1]={type[1]}&eventCategoryType={eventCategoryType}&activeRolesOnly={activeRolesOnly}&propertyId={propertyId}&excludedTypes[0]={excludedTypes[0]}&excludedTypes[1]={excludedTypes[1]}&roleId={roleId}&includeDrafts={includeDrafts}&showCancelled={showCancelled}

Get group events by its Id

PUT api/group/{id}/displaysettings

Edit Display settings for the Group. Primarily shown in the GroupHub e.g. the icon and background image.

PUT api/group/{id}/attachdocument?documentId={documentId}

Attaches an existing document to a group

PUT api/group/{id}/detachdocument?documentId={documentId}

Detaches a document from a group

POST api/group/{id}/uploadandattachdocument

Uploads a new document and attaches it to the specified group.

POST api/group/{id}/attachexternaldocument

Attaches the external document.

PUT api/group/{id}/setdescription

Sets the description of the specified group

POST api/group/{id}/setbranch

Set the Groups home Branch

POST api/group/{id}/setteam

Set the Groups owning team

GET api/group/{id}/getpropertyroleidsalreadysent?withinDays={withinDays}&resendPriceChangedProperties={resendPriceChangedProperties}

returns a list of the property role ids that should be excluded from mailouts to this role id because the have been sent before

GET api/group/{id}/documents?subTypes[0]={subTypes[0]}&subTypes[1]={subTypes[1]}&pageSize={pageSize}&pageNumber={pageNumber}&type={type}&orderDesc={orderDesc}

Get a list of documents belonging to a group

GET api/group/{id}/offers/made?pageSize={pageSize}&pageNumber={pageNumber}

Get a list of documents belonging to a group

GET api/group/{id}/offers/received?pageSize={pageSize}&pageNumber={pageNumber}

Get a list of documents belonging to a group

GET api/group/backgroundimages?pageSize={pageSize}&pageNumber={pageNumber}

Return all background images.

PUT api/group/updateprimarygroupmember

Return the Groups with appointments between a given date range, ordered by appointments Count

GET api/group/mostactive?pageSize={pageSize}

Return the Groups with the most viewings between a given date range, ordered by viewing Count

GET api/group/basicapplicantheatmap?pageSize={pageSize}

Return the lat and longs for every applicant in the system

GET api/group/{id}/properties?pageSize={pageSize}&pageNumber={pageNumber}

Return a list of properties that the group owns

PUT api/group/{id}/saveadditionalinfo

To save or edit the Group additional info i.e. the Origin and Grade.

PUT api/group/{id}/saveadditionalquestions

To edit the Group additional questions

POST api/group/{id}/sendemail

To send an adhoc email to a group

POST api/group/{id}/sendsms

To send an adhoc sms to a group

POST api/group/geoaggregation/{zoom}

Returns GeoAggregations of all searching groups

PUT api/group/{id}/setgroupmemberstatus

Sets members Active/Inactive system status

PUT api/group/setgroupmembersorder

Sets order for members of a group

GET api/group/{id}/roles?pageSize={pageSize}&pageNumber={pageNumber}&roleTypes[0]={roleTypes[0]}&roleTypes[1]={roleTypes[1]}&roleStatuses[0]={roleStatuses[0]}&roleStatuses[1]={roleStatuses[1]}

Get the roles for a Group by Group id

POST api/group/recordcontact

Records an event on the group representing a neg being in contact

PUT api/group/{id}/setflags

Sets the interest flags on groups interest role.

PUT api/group/{id}/undelete

Undelete a group

POST api/group/{id}/addpreferredcompany?companyId={companyId}&preferredContactId={preferredContactId}

Add a preferred company to a group

POST api/group/{id}/removepreferredcompany?companyId={companyId}

Remove a preferred company to a group

POST api/group/archivegroups

Archive groups in bulk

Database

APIDescription
POST api/admin/database/setperformancelevel?nodeId={nodeId}&level={level}

Set the performance level of a database node

TextDescription

Rezi Text Description Api

APIDescription
POST api/textdescription/Save

DELETE api/textdescription/Delete?id={id}

GET api/TextDescription/{id}

Preview

Rezi Document Api.

APIDescription
GET api/preview/{docReference}?width={width}&height={height}&rotation={rotation}&quality={quality}&inline={inline}

Gets a temporary document stored by document generation, so that it can be previewed.

PUT api/preview/saveDocx/{docReference}

Save a file sent in native word format, and convert it to the right file format to be saved to disk

GET api/preview/getHtmlDocument/{docReference}

Gets a html document from public storage and returns the html body

PUT api/preview/saveHtmlDocument

Save a file html format

GET api/preview/getTextDocument/{docReference}

Gets a text document from public storage and returns

PUT api/preview/saveTextDocument

Save a file in text format

SalesRole

Rezi Role Api.

APIDescription
GET api/role/sales/{id}/getepc

Gets EPC from the supplied propertyRoleId

POST api/role/sales/{id}/saveepc

Creates/Overrides the EPC for the supplied propertyRoleId

POST api/role/sales/{id}/clearepc

Clears EPC numbers and Expiry Date and marks all EPC documents as private for the supplied propertyRoleId

Identity

Identity Controller

APIDescription
GET api/identity/Get

Gets all of the identities for the logged in person

POST api/identity/Add?personId={personId}

Adds a new identity (E.g. Facebook Identity, Twitter identity etc.) to a person

PUT api/identity/Remove?personId={personId}&identityId={identityId}

Removes an identity (E.g. Facebook Identity, Twitter identity etc.) from a person

Poi

Rezi POI Api

APIDescription
GET api/poi/{id}

Gets a POI

POST api/poi/save

Adds POI's

DELETE api/poi/delete/{id}

Delete a Poi by its Id

POST api/poi/search/radius

Search for POI's in a radius from a point

POST api/poi/search/box

Search for POI's inside a bounding box

TagDescription

Rezi Tag Description Api

APIDescription
POST api/tagdescription/Save

DELETE api/tagdescription/Delete?id={id}

GET api/TagDescription/{id}

Screenz

Rezi Group Api.

APIDescription
GET api/screenz/config/{screenid}

Gets the config back for a screen with a guid that was registered against a branch

GET api/screenz/registered

Gets the config back for a screen with a guid that was registered against a branch

POST api/screenz/register

Gets Creates a new screenz display for the branch

DELETE api/screenz/delete/{screenid}

Gets Creates a new screenz display for the branch

CorePlatformState

APIDescription
POST api/coreplatformstate/reportMigration

Reports that a data migration has been shedueled.

POST api/coreplatformstate/reportMigration/{migrationId}

Reports that a data migration has been shedueled - used by workflow

DELETE api/coreplatformstate/{stateItemReference}

Clears a state item.

POST api/coreplatformstate/platformissue

Allows business workflows to post system issues to the platform state service.

GET api/coreplatformstate/health

Gets core platform master health status

POST api/coreplatformstate/sendpendingalerts

Sends alerts for all current platform issues.

SimplePropertyRole

Rezi Simple Web Gateway API.

APIDescription
POST api/simplepropertyrole/search

Performs a searh using the specified criteria

GET api/simplepropertyrole/{roleId}

Get a property with an associated role by their Id's

Tax

APIDescription
GET api/tax/agentheld

Get all tax held by agent

POST api/tax/pay/hmrc

Pay tax out of tax held account

POST api/tax/{id}/setasdefault

Set default tax rate for the accounting system

POST api/tax/create

Create a new tax rate for the system

GET api/Tax

Get Tax rates

Agency

Rezi Agency Api.

APIDescription
GET api/agency/branches

Get the branches for an agency

GET api/agency/milestoneconfigurations

Get the milestone configurations for an agency

GET api/agency/administrators

Get the administrators for an agency

GET api/agency/accountmanager

Get the account manager for an agency

GET api/agency/meetingplaces

Get meeting places for an agency

POST api/agency/savemeetingplace

Saves a new meeting place to that particular agency

GET api/agency/fees?transactionType={transactionType}&defaultOnly={defaultOnly}

Get fees for logged in agency

PUT api/agency/updatefee

Add or update fee for logged in agency.

DELETE api/agency/deletefee/{defaultFeeId}

Delete fee for logged in agency.

GET api/agency/teams?pageSize={pageSize}&pageNumber={pageNumber}&teamType={teamType}

Returns a list of team groups for the agency.

GET api/agency/portalconfigurations?pageSize={pageSize}&pageNumber={pageNumber}

Get a list of portal configurations for the brand within a branch.

PUT api/agency/updateportalcustomisation

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.

POST api/agency/apikey?subjectId={subjectId}

Issues an API key for use with the simple role/search endpoints

GET api/agency/feestructure

Gets the fee structure of the agency

GET api/agency/getvatrate?vatRateType={vatRateType}&vatDate={vatDate}

Gets the current VAT rate unless the date is specified

GET api/agency/{id}/getbrand?brandId={brandId}

Get a specific brand by brandId or default agency brand if brandId is not supplied.

GET api/agency/tenantclause

Get meeting places for an agency

POST api/agency/addbankaccount

Creates a bank account for the agency.

GET api/Agency

Get details of the current users agency

Location

Rezi Location API

APIDescription
POST api/location/suggest

GET api/location/{id}?type={type}&source={source}

Gets a location

POST api/location/tag/match

Saves a tag to location match

Key

Rezi Key Api.

APIDescription
GET api/key/all?pageSize={pageSize}&pageNumber={pageNumber}

Gets a summary of all keys in an agency.

LettingRole

Rezi Role Api.

APIDescription
POST api/role/lettings/{id}/setdeposit

Sets the deposit on a letting role

POST api/role/lettings/{id}/setlettinginfo

Sets the core information on a letting role

POST api/role/lettings/{id}/setfeestructure

Sets the fee structure on a letting role

GET api/role/lettings/{id}/feestructure

Gets the fee structure on a letting role

PUT api/role/lettings/{id}/setheadlandlord?personId={personId}&groupId={groupId}

Set the head landlord for PropertyLettingRole

PUT api/role/lettings/{id}/setrentshare

Set the rent share for landlords on PropertyLettingRole

PUT api/role/lettings/{id}/settobsigned

Set the terms of business for a landlord on a PropertyLettingRole

PUT api/role/lettings/{id}/setnrldetails

Set the NRL details for a landlord on a PropertyLettingRole

POST api/role/lettings/{id}/addlandlordinfo

PUT api/role/lettings/{id}/setidreceived?personId={personId}

POST api/role/lettings/{id}/saveutility

Add or Update a utility for the letting role

DELETE api/role/lettings/{roleId}/removeutility?utilityId={utilityId}

Remove a utility for the letting role

POST api/role/lettings/{id}/setadditionalservice

Create/Update additional service on lettings role

POST api/role/lettings/{id}/removeadditionalservice/{additionalServiceId}

Remove additional service to lettings role tenancy

Invoice

APIDescription
GET api/invoice/{id}

Get invoice by Id

POST api/invoice/find?pageSize={pageSize}&pageNumber={pageNumber}

Get filtered list of invoices

POST api/invoice/totals

Get filtered list of invoices

GET api/invoice/fees

Get agent fees invoices earned

POST api/invoice/sales/create

Create a new invoice

PUT api/invoice/sales/edit?id={id}

Edit a draft invoice

POST api/invoice/{id}/linkfees

Add a fee to an existing invoice

PUT api/invoice/{id}/removefee?attachedFeeId={attachedFeeId}

Remove fee from existing invoice

POST api/invoice/makeallocation

Make an allocation against an existing invoice

POST api/invoice/raisecreditnote

Raise a credit note against invoice items on an invoice

POST api/invoice/issuerefund

Raises a refund against an invoice item on an invoice

POST api/invoice/saveforlater

Save expected receipts progress

GET api/invoice/saveforlater

Return list of receipts progress amounts

POST api/invoice/savereceiptlistitem

Save receipt list item

GET api/invoice/getreceiptitems

Return list of receipts to process

DELETE api/invoice/removereceiptallocation?receiptItemId={receiptItemId}&invoiceId={invoiceId}&allocationId={allocationId}

Remove a receipt list item allocation

DELETE api/invoice/removesinglereceiptitem?receiptItemId={receiptItemId}

Remove a single receipt list item without and invoice or allocations

PUT api/invoice/processreceiptlistitems?negotiatorId={negotiatorId}

Process receipt list items for a specifici negotiator.

DELETE api/invoice/saveforlater

PUT api/invoice/{id}/updatedetails

Update properties on invoice

POST api/invoice/raiseadjustment

Raise an adjustment against an invoice

PUT api/invoice/formalise?id={id}

Formalise a draft invoice and create relevant ledger entries.

POST api/invoice/invoiceoverview

Get a summary of invoices outstanding, paid and funds available for an account.

POST api/invoice/{id}/cancelinvoice

Sets the invoice status to cancelled

POST api/invoice/{id}/uploadandattachdocument

Allows you to upload a document and attach it directly to an invoice.

PUT api/invoice/{id}/detachdocument?documentId={documentId}

Detaches a document from a invoice

Feature

Rezi Feature Api.

APIDescription
GET api/feature/{name}

Get a feature by its name

GET api/feature/list?identifiers[0]={identifiers[0]}&identifiers[1]={identifiers[1]}

Get a list of features by a list of ids

GET api/feature/suggest?name={name}

Get feature suggestions for value

CustomField

Rezi Custom Field Group Api

APIDescription
POST api/customfield/{save}

Save a custom field within a predefinied custom field group.

POST api/customfield/value/save

PUT api/CustomField

Tag

Rezi Tag Api.

APIDescription
GET api/tag/{name}

Get a tag by its name

GET api/tag/list?identifiers[0]={identifiers[0]}&identifiers[1]={identifiers[1]}

Get a list of tags by a list of ids

GET api/tag

No documentation available.

GET api/tag/suggest?name={name}

Get tag suggestions for value

POST api/tag/Save

InboundLead

APIDescription
PUT api/inboundlead/discardthelead?leadId={leadId}

Discard the Lead.

GET api/inboundlead/checkformatchinggroups?leadId={leadId}&pageSize={pageSize}&pageNumber={pageNumber}

Check for Matching groups for the given leads based on contact item values i.e. Emails and Phones.

PUT api/inboundlead/{todoTaskLeadId}/setleadgroup/{groupId}

Endpoint to update group on inbound lead task

POST api/inboundlead/create?assignToNegId={assignToNegId}

Creates a lead in the system, optinally assigning the lead to a negotiator

GET api/inboundlead/getlead/{id}

Gets a lead by its id

GET api/inboundlead/outstanding

Gets all leads that are awaiting to be processed

TemporaryDocument

Rezi temporary document controller

APIDescription
GET api/TemporaryDocument?reference={reference}

Loads the file from the scratch disk

ExternalProvider

Manages external providers

APIDescription
GET api/ExternalProvider?externalProviderId={externalProviderId}

Returns a URL that will start the process of authorisation with the external provider - normally using the OAuth1/2 protocol suite.

Peppermint

Allows you to create legal referrals

APIDescription
POST api/Peppermint

Submits a referral to dezrez legal