Smart API Appendix

Lookup list


Enum List

EntityTypes

1Project
2Company
3Contact
4Tender

UserProjectStatuses

1New
2Working With
3Monitoring
4Undesirable
5Finished

UserTenderStatuses

1New
2Working With
3Monitoring
4Undesirable
5Finished

TenderSubjects

1Materials
2Role

GeoAccuracy

1RSM Manual
2Rooftop
3Range Interpolated
4Geometric Center
5Approximate
6RSM City Center

DateAccuracy

1Exact Day
2Month
3Month Range
4Quarter
5Season
6Half Year
7Year
8Year Range
9Week
10Day Range
11Exact time

How to use DateAccuracy?

DateAccuracy - this enum helps to determine an accuracy range for the estimated dates such as project construction start (start_date) and project construction end (finish_date). Accuracy values for these dates are stored in the start_date_accuracy_id and finish_date_accuracy_id respectively.

For example: for the project with start_date = 2022-07-01T00:00:00 and start_date_accuracy = 4 we look at the corresponding DateAccuracy value in the Enum List. 4 stands for quarter of the year. It means that the estimated date of the construction start is between:

2022-07-01T00:00:00 and 2022-10-01T00:00:00.


UserLicenses

2Admin
3User

UserStatuses

1Dummy (not registered)
2Init (registered but not onboarded)
3Live

UserInviteStatuses

1Not sent
2Sending
3Sent

UpdateKeys

PROJECT_REGISTEREDProject was registered
PROJECT_DETAILS_CHANGEDProject details were changed
PROJECT_CLOSED_FOR_UPDATESProject was closed for updates
PROJECT_REMOVEDProject was removed
PROJECT_ADDRESS_CHANGEDProject address was changed
PROJECT_START_DATE_CHANGEDProject start date was changed
PROJECT_FINISH_DATE_CHANGEDProject finish date was changed
PROJECT_COST_CHANGEDProject cost was changed
PROJECT_MATERIALS_CHANGEDProject materials were changed
PROJECT_COMPANY_ROLE_REGISTEREDCompany was registered to the project
PROJECT_CONTACT_ROLE_REGISTEREDContact was added to the project
PROJECT_TENDER_REGISTEREDTender was added to the project
PROJECT_PUBLISH_SOURCE_CHANGEDThe Publish Source of the project was changed
COMPANY_REGISTEREDCompany was registered
COMPANY_REGISTERED_TO_PROJECTCompany was registered to the project
COMPANY_DETAILS_CHANGEDCompany details were changed
COMPANY_REMOVEDCompany was removed
COMPANY_ADDRESS_CHANGEDCompany address was changed
COMPANY_REGISTERED_TO_TENDERCompany was registered to the tender
CONTACT_REGISTEREDContact was registered
CONTACT_REGISTERED_TO_PROJECTContact was added to the project
CONTACT_DETAILS_CHANGEDContact details were changed
CONTACT_REMOVEDContact was removed
CONTACT_REGISTERED_TO_TENDERContact was added to the tender
TENDER_REGISTEREDTender was registered
TENDER_DETAILS_CHANGEDTender details were changed
TENDER_REGISTERED_TO_PROJECTTender was added to the project
TENDER_COMPANY_REGISTEREDCompany was registered to the tender
TENDER_CONTACT_REGISTEREDContact was added to the tender
TENDER_REMOVEDTender was removed
TENDER_ADDRESS_CHANGEDTender address was changed
TENDER_START_DATE_CHANGEDTender start date was changed
TENDER_FINISH_DATE_CHANGEDTender finish date was changed
TENDER_COST_CHANGEDTender cost was changed
TENDER_MATERIALS_CHANGEDTender materials were changed

CustomFieldTypes

1Single line text
2Description
3Phone number
4Email
5Date
6Number
7Percent
8Formula
9Single select
10Multiple select
11Checkbox
12Attachment



Field Names (Smart FrontEnd)

Projects

Field key en sv da fi no cs sk
id
version
project_name Project name Projekt namn Projektnavn Hankkeen nimi Prosjektnavn Název projektu Názov projektu
title Project name Projekt namn Projektnavn Hankkeen nimi Prosjektnavn Název projektu Názov projektu
description Description Beskrivning Beskrivelse Lisätiedot Beskrivelse Popis Popis
what_happens Status Status Status Tila Status Poznámka pro zákazníky Poznámka pre zákazníkov
property_designation Property designation Fastighetsbet Supplerende adresse Alue/Paikka Eiendomsbetegnelse Označení projektu Označenie projektu
framework_agreement Framework agreement Ramavtal Rammeaftale Puitesopimus Rammeavtale Rámcová dohoda Rámcová dohoda
buildings Amount of buildings Antal byggnader Antal bygninger Rakennusten määrä Bygninger Počet budov Počet budov
apartments Amount of apartments Antal lägenheter Antal lejligheder Asuntojen määrä Leiligheter Počet bytů Počet bytov
floors Number of floors Antal våningar Antal etager Kerrosten lukumäärä Antall etasjer Celkový počet pater Celkový počet poschodí
underground_floors Number of floors underground Antal våningar under mark Antal etager under jorden Maanalaisten kerrosten lukumäärä Antall etasjer under bakken Počet podzemních podlaží Počet podzemných podlaží
gross_area Gross area, m² Bruttoarea, kvm Bruttoareal kvm. Bruttoala, m2 Brutto areal, m² Hrubá plocha (m²) Hrubá plocha (m²)
construction_area Construction area, m² Byggarea, kvm Bygningsareal kvm. Huoneistoala, m2 Bygningsareal, m² Zastavěná plocha (m²) Zastavaná plocha (m²)
gross_volume Gross volume, m³ Bruttovolym, kbm Bruttovolumen kbm. Kokonaistilavuus, m3 Brutto volum, m³ Obestavěný prostor (m³) Obostavaný priestor (m³)
renovation_area Renovation area, m² Renoveringsarea, kvm Renoveringsområde kvm. Korjattava ala, m2 Renovasjonsareal, m² Plocha renovace (m²) Plocha renovácie (m²)
demolition_area Demolition area, m² Rivningsarea, kvm Nedrivningsareal kvm. Purettava ala, m2 Rivingsareal, m² Plocha demolice (m²) Plocha demolácie (m²)
decontamination_area Decontamination area, m² Saneringsarea, kvm Saneringsareal kvm. Puhdistettava ala, m2 Saneringsareal, m² Dekontaminační plocha (m²) Dekontaminačné plocha (m²)
usage_area Usage area, m² Bruksarea, kvm Anvendelsesområde Hyötyala,m2 Bruksområde, m² Užitná plocha (m²) Úžitková plocha (m²)
contract_type_id Contract type Entr.form Entrepriseform Urakkamuoto Entrepriseform Typ smlouvy Typ zmluvy
uncertainty_id Uncertainty Osäkerhet Usikkerhedsfaktor Epävarmuustekijä Usikkerhet Nejistota Neistota
ecocertified_type_id Ecocertification Miljöcertifierad Bæredygtighed Ympäristösertifioitu Miljøsertifisert Atribut projektu (ekosertifikovaný) Atribút projektu (ekocertifikovaný)
certification_types
stage_id Stage icon Skede-ikon Stadie ikon Vaihekuvake Faseikon Etapy stavebního záměru Etapy stavebného zámeru
update_ended No updates expected Inga uppdateringar på väg Der forventes ikke opdatering Loppuun raportoitu Ingen forventede oppdateringer Bez plánovaného telefonního kontaktu Bez plánovaného telefónneho kontaktu
country_id
city City Stad By Kaupunki Sted Město Mesto
region_id County Län Region Maakunta Fylke Kraj Kraj
district_id Community Kommun Kommune Kunta Kommune Okres Okres
postcode Postcode Postnummer Postnummer Postinumero Postnummer PSČ PSČ
postcode_text City, postcode Stad, postnummer By, postnummer Kaupunki, Postinumero Sted, postnummer Město, PSČ Město, PSČ
street Street, number Gatuadress, nummer Adresse, nummer Katu, Numero Gateadresse Ulice / číslo Ulice / číslo
street_number Street, number Gatuadress, nummer Adresse, nummer Katu, Numero Gateadresse Ulice / číslo Ulice / číslo
location
start_date Construction start Byggstart Byggestart Aloituspäivä Startdato Zahájení výstavby Začatie výstavby
start_text Construction start Byggstart Byggestart Aloituspäivä Startdato Zahájení výstavby Začatie výstavby
finish_date Construction finish Byggslut Byggeslut Rakentamisen valmistuminen Sluttdato Dokončení výstavby Dokončenie výstavby
finish_text Construction finish Byggslut Byggeslut Rakentamisen valmistuminen Sluttdato Dokončení výstavby Dokončenie výstavby
months Period Byggmånader Byggeperiode Rakennusaika Periode Doba výstavby Doba výstavby
value Budget Kostnad Budget Kustannustaso Totalkostnad eks. mva. Rozpočet Rozpočet
value_text Budget Kostnad Budget Kustannustaso Totalkostnad eks. mva. Rozpočet Rozpočet
value_range Budget Kostnad Budget Kustannustaso Totalkostnad eks. mva. Rozpočet Rozpočet
roles Roles Roller Roller Roolit Roller Role Role
material_data Materials Material Materialer Materiaalit Materialer Materiály Materiály
cat_dev_type Category Kategori Kategori Luokka Kategori Kategorie Kategórie
residence_forms Residence form Boendeform Boligtype Asumismuoto Boligtype Typ rezidence Typ rezidencie
category_id Category Kategori Kategori Luokka Kategori Kategorie Kategórie
dev_type_id Construction type Typ av projekt Byggeart Rakennuslaji Byggetype Typ konstrukce Typ konštrukcie
source_id Project nr Projektnummer Projektnummer Hankenro Prosjekt-ID Projekt č Projekt č.
geo_accuracy_id
start_date_accuracy_id
finish_date_accuracy_id
detailed_stage_id Stage Skede Stadie Vaihe Fase Fáze stavby Fáze stavby
crafts Crafts Arbeten Håndværkere Käsityöt Fag Řemesla Remesla
updated_at Last updated date Senaste uppdatering Seneste opdateringsdato Viimeksi päivitetty Siste dato oppdatering Datum poslední aktualizace Dátum poslednej aktualizácie
delivered_at Delivered date Leveransdatum Oprettelsesdato Toimituspäivä Leveringsdato Datum doručení Dátum doručenia
modified_at
user_project_status_id Status Status Status Tila Status Stav Stav
user_id
updates Last updates Uppdateringar Nyeste opdateringer Viimeisimmät päivitykset Siste oppdateringer Poslední aktualizace Posledná aktualizácia
client_statuses
expected_tender_roles Expected roles Očekávané role Očekávané role
assigned_tender_roles Assigned tender roles Přidělená role Pridělená rola
publish_source_id Last source of information Senaste informationskälla Afsluttende noter Viimeinen tietolähde Siste informasjonskilde Poslední zdroj informace Posledný zdroj informácie
custom_fields Custom fields Interna fält Egne parametre Sisäiset kentät Interne felt Vlastní pole Vlastné pole

Companies

Field key en sv da fi no cs sk
id
version
name Company name Företagnamn Firmanavn Yrityksen nimi Firmanavn Jméno společnosti Meno spoločnosti
org_nr Org nr. Org.nr. CVR nr. Y-tunnus Org. nummer Org. Org.
par_id
cfar_nr
company_nr Company nr. Företagsnummer Id Nr. Yritysnumero Bedrift-ID Společnost č. Spoločnosť č.
company_type_id Company type Företagstyp Firmatype Yritystyyppi Bedriftstype Typ společnosti Typ spoločnosti
country_id
region_id County Län Region Maakunta Fylke Kraj Kraj
district_id Community Kommun Kommune Kunta Kommune Okres Okres
city City, postcode Stad, postnummer By, postnummer Kaupunki, Postinumero Sted Město, PSČ Mesto, PSČ
postcode_text City, postcode Stad, postnummer By, postnummer Kaupunki, Postinumero Sted Město, PSČ Mesto, PSČ
location
addresses
communications
active_contacts
source_id Company nr. Företagsnummer CVR. Nr. Yritysnumero Bedrift-ID Společnost č. Spoločnosť č.
updated_at Last updated date Senaste uppdatering Seneste opdateringsdato Viimeksi päivitetty Siste dato oppdatering Datum poslední aktualizace Dátum poslednej aktualizácie
delivered_at Delivered date Leveransdatum Oprettelsesdato Toimituspäivä Leveringsdato Datum doručení Dátum doručenia
modified_at
client_company_folder_id
user_id
updates Last updates Uppdateringar Nyeste opdateringer Viimeisimmät päivitykset Siste oppdateringer Poslední aktualizace Posledná aktualizácia
custom_fields Custom fields Interna fält Egne parametre Sisäiset kentät Interne felt Vlastní pole Vlastné pole

Tenders

Field key en sv da fi no cs sk
id
version
name Tender name Anbudsnamn Udbudsnavn Tarjouspyynnön nimi Anbudsnavn Název Příležitosti Názov Príležitosti
description Description Beskrivning Beskrivelse Lisätiedot Beskrivelse Popis Popis
tender_subject_id
tender_type_id Type Typ av anbud Udbudsform Tyyppi Type anbud Typ Typ
tender_status_id Status Status Status Tila Status Stav Stav
company_role_id Role Roll Rolle Rooli Rolle Role Rola
url External link Anbudshandling Eksternt link Ulkoinen linkki Ekstern link til anbud Externí odkaz Externý odkaz
framework_agreement Framework agreement Ramavtal Rammeaftale Puitesopimus Rammeavtale Rámcová dohoda Rámcová dohoda
project_id
company_id
contact_id
first_day_materials_text First day documents Första dag handling Forventet igangsætning af udbudsproces Laskenta alkaa Grunnlag gjøres tilgjengelig Začátek Začiatok Príležitosti
last_day_application_text Last day for application Sista anbudsdag Licitationsdato Tarjouspäivä Siste frist for anbud Poslední den pro kontaktování Koniec Príležitosti
prequalification_date_text Pre-qualification date Prekvalificeringsdatum Deadline Ennakkoilmoittautumiset Prekvalifisering Předkvalifikační datum Predkvalifikačný dátum
first_day_materials_range First day documents Första dag handling Forventet igangsætning af udbudsproces Laskenta alkaa Grunnlag gjøres tilgjengelig Začátek Začiatok Príležitosti
last_day_application_range Last day for application Sista anbudsdag Tilbudsfrist Tarjouspäivä Siste frist for anbud Poslední den pro kontaktování Koniec Príležitosti
prequalification_date_range Pre-qualification date Prekvalificeringsdatum Deadline Ennakkoilmoittautumiset Prekvalifisering Předkvalifikační datum Predkvalifikačný dátum
country_id
region_id County Län Region Maakunta Fylke Kraj Kraj
district_id Community Kommun Kommune Kunta Kommune Okres Okres
city City, postcode Stad, postnummer By, postnummer Kaupunki, Postinumero Sted Město, PSČ Město, PSČ
postcode City, postcode Stad, postnummer By, postnummer Kaupunki, Postinumero Sted Město, PSČ Město, PSČ
postcode_text City, postcode Stad, postnummer By, postnummer Kaupunki, Postinumero Sted Město, PSČ Město, PSČ
street Street, number Gatuadress, nummer Gade, husnummer Katu, Numero Gateadresse Ulice / číslo Ulice / číslo
street_number Street, number Gatuadress, nummer Gade, husnummer Katu, Numero Gateadresse Ulice / číslo Ulice / číslo
location
agreement_period Period Period Periode Kausi Periode Doba Doba
cat_dev_type Category Kategori Kategori Luokka Kategori Kategorie Kategórie
material_data Materials Material Materialer Materiaalit Anbud for materialer Materiály Materiály
category_id Category Kategori Kategori Luokka Kategori Kategorie Kategórie
dev_type_id Construction type Typ av projekt Byggeart Rakennuslaji Byggetype Typy projektů Typy projektov
source_id Tender nr. Anbudsnummer Udbudsnummer Tarjous nro Anbuds-ID Číslo Príležitost číslo
geo_accuracy_id
content_standard Description Beskrivning Beskrivelse Lisätiedot Beskrivelse Popis Popis
content_ted Description Beskrivning Beskrivelse Lisätiedot Beskrivelse Popis Popis
archived Archive Arkiv Arkiv Arkisto Arkiv Archiv Archív
updated_at Last updated date Senaste uppdatering Seneste opdateringsdato Viimeksi päivitetty Siste dato oppdatering Datum poslední aktualizace Dátum poslednej aktualizácie
delivered_at Delivered date Leveransdatum Oprettelsesdato Toimituspäivä Leveringsdato Datum doručení Dátum doručenia
modified_at
user_tender_status_id Status Status Status Tila Status Stav Stav
user_id
updates Last updates Uppdateringar Nyeste opdateringer Viimeisimmät päivitykset Siste oppdateringer Poslední aktualizace Posledná aktualizácia
client_statuses
custom_fields Custom fields Interna fält Egne parametre Sisäiset kentät Interne felt Vlastní pole Vlastné pole

Contacts

Field key en sv da fi no cs sk
id
version
first_name Name Namn Navn Nimi Navn Jméno Meno
last_name
communications
source_id
updated_at Last updated date Senaste uppdatering Seneste opdateringsdato Viimeksi päivitetty Siste dato oppdatering Datum poslední aktualizace Dátum poslednej aktualizácie
modified_at
user_id
updates Last updates Uppdateringar Nyeste opdateringer Viimeisimmät päivitykset Siste oppdateringer Poslední aktualizace Posledná aktualizácia
custom_fields Custom fields Interna fält Egne parametre Sisäiset kentät Interne felt Vlastní pole Vlastné pole