Skip to content

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.

EnvironmentPage
Productionhttps://www.pm-app.evorest.ch/import-deposit
Testhttps://www.test.pm-app.evorest.ch/import-deposit
  • 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 opening and 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 tells Evorest which system the link came from. Evorest stores it on the deposit.

SystemHow Evorest recognizes it
AbaImmoSource=AbaImmo
Immob10Source=Immob10
Rimo R5No Source. Recognized by Gender1, see below.
ImmoTop2No 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 tenantGender1Recognized as
naturala number other than 0, such as 1, 2, or 4ImmoTop2
naturalpresent but empty, 0, or text such as MannRimo R5
naturalnot sentnone
legalnot sentRimo R5
legalpresent, even if emptyImmoTop2

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.

ParameterMeaning
ReferenceProperty id in your system.
ObjectStreet and ObjectStreetNumberStreet and house number. If either is missing, Evorest splits ObjectAddressLine1 at its first digit.
ObjectZipCodePostal code. Four digits.
ObjectCityCity.
RentStartRental start, dd.mm.yyyy with leading zeros.
WarrantyDeposit 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.
ParameterMeaning
LessorNameLessor name.
LessorAddressStreet and LessorAddressStreetNumberStreet and house number. If either is missing, Evorest splits LessorAddress at its first digit.
LessorZipCodePostal code.
LessorCityCity.

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.

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.

ParameterMeaning
FirstNameN, LastNameNPerson name. For a company, these are the contact, not the company name.
EmailNEmail.
PhoneN, MobileN, WorkPhoneNFirst non-empty value wins, in that order. Tenant 1 also accepts Phone, Mobile, and WorkPhone without a suffix. See Phone numbers.
GenderN1, 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.
BirthDateNdd.mm.yyyy with leading zeros. The first tenant must be at least 18.
NationalityNISO 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.
CivilStatusNSee the table below.
AddressStreetN and AddressStreetNumberNPrevious address. If either is missing, Evorest splits AddressLineN at its first digit.
ZipCodeN, CityN, CountryNPrevious 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.
TenantTypeNlegal_person for a company.
CompanyNameNCompany name.
CompanyUidNUID of the company, starting with CHE-.
DomicileNSeat of the company. Letters only. CH, Schweiz, Switzerland, Suisse, and Svizzera are refused.
LegalFormNLower 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.

The tokens are case-sensitive and lower case.

CivilStatusNStored as
1, 2, ledigSingle
4, verheiratetMarried
5, 7, geschieden, getrenntDivorced
6, verwitwetWidowed
3, eingetragene Partnerschaft, andereOther

Evorest takes the first non-empty value of PhoneN, MobileN, WorkPhoneN, removes spaces, and then:

  • a leading 00 becomes +,
  • a leading 0 is treated as Swiss and becomes +41 followed 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.

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 are dropped. The property manager can still edit every field before continuing.