Ote Kitsaan vanhemmasta rajapinnasta - Kirjanpidon tietojen noutaminen version 2
https://api.kitsas.fi/cloud/{cloudid}
Kitsaan pilvikirjanpidon palvelin - Kirjanpidon tietojen noutamiseen käytettävä osa rajapinnasta. Rajapinnan käyttöön tarvittavan autentikaatiorajapinnan kuvaus on saatavilla pyynnöstä osoitteesta kitsas@kitsas.fi
-
cloudid:
required (integer)
Pilven id
/asetukset
Kirjanpidon asetukset
Hakee kirjanpidon kaikki asetukset. Asetukset palautetaan objektina, jossa avaimet ovat asetuksen nimet ja arvot asetuksen arvot. Arvot voivat olla merkkijonoja, numeroita, totuusarvoja tai objekteja.
get /asetukset
Hakee kirjanpidon kaikki asetukset. Asetukset palautetaan objektina, jossa avaimet ovat asetuksen nimet ja arvot asetuksen arvot. Arvot voivat olla merkkijonoja, numeroita, totuusarvoja tai objekteja.
Kitsaan autentikaatiotoken
HTTP status code 200
Kirjanpidon asetukset
Body
Media type: application/json
Type: object
Example:
{
"Nimi": "Yritys Oy",
"Harjoitus": "ON",
"Ytunnus": "1234567-8",
"PankkiPalvelumaksutili": 4000,
"TiliotePankkikorttitiliKaytossa": "ON",
"TiliotePankkikorttitili": 1910,
"VeroTuloViite": "123456",
"OletusMenotili": 4000,
"OletusMyyntitili": 3000
}
Secured by token
Headers
-
Authorization:
required (string)
Kitsas Login Serverin tuottaman token, joka antaa oikeuden tähän pilveen
HTTP status code 403
Virheellinen token tai puuttuva oikeus
Hakee yksittäisen asetuksen arvon. Asetuksen arvo voi olla merkkijono, numero, totuusarvo tai objekti.
get /asetukset/{asetus}
Hakee yksittäisen asetuksen arvon. Asetuksen arvo voi olla merkkijono, numero, totuusarvo tai objekti.
Kitsaan autentikaatiotoken
URI Parameters
-
asetus:
required (string)
Asetuksen avain
HTTP status code 200
Asetuksen arvo haettu onnistuneesti
Body
Media type: application/json
Type: string | number | boolean | object
Examples:
string:
Merkkijonoarvo (esim. yrityksen nimi)
Yritys Oy
number:
Numeroarvo (esim. tilin numero)
4000
boolean:
Totuusarvo (esim. toiminnon tila)
ON
object:
Objektitarvo (esim. monimutkainen asetus)
{"kohde": "arvo"}
HTTP status code 404
Asetusta ei löytynyt annetulla avaimella
Body
Media type: application/json
Type: string
Example:
[object Object]
Secured by token
Headers
-
Authorization:
required (string)
Kitsas Login Serverin tuottaman token, joka antaa oikeuden tähän pilveen
HTTP status code 403
Virheellinen token tai puuttuva oikeus
/budjetti
Tilikauden budjetti
Hakee tilikauden budjetin
get /budjetti/{tilikausi}
Hakee tilikauden budjetin
Kitsaan autentikaatiotoken
URI Parameters
-
tilikausi:
required (string)
Tilikauden alkupäivämäärä muodossa 2019-01-01
Query Parameters
-
kohdennus:
(integer)
Hakee budjetin tietyllä kohdennuksella (kohdennuksen id)
-
kohdennukset:
(string)
Hakee kaikkien kohdennusten budjetin. Palautetaan objeti mallia { kohdennus : { tili : budjetti, .. }, ..}
-
kustannuspaikat:
(string)
Palauttaa kustannuspaikkojen budjetit, ml. projektit
-
projektit:
(string)
Palauttaa projektien budjetit
HTTP status code 200
Budjetti haettu onnistuneesti
Body
Media type: application/json
Type: object
Examples:
kokonaisbudjetti:
{
"1000": 50000.00,
"2000": 30000.00,
"3000": 80000.00
}
kohdennukset:
{
"1": {
"1000": 25000.00,
"2000": 15000.00
},
"2": {
"1000": 25000.00,
"2000": 15000.00
}
}
Secured by token
Headers
-
Authorization:
required (string)
Kitsas Login Serverin tuottaman token, joka antaa oikeuden tähän pilveen
HTTP status code 403
Virheellinen token tai puuttuva oikeus
/huoneistot
Huoneistojen tiedot
Hakee huoneistojen luettelon. Jos saldopvm-parametri annetaan, palautetaan myös laskutus- ja maksutiedot. Vaatii LASKUT_SELAUS, LASKUT_LAATIMINEN, ASETUKSET tai LASKUT_LAHETTAMINEN-oikeudet.
get /huoneistot
Hakee huoneistojen luettelon. Jos saldopvm-parametri annetaan, palautetaan myös laskutus- ja maksutiedot. Vaatii LASKUT_SELAUS, LASKUT_LAATIMINEN, ASETUKSET tai LASKUT_LAHETTAMINEN-oikeudet.
Kitsaan autentikaatiotoken
Query Parameters
-
saldopvm:
(string - pattern: \d{4}-\d{2}-\d{2})
Päivämäärä, jolta laskut haetaan
HTTP status code 200
Huoneistot haettu onnistuneesti
Body
Media type: application/json
Type: object
Properties-
id:
required (integer)
Huoneiston id
-
nimi:
required (string)
Huoneiston nimi
-
asiakas:
required (integer)
Asiakkaan id
-
laskutettu:
(number)
Laskutettu määrä (vain kun saldopvm annettu)
-
maksettu:
(number)
Maksettu määrä (vain kun saldopvm annettu)
HTTP status code 403
Käyttäjällä ei ole riittäviä oikeuksia
HTTP status code 500
Palvelinvirhe
Secured by token
Headers
-
Authorization:
required (string)
Kitsas Login Serverin tuottaman token, joka antaa oikeuden tähän pilveen
HTTP status code 403
Virheellinen token tai puuttuva oikeus
Huoneiston tiedot
get /huoneistot/{id}
Huoneiston tiedot
Kitsaan autentikaatiotoken
URI Parameters
-
id:
required (integer)
Huoneiston
HTTP status code 200
Body
Media type: application/json
Type: object
Properties-
id:
(integer)
Huoneiston id
-
nimi:
(string)
Huoneiston tunniste
-
asiakas:
(integer)
Asukkaan tai omistajan id
-
laskutus:
(array of HuoneistoLaskutettava)
Kuukausittain laskutettavat
Items: HuoneistoLaskutettava
- tuote: required (integer)
- lkm: required (string)
- muistiinpanot: (string)
Secured by token
Headers
-
Authorization:
required (string)
Kitsas Login Serverin tuottaman token, joka antaa oikeuden tähän pilveen
HTTP status code 403
Virheellinen token tai puuttuva oikeus
/kierrot
Tositekierrot ja niiden määritykset
Luettelo kierroista
get /kierrot
Luettelo kierroista
Kitsaan autentikaatiotoken
HTTP status code 200
Body
Media type: application/json
Type: array of object
Items: KiertoNimi
-
id:
required (integer)
Kierron id
-
nimi:
required (string)
Kierron nimi
-
portaalissa:
(boolean)
Näytetäänkö portaalissa (vain /kierrot endpointissa)
-
json:
required (object)
Kierron asetukset. Sisältää:
- tili: tilin numero
- vastatili: vastatilin numero
- kohdennus: kohdennuksen id
- tositetyyppi: tositteen tyyppikoodi
Secured by token
Headers
-
Authorization:
required (string)
Kitsas Login Serverin tuottaman token, joka antaa oikeuden tähän pilveen
HTTP status code 403
Virheellinen token tai puuttuva oikeus
Kierron tiedot
get /kierrot/{id}
Kierron tiedot
Kitsaan autentikaatiotoken
URI Parameters
-
id:
required (integer)
Kierron id
HTTP status code 200
Kierron tiedot haettu onnistuneesti
Body
Media type: application/json
Type: object
Properties-
nimi:
required (string)
Kierron nimi
-
portaalissa:
required (boolean)
Onko kierto näkyvissä portaalissa
-
json:
required (object)
Kierron asetukset. Sisältää:
- tili: tilin numero
- vastatili: vastatilin numero
- kohdennus: kohdennuksen id
- tositetyyppi: tositteen tyyppikoodi
-
kierto:
required (array of KierrossaTiedot)
Kierron kulku (käyttäjät ja roolit)
Items: KierrossaTiedot
-
userid:
required (integer)
Käyttäjän id
-
kierto:
required (integer)
Kierron id
-
rooli:
required (integer)
Käyttäjän rooli
-
ilmoita:
required (boolean)
Ilmoitetaanko sähköpostilla
-
nimi:
required (string)
Käyttäjän nimi
-
userid:
required (integer)
HTTP status code 403
Käyttäjällä ei ole riittäviä oikeuksia
HTTP status code 404
Kierron id:tä ei löytynyt
Secured by token
Headers
-
Authorization:
required (string)
Kitsas Login Serverin tuottaman token, joka antaa oikeuden tähän pilveen
HTTP status code 403
Virheellinen token tai puuttuva oikeus
Käyttäjän kierroissa olevat käsiteltävät tositteet
get /kierrot/tyolista
Kitsaan autentikaatiotoken
HTTP status code 200
Body
Media type: application/json
Type: array of object
Items: KiertoTosite
-
id:
required (integer)
Tosite-id
-
tila:
required (integer)
Tositteen tila
-
tyyppi:
required (integer)
Tositteen tyyppikoodi
-
kierto:
required (integer)
Kierron polku-id
-
pvm:
(string - pattern: \d{4}-\d{2}-\d{2})
Tositteen pvm
-
erapvm:
(string - pattern: \d{4}-\d{2}-\d{2})
Tositteen eräpäivä
-
otsikko:
(string)
Tositteen otsikko
-
kumppaninimi:
(string)
Kumppanin nimi
-
laskunumero:
(string)
Laskun numero
-
summa:
required (number)
Tositteen vientien yhteissumma
Secured by token
Headers
-
Authorization:
required (string)
Kitsas Login Serverin tuottaman token, joka antaa oikeuden tähän pilveen
HTTP status code 403
Virheellinen token tai puuttuva oikeus
Kaikissa kierroissa olevat tositteet
get /kierrot/kaikki
Kitsaan autentikaatiotoken
HTTP status code 200
Body
Media type: application/json
Type: array of object
Items: KiertoTosite
-
id:
required (integer)
Tosite-id
-
tila:
required (integer)
Tositteen tila
-
tyyppi:
required (integer)
Tositteen tyyppikoodi
-
kierto:
required (integer)
Kierron polku-id
-
pvm:
(string - pattern: \d{4}-\d{2}-\d{2})
Tositteen pvm
-
erapvm:
(string - pattern: \d{4}-\d{2}-\d{2})
Tositteen eräpäivä
-
otsikko:
(string)
Tositteen otsikko
-
kumppaninimi:
(string)
Kumppanin nimi
-
laskunumero:
(string)
Laskun numero
-
summa:
required (number)
Tositteen vientien yhteissumma
Secured by token
Headers
-
Authorization:
required (string)
Kitsas Login Serverin tuottaman token, joka antaa oikeuden tähän pilveen
HTTP status code 403
Virheellinen token tai puuttuva oikeus
/kohdennukset
Kirjanpidon kohdennukset
Kohdennusten tiedot
get /kohdennukset
Kohdennusten tiedot
Kitsaan autentikaatiotoken
HTTP status code 200
Body
Media type: application/json
Type: array of object
Items: KohdennusTiedot
-
id:
required (integer)
Kohdennuksen id
-
tyyppi:
required (one of 0, 1, 2, 3)
Kohdennuksen tyyppi
Koodi Tyyppi 0 Ei kohdenneta 1 Kustannuspaikka 2 Projekti 3 merkkaus -
kuuluu:
required (integer)
Kohdennuksen id, jolle projekti kuuluu
-
json:
required (object)
Kohdennuksen JSON-tiedot. Sisältää:
- nimi: Kohdennuksen nimi eri kielillä muodossa {kieli: nimi, ...} Tuetut kielet: suomi (fi), ruotsi (sv), englanti (en) Esim. {"fi": "Myynti", "sv": "Försäljning", "en": "Sales"}
- lisätiedot: Muut kohdennuksen asetukset ja tiedot
-
lkm:
required (integer)
Kohdennuksen käyttökertojen määrä (kuinka monta kertaa kohdennusta on käytetty vienneissä)
Secured by token
Headers
-
Authorization:
required (string)
Kitsas Login Serverin tuottaman token, joka antaa oikeuden tähän pilveen
HTTP status code 403
Virheellinen token tai puuttuva oikeus
/kumppanit
Kumppanit asiakas- ja toimittajarekisterissä
Palauttaa kumppaniluettelon.
Perusluettelo (ei query-parametreja): Palauttaa vain perustiedot: id, nimi, alvtunnus
Tarkennettu haku (query-parametreillä): Palauttaa lisäksi: iban, menotili, tulotili ja muut kumppanin tiedot
get /kumppanit
Palauttaa kumppaniluettelon.
Perusluettelo (ei query-parametreja): Palauttaa vain perustiedot: id, nimi, alvtunnus
Tarkennettu haku (query-parametreillä): Palauttaa lisäksi: iban, menotili, tulotili ja muut kumppanin tiedot
Kitsaan autentikaatiotoken
Query Parameters
-
email:
(string)
Hakee sähköpostiosoitteella
-
alv:
(string)
Hakee alv-tunnuksella
-
nimi:
(string)
Hakee nimellä
-
ryhma:
(integer)
Hakee ryhmän jäsenet
-
iban:
(string)
Hakee tilinumerolla (iban)
HTTP status code 200
Body
Media type: application/json
Type: array of object
Items: KumppaniListaTieto
-
id:
required (integer)
Kumppanin id
-
nimi:
required (string)
Kumppanin nimi
-
alvtunnus:
required (string)
Kumppanin ALV-tunnus
-
iban:
(array of string)
Kumppanin IBAN-tilinumerot
-
menotili:
(integer)
Eniten käytetty menotili
-
tulotili:
(integer)
Eniten käytetty tulotili
-
maa:
(string)
Maatunnus (esim. fi)
-
email:
(string)
Kumppanin sähköpostiosoite
-
osoite:
(string)
Kumppanin lähiosoite
-
postinumero:
(string)
Kumppanin postinumero
-
kaupunki:
(string)
Kumppanin postitoimipaikka
-
osavaltio:
(string)
Kumppanin alue tai osavaltio
-
ovt:
(string)
Kumppanin verkkolaskuosoitteen ovt-tunnus
-
operaattori:
(string)
Kumppanin verkkolaskuosoitteen operaattoritunnus
-
kieli:
(string)
Kumppanin laskutuskieli (esim FI)
-
laskutapa:
(one of 0, 1, 2, 5)
Oletustapa laskun lähettämiseen
Koodi Lähetystapa 0 Lasku tulostetaan 1 Lasku lähetetään sähköpostilla 2 Lasku toimitetaan verkkolaskuna 5 Lasku toimitetaan postituspalvelun välityksellä -
ryhmat:
(array of integer)
Ryhmien id:t, joihin kumppani kuuluu
-
lisatiedot:
(string)
Kumppanille määritellyt tekstimuotoiset lisätiedot
-
puhelin:
(string)
Kumppanin puhelinnumero
-
maksuaika:
(integer)
Asiakaskohtainen maksuaika vuorokausina
Secured by token
Headers
-
Authorization:
required (string)
Kitsas Login Serverin tuottaman token, joka antaa oikeuden tähän pilveen
HTTP status code 403
Virheellinen token tai puuttuva oikeus
Kumppanin tiedot id:llä
get /kumppanit/{id}
Kumppanin tiedot id:llä
Kitsaan autentikaatiotoken
URI Parameters
-
id:
required (integer)
Haettavan kumppanin id
HTTP status code 200
Body
Media type: application/json
Type: object
Properties-
id:
(integer)
Kumppanin id
-
nimi:
(string)
Kumppanin nimi
-
alvtunnus:
(string)
Kumppanin ALV-tunnus. Suomalainen Y-tunnus muutetaan alv-tunnukseksi, vaikka kumppani ei olisikaan alv-velvollinen ja siten kumppanilla ei todellisuudessa olisi alv-tunnusta
-
maa:
(string)
Maatunnus (esim. fi)
-
email:
(string)
Kumppanin sähköpostiosoite
-
osoite:
(string)
Kumppanin lähiosoite
-
postinumero:
(string)
Kumppanin postinumero
-
kaupunk:
(string)
Kumppanin postitoimipaikka
-
iban:
(array of string)
Kumppanin tilinumerot (IBAN)-muodossa. Käytetään ostolaskujen kohdentamiseen tiliotteelta tuotaessa
-
ovt:
(string)
Kumppanin verkkolaskuosoitteen ovt-tunnus
-
operaattori:
(string)
Kumppanin verkkolaskuosoitteen operaattoritunnus
-
kieli:
(string)
Kumppanin laskutuskieli (esim FI)
-
laskutapa:
(one of 0, 1, 2, 5)
Oletustapa laskun lähettämiseen
Koodi Lähetystapa 0 Lasku tulostetaan 1 Lasku lähetetään sähköpostilla 2 Lasku toimitetaan verkkolaskuna 5 Lasku toimitetaan postituspalvelun välityksellä -
ryhmat:
(array of integer)
Ryhmien id:t, joihin kumppani kuuluu
-
lisatiedot:
(string)
Kumppanille määritellyt tekstimuotoiset lisätiedot
-
menotili:
(any)
Tili, jolla tältä kumppanilta kirjattu eniten menokirjauksia
-
tulotili:
(any)
Tili, jolle tältä kumppanilta kirjattu eniten tulokirjauksia
Secured by token
Headers
-
Authorization:
required (string)
Kitsas Login Serverin tuottaman token, joka antaa oikeuden tähän pilveen
HTTP status code 403
Virheellinen token tai puuttuva oikeus
/liitteet
Liitteiden luettelo
get /liitteet
Liitteiden luettelo
Kitsaan autentikaatiotoken
Query Parameters
- alkupvm: required (string - pattern: \d{4}-\d{2}-\d{2})
- loppupvm: required (string - pattern: \d{4}-\d{2}-\d{2})
HTTP status code 200
Body
Media type: application/json
Type: array of object
Items: LiiteInfo
-
id:
required (integer)
Liitteen id
-
pvm:
required (string - pattern: \d{4}-\d{2}-\d{2})
Tositteen pvm
-
sarja:
(string)
Tositteen tunnistesarja
-
tunniste:
required (integer)
Tositteen tunniste
-
nimi:
(string)
Liitteen nimi
-
tyyppi:
(string)
Liitteen mimetyyppi
Secured by token
Headers
-
Authorization:
required (string)
Kitsas Login Serverin tuottaman token, joka antaa oikeuden tähän pilveen
HTTP status code 403
Virheellinen token tai puuttuva oikeus
Hakee liitteen id:llä
get /liitteet/{id}
Hakee liitteen id:llä
Kitsaan autentikaatiotoken
URI Parameters
-
id:
required (integer)
Haetaan Merkitys Yksittäistä liitettä liitteen id Tositteen liite roolinimellä tositteen id Tositteeseen liittymätön tiedosto roolinimellä 0
HTTP status code 200
Body
Media type: image/jpeg
Type: file
Media type: application/pdf
Type: file
Media type: image/png
Type: file
Media type: text/csv
Type: file
Secured by token
Headers
-
Authorization:
required (string)
Kitsas Login Serverin tuottaman token, joka antaa oikeuden tähän pilveen
HTTP status code 403
Virheellinen token tai puuttuva oikeus
Hakee tositteeseen liittyvän liitten roolinimellä
get /liitteet/{id}/{roolinimi}
Hakee tositteeseen liittyvän liitten roolinimellä
Kitsaan autentikaatiotoken
URI Parameters
-
id:
required (integer)
Haetaan Merkitys Yksittäistä liitettä liitteen id Tositteen liite roolinimellä tositteen id Tositteeseen liittymätön tiedosto roolinimellä 0 -
roolinimi:
required (string)
Liitteen roolinimi (esim. lasku)
HTTP status code 200
Body
Media type: image/jpeg
Type: file
Media type: application/pdf
Type: file
Media type: image/png
Type: file
Media type: text/csv
Type: file
Media type: text/plain
Type: file
Secured by token
Headers
-
Authorization:
required (string)
Kitsas Login Serverin tuottaman token, joka antaa oikeuden tähän pilveen
HTTP status code 403
Virheellinen token tai puuttuva oikeus
/ryhmat
Kumppaniryhmän tiedot
Hakee kumppaniryhmät
get /ryhmat
Hakee kumppaniryhmät
Kitsaan autentikaatiotoken
HTTP status code 200
Body
Media type: application/json
Type: array of object
Items: KumppaniRyhmaInfo
-
id:
required (integer)
Ryhman id
-
nimi:
required (string)
Ryhmän nimi
Secured by token
Headers
-
Authorization:
required (string)
Kitsas Login Serverin tuottaman token, joka antaa oikeuden tähän pilveen
HTTP status code 403
Virheellinen token tai puuttuva oikeus
Ryhmän tiedot
get /ryhmat/{id}
Ryhmän tiedot
Kitsaan autentikaatiotoken
URI Parameters
-
id:
required (integer)
Ryhmän id
HTTP status code 200
Body
Media type: application/json
Type: object
Properties-
id:
required (integer)
Ryhmän id
-
nimi:
required (string)
Ryhmän nimi
-
jasenet:
required (array of object)
Ryhmän jäsenet
Items: KumppaniRyhmaJasenyys
-
id:
required (integer)
Kumppanin id
-
nimi:
required (string)
Kumppanin nimi
-
id:
required (integer)
Secured by token
Headers
-
Authorization:
required (string)
Kitsas Login Serverin tuottaman token, joka antaa oikeuden tähän pilveen
HTTP status code 403
Virheellinen token tai puuttuva oikeus
/tilikaudet
Tilikausien näkymän tiedot
get /tilikaudet
Kitsaan autentikaatiotoken
HTTP status code 200
Body
Media type: application/json
Type: array of TilikausiPerus
Items: TilikausiInfo
-
alkaa:
required (string - pattern: \d{4}-\d{2}-\d{2})
Tilikauden alkupäivä
-
loppuu:
required (string - pattern: \d{4}-\d{2}-\d{2})
Tilikauden päättymispäivä
-
henkilosto:
(integer)
Henkilöstön määrä (JSON-kentästä)
-
tilinpaatosteksti:
(string)
Tilinpäätöksen liitetietojen teksti (JSON-kentästä)
-
vahvistettu:
(string - pattern: \d{4}-\d{2}-\d{2})
Päivämäärä, jolloin tilinpäätös vahvistettu (JSON-kentästä)
-
virhe:
(boolean)
Onko tilikausi tasapainossa (true = ei ole tasapainossa)
-
tase:
required (string - pattern: -?\d+\.\d{2})
Tilikauden tase euroina (muodossa "123.45")
-
tulos:
required (string - pattern: -?\d+\.\d{2})
Tilikauden tulos euroina (muodossa "123.45")
-
liikevaihto:
required (number)
Tilikauden liikevaihto euroina
-
paivitetty:
(string - pattern: \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z)
Viimeisin päivitysaika ISO 8601 -muodossa
-
liitekoko:
(number)
Liitteiden kokonaiskoko tavuissa
-
viimeinen:
(string - pattern: \d{4}-\d{2}-\d{2})
Viimeisen tositteen päivä (vain viimeiselle kaudelle)
Secured by token
Headers
-
Authorization:
required (string)
Kitsas Login Serverin tuottaman token, joka antaa oikeuden tähän pilveen
HTTP status code 403
Virheellinen token tai puuttuva oikeus
Tilikauden tiedot
get /tilikaudet/{alkupaiva}
Tilikauden tiedot
Kitsaan autentikaatiotoken
URI Parameters
- alkupaiva: required (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties-
loppuu:
required (string - pattern: \d{4}-\d{2}-\d{2})
Tilikauden päättymispäivä
-
henkilosto:
(number)
Henkilöstöä keskimäärin
- tilinpaatosteksti: (string)
-
vahvistettu:
(string - pattern: \d{4}-\d{2}-\d{2})
Päivämäärä, jolloin tilinpäätös vahvistettu
Secured by token
Headers
-
Authorization:
required (string)
Kitsas Login Serverin tuottaman token, joka antaa oikeuden tähän pilveen
HTTP status code 403
Virheellinen token tai puuttuva oikeus
/tilit
Tilien tiedot
Hae tililuettelo
get /tilit
Hae tililuettelo
Kitsaan autentikaatiotoken
HTTP status code 200
Body
Media type: application/json
Type: array of object
Items: TiliTieto
-
numero:
required (integer)
Tilin numero
-
nimi:
required (object)
Nimi eri kielillä
-
fi:
required (string)
Nimi suomeksi
-
sv:
required (string)
Nimi ruotsiksi
-
en:
required (string)
Nimi englanniksi
-
fi:
required (string)
-
tyyppi:
required (string)
Tilin tyyppi tai otsikon taso (H1, H2, jne.)
-
lkm:
(integer)
Vientien lukumäärä
-
iban:
(string)
IBAN-numero (vain tileille)
-
laajuus:
(integer)
Millä laajuudella tili on käytössä
-
muodot:
(array of string)
Millä muodoilla tili näytetään
-
poistotili:
(integer)
Mille menotilille poistot kirjataan
-
tasaerapoisto:
(integer)
Tasaeräpoiston poistoaika kuukausina
-
ohje:
(object)
Kirjausohje eri kielillä
-
fi:
required (string)
Kirjausohje suomeksi
-
sv:
required (string)
Kirjausohje ruotsiksi
-
en:
required (string)
Kirjausohje englanniksi
-
fi:
required (string)
-
erittely:
(one of 0, 1, 2, 3)
Tase-erittelyn laajuus:
Arvo Merkitys 0 Saldot 1 Muutokset 2 Tase-erittelyjen luettelo 3 Täysi tase-erittely -
vastatili:
(integer)
Oletustili vastakirjauksille
-
kohdennus:
(integer)
Oletuskohdennus
-
alvlaji:
(integer)
Alv-tyypin koodi
-
alvprosentti:
(number)
Arvonlisäveroprosentti
-
bic:
(string)
Pankkitilin BIC
-
pankki:
(string)
Pankkitilin pankin nimi
Secured by token
Headers
-
Authorization:
required (string)
Kitsas Login Serverin tuottaman token, joka antaa oikeuden tähän pilveen
HTTP status code 403
Virheellinen token tai puuttuva oikeus
Tilin tiedot
get /tilit/{numero}
Tilin tiedot
Kitsaan autentikaatiotoken
URI Parameters
- numero: required (integer)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties-
numero:
required (integer)
Tilin numero
-
nimi:
required (object)
Nimi eri kielillä
-
fi:
required (string)
Nimi suomeksi
-
sv:
required (string)
Nimi ruotsiksi
-
en:
required (string)
Nimi englanniksi
-
fi:
required (string)
-
tyyppi:
required (string)
Tilin tyyppi tai otsikon taso (H1, H2, jne.)
-
lkm:
(integer)
Vientien lukumäärä
-
iban:
(string)
IBAN-numero (vain tileille)
-
laajuus:
(integer)
Millä laajuudella tili on käytössä
-
muodot:
(array of string)
Millä muodoilla tili näytetään
-
poistotili:
(integer)
Mille menotilille poistot kirjataan
-
tasaerapoisto:
(integer)
Tasaeräpoiston poistoaika kuukausina
-
ohje:
(object)
Kirjausohje eri kielillä
-
fi:
required (string)
Kirjausohje suomeksi
-
sv:
required (string)
Kirjausohje ruotsiksi
-
en:
required (string)
Kirjausohje englanniksi
-
fi:
required (string)
-
erittely:
(one of 0, 1, 2, 3)
Tase-erittelyn laajuus:
Arvo Merkitys 0 Saldot 1 Muutokset 2 Tase-erittelyjen luettelo 3 Täysi tase-erittely -
vastatili:
(integer)
Oletustili vastakirjauksille
-
kohdennus:
(integer)
Oletuskohdennus
-
alvlaji:
(integer)
Alv-tyypin koodi
-
alvprosentti:
(number)
Arvonlisäveroprosentti
-
bic:
(string)
Pankkitilin BIC
-
pankki:
(string)
Pankkitilin pankin nimi
Secured by token
Headers
-
Authorization:
required (string)
Kitsas Login Serverin tuottaman token, joka antaa oikeuden tähän pilveen
HTTP status code 403
Virheellinen token tai puuttuva oikeus
/tositteet
Kirjanpidon tositteet
Tositteiden lista
get /tositteet
Tositteiden lista
Kitsaan autentikaatiotoken
Query Parameters
-
luonnos:
(string)
Hakee luonnokset
-
malli:
(string)
Hakee mallipohjat
-
poistetut:
(string)
Hakee poistetut tositteet
-
alkupvm:
(string - pattern: \d{4}-\d{2}-\d{2})
Rajaa tositepäivästä alkaen
-
loppupvm:
(string - pattern: \d{4}-\d{2}-\d{2})
Rajaa toistepäivään saakka
-
pvm:
(string - pattern: \d{4}-\d{2}-\d{2})
Rajaa tositepäivällä
-
laskupvm:
(string)
Rajaa laskupäivällä
-
kumppani:
(integer)
Rajaa kumppani-id:llä
-
tyyppi:
(integer)
Rajaa tositetyypillä
-
viite:
(string)
Rajaa viitteellä
-
laskunumero:
(string)
Rajaa laskunumerolla
-
jarjestys:
(string)
Lajittelujärjestys
- pvm
- tyyppi, tosite
- tosite
- tyyppi, pvm
-
vienti:
(integer)
Hakee tositteen, jolla kyseinen vienti
HTTP status code 200
Body
Media type: application/json
Type: array of object
Items: TositeListalla
-
id:
required (integer)
Tositteen id
-
pvm:
required (string - pattern: \d{4}-\d{2}-\d{2})
Tositteen päivämäärä
-
tyyppi:
required (integer)
Tositten tyyppikoodi
-
tila:
required (integer)
Tositteen tila
-
tunniste:
(integer)
Tositteen tunnistenumero
-
otsikko:
required (string)
Tositteen otsikko
-
kumppani:
(any)
Kumppanin nimi
-
sarja:
(string)
Tositteen numerointisarja
-
summa:
required (number)
Tositteen vientien summa
-
liitteita:
(integer)
Tositteen liiteiden määrä
-
huomio:
(boolean)
Tositteelle on asetettu huomiomerkki
-
tilioimatta:
(integer)
Tiliöimättömien vientien määrä
Secured by token
Headers
-
Authorization:
required (string)
Kitsas Login Serverin tuottaman token, joka antaa oikeuden tähän pilveen
HTTP status code 403
Virheellinen token tai puuttuva oikeus
Hae yksittäisen tositteen tiedot. Palauttaa tositteen kaikki tiedot yhdessä vastauksessa, mukaan lukien viennit, rivit, liitteet, kommentit ja muutokshistorian.
Huom: Tositteen voi hakea myös vientitunnisteella käyttämällä
negatiivista numeroa. Esim. -123
hakee tositteen, jolla on vienti
tunnisteella 123.
Palauttaa yksittäisen tositteen kaikki tiedot. Vastaus sisältää:
Perustiedot:
- Tositteen tunniste, päivämäärä, tyyppi ja tila
- Numerointi (sarja ja tunniste)
- Otsikko ja lisätiedot
Kirjaukset:
- Viennit (kirjausrivit) tilineen, kohdennuksineen ja summineen
- Rivit (tuoterivit) tuotetietoineen ja hinnoineen
- Erät ja niiden saldot
Liitetyt tiedot:
- Kumppanin tiedot (asiakas/toimittaja)
- Liitteet (tiedostot ja niiden metatiedot)
- Kommentit ja niiden kirjoittajat
- Muutoshistoria (loki)
Laskutiedot (laskuissa):
- Laskun numero, viite ja päivämäärät
- Lähetystapa ja saajan tiedot
- ALV-tiedot ja maksutavat
Erikoistiedot:
- Tiliotteen tiedot (tiliotteissa)
- ALV-ilmoituksen tiedot (ALV-laskelmissa)
- Portaalin tiedot (portaaliin syötetyissä laskuissa)
get /tositteet/{tositeId}
Palauttaa yksittäisen tositteen kaikki tiedot. Vastaus sisältää:
Perustiedot:
- Tositteen tunniste, päivämäärä, tyyppi ja tila
- Numerointi (sarja ja tunniste)
- Otsikko ja lisätiedot
Kirjaukset:
- Viennit (kirjausrivit) tilineen, kohdennuksineen ja summineen
- Rivit (tuoterivit) tuotetietoineen ja hinnoineen
- Erät ja niiden saldot
Liitetyt tiedot:
- Kumppanin tiedot (asiakas/toimittaja)
- Liitteet (tiedostot ja niiden metatiedot)
- Kommentit ja niiden kirjoittajat
- Muutoshistoria (loki)
Laskutiedot (laskuissa):
- Laskun numero, viite ja päivämäärät
- Lähetystapa ja saajan tiedot
- ALV-tiedot ja maksutavat
Erikoistiedot:
- Tiliotteen tiedot (tiliotteissa)
- ALV-ilmoituksen tiedot (ALV-laskelmissa)
- Portaalin tiedot (portaaliin syötetyissä laskuissa)
Kitsaan autentikaatiotoken
URI Parameters
-
tositeId:
required (integer)
Haettavan tositteen yksilöllinen tunniste.
- Positiivinen luku: tositteen ID
- Negatiivinen luku: vientitunniste (hakee tositteen, jolla on kyseinen vienti)
HTTP status code 200
Tositteen tiedot on haettu onnistuneesti. Vastaus sisältää tositteen kaikki tiedot TositeResult-tyypin mukaisesti.
Body
Media type: application/json
Type: object
Properties-
id:
required (integer)
Tositteen yksilöllinen tunniste
-
pvm:
required (string - pattern: \d{4}-\d{2}-\d{2})
Tositteen kirjauspäivämäärä (YYYY-MM-DD)
-
tyyppi:
required (integer)
Tositteen tyyppikoodi. Määrittelee tositteen luonteen ja käyttötarkoituksen.
Koodi Tyyppi Kuvaus 0 MUU Muu tosite 100 MENO Menokirjaus 120 KULULASKU Kululasku 200 TULO Tulokirjaus 210 MYYNTILASKU Myyntilasku 214 HYVITYSLASKU Hyvityslasku 216 MAKSUMUISTUTUS Maksumuistutus 300 SIIRTO Siirtokirjaus 400 TILIOTE Tiliote 500 PALKKA Palkka 700 MUISTIO Muistio 800 LIITETIETO Liitetieto 9000 JARJESTELMA Järjestelmätosite 9010 TILINAVAUS Tilinavaus 9100 ALVLASKELMA ALV-laskelma 9110 YHTEENVETOILMOITUS Yhteenvetoilmoitus 9910 POISTOLASKELMA Poistolaskelma 9920 JAKSOTUS Jaksotus 9930 TULOVERO Tulovero 9040 YKSITYISTILIEN_PAATTAMINEN Yksityistilien päätäminen -
tila:
(integer)
Tositteen tilakoodi. Määrittelee tositteen käsittelyvaiheen.
Koodi Tila Kuvaus 0 POISTETTU Tosite on poistettu 5 MALLIPOHJA Mallipohja 10 HYLATTY Hylätty kierrossa 20 SAAPUNUT Saapunut kierrossa 30 TARKASTETTU Tarkastettu kierrossa 40 HYVAKSYTTY Hyväksytty kierrossa 50 LUONNOS Luonnos 80 VALMISLASKU Valmis lasku 100 KIRJANPIDOSSA Kirjanpidossa 101 LAHETETAAN Lasku lähetetään 102 LAHETYSVIRHE Laskun lähetyksessä virhe 110 LAHETETTYLASKU Lasku lähetetty 120 MUISTUTETTU Muistutettu -
sarja:
(string)
Tositteen numerointisarja (esim. "A", "B", "LASKU")
-
tunniste:
(integer)
Tositteen numerointisarjan sisäinen järjestysnumero
-
viennit:
(array of TositeVienti)
Tositteen viennit (kirjaukset). Jokainen vienti edustaa yhtä kirjausriviä. Viennit sisältävät tilin, kohdennuksen, selitteen ja rahasumman.
Items: TositeVienti
-
id:
(integer)
Viennin yksilöllinen tunniste
-
pvm:
required (string - pattern: \d{4}-\d{2}-\d{2})
Viennin kirjauspäivämäärä (YYYY-MM-DD). Yleensä sama kuin tositteen päivämäärä.
-
tili:
required (integer)
Kirjausvastatilin numero. Määrittelee mille tilille vienti kirjataan. Esim. 2871 = Ostovelat, 1701 = Myyntisaamiset.
-
kohdennus:
(integer)
Kohdennuksen tunniste. Määrittelee kustannuspaikan tai projektin. Jos ei määritelty, käytetään oletuskohdennusta.
-
selite:
(string)
Viennin selite. Kuvaa mitä vienti edustaa. Esim. "Ostolasku toimittajalta", "Myyntilasku asiakkaalle".
-
debet:
(number)
Debet-summa euroina. Positiivinen arvo tarkoittaa debet-kirjausta. Esim. 100.50 = 100 euroa 50 senttiä.
-
kredit:
(number)
Kredit-summa euroina. Positiivinen arvo tarkoittaa kredit-kirjausta. Esim. 100.50 = 100 euroa 50 senttiä.
-
alvprosentti:
(number)
Arvonlisäveroprosentti. Esim. 24.0 = 24% ALV. Jos ei määritelty, ei ALV-kirjausta.
-
alvkoodi:
(integer)
ALV-koodi. Määrittelee ALV-kirjauksen tyypin. Esim. 1 = ALV-velvollinen myynti, 2 = ALV-vapaa myynti.
-
era:
(object)
Erän tiedot. Sisältää erän tunnisteen, saldon ja muut erätiedot. Käytetään tase-erittelyssä ja maksujen seurannassa.
-
id:
required (integer)
Erän yksilöllinen tunniste
-
sarja:
(string)
Erän avanneen tositteen sarja
-
tunniste:
(integer)
Erän avanneen tositteen tunniste
-
pvm:
(string - pattern: \d{4}-\d{2}-\d{2})
Erän avanneen tositteen päivämäärä
-
saldo:
required (number)
Erän avoin saldo euroina
-
asiakas:
(object)
Asiakkaan tiedot, jos erä on asiakas-erä
-
id:
required (integer)
Asiakkaan tunniste
-
nimi:
required (string)
Asiakkaan nimi
-
id:
required (integer)
-
huoneisto:
(object)
Huoneiston tiedot, jos erä on huoneisto-erä
-
id:
required (integer)
Huoneiston tunniste
-
nimi:
required (string)
Huoneiston nimi
-
id:
required (integer)
-
id:
required (integer)
-
jaksoalkaa:
(string - pattern: \d{4}-\d{2}-\d{2})
Jaksotuksen alkupäivä. Jos vienti on jaksotettu, tämä määrittelee jaksotuksen alkupäivämäärän.
-
jaksoloppuu:
(string - pattern: \d{4}-\d{2}-\d{2})
Jaksotuksen loppupäivä. Jos vienti on jaksotettu, tämä määrittelee jaksotuksen päättymispäivämäärän.
-
jaksotustili:
(integer)
Jaksotuksen tasetili. Jos vienti on jaksotettu, tämä määrittelee mille tasetilille jaksotus kirjataan.
-
kumppani:
(object)
Vientiin liittyvä kumppani. Sisältää kumppanin perustiedot. Käytetään esim. ostolaskuissa ja myyntilaskuissa.
-
id:
(integer)
Kumppanin id
-
nimi:
(string)
Kumppanin nimi
-
alvtunnus:
(string)
Kumppanin ALV-tunnus. Suomalainen Y-tunnus muutetaan alv-tunnukseksi, vaikka kumppani ei olisikaan alv-velvollinen ja siten kumppanilla ei todellisuudessa olisi alv-tunnusta
-
maa:
(string)
Maatunnus (esim. fi)
-
email:
(string)
Kumppanin sähköpostiosoite
-
osoite:
(string)
Kumppanin lähiosoite
-
postinumero:
(string)
Kumppanin postinumero
-
kaupunk:
(string)
Kumppanin postitoimipaikka
-
iban:
(array of string)
Kumppanin tilinumerot (IBAN)-muodossa. Käytetään ostolaskujen kohdentamiseen tiliotteelta tuotaessa
-
ovt:
(string)
Kumppanin verkkolaskuosoitteen ovt-tunnus
-
operaattori:
(string)
Kumppanin verkkolaskuosoitteen operaattoritunnus
-
kieli:
(string)
Kumppanin laskutuskieli (esim FI)
-
laskutapa:
(one of 0, 1, 2, 5)
Oletustapa laskun lähettämiseen
Koodi Lähetystapa 0 Lasku tulostetaan 1 Lasku lähetetään sähköpostilla 2 Lasku toimitetaan verkkolaskuna 5 Lasku toimitetaan postituspalvelun välityksellä -
ryhmat:
(array of integer)
Ryhmien id:t, joihin kumppani kuuluu
-
lisatiedot:
(string)
Kumppanille määritellyt tekstimuotoiset lisätiedot
-
menotili:
(any)
Tili, jolla tältä kumppanilta kirjattu eniten menokirjauksia
-
tulotili:
(any)
Tili, jolle tältä kumppanilta kirjattu eniten tulokirjauksia
-
id:
(integer)
-
tyyppi:
(integer)
Viennin tyyppikoodi. Määrittelee viennin luonteen.
Koodi Tyyppi Kuvaus 1 KIRJAUS Tavallinen kirjaus 2 VASTAKIRJAUS Vastakirjaus 3 ALVKIRJAUS ALV-kirjaus 100 OSTO Ostokirjaus 200 MYYNTI Myyntikirjaus 300 SUORITUS Maksukirjaus 400 SIIRTO Siirtokirjaus -
viite:
(string)
Tiliotteen rivin viitenumero. Käytetään kun vienti on tuotu tiliotteelta.
-
tasaerapoisto:
(integer)
Tasaeräpoiston poistoaika kuukausina. Jos vienti on tasaeräpoisto, tämä määrittelee poistoajan.
-
ostopvm:
(string - pattern: \d{4}-\d{2}-\d{2})
Pankkikorttioston päivämäärä. Käytetään kun vienti on pankkikorttiosto.
-
aalv:
(string)
Arvonlisäveron kirjaaminen. Määrittelee miten ALV kirjataan. Esim. "A" = ALV-kirjaus erikseen, "B" = ALV sisältyy summaan.
-
arkistotunnus:
(string)
Pankin arkistotunnus. Käytetään kun vienti on tuotu pankkiyhteydellä.
-
tiliote:
(object)
Tiliotteen tiedot. Sisältää tiliotteen tyyppikoodin. Käytetään kun vienti on tuotu tiliotteelta.
-
tyyppikoodi:
required (string)
Pankkiyhteydellä tuotaessa tyyppikoodi. Määrittelee tapahtuman tyypin pankin mukaan.
-
tyyppikoodi:
required (string)
-
id:
(integer)
-
rivit:
(array of TositeRivi)
Tositteen rivit (tuoterivit). Käytetään laskuissa ja tuotekirjauksissa. Sisältää tuotetiedot, määrät ja hinnat.
Items: TositeRivi
-
tuote:
(integer)
Tuotteen tuotekoodi. Viittaa tuoterekisteriin. Jos ei määritelty, rivi on manuaalinen.
-
myyntikpl:
(number)
Myyty kappaletta. Positiivinen luku. Esim. 5.0 = 5 kappaletta.
-
ostokpl:
(number)
Ostettu kappaletta. Positiivinen luku. Esim. 10.0 = 10 kappaletta.
-
ahinta:
(number)
Yksikkönettohinta euroina. Veroton hinta per kappale. Esim. 25.50 = 25 euroa 50 senttiä per kappale.
-
nimike:
(string)
Tuotteen nimike. Tuotteen nimi tai kuvaus. Esim. "Tietokone", "Konsultointi".
-
yksikko:
(string)
Tuotteen yksikkö. Esim. "kpl", "h", "kg". Määrittelee miten määrä ilmaistaan.
-
tili:
(integer)
Kirjaustili. Mille tilille rivi kirjataan. Esim. 3000 = Ostovelat, 4000 = Myyntisaamiset.
-
kohdennus:
(integer)
Kohdennuksen id. Määrittelee kustannuspaikan tai projektin. Jos ei määritelty, kuuluu kohdennukselle "Yleinen".
-
alvkoodi:
(integer)
ALV-koodi. Määrittelee ALV-kirjauksen tyypin. Esim. 1 = ALV-velvollinen myynti, 2 = ALV-vapaa myynti.
-
alvprosentti:
(number)
ALV-prosentti. Esim. 24.0 = 24% ALV. Jos ei määritelty, ei ALV-kirjausta.
-
aleprosentti:
(number)
Prosentteina määritelty alennus. Esim. 10.0 = 10% alennus. Lasketaan alkuperäisestä hinnasta.
-
kuvaus:
(string)
Rivin kuvaus. Lisätietoja rivistä. Esim. "Asennuspalvelu", "Kuljetus".
-
merkkaukset:
(array of integer)
Merkkaukset. Kohdennusten tunnukset. Sisältää kustannuspaikat ja projektit.
-
euroalennus:
(number)
Euroina määritelty alennus. Esim. 5.00 = 5 euroa alennus. Lasketaan alkuperäisestä hinnasta.
-
alennussyy:
(integer)
Alennuksen syykoodi. Peppol-standardin mukainen. Käytetään verkkolaskujen lähetyksessä.
-
toimitettu:
(number)
Toimitettu kappaletta. Käytetään osittaisissa toimituksissa. Esim. 3.0 = 3 kappaletta toimitettu.
-
jalkitoimitus:
(number)
Jälkitoimitetaan kappaletta. Käytetään osittaisissa toimituksissa. Esim. 2.0 = 2 kappaletta jälkitoimitetaan.
-
laskutetaan:
(number)
Laskutetaan kappaletta. Käytetään osittaisissa laskutuksissa. Esim. 4.0 = 4 kappaletta laskutetaan.
-
unkoodi:
(string)
Yksikön UN-koodi. Standardoitu yksikkökoodi. Käytetään kansainvälisessä kaupassa.
-
brutto:
(number)
Rivin bruttosumma euroina. Sisältää ALV:n. Esim. 124.00 = 100.00 + 24.00 ALV.
-
lisatiedot:
(string)
Rivin lisätiedot. Vapaamuotoinen lisätieto. Esim. "Kiireellinen toimitus", "Erikoishinta".
-
ennakkoera:
(integer)
Hyvitettäessä ennakkolaskua ennakkomaksun eräid. Viittaa ennakkomaksun erään.
-
jaksoalkaa:
(string - pattern: \d{4}-\d{2}-\d{2})
Jaksotuksen alkupäivä. Jos rivi on jaksotettu, tämä määrittelee jaksotuksen alkupäivämäärän.
-
jaksoloppuu:
(string - pattern: \d{4}-\d{2}-\d{2})
Jaksotuksen loppupäivä. Jos rivi on jaksotettu, tämä määrittelee jaksotuksen päättymispäivämäärän.
-
tuotekoodi:
(string)
Tuotekoodi järjestelmäintegraatioita varten. Ulkoinen tuotekoodi tai viittaus.
-
tuote:
(integer)
-
otsikko:
(string)
Tositteen otsikko tai selite
-
info:
(string)
Tositteen lisätiedot tai kommentit
-
laskupvm:
(string - pattern: \d{4}-\d{2}-\d{2})
Laskun antamispäivämäärä (laskuissa)
-
erapvm:
(string - pattern: \d{4}-\d{2}-\d{2})
Laskun eräpäivä (laskuissa)
-
viite:
(string)
Laskun viitenumero
-
kierto:
(integer)
Kierron polkutunnus, jos tosite on kierrossa. Määrittelee missä kierrossa tosite on ja mikä on sen rooli.
-
lasku:
(object)
Laskun tiedot, jos tosite on lasku. Sisältää laskun numeron, lähetystavan, saajan tiedot ja muut laskuun liittyvät tiedot.
-
numero:
(any)
Laskun numero
-
viite:
(any)
Viitenumero
-
alvtunnus:
(string)
Asiakkaan alv-tunnus
-
email:
(string)
Asiakkaan osoite
-
pvm:
(string - pattern: \d{4}-\d{2}-\d{2})
Laskun päivämäärä
-
kieli:
(string)
Laskun kielikoodi (esim. FI)
-
viivkorko:
(any)
Laskun viivästyskorko
-
laskutapa:
(integer)
Laskun lähetystapa
Koodi Lähetystapa 0 Lasku tulostetaan 1 Lasku lähetetään sähköpostilla 2 Lasku toimitetaan verkkolaskuna 3 Tallenna pdf-tiedosto 4 Laskua ei tulosteta 5 Lasku toimitetaan postituspalvelun välityksellä 6 Lasku tuotu aiemmasta versiosta -
toimituspvm:
(string - pattern: \d{4}-\d{2}-\d{2})
Tuotteen toimituspäivä
-
jaksopvm:
(string - pattern: \d{4}-\d{2}-\d{2})
Jaksotuksen päättymispvm
-
erapvm:
(string - pattern: \d{4}-\d{2}-\d{2})
Laskun eräpäivä
-
maksutapa:
(integer)
Laskun kirjanpitokäsittely
Koodi Kirjaaminen 0 Laskuperuste 1 Käteinen 2 Ennakkolasku 3 Suoriteperuste 4 Kuukausittainen -
otsikko:
(any)
Laskun otsikko
-
osoite:
(string)
Laskun saaja ja osoite
-
saate:
(any)
Saatteena lähetettävä sähköpostiviesti
-
saateotsikko:
(any)
Saatteena lähtevän sähköpostiviestin otsikko
-
alkupNro:
(integer)
Hyvityslaskussa ja maksumuistuksessa alkuperäisen laskun numero
-
alkupPvm:
(string - pattern: \d{4}-\d{2}-\d{2})
Hyvityslaskussa ja maksumuistuksessa alkuperäisen laskun päiväys
-
aiemmat:
(array of object)
Maksumuistuksella muistutettavat laskut
Items:
-
aiempisaldo:
(number)
Maksumuistutuksessa aiempien laskujen saldo
-
asviite:
(any)
Asiakkaan viite
-
tilausnumero:
(any)
Asiakkaan tilausnumero
-
tilaaja:
(any)
Tilaajan nimi
-
sopimusnumero:
(any)
Sopimuksen numero
-
lisatiedot:
(any)
Laskun lisätiedot
-
erittely:
(any)
Laskun loppuun tulostuva erittely
-
summa:
(any)
Laskun maksettava summa
-
muistutusmaksu:
(any)
Maksumuistuksen maksu euroa
-
korko:
(any)
Maksettava viivästyskorko euroa
-
korkoalkaa:
(string - pattern: \d{4}-\d{2}-\d{2})
Viivästyskoron laskenta alkaen
-
korkoloppuu:
(string - pattern: \d{4}-\d{2}-\d{2})
Viivästyskoko laskenta päättyy
-
iban:
(string)
Ostolaskun maksutili
-
valvonta:
(integer)
Laskun valvonta
Koodi Kirjaaminen 0 Laskuvalvonta 2 Vakioviite 3 Asiakas 4 Huoneisto 99 Valvomaton -
saatemaksutiedot:
(string)
Sähköpostiviestiin liitetään maksutiedot
-
toisto:
(object)
Laskun toistuminen laskutusjakson jälkeen
-
pvm:
required (string - pattern: \{4}-\d{2}-\d{2})
Päivämäärä jolloin seuraava lasku muodostetaan
-
loppuu:
(string - pattern: \{4}-\d{2}-\d{2})
Päivämäärä jolloin toistaminen lopetetaan
-
jaksonpituus:
required (integer)
Toistojakson pituus kuukautta
-
hinnastolla:
(boolean)
Toistettaessa päivitetään hinnaston mukaiseksi
-
pvm:
required (string - pattern: \{4}-\d{2}-\d{2})
-
myyja:
(string)
Myyjän nimi
-
huomautusaika:
(integer)
Huomautusaika päivää
-
toistuvanerapaiva:
(integer)
Kuukausittaisen laskun eräpäivä
-
rivityyppi:
(integer)
Laskun rivien tyyppi
koodi Rivityyppi 0 Bruttorivit 1 Nettorivit 2 Pitkät rivit -
toiminimi:
(integer)
Laskulle tulostettavan toiminimen indeksi
-
banner:
(string)
Laskulle tulostuvan markkinointibannerin id
-
numero:
(any)
-
kumppani:
(object)
Tositteeseen liittyvä kumppani (asiakas tai toimittaja). Sisältää kumppanin perustiedot ilman laskennallisia kenttiä.
-
id:
(integer)
Kumppanin id
-
nimi:
(string)
Kumppanin nimi
-
alvtunnus:
(string)
Kumppanin ALV-tunnus. Suomalainen Y-tunnus muutetaan alv-tunnukseksi, vaikka kumppani ei olisikaan alv-velvollinen ja siten kumppanilla ei todellisuudessa olisi alv-tunnusta
-
maa:
(string)
Maatunnus (esim. fi)
-
email:
(string)
Kumppanin sähköpostiosoite
-
osoite:
(string)
Kumppanin lähiosoite
-
postinumero:
(string)
Kumppanin postinumero
-
kaupunki:
(string)
Kumppanin postitoimipaikka
-
osavaltio:
(string)
Kumppanin alue tai osavaltio
-
iban:
(array of string)
Kumppanin tilinumerot (IBAN)-muodossa. Käytetään ostolaskujen kohdentamiseen tiliotteelta tuotaessa
-
ovt:
(string)
Kumppanin verkkolaskuosoitteen ovt-tunnus
-
operaattori:
(string)
Kumppanin verkkolaskuosoitteen operaattoritunnus
-
kieli:
(string)
Kumppanin laskutuskieli (esim FI)
-
laskutapa:
(one of 0, 1, 2, 5)
Oletustapa laskun lähettämiseen
Koodi Lähetystapa 0 Lasku tulostetaan 1 Lasku lähetetään sähköpostilla 2 Lasku toimitetaan verkkolaskuna 5 Lasku toimitetaan postituspalvelun välityksellä -
ryhmat:
(array of integer)
Ryhmien id:t, joihin kumppani kuuluu
-
lisatiedot:
(string)
Kumppanille määritellyt tekstimuotoiset lisätiedot
-
puhelin:
(string)
Kumppanin puhelinnumero
-
maksuaika:
(integer)
Asiakaskohtainen maksuaika vuorokausina
-
id:
(integer)
-
alv:
(object)
ALV-ilmoituksen lisätiedot. Sisältää ALV-kauden, maksettavan veron ja marginaaliveron alijäämät.
-
kausialkaa:
required (string - pattern: \d{4}-\d{2}-\d{2})
ALV-kauden alkupäivämäärä (YYYY-MM-DD). ALV-ilmoituksen kattaman ajanjakson alku.
-
kausipaattyy:
required (string - pattern: \d{4}-\d{2}-\d{2})
ALV-kauden loppupäivämäärä (YYYY-MM-DD). ALV-ilmoituksen kattaman ajanjakson loppu.
-
erapvm:
(string - pattern: \d{4}-\d{2}-\d{2})
ALV-ilmoituksen eräpäivä (YYYY-MM-DD). Päivä, jolloin ALV on maksettava.
-
maksettava:
(number)
Maksettavan veron määrä euroina ALV-kaudelta. Positiivinen arvo tarkoittaa maksettavaa veroa. Negatiivinen arvo tarkoittaa palautettavaa veroa.
-
marginaalialijaama:
(object)
Marginaaliveron alijäämät muodossa { verokanta : alijäämä, ...}. Käytetään marginaaliveron laskennassa. Esim. { "24": 100.50, "14": 25.00 }.
-
kausialkaa:
required (string - pattern: \d{4}-\d{2}-\d{2})
-
maventaid:
(string)
Lähetetyn tai vastaanotetun verkkolaskun tunnus Maventassa. Käytetään verkkolaskujen seurantaan.
-
huomio:
(boolean)
Onko tositteelle asetettu huomiomerkki. Huomiomerkityt tositteet näkyvät erikseen käyttöliittymässä.
-
tiliote:
(object)
Tiliotteen tiedot, jos tosite on tiliote. Sisältää tiliotteen aikavälin ja tilin tiedot.
-
alkupvm:
required (string - pattern: \d{4}-\d{2}-\d{2})
Tiliotteen alkupäivämäärä (YYYY-MM-DD). Tiliotteen kattaman ajanjakson alku.
-
lopupvm:
required (string - pattern: \d{4}-\d{2}-\d{2})
Tiliotteen loppupäivämäärä (YYYY-MM-DD). Tiliotteen kattaman ajanjakson loppu.
-
tili:
required (integer)
Tiliotteen tili. Pankkitilin tunniste kirjanpidossa. Viittaa Tili-taulun numero-kenttään.
-
original:
(object)
Pankkiyhteydellä tuotu alkuperäistiliote. Sisältää pankin palauttamat alkuperäiset tiedot. Muoto riippuu pankista ja yhteydestä.
-
alkupvm:
required (string - pattern: \d{4}-\d{2}-\d{2})
-
tilioterivi:
(integer)
Rivinumero tiliotteella, jos tosite on tiliotteen rivi. Tiliotteelle itselleen arvo on 0.
-
origin:
(object)
Lisäosan tallentamia alkuperätietoja
-
liitteet:
(array of LiiteInfo)
Tositteeseen liittyvät liitteet. Sisältää tiedostojen nimet, tyypit ja roolinimet.
Items: LiiteInfo
-
id:
required (integer)
Liitteen id
-
pvm:
required (string - pattern: \d{4}-\d{2}-\d{2})
Tositteen pvm
-
sarja:
(string)
Tositteen tunnistesarja
-
tunniste:
required (integer)
Tositteen tunniste
-
nimi:
(string)
Liitteen nimi
-
tyyppi:
(string)
Liitteen mimetyyppi
-
id:
required (integer)
-
loki:
(array of TositeLokiRivi)
Tositteen muutokshistoria. Sisältää kaikki tositteeseen tehdyt muutokset, muuttajat ja muutosaikaleimat.
Items: TositeLokiRivi
-
data:
required (object)
Päivityspyynnön data. Sisältää muutetut kentät ja niiden arvot. Muoto riippuu muutoksen tyypistä.
-
aika:
required (datetime)
Muutoksen aikaleima. Muodossa ISO 8601 (YYYY-MM-DDTHH:MM:SS.sssZ).
-
tila:
required (integer)
Tositteen tila muutoksen jälkeen. Vastaa TositeResult.tila-kentän arvoja.
-
nimi:
required (string)
Muutoksen tehneen käyttäjän nimi
-
userid:
required (integer)
Muutoksen tehneen käyttäjän tunniste
-
data:
required (object)
-
kommentit:
(array of KommenttiResult)
Tositteeseen lisätyt kommentit. Sisältää kommentin tekstin, kirjoittajan ja aikaleiman.
Items: KommenttiResult
-
teksti:
required (string)
Kommentin teksti
-
aika:
required (datetime)
Kommentin aika
-
userid:
required (integer)
Käyttäjän id
-
nimi:
required (string)
Kommentoijan nimi
-
teksti:
required (string)
-
portaali:
(object)
Portaaliin syötetyn laskun tallentajatiedot. Sisältää portaalin käyttäjän tiedot.
-
nimi:
required (string)
Portaalin käyttäjän nimi
-
email:
required (string)
Portaalin käyttäjän sähköpostiosoite
-
osoite:
(string)
Portaalin käyttäjän osoite
-
puhelin:
(string)
Portaalin käyttäjän puhelinnumero
-
iban:
(string)
Portaalin käyttäjän pankkitilin IBAN
-
nimi:
required (string)
HTTP status code 403
Käyttäjällä ei ole oikeutta hakea tätä tositetta. Tarkista käyttäjän oikeudet tositteen tyypin mukaan.
HTTP status code 404
Tositetta ei löytynyt annetulla tunnisteella
Secured by token
Headers
-
Authorization:
required (string)
Kitsas Login Serverin tuottaman token, joka antaa oikeuden tähän pilveen
HTTP status code 403
Virheellinen token tai puuttuva oikeus
/tuotteet
Tuoterekisteri
Tuoteluettelo
get /tuotteet
Tuoteluettelo
Kitsaan autentikaatiotoken
Query Parameters
-
koodi:
(string)
Tuotteet koodilla
HTTP status code 200
Body
Media type: application/json
Type: array of object
Items: Tuote
-
id:
(integer)
Tuotteen id
-
nimike:
required (string)
Tuotteen nimi
-
nimi:
required (any)
Tuotteen nimike monikielisenä
-
yksikko:
(any)
Tuotteen yksikkö, esim. kpl
-
unkoodi:
(string)
Yksikön UN-koodi
-
ahinta:
(number)
Tuotteen veroton yksikköhinta
-
alvkoodi:
(integer)
Alv-koodi
-
alvprosentti:
(number)
Tuotteesta maksettava alv-prosentti
-
tili:
required (integer)
Tuotteen oletustiliöinti
-
kohdennus:
(integer)
Tuotteen oletuskohdennus
-
koodi:
(string)
Tuotekoodi järjestelmäintegraatioita varten
Secured by token
Headers
-
Authorization:
required (string)
Kitsas Login Serverin tuottaman token, joka antaa oikeuden tähän pilveen
HTTP status code 403
Virheellinen token tai puuttuva oikeus
Myyntiraportti
get /tuotteet/myynti
Kitsaan autentikaatiotoken
Query Parameters
-
alkupvm:
(string - pattern: \d{4}-\d{2}-\d{2})
Raportti alkaen
-
loppupvm:
(string - pattern: \d{4}-\d{2}-\d{2})
Raportti päättyen
HTTP status code 200
Body
Media type: application/json
Type: array of object
Items: MyyntiInfo
-
tuote:
required (integer)
Tuotteen id
-
nimike:
required (string)
Tuotteen nimike
-
koodi:
required (string)
Tuotekoodi
-
kpl:
required (number)
Kappaletta yhteensä
-
myynti:
required (number)
Tuotteen nettomyynti yhteensä
-
brutto:
required (number)
Tuotteen bruttomyynti yhteensä
Secured by token
Headers
-
Authorization:
required (string)
Kitsas Login Serverin tuottaman token, joka antaa oikeuden tähän pilveen
HTTP status code 403
Virheellinen token tai puuttuva oikeus
/vakioviitteet
Vakioviitteiden tiedot
Vakioviitteiden lista
get /vakioviitteet
Vakioviitteiden lista
Kitsaan autentikaatiotoken
HTTP status code 200
Body
Media type: application/json
Type: array of object
Items: Vakioviite
- viite: required (integer)
- tili: required (integer)
- kohdennus: required (integer)
- otsikko: required (string)
Secured by token
Headers
-
Authorization:
required (string)
Kitsas Login Serverin tuottaman token, joka antaa oikeuden tähän pilveen
HTTP status code 403
Virheellinen token tai puuttuva oikeus
get /vakioviitteet/{viite}
Kitsaan autentikaatiotoken
URI Parameters
- viite: required (integer)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- viite: required (integer)
- tili: required (integer)
- kohdennus: required (integer)
- otsikko: required (string)
Secured by token
Headers
-
Authorization:
required (string)
Kitsas Login Serverin tuottaman token, joka antaa oikeuden tähän pilveen
HTTP status code 403
Virheellinen token tai puuttuva oikeus