Get list of contracts

28 Oct 2024
31 Minutes to read
Contributors

Print
Dark
Light
PDF

Get list of contracts

Updated on 28 Oct 2024
31 Minutes to read
Contributors

Print
Dark
Light
PDF

Article summary

Did you find this summary helpful?

Thank you for your feedback

Get

/contracts/

Operation is used to get a list of Contracts. Available from product version 3.2.24.

Contracts data can be filtered by giving filtering parameters at HTTP querystring (see parameters).

Security

API Key

Header parameter nameAuthorization

Token issued for API consumer.

Query parameters

offset

integer

Offset to start returning results.

Minimum0

limit

integer

Limit number of results returned. Set to -1 to use maximum limit set in the environment. Default limit will be used if parameter is not specified. Special value -1 is available from product version 3.2.18.

Minimum1

srs

string

Coordinate system to transform location to.

Example: srs=epsg:4326

precision

integer

Number of decimals to be returned with object location. If parameter is not specified the number of decimals is as precise as possible for current running instance. Available from product version 2024.4.

Minimum1

dimensions

integer

number of dimensions to be returned. Acceptable values are 2 and 3. If parameter is not specified the number of dimensions are as default for current product. Available from product version 2024.4.

Minimum1

__any of the object fields__

string

Filters list by selected object field value. Supports structured queries via +__+ delimiter. Supports ending keywords via +__+ delimiter:

For string fields: istartswith, startswith, iendswith, endswith, contains, icontains, isnull
For numerics: gt, lt, gte, lte, isnull
For spatial fields: contains, isnull, within, intersects, disjoint, touches, overlaps, covers, coveredby Examples: +++usage_state__txt__istartswith=in+++ , +++plan__state__txt__startswith=In+++ , +++creation_date__gte=2019-01-02T15:32:01+++, +++location__within=POLYGON ((641503.89 6944059.81, 641406.52 6943933.87, 641369.48 6943772.48, 641474.25 6943704.74, 641873.78 6943735.96, 641848.38 6943975.15, 641607.08 6944167.76, 641653.11 6944102.15, 641503.89 6944059.81))+++ Supports exclusive queries by field value using a not-operator preceeding the field lookup: Examples: +++not__type__txt__istartswith=Tie+++ , +++not__id=1390+++

orderby

string

Selects the object field to order the returned objects by. Can be used to sort in reverse order with '-' prefix. Can have several ordering rules separated by comma. Can be used only for object own fields and does not supports structured queries. Example: orderby=creator,-creation_date

Responses

200

A result response object.

{
  "Next": "https://keycom.example.com/api/v2/contracts/?limit=10&offset=10",
  "Previous": null,
  "Results": [
    {
      "agreement": "1234567890A",
      "antenna": null,
      "billing": {
        "availability_end_ts": null,
        "availability_start_ts": null,
        "available": true,
        "groupname": "ELECTRIC_BIL_TYPE",
        "id": 14290,
        "list_url": "https://keypro.example.com/api/v2/txt_constants/groupname/ELECTRIC_BIL_TYPE/",
        "logical_txt": "Arviolaskutus",
        "num_value": null,
        "num_value2": null,
        "num_value3": null,
        "num_value4": null,
        "txt": "Arviolaskutus"
      },
      "billingDay": 15,
      "billingPeriod": 4,
      "billingReference": "1234567890",
      "cableUsage": "",
      "comment": "",
      "contractStatus": {
        "availability_end_ts": null,
        "availability_start_ts": null,
        "available": true,
        "groupname": "RENT_STATUS",
        "id": 1350,
        "list_url": "https://keypro.example.com/api/v2/txt_constants/groupname/RENT_STATUS/",
        "logical_txt": "Vuokrattu",
        "num_value": 2.0,
        "num_value2": null,
        "num_value3": 2.0,
        "num_value4": 1.0,
        "txt": "Vuokrattu"
      },
      "contractType": {
        "availability_end_ts": null,
        "availability_start_ts": null,
        "available": true,
        "groupname": "CONTRACT_TYPE",
        "id": 14270,
        "list_url": "https://keypro.example.com/api/v2/txt_constants/groupname/CONTRACT_TYPE/",
        "logical_txt": "Alivuokrasopimus",
        "num_value": null,
        "num_value2": null,
        "num_value3": null,
        "num_value4": null,
        "txt": "Alivuokrasopimus"
      },
      "createdBy": "petri",
      "createdTs": "2011-02-17T03:21:48Z",
      "id": 410,
      "lessee": {
        "address": {
          "address": {
            "apartments": [
              "https://keypro.example.com/api/v2/apartments/14536/"
            ],
            "buildingId": "",
            "city": "LOVISA",
            "cityAlt": "",
            "country": "",
            "createdBy": "",
            "createdTs": null,
            "district": "",
            "empty": 0,
            "id": 173470,
            "listUrl": "https://keypro.example.com/api/v2/addresses/",
            "location": null,
            "municipality": "",
            "propertyId": "",
            "province": "",
            "streetname": "INGENJÖRSVÄGEN",
            "streetnameAlt": "",
            "streetno": "2",
            "subdivision": "",
            "updatedBy": "KEYCOM_STAGE30",
            "updatedTs": "2018-01-11T06:00:23Z",
            "usagePurpose": {
              "availability_end_ts": null,
              "availability_start_ts": null,
              "available": true,
              "groupname": "BUILDING_USAGE",
              "id": 233970,
              "list_url": "https://keypro.example.com/api/v2/txt_constants/groupname/BUILDING_USAGE/",
              "logical_txt": "Asuinrakennus",
              "num_value": null,
              "num_value2": null,
              "num_value3": 1.0,
              "num_value4": null,
              "txt": "Asuinrakennus"
            },
            "usagePurposeAlt": null,
            "zipcode": 7900
          },
          "apartmentDivision": "",
          "apartmentLetter": "",
          "apartmentNumber": "",
          "empty": 1,
          "id": 14536,
          "listUrl": "https://keypro.example.com/api/v2/apartments/",
          "originProperty": "//0000000014536",
          "originalStreetno": "2",
          "usagePurpose": null,
          "usagePurposeAlt": null,
          "usageState": null
        },
        "addressAlt": null,
        "billingName": "",
        "businessId": "",
        "createdBy": "",
        "createdTs": null,
        "email": "janne.testicase@keypro.fi",
        "id": 35866041,
        "listUrl": "https://keypro.example.com/api/v2/customers/",
        "mobilePhone": "",
        "name": "0ra Janne",
        "number": "35866041",
        "phone": "019 533353",
        "smsProhibited": null,
        "telefax": "",
        "type": {
          "availability_end_ts": null,
          "availability_start_ts": null,
          "available": true,
          "groupname": "KN_CUST_TYPE",
          "id": 6010,
          "list_url": "https://keypro.example.com/api/v2/txt_constants/groupname/KN_CUST_TYPE/",
          "logical_txt": "Yksityishenkilö",
          "num_value": 1.0,
          "num_value2": null,
          "num_value3": null,
          "num_value4": null,
          "txt": "Yksityishenkilö"
        },
        "updatedBy": "",
        "updatedTs": null
      },
      "lessor": {
        "address": {
          "address": {
            "apartments": [
              "https://keypro.example.com/api/v2/apartments/3281/"
            ],
            "buildingId": "",
            "city": "",
            "cityAlt": "",
            "country": "",
            "createdBy": "",
            "createdTs": null,
            "district": "",
            "empty": 1,
            "id": 390,
            "listUrl": "https://keypro.example.com/api/v2/addresses/",
            "location": null,
            "municipality": "",
            "propertyId": "",
            "province": "",
            "streetname": "",
            "streetnameAlt": "",
            "streetno": "",
            "subdivision": "",
            "updatedBy": "KEYCOM_STAGE30",
            "updatedTs": "2018-01-11T06:00:20Z",
            "usagePurpose": {
              "availability_end_ts": null,
              "availability_start_ts": null,
              "available": true,
              "groupname": "BUILDING_USAGE",
              "id": 233970,
              "list_url": "https://keypro.example.com/api/v2/txt_constants/groupname/BUILDING_USAGE/",
              "logical_txt": "Asuinrakennus",
              "num_value": null,
              "num_value2": null,
              "num_value3": 1.0,
              "num_value4": null,
              "txt": "Asuinrakennus"
            },
            "usagePurposeAlt": null,
            "zipcode": ""
          },
          "apartmentDivision": "",
          "apartmentLetter": "",
          "apartmentNumber": "",
          "empty": 1,
          "id": 3281,
          "listUrl": "https://keypro.example.com/api/v2/apartments/",
          "originProperty": "//0000000003281",
          "originalStreetno": "",
          "usagePurpose": null,
          "usagePurposeAlt": null,
          "usageState": null
        },
        "addressAlt": null,
        "billingName": "",
        "businessId": "",
        "createdBy": "KEYCOM_STAGE30",
        "createdTs": "2018-04-10T01:30:34Z",
        "email": "",
        "id": 192470,
        "listUrl": "https://keypro.example.com/api/v2/customers/",
        "mobilePhone": "",
        "name": "Corenet Oy",
        "number": "A-192470",
        "phone": "",
        "smsProhibited": null,
        "telefax": "",
        "type": null,
        "updatedBy": "KEYCOM_STAGE30",
        "updatedTs": "2018-04-10T01:30:34Z"
      },
      "parentContract": "https://keypro.example.com/api/v2/contracts/11630/",
      "rent": "1000.00",
      "rentBeginDate": "2012-12-19",
      "rentEndDate": "2012-12-28",
      "rent_2": "2000.00",
      "rent_3": "10000.00",
      "reserveBeginDate": "2012-12-29",
      "reserveEndDate": "2012-12-30",
      "termOfNotice": 30,
      "updatedBy": "admin",
      "updatedTs": "2014-03-24T09:51:46Z"
    },
    {
      "agreement": "33789",
      "antenna": null,
      "billing": null,
      "billingDay": null,
      "billingPeriod": null,
      "billingReference": "",
      "cableUsage": "",
      "comment": "",
      "contractStatus": {
        "availability_end_ts": null,
        "availability_start_ts": null,
        "available": true,
        "groupname": "RENT_STATUS",
        "id": 1330,
        "list_url": "https://keypro.example.com/api/v2/txt_constants/groupname/RENT_STATUS/",
        "logical_txt": "Varattu",
        "num_value": 0.0,
        "num_value2": null,
        "num_value3": 1.0,
        "num_value4": 5.0,
        "txt": "Varattu"
      },
      "contractType": null,
      "createdBy": "petri",
      "createdTs": "2011-02-17T03:22:11Z",
      "id": 430,
      "lessee": null,
      "lessor": null,
      "parentContract": "https://keypro.example.com/api/v2/contracts/410/",
      "rent": null,
      "rentBeginDate": null,
      "rentEndDate": null,
      "rent_2": null,
      "rent_3": null,
      "reserveBeginDate": null,
      "reserveEndDate": null,
      "termOfNotice": null,
      "updatedBy": "kim",
      "updatedTs": "2013-01-22T01:31:47Z"
    },
    {
      "agreement": "666",
      "antenna": 12,
      "billing": {
        "availability_end_ts": null,
        "availability_start_ts": null,
        "available": true,
        "groupname": "ELECTRIC_BIL_TYPE",
        "id": 14310,
        "list_url": "https://keypro.example.com/api/v2/txt_constants/groupname/ELECTRIC_BIL_TYPE/",
        "logical_txt": "Oma mittari",
        "num_value": null,
        "num_value2": null,
        "num_value3": null,
        "num_value4": null,
        "txt": "Oma mittari"
      },
      "billingDay": 12,
      "billingPeriod": 12,
      "billingReference": "1234",
      "cableUsage": "",
      "comment": "",
      "contractStatus": {
        "availability_end_ts": null,
        "availability_start_ts": null,
        "available": true,
        "groupname": "RENT_STATUS",
        "id": 1310,
        "list_url": "https://keypro.example.com/api/v2/txt_constants/groupname/RENT_STATUS/",
        "logical_txt": "Vapaa",
        "num_value": 1.0,
        "num_value2": null,
        "num_value3": 4.0,
        "num_value4": 1.0,
        "txt": "Vapaa"
      },
      "contractType": {
        "availability_end_ts": null,
        "availability_start_ts": null,
        "available": true,
        "groupname": "CONTRACT_TYPE",
        "id": 14250,
        "list_url": "https://keypro.example.com/api/v2/txt_constants/groupname/CONTRACT_TYPE/",
        "logical_txt": "Vuokrasopimus",
        "num_value": null,
        "num_value2": null,
        "num_value3": null,
        "num_value4": null,
        "txt": "Vuokrasopimus"
      },
      "createdBy": "demo",
      "createdTs": "2011-08-25T02:35:42Z",
      "id": 2410,
      "lessee": {
        "address": {
          "address": {
            "apartments": [
              "https://keypro.example.com/api/v2/apartments/25821/",
              "https://keypro.example.com/api/v2/apartments/65864/"
            ],
            "buildingId": "12",
            "city": "JOENZ00",
            "cityAlt": "1234",
            "country": "",
            "createdBy": "",
            "createdTs": null,
            "district": "",
            "empty": 0,
            "id": 528010,
            "listUrl": "https://keypro.example.com/api/v2/addresses/",
            "location": "SRID=3067;POINT (457001.3785999999963678 6703317.4406000003218651)",
            "municipality": "",
            "propertyId": "12",
            "province": "",
            "streetname": "TESTIKATU",
            "streetnameAlt": "TESTGATAN",
            "streetno": "16",
            "subdivision": "",
            "updatedBy": "KEYCOM_STAGE32",
            "updatedTs": "2021-06-16T11:23:48Z",
            "usagePurpose": {
              "availability_end_ts": null,
              "availability_start_ts": null,
              "available": true,
              "groupname": "BUILDING_USAGE",
              "id": 233990,
              "list_url": "https://keypro.example.com/api/v2/txt_constants/groupname/BUILDING_USAGE/",
              "logical_txt": "Liike- tai teollisuusrakennus",
              "num_value": null,
              "num_value2": null,
              "num_value3": 2.0,
              "num_value4": null,
              "txt": "Liike- tai teollisuusrakennus"
            },
            "usagePurposeAlt": null,
            "zipcode": "80110"
          },
          "apartmentDivision": "",
          "apartmentLetter": "",
          "apartmentNumber": "",
          "empty": 1,
          "id": 25821,
          "listUrl": "https://keypro.example.com/api/v2/apartments/",
          "originProperty": "//0000000025781",
          "originalStreetno": "",
          "usagePurpose": null,
          "usagePurposeAlt": null,
          "usageState": null
        },
        "addressAlt": {
          "address": {
            "apartments": [
              "https://keypro.example.com/api/v2/apartments/25821/",
              "https://keypro.example.com/api/v2/apartments/65864/"
            ],
            "buildingId": "12",
            "city": "JOENZ00",
            "cityAlt": "1234",
            "country": "",
            "createdBy": "",
            "createdTs": null,
            "district": "",
            "empty": 0,
            "id": 528010,
            "listUrl": "https://keypro.example.com/api/v2/addresses/",
            "location": "SRID=3067;POINT (457001.3785999999963678 6703317.4406000003218651)",
            "municipality": "",
            "propertyId": "12",
            "province": "",
            "streetname": "TESTIKATU",
            "streetnameAlt": "TESTGATAN",
            "streetno": "16",
            "subdivision": "",
            "updatedBy": "KEYCOM_STAGE32",
            "updatedTs": "2021-06-16T11:23:48Z",
            "usagePurpose": {
              "availability_end_ts": null,
              "availability_start_ts": null,
              "available": true,
              "groupname": "BUILDING_USAGE",
              "id": 233990,
              "list_url": "https://keypro.example.com/api/v2/txt_constants/groupname/BUILDING_USAGE/",
              "logical_txt": "Liike- tai teollisuusrakennus",
              "num_value": null,
              "num_value2": null,
              "num_value3": 2.0,
              "num_value4": null,
              "txt": "Liike- tai teollisuusrakennus"
            },
            "usagePurposeAlt": null,
            "zipcode": "80110"
          },
          "apartmentDivision": "",
          "apartmentLetter": "",
          "apartmentNumber": "",
          "empty": 1,
          "id": 25821,
          "listUrl": "https://keypro.example.com/api/v2/apartments/",
          "originProperty": "//0000000025781",
          "originalStreetno": "",
          "usagePurpose": null,
          "usagePurposeAlt": null,
          "usageState": null
        },
        "billingName": "1a",
        "businessId": "12",
        "createdBy": "",
        "createdTs": null,
        "email": "1a",
        "id": 3210,
        "listUrl": "https://keypro.example.com/api/v2/customers/",
        "mobilePhone": "12",
        "name": "Testi Customer",
        "number": "1337",
        "phone": "12",
        "smsProhibited": null,
        "telefax": "12",
        "type": {
          "availability_end_ts": null,
          "availability_start_ts": null,
          "available": true,
          "groupname": "KN_CUST_TYPE",
          "id": 6010,
          "list_url": "https://keypro.example.com/api/v2/txt_constants/groupname/KN_CUST_TYPE/",
          "logical_txt": "Yksityishenkilö",
          "num_value": 1.0,
          "num_value2": null,
          "num_value3": null,
          "num_value4": null,
          "txt": "Yksityishenkilö"
        },
        "updatedBy": "",
        "updatedTs": null
      },
      "lessor": {
        "address": {
          "address": {
            "apartments": [
              "https://keypro.example.com/api/v2/apartments/3281/"
            ],
            "buildingId": "",
            "city": "",
            "cityAlt": "",
            "country": "",
            "createdBy": "",
            "createdTs": null,
            "district": "",
            "empty": 1,
            "id": 390,
            "listUrl": "https://keypro.example.com/api/v2/addresses/",
            "location": null,
            "municipality": "",
            "propertyId": "",
            "province": "",
            "streetname": "",
            "streetnameAlt": "",
            "streetno": "",
            "subdivision": "",
            "updatedBy": "KEYCOM_STAGE30",
            "updatedTs": "2018-01-11T06:00:20Z",
            "usagePurpose": {
              "availability_end_ts": null,
              "availability_start_ts": null,
              "available": true,
              "groupname": "BUILDING_USAGE",
              "id": 233970,
              "list_url": "https://keypro.example.com/api/v2/txt_constants/groupname/BUILDING_USAGE/",
              "logical_txt": "Asuinrakennus",
              "num_value": null,
              "num_value2": null,
              "num_value3": 1.0,
              "num_value4": null,
              "txt": "Asuinrakennus"
            },
            "usagePurposeAlt": null,
            "zipcode": ""
          },
          "apartmentDivision": "",
          "apartmentLetter": "",
          "apartmentNumber": "",
          "empty": 1,
          "id": 3281,
          "listUrl": "https://keypro.example.com/api/v2/apartments/",
          "originProperty": "//0000000003281",
          "originalStreetno": "",
          "usagePurpose": null,
          "usagePurposeAlt": null,
          "usageState": null
        },
        "addressAlt": null,
        "billingName": "",
        "businessId": "",
        "createdBy": "KEYCOM_STAGE30",
        "createdTs": "2018-04-10T01:30:34Z",
        "email": "",
        "id": 192430,
        "listUrl": "https://keypro.example.com/api/v2/customers/",
        "mobilePhone": "",
        "name": "Testi Omistaja",
        "number": "A-192430",
        "phone": "",
        "smsProhibited": null,
        "telefax": "",
        "type": null,
        "updatedBy": "KEYCOM_STAGE30",
        "updatedTs": "2018-04-10T01:30:34Z"
      },
      "parentContract": "https://keypro.example.com/api/v2/contracts/430/",
      "rent": "12.00",
      "rentBeginDate": "2011-08-25",
      "rentEndDate": "2011-08-25",
      "rent_2": "12.00",
      "rent_3": "12.00",
      "reserveBeginDate": "2011-08-26",
      "reserveEndDate": "2011-08-25",
      "termOfNotice": 12,
      "updatedBy": "sami",
      "updatedTs": "2013-03-05T03:35:35Z"
    },
    {
      "agreement": "aaa",
      "antenna": null,
      "billing": null,
      "billingDay": null,
      "billingPeriod": null,
      "billingReference": "",
      "cableUsage": "",
      "comment": "",
      "contractStatus": null,
      "contractType": null,
      "createdBy": "admin",
      "createdTs": "2012-03-01T10:34:14Z",
      "id": 3210,
      "lessee": null,
      "lessor": null,
      "parentContract": null,
      "rent": null,
      "rentBeginDate": null,
      "rentEndDate": null,
      "rent_2": null,
      "rent_3": null,
      "reserveBeginDate": null,
      "reserveEndDate": null,
      "termOfNotice": null,
      "updatedBy": "admin",
      "updatedTs": "2012-03-01T10:34:14Z"
    },
    {
      "agreement": "7181883",
      "antenna": 2,
      "billing": {
        "availability_end_ts": null,
        "availability_start_ts": null,
        "available": true,
        "groupname": "ELECTRIC_BIL_TYPE",
        "id": 14290,
        "list_url": "https://keypro.example.com/api/v2/txt_constants/groupname/ELECTRIC_BIL_TYPE/",
        "logical_txt": "Arviolaskutus",
        "num_value": null,
        "num_value2": null,
        "num_value3": null,
        "num_value4": null,
        "txt": "Arviolaskutus"
      },
      "billingDay": 15,
      "billingPeriod": 3,
      "billingReference": "1029384756",
      "cableUsage": "Ei ole tietoa tästäkään",
      "comment": "Testauksen tulos",
      "contractStatus": {
        "availability_end_ts": null,
        "availability_start_ts": null,
        "available": true,
        "groupname": "RENT_STATUS",
        "id": 1350,
        "list_url": "https://keypro.example.com/api/v2/txt_constants/groupname/RENT_STATUS/",
        "logical_txt": "Vuokrattu",
        "num_value": 2.0,
        "num_value2": null,
        "num_value3": 2.0,
        "num_value4": 1.0,
        "txt": "Vuokrattu"
      },
      "contractType": {
        "availability_end_ts": null,
        "availability_start_ts": null,
        "available": true,
        "groupname": "CONTRACT_TYPE",
        "id": 14250,
        "list_url": "https://keypro.example.com/api/v2/txt_constants/groupname/CONTRACT_TYPE/",
        "logical_txt": "Vuokrasopimus",
        "num_value": null,
        "num_value2": null,
        "num_value3": null,
        "num_value4": null,
        "txt": "Vuokrasopimus"
      },
      "createdBy": "lasse",
      "createdTs": "2012-10-02T02:54:12Z",
      "id": 4030,
      "lessee": {
        "address": {
          "address": {
            "apartments": [
              "https://keypro.example.com/api/v2/apartments/26935/"
            ],
            "buildingId": "",
            "city": "PYHTÄÄ",
            "cityAlt": "PYTTIS",
            "country": "",
            "createdBy": "",
            "createdTs": null,
            "district": "",
            "empty": 0,
            "id": 545830,
            "listUrl": "https://keypro.example.com/api/v2/addresses/",
            "location": "SRID=3067;POINT (478045.5530000000144355 6699670.6042999997735023)",
            "municipality": "",
            "propertyId": "",
            "province": "",
            "streetname": "SANTANIEMENTIE",
            "streetnameAlt": "SANDNÄSVÄGEN",
            "streetno": "16",
            "subdivision": "",
            "updatedBy": "",
            "updatedTs": null,
            "usagePurpose": null,
            "usagePurposeAlt": null,
            "zipcode": ""
          },
          "apartmentDivision": "",
          "apartmentLetter": "",
          "apartmentNumber": "",
          "empty": 1,
          "id": 26935,
          "listUrl": "https://keypro.example.com/api/v2/apartments/",
          "originProperty": "//0000000026895",
          "originalStreetno": "",
          "usagePurpose": null,
          "usagePurposeAlt": null,
          "usageState": null
        },
        "addressAlt": null,
        "billingName": "Laskutustiedon nimi",
        "businessId": "",
        "createdBy": "",
        "createdTs": null,
        "email": "lakeija.munapirtti@munapirtinemail.com",
        "id": 11250,
        "listUrl": "https://keypro.example.com/api/v2/customers/",
        "mobilePhone": "050-442211",
        "name": "Munapirtin Lakeija",
        "number": "MUN48833",
        "phone": "09-9876542",
        "smsProhibited": null,
        "telefax": "",
        "type": {
          "availability_end_ts": null,
          "availability_start_ts": null,
          "available": true,
          "groupname": "KN_CUST_TYPE",
          "id": 6010,
          "list_url": "https://keypro.example.com/api/v2/txt_constants/groupname/KN_CUST_TYPE/",
          "logical_txt": "Yksityishenkilö",
          "num_value": 1.0,
          "num_value2": null,
          "num_value3": null,
          "num_value4": null,
          "txt": "Yksityishenkilö"
        },
        "updatedBy": "",
        "updatedTs": null
      },
      "lessor": {
        "address": {
          "address": {
            "apartments": [
              "https://keypro.example.com/api/v2/apartments/3281/"
            ],
            "buildingId": "",
            "city": "",
            "cityAlt": "",
            "country": "",
            "createdBy": "",
            "createdTs": null,
            "district": "",
            "empty": 1,
            "id": 390,
            "listUrl": "https://keypro.example.com/api/v2/addresses/",
            "location": null,
            "municipality": "",
            "propertyId": "",
            "province": "",
            "streetname": "",
            "streetnameAlt": "",
            "streetno": "",
            "subdivision": "",
            "updatedBy": "KEYCOM_STAGE30",
            "updatedTs": "2018-01-11T06:00:20Z",
            "usagePurpose": {
              "availability_end_ts": null,
              "availability_start_ts": null,
              "available": true,
              "groupname": "BUILDING_USAGE",
              "id": 233970,
              "list_url": "https://keypro.example.com/api/v2/txt_constants/groupname/BUILDING_USAGE/",
              "logical_txt": "Asuinrakennus",
              "num_value": null,
              "num_value2": null,
              "num_value3": 1.0,
              "num_value4": null,
              "txt": "Asuinrakennus"
            },
            "usagePurposeAlt": null,
            "zipcode": ""
          },
          "apartmentDivision": "",
          "apartmentLetter": "",
          "apartmentNumber": "",
          "empty": 1,
          "id": 3281,
          "listUrl": "https://keypro.example.com/api/v2/apartments/",
          "originProperty": "//0000000003281",
          "originalStreetno": "",
          "usagePurpose": null,
          "usagePurposeAlt": null,
          "usageState": null
        },
        "addressAlt": null,
        "billingName": "",
        "businessId": "",
        "createdBy": "KEYCOM_STAGE30",
        "createdTs": "2018-04-10T01:30:34Z",
        "email": "",
        "id": 192430,
        "listUrl": "https://keypro.example.com/api/v2/customers/",
        "mobilePhone": "",
        "name": "Testi Omistaja",
        "number": "A-192430",
        "phone": "",
        "smsProhibited": null,
        "telefax": "",
        "type": null,
        "updatedBy": "KEYCOM_STAGE30",
        "updatedTs": "2018-04-10T01:30:34Z"
      },
      "parentContract": null,
      "rent": "500.00",
      "rentBeginDate": "2012-10-02",
      "rentEndDate": "2012-10-31",
      "rent_2": "100.00",
      "rent_3": "20.00",
      "reserveBeginDate": "2012-10-03",
      "reserveEndDate": "2012-10-30",
      "termOfNotice": 7,
      "updatedBy": "lasse",
      "updatedTs": "2013-01-16T06:33:48Z"
    },
    {
      "agreement": "TEST_CASE",
      "antenna": 2,
      "billing": {
        "availability_end_ts": null,
        "availability_start_ts": null,
        "available": true,
        "groupname": "ELECTRIC_BIL_TYPE",
        "id": 14310,
        "list_url": "https://keypro.example.com/api/v2/txt_constants/groupname/ELECTRIC_BIL_TYPE/",
        "logical_txt": "Oma mittari",
        "num_value": null,
        "num_value2": null,
        "num_value3": null,
        "num_value4": null,
        "txt": "Oma mittari"
      },
      "billingDay": 15,
      "billingPeriod": 2,
      "billingReference": "765432",
      "cableUsage": "Diipa daapaa",
      "comment": "aölskjföalkjf",
      "contractStatus": {
        "availability_end_ts": null,
        "availability_start_ts": null,
        "available": true,
        "groupname": "RENT_STATUS",
        "id": 1350,
        "list_url": "https://keypro.example.com/api/v2/txt_constants/groupname/RENT_STATUS/",
        "logical_txt": "Vuokrattu",
        "num_value": 2.0,
        "num_value2": null,
        "num_value3": 2.0,
        "num_value4": 1.0,
        "txt": "Vuokrattu"
      },
      "contractType": {
        "availability_end_ts": null,
        "availability_start_ts": null,
        "available": true,
        "groupname": "CONTRACT_TYPE",
        "id": 14250,
        "list_url": "https://keypro.example.com/api/v2/txt_constants/groupname/CONTRACT_TYPE/",
        "logical_txt": "Vuokrasopimus",
        "num_value": null,
        "num_value2": null,
        "num_value3": null,
        "num_value4": null,
        "txt": "Vuokrasopimus"
      },
      "createdBy": "lasse",
      "createdTs": "2012-10-10T03:19:08Z",
      "id": 4810,
      "lessee": {
        "address": {
          "address": {
            "apartments": [
              "https://keypro.example.com/api/v2/apartments/14536/"
            ],
            "buildingId": "",
            "city": "LOVISA",
            "cityAlt": "",
            "country": "",
            "createdBy": "",
            "createdTs": null,
            "district": "",
            "empty": 0,
            "id": 173470,
            "listUrl": "https://keypro.example.com/api/v2/addresses/",
            "location": null,
            "municipality": "",
            "propertyId": "",
            "province": "",
            "streetname": "INGENJÖRSVÄGEN",
            "streetnameAlt": "",
            "streetno": "2",
            "subdivision": "",
            "updatedBy": "KEYCOM_STAGE30",
            "updatedTs": "2018-01-11T06:00:23Z",
            "usagePurpose": {
              "availability_end_ts": null,
              "availability_start_ts": null,
              "available": true,
              "groupname": "BUILDING_USAGE",
              "id": 233970,
              "list_url": "https://keypro.example.com/api/v2/txt_constants/groupname/BUILDING_USAGE/",
              "logical_txt": "Asuinrakennus",
              "num_value": null,
              "num_value2": null,
              "num_value3": 1.0,
              "num_value4": null,
              "txt": "Asuinrakennus"
            },
            "usagePurposeAlt": null,
            "zipcode": 7900
          },
          "apartmentDivision": "",
          "apartmentLetter": "",
          "apartmentNumber": "",
          "empty": 1,
          "id": 14536,
          "listUrl": "https://keypro.example.com/api/v2/apartments/",
          "originProperty": "//0000000014536",
          "originalStreetno": "2",
          "usagePurpose": null,
          "usagePurposeAlt": null,
          "usageState": null
        },
        "addressAlt": null,
        "billingName": "",
        "businessId": "",
        "createdBy": "",
        "createdTs": null,
        "email": "janne.testicase@keypro.fi",
        "id": 35866041,
        "listUrl": "https://keypro.example.com/api/v2/customers/",
        "mobilePhone": "",
        "name": "0ra Janne",
        "number": "35866041",
        "phone": "019 533353",
        "smsProhibited": null,
        "telefax": "",
        "type": {
          "availability_end_ts": null,
          "availability_start_ts": null,
          "available": true,
          "groupname": "KN_CUST_TYPE",
          "id": 6010,
          "list_url": "https://keypro.example.com/api/v2/txt_constants/groupname/KN_CUST_TYPE/",
          "logical_txt": "Yksityishenkilö",
          "num_value": 1.0,
          "num_value2": null,
          "num_value3": null,
          "num_value4": null,
          "txt": "Yksityishenkilö"
        },
        "updatedBy": "",
        "updatedTs": null
      },
      "lessor": {
        "address": {
          "address": {
            "apartments": [
              "https://keypro.example.com/api/v2/apartments/5198/"
            ],
            "buildingId": "",
            "city": "LOVIISA",
            "cityAlt": "",
            "country": "",
            "createdBy": "",
            "createdTs": null,
            "district": "",
            "empty": 0,
            "id": 3350,
            "listUrl": "https://keypro.example.com/api/v2/addresses/",
            "location": null,
            "municipality": "",
            "propertyId": "",
            "province": "",
            "streetname": "MANNERHEIMINKATU",
            "streetnameAlt": "",
            "streetno": "4",
            "subdivision": "",
            "updatedBy": "gdpr_disabled_user",
            "updatedTs": "2020-08-14T02:53:40Z",
            "usagePurpose": {
              "availability_end_ts": null,
              "availability_start_ts": null,
              "available": true,
              "groupname": "BUILDING_USAGE",
              "id": 233970,
              "list_url": "https://keypro.example.com/api/v2/txt_constants/groupname/BUILDING_USAGE/",
              "logical_txt": "Asuinrakennus",
              "num_value": null,
              "num_value2": null,
              "num_value3": 1.0,
              "num_value4": null,
              "txt": "Asuinrakennus"
            },
            "usagePurposeAlt": {
              "availability_end_ts": null,
              "availability_start_ts": null,
              "available": true,
              "groupname": "KN_ADDR_SPEC",
              "id": 266390,
              "list_url": "https://keypro.example.com/api/v2/txt_constants/groupname/KN_ADDR_SPEC/",
              "logical_txt": "Korjattu",
              "num_value": null,
              "num_value2": null,
              "num_value3": null,
              "num_value4": 1.0,
              "txt": "Korjattu"
            },
            "zipcode": 7900
          },
          "apartmentDivision": "",
          "apartmentLetter": "",
          "apartmentNumber": "",
          "empty": 1,
          "id": 5198,
          "listUrl": "https://keypro.example.com/api/v2/apartments/",
          "originProperty": "//0000000005198",
          "originalStreetno": "4",
          "usagePurpose": null,
          "usagePurposeAlt": null,
          "usageState": null
        },
        "addressAlt": null,
        "billingName": "",
        "businessId": "",
        "createdBy": "",
        "createdTs": null,
        "email": "",
        "id": 35900641,
        "listUrl": "https://keypro.example.com/api/v2/customers/",
        "mobilePhone": "",
        "name": "Lpo",
        "number": "35900641",
        "phone": "019 555441",
        "smsProhibited": null,
        "telefax": "",
        "type": {
          "availability_end_ts": null,
          "availability_start_ts": null,
          "available": true,
          "groupname": "KN_CUST_TYPE",
          "id": 6010,
          "list_url": "https://keypro.example.com/api/v2/txt_constants/groupname/KN_CUST_TYPE/",
          "logical_txt": "Yksityishenkilö",
          "num_value": 1.0,
          "num_value2": null,
          "num_value3": null,
          "num_value4": null,
          "txt": "Yksityishenkilö"
        },
        "updatedBy": "",
        "updatedTs": null
      },
      "parentContract": null,
      "rent": "123.00",
      "rentBeginDate": "2012-10-11",
      "rentEndDate": "2012-10-26",
      "rent_2": "432.00",
      "rent_3": "1357.00",
      "reserveBeginDate": "2012-10-18",
      "reserveEndDate": "2012-10-30",
      "termOfNotice": 66,
      "updatedBy": "lasse",
      "updatedTs": "2012-10-10T04:03:08Z"
    },
    {
      "agreement": "DEMO 100",
      "antenna": null,
      "billing": null,
      "billingDay": null,
      "billingPeriod": null,
      "billingReference": "",
      "cableUsage": "",
      "comment": "",
      "contractStatus": {
        "availability_end_ts": null,
        "availability_start_ts": null,
        "available": true,
        "groupname": "RENT_STATUS",
        "id": 1330,
        "list_url": "https://keypro.example.com/api/v2/txt_constants/groupname/RENT_STATUS/",
        "logical_txt": "Varattu",
        "num_value": 0.0,
        "num_value2": null,
        "num_value3": 1.0,
        "num_value4": 5.0,
        "txt": "Varattu"
      },
      "contractType": {
        "availability_end_ts": null,
        "availability_start_ts": null,
        "available": true,
        "groupname": "CONTRACT_TYPE",
        "id": 14250,
        "list_url": "https://keypro.example.com/api/v2/txt_constants/groupname/CONTRACT_TYPE/",
        "logical_txt": "Vuokrasopimus",
        "num_value": null,
        "num_value2": null,
        "num_value3": null,
        "num_value4": null,
        "txt": "Vuokrasopimus"
      },
      "createdBy": "lasse",
      "createdTs": "2012-10-10T04:06:51Z",
      "id": 4890,
      "lessee": null,
      "lessor": null,
      "parentContract": null,
      "rent": null,
      "rentBeginDate": null,
      "rentEndDate": null,
      "rent_2": null,
      "rent_3": null,
      "reserveBeginDate": null,
      "reserveEndDate": null,
      "termOfNotice": null,
      "updatedBy": "kim",
      "updatedTs": "2013-01-22T01:31:47Z"
    },
    {
      "agreement": "324234",
      "antenna": null,
      "billing": null,
      "billingDay": null,
      "billingPeriod": null,
      "billingReference": "",
      "cableUsage": "",
      "comment": "this is future test",
      "contractStatus": null,
      "contractType": null,
      "createdBy": "demo",
      "createdTs": "2012-10-18T09:00:04Z",
      "id": 5230,
      "lessee": null,
      "lessor": null,
      "parentContract": null,
      "rent": null,
      "rentBeginDate": null,
      "rentEndDate": null,
      "rent_2": null,
      "rent_3": null,
      "reserveBeginDate": null,
      "reserveEndDate": null,
      "termOfNotice": null,
      "updatedBy": "example@example.com",
      "updatedTs": "2022-02-04T07:38:56Z"
    },
    {
      "agreement": "990099",
      "antenna": null,
      "billing": null,
      "billingDay": null,
      "billingPeriod": null,
      "billingReference": "",
      "cableUsage": "",
      "comment": "",
      "contractStatus": null,
      "contractType": null,
      "createdBy": "demo",
      "createdTs": "2012-10-18T09:13:36Z",
      "id": 5290,
      "lessee": null,
      "lessor": null,
      "parentContract": null,
      "rent": null,
      "rentBeginDate": null,
      "rentEndDate": null,
      "rent_2": null,
      "rent_3": null,
      "reserveBeginDate": null,
      "reserveEndDate": null,
      "termOfNotice": null,
      "updatedBy": "demo",
      "updatedTs": "2012-10-18T09:13:36Z"
    },
    {
      "agreement": "2323232",
      "antenna": null,
      "billing": null,
      "billingDay": null,
      "billingPeriod": null,
      "billingReference": "",
      "cableUsage": "",
      "comment": "",
      "contractStatus": null,
      "contractType": null,
      "createdBy": "timo",
      "createdTs": "2012-10-19T12:28:23Z",
      "id": 5330,
      "lessee": null,
      "lessor": null,
      "parentContract": null,
      "rent": null,
      "rentBeginDate": null,
      "rentEndDate": null,
      "rent_2": null,
      "rent_3": null,
      "reserveBeginDate": null,
      "reserveEndDate": null,
      "termOfNotice": null,
      "updatedBy": "lasse",
      "updatedTs": "2013-01-28T02:25:04Z"
    }
  ],
  "Total": 116
}

Expand All

object

string (url)

Url to next page of Contracts. Null if No next page exist

string (url)

Url to previous page of Contracts. Null if No previous page exist

Results

Array of object (Contract)

List of fetched Contracts

object

agreement

string

Agreements in Contract

antenna

integer

Contract antenna

billing

object (ContractBilling)

Contract billing type

availability_end_ts

string (date-time)

Ending date time for availability

availability_start_ts

string (date-time)

Beginning date time for availability

available

boolean

Is object deemed as available. Based on availability_start_ts and availability_end_ts values.

groupname

Group name of constant

Valid values[ "ELECTRIC_BIL_TYPE" ]

integer

Unique id of constant

list_url

string (url)

Url to fetch all contants from this group

logical_txt

string

Logical textual value

num_value

number (float)

Numeric value

num_value2

number (float)

Numeric value 2

num_value3

number (float)

Numeric value 3

num_value4

number (float)

Numeric value 4

txt

string

Human readable textual representation

billingDay

integer

Contract billing day

billingPeriod

integer

Contract billing period

billingReference

string

Contract billing reference

cableUsage

string

Contract billing cable usage

comments

string

Contract comments

contractStatus

object (ContractStatus)

Contract status

availability_end_ts

string (date-time)

Ending date time for availability

availability_start_ts

string (date-time)

Beginning date time for availability

available

boolean

Is object deemed as available. Based on availability_start_ts and availability_end_ts values.

groupname

Group name of constant

Valid values[ "RENT_STATUS" ]

integer

Unique id of constant

list_url

string (url)

Url to fetch all contants from this group

logical_txt

string

Logical textual value

num_value

number (float)

Numeric value

num_value2

number (float)

Numeric value 2

num_value3

number (float)

Numeric value 3

num_value4

number (float)

Numeric value 4

txt

string

Human readable textual representation

contractType

object (ContractType)

Contract type

availability_end_ts

string (date-time)

Ending date time for availability

availability_start_ts

string (date-time)

Beginning date time for availability

available

boolean

Is object deemed as available. Based on availability_start_ts and availability_end_ts values.

groupname

Group name of constant

Valid values[ "CONTRACT_TYPE" ]

integer

Unique id of constant

list_url

string (url)

Url to fetch all contants from this group

logical_txt

string

Logical textual value

num_value

number (float)

Numeric value

num_value2

number (float)

Numeric value 2

num_value3

number (float)

Numeric value 3

num_value4

number (float)

Numeric value 4

txt

string

Human readable textual representation

createdBy

string

creator

createdTs

string (date-time)

Creation date and time

integer

Primary key

lessee

object (Customer)

address

object (Apartment)

address

object (Address)

buildingId

string

Building id

buildingName

string

Building name

city

string

Building city name

cityAlt

string

Building city name in alternative language

country

string

Building country

createdBy

string

creator

createdTs

string (date-time)

Creation date and time

district

string

Building district

empty

integer

Address with this value as 1 is default address. Modifying or deleting such address is prohibited.

Valid values[ 0, 1 ]

integer

Primary key

location

string (ewkt)

Geographical location

municipality

string

Building municipality

propertyId

string

Property number

province

string

Building province

sourceSystem

object (SourceSystem)

External source system

availability_end_ts

string (date-time)

Ending date time for availability

availability_start_ts

string (date-time)

Beginning date time for availability

available

boolean

Is object deemed as available. Based on availability_start_ts and availability_end_ts values.

groupname

Group name of constant

Valid values[ "SOURCE_SYSTEM" ]

integer

Unique id of constant

list_url

string (url)

Url to fetch all contants from this group

logical_txt

string

Logical textual value

num_value

number (float)

Numeric value

num_value2

number (float)

Numeric value 2

num_value3

number (float)

Numeric value 3

num_value4

number (float)

Numeric value 4

txt

string

Human readable textual representation

sourceSystemKey

integer

source system key

streetname

string

Building street name

streetnameAlt

string

Building street name in alternative language

streetno

string

Building number

subdivision

string

Building municipality subdivision

updatedBy

string

Last updater

updatedTs

string (date-time)

Last update date time

usagePurpose

object (BuildingUsage)

Building usage purpose

availability_end_ts

string (date-time)

Ending date time for availability

availability_start_ts

string (date-time)

Beginning date time for availability

available

boolean

Is object deemed as available. Based on availability_start_ts and availability_end_ts values.

groupname

Group name of constant

Valid values[ "BUILDING_USAGE" ]

integer

Unique id of constant

list_url

string (url)

Url to fetch all contants from this group

logical_txt

string

Logical textual value

num_value

number (float)

Numeric value

num_value2

number (float)

Numeric value 2

num_value3

number (float)

Numeric value 3

num_value4

number (float)

Numeric value 4

txt

string

Human readable textual representation

usagePurposeAlt

object (AddressSecondaryUsage)

Address usage purpose

availability_end_ts

string (date-time)

Ending date time for availability

availability_start_ts

string (date-time)

Beginning date time for availability

available

boolean

Is object deemed as available. Based on availability_start_ts and availability_end_ts values.

groupname

Group name of constant

Valid values[ "KN_ADDR_SPEC" ]

integer

Unique id of constant

list_url

string (url)

Url to fetch all contants from this group

logical_txt

string

Logical textual value

num_value

number (float)

Numeric value

num_value2

number (float)

Numeric value 2

num_value3

number (float)

Numeric value 3

num_value4

number (float)

Numeric value 4

txt

string

Human readable textual representation

zipcode

string

Building zipcode

apartmentDivision

string

apartment division

apartmentLetter

string

apartment letter

apartmentNumber

string

apartment number

empty

integer

Apartment with this value as 1 is default apartment. Modifying or deleting such apartment is prohibited.

Valid values[ 0, 1 ]

integer

Primary key

originProperty

string

apartment original property id

originalStreetno

string

apartment original streen number

sourceSystem

object (SourceSystem)

External source system

availability_end_ts

string (date-time)

Ending date time for availability

availability_start_ts

string (date-time)

Beginning date time for availability

available

boolean

Is object deemed as available. Based on availability_start_ts and availability_end_ts values.

groupname

Group name of constant

Valid values[ "SOURCE_SYSTEM" ]

integer

Unique id of constant

list_url

string (url)

Url to fetch all contants from this group

logical_txt

string

Logical textual value

num_value

number (float)

Numeric value

num_value2

number (float)

Numeric value 2

num_value3

number (float)

Numeric value 3

num_value4

number (float)

Numeric value 4

txt

string

Human readable textual representation

sourceSystemKey

integer

source system key

usagePurpose

object (ApartmentUsage)

Apartment Usage purpose

availability_end_ts

string (date-time)

Ending date time for availability

availability_start_ts

string (date-time)

Beginning date time for availability

available

boolean

Is object deemed as available. Based on availability_start_ts and availability_end_ts values.

groupname

Group name of constant

Valid values[ "APARTMENT_USAGE" ]

integer

Unique id of constant

list_url

string (url)

Url to fetch all contants from this group

logical_txt

string

Logical textual value

num_value

number (float)

Numeric value

num_value2

number (float)

Numeric value 2

num_value3

number (float)

Numeric value 3

num_value4

number (float)

Numeric value 4

txt

string

Human readable textual representation

usagePurposeAlt

object (AddressSecondaryUsage)

Address usage purpose

availability_end_ts

string (date-time)

Ending date time for availability

availability_start_ts

string (date-time)

Beginning date time for availability

available

boolean

Is object deemed as available. Based on availability_start_ts and availability_end_ts values.

groupname

Group name of constant

Valid values[ "KN_ADDR_SPEC" ]

integer

Unique id of constant

list_url

string (url)

Url to fetch all contants from this group

logical_txt

string

Logical textual value

num_value

number (float)

Numeric value

num_value2

number (float)

Numeric value 2

num_value3

number (float)

Numeric value 3

num_value4

number (float)

Numeric value 4

txt

string

Human readable textual representation

usageState

object (ApartmentStatus)

Apartment status

availability_end_ts

string (date-time)

Ending date time for availability

availability_start_ts

string (date-time)

Beginning date time for availability

available

boolean

Is object deemed as available. Based on availability_start_ts and availability_end_ts values.

groupname

Group name of constant

Valid values[ "APARTMENT_STATUS" ]

integer

Unique id of constant

list_url

string (url)

Url to fetch all contants from this group

logical_txt

string

Logical textual value

num_value

number (float)

Numeric value

num_value2

number (float)

Numeric value 2

num_value3

number (float)

Numeric value 3

num_value4

number (float)

Numeric value 4

txt

string

Human readable textual representation

addressAlt

object (Apartment)

address

object (Address)

buildingId

string

Building id

buildingName

string

Building name

city

string

Building city name

cityAlt

string

Building city name in alternative language

country

string

Building country

createdBy

string

creator

createdTs

string (date-time)

Creation date and time

district

string

Building district

empty

integer

Address with this value as 1 is default address. Modifying or deleting such address is prohibited.

Valid values[ 0, 1 ]

integer

Primary key

location

string (ewkt)

Geographical location

municipality

string

Building municipality

propertyId

string

Property number

province

string

Building province

sourceSystem

object (SourceSystem)

External source system

availability_end_ts

string (date-time)

Ending date time for availability

availability_start_ts

string (date-time)

Beginning date time for availability

available

boolean

Is object deemed as available. Based on availability_start_ts and availability_end_ts values.

groupname

Group name of constant

Valid values[ "SOURCE_SYSTEM" ]

integer

Unique id of constant

list_url

string (url)

Url to fetch all contants from this group

logical_txt

string

Logical textual value

num_value

number (float)

Numeric value

num_value2

number (float)

Numeric value 2

num_value3

number (float)

Numeric value 3

num_value4

number (float)

Numeric value 4

txt

string

Human readable textual representation

sourceSystemKey

integer

source system key

streetname

string

Building street name

streetnameAlt

string

Building street name in alternative language

streetno

string

Building number

subdivision

string

Building municipality subdivision

updatedBy

string

Last updater

updatedTs

string (date-time)

Last update date time

usagePurpose

object (BuildingUsage)

Building usage purpose

availability_end_ts

string (date-time)

Ending date time for availability

availability_start_ts

string (date-time)

Beginning date time for availability

available

boolean

Is object deemed as available. Based on availability_start_ts and availability_end_ts values.

groupname

Group name of constant

Valid values[ "BUILDING_USAGE" ]

integer

Unique id of constant

list_url

string (url)

Url to fetch all contants from this group

logical_txt

string

Logical textual value

num_value

number (float)

Numeric value

num_value2

number (float)

Numeric value 2

num_value3

number (float)

Numeric value 3

num_value4

number (float)

Numeric value 4

txt

string

Human readable textual representation

usagePurposeAlt

object (AddressSecondaryUsage)

Address usage purpose

availability_end_ts

string (date-time)

Ending date time for availability

availability_start_ts

string (date-time)

Beginning date time for availability

available

boolean

Is object deemed as available. Based on availability_start_ts and availability_end_ts values.

groupname

Group name of constant

Valid values[ "KN_ADDR_SPEC" ]

integer

Unique id of constant

list_url

string (url)

Url to fetch all contants from this group

logical_txt

string

Logical textual value

num_value

number (float)

Numeric value

num_value2

number (float)

Numeric value 2

num_value3

number (float)

Numeric value 3

num_value4

number (float)

Numeric value 4

txt

string

Human readable textual representation

zipcode

string

Building zipcode

apartmentDivision

string

apartment division

apartmentLetter

string

apartment letter

apartmentNumber

string

apartment number

empty

integer

Apartment with this value as 1 is default apartment. Modifying or deleting such apartment is prohibited.

Valid values[ 0, 1 ]

integer

Primary key

originProperty

string

apartment original property id

originalStreetno

string

apartment original streen number

sourceSystem

object (SourceSystem)

External source system

availability_end_ts

string (date-time)

Ending date time for availability

availability_start_ts

string (date-time)

Beginning date time for availability

available

boolean

Is object deemed as available. Based on availability_start_ts and availability_end_ts values.

groupname

Group name of constant

Valid values[ "SOURCE_SYSTEM" ]

integer

Unique id of constant

list_url

string (url)

Url to fetch all contants from this group

logical_txt

string

Logical textual value

num_value

number (float)

Numeric value

num_value2

number (float)

Numeric value 2

num_value3

number (float)

Numeric value 3

num_value4

number (float)

Numeric value 4

txt

string

Human readable textual representation

sourceSystemKey

integer

source system key

usagePurpose

object (ApartmentUsage)

Apartment Usage purpose

availability_end_ts

string (date-time)

Ending date time for availability

availability_start_ts

string (date-time)

Beginning date time for availability

available

boolean

Is object deemed as available. Based on availability_start_ts and availability_end_ts values.

groupname

Group name of constant

Valid values[ "APARTMENT_USAGE" ]

integer

Unique id of constant

list_url

string (url)

Url to fetch all contants from this group

logical_txt

string

Logical textual value

num_value

number (float)

Numeric value

num_value2

number (float)

Numeric value 2

num_value3

number (float)

Numeric value 3

num_value4

number (float)

Numeric value 4

txt

string

Human readable textual representation

usagePurposeAlt

object (AddressSecondaryUsage)

Address usage purpose

availability_end_ts

string (date-time)

Ending date time for availability

availability_start_ts

string (date-time)

Beginning date time for availability

available

boolean

Is object deemed as available. Based on availability_start_ts and availability_end_ts values.

groupname

Group name of constant

Valid values[ "KN_ADDR_SPEC" ]

integer

Unique id of constant

list_url

string (url)

Url to fetch all contants from this group

logical_txt

string

Logical textual value

num_value

number (float)

Numeric value

num_value2

number (float)

Numeric value 2

num_value3

number (float)

Numeric value 3

num_value4

number (float)

Numeric value 4

txt

string

Human readable textual representation

usageState

object (ApartmentStatus)

Apartment status

availability_end_ts

string (date-time)

Ending date time for availability

availability_start_ts

string (date-time)

Beginning date time for availability

available

boolean

Is object deemed as available. Based on availability_start_ts and availability_end_ts values.

groupname

Group name of constant

Valid values[ "APARTMENT_STATUS" ]

integer

Unique id of constant

list_url

string (url)

Url to fetch all contants from this group

logical_txt

string

Logical textual value

num_value

number (float)

Numeric value

num_value2

number (float)

Numeric value 2

num_value3

number (float)

Numeric value 3

num_value4

number (float)

Numeric value 4

txt

string

Human readable textual representation

billingName

string

Customer billing name

businessId

string

Customer bussiness id

createdBy

string

creator

createdTs

string (date-time)

Creation date and time

string

Customer email

integer

Primary key

mobilePhone

string

Customer mobile phone number name

name

string

Customer name

number

string

Customer number

phone

string

Customer phone number

smsProhibited

boolean

Sending sms is prohibited to customer

telefax

string

Customer fax number

type

object (CustomerType)

Customer type

availability_end_ts

string (date-time)

Ending date time for availability

availability_start_ts

string (date-time)

Beginning date time for availability

available

boolean

Is object deemed as available. Based on availability_start_ts and availability_end_ts values.

groupname

Group name of constant

Valid values[ "KN_CUST_TYPE" ]

integer

Unique id of constant

list_url

string (url)

Url to fetch all contants from this group

logical_txt

string

Logical textual value

num_value

number (float)

Numeric value

num_value2

number (float)

Numeric value 2

num_value3

number (float)

Numeric value 3

num_value4

number (float)

Numeric value 4

txt

string

Human readable textual representation

updatedBy

string

Last updater

updatedTs

string (date-time)

Last update date time

lessor

object (Customer)

address

object (Apartment)

address

object (Address)

buildingId

string

Building id

buildingName

string

Building name

city

string

Building city name

cityAlt

string

Building city name in alternative language

country

string

Building country

createdBy

string

creator

createdTs

string (date-time)

Creation date and time

district

string

Building district

empty

integer

Address with this value as 1 is default address. Modifying or deleting such address is prohibited.

Valid values[ 0, 1 ]

integer

Primary key

location

string (ewkt)

Geographical location

municipality

string

Building municipality

propertyId

string

Property number

province

string

Building province

sourceSystem

object (SourceSystem)

External source system

availability_end_ts

string (date-time)

Ending date time for availability

availability_start_ts

string (date-time)

Beginning date time for availability

available

boolean

Is object deemed as available. Based on availability_start_ts and availability_end_ts values.

groupname

Group name of constant

Valid values[ "SOURCE_SYSTEM" ]

integer

Unique id of constant

list_url

string (url)

Url to fetch all contants from this group

logical_txt

string

Logical textual value

num_value

number (float)

Numeric value

num_value2

number (float)

Numeric value 2

num_value3

number (float)

Numeric value 3

num_value4

number (float)

Numeric value 4

txt

string

Human readable textual representation

sourceSystemKey

integer

source system key

streetname

string

Building street name

streetnameAlt

string

Building street name in alternative language

streetno

string

Building number

subdivision

string

Building municipality subdivision

updatedBy

string

Last updater

updatedTs

string (date-time)

Last update date time

usagePurpose

object (BuildingUsage)

Building usage purpose

availability_end_ts

string (date-time)

Ending date time for availability

availability_start_ts

string (date-time)

Beginning date time for availability

available

boolean

Is object deemed as available. Based on availability_start_ts and availability_end_ts values.

groupname

Group name of constant

Valid values[ "BUILDING_USAGE" ]

integer

Unique id of constant

list_url

string (url)

Url to fetch all contants from this group

logical_txt

string

Logical textual value

num_value

number (float)

Numeric value

num_value2

number (float)

Numeric value 2

num_value3

number (float)

Numeric value 3

num_value4

number (float)

Numeric value 4

txt

string

Human readable textual representation

usagePurposeAlt

object (AddressSecondaryUsage)

Address usage purpose

availability_end_ts

string (date-time)

Ending date time for availability

availability_start_ts

string (date-time)

Beginning date time for availability

available

boolean

Is object deemed as available. Based on availability_start_ts and availability_end_ts values.

groupname

Group name of constant

Valid values[ "KN_ADDR_SPEC" ]

integer

Unique id of constant

list_url

string (url)

Url to fetch all contants from this group

logical_txt

string

Logical textual value

num_value

number (float)

Numeric value

num_value2

number (float)

Numeric value 2

num_value3

number (float)

Numeric value 3

num_value4

number (float)

Numeric value 4

txt

string

Human readable textual representation

zipcode

string

Building zipcode

apartmentDivision

string

apartment division

apartmentLetter

string

apartment letter

apartmentNumber

string

apartment number

empty

integer

Apartment with this value as 1 is default apartment. Modifying or deleting such apartment is prohibited.

Valid values[ 0, 1 ]

integer

Primary key

originProperty

string

apartment original property id

originalStreetno

string

apartment original streen number

sourceSystem

object (SourceSystem)

External source system

availability_end_ts

string (date-time)

Ending date time for availability

availability_start_ts

string (date-time)

Beginning date time for availability

available

boolean

Is object deemed as available. Based on availability_start_ts and availability_end_ts values.

groupname

Group name of constant

Valid values[ "SOURCE_SYSTEM" ]

integer

Unique id of constant

list_url

string (url)

Url to fetch all contants from this group

logical_txt

string

Logical textual value

num_value

number (float)

Numeric value

num_value2

number (float)

Numeric value 2

num_value3

number (float)

Numeric value 3

num_value4

number (float)

Numeric value 4

txt

string

Human readable textual representation

sourceSystemKey

integer

source system key

usagePurpose

object (ApartmentUsage)

Apartment Usage purpose

availability_end_ts

string (date-time)

Ending date time for availability

availability_start_ts

string (date-time)

Beginning date time for availability

available

boolean

Is object deemed as available. Based on availability_start_ts and availability_end_ts values.

groupname

Group name of constant

Valid values[ "APARTMENT_USAGE" ]

integer

Unique id of constant

list_url

string (url)

Url to fetch all contants from this group

logical_txt

string

Logical textual value

num_value

number (float)

Numeric value

num_value2

number (float)

Numeric value 2

num_value3

number (float)

Numeric value 3

num_value4

number (float)

Numeric value 4

txt

string

Human readable textual representation

usagePurposeAlt

object (AddressSecondaryUsage)

Address usage purpose

availability_end_ts

string (date-time)

Ending date time for availability

availability_start_ts

string (date-time)

Beginning date time for availability

available

boolean

Is object deemed as available. Based on availability_start_ts and availability_end_ts values.

groupname

Group name of constant

Valid values[ "KN_ADDR_SPEC" ]

integer

Unique id of constant

list_url

string (url)

Url to fetch all contants from this group

logical_txt

string

Logical textual value

num_value

number (float)

Numeric value

num_value2

number (float)

Numeric value 2

num_value3

number (float)

Numeric value 3

num_value4

number (float)

Numeric value 4

txt

string

Human readable textual representation

usageState

object (ApartmentStatus)

Apartment status

availability_end_ts

string (date-time)

Ending date time for availability

availability_start_ts

string (date-time)

Beginning date time for availability

available

boolean

Is object deemed as available. Based on availability_start_ts and availability_end_ts values.

groupname

Group name of constant

Valid values[ "APARTMENT_STATUS" ]

integer

Unique id of constant

list_url

string (url)

Url to fetch all contants from this group

logical_txt

string

Logical textual value

num_value

number (float)

Numeric value

num_value2

number (float)

Numeric value 2

num_value3

number (float)

Numeric value 3

num_value4

number (float)

Numeric value 4

txt

string

Human readable textual representation

addressAlt

object (Apartment)

address

object (Address)

buildingId

string

Building id

buildingName

string

Building name

city

string

Building city name

cityAlt

string

Building city name in alternative language

country

string

Building country

createdBy

string

creator

createdTs

string (date-time)

Creation date and time

district

string

Building district

empty

integer

Address with this value as 1 is default address. Modifying or deleting such address is prohibited.

Valid values[ 0, 1 ]

integer

Primary key

location

string (ewkt)

Geographical location

municipality

string

Building municipality

propertyId

string

Property number

province

string

Building province

sourceSystem

object (SourceSystem)

External source system

availability_end_ts

string (date-time)

Ending date time for availability

availability_start_ts

string (date-time)

Beginning date time for availability

available

boolean

Is object deemed as available. Based on availability_start_ts and availability_end_ts values.

groupname

Group name of constant

Valid values[ "SOURCE_SYSTEM" ]

integer

Unique id of constant

list_url

string (url)

Url to fetch all contants from this group

logical_txt

string

Logical textual value

num_value

number (float)

Numeric value

num_value2

number (float)

Numeric value 2

num_value3

number (float)

Numeric value 3

num_value4

number (float)

Numeric value 4

txt

string

Human readable textual representation

sourceSystemKey

integer

source system key

streetname

string

Building street name

streetnameAlt

string

Building street name in alternative language

streetno

string

Building number

subdivision

string

Building municipality subdivision

updatedBy

string

Last updater

updatedTs

string (date-time)

Last update date time

usagePurpose

object (BuildingUsage)

Building usage purpose

availability_end_ts

string (date-time)

Ending date time for availability

availability_start_ts

string (date-time)

Beginning date time for availability

available

boolean

Is object deemed as available. Based on availability_start_ts and availability_end_ts values.

groupname

Group name of constant

Valid values[ "BUILDING_USAGE" ]

integer

Unique id of constant

list_url

string (url)

Url to fetch all contants from this group

logical_txt

string

Logical textual value

num_value

number (float)

Numeric value

num_value2

number (float)

Numeric value 2

num_value3

number (float)

Numeric value 3

num_value4

number (float)

Numeric value 4

txt

string

Human readable textual representation

usagePurposeAlt

object (AddressSecondaryUsage)

Address usage purpose

availability_end_ts

string (date-time)

Ending date time for availability

availability_start_ts

string (date-time)

Beginning date time for availability

available

boolean

Is object deemed as available. Based on availability_start_ts and availability_end_ts values.

groupname

Group name of constant

Valid values[ "KN_ADDR_SPEC" ]

integer

Unique id of constant

list_url

string (url)

Url to fetch all contants from this group

logical_txt

string

Logical textual value

num_value

number (float)

Numeric value

num_value2

number (float)

Numeric value 2

num_value3

number (float)

Numeric value 3

num_value4

number (float)

Numeric value 4

txt

string

Human readable textual representation

zipcode

string

Building zipcode

apartmentDivision

string

apartment division

apartmentLetter

string

apartment letter

apartmentNumber

string

apartment number

empty

integer

Apartment with this value as 1 is default apartment. Modifying or deleting such apartment is prohibited.

Valid values[ 0, 1 ]

integer

Primary key

originProperty

string

apartment original property id

originalStreetno

string

apartment original streen number

sourceSystem

object (SourceSystem)

External source system

availability_end_ts

string (date-time)

Ending date time for availability

availability_start_ts

string (date-time)

Beginning date time for availability

available

boolean

Is object deemed as available. Based on availability_start_ts and availability_end_ts values.

groupname

Group name of constant

Valid values[ "SOURCE_SYSTEM" ]

integer

Unique id of constant

list_url

string (url)

Url to fetch all contants from this group

logical_txt

string

Logical textual value

num_value

number (float)

Numeric value

num_value2

number (float)

Numeric value 2

num_value3

number (float)

Numeric value 3

num_value4

number (float)

Numeric value 4

txt

string

Human readable textual representation

sourceSystemKey

integer

source system key

usagePurpose

object (ApartmentUsage)

Apartment Usage purpose

availability_end_ts

string (date-time)

Ending date time for availability

availability_start_ts

string (date-time)

Beginning date time for availability

available

boolean

Is object deemed as available. Based on availability_start_ts and availability_end_ts values.

groupname

Group name of constant

Valid values[ "APARTMENT_USAGE" ]

integer

Unique id of constant

list_url

string (url)

Url to fetch all contants from this group

logical_txt

string

Logical textual value

num_value

number (float)

Numeric value

num_value2

number (float)

Numeric value 2

num_value3

number (float)

Numeric value 3

num_value4

number (float)

Numeric value 4

txt

string

Human readable textual representation

usagePurposeAlt

object (AddressSecondaryUsage)

Address usage purpose

availability_end_ts

string (date-time)

Ending date time for availability

availability_start_ts

string (date-time)

Beginning date time for availability

available

boolean

Is object deemed as available. Based on availability_start_ts and availability_end_ts values.

groupname

Group name of constant

Valid values[ "KN_ADDR_SPEC" ]

integer

Unique id of constant

list_url

string (url)

Url to fetch all contants from this group

logical_txt

string

Logical textual value

num_value

number (float)

Numeric value

num_value2

number (float)

Numeric value 2

num_value3

number (float)

Numeric value 3

num_value4

number (float)

Numeric value 4

txt

string

Human readable textual representation

usageState

object (ApartmentStatus)

Apartment status

availability_end_ts

string (date-time)

Ending date time for availability

availability_start_ts

string (date-time)

Beginning date time for availability

available

boolean

Is object deemed as available. Based on availability_start_ts and availability_end_ts values.

groupname

Group name of constant

Valid values[ "APARTMENT_STATUS" ]

integer

Unique id of constant

list_url

string (url)

Url to fetch all contants from this group

logical_txt

string

Logical textual value

num_value

number (float)

Numeric value

num_value2

number (float)

Numeric value 2

num_value3

number (float)

Numeric value 3

num_value4

number (float)

Numeric value 4

txt

string

Human readable textual representation

billingName

string

Customer billing name

businessId

string

Customer bussiness id

createdBy

string

creator

createdTs

string (date-time)

Creation date and time

string

Customer email

integer

Primary key

mobilePhone

string

Customer mobile phone number name

name

string

Customer name

number

string

Customer number

phone

string

Customer phone number

smsProhibited

boolean

Sending sms is prohibited to customer

telefax

string

Customer fax number

type

object (CustomerType)

Customer type

availability_end_ts

string (date-time)

Ending date time for availability

availability_start_ts

string (date-time)

Beginning date time for availability

available

boolean

Is object deemed as available. Based on availability_start_ts and availability_end_ts values.

groupname

Group name of constant

Valid values[ "KN_CUST_TYPE" ]

integer

Unique id of constant

list_url

string (url)

Url to fetch all contants from this group

logical_txt

string

Logical textual value

num_value

number (float)

Numeric value

num_value2

number (float)

Numeric value 2

num_value3

number (float)

Numeric value 3

num_value4

number (float)

Numeric value 4

txt

string

Human readable textual representation

updatedBy

string

Last updater

updatedTs

string (date-time)

Last update date time

parentContract

string (url)

link to parent contract

rent

number (float)

Contract rent. Normally a required attribute, can be set as not required on request.

rentBeginDate

string (date-time)

The date begin to rent

rentEndDate

string (date-time)

The date end of the rent

rent_2

number (float)

Contract rent 2

rent_3

number (float)

Contract rent 3

reserveBeginDate

string (date-time)

The date begin to reserved

reserveEndDate

string (date-time)

The date end of the reservation

termOfNotice

integer

Contract term of notice

updatedBy

string

Last updated

updatedTs

string (date-time)

Last update date time

Total

integer

Total number of Contracts

401

Authentication credentials are missing or invalid

{
  "details": "Authentication credentials were not provided"
}

object

details

string

Detailed description of error

Was this article helpful?

What's Next

Update contract data partially