Arthur Tenancies API

openapi: 3.1.0
info:
  title: Arthur Tenancies API
  version: 2.0.0
  description: Arthur Tenancies API - the tenancies surface of the Arthur API v2, the UK property management
    platform from Arthur Online (an Aareon company). Derived operation-for-operation from the provider's
    public Postman Documenter collection at https://developer.arthuronline.co.uk/. Every request is scoped
    to an Arthur entity via the mandatory X-EntityID header and authorised with an OAuth 2.0 Authorization
    Code access token.
  contact:
    name: Arthur Online API Support
    url: https://support.arthuronline.co.uk/
  termsOfService: https://www.arthuronline.co.uk/terms-and-conditions/
  x-derived-from: collections/arthur-online.postman_collection.json
  x-derived-by: API Evangelist enrichment pipeline
  x-derived-date: '2026-07-26'
servers:
- url: https://api.arthuronline.co.uk/v2
  description: Arthur API v2 production
security:
- arthurOAuth: []
tags:
- name: Tenants
- name: Assets
- name: Certificates
- name: Register Deposit
- name: Tasks
- name: Workorders
- name: Conversations
- name: Transactions
- name: Notes
- name: Tags
- name: Recurrings
- name: Tenancies
paths:
  /tenancies/{tenancy_id}/tenants:
    get:
      operationId: listTenantsOnTenancy
      summary: List Tenants On Tenancy
      tags:
      - Tenants
      parameters:
      - name: tenancy_id
        in: path
        required: true
        description: Arthur tenancy id.
        schema:
          type: integer
      - $ref: '#/components/parameters/EntityId'
      - $ref: '#/components/parameters/Page'
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/Sort'
      - $ref: '#/components/parameters/Direction'
      description: This retrieves a list of tenants related to a tenancy
      responses:
        '200':
          description: The request was completed successfully without errors.
          content:
            application/json:
              schema:
                type: object
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
    post:
      operationId: addTenantOnTenancy
      summary: Add Tenant On Tenancy
      tags:
      - Tenants
      parameters:
      - name: tenancy_id
        in: path
        required: true
        description: Arthur tenancy id.
        schema:
          type: integer
      - $ref: '#/components/parameters/EntityId'
      - $ref: '#/components/parameters/Strict'
      description: "Use this endpoint to create a new tenant on a tenancy. The API will return the saved\
        \ data and a unique tenant ID.\n\nSupported Fields \n The following fields are supported for the\
        \ request body\n\nField \n Example \n Type \n Required? \n\nmain_tenant \n True \n Boolean \n\
        \ No \n\nmove_in_date \n 2019-05-28 \n Date \n No \n\nmove_out_date \n 2019-06-28 \n Time \n No\
        \ \n\ntitle \n Mr \n Enum \n No \n\nfirst_name \n Ryan \n String \n No \n\nlast_name \n Cullen\
        \ \n String \n No \n\ndate_of_birth \n 1995-01-21 \n Date \n No \n\ngender \n Male \n Enum \n\
        \ No \n\ncitizen_type \n 1 \n Enum \n No \n\nemail \n email@gmail.com \n String \n No \n\ncompany_name\
        \ \n MyCompany \n Strong \n No \n\ncompant_address_name \n Address \n String \n No \n\ncompany_address1\
        \ \n Boundry Road \n String \n No \n\ncompany_address2 \n Wren Court \n String \n No \n\ncompany_city\
        \ \n London \n String \n No \n\ncompany_postcode \n SW94DA \n String \n No \n\ncompany_county\
        \ \n City of London \n String \n No \n\ncompany_country \n England \n String \n No \n\nphone_home\
        \ \n 029302932 \n String \n No \n\nphone_work \n 029382928 \n String \n No \n\nmobile \n 020192029\
        \ \n String \n No \n\nresidential_number \n 201 \n String \n No \n\nvisa_number \n 120-123 \n\
        \ String \n No \n\nvisa_years \n 3 \n String \n No \n\nvisa_type \n Tier 2 \n Enum \n No \n\n\
        country_of_origin \n Wales \n String \n No \n\nni_number \n KS 01 AK 11 F \n String \n No \n\n\
        kin_mobile \n 029302991 \n String \n No \n\nkin_last_name \n Cullen \n String \n No \n\nkin_first_name\
        \ \n Monica \n String \n No \n\nkin_phone_work \n 029320191 \n String \n No \n\nstudent_status\
        \ \n Full-time \n String \n No \n\nuniversity \n Oxford \n String \n No \n\ncourse_name \n Doe\
        \ Studies \n String \n No \n\ncourse_id \n 1 \n String \n No \n\ncourse_year \n 2 \n String \n\
        \ No \n\nemployment_company_name \n Lorem \n String \n No \n\nemployment_address1 \n Address First\
        \ Line \n String \n No \n\nemployment_address2 \n Address Second Line \n String \n No \n\nemployment_city\
        \ \n Liverpool \n String \n No \n\nemployment_postcode \n LN91LS \n String \n No \n\nemployment_county\
        \ \n Norfolk \n String \n No \n\nemployment_contact_name \n Grace \n String \n No \n\nemployment_contact_number\
        \ \n 0239203900 \n String \n No \n\nemployment_salary \n 90000 \n String \n No \n\nemployment_length\
        \ \n 5 years \n String \n No \n\nhousing_benefit_council \n Borought \n String \n No \n\nhousing_benefit_number\
        \ \n 19203 \n String \n No \n\nguarantor_first_name \n Nicolas \n String \n No \n\nguarantor_last_name\
        \ \n Cage \n String \n No \n\nguarantor_date_of_birth \n 1911-02-12 \n String \n No \n\nguarantor_address1\
        \ \n Address first line \n String \n No \n\nguarantor_address2 \n Address second line \n String\
        \ \n No \n\nguarantor_city \n London \n String \n No \n\nguarantor_postcode \n XP91AP \n String\
        \ \n No \n\nguarantor_county \n Suffolk \n String \n No \n\nguarantor_country \n England \n String\
        \ \n No \n\nguarantor_phone_home \n 028392871 \n String \n No \n\nguarantor_phone_work \n 028191282\
        \ \n String \n No \n\nguarantor_mobile \n 029384383 \n String \n No \n\nguarantor_email \n guarantor@email.com\
        \ \n String \n No \n\nguarantor_relation \n Brother \n String \n No \n\nguarantor_home_owner \n\
        \ Yes \n String \n No \n\nguarantor_profession \n Teacher \n String \n No \n\nbank_name \n Barclays\
        \ \n String \n No \n\nbank_address1 \n Address first line \n String \n No \n\nbank_address2 \n\
        \ Address second line \n String \n No \n\nbank_city \n Romford \n String \n No \n\nbank_county\
        \ \n Essex \n String \n No \n\nbank_postcode \n FS18LA \n String \n No \n\nref_name \n Ref Name\
        \ \n String \n No \n\nref_address1 \n Ref First Line \n String \n No \n\nref_address2 \n Ref Second\
        \ Line \n String \n No \n\nref_county \n Ref Hertfordshire \n String \n No \n\nref_city \n Ref\
        \ City \n String \n No \n\nref_postcode \n Ref Postcode \n String \n No \n\nref_contact_number\
        \ \n 029392832 \n String \n No \n\nref_relation \n Mother \n String \n No \n\napplicant_note \n\
        \ Note to remember \n String \n No \n\nmanager_note \n Manager note \n String \n No"
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                main_tenant:
                  type: boolean
                  example: true
                move_in_date:
                  type: string
                  format: date
                  example: '2019-05-28'
                move_out_date:
                  type: string
                  example: '2019-06-28'
                title:
                  type: string
                  example: Mr
                  description: Enum - see the Types API for the allowed values
                first_name:
                  type: string
                  example: Ryan
                last_name:
                  type: string
                  example: Cullen
                date_of_birth:
                  type: string
                  format: date
                  example: '1995-01-21'
                gender:
                  type: string
                  example: Male
                  description: Enum - see the Types API for the allowed values
                citizen_type:
                  type: string
                  example: '1'
                  description: Enum - see the Types API for the allowed values
                email:
                  type: string
                  example: email@gmail.com
                company_name:
                  type: string
                  example: MyCompany
                compant_address_name:
                  type: string
                  example: Address
                company_address1:
                  type: string
                  example: Boundry Road
                company_address2:
                  type: string
                  example: Wren Court
                company_city:
                  type: string
                  example: London
                company_postcode:
                  type: string
                  example: SW94DA
                company_county:
                  type: string
                  example: City of London
                company_country:
                  type: string
                  example: England
                phone_home:
                  type: string
                  example: 029302932
                phone_work:
                  type: string
                  example: 029382928
                mobile:
                  type: string
                  example: 020192029
                residential_number:
                  type: string
                  example: '201'
                visa_number:
                  type: string
                  example: 120-123
                visa_years:
                  type: string
                  example: '3'
                visa_type:
                  type: string
                  example: Tier 2
                  description: Enum - see the Types API for the allowed values
                country_of_origin:
                  type: string
                  example: Wales
                ni_number:
                  type: string
                  example: KS 01 AK 11 F
                kin_mobile:
                  type: string
                  example: 029302991
                kin_last_name:
                  type: string
                  example: Cullen
                kin_first_name:
                  type: string
                  example: Monica
                kin_phone_work:
                  type: string
                  example: 029320191
                student_status:
                  type: string
                  example: Full-time
                university:
                  type: string
                  example: Oxford
                course_name:
                  type: string
                  example: Doe Studies
                course_id:
                  type: string
                  example: '1'
                course_year:
                  type: string
                  example: '2'
                employment_company_name:
                  type: string
                  example: Lorem
                employment_address1:
                  type: string
                  example: Address First Line
                employment_address2:
                  type: string
                  example: Address Second Line
                employment_city:
                  type: string
                  example: Liverpool
                employment_postcode:
                  type: string
                  example: LN91LS
                employment_county:
                  type: string
                  example: Norfolk
                employment_contact_name:
                  type: string
                  example: Grace
                employment_contact_number:
                  type: string
                  example: 0239203900
                employment_salary:
                  type: string
                  example: '90000'
                employment_length:
                  type: string
                  example: 5 years
                housing_benefit_council:
                  type: string
                  example: Borought
                housing_benefit_number:
                  type: string
                  example: '19203'
                guarantor_first_name:
                  type: string
                  example: Nicolas
                guarantor_last_name:
                  type: string
                  example: Cage
                guarantor_date_of_birth:
                  type: string
                  example: '1911-02-12'
                guarantor_address1:
                  type: string
                  example: Address first line
                guarantor_address2:
                  type: string
                  example: Address second line
                guarantor_city:
                  type: string
                  example: London
                guarantor_postcode:
                  type: string
                  example: XP91AP
                guarantor_county:
                  type: string
                  example: Suffolk
                guarantor_country:
                  type: string
                  example: England
                guarantor_phone_home:
                  type: string
                  example: 028392871
                guarantor_phone_work:
                  type: string
                  example: 028191282
                guarantor_mobile:
                  type: string
                  example: 029384383
                guarantor_email:
                  type: string
                  example: guarantor@email.com
                guarantor_relation:
                  type: string
                  example: Brother
                guarantor_home_owner:
                  type: string
                  example: 'Yes'
                guarantor_profession:
                  type: string
                  example: Teacher
                bank_name:
                  type: string
                  example: Barclays
                bank_address1:
                  type: string
                  example: Address first line
                bank_address2:
                  type: string
                  example: Address second line
                bank_city:
                  type: string
                  example: Romford
                bank_county:
                  type: string
                  example: Essex
                bank_postcode:
                  type: string
                  example: FS18LA
                ref_name:
                  type: string
                  example: Ref Name
                ref_address1:
                  type: string
                  example: Ref First Line
                ref_address2:
                  type: string
                  example: Ref Second Line
                ref_county:
                  type: string
                  example: Ref Hertfordshire
                ref_city:
                  type: string
                  example: Ref City
                ref_postcode:
                  type: string
                  example: Ref Postcode
                ref_contact_number:
                  type: string
                  example: 029392832
                ref_relation:
                  type: string
                  example: Mother
                applicant_note:
                  type: string
                  example: Note to remember
                manager_note:
                  type: string
                  example: Manager note
      responses:
        '200':
          description: The request was completed successfully without errors.
          content:
            application/json:
              schema:
                type: object
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
  /tenancies/{tenancy_id}/assets:
    get:
      operationId: listAssetsOnTenancy
      summary: List Assets On Tenancy
      tags:
      - Assets
      parameters:
      - name: tenancy_id
        in: path
        required: true
        description: Arthur tenancy id.
        schema:
          type: integer
      - $ref: '#/components/parameters/EntityId'
      - $ref: '#/components/parameters/Page'
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/Sort'
      - $ref: '#/components/parameters/Direction'
      description: This endpoint retrieves a list of assets associated with the given tenancy ID.
      responses:
        '200':
          description: The request was completed successfully without errors.
          content:
            application/json:
              schema:
                type: object
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
    post:
      operationId: createAssetOnTenancy
      summary: Create Asset On Tenancy
      tags:
      - Assets
      parameters:
      - name: tenancy_id
        in: path
        required: true
        description: Arthur tenancy id.
        schema:
          type: integer
      - $ref: '#/components/parameters/EntityId'
      - $ref: '#/components/parameters/Strict'
      description: "Use this endpoint to create a new asset related to an  tenancy . The API will return\
        \ the saved data.\n\nSupported Fields \n The following fields are supported for the request body\n\
        \nField \n Example \n Type \n Required? \n\nasset_type \n image \n String \n No \n\nname \n inventory\
        \ \n String \n No \n\nshare_manager \n true \n Boolean \n No \n\nshare_tenant \n false \n Boolean\
        \ \n No \n\nshare_contractor \n true \n Boolean \n No \n\nshare_owner \n true \n Boolean \n No\
        \ \n\nfile \n base64 \n String \n Yes \n\nmime_type \n application/pdf \n String \n Yes \n\nfile_name\
        \ \n inventory \n String \n Yes"
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                asset_type:
                  type: string
                  example: image
                name:
                  type: string
                  example: inventory
                share_manager:
                  type: boolean
                  example: true
                share_tenant:
                  type: boolean
                  example: false
                share_contractor:
                  type: boolean
                  example: true
                share_owner:
                  type: boolean
                  example: true
                file:
                  type: string
                  example: base64
                mime_type:
                  type: string
                  example: application/pdf
                file_name:
                  type: string
                  example: inventory
              required:
              - file
              - mime_type
              - file_name
            example:
              asset_type: image
              name: name of asset
              share_manager: true
              share_tenant: true
              share_owner: true
              share_contractor: true
              file: pdf file converted to base64 string
              mime_type: application/pdf
              file_name: inventory
      responses:
        '200':
          description: The request was completed successfully without errors.
          content:
            application/json:
              schema:
                type: object
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
  /tenancies/{tenancy_id}/certificates:
    get:
      operationId: listCertificatesOnTenancy
      summary: List Certificates On Tenancy
      tags:
      - Certificates
      parameters:
      - name: tenancy_id
        in: path
        required: true
        description: Arthur tenancy id.
        schema:
          type: integer
      - $ref: '#/components/parameters/EntityId'
      - $ref: '#/components/parameters/Page'
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/Sort'
      - $ref: '#/components/parameters/Direction'
      description: This endpoint retrieves a list of certificates associated with the given tenancy ID.
      responses:
        '200':
          description: The request was completed successfully without errors.
          content:
            application/json:
              schema:
                type: object
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
    post:
      operationId: addCertificateOnTenancy
      summary: Add Certificate on Tenancy
      tags:
      - Certificates
      parameters:
      - name: tenancy_id
        in: path
        required: true
        description: Arthur tenancy id.
        schema:
          type: integer
      - $ref: '#/components/parameters/EntityId'
      - $ref: '#/components/parameters/Strict'
      description: "Use this endpoint to create a new certificate related to a  tenancy . The API will\
        \ return the saved data.\n\nSupported Fields \n The following fields are supported for the request\
        \ body\n\nField \n Example \n Type \n Required? \n\ntype \n Boiler Service \n String \n Yes \n\
        \nexpiry_date \n 2023-12-05 \n String \n No \n\nnotes \n Fully assessed \n String \n No \n\nfile\
        \ \n Base64 \n String \n No \n\nmime_type \n application/pdf \n String \n No (Required if File\
        \ field is present) \n\nfile_name \n Certificate Document \n string \n No (Required if File field\
        \ is present)"
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                type:
                  type: string
                  example: Boiler Service
                expiry_date:
                  type: string
                  example: '2023-12-05'
                notes:
                  type: string
                  example: Fully assessed
                file:
                  type: string
                  example: Base64
                mime_type:
                  type: string
                  example: application/pdf
                file_name:
                  type: string
                  example: Certificate Document
              required:
              - type
            example:
              type: Boiler Service
              expiry_date: '2022-02-28'
              notes: Fully assessed
              file: JVBERi0xLjMNCiXi48/TDQoNCjEgMCBvYmoNCjw8DQovVHlwZSAvQ2F0YWxvZw0KL091dGxpbmVzIDIgMCBSDQovUGFnZXMgMyAwIFINCj4+DQplbmRvYmoNCg0KMiAwIG9iag0KPDwNCi9UeXBlIC9PdXRsaW5lcw0KL0NvdW50IDANCj4+DQplbmRvYmoNCg0KMyAwIG9iag0KPDwNCi9UeXBlIC9QYWdlcw0KL0NvdW50IDINCi9LaWRzIFsgNCAwIFIgNiAwIFIgXSANCj4+DQplbmRvYmoNCg0KNCAwIG9iag0KPDwNCi9UeXBlIC9QYWdlDQovUGFyZW50IDMgMCBSDQovUmVzb3VyY2VzIDw8DQovRm9udCA8PA0KL0YxIDkgMCBSIA0KPj4NCi9Qcm9jU2V0IDggMCBSDQo+Pg0KL01lZGlhQm94IFswIDAgNjEyLjAwMDAgNzkyLjAwMDBdDQovQ29udGVudHMgNSAwIFINCj4+DQplbmRvYmoNCg0KNSAwIG9iag0KPDwgL0xlbmd0aCAxMDc0ID4+DQpzdHJlYW0NCjIgSg0KQlQNCjAgMCAwIHJnDQovRjEgMDAyNyBUZg0KNTcuMzc1MCA3MjIuMjgwMCBUZA0KKCBBIFNpbXBsZSBQREYgRmlsZSApIFRqDQpFVA0KQlQNCi9GMSAwMDEwIFRmDQo2OS4yNTAwIDY4OC42MDgwIFRkDQooIFRoaXMgaXMgYSBzbWFsbCBkZW1vbnN0cmF0aW9uIC5wZGYgZmlsZSAtICkgVGoNCkVUDQpCVA0KL0YxIDAwMTAgVGYNCjY5LjI1MDAgNjY0LjcwNDAgVGQNCigganVzdCBmb3IgdXNlIGluIHRoZSBWaXJ0dWFsIE1lY2hhbmljcyB0dXRvcmlhbHMuIE1vcmUgdGV4dC4gQW5kIG1vcmUgKSBUag0KRVQNCkJUDQovRjEgMDAxMCBUZg0KNjkuMjUwMCA2NTIuNzUyMCBUZA0KKCB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiApIFRqDQpFVA0KQlQNCi9GMSAwMDEwIFRmDQo2OS4yNTAwIDYyOC44NDgwIFRkDQooIEFuZCBtb3JlIHRleHQuIEFuZCBtb3JlIHRleHQuIEFuZCBtb3JlIHRleHQuIEFuZCBtb3JlIHRleHQuIEFuZCBtb3JlICkgVGoNCkVUDQpCVA0KL0YxIDAwMTAgVGYNCjY5LjI1MDAgNjE2Ljg5NjAgVGQNCiggdGV4dC4gQW5kIG1vcmUgdGV4dC4gQm9yaW5nLCB6enp6ei4gQW5kIG1vcmUgdGV4dC4gQW5kIG1vcmUgdGV4dC4gQW5kICkgVGoNCkVUDQpCVA0KL0YxIDAwMTAgVGYNCjY5LjI1MDAgNjA0Ljk0NDAgVGQNCiggbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiApIFRqDQpFVA0KQlQNCi9GMSAwMDEwIFRmDQo2OS4yNTAwIDU5Mi45OTIwIFRkDQooIEFuZCBtb3JlIHRleHQuIEFuZCBtb3JlIHRleHQuICkgVGoNCkVUDQpCVA0KL0YxIDAwMTAgVGYNCjY5LjI1MDAgNTY5LjA4ODAgVGQNCiggQW5kIG1vcmUgdGV4dC4gQW5kIG1vcmUgdGV4dC4gQW5kIG1vcmUgdGV4dC4gQW5kIG1vcmUgdGV4dC4gQW5kIG1vcmUgKSBUag0KRVQNCkJUDQovRjEgMDAxMCBUZg0KNjkuMjUwMCA1NTcuMTM2MCBUZA0KKCB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBFdmVuIG1vcmUuIENvbnRpbnVlZCBvbiBwYWdlIDIgLi4uKSBUag0KRVQNCmVuZHN0cmVhbQ0KZW5kb2JqDQoNCjYgMCBvYmoNCjw8DQovVHlwZSAvUGFnZQ0KL1BhcmVudCAzIDAgUg0KL1Jlc291cmNlcyA8PA0KL0ZvbnQgPDwNCi9GMSA5IDAgUiANCj4+DQovUHJvY1NldCA4IDAgUg0KPj4NCi9NZWRpYUJveCBbMCAwIDYxMi4wMDAwIDc5Mi4wMDAwXQ0KL0NvbnRlbnRzIDcgMCBSDQo+Pg0KZW5kb2JqDQoNCjcgMCBvYmoNCjw8IC9MZW5ndGggNjc2ID4+DQpzdHJlYW0NCjIgSg0KQlQNCjAgMCAwIHJnDQovRjEgMDAyNyBUZg0KNTcuMzc1MCA3MjIuMjgwMCBUZA0KKCBTaW1wbGUgUERGIEZpbGUgMiApIFRqDQpFVA0KQlQNCi9GMSAwMDEwIFRmDQo2OS4yNTAwIDY4OC42MDgwIFRkDQooIC4uLmNvbnRpbnVlZCBmcm9tIHBhZ2UgMS4gWWV0IG1vcmUgdGV4dC4gQW5kIG1vcmUgdGV4dC4gQW5kIG1vcmUgdGV4dC4gKSBUag0KRVQNCkJUDQovRjEgMDAxMCBUZg0KNjkuMjUwMCA2NzYuNjU2MCBUZA0KKCBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSApIFRqDQpFVA0KQlQNCi9GMSAwMDEwIFRmDQo2OS4yNTAwIDY2NC43MDQwIFRkDQooIHRleHQuIE9oLCBob3cgYm9yaW5nIHR5cGluZyB0aGlzIHN0dWZmLiBCdXQgbm90IGFzIGJvcmluZyBhcyB3YXRjaGluZyApIFRqDQpFVA0KQlQNCi9GMSAwMDEwIFRmDQo2OS4yNTAwIDY1Mi43NTIwIFRkDQooIHBhaW50IGRyeS4gQW5kIG1vcmUgdGV4dC4gQW5kIG1vcmUgdGV4dC4gQW5kIG1vcmUgdGV4dC4gQW5kIG1vcmUgdGV4dC4gKSBUag0KRVQNCkJUDQovRjEgMDAxMCBUZg0KNjkuMjUwMCA2NDAuODAwMCBUZA0KKCBCb3JpbmcuICBNb3JlLCBhIGxpdHRsZSBtb3JlIHRleHQuIFRoZSBlbmQsIGFuZCBqdXN0IGFzIHdlbGwuICkgVGoNCkVUDQplbmRzdHJlYW0NCmVuZG9iag0KDQo4IDAgb2JqDQpbL1BERiAvVGV4dF0NCmVuZG9iag0KDQo5IDAgb2JqDQo8PA0KL1R5cGUgL0ZvbnQNCi9TdWJ0eXBlIC9UeXBlMQ0KL05hbWUgL0YxDQovQmFzZUZvbnQgL0hlbHZldGljYQ0KL0VuY29kaW5nIC9XaW5BbnNpRW5jb2RpbmcNCj4+DQplbmRvYmoNCg0KMTAgMCBvYmoNCjw8DQovQ3JlYXRvciAoUmF2ZSBcKGh0dHA6Ly93d3cubmV2cm9uYS5jb20vcmF2ZVwpKQ0KL1Byb2R1Y2VyIChOZXZyb25hIERlc2lnbnMpDQovQ3JlYXRpb25EYXRlIChEOjIwMDYwMzAxMDcyODI2KQ0KPj4NCmVuZG9iag0KDQp4cmVmDQowIDExDQowMDAwMDAwMDAwIDY1NTM1IGYNCjAwMDAwMDAwMTkgMDAwMDAgbg0KMDAwMDAwMDA5MyAwMDAwMCBuDQowMDAwMDAwMTQ3IDAwMDAwIG4NCjAwMDAwMDAyMjIgMDAwMDAgbg0KMDAwMDAwMDM5MCAwMDAwMCBuDQowMDAwMDAxNTIyIDAwMDAwIG4NCjAwMDAwMDE2OTAgMDAwMDAgbg0KMDAwMDAwMjQyMyAwMDAwMCBuDQowMDAwMDAyNDU2IDAwMDAwIG4NCjAwMDAwMDI1NzQgMDAwMDAgbg0KDQp0cmFpbGVyDQo8PA0KL1NpemUgMTENCi9Sb290IDEgMCBSDQovSW5mbyAxMCAwIFINCj4+DQoNCnN0YXJ0eHJlZg0KMjcxNA0KJSVFT0YNCg==
              mime_type: application/pdf
              file_name: file_name
      responses:
        '200':
          description: The request was completed successfully without errors.
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                  data:
                    type: object
              example:
                status: 200
                data:
                  id: 878809
                  type: 'Boiler Service '
                  expiry_date: '2022-02-28'
                  status: Expired
                  missing: false
                  file:
                    id: 5779465
                    download_url: https://asset.arthuronline.co.uk/download/27210b2b-896e-45fe-949f-171f90998f14
                    mime_type: application/pdf
                  property:
                    id: 280736
                    address: 5 marford close, northwich, Cheshire, CW9 8WW
                  unit:
                    id: 599238
                    address: Unit 2 - B, 5 marford close, northwich, Cheshire, CW9 8WW
                  tenancy:
                    id: 709960
                    ref: TE1197
                    address: Unit 2 - B, 5 marford close, northwich, Cheshire, CW9 8WW
                  notes: Fully assessed
                  share_manager: true
                  share_tenant: false
                  share_contractor: false
                  share_owner: false
                  created: '2023-03-06T15:08:02'
                  modified: '2023-03-06T15:08:02'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
  /tenancies/{id}/register_deposit:
    get:
      operationId: registerDepositOnTenancy
      summary: Register Deposit on Tenancy
      tags:
      - Register Deposit
      parameters:
      - $ref: '#/components/parameters/EntityId'
      description: This endpoint retrieves the registered deposit associated with the given tenancy ID.
      responses:
        '200':
          description: The request was completed successfully without errors.
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                  data:
                    type: object
              example:
                status: 200
                data:
                  tenancy_id: 709960
                  deposit_registered_not_needed: false
                  date_registered: '2022-10-01'
                  payment_id: ''
                  certificate_no: ''
                  deposit_scheme: LSDWUC
                  deposit_held_by: TDS
                  deposit_required: '1200.00'
                  deposit_registered: true
                  image_urls: []
                  document_urls:
                  - https://asset.arthuronline.co.uk/download/27210b2b-896e-45fe-949f-171f90998f14
                  modified: '2023-03-06T09:08:27'
                  created: '2023-03-06T09:08:26'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
    put:
      operationId: updateDepositOnTenancy
      summary: Update Deposit on Tenancy
      tags:
      - Register Deposit
      parameters:
      - $ref: '#/components/parameters/EntityId'
      - $ref: '#/components/parameters/Strict'
      description: "Use this endpoint to update the registered deposit related to a tenancy . The API\
        \ will return the saved data.\n\nSupported Fields \n The following fields are supported for the\
        \ request body\n\nField \n Example \n Type \n Required? \n\ndeposit_registered_not_needed \n true\
        \ \n Boolean \n No \n\ndate_registered \n 2023-12-05 \n String \n No \n\ncertificate_no \n ABC\
        \ \n String \n No \n\ndeposit_scheme \n Base64 \n String \n No \n\ndeposit_held_by \n TDS \n String\
        \ \n No \n\ndeposit_required \n 1200 \n string \n No \n\ndeposit_registered \n true \n Boolean\
        \ \n No \n\nThe \"deposit_scheme\" field is required to have one of the following values:\n\n\
        Tenancy Deposit Scheme (TDS) \n Deposit Protection Service (DPS) \n MyDeposits \n Letting Protection\
        \ Scotland \n Safe Deposits Scotland \n My Deposits Scotland \n Reposit \n N/A"
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                deposit_registered_not_needed:
                  type: boolean
                  example: true
                date_registered:
                  type: string
                  example: '2023-12-05'
                certificate_no:
                  type: string
                  example: ABC
                deposit_scheme:
                  type: string
                  example: Base64
                deposit_held_by:
                  type: string
                  example: TDS
                deposit_required:
                  type: string
                  example: '1200'
                deposit_registered:
                  type: boolean
                  example: true
            example:
              deposit_registered_not_needed: true
              date_registered: '202

# --- truncated at 32 KB (90 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/arthur-online/refs/heads/main/openapi/arthur-online-tenancies-openapi.yml