Her finner du informasjon om hvordan API kan benyttes for å hente ut timer fra Capitech for gjenbruk i andre systemer.
I korte trekk
- Logge på med en gyldig bruker med tilgang til API og hent ut et accessToken
Dette gjøres via endepunkt /api/public/v1/Access/login - Kjør en request mot API for timer med ønskede parameter for f. eks datointervall, klient (selskap) og evt. andre kriterier.
Dette gjøres via endepunkt api/public/v1/Time/getTimeTransactions
TimeAPI - getTimeTransaction
Beskrivelse av Request parametere
En kan få detaljert informasjon og eksempler via mouseover på hhv. request parameter og return felter i API oversikt.
| Parameter | Påkrevd | Beskrivelse | Merknad |
|---|---|---|---|
| accessToken | Ja | Token fra Login. | Kreves for å få svar på API request |
| clientId | Ja | Klientnummer for hvilket firma en skal hente timer på | |
| fromDate | Ja | Fradato for ønsket periode i format 'yyyy-mm-dd' | Fra og med |
| toDate | Ja | Tildato for ønsket periode i format 'yyyy-mm-dd' | Til og med |
| approvedLevelFilter | Nei | Filter for å avgrense til kun godkjente timer Vanligvis benyttes nivå 1 Om flere nivå benyttes kan en spørre på f. eks nivå 2 osv.. | Om ikke angitt får en alle timer uavhengig av godkjenning. |
| employeeIdFilter | Nei | Filter for å angi evt. en eller flere ansattnr en ønsker å avgrense på. | |
| departmentIdFilter | Nei | Filter for å angi evt. en eller flere avdelingsnr en ønsker å avgrense på. | |
| taskIdFilter | Nei | Filter for å angi evt. en eller flere arbeidsoppgavenr en ønsker å avgrense på. | Bør kun benyttes sammen med avgrensning på en avdeling da arbeidsoppgavenr er en subdimensjon til avdeling. (Og samme nr på arbeidsoppgave kan i praksis være ulike oppgaver på ulike avdelinger) |
| orderIdFilter | Nei | Filter for å angi evt. en eller flere ordrenr en ønsker å avgrense på. | |
| dutyIdFilter | Nei | Filter for å angi evt. en eller flere Flow vakt id'er en ønsker å avgrense på. | NB Id på vakt er et autogenerert løpenr som ikke vises i vaktregister brukergrensesnitt. Dette filteret er kun for spesiell bruk. |
| projectIdFilter | Nei | Filter for å angi evt. en eller flere prosjektnr en ønsker å avgrense på. | |
| subProjectIdFilter | Nei | Filter for å angi evt. en eller flere underprosjektnr en ønsker å avgrense på. | Bør kun benyttes sammen med avgrensning på ett prosjekt da underprosjektnr er en subdimensjon til prosjekt. (Og samme nr på underprosjekt kan i praksis være ulike underprosjekt på ulike prosjekt) |
| projectPhaseIdFilter | Nei | Filter for å angi evt. en eller flere fasenr en ønsker å avgrense på. | Bør kun benyttes sammen med avgrensning på ett prosjekt og ett underprosjekt da fasenr er en subdimensjon til underprosjekt. (Og samme fasenr kan i praksis være ulike faser på ulike prosjekt / underprosjekt) |
| freeDimension1Filter | Nei | Filter for å angi evt. en eller flere fri dimensjon1 nr en ønsker å avgrense på. | Fri dimensjon 1 er en konfigurerbar dimensjon som kan aktiveres og gis navn iht. kundens behov. |
| freeDimension2Filter | Nei | Filter for å angi evt. en eller flere fri dimensjon2 nr en ønsker å avgrense på. | Fri dimensjon 2 er en konfigurerbar dimensjon som kan aktiveres og gis navn iht. kundens behov. |
| timeCategoryIdFilter | Nei | Filter for å angi en eller flere tidskategori nr en ønsker å avgrense på | Tidskategorier kan f. eks være Timelønn, Overtid 50%, Overtid 100%, Nattillegg osv. |
| timeCategoryTypeIdFilter | Nei | FIlter for å angi en eller flere typer timer en ønsker å avgrense på. | Typedefinisjoner er: 'O' Ordinære timer (f.eks Timelønn, Fastlønn) |
| includePayableCategory | Nei | Filter for å kunne avgrense på kun tidskategorier som er lønnet, ikke lønnet eller alle. | |
| externalStatusCodeFilter | Nei | Filter for å kunne avgrense til kun transaksjoner som har en gitt ekstern statuskode. | Benyttes f. eks for å kun hente timer som ikke er flagget med en ekstern statuskode som betyr at timene allerede er overført. Det finnes et eget API endepunkt for å sette denne statuskoden: api/public/v1/Time/setExternalStatusCode |
| includeElementsWithExternalStatusCodeNull | Nei | Filter for å kunne angi om en vil inkludere timer hvor ekstern statuskode er null eller ikke. | |
| lastUpdatedGreaterThanOrEqualToFilter | Nei | Filter for å kunne hente ut timer som er opprettet eller oppdatert på eller etter angitt dato og klokkeslett. Format: 'yyyy-mm-dd' | NB! Støtter pr nå kun dato uten klokkeslett som parameter. Det vil komme støtte for parameter med dato og klokkeslett |
| projectAlphanumericCodeFilter | Nei | Filter for å angi evt. en eller flere prosjekt alfanumerisk kode en ønsker å avgrense på. | Kan benyttes dersom det er aktivert støtte for alfanumerisk kode på prosjekter. F. eks kan prosjektnr være 10588 (løpenr) og alfanumerisk kode 'B400' |
| subProjectAlphanumericCodeFilter | Nei | Filter for å angi evt. en eller flere underprosjekt alfanumerisk kode en ønsker å avgrense på. | Bør kun benyttes sammen med avgrensning på ett prosjekt da underprosjekt alfakode er en subdimensjon til prosjekt. (Og samme kode på underprosjekt kan i praksis være ulike underprosjekt på ulike prosjekt) |
| phaseAlphanumericCodeFilter | Nei | Filter for å angi evt. en eller flere fase alfanumerisk kode en ønsker å avgrense på. | Bør kun benyttes sammen med avgrensning på ett prosjekt og ett underprosjekt da fase alfakode er en subdimensjon til underprosjekt. (Og samme fase kan i praksis være ulike faser på ulike prosjekt / underprosjekt) |
| Tip | ||
|---|---|---|
| ||
Du kan se mer detaljer om request parametere og returdata her Demosalg.capitech.no/API |