Types > Aspect

A aspect can be: Employee, Customer, Project, Activity or a group (groups in TimeWriter Pro)

Tag/field name

Type

Remark

Description

long

Leave the id empty for new aspects.

If the id has got a value, the aspect with the id will be updated.

aspect id

aspectType

string

Mandatory

Note: cannot be changed for an existing aspect.

see AspectType

name

string

Mandatory

description

category 1)

string

category

abbreviation

string

abbreviation

loginName

string

Only it aspectType is IT_MED (Employee)

password

string

Only it aspectType is IT_MED (Employee)

Sending a password can be done in plain text. (It will be saved encrypted).

The password will never be returned in the response of a request.

password

overhead

boolean

overhead

validFrom 1)

date

format: yyyy-mm-dd

valid from

validTo 1)

date

format: yyyy-mm-dd

valid to (until and including)

notForAccess 1)

boolean

Only for groups

not for access

notForAuthorizations 1)

boolean

Only for groups

not for authorizations

notForCombinations 1)

boolean

Only for groups

not for combinations

notForTariffAgreements 1)

boolean

Only for groups

not for tariff agreements

notForBudgets 1)

boolean

Only for groups

not for budgets

notForProgramModules 1)

boolean

Only for groups

not for program modules

invoiceData 2)

InvoiceData

Tag/field name	Type	Remark	Description
address	string		address
postalCode	string		postal code
city	string		city
countryCode	string	e.g.: UK, US, NL, BE, DE	ISO 3166 country code (2 characters code)
contact	string		contact person
email	string		e-mail address
debtorId	string		debtor number
reference	string		invoice reference
kvk	string		Chamber of Commerce number
debtorLedgerAccountCode	string		debtor ledger account code
turnoverLedgerAccountCode	string		turnover ledger account code

taskData 3)

TaskData

Tag/field name

Type

Remark

Description

long

Read only, automatically filled

Number of the task

groupId

long

Mandatory for tasks.

For task groups: If groupid is 0, then it will be linked to the 'All task groups' node.

id of the task group which should be the parent of the task of task group

description

string

A large description field of the task

closed

boolean

True if task is closed

budget

float

Thebudget used for invoicing a task when invoiceType is FIXED_PRICE

invoiceable

boolean

if it is set to true it will be invoiced in the next time generate orders sequence. (for tasks and invoiceType = FIXED_PRICE)

useInvoicing

boolean

The invoice settings are manage on the task(group) when set this field to true.

invoiceType

TaskInvoiceType

Enumeration with the next possible values:

Value	Description
NONE	Geen facturatie
SUBSEQUENT_CALC	Nacalculatie
FIXED_PRICE	Vaste prijzen
RECURRING	Periodiek / abonnementen

The way the task(group) must be invoiced.

price

float

The price. Used when invoiceType = FIXED_PRICE or RECURRING

recurringPattern 4)

RecurringPattern

Tag/field name

Type

Remark

Description

start

date

mandatory

start date of the periodic task (subscription)

end

date

end date of the periodic task.

type

RecurringPatternType

Enumeration with the next possible values:

Value

WEEK

MONTH

YEAR

the recurring pattern

frequency

integer

minimal 1

the recurring interval

id_GR_MED

long

employee group (role) id

id_IT_AT1

long

id aspect 1

id_IT_AT2

long

id aspect 2

id_IT_AT3

long

id aspect 3

id_IT_AT4

long

id aspect 4

id_IT_AT5

long

id aspect 5

userFieldList

List<UserField>

A aspect can have none or more user fields

see UserField

1) Only for TimeWriter Pro.

2) Only available for the aspect that is set as the customer aspect at the invoicing settings.

3) Only for tasks and task groups (aspect type 'IT_TAA' en 'GR_TAA').

4) If invoiceType = RECURRING a RecurringPattern is mandatory.