How to create a Lodger Agreement

What is a Lodger Agreement?

A Lodger Agreement, also known as a Lodger License Agreement, is a rental agreement, allowing a licensor (live-in landlord) to rent out a room to a licensee (lodger). Both the lodger and licensor, share common facilities in the household.

Related Recipes

How to create a Lodger Agreement?

To create a Lodger Agreement:

  • Create a user, and identify your user id
  • Create or identify team that will be involved in making the Lodger Agreement
  • Obtain Lodger Agreement Template and contract fields
  • Create the contract
  • Fill in fields
  • Add any other parties
  • Sign the contract

Creating a user

A user is an account registered on legislate. A user requires a first name, last name and an email input to be created, an avatar however, is not necessary. Upon completing the request, a 200 response should be given, and the user id should be given (6749541852252073 in the example). If this doesn't happen, it is possible that the name fields have not been filled, or the email has already been registered with another user.

{
  "_links": {
    "self": {
      "href": "https://sandbox.legislate.tech/v1/users/6749541852252073"
    }
  },
  "user_id": 0,
  "email": null
}

Creating a team

Contracts are created in teams. A User can create a new Team or select an existing. In this guide we will create a "New team for Lodger Agreement" with the create team endpoint:

curl --request POST \
     --url https://sandbox.legislate.tech/v1/users/6749541852252073/teams \
     --header 'Accept: application/json' \
     --header 'Authorization: Bearer APIKEY' \
     --header 'Content-Type: application/json' \
     --data '
{
     "name": "New team for Lodger Agreement"
}
'

A successful 201 response should return the team ID, an error could mean the name of the team has not been given, or the user ID is incorrect.

{
  "id": 6753931778590809,
  "name": "New team for Lodger Agreement",
  "created": "2022-06-16 15:16:27.980+0000",
  "_links": {
    "self": {
      "href": "https://sandbox.legislate.tech/v1/teams/6753931778590809"
    }
  }
}

Getting contract fields of the Lodger Agreement

The Lodger Agreement is a public contract, and we will look at the list of contracts the team can create to find the ID for the Lodger Agreement. This can be done using the Get contract types of a team endpoint (https://developers.legislate.tech/reference/getcontracttypesperteamusingget) which uses the team ID. A successful 204 response should look something like this:

{
    "id": 6690589634461711,
    "name": "Section 8 Notice",
    "links": [
      {
        "rel": "self",
        "href": "https://sandbox.legislate.tech/v1/teams/6753931778590809/contract-types/6690589634461711"
      },
      {
        "rel": "templates",
        "href": "https://sandbox.legislate.tech/v1/teams/6753931778590809/contract-types/6690589634461711/templates"
      }
    ],
    "about_url": "www.legislate.tech"
  },
  {
    "id": 6690589634461712,
    "name": "Section 21 Notice",
    "links": [
      {
        "rel": "self",
        "href": "https://sandbox.legislate.tech/v1/teams/6753931778590809/contract-types/6690589634461712"
      },
      {
        "rel": "templates",
        "href": "https://sandbox.legislate.tech/v1/teams/6753931778590809/contract-types/6690589634461712/templates"
      }
    ],
    "about_url": "www.legislate.tech"
  },

This is a list of contracts the team is able to create, and the Lodger Agreement type should be in this list

"id": 6690589634461710,
    "name": "Lodger Licence Agreement",
    "links": [
      {
        "rel": "self",
        "href": "https://sandbox.legislate.tech/v1/teams/6753931778590809/contract-types/6690589634461710"
      },
      {
        "rel": "templates",
        "href": "https://sandbox.legislate.tech/v1/teams/6753931778590809/contract-types/6690589634461710/templates"
      }
    ],
    "about_url": "www.legislate.tech"

This shows the ID of the Lodger Agreement we need to locate the Lodger Agreement Template using the Get templates endpoint (https://developers.legislate.tech/reference/gettemplatesusingget):

[
  {
    "id": 142,
    "version": "Last updated 10/02/2022",
    "links": [
      {
        "rel": "self",
        "href": "https://sandbox.legislate.tech/v1/teams/6753931778590809/contract-types/6690589634461710/templates/142"
      },
      {
        "rel": "type",
        "href": "https://sandbox.legislate.tech/v1/teams/6753931778590809/contract-types/6690589634461710"
      },
      {
        "rel": "terms",
        "href": "https://sandbox.legislate.tech/v1/templates/142/terms"
      }
    ]
  }
]

This id is the Lodger Agreement template ID. This can be used to get the Lodger Agreement fields, using the Get contract fields endpoint (https://developers.legislate.tech/reference/gettemplatetermsusingget). This endpoint uses the template ID as a parameter and a successful 200 response will look like:

[
  {
    "id": 3499,
    "label": "Contract Name",
    "name": "contract_name",
    "links": [
      {
        "rel": "self",
        "href": "https://sandbox.legislate.tech/v1/terms/3499"
      }
    ]
  },
  {
    "id": 3500,
    "label": "Agreement Date",
    "name": "contract_agreementDate",
    "links": [
      {
        "rel": "self",
        "href": "https://sandbox.legislate.tech/v1/terms/3500"
      }
    ]
  },
  {
    "id": 3501,
    "label": "Commencement Date",
    "name": "contract_startDate",
    "links": [
      {
        "rel": "self",
        "href": "https://sandbox.legislate.tech/v1/terms/3501"
      }
    ]
  },
  {
    "id": 3502,
    "label": "Please specify the deposit amount",
    "name": "contract_depositAmount",
    "links": [
      {
        "rel": "self",
        "href": "https://sandbox.legislate.tech/v1/terms/3502"
      }
    ]
  },
  {
    "id": 3503,
    "label": "How frequently will the licence fee be paid?",
    "name": "contract_rentFrequency",
    "options": [
      {
        "value": "week"
      },
      {
        "value": "month"
      }
    ],
    "links": [
      {
        "rel": "self",
        "href": "https://sandbox.legislate.tech/v1/terms/3503"
      }
    ]
  },
  {
    "id": 3504,
    "label": "Please confirm the licence fee for the chosen frequency",
    "name": "contract_individualRent",
    "links": [
      {
        "rel": "self",
        "href": "https://sandbox.legislate.tech/v1/terms/3504"
      }
    ]
  },
  {
    "id": 3505,
    "label": "Please confirm on which day licence payments should be made",
    "name": "contract_paymentDay",
    "options": [
      {
        "value": "1st day of each month"
      },
      {
        "value": "2nd day of each month"
      },
      {
        "value": "3rd day of each month"
      },
      {
        "value": "4th day of each month"
      },
      {
        "value": "5th day of each month"
      },
      {
        "value": "6th day of each month"
      },
      {
        "value": "7th day of each month"
      },
      {
        "value": "8th day of each month"
      },
      {
        "value": "9th day of each month"
      },
      {
        "value": "10th day of each month"
      },
      {
        "value": "11th day of each month"
      },
      {
        "value": "12th day of each month"
      },
      {
        "value": "13th day of each month"
      },
      {
        "value": "14th day of each month"
      },
      {
        "value": "15th day of each month"
      },
      {
        "value": "16th day of each month"
      },
      {
        "value": "17th day of each month"
      },
      {
        "value": "18th day of each month"
      },
      {
        "value": "19th day of each month"
      },
      {
        "value": "20th day of each month"
      },
      {
        "value": "21st day of each month"
      },
      {
        "value": "22nd day of each month"
      },
      {
        "value": "23rd day of each month"
      },
      {
        "value": "24th day of each month"
      },
      {
        "value": "25th day of each month"
      },
      {
        "value": "26th day of each month"
      },
      {
        "value": "27th day of each month"
      },
      {
        "value": "28th day of each month"
      },
      {
        "value": "Monday"
      },
      {
        "value": "Tuesday"
      },
      {
        "value": "Wednesday"
      },
      {
        "value": "Thursday"
      },
      {
        "value": "Friday"
      }
    ],
    "links": [
      {
        "rel": "self",
        "href": "https://sandbox.legislate.tech/v1/terms/3505"
      }
    ]
  },
  {
    "id": 3506,
    "label": "Property Address",
    "name": "contract_address",
    "links": [
      {
        "rel": "self",
        "href": "https://sandbox.legislate.tech/v1/terms/3506"
      }
    ]
  },
  {
    "id": 3507,
    "label": "Room details or number",
    "name": "contract_room",
    "links": [
      {
        "rel": "self",
        "href": "https://sandbox.legislate.tech/v1/terms/3507"
      }
    ]
  },
  {
    "id": 3508,
    "label": "Will the Utilities Costs be:",
    "name": "contract_utilities",
    "options": [
      {
        "value": "utilitiesProportion"
      },
      {
        "value": "utilitiesAmount",
        "nestedFields": [
          {
            "id": 3509,
            "label": "Please confirm the amount",
            "name": "contract_utilityPayment",
            "links": [
              {
                "rel": "self",
                "href": "https://sandbox.legislate.tech/v1/terms/3509"
              }
            ]
          }
        ]
      },
      {
        "value": "utilitiesIncluded"
      }
    ],
    "links": [
      {
        "rel": "self",
        "href": "https://sandbox.legislate.tech/v1/terms/3508"
      }
    ]
  },
  {
    "id": 3510,
    "label": "Please confirm the notice for Room relocation",
    "name": "contract_noticePeriod",
    "options": [
      {
        "value": "1 week"
      },
      {
        "value": "2 weeks"
      },
      {
        "value": "1 month"
      },
      {
        "value": "2 months"
      }
    ],
    "links": [
      {
        "rel": "self",
        "href": "https://sandbox.legislate.tech/v1/terms/3510"
      }
    ]
  },
  {
    "id": 3511,
    "label": "Will the Licence end:",
    "name": "contract_terminationRight",
    "options": [
      {
        "value": "terminationDate",
        "nestedFields": [
          {
            "id": 3512,
            "label": "Please specify the End Date",
            "name": "contract_endDate",
            "links": [
              {
                "rel": "self",
                "href": "https://sandbox.legislate.tech/v1/terms/3512"
              }
            ]
          }
        ]
      },
      {
        "value": "terminationNotice",
        "nestedFields": [
          {
            "id": 3513,
            "label": "Please confirm the Licensor's notice",
            "name": "contract_noticeConsentLandlord",
            "options": [
              {
                "value": "1 week's"
              },
              {
                "value": "2 weeks'"
              },
              {
                "value": "1 month's"
              },
              {
                "value": "2 months'"
              }
            ],
            "links": [
              {
                "rel": "self",
                "href": "https://sandbox.legislate.tech/v1/terms/3513"
              }
            ]
          },
          {
            "id": 3514,
            "label": "Please confirm the Licencee's notice",
            "name": "contract_noticeConsentTenant",
            "options": [
              {
                "value": "2 days'"
              },
              {
                "value": "1 week's"
              },
              {
                "value": "2 weeks'"
              },
              {
                "value": "1 month's"
              },
              {
                "value": "2 months'"
              }
            ],
            "links": [
              {
                "rel": "self",
                "href": "https://sandbox.legislate.tech/v1/terms/3514"
              }
            ]
          }
        ]
      }
    ],
    "links": [
      {
        "rel": "self",
        "href": "https://sandbox.legislate.tech/v1/terms/3511"
      }
    ]
  },
  {
    "id": 3515,
    "label": "Are Pets permitted?",
    "name": "contract_pets",
    "options": [
      {
        "value": "petsYes"
      },
      {
        "value": "petsNo"
      }
    ],
    "links": [
      {
        "rel": "self",
        "href": "https://sandbox.legislate.tech/v1/terms/3515"
      }
    ]
  },
  {
    "id": 3516,
    "label": "Please confirm the Bank Account Holder Name for the Licensor",
    "name": "contract_bankHolderName",
    "links": [
      {
        "rel": "self",
        "href": "https://sandbox.legislate.tech/v1/terms/3516"
      }
    ]
  },
  {
    "id": 3517,
    "label": "Please confirm the Bank Account Number for the Licensor",
    "name": "contract_bankAccountNumber",
    "links": [
      {
        "rel": "self",
        "href": "https://sandbox.legislate.tech/v1/terms/3517"
      }
    ]
  },
  {
    "id": 3518,
    "label": "Please confirm the Bank Account Sort Code for the Licensor",
    "name": "contract_bankAccountSortCode",
    "links": [
      {
        "rel": "self",
        "href": "https://sandbox.legislate.tech/v1/terms/3518"
      }
    ]
  },
  {
    "id": 3519,
    "label": "Please confirm the Bank Reference for the Licensor",
    "name": "contract_bankReference",
    "links": [
      {
        "rel": "self",
        "href": "https://sandbox.legislate.tech/v1/terms/3519"
      }
    ]
  },
  {
    "id": 3520,
    "label": "Is smoking permitted in the Property?",
    "name": "contract_seniority",
    "options": [
      {
        "value": "smokingYes"
      },
      {
        "value": "smokingNo"
      }
    ],
    "links": [
      {
        "rel": "self",
        "href": "https://sandbox.legislate.tech/v1/terms/3520"
      }
    ]
  },
  {
    "id": 3521,
    "label": "How long after the termination of the Licence will the Deposit be returned?",
    "name": "contract_depositReturn",
    "options": [
      {
        "value": "5 working days"
      },
      {
        "value": "10 working days"
      },
      {
        "value": "20 working days"
      }
    ],
    "links": [
      {
        "rel": "self",
        "href": "https://sandbox.legislate.tech/v1/terms/3521"
      }
    ]
  },
  {
    "id": 3522,
    "label": "Will the Licensee have access to any additional Shared Facilities?",
    "name": "contract_sharedFacilities",
    "options": [
      {
        "value": "sharedFacilitiesYes",
        "nestedFields": [
          {
            "id": 3523,
            "label": "Please describe the shared facilities",
            "name": "contract_sharedFacilitiesDetails",
            "links": [
              {
                "rel": "self",
                "href": "https://sandbox.legislate.tech/v1/terms/3523"
              }
            ]
          }
        ]
      },
      {
        "value": "sharedFacilitiesNo"
      }
    ],
    "links": [
      {
        "rel": "self",
        "href": "https://sandbox.legislate.tech/v1/terms/3522"
      }
    ]
  },
  {
    "id": 3524,
    "label": "Would you like to attach an inventory?",
    "name": "contract_inventory",
    "options": [
      {
        "value": "inventoryYes",
        "nestedFields": [
          {
            "id": 3525,
            "label": "Please upload the inventory",
            "name": "contract_inventoryUpload",
            "links": [
              {
                "rel": "self",
                "href": "https://sandbox.legislate.tech/v1/terms/3525"
              }
            ]
          }
        ]
      },
      {
        "value": "inventoryNo"
      }
    ],
    "links": [
      {
        "rel": "self",
        "href": "https://sandbox.legislate.tech/v1/terms/3524"
      }
    ]
  },
  {
    "id": 3526,
    "label": "Would you like to add a logo to the agreement?",
    "name": "contract_logo",
    "options": [
      {
        "value": "logoYes",
        "nestedFields": [
          {
            "id": 3527,
            "label": "Please upload the logo",
            "name": "contract_logoDetails",
            "links": [
              {
                "rel": "self",
                "href": "https://sandbox.legislate.tech/v1/terms/3527"
              }
            ]
          }
        ]
      },
      {
        "value": "logoNo"
      }
    ],
    "links": [
      {
        "rel": "self",
        "href": "https://sandbox.legislate.tech/v1/terms/3526"
      }
    ]
  },
  {
    "id": 3528,
    "label": "Are telephone services included in the Utilities? ",
    "name": "contract_telephoneLine",
    "options": [
      {
        "value": "telephoneYes"
      },
      {
        "value": "telephoneNo"
      }
    ],
    "links": [
      {
        "rel": "self",
        "href": "https://sandbox.legislate.tech/v1/terms/3528"
      }
    ]
  },
  {
    "id": 3529,
    "label": "Is cable or satellite television included in the Utilities? ",
    "name": "contract_television",
    "options": [
      {
        "value": "televisionYes"
      },
      {
        "value": "televisionNo"
      }
    ],
    "links": [
      {
        "rel": "self",
        "href": "https://sandbox.legislate.tech/v1/terms/3529"
      }
    ]
  },
  {
    "id": 3530,
    "label": "Please state how many sets of keys will be provided",
    "name": "contract_keysNumber",
    "links": [
      {
        "rel": "self",
        "href": "https://sandbox.legislate.tech/v1/terms/3530"
      }
    ]
  },
  {
    "id": 3531,
    "label": "Are there any persons that are not party to this agreement but are permitted to stay in the Room(s) licensed to the licensee? ",
    "name": "contract_permittedOccupiers",
    "options": [
      {
        "value": "permittedOccupierYes",
        "nestedFields": [
          {
            "id": 3532,
            "label": "Please state the name(s) of any such third parties",
            "name": "contract_permittedOccupiersDetails",
            "links": [
              {
                "rel": "self",
                "href": "https://sandbox.legislate.tech/v1/terms/3532"
              }
            ]
          }
        ]
      },
      {
        "value": "permittedOccupierNo"
      }
    ],
    "links": [
      {
        "rel": "self",
        "href": "https://sandbox.legislate.tech/v1/terms/3531"
      }
    ]
  },
  {
    "id": 3533,
    "label": "Please confirm the licensor's notice when the lodger is in breach of their obligations",
    "name": "contract_lodgerBreachNotice",
    "options": [
      {
        "value": "2 weeks'"
      },
      {
        "value": "1 month's"
      }
    ],
    "links": [
      {
        "rel": "self",
        "href": "https://sandbox.legislate.tech/v1/terms/3533"
      }
    ]
  },
  {
    "id": 3534,
    "label": "Does the Property have a garden?",
    "name": "contract_garden",
    "options": [
      {
        "value": "gardenYes"
      },
      {
        "value": "gardenNo"
      }
    ],
    "links": [
      {
        "rel": "self",
        "href": "https://sandbox.legislate.tech/v1/terms/3534"
      }
    ]
  },
  {
    "id": 3535,
    "label": "Would you like to attach House Rules to the agreement?",
    "name": "contract_houseRules",
    "options": [
      {
        "value": "houseRulesYes",
        "nestedFields": [
          {
            "id": 3536,
            "label": "Please attach the House Rules",
            "name": "contract_houseRulesUpload",
            "links": [
              {
                "rel": "self",
                "href": "https://sandbox.legislate.tech/v1/terms/3536"
              }
            ]
          }
        ]
      },
      {
        "value": "houseRulesNo"
      }
    ],
    "links": [
      {
        "rel": "self",
        "href": "https://sandbox.legislate.tech/v1/terms/3535"
      }
    ]
  }
]

πŸ“˜

Label

The label of a field can be used to present questions that a user may be asked to provide values for

Finding the contract ID

We can find the contract ID by using the Create a contract with an auto-generated bundle endpoint (https://developers.legislate.tech/reference/postcontractusingpost_1-1) using the user ID, team ID and template ID as parameters. A successful response should look like:

{
  "contract_name": "2022 Jun 16 Lodger Licence Agreement",
  "_links": {
    "self": {
      "href": "https://sandbox.legislate.tech/v1/contracts/6697064968753806"
    }
  }

Setting the terms of the Lodger Agreement, and adding parties

The fields can be given values using the patch function in the Update contract details endpoint (https://developers.legislate.tech/reference/updatecontractusingpatch-1). This will give an error as a response if the contract id is wrong, and if the fields have not been filled in correctly.
To add another user or party to the contract, the Create a company given a contract endpoint (https://developers.legislate.tech/reference/postcollaboratorusingpost_1) should be used. This uses the contract ID, as well as the details of the party as parameters to add them to the contract. A collaborator can be added to the contract using the Create a collaborator given a contract endpoint (https://developers.legislate.tech/reference/postcollaboratorusingpost) in the same way.