Skip to main content
Each entry lists the changes introduced in that API version. See API versioning for how to upgrade and roll back. Versions are listed newest first.
​
  • Added automatic_deposit and requires_external_transfer — The automatic_deposit and requires_external_transfer fields have been added to the deposit object. automatic_deposit reports whether automatic scheme registration is enabled, the latest provider status, and the last registration error. requires_external_transfer is true when a GB custodial deposit still needs to be transferred to a scheme. (deposit)
​
  • Added request.actor field — The request.actor field has been added to the event object, identifying the user, agent, or API key that caused the event. (event)
​
  • Added late_fee billing reason — The billing_reason field on the invoice object now includes late_fee, used when an invoice is created to charge a late payment fee. (invoice)
  • Added variables field — The variables field has been added to the letter template object, and matching variables.\<key\> paths are included in merge_fields. (letter_template)
  • Added variables field — The variables field has been added to the letter object for custom template values. (letter)
​
  • Nested expense and fee (breaking) — The expense_code, fee_code, and fee_discount fields have been replaced by nested expense and fee objects. fee.discount is { end, percent_off } instead of a percentage number. expense and fee are omitted when they do not apply to the collection type. (account_collection)
  • Added application field — The application field has been added to the enquiry object. It holds the ID of the application the enquiry was converted into, set when an application is created with enquiry. (leads.enquiry)
  • Added portal field — The portal field has been added to the enquiry object. It is present when source is portal and is polymorphic on type. The first supported type is rightmove, with portal-specific details under rightmove. (leads.enquiry)
  • Added SLA and on-hold fields — The first_responded_at, on_hold, and sla fields have been added to the maintenance issue object. on_hold is a nested object with at and reason, or null when the issue is not on hold. sla is a nested object with paused_seconds, resolution_due_at, response_due_at, and status. (maintenance.issue)
  • Nested availability fields (breaking) — The availability_days, availability_every_day, and availability_time_slots fields have been replaced by a nested availability object. availability is null when availability has not been set. (maintenance.issue)
  • Nested triage fields (breaking) — The triage_enabled, triage_portal_completion_session, and triage_resolved fields have been replaced by a nested triage object. triage is null when triage is not enabled. (maintenance.issue)
  • Added consumer_link and source fields — The consumer_link and source fields have been added to the resident object. consumer_link is one of none, pending, linked, or rejected and reports whether the OneMove user has confirmed they live at the building. source is manual or tenancy. (resident)
  • Added apply_url — The apply_url field has been added to the unit object. It contains the public URL an applicant can use to apply for the unit, and is only present while the unit is released to the market and self-serve applications are enabled on the account. (unit)
  • Added availability and active_tenancy_end — The availability object has been added to the unit object, describing the letting state of the unit (to_let, coming_available, held, under_offer, and so on) alongside the release decision behind it. The end date of the occupying tenancy is also now exposed as active_tenancy_end. (unit)
​
  • Added videos field — The videos field has been added to the maintenance issue object. (maintenance.issue)
​
  • Added liability field — The liability field has been added to the dispute object. (dispute)
​
No changes to existing objects.
​
No changes to existing objects.
​
Initial version.