to access the Api directly through the URL:

replace 'USER NAME' with Troi User Name and 'USER PASSWORD' with Troi Password and run the following script

Code Block

language	php

<?php
$user = 'USER NAME';
$password = 'USER PASSWORD';
$hashString = base64_encode($user.':'.md5($password));
print_r($hashString);
?>

then add your $hashString to the URL.

Example:

https://example.troi.de/TroiSubDomain/api/v2/rest/contacts/?auth=Basic+EMPTY SPACE+YOUR GENERATED HASH

Like:

https://example.troi.de/TroiSubDomain/api/v2/rest/contacts/?auth=Basic abcdefghijk1234abcdefg

URI

Description

Method Name

Method Return Value

Parameter Name

Required/Optional

Parameter Value

Parameter Remark

Example

Test Units

Absences

/api/v2/rest/absences/

 Status
colourBlue
titleGET

ApiAbsence[]

start

 Status
subtletrue
colourRed
titleREQUIRED

string (yyyymmdd)

Fetch all absences for the given Start Date and End Date

/api/v2/rest/absences?start=20150401&end=20160601

Status

colour	Green
title	yes

/api/v2/rest/absences/

Status

colour	Blue
title	GET

end

 Status
subtletrue
colourRed
titleREQUIRED

string (yyyymmdd)

Fetch all absences for the given Start Date and End Date

/api/v2/rest/absences?start=20150401&end=20160601

Status

colour	Green
title	yes

/api/v2/rest/absences/

Status

colour	Blue
title	GET

employeeId

 Status
subtletrue
colourGreen
titleOptional

int

Fetch all Absences for the given employeeId

/api/v2/rest/absences?start=20150401&end=20160601&employeeId=33

Status

colour	Green
title	yes

/api/v2/rest/absences/[id]

 Status
colourBlue
titleGET

ApiAbsence

Fetch Absence for the given Absence ID

/api/v2/rest/absences/1

Status

colour	Green
title	yes

Account Groups

/api/v2/rest/accountGroups/

 Status
colourBlue
titleGET

ApiAccountGroup[]

clientId

 Status
subtletrue
colourRed
titleREQUIRED

int

Fetch all Account Groups for the given clientId

/api/v2/rest/accountGroups?clientId=1

Status

colour	Green
title	yes

/api/v2/rest/accountGroups/[id]

 Status
colourBlue
titleGET

ApiAccountGroup

Fetch Account Group for the given Account Group ID

/api/v2/rest/accountGroups/1

Status

colour	Green
title	yes

/api/v2/rest/accountGroups/

Status

colour	Green
title	POST

ApiSyncItem

Save Absence Groups Object

/api/v2/rest/accountGroups/[accountGroups Object]

Status

colour	Green
title	yes

/api/v2/rest/accountGroups/

Status

colour	Yellow
title	PUT

ApiSyncItem

Update Absence Groups Object

/api/v2/rest/accountGroups/[accountGroups Object]

Status

colour	Green
title	yes

/api/v2/rest/accountGroups/

Status

colour	Red
title	DELETE

Account Group ID

Delete Absence Groups

/api/v2/rest/accountGroups/[accountGroups ID]

Status

colour	Green
title	yes

Accounting Entries

/api/v2/rest/accountingEntries/

 Status
colourBlue
titleGET

ApiAccountingEntry[]

clientId

 Status
subtletrue
colourRed
titleREQUIRED

int

Fetch all Accounting Entries for the given clientId

/api/v2/rest/accountingEntries?clientId=1

Status

colour	Green
title	yes

/api/v2/rest/accountingEntries/

Status

colour	Blue
title	GET

cpId

Status

subtle	true
colour	Green
title	Optional

int

Fetch all Accounting Entries for the given CalculationPosition ID

/api/v2/rest/accountingEntries?clientId=1&cpId=1

Status

colour	Green
title	yes

/api/v2/rest/accountingEntries/

Status

colour	Blue
title	GET

projectId

Status

subtle	true
colour	Green
title	Optional

int

Fetch all Accounting Entries for the given Project ID

/api/v2/rest/accountingEntries?clientId=1&projectId=1

Status

colour	Green
title	yes

/api/v2/rest/accountingEntries/

Status

colour	Blue
title	GET

accountingEntryCollectionId

Status

subtle	true
colour	Green
title	Optional

int

Fetch all Accounting Entries for the given AccountingEntryCollection ID

/api/v2/rest/accountingEntries?clientId=1&accountingEntryCollectionId=1

Status

colour	Green
title	yes

/api/v2/rest/accountingEntries/[id]

Status

colour	Blue
title	GET

ApiAccountingEntry

Fetch Accounting Entry for the given Accounting Entry ID

/api/v2/rest/accountingEntries/1

Status

colour	Green
title	yes

/api/v2/rest/accountingEntries/

Status

colour	Green
title	POST

ApiSyncItem

Save Accounting Entry Object

/api/v2/rest/accountingEntries/[accountingEntries Object]

Status

colour	Green
title	yes

/api/v2/rest/accountingEntries/

Status

colour	Yellow
title	PUT

ApiSyncItem

Update Accounting Entry Object

/api/v2/rest/accountingEntries/[accountingEntries Object]

Status

colour	Green
title	yes

/api/v2/rest/accountingEntries/

Status

colour	Red
title	DELETE

Accounting Entry ID

Delete Accounting Entry

/api/v2/rest/accountingEntries/[accountingEntries ID]

Status

colour	Green
title	yes

Accounting Entry Collections

/api/v2/rest/accountingEntryCollections/

 Status
colourBlue
titleGET

ApiAccountingEntryCollection[]

clientId

 Status
subtletrue
colourRed
titleREQUIRED

int

Fetch All Accounting Entry Collections for the given clientId

/api/v2/rest/accountingEntryCollections?clientId=1

Status

colour	Green
title	yes

/api/v2/rest/accountingEntryCollections/

Status

colour	Blue
title	GET

type

Status

subtle	true
colour	Green
title	Optional

int

Fetch All Accounting Entry Collections for the given type

0 = export collections, 1 = import collections

/api/v2/rest/accountingEntryCollections?clientId=1&type=1

Status

colour	Green
title	yes

/api/v2/rest/accountingEntryCollections/

Status

colour	Blue
title	GET

year

Status

subtle	true
colour	Green
title	Optional

string

Fetch All Accounting Entry Collections for the given year

/api/v2/rest/accountingEntryCollections?clientId=1&year=2016

Status

colour	Green
title	yes

/api/v2/rest/accountingEntryCollections/[id]

Status

colour	Blue
title	GET

ApiAccountingEntryCollection

/api/v2/rest/accountingEntryCollections/1

Status

colour	Green
title	yes

/api/v2/rest/accountingEntryCollections/

Status

colour	Green
title	POST

ApiSyncItem

Save Accounting Entry Collections

/api/v2/rest/accountingEntryCollections/[accountingEntryCollections Object]

Status

colour	Green
title	yes

/api/v2/rest/accountingEntryCollections/

Status

colour	Yellow
title	PUT

ApiSyncItem

Update Accounting Entry Collections

/api/v2/rest/accountingEntryCollections/[accountingEntryCollections Object]

Status

colour	Green
title	yes

/api/v2/rest/accountingEntryCollections/

Status

colour	Red
title	DELETE

Accounting Entry Collection ID

Delete Accounting Entry Collections

/api/v2/rest/accountingEntryCollections/[accountingEntryCollections ID]

Status

colour	Green
title	yes

Accounts

/api/v2/rest/accounts/

 Status
colourBlue
titleGET

ApiAccount[]

clientId

 Status
subtletrue
colourRed
titleREQUIRED

int

/api/v2/rest/accounts?clientId=1

Status

colour	Green
title	yes

/api/v2/rest/accounts/

Status

colour	Blue
title	GET

accountGroupId

 Status
subtletrue
colourGreen
titleOptional

int

/api/v2/rest/accounts?clientId=1&accountGroupId=1

Status

colour	Green
title	yes

/api/v2/rest/accounts/

Status

colour	Blue
title	GET

account_is_cash_or_bank

Status

subtle	true
colour	Green
title	Optional

boolean (true/false)

/api/v2/rest/accounts?clientId=1&account_is_cash_or_bank=true

Status

colour	Green
title	yes

/api/v2/rest/accounts/[id]

Status

colour	Blue
title	GET

ApiAccount

/api/v2/rest/accounts/[Id]

Status

colour	Green
title	yes

/api/v2/rest/accounts/

Status

colour	Green
title	POST

ApiSyncItem

/api/v2/rest/accounts/[accounts Object]

Status

colour	Green
title	yes

/api/v2/rest/accounts/

Status

colour	Yellow
title	PUT

ApiSyncItem

/api/v2/rest/accounts/[accounts Object]

Status

colour	Green
title	yes

/api/v2/rest/accounts/

Status

colour	Red
title	DELETE

Account ID

/api/v2/rest/accounts/[accounts ID]

Status

colour	Green
title	yes

Billings - Hours

/api/v2/rest/billings/hours/

 Status
colourBlue
titleGET

ApiHourBilling[]

employeeId

 Status
subtletrue
colourRed
titleREQUIRED

int

employeeId or calculationPositionId or projectId or subprojectId or startDate+endDate is mandatory

Fetch all Billings for the given parameter

/api/v2/rest/billings/hours?employeeId=1

Status

colour	Green
title	yes

/api/v2/rest/billings/hours/

Status

colour	Blue
title	GET

calculationPositionId

 Status
subtletrue
colourGreen
titleOptional 1

int

Fetch all Billings for the given Calculation Position ID

/api/v2/rest/billings/hours?calculationPositionId=1

Status

colour	Green
title	yes

/api/v2/rest/billings/hours/

Status

colour	Blue
title	GET

projectId

 Status
subtletrue
colourGreen
titleOptional 1

int

Fetch all Billings for the given Project ID

/api/v2/rest/billings/hours?projectId=1

Status

colour	Green
title	yes

/api/v2/rest/billings/hours/

Status

colour	Blue
title	GET

subprojectId

 Status
subtletrue
colourGreen
titleOptional 1

int

Fetch all Billings for the given Subproject ID

/api/v2/rest/billings/hours?subprojectId=1

Status

colour	Green
title	yes

/api/v2/rest/billings/hours/

Status

colour	Blue
title	GET

startDate

 Status
subtletrue
colourGreen
titleOptional 1

string (yyyymmdd)

Fetch all Billings for the given Start Date

/api/v2/rest/billings/hours?startDate=20160101&endDate=20160120

Status

colour	Green
title	yes

/api/v2/rest/billings/hours/

Status

colour	Blue
title	GET

endDate

 Status
subtletrue
colourGreen
titleOptional 1

string (yyyymmdd)

Fetch all Billings for the given End Date

/api/v2/rest/billings/hours?startDate=20160101&endDate=20160120

Status

colour	Green
title	yes

/api/v2/rest/billings/hours/

Status

colour	Blue
title	GET

ApiHourBillingExt[]

extendedObject

 Status
subtletrue
colourGreen
titleOptional

boolean (true/false)

extended object contains the full calculation position display path

/api/v2/rest/billings/hours?employeeId=1&extendedObject=true

Status

colour	Green
title	yes

/api/v2/rest/billings/hours/

Status

colour	Blue
title	GET

fillsyncitems

Status

subtle	true
colour	Green
title	Optional

boolean (true/false)

Fetch all Billings and fill the empty objects if there is any

/api/v2/rest/billings/hours?employeeId=1&fillsyncitems=true

Status

colour	Green
title	yes

/api/v2/rest/billings/hours/

Status

colour	Green
title	POST

ApiSyncItem

Save Billing

Status

colour	Green
title	yes

/api/v2/rest/billings/hours/[id]

 Status
colourBlue
titleGET

ApiHourBilling

Fetch Billing for the given Billing ID

/api/v2/rest/billings/hours/1

Status

colour	Green
title	yes

/api/v2/rest/billings/hours/[id]

ApiHourBillingExt

extendedObject

 Status
subtletrue
colourGreen
titleOptional

boolean (true/false)

extended object contains the full calculation position display path

/api/v2/rest/billings/hours/1?extendedObject=true

/api/v2/rest/billings/hours/

 Status
colourYellow
titlePUT

ApiSyncItem

Update Billing

/api/v2/rest/billings/hours/[Billing Object]

Status

colour	Green
title	yes

/api/v2/rest/billings/hours/

 Status
colourRed
titleDELETE

Billing Hour ID

Delete Billing

/api/v2/rest/billings/hours/[Billing ID]

Status

colour	Green
title	yes

Booking Year

/api/v2/rest/bookingYears/

Status

colour	Blue
title	GET

ApiBookingYear

clientId

 Status
subtletrue
colourRed
titleREQUIRED

Fetch all Booking Years for the given client ID

/api/v2/rest/bookingYears?clientId=1

Status

colour	Green
title	yes

/api/v2/rest/bookingYears/[id]

Status

colour	Blue
title	GET

ApiBookingYear

Fetch Booking Year for the given ID

/api/v2/rest/bookingYears/1

Status

colour	Green
title	yes

/api/v2/rest/bookingYears/

Status

colour	Green
title	POST

ApiSyncItem

Save Booking Year

/api/v2/rest/bookingYears/[Booking Year Object]

Status

colour	Green
title	yes

/api/v2/rest/bookingYears/

Status

colour	Yellow
title	PUT

ApiSyncItem

Update Booking Year

/api/v2/rest/bookingYears/[Booking Year Object]

Status

colour	Green
title	yes

/api/v2/rest/bookingYears/

Status

colour	Red
title	DELETE

Booking Year ID

Delete Booking Year

/api/v2/rest/bookingYears/[Booking Year ID]

Status

colour	Green
title	yes

Calculation Positions

/api/v2/rest/calculationPositions/

 Status
colourBlue
titleGET

ApiCalculationPosition[]

clientId

 Status
subtletrue
colourRed
titleREQUIRED

int

Fetch All all Calculation Positions for the given Client ID

/api/v2/rest/calculationPositions?clientId=1

Status

colour	Green
title	yes

/api/v2/rest/calculationPositions/

Status

colour	Blue
title	GET

projectId

 Status
subtletrue
colourGreen
titleOptional

int

Fetch All all Calculation Positions for the given Project ID

/api/v2/rest/calculationPositions?clientId=1&projectId=1

Status

colour	Green
title	yes

/api/v2/rest/calculationPositions/

Status

colour	Blue
title	GET

subprojectId

 Status
subtletrue
colourGreen
titleOptional

int

Fetch All all Calculation Positions for the given Subproject ID

/api/v2/rest/calculationPositions?clientId=1&subprojectId=1

Status

colour	Green
title	yes

/api/v2/rest/calculationPositions/

Status

colour	Blue
title	GET

search

 Status
subtletrue
colourGreen
titleOptional

string

Fetch All all Calculation Positions for the given Search Term

/api/v2/rest/calculationPositions?clientId=1&search=Calculation Position Name

Status

colour	Green
title	yes

/api/v2/rest/calculationPositions/

Status

colour	Blue
title	GET

timeRecording

 Status
subtletrue
colourGreen
titleOptional

boolean (true/false)

returns on valid time recording positions for the user

/api/v2/rest/calculationPositions?clientId=1&timeRecording=true

Status

colour	Green
title	yes

/api/v2/rest/calculationPositions/

Status

colour	Blue
title	GET

favoritesOnly

 Status
subtletrue
colourGreen
titleOptional

boolean (true/false)

returns on favorite time recording positions for the user

/api/v2/rest/calculationPositions?clientId=1&favoritesOnly=true

Status

colour	Green
title	yes

/api/v2/rest/calculationPositions/

Status

colour	Blue
title	GET

withoutHourClosed

 Status
subtletrue
colourGreen
titleOptional

boolean (true/false)

returns only cp that are not closed for time recording

/api/v2/rest/calculationPositions?clientId=1&withoutHourClosed=true

Status

colour	Green
title	yes

/api/v2/rest/calculationPositions/

Status

colour	Blue
title	GET

ree_date

Status

subtle	true
colour	Green
title	Optional

String (yyyymmdd OR dd.mm.yyyy OR current_date)

return Rest Expenses Estimation for the given Calculation Position

/api/v2/rest/calculationPositions?clientId=1&ree_date=20160101

Status

colour	Green
title	yes

/api/v2/rest/calculationPositions/

Status

colour	Blue
title	GET

projectStatusId

Status

subtle	true
colour	Green
title	Optional

int

Fetch all Calculation Positions for the given Project Status ID

/api/v2/rest/calculationPositions?clientId=1&projectStatusId=11

Status

colour	Green
title	yes

/api/v2/rest/calculationPositions/

Status

colour	Blue
title	GET

bookKeeping

Status

subtle	true
colour	Green
title	Optional

boolean (true/false)

Fetch all Calculation Positions for the given Book keeping

/api/v2/rest/calculationPositions?clientId=1&bookKeeping=true

Status

colour	Green
title	yes

/api/v2/rest/calculationPositions/

Status

colour	Blue
title	GET

projectIds

Status

subtle	true
colour	Green
title	Optional

string

Fetch all Calculation Positions for the given Project IDs

/api/v2/rest/calculationPositions?clientId=1&projectIds=1,2,3

Status

colour	Green
title	yes

/api/v2/rest/calculationPositions/

Status

colour	Blue
title	GET

issueTrackerProjectKey

Status

subtle	true
colour	Green
title	Optional

string

Fetch all Calculation Positions for the given issue Tracker Project Key

/api/v2/rest/calculationPositions?clientId=1&issueTrackerProjectKey=test

Status

colour	Green
title	yes

/api/v2/rest/calculationPositions/

 Status
colourGreen
titlePOST

ApiSyncItem

synctoken

 Status
subtletrue
colourRed
titleREQUIRED

string (ApiCalculationPosition)

Save Calculation Position

/api/v2/rest/calculationPositions/[Calculation Positions Object]

Status

colour	Green
title	yes

/api/v2/rest/calculationPositions/[id]

 Status
colourBlue
titleGET

ApiCalculationPosition

Fetch Calculation Position for the given Calculation Position ID

/api/v2/rest/calculationPositions/[Calculation Positions ID]

Status

colour	Green
title	yes

/api/v2/rest/calculationPositions/

 Status
colourYellow
titlePUT

ApiSyncItem

(ApiCalculationPosition)

Update Calculation Position

/api/v2/rest/calculationPositions/[Calculation Positions Object]

Status

colour	Green
title	yes

/api/v2/rest/calculationPositions/

 Status
colourRed
titleDELETE

Calculation Position ID

synctoken

Status

subtle	true
colour	Red
title	REQUIRED

(ApiCalculationPosition)

Delete Calculation Position

/api/v2/rest/calculationPositions/[Calculation Positions ID]

Status

colour	Green
title	yes

Calendar Events

/api/v2/rest/calendarEvents/

 Status
colourBlue
titleGET

ApiCalendarEvent[]

start

 Status
subtletrue
colourRed
titleREQUIRED

string(8)

YYYYMMDD

/api/v2/rest/calendarEvents?start=20121119&end=20121125

Status

colour	Green
title	yes

/api/v2/rest/calendarEvents/

Status

colour	Blue
title	GET

end

 Status
subtletrue
colourRed
titleREQUIRED

string(8)

YYYYMMDD

/api/v2/rest/calendarEvents?start=20121119&end=20121125

/api/v2/rest/calendarEvents/

Status

colour	Blue
title	GET

search_key

 Status
subtletrue
colourGreen
titleOptional

string

/api/v2/rest/calendarEvents?start=20121119&end=20121125&search_key=Calender Event Description

Status

colour	Green
title	yes

/api/v2/rest/calendarEvents/

Status

colour	Blue
title	GET

owner_employee_id

 Status
subtletrue
colourGreen
titleOptional

int

/api/v2/rest/calendarEvents?start=20121119&end=20121125&owner_employee_id=33

Status

colour	Green
title	yes

/api/v2/rest/calendarEvents/

Status

colour	Blue
title	GET

type

 Status
subtletrue
colourGreen
titleOptional

["R","H","G","P","T"]

R=regular, H=holiday, G=general, P=private, T=assigment

/api/v2/rest/calendarEvents?start=20121119&end=20121125&type=["R","H","G","P","T"]

Status

colour	Green
title	yes

/api/v2/rest/calendarEvents/

Status

colour	Blue
title	GET

withoutAbsences

Status

subtle	true
colour	Green
title	Optional

boolean (true/false)

/api/v2/rest/calendarEvents?start=20121119&end=20121125&withoutAbsences=true

Status

colour	Green
title	yes

/api/v2/rest/calendarEvents/

 Status
colourGreen
titlePOST

ApiSyncItem

Save Calendar Event

/api/v2/rest/calendarEvents/[Calendar Event Object]

Status

colour	Green
title	yes

/api/v2/rest/calendarEvents/[id]

 Status
colourBlue
titleGET

ApiCalendarEvent

Fetch Calendar Event for the given ID

/api/v2/rest/calendarEvents/1

Status

colour	Green
title	yes

/api/v2/rest/calendarEvents/

 Status
colourYellow
titlePUT

ApiSyncItem

Update Calendar Events

/api/v2/rest/calendarEvents/[Calendar Event Object]

Status

colour	Green
title	yes

/api/v2/rest/calendarEvents/

 Status
colourRed
titleDELETE

Calendar Event ID

Delete Calendar Events

/api/v2/rest/calendarEvents/1

Status

colour	Green
title	yes

Calendar Event Participants

/api/v2/rest/calendarEventParticipants/

 Status
colourBlue
titleGET

ApiCalendarEventParticipant[]

calendarEventId

 Status
subtletrue
colourGreen
titleOptional

int

Fetch all Calendar Event Participants for the given Calendar Event ID

/api/v2/rest/calendarEventParticipants?calendarEventId=1

Status

colour	Green
title	yes

/api/v2/rest/calendarEventParticipants/

Status

colour	Blue
title	GET

employeeId

 Status
subtletrue
colourGreen
titleOptional

int

Fetch all Calendar Event Participants for the givenEmployee ID

/api/v2/rest/calendarEventParticipants?employeeId=1

Status

colour	Green
title	yes

/api/v2/rest/calendarEventParticipants/

 Status
colourGreen
titlePOST

ApiSyncItem

Save Calendar Event Participants

/api/v2/rest/calendarEventParticipants/[Calendar Event Participant Object]

Status

colour	Green
title	yes

/api/v2/rest/calendarEventParticipants/[id]

 Status
colourBlue
titleGET

ApiCalendarEventParticipant

Fetch Calendar Event Participant for the given Calendar Event Participant ID

/api/v2/rest/calendarEventParticipants/1

Status

colour	Green
title	yes

/api/v2/rest/calendarEventParticipants/

 Status
colourYellow
titlePUT

ApiSyncItem

Update Calendar Event Participant

/api/v2/rest/calendarEventParticipants/[Calendar Event Participant Object]

Status

colour	Green
title	yes

/api/v2/rest/calendarEventParticipants/

 Status
colourRed
titleDELETE

Calendar Event Participant ID

Delete Calendar Event Participant

/api/v2/rest/calendarEventParticipants/1

Status

colour	Green
title	yes

Tenants (formerly Clients)

/api/v2/rest/clients/

 Status
colourBlue
titleGET

ApiClient[]

Fetch all Clients

/api/v2/rest/clients/

Status

colour	Green
title	yes

/api/v2/rest/clients/[id]

 Status
colourBlue
titleGET

ApiClient

Fetch Client for the Given Client ID

/api/v2/rest/clients/[Client ID]

Status

colour	Green
title	yes

Contacts

/api/v2/rest/contacts/

 Status
colourBlue
titleGET

ApiContact[], ApiSyncItem[]

syncItem

 Status
subtletrue
colourGreen
titleOptional

boolean (true/false)

Fetch Contacts and return them as Sync Item

/api/v2/rest/contacts?syncItem=true

Status

colour	Green
title	yes

/api/v2/rest/contacts/

Status

colour	Blue
title	GET

from

 Status
subtletrue
colourGreen
titleOptional

int

Fetch Contacts from the given ID, use togehter with "size"

/api/v2/rest/contacts?from=100&size=50

Status

colour	Green
title	yes

/api/v2/rest/contacts/

Status

colour	Blue
title	GET

size

 Status
subtletrue
colourGreen
titleOptional

int

Fetch Contacts for the given size use together with "from"

/api/v2/rest/contacts?from=100&size=50

Status

colour	Green
title	yes

/api/v2/rest/contacts/

Status

colour	Blue
title	GET

since

 Status
subtletrue
colourGreen
titleOptional

valid ETag (yymmddhhmmss)

Fetch Contacts for the given date time (only items modified since ETag will be returned)

/api/v2/rest/contacts?since=20110722153556

Status

colour	Green
title	yes

/api/v2/rest/contacts/

Status

colour	Blue
title	GET

favoritesOnly

 Status
subtletrue
colourGreen
titleOptional

boolean (true/false)

Fetch favorites Contacts only

/api/v2/rest/contacts?favoritesOnly=true

Status

colour	Green
title	yes

/api/v2/rest/contacts/

Status

colour	Blue
title	GET

contactType

 Status
subtletrue
colourGreen
titleOptional

ApiContact:Person, ApiContact:Department, ApiContact:Company

Fetch Contacts for the given Contact Type

/api/v2/rest/contacts?contactType=ApiContact:Person

Status

colour	Green
title	yes

/api/v2/rest/contacts/

Status

colour	Blue
title	GET

search

 Status
subtletrue
colourGreen
titleOptional

string

Fetch Contacts for the given Search Term

/api/v2/rest/contacts?search=test

Status

colour	Green
title	yes

/api/v2/rest/contacts/

Status

colour	Blue
title	GET

searchField

 Status
subtletrue
colourGreen
titleOptional

JSON

Fetch Contacts for the given Search Field

single value:
searchField={"categoryId":392}

multiple values:
searchField={"categoryId":[392,396]}

/api/v2/rest/contacts?searchField={"categoryId":392}

Status

colour	Green
title	yes

/api/v2/rest/contacts/

Status

colour	Blue
title	GET

withCustomFields

 Status
subtletrue
colourGreen
titleOptional

int

Fetch Contacts for the given with Custom Field

/api/v2/rest/contacts?withCustomFields=1

Status

colour	Green
title	yes

/api/v2/rest/contacts/

Status

colour	Blue
title	GET

parentId

Status

subtle	true
colour	Green
title	Optional

int

Fetch Contacts for the given parent ID

/api/v2/rest/contacts?parentId=1234

Status

colour	Green
title	yes

/api/v2/rest/contacts/

 Status
colourBlue
titleGET

isAssociatedWithCustomer

Status

subtle	true
colour	Green
title	Optional

boolean (true/false)

show all contacts that associated with some customer

/api/v2/rest/contacts?isAssociatedWithCustomer=true

Status

colour	Green
title	yes

/api/v2/rest/contacts/

Status

colour	Blue
title	GET

onlyInactive

Status

subtle	true
colour	Green
title	Optional

boolean (true/false)

show all inactive contacts

/api/v2/rest/contacts?onlyInactive=true

/api/v2/rest/contacts/

 Status
colourGreen
titlePOST

ApiSyncItem

Save Contact

Status

colour	Green
title	yes

/api/v2/rest/contacts/[id]

Status

colour	Blue
title	GET

ApiSyncItem

withCustomFields

 Status
subtletrue
colourGreen
titleOptional

Fetch Contact for the given with custom Field

/api/v2/rest/contacts/1?withCustomFields=1

Status

colour	Green
title	yes

/api/v2/rest/contacts/

 Status
colourYellow
titlePUT

ApiSyncItem

Update Contact

/api/v2/rest/contacts/[Contact Object]

Status

colour	Green
title	yes

/api/v2/rest/contacts/

 Status
colourRed
titleDELETE

Contact ID

Delete Contact

/api/v2/rest/contacts/1

Status

colour	Green
title	yes

Contacts Logical Database

/api/v2/rest/contactCategories/

 Status
colourBlue
titleGET

ApiContactCategory[]

contactId

 Status
subtletrue
colourGreen
titleOptional

int

Fetch all Contact Categories for the given Contact ID

/api/v2/rest/contactCategories?contactId=123

Status

colour	Green
title	yes

/api/v2/rest/contactCategories/

Status

colour	Blue
title	GET

categoryId

 Status
subtletrue
colourGreen
titleOptional

int

Fetch all Contact Categories for the given Category ID

/api/v2/rest/contactCategories?categoryId=123

Status

colour	Green
title	yes

/api/v2/rest/contactCategories/

Status

colour	Blue
title	GET

size

 Status
subtletrue
colourGreen
titleOptional

int

Fetch Contact Categories for the given size use together with "from"

/api/v2/rest/contactCategories?size=100

Status

colour	Green
title	yes

/api/v2/rest/contactCategories/

Status

colour	Blue
title	GET

from

 Status
subtletrue
colourGreen
titleOptional

int

Fetch Contact Category from the given ID use together with "size"

/api/v2/rest/contactCategories?size=100&from=200

Status

colour	Green
title	yes

/api/v2/rest/contactCategories/

 Status
colourGreen
titlePOST

ApiSyncItem

Save Contact Category

/api/v2/rest/contactCategories/[Contact Category Object]

Status

colour	Green
title	yes

/api/v2/rest/contactCategories/[id]

 Status
colourBlue
titleGET

ApiContactCategory

Fetch Contact Category for the given ID

/api/v2/rest/contactCategories/123

Status

colour	Green
title	yes

/api/v2/rest/contactCategories/

 Status
colourRed
titleDELETE

ContactCategory ID

Delete Contact Category

/api/v2/rest/contactCategories/123

Status

colour	Green
title	yes

Customers

/api/v2/rest/customers/

 Status
colourBlue
titleGET

ApiCustomer[]

clientId

 Status
subtletrue
colourRed
titleREQUIRED

int

Fetch all Customers for the given Client ID

/api/v2/rest/customers?clientId=1

Status

colour	Green
title	yes

/api/v2/rest/customers/

Status

colour	Blue
title	GET

ApiSyncItem[]

syncItem

 Status
subtletrue
colourGreen
titleOptional

boolean (true/false)

Fetch all Customers for the given Client ID and return them as SyncItems

/api/v2/rest/customers?clientId=1&syncItem=true

Status

colour	Green
title	yes

/api/v2/rest/customers/

Status

colour	Blue
title	GET

isActive

 Status
subtletrue
colourGreen
titleOptional

boolean (true/false)

Fetch all active Customers

if ommited, all customers are returned

/api/v2/rest/customers?clientId=1&isActive=true

Status

colour	Green
title	yes

/api/v2/rest/customers/

 Status
colourGreen
titlePOST

ApiSyncItem

Save Customer

/api/v2/rest/customers/[Customer Object]

Status

colour	Green
title	yes

/api/v2/rest/customers/[id]

 Status
colourBlue
titleGET

ApiCustomer

Fetch Customer for the given Customer ID

/api/v2/rest/customers/1

Status

colour	Green
title	yes

/api/v2/rest/customers/

 Status
colourYellow
titlePUT

ApiSyncItem

Update Customer

/api/v2/rest/customers/[Customer Object]

Status

colour	Green
title	yes

Suppliers

/api/v2/rest/suppliers/

 Status
colourBlue
titleGET

ApiSupplier[]

clientId

 Status
subtletrue
colourRed
titleREQUIRED

int

Fetch all Suppliers for the given Client ID

/api/v2/rest/suppliers?clientId=1

Status

colour	Green
title	yes

/api/v2/rest/suppliers/

Status

colour	Blue
title	GET

returnApiSyncItems

Status

subtle	true
colour	Green
title	Optional

boolean (true/false)

Fetch all Suppliers and return them as SyncItems

/api/v2/rest/suppliers?clientId=1&returnApiSyncItems=true

Status

colour	Green
title	yes

/api/v2/rest/suppliers/

Status

colour	Blue
title	GET

search

Status

subtle	true
colour	Green
title	Optional

string

Fetch all Suppliers for the given Search term

/api/v2/rest/suppliers?clientId=1&search=Supplier Name

Status

colour	Green
title	yes

/api/v2/rest/suppliers/

Status

colour	Blue
title	GET

isActive

Status

subtle	true
colour	Green
title	Optional

boolean (true/false)

Fetch all Active Suppliers

/api/v2/rest/suppliers?clientId=1&isActive=true

Status

colour	Green
title	yes

/api/v2/rest/suppliers/

Status

colour	Blue
title	GET

showReferenceDetails

Status

subtle	true
colour	Green
title	Optional

boolean (true/false)

Fetch all Suppliers and return extended payment term array

/api/v2/rest/suppliers?clientId=1&showReferenceDetails=true

/api/v2/rest/suppliers/

 Status
colourGreen
titlePOST

ApiSyncItem

Save Supplier

/api/v2/rest/suppliers/[Supplier Object]

Status

colour	Green
title	yes

/api/v2/rest/suppliers/[id]

 Status
colourBlue
titleGET

ApiSupplier

Fetch supplier for the given ID

/api/v2/rest/suppliers/1

Status

colour	Green
title	yes

/api/v2/rest/suppliers/

 Status
colourYellow
titlePUT

ApiSyncItem

Update Supplier

/api/v2/rest/suppliers/[Supplier Object]

Status

colour	Green
title	yes

EmployeeProjects

/api/v2/rest/employeeProjects/

 Status
colourBlue
titleGET

ApiEmployeeProject[]

employeeId

 Status
subtletrue
colourRed
titleREQUIRED 1

int

Fetch all Employee Projects for the given employee ID

/api/v2/rest/employeeProjects?employeeId=123

Status

colour	Green
title	yes

/api/v2/rest/employeeProjects/[id]

 Status
colourBlue
titleGET

ApiEmployeeProject

Fetch Employee Project for the given ID

/api/v2/rest/employeeProjects/1

Status

colour	Green
title	yes

/api/v2/rest/employeeProjects/

 Status
colourYellow
titlePUT

ApiSyncItem

Update Employee Project

/api/v2/rest/employeeProjects/[Employee Project Object]

Status

colour	Green
title	yes

/api/v2/rest/employeeProjects/

 Status
colourRed
titleDELETE

EmployeeProject ID

Delete Employee Project

/api/v2/rest/employeeProjects/1

Status

colour	Green
title	yes

/api/v2/rest/employeeProjects/

Status

colour	Green
title	POST

ApiSyncItem

Save Employee Project

/api/v2/rest/employeeProjects/[Employee Project Object]

Status

colour	Green
title	yes

Employees

/api/v2/rest/employees/

 Status
colourBlue
titleGET

ApiEmployee[]

clientId

 Status
subtletrue
colourRed
titleREQUIRED

int

Fetch Employees for the given Client ID

/api/v2/rest/employees?clientId=1

Status

colour	Green
title	yes

/api/v2/rest/employees/

Status

colour	Blue
title	GET

employeeBrand

 Status
subtletrue
colourGreen
titleOptional

string

Fetch Employees for the given Client ID and Employee Brand

/api/v2/rest/employees?clientId=1&employeeBrand=N,E

Status

colour	Green
title	yes

/api/v2/rest/employees/

Status

colour	Blue
title	GET

employeeLoginName

 Status
subtletrue
colourGreen
titleOptional

string

Fetch Employees for the given Client ID and Employee Login Name

/api/v2/rest/employees?clientId=1&employeeLoginName=USER

Status

colour	Green
title	yes

/api/v2/rest/employees/

Status

colour	Blue
title	GET

checkForEnabledExchangeSync

 Status
subtletrue
colourGreen
titleOptional

boolean (true/false)

Fetch Employees for the given Client ID and employees with activated exchange sync

/api/v2/rest/employees?clientId=1&checkForEnabledExchangeSync=true

Status

colour	Green
title	yes

/api/v2/rest/employees/

Status

colour	Blue
title	GET

ignoreClient

 Status
subtletrue
colourGreen
titleOptional

Fetch Employees for the given Client ID and return employees without client check

/api/v2/rest/employees?clientId=1&ignoreClient

Status

colour	Green
title	yes

/api/v2/rest/employees/

 Status
colourGreen
titlePOST

ApiSyncItem

Save Employee

/api/v2/rest/employees/[Employee Object]

Status

colour	Green
title	yes

/api/v2/rest/employees/[id]

 Status
colourBlue
titleGET

ApiEmployee

Fetch Employee for the given Employee ID

/api/v2/rest/employees/1

Status

colour	Green
title	yes

/api/v2/rest/employees/

 Status
colourYellow
titlePUT

ApiSyncItem

Update Employee

/api/v2/rest/employees/[Employee Object]

Status

colour	Green
title	yes

Projects

/api/v2/rest/projects/

 Status
colourBlue
titleGET

ApiProject[], ApiSyncItem[]

clientId

Status

subtle	true
colour	Red
title	REQUIRED

int

Fetch All Projects for the given Client ID

/api/v2/rest/project?clientId=1

Status

colour	Green
title	yes

/api/v2/rest/projects/

Status

colour	Blue
title	GET

from

 Status
subtletrue
colourGreen
titleOptional

int

Fetch All Projects for the given Client ID and start with given Project ID, use togehter with "size"

/api/v2/rest/projects?clientId=1&from=100&size=50

Status

colour	Green
title	yes

/api/v2/rest/projects/

Status

colour	Blue
title	GET

size

 Status
subtletrue
colourGreen
titleOptional

int

Fetch All Projects for the given Client ID and the given limit, use together with "from"

/api/v2/rest/projects?clientId=1&from=100&size=50

Status

colour	Green
title	yes

/api/v2/rest/projects/

Status

colour	Blue
title	GET

since

 Status
subtletrue
colourGreen
titleOptional

valid ETag

Fetch All Projects for the given Client ID and given date, only items modified since ETag will be returned

/api/v2/rest/projects?clientId=1&since=20110722153556

Status

colour	Green
title	yes

/api/v2/rest/projects/

Status

colour	Blue
title	GET

syncItem

Status

subtle	true
colour	Green
title	Optional

boolean (true/false)

Fetch All Projects for the given Client ID and set syncitems "true" to return ApiSyncItems

/api/v2/rest/projects?clientId=1&syncItem=true

Status

colour	Green
title	yes

/api/v2/rest/projects/

Status

colour	Blue
title	GET

customerId

 Status
subtletrue
colourGreen
titleOptional

string

Fetch All Projects for the given Client ID and given Customer ID

/api/v2/rest/projects?clientId=1&customerId=1

Status

colour	Green
title	yes

/api/v2/rest/projects/

Status

colour	Blue
title	GET

customerIsActive

 Status
subtletrue
colourGreen
titleOptional

boolean (true/false)

Fetch All Projects for the given Client ID and given Parameter, set to "true" to get only projects of active customers

/api/v2/rest/projects?clientId=1&customerIsActive=true

Status

colour	Green
title	yes

/api/v2/rest/projects/

Status

colour	Blue
title	GET

projectIsInProcess

 Status
subtletrue
colourGreen
titleOptional

boolean (true/false)

Fetch All Projects for the given Client ID and given Parameter, set to "true" to get only "in process" projects

/api/v2/rest/projects?clientId=1&projectIsInProcess=true

Status

colour	Green
title	yes

/api/v2/rest/projects/

Status

colour	Blue
title	GET

projectStatusId

 Status
subtletrue
colourGreen
titleOptional

int or array

Fetch All Projects for the given Client ID and given Project status ID

/api/v2/rest/projects?clientId=1&projectStatusId=[11, 12, 16, 35, 97, 108, 116]

Status

colour	Green
title	yes

/api/v2/rest/projects/

Status

colour	Blue
title	GET

projectTypeId

 Status
subtletrue
colourGreen
titleOptional

int or array

Fetch All Projects for the given Client ID and given Project Type ID

/api/v2/rest/projects?clientId=1&projectTypeId=[24, 25, 26, 29, 30]

Status

colour	Green
title	yes

/api/v2/rest/projects/

Status

colour	Blue
title	GET

projectLeaderId

 Status
subtletrue
colourGreen
titleOptional

int

Fetch All Projects for the given Client ID and given Leader ID

/api/v2/rest/projects?clientId=1&projectLeaderId=1

Status

colour	Green
title	yes

/api/v2/rest/projects/

Status

colour	Blue
title	GET

search

 Status
subtletrue
colourGreen
titleOptional

string

Fetch All Projects for the given Client ID and givenSearch Term

/api/v2/rest/projects?clientId=1&search=Project Name

Status

colour	Green
title	yes

/api/v2/rest/projects/

 Status
colourGreen
titlePOST

ApiSyncItem

synctoken

 Status
subtletrue
colourRed
titleREQUIRED

string (ApiProject)

Save Project

/api/v2/rest/projects/[Project Object]

Status

colour	Green
title	yes

/api/v2/rest/projects/[id]

 Status
colourBlue
titleGET

ApiProject, ApiSyncItem

syncItem

 Status
subtletrue
colourGreen
titleOptional

boolean (true/false)

set "true" to return ApiSyncItem

/api/v2/rest/projects/1&syncItem=true

Status

colour	Green
title	yes

/api/v2/rest/projects/

 Status
colourYellow
titlePUT

ApiSyncItem

(ApiProject)

Update Project

/api/v2/rest/projects/[Project Object]

Status

colour	Green
title	yes

/api/v2/rest/projects/

 Status
colourRed
titleDELETE

ApiSyncItem

synctoken

Status

subtle	true
colour	Red
title	REQUIRED

(ApiProject)

Delete Project

/api/v2/rest/projects/1

Status

colour	Green
title	yes

projectFolders

/api/v2/rest/projectFolders/

 Status
colourBlue
titleGET

ApiProjectFolder[]

clientId

 Status
subtletrue
colourRed
titleREQUIRED

int

Status

colour	Green
title	yes

/api/v2/rest/projectFolders/

customerId

 Status
subtletrue
colourGreen
titleOptional

string

/api/v2/rest/projectFolders/

onlyActive

 Status
subtletrue
colourGreen
titleOptional

boolean (true/false)

set to "true" to get only project folders

/api/v2/rest/projectFolders/

type

 Status
subtletrue
colourGreen
titleOptional

string

folder type, P = project, SS = service - service, SM = service - material, SP = service - position, ALL = returns all type, if you ommit this parameter only P-types will return

/api/v2/rest/projectFolders/

 Status
colourGreen
titlePOST

ApiSyncItem

synctoken

 Status
subtletrue
colourRed
titleREQUIRED

string (ApiProjectFolder)

Status

colour	Green
title	yes

/api/v2/rest/projectFolders/[id]

 Status
colourBlue
titleGET

ApiProjectFolder

Status

colour	Green
title	yes

/api/v2/rest/projectFolders/

 Status
colourYellow
titlePUT

ApiSyncItem

(ApiProjectFolder)

Status

colour	Green
title	yes

/api/v2/rest/projectFolders/

 Status
colourRed
titleDELETE

ApiSyncItem

(ApiProjectFolder)

Status

colour	Green
title	yes

projectUnits

/api/v2/rest/projectUnits

 Status
colourBlue
titleGET

ApiProjectUnit[]

clientId

 Status
subtletrue
colourRed
titleREQUIRED

int

Fetch all Project Units for the given clientId

/api/v2/rest/projectUnits

Status

colour	Green
title	yes

/api/v2/rest/projectUnit/[id]

 Status
colourBlue
titleGET

ApiProjectUnit

Fetch Project Unit for the given Project Unit ID

/api/v2/rest/projectUnits/1

Status

colour	Green
title	yes

services

/api/v2/rest/services

 Status
colourBlue
titleGET

ApiService[]

clientId

 Status
subtletrue
colourRed
titleREQUIRED

int

Fetch all Services for the given Client ID

/api/v2/rest/services?clientId=1

Status

colour	Green
title	yes

/api/v2/rest/services/[id]

 Status
colourBlue
titleGET

ApiService

Fetch Service for the given Service ID

/api/v2/rest/services/1

Status

colour	Green
title	yes

serviceFees

/api/v2/rest/serviceFees

 Status
colourBlue
titleGET

ApiServiceFee[]

clientId

 Status
subtletrue
colourRed
titleREQUIRED

int

Fetch all Service Fees for the given clientId

/api/v2/rest/serviceFees

Status

colour	Green
title	yes

/api/v2/rest/serviceFees/[id]

 Status
colourBlue
titleGET

ApiServiceFee

Fetch Service Fee for the given Service

/api/v2/rest/serviceFees/1

Status

colour	Green
title	yes

Subproject

 Status
colourBlue
titleGET

ApiSubproject[]

clientId

 Status
subtletrue
colourRed
titleREQUIRED

int

Status

colour	Green
title	yes

projectId

 Status
subtletrue
colourGreen
titleOptional

int

Status

colour	Green
title	yes

parentId

 Status
subtletrue
colourGreen
titleOptional

int

Status

colour	Green
title	yes

ApiSyncItem[]

syncItem

 Status
subtletrue
colourGreen
titleOptional

boolean (true/false)

Status

colour	Green
title	yes

 Status
colourGreen
titlePOST

ApiSyncItem

synctoken

 Status
subtletrue
colourRed
titleREQUIRED

string (ApiSubproject)

Status

colour	Green
title	yes

/api/v2/rest/subprojects/[id]

 Status
colourBlue
titleGET

ApiSubproject

Status

colour	Green
title	yes

 Status
colourYellow
titlePUT

ApiSyncItem

(ApiSubproject)

Status

colour	Green
title	yes

 Status
colourRed
titleDELETE

ApiSyncItem

(ApiSubproject)

Status

colour	Green
title	yes

/api/v2/rest/tasks

 Status
colourBlue
titleGET

ApiTask[]

fromEmployeeId

Status

subtle	true
colour	Green
title	Optional

int

Status

colour	Green
title	yes

toEmployeeId

 Status
subtletrue
colourGreen
titleOptional

int

type

 Status
subtletrue
colourGreen
titleOptional

string (ApiTask:Task, ApiTask:ProjectTask, ApiTask:ProjectWarning)

 Status
colourGreen
titlePOST

ApiSyncItem

Status

colour	Green
title	yes

/api/v2/rest/tasks/[id]

 Status
colourBlue
titleGET

ApiTask

Status

colour	Green
title	yes

 Status
colourYellow
titlePUT

ApiSyncItem

Status

colour	Green
title	yes

Status

colour	Red
title	DELETE

boolean

Status

colour	Green
title	yes

/api/v2/rest/texts

 Status
colourBlue
titleGET

ApiText[]

parentType

 Status
subtletrue
colourRed
titleREQUIRED

type: A = assignment, C = calculation position, D = document, E = document position, F = cover footer, I = client, X = text, P = project, S = subproject, L = cover letter, T = milestone

Status

colour	Green
title	yes

parentId

 Status
subtletrue
colourRed
titleREQUIRED

int

 Status
colourGreen
titlePOST

ApiSyncItem

Status

colour	Green
title	yes

/api/v2/rest/texts/[id]

 Status
colourBlue
titleGET

ApiText

Status

colour	Green
title	yes

Status

colour	Yellow
title	PUT

ApiSyncItem

Status

colour	Green
title	yes

 Status
colourRed
titleDELETE

boolean

Status

colour	Green
title	yes

/api/v2/rest/misc/availablePaths

return a list of available paths

 Status
colourBlue
titleGET

string array

Status

colour	Green
title	yes

/api/v2/rest/misc/categories

 Status
colourBlue
titleGET

ApiSyncItem[]

Status

colour	Green
title	yes

/api/v2/rest/misc/costCenters

 Status
colourBlue
titleGET

ApiCostCenter[]

clientId

 Status
subtletrue
colourRed
titleREQUIRED

int

Status

colour	Green
title	yes

/api/v2/rest/misc/costCenters/[id]

 Status
colourBlue
titleGET

ApiCostCenter

Status

colour	Green
title	yes

/api/v2/rest/misc/countries

 Status
colourBlue
titleGET

string array

Status

colour	Green
title	yes

/api/v2/rest/misc/currentEmployee

 Status
colourBlue
titleGET

ApiEmployee

Status

colour	Green
title	yes

/api/v2/rest/misc/currentEmployee/accessRoles

 Status
colourBlue
titleGET

array

roles

 Status
subtletrue
colourRed
titleREQUIRED

["contacts","projectTasks","timeRecording","timeReporting"]

api/v2/rest/misc/currentEmployee/accessRoles?roles=["contacts","projectTasks","timeRecording","timeReporting"]

Status

colour	Green
title	yes

/api/v2/rest/misc/projectStatuses

 Status
colourBlue
titleGET

ApiProjectStatus[]

clientId

 Status
subtletrue
colourRed
titleREQUIRED

int

Status

colour	Green
title	yes

/api/v2/rest/misc/projectTypes

 Status
colourBlue
titleGET

ApiProjectType[]

clientId

 Status
subtletrue
colourRed
titleREQUIRED

int

Status

colour	Green
title	yes

/api/v2/rest/misc/salutations

 Status
colourBlue
titleGET

string array

Status

colour	Green
title	yes

/api/v2/rest/misc/settings

 Status
colourBlue
titleGET

array

clientId

 Status
subtletrue
colourRed
titleREQUIRED

int

Status

colour	Green
title	yes

scope

 Status
subtletrue
colourRed
titleREQUIRED

billing

api/v2/rest/misc/settings?scope=billing&clientId=1

/api/v2/rest/misc/taxRates

 Status
colourBlue
titleGET

ApiTaxRate[]

clientId

 Status
subtletrue
colourRed
titleREQUIRED

int

Status

colour	Green
title	yes

/api/v2/rest/misc/taxRates/[id]

 Status
colourBlue
titleGET

ApiTaxRate

Status

colour	Green
title	yes

Units

/api/v2/rest/misc/units

 Status
colourBlue
titleGET

ApiUnit[]

clientId

 Status
subtletrue
colourRed
titleREQUIRED

int

Status

colour	Green
title	yes

/api/v2/rest/misc/units/[Id]

 Status
colourBlue
titleGET

ApiUnit

Status

colour	Green
title	yes

Credentials Verification

/api/v2/rest/misc/verifyCredentials

 Status
colourBlue
titleGET

boolean or ApiErrorData

auth

Status

subtle	true
colour	Red
title	REQUIRED

string

api/v2/rest/misc/verifyCredentials?auth=Basic bHVkd2lnOjA5NDVmYzk2MTFmNTVmZDBlMTgzZmI4YjA0NGYxYWZl

Status

colour	Green
title	yes

Approval Groups

api/v2/rest/misc/approvalGroups

Status

colour	Blue
title	GET

ApiApprovalGroup[]

clientId

Status

subtle	true
colour	Red
title	REQUIRED

int

Fetch all Approval Groups given Client.

api/v2/rest/misc/approvalGroups?clientId=1

Status

colour	Green
title	yes

/api/v2/rest/misc/approvalGroups/[Id]

Status

colour	Blue
title	GET

ApiApprovalGroup

api/v2/rest/misc/approvalGroups/1

Status

colour	Green
title	yes

User Groups

api/v2/rest/misc/userGroups

Status

colour	Blue
title	GET

ApiSyncItem[]

Fetch all User Groups

api/v2/rest/misc/userGroups

Status

colour	Green
title	yes

Currencies

api/v2/rest/misc/currencies

Status

colour	Blue
title	GET

ApiCurrency[]

clientId

Status

subtle	true
colour	Red
title	REQUIRED

int

Fetch all Currencies given Client.

api/v2/rest/misc/currencies

Status

colour	Green
title	yes

/api/v2/rest/misc/currencies/[Id]

Status

colour	Blue
title	GET

ApiCurrency[]

Fetch Currency By ID

api/v2/rest/misc/currencies/1

Status

colour	Green
title	yes

Project Leaders

api/v2/rest/misc/projectLeaders

/api/v2/rest/misc/projectLeaders

Status

colour	Blue
title	GET

ApiEmployee[]

clientId

Status

subtle	true
colour	Red
title	REQUIRED

int

Fetch all Project Leaders for the given Client.

api/v2/rest/misc/projectLeaders

Status

colour	Green
title	yes

Version

api/v2/rest/misc/version

/api/v2/rest/misc/version

Status

colour	Blue
title	GET

string Array[]

Fetch Current Troi Version

api/v2/rest/misc/version

Status

colour	Green
title	yes

Settings

api/v2/rest/misc/settings

/api/v2/rest/misc/settings

Status

colour	Blue
title	GET

string Array[]

clientId

Status

subtle	true
colour	Red
title	REQUIRED

int

Fetch all Settings for the given Scope

api/v2/rest/misc/settings?clientId=1&scope=accounting

Status

colour	Green
title	yes

scope

Status

subtle	true
colour	Red
title	REQUIRED

string - available parameters (accounting, billing, BOOKKEEPING_VAT_IN_PRICE_LIST)

Sync for Offline Client

Status

colour	Blue
title	GET

ApiOfflineClientsSync

Status

colour	Green
title	yes

WorkingTimeLog

/api/v2/rest/checkincheckout

Status

colour	Blue
title	GET

ApiWorkingTimeLog[]

getCurrentCheckIn

Status

subtle	true
colour	Red
title	REQUIRED

boolean

Fetch All WorkingTimeLog

/api/v2/rest/checkincheckout?getCurrentCheckIn=true

Status

colour	Green
title	yes

/api/v2/rest/checkincheckout

Status

colour	Green
title	POST

ApiSyncItem

Save WorkTimeLog

/api/v2/rest/checkincheckout/[WorkTimeLog Object]

Status

colour	Green
title	yes

Hermes Settings

/api/v2/rest/hermes/settings

Status

colour	Blue
title	GET

ApiHermesSettings[]

Fetch All Hermes Settings

/api/v2/rest/hermes/settings

Status

colour	Green
title	yes

Hermes Projects

/api/v2/rest/hermes/projects

Status

colour	Blue
title	GET

ApiHermesProjects[]

search

Status

subtle	true
colour	Red
title	REQUIRED

string (search=* , search=projectname)

2 search patterns are available (*) → for all projects and

a part of Project Name like (test project)

Fetch All Hermes Projects

/api/v2/rest/hermes/projects?search=*

/api/v2/rest/hermes/projects?search=projectName

Status

colour	Green
title	yes

/api/v2/rest/hermes/projects/[id]

Status

colour	Blue
title	GET

ApiHermesProjects[]

Fetch Hermes Project By ID

/api/v2/rest/hermes/projects/123

Status

colour	Green
title	yes

Hermes / E-Mail Management - Mails Attachment

/api/v2/rest/hermes/mails/attachments/[id]

Status

colour	Blue
title	GET

ApiHermesEmaiAttachment[]

Fetch Hermes Mail Attachment By ID

/api/v2/rest/hermes/mails/attachments/1

Status

colour	Green
title	yes

/api/v2/rest/hermes/mails/attachments/

Status

colour	Green
title	POST

ApiSyncItem

Save Hermes Email Attachment

/api/v2/rest/hermes/mails/attachments/[Hermes EmaiAttachment Object]

Status

colour	Green
title	yes

Hermes / E-Mail Management - Tags

/api/v2/rest/hermes/tags

Status

colour	Green
title	POST

ApiHermesTagEx

Save Hermes Tag

/api/v2/rest/hermes/tags/[HermesTagObject]

Status

colour	Green
title	yes

/api/v2/rest/hermes/tags/[id]

Status

colour	Blue
title	GET

ApiHermesTagEx

Fetch Hermes Tag by ID

/api/v2/rest/hermes/tags/[id]

Status

colour	Green
title	yes

/api/v2/rest/hermes/tags/[object]

tagParticipants as Hermes Contact Object (see Hermes / E-Mail Management - Contacts Object)

Status

colour	Yellow
title	PUT

ApiHermesTagEx

Update Hermes Participant For Hermes Tag

/api/v2/rest/hermes/tags/[HermesTagObject]

Status

colour	Green
title	yes

Hermes / E-Mail Management - Contacts

/api/v2/rest/hermes/contacts

Status

colour	Blue
title	GET

ApiHermesTagParticipant[]

search

Status

subtle	true
colour	Red
title	required

string

search for contacts that will be participants of Hermes Tag

* to get all entries

OR Contact Name

/api/v2/rest/hermes/contacts?search=ludwig

/api/v2/rest/hermes/contacts?search=*

Status

colour	Green
title	yes

/api/v2/rest/hermes/contacts[id]

Status

colour	Blue
title	GET

ApiHermesTagParticipant

Fetch Hermes Contact By ID

/api/v2/rest/hermes/contacts/[id]

Status

colour	Green
title	yes

Hermes / E-Mail Management - Mails

/api/v2/rest/hermes/mails

Status

colour	Green
title	POST

ApiSyncItem

add new mail tagged by Hermes to be stored in Troi

/api/v2/rest/hermes/mails/[ApiHermesMail Object]

Status

colour	Green
title	yes

/api/v2/rest/hermes/mails

Status

colour	Blue
title	GET

ApiHermesMail[]

messageId

Status

subtle	true
colour	Red
title	required

string

search for Hermes Mail that fit given criteria message id (header); MUST be url-encoded

/api/v2/rest/hermes/mails?messageId=%3csample%3aid%40mail%3e

Status

colour	Green
title	yes

/api/v2/rest/hermes/mails

tagId

Status

subtle	true
colour	Green
title	Optional

int

ID or HermesTag that was assigned with mail

/api/v2/rest/hermes/mails?messageId=%3csample%3aid%40mail%3e&tagId=123

Status

colour	Green
title	yes

/api/v2/rest/hermes/mails/[id]

Status

colour	Blue
title	GET

ApiHermesMail

Fetch Hermes Mail By ID

/api/v2/rest/hermes/mails/123

Status

colour	Green
title	yes

Documents

 Status
colourBlue
titleGET

ApiDocuments[]

clientId

 Status
subtletrue
colourRed
titleREQUIRED

int

Status

colour	Green
title	yes

projectId

 Status
subtletrue
colourRed
titleREQUIRED

int

Status

colour	Green
title	yes

document_type

Status

subtle	true
colour	Green
title	Optional

I (invoice) or O (offer)

Status

colour	Green
title	yes

onlyIds

Status

subtle	true
colour	Green
title	Optional

1

Status

colour	Green
title	yes

size

Status

subtle	true
colour	Green
title	Optional

int

Status

colour	Green
title	yes

from

Status

subtle	true
colour	Green
title	Optional

int

Status

colour	Green
title	yes

since

Status

subtle	true
colour	Green
title	Optional

string (YYMMDDHHMMSS) fromat

Status

colour	Green
title	yes

/api/v2/rest/documents/[id]

Status

colour	Blue
title	GET

Status

colour	Green
title	yes

/api/v2/rest/documents/[id]

Documents can just be updated when document has no number

Status

colour	Yellow
title	PUT

ApiSyncItem

Status

colour	Green
title	yes

Page Comparison

Versions Compared

Old Version 222

New Version 223

Key

Absences

Account Groups

Accounting Entries

Accounting Entry Collections

Accounts

Billings - Hours

Booking Year

Calculation Positions

Calendar Events

Calendar Event Participants

Tenants (formerly Clients)

Contacts

Contacts Logical Database

Customers

Suppliers

EmployeeProjects

Employees

Projects

projectFolders

projectUnits

categories

services

serviceFees

Subproject

Units

Credentials Verification

Approval Groups

User Groups

Currencies

Project Leaders

Version

Settings

Sync for Offline Client

WorkingTimeLog

Hermes Settings

Hermes Projects

Hermes / E-Mail Management - Mails Attachment

Hermes / E-Mail Management - Tags

Hermes / E-Mail Management - Contacts

Hermes / E-Mail Management - Mails

Documents