Momentum BI-API

Inledning

Momentum BI-API är en webbtjänst (REST JSON) som levererar en utvald del av informationen från Momentum BI datalager.

BI-API som webbtjänst

Kommunikationen med BI-API-tjänsten är synkron och meddelandeorienterat. Anroparen skickar en begäran i form av ett meddelande till tjänsten, vilken i sin tur returnerar ett svarsmeddelande. Anroparens meddelande består av ett antal parametrar som är specifika för den aktuella begäran. Typiskt utgör parametrarna sökkriterier för objekturval. I vissa fall är parametrarna obligatoriska, i andra är de valfria eller saknas helt. Svarsmeddelanden kan innehålla information om ett eller flera objekt.

Anropen kräver Basic Authentication i form av username och password.

Webtjänstens adress (URL) samt username och password distribueras separat.

Basic Authentication

Benämning Typ Exempel Källa Version
Adress (URL) Fritext https://bixxx.momentum.se/api/hyresobjekt - 1
Username Fritext Xxx - 1
Password Fritext xxxxxxxxxxxxxxxxx - 1

Hämta hyresobjekt 

1
GET /hyresobjekt/

Returnerar en lista med alla hyresobjekt och kopplade avtal till hyresobjektet.

Parametrar

Inga funktionsspecifika parametrar kan anges.

Resultat (hyresobjekt)

Benämning Typ Exempel Källa Version
Period Fritext 2019-09 BI PM5 1
BolagNummer Fritext 100 BI PM5 1
Bolag Fritext Järfällahus BI PM5 1
BostadsområdeNummer Fritext 200 BI PM5 1
Bostadsområde Fritext Släggan BI PM5 1
BovärdsområdeNummer Fritext 300 BI PM5 1
Bovärdsområde Fritext Team Snapphane BI PM5 1
FastighetNummer Fritext 400 BI PM5 1
Fastighet Fritext Jakobsberg 2:232 BI PM5 1
ByggnadNummer Fritext 500 BI PM5 1
Byggnad Fritext Vasavägen 2-14 BI PM5 1
Hyresobjekt Fritext 01-001-01-xxxx BI PM5 1
HyresobjektStatusKod Fritext P BI PM5 1
HyresobjektStatus Fritext Påslagen BI PM5 1
HyresobjektGruppKod Fritext L BI PM5 1
HyresobjektGrupp Fritext Lägenhet BI PM5 1
HyresobjektTypKod Fritext 10 BI PM5 1
HyresobjektTyp Fritext Lägenhet BI PM5 1
HyresobjektStorlekKod Fritext 3 ROK BI PM5 1
HyresobjektStorlek Fritext 3 rum och kök BI PM5 1
HyresobjektAnvändning Fritext Trygghetsboende BI PM5 1
HyresobjektAvtal Fritext 1203285-1 BI PM5 1
HyresobjektAvtalstatus Fritext Uthyrd BI PM5 1
HyresobjektHarMoms Integer 0 BI PM5 (Avtalsmoms) 1
HyresobjektGrundhyra Decimaltal 8004,00 BI PM5 1
AvtalTAhyra Decimaltal -4490,00 BI PM5 1
HyresobjektTAhyra Decimaltal 75,00 BI PM5 1
HyresobjektYta Decimaltal 81,5000 BI PM5 1
HyresobjektKst Fritext 320708 BI PM5 1
HyresobjektByggnadByggÅr Fritext 1970 BI PM5 1
HyresobjektAdress Fritext Vasavägen x BI PM5 1
HyresobjektPostnr Fritext 177 xx BI PM5 1
HyresobjektPostort Fritext Järfälla BI PM5 1

Exempel resultat JSON 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
[
    {
        "Period": "2019-09",
        "BolagNummer": "100",
        "Bolag": "Järfällahus AB",
        "BostadsområdeNummer": "200",
        "Bostadsområde": "Släggan",
        "BovärdsområdeNummer": "300",
        "Bovärdsområde": "Team Snapphane",
        "FastighetNummer": "400",
        "Fastighet": "Jakobsberg 2:232",
        "ByggnadNummer": "500",
        "Byggnad": "Vasavägen 2-14",
        "Hyresobjekt": "01-001-01-xxxx",
        "HyresobjektStatusKod": "P",
        "HyresobjektStatus": "Påslagen",
        "HyresobjektGruppKod": "L",
        "HyresobjektGrupp": "Lägenhet",
        "HyresobjektTypKod": "10",
        "HyresobjektTyp": "Lägenhet",
        "HyresobjektStorlekKod": "3 ROK",
        "HyresobjektStorlek": "3 Rum o Kök",
        "HyresobjektAnvändning": "Trygghetsboende",
        "HyresobjektAvtal": "1203285-1",
        "HyresobjektAvtalstatus": "Uthyrd",
        "HyresobjektHarMoms": "0",
        "HyresobjektGrundhyra": "8004.00",
        "AvtalTAhyra": "-4490.00",
        "HyresobjektTAhyra": "75.00",
        "HyresobjektYta": "81.5000",
        "HyresobjektKst": "320708",
        "HyresobjektByggnadByggÅr": "1970",
        "HyresobjektAdress": "Vasavägen 2",
        "HyresobjektPostnr": "177 xx",
        "HyresobjektPostort": "JÄRFÄLLA",
    }
]

Hämta avtal och pris 

1
GET /avtal/

Returnerar en lista med alla avtal och prisdelar kopplade till hyresobjekt/kund och avtal dvs avtal kan ha flera rader om det finns både hyra och tillägg, ex bashyra + kabel-tv.

Prisdelar som passerats i tid eller ligger framåt i tid inkluderas ej.

Datum i fältet AvtalUppsagd indikerar om avtalet är aktivt.

Parametrar

Inga funktionsspecifika parametrar kan anges.

Resultat (avtal)

Benämning Typ Exempel Källa Version
Avtal Fritext 1203285-1 BI PM5 1
AvtalSamDeb Fritext 1203450 BI PM5 1
KundId Fritext 2964642 BI PM5 1
AvtalHyresobjekt Fritext 01-001-01-xxxx BI PM5 1
AvtalTyp Fritext Bostadsavtal BI PM5 1
AvtalMoms Integer 1 BI PM5 1
AvtalSignerad Fritext 2017-12-01 BI PM5 1
AvtalFom Fritext 2017-12-01 BI PM5 1
AvtalTom Fritext - BI PM5 1
AvtalUppsagd Fritext - BI PM5 1
AvtalLedigFom Fritext - BI PM5 1
AvtalFörlängningstid Integer 0 BI PM5 1
AvtalKundUppsägningstid Integer 3 BI PM5 1
AvtalKundUppsägningstidEnhet Fritext Månader BI PM5 1
AvtalHyresvärdUppsägningstid Integer 3 BI PM5 1
AvtalHyresvärdUppsägningstidEnhet Fritext Månader BI PM5 1
AvtalBorgensman Fritext Nej BI PM5 1
AvtalDebiteringsperiod Fritext Månadsdebitering BI PM5 1
AvtalBetalsätt Fritext E-Faktura BI PM5 1
AvtalAnvändning Fritext - BI PM5 1
AvtalPrisdelTypId Fritext 706 BI PM5 1
AvtalPrisdelTyp Fritext Bashyra BI PM5 1
AvtalPrisdelTypAnvändning Fritext Hyra BI PM5 1
AvtalPrisdelTypTAKoppladTill Fritext Avtal BI PM5 1
AvtalPrisdelTypKoppladTill Fritext Hyresobjekt BI PM5 1
AvtalPrisdelAktiv Fritext Ja BI PM5 1
AvtalPrisdelAktivFom Fritext 2017-12-01 BI PM5 1
AvtalPrisdelAktivTom Fritext - BI PM5 1
AvtalPrisdelBelopp Integer 5154 BI PM5 1
AvtalPrisdelBeloppFom Fritext 2017-12-01 BI PM5 1
AvtalPrisdelBeloppTom Fritext - BI PM5 1

Exempel resultat JSON 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
[
    {
        "Avtal": "1203285-1",
        "AvtalSamDeb": "1203450",
        "KundId": "2964642",
        "AvtalHyresobjekt": "01-001-01-xxxx",
        "AvtalTyp": "Bostadsavtal",
        "AvtalMoms": "1",
        "AvtalSignerad": "2017-12-01",
        "AvtalFom": "2017-12-01",
        "AvtalTom": "-",
        "AvtalUppsagd": "-",
        "AvtalLedigFom": "-",
        "AvtalFörlängningstid": "0",
        "AvtalKundUppsägningstid": "3",
        "AvtalKundUppsägningstidEnhet": "Månader",
        "AvtalHyresvärdUppsägningstid": "3",
        "AvtalHyresvärdUppsägningstidEnhet": "Månader",
        "AvtalBorgensman": "Nej",
        "AvtalDebiteringsperiod": "Månadsdebitering",
        "AvtalBetalsätt": "E-Faktura",
        "AvtalAnvändning": "-",
        "AvtalPrisdelTypId": "706",
        "AvtalPrisdelTyp": "Bashyra",
        "AvtalPrisdelTypAnvändning": "Hyra",
        "AvtalPrisdelTypTAKoppladTill": "Avtal",
        "AvtalPrisdelTypKoppladTill": "Hyresobjekt",
        "AvtalPrisdelAktiv": "Ja",
        "AvtalPrisdelAktivFom": "2017-12-01",
        "AvtalPrisdelAktivTom": "-",
        "AvtalPrisdelBelopp": "5154",
        "AvtalPrisdelBeloppFom": "2017-12-01",
        "AvtalPrisdelBeloppTom": "-"
    }
]

Hämta kund 

1
GET /kund/

Returnerar en lista med alla kunder och kontaktuppgifter kopplade till hyresobjekt.

Parametrar

Inga funktionsspecifika parametrar kan anges.

Resultat (kund)

Benämning Typ Exempel Källa Version
Period Fritext 2019-09 BI PM5 1
Bolag Fritext Järfällahus BI PM5 1
Hyresobjekt Fritext 01-001-01-xxxx BI PM5 1
HyresobjektAdress Fritext Vasavägen x BI PM5 1
HyresobjektPostnr Fritext 177 xx BI PM5 1
HyresobjektPostort Fritext Järfälla BI PM5 1
KundTyp Fritext Privatperson BI PM5 1
KundId Fritext 2964642 BI PM5 1
Kund Fritext Förnamn Efternamn BI PM5 1
KundPersonOrgNr Fritext 19xxxxxx-xxxx BI PM5 1
KundLand Fritext - BI PM5 1
KundTelHem Fritext 070xxxxxxx BI PM5 1
KundTelArb Fritext 08xxxxxxx BI PM5 1
KundMobilNr Fritext 070xxxxxxx BI PM5 1
KundEpostHem Fritext namn@domän BI PM5 1
KundEpostArb Fritext namn@domän BI PM5 1

Exempel resultat JSON 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
[
    {
        "Period": "2019-09",
        "Bolag": "Järfällahus AB",
        "Hyresobjekt": "01-001-01-xxxx",
        "HyresobjektAdress": "Vasavägen 2",
        "HyresobjektPostnr": "177 xx",
        "HyresobjektPostort": "JÄRFÄLLA",
        "KundTyp": "Privatperson",
        "KundId": "2964642",
        "Kund": "Förnamn Efternamn",
        "KundPersonOrgNr": "xxxxxxxx-xxxx",
        "KundLand": "-",
        "KundTelHem": "070xxxxxxx",
        "KundTelArb": "08xxxxxxx",
        "KundMobilNr": "070xxxxxxx",
        "KundEpostHem": "namn@domän",
        "KundEpostArb": "namn@domän"
    }
]

Hämta bokforingtransaktion 

1
GET /bokforingtransaktion/

Returnerar en lista med alla bokföringstransaktioner fördelat på period, fastighet, konto.

Parametrar

Inga funktionsspecifika parametrar kan anges.

Resultat (bokforingtransaktion)

Benämning Typ Exempel Källa Version
Period Fritext 2019-12 BI PM5 1
BolagNummer Fritext 100 BI PM5 1
Bolag Fritext Järfällahus BI PM5 1
FastighetNummer Fritext 400 BI PM5 1
Fastighet Fritext Jakobsberg 2:232 BI PM5 1
HyresobjektGruppKod Fritext L BI PM5 1
HyresobjektGrupp Fritext Lägenhet BI PM5 1
Konto Konto 3010 BI PM5 1
Debet Decimaltal 7060,5 BI PM5 1
Kredit Decimaltal 1035,5 BI PM5 1
Netto Decimaltal 6025,00 BI PM5 1

Exempel resultat JSON 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
[
    {
        "Period": "2019-12",
        "BolagNummer": "100",
        "Bolag": "Järfällahus AB",
        "FastighetNummer": "100",
        "Fastighet": "Jakobsberg 2:232",
        "HyresobjektGruppKod": "L",
        "HyresobjektGrupp": "Lägenhet",
        "Konto": "3010",
        "Debet": "7060,5",
        "Kredit": "1035,5",
        "Netto": "6025,00",
    }
]

Hämta uthyrning 

1
GET /uthyrning/

Returnerar en lista med alla uthyrningar som förmedlats i Momentum PM Marknad.

Parametrar

Inga funktionsspecifika parametrar kan anges.

Resultat (uthyrning)

Benämning Typ Exempel Källa Version
Period Fritext 2019-09 BI Marknad 1
Kö Fritext Bostad BI Marknad 1
Marknadsplats Fritext Torget BI Marknad 1
Sökområde Fritext Centrum BI Marknad 1
FastighetNummer Fritext 100 BI Marknad 1
Fastighet Fritext Jakobsberg 2:232 BI Marknad 1
ByggnadNummer Fritext 200 BI Marknad 1
Byggnad Fritext Vasavägen 2-14 BI Marknad 1
Hyresobjekt Fritext 01-001-01-xxxx BI Marknad 1
HyresobjektStorlek Fritext 3 rum och kök BI Marknad 1
HyresobjektAnvändning Fritext Trygghetsboende BI Marknad 1
Köpoäng Integer 470 BI Marknad 1
AntalIntresseAnmälningar Integer 41 BI Marknad 1
HyresobjektAdress Fritext Vasavägen x BI Marknad 1
HyresobjektPostnr Fritext 177 xx BI Marknad 1
HyresobjektPostort Fritext Järfälla BI Marknad 1

Exempel resultat JSON 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
[
    {
        "Period": "2019-09",
        "Kö": "Bostad",
        "Marknadsplats": "Torget",
        "Sökområde": "Centrum",
        "FastighetNummer": "100",
        "Fastighet": "Jakobsberg 2:232",
        "ByggnadNummer": "200",
        "Byggnad": "Vasavägen 2-14",
        "Hyresobjekt": "01-001-01-xxxx",
        "HyresobjektStorlek": "3 Rum o Kök",
        "HyresobjektAnvändning": "Trygghetsboende",
        "Köpoäng": 470,
        "AntalIntresseAnmälningar": 41,
        "HyresobjektAdress": "Vasavägen 2",
        "HyresobjektPostnr": "177 xx",
        "HyresobjektPostort": "JÄRFÄLLA",
    }
]

Support for search

Link to the source