Sign in

v1

latestOpenAPI 3.0.02026-07-2412592575.3 KB
rental records

Create a rental recognition record for user

Requires rental_records:write scope. Please note that a user will only have one rental recognition record. The rental record created will be for the authenticated user.

post/rental-records

Request body

titlestring

Title of the user the rental record belongs to.

firstNamestring required

First name of the user the rental record belongs to.

lastNamestring required

Last name of the user the rental record belongs to.

birthdatestring date required

Date of birth of the user the rental record belongs to.

addressLine1string required

First line of the rented address.

addressLine2string nullable

Second line of the rented address.

addressLine3string nullable

Third line of the rented address.

addressLine4string nullable

Fourth line of the rented address.

postalCodestring required

Postal code of rented address.

tenancyStartDatestring date required

Start date of the tenancy agreement.

rentalFrequency'weekly' | 'fortnightly' | 'monthly' required

Frequency of the rental payments e.g. monthly.

seriesIdstring required

The unique identity of the regular transaction series.

Example request

{
  "title": "Ms",
  "firstName": "name",
  "lastName": "surname",
  "birthdate": "2021-01-31",
  "addressLine1": "123 Example Road",
  "addressLine2": "Building",
  "addressLine3": "City",
  "addressLine4": "County",
  "postalCode": "BS1 6QF",
  "tenancyStartDate": "2021-01-31",
  "rentalAmount": {
    "value": 10000
  },
  "seriesId": "ac9bd177-d01e-449c-9f29-d3656d2edc2e"
}

Response

Successful Rental Record Response

metaobject

Example response

{
  "data": {
    "id": "ac9bd177-d01e-449c-9f29-d3656d2edc2e",
    "userId": "ac9bd177-d01e-449c-9f29-d3656d2edc2e",
    "title": "Ms",
    "firstName": "name",
    "lastName": "surname",
    "birthdate": "2021-01-31",
    "addressLine1": "123 Example Road",
    "addressLine2": "Building",
    "addressLine3": "City",
    "addressLine4": "County",
    "postalCode": "BS1 6QF",
    "tenancyStartDate": "2021-01-31",
    "rentalAmount": {
      "value": 10000,
      "majorUnits": 100,
      "currency": "GBP"
    },
    "seriesId": "ac9bd177-d01e-449c-9f29-d3656d2edc2e",
    "createdAt": "2018-07-10T11:39:44.000Z",
    "modifiedAt": "2018-07-10T11:39:44.000Z",
    "lastSubmittedDate": "2018-07-10",
    "consentApprovedAt": "2018-07-10T11:39:44.000Z"
  }
}