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

<?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

field name	data type	remark
Start	string(19)	yyyy-mm-dd hh:mm:ss
End	string(19)	yyyy-mm-dd hh:mm:ss
Subject	string
Description	string
Destination	string
Employee	Array
Id	integer
Path	string
ETag	string
IsDeleted	boolean
halfDay	integer	1 = half day before noon, 2 = half day afternoon, 0 = full day
ClassName	String	ApiAbsence

/api/v2/rest/absences/

ApiAbsence[]

start

string (yyyymmdd)

Fetch all absences for the given Start Date and End Date

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

/api/v2/rest/absences/

end

string (yyyymmdd)

Fetch all absences for the given Start Date and End Date

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

/api/v2/rest/absences/

employeeId

int

Fetch all Absences for the given employeeId

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

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

ApiAbsence

Fetch Absence for the given Absence ID

/api/v2/rest/absences/1

Account Groups

field name	data type	remark
Name	string(255)
Client	Array
Type	integer
Id	integer
Path	string
ETag	string
IsDeleted	boolean
ClassName	string	ApiAccountGroup

/api/v2/rest/accountGroups/

ApiAccountGroup[]

clientId

int

Fetch all Account Groups for the given clientId

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

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

ApiAccountGroup

Fetch Account Group for the given Account Group ID

/api/v2/rest/accountGroups/1

/api/v2/rest/accountGroups/

ApiSyncItem

Save Absence Groups Object

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

/api/v2/rest/accountGroups/

ApiSyncItem

Update Absence Groups Object

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

/api/v2/rest/accountGroups/

Account Group ID

Delete Absence Groups

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

Accounting Entries

field name	data type	remark
Client	Array
CostCenter	Array
CostCenter1	Array
CostCenter2	Array
Amount	decimal
Account	Array	aeCreditAccount
ContraAccount	Array	aeDebitAccount
AccountingEntryCollection	Array
CostCenter	Array
DocumentDate	string(10)	yyyy-mm-dd
DocumentNumber	string(100)
DocumentNumber2	string(100)
DmsLink	string(255)	link to document in external document management system (dms)
BesrReferenceNumber	integer
Description	string(255)
CalculationPosition	Array
TaxRate	Array
Location	integer	0 = journal, 1 = heap
IsNotBillable	boolean
IsBilled	boolean
IsPaid	boolean
IsKsk	boolean	available with version 4.2.4.113 and up
IsSplitBase	boolean
ParentId	integer
PaymentTerm	Array
ProjectNumber	string
Id	integer
Path	string
ETag	string
IsDeleted	boolean
ClassName	string

/api/v2/rest/accountingEntries/

ApiAccountingEntry[]

clientId

int

Fetch all Accounting Entries for the given clientId

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

/api/v2/rest/accountingEntries/

cpId

int

Fetch all Accounting Entries for the given CalculationPosition ID

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

/api/v2/rest/accountingEntries/

projectId

int

Fetch all Accounting Entries for the given Project ID

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

/api/v2/rest/accountingEntries/

accountingEntryCollectionId

int

Fetch all Accounting Entries for the given AccountingEntryCollection ID

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

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

ApiAccountingEntry

Fetch Accounting Entry for the given Accounting Entry ID

/api/v2/rest/accountingEntries/1

/api/v2/rest/accountingEntries/

ApiSyncItem

Save Accounting Entry Object

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

/api/v2/rest/accountingEntries/

ApiSyncItem

Update Accounting Entry Object

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

/api/v2/rest/accountingEntries/

Accounting Entry ID

Delete Accounting Entry

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

Accounting Entry Collections

field name	data type	remark
Client	Array
FromDate	string(10)	yyyy-mm-dd
TillDate	string(10)	yyyy-mm-dd
IsLocked	boolean
CreateEmployee	array	readonly
CreateDate	string(10)	readonly
Type	integer
Id	integer
Path	string
ETag	string
IsDeleted	boolean
ClassName	string	ApiAccountingEntryCollection

/api/v2/rest/accountingEntryCollections/

ApiAccountingEntryCollection[]

clientId

int

Fetch All Accounting Entry Collections for the given clientId

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

/api/v2/rest/accountingEntryCollections/

type

int

Fetch All Accounting Entry Collections for the given type

0 = export collections, 1 = import collections

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

/api/v2/rest/accountingEntryCollections/

year

string

Fetch All Accounting Entry Collections for the given year

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

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

ApiAccountingEntryCollection

/api/v2/rest/accountingEntryCollections/1

/api/v2/rest/accountingEntryCollections/

ApiSyncItem

Save Accounting Entry Collections

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

/api/v2/rest/accountingEntryCollections/

ApiSyncItem

Update Accounting Entry Collections

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

/api/v2/rest/accountingEntryCollections/

Accounting Entry Collection ID

Delete Accounting Entry Collections

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

Accounts

field name	data type	remark
Name	string(255)
Number	integer
Client	array
DefaultContraAccount	array
SummaryAccount	integer
IsActive	boolean
IsCashDeskAccount	boolean
IsBankAccount	boolean
IsAutomaticAccount	boolean
IsLockedForDatev	boolean
Taxrate	array
AccountGroup	array
Id	integer
Path	string
ETag	string
IsDeleted	boolean
ClassName	string	ApiAccount

/api/v2/rest/accounts/

ApiAccount[]

clientId

int

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

/api/v2/rest/accounts/

accountGroupId

int

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

/api/v2/rest/accounts/

account_is_cash_or_bank

boolean (true/false)

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

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

ApiAccount

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

/api/v2/rest/accounts/

ApiSyncItem

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

/api/v2/rest/accounts/

ApiSyncItem

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

/api/v2/rest/accounts/

Account ID

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

Billings - Hours

field name	data type	remark
Client	array	link to ApiClient object
CalculationPosition	array	link to ApiCalculationPosition object
Service	array	link to ApiService object
Employee	array	link to ApiEmployee object
Date	string (yyyy-mm-dd)
Quantity	decimal
Remark	string(max)
IsBillable	boolean
IsBilled	boolean
IsInvoiced	boolean
IsApproved	boolean
Id	integer
Path	string
ETag	string
IsDeleted	boolean
documentComputedTotalNet	decimal
ClassName	string	ApiHourBilling

ApiHourBillingExt
inherits from ApiHourBilling

field name	data type	remark
CalculationPositionDisplayPath	string	readonly

/api/v2/rest/billings/hours/

ApiHourBilling[]

employeeId

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

/api/v2/rest/billings/hours/

calculationPositionId

int

Fetch all Billings for the given Calculation Position ID

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

/api/v2/rest/billings/hours/

projectId

int

Fetch all Billings for the given Project ID

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

/api/v2/rest/billings/hours/

subprojectId

int

Fetch all Billings for the given Subproject ID

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

/api/v2/rest/billings/hours/

startDate

string (yyyymmdd)

Fetch all Billings for the given Start Date

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

/api/v2/rest/billings/hours/

endDate

string (yyyymmdd)

Fetch all Billings for the given End Date

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

/api/v2/rest/billings/hours/

ApiHourBillingExt[]

extendedObject

boolean (true/false)

extended object contains the full calculation position display path

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

/api/v2/rest/billings/hours/

fillsyncitems

boolean (true/false)

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

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

/api/v2/rest/billings/hours/

ApiSyncItem

Save Billing

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

ApiHourBilling

Fetch Billing for the given Billing ID

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

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

ApiHourBillingExt

extendedObject

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/

ApiSyncItem

Update Billing

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

/api/v2/rest/billings/hours/

Billing Hour ID

Delete Billing

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

Booking Year

field name	data type	remark
Year	integer
Client	array
IsActive	boolean
IsCurrent	boolean
Id	integer
Path	string
ETag	string
ClassName	string	ApiBookingYear

/api/v2/rest/bookingYears/

ApiBookingYear

clientId

Fetch all Booking Years for the given client ID

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

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

ApiBookingYear

Fetch Booking Year for the given ID

/api/v2/rest/bookingYears/1

/api/v2/rest/bookingYears/

ApiSyncItem

Save Booking Year

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

/api/v2/rest/bookingYears/

ApiSyncItem

Update Booking Year

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

/api/v2/rest/bookingYears/

Booking Year ID

Delete Booking Year

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

Calculation Positions

field name	data type	remark
OrderNumber	integer
Name	string(128)
ExternalDescription	string(max)
InternalDescription	string(max)
Project	array	link to ApiProject object
Subproject	array	link to ApiSubproject object
Customer	array	link to ApiCustomer object
IsExternalService	boolean
IsServiceNeeded	boolean
DisplayPath	string	readonly path of calculation, like: project / subproject / calculationName
Quantity	decimal
SalePrice	decimal
PurchasePrice	decimal
TotalCalculation	decimal
Unit	array	link to ApiUnit object
Service	array
IsBillable	boolean
IsOptional	boolean
IsPrintable	boolean
HourClosed	boolean
AccountId	AccountId
CostCenterId	integer
CreatedBy	integer	readonly
ModifiedBy	integer	readonly
DeletedBy	integer	readonly
CreatedAt	string (yyyy-mm-dd hh:nn:ss)	readonly
ModifiedAt	string (yyyy-mm-dd hh:nn:ss)	readonly
DeletedAt	string (yyyy-mm-dd hh:nn:ss)	readonly
PercentageMode	boolean
IsPercentageGlobal	boolean
ServiceSource	string
TaxRate	array
id	integer
Path	string
ETag	string
IsDeleted	boolean
TotalOffer	decimal
RSAs	ApiSyncItem	link to Rest Expenses Estimation Object (if Rest Estimation Modul is activated)
lastRsaDate	ApiSyncItem	link to Last Rest Expenses Estimation Date Object (if Rest Estimation Modul is activated)
cpIsCleared	boolean
ClassName	string	ApiCalculationPosition

/api/v2/rest/calculationPositions/

ApiCalculationPosition[]

clientId

int

Fetch All all Calculation Positions for the given Client ID

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

/api/v2/rest/calculationPositions/

projectId

int

Fetch All all Calculation Positions for the given Project ID

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

/api/v2/rest/calculationPositions/

subprojectId

int

Fetch All all Calculation Positions for the given Subproject ID

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

/api/v2/rest/calculationPositions/

search

string

Fetch All all Calculation Positions for the given Search Term

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

/api/v2/rest/calculationPositions/

timeRecording

boolean (true/false)

returns on valid time recording positions for the user

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

/api/v2/rest/calculationPositions/

favoritesOnly

boolean (true/false)

returns on favorite time recording positions for the user

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

/api/v2/rest/calculationPositions/

withoutHourClosed

boolean (true/false)

returns only cp that are not closed for time recording

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

/api/v2/rest/calculationPositions/

ree_date

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

/api/v2/rest/calculationPositions/

projectStatusId

int

Fetch all Calculation Positions for the given Project Status ID

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

/api/v2/rest/calculationPositions/

bookKeeping

boolean (true/false)

Fetch all Calculation Positions for the given Book keeping

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

/api/v2/rest/calculationPositions/

projectIds

string

Fetch all Calculation Positions for the given Project IDs

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

/api/v2/rest/calculationPositions/

issueTrackerProjectKey

string

Fetch all Calculation Positions for the given issue Tracker Project Key

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

/api/v2/rest/calculationPositions/

ApiSyncItem

synctoken

string (ApiCalculationPosition)

Save Calculation Position

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

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

ApiCalculationPosition

Fetch Calculation Position for the given Calculation Position ID

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

/api/v2/rest/calculationPositions/

ApiSyncItem

(ApiCalculationPosition)

Update Calculation Position

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

/api/v2/rest/calculationPositions/

Calculation Position ID

synctoken

(ApiCalculationPosition)

Delete Calculation Position

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

Calendar Events

field name	data type	remark
Start	string(19)	yyyy-mm-dd hh:mm:ss
End	string(19)	yyyy-mm-dd hh:mm:ss
Subject	string
Description	string
Location	string
Owner	link to ApiSyncItem object, readonly
Type	string(1)	R=regular, H=holiday, G=general, P=private, T=assigment
IsPublic	boolean
IsImportant	boolean
IsExternal	boolean
Participants	array
SyncParticipants	array
GroupId	integer
ReminderMinutesBeforeStart	integer
Id	integer
Path	string
ETag	string
IsDeleted	boolean
ClassName	string	ApiCalendarEvent

/api/v2/rest/calendarEvents/

ApiCalendarEvent[]

start

string(8)

YYYYMMDD

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

/api/v2/rest/calendarEvents/

end

string(8)

YYYYMMDD

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

/api/v2/rest/calendarEvents/

search_key

string

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

/api/v2/rest/calendarEvents/

owner_employee_id

int

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

/api/v2/rest/calendarEvents/

type

["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"]

/api/v2/rest/calendarEvents/

withoutAbsences

boolean (true/false)

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

/api/v2/rest/calendarEvents/

ApiSyncItem

Save Calendar Event

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

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

ApiCalendarEvent

Fetch Calendar Event for the given ID

/api/v2/rest/calendarEvents/1

/api/v2/rest/calendarEvents/

ApiSyncItem

Update Calendar Events

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

/api/v2/rest/calendarEvents/

Calendar Event ID

Delete Calendar Events

/api/v2/rest/calendarEvents/1

Calendar Event Participants

field name	data type	remark
CalendarEvent	array
Employee	array
IsReadOnly	boolean
AcceptanceState	string
Id	integer
Path	string
ETag	string
IsDeleted	boolean
ClassName	string	ApiCalendarEventParticipant

/api/v2/rest/calendarEventParticipants/

ApiCalendarEventParticipant[]

calendarEventId

int

Fetch all Calendar Event Participants for the given Calendar Event ID

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

/api/v2/rest/calendarEventParticipants/

employeeId

int

Fetch all Calendar Event Participants for the givenEmployee ID

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

/api/v2/rest/calendarEventParticipants/

ApiSyncItem

Save Calendar Event Participants

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

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

ApiCalendarEventParticipant

Fetch Calendar Event Participant for the given Calendar Event Participant ID

/api/v2/rest/calendarEventParticipants/1

/api/v2/rest/calendarEventParticipants/

ApiSyncItem

Update Calendar Event Participant

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

/api/v2/rest/calendarEventParticipants/

Calendar Event Participant ID

Delete Calendar Event Participant

/api/v2/rest/calendarEventParticipants/1

Tenants (formerly Clients)

field name	data type	remark
Name	string(255)
Number	integer
IsActive	boolean
Contact	array	link to ApiContact object
DatevAccountNumberLength	integer
DatevConsultantNumber	integer
DatevClientNumber	integer
Id	integer
Path	string
ETag	string
IsDeleted	boolean
ClassName	string	ApiClient

/api/v2/rest/clients/

ApiClient[]

Fetch all Clients

/api/v2/rest/clients/

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

ApiClient

Fetch Client for the Given Client ID

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

Contacts

field name	data type	remark
Type	string	ApiContact:Person, ApiContact:Department:ApiContact:Company
Salutation	string	must match a valid salutation
Name1	string(50)
Name2	string(100)
Name3	string(50)
Categories	array
Title	string(30)
PrivateFax	string(30)
PrivateMail	string(100)
PrivateMobile	string(30)
PrivatePhone	string(30)
PrivateWeb	string(50)
PrivateAddressCity	string(50)
PrivateAddressCountry	string(255)	must match a valid country
PrivateAddressCountryIso	string
PrivateAddressState	string(50)
PrivateAddressStreet	string(50)
PrivateAddressZipCode	string(10)
Birthday	string(10)	yyyy-mm-dd; 0000-00-00 for an empty date
Position	string(255)
OfficePhone	string(30)
OfficeMobile	string
OfficeFax	string(30)
OfficeMail	string(100)
CompanyPhone	string(30)
CompanyFax	string(30)
CompanyWeb	string(50)
CompanyMail	string(100)
CompanyAddressCity	string(50)
CompanyAddressCountry	string(255)	must match a valid country
CompanyAddressCountryIso	string
CompanyAddressState	string(50)
CompanyAddressStreet	string(50)
CompanyAddressZipCode	string(10)
Remark	string(max)
Parent	array	is always of type contact_company
Department	array
IsFavorite	boolean
IsInactive	boolean
Id	integer
Path	string
ETag	string
IsDeleted	boolean
ClassName	string	ApiContact

ApiContact Types

	ApiContact:Person		ApiContact:Department		ApiContact:Company
field name	available	usage	available	usage	available	usage
ClassName	c		c		c
Id	r/w		r/w		r/w
Path	r/w		r/w		r/w
ETag	r/w		r/w		r/w
IsDeleted	r		r		r

Type	c		c		c
IsFavorite	r/w		r/w		r/w
IsInactive	r/w		r/w		r/w
Salutation	r/w
Name1	r/w	first name			r/w	company name 2nd row
Name2	r/w	last name	r/w	department name	r/w	company name 1st row
Name3	r/w	middle name			r/w	company name 3rd row
Title	r/w
PrivateFax	r/w
PrivateMail	r/w
PrivateMobile	r/w
PrivatePhone	r/w
PrivateWeb	r/w
PrivateAddressCity	r/w
PrivateAddressCountry	r/w
PrivateAddressState	r/w
PrivateAddressStreet	r/w
PrivateAddressZipCode	r/w
Birthday	r/w
Position	r/w
OfficePhone	r/w		r/w
OfficeFax	r/w		r/w
OfficeMail	r/w		r/w
OfficeMobile	r/w
CompanyPhone	r		r		r/w
CompanyFax	r		r		r/w
CompanyMail	r		r		r/w
CompanyWeb	r		r		r/w
CompanyAddressCity	r		r		r/w
CompanyAddressCountry	r		r		r/w
CompanyAddressState	r		r		r/w
CompanyAddressStreet	r		r		r/w
CompanyAddressZipCode	r		r		r/w
Remark	r/w		r/w		r/w
Parent	r/w		r/w		r/w
Department	r/w	only in conjunction with contactParent

/api/v2/rest/contacts/

ApiContact[], ApiSyncItem[]

syncItem

boolean (true/false)

Fetch Contacts and return them as Sync Item

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

/api/v2/rest/contacts/

from

int

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

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

/api/v2/rest/contacts/

size

int

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

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

/api/v2/rest/contacts/

since

valid ETag (yymmddhhmmss)

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

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

/api/v2/rest/contacts/

favoritesOnly

boolean (true/false)

Fetch favorites Contacts only

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

/api/v2/rest/contacts/

contactType

ApiContact:Person, ApiContact:Department, ApiContact:Company

Fetch Contacts for the given Contact Type

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

/api/v2/rest/contacts/

search

string

Fetch Contacts for the given Search Term

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

/api/v2/rest/contacts/

searchField

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}

/api/v2/rest/contacts/

withCustomFields

int

Fetch Contacts for the given with Custom Field

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

/api/v2/rest/contacts/

parentId

int

Fetch Contacts for the given parent ID

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

/api/v2/rest/contacts/

isAssociatedWithCustomer

boolean (true/false)

show all contacts that associated with some customer

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

/api/v2/rest/contacts/

onlyInactive

boolean (true/false)

show all inactive contacts

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

/api/v2/rest/contacts/

ApiSyncItem

Save Contact

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

ApiSyncItem

withCustomFields

Fetch Contact for the given with custom Field

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

/api/v2/rest/contacts/

ApiSyncItem

Update Contact

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

/api/v2/rest/contacts/

Contact ID

Delete Contact

/api/v2/rest/contacts/1

Contacts Logical Database

field name	data type	remark
Category	array
Contact	array
Id	integer
Path	string
ETag	string
IsDeleted	boolean
ClassName	string	ApiContactCategory

/api/v2/rest/contactCategories/

ApiContactCategory[]

contactId

int

Fetch all Contact Categories for the given Contact ID

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

/api/v2/rest/contactCategories/

categoryId

int

Fetch all Contact Categories for the given Category ID

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

/api/v2/rest/contactCategories/

size

int

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

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

/api/v2/rest/contactCategories/

from

int

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

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

/api/v2/rest/contactCategories/

ApiSyncItem

Save Contact Category

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

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

ApiContactCategory

Fetch Contact Category for the given ID

/api/v2/rest/contactCategories/123

/api/v2/rest/contactCategories/

ContactCategory ID

Delete Contact Category

/api/v2/rest/contactCategories/123

Customers

field name	data type	remark
Client	array
Debitor	array
TaxRate	array
TaxRateDisplayMode	integer
PaymentTerm	array
IsActive	boolean
Contact	array
Shortcut	string
Number	integer
VatNumber	integer
TaxNumber	integer
Name	string
FileShareName	string
Id	integer
Path	string
ETag	string
IsDeleted	boolean
ClassName	string	ApiCustomer

/api/v2/rest/customers/

ApiCustomer[]

clientId

int

Fetch all Customers for the given Client ID

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

/api/v2/rest/customers/

ApiSyncItem[]

syncItem

boolean (true/false)

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

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

/api/v2/rest/customers/

isActive

boolean (true/false)

Fetch all active Customers

if ommited, all customers are returned

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

/api/v2/rest/customers/

ApiSyncItem

Save Customer

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

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

ApiCustomer

Fetch Customer for the given Customer ID

/api/v2/rest/customers/1

/api/v2/rest/customers/

ApiSyncItem

Update Customer

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

Suppliers

field name	data type	remark
Client	array
Creditor	array
PaymentTerm	array
IsActive	boolean
Contact	array
Number	integer
VatNumber	integer
TaxNumber	integer
Name	string
Id	integer
Path	string
ETag	string
IsDeleted	boolean
ClassName	string	ApiSupplier

/api/v2/rest/suppliers/

ApiSupplier[]

clientId

int

Fetch all Suppliers for the given Client ID

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

/api/v2/rest/suppliers/

returnApiSyncItems

boolean (true/false)

Fetch all Suppliers and return them as SyncItems

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

/api/v2/rest/suppliers/

search

string

Fetch all Suppliers for the given Search term

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

/api/v2/rest/suppliers/

isActive

boolean (true/false)

Fetch all Active Suppliers

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

/api/v2/rest/suppliers/

showReferenceDetails

boolean (true/false)

Fetch all Suppliers and return extended payment term array

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

/api/v2/rest/suppliers/

ApiSyncItem

Save Supplier

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

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

ApiSupplier

Fetch supplier for the given ID

/api/v2/rest/suppliers/1

/api/v2/rest/suppliers/

ApiSyncItem

Update Supplier

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

EmployeeProjects

field name	data type	remark
Employee	array
Project	array
Id	integer
Path	string
ETag	string
IsDeleted	boolean
ClassName	string	ApiEmployeeProject

/api/v2/rest/employeeProjects/

ApiEmployeeProject[]

employeeId

int

Fetch all Employee Projects for the given employee ID

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

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

ApiEmployeeProject

Fetch Employee Project for the given ID

/api/v2/rest/employeeProjects/1

/api/v2/rest/employeeProjects/

ApiSyncItem

Update Employee Project

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

/api/v2/rest/employeeProjects/

EmployeeProject ID

Delete Employee Project

/api/v2/rest/employeeProjects/1

/api/v2/rest/employeeProjects/

ApiSyncItem

Save Employee Project

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

Employees

field name	data type	remark
Client	array
LoginName	string
FirstName	string
LastName	string
SmtpAddress	string
FullName	string
Contact	array
IsActive	boolean
IsLocked	boolean
Brand	string
Id	integer
Path	string
ETag	string
IsDeleted	boolean
ClassName	string	ApiEmployee

/api/v2/rest/employees/

ApiEmployee[]

clientId

int

Fetch Employees for the given Client ID

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

/api/v2/rest/employees/

employeeBrand

string

Fetch Employees for the given Client ID and Employee Brand

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

/api/v2/rest/employees/

employeeLoginName

string

Fetch Employees for the given Client ID and Employee Login Name

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

/api/v2/rest/employees/

checkForEnabledExchangeSync

boolean (true/false)

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

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

/api/v2/rest/employees/

ignoreClient

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

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

/api/v2/rest/employees/

ApiSyncItem

Save Employee

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

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

ApiEmployee

Fetch Employee for the given Employee ID

/api/v2/rest/employees/1

/api/v2/rest/employees/

ApiSyncItem

Update Employee

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

Projects

field name	data type	remark
Name	string(64)
Number	string(32)
Client	array
Customer	array
ExternalDescription	string(max)
InternalDescription	string(max)
Status	array
Currency	array
IsApproved	boolean
IsBlocked	boolean
BlockedBy	integer
Leader	array
Team	array
TypeId	integer
TaxRateId	integer
ProjectFolderId	integer
ForeignServicesCpIp	integer
ProjectTypes	array
Contact	array
InvoiceRecipientId	integer
InvoiceRecipientPersonId	integer
ReportingDate	string (yyyy-mm-dd)
ApprovedDate	string (yyyy-mm-dd)
CreatedBy	integer	readonly
ModifiedBy	integer	readonly
DeletedBy	integer	readonly
CreatedAt	string (yyyy-mm-dd hh:nn:ss)	readonly
ModifiedAt	string (yyyy-mm-dd hh:nn:ss)	readonly
DeletedAt	string (yyyy-mm-dd hh:nn:ss)	readonly
projectIssueTrackerProjectKey	string
Id	integer
Path	string
ETag	string
IsDeleted	boolean
ClassName	string	ApiProject

/api/v2/rest/projects/

ApiProject[], ApiSyncItem[]

clientId

int

Fetch All Projects for the given Client ID

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

/api/v2/rest/projects/

from

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

/api/v2/rest/projects/

size

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

/api/v2/rest/projects/

since

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

/api/v2/rest/projects/

syncItem

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

/api/v2/rest/projects/

customerId

string

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

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

/api/v2/rest/projects/

customerIsActive

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

/api/v2/rest/projects/

projectIsInProcess

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

/api/v2/rest/projects/

projectStatusId

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]

/api/v2/rest/projects/

projectTypeId

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]

/api/v2/rest/projects/

projectLeaderId

int

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

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

/api/v2/rest/projects/

search

string

Fetch All Projects for the given Client ID and givenSearch Term

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

/api/v2/rest/projects/

ApiSyncItem

synctoken

string (ApiProject)

Save Project

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

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

ApiProject, ApiSyncItem

syncItem

boolean (true/false)

set "true" to return ApiSyncItem

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

/api/v2/rest/projects/

ApiSyncItem

(ApiProject)

Update Project

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

/api/v2/rest/projects/

ApiSyncItem

synctoken

(ApiProject)

Delete Project

/api/v2/rest/projects/1

projectFolders

field name	data type	remark
Name	string
Shortcut	string
ClientId	integer
CustomerId	integer
IsActive	boolean
RootId	integer
ParentId	integer
SetLeft	integer
SetRight	integer
Level	integer
Type	string
Id	integer
Path	string
ETag	string
IsDeleted	boolean
ClassName	string	ApiProjectFolder

/api/v2/rest/projectFolders/

ApiProjectFolder[]

clientId

int

/api/v2/rest/projectFolders/

customerId

string

/api/v2/rest/projectFolders/

onlyActive

boolean (true/false)

set to "true" to get only project folders

/api/v2/rest/projectFolders/

type

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/

ApiSyncItem

synctoken

string (ApiProjectFolder)

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

ApiProjectFolder

/api/v2/rest/projectFolders/

ApiSyncItem

(ApiProjectFolder)

/api/v2/rest/projectFolders/

ApiSyncItem

(ApiProjectFolder)

projectUnits

field name	data type	remark
Name	string
IsActive	boolean
IsDeleted	boolean
Id	integer
Path	string
ETag	string
Client	array
IsDeleted	boolean
ClassName	string	ApiProjectUnit

/api/v2/rest/projectUnits

ApiProjectUnit[]

clientId

int

Fetch all Project Units for the given clientId

/api/v2/rest/projectUnits

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

ApiProjectUnit

Fetch Project Unit for the given Project Unit ID

/api/v2/rest/projectUnits/1

services

field name	data type	remark
Name	string
Client	array
Customer	array
Project	array
Description	string
InternalDescription	string
RootId	integer
UnitId	integer
PurchasePrice	decimal
SalePrice	decimal
AccountId	integer
Account	array
CostCenterId	integer
ServiceFeeId	integer
ItemNumber	integer
Source	string
Type	integer
IsNpo	boolean
IsOs	boolean
IsAp	boolean
IsKsk	boolean
IsDefault	boolean
IsDropdownVisible	boolean
IsClosedForTimeRecording	boolean
IsDeleted	boolean
TaxRate	array
Id	integer
Path	string
ETag	string
IsActive	boolean
ClassName	string	ApiService

/api/v2/rest/services

ApiService[]

clientId

int

Fetch all Services for the given Client ID

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

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

ApiService

Fetch Service for the given Service ID

/api/v2/rest/services/1

serviceFees

field name	data type	remark
Value	deciaml
Description	string
Default	integer
Client	array
Id	integer
Path	string
ETag	string
IsDeleted	boolean
ClassName	string	ApiService

/api/v2/rest/serviceFees

ApiServiceFee[]

clientId

int

Fetch all Service Fees for the given clientId

/api/v2/rest/serviceFees

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

ApiServiceFee

Fetch Service Fee for the given Service

/api/v2/rest/serviceFees/1

Subproject

field name	data type	remark
ClassName	string	ApiSubproject
Id	integer	readonly
Path	string	readonly
ETag	string	readonly
IsDeleted	boolean

Name	string(64)
ExternalDescription	string(max)
InternalDescription	string(max)
Status	ApiSyncItem	link to ApiProjectStatus object
IsApproved	boolean
Project	ApiSyncItem	link to ApiProject object
Parent	ApiSyncItem	link to ApiSubproject object
IsLeaf	boolean	readonly
OrderNumber	integer	readonly
SetLeft	integer	readonly
SetRight	integer	readonly
CreatedBy	integer	readonly
ModifiedBy	integer	readonly
DeletedBy	integer	readonly
CreatedAt	string (yyyy-mm-dd hh:nn:ss)	readonly
ModifiedAt	string (yyyy-mm-dd hh:nn:ss)	readonly
DeletedAt	string (yyyy-mm-dd hh:nn:ss)	readonly

ApiSubproject[]

clientId

int

projectId

int

parentId

int

ApiSyncItem[]

syncItem

boolean (true/false)

ApiSyncItem

synctoken

string (ApiSubproject)

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

ApiSubproject

ApiSyncItem

(ApiSubproject)

ApiSyncItem

(ApiSubproject)

/api/v2/rest/tasks

ApiTask[]

fromEmployeeId

int

toEmployeeId

int

type

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

ApiSyncItem

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

ApiTask

ApiSyncItem

boolean

/api/v2/rest/texts

ApiText[]

parentType

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

parentId

int

ApiSyncItem

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

ApiText

ApiSyncItem

boolean

/api/v2/rest/misc/availablePaths

return a list of available paths

string array

/api/v2/rest/misc/categories

ApiSyncItem[]

/api/v2/rest/misc/costCenters

ApiCostCenter[]

clientId

int

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

ApiCostCenter

/api/v2/rest/misc/countries

string array

/api/v2/rest/misc/currentEmployee

ApiEmployee

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

array

roles

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

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

/api/v2/rest/misc/projectStatuses

ApiProjectStatus[]

clientId

int

/api/v2/rest/misc/projectTypes

ApiProjectType[]

clientId

int

/api/v2/rest/misc/salutations

string array

/api/v2/rest/misc/settings

array

clientId

int

scope

billing

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

/api/v2/rest/misc/taxRates

ApiTaxRate[]

clientId

int

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

ApiTaxRate

Units

/api/v2/rest/misc/units

ApiUnit[]

clientId

int

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

ApiUnit

Credentials Verification

/api/v2/rest/misc/verifyCredentials

boolean or ApiErrorData

auth

string

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

Approval Groups

api/v2/rest/misc/approvalGroups

ApiApprovalGroup[]

clientId

int

Fetch all Approval Groups given Client.

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

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

ApiApprovalGroup

api/v2/rest/misc/approvalGroups/1

User Groups

api/v2/rest/misc/userGroups

ApiSyncItem[]

Fetch all User Groups

api/v2/rest/misc/userGroups

Currencies

api/v2/rest/misc/currencies

ApiCurrency[]

clientId

int

Fetch all Currencies given Client.

api/v2/rest/misc/currencies

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

ApiCurrency[]

Fetch Currency By ID

api/v2/rest/misc/currencies/1

Project Leaders

api/v2/rest/misc/projectLeaders

/api/v2/rest/misc/projectLeaders

ApiEmployee[]

clientId

int

Fetch all Project Leaders for the given Client.

api/v2/rest/misc/projectLeaders

Version

api/v2/rest/misc/version

/api/v2/rest/misc/version

string Array[]

Fetch Current Troi Version

api/v2/rest/misc/version

Settings

api/v2/rest/misc/settings

/api/v2/rest/misc/settings

string Array[]

clientId

int

Fetch all Settings for the given Scope

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

scope

string - available parameters (accounting, billing, BOOKKEEPING_VAT_IN_PRICE_LIST)

Sync for Offline Client

field name	data type	remark
ClassName	string	ApiOfflineClientsSync
Id	integer	readonly
Path	string	readonly
ETag	string	readonly
IsDeleted	boolean	readonly

token	string(128)

ApiOfflineClientsSync

WorkingTimeLog

field name	data type	remark
workingtimeLogId	integer	readonly
workingtimeLogEmployee
workingtimeLogEmployeeId	integer
workingTimeDate	string
workingtimeLogCheckIn	string
workingtimeLogCheckOut	string
workingTimeLogBreaks	array
workingTimeLogHasActiveBreak	array
workingTimeLogActiveBreakId	integer
id	integer	readonly
Id	integer	readonly
Path	string	readonly
ETag	string	readonly
IsDeleted	boolean	readonly
ClassName	string	readonly

/api/v2/rest/checkincheckout

ApiWorkingTimeLog[]

getCurrentCheckIn

boolean

Fetch All WorkingTimeLog

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

/api/v2/rest/checkincheckout

ApiSyncItem

Save WorkTimeLog

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

Hermes / E-Mail Management - Mails Attachment

field name	data type	remark
MailId	int
ContentType	string
Body	string
FileSize	string
id	int
Id	int
Path	string
ETag	string
IsDeleted	boolean
ClassName	string

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

ApiHermesEmaiAttachment[]

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

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

ApiSyncItem

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

Hermes / E-Mail Management - Tags

field name	data type	remark
ClassName	string	ApiHermesTagEx
Id	integer	readonly
Path	string	readonly
ETag	string	readonly
IsDeleted	boolean	readonly

tagId	integer	readonly
tagToken	string	readonly
tagParticipants	ApiHermesTagParticipant[]	writable

/api/v2/rest/hermes/tags

ApiHermesTagEx

add new, empty Hermes Tag

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

ApiHermesTagEx

edit Hermes Tag's participants

Hermes / E-Mail Management - Contacts

field name	data type	remark
ClassName	string	ApiHermesTagParticipant
Id	integer	readonly
Path	string	readonly
ETag	string	readonly
IsDeleted	boolean	readonly

participantName	string	readonly; name of contact/project
participantType	int	readonly; 1-project, 2-contact
participantOriginalId	int	readonly; reference to project's or contact's ID

/api/v2/rest/hermes/contacts

ApiHermesTagParticipant[]

search

string

search for contacts that will be participants of Hermes Tag

* to get all entries

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

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

ApiHermesTagParticipant

Hermes / E-Mail Management - Projects

field name	data type	remark
ClassName	string	ApiHermesTagParticipant
Id	integer	readonly
Path	string	readonly
ETag	string	readonly
IsDeleted	boolean	readonly

participantName	string	readonly; name of contact/project
participantType	int	readonly; 1-project, 2-contact
participantOriginalId	int	readonly; reference to project's or contact's ID

/api/v2/rest/hermes/projects

ApiHermesTagParticipant[]

search

string

search for contacts that will be participants of Hermes Tag

* to get all entries

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

- bitte nach Richtigkeit prüfen

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

ApiHermesTagParticipant

Hermes / E-Mail Management - Mails

field name	data type	remark
ClassName	string	ApiHermesMail
Id	integer	readonly
Path	string	readonly
ETag	string	readonly
IsDeleted	boolean	readonly

From	string
To	string
CC	string
Subject	string
Body	string
HeaderMessageId	string

/api/v2/rest/hermes/mails

ApiHermesMail

ApiSyncItem

add new mail tagged by Hermes to be stored in Troi

ApiHermesMail[]

messageId

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

tagId

int

ID or HermesTag that was assigned with mail

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

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

ApiHermesMail

view Hermes Mail details

Hermes / E-Mail Management - Attachments

field name	data type	remark
ClassName	string	ApiHermesMailAttachment
Id	integer	readonly
Path	string	readonly
ETag	string	readonly
IsDeleted	boolean	readonly

MailId	int
ContentType	string
FileName	string
Body	string	encoded as BASE64

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

ApiHemesMail

ApiSyncItem

add new mail attachment (for Hermes Mail)

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

ApiHemesMail

view Hermes Mail attachment details

Documents

field name	data type	remark
Name	string
Number	integer
Client	ApiSyncItem	Client ApiSyncItem
Customer	ApiSyncItem	link to ApiCustomer Object
Contact	ApiSyncItem	link to ApiContact Object
Signee	ApiSyncItem	link to ApiEmployee Object
Consignee	ApiSyncItem	link to ApiContact Object
InvoiceRecipient	ApiSyncItem	ApiSyncItem
InvoiceRecipientPerson	ApiSyncItem	ApiSyncItem
Date	date
ExternalDescription	string
InternalDescription	string
Status	string
PaymentDiscount	ApiSyncItem	link to DocumentPaymentDiscount Object
TaxRate	ApiSyncItem	link to ApiTaxRate Object
Project	ApiSyncItem	link to ApiProject Object
DocumentPositions	ApiSyncItem	link to ApiDocumentPosition
id	integer	readonly
Id	integer	readonly
Path	string	readonly
ETag	string	readonly
IsDeleted	boolean
ClassName	string	readonly

ApiDocuments[]

clientId

int

projectId

int

document_type

I (invoice) or O (offer)

onlyIds

1

size

int

from

int

since

string (YYMMDDHHMMSS) fromat

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

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

Documents can just be updated when document has no number

ApiSyncItem