1. Overview

Manage Akuiteo Workforce (Employee) domain by REST Api

1.1. Version information

Version : 2.0.0

1.2. Contact information

Contact Email : admin@akuiteo.com

1.3. License information

License : Commercial
License URL : https://www.akuiteo.com/mentions-legales
Terms of service : null

1.4. URI scheme

Host : api.akuiteo.fr
BasePath : /akuiteo/rest/workforce
Schemes : HTTPS

1.5. Tags

  • Custom Requests : Custom Requests Management

  • Employees : Employees Management

  • Expenses : Expenses & Expenses Reports Management

  • Fluent : Fluent Api for Employees Management

  • Leaves : Leaves Management

  • Quick Entries Issue : Quick Entries Issue Management

  • Quick Entries Time : Quick Entries Time Management

  • Schedules : Schedules Management

  • Timerecordings : Timerecordings Management

1.6. Schemas Types

Data types of a schema can be :

  • string (date-time) : the date-time notation as defined by RFC 3339 (yyyy-MM-dd’T’HH:mm:ss.SSSXXX). e.g. "2020-11-29T08:10:10+200"

  • number : Any numbers.

  • number (double) : Floating-point numbers with double precision. e.g. 10.8

  • number (float) : Floating-point numbers. e.g. 10.8

  • integer (int64) : Signed 64-bit integers (long type). e.g. 10

  • boolean : Represents two values: true and false. Note that truthy and falsy values such as "true", "", 0 or null are not considered boolean values.

2. Resources

2.1. Custom Requests

Custom Requests Management

2.1.1. Get the list of the custom requests

POST /custom-requests/search
Description

Get the list of the custom requests

Parameters
Type Name Description Schema

Body

criteria
required

The criteria

CustomRequestCriteria
Responses
HTTP Code Description Schema

200

Orders successfully loaded

< CustomRequest > array
Consumes

  • application/json

Produces

  • application/json

2.1.2. Get a custom request

GET /custom-requests/{custom_request_id}
Description

Get a custom request

Parameters
Type Name Description Schema

Path

custom_request_id
required

The ident of a custom request

string
Responses
HTTP Code Description Schema

200

Order successfully loaded

CustomRequest
Produces

  • application/json

2.1.3. publish custom request

POST /custom-requests/{custom_request_id}/publish
Description

Publish custom request

Parameters
Type Name Description Schema

Path

custom_request_id
required

The ident of a custom request

string

Body

publish_arguments
required

The arguments for publishing custom request

PublishArguments
Responses
HTTP Code Description Schema

200

Published document

PublishedDocument
Consumes

  • application/json

Produces

  • application/json

2.1.4. Read a custom request

POST /custom-requests/{custom_request_id}/read
Description

Read a custom request

Parameters
Type Name Description Schema

Path

custom_request_id
required

The ident of a custom request

string

Body

read_option
optional

The read options for returned custom request

CustomRequestReadOption
Responses
HTTP Code Description Schema

200

Order successfully loaded

CustomRequest
Consumes

  • application/json

Produces

  • application/json

2.2. Employees

Employees Management

2.2.1. create an employee

POST /employees
Description

create an employee

Parameters
Type Name Description Schema

Body

employee
required

The employee to be created

Employee
Responses
HTTP Code Description Schema

200

successful creation

string
Consumes

  • application/json

Produces

  • application/json

2.2.2. Retrieve all employees

GET /employees
Description

Retrieve all employees

Responses
HTTP Code Description Schema

200

Employees having this id

< Employee > array
Produces

  • application/json

2.2.3. Get the avatar of the employee

GET /employees/avatar.png
Description

Get the avatar of the employee

Parameters
Type Name Description Schema

Query

employee_code
required

The code of the employee

string

Query

s
optional

Size in pixel of the image

integer
Responses
HTTP Code Description Schema

200

Image of the Employee having this code

string (binary)
Consumes

  • application/json

Produces

  • image/*

2.2.4. Get the list of the business card

POST /employees/business-cards/search
Description

Search business card

Parameters
Type Name Description Schema

Body

criteria
required

The criteria

BusinessCardCriteria
Responses
HTTP Code Description Schema

200

business card successfully loaded

< BusinessCard > array
Consumes

  • application/json

Produces

  • application/json

2.2.5. Get the list of the employees

POST /employees/search
Description

Get the list of the employees

Parameters
Type Name Description Schema

Query

from
optional

Filtering employee history from this date

string (date-time)

Query

to
optional

Filtering employee history to this date

string (date-time)

Body

criteria
required

The criteria

EmployeeCriteria
Responses
HTTP Code Description Schema

200

Employees meeting the search criteria

< Employee > array
Produces

  • application/json

2.2.6. Get an employee

GET /employees/{employee_id}
Description

Get an employee

Parameters
Type Name Description Schema

Path

employee_id
required

The id of the employee

string
Responses
HTTP Code Description Schema

200

Employee having this id

Employee
Produces

  • application/json

2.2.7. Update an employee

PUT /employees/{employee_id}
Description

Update an employee

Parameters
Type Name Description Schema

Path

employee_id
required

The id of the employee

string

Body

employee
required

The employee to be updated

Employee
Responses
HTTP Code Description Schema

200

successful update

string
Consumes

  • application/json

Produces

  • application/json

2.2.8. Update the list of abilities of an employee

POST /employees/{employee_id}/abilities
Description

Update the list of abilities of an employee

Parameters
Type Name Description Schema

Path

employee_id
required

The id of the employee

string

Body

employeeAbility
required

Employee Abilities to be updated

< EmployeeAbility > array
Responses
HTTP Code Description Schema

200

Abilities of the employee

string
Produces

  • application/json

2.2.9. Get the list of abilities of an employee

GET /employees/{employee_id}/abilities
Description

Get the list of abilities of an employee

Parameters
Type Name Description Schema

Path

employee_id
required

The id of the employee

string
Responses
HTTP Code Description Schema

200

Abilities of the employee

< EmployeeAbility > array
Produces

  • application/json

2.2.10. Delete employee’s abilities

DELETE /employees/{employee_id}/abilities
Description

Delete employee’s abilities

Parameters
Type Name Description Schema

Path

employee_id
required

The id of the employee

string

Body

employeeAbility
required

Employee Abilities to be deleted

< EmployeeAbility > array
Responses
HTTP Code Description Schema

200

Employee’s abilities deleted

No Content
Produces

  • application/json

2.2.11. Get the avatar of the employee

GET /employees/{employee_id}/avatar.png
Description

Get the avatar of the employee

Parameters
Type Name Description Schema

Path

employee_id
required

The id of the employee

string

Query

s
optional

Size in pixel of the image

integer
Responses
HTTP Code Description Schema

200

Image of the Employee having this id

string (binary)
Consumes

  • application/json

Produces

  • image/*

2.2.12. Create a business card

PUT /employees/{employee_id}/business-cards
Description

Create a business card

Parameters
Type Name Description Schema

Path

employee_id
required

The id of the employee

string

Body

business-card
required

The business card to be created

BusinessCard
Responses
HTTP Code Description Schema

200

BusinessCard successfully inserted

string
Consumes

  • application/json

Produces

  • application/json

2.2.13. Update a business card

POST /employees/{employee_id}/business-cards/{business_card_id}
Description

Update a business card

Parameters
Type Name Description Schema

Path

business_card_id
required

The ident of a business card

string

Path

employee_id
required

The ident of an employee

string

Body

business-card
required

The business card to be updated

BusinessCard
Responses
HTTP Code Description Schema

200

BusinessCard successfully updated

string
Consumes

  • application/json

Produces

  • application/json

2.2.14. Delete a business card

DELETE /employees/{employee_id}/business-cards/{business_card_id}
Description

Delete a business card

Parameters
Type Name Description Schema

Path

business_card_id
required

The ident of a business card

string

Path

employee_id
required

The ident of an employee

string
Responses
HTTP Code Description Schema

200

Business card successfully deleted

No Content
Consumes

  • application/json

Produces

  • application/json

2.2.15. update an employee history

PUT /employees/{employee_id}/history
Description

update an employee history

Parameters
Type Name Description Schema

Path

employee_id
required

The id of the employee

string

Query

from
optional

date

string (date-time)

Body

employee
required

The employee to be updated

EmployeeHistory
Responses
HTTP Code Description Schema

200

successful history update

string
Consumes

  • application/json

Produces

  • application/json

2.2.16. Read an employee

POST /employees/{employee_id}/read
Description

Read an employee

Parameters
Type Name Description Schema

Path

employee_id
required

The id of the employee

string

Body

read_options
optional

the read options for returned employee

EmployeeReadOption
Responses
HTTP Code Description Schema

200

Employee having this id

Employee
Produces

  • application/json

2.2.17. create an employee fluently

POST /fluent/employees
Description

create an employee fluently

Parameters
Type Name Description Schema

Body

employeesFluent
required

The employee to be created

EmployeeFluent
Responses
HTTP Code Description Schema

200

successful creation

string
Consumes

  • application/json

Produces

  • application/json

2.2.18. update an employee fluently

PUT /fluent/employees/{employee_code}
Description

update an employee fluently

Parameters
Type Name Description Schema

Path

employee_code
required

the code a the Employee to update

string

Body

employeesFluent
required

The employeeFluent to update

EmployeeFluent
Responses
HTTP Code Description Schema

200

successful update

string
Consumes

  • application/json

Produces

  • application/json

2.2.19. update an employee history fluently

POST /fluent/employees/{employee_code}/history
Description

update an employee history fluently

Parameters
Type Name Description Schema

Path

employee_code
required

the code a the Employee to update

string

Query

from
optional

date

string (date-time)

Body

history
required

The employee to be updated

EmployeeHistoryFluent
Responses
HTTP Code Description Schema

200

successful history update

string
Consumes

  • application/json

Produces

  • application/json

2.2.20. Retrieve holidays

GET /holidays
Description

Retrieve holidays

Parameters
Type Name Description Schema

Query

from
optional

Filtering from this date

string (date-time)

Query

to
optional

Filtering to this date

string (date-time)
Responses
HTTP Code Description Schema

200

Holidays having this id

< Holiday > array
Produces

  • application/json

2.2.21. Retrieve all managers with delegation for me

POST /managers-delegated/mine
Description

Retrieve all managers with delegation for me

Parameters
Type Name Description Schema

Body

criteria
optional

Filtering the managers for this module delegation

ManagerDelegatedCriteria
Responses
HTTP Code Description Schema

200

My Delegated Managers

< Employee > array
Produces

  • application/json

2.2.22. Retrieve all managers

POST /managers/search
Description

Retrieve all managers

Parameters
Type Name Description Schema

Query

from
optional

Filtering the managers from this date

string (date-time)

Query

to
optional

Filtering the managers to this date

string (date-time)

Body

criteria
optional

search criteria

ManagerCriteria
Responses
HTTP Code Description Schema

200

All Managers meeting the search criteria

< Employee > array
Produces

  • application/json

2.3. Expenses

Expenses & Expenses Reports Management

2.3.1. Search the expense types

POST /employees/expense-types/search
Description

Search the expense types

Parameters
Type Name Description Schema

Body

criteria
required

The criteria

ExpenseTypeCriteria
Responses
HTTP Code Description Schema

200

Expense types

< ExpenseType > array
Produces

  • application/json

2.3.2. create an expense

PUT /employees/{employee_id}/expense-reports/expenses
Description

create an expense

Parameters
Type Name Description Schema

Path

employee_id
required

The id of the employee

string

Body

expense
required

The expense to be created

Expense
Responses
HTTP Code Description Schema

200

Expense successfully inserted

string
Consumes

  • application/json

Produces

  • application/json

2.3.3. get the employee’s expense reports

POST /employees/{employee_id}/expense-reports/search
Description

get the employee’s expense reports

Parameters
Type Name Description Schema

Path

employee_id
required

The id of the employee

string

Query

range
optional

The range of reports (ex 10-15)

string

Body

criteria
optional

the criteria

ExpenseReportCriteria
Responses
HTTP Code Description Schema

200

The Expense reports of the employee

< ExpenseReport > array
Consumes

  • application/json

Produces

  • application/json

2.3.4. Remaining threshold

GET /employees/{employee_id}/expense-type/{expense_type_code}/calculate-remaining-threshold
Description

calculate the remaining threshold for the employee and the expense type

Parameters
Type Name Description Schema

Path

employee_id
required

The id of the employee

string

Path

expense_type_code
required

The code of the expenseType

string

Query

alreadyUsed
optional

true if the expense type is already used the same day

boolean

Query

expenseDate
optional

date of the expense

string (date-time)

Query

expense_report_to_exclude_id
optional

The expense report to exclude from the calculation

string
Responses
HTTP Code Description Schema

200

Remaining threshold for the employee and the expense type

number (double)
Produces

  • application/json

2.3.5. Get the expense threshold

GET /employees/{employee_id}/expense-type/{expense_type_code}/threshold
Description

Retrieve schedule

Parameters
Type Name Description Schema

Path

employee_id
required

The id of the employee

string

Path

expense_type_code
required

The code of the expenseType

string

Query

expenseDate
optional

date of the expense

string (date-time)
Responses
HTTP Code Description Schema

200

ExpenseThreshold having this id

ExpenseThreshold
Produces

  • application/json

2.3.6. Search the expense types of employee

POST /employees/{employee_id}/expense-types/search
Description

Search the expense types of employee

Parameters
Type Name Description Schema

Path

employee_id
required

The id of the employee

string

Body

criteria
required

The criteria

ExpenseTypeCriteria
Responses
HTTP Code Description Schema

200

Expense types of employee

< ExpenseType > array
Produces

  • application/json

2.3.7. Pre-fill expense

POST /employees/{employee_id}/expenses/pre-fill
Description

Pre-fill a previously created expense.

Parameters
Type Name Description Schema

Path

employee_id
required

The id of the employee

string

Query

object_id
optional

The id of the object à partir duquel pré remplir la dépense

string

Query

object_type
optional

The type of object (see ExpensePreFillObjectType)

string

Body

expense
required

The expense to be prefilled

Expense
Responses
HTTP Code Description Schema

200

Expense successfully prefilled

Expense
Consumes

  • application/json

Produces

  • application/json

2.3.8. get refused expenses of the employee

GET /employees/{employee_id}/expenses/refused
Description

get refused expenses

Parameters
Type Name Description Schema

Path

employee_id
required

The id of the employee

string
Responses
HTTP Code Description Schema

200

refused expenses of the employee

< Expense > array
Consumes

  • application/json

Produces

  • application/json

2.3.9. dashboard for expenses

POST /expense-report/dashboard
Description

dashboard for expenses

Parameters
Type Name Description Schema

Body

criteria
optional

search criteria

ExpenseDashboardCriteria
Responses
HTTP Code Description Schema

200

the expenses results successfully loaded

< ExpenseDashboardResult > array
Consumes

  • application/json

Produces

  • application/json

2.3.10. get the ids of the related company codes

POST /expense-report/intercompany-rebilling/related-company-code
Description

get the ids of the related company codes

Parameters
Type Name Description Schema

Body

expense_report_id_list
required

The ids of the related company codes

ExpenseReportIdListParamHolder
Responses
HTTP Code Description Schema

200

The ids of the related company codes

< string > array
Consumes

  • application/json

Produces

  • application/json

2.3.11. get expense report specific publish parameters

GET /expense-report/publishing/templates/parameters
Description

get expense report specific publish parameters

Responses
HTTP Code Description Schema

200

publish parameters

< PublishTemplateParameter > array
Produces

  • application/json

2.3.12. bill expense report

POST /expense-report/{expense_report_id}/bill
Description

bill expense report

Parameters
Type Name Description Schema

Path

expense_report_id
required

The ident of an expense report

string

Body

billing_parameters
required

The parameters for the billing

ExpenseReportBillingParameters
Responses
HTTP Code Description Schema

200

the expense report has been billed

string
Consumes

  • application/json

Produces

  • application/json

2.3.13. publish expense report

POST /expense-report/{expense_report_id}/publish
Description

Publish expense report

Parameters
Type Name Description Schema

Path

expense_report_id
required

The ident of an expense report

string

Query

link_receipts
optional

true if the receipts have to be linked to the document

boolean

Body

publish_arguments
required

The arguments for publishing expense report

PublishArguments
Responses
HTTP Code Description Schema

200

published document

PublishedDocument
Consumes

  • application/json

Produces

  • application/json

2.3.14. validate expense report

POST /expense-report/{expense_report_id}/validate
Description

validate expense report

Parameters
Type Name Description Schema

Path

expense_report_id
required

The ident of an expense report

string
Responses
HTTP Code Description Schema

200

the expense report has been validated

No Content
Consumes

  • application/json

Produces

  • application/json

2.3.15. Search Assignment

POST /expense-reports/assignments/search
Description

Search Assignment For Expense Reports Module

Parameters
Type Name Description Schema

Body

criteria
optional

search criteria

AssignmentCriteria
Responses
HTTP Code Description Schema

200

Projects successfully loaded

< AssignmentNode > array
Consumes

  • application/json

Produces

  • application/json

2.3.16. get my expense reports

POST /expense-reports/mine
Description

get my expense reports

Parameters
Type Name Description Schema

Query

from
optional

Filtering my expense reports from this date

string (date-time)

Query

mode
optional

if 'latest' then filter the expense reports with all non invoiced and the latest invoiced

string

Query

to
optional

Filtering my expense reports to this date

string (date-time)

Body

read_option
optional

the read options for returned expenses

ExpenseReportReadOption
Responses
HTTP Code Description Schema

200

My Expense reports

< ExpenseReport > array
Consumes

  • application/json

Produces

  • application/json

2.3.17. search expense Report

POST /expense-reports/search
Description

search Expense Report

Parameters
Type Name Description Schema

Body

criteria
optional

search criteria

ExpenseReportCriteria
Responses
HTTP Code Description Schema

200

Expenses meeting the search criteria

< ExpenseReport > array
Consumes

  • application/json

Produces

  • application/json

2.3.18. Get an expense report

GET /expense-reports/{expense_report_id}
Description

Get an expense report

Parameters
Type Name Description Schema

Path

expense_report_id
required

The ident of an expense report

string
Responses
HTTP Code Description Schema

200

Expense report successfully loaded

ExpenseReport
Produces

  • application/json

2.3.19. Delete an expense report

DELETE /expense-reports/{expense_report_id}
Description

Delete an expense report

Parameters
Type Name Description Schema

Path

expense_report_id
required

The ident of an expense report

string
Responses
HTTP Code Description Schema

200

Expense report successfully deleted

No Content
Produces

  • application/json

2.3.20. Update an expense report with a patch

PATCH /expense-reports/{expense_report_id}
Description

Update an expense report with a patch

Parameters
Type Name Description Schema

Path

expense_report_id
required

The ident of an expense report

string

Body

patch_elements
optional

all patches to applies

< PatchElement > array
Responses
HTTP Code Description Schema

200

successful Expense Report update using the patch

string
Produces

  • application/json

2.3.21. Cancel an expense report completion

POST /expense-reports/{expense_report_id}/cancel-completion
Description

Complete an expense report

Parameters
Type Name Description Schema

Path

expense_report_id
required

The ident of an expense report

string
Responses
HTTP Code Description Schema

200

Expense report completion successfully cancelled

No Content
Produces

  • application/json

2.3.22. Complete an expense report

POST /expense-reports/{expense_report_id}/complete
Description

Complete an expense report

Parameters
Type Name Description Schema

Path

expense_report_id
required

The ident of an expense report

string
Responses
HTTP Code Description Schema

200

Expense report successfully completed

No Content
Produces

  • application/json

2.3.23. Update an expense

POST /expense-reports/{expense_report_id}/expenses/{expense_id}
Description

Update an expense

Parameters
Type Name Description Schema

Path

expense_id
required

The ident of an expense

string

Path

expense_report_id
required

The ident of an expense report

string

Body

expense
required

The expense to be updated

Expense
Responses
HTTP Code Description Schema

200

Expense successfully updated

string
Consumes

  • application/json

Produces

  • application/json

2.3.24. Delete an expense

DELETE /expense-reports/{expense_report_id}/expenses/{expense_id}
Description

Delete an expense

Parameters
Type Name Description Schema

Path

expense_id
required

The ident of an expense

string

Path

expense_report_id
required

The ident of an expense report

string
Responses
HTTP Code Description Schema

200

Expense successfully deleted

No Content
Consumes

  • application/json

Produces

  • application/json

2.3.25. Cancel a smart scan

POST /expense-reports/{expense_report_id}/expenses/{expense_id}/cancel-smart-scan
Description

Cancel a smart scan

Parameters
Type Name Description Schema

Path

expense_id
required

The ident of an expense

string

Path

expense_report_id
required

The ident of an expense report

string
Responses
HTTP Code Description Schema

200

Smart scan successfully cancelled

No Content
Consumes

  • application/json

Produces

  • application/json

2.3.26. Give up an expense

POST /expense-reports/{expense_report_id}/expenses/{expense_id}/give-up
Description

Give up an expense

Parameters
Type Name Description Schema

Path

expense_id
required

The ident of an expense

string

Path

expense_report_id
required

The ident of an expense report

string
Responses
HTTP Code Description Schema

200

Expense successfully give up

string
Consumes

  • application/json

Produces

  • application/json

2.3.27. Move an expense

POST /expense-reports/{expense_report_id}/expenses/{expense_id}/move
Description

move an expense to an existing expense report or to a new one

Parameters
Type Name Description Schema

Path

expense_id
required

The ident of an expense

string

Path

expense_report_id
required

The ident of an expense report

string

Query

expense_date
optional

The expense date

string (date-time)

Query

new_expense_report_id
optional

The target expense report

string
Responses
HTTP Code Description Schema

200

Expense successfully moved

string
Consumes

  • application/json

Produces

  • application/json

2.3.28. recover an expense in an expense report

POST /expense-reports/{expense_report_id}/expenses/{expense_id}/recover
Description

Recover an expense in an expense report

Parameters
Type Name Description Schema

Path

expense_id
required

The ident of an expense

string

Path

expense_report_id
required

The ident of an expense report

string
Responses
HTTP Code Description Schema

200

Expense successfully recovered

string
Consumes

  • application/json

Produces

  • application/json

2.3.29. Refuse an expense

POST /expense-reports/{expense_report_id}/expenses/{expense_id}/refuse
Description

Refuse an expense

Parameters
Type Name Description Schema

Path

expense_id
required

The ident of an expense

string

Path

expense_report_id
required

The ident of an expense report

string

Body

comment
optional

comment

string
Responses
HTTP Code Description Schema

200

Expense successfully refused

string
Consumes

  • application/json

Produces

  • application/json

2.3.30. get the expense receipts linked to an expense report

GET /expense-reports/{expense_report_id}/get-linked-expense-receipt
Description

get the expense receipts linked to an expense report

Parameters
Type Name Description Schema

Path

expense_report_id
required

The ident of an expense report

string
Responses
HTTP Code Description Schema

200

the linked expense receipts

< ExpenseReceiptSummary > array
Consumes

  • application/json

Produces

  • application/json

2.3.31. Get an expense report with read options

POST /expense-reports/{expense_report_id}/read
Description

Get an expense report with read options

Parameters
Type Name Description Schema

Path

expense_report_id
required

The ident of an expense report

string

Body

read_option
optional

the read options for returned expense report

ExpenseReportReadOption
Responses
HTTP Code Description Schema

200

Expense report successfully loaded

ExpenseReport
Consumes

  • application/json

Produces

  • application/json

2.3.32. Cancel a refusal for an expense

POST /expenses/{expense_id}/cancel-refusal
Description

Cancel a refusal for an expense

Parameters
Type Name Description Schema

Path

expense_id
required

The ident of an expense

string
Responses
HTTP Code Description Schema

200

Expense successfully refused

string
Consumes

  • application/json

Produces

  • application/json

2.3.33. Get the list of the fiscal power

POST /fiscal-power/search
Description

Search fiscal power

Parameters
Type Name Description Schema

Body

criteria
required

The criteria

FiscalPowerCriteria
Responses
HTTP Code Description Schema

200

fiscal power successfully loaded

< FiscalPower > array
Consumes

  • application/json

Produces

  • application/json

2.4. Fluent

Fluent Api for Employees Management

2.4.1. create an employee fluently

POST /fluent/employees
Description

create an employee fluently

Parameters
Type Name Description Schema

Body

employeesFluent
required

The employee to be created

EmployeeFluent
Responses
HTTP Code Description Schema

200

successful creation

string
Consumes

  • application/json

Produces

  • application/json

2.4.2. update an employee fluently

PUT /fluent/employees/{employee_code}
Description

update an employee fluently

Parameters
Type Name Description Schema

Path

employee_code
required

the code a the Employee to update

string

Body

employeesFluent
required

The employeeFluent to update

EmployeeFluent
Responses
HTTP Code Description Schema

200

successful update

string
Consumes

  • application/json

Produces

  • application/json

2.4.3. update an employee history fluently

POST /fluent/employees/{employee_code}/history
Description

update an employee history fluently

Parameters
Type Name Description Schema

Path

employee_code
required

the code a the Employee to update

string

Query

from
optional

date

string (date-time)

Body

history
required

The employee to be updated

EmployeeHistoryFluent
Responses
HTTP Code Description Schema

200

successful history update

string
Consumes

  • application/json

Produces

  • application/json

2.4.4. create a schedule fluently

POST /fluent/schedule
Description

Create a schedule fluently

Parameters
Type Name Description Schema

Body

schedule
optional

search criteria

ScheduleFluent
Responses
HTTP Code Description Schema

200

creation successful

string
Consumes

  • application/json

Produces

  • application/json

2.4.5. delete the list of the schedule fluently

DELETE /fluent/schedule
Description

Delete the list of the schedule fluently

Parameters
Type Name Description Schema

Query

from
optional

Filtering Schedule from this date

string (date-time)

Query

to
optional

Filtering Schedule to this date

string (date-time)

Body

criteria
required

The criteria

ScheduleCriteriaFluent
Responses
HTTP Code Description Schema

200

delete successful

string
Consumes

  • application/json

Produces

  • application/json

2.5. Leaves

Leaves Management

2.5.1. Retrieve my leave rights

GET /leave-rights/mine
Description

Retrieve my leave rights

Responses
HTTP Code Description Schema

200

My Leave Rights

< LeaveRight > array
Produces

  • application/json

2.5.2. create a leave

PUT /leaves
Description

create a leave

Parameters
Type Name Description Schema

Body

leave
required

The leave to be created

Leave
Responses
HTTP Code Description Schema

200

id of the Leaves successfully created

string
Consumes

  • application/json

Produces

  • application/json

2.5.3. for test only, to remove

GET /leaves/mine
Description

for test only, to remove

Responses
HTTP Code Description Schema

200

My Leaves

< Leave > array
Produces

  • application/json

2.5.4. search leaves

POST /leaves/search
Description

search leaves

Parameters
Type Name Description Schema

Body

criteria
optional

search criteria

LeaveCriteria
Responses
HTTP Code Description Schema

200

Leaves meeting the search criteria

< Leave > array
Consumes

  • application/json

Produces

  • application/json

2.5.5. Update a leave

POST /leaves/{leave_id}
Description

Update a leave

Parameters
Type Name Description Schema

Path

leave_id
required

The id of the leave

string

Body

leave
required

The leave to be updated

Leave
Responses
HTTP Code Description Schema

200

id of the Leave successfully created

string
Consumes

  • application/json

Produces

  • application/json

2.5.6. Get a leave

GET /leaves/{leave_id}
Description

Get a leave

Parameters
Type Name Description Schema

Path

leave_id
required

The id of the leave

string
Responses
HTTP Code Description Schema

200

Leave having this id

Leave
Produces

  • application/json

2.5.7. Delete a leave

DELETE /leaves/{leave_id}
Description

Delete a leave

Parameters
Type Name Description Schema

Path

leave_id
required

The id of the leave

string
Responses
HTTP Code Description Schema

200

successful delete

No Content
Produces

  • application/json

2.5.8. Cancel a leave

POST /leaves/{leave_id}/cancel
Description

Cancel a leave

Parameters
Type Name Description Schema

Path

leave_id
required

The id of the leave

string
Responses
HTTP Code Description Schema

200

successful Cancel

No Content
Produces

  • application/json

2.6. Quick Entries Issue

Quick Entries Issue Management

2.7. Quick Entries Time

Quick Entries Time Management

2.7.1. Search My Quick Entries Time

GET /timerecordings/quick-entries-time/search-mine
Description

Search My Quick Entries Time

Responses
HTTP Code Description Schema

200

My QuickEntriesTime

< QuickEntryTime > array
Produces

  • application/json

2.8. Schedules

Schedules Management

2.8.1. create a schedule fluently

POST /fluent/schedule
Description

Create a schedule fluently

Parameters
Type Name Description Schema

Body

schedule
optional

search criteria

ScheduleFluent
Responses
HTTP Code Description Schema

200

creation successful

string
Consumes

  • application/json

Produces

  • application/json

2.8.2. delete the list of the schedule fluently

DELETE /fluent/schedule
Description

Delete the list of the schedule fluently

Parameters
Type Name Description Schema

Query

from
optional

Filtering Schedule from this date

string (date-time)

Query

to
optional

Filtering Schedule to this date

string (date-time)

Body

criteria
required

The criteria

ScheduleCriteriaFluent
Responses
HTTP Code Description Schema

200

delete successful

string
Consumes

  • application/json

Produces

  • application/json

2.8.3. create a schedule

POST /schedules
Description

Create a schedule

Parameters
Type Name Description Schema

Body

schedule
optional

schedule to create

Schedule
Responses
HTTP Code Description Schema

200

creation successful

string
Consumes

  • application/json

Produces

  • application/json

2.8.4. delete the list of the schedule

DELETE /schedules
Description

Delete the list of the schedule

Parameters
Type Name Description Schema

Query

from
optional

Filtering Schedule from this date

string (date-time)

Query

to
optional

Filtering Schedule to this date

string (date-time)

Body

criteria
required

The criteria

ScheduleCriteria
Responses
HTTP Code Description Schema

200

delete successful

string
Consumes

  • application/json

Produces

  • application/json

2.8.5. Search Schedule

POST /schedules/search
Description

Search Schedule

Parameters
Type Name Description Schema

Query

from
optional

Filtering times from this date

string (date-time)

Query

to
optional

Filtering times to this date

string (date-time)

Body

criteria
required

The criteria

ScheduleCriteria
Responses
HTTP Code Description Schema

200

Schedule meeting the search criteria

< Schedule > array
Produces

  • application/json

2.8.6. Retrieve schedule

GET /schedules/{schedule_id}
Description

Retrieve schedule

Parameters
Type Name Description Schema

Path

schedule_id
required

The id of the schedule

string
Responses
HTTP Code Description Schema

200

Schedule having this id

Schedule
Produces

  • application/json

2.9. Timerecordings

Timerecordings Management

2.9.1. Retrieve approvals

GET /approvals
Description

Retrieve approvals

Responses
HTTP Code Description Schema

200

Approvals having this id

< Approval > array
Produces

  • application/json

2.9.2. Retrieve approvals without refuse

GET /approvals-without-refuse
Description

Retrieve approvals without refuse

Responses
HTTP Code Description Schema

200

Approvals Without Refuse

< Approval > array
Produces

  • application/json

2.9.3. Get the list of the timerecording terminations of an employee

GET /employees/{employee_id}/timerecording-terminations
Description

Get the list of the timerecording terminations of an employee

Parameters
Type Name Description Schema

Path

employee_id
required

The id of the employee

string

Query

from
optional

Filtering times from this date

string (date-time)

Query

to
optional

Filtering times to this date

string (date-time)
Responses
HTTP Code Description Schema

200

TimeRecording Terminations Of Employee

< TimeRecordingTermination > array
Produces

  • application/json

2.9.4. Get the list of the timerecording terminations of the employees for a given manager

GET /managers/{manager_id}/employees/timerecording-terminations
Description

Get the list of the timerecording terminations of the employees for a given manager

Parameters
Type Name Description Schema

Path

manager_id
required

The id of the manager

string

Query

from
optional

Filtering times from this date

string (date-time)

Query

to
optional

Filtering times to this date

string (date-time)
Responses
HTTP Code Description Schema

200

TimeRecording terminations of Employees for a given Manager

< TimeRecordingTermination > array
Produces

  • application/json

2.9.5. Get the list of the timerecordings of the employees of the manager

GET /managers/{manager_id}/employees/timerecordings
Description

Get the list of the timerecordings of the employees of the manager

Parameters
Type Name Description Schema Default

Path

manager_id
required

The id of the manager

string

Query

from
optional

Filtering times from this date

string (date-time)

Query

to
optional

Filtering times to this date

string (date-time)

Query

unit
optional

unit of duration

string

"MINUTE"
Responses
HTTP Code Description Schema

200

Timerecordings meeting the criteria

< TimeRecording > array
Produces

  • application/json

2.9.6. Add a duration on this referential

POST /timerecordings/add
Description

Add a duration on this referential

Parameters
Type Name Description Schema

Body

timerecording
required

The timerecording which contains the duration, date and data referential

TimeRecording
Responses
HTTP Code Description Schema

200

TimeRecording successfully added

No Content
Consumes

  • application/json

Produces

  • application/json

2.9.7. Cancel validation of time recordings

POST /timerecordings/cancel-validation
Description

Cancel validation of time recordings

Parameters
Type Name Description Schema

Body

idents
optional

Time recordings’s idents

< string > array
Responses
HTTP Code Description Schema

200

Number of TimeRecordings Canceled

integer
Consumes

  • application/json

Produces

  • application/json

2.9.8. get my timerecordings

GET /timerecordings/mine
Description

get my timerecordings

Parameters
Type Name Description Schema

Query

from
optional

Filtering my timerecordings from this date

string (date-time)

Query

to
optional

Filtering my timerecordings to this date

string (date-time)
Responses
HTTP Code Description Schema

200

My TimeRecording

< TimeRecording > array
Produces

  • application/json

2.9.9. Search My Quick Entries Time

GET /timerecordings/quick-entries-time/search-mine
Description

Search My Quick Entries Time

Responses
HTTP Code Description Schema

200

My QuickEntriesTime

< QuickEntryTime > array
Produces

  • application/json

2.9.10. Refuse time recordings

POST /timerecordings/refuse
Description

Refuse time recordings

Parameters
Type Name Description Schema

Body

approvalValidation
optional

Refuse type and time recordings’s idents

ApprovalValidation
Responses
HTTP Code Description Schema

200

number of TimeRecordings Refused

integer
Consumes

  • application/json

Produces

  • application/json

2.9.11. Replace all existing durations by a new duration on this referential

POST /timerecordings/replace
Description

Replace all existing durations by a new duration on this referential

Parameters
Type Name Description Schema

Body

timerecording
required

The timerecording which contains the duration, date and data referential

TimeRecording
Responses
HTTP Code Description Schema

200

TimeRecording successfully replaced

No Content
Consumes

  • application/json

Produces

  • application/json

2.9.12. Remove all existing durations on this referential

POST /timerecordings/reset
Description

Remove all existing durations on this referential

Parameters
Type Name Description Schema

Body

timerecording
required

The timerecording which contains the duration, date and data referential

TimeRecording
Responses
HTTP Code Description Schema

200

TimeRecording successfully reset

No Content
Consumes

  • application/json

Produces

  • application/json

2.9.13. Search TimeRecording

POST /timerecordings/search
Description

Search TimeRecording

Parameters
Type Name Description Schema Default

Query

unit
optional

unit of duration

string

"UNIT_OF_EMPLOYEE"

Body

criteria
required

The criteria

TimeRecordingCriteria
Responses
HTTP Code Description Schema

200

Timerecordings meeting the criteria

< TimeRecording > array
Produces

  • application/json

2.9.14. Notify by email employees with incomplete time recordings

POST /timerecordings/send
Description

Notify by email employees with incomplete time recordings

Parameters
Type Name Description Schema

Body

criteria
required

The criteria

TimeRecordingCriteria
Responses
HTTP Code Description Schema

200

Number of sent emails

integer
Consumes

  • application/json

Produces

  • application/json

2.9.15. add termination

POST /timerecordings/termination/add
Description

add a termination. Depending on the management rule TPS_TERMINAISON, the termination is on a month or on a week

Parameters
Type Name Description Schema

Body

termination
required

The TimeRecordingTermination

TimeRecordingTermination
Responses
HTTP Code Description Schema

200

successful operation, return the id of the created TimeRecordingTermination

string
Consumes

  • application/json

Produces

  • application/json

2.9.16. cancel termination

POST /timerecordings/termination/cancel
Description

cancel termination

Parameters
Type Name Description Schema

Body

ids
optional

timerecordingTermination ids

< string > array
Responses
HTTP Code Description Schema

200

Termination canceled

No Content
Consumes

  • application/json

Produces

  • application/json

2.9.17. Validate time recordings

POST /timerecordings/validate
Description

Validate time recordings

Parameters
Type Name Description Schema

Body

approvalValidation
optional

Approval type and time recordings’s idents

ApprovalValidation
Responses
HTTP Code Description Schema

200

number of TimeRecordings Validated

integer
Consumes

  • application/json

Produces

  • application/json

3. Definitions

3.1. Ability

ability

Name Schema

level
optional

AbilityLevel

skill
optional

Skill

3.2. AbilityLevel

level of expertise of an employee an a specific ability

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

code
optional

string

id
required

Id in database

string

name
optional

string

3.3. AccountingJournal

Accounting Journal

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

code
optional

Code of the accounting journal
Example : "ACC"

string

id
required

Id in database

string

name
optional

Name of the accounting journal
Example : "Accounting Journal"

string

type
optional

Details about the journal type

JournalType

3.4. Action

Verb of the request to specify which type of action you will send.

Type : enum (ADD, UPDATE, REMOVE)

3.5. ActionCode

Code of the Action

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

id
required

Id in database

string

name
optional

string

3.6. ActionCode2

ActionCode2

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

code
optional

string

id
required

Id in database

string

name
optional

string

3.7. ActiveModule

List of active modules

Type : enum (EXPENSE_REPORTS, TIMES_RECORDING, SCHEDULE, QUOTATION, SALES_ORDER, INVOICE, PURCHASE_ORDER, QUOTE, RECEPTION, PURCHASE_INVOICE)

3.8. Address

Address

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

cedex
optional

string

city
optional

string

country
optional

string

id
required

Id in database

string

line1
optional

string

line2
optional

string

line3
optional

string

postalCode
optional

string

3.9. Alert

Alert message

Name Schema

level
optional

enum (ERROR, WARNING, INFO)

message
optional

string

3.10. AnalysisResult

AnalysisResult

Name Schema

date
optional

string (date-time)

group
optional

< string, object > map

value
optional

number (double)

3.11. ApplicationControlBase

Application control

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

code
optional

string

id
required

Id in database

string

info1
optional

string

info2
optional

string

info3
optional

string

info4
optional

string

info5
optional

string

3.12. Approval

Approval

Name Schema

code
optional

string

ident
optional

string

name
optional

string

order
optional

integer

3.13. ApprovalValidation

ApprovalValidation

Name Schema

approval
optional

Approval

idents
optional

< string > array

reason
optional

string

3.14. Assignment

Assignment (affectation)

Polymorphism : Composition

Name Schema

customer
optional

CustomerBase

customerId
optional

string

phase
optional

PhaseBase

phaseId
optional

string

project
optional

ProjectBase

projectId
optional

string

projectTask
optional

ProjectTaskBase

projectTaskId
optional

string

subPhase
optional

SubPhaseBase

subPhaseId
optional

string

3.15. AssignmentCriteria

AssignmentCriteria

Name Description Schema

customerId
optional

ClauseString

divisionGroupId
optional

ClauseString

divisionId
optional

ClauseString

employeeId
optional

string

entityId
optional

ClauseString

lowerAssignmentType
optional

Define the leaf node type when searching an assignment tree. If not set, default leaf node type is SUBPHASE or PROJECT_TASK according to the selected ActiveModule.

AssignmentType

phaseCode
optional

ClauseString

phaseId
optional

ClauseString

projectClosed
optional

ClauseBoolean

projectId
optional

ClauseString

projectTaskId
optional

ClauseString

referentialDate
optional

string (date-time)

subPhaseCode
optional

ClauseString

subPhaseId
optional

ClauseString

tag
optional

ClauseString

upperAssignmentType
optional

Define the root node type when searching an assignment tree. If not set, default root node type is CUSTOMER

AssignmentType

3.16. AssignmentNode

Assignement

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

additionalProperties
optional

functional properties (map<String, string>) of this node

< string, string > map

assignments
optional

Example : "see AssignmentNode"

< AssignmentNode > array

code
optional

string

description
optional

string

id
required

Id in database

string

longDescription
optional

string

parentId
optional

string

parentType
optional

AssignmentType

selectable
optional

boolean

type
optional

AssignmentType

3.17. AssignmentType

Type of Assignment

Type : enum (CUSTOMER, PROJECT, PHASE, SUBPHASE, PROJECT_TASK, DIVISION, DIVISION_GROUP, ENTITY, COMPANY)

3.18. Avatar

Entity avatar

Name Schema

content
optional

string

3.19. AxeCriteria

AxeCriteria

Name Schema

axeType
required

string

customerAccountManagerId
optional

ClauseString

customerAccountManagerSupervisorId
optional

ClauseString

customerCountryId
optional

ClauseString

customerFamilyId
optional

ClauseString

customerGrouping1
optional

ClauseString

customerGrouping2
optional

ClauseString

customerId
optional

ClauseString

customerRegionId
optional

ClauseString

customerSalesmanId
optional

ClauseString

customerSalesmanSupervisorId
optional

ClauseString

customerSectorId
optional

ClauseString

customerState
optional

ClauseString

customerSubFamilyId
optional

ClauseString

groupCustomer
optional

ClauseBoolean

phaseId
optional

ClauseString

projectActivityId
optional

ClauseString

projectCampaignId
optional

ClauseString

projectCompanyCode
optional

ClauseString

projectDepartmentId
optional

ClauseString

projectDivisionGroupId
optional

ClauseString

projectDivisionId
optional

ClauseString

projectEstablishmentId
optional

ClauseString

projectFamilyId
optional

ClauseString

projectFinancialManagerId
optional

ClauseString

projectId
optional

ClauseString

projectManagerId
optional

ClauseString

projectMarketId
optional

ClauseString

projectProductionManagerId
optional

ClauseString

projectSalesManagerId
optional

ClauseString

projectState
optional

ClauseString

projectSubFamily2Id
optional

ClauseString

projectSubFamilyId
optional

ClauseString

projectVintageId
optional

ClauseString

prospect
optional

ClauseBoolean

subPhaseId
optional

ClauseString

3.20. AxeGroups

AxeGroups

Type : < AxeGroupsType > array

3.21. AxeGroupsType

AxeGroupsType

Type : enum (PROJECT_ID, PROJECT_NAME, PROJECT_COMPANY_CODE, PROJECT_DIVISION_GROUP_ID, PROJECT_DIVISION_GROUP_NAME, PROJECT_DIVISION_ID, PROJECT_DIVISION_NAME, PROJECT_ESTABLISHMENT_ID, PROJECT_ESTABLISHMENT_NAME, PROJECT_ACTIVITY_ID, PROJECT_ACTIVITY_NAME, PROJECT_DEPARTMENT_ID, PROJECT_DEPARTMENT_NAME, PROJECT_FAMILY_ID, PROJECT_FAMILY_CODE, PROJECT_SUB_FAMILY_ID, PROJECT_SUB_FAMILY_CODE, PROJECT_SUB_FAMILY2_ID, PROJECT_SUB_FAMILY2_CODE, PROJECT_VINTAGE_ID, PROJECT_VINTAGE_CODE, PROJECT_MANAGER_ID, PROJECT_MANAGER_CODE, PROJECT_SALES_MANAGER_ID, PROJECT_SALES_MANAGER_CODE, PROJECT_FINANCIAL_MANAGER_ID, PROJECT_FINANCIAL_MANAGER_CODE, PROJECT_PRODUCTION_MANAGER_ID, PROJECT_PRODUCTION_MANAGER_CODE, PROJECT_CAMPAIGN_ID, PROJECT_CAMPAIGN_CODE, PROJECT_STATE, PROJECT_MARKET_ID, PROJECT_MARKET_CODE, PROJECT_MARKET_NAME, PHASE_ID, PHASE_CODE, PHASE_NAME, SUB_PHASE_ID, SUB_PHASE_CODE, SUB_PHASE_NAME, CUSTOMER_ID, CUSTOMER_CODE, CUSTOMER_NAME, CUSTOMER_FAMILY_ID, CUSTOMER_FAMILY_CODE, CUSTOMER_SUB_FAMILY_ID, CUSTOMER_SUB_FAMILY_CODE, CUSTOMER_GROUPING_1, CUSTOMER_GROUPING_2, CUSTOMER_SECTOR_ID, CUSTOMER_SECTOR_CODE, CUSTOMER_STATE, CUSTOMER_COUNTRY_ID, CUSTOMER_COUNTRY_NAME, CUSTOMER_COUNTRY_CODE, CUSTOMER_REGION_ID, CUSTOMER_REGION_CODE, CUSTOMER_ACCOUNT_MANAGER_ID, CUSTOMER_ACCOUNT_MANAGER_CODE, CUSTOMER_SALES_MAN_ID, CUSTOMER_SALES_MAN_CODE, CUSTOMER_ACCOUNT_MANAGER_SUPERVISOR_ID, CUSTOMER_ACCOUNT_MANAGER_SUPERVISOR_CODE, CUSTOMER_SALES_MAN_SUPERVISOR_ID, CUSTOMER_SALES_MAN_SUPERVISOR_CODE, CUSTOMER_PROSPECT, CUSTOMER_OPENING_DATE, CUSTOMER_PROFESSION, CUSTOMER_PROFESSIONAL_CATEGORY)

3.22. BusinessCard

Business card (Carte entreprise)

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

cardNumber
optional

string

employeeId
optional

string

encryptedCardNumber
optional

string

endDate
optional

string (date-time)

id
required

Id in database

string

name
optional

string

type
optional

BusinessCardType

3.23. BusinessCardCriteria

BusinessCardCriteria

Name Schema

employeeId
optional

ClauseString

encryptedCardNumber
optional

ClauseString

endDate
optional

ClauseDate

id
optional

ClauseString

name
optional

ClauseString

type
optional

ClauseString

3.24. BusinessCardType

Type of Business Card

Type : enum (EMPLOYEE_ACCOUNT, BUSINESS_ACCOUNT)

3.25. BusinessDocument

businessDocument (pièce de gestion)

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

accountingJournalId
optional

ID of Accounting Journal
Example : "1203"

string

afterTaxAmount
optional

After-Tax Amount
Example : 120.37

number (double)

changeTracking
optional

Date and user in case of creation and modification

ChangeTracking

comment
optional

Comment
Example : "Lorem ipsum"

string

companyCode
optional

The company code
Example : "AKSAS"

string

currency
optional

All details about the currency

Currency

currencyCode
optional

Code of the currency used in the document
Example : "EUR"

string

date
optional

Date on the business document
Example : "2020-11-29T08:10:10+200"

string (date-time)

description
optional

Description
Example : "Lorem ipsum"

string

entityCode
optional

The entity code
Example : "Lyon"

string

id
required

Id in database

string

manager
optional

Manager details

EmployeeBase

managerId
optional

Id of the manager
Example : "500001"

string

name
optional

Name of the business document
Example : "Label for my doc"

string

number
optional

The number of the business document
Example : "CC00001"

string

payment
optional

Payment

Payment

phase
optional

Details about the phase of the project.

PhaseBase

phaseId
optional

The Id of the phase
Example : "500000123"

string

preTaxAmount
optional

Pre-Tax Amount
Example : 100.14

number (double)

project
optional

All details about the project

ProjectBase

projectId
optional

The code of the project
Example : "PRJT_001"

string

projectedApprovalDate
optional

Project approval date
Example : "2013-10-02T08:10:10+200"

string (date-time)

subPhase
optional

Details about the sub-phase of the project

SubPhaseBase

subPhaseId
optional

The Id of the sub-phase
Example : "51000122"

string

text
optional

Text on document
Example : "Lorem ipsum"

string

thirdPartyId
optional

The Id of the third-party
Example : "CUSTOMER01"

string

thirdPartyToBillId
optional

The Id of the third-party to bill
Example : "CUSTOMER02"

string

type
optional

Type of the business document
Example: Quotations, Orders, Invoices…

BusinessDocumentType

3.26. BusinessDocumentLine

BusinessDocumentLine (ligne de pièce de gestion)

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

amountTotal
optional

Total amount in euro
Example : 1200.0

number (double)

amountTotalCurrency
optional

Total amount in the currency
Example : 1200.0

number (double)

complementName
optional

Description of the line
Example : "Lorem ipsum"

string

generalAccount
optional

General Account
Example : "411000"

string

id
required

Id in database

string

name
optional

Name of the line
Example : "Helpdesk"

string

phase
optional

Details about the phase of the project.

PhaseBase

phaseId
optional

The Id of the phase
Example : "500000123"

string

project
optional

All details about the project

ProjectBase

projectId
optional

The code of the project
Example : "PRJT_001"

string

quantity
optional

Quantity of the sold product
Example : 3.0

number (double)

rankNumber
optional

Rank number of the line
Example : 2.0

number (double)

subPhase
optional

Details about the sub-phase of the project

SubPhaseBase

subPhaseId
optional

The Id of the sub-phase
Example : "51000122"

string

unitPrice
optional

Unit price of the sold product in euro
Example : 40.0

number (double)

unitPriceCurrency
optional

Unit price of the sold product in the currency
Example : 36.32

number (double)

3.27. BusinessDocumentSalesLine

BusinessDocumentSalesLine (ligne de pièce de gestion vente)

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

amountTotal
optional

Total amount in euro
Example : 1200.0

number (double)

amountTotalCurrency
optional

Total amount in the currency
Example : 1200.0

number (double)

complementName
optional

Description of the line
Example : "Lorem ipsum"

string

discount
optional

Total discount amount (on the line) in currency

number (double)

endDate
optional

Period end date
Example : "2020-12-21T00:00:00.000+0100"

string (date-time)

exchangeRate
optional

Details about the exchange rate

ExchangeRate

generalAccount
optional

General Account
Example : "411000"

string

id
required

Id in database

string

item
optional

Details about the item

Item

itemId
optional

The Id of the sold product
Example : "10727"

string

name
optional

Name of the line
Example : "Helpdesk"

string

phase
optional

Details about the phase of the project.

PhaseBase

phaseId
optional

The Id of the phase
Example : "500000123"

string

project
optional

All details about the project

ProjectBase

projectId
optional

The code of the project
Example : "PRJT_001"

string

projectTask
optional

Details about the project task.

ProjectTaskBase

projectTaskId
optional

Id of the project task
Example : "5423001"

string

quantity
optional

Quantity of the sold product
Example : 3.0

number (double)

rankNumber
optional

Rank number of the line
Example : 2.0

number (double)

startDate
optional

Period start date
Example : "2020-12-21T00:00:00.000+0100"

string (date-time)

subPhase
optional

Details about the sub-phase of the project

SubPhaseBase

subPhaseId
optional

The Id of the sub-phase
Example : "51000122"

string

unitPrice
optional

Unit price of the sold product in euro
Example : 40.0

number (double)

unitPriceCurrency
optional

Unit price of the sold product in the currency
Example : 36.32

number (double)

vat1
optional

Details about the first VAT rate

VATBase

vat2
optional

Details about the second VAT rate

VATBase

vatAmount1
optional

Amount in euro with the first VAT
Example : 120.0

number (double)

vatAmount1Currency
optional

Amount in currency for the first VAT
Example : 126.57

number (double)

vatAmount2
optional

Amount in euro for the second VAT
Example : 110.0

number (double)

vatAmount2Currency
optional

Amount in currency for the second VAT
Example : 113.26

number (double)

3.28. BusinessDocumentType

Type of the business document

Type : enum (QUOTATION, SALES_ORDER, QUOTE, PURCHASE_ORDER, CUSTOM_REQUEST, PURCHASE_INVOICE, EXPENSE_REPORT, INVOICE, SALES_BILLING_TABLE, PURCHASE_BILLING_TABLE, RECEPTION)

3.29. BusinessReferential

businessReferential

Polymorphism : Composition

Name Description Schema

phase
optional

Details about the phase of the project.

PhaseBase

phaseId
optional

The Id of the phase
Example : "500000123"

string

project
optional

All details about the project

ProjectBase

projectId
optional

The code of the project
Example : "PRJT_001"

string

subPhase
optional

Details about the sub-phase of the project

SubPhaseBase

subPhaseId
optional

The Id of the sub-phase
Example : "51000122"

string

3.30. CalendarEvent

CalendarEvent

Polymorphism : Inheritance
Discriminator : type

Name Description Schema

actionCode
optional

ActionCode

actionCodeId
optional

string

changeTracking
optional

Creation and modification date and user

ChangeTracking

comment
optional

string

customer
optional

CustomerBase

customerId
optional

string

date
optional

string (date-time)

duration
optional

duration in unit asked (dft Unit of presentation of employee)

number (double)

employee
optional

EmployeeBase

employeeId
optional

string

guid
optional

string

id
required

Id in database

string

phase
optional

PhaseBase

phaseId
optional

string

place
optional

string

project
optional

ProjectBase

projectId
optional

string

projectTask
optional

ProjectTaskBase

projectTaskId
optional

string

subPhase
optional

SubPhaseBase

subPhaseId
optional

string

type
required

string

unit
optional

Unit of duration (dft Unit of presentation of employee)

UnitDuration

validated
optional

boolean

3.31. CalendarEventRules

CalendarEventRules

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

allowManualEntry
optional

Autorise ou non la saisie manuelle de la durée, si non, seule la saisie via le range de valeurs sera autorisée

boolean

base
optional

Base de calcul permettant de déduire la valeur max de décimal autorisé (ex: 60, 100) et permettant d’effectuer d’autres calculs sur les temps de manière dynamique

number (double)

closingDates
optional

Dates d’arrêté pour les temps et les plannings

< ClosingDate > array

employeeId
optional

string

employeeWeeks
optional

Semaines types du collaborateur

< EmployeeWeek > array

id
required

Id in database

string

max
optional

Borne maximale exclue de saisie d’une durée

number (double)

min
optional

Borne minimale exclue de saisie d’une durée

number (double)

prettyStep
optional

Pas d’incrémentation graphique d’une durée

number (double)

step
optional

Précision d’une durée, utile pour connaître le pas d’incrémentation

number (double)

unit
optional

Code de l’unité de présentation (cf com.itnsa.fwk.util.temps.UniteDePresentation)

string

unitDuration
optional

Unité de présentation (cf com.itnsa.fwk.util.temps.UniteDePresentation)

UnitDuration

3.32. Category

Category

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

code
optional

The code of the category
Example : "LANG"

string

companyCode
optional

The code of the company
Example : "AKSAS"

string

endDate
optional

End date for using the category of the sold product
Example : "2020-10-29T08:10:10+200"

string (date-time)

id
required

Id in database

string

name
optional

The name of the category
Example : "Language"

string

type
optional

Type of the category.

CategoryType

3.33. CategoryType

Type of category

Type : enum (SALES_ITEM, PURCHASE_ITEM, PROJECT_CATEGORY, PROJECT_SUB_CATEGORY, PROJECT_SUB_CATEGORY_LEVEL2)

3.34. ChangeTracking

History of all changes made

Name Description Schema

createdBy
optional

Code of the creator (user)

UserBase

createdById
optional

Id of the creator (user)
Example : "510034"

string

createdTime
optional

Creation Date
Example : "2020-08-19T08:10:10+200"

string (date-time)

modificationBy
optional

Code of the user who did the modification

UserBase

modificationById
optional

Id of the user who did the modification
Example : "510034"

string

modificationTime
optional

Date of the modification.
Example : "2020-10-29T08:10:10+200"

string (date-time)

3.35. Clause

Basic clause type

Name Description Schema

operator
required

The operator for your operation.

ClauseOperation

value
required

object

3.36. ClauseBoolean

Boolean clause type

Polymorphism : Inheritance
Discriminator : operator

Name Description Schema

operator
required

The operator for your operation.

ClauseOperation

value
required

boolean

3.37. ClauseDate

String clause type

Polymorphism : Inheritance
Discriminator : operator

Name Description Schema

operator
required

The operator for your operation.

ClauseOperation

value
required

string (date-time)

3.38. ClauseDouble

Double clause type

Polymorphism : Inheritance
Discriminator : operator

Name Description Schema

operator
required

The operator for your operation.

ClauseOperation

value
required

number

3.39. ClauseOperation

Operation used by the clause

Type : enum (LIKE, IS, IS_NOT, IN, IS_NULL, IS_NOT_NULL, CLAUSES, GREATER_OR_EQUALS, GREATER, LOWER_OR_EQUALS, LOWER)

3.40. ClauseString

String clause type

Polymorphism : Inheritance
Discriminator : operator

Name Description Schema

operator
required

The operator for your operation.

ClauseOperation

value
required

The value you search.
Example : "Customer"

string

3.41. ClosingDate

ClosingDate

Name Schema

beginningOfPeriod
optional

string (date-time)

closingDate
optional

string (date-time)

endOfPeriod
optional

string (date-time)

module
optional

string

3.42. ColorCodes

ColorCodes

Name Schema

color1
optional

string

color2
optional

string

color3
optional

string

3.43. Command

Command

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

endDate
optional

string (date-time)

error
optional

string

id
required

Id in database

string

progress
optional

CommandProgress

result
optional

string

startDate
optional

string (date-time)

status
optional

enum (STARTED, NOT_STARTED, FINISHED, UNKNOWN, ERROR)

3.44. CommandProgress

Command progress status

Name Schema

current
optional

integer

max
optional

integer

3.45. Company

Company (Société)

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

code
optional

string

id
required

Id in database

string

legalName
optional

string

name
optional

string

3.46. CompanyBase

Company (Société)

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

code
optional

string

id
required

Id in database

string

name
optional

string

3.47. ContactBase

contact

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

code
optional

string

firstName
optional

string

id
required

Id in database

string

name
optional

string

3.48. Contract

Contract (contrat)

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

code
optional

string

endDate
optional

string (date-time)

id
required

Id in database

string

name
optional

string

phaseId
optional

string

projectId
optional

string

reminderAlert
optional

string

reminderDetail
optional

string

subPhaseId
optional

string

terminationDate
optional

string (date-time)

3.49. ContractService

ContractService (prestation)

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

code
optional

string

contract
optional

Contract

contractId
optional

string

criticalityId
optional

string

id
required

Id in database

string

issueTypeId
optional

string

name
optional

string

phaseId
optional

string

priorityId
optional

string

projectId
optional

string

regression
optional

boolean

reminderAlert
optional

string

reminderDetail
optional

string

severityId
optional

string

subPhaseId
optional

string

teamId
optional

string

3.50. ControlBehavior

Field control behavior

Name Schema

defaultValue
optional

object

enabled
optional

boolean

property
optional

string

required
optional

boolean

visible
optional

boolean

3.51. Currency

Currency

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

code
optional

Code of the currency
Example : "EUR"

string

endDate
optional

End date for using the currency
Example : "2022-12-31T08:10:10+200"

string (date-time)

euro
optional

Returns true if the currency is in euro
Example : true

boolean

euroRate
optional

Euro exchange rate
Example : 0.9678

number (double)

id
required

Id in database

string

name
optional

Name of the currency
Example : "Euro"

string

order
optional

order number of the currency
Example : 17

integer

3.52. CustomField

Custom data

Name Description Schema

name
optional

Name of the custom data
Example : "Reference 4"

string

type
optional

Type of the custom data

CustomFieldType

value
optional

Value of the custom data
Example : "Autoref 010520"

object

3.53. CustomFieldParam

Description of a parameter of custom field

Name Schema

id
optional

string

keywordId
optional

string

multiLine
optional

boolean

name
optional

string

order
optional

integer (int32)

property
optional

string

realOrder
optional

integer (int32)

sequence
optional

integer (int32)

textLimit
optional

integer (int32)

type
optional

CustomFieldType

3.54. CustomFieldType

Type of the CustomField

Type : enum (NUMBER, DATE, BOOLEAN, ALPHANUMERIC)

3.55. CustomRequest

CustomRequest

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

accountingJournalId
optional

ID of Accounting Journal
Example : "1203"

string

afterTaxAmount
optional

After-Tax Amount
Example : 120.37

number (double)

arrivalActualDate
optional

string (date-time)

arrivalDate
optional

string (date-time)

arrivalPlace
optional

string

category
optional

string

categoryId
optional

string

changeTracking
optional

Date and user in case of creation and modification

ChangeTracking

comment
optional

Comment
Example : "Lorem ipsum"

string

companyCode
optional

The company code
Example : "AKSAS"

string

currency
optional

All details about the currency

Currency

currencyCode
optional

Code of the currency used in the document
Example : "EUR"

string

customFields
optional

< string, CustomField > map

customer
optional

CustomerBase

customerId
optional

string

date
optional

Date on the business document
Example : "2020-11-29T08:10:10+200"

string (date-time)

departureActualDate
optional

string (date-time)

departureDate
optional

string (date-time)

departurePlace
optional

string

description
optional

Description
Example : "Lorem ipsum"

string

entityCode
optional

The entity code
Example : "Lyon"

string

id
required

Id in database

string

lines
optional

< CustomRequestLine > array

manager
optional

Manager details

EmployeeBase

managerId
optional

Id of the manager
Example : "500001"

string

name
optional

Name of the business document
Example : "Label for my doc"

string

number
optional

The number of the business document
Example : "CC00001"

string

payment
optional

Payment

Payment

phase
optional

Details about the phase of the project.

PhaseBase

phaseId
optional

The Id of the phase
Example : "500000123"

string

preTaxAmount
optional

Pre-Tax Amount
Example : 100.14

number (double)

project
optional

All details about the project

ProjectBase

projectId
optional

The code of the project
Example : "PRJT_001"

string

projectedApprovalDate
optional

Project approval date
Example : "2013-10-02T08:10:10+200"

string (date-time)

subPhase
optional

Details about the sub-phase of the project

SubPhaseBase

subPhaseId
optional

The Id of the sub-phase
Example : "51000122"

string

text
optional

Text on document
Example : "Lorem ipsum"

string

thirdPartyId
optional

The Id of the third-party
Example : "CUSTOMER01"

string

thirdPartyToBillId
optional

The Id of the third-party to bill
Example : "CUSTOMER02"

string

type
optional

Type of the business document
Example: Quotations, Orders, Invoices…

BusinessDocumentType

3.56. CustomRequestCriteria

CustomRequestCriteria

Name Schema

employeeId
optional

ClauseString

id
optional

ClauseString

name
optional

ClauseString

projectId
optional

ClauseString

3.57. CustomRequestLine

Custom request Line (Ligne de demande interne)

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

amountTotal
optional

Total amount in euro
Example : 1200.0

number (double)

amountTotalCurrency
optional

Total amount in the currency
Example : 1200.0

number (double)

complementName
optional

Description of the line
Example : "Lorem ipsum"

string

expenseTypeExpected
optional

ExpenseTypeExpected

expenseTypeExpectedId
optional

string

generalAccount
optional

General Account
Example : "411000"

string

id
required

Id in database

string

isExpenseReport
optional

boolean

name
optional

Name of the line
Example : "Helpdesk"

string

phase
optional

Details about the phase of the project.

PhaseBase

phaseId
optional

The Id of the phase
Example : "500000123"

string

project
optional

All details about the project

ProjectBase

projectId
optional

The code of the project
Example : "PRJT_001"

string

quantity
optional

Quantity of the sold product
Example : 3.0

number (double)

rankNumber
optional

Rank number of the line
Example : 2.0

number (double)

subPhase
optional

Details about the sub-phase of the project

SubPhaseBase

subPhaseId
optional

The Id of the sub-phase
Example : "51000122"

string

unitPrice
optional

Unit price of the sold product in euro
Example : 40.0

number (double)

unitPriceCurrency
optional

Unit price of the sold product in the currency
Example : 36.32

number (double)

3.58. CustomRequestReadOption

CustomRequestReadOption

Polymorphism : Inheritance
Discriminator : type

Name Schema

options
optional

< enum (CUSTOMER, PROJECT, PHASE, SUB_PHASE, CHANGE_TRACKING, CURRENCY, LINE, LINE_EXPENSE_TYPE_EXPECTED, LINE_PROJECT, LINE_PHASE, LINE_SUB_PHASE, CUSTOM_FIELDS) > array

type
required

string

3.59. CustomerBase

Customers

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

code
optional

Code of the customer
Example : "CUST_001"

string

id
required

Id in database

string

name
optional

Name of the customer
Example : "Customer number 1"

string

3.60. CustomerSiteBase

Customer Sites

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

customerId
optional

Code of the associated customer
Example : "CUST_001"

string

id
required

Id in database

string

name
optional

Name of the customer site
Example : "Paris"

string

3.61. CustomizableResources

Customizable resources (Ressources personnalisables)

Type : enum (ISSUE, OPPORTUNITY, OPPORTUNITY_LINE, CUSTOM_REQUEST, EVENT)

3.62. DateParamHolder

Date

Name Schema

date
optional

string (date-time)

3.63. DelegationModule

DelegationModule

Type : enum (SAISIE_TPS_PASSES, VALIDATION_ET_CONTROLE_DES_TEMPS, ACTIVITES_PAR_DEFAUT, DEMANDES_ABSENCE, NDF, APPROBATIONS)

3.64. Describable

Describable interface

Name Schema

description
optional

string

externalReport
optional

string

number
optional

string

title
optional

string

3.65. Division

Division

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

code
optional

string

id
required

Id in database

string

name
optional

string

serviceId
optional

string

3.66. DivisionGrouping

Division grouping

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

code
optional

string

id
required

Id in database

string

name
optional

string

serviceId
optional

string

3.67. Document

a document. It can be a file or a link

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

action
optional

Action

category1
optional

string

category2
optional

string

category3
optional

string

changeTracking
optional

Creation and modification date and user

ChangeTracking

classification
optional

string

companyId
optional

string

createdBy
optional

UserBase

createdById
optional

string

creationDate
optional

string (date-time)

documentType
optional

string

externalDMSUuid
optional

string

fileName
optional

string

fileUrl
optional

string

id
required

Id in database

string

lienUrl
optional

string

links
optional

< DocumentLink > array

original
optional

boolean

preview
optional

string

publicationDate
optional

string (date-time)

publishedBy
optional

UserBase

publishedById
optional

string

sysName
optional

string

title
optional

string

url
optional

string

version
optional

number (double)

versionId
optional

string

3.68. DocumentLink

a link between a document and any other object

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

document
optional

Document

documentId
optional

string

id
required

Id in database

string

objectId
optional

string

objectType
optional

LinkedObjectType

original
optional

boolean

3.69. DocumentVersion

DocumentVersion

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

classification
optional

string

id
required

Id in database

string

title
optional

string

3.70. DueDate

Due date (Echéance)

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

amount
optional

number (double)

currencyCode
optional

string

date
optional

string (date-time)

id
required

Id in database

string

invoiceId
optional

string

3.71. DueDateCriteria

DueDateCriteria

Name Schema

invoiceId
optional

ClauseString

3.72. DutiableLine

Tax Line

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

amountTotal
optional

Total amount in euro
Example : 1200.0

number (double)

amountTotalCurrency
optional

Total amount in the currency
Example : 1200.0

number (double)

complementName
optional

Description of the line
Example : "Lorem ipsum"

string

exchangeRate
optional

Details about the exchange rate

ExchangeRate

generalAccount
optional

General Account
Example : "411000"

string

id
required

Id in database

string

name
optional

Name of the line
Example : "Helpdesk"

string

phase
optional

Details about the phase of the project.

PhaseBase

phaseId
optional

The Id of the phase
Example : "500000123"

string

project
optional

All details about the project

ProjectBase

projectId
optional

The code of the project
Example : "PRJT_001"

string

quantity
optional

Quantity of the sold product
Example : 3.0

number (double)

rankNumber
optional

Rank number of the line
Example : 2.0

number (double)

subPhase
optional

Details about the sub-phase of the project

SubPhaseBase

subPhaseId
optional

The Id of the sub-phase
Example : "51000122"

string

unitPrice
optional

Unit price of the sold product in euro
Example : 40.0

number (double)

unitPriceCurrency
optional

Unit price of the sold product in the currency
Example : 36.32

number (double)

vat1
optional

Details about the first VAT rate

VATBase

vat2
optional

Details about the second VAT rate

VATBase

vatAmount1
optional

Amount in euro with the first VAT
Example : 120.0

number (double)

vatAmount1Currency
optional

Amount in currency for the first VAT
Example : 126.57

number (double)

vatAmount2
optional

Amount in euro for the second VAT
Example : 110.0

number (double)

vatAmount2Currency
optional

Amount in currency for the second VAT
Example : 113.26

number (double)

3.73. Employee

Employee

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

action
optional

The action verb.

Action

businessCards
optional

< BusinessCard > array

candidate
optional

boolean

code
optional

Code of the employee
Example : "CASH"

string

customFields
optional

< string, CustomField > map

email
optional

string

employeeAbilities
optional

< EmployeeAbility > array

employeeFunctions
optional

EmployeeFunctions

employeeHistory
optional

< EmployeeHistory > array

external
optional

boolean

firstName
optional

First name of the employee
Example : "Jean"

string

id
required

Id in database

string

managerMultiCompany
optional

boolean

mobilePhone
optional

string

modeInputSchedule
optional

number (double)

modeTimeRecording
optional

number (double)

multiCompany
optional

boolean

name
optional

Name of the employee
Example : "DUPONT"

string

noTimesDunning
optional

boolean

number
optional

string

phone
optional

string

relations
optional

< Relation > array

scheduleRules
optional

ScheduleRules

timeRecordingRules
optional

TimeRecordingRules

title
optional

string

3.74. EmployeeAbility

ability of an employee

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

employeeId
optional

string

endDate
optional

string (date-time)

id
required

Id in database

string

level
optional

AbilityLevel

skill
optional

Skill

startDate
optional

string (date-time)

3.75. EmployeeBase

Employees

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

action
optional

The action verb.

Action

code
optional

Code of the employee
Example : "CASH"

string

firstName
optional

First name of the employee
Example : "Jean"

string

id
required

Id in database

string

name
optional

Name of the employee
Example : "DUPONT"

string

3.76. EmployeeCriteria

EmployeeCriteria

Name Schema

code
optional

ClauseString

excludeCandidate
optional

ClauseBoolean

excludeExternal
optional

ClauseBoolean

excludeGeneric
optional

ClauseBoolean

id
optional

ClauseString

managerId
optional

ClauseString

number
optional

ClauseString

onlyPresent
optional

ClauseBoolean

readOption
optional

EmployeeReadOption

relatedEmployeeId
optional

ClauseString

relationTypeId
optional

ClauseString

shouldBeNotified
optional

ClauseBoolean

tag
optional

ClauseString

teamId
optional

ClauseString

3.77. EmployeeFluent

EmployeeFluent

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

action
optional

The action verb.

Action

businessCards
optional

< BusinessCard > array

candidate
optional

boolean

code
optional

Code of the employee
Example : "CASH"

string

customFields
optional

< string, CustomField > map

email
optional

string

employeeAbilities
optional

< EmployeeAbility > array

employeeFunctions
optional

EmployeeFunctions

employeeHistory
optional

< EmployeeHistory > array

external
optional

boolean

firstName
optional

First name of the employee
Example : "Jean"

string

historiqueCollaborateur
optional

< EmployeeHistoryFluent > array

id
required

Id in database

string

managerMultiCompany
optional

boolean

mobilePhone
optional

string

modeInputSchedule
optional

number (double)

modeTimeRecording
optional

number (double)

multiCompany
optional

boolean

name
optional

Name of the employee
Example : "DUPONT"

string

noTimesDunning
optional

boolean

number
optional

string

phone
optional

string

relations
optional

< Relation > array

scheduleRules
optional

ScheduleRules

timeRecordingRules
optional

TimeRecordingRules

title
optional

string

3.78. EmployeeFunctions

EmployeeFunctions

Name Schema

allFunctions
optional

boolean

allOperational
optional

boolean

allPurchases
optional

boolean

allSales
optional

boolean

cMMSContractSalesManager
optional

boolean

cMMSContractTechnicalManager
optional

boolean

cMMSMRAndEOManager
optional

boolean

inputOfExpenseReport
optional

boolean

inputSchedule
optional

boolean

projectAccountManager
optional

boolean

projectAssignment
optional

boolean

projectFinanceManager
optional

boolean

projectPhaseManager
optional

boolean

projectProductionManager
optional

boolean

projectSalesManager
optional

boolean

projectSendOnMission
optional

boolean

purchasesReceptionTracking
optional

boolean

purchasingBuyer
optional

boolean

salesBillingSchedulesTracking
optional

boolean

salesOrderAndEstimateTracking
optional

boolean

salesSalesAssistant
optional

boolean

timeRecording
optional

boolean

3.79. EmployeeHistory

EmployeeHistory

Name Schema

code
optional

string

dailyCost
optional

number (double)

dailyHours
optional

number (double)

dailySellingPrice
optional

number (double)

directHourlyRate
optional

number (double)

employeeFamily1
optional

string

employeeFamily2
optional

string

employeeFamily3
optional

string

employeeHistoryType
required

string

employeeId
optional

string

entity
optional

string

from
optional

string (date-time)

leave
optional

boolean

managerId
optional

string

occupancyRate
optional

number (double)

position
optional

string

service
optional

string

skill
optional

string

standardHourlyRate
optional

number (double)

to
optional

string (date-time)

weekHours
optional

number (double)

3.80. EmployeeHistoryCriteria

EmployeeHistoryCriteria

Name Schema

employeeId
optional

ClauseString

from
optional

ClauseDate

managerId
optional

ClauseString

to
optional

ClauseDate

3.81. EmployeeHistoryFluent

EmployeeHistoryFluent

Polymorphism : Inheritance
Discriminator : employeeHistoryType

Name Schema

code
optional

string

dailyCost
optional

number (double)

dailyHours
optional

number (double)

dailySellingPrice
optional

number (double)

directHourlyRate
optional

number (double)

employeeFamily1
optional

string

employeeFamily1Code
optional

string

employeeFamily2
optional

string

employeeFamily2Code
optional

string

employeeFamily3
optional

string

employeeFamily3Code
optional

string

employeeHistoryType
required

string

employeeId
optional

string

entity
optional

string

entityCode
optional

string

from
optional

string (date-time)

leave
optional

boolean

managerCode
optional

string

managerId
optional

string

occupancyRate
optional

number (double)

position
optional

string

service
optional

string

serviceCode
optional

string

skill
optional

string

skillCode
optional

string

standardHourlyRate
optional

number (double)

to
optional

string (date-time)

weekHours
optional

number (double)

3.82. EmployeeReadOption

EmployeeReadOption

Polymorphism : Inheritance
Discriminator : type

Name Schema

options
optional

< enum (EMPLOYEE_HISTORY, CALENDAR_RULES, BUSINESS_CARDS, RELATED_EMPLOYEES, EMPLOYEE_ABILITIES, CUSTOM_FIELDS) > array

type
required

string

3.83. EmployeeWeek

EmployeeWeek

Name Schema

dailyHours
optional

number (double)

employeeId
optional

string

from
optional

string (date-time)

leave
optional

boolean

to
optional

string (date-time)

typicalDaysByWeekDay
optional

< string, typicalDaysByWeekDay > map

weekHours
optional

number (double)

typicalDaysByWeekDay

Name Schema

afternoonMinutes
optional

number (double)

morningMinutes
optional

number (double)

3.84. Entity

Entity (Etablissement)

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

code
optional

The code of the entity
Example : "01-BRDX"

string

companyId
optional

string

divisionId
optional

string

id
required

Id in database

string

legalName
optional

string

name
optional

The name of the entity
Example : "Bordeaux"

string

3.85. EntityBase

Entity

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

code
optional

The code of the entity
Example : "01-BRDX"

string

id
required

Id in database

string

name
optional

The name of the entity
Example : "Bordeaux"

string

3.86. EventType

Type of event

Type : enum (COMMAND_TASK, COMPANY, CUSTOMER, DIVISION, DIVISION_GROUP, EMPLOYEE, ENTITY, EXPENSE, EXPENSE_REPORTS, INVOICES_CHECK, ISSUE, PHASE, PROJECT, PROJECT_TASK, SCHEDULE, SPRINT, SUB_PHASE, TASK, TIMERECORDING, DOCUMENT, YEAR, REFRESH_CQRS, ALL)

3.87. ExchangeRate

Exchange Rate

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

currency
optional

Details about the currency

Currency

currencyId
optional

Id of the currency
Example : "12006"

string

endDate
optional

End date for using the exchange rate
Example : "2022-12-31T08:10:10+200"

string (date-time)

id
required

Id in database

string

rate
optional

Exchange rate to convert the amount from euro into an amount in the revelant currency
Example : 0.9156852

number (double)

startDate
optional

Start date for using the exchange rate
Example : "2022-12-31T08:10:10+200"

string (date-time)

3.88. Expense

Expense

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

afterTaxAmountRefunded
optional

number (double)

afterTaxCurrencyAmountRefunded
optional

number (double)

alerts
optional

< Alert > array

amountTotal
optional

Total amount in euro
Example : 1200.0

number (double)

amountTotalCurrency
optional

Total amount in the currency
Example : 1200.0

number (double)

businessCard
optional

boolean

changeTracking
optional

Date and user of creation and modification

ChangeTracking

complementName
optional

Description of the line
Example : "Lorem ipsum"

string

currency
optional

Currency

currencyCode
optional

string

customAssignment
optional

string

customRequest
optional

CustomRequest

customRequestId
optional

string

customer
optional

CustomerBase

customerId
optional

string

dateAcceptationOfDenial
optional

string (date-time)

dateCancellationOfDenial
optional

string (date-time)

dateOfDenial
optional

string (date-time)

documents
optional

< Document > array

employeeAcceptationOfDenial
optional

EmployeeBase

employeeAcceptationOfDenialId
optional

string

employeeCancellationOfDenial
optional

EmployeeBase

employeeCancellationOfDenialId
optional

string

exchangeRate
optional

ExchangeRate

exchangeRateId
optional

string

expenseDate
optional

string (date-time)

expenseReportId
optional

string

expenseType
optional

ExpenseType

expenseTypeCode
optional

Deprecated See expenseTypeId and expenseType

string

expenseTypeId
optional

string

fiscalPower
optional

FiscalPower

generalAccount
optional

General Account
Example : "411000"

string

guests
optional

< Guest > array

guid
optional

string

id
required

Id in database

string

kilometers
optional

number (double)

name
optional

Name of the line
Example : "Helpdesk"

string

notRefundable
optional

boolean

numberOfDocuments
optional

integer

phase
optional

Details about the phase of the project.

PhaseBase

phaseId
optional

The Id of the phase
Example : "500000123"

string

preTaxAmountRefunded
optional

number (double)

preTaxCurrencyAmountRefunded
optional

number (double)

preTaxExpenseAmount
optional

number (double)

previousExpense
optional

Expense

previousExpenseId
optional

string

project
optional

All details about the project

ProjectBase

projectId
optional

The code of the project
Example : "PRJT_001"

string

quantity
optional

Quantity of the sold product
Example : 3.0

number (double)

rankNumber
optional

Rank number of the line
Example : 2.0

number (double)

rebillable
optional

boolean

receiptNumber
optional

string

refusalComment
optional

string

refused
optional

boolean

refusingEmployee
optional

EmployeeBase

refusingEmployeeId
optional

string

smartScan
optional

SmartScanState

subPhase
optional

Details about the sub-phase of the project

SubPhaseBase

subPhaseId
optional

The Id of the sub-phase
Example : "51000122"

string

syncError
optional

boolean

threshold
optional

number (double)

unitPrice
optional

Unit price of the sold product in euro
Example : 40.0

number (double)

unitPriceCurrency
optional

Unit price of the sold product in the currency
Example : 36.32

number (double)

vat1
optional

Details about the first VAT rate

VATBase

vat2
optional

Details about the second VAT rate

VATBase

vatAmount1
optional

Amount in euro with the first VAT
Example : 120.0

number (double)

vatAmount1Currency
optional

Amount in currency for the first VAT
Example : 126.57

number (double)

vatAmount2
optional

Amount in euro for the second VAT
Example : 110.0

number (double)

vatAmount2Currency
optional

Amount in currency for the second VAT
Example : 113.26

number (double)

3.89. ExpenseCategory

Category of expense type

Type : enum (REGULAR, MILEAGE, TOLL, RESTAURANT_DOUBLE_VAT)

3.90. ExpenseCriteria

All the criteria that can be used to search for Expense

Name Schema

billable
optional

ClauseBoolean

date
optional

ClauseDate

expenseTypeId
optional

ClauseString

id
optional

ClauseString

missionNumber
optional

ClauseString

project
optional

WorkforceProjectCriteria

proofNumber
optional

ClauseString

syncError
optional

ClauseBoolean

3.91. ExpenseDashboardCriteria

All the criteria that can be used to search for ExpenseDashboard

Name Schema

expenseCriteria
optional

ExpenseCriteria

expenseReportCriteria
optional

ExpenseReportCriteria

3.92. ExpenseDashboardResult

Result of expenses dashboard

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

expense
optional

Expense

expenseReport
optional

ExpenseReport

id
required

Id in database

string

3.93. ExpensePreFillObjectType

Query param for object type

Type : enum (TIMERECORDING, SCHEDULE)

3.94. ExpenseRebillableOptions

default option to bill again the customer

Type : enum (REFUND_AMOUNT, INPUT_AMOUNT, NOTHING)

3.95. ExpenseReceiptSummary

Validity criteria

Name Schema

amount
optional

number (double)

currencyCode
optional

string

date
optional

string (date-time)

expenseTypeCode
optional

string

filePath
optional

string

3.96. ExpenseReport

ExpenseReport

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

accountingJournalId
optional

ID of Accounting Journal
Example : "1203"

string

afterTaxAmount
optional

After-Tax Amount
Example : 120.37

number (double)

changeTracking
optional

Date and user in case of creation and modification

ChangeTracking

code
optional

string

comment
optional

Comment
Example : "Lorem ipsum"

string

companyCode
optional

The company code
Example : "AKSAS"

string

currency
optional

All details about the currency

Currency

currencyCode
optional

Code of the currency used in the document
Example : "EUR"

string

date
optional

Date on the business document
Example : "2020-11-29T08:10:10+200"

string (date-time)

description
optional

Description
Example : "Lorem ipsum"

string

employee
optional

EmployeeBase

employeeId
optional

string

entityCode
optional

The entity code
Example : "Lyon"

string

expenses
optional

< Expense > array

guid
optional

string

id
required

Id in database

string

invoicedDate
optional

string (date-time)

manager
optional

Manager details

EmployeeBase

managerId
optional

Id of the manager
Example : "500001"

string

name
optional

Name of the business document
Example : "Label for my doc"

string

number
optional

The number of the business document
Example : "CC00001"

string

paidDate
optional

string (date-time)

payment
optional

Payment

Payment

phase
optional

Details about the phase of the project.

PhaseBase

phaseId
optional

The Id of the phase
Example : "500000123"

string

preTaxAmount
optional

Pre-Tax Amount
Example : 100.14

number (double)

project
optional

All details about the project

ProjectBase

projectId
optional

The code of the project
Example : "PRJT_001"

string

projectedApprovalDate
optional

Project approval date
Example : "2013-10-02T08:10:10+200"

string (date-time)

regularizationReason
optional

string

subPhase
optional

Details about the sub-phase of the project

SubPhaseBase

subPhaseId
optional

The Id of the sub-phase
Example : "51000122"

string

supplier
optional

SupplierBase

terminationDate
optional

string (date-time)

text
optional

Text on document
Example : "Lorem ipsum"

string

thirdPartyId
optional

The Id of the third-party
Example : "CUSTOMER01"

string

thirdPartyToBillId
optional

The Id of the third-party to bill
Example : "CUSTOMER02"

string

type
optional

Type of the business document
Example: Quotations, Orders, Invoices…

BusinessDocumentType

validationDate
optional

string (date-time)

3.97. ExpenseReportBillingParameters

ExpenseReportBillingParameters

Name Schema

accountingJournalId
optional

string

billingDate
optional

string (date-time)

entityId
optional

string

fiscalYearId
optional

string

mergeJustificatories
optional

boolean

paymentDate
optional

string (date-time)

3.98. ExpenseReportCriteria

All the criteria that can be used to search for ExpenseReport

Name Description Schema

acceptationOfDenial
optional

ClauseBoolean

billed
optional

if true, expenseReport billed

ClauseBoolean

cancelled
optional

ClauseBoolean

code
optional

ClauseString

companyCode
optional

ClauseString

date
optional

ClauseDate

employeeDivisionGroupingId
optional

ClauseString

employeeDivisionId
optional

ClauseString

employeeEstablishmentId
optional

ClauseString

employeeId
optional

ClauseString

employeeServiceId
optional

ClauseString

expenseId
optional

ClauseString

id
optional

ClauseString

invoicedDate
optional

ClauseDate

isMultiCompany
optional

ClauseBoolean

missionNumber
optional

ClauseString

mode
optional

if 'latest' then filter the expense reports with all non invoiced and the latest invoiced

ExpenseReportQueryMode

readOption
optional

ExpenseReportReadOption

refused
optional

ClauseBoolean

regularizationReason
optional

ClauseString

terminated
optional

ClauseString

validated
optional

if true, expenseReport validated

ClauseBoolean

3.99. ExpenseReportIdListParamHolder

ExpenseReportIdListParamHolder

Name Schema

expenseReportIdList
optional

< string > array

3.100. ExpenseReportQueryMode

Query Mode

Type : enum (latest)

3.101. ExpenseReportReadOption

ExpenseReportReadOption

Polymorphism : Inheritance
Discriminator : type

Name Schema

options
optional

< enum (SUPPLIER, EMPLOYEE, MANAGER, EXPENSE, EXPENSE_CUSTOMER, EXPENSE_PROJECT, EXPENSE_PHASE, EXPENSE_SUB_PHASE, EXPENSE_EXPENSE_TYPE, EXPENSE_DOCUMENTS_COUNT, EXPENSE_REFUSING_EMPLOYEE, EXPENSE_EMPLOYEE_ACCEPTATION_OF_DENIAL, EXPENSE_EMPLOYEE_CANCELLATION_OF_DENIAL, EXPENSE_GUESTS, EXPENSE_CURRENCY, EXPENSE_DOCUMENTS, EXPENSE_CUSTOM_REQUEST) > array

type
required

string

3.102. ExpenseThreshold

Expense limit for an employee and a given expenseType

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

dailyThreshold
optional

number (double)

hasThreshold
optional

boolean

id
required

Id in database

string

threshold
optional

number (double)

3.103. ExpenseType

ExpenseType

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

amountEditable
optional

boolean

billableEditable
optional

boolean

code
optional

string

commentRequired
optional

boolean

controlsBehavior
optional

Field control behavior for expense Type

< ControlBehavior > array

dailyLimit
optional

number (double)

defaultAmount
optional

number (double)

description
optional

string

endDate
optional

string (date-time)

expenseCategory
optional

ExpenseCategory

expenseRebillableOptions
optional

ExpenseRebillableOptions

expenseThreshold
optional

number (double)

guestsRequired
optional

boolean

hideVat
optional

boolean

icon
optional

string

id
required

Id in database

string

km
optional

boolean

notRefundable
optional

boolean

notRefundableEditable
optional

boolean

receiptRequired
optional

boolean

showAdditionalComment
optional

boolean

showCustomRequest
optional

boolean

showQuantity
optional

boolean

showReceiptNumber
optional

boolean

vat1Code
optional

string

vat2Code
optional

string

3.104. ExpenseTypeCriteria

Criteria used on Expense Type when doing a search

Name Schema

code
optional

ClauseString

companyCode
optional

ClauseString

description
optional

ClauseString

employeeId
optional

ClauseString

id
optional

ClauseString

readOption
optional

ExpenseTypeReadOption

tag
optional

ClauseString

validity
optional

Validity

3.105. ExpenseTypeExpected

Expense type expected (Nature de dépense prévue)

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

code
optional

string

description
optional

string

endDate
optional

string (date-time)

id
required

Id in database

string

name
optional

string

3.106. ExpenseTypeReadOption

ExpenseTypeReadOption

Polymorphism : Inheritance
Discriminator : type

Name Schema

options
optional

< enum (CONTROLS_BEHAVIOR) > array

type
required

string

3.107. FiscalPower

fiscalPower (Puissance fiscale)

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

endDate
optional

string (date-time)

expenseTypeId
optional

string

id
required

Id in database

string

power
optional

number (double)

rate
optional

number (double)

startDate
optional

string (date-time)

3.108. FiscalPowerCriteria

FiscalPowerCriteria

Name Schema

companyCode
optional

ClauseString

employeeId
optional

ClauseString

expenseTypeId
optional

ClauseString

id
optional

ClauseString

power
optional

ClauseDouble

rate
optional

ClauseDouble

validity
optional

Validity

3.109. ForcedVatAmountHolder

VAT Amount and forced indicator holder

Name Description Schema

amount
optional

Forced amount
Example : 124.56

number (double)

businessDocumentLineId
optional

ID of the business document line
Example : "780023"

string

forced
required

Returns true if the amount is forced
Example : true

boolean

3.110. Guest

A guest of an expense report

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

company
optional

string

employee
optional

Employee

employeeId
optional

string

expenseId
optional

string

firstName
optional

string

id
required

Id in database

string

lastName
optional

string

3.111. Holiday

Holiday

Name Schema

date
optional

string (date-time)

type
optional

string

3.112. IdIdentifiable

Basic type for all pojos with an API ID

Name Description Schema

id
required

Id in database

string

3.113. Item

Item

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

category
optional

All details about the category of the sold product

Category

categoryId
optional

The Id of the category
Example : "10024"

string

comment
optional

Comment on the sold product
Example : "Lorem ipsum"

string

companyCode
optional

The company code
Example : "AKSAS"

string

entityCode
optional

The entity code
Example : "Lyon"

string

family
optional

The category of the sold product
Example : "FML-LICENCE"

string

grouping
optional

The grouping of the sold product
Example : "LICENCE"

string

id
required

Id in database

string

inventory
optional

Returns true if the sold product is in the inventory
Example : true

boolean

name
optional

Identification name
Example : "Maintenance"

string

reference
optional

The reference of the sold product
Example : "ENGLISH"

string

shortName
optional

Abbreviated designation
Example : "Maint"

string

subCategory
optional

All details about the sub-category of the sold product

SubCategoryItem

subCategoryId
optional

The Id of the sub-category
Example : "11037"

string

subFamily
optional

The sub-category of the sold product
Example : "RECCURENT"

string

3.114. ItemBase

Item

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

id
required

Id in database

string

3.115. ItemLine

ItemLine

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

amountTotal
optional

Total amount in euro
Example : 1200.0

number (double)

amountTotalCurrency
optional

Total amount in the currency
Example : 1200.0

number (double)

complementName
optional

Description of the line
Example : "Lorem ipsum"

string

discount
optional

Total discount amount (on the line) in currency

number (double)

endDate
optional

Period end date
Example : "2020-12-21T00:00:00.000+0100"

string (date-time)

exchangeRate
optional

Details about the exchange rate

ExchangeRate

generalAccount
optional

General Account
Example : "411000"

string

id
required

Id in database

string

item
optional

Details about the item

Item

itemId
optional

The Id of the sold product
Example : "10727"

string

name
optional

Name of the line
Example : "Helpdesk"

string

phase
optional

Details about the phase of the project.

PhaseBase

phaseId
optional

The Id of the phase
Example : "500000123"

string

project
optional

All details about the project

ProjectBase

projectId
optional

The code of the project
Example : "PRJT_001"

string

quantity
optional

Quantity of the sold product
Example : 3.0

number (double)

rankNumber
optional

Rank number of the line
Example : 2.0

number (double)

startDate
optional

Period start date
Example : "2020-12-21T00:00:00.000+0100"

string (date-time)

subPhase
optional

Details about the sub-phase of the project

SubPhaseBase

subPhaseId
optional

The Id of the sub-phase
Example : "51000122"

string

unitPrice
optional

Unit price of the sold product in euro
Example : 40.0

number (double)

unitPriceCurrency
optional

Unit price of the sold product in the currency
Example : 36.32

number (double)

vat1
optional

Details about the first VAT rate

VATBase

vat2
optional

Details about the second VAT rate

VATBase

vatAmount1
optional

Amount in euro with the first VAT
Example : 120.0

number (double)

vatAmount1Currency
optional

Amount in currency for the first VAT
Example : 126.57

number (double)

vatAmount2
optional

Amount in euro for the second VAT
Example : 110.0

number (double)

vatAmount2Currency
optional

Amount in currency for the second VAT
Example : 113.26

number (double)

3.116. JournalType

Type of journal

Type : enum (SALES, PURCHASE, BANK)

3.117. Leave

Leave

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

comment
optional

string

commentValidator
optional

string

dateValidator
optional

string (date-time)

duration
optional

number (double)

employeeId
optional

string

employeeValidator
optional

string

endDate
optional

string (date-time)

guid
optional

string

id
required

Id in database

string

leaveRightId
optional

string

leaveState
optional

LeaveState

leaveType
optional

string

modificationTime
optional

string (date-time)

requestDate
optional

string (date-time)

startAfterNoon
optional

boolean

startDate
optional

string (date-time)

3.118. LeaveCriteria

LeaveCriteria

Name Schema

comment
optional

ClauseString

duration
optional

ClauseDouble

employeeId
optional

ClauseString

endDate
optional

ClauseDate

guid
optional

ClauseString

id
optional

ClauseString

leaveRightId
optional

ClauseString

leaveState
optional

ClauseString

modificationTime
optional

ClauseDate

requestDate
optional

ClauseDate

startAfterNoon
optional

ClauseBoolean

startDate
optional

ClauseDate

3.119. LeaveRight

LeaveRight

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

code
optional

string

endDate
optional

string (date-time)

id
required

Id in database

string

name
optional

string

right
optional

number (double)

startDate
optional

string (date-time)

tolerance
optional

number (double)

3.120. LeaveState

LeaveState

Type : enum (ACCEPTED, CANCELLED, REFUSED, REQUESTED)

3.121. LinkedObjectType

Type of publish.

Type : enum (CUSTOMER, CONTACT, OPPORTUNITY, EVENT, CARD, ISSUE, EXPENSE, EXPENSE_REPORT, QUOTATION, SALES_ORDER, QUOTE, PURCHASE_ORDER, PURCHASE_INVOICE, INVOICE, PROJECT, SUPPLIER, DELIVERY, EMPLOYEE)

3.122. Mail

Represents all information needed to send a mail (recipient, subject and body)

Name Description Schema

body
optional

content of the mail as a text

string

cc
optional

Mail carbon copy recipients

< string > array

cci
optional

Mail hidden carbon copy recipients

< string > array

from
optional

Mail sender

string

replyTo
optional

Mail reply to

string

title
optional

Mail title

string

to
optional

Mail recipients

< string > array

3.123. ManagerCriteria

ManagerCriteria

Name Schema

endDate
optional

ClauseDate

startDate
optional

ClauseDate

tag
optional

ClauseString

3.124. ManagerDelegatedCriteria

ManagerDelegatedCriteria

Name Schema

delegationModule
optional

DelegationModule

tag
optional

string

3.125. Message

A message is a combination of a Mail (used to store standard information for sending a mail) and functional information. This functional information is processed by backend service to compute standard information for sending mail like an employee’s email address.

Name Description Schema

ccRecipients
optional

Mail recipients

< MessageRecipient > array

cciRecipients
optional

Mail recipients

< MessageRecipient > array

mail
optional

Mail

replyTo
optional

Mail recipient replyTo

MessageRecipient

toRecipients
optional

Mail recipients

< MessageRecipient > array

3.126. MessageRecipient

Recipient of a message

Name Schema

address
optional

string

id
optional

string

summary
optional

string

type
optional

MessageRecipientType

3.127. MessageRecipientType

Message recipient type

Type : enum (USER, EMPLOYEE, CONTACT, TEAM, MAIL_ADDRESS)

3.128. OpportunityBase

OpportunityBase

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

code
optional

string

id
required

Id in database

string

name
optional

string

3.129. PatchElement

A JSONPatch as defined by RFC 6902

Name Description Schema

from
required

A JSON-Pointer @see https://tools.ietf.org/html/rfc6901

string

op
required

The operation to be performed

enum (ADD, REMOVE, REPLACE, TEST, MOVE, COPY)

path
required

A JSON-Pointer @see https://tools.ietf.org/html/rfc6901

string

value
optional

The value to be used within the operations.

object

3.130. Payment

Payment

Polymorphism : Composition

Name Schema

code
optional

string

day
optional

number (double)

deadLine
optional

string

term
optional

string

3.131. Period

Period

Name Description Schema

from
optional

smaller date of the period

string (date-time)

granularity
optional

To limit the granularity to a unit other than milliseconds, pass the units as the third parameter. DAY by default.

PeriodGranularity

inclusivity
optional

inclusivity. A [ indicates inclusion of a value. A ( indicates exclusion (for the smaller date of the period, use ) and ] for the bigger one). Inclusive by default.

string

to
optional

bigger date of the period

string (date-time)

3.132. PeriodGranularity

Granularity of a period

Type : enum (YEAR, MONTH, DAY, HOUR, MINUTE, SECOND, MILLISECOND)

3.133. Periodicity

Periodicity

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

code
optional

Periodicity of payment (0 = Unique (default); 1 = Annual; 2 = Bi-annual; 3 = Quarterly; 4 = Monthly)

PeriodicityCodeType

duration
optional

Duration in month
Example : 3.0

number (double)

id
required

Id in database

string

startDate
optional

Date by which the periodicity is starting

string (date-time)

tacitAgrement
optional

Returns true if the checkbox "tacit renewal" is checked
Example : true

boolean

term
optional

Returns true if due, false if not due
Example : true

boolean

3.134. PeriodicityCodeType

Type of tag

Type : enum (UNIQUE, ANNUAL, BIANNUAL, QUARTERLY, MONTHLY)

3.135. PhaseBase

Phase

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

code
optional

Code of a phase
Example : "PHS_1"

string

id
required

Id in database

string

name
optional

Name of a phase
Example : "Phase 1"

string

order
optional

Order number of the project
Example : 1

integer (int32)

project
optional

Details about the corresponding project

ProjectBase

projectId
optional

Id of the corresponding project
Example : "5100002"

string

3.136. ProjectBase

Project

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

customerId
optional

Id of the customer
Example : "3400012"

string

endCustomerId
optional

Id of the end customer
Example : "3400013"

string

id
required

Id in database

string

internal
optional

If the project is internal or not
Example : false

boolean

name
optional

Name of a project
Example : "My project"

string

3.137. ProjectGroup

ProjectGroup

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

code
optional

string

description
optional

string

id
required

Id in database

string

name
optional

string

3.138. ProjectTaskBase

The Project task base

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

id
required

Id in database

string

name
optional

Name of the task
Example : "Team building"

string

order
optional

Order number of the task
Example : 2

integer (int32)

phase
optional

The phase of the project

PhaseBase

phaseId
optional

The ID of the phase
Example : "PH_1"

string

project
optional

The project

ProjectBase

projectId
optional

The ID of a project
Example : "PRJT_1"

string

subPhase
optional

The sub-phase of the project

SubPhaseBase

subPhaseId
optional

The ID of the sub-phase
Example : "SB_1"

string

3.139. PublishArguments

Arguments for a publication (Template / Extension / Parameters).

Name Description Schema

extension
optional

string

parameters
optional

< PublishTemplateParameter > array

saveDocument
optional

boolean

template
optional

Detail about the template

PublishTemplate

3.140. PublishTemplate

Publish template

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

code
optional

string

endDate
optional

string (date-time)

extensions
optional

< string > array

id
required

Id in database

string

name
optional

string

path
optional

string

type
optional

PublishTemplateType

3.141. PublishTemplateParameter

Parameters of a Publish template.

Name Schema

controlType
optional

PublishTemplateParameterType

groupName
optional

string

labelText
optional

string

nameField
optional

string

nameFieldNext
optional

string

pattern
optional

string

required
optional

boolean

selectionList
optional

< PublishTemplateParameterChoice > array

value
optional

object

3.142. PublishTemplateParameterChoice

Choices for a parameter of a Publish template.

Name Schema

label
optional

string

value
optional

string

3.143. PublishTemplateParameterType

Type of parameter.

Type : enum (TEXT_BOX, LIST_BOX, DATE_BOX, RADIO_BUTTON, CHECK_BOX, COMBO_BOX)

3.144. PublishTemplateType

Describe the Publish template type which is unique by code-modelId tuple. Allowed ModelId values depend on choosen code value.

Name Schema

code
optional

string

modelDescription
optional

string

modelId
optional

string

name
optional

string

3.145. PublishType

Type of publish.

Type : enum (QUOTATION, SALES_ORDER, SALES_INVOICE, QUOTE, PURCHASE_ORDER, PURCHASE_INVOICE, CUSTOMER, CUSTOM_REQUEST, EXPENSE_REPORT)

3.146. PublishedDocument

Published Document.

Name Description Schema

documentId
optional

Document ID
Example : "112302"

string

isDocument
optional

boolean

token
optional

string

3.147. QuickEntryTime

QuickEntryTime

Polymorphism : Inheritance
Discriminator : type

Name Description Schema

actionCode
optional

ActionCode

actionCode2
optional

ActionCode2

actionCode2Id
optional

string

actionCodeId
optional

string

approval
optional

enum (BRUT, CONTROLE, VALIDE, GRATUIT, NON_FACTURE, FACTURE, REFUSE, DISSOCIE)

approvalLabel
optional

string

changeTracking
optional

Creation and modification date and user

ChangeTracking

comment
optional

string

customer
optional

CustomerBase

customerId
optional

string

date
optional

string (date-time)

duration
optional

duration in unit asked (dft Unit of presentation of employee)

number (double)

employee
optional

EmployeeBase

employeeId
optional

string

guid
optional

string

id
required

Id in database

string

name
optional

string

phase
optional

PhaseBase

phaseId
optional

string

place
optional

string

project
optional

ProjectBase

projectId
optional

string

projectTask
optional

ProjectTaskBase

projectTaskId
optional

string

subPhase
optional

SubPhaseBase

subPhaseId
optional

string

type
required

string

unit
optional

Unit of duration (dft Unit of presentation of employee)

UnitDuration

validated
optional

boolean

3.148. ReadOption

option use to get additional information when doing a search

Name Schema

type
required

string

3.149. Relation

a relation between two employees

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

employee
optional

EmployeeBase

employeeId
optional

string

id
required

Id in database

string

relatedEmployee
optional

EmployeeBase

relatedEmployeeId
optional

string

relationType
optional

RelationType

3.150. RelationCriteria

RelationCriteria

Name Schema

employeeId
optional

ClauseString

employeeIdOrRelatedEmployeeId
optional

ClauseString

relatedEmployeeId
optional

ClauseString

3.151. RelationType

Type of a relation

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

code
optional

string

id
required

Id in database

string

name
optional

string

3.152. Schedule

Schedule

Polymorphism : Inheritance
Discriminator : type

Name Description Schema

actionCode
optional

ActionCode

actionCodeId
optional

string

changeTracking
optional

Creation and modification date and user

ChangeTracking

comment
optional

string

customer
optional

CustomerBase

customerId
optional

string

date
optional

string (date-time)

description
optional

string

duration
optional

duration in unit asked (dft Unit of presentation of employee)

number (double)

employee
optional

EmployeeBase

employeeId
optional

string

guid
optional

string

id
required

Id in database

string

phase
optional

PhaseBase

phaseId
optional

string

place
optional

string

project
optional

ProjectBase

projectId
optional

string

projectTask
optional

ProjectTaskBase

projectTaskId
optional

string

subPhase
optional

SubPhaseBase

subPhaseId
optional

string

type
required

string

unit
optional

Unit of duration (dft Unit of presentation of employee)

UnitDuration

validated
optional

boolean

3.153. ScheduleBase

Schedules

Polymorphism : Inheritance
Discriminator : type

Name Description Schema

actionCode
optional

ActionCode

actionCodeId
optional

string

changeTracking
optional

Creation and modification date and user

ChangeTracking

comment
optional

string

customer
optional

CustomerBase

customerId
optional

string

date
optional

string (date-time)

description
optional

string

duration
optional

duration in unit asked (dft Unit of presentation of employee)

number (double)

employee
optional

EmployeeBase

employeeId
optional

string

guid
optional

string

id
required

Id in database

string

phase
optional

PhaseBase

phaseId
optional

string

place
optional

string

project
optional

ProjectBase

projectId
optional

string

projectTask
optional

ProjectTaskBase

projectTaskId
optional

string

subPhase
optional

SubPhaseBase

subPhaseId
optional

string

type
required

string

unit
optional

Unit of duration (dft Unit of presentation of employee)

UnitDuration

validated
optional

boolean

3.154. ScheduleCriteria

ScheduleCriteria

Name Schema

actionCode
optional

ClauseString

comment
optional

ClauseString

creationDateFrom
optional

ClauseDate

creationDateTo
optional

ClauseDate

description
optional

ClauseString

employeeCode
optional

ClauseString

employeeId
optional

ClauseString

id
optional

ClauseString

modificationDateFrom
optional

ClauseDate

modificationDateTo
optional

ClauseDate

phaseCode
optional

ClauseString

phaseId
optional

ClauseString

place
optional

ClauseString

projectCode
optional

ClauseString

projectTaskCode
optional

ClauseString

projectTaskId
optional

ClauseString

readOption
optional

ScheduleReadOption

scheduleCriteriaType
required

string

subPhaseCode
optional

ClauseString

subPhaseId
optional

ClauseString

validated
optional

ClauseBoolean

3.155. ScheduleCriteriaFluent

ScheduleCriteriaFluent

Polymorphism : Inheritance
Discriminator : scheduleCriteriaType

Name Schema

actionCode
optional

ClauseString

comment
optional

ClauseString

creationDateFrom
optional

ClauseDate

creationDateTo
optional

ClauseDate

description
optional

ClauseString

employeeCode
optional

ClauseString

employeeId
optional

ClauseString

id
optional

ClauseString

modificationDateFrom
optional

ClauseDate

modificationDateTo
optional

ClauseDate

phaseCode
optional

ClauseString

phaseId
optional

ClauseString

place
optional

ClauseString

projectCode
optional

ClauseString

projectTaskCode
optional

ClauseString

projectTaskId
optional

ClauseString

readOption
optional

ScheduleReadOption

scheduleCriteriaType
required

string

subPhaseCode
optional

ClauseString

subPhaseId
optional

ClauseString

validated
optional

ClauseBoolean

3.156. ScheduleFluent

ScheduleFluent

Polymorphism : Inheritance
Discriminator : type

Name Description Schema

actionCode
optional

ActionCode

actionCodeId
optional

string

changeTracking
optional

Creation and modification date and user

ChangeTracking

comment
optional

string

customer
optional

CustomerBase

customerCode
optional

string

customerId
optional

string

date
optional

string (date-time)

description
optional

string

duration
optional

duration in unit asked (dft Unit of presentation of employee)

number (double)

employee
optional

EmployeeBase

employeeCode
optional

string

employeeId
optional

string

guid
optional

string

id
required

Id in database

string

phase
optional

PhaseBase

phaseCode
optional

string

phaseId
optional

string

place
optional

string

project
optional

ProjectBase

projectCode
optional

string

projectId
optional

string

projectTask
optional

ProjectTaskBase

projectTaskCode
optional

string

projectTaskId
optional

string

subPhase
optional

SubPhaseBase

subPhaseCode
optional

string

subPhaseId
optional

string

type
required

string

unit
optional

Unit of duration (dft Unit of presentation of employee)

UnitDuration

validated
optional

boolean

3.157. ScheduleReadOption

ScheduleReadOption

Polymorphism : Inheritance
Discriminator : type

Name Schema

options
optional

< enum (EMPLOYEE, CUSTOMER, PROJECT, PHASE, SUB_PHASE, PROJECT_TASK, ACTION, CHANGE_TRACKING) > array

type
required

string

3.158. ScheduleRules

ScheduleRules

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

allowManualEntry
optional

Autorise ou non la saisie manuelle de la durée, si non, seule la saisie via le range de valeurs sera autorisée

boolean

base
optional

Base de calcul permettant de déduire la valeur max de décimal autorisé (ex: 60, 100) et permettant d’effectuer d’autres calculs sur les temps de manière dynamique

number (double)

closingDates
optional

Dates d’arrêté pour les temps et les plannings

< ClosingDate > array

employeeId
optional

string

employeeWeeks
optional

Semaines types du collaborateur

< EmployeeWeek > array

id
required

Id in database

string

max
optional

Borne maximale exclue de saisie d’une durée

number (double)

min
optional

Borne minimale exclue de saisie d’une durée

number (double)

prettyStep
optional

Pas d’incrémentation graphique d’une durée

number (double)

step
optional

Précision d’une durée, utile pour connaître le pas d’incrémentation

number (double)

unit
optional

Code de l’unité de présentation (cf com.itnsa.fwk.util.temps.UniteDePresentation)

string

unitDuration
optional

Unité de présentation (cf com.itnsa.fwk.util.temps.UniteDePresentation)

UnitDuration

3.159. Service

Service

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

code
optional

string

id
required

Id in database

string

name
optional

string

3.160. Skill

Main skill of an employee

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

code
optional

string

id
required

Id in database

string

name
optional

string

typeCode
optional

string

typeLabel
optional

string

3.161. SmartScanState

SmartScanState

Type : enum (NOT_REQUESTED, REQUESTED, DONE, CANCELED)

3.162. Steppable

Steppable interface

Name Schema

estimate
optional

number (double)

sprintId
optional

string

stepId
optional

string

3.163. SubCategory

Sub-Category

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

category
optional

Details about the category

Category

categoryId
optional

The Id of the sub-category
Example : "500143"

string

code
optional

The code of the category
Example : "LANG"

string

companyCode
optional

The code of the company
Example : "AKSAS"

string

endDate
optional

End date for using the category of the sold product
Example : "2020-10-29T08:10:10+200"

string (date-time)

id
required

Id in database

string

name
optional

The name of the category
Example : "Language"

string

type
optional

Type of the category.

CategoryType

3.164. SubCategoryItem

Sub category of an item

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

category
optional

Details about the category

Category

categoryId
optional

The Id of the sub-category
Example : "500143"

string

code
optional

The code of the category
Example : "LANG"

string

companyCode
optional

The code of the company
Example : "AKSAS"

string

endDate
optional

End date for using the category of the sold product
Example : "2020-10-29T08:10:10+200"

string (date-time)

id
required

Id in database

string

name
optional

The name of the category
Example : "Language"

string

subType
optional

Sub-type of the sub-category item

SubCategoryItemType

type
optional

Type of the category.

CategoryType

3.165. SubCategoryItemType

Sub type of a sub category of an item

Type : enum (PRESTATION, DISTRIBUTION, FRAIS_DE_MISSION, ACOMPTE, DIVERS, NON_RENSEIGNE, LICENCE, MAINTENANCE, DEVELOPPEMENT, SOUS_TRAITANCE, FRAIS_DE_PORT, ABONNEMENT)

3.166. SubPhaseBase

SubPhase

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

code
optional

Code of a sub-phase
Example : "SB_1"

string

id
required

Id in database

string

name
optional

Name of a sub-phase
Example : "Sub Phase 1"

string

order
optional

Order number of the sub-phase
Example : 1

integer (int32)

phase
optional

Details about the corresponding phase

PhaseBase

phaseId
optional

Id of the corresponding phase
Example : "5000123"

string

3.167. Subscription

subscription to listen events using SSE

Name Schema

token
optional

string

topic
optional

Topic

3.168. SupplierBase

Suppliers

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

code
optional

string

id
required

Id in database

string

name
optional

string

3.169. SupplierSiteBase

Supplier Site Base (Site Fournisseur)

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

id
required

Id in database

string

name
optional

string

supplierId
optional

string

3.170. Tag

Tag

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

code
optional

Code of tag

string

color
optional

Color of tag

string

comment
optional

Comment of tag

string

companyId
optional

Id of company

string

endDate
optional

End of validity

string (date-time)

icon
optional

Icon of tag

string

id
required

Id in database

string

name
optional

Name of tag

string

type
optional

Type of tag

TagType

3.171. TagCriteria

Tag criteria

Name Schema

code
optional

ClauseString

companyId
optional

ClauseString

id
optional

ClauseString

name
optional

ClauseString

tag
optional

ClauseString

type
optional

ClauseString

validity
optional

Validity

3.172. TagLinked

Tag linked

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

action
optional

Action

code
optional

Code of tag

string

color
optional

Color of tag

string

comment
optional

Comment of tag

string

companyId
optional

Id of company

string

endDate
optional

End of validity

string (date-time)

icon
optional

Icon of tag

string

id
required

Id in database

string

name
optional

Name of tag

string

objectId
optional

Id of object linked

string

type
optional

Type of tag

TagType

3.173. TagType

Type of tag

Type : enum (ISSUE)

3.174. TimeRecording

TimeRecording

Polymorphism : Inheritance
Discriminator : type

Name Description Schema

actionCode
optional

ActionCode

actionCode2
optional

ActionCode2

actionCode2Id
optional

string

actionCodeId
optional

string

approval
optional

enum (BRUT, CONTROLE, VALIDE, GRATUIT, NON_FACTURE, FACTURE, REFUSE, DISSOCIE)

approvalLabel
optional

string

changeTracking
optional

Creation and modification date and user

ChangeTracking

comment
optional

string

customer
optional

CustomerBase

customerId
optional

string

date
optional

string (date-time)

duration
optional

duration in unit asked (dft Unit of presentation of employee)

number (double)

employee
optional

EmployeeBase

employeeId
optional

string

guid
optional

string

id
required

Id in database

string

phase
optional

PhaseBase

phaseId
optional

string

place
optional

string

project
optional

ProjectBase

projectId
optional

string

projectTask
optional

ProjectTaskBase

projectTaskId
optional

string

subPhase
optional

SubPhaseBase

subPhaseId
optional

string

type
required

string

unit
optional

Unit of duration (dft Unit of presentation of employee)

UnitDuration

validated
optional

boolean

3.175. TimeRecordingBase

TimeRecordingBase

Polymorphism : Inheritance
Discriminator : type

Name Description Schema

actionCode
optional

ActionCode

actionCode2
optional

ActionCode2

actionCode2Id
optional

string

actionCodeId
optional

string

approval
optional

enum (BRUT, CONTROLE, VALIDE, GRATUIT, NON_FACTURE, FACTURE, REFUSE, DISSOCIE)

approvalLabel
optional

string

changeTracking
optional

Creation and modification date and user

ChangeTracking

comment
optional

string

customer
optional

CustomerBase

customerId
optional

string

date
optional

string (date-time)

duration
optional

duration in unit asked (dft Unit of presentation of employee)

number (double)

employee
optional

EmployeeBase

employeeId
optional

string

guid
optional

string

id
required

Id in database

string

phase
optional

PhaseBase

phaseId
optional

string

place
optional

string

project
optional

ProjectBase

projectId
optional

string

projectTask
optional

ProjectTaskBase

projectTaskId
optional

string

subPhase
optional

SubPhaseBase

subPhaseId
optional

string

type
required

string

unit
optional

Unit of duration (dft Unit of presentation of employee)

UnitDuration

validated
optional

boolean

3.176. TimeRecordingCriteria

TimeRecordingCriteria

Name Description Schema

actionCode2Id
optional

filter the actionCode2 by its id

ClauseString

actionCodeCode
optional

filter the actionCode by its code

ClauseString

approval
optional

ClauseString

companyId
optional

ClauseString

divisionGroupingId
optional

ClauseString

divisionId
optional

ClauseString

doNotRoundUp
optional

boolean

employeeId
optional

ClauseString

entityId
optional

ClauseString

from
optional

ClauseDate

id
optional

ClauseString

managerId
optional

ClauseString

onlyFinishedTimes
optional

boolean

period
optional

Period

project
optional

WorkforceProjectCriteria

projectTaskId
optional

ClauseString

readOption
optional

TimeRecordingReadOption

serviceId
optional

ClauseString

to
optional

ClauseDate

3.177. TimeRecordingReadOption

TimeRecordingReadOption

Polymorphism : Inheritance
Discriminator : type

Name Schema

options
optional

< enum (EMPLOYEE, CUSTOMER, PROJECT, PHASE, SUB_PHASE, PROJECT_TASK, ACTION, ACTION_2) > array

type
required

string

3.178. TimeRecordingRules

TimeRecordingRules

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

allowManualEntry
optional

Autorise ou non la saisie manuelle de la durée, si non, seule la saisie via le range de valeurs sera autorisée

boolean

base
optional

Base de calcul permettant de déduire la valeur max de décimal autorisé (ex: 60, 100) et permettant d’effectuer d’autres calculs sur les temps de manière dynamique

number (double)

closingDates
optional

Dates d’arrêté pour les temps et les plannings

< ClosingDate > array

employeeId
optional

string

employeeWeeks
optional

Semaines types du collaborateur

< EmployeeWeek > array

id
required

Id in database

string

max
optional

Borne maximale exclue de saisie d’une durée

number (double)

min
optional

Borne minimale exclue de saisie d’une durée

number (double)

prettyStep
optional

Pas d’incrémentation graphique d’une durée

number (double)

simpleDuration
optional

see Pilote TPSCTRL_SIMPLE, duration of a day in minutes

number (double)

step
optional

Précision d’une durée, utile pour connaître le pas d’incrémentation

number (double)

terminationMode
optional

see Pilote TPS_TERMINAISON

enum (WEEKLY, MONTHLY, WEEKLY_MONTHLY, NONE)

unit
optional

Code de l’unité de présentation (cf com.itnsa.fwk.util.temps.UniteDePresentation)

string

unitDuration
optional

Unité de présentation (cf com.itnsa.fwk.util.temps.UniteDePresentation)

UnitDuration

3.179. TimeRecordingTermination

TimeRecordingTermination

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

employee
optional

Employee

employeeId
optional

string

id
required

Id in database

string

number
optional

number (double)

terminationType
optional

enum (WEEK, MONTH)

year
optional

number (double)

3.180. TimeRecordingTerminationCriteria

TimeRecordingTerminationCriteria

Name Schema

employeeId
optional

ClauseString

id
optional

ClauseString

managerId
optional

ClauseString

number
optional

ClauseDouble

type
optional

ClauseString

year
optional

ClauseDouble

3.181. TitleType

Type of title

Type : enum (UNKNOWN, NEUTRAL, MALE, FEMALE)

3.182. Topic

topic to listen events

Name Schema

action
optional

string

id
optional

string

type
optional

EventType

3.183. UnitDuration

Unit of duration (cf com.itnsa.fwk.util.temps.UniteDePresentation)

Type : enum (MINUTE, HOUR_MINUTE, HOUR_DECIMAL, DAY, UNIT_OF_EMPLOYEE)

3.184. UserBase

User

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

code
optional

Code of the user
Example : "CASH"

string

firstname
optional

First name of the user
Example : "John"

string

id
required

Id in database

string

name
optional

Name of the user
Example : "Doe"

string

3.185. UserCriteria

UserCriteria

Name Schema

id
optional

ClauseString

3.186. VAT

VAT

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

code
optional

VAT code
Example : "7"

string

companyCode
optional

The compagny code
Example : "AKSAS"

string

endDate
optional

End date of the VAT
Example : "2099-12-31T08:10:10+200"

string (date-time)

id
required

Id in database

string

name
optional

Name
Example : "VAT for capital asset"

string

rate
optional

VAT rate in percentage
Example : "20.0%"

number (double)

reduced
optional

Returns true if the rate is reduced
Example : true

boolean

startDate
optional

Start date of the VAT
Example : "2020-12-31T08:10:10+200"

string (date-time)

3.187. VATBase

VAT

Polymorphism : Composition

Name Description Schema

code
optional

VAT code
Example : "7"

string

rate
optional

VAT rate in percentage
Example : "20.0%"

number (double)

3.188. Validity

Validity criteria

Name Description Schema

date
optional

If date is null the validity is on current date.

string (date-time)

type
optional

Type of validity. Search valid or invalid objects. If date is null the validity is on current date.

ValidityType

3.189. ValidityType

Type of validity

Type : enum (VALID, INVALID)

3.190. WorkforceProjectCriteria

Criteria used on Project when doing a Project search

Name Description Schema

activityId
optional

ClauseString

categoryId
optional

ClauseString

customerId
optional

ClauseString

departmentId
optional

ClauseString

divisionGroupingId
optional

ClauseString

divisionId
optional

ClauseString

entityId
optional

ClauseString

financialManagerId
optional

ClauseString

id
optional

ClauseString

managerId
optional

ClauseString

name
optional

ClauseString

productionManagerId
optional

ClauseString

projectGroupCode
optional

ClauseString

projectState
optional

ClauseString

referentialDate
optional

Date à laquelle l’affaire doit être active (en prod)

string (date-time)

salesManagerId
optional

ClauseString

subCategoryId
optional

ClauseString

subCategoryLevel2Id
optional

ClauseString

tag
optional

ClauseString

4. Security

4.1. basicAuth

Type : basic

5. Deprecated fields

Definition Field Information

Item View

family

Use category instead

Item View

subFamily

Use subCategory instead

Document View

createdBy

Use changeTracking.createdBy instead

Document View

createdById

Use changeTracking.createdById instead

Document View

creationDate

Use changeTracking.creationDate instead

Document View

sysName

Use fileName instead

TimeRecordingCriteria View

from

Use the period

TimeRecordingCriteria View

to

Use the period

6. Lexique multilingue des termes Akuiteo

Anglais Français

year

millésime

* company

société *

account

compte

accounting

comptabilité

accounting export

export comptable

accounting journal

journal comptable

achievement project

affaire de réalisation

action

action

action code

code action

activity

activité

activity report

rapport d’activité

after-tax amount

montant TTC

aging schedule

balance âgée

alert

alerte

allocation

affectation

amortization

amortissement

application control

pilote applicatif

appointment

rendez-vous

approval

approbation

approval type

type d’approbation

approver

approbateur

archived

archivé

arrears

arriéré

Authorization

Autorisation

automatic numbering

numérotation automatique

average daily cost

coût journalier moyen

balance

solde

balance sheet

bilan

bank account details

RIB

bank details

coordonnées bancaires

bank reconciliation

rapprochement bancaire

bank statement

relevé bancaire

bank transfer

virement bancaire

banking

trésorerie (module)

billable

facturable

billed

facturé

billing

facturation

billing table

tableau de facturation

blocking rule

règle de blocage

booked

comptabilisé

Bookmarks

Favoris

budget

budget

budget control

contrôle budgétaire

campaign

campagne

cancel

annuler

canceled

annulé

capital asset

immobilisation

carry forwards

à nouveaux

cash flow

trésorerie

category

famille

charge project

affaire de charge

charging

imputation

chart of accounts (COA)

plan comptable

checkbook

chéquier

checking

pointage

clearing journal

journal de compensation

closing

arrêté

closure

clôture

company

société

complete

terminer

completed

terminé

completion

terminaison

contact

contact

control template

modèle de contrôle

cost

charge

credit

crédit

credit note

avoir

criticality

criticité

CRM

CRM

CRM query

Requêteur CRM

cross-function

transverse

currency

devise

custom control

contrôle paramétrable

custom data

donnée personnalisée

custom request

demande interne

customer

client

Customer Portal

Portail Client

customer to bill

client à facturer

dashboard

tableau de bord

deactivate

désactiver

debit

débit

deferred expenses

CCA (charges constatées d’avance

delete

supprimer

deletion

suppression

delivery

livraison

delivery note

bordereau

dialog box

boîte de dialogue

direct debit

prélèvement bancaire

disbursement

décaissement

discharge

quittance

discount

remise

division

division

division grouping

regroupement de division

DMF

DMF

document

document

Document Management System (DMS)

Gestion électronique des documents (GED)

doubtful customer

client douteux

down payment

acompte

due date

échéance

dunning email

e-mail de relance

dunning letter

lettre de relance

duplicate

dupliquer

Edit

Edition

edit

modifier

employee

collaborateur (salarié)

employee number

matricule (collaborateur)

Employee Portal

Portail Collaborateur

employee schedule

planning collaborateur

entity

établissement

event

événement

event category

catégorie d’événement

exchange rate

taux de change

expense report

note de frais

expense type

nature de dépense

factoring

affacturage

feature

fonction (application)

finances

finances

fiscal year

exercice

follow-up

suivi

GDPR

RGPD

General Setup

Paramétrage Général

group

groupe

grouping

regroupement

Guaranteed Fault Repair Time

GTR

Guaranteed Response Time

GTI

header

en-tête

Helpdesk

Support

history

historique

IDB

TBI

identification

désignation

in progress

en cours

Indicator DashBoard

Tableau de Bord Interactif

info 1

info 1

input

saisie

intercompany

intra-groupe (cross org)

internal account

compte interne

inventory

stock

invoice

facture

issue

demande (support)

journal entry

écriture comptable

label

libellé

labor subleasing

prêt de main d’œuvre

leave request

demande d’absence

leave type

nature d’absence

legal structure

forme juridique

line

ligne

log in

se connecter

log out

se déconnecter

lost opportunity

opportunité perdue

maintained product

produit maintenu

maintenance contract

contrat de maintenance

management

gestion

management object

pièce de gestion

management rule

règle de gestion

manager

responsable

Manager Portal

Portail Manager

mandate

mandat

matching

lettrage

miscellaneous operations

opérations diverses

mission

mission

non-billable

non-facturable

note

note

occupancy rate

taux d’occupation

operating account

compte d’exploitation

opportunity

opportunité

opportunity pipeline

portefeuille d’opportunités

order

commande

order form

bon de commande

owner

propriétaire

paid invoice

facture soldée

partitioning

cloisonnement

payment

règlement

payment authorization

bon à payer

pending

en attente

phase

lot

planned workload

plan de charge

position

fonction (collaborateur)

pre-tax amount

montant HT

print

éditer

product

produit

profitability

rentabilité

project

affaire

project group

marché

project task

tâche

projected billing table

tableau de facturation prévisionnelle

Properties

Propriétés

proposal

proposition

prospect

prospect

purchase

achats

purchase invoice

facture fournisseur

purchase order

commande fournisseur

purchased product

produit acheté

qualification level

niveau d’habilitation

quotation

devis

quote

cotation

rank number

numéro d’ordre

receipt

encaissement

receipt

justificatif

reception

réception

recipient

destinataire

recognized revenue

CA reconnu

reconciliation account

compte collectif

record sheet

fiche

recovery

recouvrement

recurring billing

facturation récurrente

reference

référence

rejected

refusé

renewal

renouvellement

report template

modèle d’édition

required

obligatoire

resolved

résolu

resources

collaborateurs

retention money

retenue de garantie

revenue

chiffre d’affaire

revenue recognition

reconnaissance du CA

sales

ventes

sales contract

contrat client

sales invoice

facture client

sales order

commande client

schedule

planning

scheduled item

élément de planning

screen

écran

search results

résultats de recherche

secondment

détachement

serial number

numéro de série

service

prestation

service

service

setup

paramétrage

severity

gravité

SIA (sales invoice accruals)

FAE (facture à émettre)

signature

signature

simplified issue

demande simplifiée

site

site

skill

compétence

sold product

produit vendu

spending commitment

engagement de dépense

stage

stade

standalone invoice

facture indépendante

standard issue

demande classique

state code

code état

status

statut

status history

historique des situations

sub-category

sous-famille

sub-category level 2

sous-famille 2

subledger account

compte auxiliaire

sub-phase

sous-lot

supplier

fournisseur

supplier employee

fournisseur collaborateur

target

cible

task

intervention

task unit

unité d’intervention

template

modèle

termination

résiliation

Third-party

Tiers

threshold

seuil

time spent

temps passés

time-based billing

facturation en régie

times

temps

Tools

Outils

training

formation

transferred

transféré

trigger

déclencheur

type

nature

unmatching

délettrage

unpaid invoice

facture non soldée

updated projection

reprévision

user

utilisateur

User management

Gestion des utilisateurs

validated

validé

validation

validation

VAT rate

taux de TVA

window

fenêtre

won opportunity

opportunité gagnée

workforce

main d’œuvre

Date de publicatrion: Wed, 10 Mar 2021 10:43:55 GMT
Copyright: Akuiteo © 2020