Every Abide.Rent operation, as a tool for your AI assistant.

Lists the properties in the account with the current tenant, rent (in pence), rent review date, occupancy, service level and PRS Database numbers.

Returns just the ids of every property matching the same search and filters as list_properties, without paging, for working through many properties at once (for example before a bulk job).

Returns one property in full: its tenancies and occupiers, rent history, deposit, certificates, PRS Database numbers, management agreement and service level, the landlord duties checklist and the 0 to 100 compliance score with the items behind it.

Adds a property to the account, optionally with its landlord, current tenant and tenancy, and the dates of its gas safety record, EICR, EPC and deposit.

Changes a property's details (address, type, PRS Database numbers, EPC, council tax, MEES exemption), archives or restores it, or changes its current or incoming tenancy (rent, dates, statement of terms, leaving).

Records a new tenancy on a property, with its lead tenant and starting compliance dates.

Adds a joint named tenant, a permitted occupier or a guarantor to the current tenancy on a property.

Sets what the agency does on a property (let only, rent collection, fully managed, guaranteed rent, or managed by the landlord) and whether the landlord passed the Right to Rent and gas safety duties to the agency in writing (the two accepted-in-writing flags are refused with 422 while the property is under a written management agreement, because those duties follow the agreement's terms: change them with update_management_agreement instead).

Records (or withdraws) that a property has no gas supply or gas appliances, so no gas safety record is expected and the compliance score stops counting it as missing.

Records why the 12-month restriction on re-letting after possession for sale or a family move (Housing Act 1988 s.16F) does not apply, so a new tenancy can be added.

Records that the property was sold with the tenants in place: the buyer becomes the landlord from the completion date.

Offers to move a property's management to another agency, named by email or by an id from get_handover_agent.

Checks an agency you already know (one you have a seat in, or one managing a property you can see) by email or id and returns its name, before offering it a property with hand_over_property.

For a landlord on the title, claims a property an agency added for them, so it appears in their own landlord workspace.

Returns the property's cover photo as an image, if one was added.

Sets or replaces the property's cover photo (JPEG, PNG or HEIC).

Removes the property's cover photo.

Lists the emails about a property that this account sent or received, newest first, 50 to a page, with delivery status but not the message body (get_email_message opens one).

Imports properties (with landlords, tenancies and certificate dates) from CSV text.

Lists the tenants, occupiers and guarantors on properties this account can see, with their tenancies.

Returns one tenant, occupier or guarantor with every tenancy they are on in this account's properties.

Finds existing tenants and occupiers by name or email, to reuse their record (by id) when adding a tenancy or occupier instead of creating a duplicate.

For a landlord, lists the agencies managing their properties, with which properties and at what service level.

For a landlord, returns one of their agencies with the properties it manages for them and its terms with this landlord.

Lists the team roles on a property (lead, backup, progressor, maintenance), who answers for it today (cover included) and any handover note.

Gives a team member a role on a property (lead by default, or backup, progressor, maintenance), replacing whoever held it.

Ends one team role on a property, from today.

Lists other agencies given access to work on a property, and until when.

Sets the last day another agency's access to a property lasts.

Ends another agency's access to a property today.

Lists offers to change a property's managing agent, incoming (to this agency) and outgoing (made by this account), with their status.

Takes on a property offered to this agency.

Declines a property offered to this agency.

Takes back an offer this account made to move a property to another agency, before it is answered.

Returns an offer to carry a property's record over when an account changes (a landlord claiming it, or a handover), for the offering account or the person it was made to.

Accepts an offer to carry a property's record (its next review date and file) over to you.

Lists the read-only links this account made to a property's compliance record (for a solicitor, buyer or insurer), live and ended, and who each was for.

Stops a read-only share link to a property's record working, at once.

Lists the agency's landlord clients (people and companies) with their properties, contact details and whether they have a current tenancy.

Returns one landlord client with their properties, contact details, address for notices, statement settings and management agreements.

Finds existing landlords by name or email, to reuse their record when adding a property instead of creating a duplicate.

Records a landlord's address in England and Wales for notices, used on the written statement, on rent demands (Landlord and Tenant Act 1987 s.47 and s.48) and in the deposit prescribed information.

For a landlord account, returns its own payer and any company on its titles that the person directs, each with its key and the address recorded for notices.

Lists the monthly compliance statements this agency has written for one landlord, newest first, and whether the monthly statement is switched on for them.

Shows what a month's compliance statement for a landlord would say now (each property's score, what is due and who is on it) without saving or sending it.

Writes a month's compliance statement for a landlord now, keeps the PDF on file and tells the landlord it is ready in their portal.

Switches the automatic monthly compliance statement on or off for one landlord.

Lists monthly compliance statements: for an agency, the ones it wrote; for a landlord, the ones written about them (or a company they direct) by any agency.

Returns one monthly compliance statement as written: each property's score, what was due and done, and who was responsible.

Returns a monthly compliance statement as the PDF that was kept on file.

Lists the landlords (by person id) who are sent the weekly summary email.

Switches on the weekly summary email for one landlord.

Switches off the weekly summary email for one landlord.

For a landlord account, lists every property it owns that is not archived, with the agent managing it, the tenancy, rent, compliance score and what is due.

Lists management agreements between the agency and its landlords: reference, landlord, start and end, fees, who holds client money and the deposit, authority to serve notices, and the properties linked now and before.

Returns one management agreement with all its terms, the linked properties and whether a signed copy is held.

Records a management agreement between the agency and a landlord with its terms (fees, notice period, who holds client money and the deposit, whether the agency may serve notices, duties accepted in writing) and links the properties it covers, setting their instruction.

Changes a management agreement's terms, links more properties or unlinks one, or attaches the signed PDF.

Ends a management agreement today.

Returns a management agreement as a PDF (base64) - the signed copy where one is held, or the record Abide.Rent keeps of its terms.

Returns what was done on the landlord's properties in a period, by whoever manages them: notices served and the tenants' answers, safety records added and given to the tenant, deposits protected and the prescribed information served, repairs reported, closed or overdue, inspections, Right to Rent checks and PRS registrations, each with the account that did it.

Returns a tenancy's move-in or move-out checklist: each step (documents given, deposit protected, meter readings, keys, inventory, forwarding address, deposit return and so on) with whether it is done, when and by whom, which steps the tenant can confirm, and the sign-offs.

Marks one manual step on a move-in or move-out checklist as done, on a date, with a note.

For the landlord side, marks a checklist step as not done.

Signs off a move-in or move-out checklist.

Lists a tenancy's inventory and check-in reports and check-out reports, with the date, who prepared them, the files, whether they were sent and each tenant's answer.

Adds an inventory and check-in report or a check-out report to a tenancy as a draft, with its files (the PDF and photos, at most 40).

Changes an inventory or check-out report's details until it is sent.

Deletes an inventory or check-out report that was never sent.

Adds files (the report PDF, photos) to an inventory or check-out report until it is sent.

Returns one file from an inventory or check-out report (the PDF or a photo).

Removes one file from an inventory or check-out report that has not been sent.

Sends an inventory or check-out report to each named tenant to confirm or comment within the response period.

For a named tenant, confirms an inventory or check-out report sent to them, or comments on it.

Lists the Right to Rent checks recorded on a tenancy: who was checked, when and how, the result, any time limit and follow-up date, and the evidence kept.

Records a Right to Rent check on an adult occupier: the date, method (Home Office share code, original documents or an identity service provider), result and the evidence kept.

Lists each guarantor on a tenancy with their signed guarantees (date, whether executed as a deed, the file), and the reminder that a guarantor is told of rent increases.

Records a guarantor's signed guarantee with its date, whether it was executed as a deed, and the signed copy.

Returns the signed copy of a guarantor's guarantee (a PDF or image).

Returns, for each named tenant, whether they agreed to be served notices by email, where that comes from (the tenancy agreement or written consent), when and at which address.

Records that a named tenant agreed to be served notices by email at an address, from the tenancy agreement or their written consent, or records that they withdrew it.

Records the address a tenant can be contacted at after the tenancy ends, where the deposit is returned.

Records that a joint tenant, permitted occupier or guarantor has left on a date: from then they are not sent notices or letters and cannot act on the tenancy.

Returns the property a tenancy belongs to (tenancy_id and property_id), for following a tenancy id to its property with get_property.

Lists incidents recorded on a tenancy (anti-social behaviour, breaches, warnings given) with dates and accounts, kept as possession evidence.

Records an incident on a tenancy (anti-social behaviour, a breach of the tenancy, or a warning given) with the date and a factual account, kept as possession evidence.

Lists legal and contractual deadlines, soonest first: certificate renewals, deposit protection and prescribed information, notice dates, inspections, right to rent and more, each with its legal basis, due date and status (overdue, due soon, upcoming).

Emails a reminder about one deadline that is due soon or overdue to the others recorded on it (landlord, agency or tenant, as the duty says).

Assembles and keeps a sealed evidence pack (with a SHA-256 fingerprint) of every deadline on one property, tenancy, pet request or notice and how each was met, for a dispute or tribunal.

Returns the duty matrix for one property: each legal duty (gas safety, electrical safety, deposit, right to rent, repairs, notices and so on), whether the agency or the landlord answers for it under the management agreement, and its current state.

Returns readiness for the Private Rented Sector Database (Renters' Rights Act 2025): how many properties have landlord and property registration numbers, the regional rollout windows and the earliest deadline.

Checks a property's landlord and property registration numbers against the PRS Database and records the result on the property.

Returns the register pack for one property: each item GOV.UK's "Register your rental property" service will ask for (landlord names and address for service, the property's address, type and bedrooms, gas, EICR and EPC records, any licence), marked ready or missing with what to fix, the region's window and deadline, and the yearly fee.

Lists the workspace's open legal holds (newest 50): records kept from deletion because of a live notice, tribunal referral, possession claim or deadline evidence, with the record held and whether the hold can be lifted by hand.

Places a legal hold on a property, tenancy, notice or certificate so it and its evidence are not deleted.

Lifts a legal hold so normal retention applies again.

Lists gas safety records, EICRs, EPCs, licences and other certificates with their expiry dates and whether the current tenants have been given a copy.

Returns counts of expired, expiring and valid certificates, and the properties missing a gas safety record, EICR or EPC, across every property this account can see.

Returns one certificate in full: kind, dates, number, issuer, rating, the file, every copy given to tenants (current and earlier tenancies) and whether it can be deleted.

Returns the certificate's file (usually a PDF).

Adds a certificate to a property, with its file (a PDF of at most 10 MB) or as a placeholder until the file arrives.

Corrects a certificate's dates, number, issuer or rating, or attaches the file to a placeholder.

Deletes a certificate entered by mistake.

Gives the current tenants a copy of a certificate (or gives it again), recording when, so there is proof they received it.

Reads up to 10 certificate PDFs and suggests, for each, the kind, dates, number and the property it belongs to, with a confidence and a token.

Saves the rows from read_certificate_files that the person has checked, each as a certificate on its property, exactly as a single upload would (tenants are given their copies).

Lists memberships and registrations with renewal dates: redress scheme, client money protection, ICO fee, PI insurance, trade body, Landlord Ombudsman.

Records a membership or registration with its provider, reference and renewal date, so it is reminded before it lapses.

Changes a membership or registration's provider, reference, dates or note, for example after renewing it.

Removes a membership or registration recorded by mistake or no longer held.

Lists every inspection on a property, booked and carried out, with the kind, the visit date and the notice given to the tenants, and whether a report is attached.

With visit_at, books an inspection visit and gives the tenants written notice now (by email, or flagged to give by hand or post when there is no email).

Records that a booked inspection took place, on which day, with notes and the report.

Returns the report attached to one inspection, as its file name and base64 contents.

Lists repeating inspection schedules (every so many months), with the next date and how far ahead a task is created for it.

Sets a property to be inspected every so many months.

Changes how often a repeating inspection happens, its next date or lead time, or pauses and resumes it.

Removes a repeating inspection schedule.

Lists repairs with their severity, status, target date and whether they are overdue, open ones first.

Returns one repair in full: what was reported, severity and target date, every status change and note, photos and the contractor jobs raised for it.

Records a new repair on a property or tenancy and sets its target date from the severity and the account's repair settings.

Changes a repair's title, description, location, category or severity.

Moves a repair on (acknowledged, visit booked, in progress, fixed, closed) and records a note.

Adds a note to a repair's history for the team, the landlord or the tenant.

Adds photos to a repair, up to the repair's limit, at most 5 MB each.

Returns one photo attached to a repair, as an image.

Returns every email and message about a repair and its contractor jobs, with when each was sent, delivered and opened.

Records the tenant's answer to "Is it fixed?" on a repair marked fixed.

Returns how quickly this account aims to deal with emergency, urgent and routine repairs.

Changes the target times for emergency (hours), urgent (days) and routine (days) repairs.

Lists this account's contractors with their trades, contact details, registration numbers and insurance expiry.

Returns one contractor in full, with their trades, areas covered, Gas Safe or electrical scheme number, insurance expiry and recent jobs.

Adds a contractor to this account so jobs can be sent to them.

Changes a contractor's details, trades, areas, registration numbers or insurance expiry.

Archives a contractor so no new jobs go to them.

Searches Google for local businesses of a trade near a postcode district or a property, to add with create_contractor.

Lists jobs sent to this account's contractors with their status, property, visit date, cost and files returned.

Returns one contractor job in full: what it is for, the contractor, the visit, cost, approval, notes from the contractor and the files they returned (certificates, invoice).

Raises a job for one of this account's contractors, for a repair, a certificate renewal, an inspection or other work at a property.

Changes a job's due date, notes, cost or trade, books or calls off the visit, adds a note for the contractor, or attaches the invoice.

Emails the contractor a new link to the job, where they accept it, book the visit and upload certificates or the invoice without an account.

Cancels a job.

Marks a sent job done when the work is finished but the contractor did not mark it on their link (for example it expired).

Stops the contractor's current link to a job working, for example if it was sent to the wrong address.

Accepts a certificate (gas safety, EICR, EPC…) a contractor uploaded to a job and saves it on the property, replacing the current one of that kind.

Rejects a file the contractor uploaded, with a note telling them what is wrong so they can upload it again on their link.

Returns a file a contractor uploaded to a job (certificate, photo or invoice).

Returns every email about a contractor job (to the contractor and to the occupiers) with when it was sent, delivered and opened.

Asks the landlord to approve a job that costs more than their maintenance limit in the management agreement.

Records that the landlord approved a job outside Abide.Rent (by phone or email), with a note of how and when.

For a landlord, lists contractor jobs on their properties that cost more than their maintenance limit and wait for their decision.

Records a landlord's decision on a job above their maintenance limit: approve it, decline it, or send a question back.

Marks one stage of a hazard repair done where the account works to the Awaab's Law stages (proposed for private renting, not law yet): make safe, investigate, written summary or start works.

Lists rent reviews with the current and proposed rent (in pence), the area band and risk, the landlord's approval and the proposed start date.

Returns just the ids of every rent review matching the same filters as list_rent_reviews, without paging.

Returns one rent review in full: the evidence behind the band, the risk at tribunal, the landlord's approval history, any counter-offer and reply, and the Form 4A it led to and what happened after it was served.

Prices a Section 13 rent increase for a tenancy: records the proposed rent and start date, the evidence band for the area and the risk at tribunal, and checks the date against the notice and 52-week rules.

Changes the proposed rent or start date on a review.

Returns the comparable lettings attached to a rent review, each graded strong, usable, weak or decision against the home under review (bedrooms, kind of home, distance, how recently let), with the evidence summary: strong count, the middle of the adjusted rents, where the proposed rent sits, whether the bundle has the three strong lettings it needs, and the account's own lettings that could be added.

Returns one comparable letting with its rent, monthly equivalent, adjustments, grade, distance, the reasons it matches and where it differs from the home under review.

Adds a letting of a similar home as evidence for a rent review.

Adds one of the account's own lettings (still let or since ended) as an achieved-rent comparable, with its address, size and the rent agreed when it was let.

Changes a comparable letting's details, rent, date let or adjustments, or attaches its evidence file.

Takes a comparable out of the review's evidence and its bundle.

Returns the evidence file attached to a comparable letting (an agent's letter or a let-agreed listing), as base64 with its file name and type.

Sends a priced rent review to the landlord for approval.

Emails the landlord a reminder that a rent review is waiting for their decision.

For the landlord on the title, approves the proposed rent and start date so the agency can prepare the Form 4A.

For the landlord on the title, declines the proposed increase.

For the landlord on the title, sends a question back to the agency about a proposed increase instead of deciding.

For the landlord on the title, proposes a different rent or start date.

Takes the landlord's counter-offer (rent and start date) as the approved proposal, ready for the Form 4A.

Answers the landlord's question or counter-offer on a rent review and asks them to decide again.

Cancels a rent review that will not go ahead.

Returns the rent range the evidence supports for a postcode district and number of bedrooms, from the agency's own lettings, the ONS private rents index and Local Housing Allowance, with its sources.

Returns what is known about rents in a postcode district: the local authority and Broad Rental Market Area, tribunal decisions there (count, share cut, median rents, median wait), the market figures, the agency's band and the account's own properties in the district.

Lists published First-tier Tribunal (Property Chamber) rent determinations under the Renters' Rights Act: the proposed, existing and determined rent, the outcome and the postcode district.

Returns just the ids of every tribunal decision matching the same search and filters as list_tribunal_decisions.

Returns one tribunal rent determination with what was proposed, what was decided and why, as published.

Returns the published decision document for one tribunal rent determination.

Returns, for each postcode district, how many tribunal rent decisions there are, how many cut the rent, and the median determined rent in pence.

Returns the reference figures Abide.Rent shows, each with its source and date: the tribunal application fee, the median wait for a decision, and the share of decisions set below the landlord's proposal.

Lists tenants' applications against served rent increase notices that are still open, soonest statement first: the forum (First-tier Tribunal, or the Valuation Office rent service once it starts), case reference, date applied, the landlord's statement due date, any inspection or hearing, and the next step.

Returns one referral with its dates, the papers on file (directions, statements, letters) and the next step.

Records the tribunal's case reference, an inspection date, a hearing request or date, a note, or attaches a paper.

Records the directions the tribunal sent: when they arrived, when the landlord's statement and evidence are due (which becomes a deadline on Today, the calendar and the daily email), when the tenant's is due, and whether the case will be decided on the papers.

Returns a first draft of the landlord's statement from the records: the notice, the property and its condition (with the tenant's improvements and damage kept apart, which the tribunal disregards), the comparable lettings with their adjustments, and published decisions for similar homes, plus the gaps to fix.

Records that the landlord's statement was sent, the date and how (email, post, the tribunal's portal or by hand), with the statement exactly as sent, so the record shows what the tribunal received.

Returns one paper kept on a referral (the directions, a statement or a letter), as base64 with its name and type.

Lists notices and documents of record: Form 4A rent increases, Section 8 notices (Form 3A), tenants' notices to quit, written statements, change-of-management letters and evidence packs, with the service date, proposed rent and the tenant's response.

Returns one notice or document in full: its figures and dates, how and when it was served, proof of service, the tenant's response and questions, the tribunal risk for a Form 4A, any legal hold, and what happened after service.

Prepares a draft notice on the official form: a Form 4A rent increase (Section 13) from an approved rent review, or a Section 8 notice (Form 3A) with its grounds and particulars.

Records a Form 4A or Section 8 notice that was served outside Abide.Rent, with the day and way it was served and the tenant's answer if any, so its dates and the 52-week rule count.

Deletes a notice that was prepared but not served.

Returns a notice's PDF (base64) with whether it is the official GOV.UK form, a readable copy where an older layout is hard to read, its text, and a short-lived download link.

Lists the emails sent about a notice (service, reminders, copies), with when each was delivered and opened.

For a named tenant, answers a Form 4A rent increase: accept it, say they will refer it to the First-tier Tribunal, or ask the landlord a question.

Answers a question a tenant asked about a notice.

For a Form 4A drafted without a rent review, where the landlord must approve the figure first: opens a rent review at the notice's figures, ties the notice to it and asks the landlord to approve, so it need not be drafted again.

Adds evidence that arrived after service (a proof of delivery, certificate of posting, receipt, photo or witness statement) to a served notice.

Returns one proof-of-service file on a notice, as its file name, type and base64 contents.

Returns what happened to a served Form 4A: withdrawn, varied by written agreement, referred to the tribunal and the decision, or no application made, with the rent that applies and from when.

Records what happened to a served Form 4A, with its written evidence: withdrawn; varied (a different rent or date agreed in writing with every named tenant, s.13(4)(b)); a tribunal application made or withdrawn; the rent the tribunal determined (never more than proposed); or no application made.

Returns one evidence file recorded with a notice's outcome, as its file name, type and base64 contents.

Records that a served Form 4A's new rent has taken effect and puts it on the tenancy.

Lists the possession steps recorded on a Section 8 notice (claim issued, hearing, order, warrant, possession recovered) with dates and court references.

Records a step in possession proceedings on a Section 8 notice.

Returns the tenant's notice to quit on a tenancy with its dates, replies, any written agreement to an earlier end, withdrawal, and the evidence on file.

For a named tenant, gives notice to end their tenancy, with the date it is given and the end date.

For the landlord side, confirms a tenant's notice to quit was received, or sends a question about it.

For the landlord side, records a tenant's notice to quit that arrived on paper or by email, with who gave it, when, the end date and a copy.

Records the landlord's written agreement that a tenancy ends earlier than the tenant's notice says.

Records one side's agreement to withdraw a tenant's notice to quit.

For a named tenant, replies to the landlord side's question about their notice to quit.

Lists the emails sent about a tenant's notice to quit, with delivery times.

With a PDF and the date it was given, records the written statement of terms given to the tenants outside Abide.Rent.

For a named tenant, confirms they received the written statement of terms.

Lists the emails sent about a tenancy's written statement of terms, with delivery times.

Records whether a deposit was taken on a tenancy and, if held, its amount, the day it was received, the scheme (DPS, mydeposits or TDS), when it was protected and when the prescribed information was served.

Records a relevant person: someone other than the tenant who paid the deposit (a parent, say), who must also be given the prescribed information.

Gives the current named tenants (and any relevant person) the deposit's prescribed information through Abide.Rent, with the scheme's PDF if attached, and records the date.

Returns the proof that the deposit was paid (a bank statement or receipt) as its file name, type and base64 contents.

Attaches the proof that the deposit was paid, replacing any earlier one.

Removes the proof of payment attached to a tenancy's deposit.

For a named tenant, lists the deposit prescribed information given to them through Abide.Rent, with the scheme, amount and whether they have confirmed receipt.

For a named tenant, returns the deposit prescribed information PDF given to them (base64).

For a named tenant, confirms they received the deposit prescribed information.

Lists the holding deposits taken on a property's proposed tenancies (Tenant Fees Act 2019), newest first: amount, payer, the deadline for agreement, what happened, and whether it was repaid or kept with written reasons.

Records a holding deposit taken for a proposed tenancy: at most one week's rent, with who paid it and the deadline for agreement (the 15th day beginning with the day it was received, unless another is agreed in writing).

Changes a holding deposit's details while it is still held (not yet applied, repaid or kept).

Records what happened: the tenancy agreement was entered into, the landlord decided not to proceed, or the deadline passed; and whether it goes towards the first rent or the deposit (with the payer's consent), is repaid, or is kept for a reason the Tenant Fees Act allows.

Records that a holding deposit was repaid to the payer, on which day and with which payment reference.

Prepares the written reasons for keeping a holding deposit as a PDF, from the recorded reason and facts.

Returns the prepared letter of reasons for keeping a holding deposit as a PDF (base64) with its SHA-256 fingerprint.

Records that the written reasons for keeping a holding deposit were given to the payer, when and how.

Returns the live end-of-tenancy deposit settlement on a tenancy: its status, each proposed deduction with evidence, each tenant's answers, the landlord's approval, any lead tenant, scheme referral and release.

Starts settling a tenancy's deposit at the end of the tenancy.

Adds a proposed deduction to a deposit settlement with its category, description, amount and up to 6 evidence files (photos, invoices, the check-out report).

Changes a proposed deduction or adds evidence.

Removes a proposed deduction from a deposit settlement while it can still be changed.

Returns one evidence file on a proposed deduction (a photo, invoice or report).

Sends the proposed deductions out.

For a landlord on the title, approves the agent's proposed deductions so they go to the tenants.

For a landlord on the title, sends the agent's proposed deductions back with what should change.

For a named tenant, agrees or disputes each proposed deduction (a dispute needs a reason).

Records one joint tenant as the lead tenant who answers the deductions for all, with how each of the other tenants agreed to that.

Removes the lead tenant from a deposit settlement so each joint tenant answers for themselves.

Records that the disputed deductions were referred to the deposit scheme's dispute service, with its reference.

Records what the scheme's adjudicator awarded for each deduction (0 if nothing) and the decision date, which settles the deposit.

Records that the agreed deposit was released, on which day, with the split between landlord and tenants.

Cancels a deposit settlement that is being prepared or was disputed, so a new one can be started.

Returns a tenancy's rent account: each rent period due, payments and reversals, the running balance, and where the Section 8 Ground 8 arrears test stands.

Returns a tenancy's rent account as a PDF statement (base64), suitable as evidence of arrears.

Starts keeping a tenancy's rent account in Abide.Rent from a date, with any balance owed (or in credit) on that date.

Changes the day a tenancy's rent account starts or its opening balance.

Records money received against a tenancy's rent, with the day, amount, method and reference.

Reads a CSV of one tenancy's payments (date, amount, reference; a bank export trimmed to the tenant) and says, row by row, which match a rent period, which are part payments, which are duplicates and which are invalid.

Saves the good, new rows of a CSV of one tenancy's payments to its rent account in one go, skipping duplicates and invalid rows.

Reverses a payment recorded in error by adding a reversal row with the reason.

Lists the arrears periods recorded by hand on a tenancy that has no rent account in Abide.Rent: each period's rent due, paid and Universal Credit pending.

Records one rent period's amount due and paid on a tenancy whose rent account is kept outside Abide.Rent.

Returns every current tenancy the workspace manages with its address, lead tenant, rent and annual rent, the total annual rent and the rent roll for each of the last 12 months.

Returns the workspace's Abide.Rent plan, trial, limits and usage, and the plan changes open to it.

Says what moving to another Abide.Rent plan would charge and when, with an optional promotion code.

Says whether a promotion code is valid for this workspace and what it would take off the first invoice it applies to.

Returns the workspace's referral code and link and how its referrals are doing.

Lists the invoices Abide.Rent issued to this workspace for its subscription and packs, newest first, with amounts, VAT and status.

Returns only the ids of the Abide.Rent invoices matching the same search and filters as list_invoices.

Returns one Abide.Rent invoice with its lines, VAT, totals and payment status.

Returns an Abide.Rent invoice's PDF: a link to Stripe's PDF or hosted invoice page (with the sequential number and VAT breakdown) where Stripe issued it, otherwise the PDF itself (base64).

Lists pet requests, the soonest answer date first: the pets, when asked, the date an answer is due, any further information asked for, a superior landlord's consent, and the decision.

Makes a request to keep one or more pets on a tenancy: a named tenant asks for themselves, or the managing account records a request the tenant made another way.

Asks the tenant for further information about a pet request, on or before the 28th day.

Records the further information asked for: a tenant sends it through the portal; the landlord side records what arrived another way (email, post or by hand) and the day it arrived.

Records that the consent of a superior landlord (such as the freeholder of a flat) was sought for a pet, whether they replied, and whether they granted it.

Gives the landlord side's written decision on a pet request: approved, or refused with a written reason.

For a named tenant, withdraws their open pet request.

Lists the emails sent about a pet request, with delivery times.

Lists documents drafted from a template and signed in order (statements of terms, management agreements, consent and cover letters), with status and who still has to sign.

Returns one document for signature with its wording, field values, each signer's turn and status, and the audit of sending and signing.

Drafts a document from one of the workspace's templates for a tenancy, property or management agreement, with its signers in order and the template's fields filled in.

Changes a draft document's title, wording, field values or signers before it is sent.

Sends a draft for signature: the first signer (or every named tenant together on a statement of terms) is asked to sign, in the app or by an emailed link.

Asks every signer whose turn it is to sign again (an emailed signer gets a new link).

Cancels a draft or a document still out for signature.

Starts a new draft from a document a signer declined, or one that was cancelled (or signed, to issue afresh), with the same wording, values and signers in the same order.

Lists every saved version of a document's wording, newest first, with who saved it and when.

Lists the comments the people on a document left about it, oldest first.

Adds a comment to a document for the other people on it to read, such as a question about a clause.

Returns a document as a PDF (base64) with its SHA-256: the signed copy, checked against the hash recorded when it was signed, or a preview while it is unsigned.

Lists the workspace's document templates (statement of terms, Information Sheet cover letter, pet consent letter, management agreement, privacy notice, rent receipt letter and its own), starter templates first.

Lists the {{fields}} a template can use (tenant names, address, rent, deposit, dates and so on), grouped, with labels.

Returns one document template with its full wording and the fields it uses.

Creates a document template from wording with {{field}} placeholders.

Changes a template's name, kind or wording.

Archives a document template so it is no longer offered.

Makes an editable copy of a template, such as a starter template to adapt to the workspace's own wording.

Lists every saved version of a template with its wording, who saved it and when.

Lists the workspace's reusable clauses (at most 50) to insert into a template or a draft document.

Adds a reusable clause to the workspace's clause library.

Changes a clause in the library.

Archives a clause so it is no longer offered in the library.

Returns one email sent from Abide.Rent with its recipients, subject, body and delivery events (delivered, opened, bounced).

Lists replies people sent to official emails from Abide.Rent (notices, letters, requests), routed to the person responsible for the property.

Marks a reply to an Abide.Rent email as answered.

Lists notes the workspace can read, newest first (50 at a time): notes on a property or one of its records, a landlord, an agreement or an invoice.

One row per property with notes, latest activity first (30 per page), with counts and the latest note.

Lists the notes currently pinned (such as access instructions or a warning), optionally on one property.

Lists the notes that mention you, unread first.

Marks notes that mention you as read; all of them when no ids are given.

Lists the people who can be mentioned in a note (colleagues; on a shared note, also the landlord or managing agency), with whether this workspace may share notes there.

Adds a note to a property, one of its records, a landlord, an agreement or an invoice.

Edits your own note within 15 minutes of writing it.

Removes a note's wording, keeping a record that it was redacted, by whom and why.

Pins a note to the top of its record (optionally until a date) or unpins it.

Lists tasks on properties you can see (100 at a time): yours by default, or ones you follow, set, or everyone's; open by default.

Returns one task with its details, owner, due date, the record it is on and its full history.

Creates a task for yourself or a colleague, with a due date, on a property or one of its records.

Changes a task's title, details, due date or owner.

Marks a task done, with a short note of the evidence (what was done, where it is filed).

Cancels a task with a reason.

Reopens a task that was done or cancelled.

Follows a task so you are told when it changes or is done.

Stops following a task, so you are no longer told when it changes.

Says how many properties would move from one person to one or more colleagues, and to whom, spread by workload (a landlord's properties stay together).

Moves one person's properties to one or more colleagues as a bulk job, spread by workload (a landlord's properties stay together).

Reverses a bulk change of property manager made in the last 24 hours, as a new bulk job.

Hides one invoice or audit event from your own lists (only for you; nothing is deleted).

Shows a row you hid in your lists again.

Lists the workspace's reports and registers, each with a one-line description and a live count, so you can pick one for run_report.

Runs one workspace report over every property this workspace can see and returns its rows, columns and summary.

Lists tenancies whose rent is below the local band for similar homes and whose next increase could be given within a number of days, with the gap and the earliest date.

Returns the home dashboard: headline figures (properties occupied and vacant, certificates expiring or missing, approvals waiting, live tribunal cases, open notices), the compliance score, PRS Database readiness, what needs a decision, and the rent roll for seats allowed to see it.

Returns one prioritised list of what needs doing today: overdue duties, those due this week, open pet requests, tenants' notices to confirm, notices not yet signed, rent proposals waiting on a landlord, repairs and contractor jobs.

Returns everything for the properties you answer for today (you lead them or cover for the lead) - deadlines, your open tasks, replies - and how many properties have no lead.

Returns the message trail for a certificate, rent review, inspection, landlord statement, deposit, document for signature or deposit settlement: who was told what, by which channel, and when it was sent, delivered, opened or read.

With a record (auditable_type and auditable_id), returns that record's full audit history: who did what and when.

Returns how well the workspace uses Abide.Rent (a score from 0 to 100 with its parts) and what Abide.Rent did for it in the last 90 days.

Returns a short summary of a property, landlord, occupier, rent review, notice or tenancy - the few facts shown when hovering over it in a list.

Lists the workspace's team with each person's seat, properties led and other roles, cover, leave, working hours and alert setting, and how many properties have no lead.

Changes a team member's working days and hours, or whether they are alerted about all properties or only theirs.

Signs a team member out of every device, for a lost phone or a shared computer.

Lists people who have left the workspace (deactivated, not deleted), with when they left and their last seat.

Lists who has access to this workspace and their seat (owner, manager, negotiator, accounts, read-only) and whether they may serve notices.

Lists invitations this workspace sent (team, landlords, tenants, collaborators), with their status and expiry.

Returns only the ids of the invitations matching the same search and filters as list_invitations, for acting on all of them.

Emails an invitation to join Abide.Rent as a party to a tenancy or property: a tenant, joint tenant, occupier or guarantor (on a tenancy), or the landlord of a property the agency manages.

Cancels a pending invitation so its link stops working.

Lists current and future cover in the workspace - who covers whose properties, from when to when, and why.

Sets one colleague to cover another's properties between two dates (holiday, sickness), so alerts and tasks reach them.

Cancels holiday or absence cover, so alerts and tasks go back to the person.

Lists the team's leave and absence between two dates (default the next 90 days), with kind and whether cover is needed.

Records leave or absence for yourself, or for anyone if you are an owner or manager.

Removes a leave or absence entry from the team calendar.

Lists on-call shifts between two times (default the next 4 weeks) and who is on call now.

Puts a team member on call between two times.

Changes an on-call shift's times, or swaps who is on call.

Removes an on-call shift from the rota, leaving that time uncovered.

Returns the team calendar between two dates (at most 100 days): legal deadlines, tasks, contractor visits, inspections, move-ins and outs, rent reviews, leave, cover, on-call and bank holidays, optionally for one person.

Moves a task or a contractor visit to another day.

Returns the workspace's working week and hours, how early and late deadlines escalate, the reply target, and bank holidays and closure days for a year.

Changes the workspace's working days and hours, how many days before a deadline it escalates and after it is overdue, and the target for answering replies.

Adds a day the office is closed (beyond bank holidays), so working-day targets skip it.

Removes a closure day from the working calendar.

Lists the agency's branches with their members and property counts, and figures per branch.

Adds a branch with its phone and email.

Changes a branch's name, phone or email.

Archives a branch; its properties move to No branch.

Returns your own scorecard from your work records over 30, 90 or 365 days - overdue deadlines, tasks, replies and repairs on time, records kept up to date - against the targets.

Returns one team member's scorecard over 30, 90 or 365 days against the targets.

Sets one team member's scorecard targets.

Returns your own joiner steps and tips in this workspace, and which you have finished.

Marks your joiner welcome or tips as read.

Lists recent joiners and how far they are through their onboarding.

Opens the exit plan for a team member leaving on a date or now: what they hold (properties, roles, tasks, replies, on-call) and who it goes to.

Returns an exit plan with what the person holds now, who each item goes to, the handover note and the colleagues who can take work.

Changes who takes each item in an exit plan, the handover note, whether landlords are told of their new contact, or the last day.

Checks an exit plan without carrying it out and lists anything that would stop it (work with nobody to take it).

Cancels an exit plan that has not been carried out.

Starts a background export of the workspace's records as a spreadsheet (properties, tenancies with rent and status, and notices and documents with their SHA-256 and legal hold), for all properties or chosen ones.

Returns an export's status and, when it is ready, the file to download.

Lists the workspace's background data jobs (imports and exports), newest first, with status and counts.

Returns only the ids of the data jobs matching the same filters as list_data_jobs.

Returns one import or export with its status, counts, each row's outcome and whether a file is ready.

Returns the file an export (or an import's report) produced, as base64 with a short-lived download link.

Cancels an import or export that is still queued.

Lists the bulk actions offered on one list (properties, landlords, rent reviews, certificates, occupiers, notifications) and whether your seat may run each.

Runs one action over many records in the background: archive or restore properties, set their service level or manager, send landlords their statements or switch them on or off, send rent reviews to landlords for approval, give certificates to tenants, invite occupiers to the tenant portal, mark notifications read.

Lists the workspace's bulk jobs, newest first (25 a page), with what they did, their status and counts.

Returns a bulk job's status, counts (done, skipped, failed) and progress.

Lists each record in a bulk job with its outcome (success, skipped, failed) and the reason.

Returns a bulk job's outcomes as a spreadsheet (record, key, outcome, message, time).

Stops a running bulk job before the remaining records.

Starts a new bulk job over the records that failed in an earlier one.

Lists the fields a list can be filtered and sorted on, each with its type and operators, and the fields its search covers.

Suggests values for a reference field's filter (such as a landlord or tenancy), matching typed text.

Lists the saved views (named filters) on one of the app's lists, yours and those shared with the workspace.

Saves a named filter on one of the app's lists, for you or shared with the workspace, optionally as the list's default.

Changes one of your saved views' name, filter, sharing or default.

Deletes one of your saved views from an app list.

Returns the signed-in person's profile (name, email, phone, email choices), every workspace and portal they can open, and the one this connection acts in.

Changes the signed-in person's own name or phone number, or which optional emails (rent reviews, notices, billing) they get.

Returns your notification choices by category (statutory, service, nudge) and channel, and how often summaries of your work are emailed (email_summary: daily, weekly or off).

Switches notification channels on or off for the service and nudge categories, and chooses how often summaries of your work are emailed.

Lists your in-app notifications in this workspace, newest first, each linked to its property, tenancy or notice.

Returns how many of your notifications are unread, in the inbox and in support ticket updates.

Marks one of your notifications as read.

Marks all your notifications in this workspace as read, or only one topic.

Clears one notification from your inbox.

Returns the workspace's business details used on notices, letters and invoices: legal and trading names, company and VAT numbers, registered and trading addresses, contact details, redress scheme and client money protection.

Changes the workspace's business details shown on notices, letters and invoices.

Returns the logo shown on letters and the portals, as its file name, type and base64 contents.

Uploads the logo shown on letters and the portals (PNG, JPEG or SVG), replacing any earlier one.

Removes the logo from letters and the portals.

Sets the workspace's name, its branch postcode (for local rent comparisons) and roughly how many tenancies it manages.

Returns your getting-started checklist in this workspace (adding properties, certificates, the team and so on) and which steps are done.

Lists your support tickets with Abide.Rent, with status, priority and the latest activity.

Returns only the ids of your support tickets matching the same search as list_support_tickets.

Returns one support ticket with its latest messages from you and Abide.Rent support.

Opens a support ticket with Abide.Rent, with a subject, message and up to 5 attachments (screenshots, PDFs, spreadsheets, Word files, ZIP).

Lists a support ticket's messages, newest first, a page at a time.

Adds your reply to a support ticket, with up to 5 attachments.

Closes your support ticket once it is resolved.

Returns one file attached to a support ticket message.

For a tenant, lists the tenancies on which they are a current named tenant, newest first, with the address, rent, who manages it, the deposit's protection, the latest notice and pet requests.

For a tenant, returns one of their tenancies in full: the landlord or agent and how to contact them, rent, deposit (scheme, amount, protection date and reference), the notices served on them with what they can do and by when, and their pet requests.

For a tenant, lists the safety certificates given to them for their tenancy (gas safety, electrical, energy performance and others), with the dates given and whether they have confirmed receipt.

For a tenant, returns a safety certificate given to them as a PDF (base64).

For a named tenant, confirms they received a safety certificate.