URL import
Some property-management systems do not call the webhook. They open the property-manager app on /import-deposit and pass the tenancy as query parameters. The page prefills the deposit form for the property manager, who checks it and continues.
| Environment | Page |
|---|---|
| Production | https://www.pm-app.evorest.ch/import-deposit |
| Test | https://www.test.pm-app.evorest.ch/import-deposit |
How it behaves
Section titled “How it behaves”- The property manager must be signed in to the property-manager app. If they are not, the app sends them to its sign-in page. Open the link again after signing in.
- Opening the link creates nothing. The form is prefilled and the property manager can edit every field.
- A value that Evorest cannot read is left empty or kept as it is, and the form then shows a validation error on that field. Nothing is rejected at the URL level.
- When the property manager continues past the first form page with a valid form, Evorest creates the deposit as a draft in state
openingand shows the review page. Only a later step sends it to the tenant. - Unlike the webhook, the URL import sends no
externalContractId. Evorest therefore sends no document callback for a URL-import deposit. The property manager gets the documents in the app. - Parameter names are case-sensitive and exact. Spell them as in the tables below.
- The organization and the property manager on the form are those of the signed-in user. Agency or property-manager parameters in the URL are not applied.
Source
Section titled “Source”Source tells Evorest which system the link came from. Evorest stores it on the deposit.
| System | How Evorest recognizes it |
|---|---|
| AbaImmo | Source=AbaImmo |
| Immob10 | Source=Immob10 |
| Rimo R5 | No Source. Recognized by Gender1, see below. |
| ImmoTop2 | No Source. Recognized by Gender1, see below. |
The two values are case-sensitive. Immob_10, immob10, abaimmo, and CustomURL are not recognized and fall through to the rules below.
If Source is not one of the two values, Evorest looks at the first tenant and at Gender1:
| First tenant | Gender1 | Recognized as |
|---|---|---|
| natural | a number other than 0, such as 1, 2, or 4 | ImmoTop2 |
| natural | present but empty, 0, or text such as Mann | Rimo R5 |
| natural | not sent | none |
| legal | not sent | Rimo R5 |
| legal | present, even if empty | ImmoTop2 |
Rimo R5 sends gender as text and ImmoTop2 sends it as a number. Both are offered by W&W. If you build a link of your own, set Source to AbaImmo or Immob10 only if you are that system. Otherwise leave it out, and do not use Gender1 to pick a source.
Lang and PlaceOfOrigin are not read.
Property and deposit
Section titled “Property and deposit”| Parameter | Meaning |
|---|---|
Reference | Property id in your system. |
ObjectStreet and ObjectStreetNumber | Street and house number. If either is missing, Evorest splits ObjectAddressLine1 at its first digit. |
ObjectZipCode | Postal code. Four digits. |
ObjectCity | City. |
RentStart | Rental start, dd.mm.yyyy with leading zeros. |
Warranty | Deposit amount in CHF as a plain number with a dot, for example 3560 or 3560.50. Not 3'560, 3560,50, or CHF 3560: a comma or an apostrophe ends the number, so 3560,50 becomes 3560. A missing value prefills 0, and the form requires more than 0. |
Lessor
Section titled “Lessor”| Parameter | Meaning |
|---|---|
LessorName | Lessor name. |
LessorAddressStreet and LessorAddressStreetNumber | Street and house number. If either is missing, Evorest splits LessorAddress at its first digit. |
LessorZipCode | Postal code. |
LessorCity | City. |
Some organizations store the lessor address on the Evorest organization. Then the lessor address in the URL is ignored, the address of the organization is used, and the lessor is written as <LessorName> c/o <organization>. Evorest sets that up.
Tenants
Section titled “Tenants”Send up to three tenants. Use the suffix 1, 2, and 3 on every tenant parameter (FirstName1, FirstName2, FirstName3). A fourth tenant is not read. A tenant without any parameter is dropped. All tenants on the form take the type of the first tenant, so do not mix natural and legal tenants. For a legal entity the form allows two signatories.
A tenant is a legal entity when TenantTypeN is exactly legal_person or when CompanyNameN is present. Otherwise the tenant is a natural person.
| Parameter | Meaning |
|---|---|
FirstNameN, LastNameN | Person name. For a company, these are the contact, not the company name. |
EmailN | Email. |
PhoneN, MobileN, WorkPhoneN | First non-empty value wins, in that order. Tenant 1 also accepts Phone, Mobile, and WorkPhone without a suffix. See Phone numbers. |
GenderN | 1, Mann, or männlich is Mr. 2, Frau, weiblich, 4, Divers, or divers is Ms. Anything else leaves the title empty, and the form asks for it. |
BirthDateN | dd.mm.yyyy with leading zeros. The first tenant must be at least 18. |
NationalityN | ISO alpha-2 in either case, or the exact country name in German, French, or English. A name that is not recognized leaves the field empty. |
CivilStatusN | See the table below. |
AddressStreetN and AddressStreetNumberN | Previous address. If either is missing, Evorest splits AddressLineN at its first digit. |
ZipCodeN, CityN, CountryN | Previous address. Tenant 1 also accepts ZipCode, City, and Country without a suffix. Use the ISO alpha-2 country code, for example CH. For CH the postal code must be four digits. |
TenantTypeN | legal_person for a company. |
CompanyNameN | Company name. |
CompanyUidN | UID of the company, starting with CHE-. |
DomicileN | Seat of the company. Letters only. CH, Schweiz, Switzerland, Suisse, and Svizzera are refused. |
LegalFormN | Lower case: ag, gmbh, simple_partnership, general_partnership, limited_partnership, sole_proprietorship, cooperative, association, foundation, or other. |
The UID and the domicile are required for ag, gmbh, general_partnership, limited_partnership, and cooperative.
Civil status
Section titled “Civil status”The tokens are case-sensitive and lower case.
CivilStatusN | Stored as |
|---|---|
1, 2, ledig | Single |
4, verheiratet | Married |
5, 7, geschieden, getrennt | Divorced |
6, verwitwet | Widowed |
3, eingetragene Partnerschaft, andere | Other |
Phone numbers
Section titled “Phone numbers”Evorest takes the first non-empty value of PhoneN, MobileN, WorkPhoneN, removes spaces, and then:
- a leading
00becomes+, - a leading
0is treated as Swiss and becomes+41followed by the rest, - a leading
+is kept, - anything else gets a
+in front.
Other characters, such as hyphens or brackets, are not removed, and then the form rejects the number. A Swiss number must have exactly nine digits after +41. Send +41790000000 and none of this matters.
Streets and house numbers
Section titled “Streets and house numbers”Wherever a street and a house number are separate parameters, send them separately. When Evorest has to split an address line it cuts at the first digit: Rue du 1er Août 12 becomes Rue du and 1er Août 12. A house number is at most 10 characters.
Empty tenants and editing
Section titled “Empty tenants and editing”Empty tenants are dropped. The property manager can still edit every field before continuing.