Notice

Use this API if you want to create a notice for ongoing contracts for a logged in actor. Start with fetching contracts to make notice for by using the /v2/contracts/{id}/notice/contracts endpoint. Check if the actor can make a notice with the status endpoint /v2/contracts/{id}/notice If the actor can make an notice for a specific contract then present the options for the notice with the options endpoint /v2/contracts/{contractId}/notice/options to present the valid moving out dates etc. Last a temporary notice can be created for the actor to sign with /v2/contracts/{contractId}/notice/{id} endpoint and also an ongoing notice can be deleted with /v2/contracts/{id}/notice. After the actor (or from within the Momentum system) has signed the temporary notice the contract is now officially noticed.

Get a list of contracts to notice from a contract

Retrieve a list of any contracts to notice that has a relationship with the contract. Please note that the user must be logged in have a relationship to the contract.

Request

Example

GET /v2/contracts/{id}/notice/contracts

Parameters

Name	Description
id	Identifier of the contract to get notice information for.

Response

Example

{
  "items": [
    {
      "id": "345d8669e7a44e888c0a5dd9fb37186d",
      "displayName": "275971-1",
      "typeDisplayName": "Bostadsavtal",
      "primaryObjectDisplayName": "0001-1002",
      "primaryObjectTypeDisplayName": "Lägenhet",
      "primaryObjectLocationAddress": "Min gata 2 B",
      "noticeTenantPeriodDescription": "3 månader",
      "isPrimaryContract": true
    },
    {
      "id": "a7b6ace5072446bc848e3065dea9d124",
      "displayName": "275990-1",
      "typeDisplayName": "Bostadsavtal",
      "primaryObjectDisplayName": "0002-140",
      "primaryObjectTypeDisplayName": "Lägenhet",
      "primaryObjectLocationAddress": "Elisegatan 130",
      "primaryObjectLocationPostcode": "87055",
      "primaryObjectLocationCity": "Biancastad",
      "noticeTenantPeriodDescription": "3 månader",
      "isPrimaryContract": false
    },
    {
      "id": "8b6cdb7dc1c44f2482d3397f6c7104cd",
      "displayName": "177837-1",
      "typeDisplayName": "Parkeringsplatsavtal",
      "primaryObjectDisplayName": "0001-1001-02",
      "primaryObjectTypeDisplayName": "Parkeringsplats med motorvärmare",
      "primaryObjectLocationAddress": "Folkbokgatan 1 ",
      "primaryObjectLocationPostcode": "87133",
      "primaryObjectLocationCity": "HÄRNÖSAND",
      "noticeTenantPeriodDescription": "1 månad",
      "isPrimaryContract": false
    },
    {
      "id": "8f9Mt7hYMyjMDXtthYTfwjrG",
      "displayName": "275997-1",
      "typeDisplayName": "Lokalavtal",
      "primaryObjectDisplayName": "0002-151",
      "primaryObjectTypeDisplayName": "Lägenhet används som lokal",
      "primaryObjectLocationAddress": "Milagatan 92",
      "primaryObjectLocationPostcode": "64509",
      "primaryObjectLocationCity": "Elsaby",
      "noticeTenantPeriodDescription": "9 månader",
      "isPrimaryContract": false
    }
  ]
}

Name	Description
id	The contract version Identifier.
displayName	The contract's reference number. Equal to full contract number in Momentum PM, e.g. `123456-1`.
typeDisplayName	Type of contract as determined by the type of rental object.
primaryObjectDisplayName	The rental object's display name.
primaryObjectTypeDisplayName	The rental object's type display name.
primaryObjectLocationAddress	The rental object's address.
primaryObjectLocationPostcode	The rental object's postal code.
primaryObjectLocationCity	The rental object's city.
noticeTenantPeriodDescription	Tenant's notice period for the rental object.
isPrimaryContract	Indicates whether or not the contract is the main contract in a group of linked contracts.

Get notice status for a contract

Retrieve information about the possibility to create a notice for a contract for a logged in user.

Request

Example

GET /v2/contracts/{id}/notice

Parameters

Name	Description
id	Identifier of the contract to get notice information for.

Response

Example

{
  "allowDigitalNotice": true,
  "signingId": "43434",
  "hasSwedishSSN": true
}

Name	Description
allowDigitalNotice	`true` if the contract is allowed to be noticed. Reasons not to be allowed can be e.g. if the contract has a notice in progress, the current contract type is not allowed to be digitaly noticed.
signingId	Id of the signing if a notice is under progress and waiting to be signed.
hasSwedishSSN	If the loged in user has a swedish social security number

Get options for creating a notice

This API returns all the options needed for creating a succesfull notice for a contract e.g. reason for move codes,allowed end dates, allowed early end dates

Request

Example

GET /v2/contracts/{contractId}/notice/options

Parameters

Name	Description
id	Identifier of the contract to get notice information for.
additionalContractIds	Comma delimited list of additional contracts to notice when creating a notice for the main contract in parameter `id`

Response

Example

{
"reasonTypes": [
    {
      "id": "20",
      "displayName": "Avflyttning"
    },
    {
      "id": "3",
      "displayName": "Direktbyte"
    }
  ],
  "noticeTenantPeriodDescription": "3 månader",
  "allowedEndDates": [
    "2022-02-28T00:00:00+01:00",
    "2022-03-31T00:00:00+02:00",
    "2022-04-30T00:00:00+02:00",
    "2022-05-31T00:00:00+02:00",
    "2022-06-30T00:00:00+02:00",
    "2022-07-31T00:00:00+02:00",
    "2022-08-31T00:00:00+02:00",
    "2022-09-30T00:00:00+02:00",
    "2022-10-31T00:00:00+01:00",
    "2022-11-30T00:00:00+01:00",
    "2022-12-31T00:00:00+01:00",
    "2023-01-31T00:00:00+01:00",
    "2023-02-28T00:00:00+01:00",
    "2023-03-31T00:00:00+02:00",
    "2023-04-30T00:00:00+02:00",
    "2023-05-31T00:00:00+02:00",
    "2023-06-30T00:00:00+02:00",
    "2023-07-31T00:00:00+02:00",
    "2023-08-31T00:00:00+02:00",
    "2023-09-30T00:00:00+02:00",
    "2023-10-31T00:00:00+01:00",
    "2023-11-30T00:00:00+01:00",
    "2023-12-31T00:00:00+01:00",
    "2024-01-31T00:00:00+01:00"
  ],
  "earlyEndDates": [],
  "addressRequired": true,
  "reasonTypeRequired": true
}

|Name|Description| |----|--------------------------------------------------------------------| |reasonTypes| List of reason types to choose from when making a notice. |noticeTenantPeriodDescription| The tenant period indicating the period used when calculating the earliest allowed end date. The period description is from the contract with the furthest allowed end date in the list of contracts in parameter additionalContractIds |allowedEndDates| List of available end dates to choose from when making a notice. |earlyEndDates| List of available early end dates if a user wishes to end a contract earlier then the available dates in parameter allowedEndDates. If the list is empty any date is allowed.
|addressRequired| If true then a address for the actor after the notice is completed must be supplied where creating a notice. |reasonTypeRequired| If true then a reasoncode id from parameter resonTypes must be supplied when creating a notice.

Create a new notice

Create a new notice for a contract and all supplied additional contract's.

Request

Example

PUT /v2/contracts/{contractId}/notice/{id}

{
    "additionalContractIds": [
        "392a73a8452349348948d9f911838a01",
        "342c72a9322343948948f9s911838b11"
    ],
    "reasonType": "20",
    "endDate": "2023-07-31",
    "earlyEndDate": "2023-06-03",
    "notifyCurrentUser": true,
    "address": {
        "name": "Abborre",
        "address1": "Abooregrund 233",
        "address2": "",
        "attention": "",
        "careOf": "",
        "postcode": "77743",
        "city": "Boltjärn",
        "countryId": "SE"
    }
}

Parameters

Name	Description
contractId	Identifier of the contract to get notice information for.
id	Global unique identifier for the new notice. Read about `guid` here /v2/guid}
additionalContractIds	Optional. Comma delimited list of additional contracts to notice when creating a notice for the main contract in parameter `contractId`
reasonType	Identifier for the reasonType. If `reasonTypeRequired` from `/v2/contracts/{contractId}/notice/options` is `true` this parameter is required. List of reason type identifyer's can be found in `v2/contracts/{contractId}/notice/options`.
endDate	Valid end date from the list of valid end dates in `v2/contracts/{contractId}/notice/options`
earlyEndDate	Optional. Valid early end date from the list of valid early end dates in `v2/contracts/{contractId}/notice/options`
notifyCurrentUser	`true` if a notice will be send to the current logged in user that a signing exists to sign for the notice.
address	Address for the actor after the notice is completed. If `addressRequired` from `/v2/contracts/{contractId}/notice/options` is `true` this parameter is required.

.address

Name	Description
name	Name of address.
address1	Address1 of address.
address2	Address2 of address.
attention	Attention of address.
careOf	CareOf of address.
postcode	Postalcode of address.
city	City of address.
countryId	Identifier of country. List of valid country identifiers can be retrieved from `/v2/shared/addresses/countries`

Delete an ongoing notice for a contract

Cancelles an ongoing notice for a logged in user.

Request

Example

DELETE /v2/contracts/{id}/notice

Parameters

Name	Description
id	Identifier of the contract to delete a notice for.