1. Introduction
The Workforce domain enables you to manage employees, timesheets and schedules, expense reports, leave requests, custom requests and project events.
1.3. Tags
-
Business cards : Business cards
-
Custom Request Settings : Custom Request Settings
-
Custom requests : Custom Requests Management
-
Employee skills : Employee skills
-
Employees : Employees Management
-
Employees categories : Employees categories (Employees classification)
-
Expense reports : Expense reports Management
-
Expense types expected : Expense types expected
-
Expenses : Expenses Management
-
Leaves : Leaves Management
-
Project events : Project Events Management
-
Remote work : Remote work entries Management
-
Schedules : Schedules Management
-
Timesheets : Timesheets Management
-
Timesheets Settings : Timesheets Management Settings
1.4. 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+0200" -
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. Business Cards
2.1.1. Create a business card
PUT |
/employees/{employee_id}/business-cards |
Description
Create a business card using the list of parameters below.
DMF required:
-
DMF A40701: Api Workforce / Business Cards / Insert
-
DMF 160875: Tools / Resources / Modify Business Cards
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
employee_id |
Id of an employee |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
business-card |
The business card to create BusinessCard |
X |
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Business card successfully created |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"id" : "5000123",
"employeeId" : "5000123",
"cardNumber" : "XXXX XXXX XXXX 7568",
"encryptedCardNumber" : "0",
"name" : "Management card",
"type" : "{}",
"endDate" : "2020-01-31T23:59:59Z"
}
2.1.2. Delete a business card
DELETE |
/employees/{employee_id}/business-cards/{business_card_id} |
Description
Delete the business card of an employee given as a parameter and matching specified IDs (employee and business card).
DMF required:
-
DMF A40703: Api Workforce / Business Cards / Delete
-
DMF 160875: Tools / Resources / Modify Business Cards
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
employee_id |
Id of an employee |
X |
null |
|
business_card_id |
Id of a business card |
X |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Business card successfully deleted |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.1.3. Search for business card (with search criteria)
POST |
/employees/business-cards/search |
Description
Get the list of business card matching the search criteria.
DMF required:
-
DMF A40704: Api Workforce / Business Cards / Search
-
DMF 160874: Tools / Resources / Show Business Cards
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
criteria |
Criteria that you choose (Employee ID, name, etc…) BusinessCardCriteria |
X |
Return Type
array[BusinessCard]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Business card successfully loaded |
List[BusinessCard] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"encryptedCardNumber" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"endDate" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
},
"name" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"employeeId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"id" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"type" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
}
}
2.1.4. Update a business card
POST |
/employees/{employee_id}/business-cards/{business_card_id} |
Description
Update the business card of an employee matching specified IDs\ \ (employee and business card) and using the list of parameters below.
DMF required:
-
DMF A40702: Api Workforce / Business Cards / Update
-
DMF 160875: Tools / Resources / Modify Business Cards
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
employee_id |
Id of an employee |
X |
null |
|
business_card_id |
Id of a business card |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
business-card |
The business card to update BusinessCard |
X |
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Business card successfully updated |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"id" : "5000123",
"employeeId" : "5000123",
"cardNumber" : "XXXX XXXX XXXX 7568",
"encryptedCardNumber" : "0",
"name" : "Management card",
"type" : "{}",
"endDate" : "2020-01-31T23:59:59Z"
}
2.2. Custom Request Settings
2.2.1. Create a Custom Request Category
PUT |
/settings/custom-request-categories |
Description
Create a Custom Request Category
DMF required:
-
DMF A41101: Api Workforce / Custom Request Categories / Insert
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
customRequestCategory |
The Custom Request Category to create CustomRequestCategory |
X |
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Custom Request Category has been successfully created |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"id" : "50000012",
"code" : "CATEGORY_1",
"name" : "Category one",
"endDate" : "2000-06-21T04:56:07.000+00:00",
"icon" : "fas fa-pen",
"companyId" : "companyId",
"enableActualDates" : true,
"enableEndDate" : true,
"editableWithoutExpense" : true,
"defaultValueWithoutExpense" : true,
"scheduleCreation" : true,
"timesheetCreation" : true,
"departureLocation" : true,
"departureLocationType" : "{}",
"destinationLocation" : true,
"destinationLocationType" : "{}",
"accreditationLevelType" : 1,
"accreditationOptions" : "{}",
"displayCustomData" : true,
"customDataStart" : 1,
"customDataEnd" : 9,
"customDataNbColumns" : 2
}
2.2.2. Delete a Custom Request Category
DELETE |
/settings/custom-request-categories/{custom_request_category_id} |
Description
Delete a Custom Request Category
DMF required:
-
DMF A41103: Api Workforce / Custom Request Categories / Delete
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
custom_request_category_id |
Id of a custom request's category |
X |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Custom Request Category has been successfully deleted |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.2.3. Get a Custom Request Category
GET |
/settings/custom-request-categories/{custom_request_category_id} |
Description
Get a Custom Request Category
DMF required:
-
DMF A41106: Api Workforce / Custom Request Categories / Info
-
DMF 1911__: Web Portal / Custom Requests
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
custom_request_category_id |
Id of a custom request's category |
X |
null |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Custom Request Category has been successfully loaded |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.2.4. Get an expense report template
GET |
/settings/expense-report-templates/{expense_report_template_id} |
Description
Get an expense report template
DMF required:
-
DMF A62906: Api Settings / Template Expense Reports / Info
-
DMF 191101: Web Portal / Custom Requests / New
-
DMF 191103: Web Portal / Custom Requests / Modify
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
expense_report_template_id |
The id of an Expense Report's Template |
X |
null |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
The expense report template has been successfully loaded |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.2.5. Search for my Custom Request Categories
GET |
/settings/custom-request-categories/mine |
Description
Get the list of my Custom Request Categories
DMF required:
-
DMF A41110: Api Workforce / Custom Request Categories / Mine
-
DMF 1911__: Web Portal / Custom Requests
Return Type
array[CustomRequestCategory]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Custom Request Categories have been successfully loaded |
List[CustomRequestCategory] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.2.6. Search for Custom Request Categories
POST |
/settings/custom-request-categories/search |
Description
Get the list of Custom Request Categories matching the search criteria
DMF required:
-
DMF A41104: Api Workforce / Custom Request Categories / Search
-
DMF 1911__: Web Portal / Custom Requests
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
criteria |
Criteria that you choose (id, code, etc…) CustomRequestCategoryCriteria |
X |
Return Type
array[CustomRequestCategory]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Custom Request Categories have been successfully loaded |
List[CustomRequestCategory] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"destinationLocationType" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"code" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"enableEndDate" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"timesheetCreation" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"departureLocation" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"endDate" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
},
"enableActualDates" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"displayCustomData" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"destinationLocation" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"accreditationLevelType" : {
"operator" : "IS",
"value" : 12.6,
"includeNullResults" : false
},
"editableWithoutExpense" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"companyId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"departureLocationType" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"name" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"defaultValueWithoutExpense" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"id" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"validity" : {
"type" : "{}",
"date" : "2000-06-21T04:56:07.000+00:00"
},
"scheduleCreation" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"accreditationOptions" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
}
}
2.2.7. Search for expense report templates
POST |
/settings/expense-report-templates/search |
Description
Get the list of expense report templates matching the search criteria
DMF required:
-
DMF A62904: Api Settings / Template Expense Reports / Search
-
DMF 191101: Web Portal / Custom Requests / New
-
DMF 191103: Web Portal / Custom Requests / Modify
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
criteria |
Criteria that you choose (id, code, etc…) ExpenseReportTemplateCriteria |
X |
Return Type
array[ExpenseReportTemplate]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
The expense report templates have been successfully loaded |
List[ExpenseReportTemplate] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"companyId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"code" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"endDate" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
},
"name" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"id" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"readOption" : {
"options" : [ "LINE", "LINE" ]
}
}
2.2.8. Update a Custom Request Category
POST |
/settings/custom-request-categories/{custom_request_category_id} |
Description
Update a Custom Request Category
DMF required:
-
DMF A41102: Api Workforce / Custom Request Categories / Update
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
custom_request_category_id |
Id of a custom request's category |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
customRequestCategory |
The Custom Request Category to update CustomRequestCategory |
X |
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Custom Request Category has been successfully updated |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"id" : "50000012",
"code" : "CATEGORY_1",
"name" : "Category one",
"endDate" : "2000-06-21T04:56:07.000+00:00",
"icon" : "fas fa-pen",
"companyId" : "companyId",
"enableActualDates" : true,
"enableEndDate" : true,
"editableWithoutExpense" : true,
"defaultValueWithoutExpense" : true,
"scheduleCreation" : true,
"timesheetCreation" : true,
"departureLocation" : true,
"departureLocationType" : "{}",
"destinationLocation" : true,
"destinationLocationType" : "{}",
"accreditationLevelType" : 1,
"accreditationOptions" : "{}",
"displayCustomData" : true,
"customDataStart" : 1,
"customDataEnd" : 9,
"customDataNbColumns" : 2
}
2.3. Custom Requests
2.3.1. Cancel completion of a custom request
POST |
/custom-requests/{custom_request_id}/cancel-completion |
Description
Cancel completion of a custom request asking approvals.
DMF required:
-
DMF A40602: Api Workforce / Custom Requests / Update
-
DMF 161404: Tools / Custom Requests / Modify
-
DMF 161411: Tools / Custom Requests / Modify Completed Request
-
DMF 161417: Tools / Custom Requests / Modify Archived Request
-
DMF 191103: Web Portal / Custom Requests / Modify
-
DMF 191108: Web Portal / Custom Requests / Cancel 'approved' Request
-
DMF 191109: Web Portal / Custom Requests / Cancel 'to Be Approved' Request
-
DMF 191110: Web Portal / Custom Requests / Cancel 'denied' Request
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
custom_request_id |
Id of a custom request |
X |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Completion successfully canceled |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.3.2. Cancel a custom request
POST |
/custom-requests/{custom_request_id}/cancel |
Description
Cancel a custom request
DMF required:
-
DMF A40602: Api Workforce / Custom Requests / Update
-
DMF 161404: Tools / Custom Requests / Modify
-
DMF 161411: Tools / Custom Requests / Modify Completed Request
-
DMF 161417: Tools / Custom Requests / Modify Archived Request
-
DMF 191103: Web Portal / Custom Requests / Modify
-
DMF 191108: Web Portal / Custom Requests / Cancel 'approved' Request
-
DMF 191109: Web Portal / Custom Requests / Cancel 'to Be Approved' Request
-
DMF 191110: Web Portal / Custom Requests / Cancel 'denied' Request
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
custom_request_id |
Id of a custom request |
X |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Custom request successfully canceled |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.3.3. Complete a custom request
POST |
/custom-requests/{custom_request_id}/complete |
Description
Complete a custom request asking approvals.
DMF required:
-
DMF A40602: Api Workforce / Custom Requests / Update
-
DMF 161404: Tools / Custom Requests / Modify
-
DMF 161411: Tools / Custom Requests / Modify Completed Request
-
DMF 161417: Tools / Custom Requests / Modify Archived Request
-
DMF 191103: Web Portal / Custom Requests / Modify
-
DMF 191108: Web Portal / Custom Requests / Cancel 'approved' Request
-
DMF 191109: Web Portal / Custom Requests / Cancel 'to Be Approved' Request
-
DMF 191110: Web Portal / Custom Requests / Cancel 'denied' Request
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
custom_request_id |
Id of a custom request |
X |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Custom request successfully completed |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.3.4. Create a customRequest
PUT |
/custom-requests |
Description
Create a custom request
DMF required:
-
DMF A40601: Api Workforce / Custom Requests / Insert
-
DMF 161402: Tools / Custom Requests / New
-
DMF 191101: Web Portal / Custom Requests / New
-
DMF 191102: Web Portal / Custom Requests / Duplicate
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
customRequest |
The Custom Request to create CustomRequest |
X |
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Custom Request has been successfully created |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"id" : "5000123",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJT_001",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"subPhase" : {
"id" : "5000123",
"code" : "SB_1",
"name" : "Sub Phase 1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"order" : 1
},
"subPhaseId" : "51000122",
"projectTask" : {
"id" : "5000123",
"code" : "code",
"name" : "Team building",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJT_001",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"subPhase" : {
"id" : "5000123",
"code" : "SB_1",
"name" : "Sub Phase 1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"order" : 1
},
"subPhaseId" : "51000122",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"order" : 2,
"startDate" : "2000-06-21T04:56:07.000+00:00",
"endDate" : "2000-06-21T04:56:07.000+00:00",
"description" : "description"
},
"projectTaskId" : "5000123",
"number" : "CC00001",
"name" : "Label for my doc",
"type" : "{}",
"companyCode" : "AKSAS",
"companyId" : "5000123",
"currencyCode" : "EUR",
"currency" : {
"id" : "5000123",
"name" : "Euro",
"code" : "EUR",
"order" : 17,
"euro" : true,
"euroRate" : 0.9678,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"euroRateStartDate" : "2020-01-23T04:56:07Z",
"euroRateEndDate" : "2020-01-23T04:56:07Z"
},
"date" : "2000-06-21T04:56:07.000+00:00",
"description" : "Lorem ipsum",
"entityCode" : "Lyon",
"afterTaxAmount" : 120.37,
"preTaxAmount" : 100.14,
"thirdPartyId" : "CUSTOMER01",
"customData" : {
"key" : {
"type" : "{}",
"value" : "Autoref 010520",
"name" : "Reference 4",
"realOrder" : 0,
"label" : "REFERENCE_4"
}
},
"changeTracking" : {
"createdTime" : "2000-06-21T04:56:07.000+00:00",
"createdBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"createdById" : "5000123",
"modificationTime" : "2000-06-21T04:56:07.000+00:00",
"modificationBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"modificationById" : "5000123"
},
"approvalState" : "{}",
"approvalDate" : "2000-06-21T04:56:07.000+00:00",
"lines" : [ {
"id" : "5000123",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJT_001",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"subPhase" : {
"id" : "5000123",
"code" : "SB_1",
"name" : "Sub Phase 1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"order" : 1
},
"subPhaseId" : "51000122",
"projectTask" : {
"id" : "5000123",
"code" : "code",
"name" : "Team building",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJT_001",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"subPhase" : {
"id" : "5000123",
"code" : "SB_1",
"name" : "Sub Phase 1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"order" : 1
},
"subPhaseId" : "51000122",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"order" : 2,
"startDate" : "2000-06-21T04:56:07.000+00:00",
"endDate" : "2000-06-21T04:56:07.000+00:00",
"description" : "description"
},
"projectTaskId" : "5000123",
"managementObjectId" : "5000123",
"name" : "Helpdesk",
"quantity" : 3,
"unitPriceCurrency" : 36.32,
"unitPrice" : 40,
"amountTotalCurrency" : 1200,
"amountTotal" : 1200,
"rankNumber" : 2,
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"expenseTypeExpected" : {
"id" : "5000123",
"code" : "AIR-PL",
"name" : "Airplane",
"description" : "Transportation",
"endDate" : "2000-06-21T04:56:07.000+00:00",
"expenseType" : {
"id" : "5000123",
"code" : "MEAL",
"description" : "Plane",
"km" : false,
"notRefundable" : true,
"icon" : "fa fa-plane",
"color" : "00ff40",
"receiptRequired" : false,
"commentRequired" : false,
"guestsRequired" : false,
"notRefundableEditable" : true,
"billableEditable" : true,
"amountEditable" : true,
"showQuantity" : false,
"showAdditionalComment" : false,
"showReceiptNumber" : true,
"showAmountCategory" : true,
"showBillable" : true,
"hideVat" : false,
"vat1Code" : "1",
"vat2Code" : "2",
"vat3Code" : "3",
"expenseThreshold" : 100,
"defaultAmount" : 45,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"expenseCategory" : "{}",
"expenseRebillableOptions" : "{}",
"showCustomRequest" : true,
"showAmountWithoutVat" : true,
"controlsBehavior" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"calculateKilometers" : true,
"freeEntryProhibited" : true,
"controls" : {
"enableDuplicate" : true,
"enablelOnNonWorkingDay" : true,
"enableOnDayWithLeaveRequest" : true,
"enableOnDayWithTimesheetOrSchedule" : true
},
"expenseThresholdExceededNoVat" : false
},
"expenseTypeId" : "expenseTypeId",
"editableExpenseReport" : true,
"defaultExpenseReport" : true
},
"expenseTypeExpectedId" : "5000123",
"isExpenseReport" : true
}, {
"id" : "5000123",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJT_001",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"subPhase" : {
"id" : "5000123",
"code" : "SB_1",
"name" : "Sub Phase 1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"order" : 1
},
"subPhaseId" : "51000122",
"projectTask" : {
"id" : "5000123",
"code" : "code",
"name" : "Team building",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJT_001",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"subPhase" : {
"id" : "5000123",
"code" : "SB_1",
"name" : "Sub Phase 1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"order" : 1
},
"subPhaseId" : "51000122",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"order" : 2,
"startDate" : "2000-06-21T04:56:07.000+00:00",
"endDate" : "2000-06-21T04:56:07.000+00:00",
"description" : "description"
},
"projectTaskId" : "5000123",
"managementObjectId" : "5000123",
"name" : "Helpdesk",
"quantity" : 3,
"unitPriceCurrency" : 36.32,
"unitPrice" : 40,
"amountTotalCurrency" : 1200,
"amountTotal" : 1200,
"rankNumber" : 2,
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"expenseTypeExpected" : {
"id" : "5000123",
"code" : "AIR-PL",
"name" : "Airplane",
"description" : "Transportation",
"endDate" : "2000-06-21T04:56:07.000+00:00",
"expenseType" : {
"id" : "5000123",
"code" : "MEAL",
"description" : "Plane",
"km" : false,
"notRefundable" : true,
"icon" : "fa fa-plane",
"color" : "00ff40",
"receiptRequired" : false,
"commentRequired" : false,
"guestsRequired" : false,
"notRefundableEditable" : true,
"billableEditable" : true,
"amountEditable" : true,
"showQuantity" : false,
"showAdditionalComment" : false,
"showReceiptNumber" : true,
"showAmountCategory" : true,
"showBillable" : true,
"hideVat" : false,
"vat1Code" : "1",
"vat2Code" : "2",
"vat3Code" : "3",
"expenseThreshold" : 100,
"defaultAmount" : 45,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"expenseCategory" : "{}",
"expenseRebillableOptions" : "{}",
"showCustomRequest" : true,
"showAmountWithoutVat" : true,
"controlsBehavior" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"calculateKilometers" : true,
"freeEntryProhibited" : true,
"controls" : {
"enableDuplicate" : true,
"enablelOnNonWorkingDay" : true,
"enableOnDayWithLeaveRequest" : true,
"enableOnDayWithTimesheetOrSchedule" : true
},
"expenseThresholdExceededNoVat" : false
},
"expenseTypeId" : "expenseTypeId",
"editableExpenseReport" : true,
"defaultExpenseReport" : true
},
"expenseTypeExpectedId" : "5000123",
"isExpenseReport" : true
} ],
"category" : {
"id" : "50000012",
"code" : "CATEGORY_1",
"name" : "Category one",
"endDate" : "2000-06-21T04:56:07.000+00:00",
"icon" : "fas fa-pen",
"companyId" : "companyId",
"enableActualDates" : true,
"enableEndDate" : true,
"editableWithoutExpense" : true,
"defaultValueWithoutExpense" : true,
"scheduleCreation" : true,
"timesheetCreation" : true,
"departureLocation" : true,
"departureLocationType" : "{}",
"destinationLocation" : true,
"destinationLocationType" : "{}",
"accreditationLevelType" : 1,
"accreditationOptions" : "{}",
"displayCustomData" : true,
"customDataStart" : 1,
"customDataEnd" : 9,
"customDataNbColumns" : 2
},
"categoryId" : "5000123",
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}",
"title" : "GEN",
"phone" : "+33 6 04 04 04 05",
"mobilePhone" : "+33 6 00 00 00 01",
"email" : "myemail@bechmail.com",
"noTimesDunning" : true,
"assignmentMultiCompany" : false,
"modeTimeRecording" : 1,
"modeInputSchedule" : 3,
"timeRecordingInputMode" : "{}",
"scheduleInputMode" : "{}",
"executive" : true,
"generic" : true,
"candidate" : false,
"external" : false,
"managerMultiCompany" : true,
"employeeFunctions" : {
"allFunctions" : false,
"allSales" : true,
"allPurchases" : false,
"allOperational" : true,
"projectSalesManager" : false,
"projectFinanceManager" : true,
"projectProductionManager" : false,
"projectAccountManager" : true,
"projectAssignment" : false,
"projectPhaseManager" : true,
"projectSendOnMission" : false,
"salesSalesAssistant" : true,
"salesOrderAndEstimateTracking" : false,
"salesBillingSchedulesTracking" : true,
"purchasingBuyer" : false,
"timeRecording" : true,
"inputOfExpenseReport" : false,
"purchasesReceptionTracking" : false,
"inputSchedule" : false,
"CMMSContractSalesManager" : false,
"CMMSContractTechnicalManager" : false,
"CMMSMRAndEOManager" : false
},
"employeeHistory" : [ {
"id" : "5000123",
"employeeHistoryType" : "5000123",
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 7.42,
"weekHours" : 38.3,
"occupancyRate" : 0.8,
"manager" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"managerId" : "5000123",
"company" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo"
},
"companyId" : "5000123",
"directHourlyRate" : 10.42,
"standardHourlyRate" : 10,
"dailyCost" : 59.36,
"dailySellingPrice" : 80,
"entity" : "5000123",
"serviceRef" : {
"id" : "5000123",
"name" : "Professional services",
"code" : "PS"
},
"service" : "5000123",
"position" : "Developer",
"skillRef" : {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
},
"skill" : "5000123",
"family1" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family1Id" : "5000123",
"family2" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family2Id" : "5000123",
"family3" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family3Id" : "5000123",
"leave" : false,
"standardWeek" : {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
}
},
"standardWeekId" : "5000123",
"salary" : 1024
}, {
"id" : "5000123",
"employeeHistoryType" : "5000123",
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 7.42,
"weekHours" : 38.3,
"occupancyRate" : 0.8,
"manager" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"managerId" : "5000123",
"company" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo"
},
"companyId" : "5000123",
"directHourlyRate" : 10.42,
"standardHourlyRate" : 10,
"dailyCost" : 59.36,
"dailySellingPrice" : 80,
"entity" : "5000123",
"serviceRef" : {
"id" : "5000123",
"name" : "Professional services",
"code" : "PS"
},
"service" : "5000123",
"position" : "Developer",
"skillRef" : {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
},
"skill" : "5000123",
"family1" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family1Id" : "5000123",
"family2" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family2Id" : "5000123",
"family3" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family3Id" : "5000123",
"leave" : false,
"standardWeek" : {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
}
},
"standardWeekId" : "5000123",
"salary" : 1024
} ],
"companyChanges" : [ {
"id" : "5000123",
"employeeId" : "500123",
"companyId" : "5000123",
"startDate" : "2020-01-23T04:56:07Z",
"endDate" : "2020-01-23T04:56:07Z",
"companyChangeState" : "{}",
"comment" : "Limpso usum"
}, {
"id" : "5000123",
"employeeId" : "500123",
"companyId" : "5000123",
"startDate" : "2020-01-23T04:56:07Z",
"endDate" : "2020-01-23T04:56:07Z",
"companyChangeState" : "{}",
"comment" : "Limpso usum"
} ],
"timeRecordingRules" : {
"id" : "5000123",
"employeeId" : "5000123",
"min" : 0,
"max" : 24,
"step" : 0.01,
"prettyStep" : 0.3,
"base" : 60,
"unit" : "H",
"unitDuration" : "{}",
"allowManualEntry" : true,
"employeeWeeks" : [ {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
},
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 8,
"dailyMinutes" : 10,
"weekHours" : 40,
"leave" : false
}, {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
},
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 8,
"dailyMinutes" : 10,
"weekHours" : 40,
"leave" : false
} ],
"closingDates" : [ {
"closingDate" : "2020-01-31T23:59:59Z",
"module" : "DATE_MODULE",
"beginningOfPeriod" : "2020-01-31T23:59:59Z",
"endOfPeriod" : "2020-01-31T23:59:59Z"
}, {
"closingDate" : "2020-01-31T23:59:59Z",
"module" : "DATE_MODULE",
"beginningOfPeriod" : "2020-01-31T23:59:59Z",
"endOfPeriod" : "2020-01-31T23:59:59Z"
} ],
"simpleDuration" : 750,
"completionMode" : "WEEKLY"
},
"scheduleRules" : {
"id" : "5000123",
"employeeId" : "5000123",
"min" : 0,
"max" : 24,
"step" : 0.01,
"prettyStep" : 0.3,
"base" : 60,
"unit" : "H",
"unitDuration" : "{}",
"allowManualEntry" : true,
"employeeWeeks" : [ {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
},
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 8,
"dailyMinutes" : 10,
"weekHours" : 40,
"leave" : false
}, {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
},
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 8,
"dailyMinutes" : 10,
"weekHours" : 40,
"leave" : false
} ],
"closingDates" : [ {
"closingDate" : "2020-01-31T23:59:59Z",
"module" : "DATE_MODULE",
"beginningOfPeriod" : "2020-01-31T23:59:59Z",
"endOfPeriod" : "2020-01-31T23:59:59Z"
}, {
"closingDate" : "2020-01-31T23:59:59Z",
"module" : "DATE_MODULE",
"beginningOfPeriod" : "2020-01-31T23:59:59Z",
"endOfPeriod" : "2020-01-31T23:59:59Z"
} ],
"timestamped" : true
},
"businessCards" : [ {
"id" : "5000123",
"employeeId" : "5000123",
"cardNumber" : "XXXX XXXX XXXX 7568",
"encryptedCardNumber" : "0",
"name" : "Management card",
"type" : "{}",
"endDate" : "2020-01-31T23:59:59Z"
}, {
"id" : "5000123",
"employeeId" : "5000123",
"cardNumber" : "XXXX XXXX XXXX 7568",
"encryptedCardNumber" : "0",
"name" : "Management card",
"type" : "{}",
"endDate" : "2020-01-31T23:59:59Z"
} ],
"sector" : "Marketing",
"number" : "84",
"relations" : [ {
"id" : "5000123",
"relationType" : {
"id" : "5000123",
"code" : "TUTOR",
"name" : "Tutor for internship"
},
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"relatedEmployee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"relatedEmployeeId" : "5000123"
}, {
"id" : "5000123",
"relationType" : {
"id" : "5000123",
"code" : "TUTOR",
"name" : "Tutor for internship"
},
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"relatedEmployee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"relatedEmployeeId" : "5000123"
} ],
"employeeAbilities" : [ {
"id" : "5000123",
"skill" : {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
},
"level" : {
"id" : "5000123",
"code" : "EXP",
"name" : "Expert"
},
"startDate" : "2020-01-31T23:59:59Z",
"endDate" : "2020-01-31T23:59:59Z",
"employeeId" : "5000123"
}, {
"id" : "5000123",
"skill" : {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
},
"level" : {
"id" : "5000123",
"code" : "EXP",
"name" : "Expert"
},
"startDate" : "2020-01-31T23:59:59Z",
"endDate" : "2020-01-31T23:59:59Z",
"employeeId" : "5000123"
} ],
"jobType" : {
"id" : "5000123",
"companyCode" : "AKSAS",
"code" : "ADMIN",
"name" : "Administrator",
"category" : "{}",
"validity" : {
"type" : "{}",
"date" : "2000-06-21T04:56:07.000+00:00"
},
"default" : true
},
"jobTypeId" : "100245",
"address" : {
"id" : "id",
"line1" : "221B Baker Street",
"line2" : "2nd Floor",
"line3" : "First door at your right",
"cedex" : "CEDEX 14",
"postalCode" : "69002",
"city" : "London",
"country" : "FR (for 'FRANCE')",
"countryName" : "FRANCE",
"department" : "75 (for 'PARIS')",
"geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
"region" : "65 (for 'ILE DE FRANCE')",
"regionName" : "ILE DE FRANCE",
"phone" : "06 00 00 00 01",
"phone2" : "06 00 00 00 02",
"email" : "myemail@mail.com",
"mobilePhone" : "06 00 00 00 02",
"fax" : "04 00 00 00 07",
"webSite" : "mysite.com"
},
"addressId" : "5000123",
"birthDate" : "2000-06-21T04:56:07.000+00:00",
"customData" : {
"key" : {
"type" : "{}",
"value" : "Autoref 010520",
"name" : "Reference 4",
"realOrder" : 0,
"label" : "REFERENCE_4"
}
},
"color" : "#FF0000",
"targetTace" : 75,
"formConfig" : {
"type" : "{}",
"fields" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"controls" : {
"key" : {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}
},
"insertable" : true,
"editable" : false,
"deletable" : false,
"formSearchHidden" : false
},
"changeTracking" : {
"createdTime" : "2000-06-21T04:56:07.000+00:00",
"createdBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"createdById" : "5000123",
"modificationTime" : "2000-06-21T04:56:07.000+00:00",
"modificationBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"modificationById" : "5000123"
},
"vehicles" : [ {
"id" : "5000123",
"power" : 5,
"licensePlate" : "licensePlate",
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"expenseType" : {
"id" : "5000123",
"code" : "MEAL",
"description" : "Plane",
"km" : false,
"notRefundable" : true,
"icon" : "fa fa-plane",
"color" : "00ff40",
"receiptRequired" : false,
"commentRequired" : false,
"guestsRequired" : false,
"notRefundableEditable" : true,
"billableEditable" : true,
"amountEditable" : true,
"showQuantity" : false,
"showAdditionalComment" : false,
"showReceiptNumber" : true,
"showAmountCategory" : true,
"showBillable" : true,
"hideVat" : false,
"vat1Code" : "1",
"vat2Code" : "2",
"vat3Code" : "3",
"expenseThreshold" : 100,
"defaultAmount" : 45,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"expenseCategory" : "{}",
"expenseRebillableOptions" : "{}",
"showCustomRequest" : true,
"showAmountWithoutVat" : true,
"controlsBehavior" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"calculateKilometers" : true,
"freeEntryProhibited" : true,
"controls" : {
"enableDuplicate" : true,
"enablelOnNonWorkingDay" : true,
"enableOnDayWithLeaveRequest" : true,
"enableOnDayWithTimesheetOrSchedule" : true
},
"expenseThresholdExceededNoVat" : false
},
"expenseTypeId" : "5000123",
"endDate" : "2020-01-31T23:59:59Z"
}, {
"id" : "5000123",
"power" : 5,
"licensePlate" : "licensePlate",
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"expenseType" : {
"id" : "5000123",
"code" : "MEAL",
"description" : "Plane",
"km" : false,
"notRefundable" : true,
"icon" : "fa fa-plane",
"color" : "00ff40",
"receiptRequired" : false,
"commentRequired" : false,
"guestsRequired" : false,
"notRefundableEditable" : true,
"billableEditable" : true,
"amountEditable" : true,
"showQuantity" : false,
"showAdditionalComment" : false,
"showReceiptNumber" : true,
"showAmountCategory" : true,
"showBillable" : true,
"hideVat" : false,
"vat1Code" : "1",
"vat2Code" : "2",
"vat3Code" : "3",
"expenseThreshold" : 100,
"defaultAmount" : 45,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"expenseCategory" : "{}",
"expenseRebillableOptions" : "{}",
"showCustomRequest" : true,
"showAmountWithoutVat" : true,
"controlsBehavior" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"calculateKilometers" : true,
"freeEntryProhibited" : true,
"controls" : {
"enableDuplicate" : true,
"enablelOnNonWorkingDay" : true,
"enableOnDayWithLeaveRequest" : true,
"enableOnDayWithTimesheetOrSchedule" : true
},
"expenseThresholdExceededNoVat" : false
},
"expenseTypeId" : "5000123",
"endDate" : "2020-01-31T23:59:59Z"
} ],
"currentCompany" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo",
"legalName" : "legalName",
"siren" : "siren",
"siret" : "siret",
"calendar" : {
"id" : "5000123",
"code" : "Text",
"name" : "Text",
"default" : true,
"daysNotWorked" : [ 6, 6 ],
"holidays" : [ {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
}, {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
} ]
},
"calendarId" : "calendarId",
"color" : "color",
"currency" : {
"id" : "5000123",
"name" : "Euro",
"code" : "EUR",
"order" : 17,
"euro" : true,
"euroRate" : 0.9678,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"euroRateStartDate" : "2020-01-23T04:56:07Z",
"euroRateEndDate" : "2020-01-23T04:56:07Z"
},
"currencyId" : "currencyId",
"address" : {
"id" : "id",
"line1" : "221B Baker Street",
"line2" : "2nd Floor",
"line3" : "First door at your right",
"cedex" : "CEDEX 14",
"postalCode" : "69002",
"city" : "London",
"country" : "FR (for 'FRANCE')",
"countryName" : "FRANCE",
"department" : "75 (for 'PARIS')",
"geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
"region" : "65 (for 'ILE DE FRANCE')",
"regionName" : "ILE DE FRANCE",
"phone" : "06 00 00 00 01",
"phone2" : "06 00 00 00 02",
"email" : "myemail@mail.com",
"mobilePhone" : "06 00 00 00 02",
"fax" : "04 00 00 00 07",
"webSite" : "mysite.com"
},
"addressId" : "addressId"
},
"currentCompanyId" : "5000123",
"bankingInformation" : {
"id" : "5000123",
"sepa" : {
"bankDetails" : {
"entity" : "30002",
"counter" : "550",
"accountNumber" : "0000157841Z",
"key" : "25",
"domiciliation" : "AURA"
},
"bic" : {
"country" : "FR (for 'FRANCE')",
"bank" : "DAAE",
"location" : "PP",
"branch" : "CCT"
},
"iban" : {
"country" : "FR (for 'FRANCE')",
"key" : "69",
"accountNumber" : "0000157841Z"
}
},
"noneSepa" : {
"defaultBankDetail" : false,
"beneficiary" : {
"holder" : {
"name" : "RITA",
"firstName" : "BRITA",
"accountType" : "{}",
"accountNumber" : "123456789"
},
"bank" : {
"bankName" : "UBA",
"bankName2" : "UBA",
"bankType" : "{}",
"bankCode" : "C8",
"bankAddress" : {
"id" : "id",
"line1" : "221B Baker Street",
"line2" : "2nd Floor",
"line3" : "First door at your right",
"cedex" : "CEDEX 14",
"postalCode" : "69002",
"city" : "London",
"country" : "FR (for 'FRANCE')",
"countryName" : "FRANCE",
"department" : "75 (for 'PARIS')",
"geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
"region" : "65 (for 'ILE DE FRANCE')",
"regionName" : "ILE DE FRANCE",
"phone" : "06 00 00 00 01",
"phone2" : "06 00 00 00 02",
"email" : "myemail@mail.com",
"mobilePhone" : "06 00 00 00 02",
"fax" : "04 00 00 00 07",
"webSite" : "mysite.com"
}
}
},
"intermediate" : {
"holder" : {
"name" : "RITA",
"firstName" : "BRITA",
"accountType" : "{}",
"accountNumber" : "123456789"
},
"bank" : {
"bankName" : "UBA",
"bankName2" : "UBA",
"bankType" : "{}",
"bankCode" : "C8",
"bankAddress" : {
"id" : "id",
"line1" : "221B Baker Street",
"line2" : "2nd Floor",
"line3" : "First door at your right",
"cedex" : "CEDEX 14",
"postalCode" : "69002",
"city" : "London",
"country" : "FR (for 'FRANCE')",
"countryName" : "FRANCE",
"department" : "75 (for 'PARIS')",
"geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
"region" : "65 (for 'ILE DE FRANCE')",
"regionName" : "ILE DE FRANCE",
"phone" : "06 00 00 00 01",
"phone2" : "06 00 00 00 02",
"email" : "myemail@mail.com",
"mobilePhone" : "06 00 00 00 02",
"fax" : "04 00 00 00 07",
"webSite" : "mysite.com"
}
}
}
},
"statusChangeDate" : "2000-06-21T04:56:07.000+00:00",
"statusChangeArgument" : {
"comment" : "Comment",
"status" : "{}"
},
"validator" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"validatorId" : "5000123",
"action" : "{}",
"type" : "{}"
},
"faxNumber" : "418 643 3210",
"phoneExtensionNumber" : "04 00 00 00 07"
},
"employeeId" : "5000123",
"departureDate" : "2020-01-31T23:59:59Z",
"departureActualDate" : "2020-01-31T23:59:59Z",
"departureCity" : {
"id" : "5000123",
"name" : "City 1",
"default" : true,
"postcode" : "73000",
"country" : {
"id" : "5000123",
"name" : "Country 1",
"currency" : {
"id" : "5000123",
"name" : "Euro",
"code" : "EUR",
"order" : 17,
"euro" : true,
"euroRate" : 0.9678,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"euroRateStartDate" : "2020-01-23T04:56:07Z",
"euroRateEndDate" : "2020-01-23T04:56:07Z"
},
"currencyId" : "5000123",
"calendar" : {
"id" : "5000123",
"code" : "Text",
"name" : "Text",
"default" : true,
"daysNotWorked" : [ 6, 6 ],
"holidays" : [ {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
}, {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
} ]
},
"calendarId" : "5000123",
"code" : "FR",
"companyCode" : "AKSAS",
"companyId" : "5000123",
"isPartOfEU" : true,
"continent" : "AFRICA"
},
"countryId" : "5000123",
"department" : {
"id" : "5000123",
"code" : "01-A",
"companyCode" : "AKSAS",
"name" : "Lorem Ipsum",
"analysis" : "analysis",
"comment" : "comment",
"entity" : {
"id" : "5000123",
"code" : "01-BRDX",
"name" : "Bordeaux",
"legalName" : "Customer care",
"division" : {
"id" : "5000123",
"name" : "Rhone-Alpes",
"code" : "RA",
"group" : {
"id" : "5000123",
"name" : "West",
"code" : "WST",
"serviceId" : "5000123"
},
"groupId" : "5000123",
"companyId" : "5000123"
},
"divisionId" : "5000123",
"divisionCode" : "01-DIV",
"companyId" : "5000123",
"endDate" : "2020-01-23T04:56:07Z"
},
"entityId" : "entityId",
"projectType" : "{}",
"activities" : [ {
"id" : "5000123",
"code" : "code",
"name" : "name"
}, {
"id" : "5000123",
"code" : "code",
"name" : "name"
} ]
},
"departmentId" : "5000123",
"regionId" : "123456",
"companyCode" : "AKSAS",
"latitude" : "5.9845W",
"longitude" : "37.3891N"
},
"departureLocation" : "Lyon",
"arrivalDate" : "2020-01-31T23:59:59Z",
"arrivalActualDate" : "2020-01-31T23:59:59Z",
"arrivalCity" : {
"id" : "5000123",
"name" : "City 1",
"default" : true,
"postcode" : "73000",
"country" : {
"id" : "5000123",
"name" : "Country 1",
"currency" : {
"id" : "5000123",
"name" : "Euro",
"code" : "EUR",
"order" : 17,
"euro" : true,
"euroRate" : 0.9678,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"euroRateStartDate" : "2020-01-23T04:56:07Z",
"euroRateEndDate" : "2020-01-23T04:56:07Z"
},
"currencyId" : "5000123",
"calendar" : {
"id" : "5000123",
"code" : "Text",
"name" : "Text",
"default" : true,
"daysNotWorked" : [ 6, 6 ],
"holidays" : [ {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
}, {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
} ]
},
"calendarId" : "5000123",
"code" : "FR",
"companyCode" : "AKSAS",
"companyId" : "5000123",
"isPartOfEU" : true,
"continent" : "AFRICA"
},
"countryId" : "5000123",
"department" : {
"id" : "5000123",
"code" : "01-A",
"companyCode" : "AKSAS",
"name" : "Lorem Ipsum",
"analysis" : "analysis",
"comment" : "comment",
"entity" : {
"id" : "5000123",
"code" : "01-BRDX",
"name" : "Bordeaux",
"legalName" : "Customer care",
"division" : {
"id" : "5000123",
"name" : "Rhone-Alpes",
"code" : "RA",
"group" : {
"id" : "5000123",
"name" : "West",
"code" : "WST",
"serviceId" : "5000123"
},
"groupId" : "5000123",
"companyId" : "5000123"
},
"divisionId" : "5000123",
"divisionCode" : "01-DIV",
"companyId" : "5000123",
"endDate" : "2020-01-23T04:56:07Z"
},
"entityId" : "entityId",
"projectType" : "{}",
"activities" : [ {
"id" : "5000123",
"code" : "code",
"name" : "name"
}, {
"id" : "5000123",
"code" : "code",
"name" : "name"
} ]
},
"departmentId" : "5000123",
"regionId" : "123456",
"companyCode" : "AKSAS",
"latitude" : "5.9845W",
"longitude" : "37.3891N"
},
"arrivalLocation" : "Oslo",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"documents" : [ {
"id" : "5000123",
"title" : "Title",
"versionId" : "5000123",
"changeTracking" : {
"createdTime" : "2000-06-21T04:56:07.000+00:00",
"createdBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"createdById" : "5000123",
"modificationTime" : "2000-06-21T04:56:07.000+00:00",
"modificationBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"modificationById" : "5000123"
},
"publishedBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"publishedById" : "5001206",
"classification" : "STD",
"subClassification" : "EDITIONS",
"category1" : "CAT1",
"category2" : "CAT2",
"category3" : "CAT3",
"companyId" : "5000123",
"publicationDate" : "2000-06-21T04:56:07.000+00:00",
"version" : 1,
"documentType" : "File",
"fileUrl" : "myFiles/thisFile.pdf",
"fileName" : "thisFile.pdf",
"lienUrl" : "myStorage.com/myFiles/thisFile.pdf",
"url" : "myFiles/thisFile.pdf",
"original" : false,
"preview" : "data:image",
"tokenPreview" : "8946A85V85D851DF",
"externalDMSUuid" : "OD1245126",
"links" : [ {
"id" : "5000123",
"original" : true,
"documentId" : "5000123",
"objectId" : "5000123",
"objectType" : "{}"
}, {
"id" : "5000123",
"original" : true,
"documentId" : "5000123",
"objectId" : "5000123",
"objectType" : "{}"
} ],
"archived" : false,
"action" : "{}",
"owner" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"ownerId" : "5001206",
"description" : "Text",
"category" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"categoryId" : "100024",
"subCategory" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"company" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo",
"legalName" : "legalName",
"siren" : "siren",
"siret" : "siret",
"calendar" : {
"id" : "5000123",
"code" : "Text",
"name" : "Text",
"default" : true,
"daysNotWorked" : [ 6, 6 ],
"holidays" : [ {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
}, {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
} ]
},
"calendarId" : "calendarId",
"color" : "color",
"currency" : {
"id" : "5000123",
"name" : "Euro",
"code" : "EUR",
"order" : 17,
"euro" : true,
"euroRate" : 0.9678,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"euroRateStartDate" : "2020-01-23T04:56:07Z",
"euroRateEndDate" : "2020-01-23T04:56:07Z"
},
"currencyId" : "currencyId",
"address" : {
"id" : "id",
"line1" : "221B Baker Street",
"line2" : "2nd Floor",
"line3" : "First door at your right",
"cedex" : "CEDEX 14",
"postalCode" : "69002",
"city" : "London",
"country" : "FR (for 'FRANCE')",
"countryName" : "FRANCE",
"department" : "75 (for 'PARIS')",
"geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
"region" : "65 (for 'ILE DE FRANCE')",
"regionName" : "ILE DE FRANCE",
"phone" : "06 00 00 00 01",
"phone2" : "06 00 00 00 02",
"email" : "myemail@mail.com",
"mobilePhone" : "06 00 00 00 02",
"fax" : "04 00 00 00 07",
"webSite" : "mysite.com"
},
"addressId" : "addressId"
},
"companyId" : "5000123",
"type" : "{}",
"category" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"categoryId" : "500143",
"grouping" : "grouping",
"ranking" : 2
},
"subCategoryId" : "11037",
"locked" : false
}, {
"id" : "5000123",
"title" : "Title",
"versionId" : "5000123",
"changeTracking" : {
"createdTime" : "2000-06-21T04:56:07.000+00:00",
"createdBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"createdById" : "5000123",
"modificationTime" : "2000-06-21T04:56:07.000+00:00",
"modificationBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"modificationById" : "5000123"
},
"publishedBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"publishedById" : "5001206",
"classification" : "STD",
"subClassification" : "EDITIONS",
"category1" : "CAT1",
"category2" : "CAT2",
"category3" : "CAT3",
"companyId" : "5000123",
"publicationDate" : "2000-06-21T04:56:07.000+00:00",
"version" : 1,
"documentType" : "File",
"fileUrl" : "myFiles/thisFile.pdf",
"fileName" : "thisFile.pdf",
"lienUrl" : "myStorage.com/myFiles/thisFile.pdf",
"url" : "myFiles/thisFile.pdf",
"original" : false,
"preview" : "data:image",
"tokenPreview" : "8946A85V85D851DF",
"externalDMSUuid" : "OD1245126",
"links" : [ {
"id" : "5000123",
"original" : true,
"documentId" : "5000123",
"objectId" : "5000123",
"objectType" : "{}"
}, {
"id" : "5000123",
"original" : true,
"documentId" : "5000123",
"objectId" : "5000123",
"objectType" : "{}"
} ],
"archived" : false,
"action" : "{}",
"owner" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"ownerId" : "5001206",
"description" : "Text",
"category" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"categoryId" : "100024",
"subCategory" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"company" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo",
"legalName" : "legalName",
"siren" : "siren",
"siret" : "siret",
"calendar" : {
"id" : "5000123",
"code" : "Text",
"name" : "Text",
"default" : true,
"daysNotWorked" : [ 6, 6 ],
"holidays" : [ {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
}, {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
} ]
},
"calendarId" : "calendarId",
"color" : "color",
"currency" : {
"id" : "5000123",
"name" : "Euro",
"code" : "EUR",
"order" : 17,
"euro" : true,
"euroRate" : 0.9678,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"euroRateStartDate" : "2020-01-23T04:56:07Z",
"euroRateEndDate" : "2020-01-23T04:56:07Z"
},
"currencyId" : "currencyId",
"address" : {
"id" : "id",
"line1" : "221B Baker Street",
"line2" : "2nd Floor",
"line3" : "First door at your right",
"cedex" : "CEDEX 14",
"postalCode" : "69002",
"city" : "London",
"country" : "FR (for 'FRANCE')",
"countryName" : "FRANCE",
"department" : "75 (for 'PARIS')",
"geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
"region" : "65 (for 'ILE DE FRANCE')",
"regionName" : "ILE DE FRANCE",
"phone" : "06 00 00 00 01",
"phone2" : "06 00 00 00 02",
"email" : "myemail@mail.com",
"mobilePhone" : "06 00 00 00 02",
"fax" : "04 00 00 00 07",
"webSite" : "mysite.com"
},
"addressId" : "addressId"
},
"companyId" : "5000123",
"type" : "{}",
"category" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"categoryId" : "500143",
"grouping" : "grouping",
"ranking" : 2
},
"subCategoryId" : "11037",
"locked" : false
} ],
"numberOfDocuments" : 2,
"formConfig" : {
"type" : "{}",
"fields" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"controls" : {
"key" : {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}
},
"insertable" : true,
"editable" : false,
"deletable" : false,
"formSearchHidden" : false
},
"cancellationDate" : "2020-01-31T23:59:59Z",
"cancellationUser" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"cancellationUserId" : "5000123",
"archiveDate" : "2020-01-31T23:59:59Z",
"archiveUser" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"archiveUserId" : "5000123",
"comment" : "Lorem ipsum",
"multiProjects" : true
}
2.3.5. Create a custom request line.
PUT |
/custom-requests/{custom_request_id}/custom-request-lines |
Description
Create a custom request line.
This API allows the creation of a single line within a custom request.
DMF required:
-
DMF A40601: Api Workforce / Custom Requests / Insert
-
DMF 161402: Tools / Custom Requests / New
-
DMF 191101: Web Portal / Custom Requests / New
-
DMF 191102: Web Portal / Custom Requests / Duplicate
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
custom_request_id |
Id of a custom request |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
customRequestLine |
The custom request line to create CustomRequestLine |
X |
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
The custom request line has been successfully created |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"id" : "5000123",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJT_001",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"subPhase" : {
"id" : "5000123",
"code" : "SB_1",
"name" : "Sub Phase 1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"order" : 1
},
"subPhaseId" : "51000122",
"projectTask" : {
"id" : "5000123",
"code" : "code",
"name" : "Team building",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJT_001",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"subPhase" : {
"id" : "5000123",
"code" : "SB_1",
"name" : "Sub Phase 1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"order" : 1
},
"subPhaseId" : "51000122",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"order" : 2,
"startDate" : "2000-06-21T04:56:07.000+00:00",
"endDate" : "2000-06-21T04:56:07.000+00:00",
"description" : "description"
},
"projectTaskId" : "5000123",
"managementObjectId" : "5000123",
"name" : "Helpdesk",
"quantity" : 3,
"unitPriceCurrency" : 36.32,
"unitPrice" : 40,
"amountTotalCurrency" : 1200,
"amountTotal" : 1200,
"rankNumber" : 2,
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"expenseTypeExpected" : {
"id" : "5000123",
"code" : "AIR-PL",
"name" : "Airplane",
"description" : "Transportation",
"endDate" : "2000-06-21T04:56:07.000+00:00",
"expenseType" : {
"id" : "5000123",
"code" : "MEAL",
"description" : "Plane",
"km" : false,
"notRefundable" : true,
"icon" : "fa fa-plane",
"color" : "00ff40",
"receiptRequired" : false,
"commentRequired" : false,
"guestsRequired" : false,
"notRefundableEditable" : true,
"billableEditable" : true,
"amountEditable" : true,
"showQuantity" : false,
"showAdditionalComment" : false,
"showReceiptNumber" : true,
"showAmountCategory" : true,
"showBillable" : true,
"hideVat" : false,
"vat1Code" : "1",
"vat2Code" : "2",
"vat3Code" : "3",
"expenseThreshold" : 100,
"defaultAmount" : 45,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"expenseCategory" : "{}",
"expenseRebillableOptions" : "{}",
"showCustomRequest" : true,
"showAmountWithoutVat" : true,
"controlsBehavior" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"calculateKilometers" : true,
"freeEntryProhibited" : true,
"controls" : {
"enableDuplicate" : true,
"enablelOnNonWorkingDay" : true,
"enableOnDayWithLeaveRequest" : true,
"enableOnDayWithTimesheetOrSchedule" : true
},
"expenseThresholdExceededNoVat" : false
},
"expenseTypeId" : "expenseTypeId",
"editableExpenseReport" : true,
"defaultExpenseReport" : true
},
"expenseTypeExpectedId" : "5000123",
"isExpenseReport" : true
}
2.3.6. Batch Create Custom Request Lines
POST |
/custom-requests/{custom_request_id}/custom-request-lines |
Description
Batch Create Custom Request Lines
This API allows the creation of multiple custom request lines at once.
The lines must be provided as a list in the request body.
DMF required:
-
DMF A40601: Api Workforce / Custom Requests / Insert
-
DMF 161402: Tools / Custom Requests / New
-
DMF 191101: Web Portal / Custom Requests / New
-
DMF 191102: Web Portal / Custom Requests / Duplicate
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
custom_request_id |
Id of a custom request |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
CustomRequestLine |
The custom request lines to be created CustomRequestLine |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Lines successfully created |
List[[string]] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"id" : "5000123",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJT_001",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"subPhase" : {
"id" : "5000123",
"code" : "SB_1",
"name" : "Sub Phase 1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"order" : 1
},
"subPhaseId" : "51000122",
"projectTask" : {
"id" : "5000123",
"code" : "code",
"name" : "Team building",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJT_001",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"subPhase" : {
"id" : "5000123",
"code" : "SB_1",
"name" : "Sub Phase 1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"order" : 1
},
"subPhaseId" : "51000122",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"order" : 2,
"startDate" : "2000-06-21T04:56:07.000+00:00",
"endDate" : "2000-06-21T04:56:07.000+00:00",
"description" : "description"
},
"projectTaskId" : "5000123",
"managementObjectId" : "5000123",
"name" : "Helpdesk",
"quantity" : 3,
"unitPriceCurrency" : 36.32,
"unitPrice" : 40,
"amountTotalCurrency" : 1200,
"amountTotal" : 1200,
"rankNumber" : 2,
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"expenseTypeExpected" : {
"id" : "5000123",
"code" : "AIR-PL",
"name" : "Airplane",
"description" : "Transportation",
"endDate" : "2000-06-21T04:56:07.000+00:00",
"expenseType" : {
"id" : "5000123",
"code" : "MEAL",
"description" : "Plane",
"km" : false,
"notRefundable" : true,
"icon" : "fa fa-plane",
"color" : "00ff40",
"receiptRequired" : false,
"commentRequired" : false,
"guestsRequired" : false,
"notRefundableEditable" : true,
"billableEditable" : true,
"amountEditable" : true,
"showQuantity" : false,
"showAdditionalComment" : false,
"showReceiptNumber" : true,
"showAmountCategory" : true,
"showBillable" : true,
"hideVat" : false,
"vat1Code" : "1",
"vat2Code" : "2",
"vat3Code" : "3",
"expenseThreshold" : 100,
"defaultAmount" : 45,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"expenseCategory" : "{}",
"expenseRebillableOptions" : "{}",
"showCustomRequest" : true,
"showAmountWithoutVat" : true,
"controlsBehavior" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"calculateKilometers" : true,
"freeEntryProhibited" : true,
"controls" : {
"enableDuplicate" : true,
"enablelOnNonWorkingDay" : true,
"enableOnDayWithLeaveRequest" : true,
"enableOnDayWithTimesheetOrSchedule" : true
},
"expenseThresholdExceededNoVat" : false
},
"expenseTypeId" : "expenseTypeId",
"editableExpenseReport" : true,
"defaultExpenseReport" : true
},
"expenseTypeExpectedId" : "5000123",
"isExpenseReport" : true
}
2.3.7. Delete a Custom Request
DELETE |
/custom-requests/{custom_request_id} |
Description
Delete a Custom Request
DMF required:
-
DMF A40603: Api Workforce / Custom Requests / Delete
-
DMF 161405: Tools / Custom Requests / Delete
-
DMF 191104: Web Portal / Custom Requests / Delete
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
custom_request_id |
Id of a custom request |
X |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Custom Request has been successfully deleted |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.3.8. Delete a custom request line
DELETE |
/custom-requests/{custom_request_id}/custom-request-lines/{custom_request_line_id} |
Description
Delete a custom request line
DMF required:
-
DMF A40603: Api Workforce / Custom Requests / Delete
-
DMF 161405: Tools / Custom Requests / Delete
-
DMF 191104: Web Portal / Custom Requests / Delete
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
custom_request_id |
Id of a custom request |
X |
null |
|
custom_request_line_id |
Id of a custom request line |
X |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
The custom request line has been successfully deleted |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.3.9. Generate expenses from a custom request
POST |
/custom-requests/{custom_request_id}/generate-expenses |
Description
Generate expenses from a custom request
DMF required:
-
DMF A40610: Api Workforce / Custom Requests / Generate Expenses
-
DMF 161412: Tools / Custom Requests / New Expense Report
-
DMF 191112: Web Portal / Custom Requests / Create Expense Report
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
custom_request_id |
Id of a custom request |
X |
null |
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Expenses successfully created |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.3.10. Search a custom request by its ID
GET |
/custom-requests/{custom_request_id} |
Description
Get the custom request matching the specified ID.
DMF required:
-
DMF A40606: Api Workforce / Custom Requests / Info
-
DMF 1614__: Tools / Custom Requests
-
DMF 1911__: Web Portal / Custom Requests
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
custom_request_id |
Id of a custom request |
X |
null |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Custom request successfully loaded |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.3.11. Pre-fill a Custom Request.
POST |
/custom-request-categories/{custom_request_category_id}/custom-requests/pre-fill |
Description
Pre-fill a Custom Request.
You can use query parameters to control the behavior of the pre-fill:
object_type and object_id allow you to specify the source object used for pre-filling content.
includeLines can be set to true to also pre-fill the lines of the custom request. If not set, it defaults to false.
DMF required:
-
DMF A40601: Api Workforce / Custom Requests / Insert
-
DMF 161402: Tools / Custom Requests / New
-
DMF 191101: Web Portal / Custom Requests / New
-
DMF 191102: Web Portal / Custom Requests / Duplicate
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
custom_request_category_id |
Id of a custom request's category |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
CustomRequest |
The Custom Request to be prefilled CustomRequest |
X |
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
object_type |
The type of object (see SchedulePreFillObjectType or TimesheetPreFillObjectType) |
- |
null |
|
object_id |
The id of the object used to fill in the schedule or the timesheet or … |
- |
null |
|
include_lines |
Set to true if you want to also pre-fill the lines of the custom request. If not defined, defaults to false. |
- |
null |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Custom Request successfully pre-filled |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"id" : "5000123",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJT_001",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"subPhase" : {
"id" : "5000123",
"code" : "SB_1",
"name" : "Sub Phase 1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"order" : 1
},
"subPhaseId" : "51000122",
"projectTask" : {
"id" : "5000123",
"code" : "code",
"name" : "Team building",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJT_001",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"subPhase" : {
"id" : "5000123",
"code" : "SB_1",
"name" : "Sub Phase 1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"order" : 1
},
"subPhaseId" : "51000122",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"order" : 2,
"startDate" : "2000-06-21T04:56:07.000+00:00",
"endDate" : "2000-06-21T04:56:07.000+00:00",
"description" : "description"
},
"projectTaskId" : "5000123",
"number" : "CC00001",
"name" : "Label for my doc",
"type" : "{}",
"companyCode" : "AKSAS",
"companyId" : "5000123",
"currencyCode" : "EUR",
"currency" : {
"id" : "5000123",
"name" : "Euro",
"code" : "EUR",
"order" : 17,
"euro" : true,
"euroRate" : 0.9678,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"euroRateStartDate" : "2020-01-23T04:56:07Z",
"euroRateEndDate" : "2020-01-23T04:56:07Z"
},
"date" : "2000-06-21T04:56:07.000+00:00",
"description" : "Lorem ipsum",
"entityCode" : "Lyon",
"afterTaxAmount" : 120.37,
"preTaxAmount" : 100.14,
"thirdPartyId" : "CUSTOMER01",
"customData" : {
"key" : {
"type" : "{}",
"value" : "Autoref 010520",
"name" : "Reference 4",
"realOrder" : 0,
"label" : "REFERENCE_4"
}
},
"changeTracking" : {
"createdTime" : "2000-06-21T04:56:07.000+00:00",
"createdBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"createdById" : "5000123",
"modificationTime" : "2000-06-21T04:56:07.000+00:00",
"modificationBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"modificationById" : "5000123"
},
"approvalState" : "{}",
"approvalDate" : "2000-06-21T04:56:07.000+00:00",
"lines" : [ {
"id" : "5000123",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJT_001",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"subPhase" : {
"id" : "5000123",
"code" : "SB_1",
"name" : "Sub Phase 1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"order" : 1
},
"subPhaseId" : "51000122",
"projectTask" : {
"id" : "5000123",
"code" : "code",
"name" : "Team building",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJT_001",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"subPhase" : {
"id" : "5000123",
"code" : "SB_1",
"name" : "Sub Phase 1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"order" : 1
},
"subPhaseId" : "51000122",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"order" : 2,
"startDate" : "2000-06-21T04:56:07.000+00:00",
"endDate" : "2000-06-21T04:56:07.000+00:00",
"description" : "description"
},
"projectTaskId" : "5000123",
"managementObjectId" : "5000123",
"name" : "Helpdesk",
"quantity" : 3,
"unitPriceCurrency" : 36.32,
"unitPrice" : 40,
"amountTotalCurrency" : 1200,
"amountTotal" : 1200,
"rankNumber" : 2,
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"expenseTypeExpected" : {
"id" : "5000123",
"code" : "AIR-PL",
"name" : "Airplane",
"description" : "Transportation",
"endDate" : "2000-06-21T04:56:07.000+00:00",
"expenseType" : {
"id" : "5000123",
"code" : "MEAL",
"description" : "Plane",
"km" : false,
"notRefundable" : true,
"icon" : "fa fa-plane",
"color" : "00ff40",
"receiptRequired" : false,
"commentRequired" : false,
"guestsRequired" : false,
"notRefundableEditable" : true,
"billableEditable" : true,
"amountEditable" : true,
"showQuantity" : false,
"showAdditionalComment" : false,
"showReceiptNumber" : true,
"showAmountCategory" : true,
"showBillable" : true,
"hideVat" : false,
"vat1Code" : "1",
"vat2Code" : "2",
"vat3Code" : "3",
"expenseThreshold" : 100,
"defaultAmount" : 45,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"expenseCategory" : "{}",
"expenseRebillableOptions" : "{}",
"showCustomRequest" : true,
"showAmountWithoutVat" : true,
"controlsBehavior" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"calculateKilometers" : true,
"freeEntryProhibited" : true,
"controls" : {
"enableDuplicate" : true,
"enablelOnNonWorkingDay" : true,
"enableOnDayWithLeaveRequest" : true,
"enableOnDayWithTimesheetOrSchedule" : true
},
"expenseThresholdExceededNoVat" : false
},
"expenseTypeId" : "expenseTypeId",
"editableExpenseReport" : true,
"defaultExpenseReport" : true
},
"expenseTypeExpectedId" : "5000123",
"isExpenseReport" : true
}, {
"id" : "5000123",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJT_001",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"subPhase" : {
"id" : "5000123",
"code" : "SB_1",
"name" : "Sub Phase 1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"order" : 1
},
"subPhaseId" : "51000122",
"projectTask" : {
"id" : "5000123",
"code" : "code",
"name" : "Team building",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJT_001",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"subPhase" : {
"id" : "5000123",
"code" : "SB_1",
"name" : "Sub Phase 1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"order" : 1
},
"subPhaseId" : "51000122",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"order" : 2,
"startDate" : "2000-06-21T04:56:07.000+00:00",
"endDate" : "2000-06-21T04:56:07.000+00:00",
"description" : "description"
},
"projectTaskId" : "5000123",
"managementObjectId" : "5000123",
"name" : "Helpdesk",
"quantity" : 3,
"unitPriceCurrency" : 36.32,
"unitPrice" : 40,
"amountTotalCurrency" : 1200,
"amountTotal" : 1200,
"rankNumber" : 2,
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"expenseTypeExpected" : {
"id" : "5000123",
"code" : "AIR-PL",
"name" : "Airplane",
"description" : "Transportation",
"endDate" : "2000-06-21T04:56:07.000+00:00",
"expenseType" : {
"id" : "5000123",
"code" : "MEAL",
"description" : "Plane",
"km" : false,
"notRefundable" : true,
"icon" : "fa fa-plane",
"color" : "00ff40",
"receiptRequired" : false,
"commentRequired" : false,
"guestsRequired" : false,
"notRefundableEditable" : true,
"billableEditable" : true,
"amountEditable" : true,
"showQuantity" : false,
"showAdditionalComment" : false,
"showReceiptNumber" : true,
"showAmountCategory" : true,
"showBillable" : true,
"hideVat" : false,
"vat1Code" : "1",
"vat2Code" : "2",
"vat3Code" : "3",
"expenseThreshold" : 100,
"defaultAmount" : 45,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"expenseCategory" : "{}",
"expenseRebillableOptions" : "{}",
"showCustomRequest" : true,
"showAmountWithoutVat" : true,
"controlsBehavior" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"calculateKilometers" : true,
"freeEntryProhibited" : true,
"controls" : {
"enableDuplicate" : true,
"enablelOnNonWorkingDay" : true,
"enableOnDayWithLeaveRequest" : true,
"enableOnDayWithTimesheetOrSchedule" : true
},
"expenseThresholdExceededNoVat" : false
},
"expenseTypeId" : "expenseTypeId",
"editableExpenseReport" : true,
"defaultExpenseReport" : true
},
"expenseTypeExpectedId" : "5000123",
"isExpenseReport" : true
} ],
"category" : {
"id" : "50000012",
"code" : "CATEGORY_1",
"name" : "Category one",
"endDate" : "2000-06-21T04:56:07.000+00:00",
"icon" : "fas fa-pen",
"companyId" : "companyId",
"enableActualDates" : true,
"enableEndDate" : true,
"editableWithoutExpense" : true,
"defaultValueWithoutExpense" : true,
"scheduleCreation" : true,
"timesheetCreation" : true,
"departureLocation" : true,
"departureLocationType" : "{}",
"destinationLocation" : true,
"destinationLocationType" : "{}",
"accreditationLevelType" : 1,
"accreditationOptions" : "{}",
"displayCustomData" : true,
"customDataStart" : 1,
"customDataEnd" : 9,
"customDataNbColumns" : 2
},
"categoryId" : "5000123",
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}",
"title" : "GEN",
"phone" : "+33 6 04 04 04 05",
"mobilePhone" : "+33 6 00 00 00 01",
"email" : "myemail@bechmail.com",
"noTimesDunning" : true,
"assignmentMultiCompany" : false,
"modeTimeRecording" : 1,
"modeInputSchedule" : 3,
"timeRecordingInputMode" : "{}",
"scheduleInputMode" : "{}",
"executive" : true,
"generic" : true,
"candidate" : false,
"external" : false,
"managerMultiCompany" : true,
"employeeFunctions" : {
"allFunctions" : false,
"allSales" : true,
"allPurchases" : false,
"allOperational" : true,
"projectSalesManager" : false,
"projectFinanceManager" : true,
"projectProductionManager" : false,
"projectAccountManager" : true,
"projectAssignment" : false,
"projectPhaseManager" : true,
"projectSendOnMission" : false,
"salesSalesAssistant" : true,
"salesOrderAndEstimateTracking" : false,
"salesBillingSchedulesTracking" : true,
"purchasingBuyer" : false,
"timeRecording" : true,
"inputOfExpenseReport" : false,
"purchasesReceptionTracking" : false,
"inputSchedule" : false,
"CMMSContractSalesManager" : false,
"CMMSContractTechnicalManager" : false,
"CMMSMRAndEOManager" : false
},
"employeeHistory" : [ {
"id" : "5000123",
"employeeHistoryType" : "5000123",
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 7.42,
"weekHours" : 38.3,
"occupancyRate" : 0.8,
"manager" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"managerId" : "5000123",
"company" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo"
},
"companyId" : "5000123",
"directHourlyRate" : 10.42,
"standardHourlyRate" : 10,
"dailyCost" : 59.36,
"dailySellingPrice" : 80,
"entity" : "5000123",
"serviceRef" : {
"id" : "5000123",
"name" : "Professional services",
"code" : "PS"
},
"service" : "5000123",
"position" : "Developer",
"skillRef" : {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
},
"skill" : "5000123",
"family1" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family1Id" : "5000123",
"family2" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family2Id" : "5000123",
"family3" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family3Id" : "5000123",
"leave" : false,
"standardWeek" : {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
}
},
"standardWeekId" : "5000123",
"salary" : 1024
}, {
"id" : "5000123",
"employeeHistoryType" : "5000123",
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 7.42,
"weekHours" : 38.3,
"occupancyRate" : 0.8,
"manager" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"managerId" : "5000123",
"company" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo"
},
"companyId" : "5000123",
"directHourlyRate" : 10.42,
"standardHourlyRate" : 10,
"dailyCost" : 59.36,
"dailySellingPrice" : 80,
"entity" : "5000123",
"serviceRef" : {
"id" : "5000123",
"name" : "Professional services",
"code" : "PS"
},
"service" : "5000123",
"position" : "Developer",
"skillRef" : {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
},
"skill" : "5000123",
"family1" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family1Id" : "5000123",
"family2" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family2Id" : "5000123",
"family3" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family3Id" : "5000123",
"leave" : false,
"standardWeek" : {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
}
},
"standardWeekId" : "5000123",
"salary" : 1024
} ],
"companyChanges" : [ {
"id" : "5000123",
"employeeId" : "500123",
"companyId" : "5000123",
"startDate" : "2020-01-23T04:56:07Z",
"endDate" : "2020-01-23T04:56:07Z",
"companyChangeState" : "{}",
"comment" : "Limpso usum"
}, {
"id" : "5000123",
"employeeId" : "500123",
"companyId" : "5000123",
"startDate" : "2020-01-23T04:56:07Z",
"endDate" : "2020-01-23T04:56:07Z",
"companyChangeState" : "{}",
"comment" : "Limpso usum"
} ],
"timeRecordingRules" : {
"id" : "5000123",
"employeeId" : "5000123",
"min" : 0,
"max" : 24,
"step" : 0.01,
"prettyStep" : 0.3,
"base" : 60,
"unit" : "H",
"unitDuration" : "{}",
"allowManualEntry" : true,
"employeeWeeks" : [ {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
},
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 8,
"dailyMinutes" : 10,
"weekHours" : 40,
"leave" : false
}, {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
},
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 8,
"dailyMinutes" : 10,
"weekHours" : 40,
"leave" : false
} ],
"closingDates" : [ {
"closingDate" : "2020-01-31T23:59:59Z",
"module" : "DATE_MODULE",
"beginningOfPeriod" : "2020-01-31T23:59:59Z",
"endOfPeriod" : "2020-01-31T23:59:59Z"
}, {
"closingDate" : "2020-01-31T23:59:59Z",
"module" : "DATE_MODULE",
"beginningOfPeriod" : "2020-01-31T23:59:59Z",
"endOfPeriod" : "2020-01-31T23:59:59Z"
} ],
"simpleDuration" : 750,
"completionMode" : "WEEKLY"
},
"scheduleRules" : {
"id" : "5000123",
"employeeId" : "5000123",
"min" : 0,
"max" : 24,
"step" : 0.01,
"prettyStep" : 0.3,
"base" : 60,
"unit" : "H",
"unitDuration" : "{}",
"allowManualEntry" : true,
"employeeWeeks" : [ {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
},
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 8,
"dailyMinutes" : 10,
"weekHours" : 40,
"leave" : false
}, {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
},
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 8,
"dailyMinutes" : 10,
"weekHours" : 40,
"leave" : false
} ],
"closingDates" : [ {
"closingDate" : "2020-01-31T23:59:59Z",
"module" : "DATE_MODULE",
"beginningOfPeriod" : "2020-01-31T23:59:59Z",
"endOfPeriod" : "2020-01-31T23:59:59Z"
}, {
"closingDate" : "2020-01-31T23:59:59Z",
"module" : "DATE_MODULE",
"beginningOfPeriod" : "2020-01-31T23:59:59Z",
"endOfPeriod" : "2020-01-31T23:59:59Z"
} ],
"timestamped" : true
},
"businessCards" : [ {
"id" : "5000123",
"employeeId" : "5000123",
"cardNumber" : "XXXX XXXX XXXX 7568",
"encryptedCardNumber" : "0",
"name" : "Management card",
"type" : "{}",
"endDate" : "2020-01-31T23:59:59Z"
}, {
"id" : "5000123",
"employeeId" : "5000123",
"cardNumber" : "XXXX XXXX XXXX 7568",
"encryptedCardNumber" : "0",
"name" : "Management card",
"type" : "{}",
"endDate" : "2020-01-31T23:59:59Z"
} ],
"sector" : "Marketing",
"number" : "84",
"relations" : [ {
"id" : "5000123",
"relationType" : {
"id" : "5000123",
"code" : "TUTOR",
"name" : "Tutor for internship"
},
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"relatedEmployee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"relatedEmployeeId" : "5000123"
}, {
"id" : "5000123",
"relationType" : {
"id" : "5000123",
"code" : "TUTOR",
"name" : "Tutor for internship"
},
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"relatedEmployee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"relatedEmployeeId" : "5000123"
} ],
"employeeAbilities" : [ {
"id" : "5000123",
"skill" : {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
},
"level" : {
"id" : "5000123",
"code" : "EXP",
"name" : "Expert"
},
"startDate" : "2020-01-31T23:59:59Z",
"endDate" : "2020-01-31T23:59:59Z",
"employeeId" : "5000123"
}, {
"id" : "5000123",
"skill" : {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
},
"level" : {
"id" : "5000123",
"code" : "EXP",
"name" : "Expert"
},
"startDate" : "2020-01-31T23:59:59Z",
"endDate" : "2020-01-31T23:59:59Z",
"employeeId" : "5000123"
} ],
"jobType" : {
"id" : "5000123",
"companyCode" : "AKSAS",
"code" : "ADMIN",
"name" : "Administrator",
"category" : "{}",
"validity" : {
"type" : "{}",
"date" : "2000-06-21T04:56:07.000+00:00"
},
"default" : true
},
"jobTypeId" : "100245",
"address" : {
"id" : "id",
"line1" : "221B Baker Street",
"line2" : "2nd Floor",
"line3" : "First door at your right",
"cedex" : "CEDEX 14",
"postalCode" : "69002",
"city" : "London",
"country" : "FR (for 'FRANCE')",
"countryName" : "FRANCE",
"department" : "75 (for 'PARIS')",
"geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
"region" : "65 (for 'ILE DE FRANCE')",
"regionName" : "ILE DE FRANCE",
"phone" : "06 00 00 00 01",
"phone2" : "06 00 00 00 02",
"email" : "myemail@mail.com",
"mobilePhone" : "06 00 00 00 02",
"fax" : "04 00 00 00 07",
"webSite" : "mysite.com"
},
"addressId" : "5000123",
"birthDate" : "2000-06-21T04:56:07.000+00:00",
"customData" : {
"key" : {
"type" : "{}",
"value" : "Autoref 010520",
"name" : "Reference 4",
"realOrder" : 0,
"label" : "REFERENCE_4"
}
},
"color" : "#FF0000",
"targetTace" : 75,
"formConfig" : {
"type" : "{}",
"fields" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"controls" : {
"key" : {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}
},
"insertable" : true,
"editable" : false,
"deletable" : false,
"formSearchHidden" : false
},
"changeTracking" : {
"createdTime" : "2000-06-21T04:56:07.000+00:00",
"createdBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"createdById" : "5000123",
"modificationTime" : "2000-06-21T04:56:07.000+00:00",
"modificationBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"modificationById" : "5000123"
},
"vehicles" : [ {
"id" : "5000123",
"power" : 5,
"licensePlate" : "licensePlate",
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"expenseType" : {
"id" : "5000123",
"code" : "MEAL",
"description" : "Plane",
"km" : false,
"notRefundable" : true,
"icon" : "fa fa-plane",
"color" : "00ff40",
"receiptRequired" : false,
"commentRequired" : false,
"guestsRequired" : false,
"notRefundableEditable" : true,
"billableEditable" : true,
"amountEditable" : true,
"showQuantity" : false,
"showAdditionalComment" : false,
"showReceiptNumber" : true,
"showAmountCategory" : true,
"showBillable" : true,
"hideVat" : false,
"vat1Code" : "1",
"vat2Code" : "2",
"vat3Code" : "3",
"expenseThreshold" : 100,
"defaultAmount" : 45,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"expenseCategory" : "{}",
"expenseRebillableOptions" : "{}",
"showCustomRequest" : true,
"showAmountWithoutVat" : true,
"controlsBehavior" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"calculateKilometers" : true,
"freeEntryProhibited" : true,
"controls" : {
"enableDuplicate" : true,
"enablelOnNonWorkingDay" : true,
"enableOnDayWithLeaveRequest" : true,
"enableOnDayWithTimesheetOrSchedule" : true
},
"expenseThresholdExceededNoVat" : false
},
"expenseTypeId" : "5000123",
"endDate" : "2020-01-31T23:59:59Z"
}, {
"id" : "5000123",
"power" : 5,
"licensePlate" : "licensePlate",
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"expenseType" : {
"id" : "5000123",
"code" : "MEAL",
"description" : "Plane",
"km" : false,
"notRefundable" : true,
"icon" : "fa fa-plane",
"color" : "00ff40",
"receiptRequired" : false,
"commentRequired" : false,
"guestsRequired" : false,
"notRefundableEditable" : true,
"billableEditable" : true,
"amountEditable" : true,
"showQuantity" : false,
"showAdditionalComment" : false,
"showReceiptNumber" : true,
"showAmountCategory" : true,
"showBillable" : true,
"hideVat" : false,
"vat1Code" : "1",
"vat2Code" : "2",
"vat3Code" : "3",
"expenseThreshold" : 100,
"defaultAmount" : 45,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"expenseCategory" : "{}",
"expenseRebillableOptions" : "{}",
"showCustomRequest" : true,
"showAmountWithoutVat" : true,
"controlsBehavior" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"calculateKilometers" : true,
"freeEntryProhibited" : true,
"controls" : {
"enableDuplicate" : true,
"enablelOnNonWorkingDay" : true,
"enableOnDayWithLeaveRequest" : true,
"enableOnDayWithTimesheetOrSchedule" : true
},
"expenseThresholdExceededNoVat" : false
},
"expenseTypeId" : "5000123",
"endDate" : "2020-01-31T23:59:59Z"
} ],
"currentCompany" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo",
"legalName" : "legalName",
"siren" : "siren",
"siret" : "siret",
"calendar" : {
"id" : "5000123",
"code" : "Text",
"name" : "Text",
"default" : true,
"daysNotWorked" : [ 6, 6 ],
"holidays" : [ {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
}, {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
} ]
},
"calendarId" : "calendarId",
"color" : "color",
"currency" : {
"id" : "5000123",
"name" : "Euro",
"code" : "EUR",
"order" : 17,
"euro" : true,
"euroRate" : 0.9678,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"euroRateStartDate" : "2020-01-23T04:56:07Z",
"euroRateEndDate" : "2020-01-23T04:56:07Z"
},
"currencyId" : "currencyId",
"address" : {
"id" : "id",
"line1" : "221B Baker Street",
"line2" : "2nd Floor",
"line3" : "First door at your right",
"cedex" : "CEDEX 14",
"postalCode" : "69002",
"city" : "London",
"country" : "FR (for 'FRANCE')",
"countryName" : "FRANCE",
"department" : "75 (for 'PARIS')",
"geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
"region" : "65 (for 'ILE DE FRANCE')",
"regionName" : "ILE DE FRANCE",
"phone" : "06 00 00 00 01",
"phone2" : "06 00 00 00 02",
"email" : "myemail@mail.com",
"mobilePhone" : "06 00 00 00 02",
"fax" : "04 00 00 00 07",
"webSite" : "mysite.com"
},
"addressId" : "addressId"
},
"currentCompanyId" : "5000123",
"bankingInformation" : {
"id" : "5000123",
"sepa" : {
"bankDetails" : {
"entity" : "30002",
"counter" : "550",
"accountNumber" : "0000157841Z",
"key" : "25",
"domiciliation" : "AURA"
},
"bic" : {
"country" : "FR (for 'FRANCE')",
"bank" : "DAAE",
"location" : "PP",
"branch" : "CCT"
},
"iban" : {
"country" : "FR (for 'FRANCE')",
"key" : "69",
"accountNumber" : "0000157841Z"
}
},
"noneSepa" : {
"defaultBankDetail" : false,
"beneficiary" : {
"holder" : {
"name" : "RITA",
"firstName" : "BRITA",
"accountType" : "{}",
"accountNumber" : "123456789"
},
"bank" : {
"bankName" : "UBA",
"bankName2" : "UBA",
"bankType" : "{}",
"bankCode" : "C8",
"bankAddress" : {
"id" : "id",
"line1" : "221B Baker Street",
"line2" : "2nd Floor",
"line3" : "First door at your right",
"cedex" : "CEDEX 14",
"postalCode" : "69002",
"city" : "London",
"country" : "FR (for 'FRANCE')",
"countryName" : "FRANCE",
"department" : "75 (for 'PARIS')",
"geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
"region" : "65 (for 'ILE DE FRANCE')",
"regionName" : "ILE DE FRANCE",
"phone" : "06 00 00 00 01",
"phone2" : "06 00 00 00 02",
"email" : "myemail@mail.com",
"mobilePhone" : "06 00 00 00 02",
"fax" : "04 00 00 00 07",
"webSite" : "mysite.com"
}
}
},
"intermediate" : {
"holder" : {
"name" : "RITA",
"firstName" : "BRITA",
"accountType" : "{}",
"accountNumber" : "123456789"
},
"bank" : {
"bankName" : "UBA",
"bankName2" : "UBA",
"bankType" : "{}",
"bankCode" : "C8",
"bankAddress" : {
"id" : "id",
"line1" : "221B Baker Street",
"line2" : "2nd Floor",
"line3" : "First door at your right",
"cedex" : "CEDEX 14",
"postalCode" : "69002",
"city" : "London",
"country" : "FR (for 'FRANCE')",
"countryName" : "FRANCE",
"department" : "75 (for 'PARIS')",
"geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
"region" : "65 (for 'ILE DE FRANCE')",
"regionName" : "ILE DE FRANCE",
"phone" : "06 00 00 00 01",
"phone2" : "06 00 00 00 02",
"email" : "myemail@mail.com",
"mobilePhone" : "06 00 00 00 02",
"fax" : "04 00 00 00 07",
"webSite" : "mysite.com"
}
}
}
},
"statusChangeDate" : "2000-06-21T04:56:07.000+00:00",
"statusChangeArgument" : {
"comment" : "Comment",
"status" : "{}"
},
"validator" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"validatorId" : "5000123",
"action" : "{}",
"type" : "{}"
},
"faxNumber" : "418 643 3210",
"phoneExtensionNumber" : "04 00 00 00 07"
},
"employeeId" : "5000123",
"departureDate" : "2020-01-31T23:59:59Z",
"departureActualDate" : "2020-01-31T23:59:59Z",
"departureCity" : {
"id" : "5000123",
"name" : "City 1",
"default" : true,
"postcode" : "73000",
"country" : {
"id" : "5000123",
"name" : "Country 1",
"currency" : {
"id" : "5000123",
"name" : "Euro",
"code" : "EUR",
"order" : 17,
"euro" : true,
"euroRate" : 0.9678,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"euroRateStartDate" : "2020-01-23T04:56:07Z",
"euroRateEndDate" : "2020-01-23T04:56:07Z"
},
"currencyId" : "5000123",
"calendar" : {
"id" : "5000123",
"code" : "Text",
"name" : "Text",
"default" : true,
"daysNotWorked" : [ 6, 6 ],
"holidays" : [ {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
}, {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
} ]
},
"calendarId" : "5000123",
"code" : "FR",
"companyCode" : "AKSAS",
"companyId" : "5000123",
"isPartOfEU" : true,
"continent" : "AFRICA"
},
"countryId" : "5000123",
"department" : {
"id" : "5000123",
"code" : "01-A",
"companyCode" : "AKSAS",
"name" : "Lorem Ipsum",
"analysis" : "analysis",
"comment" : "comment",
"entity" : {
"id" : "5000123",
"code" : "01-BRDX",
"name" : "Bordeaux",
"legalName" : "Customer care",
"division" : {
"id" : "5000123",
"name" : "Rhone-Alpes",
"code" : "RA",
"group" : {
"id" : "5000123",
"name" : "West",
"code" : "WST",
"serviceId" : "5000123"
},
"groupId" : "5000123",
"companyId" : "5000123"
},
"divisionId" : "5000123",
"divisionCode" : "01-DIV",
"companyId" : "5000123",
"endDate" : "2020-01-23T04:56:07Z"
},
"entityId" : "entityId",
"projectType" : "{}",
"activities" : [ {
"id" : "5000123",
"code" : "code",
"name" : "name"
}, {
"id" : "5000123",
"code" : "code",
"name" : "name"
} ]
},
"departmentId" : "5000123",
"regionId" : "123456",
"companyCode" : "AKSAS",
"latitude" : "5.9845W",
"longitude" : "37.3891N"
},
"departureLocation" : "Lyon",
"arrivalDate" : "2020-01-31T23:59:59Z",
"arrivalActualDate" : "2020-01-31T23:59:59Z",
"arrivalCity" : {
"id" : "5000123",
"name" : "City 1",
"default" : true,
"postcode" : "73000",
"country" : {
"id" : "5000123",
"name" : "Country 1",
"currency" : {
"id" : "5000123",
"name" : "Euro",
"code" : "EUR",
"order" : 17,
"euro" : true,
"euroRate" : 0.9678,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"euroRateStartDate" : "2020-01-23T04:56:07Z",
"euroRateEndDate" : "2020-01-23T04:56:07Z"
},
"currencyId" : "5000123",
"calendar" : {
"id" : "5000123",
"code" : "Text",
"name" : "Text",
"default" : true,
"daysNotWorked" : [ 6, 6 ],
"holidays" : [ {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
}, {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
} ]
},
"calendarId" : "5000123",
"code" : "FR",
"companyCode" : "AKSAS",
"companyId" : "5000123",
"isPartOfEU" : true,
"continent" : "AFRICA"
},
"countryId" : "5000123",
"department" : {
"id" : "5000123",
"code" : "01-A",
"companyCode" : "AKSAS",
"name" : "Lorem Ipsum",
"analysis" : "analysis",
"comment" : "comment",
"entity" : {
"id" : "5000123",
"code" : "01-BRDX",
"name" : "Bordeaux",
"legalName" : "Customer care",
"division" : {
"id" : "5000123",
"name" : "Rhone-Alpes",
"code" : "RA",
"group" : {
"id" : "5000123",
"name" : "West",
"code" : "WST",
"serviceId" : "5000123"
},
"groupId" : "5000123",
"companyId" : "5000123"
},
"divisionId" : "5000123",
"divisionCode" : "01-DIV",
"companyId" : "5000123",
"endDate" : "2020-01-23T04:56:07Z"
},
"entityId" : "entityId",
"projectType" : "{}",
"activities" : [ {
"id" : "5000123",
"code" : "code",
"name" : "name"
}, {
"id" : "5000123",
"code" : "code",
"name" : "name"
} ]
},
"departmentId" : "5000123",
"regionId" : "123456",
"companyCode" : "AKSAS",
"latitude" : "5.9845W",
"longitude" : "37.3891N"
},
"arrivalLocation" : "Oslo",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"documents" : [ {
"id" : "5000123",
"title" : "Title",
"versionId" : "5000123",
"changeTracking" : {
"createdTime" : "2000-06-21T04:56:07.000+00:00",
"createdBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"createdById" : "5000123",
"modificationTime" : "2000-06-21T04:56:07.000+00:00",
"modificationBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"modificationById" : "5000123"
},
"publishedBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"publishedById" : "5001206",
"classification" : "STD",
"subClassification" : "EDITIONS",
"category1" : "CAT1",
"category2" : "CAT2",
"category3" : "CAT3",
"companyId" : "5000123",
"publicationDate" : "2000-06-21T04:56:07.000+00:00",
"version" : 1,
"documentType" : "File",
"fileUrl" : "myFiles/thisFile.pdf",
"fileName" : "thisFile.pdf",
"lienUrl" : "myStorage.com/myFiles/thisFile.pdf",
"url" : "myFiles/thisFile.pdf",
"original" : false,
"preview" : "data:image",
"tokenPreview" : "8946A85V85D851DF",
"externalDMSUuid" : "OD1245126",
"links" : [ {
"id" : "5000123",
"original" : true,
"documentId" : "5000123",
"objectId" : "5000123",
"objectType" : "{}"
}, {
"id" : "5000123",
"original" : true,
"documentId" : "5000123",
"objectId" : "5000123",
"objectType" : "{}"
} ],
"archived" : false,
"action" : "{}",
"owner" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"ownerId" : "5001206",
"description" : "Text",
"category" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"categoryId" : "100024",
"subCategory" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"company" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo",
"legalName" : "legalName",
"siren" : "siren",
"siret" : "siret",
"calendar" : {
"id" : "5000123",
"code" : "Text",
"name" : "Text",
"default" : true,
"daysNotWorked" : [ 6, 6 ],
"holidays" : [ {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
}, {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
} ]
},
"calendarId" : "calendarId",
"color" : "color",
"currency" : {
"id" : "5000123",
"name" : "Euro",
"code" : "EUR",
"order" : 17,
"euro" : true,
"euroRate" : 0.9678,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"euroRateStartDate" : "2020-01-23T04:56:07Z",
"euroRateEndDate" : "2020-01-23T04:56:07Z"
},
"currencyId" : "currencyId",
"address" : {
"id" : "id",
"line1" : "221B Baker Street",
"line2" : "2nd Floor",
"line3" : "First door at your right",
"cedex" : "CEDEX 14",
"postalCode" : "69002",
"city" : "London",
"country" : "FR (for 'FRANCE')",
"countryName" : "FRANCE",
"department" : "75 (for 'PARIS')",
"geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
"region" : "65 (for 'ILE DE FRANCE')",
"regionName" : "ILE DE FRANCE",
"phone" : "06 00 00 00 01",
"phone2" : "06 00 00 00 02",
"email" : "myemail@mail.com",
"mobilePhone" : "06 00 00 00 02",
"fax" : "04 00 00 00 07",
"webSite" : "mysite.com"
},
"addressId" : "addressId"
},
"companyId" : "5000123",
"type" : "{}",
"category" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"categoryId" : "500143",
"grouping" : "grouping",
"ranking" : 2
},
"subCategoryId" : "11037",
"locked" : false
}, {
"id" : "5000123",
"title" : "Title",
"versionId" : "5000123",
"changeTracking" : {
"createdTime" : "2000-06-21T04:56:07.000+00:00",
"createdBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"createdById" : "5000123",
"modificationTime" : "2000-06-21T04:56:07.000+00:00",
"modificationBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"modificationById" : "5000123"
},
"publishedBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"publishedById" : "5001206",
"classification" : "STD",
"subClassification" : "EDITIONS",
"category1" : "CAT1",
"category2" : "CAT2",
"category3" : "CAT3",
"companyId" : "5000123",
"publicationDate" : "2000-06-21T04:56:07.000+00:00",
"version" : 1,
"documentType" : "File",
"fileUrl" : "myFiles/thisFile.pdf",
"fileName" : "thisFile.pdf",
"lienUrl" : "myStorage.com/myFiles/thisFile.pdf",
"url" : "myFiles/thisFile.pdf",
"original" : false,
"preview" : "data:image",
"tokenPreview" : "8946A85V85D851DF",
"externalDMSUuid" : "OD1245126",
"links" : [ {
"id" : "5000123",
"original" : true,
"documentId" : "5000123",
"objectId" : "5000123",
"objectType" : "{}"
}, {
"id" : "5000123",
"original" : true,
"documentId" : "5000123",
"objectId" : "5000123",
"objectType" : "{}"
} ],
"archived" : false,
"action" : "{}",
"owner" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"ownerId" : "5001206",
"description" : "Text",
"category" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"categoryId" : "100024",
"subCategory" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"company" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo",
"legalName" : "legalName",
"siren" : "siren",
"siret" : "siret",
"calendar" : {
"id" : "5000123",
"code" : "Text",
"name" : "Text",
"default" : true,
"daysNotWorked" : [ 6, 6 ],
"holidays" : [ {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
}, {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
} ]
},
"calendarId" : "calendarId",
"color" : "color",
"currency" : {
"id" : "5000123",
"name" : "Euro",
"code" : "EUR",
"order" : 17,
"euro" : true,
"euroRate" : 0.9678,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"euroRateStartDate" : "2020-01-23T04:56:07Z",
"euroRateEndDate" : "2020-01-23T04:56:07Z"
},
"currencyId" : "currencyId",
"address" : {
"id" : "id",
"line1" : "221B Baker Street",
"line2" : "2nd Floor",
"line3" : "First door at your right",
"cedex" : "CEDEX 14",
"postalCode" : "69002",
"city" : "London",
"country" : "FR (for 'FRANCE')",
"countryName" : "FRANCE",
"department" : "75 (for 'PARIS')",
"geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
"region" : "65 (for 'ILE DE FRANCE')",
"regionName" : "ILE DE FRANCE",
"phone" : "06 00 00 00 01",
"phone2" : "06 00 00 00 02",
"email" : "myemail@mail.com",
"mobilePhone" : "06 00 00 00 02",
"fax" : "04 00 00 00 07",
"webSite" : "mysite.com"
},
"addressId" : "addressId"
},
"companyId" : "5000123",
"type" : "{}",
"category" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"categoryId" : "500143",
"grouping" : "grouping",
"ranking" : 2
},
"subCategoryId" : "11037",
"locked" : false
} ],
"numberOfDocuments" : 2,
"formConfig" : {
"type" : "{}",
"fields" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"controls" : {
"key" : {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}
},
"insertable" : true,
"editable" : false,
"deletable" : false,
"formSearchHidden" : false
},
"cancellationDate" : "2020-01-31T23:59:59Z",
"cancellationUser" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"cancellationUserId" : "5000123",
"archiveDate" : "2020-01-31T23:59:59Z",
"archiveUser" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"archiveUserId" : "5000123",
"comment" : "Lorem ipsum",
"multiProjects" : true
}
2.3.12. Publish a custom request
POST |
/custom-requests/{custom_request_id}/publish |
Description
Publish a custom request using the template given as a parameter.
DMF required:
-
DMF A40605: Api Workforce / Custom Requests / Publish
-
DMF 161406: Tools / Custom Requests / Reports
-
DMF 191105: Web Portal / Custom Requests / Reports
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
custom_request_id |
Id of a custom request |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
publish_arguments |
The arguments for publishing custom request PublishArguments |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Published document |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"template" : {
"id" : "5000123",
"code" : "MODELE_EDITION_001",
"name" : "Edition model for my documents",
"type" : {
"code" : "TEMP01",
"name" : "Template one",
"modelId" : "5000123",
"modelDescription" : "Lorem Ipsum"
},
"publishType" : "{}",
"path" : "C://MyDoc/Template/modele_edition_001",
"endDate" : "2000-06-21T04:56:07.000+00:00",
"extensions" : ".pdf, .docx",
"defaultTemplate" : true,
"interactive" : true,
"order" : 1
},
"extension" : ".pdf",
"parameters" : [ {
"groupName" : "text_box",
"labelText" : "Detail BL",
"pattern" : "cl",
"nameField" : "DetailBL",
"selectionList" : [ {
"label" : "Bank transfer",
"value" : "BT"
}, {
"label" : "Bank transfer",
"value" : "BT"
} ],
"nameFieldNext" : "DetailCheckbox",
"value" : "checked",
"required" : true
}, {
"groupName" : "text_box",
"labelText" : "Detail BL",
"pattern" : "cl",
"nameField" : "DetailBL",
"selectionList" : [ {
"label" : "Bank transfer",
"value" : "BT"
}, {
"label" : "Bank transfer",
"value" : "BT"
} ],
"nameFieldNext" : "DetailCheckbox",
"value" : "checked",
"required" : true
} ],
"saveDocument" : true
}
2.3.13. Search a custom request with read options
POST |
/custom-requests/{custom_request_id}/read |
Description
Get a custom request, with additional information of your choice (example: customer information).
You can add this information with Read Options. These are listed in the link below.'
DMF required:
-
DMF A40606: Api Workforce / Custom Requests / Info
-
DMF 1614__: Tools / Custom Requests
-
DMF 1911__: Web Portal / Custom Requests
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
custom_request_id |
Id of a custom request |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
read_option |
The read options for returned custom request CustomRequestReadOption |
- |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Custom request successfully loaded |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"options" : [ "CATEGORY", "CATEGORY" ]
}
2.3.14. Search for custom request cities
POST |
/custom-requests/custom-request-categories/{custom_request_category_id}/cities/find |
Description
Get a list of the departure or arrival cities matching the parameters in CustomRequestLocationParamHolder.
DMF required:
-
DMF A40602: Api Workforce / Custom Requests / Update
-
DMF 161404: Tools / Custom Requests / Modify
-
DMF 161411: Tools / Custom Requests / Modify Completed Request
-
DMF 161417: Tools / Custom Requests / Modify Archived Request
-
DMF 191103: Web Portal / Custom Requests / Modify
-
DMF 191108: Web Portal / Custom Requests / Cancel 'approved' Request
-
DMF 191109: Web Portal / Custom Requests / Cancel 'to Be Approved' Request
-
DMF 191110: Web Portal / Custom Requests / Cancel 'denied' Request
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
custom_request_category_id |
Id of a custom request's category |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
CustomRequestLocationParamHolder |
Parameters that you choose (search text, type, etc.). The parameter 'type' indicates whether you are searching for arrival cities or departure cities. CustomRequestLocationParamHolder |
- |
Return Type
array[City]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Cities successfully loaded |
List[City] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"searchText" : "Lorem ipsum dolor sit amet",
"customerIds" : [ "customerIds", "customerIds" ]
}
2.3.15. Search for custom requests (with search criteria)
POST |
/custom-requests/search |
Description
Get the list of custom requests matching the search criteria.
DMF required:
-
DMF A40604: Api Workforce / Custom Requests / Search
-
DMF 161408: Tools / Custom Requests / Search
-
DMF 1911__: Web Portal / Custom Requests
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
criteria |
Criteria that you choose (ProjectID, name, etc…) CustomRequestCriteria |
X |
Return Type
array[CustomRequest]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Custom request successfully loaded |
List[CustomRequest] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"id" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"date" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
},
"creationDate" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
},
"validationDate" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
},
"name" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"companyCode" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"entityCode" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"afterTaxAmount" : {
"operator" : "IS",
"value" : 12.6,
"includeNullResults" : false
},
"preTaxAmount" : {
"operator" : "IS",
"value" : 12.6,
"includeNullResults" : false
},
"currencyCode" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"managerId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"fiscalYearId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"journalId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"thirdPartyId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"thirdPartyToBillId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"description" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"approvalState" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"approvalDate" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
},
"internal" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"group" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"methodOfPayment" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"customData" : {
"key" : {
"operator" : "IS",
"value" : "{}",
"includeNullResults" : false
}
},
"number" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"categoryId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"departureDate" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
},
"departureActualDate" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
},
"departureLocation" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"arrivalDate" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
},
"arrivalActualDate" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
},
"arrivalLocation" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"projectId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"employeeId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"cancellationDate" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
},
"cancellationUserId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"archiveDate" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
},
"archiveUserId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"readOption" : {
"options" : [ "CATEGORY", "CATEGORY" ]
}
}
2.3.16. Search for search field behavior for the category of custom request
GET |
/custom-request-categories/{custom_request_category_id}/search-fields-information |
Deprecated
|
Tip
|
This API will soon be removed as it is no longer functional. No data will be returned when using it. |
Description
Get the list of search field behavior for Custom Requests
DMF required:
-
DMF A40604: Api Workforce / Custom Requests / Search
-
DMF 161408: Tools / Custom Requests / Search
-
DMF 1911__: Web Portal / Custom Requests
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
custom_request_category_id |
Id of a custom request's category |
X |
null |
Return Type
array[SearchControlBehavior]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Search field behavior results |
List[SearchControlBehavior] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.3.17. Send Message for a custom request
POST |
/custom-requests/{custom_request_id}/send-message |
Description
A complex Mail sent with a list of recipients represented by a recipient object, a body and a title. Each MessageRecipient object will be treated by the backend in order to translate Akuiteo 'Tiers' as an email address.
DMF required:
-
DMF AH0111: Api Service Integration / Message / Send Message
-
DMF 020424: Sales / Deliveries / Send Multiple Deliveries By Email To Customers
-
DMF 020532: Sales / Invoices / Send Multiple Invoices By Email
-
DMF 020558: Sales / Invoices / Send Dunning Email To Selected Invoices' Managers
-
DMF 020559: Sales / Invoices / Send Arrears Information By Email
-
DMF 020567: Sales / Invoices / Send Email Reminders
-
DMF 020714: Sales / Billing Schedules / Send Multiple Emails
-
DMF 060128: Projects
-
DMF 060237: Projects / Schedules / Send Schedule Assignment By Email
-
DMF 080112: Banking / Customer Receipts / Send By Email
-
DMF 080312: Banking / Supplier Receipts / Send By Email
-
DMF 080412: Banking / Customer Disbursements / Send By Email
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
custom_request_id |
Id of a custom request |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
The message to send TemplatedMessage |
- |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
The mail has been correctly staged for background sending process |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"message" : {
"toRecipients" : [ {
"id" : "5000123",
"summary" : "Text",
"address" : "jean@email.com",
"type" : "{}"
}, {
"id" : "5000123",
"summary" : "Text",
"address" : "jean@email.com",
"type" : "{}"
} ],
"mail" : {
"cc" : [ "cc", "cc" ],
"cci" : [ "cci", "cci" ],
"replyTo" : "replyTo",
"from" : "from",
"to" : [ "to", "to" ],
"title" : "title",
"body" : "body"
},
"replyTo" : {
"id" : "5000123",
"summary" : "Text",
"address" : "jean@email.com",
"type" : "{}"
},
"ccRecipients" : [ {
"id" : "5000123",
"summary" : "Text",
"address" : "jean@email.com",
"type" : "{}"
}, {
"id" : "5000123",
"summary" : "Text",
"address" : "jean@email.com",
"type" : "{}"
} ],
"cciRecipients" : [ {
"id" : "5000123",
"summary" : "Text",
"address" : "jean@email.com",
"type" : "{}"
}, {
"id" : "5000123",
"summary" : "Text",
"address" : "jean@email.com",
"type" : "{}"
} ],
"publishedDocuments" : [ {
"isDocument" : true,
"documentId" : "112302",
"token" : "token"
}, {
"isDocument" : true,
"documentId" : "112302",
"token" : "token"
} ]
},
"templateId" : "255644",
"parameters" : [ {
"groupName" : "text_box",
"labelText" : "Detail BL",
"pattern" : "cl",
"nameField" : "DetailBL",
"selectionList" : [ {
"label" : "Bank transfer",
"value" : "BT"
}, {
"label" : "Bank transfer",
"value" : "BT"
} ],
"nameFieldNext" : "DetailCheckbox",
"value" : "checked",
"required" : true
}, {
"groupName" : "text_box",
"labelText" : "Detail BL",
"pattern" : "cl",
"nameField" : "DetailBL",
"selectionList" : [ {
"label" : "Bank transfer",
"value" : "BT"
}, {
"label" : "Bank transfer",
"value" : "BT"
} ],
"nameFieldNext" : "DetailCheckbox",
"value" : "checked",
"required" : true
} ]
}
2.3.18. Update a Custom Request
POST |
/custom-requests/{custom_request_id} |
Description
Update a Custom Request
DMF required:
-
DMF A40602: Api Workforce / Custom Requests / Update
-
DMF 161404: Tools / Custom Requests / Modify
-
DMF 161411: Tools / Custom Requests / Modify Completed Request
-
DMF 161417: Tools / Custom Requests / Modify Archived Request
-
DMF 191103: Web Portal / Custom Requests / Modify
-
DMF 191108: Web Portal / Custom Requests / Cancel 'approved' Request
-
DMF 191109: Web Portal / Custom Requests / Cancel 'to Be Approved' Request
-
DMF 191110: Web Portal / Custom Requests / Cancel 'denied' Request
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
custom_request_id |
Id of a custom request |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
customRequest |
The Custom Request to update CustomRequest |
X |
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Custom Request has been successfully updated |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"id" : "5000123",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJT_001",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"subPhase" : {
"id" : "5000123",
"code" : "SB_1",
"name" : "Sub Phase 1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"order" : 1
},
"subPhaseId" : "51000122",
"projectTask" : {
"id" : "5000123",
"code" : "code",
"name" : "Team building",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJT_001",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"subPhase" : {
"id" : "5000123",
"code" : "SB_1",
"name" : "Sub Phase 1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"order" : 1
},
"subPhaseId" : "51000122",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"order" : 2,
"startDate" : "2000-06-21T04:56:07.000+00:00",
"endDate" : "2000-06-21T04:56:07.000+00:00",
"description" : "description"
},
"projectTaskId" : "5000123",
"number" : "CC00001",
"name" : "Label for my doc",
"type" : "{}",
"companyCode" : "AKSAS",
"companyId" : "5000123",
"currencyCode" : "EUR",
"currency" : {
"id" : "5000123",
"name" : "Euro",
"code" : "EUR",
"order" : 17,
"euro" : true,
"euroRate" : 0.9678,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"euroRateStartDate" : "2020-01-23T04:56:07Z",
"euroRateEndDate" : "2020-01-23T04:56:07Z"
},
"date" : "2000-06-21T04:56:07.000+00:00",
"description" : "Lorem ipsum",
"entityCode" : "Lyon",
"afterTaxAmount" : 120.37,
"preTaxAmount" : 100.14,
"thirdPartyId" : "CUSTOMER01",
"customData" : {
"key" : {
"type" : "{}",
"value" : "Autoref 010520",
"name" : "Reference 4",
"realOrder" : 0,
"label" : "REFERENCE_4"
}
},
"changeTracking" : {
"createdTime" : "2000-06-21T04:56:07.000+00:00",
"createdBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"createdById" : "5000123",
"modificationTime" : "2000-06-21T04:56:07.000+00:00",
"modificationBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"modificationById" : "5000123"
},
"approvalState" : "{}",
"approvalDate" : "2000-06-21T04:56:07.000+00:00",
"lines" : [ {
"id" : "5000123",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJT_001",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"subPhase" : {
"id" : "5000123",
"code" : "SB_1",
"name" : "Sub Phase 1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"order" : 1
},
"subPhaseId" : "51000122",
"projectTask" : {
"id" : "5000123",
"code" : "code",
"name" : "Team building",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJT_001",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"subPhase" : {
"id" : "5000123",
"code" : "SB_1",
"name" : "Sub Phase 1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"order" : 1
},
"subPhaseId" : "51000122",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"order" : 2,
"startDate" : "2000-06-21T04:56:07.000+00:00",
"endDate" : "2000-06-21T04:56:07.000+00:00",
"description" : "description"
},
"projectTaskId" : "5000123",
"managementObjectId" : "5000123",
"name" : "Helpdesk",
"quantity" : 3,
"unitPriceCurrency" : 36.32,
"unitPrice" : 40,
"amountTotalCurrency" : 1200,
"amountTotal" : 1200,
"rankNumber" : 2,
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"expenseTypeExpected" : {
"id" : "5000123",
"code" : "AIR-PL",
"name" : "Airplane",
"description" : "Transportation",
"endDate" : "2000-06-21T04:56:07.000+00:00",
"expenseType" : {
"id" : "5000123",
"code" : "MEAL",
"description" : "Plane",
"km" : false,
"notRefundable" : true,
"icon" : "fa fa-plane",
"color" : "00ff40",
"receiptRequired" : false,
"commentRequired" : false,
"guestsRequired" : false,
"notRefundableEditable" : true,
"billableEditable" : true,
"amountEditable" : true,
"showQuantity" : false,
"showAdditionalComment" : false,
"showReceiptNumber" : true,
"showAmountCategory" : true,
"showBillable" : true,
"hideVat" : false,
"vat1Code" : "1",
"vat2Code" : "2",
"vat3Code" : "3",
"expenseThreshold" : 100,
"defaultAmount" : 45,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"expenseCategory" : "{}",
"expenseRebillableOptions" : "{}",
"showCustomRequest" : true,
"showAmountWithoutVat" : true,
"controlsBehavior" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"calculateKilometers" : true,
"freeEntryProhibited" : true,
"controls" : {
"enableDuplicate" : true,
"enablelOnNonWorkingDay" : true,
"enableOnDayWithLeaveRequest" : true,
"enableOnDayWithTimesheetOrSchedule" : true
},
"expenseThresholdExceededNoVat" : false
},
"expenseTypeId" : "expenseTypeId",
"editableExpenseReport" : true,
"defaultExpenseReport" : true
},
"expenseTypeExpectedId" : "5000123",
"isExpenseReport" : true
}, {
"id" : "5000123",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJT_001",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"subPhase" : {
"id" : "5000123",
"code" : "SB_1",
"name" : "Sub Phase 1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"order" : 1
},
"subPhaseId" : "51000122",
"projectTask" : {
"id" : "5000123",
"code" : "code",
"name" : "Team building",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJT_001",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"subPhase" : {
"id" : "5000123",
"code" : "SB_1",
"name" : "Sub Phase 1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"order" : 1
},
"subPhaseId" : "51000122",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"order" : 2,
"startDate" : "2000-06-21T04:56:07.000+00:00",
"endDate" : "2000-06-21T04:56:07.000+00:00",
"description" : "description"
},
"projectTaskId" : "5000123",
"managementObjectId" : "5000123",
"name" : "Helpdesk",
"quantity" : 3,
"unitPriceCurrency" : 36.32,
"unitPrice" : 40,
"amountTotalCurrency" : 1200,
"amountTotal" : 1200,
"rankNumber" : 2,
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"expenseTypeExpected" : {
"id" : "5000123",
"code" : "AIR-PL",
"name" : "Airplane",
"description" : "Transportation",
"endDate" : "2000-06-21T04:56:07.000+00:00",
"expenseType" : {
"id" : "5000123",
"code" : "MEAL",
"description" : "Plane",
"km" : false,
"notRefundable" : true,
"icon" : "fa fa-plane",
"color" : "00ff40",
"receiptRequired" : false,
"commentRequired" : false,
"guestsRequired" : false,
"notRefundableEditable" : true,
"billableEditable" : true,
"amountEditable" : true,
"showQuantity" : false,
"showAdditionalComment" : false,
"showReceiptNumber" : true,
"showAmountCategory" : true,
"showBillable" : true,
"hideVat" : false,
"vat1Code" : "1",
"vat2Code" : "2",
"vat3Code" : "3",
"expenseThreshold" : 100,
"defaultAmount" : 45,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"expenseCategory" : "{}",
"expenseRebillableOptions" : "{}",
"showCustomRequest" : true,
"showAmountWithoutVat" : true,
"controlsBehavior" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"calculateKilometers" : true,
"freeEntryProhibited" : true,
"controls" : {
"enableDuplicate" : true,
"enablelOnNonWorkingDay" : true,
"enableOnDayWithLeaveRequest" : true,
"enableOnDayWithTimesheetOrSchedule" : true
},
"expenseThresholdExceededNoVat" : false
},
"expenseTypeId" : "expenseTypeId",
"editableExpenseReport" : true,
"defaultExpenseReport" : true
},
"expenseTypeExpectedId" : "5000123",
"isExpenseReport" : true
} ],
"category" : {
"id" : "50000012",
"code" : "CATEGORY_1",
"name" : "Category one",
"endDate" : "2000-06-21T04:56:07.000+00:00",
"icon" : "fas fa-pen",
"companyId" : "companyId",
"enableActualDates" : true,
"enableEndDate" : true,
"editableWithoutExpense" : true,
"defaultValueWithoutExpense" : true,
"scheduleCreation" : true,
"timesheetCreation" : true,
"departureLocation" : true,
"departureLocationType" : "{}",
"destinationLocation" : true,
"destinationLocationType" : "{}",
"accreditationLevelType" : 1,
"accreditationOptions" : "{}",
"displayCustomData" : true,
"customDataStart" : 1,
"customDataEnd" : 9,
"customDataNbColumns" : 2
},
"categoryId" : "5000123",
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}",
"title" : "GEN",
"phone" : "+33 6 04 04 04 05",
"mobilePhone" : "+33 6 00 00 00 01",
"email" : "myemail@bechmail.com",
"noTimesDunning" : true,
"assignmentMultiCompany" : false,
"modeTimeRecording" : 1,
"modeInputSchedule" : 3,
"timeRecordingInputMode" : "{}",
"scheduleInputMode" : "{}",
"executive" : true,
"generic" : true,
"candidate" : false,
"external" : false,
"managerMultiCompany" : true,
"employeeFunctions" : {
"allFunctions" : false,
"allSales" : true,
"allPurchases" : false,
"allOperational" : true,
"projectSalesManager" : false,
"projectFinanceManager" : true,
"projectProductionManager" : false,
"projectAccountManager" : true,
"projectAssignment" : false,
"projectPhaseManager" : true,
"projectSendOnMission" : false,
"salesSalesAssistant" : true,
"salesOrderAndEstimateTracking" : false,
"salesBillingSchedulesTracking" : true,
"purchasingBuyer" : false,
"timeRecording" : true,
"inputOfExpenseReport" : false,
"purchasesReceptionTracking" : false,
"inputSchedule" : false,
"CMMSContractSalesManager" : false,
"CMMSContractTechnicalManager" : false,
"CMMSMRAndEOManager" : false
},
"employeeHistory" : [ {
"id" : "5000123",
"employeeHistoryType" : "5000123",
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 7.42,
"weekHours" : 38.3,
"occupancyRate" : 0.8,
"manager" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"managerId" : "5000123",
"company" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo"
},
"companyId" : "5000123",
"directHourlyRate" : 10.42,
"standardHourlyRate" : 10,
"dailyCost" : 59.36,
"dailySellingPrice" : 80,
"entity" : "5000123",
"serviceRef" : {
"id" : "5000123",
"name" : "Professional services",
"code" : "PS"
},
"service" : "5000123",
"position" : "Developer",
"skillRef" : {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
},
"skill" : "5000123",
"family1" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family1Id" : "5000123",
"family2" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family2Id" : "5000123",
"family3" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family3Id" : "5000123",
"leave" : false,
"standardWeek" : {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
}
},
"standardWeekId" : "5000123",
"salary" : 1024
}, {
"id" : "5000123",
"employeeHistoryType" : "5000123",
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 7.42,
"weekHours" : 38.3,
"occupancyRate" : 0.8,
"manager" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"managerId" : "5000123",
"company" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo"
},
"companyId" : "5000123",
"directHourlyRate" : 10.42,
"standardHourlyRate" : 10,
"dailyCost" : 59.36,
"dailySellingPrice" : 80,
"entity" : "5000123",
"serviceRef" : {
"id" : "5000123",
"name" : "Professional services",
"code" : "PS"
},
"service" : "5000123",
"position" : "Developer",
"skillRef" : {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
},
"skill" : "5000123",
"family1" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family1Id" : "5000123",
"family2" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family2Id" : "5000123",
"family3" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family3Id" : "5000123",
"leave" : false,
"standardWeek" : {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
}
},
"standardWeekId" : "5000123",
"salary" : 1024
} ],
"companyChanges" : [ {
"id" : "5000123",
"employeeId" : "500123",
"companyId" : "5000123",
"startDate" : "2020-01-23T04:56:07Z",
"endDate" : "2020-01-23T04:56:07Z",
"companyChangeState" : "{}",
"comment" : "Limpso usum"
}, {
"id" : "5000123",
"employeeId" : "500123",
"companyId" : "5000123",
"startDate" : "2020-01-23T04:56:07Z",
"endDate" : "2020-01-23T04:56:07Z",
"companyChangeState" : "{}",
"comment" : "Limpso usum"
} ],
"timeRecordingRules" : {
"id" : "5000123",
"employeeId" : "5000123",
"min" : 0,
"max" : 24,
"step" : 0.01,
"prettyStep" : 0.3,
"base" : 60,
"unit" : "H",
"unitDuration" : "{}",
"allowManualEntry" : true,
"employeeWeeks" : [ {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
},
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 8,
"dailyMinutes" : 10,
"weekHours" : 40,
"leave" : false
}, {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
},
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 8,
"dailyMinutes" : 10,
"weekHours" : 40,
"leave" : false
} ],
"closingDates" : [ {
"closingDate" : "2020-01-31T23:59:59Z",
"module" : "DATE_MODULE",
"beginningOfPeriod" : "2020-01-31T23:59:59Z",
"endOfPeriod" : "2020-01-31T23:59:59Z"
}, {
"closingDate" : "2020-01-31T23:59:59Z",
"module" : "DATE_MODULE",
"beginningOfPeriod" : "2020-01-31T23:59:59Z",
"endOfPeriod" : "2020-01-31T23:59:59Z"
} ],
"simpleDuration" : 750,
"completionMode" : "WEEKLY"
},
"scheduleRules" : {
"id" : "5000123",
"employeeId" : "5000123",
"min" : 0,
"max" : 24,
"step" : 0.01,
"prettyStep" : 0.3,
"base" : 60,
"unit" : "H",
"unitDuration" : "{}",
"allowManualEntry" : true,
"employeeWeeks" : [ {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
},
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 8,
"dailyMinutes" : 10,
"weekHours" : 40,
"leave" : false
}, {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
},
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 8,
"dailyMinutes" : 10,
"weekHours" : 40,
"leave" : false
} ],
"closingDates" : [ {
"closingDate" : "2020-01-31T23:59:59Z",
"module" : "DATE_MODULE",
"beginningOfPeriod" : "2020-01-31T23:59:59Z",
"endOfPeriod" : "2020-01-31T23:59:59Z"
}, {
"closingDate" : "2020-01-31T23:59:59Z",
"module" : "DATE_MODULE",
"beginningOfPeriod" : "2020-01-31T23:59:59Z",
"endOfPeriod" : "2020-01-31T23:59:59Z"
} ],
"timestamped" : true
},
"businessCards" : [ {
"id" : "5000123",
"employeeId" : "5000123",
"cardNumber" : "XXXX XXXX XXXX 7568",
"encryptedCardNumber" : "0",
"name" : "Management card",
"type" : "{}",
"endDate" : "2020-01-31T23:59:59Z"
}, {
"id" : "5000123",
"employeeId" : "5000123",
"cardNumber" : "XXXX XXXX XXXX 7568",
"encryptedCardNumber" : "0",
"name" : "Management card",
"type" : "{}",
"endDate" : "2020-01-31T23:59:59Z"
} ],
"sector" : "Marketing",
"number" : "84",
"relations" : [ {
"id" : "5000123",
"relationType" : {
"id" : "5000123",
"code" : "TUTOR",
"name" : "Tutor for internship"
},
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"relatedEmployee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"relatedEmployeeId" : "5000123"
}, {
"id" : "5000123",
"relationType" : {
"id" : "5000123",
"code" : "TUTOR",
"name" : "Tutor for internship"
},
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"relatedEmployee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"relatedEmployeeId" : "5000123"
} ],
"employeeAbilities" : [ {
"id" : "5000123",
"skill" : {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
},
"level" : {
"id" : "5000123",
"code" : "EXP",
"name" : "Expert"
},
"startDate" : "2020-01-31T23:59:59Z",
"endDate" : "2020-01-31T23:59:59Z",
"employeeId" : "5000123"
}, {
"id" : "5000123",
"skill" : {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
},
"level" : {
"id" : "5000123",
"code" : "EXP",
"name" : "Expert"
},
"startDate" : "2020-01-31T23:59:59Z",
"endDate" : "2020-01-31T23:59:59Z",
"employeeId" : "5000123"
} ],
"jobType" : {
"id" : "5000123",
"companyCode" : "AKSAS",
"code" : "ADMIN",
"name" : "Administrator",
"category" : "{}",
"validity" : {
"type" : "{}",
"date" : "2000-06-21T04:56:07.000+00:00"
},
"default" : true
},
"jobTypeId" : "100245",
"address" : {
"id" : "id",
"line1" : "221B Baker Street",
"line2" : "2nd Floor",
"line3" : "First door at your right",
"cedex" : "CEDEX 14",
"postalCode" : "69002",
"city" : "London",
"country" : "FR (for 'FRANCE')",
"countryName" : "FRANCE",
"department" : "75 (for 'PARIS')",
"geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
"region" : "65 (for 'ILE DE FRANCE')",
"regionName" : "ILE DE FRANCE",
"phone" : "06 00 00 00 01",
"phone2" : "06 00 00 00 02",
"email" : "myemail@mail.com",
"mobilePhone" : "06 00 00 00 02",
"fax" : "04 00 00 00 07",
"webSite" : "mysite.com"
},
"addressId" : "5000123",
"birthDate" : "2000-06-21T04:56:07.000+00:00",
"customData" : {
"key" : {
"type" : "{}",
"value" : "Autoref 010520",
"name" : "Reference 4",
"realOrder" : 0,
"label" : "REFERENCE_4"
}
},
"color" : "#FF0000",
"targetTace" : 75,
"formConfig" : {
"type" : "{}",
"fields" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"controls" : {
"key" : {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}
},
"insertable" : true,
"editable" : false,
"deletable" : false,
"formSearchHidden" : false
},
"changeTracking" : {
"createdTime" : "2000-06-21T04:56:07.000+00:00",
"createdBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"createdById" : "5000123",
"modificationTime" : "2000-06-21T04:56:07.000+00:00",
"modificationBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"modificationById" : "5000123"
},
"vehicles" : [ {
"id" : "5000123",
"power" : 5,
"licensePlate" : "licensePlate",
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"expenseType" : {
"id" : "5000123",
"code" : "MEAL",
"description" : "Plane",
"km" : false,
"notRefundable" : true,
"icon" : "fa fa-plane",
"color" : "00ff40",
"receiptRequired" : false,
"commentRequired" : false,
"guestsRequired" : false,
"notRefundableEditable" : true,
"billableEditable" : true,
"amountEditable" : true,
"showQuantity" : false,
"showAdditionalComment" : false,
"showReceiptNumber" : true,
"showAmountCategory" : true,
"showBillable" : true,
"hideVat" : false,
"vat1Code" : "1",
"vat2Code" : "2",
"vat3Code" : "3",
"expenseThreshold" : 100,
"defaultAmount" : 45,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"expenseCategory" : "{}",
"expenseRebillableOptions" : "{}",
"showCustomRequest" : true,
"showAmountWithoutVat" : true,
"controlsBehavior" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"calculateKilometers" : true,
"freeEntryProhibited" : true,
"controls" : {
"enableDuplicate" : true,
"enablelOnNonWorkingDay" : true,
"enableOnDayWithLeaveRequest" : true,
"enableOnDayWithTimesheetOrSchedule" : true
},
"expenseThresholdExceededNoVat" : false
},
"expenseTypeId" : "5000123",
"endDate" : "2020-01-31T23:59:59Z"
}, {
"id" : "5000123",
"power" : 5,
"licensePlate" : "licensePlate",
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"expenseType" : {
"id" : "5000123",
"code" : "MEAL",
"description" : "Plane",
"km" : false,
"notRefundable" : true,
"icon" : "fa fa-plane",
"color" : "00ff40",
"receiptRequired" : false,
"commentRequired" : false,
"guestsRequired" : false,
"notRefundableEditable" : true,
"billableEditable" : true,
"amountEditable" : true,
"showQuantity" : false,
"showAdditionalComment" : false,
"showReceiptNumber" : true,
"showAmountCategory" : true,
"showBillable" : true,
"hideVat" : false,
"vat1Code" : "1",
"vat2Code" : "2",
"vat3Code" : "3",
"expenseThreshold" : 100,
"defaultAmount" : 45,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"expenseCategory" : "{}",
"expenseRebillableOptions" : "{}",
"showCustomRequest" : true,
"showAmountWithoutVat" : true,
"controlsBehavior" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"calculateKilometers" : true,
"freeEntryProhibited" : true,
"controls" : {
"enableDuplicate" : true,
"enablelOnNonWorkingDay" : true,
"enableOnDayWithLeaveRequest" : true,
"enableOnDayWithTimesheetOrSchedule" : true
},
"expenseThresholdExceededNoVat" : false
},
"expenseTypeId" : "5000123",
"endDate" : "2020-01-31T23:59:59Z"
} ],
"currentCompany" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo",
"legalName" : "legalName",
"siren" : "siren",
"siret" : "siret",
"calendar" : {
"id" : "5000123",
"code" : "Text",
"name" : "Text",
"default" : true,
"daysNotWorked" : [ 6, 6 ],
"holidays" : [ {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
}, {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
} ]
},
"calendarId" : "calendarId",
"color" : "color",
"currency" : {
"id" : "5000123",
"name" : "Euro",
"code" : "EUR",
"order" : 17,
"euro" : true,
"euroRate" : 0.9678,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"euroRateStartDate" : "2020-01-23T04:56:07Z",
"euroRateEndDate" : "2020-01-23T04:56:07Z"
},
"currencyId" : "currencyId",
"address" : {
"id" : "id",
"line1" : "221B Baker Street",
"line2" : "2nd Floor",
"line3" : "First door at your right",
"cedex" : "CEDEX 14",
"postalCode" : "69002",
"city" : "London",
"country" : "FR (for 'FRANCE')",
"countryName" : "FRANCE",
"department" : "75 (for 'PARIS')",
"geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
"region" : "65 (for 'ILE DE FRANCE')",
"regionName" : "ILE DE FRANCE",
"phone" : "06 00 00 00 01",
"phone2" : "06 00 00 00 02",
"email" : "myemail@mail.com",
"mobilePhone" : "06 00 00 00 02",
"fax" : "04 00 00 00 07",
"webSite" : "mysite.com"
},
"addressId" : "addressId"
},
"currentCompanyId" : "5000123",
"bankingInformation" : {
"id" : "5000123",
"sepa" : {
"bankDetails" : {
"entity" : "30002",
"counter" : "550",
"accountNumber" : "0000157841Z",
"key" : "25",
"domiciliation" : "AURA"
},
"bic" : {
"country" : "FR (for 'FRANCE')",
"bank" : "DAAE",
"location" : "PP",
"branch" : "CCT"
},
"iban" : {
"country" : "FR (for 'FRANCE')",
"key" : "69",
"accountNumber" : "0000157841Z"
}
},
"noneSepa" : {
"defaultBankDetail" : false,
"beneficiary" : {
"holder" : {
"name" : "RITA",
"firstName" : "BRITA",
"accountType" : "{}",
"accountNumber" : "123456789"
},
"bank" : {
"bankName" : "UBA",
"bankName2" : "UBA",
"bankType" : "{}",
"bankCode" : "C8",
"bankAddress" : {
"id" : "id",
"line1" : "221B Baker Street",
"line2" : "2nd Floor",
"line3" : "First door at your right",
"cedex" : "CEDEX 14",
"postalCode" : "69002",
"city" : "London",
"country" : "FR (for 'FRANCE')",
"countryName" : "FRANCE",
"department" : "75 (for 'PARIS')",
"geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
"region" : "65 (for 'ILE DE FRANCE')",
"regionName" : "ILE DE FRANCE",
"phone" : "06 00 00 00 01",
"phone2" : "06 00 00 00 02",
"email" : "myemail@mail.com",
"mobilePhone" : "06 00 00 00 02",
"fax" : "04 00 00 00 07",
"webSite" : "mysite.com"
}
}
},
"intermediate" : {
"holder" : {
"name" : "RITA",
"firstName" : "BRITA",
"accountType" : "{}",
"accountNumber" : "123456789"
},
"bank" : {
"bankName" : "UBA",
"bankName2" : "UBA",
"bankType" : "{}",
"bankCode" : "C8",
"bankAddress" : {
"id" : "id",
"line1" : "221B Baker Street",
"line2" : "2nd Floor",
"line3" : "First door at your right",
"cedex" : "CEDEX 14",
"postalCode" : "69002",
"city" : "London",
"country" : "FR (for 'FRANCE')",
"countryName" : "FRANCE",
"department" : "75 (for 'PARIS')",
"geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
"region" : "65 (for 'ILE DE FRANCE')",
"regionName" : "ILE DE FRANCE",
"phone" : "06 00 00 00 01",
"phone2" : "06 00 00 00 02",
"email" : "myemail@mail.com",
"mobilePhone" : "06 00 00 00 02",
"fax" : "04 00 00 00 07",
"webSite" : "mysite.com"
}
}
}
},
"statusChangeDate" : "2000-06-21T04:56:07.000+00:00",
"statusChangeArgument" : {
"comment" : "Comment",
"status" : "{}"
},
"validator" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"validatorId" : "5000123",
"action" : "{}",
"type" : "{}"
},
"faxNumber" : "418 643 3210",
"phoneExtensionNumber" : "04 00 00 00 07"
},
"employeeId" : "5000123",
"departureDate" : "2020-01-31T23:59:59Z",
"departureActualDate" : "2020-01-31T23:59:59Z",
"departureCity" : {
"id" : "5000123",
"name" : "City 1",
"default" : true,
"postcode" : "73000",
"country" : {
"id" : "5000123",
"name" : "Country 1",
"currency" : {
"id" : "5000123",
"name" : "Euro",
"code" : "EUR",
"order" : 17,
"euro" : true,
"euroRate" : 0.9678,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"euroRateStartDate" : "2020-01-23T04:56:07Z",
"euroRateEndDate" : "2020-01-23T04:56:07Z"
},
"currencyId" : "5000123",
"calendar" : {
"id" : "5000123",
"code" : "Text",
"name" : "Text",
"default" : true,
"daysNotWorked" : [ 6, 6 ],
"holidays" : [ {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
}, {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
} ]
},
"calendarId" : "5000123",
"code" : "FR",
"companyCode" : "AKSAS",
"companyId" : "5000123",
"isPartOfEU" : true,
"continent" : "AFRICA"
},
"countryId" : "5000123",
"department" : {
"id" : "5000123",
"code" : "01-A",
"companyCode" : "AKSAS",
"name" : "Lorem Ipsum",
"analysis" : "analysis",
"comment" : "comment",
"entity" : {
"id" : "5000123",
"code" : "01-BRDX",
"name" : "Bordeaux",
"legalName" : "Customer care",
"division" : {
"id" : "5000123",
"name" : "Rhone-Alpes",
"code" : "RA",
"group" : {
"id" : "5000123",
"name" : "West",
"code" : "WST",
"serviceId" : "5000123"
},
"groupId" : "5000123",
"companyId" : "5000123"
},
"divisionId" : "5000123",
"divisionCode" : "01-DIV",
"companyId" : "5000123",
"endDate" : "2020-01-23T04:56:07Z"
},
"entityId" : "entityId",
"projectType" : "{}",
"activities" : [ {
"id" : "5000123",
"code" : "code",
"name" : "name"
}, {
"id" : "5000123",
"code" : "code",
"name" : "name"
} ]
},
"departmentId" : "5000123",
"regionId" : "123456",
"companyCode" : "AKSAS",
"latitude" : "5.9845W",
"longitude" : "37.3891N"
},
"departureLocation" : "Lyon",
"arrivalDate" : "2020-01-31T23:59:59Z",
"arrivalActualDate" : "2020-01-31T23:59:59Z",
"arrivalCity" : {
"id" : "5000123",
"name" : "City 1",
"default" : true,
"postcode" : "73000",
"country" : {
"id" : "5000123",
"name" : "Country 1",
"currency" : {
"id" : "5000123",
"name" : "Euro",
"code" : "EUR",
"order" : 17,
"euro" : true,
"euroRate" : 0.9678,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"euroRateStartDate" : "2020-01-23T04:56:07Z",
"euroRateEndDate" : "2020-01-23T04:56:07Z"
},
"currencyId" : "5000123",
"calendar" : {
"id" : "5000123",
"code" : "Text",
"name" : "Text",
"default" : true,
"daysNotWorked" : [ 6, 6 ],
"holidays" : [ {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
}, {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
} ]
},
"calendarId" : "5000123",
"code" : "FR",
"companyCode" : "AKSAS",
"companyId" : "5000123",
"isPartOfEU" : true,
"continent" : "AFRICA"
},
"countryId" : "5000123",
"department" : {
"id" : "5000123",
"code" : "01-A",
"companyCode" : "AKSAS",
"name" : "Lorem Ipsum",
"analysis" : "analysis",
"comment" : "comment",
"entity" : {
"id" : "5000123",
"code" : "01-BRDX",
"name" : "Bordeaux",
"legalName" : "Customer care",
"division" : {
"id" : "5000123",
"name" : "Rhone-Alpes",
"code" : "RA",
"group" : {
"id" : "5000123",
"name" : "West",
"code" : "WST",
"serviceId" : "5000123"
},
"groupId" : "5000123",
"companyId" : "5000123"
},
"divisionId" : "5000123",
"divisionCode" : "01-DIV",
"companyId" : "5000123",
"endDate" : "2020-01-23T04:56:07Z"
},
"entityId" : "entityId",
"projectType" : "{}",
"activities" : [ {
"id" : "5000123",
"code" : "code",
"name" : "name"
}, {
"id" : "5000123",
"code" : "code",
"name" : "name"
} ]
},
"departmentId" : "5000123",
"regionId" : "123456",
"companyCode" : "AKSAS",
"latitude" : "5.9845W",
"longitude" : "37.3891N"
},
"arrivalLocation" : "Oslo",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"documents" : [ {
"id" : "5000123",
"title" : "Title",
"versionId" : "5000123",
"changeTracking" : {
"createdTime" : "2000-06-21T04:56:07.000+00:00",
"createdBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"createdById" : "5000123",
"modificationTime" : "2000-06-21T04:56:07.000+00:00",
"modificationBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"modificationById" : "5000123"
},
"publishedBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"publishedById" : "5001206",
"classification" : "STD",
"subClassification" : "EDITIONS",
"category1" : "CAT1",
"category2" : "CAT2",
"category3" : "CAT3",
"companyId" : "5000123",
"publicationDate" : "2000-06-21T04:56:07.000+00:00",
"version" : 1,
"documentType" : "File",
"fileUrl" : "myFiles/thisFile.pdf",
"fileName" : "thisFile.pdf",
"lienUrl" : "myStorage.com/myFiles/thisFile.pdf",
"url" : "myFiles/thisFile.pdf",
"original" : false,
"preview" : "data:image",
"tokenPreview" : "8946A85V85D851DF",
"externalDMSUuid" : "OD1245126",
"links" : [ {
"id" : "5000123",
"original" : true,
"documentId" : "5000123",
"objectId" : "5000123",
"objectType" : "{}"
}, {
"id" : "5000123",
"original" : true,
"documentId" : "5000123",
"objectId" : "5000123",
"objectType" : "{}"
} ],
"archived" : false,
"action" : "{}",
"owner" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"ownerId" : "5001206",
"description" : "Text",
"category" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"categoryId" : "100024",
"subCategory" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"company" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo",
"legalName" : "legalName",
"siren" : "siren",
"siret" : "siret",
"calendar" : {
"id" : "5000123",
"code" : "Text",
"name" : "Text",
"default" : true,
"daysNotWorked" : [ 6, 6 ],
"holidays" : [ {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
}, {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
} ]
},
"calendarId" : "calendarId",
"color" : "color",
"currency" : {
"id" : "5000123",
"name" : "Euro",
"code" : "EUR",
"order" : 17,
"euro" : true,
"euroRate" : 0.9678,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"euroRateStartDate" : "2020-01-23T04:56:07Z",
"euroRateEndDate" : "2020-01-23T04:56:07Z"
},
"currencyId" : "currencyId",
"address" : {
"id" : "id",
"line1" : "221B Baker Street",
"line2" : "2nd Floor",
"line3" : "First door at your right",
"cedex" : "CEDEX 14",
"postalCode" : "69002",
"city" : "London",
"country" : "FR (for 'FRANCE')",
"countryName" : "FRANCE",
"department" : "75 (for 'PARIS')",
"geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
"region" : "65 (for 'ILE DE FRANCE')",
"regionName" : "ILE DE FRANCE",
"phone" : "06 00 00 00 01",
"phone2" : "06 00 00 00 02",
"email" : "myemail@mail.com",
"mobilePhone" : "06 00 00 00 02",
"fax" : "04 00 00 00 07",
"webSite" : "mysite.com"
},
"addressId" : "addressId"
},
"companyId" : "5000123",
"type" : "{}",
"category" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"categoryId" : "500143",
"grouping" : "grouping",
"ranking" : 2
},
"subCategoryId" : "11037",
"locked" : false
}, {
"id" : "5000123",
"title" : "Title",
"versionId" : "5000123",
"changeTracking" : {
"createdTime" : "2000-06-21T04:56:07.000+00:00",
"createdBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"createdById" : "5000123",
"modificationTime" : "2000-06-21T04:56:07.000+00:00",
"modificationBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"modificationById" : "5000123"
},
"publishedBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"publishedById" : "5001206",
"classification" : "STD",
"subClassification" : "EDITIONS",
"category1" : "CAT1",
"category2" : "CAT2",
"category3" : "CAT3",
"companyId" : "5000123",
"publicationDate" : "2000-06-21T04:56:07.000+00:00",
"version" : 1,
"documentType" : "File",
"fileUrl" : "myFiles/thisFile.pdf",
"fileName" : "thisFile.pdf",
"lienUrl" : "myStorage.com/myFiles/thisFile.pdf",
"url" : "myFiles/thisFile.pdf",
"original" : false,
"preview" : "data:image",
"tokenPreview" : "8946A85V85D851DF",
"externalDMSUuid" : "OD1245126",
"links" : [ {
"id" : "5000123",
"original" : true,
"documentId" : "5000123",
"objectId" : "5000123",
"objectType" : "{}"
}, {
"id" : "5000123",
"original" : true,
"documentId" : "5000123",
"objectId" : "5000123",
"objectType" : "{}"
} ],
"archived" : false,
"action" : "{}",
"owner" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"ownerId" : "5001206",
"description" : "Text",
"category" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"categoryId" : "100024",
"subCategory" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"company" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo",
"legalName" : "legalName",
"siren" : "siren",
"siret" : "siret",
"calendar" : {
"id" : "5000123",
"code" : "Text",
"name" : "Text",
"default" : true,
"daysNotWorked" : [ 6, 6 ],
"holidays" : [ {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
}, {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
} ]
},
"calendarId" : "calendarId",
"color" : "color",
"currency" : {
"id" : "5000123",
"name" : "Euro",
"code" : "EUR",
"order" : 17,
"euro" : true,
"euroRate" : 0.9678,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"euroRateStartDate" : "2020-01-23T04:56:07Z",
"euroRateEndDate" : "2020-01-23T04:56:07Z"
},
"currencyId" : "currencyId",
"address" : {
"id" : "id",
"line1" : "221B Baker Street",
"line2" : "2nd Floor",
"line3" : "First door at your right",
"cedex" : "CEDEX 14",
"postalCode" : "69002",
"city" : "London",
"country" : "FR (for 'FRANCE')",
"countryName" : "FRANCE",
"department" : "75 (for 'PARIS')",
"geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
"region" : "65 (for 'ILE DE FRANCE')",
"regionName" : "ILE DE FRANCE",
"phone" : "06 00 00 00 01",
"phone2" : "06 00 00 00 02",
"email" : "myemail@mail.com",
"mobilePhone" : "06 00 00 00 02",
"fax" : "04 00 00 00 07",
"webSite" : "mysite.com"
},
"addressId" : "addressId"
},
"companyId" : "5000123",
"type" : "{}",
"category" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"categoryId" : "500143",
"grouping" : "grouping",
"ranking" : 2
},
"subCategoryId" : "11037",
"locked" : false
} ],
"numberOfDocuments" : 2,
"formConfig" : {
"type" : "{}",
"fields" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"controls" : {
"key" : {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}
},
"insertable" : true,
"editable" : false,
"deletable" : false,
"formSearchHidden" : false
},
"cancellationDate" : "2020-01-31T23:59:59Z",
"cancellationUser" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"cancellationUserId" : "5000123",
"archiveDate" : "2020-01-31T23:59:59Z",
"archiveUser" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"archiveUserId" : "5000123",
"comment" : "Lorem ipsum",
"multiProjects" : true
}
2.3.19. Update a custom request line
POST |
/custom-requests/{custom_request_id}/custom-request-lines/{custom_request_line_id} |
Description
Update a custom request line
DMF required:
-
DMF A40602: Api Workforce / Custom Requests / Update
-
DMF 161404: Tools / Custom Requests / Modify
-
DMF 161411: Tools / Custom Requests / Modify Completed Request
-
DMF 161417: Tools / Custom Requests / Modify Archived Request
-
DMF 191103: Web Portal / Custom Requests / Modify
-
DMF 191108: Web Portal / Custom Requests / Cancel 'approved' Request
-
DMF 191109: Web Portal / Custom Requests / Cancel 'to Be Approved' Request
-
DMF 191110: Web Portal / Custom Requests / Cancel 'denied' Request
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
custom_request_id |
Id of a custom request |
X |
null |
|
custom_request_line_id |
Id of a custom request line |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
customRequestLine |
The custom request line to update CustomRequestLine |
X |
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
The custom request line has been successfully updated |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"id" : "5000123",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJT_001",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"subPhase" : {
"id" : "5000123",
"code" : "SB_1",
"name" : "Sub Phase 1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"order" : 1
},
"subPhaseId" : "51000122",
"projectTask" : {
"id" : "5000123",
"code" : "code",
"name" : "Team building",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJT_001",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"subPhase" : {
"id" : "5000123",
"code" : "SB_1",
"name" : "Sub Phase 1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"order" : 1
},
"subPhaseId" : "51000122",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"order" : 2,
"startDate" : "2000-06-21T04:56:07.000+00:00",
"endDate" : "2000-06-21T04:56:07.000+00:00",
"description" : "description"
},
"projectTaskId" : "5000123",
"managementObjectId" : "5000123",
"name" : "Helpdesk",
"quantity" : 3,
"unitPriceCurrency" : 36.32,
"unitPrice" : 40,
"amountTotalCurrency" : 1200,
"amountTotal" : 1200,
"rankNumber" : 2,
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"expenseTypeExpected" : {
"id" : "5000123",
"code" : "AIR-PL",
"name" : "Airplane",
"description" : "Transportation",
"endDate" : "2000-06-21T04:56:07.000+00:00",
"expenseType" : {
"id" : "5000123",
"code" : "MEAL",
"description" : "Plane",
"km" : false,
"notRefundable" : true,
"icon" : "fa fa-plane",
"color" : "00ff40",
"receiptRequired" : false,
"commentRequired" : false,
"guestsRequired" : false,
"notRefundableEditable" : true,
"billableEditable" : true,
"amountEditable" : true,
"showQuantity" : false,
"showAdditionalComment" : false,
"showReceiptNumber" : true,
"showAmountCategory" : true,
"showBillable" : true,
"hideVat" : false,
"vat1Code" : "1",
"vat2Code" : "2",
"vat3Code" : "3",
"expenseThreshold" : 100,
"defaultAmount" : 45,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"expenseCategory" : "{}",
"expenseRebillableOptions" : "{}",
"showCustomRequest" : true,
"showAmountWithoutVat" : true,
"controlsBehavior" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"calculateKilometers" : true,
"freeEntryProhibited" : true,
"controls" : {
"enableDuplicate" : true,
"enablelOnNonWorkingDay" : true,
"enableOnDayWithLeaveRequest" : true,
"enableOnDayWithTimesheetOrSchedule" : true
},
"expenseThresholdExceededNoVat" : false
},
"expenseTypeId" : "expenseTypeId",
"editableExpenseReport" : true,
"defaultExpenseReport" : true
},
"expenseTypeExpectedId" : "5000123",
"isExpenseReport" : true
}
2.4. Employee Skills
2.4.1. Delete employee's abilities
POST |
/employees/{employee_id}/abilities/delete |
Description
Delete employee’s abilities listed below matching the specified employee ID.
DMF required:
-
DMF A40102: Api Workforce / Employees / Update
-
DMF 160802: Tools / Resources / Modify
-
DMF 160866: Tools / Resources / Modify Status History
-
DMF 160851: Tools / Resources / Modify Linked Employees
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
employee_id |
Id of an employee |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
employeeAbility |
List of employee's abilities to delete EmployeeAbility |
X |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Employee's abilities successfully deleted |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"id" : "5000123",
"skill" : {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
},
"level" : {
"id" : "5000123",
"code" : "EXP",
"name" : "Expert"
},
"startDate" : "2020-01-31T23:59:59Z",
"endDate" : "2020-01-31T23:59:59Z",
"employeeId" : "5000123"
}
2.4.2. Search employee abilities by employee's ID
GET |
/employees/{employee_id}/abilities |
Description
Get the list of abilities of an employee matching the specified employee ID.
DMF required:
-
DMF A40115: Api Workforce / Employees / Search Abilities
-
DMF 090116: Administrator / Setup / Resource Skills
-
DMF 1511__: Dashboards / Skills Dashboard
-
DMF 160879: Tools / Resources / Show Skills Tab
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
employee_id |
Id of an employee |
X |
null |
Return Type
array[EmployeeAbility]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Abilities of the employee successfully loaded |
List[EmployeeAbility] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.4.3. Search for abilities (with search criteria)
POST |
/abilities/search |
Description
Get the list of skills with the associated level matching the search criteria.
DMF required:
-
DMF A40115: Api Workforce / Employees / Search Abilities
-
DMF 090116: Administrator / Setup / Resource Skills
-
DMF 1511__: Dashboards / Skills Dashboard
-
DMF 160879: Tools / Resources / Show Skills Tab
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
criteria |
Criteria that you choose (ID, name, etc…) AbilityCriteria |
X |
Return Type
array[Ability]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Abilities successfully loaded |
List[Ability] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"code" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"name" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"employeeId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"id" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"abilityFilter" : [ {
"skillId" : "5000123",
"levelId" : "5000123"
}, {
"skillId" : "5000123",
"levelId" : "5000123"
} ],
"tag" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
}
}
2.4.4. Search skills (with search criteria)
POST |
/skills/search |
Description
Get the list of the skills matching the search criteria.
DMF required:
-
DMF A40114: Api Workforce / Employees / Search Skills
-
DMF 090116: Administrator / Setup / Resource Skills
-
DMF 1511__: Dashboards / Skills Dashboard
-
DMF 160879: Tools / Resources / Show Skills Tab
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
criteria |
Criteria that you choose (code, name, etc…) SkillCriteria |
X |
Return Type
array[Skill]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Skills successfully loaded |
List[Skill] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"projectTaskId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"code" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"name" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"onlyMainSkill" : false,
"id" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"tag" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
}
}
2.4.5. Update the list of abilities of an employee
POST |
/employees/{employee_id}/abilities |
Description
Update the list of abilities of an employee matching the specified\
\ ID and using the list of parameters below.
DMF required:
-
DMF A40115: Api Workforce / Employees / Search Abilities
-
DMF 090116: Administrator / Setup / Resource Skills
-
DMF 1511__: Dashboards / Skills Dashboard
-
DMF 160879: Tools / Resources / Show Skills Tab
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
employee_id |
Id of an employee |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
employeeAbility |
Employee Abilities to update EmployeeAbility |
X |
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Abilities of the employee successfully updated |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"id" : "5000123",
"skill" : {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
},
"level" : {
"id" : "5000123",
"code" : "EXP",
"name" : "Expert"
},
"startDate" : "2020-01-31T23:59:59Z",
"endDate" : "2020-01-31T23:59:59Z",
"employeeId" : "5000123"
}
2.5. Employees
2.5.1. Add a vehicle to an employee
PUT |
/employees/{employee_id}/vehicles |
Description
Add a vehicle to an employee.
DMF required:
-
DMF A40148: Api Workforce / Employees / Add A Vehicle To An Employee
-
DMF 160802: Tools / Resources / Modify
-
DMF 160853: Tools / Resources / Modify Taxable Powers
-
DMF 160881: Tools / Resources / Import Vehicles
-
DMF 160882: Tools / Resources / Import Mileage Allowances
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
employee_id |
Id of an employee |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
Vehicle |
The vehicle to associate Vehicle Vehicle |
- |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
The vehicle has been successfully added to the employee |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"id" : "5000123",
"power" : 5,
"licensePlate" : "licensePlate",
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"expenseType" : {
"id" : "5000123",
"code" : "MEAL",
"description" : "Plane",
"km" : false,
"notRefundable" : true,
"icon" : "fa fa-plane",
"color" : "00ff40",
"receiptRequired" : false,
"commentRequired" : false,
"guestsRequired" : false,
"notRefundableEditable" : true,
"billableEditable" : true,
"amountEditable" : true,
"showQuantity" : false,
"showAdditionalComment" : false,
"showReceiptNumber" : true,
"showAmountCategory" : true,
"showBillable" : true,
"hideVat" : false,
"vat1Code" : "1",
"vat2Code" : "2",
"vat3Code" : "3",
"expenseThreshold" : 100,
"defaultAmount" : 45,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"expenseCategory" : "{}",
"expenseRebillableOptions" : "{}",
"showCustomRequest" : true,
"showAmountWithoutVat" : true,
"controlsBehavior" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"calculateKilometers" : true,
"freeEntryProhibited" : true,
"controls" : {
"enableDuplicate" : true,
"enablelOnNonWorkingDay" : true,
"enableOnDayWithLeaveRequest" : true,
"enableOnDayWithTimesheetOrSchedule" : true
},
"expenseThresholdExceededNoVat" : false
},
"expenseTypeId" : "5000123",
"endDate" : "2020-01-31T23:59:59Z"
}
2.5.2. Change an employee's code
POST |
/employees/change-code |
Description
Change an employee’s code
DMF required:
-
DMF A40158: Api Workforce / Employees / Change The Employee Code
-
DMF 160819: Tools / Resources / Modify Resource Code
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
employeeCodeChange |
Parameters for changing employee code EmployeeCodeChange |
X |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
The employee's code been successfully updated |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"oldCode" : "CASH",
"excludePreviousCode" : false,
"newCode" : "CASH"
}
2.5.3. Change the transfer state of an employee.
POST |
/employees/{employee_id}/change-transfer-state |
Description
Change the transfer state of an employee.
DMF required:
-
DMF A40155: Api Workforce / Employees / Change The Transfer State Of An Employee
-
DMF 160855: Tools / Resources / Transfer To Another Company
-
DMF 160851: Tools / Resources / Modify Linked Employees
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
employee_id |
Id of an employee |
X |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
The transfer state of the employee successfully updated |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.5.4. Create an employee
PUT |
/employees |
Description
Create an employee using the list of parameters below.
DMF required:
-
DMF A40101: Api Workforce / Employees / Insert
-
DMF 160801: Tools / Resources / New
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
employee |
The employee to create Employee |
X |
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Employee successfully created |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}",
"title" : "GEN",
"phone" : "+33 6 04 04 04 05",
"mobilePhone" : "+33 6 00 00 00 01",
"email" : "myemail@bechmail.com",
"noTimesDunning" : true,
"assignmentMultiCompany" : false,
"modeTimeRecording" : 1,
"modeInputSchedule" : 3,
"timeRecordingInputMode" : "{}",
"scheduleInputMode" : "{}",
"executive" : true,
"generic" : true,
"candidate" : false,
"external" : false,
"managerMultiCompany" : true,
"employeeFunctions" : {
"allFunctions" : false,
"allSales" : true,
"allPurchases" : false,
"allOperational" : true,
"projectSalesManager" : false,
"projectFinanceManager" : true,
"projectProductionManager" : false,
"projectAccountManager" : true,
"projectAssignment" : false,
"projectPhaseManager" : true,
"projectSendOnMission" : false,
"salesSalesAssistant" : true,
"salesOrderAndEstimateTracking" : false,
"salesBillingSchedulesTracking" : true,
"purchasingBuyer" : false,
"timeRecording" : true,
"inputOfExpenseReport" : false,
"purchasesReceptionTracking" : false,
"inputSchedule" : false,
"CMMSContractSalesManager" : false,
"CMMSContractTechnicalManager" : false,
"CMMSMRAndEOManager" : false
},
"employeeHistory" : [ {
"id" : "5000123",
"employeeHistoryType" : "5000123",
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 7.42,
"weekHours" : 38.3,
"occupancyRate" : 0.8,
"manager" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"managerId" : "5000123",
"company" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo"
},
"companyId" : "5000123",
"directHourlyRate" : 10.42,
"standardHourlyRate" : 10,
"dailyCost" : 59.36,
"dailySellingPrice" : 80,
"entity" : "5000123",
"serviceRef" : {
"id" : "5000123",
"name" : "Professional services",
"code" : "PS"
},
"service" : "5000123",
"position" : "Developer",
"skillRef" : {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
},
"skill" : "5000123",
"family1" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family1Id" : "5000123",
"family2" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family2Id" : "5000123",
"family3" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family3Id" : "5000123",
"leave" : false,
"standardWeek" : {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
}
},
"standardWeekId" : "5000123",
"salary" : 1024
}, {
"id" : "5000123",
"employeeHistoryType" : "5000123",
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 7.42,
"weekHours" : 38.3,
"occupancyRate" : 0.8,
"manager" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"managerId" : "5000123",
"company" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo"
},
"companyId" : "5000123",
"directHourlyRate" : 10.42,
"standardHourlyRate" : 10,
"dailyCost" : 59.36,
"dailySellingPrice" : 80,
"entity" : "5000123",
"serviceRef" : {
"id" : "5000123",
"name" : "Professional services",
"code" : "PS"
},
"service" : "5000123",
"position" : "Developer",
"skillRef" : {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
},
"skill" : "5000123",
"family1" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family1Id" : "5000123",
"family2" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family2Id" : "5000123",
"family3" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family3Id" : "5000123",
"leave" : false,
"standardWeek" : {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
}
},
"standardWeekId" : "5000123",
"salary" : 1024
} ],
"companyChanges" : [ {
"id" : "5000123",
"employeeId" : "500123",
"companyId" : "5000123",
"startDate" : "2020-01-23T04:56:07Z",
"endDate" : "2020-01-23T04:56:07Z",
"companyChangeState" : "{}",
"comment" : "Limpso usum"
}, {
"id" : "5000123",
"employeeId" : "500123",
"companyId" : "5000123",
"startDate" : "2020-01-23T04:56:07Z",
"endDate" : "2020-01-23T04:56:07Z",
"companyChangeState" : "{}",
"comment" : "Limpso usum"
} ],
"timeRecordingRules" : {
"id" : "5000123",
"employeeId" : "5000123",
"min" : 0,
"max" : 24,
"step" : 0.01,
"prettyStep" : 0.3,
"base" : 60,
"unit" : "H",
"unitDuration" : "{}",
"allowManualEntry" : true,
"employeeWeeks" : [ {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
},
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 8,
"dailyMinutes" : 10,
"weekHours" : 40,
"leave" : false
}, {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
},
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 8,
"dailyMinutes" : 10,
"weekHours" : 40,
"leave" : false
} ],
"closingDates" : [ {
"closingDate" : "2020-01-31T23:59:59Z",
"module" : "DATE_MODULE",
"beginningOfPeriod" : "2020-01-31T23:59:59Z",
"endOfPeriod" : "2020-01-31T23:59:59Z"
}, {
"closingDate" : "2020-01-31T23:59:59Z",
"module" : "DATE_MODULE",
"beginningOfPeriod" : "2020-01-31T23:59:59Z",
"endOfPeriod" : "2020-01-31T23:59:59Z"
} ],
"simpleDuration" : 750,
"completionMode" : "WEEKLY"
},
"scheduleRules" : {
"id" : "5000123",
"employeeId" : "5000123",
"min" : 0,
"max" : 24,
"step" : 0.01,
"prettyStep" : 0.3,
"base" : 60,
"unit" : "H",
"unitDuration" : "{}",
"allowManualEntry" : true,
"employeeWeeks" : [ {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
},
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 8,
"dailyMinutes" : 10,
"weekHours" : 40,
"leave" : false
}, {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
},
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 8,
"dailyMinutes" : 10,
"weekHours" : 40,
"leave" : false
} ],
"closingDates" : [ {
"closingDate" : "2020-01-31T23:59:59Z",
"module" : "DATE_MODULE",
"beginningOfPeriod" : "2020-01-31T23:59:59Z",
"endOfPeriod" : "2020-01-31T23:59:59Z"
}, {
"closingDate" : "2020-01-31T23:59:59Z",
"module" : "DATE_MODULE",
"beginningOfPeriod" : "2020-01-31T23:59:59Z",
"endOfPeriod" : "2020-01-31T23:59:59Z"
} ],
"timestamped" : true
},
"businessCards" : [ {
"id" : "5000123",
"employeeId" : "5000123",
"cardNumber" : "XXXX XXXX XXXX 7568",
"encryptedCardNumber" : "0",
"name" : "Management card",
"type" : "{}",
"endDate" : "2020-01-31T23:59:59Z"
}, {
"id" : "5000123",
"employeeId" : "5000123",
"cardNumber" : "XXXX XXXX XXXX 7568",
"encryptedCardNumber" : "0",
"name" : "Management card",
"type" : "{}",
"endDate" : "2020-01-31T23:59:59Z"
} ],
"sector" : "Marketing",
"number" : "84",
"relations" : [ {
"id" : "5000123",
"relationType" : {
"id" : "5000123",
"code" : "TUTOR",
"name" : "Tutor for internship"
},
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"relatedEmployee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"relatedEmployeeId" : "5000123"
}, {
"id" : "5000123",
"relationType" : {
"id" : "5000123",
"code" : "TUTOR",
"name" : "Tutor for internship"
},
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"relatedEmployee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"relatedEmployeeId" : "5000123"
} ],
"employeeAbilities" : [ {
"id" : "5000123",
"skill" : {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
},
"level" : {
"id" : "5000123",
"code" : "EXP",
"name" : "Expert"
},
"startDate" : "2020-01-31T23:59:59Z",
"endDate" : "2020-01-31T23:59:59Z",
"employeeId" : "5000123"
}, {
"id" : "5000123",
"skill" : {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
},
"level" : {
"id" : "5000123",
"code" : "EXP",
"name" : "Expert"
},
"startDate" : "2020-01-31T23:59:59Z",
"endDate" : "2020-01-31T23:59:59Z",
"employeeId" : "5000123"
} ],
"jobType" : {
"id" : "5000123",
"companyCode" : "AKSAS",
"code" : "ADMIN",
"name" : "Administrator",
"category" : "{}",
"validity" : {
"type" : "{}",
"date" : "2000-06-21T04:56:07.000+00:00"
},
"default" : true
},
"jobTypeId" : "100245",
"address" : {
"id" : "id",
"line1" : "221B Baker Street",
"line2" : "2nd Floor",
"line3" : "First door at your right",
"cedex" : "CEDEX 14",
"postalCode" : "69002",
"city" : "London",
"country" : "FR (for 'FRANCE')",
"countryName" : "FRANCE",
"department" : "75 (for 'PARIS')",
"geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
"region" : "65 (for 'ILE DE FRANCE')",
"regionName" : "ILE DE FRANCE",
"phone" : "06 00 00 00 01",
"phone2" : "06 00 00 00 02",
"email" : "myemail@mail.com",
"mobilePhone" : "06 00 00 00 02",
"fax" : "04 00 00 00 07",
"webSite" : "mysite.com"
},
"addressId" : "5000123",
"birthDate" : "2000-06-21T04:56:07.000+00:00",
"customData" : {
"key" : {
"type" : "{}",
"value" : "Autoref 010520",
"name" : "Reference 4",
"realOrder" : 0,
"label" : "REFERENCE_4"
}
},
"color" : "#FF0000",
"targetTace" : 75,
"formConfig" : {
"type" : "{}",
"fields" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"controls" : {
"key" : {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}
},
"insertable" : true,
"editable" : false,
"deletable" : false,
"formSearchHidden" : false
},
"changeTracking" : {
"createdTime" : "2000-06-21T04:56:07.000+00:00",
"createdBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"createdById" : "5000123",
"modificationTime" : "2000-06-21T04:56:07.000+00:00",
"modificationBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"modificationById" : "5000123"
},
"vehicles" : [ {
"id" : "5000123",
"power" : 5,
"licensePlate" : "licensePlate",
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"expenseType" : {
"id" : "5000123",
"code" : "MEAL",
"description" : "Plane",
"km" : false,
"notRefundable" : true,
"icon" : "fa fa-plane",
"color" : "00ff40",
"receiptRequired" : false,
"commentRequired" : false,
"guestsRequired" : false,
"notRefundableEditable" : true,
"billableEditable" : true,
"amountEditable" : true,
"showQuantity" : false,
"showAdditionalComment" : false,
"showReceiptNumber" : true,
"showAmountCategory" : true,
"showBillable" : true,
"hideVat" : false,
"vat1Code" : "1",
"vat2Code" : "2",
"vat3Code" : "3",
"expenseThreshold" : 100,
"defaultAmount" : 45,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"expenseCategory" : "{}",
"expenseRebillableOptions" : "{}",
"showCustomRequest" : true,
"showAmountWithoutVat" : true,
"controlsBehavior" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"calculateKilometers" : true,
"freeEntryProhibited" : true,
"controls" : {
"enableDuplicate" : true,
"enablelOnNonWorkingDay" : true,
"enableOnDayWithLeaveRequest" : true,
"enableOnDayWithTimesheetOrSchedule" : true
},
"expenseThresholdExceededNoVat" : false
},
"expenseTypeId" : "5000123",
"endDate" : "2020-01-31T23:59:59Z"
}, {
"id" : "5000123",
"power" : 5,
"licensePlate" : "licensePlate",
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"expenseType" : {
"id" : "5000123",
"code" : "MEAL",
"description" : "Plane",
"km" : false,
"notRefundable" : true,
"icon" : "fa fa-plane",
"color" : "00ff40",
"receiptRequired" : false,
"commentRequired" : false,
"guestsRequired" : false,
"notRefundableEditable" : true,
"billableEditable" : true,
"amountEditable" : true,
"showQuantity" : false,
"showAdditionalComment" : false,
"showReceiptNumber" : true,
"showAmountCategory" : true,
"showBillable" : true,
"hideVat" : false,
"vat1Code" : "1",
"vat2Code" : "2",
"vat3Code" : "3",
"expenseThreshold" : 100,
"defaultAmount" : 45,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"expenseCategory" : "{}",
"expenseRebillableOptions" : "{}",
"showCustomRequest" : true,
"showAmountWithoutVat" : true,
"controlsBehavior" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"calculateKilometers" : true,
"freeEntryProhibited" : true,
"controls" : {
"enableDuplicate" : true,
"enablelOnNonWorkingDay" : true,
"enableOnDayWithLeaveRequest" : true,
"enableOnDayWithTimesheetOrSchedule" : true
},
"expenseThresholdExceededNoVat" : false
},
"expenseTypeId" : "5000123",
"endDate" : "2020-01-31T23:59:59Z"
} ],
"currentCompany" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo",
"legalName" : "legalName",
"siren" : "siren",
"siret" : "siret",
"calendar" : {
"id" : "5000123",
"code" : "Text",
"name" : "Text",
"default" : true,
"daysNotWorked" : [ 6, 6 ],
"holidays" : [ {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
}, {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
} ]
},
"calendarId" : "calendarId",
"color" : "color",
"currency" : {
"id" : "5000123",
"name" : "Euro",
"code" : "EUR",
"order" : 17,
"euro" : true,
"euroRate" : 0.9678,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"euroRateStartDate" : "2020-01-23T04:56:07Z",
"euroRateEndDate" : "2020-01-23T04:56:07Z"
},
"currencyId" : "currencyId",
"address" : {
"id" : "id",
"line1" : "221B Baker Street",
"line2" : "2nd Floor",
"line3" : "First door at your right",
"cedex" : "CEDEX 14",
"postalCode" : "69002",
"city" : "London",
"country" : "FR (for 'FRANCE')",
"countryName" : "FRANCE",
"department" : "75 (for 'PARIS')",
"geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
"region" : "65 (for 'ILE DE FRANCE')",
"regionName" : "ILE DE FRANCE",
"phone" : "06 00 00 00 01",
"phone2" : "06 00 00 00 02",
"email" : "myemail@mail.com",
"mobilePhone" : "06 00 00 00 02",
"fax" : "04 00 00 00 07",
"webSite" : "mysite.com"
},
"addressId" : "addressId"
},
"currentCompanyId" : "5000123",
"bankingInformation" : {
"id" : "5000123",
"sepa" : {
"bankDetails" : {
"entity" : "30002",
"counter" : "550",
"accountNumber" : "0000157841Z",
"key" : "25",
"domiciliation" : "AURA"
},
"bic" : {
"country" : "FR (for 'FRANCE')",
"bank" : "DAAE",
"location" : "PP",
"branch" : "CCT"
},
"iban" : {
"country" : "FR (for 'FRANCE')",
"key" : "69",
"accountNumber" : "0000157841Z"
}
},
"noneSepa" : {
"defaultBankDetail" : false,
"beneficiary" : {
"holder" : {
"name" : "RITA",
"firstName" : "BRITA",
"accountType" : "{}",
"accountNumber" : "123456789"
},
"bank" : {
"bankName" : "UBA",
"bankName2" : "UBA",
"bankType" : "{}",
"bankCode" : "C8",
"bankAddress" : {
"id" : "id",
"line1" : "221B Baker Street",
"line2" : "2nd Floor",
"line3" : "First door at your right",
"cedex" : "CEDEX 14",
"postalCode" : "69002",
"city" : "London",
"country" : "FR (for 'FRANCE')",
"countryName" : "FRANCE",
"department" : "75 (for 'PARIS')",
"geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
"region" : "65 (for 'ILE DE FRANCE')",
"regionName" : "ILE DE FRANCE",
"phone" : "06 00 00 00 01",
"phone2" : "06 00 00 00 02",
"email" : "myemail@mail.com",
"mobilePhone" : "06 00 00 00 02",
"fax" : "04 00 00 00 07",
"webSite" : "mysite.com"
}
}
},
"intermediate" : {
"holder" : {
"name" : "RITA",
"firstName" : "BRITA",
"accountType" : "{}",
"accountNumber" : "123456789"
},
"bank" : {
"bankName" : "UBA",
"bankName2" : "UBA",
"bankType" : "{}",
"bankCode" : "C8",
"bankAddress" : {
"id" : "id",
"line1" : "221B Baker Street",
"line2" : "2nd Floor",
"line3" : "First door at your right",
"cedex" : "CEDEX 14",
"postalCode" : "69002",
"city" : "London",
"country" : "FR (for 'FRANCE')",
"countryName" : "FRANCE",
"department" : "75 (for 'PARIS')",
"geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
"region" : "65 (for 'ILE DE FRANCE')",
"regionName" : "ILE DE FRANCE",
"phone" : "06 00 00 00 01",
"phone2" : "06 00 00 00 02",
"email" : "myemail@mail.com",
"mobilePhone" : "06 00 00 00 02",
"fax" : "04 00 00 00 07",
"webSite" : "mysite.com"
}
}
}
},
"statusChangeDate" : "2000-06-21T04:56:07.000+00:00",
"statusChangeArgument" : {
"comment" : "Comment",
"status" : "{}"
},
"validator" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"validatorId" : "5000123",
"action" : "{}",
"type" : "{}"
},
"faxNumber" : "418 643 3210",
"phoneExtensionNumber" : "04 00 00 00 07"
}
2.5.5. Create an employee fluently
PUT |
/fluent/employees |
Description
Create an employee fluently using the list of parameters below.
DMF required:
-
DMF A40101: Api Workforce / Employees / Insert
-
DMF 160801: Tools / Resources / New
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
employeesFluent |
The employee to create EmployeeFluent |
X |
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Employee successfully created |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}",
"title" : "GEN",
"phone" : "+33 6 04 04 04 05",
"mobilePhone" : "+33 6 00 00 00 01",
"email" : "myemail@bechmail.com",
"noTimesDunning" : true,
"assignmentMultiCompany" : false,
"modeTimeRecording" : 1,
"modeInputSchedule" : 3,
"timeRecordingInputMode" : "{}",
"scheduleInputMode" : "{}",
"executive" : true,
"generic" : true,
"candidate" : false,
"external" : false,
"managerMultiCompany" : true,
"employeeFunctions" : {
"allFunctions" : false,
"allSales" : true,
"allPurchases" : false,
"allOperational" : true,
"projectSalesManager" : false,
"projectFinanceManager" : true,
"projectProductionManager" : false,
"projectAccountManager" : true,
"projectAssignment" : false,
"projectPhaseManager" : true,
"projectSendOnMission" : false,
"salesSalesAssistant" : true,
"salesOrderAndEstimateTracking" : false,
"salesBillingSchedulesTracking" : true,
"purchasingBuyer" : false,
"timeRecording" : true,
"inputOfExpenseReport" : false,
"purchasesReceptionTracking" : false,
"inputSchedule" : false,
"CMMSContractSalesManager" : false,
"CMMSContractTechnicalManager" : false,
"CMMSMRAndEOManager" : false
},
"employeeHistory" : [ {
"id" : "5000123",
"employeeHistoryType" : "5000123",
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 7.42,
"weekHours" : 38.3,
"occupancyRate" : 0.8,
"manager" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"managerId" : "5000123",
"company" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo"
},
"companyId" : "5000123",
"directHourlyRate" : 10.42,
"standardHourlyRate" : 10,
"dailyCost" : 59.36,
"dailySellingPrice" : 80,
"entity" : "5000123",
"serviceRef" : {
"id" : "5000123",
"name" : "Professional services",
"code" : "PS"
},
"service" : "5000123",
"position" : "Developer",
"skillRef" : {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
},
"skill" : "5000123",
"family1" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family1Id" : "5000123",
"family2" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family2Id" : "5000123",
"family3" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family3Id" : "5000123",
"leave" : false,
"standardWeek" : {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
}
},
"standardWeekId" : "5000123",
"salary" : 1024
}, {
"id" : "5000123",
"employeeHistoryType" : "5000123",
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 7.42,
"weekHours" : 38.3,
"occupancyRate" : 0.8,
"manager" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"managerId" : "5000123",
"company" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo"
},
"companyId" : "5000123",
"directHourlyRate" : 10.42,
"standardHourlyRate" : 10,
"dailyCost" : 59.36,
"dailySellingPrice" : 80,
"entity" : "5000123",
"serviceRef" : {
"id" : "5000123",
"name" : "Professional services",
"code" : "PS"
},
"service" : "5000123",
"position" : "Developer",
"skillRef" : {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
},
"skill" : "5000123",
"family1" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family1Id" : "5000123",
"family2" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family2Id" : "5000123",
"family3" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family3Id" : "5000123",
"leave" : false,
"standardWeek" : {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
}
},
"standardWeekId" : "5000123",
"salary" : 1024
} ],
"companyChanges" : [ {
"id" : "5000123",
"employeeId" : "500123",
"companyId" : "5000123",
"startDate" : "2020-01-23T04:56:07Z",
"endDate" : "2020-01-23T04:56:07Z",
"companyChangeState" : "{}",
"comment" : "Limpso usum"
}, {
"id" : "5000123",
"employeeId" : "500123",
"companyId" : "5000123",
"startDate" : "2020-01-23T04:56:07Z",
"endDate" : "2020-01-23T04:56:07Z",
"companyChangeState" : "{}",
"comment" : "Limpso usum"
} ],
"timeRecordingRules" : {
"id" : "5000123",
"employeeId" : "5000123",
"min" : 0,
"max" : 24,
"step" : 0.01,
"prettyStep" : 0.3,
"base" : 60,
"unit" : "H",
"unitDuration" : "{}",
"allowManualEntry" : true,
"employeeWeeks" : [ {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
},
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 8,
"dailyMinutes" : 10,
"weekHours" : 40,
"leave" : false
}, {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
},
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 8,
"dailyMinutes" : 10,
"weekHours" : 40,
"leave" : false
} ],
"closingDates" : [ {
"closingDate" : "2020-01-31T23:59:59Z",
"module" : "DATE_MODULE",
"beginningOfPeriod" : "2020-01-31T23:59:59Z",
"endOfPeriod" : "2020-01-31T23:59:59Z"
}, {
"closingDate" : "2020-01-31T23:59:59Z",
"module" : "DATE_MODULE",
"beginningOfPeriod" : "2020-01-31T23:59:59Z",
"endOfPeriod" : "2020-01-31T23:59:59Z"
} ],
"simpleDuration" : 750,
"completionMode" : "WEEKLY"
},
"scheduleRules" : {
"id" : "5000123",
"employeeId" : "5000123",
"min" : 0,
"max" : 24,
"step" : 0.01,
"prettyStep" : 0.3,
"base" : 60,
"unit" : "H",
"unitDuration" : "{}",
"allowManualEntry" : true,
"employeeWeeks" : [ {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
},
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 8,
"dailyMinutes" : 10,
"weekHours" : 40,
"leave" : false
}, {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
},
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 8,
"dailyMinutes" : 10,
"weekHours" : 40,
"leave" : false
} ],
"closingDates" : [ {
"closingDate" : "2020-01-31T23:59:59Z",
"module" : "DATE_MODULE",
"beginningOfPeriod" : "2020-01-31T23:59:59Z",
"endOfPeriod" : "2020-01-31T23:59:59Z"
}, {
"closingDate" : "2020-01-31T23:59:59Z",
"module" : "DATE_MODULE",
"beginningOfPeriod" : "2020-01-31T23:59:59Z",
"endOfPeriod" : "2020-01-31T23:59:59Z"
} ],
"timestamped" : true
},
"businessCards" : [ {
"id" : "5000123",
"employeeId" : "5000123",
"cardNumber" : "XXXX XXXX XXXX 7568",
"encryptedCardNumber" : "0",
"name" : "Management card",
"type" : "{}",
"endDate" : "2020-01-31T23:59:59Z"
}, {
"id" : "5000123",
"employeeId" : "5000123",
"cardNumber" : "XXXX XXXX XXXX 7568",
"encryptedCardNumber" : "0",
"name" : "Management card",
"type" : "{}",
"endDate" : "2020-01-31T23:59:59Z"
} ],
"sector" : "Marketing",
"number" : "84",
"relations" : [ {
"id" : "5000123",
"relationType" : {
"id" : "5000123",
"code" : "TUTOR",
"name" : "Tutor for internship"
},
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"relatedEmployee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"relatedEmployeeId" : "5000123"
}, {
"id" : "5000123",
"relationType" : {
"id" : "5000123",
"code" : "TUTOR",
"name" : "Tutor for internship"
},
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"relatedEmployee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"relatedEmployeeId" : "5000123"
} ],
"employeeAbilities" : [ {
"id" : "5000123",
"skill" : {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
},
"level" : {
"id" : "5000123",
"code" : "EXP",
"name" : "Expert"
},
"startDate" : "2020-01-31T23:59:59Z",
"endDate" : "2020-01-31T23:59:59Z",
"employeeId" : "5000123"
}, {
"id" : "5000123",
"skill" : {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
},
"level" : {
"id" : "5000123",
"code" : "EXP",
"name" : "Expert"
},
"startDate" : "2020-01-31T23:59:59Z",
"endDate" : "2020-01-31T23:59:59Z",
"employeeId" : "5000123"
} ],
"jobType" : {
"id" : "5000123",
"companyCode" : "AKSAS",
"code" : "ADMIN",
"name" : "Administrator",
"category" : "{}",
"validity" : {
"type" : "{}",
"date" : "2000-06-21T04:56:07.000+00:00"
},
"default" : true
},
"jobTypeId" : "100245",
"address" : {
"id" : "id",
"line1" : "221B Baker Street",
"line2" : "2nd Floor",
"line3" : "First door at your right",
"cedex" : "CEDEX 14",
"postalCode" : "69002",
"city" : "London",
"country" : "FR (for 'FRANCE')",
"countryName" : "FRANCE",
"department" : "75 (for 'PARIS')",
"geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
"region" : "65 (for 'ILE DE FRANCE')",
"regionName" : "ILE DE FRANCE",
"phone" : "06 00 00 00 01",
"phone2" : "06 00 00 00 02",
"email" : "myemail@mail.com",
"mobilePhone" : "06 00 00 00 02",
"fax" : "04 00 00 00 07",
"webSite" : "mysite.com"
},
"addressId" : "5000123",
"birthDate" : "2000-06-21T04:56:07.000+00:00",
"customData" : {
"key" : {
"type" : "{}",
"value" : "Autoref 010520",
"name" : "Reference 4",
"realOrder" : 0,
"label" : "REFERENCE_4"
}
},
"color" : "#FF0000",
"targetTace" : 75,
"formConfig" : {
"type" : "{}",
"fields" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"controls" : {
"key" : {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}
},
"insertable" : true,
"editable" : false,
"deletable" : false,
"formSearchHidden" : false
},
"changeTracking" : {
"createdTime" : "2000-06-21T04:56:07.000+00:00",
"createdBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"createdById" : "5000123",
"modificationTime" : "2000-06-21T04:56:07.000+00:00",
"modificationBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"modificationById" : "5000123"
},
"vehicles" : [ {
"id" : "5000123",
"power" : 5,
"licensePlate" : "licensePlate",
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"expenseType" : {
"id" : "5000123",
"code" : "MEAL",
"description" : "Plane",
"km" : false,
"notRefundable" : true,
"icon" : "fa fa-plane",
"color" : "00ff40",
"receiptRequired" : false,
"commentRequired" : false,
"guestsRequired" : false,
"notRefundableEditable" : true,
"billableEditable" : true,
"amountEditable" : true,
"showQuantity" : false,
"showAdditionalComment" : false,
"showReceiptNumber" : true,
"showAmountCategory" : true,
"showBillable" : true,
"hideVat" : false,
"vat1Code" : "1",
"vat2Code" : "2",
"vat3Code" : "3",
"expenseThreshold" : 100,
"defaultAmount" : 45,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"expenseCategory" : "{}",
"expenseRebillableOptions" : "{}",
"showCustomRequest" : true,
"showAmountWithoutVat" : true,
"controlsBehavior" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"calculateKilometers" : true,
"freeEntryProhibited" : true,
"controls" : {
"enableDuplicate" : true,
"enablelOnNonWorkingDay" : true,
"enableOnDayWithLeaveRequest" : true,
"enableOnDayWithTimesheetOrSchedule" : true
},
"expenseThresholdExceededNoVat" : false
},
"expenseTypeId" : "5000123",
"endDate" : "2020-01-31T23:59:59Z"
}, {
"id" : "5000123",
"power" : 5,
"licensePlate" : "licensePlate",
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"expenseType" : {
"id" : "5000123",
"code" : "MEAL",
"description" : "Plane",
"km" : false,
"notRefundable" : true,
"icon" : "fa fa-plane",
"color" : "00ff40",
"receiptRequired" : false,
"commentRequired" : false,
"guestsRequired" : false,
"notRefundableEditable" : true,
"billableEditable" : true,
"amountEditable" : true,
"showQuantity" : false,
"showAdditionalComment" : false,
"showReceiptNumber" : true,
"showAmountCategory" : true,
"showBillable" : true,
"hideVat" : false,
"vat1Code" : "1",
"vat2Code" : "2",
"vat3Code" : "3",
"expenseThreshold" : 100,
"defaultAmount" : 45,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"expenseCategory" : "{}",
"expenseRebillableOptions" : "{}",
"showCustomRequest" : true,
"showAmountWithoutVat" : true,
"controlsBehavior" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"calculateKilometers" : true,
"freeEntryProhibited" : true,
"controls" : {
"enableDuplicate" : true,
"enablelOnNonWorkingDay" : true,
"enableOnDayWithLeaveRequest" : true,
"enableOnDayWithTimesheetOrSchedule" : true
},
"expenseThresholdExceededNoVat" : false
},
"expenseTypeId" : "5000123",
"endDate" : "2020-01-31T23:59:59Z"
} ],
"currentCompany" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo",
"legalName" : "legalName",
"siren" : "siren",
"siret" : "siret",
"calendar" : {
"id" : "5000123",
"code" : "Text",
"name" : "Text",
"default" : true,
"daysNotWorked" : [ 6, 6 ],
"holidays" : [ {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
}, {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
} ]
},
"calendarId" : "calendarId",
"color" : "color",
"currency" : {
"id" : "5000123",
"name" : "Euro",
"code" : "EUR",
"order" : 17,
"euro" : true,
"euroRate" : 0.9678,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"euroRateStartDate" : "2020-01-23T04:56:07Z",
"euroRateEndDate" : "2020-01-23T04:56:07Z"
},
"currencyId" : "currencyId",
"address" : {
"id" : "id",
"line1" : "221B Baker Street",
"line2" : "2nd Floor",
"line3" : "First door at your right",
"cedex" : "CEDEX 14",
"postalCode" : "69002",
"city" : "London",
"country" : "FR (for 'FRANCE')",
"countryName" : "FRANCE",
"department" : "75 (for 'PARIS')",
"geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
"region" : "65 (for 'ILE DE FRANCE')",
"regionName" : "ILE DE FRANCE",
"phone" : "06 00 00 00 01",
"phone2" : "06 00 00 00 02",
"email" : "myemail@mail.com",
"mobilePhone" : "06 00 00 00 02",
"fax" : "04 00 00 00 07",
"webSite" : "mysite.com"
},
"addressId" : "addressId"
},
"currentCompanyId" : "5000123",
"bankingInformation" : {
"id" : "5000123",
"sepa" : {
"bankDetails" : {
"entity" : "30002",
"counter" : "550",
"accountNumber" : "0000157841Z",
"key" : "25",
"domiciliation" : "AURA"
},
"bic" : {
"country" : "FR (for 'FRANCE')",
"bank" : "DAAE",
"location" : "PP",
"branch" : "CCT"
},
"iban" : {
"country" : "FR (for 'FRANCE')",
"key" : "69",
"accountNumber" : "0000157841Z"
}
},
"noneSepa" : {
"defaultBankDetail" : false,
"beneficiary" : {
"holder" : {
"name" : "RITA",
"firstName" : "BRITA",
"accountType" : "{}",
"accountNumber" : "123456789"
},
"bank" : {
"bankName" : "UBA",
"bankName2" : "UBA",
"bankType" : "{}",
"bankCode" : "C8",
"bankAddress" : {
"id" : "id",
"line1" : "221B Baker Street",
"line2" : "2nd Floor",
"line3" : "First door at your right",
"cedex" : "CEDEX 14",
"postalCode" : "69002",
"city" : "London",
"country" : "FR (for 'FRANCE')",
"countryName" : "FRANCE",
"department" : "75 (for 'PARIS')",
"geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
"region" : "65 (for 'ILE DE FRANCE')",
"regionName" : "ILE DE FRANCE",
"phone" : "06 00 00 00 01",
"phone2" : "06 00 00 00 02",
"email" : "myemail@mail.com",
"mobilePhone" : "06 00 00 00 02",
"fax" : "04 00 00 00 07",
"webSite" : "mysite.com"
}
}
},
"intermediate" : {
"holder" : {
"name" : "RITA",
"firstName" : "BRITA",
"accountType" : "{}",
"accountNumber" : "123456789"
},
"bank" : {
"bankName" : "UBA",
"bankName2" : "UBA",
"bankType" : "{}",
"bankCode" : "C8",
"bankAddress" : {
"id" : "id",
"line1" : "221B Baker Street",
"line2" : "2nd Floor",
"line3" : "First door at your right",
"cedex" : "CEDEX 14",
"postalCode" : "69002",
"city" : "London",
"country" : "FR (for 'FRANCE')",
"countryName" : "FRANCE",
"department" : "75 (for 'PARIS')",
"geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
"region" : "65 (for 'ILE DE FRANCE')",
"regionName" : "ILE DE FRANCE",
"phone" : "06 00 00 00 01",
"phone2" : "06 00 00 00 02",
"email" : "myemail@mail.com",
"mobilePhone" : "06 00 00 00 02",
"fax" : "04 00 00 00 07",
"webSite" : "mysite.com"
}
}
}
},
"statusChangeDate" : "2000-06-21T04:56:07.000+00:00",
"statusChangeArgument" : {
"comment" : "Comment",
"status" : "{}"
},
"validator" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"validatorId" : "5000123",
"action" : "{}",
"type" : "{}"
},
"faxNumber" : "418 643 3210",
"phoneExtensionNumber" : "04 00 00 00 07",
"historiqueCollaborateur" : [ {
"id" : "5000123",
"employeeHistoryType" : "5000123",
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 7.42,
"weekHours" : 38.3,
"occupancyRate" : 0.8,
"manager" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"managerId" : "5000123",
"company" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo"
},
"companyId" : "5000123",
"directHourlyRate" : 10.42,
"standardHourlyRate" : 10,
"dailyCost" : 59.36,
"dailySellingPrice" : 80,
"entity" : "5000123",
"serviceRef" : {
"id" : "5000123",
"name" : "Professional services",
"code" : "PS"
},
"service" : "5000123",
"position" : "Developer",
"skillRef" : {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
},
"skill" : "5000123",
"family1" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family1Id" : "5000123",
"family2" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family2Id" : "5000123",
"family3" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family3Id" : "5000123",
"leave" : false,
"standardWeek" : {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
}
},
"standardWeekId" : "5000123",
"salary" : 1024,
"entityCode" : "AKSAS",
"serviceCode" : "PS",
"skillCode" : "ENG",
"employeeFamily1Code" : "CDI",
"employeeFamily2Code" : "DAY",
"employeeFamily3Code" : "PS-S",
"managerCode" : "CASH"
}, {
"id" : "5000123",
"employeeHistoryType" : "5000123",
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 7.42,
"weekHours" : 38.3,
"occupancyRate" : 0.8,
"manager" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"managerId" : "5000123",
"company" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo"
},
"companyId" : "5000123",
"directHourlyRate" : 10.42,
"standardHourlyRate" : 10,
"dailyCost" : 59.36,
"dailySellingPrice" : 80,
"entity" : "5000123",
"serviceRef" : {
"id" : "5000123",
"name" : "Professional services",
"code" : "PS"
},
"service" : "5000123",
"position" : "Developer",
"skillRef" : {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
},
"skill" : "5000123",
"family1" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family1Id" : "5000123",
"family2" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family2Id" : "5000123",
"family3" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family3Id" : "5000123",
"leave" : false,
"standardWeek" : {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
}
},
"standardWeekId" : "5000123",
"salary" : 1024,
"entityCode" : "AKSAS",
"serviceCode" : "PS",
"skillCode" : "ENG",
"employeeFamily1Code" : "CDI",
"employeeFamily2Code" : "DAY",
"employeeFamily3Code" : "PS-S",
"managerCode" : "CASH"
} ]
}
2.5.6. Add a new employee situation history
PUT |
/employees/{employee_id}/histories |
Description
Add a new employee situation history matching the specified employee’s ID.
The previous situation will be closed, or its end date recalculated using the n-1 date from the new situation.
DMF required:
-
DMF A40102: Api Workforce / Employees / Update
-
DMF 160802: Tools / Resources / Modify
-
DMF 160866: Tools / Resources / Modify Status History
-
DMF 160851: Tools / Resources / Modify Linked Employees
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
employee_id |
Id of an employee |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
EmployeeHistory |
The employee history to create EmployeeHistory |
X |
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
A new employee situation history successfully added |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"id" : "5000123",
"employeeHistoryType" : "5000123",
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 7.42,
"weekHours" : 38.3,
"occupancyRate" : 0.8,
"manager" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"managerId" : "5000123",
"company" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo"
},
"companyId" : "5000123",
"directHourlyRate" : 10.42,
"standardHourlyRate" : 10,
"dailyCost" : 59.36,
"dailySellingPrice" : 80,
"entity" : "5000123",
"serviceRef" : {
"id" : "5000123",
"name" : "Professional services",
"code" : "PS"
},
"service" : "5000123",
"position" : "Developer",
"skillRef" : {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
},
"skill" : "5000123",
"family1" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family1Id" : "5000123",
"family2" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family2Id" : "5000123",
"family3" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family3Id" : "5000123",
"leave" : false,
"standardWeek" : {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
}
},
"standardWeekId" : "5000123",
"salary" : 1024
}
2.5.7. Delete an employee history and open the previous history
POST |
/employees/{employee_id}/history/{employee_history_id}/cancel |
Description
Delete an employee history matching the specified employee’s ID and the specified employee history’s ID and open the previous history
DMF required:
-
DMF A40153: Api Workforce / Employees / Delete Employee History
-
DMF 160802: Tools / Resources / Modify
-
DMF 160859: Tools / Resources / Modify Status History Dates
-
DMF 160860: Tools / Resources / Status History
-
DMF 160866: Tools / Resources / Modify Status History
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
employee_id |
Id of an employee |
X |
null |
|
employee_history_id |
Id of an employee history |
X |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
The employee history has been successfully deleted and the previous history has been successfully opened |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.5.8. Delete an employee
DELETE |
/employees/{employee_id} |
Description
Delete an employee using the parameters below
Warning: Deletion only possible if there are no objects or times linked to this employee
DMF required:
-
DMF A40103: Api Workforce / Employees / Delete
-
DMF 160803: Tools / Resources / Delete
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
employee_id |
Id of an employee |
X |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
The employee been successfully deleted |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.5.9. Delete the avatar of an employee
DELETE |
/employees/{employee_id}/avatar |
Description
Delete the avatar of the specified employee.
DMF required:
-
DMF A40143: Api Workforce / Employees / Employee Avatar
-
DMF 160828: Tools / Resources / Modify Photo
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
employee_id |
Id of an employee |
X |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
The avatar has successfully been deleted |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.5.10. Delete an employee history By Id
DELETE |
/employees/{employee_id}/history/{employee_history_id} |
Description
Delete an employee history matching the specified employee’s ID and the specified employee history’s ID
DMF required:
-
DMF A40153: Api Workforce / Employees / Delete Employee History
-
DMF 160802: Tools / Resources / Modify
-
DMF 160859: Tools / Resources / Modify Status History Dates
-
DMF 160860: Tools / Resources / Status History
-
DMF 160866: Tools / Resources / Modify Status History
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
employee_id |
Id of an employee |
X |
null |
|
employee_history_id |
Id of an employee history |
X |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
The employee history has been successfully deleted |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.5.11. Delete the vehicle assigned to an employee.
POST |
/employees/{employee_id}/delete-vehicle |
Description
Delete the vehicle assigned to an employee.
It is not possible to delete a vehicle that has already been used for mileage expense entries.
DMF required:
-
DMF A40151: Api Workforce / Employees / Delete Vehicle
-
DMF 160853: Tools / Resources / Modify Taxable Powers
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
employee_id |
Id of an employee |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
vehicle |
The vehicle to delete Vehicle |
X |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
The vehicle has been successfully deleted to the employee |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"id" : "5000123",
"power" : 5,
"licensePlate" : "licensePlate",
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"expenseType" : {
"id" : "5000123",
"code" : "MEAL",
"description" : "Plane",
"km" : false,
"notRefundable" : true,
"icon" : "fa fa-plane",
"color" : "00ff40",
"receiptRequired" : false,
"commentRequired" : false,
"guestsRequired" : false,
"notRefundableEditable" : true,
"billableEditable" : true,
"amountEditable" : true,
"showQuantity" : false,
"showAdditionalComment" : false,
"showReceiptNumber" : true,
"showAmountCategory" : true,
"showBillable" : true,
"hideVat" : false,
"vat1Code" : "1",
"vat2Code" : "2",
"vat3Code" : "3",
"expenseThreshold" : 100,
"defaultAmount" : 45,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"expenseCategory" : "{}",
"expenseRebillableOptions" : "{}",
"showCustomRequest" : true,
"showAmountWithoutVat" : true,
"controlsBehavior" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"calculateKilometers" : true,
"freeEntryProhibited" : true,
"controls" : {
"enableDuplicate" : true,
"enablelOnNonWorkingDay" : true,
"enableOnDayWithLeaveRequest" : true,
"enableOnDayWithTimesheetOrSchedule" : true
},
"expenseThresholdExceededNoVat" : false
},
"expenseTypeId" : "5000123",
"endDate" : "2020-01-31T23:59:59Z"
}
2.5.12. Search all employees
GET |
/employees |
Description
Get the list of all employees
DMF required:
-
DMF A40106: Api Workforce / Employees / Info
-
DMF 020104: Sales / Customer / Search
-
DMF 141302: Helpdesk / Issues / Modify
-
DMF 142602: Helpdesk / Simplified Issue / Modify
-
DMF 160804: Tools / Resources / Search
-
DMF 160805: Tools / Resources / Detailed Search
-
DMF 1903__: Web Portal / Timesheets
-
DMF 1904__: Web Portal / Schedules
-
DMF 1905__: Web Portal / Expense Reports
-
DMF 1909__: Web Portal / Approvals
-
DMF 250119: Project / Schedule View / Employee Details
-
DMF 010204: Prospecting / Opportunities / Search
Return Type
array[Employee]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Employees successfully loaded |
List[Employee] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.5.13. Search job type
GET |
/job-types |
Description
Get the list of job types.
DMF required:
-
DMF A40117: Api Workforce / Employees / Search Job Types
-
DMF 160837: Tools / Resources / Modify Types
Return Type
array[JobType]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Job types successfully loaded |
List[JobType] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.5.14. Search standard weeks
GET |
/standard-weeks |
Description
Get the list of standard weeks.
DMF required:
-
DMF A40111: Api Workforce / Employees / Search Model Week
-
DMF 160846: Tools / Resources / Show Standard Week
-
DMF 1903__: Web Portal / Timesheets
-
DMF 1904__: Web Portal / Schedules
Return Type
array[StandardWeek]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Standard weeks successfully loaded |
List[StandardWeek] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.5.15. Get Actions authorized to an employee
GET |
/employees/{employee_id}/authorized-actions |
Description
List the actions authorized to an employee.
DMF required:
-
DMF A40119: Api Workforce / Employees / Get Authorized Actions
-
DMF 160805: Tools / Resources / Detailed Search
-
DMF 250119: Project / Schedule View / Employee Details
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
employee_id |
Id of an employee |
X |
null |
Return Type
array[ActionCodeBase]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
List of actions authorized to the employee identified by 'employee_id' |
List[ActionCodeBase] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.5.16. Search the avatar of an employee
GET |
/employees/{employee_id}/avatar.png |
Description
Get the avatar of the employee matching the specified employee ID.
DMF required:
-
USERAK: A registered user.
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
employee_id |
Id of an employee |
X |
null |
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
s |
Size in pixels of the image |
- |
null |
Content Type
-
image/*
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Avatar of the employee successfully loaded |
|
204 |
No image for this employee |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.5.17. Search an employee by its ID
GET |
/employees/{employee_id} |
Description
Get the employee matching the specified id.
DMF required:
-
DMF A40106: Api Workforce / Employees / Info
-
DMF 020104: Sales / Customer / Search
-
DMF 141302: Helpdesk / Issues / Modify
-
DMF 142602: Helpdesk / Simplified Issue / Modify
-
DMF 160804: Tools / Resources / Search
-
DMF 160805: Tools / Resources / Detailed Search
-
DMF 1903__: Web Portal / Timesheets
-
DMF 1904__: Web Portal / Schedules
-
DMF 1905__: Web Portal / Expense Reports
-
DMF 1909__: Web Portal / Approvals
-
DMF 250119: Project / Schedule View / Employee Details
-
DMF 010204: Prospecting / Opportunities / Search
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
employee_id |
Id of an employee |
X |
null |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Employee successfully loaded |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.5.18. Get an employee history by its ID
GET |
/employees/{employee_id}/histories/{employee_history_id} |
Description
Get an employee history matching the specified employee’s ID and the specified employee history’s ID.
DMF required:
-
DMF A40156: Api Workforce / Employees / Get Employee History
-
DMF 160826: Tools / Resources / Show Values
-
DMF 160857: Tools / Resources / Show Status History Tracking
-
DMF 160860: Tools / Resources / Status History
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
employee_id |
Id of an employee |
X |
null |
|
employee_history_id |
Id of an employee history |
X |
null |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Employee history successfully loaded |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.5.19. Search an employee's identification details.
POST |
/employees/{employee_id}/get-identification |
Description
Search an employee’s name, firstName and code.
DMF required:
-
DMF A40106: Api Workforce / Employees / Info
-
DMF 020104: Sales / Customer / Search
-
DMF 141302: Helpdesk / Issues / Modify
-
DMF 142602: Helpdesk / Simplified Issue / Modify
-
DMF 160804: Tools / Resources / Search
-
DMF 160805: Tools / Resources / Detailed Search
-
DMF 1903__: Web Portal / Timesheets
-
DMF 1904__: Web Portal / Schedules
-
DMF 1905__: Web Portal / Expense Reports
-
DMF 1909__: Web Portal / Approvals
-
DMF 250119: Project / Schedule View / Employee Details
-
DMF 010204: Prospecting / Opportunities / Search
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
employee_id |
Id of an employee |
X |
null |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Employee's identification successfully loaded |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.5.20. Search employee weeks of an employee
GET |
/employees/{employee_id}/employee-weeks |
Description
Get the list of employee weeks of an employee matching the specified employee ID.
DMF required:
-
DMF A40111: Api Workforce / Employees / Search Model Week
-
DMF 160846: Tools / Resources / Show Standard Week
-
DMF 1903__: Web Portal / Timesheets
-
DMF 1904__: Web Portal / Schedules
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
employee_id |
Id of an employee |
X |
null |
Return Type
array[EmployeeWeek]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Employee weeks successfully loaded |
List[EmployeeWeek] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.5.21. Search holidays with a time slot
GET |
/holidays |
Description
Retrieve holidays in an interval.
DMF required:
-
DMF A40106: Api Workforce / Employees / Info
-
DMF 020104: Sales / Customer / Search
-
DMF 141302: Helpdesk / Issues / Modify
-
DMF 142602: Helpdesk / Simplified Issue / Modify
-
DMF 160804: Tools / Resources / Search
-
DMF 160805: Tools / Resources / Detailed Search
-
DMF 1903__: Web Portal / Timesheets
-
DMF 1904__: Web Portal / Schedules
-
DMF 1905__: Web Portal / Expense Reports
-
DMF 1909__: Web Portal / Approvals
-
DMF 250119: Project / Schedule View / Employee Details
-
DMF 010204: Prospecting / Opportunities / Search
Parameters
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
from |
Start date of the search interval |
- |
null |
|
to |
End date of the search interval |
- |
null |
Return Type
array[Holiday]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Holidays successfully loaded |
List[Holiday] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.5.22. Search a job type by its ID
GET |
/job-types/{job_type_id} |
Description
Get the job type matching the specified ID.
DMF required:
-
DMF A40117: Api Workforce / Employees / Search Job Types
-
DMF 160837: Tools / Resources / Modify Types
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
job_type_id |
The identifier of a job type |
X |
null |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Job type successfully loaded |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.5.23. Get the list of my pending tasks (my actions to be taken).
POST |
/pending-tasks/search/mine |
Description
Get the list of my pending tasks (my actions to be taken).
DMF required:
-
DMF A40154: Api Workforce / Employees / Tbi
-
DMF 1922__: Web Portal / Idb
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
PendingTaskCriteria |
Criteria that you choose (Employee ID, Expense type ID, etc…) PendingTaskCriteria |
X |
Return Type
array[PendingTask]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Pending tasks successfully loaded |
List[PendingTask] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"employeeId" : "5000123",
"projectId" : "PRJ_1",
"objectType" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"readOption" : {
"options" : [ "PROJECT", "PROJECT" ]
}
}
2.5.24. Search a standard week by its ID
GET |
/standard-weeks/{standard_week_id} |
Description
Get the standard week matching the specified ID.
DMF required:
-
DMF A40111: Api Workforce / Employees / Search Model Week
-
DMF 160846: Tools / Resources / Show Standard Week
-
DMF 1903__: Web Portal / Timesheets
-
DMF 1904__: Web Portal / Schedules
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
standard_week_id |
Id of the standard week |
X |
null |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Standard week successfully loaded |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.5.25. Patch an employee
PATCH |
/employees/{employee_id} |
Description
Patch the employee matching the specified ID and using the list of parameters below.
DMF required:
-
DMF A40106: Api Workforce / Employees / Info
-
DMF 020104: Sales / Customer / Search
-
DMF 141302: Helpdesk / Issues / Modify
-
DMF 142602: Helpdesk / Simplified Issue / Modify
-
DMF 160804: Tools / Resources / Search
-
DMF 160805: Tools / Resources / Detailed Search
-
DMF 1903__: Web Portal / Timesheets
-
DMF 1904__: Web Portal / Schedules
-
DMF 1905__: Web Portal / Expense Reports
-
DMF 1909__: Web Portal / Approvals
-
DMF 250119: Project / Schedule View / Employee Details
-
DMF 010204: Prospecting / Opportunities / Search
Or
-
DMF A40102: Api Workforce / Employees / Update
-
DMF 160802: Tools / Resources / Modify
-
DMF 160866: Tools / Resources / Modify Status History
-
DMF 160851: Tools / Resources / Modify Linked Employees
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
employee_id |
Id of an employee |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
patch_elements |
List of patches to apply PatchElement |
- |
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Employee successfully patched |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"op" : "ADD",
"path" : "path",
"from" : "from",
"value" : "{}"
}
2.5.26. Search an employee with read options
POST |
/employees/{employee_id}/read |
Description
Get an employee, with additional information of your choice (example: manager information).
You can add this information with Read Options. These are listed in the link below.
DMF required:
-
DMF A40106: Api Workforce / Employees / Info
-
DMF 020104: Sales / Customer / Search
-
DMF 141302: Helpdesk / Issues / Modify
-
DMF 142602: Helpdesk / Simplified Issue / Modify
-
DMF 160804: Tools / Resources / Search
-
DMF 160805: Tools / Resources / Detailed Search
-
DMF 1903__: Web Portal / Timesheets
-
DMF 1904__: Web Portal / Schedules
-
DMF 1905__: Web Portal / Expense Reports
-
DMF 1909__: Web Portal / Approvals
-
DMF 250119: Project / Schedule View / Employee Details
-
DMF 010204: Prospecting / Opportunities / Search
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
employee_id |
Id of an employee |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
read_options |
The read options for returned employee EmployeeReadOption |
- |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Employee successfully loaded |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"options" : [ "EMPLOYEE_HISTORY", "EMPLOYEE_HISTORY" ]
}
2.5.27. Read the employees history
POST |
/employees/{employee_id}/history/read |
Description
Read the employees history identified by 'employee_id'
DMF required:
-
DMF A40120: Api Workforce / Employees / Read_history
-
DMF 160805: Tools / Resources / Detailed Search
-
DMF 250119: Project / Schedule View / Employee Details
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
employee_id |
Id of an employee |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
read_option |
Read options for employeeState EmployeeHistoryReadOption |
- |
Return Type
array[EmployeeHistory]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
The history of employee identified by 'employee_id' |
List[EmployeeHistory] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"options" : [ "COMPANY", "COMPANY" ]
}
2.5.28. Replace an employee's banking information.
POST |
/employees/{employee_id}/banking-informations/replace |
Description
Replace an employee’s banking information.
Please note that for an employee, only one bankingInformation object can be included in the body, and only the 'sepa' data can be updated.
Changes to non Sepa' are not allowed.
If you add a new Sepa bankingInformation and one already exists, the previous one will be overwritten and a new one will be created.
DMF required:
-
DMF A40157: Api Workforce / Employees / Replace An Employee’s Banking Information
-
DMF 160883: Tools / Resources / Replace Bank Details
-
DMF 160822: Tools / Resources / Modify Bank Details
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
employee_id |
Id of an employee |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
bankingInformationList |
The list of banking information to replace. BankingInformation |
X |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Banking information have been successfully updated |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"id" : "5000123",
"sepa" : {
"bankDetails" : {
"entity" : "30002",
"counter" : "550",
"accountNumber" : "0000157841Z",
"key" : "25",
"domiciliation" : "AURA"
},
"bic" : {
"country" : "FR (for 'FRANCE')",
"bank" : "DAAE",
"location" : "PP",
"branch" : "CCT"
},
"iban" : {
"country" : "FR (for 'FRANCE')",
"key" : "69",
"accountNumber" : "0000157841Z"
}
},
"noneSepa" : {
"defaultBankDetail" : false,
"beneficiary" : {
"holder" : {
"name" : "RITA",
"firstName" : "BRITA",
"accountType" : "{}",
"accountNumber" : "123456789"
},
"bank" : {
"bankName" : "UBA",
"bankName2" : "UBA",
"bankType" : "{}",
"bankCode" : "C8",
"bankAddress" : {
"id" : "id",
"line1" : "221B Baker Street",
"line2" : "2nd Floor",
"line3" : "First door at your right",
"cedex" : "CEDEX 14",
"postalCode" : "69002",
"city" : "London",
"country" : "FR (for 'FRANCE')",
"countryName" : "FRANCE",
"department" : "75 (for 'PARIS')",
"geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
"region" : "65 (for 'ILE DE FRANCE')",
"regionName" : "ILE DE FRANCE",
"phone" : "06 00 00 00 01",
"phone2" : "06 00 00 00 02",
"email" : "myemail@mail.com",
"mobilePhone" : "06 00 00 00 02",
"fax" : "04 00 00 00 07",
"webSite" : "mysite.com"
}
}
},
"intermediate" : {
"holder" : {
"name" : "RITA",
"firstName" : "BRITA",
"accountType" : "{}",
"accountNumber" : "123456789"
},
"bank" : {
"bankName" : "UBA",
"bankName2" : "UBA",
"bankType" : "{}",
"bankCode" : "C8",
"bankAddress" : {
"id" : "id",
"line1" : "221B Baker Street",
"line2" : "2nd Floor",
"line3" : "First door at your right",
"cedex" : "CEDEX 14",
"postalCode" : "69002",
"city" : "London",
"country" : "FR (for 'FRANCE')",
"countryName" : "FRANCE",
"department" : "75 (for 'PARIS')",
"geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
"region" : "65 (for 'ILE DE FRANCE')",
"regionName" : "ILE DE FRANCE",
"phone" : "06 00 00 00 01",
"phone2" : "06 00 00 00 02",
"email" : "myemail@mail.com",
"mobilePhone" : "06 00 00 00 02",
"fax" : "04 00 00 00 07",
"webSite" : "mysite.com"
}
}
}
},
"statusChangeDate" : "2000-06-21T04:56:07.000+00:00",
"statusChangeArgument" : {
"comment" : "Comment",
"status" : "{}"
},
"validator" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"validatorId" : "5000123",
"action" : "{}",
"type" : "{}"
}
2.5.29. Search for employees (with search criteria and time slot)
POST |
/employees/search |
Description
Get the list of employees matching the search criteria, with a history in the corresponding time slot.
DMF required:
-
DMF A40104: Api Workforce / Employees / Search
-
DMF 020104: Sales / Customer / Search
-
DMF 0202__: Sales / Quotations
-
DMF 020202: Sales / Quotations / Modify
-
DMF 020204: Sales / Quotations / Search
-
DMF 141302: Helpdesk / Issues / Modify
-
DMF 142602: Helpdesk / Simplified Issue / Modify
-
DMF 160804: Tools / Resources / Search
-
DMF 160805: Tools / Resources / Detailed Search
-
DMF 160813: Tools / Resources / Search Candidate
-
DMF 160838: Tools / Resources / Show Identity
-
DMF 1905__: Web Portal / Expense Reports
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
criteria |
Criteria that you choose (Employee function, team ID, etc…) EmployeeCriteria |
X |
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
from |
Start date of the search interval |
- |
null |
|
to |
End date of the search interval |
- |
null |
Return Type
array[Employee]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Employees successfully loaded |
List[Employee] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"batchKey" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"code" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"customData" : {
"key" : {
"operator" : "IS",
"value" : "{}",
"includeNullResults" : false
}
},
"shouldBeNotified" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"readOption" : {
"options" : [ "EMPLOYEE_HISTORY", "EMPLOYEE_HISTORY" ]
},
"number" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"employeePartitioning" : true,
"modificationTime" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
},
"relatedEmployeeId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"createdTime" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
},
"modificationById" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"id" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"tag" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"noTimesDunning" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"assignmentMultiCompany" : true,
"createdById" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"email" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"onlyPresent" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"entityId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"managerId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"excludeExternal" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"companyId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"excludeGeneric" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"teamId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"excludeCandidate" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"relationTypeId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
}
}
2.5.30. Search for employees referential (with search criteria)
POST |
/employees/referential/search |
Description
Get the list of employee referential matching the search criteria.
DMF required:
-
DMF A40104: Api Workforce / Employees / Search
-
DMF 020104: Sales / Customer / Search
-
DMF 0202__: Sales / Quotations
-
DMF 020202: Sales / Quotations / Modify
-
DMF 020204: Sales / Quotations / Search
-
DMF 141302: Helpdesk / Issues / Modify
-
DMF 142602: Helpdesk / Simplified Issue / Modify
-
DMF 160804: Tools / Resources / Search
-
DMF 160805: Tools / Resources / Detailed Search
-
DMF 160813: Tools / Resources / Search Candidate
-
DMF 160838: Tools / Resources / Show Identity
-
DMF 1905__: Web Portal / Expense Reports
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
criteria |
Criteria that you choose (Manager id, category code, etc…) EmployeeReferentialCriteria |
X |
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
limit |
The max number of employees returned |
- |
null |
Return Type
array[EmployeeReferential]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Employees successfully loaded |
List[EmployeeReferential] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"serviceCode" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"scheduled" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"category2Id" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"category1Id" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"employeeFirstName" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"abilityFilter" : [ {
"skillId" : "5000123",
"levelId" : "5000123"
}, {
"skillId" : "5000123",
"levelId" : "5000123"
} ],
"managerName" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"managerIncluded" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"employeeCode" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"employeeExecutive" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"customerIdScheduled" : [ "customerIdScheduled", "customerIdScheduled" ],
"readOption" : {
"options" : [ "STANDARD_WEEK", "STANDARD_WEEK" ]
},
"standardWeekId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"employeePartitioning" : true,
"category1Code" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"managerFirstName" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"category3Id" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"tag" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"divisionId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"employeeCandidate" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"serviceId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"referentialDate" : "2020-01-31T23:59:59Z",
"standardWeekCode" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"employeeName" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"divisionGroupId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"category2Code" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"referentialDateEnd" : "2020-01-31T23:59:59Z",
"employeeGeneric" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"employeeAbsent" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"employeeId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"entityId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"managerId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"employeeExternal" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"skillId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"companyId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"category3Code" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"projectTaskId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"managerCode" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"projectIdScheduled" : [ "projectIdScheduled", "projectIdScheduled" ],
"allCompanies" : true,
"skillCode" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"tagIdScheduled" : [ "tagIdScheduled", "tagIdScheduled" ],
"projectId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
}
}
2.5.31. Search for fields information behavior for employees
GET |
/employees/search-fields-information |
Deprecated
|
Tip
|
This API will soon be removed as it is no longer functional. No data will be returned when using it. |
Description
Get the list of search field behavior for employees
DMF required:
-
DMF A40104: Api Workforce / Employees / Search
-
DMF 020104: Sales / Customer / Search
-
DMF 0202__: Sales / Quotations
-
DMF 020202: Sales / Quotations / Modify
-
DMF 020204: Sales / Quotations / Search
-
DMF 141302: Helpdesk / Issues / Modify
-
DMF 142602: Helpdesk / Simplified Issue / Modify
-
DMF 160804: Tools / Resources / Search
-
DMF 160805: Tools / Resources / Detailed Search
-
DMF 160813: Tools / Resources / Search Candidate
-
DMF 160838: Tools / Resources / Show Identity
-
DMF 1905__: Web Portal / Expense Reports
Return Type
array[SearchControlBehavior]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Search field behavior results |
List[SearchControlBehavior] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.5.32. Search for fiscal powers (with search criteria)
POST |
/fiscal-power/search |
Description
Get the list of fiscal powers matching the search criteria.
DMF required:
-
DMF A40204: Api Workforce / Expenses / Search
-
DMF 041504: Purchases / Expense Reports / Search
-
DMF 190501: Web Portal / Expense Reports / Show
-
DMF 190509: Web Portal / Expense Reports / Change Employee (employees Managed By Me Only)
-
DMF 190510: Web Portal / Expense Reports / Change Employee (all Employees)
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
criteria |
Criteria that you choose (Company code, power, etc…) FiscalPowerCriteria |
X |
Return Type
array[FiscalPower]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Fiscal powers successfully loaded |
List[FiscalPower] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"companyCode" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"rate" : {
"operator" : "IS",
"value" : 12.6,
"includeNullResults" : false
},
"expenseTypeId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"employeeId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"id" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"power" : {
"operator" : "IS",
"value" : 12.6,
"includeNullResults" : false
},
"validity" : {
"type" : "{}",
"date" : "2000-06-21T04:56:07.000+00:00"
}
}
2.5.33. Search all managers (with search criteria and time slot)
POST |
/managers/search |
Description
Get all managers matching the search criteria.
DMF required:
-
DMF A40304: Api Workforce / Leaves / Search
-
DMF 160204: Tools / Leave Requests Management / Search
-
DMF 190103: Web Portal / Timesheets & Schedules Menu / Leave Requests
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
criteria |
Criteria that you choose (tag, end date, etc…) ManagerCriteria |
- |
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
from |
Start date of the search interval |
- |
null |
|
to |
End date of the search interval |
- |
null |
Return Type
array[Employee]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Managers successfully loaded |
List[Employee] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"endDate" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
},
"tag" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"startDate" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
}
}
2.5.34. Search the standard weeks (with search criteria)
POST |
/standard-weeks/search |
Description
Get the list of standard weeks matching the search criteria
DMF required:
-
DMF A40111: Api Workforce / Employees / Search Model Week
-
DMF 160846: Tools / Resources / Show Standard Week
-
DMF 1903__: Web Portal / Timesheets
-
DMF 1904__: Web Portal / Schedules
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
criteria |
Criteria that you choose (code, default, etc…) StandardWeekCriteria |
X |
Return Type
array[StandardWeek]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Standard weeks successfully loaded |
List[StandardWeek] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"companyCode" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"default" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"code" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"id" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
}
}
2.5.35. Search all managers with delegation for me (with search criteria)
POST |
/managers-delegated/mine/search |
Description
Get the list of all managers witch have delegation for me, and\
\ matching the search criteria.
DMF required:
-
DMF A40106: Api Workforce / Employees / Info
-
DMF 020104: Sales / Customer / Search
-
DMF 141302: Helpdesk / Issues / Modify
-
DMF 142602: Helpdesk / Simplified Issue / Modify
-
DMF 160804: Tools / Resources / Search
-
DMF 160805: Tools / Resources / Detailed Search
-
DMF 1903__: Web Portal / Timesheets
-
DMF 1904__: Web Portal / Schedules
-
DMF 1905__: Web Portal / Expense Reports
-
DMF 1909__: Web Portal / Approvals
-
DMF 250119: Project / Schedule View / Employee Details
-
DMF 010204: Prospecting / Opportunities / Search
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
criteria |
Criteria that you choose (tag, delegation module) ManagerDelegatedCriteria |
- |
Return Type
array[Employee]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Delegated managers successfully loaded |
List[Employee] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"tag" : "tag"
}
2.5.36. Search all projects linked to an employee (with search criteria)
POST |
/employees/{employee_id}/project-links/search |
Description
Get all projects linked to the employee matching specified ID and the search criteria.
DMF required:
-
DMF A40110: Api Workforce / Employees / Search Linked Projects
-
DMF 060104: Projects
-
DMF 060195: Projects
-
DMF 190402: Web Portal / Schedules / Modify
-
DMF 250102: Project / Schedule View / New
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
employee_id |
Id of an employee |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
criteria |
Criteria that you choose (Starting date, end date, …) ProjectLinkCriteria |
X |
Return Type
array[ProjectLink]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Projects linked successfully loaded |
List[ProjectLink] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"checkTimesheet" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"checkEmployeeCompany" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"from" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
},
"to" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
},
"checkSchedule" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
}
}
2.5.37. Search services (with search criteria)
POST |
/services/search |
Description
Get the list of the services matching the search criteria
DMF required:
-
DMF A40113: Api Workforce / Employees / Search Employee Services
-
DMF 160824: Tools / Resources / Show Organizational Data
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
criteria |
Criteria that you choose (code, name, etc…) ServiceCriteria |
X |
Return Type
array[Service]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Services successfully loaded |
List[Service] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"code" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"name" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"id" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
}
}
2.5.38. Search for vehicles (with search criteria)
POST |
/vehicles/search |
Description
Get the list of vehicles matching the search criteria, with a history in the corresponding time slot.
DMF required:
-
DMF A41204: Api Workforce / Vehicle / Search
-
DMF 190502: Web Portal / Expense Reports / Modify
-
DMF 160852: Tools / Resources / Show Taxable Powers
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
criteria |
Criteria that you choose (Employee ID, Expense type ID, etc…) VehicleCriteria |
X |
Return Type
array[Vehicle]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Employees successfully loaded |
List[Vehicle] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"licensePlate" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"employeeId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"expenseTypeId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"id" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"power" : {
"operator" : "IS",
"value" : 12.6,
"includeNullResults" : false
},
"validity" : {
"type" : "{}",
"date" : "2000-06-21T04:56:07.000+00:00"
}
}
2.5.39. Transfer an employee to another company.
POST |
/employees/{employee_id}/transfer |
Description
Transfer an employee to another company.
DMF required:
-
DMF A40147: Api Workforce / Employees / Transfer Employee
-
DMF 160854: Tools / Resources / Company Change History
-
DMF 160855: Tools / Resources / Transfer To Another Company
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
employee_id |
Id of an employee |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
TransferEmployeeParamHolder |
Parameters to transfer an employee. TransferEmployeeParamHolder |
X |
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
The transfer of the employee has been successfully done |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"startDate" : "2020-01-23T04:56:07Z",
"newCompanyId" : "AKSAS",
"comment" : "Limpso usum"
}
2.5.40. Update an employee
POST |
/employees/{employee_id} |
Description
Update the employee matching the specified ID and using the list of parameters below.
DMF required:
-
DMF A40102: Api Workforce / Employees / Update
-
DMF 160802: Tools / Resources / Modify
-
DMF 160866: Tools / Resources / Modify Status History
-
DMF 160851: Tools / Resources / Modify Linked Employees
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
employee_id |
Id of an employee |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
employee |
The employee to update Employee |
X |
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Employee successfully updated |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}",
"title" : "GEN",
"phone" : "+33 6 04 04 04 05",
"mobilePhone" : "+33 6 00 00 00 01",
"email" : "myemail@bechmail.com",
"noTimesDunning" : true,
"assignmentMultiCompany" : false,
"modeTimeRecording" : 1,
"modeInputSchedule" : 3,
"timeRecordingInputMode" : "{}",
"scheduleInputMode" : "{}",
"executive" : true,
"generic" : true,
"candidate" : false,
"external" : false,
"managerMultiCompany" : true,
"employeeFunctions" : {
"allFunctions" : false,
"allSales" : true,
"allPurchases" : false,
"allOperational" : true,
"projectSalesManager" : false,
"projectFinanceManager" : true,
"projectProductionManager" : false,
"projectAccountManager" : true,
"projectAssignment" : false,
"projectPhaseManager" : true,
"projectSendOnMission" : false,
"salesSalesAssistant" : true,
"salesOrderAndEstimateTracking" : false,
"salesBillingSchedulesTracking" : true,
"purchasingBuyer" : false,
"timeRecording" : true,
"inputOfExpenseReport" : false,
"purchasesReceptionTracking" : false,
"inputSchedule" : false,
"CMMSContractSalesManager" : false,
"CMMSContractTechnicalManager" : false,
"CMMSMRAndEOManager" : false
},
"employeeHistory" : [ {
"id" : "5000123",
"employeeHistoryType" : "5000123",
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 7.42,
"weekHours" : 38.3,
"occupancyRate" : 0.8,
"manager" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"managerId" : "5000123",
"company" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo"
},
"companyId" : "5000123",
"directHourlyRate" : 10.42,
"standardHourlyRate" : 10,
"dailyCost" : 59.36,
"dailySellingPrice" : 80,
"entity" : "5000123",
"serviceRef" : {
"id" : "5000123",
"name" : "Professional services",
"code" : "PS"
},
"service" : "5000123",
"position" : "Developer",
"skillRef" : {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
},
"skill" : "5000123",
"family1" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family1Id" : "5000123",
"family2" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family2Id" : "5000123",
"family3" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family3Id" : "5000123",
"leave" : false,
"standardWeek" : {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
}
},
"standardWeekId" : "5000123",
"salary" : 1024
}, {
"id" : "5000123",
"employeeHistoryType" : "5000123",
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 7.42,
"weekHours" : 38.3,
"occupancyRate" : 0.8,
"manager" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"managerId" : "5000123",
"company" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo"
},
"companyId" : "5000123",
"directHourlyRate" : 10.42,
"standardHourlyRate" : 10,
"dailyCost" : 59.36,
"dailySellingPrice" : 80,
"entity" : "5000123",
"serviceRef" : {
"id" : "5000123",
"name" : "Professional services",
"code" : "PS"
},
"service" : "5000123",
"position" : "Developer",
"skillRef" : {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
},
"skill" : "5000123",
"family1" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family1Id" : "5000123",
"family2" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family2Id" : "5000123",
"family3" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family3Id" : "5000123",
"leave" : false,
"standardWeek" : {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
}
},
"standardWeekId" : "5000123",
"salary" : 1024
} ],
"companyChanges" : [ {
"id" : "5000123",
"employeeId" : "500123",
"companyId" : "5000123",
"startDate" : "2020-01-23T04:56:07Z",
"endDate" : "2020-01-23T04:56:07Z",
"companyChangeState" : "{}",
"comment" : "Limpso usum"
}, {
"id" : "5000123",
"employeeId" : "500123",
"companyId" : "5000123",
"startDate" : "2020-01-23T04:56:07Z",
"endDate" : "2020-01-23T04:56:07Z",
"companyChangeState" : "{}",
"comment" : "Limpso usum"
} ],
"timeRecordingRules" : {
"id" : "5000123",
"employeeId" : "5000123",
"min" : 0,
"max" : 24,
"step" : 0.01,
"prettyStep" : 0.3,
"base" : 60,
"unit" : "H",
"unitDuration" : "{}",
"allowManualEntry" : true,
"employeeWeeks" : [ {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
},
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 8,
"dailyMinutes" : 10,
"weekHours" : 40,
"leave" : false
}, {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
},
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 8,
"dailyMinutes" : 10,
"weekHours" : 40,
"leave" : false
} ],
"closingDates" : [ {
"closingDate" : "2020-01-31T23:59:59Z",
"module" : "DATE_MODULE",
"beginningOfPeriod" : "2020-01-31T23:59:59Z",
"endOfPeriod" : "2020-01-31T23:59:59Z"
}, {
"closingDate" : "2020-01-31T23:59:59Z",
"module" : "DATE_MODULE",
"beginningOfPeriod" : "2020-01-31T23:59:59Z",
"endOfPeriod" : "2020-01-31T23:59:59Z"
} ],
"simpleDuration" : 750,
"completionMode" : "WEEKLY"
},
"scheduleRules" : {
"id" : "5000123",
"employeeId" : "5000123",
"min" : 0,
"max" : 24,
"step" : 0.01,
"prettyStep" : 0.3,
"base" : 60,
"unit" : "H",
"unitDuration" : "{}",
"allowManualEntry" : true,
"employeeWeeks" : [ {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
},
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 8,
"dailyMinutes" : 10,
"weekHours" : 40,
"leave" : false
}, {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
},
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 8,
"dailyMinutes" : 10,
"weekHours" : 40,
"leave" : false
} ],
"closingDates" : [ {
"closingDate" : "2020-01-31T23:59:59Z",
"module" : "DATE_MODULE",
"beginningOfPeriod" : "2020-01-31T23:59:59Z",
"endOfPeriod" : "2020-01-31T23:59:59Z"
}, {
"closingDate" : "2020-01-31T23:59:59Z",
"module" : "DATE_MODULE",
"beginningOfPeriod" : "2020-01-31T23:59:59Z",
"endOfPeriod" : "2020-01-31T23:59:59Z"
} ],
"timestamped" : true
},
"businessCards" : [ {
"id" : "5000123",
"employeeId" : "5000123",
"cardNumber" : "XXXX XXXX XXXX 7568",
"encryptedCardNumber" : "0",
"name" : "Management card",
"type" : "{}",
"endDate" : "2020-01-31T23:59:59Z"
}, {
"id" : "5000123",
"employeeId" : "5000123",
"cardNumber" : "XXXX XXXX XXXX 7568",
"encryptedCardNumber" : "0",
"name" : "Management card",
"type" : "{}",
"endDate" : "2020-01-31T23:59:59Z"
} ],
"sector" : "Marketing",
"number" : "84",
"relations" : [ {
"id" : "5000123",
"relationType" : {
"id" : "5000123",
"code" : "TUTOR",
"name" : "Tutor for internship"
},
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"relatedEmployee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"relatedEmployeeId" : "5000123"
}, {
"id" : "5000123",
"relationType" : {
"id" : "5000123",
"code" : "TUTOR",
"name" : "Tutor for internship"
},
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"relatedEmployee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"relatedEmployeeId" : "5000123"
} ],
"employeeAbilities" : [ {
"id" : "5000123",
"skill" : {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
},
"level" : {
"id" : "5000123",
"code" : "EXP",
"name" : "Expert"
},
"startDate" : "2020-01-31T23:59:59Z",
"endDate" : "2020-01-31T23:59:59Z",
"employeeId" : "5000123"
}, {
"id" : "5000123",
"skill" : {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
},
"level" : {
"id" : "5000123",
"code" : "EXP",
"name" : "Expert"
},
"startDate" : "2020-01-31T23:59:59Z",
"endDate" : "2020-01-31T23:59:59Z",
"employeeId" : "5000123"
} ],
"jobType" : {
"id" : "5000123",
"companyCode" : "AKSAS",
"code" : "ADMIN",
"name" : "Administrator",
"category" : "{}",
"validity" : {
"type" : "{}",
"date" : "2000-06-21T04:56:07.000+00:00"
},
"default" : true
},
"jobTypeId" : "100245",
"address" : {
"id" : "id",
"line1" : "221B Baker Street",
"line2" : "2nd Floor",
"line3" : "First door at your right",
"cedex" : "CEDEX 14",
"postalCode" : "69002",
"city" : "London",
"country" : "FR (for 'FRANCE')",
"countryName" : "FRANCE",
"department" : "75 (for 'PARIS')",
"geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
"region" : "65 (for 'ILE DE FRANCE')",
"regionName" : "ILE DE FRANCE",
"phone" : "06 00 00 00 01",
"phone2" : "06 00 00 00 02",
"email" : "myemail@mail.com",
"mobilePhone" : "06 00 00 00 02",
"fax" : "04 00 00 00 07",
"webSite" : "mysite.com"
},
"addressId" : "5000123",
"birthDate" : "2000-06-21T04:56:07.000+00:00",
"customData" : {
"key" : {
"type" : "{}",
"value" : "Autoref 010520",
"name" : "Reference 4",
"realOrder" : 0,
"label" : "REFERENCE_4"
}
},
"color" : "#FF0000",
"targetTace" : 75,
"formConfig" : {
"type" : "{}",
"fields" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"controls" : {
"key" : {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}
},
"insertable" : true,
"editable" : false,
"deletable" : false,
"formSearchHidden" : false
},
"changeTracking" : {
"createdTime" : "2000-06-21T04:56:07.000+00:00",
"createdBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"createdById" : "5000123",
"modificationTime" : "2000-06-21T04:56:07.000+00:00",
"modificationBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"modificationById" : "5000123"
},
"vehicles" : [ {
"id" : "5000123",
"power" : 5,
"licensePlate" : "licensePlate",
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"expenseType" : {
"id" : "5000123",
"code" : "MEAL",
"description" : "Plane",
"km" : false,
"notRefundable" : true,
"icon" : "fa fa-plane",
"color" : "00ff40",
"receiptRequired" : false,
"commentRequired" : false,
"guestsRequired" : false,
"notRefundableEditable" : true,
"billableEditable" : true,
"amountEditable" : true,
"showQuantity" : false,
"showAdditionalComment" : false,
"showReceiptNumber" : true,
"showAmountCategory" : true,
"showBillable" : true,
"hideVat" : false,
"vat1Code" : "1",
"vat2Code" : "2",
"vat3Code" : "3",
"expenseThreshold" : 100,
"defaultAmount" : 45,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"expenseCategory" : "{}",
"expenseRebillableOptions" : "{}",
"showCustomRequest" : true,
"showAmountWithoutVat" : true,
"controlsBehavior" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"calculateKilometers" : true,
"freeEntryProhibited" : true,
"controls" : {
"enableDuplicate" : true,
"enablelOnNonWorkingDay" : true,
"enableOnDayWithLeaveRequest" : true,
"enableOnDayWithTimesheetOrSchedule" : true
},
"expenseThresholdExceededNoVat" : false
},
"expenseTypeId" : "5000123",
"endDate" : "2020-01-31T23:59:59Z"
}, {
"id" : "5000123",
"power" : 5,
"licensePlate" : "licensePlate",
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"expenseType" : {
"id" : "5000123",
"code" : "MEAL",
"description" : "Plane",
"km" : false,
"notRefundable" : true,
"icon" : "fa fa-plane",
"color" : "00ff40",
"receiptRequired" : false,
"commentRequired" : false,
"guestsRequired" : false,
"notRefundableEditable" : true,
"billableEditable" : true,
"amountEditable" : true,
"showQuantity" : false,
"showAdditionalComment" : false,
"showReceiptNumber" : true,
"showAmountCategory" : true,
"showBillable" : true,
"hideVat" : false,
"vat1Code" : "1",
"vat2Code" : "2",
"vat3Code" : "3",
"expenseThreshold" : 100,
"defaultAmount" : 45,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"expenseCategory" : "{}",
"expenseRebillableOptions" : "{}",
"showCustomRequest" : true,
"showAmountWithoutVat" : true,
"controlsBehavior" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"calculateKilometers" : true,
"freeEntryProhibited" : true,
"controls" : {
"enableDuplicate" : true,
"enablelOnNonWorkingDay" : true,
"enableOnDayWithLeaveRequest" : true,
"enableOnDayWithTimesheetOrSchedule" : true
},
"expenseThresholdExceededNoVat" : false
},
"expenseTypeId" : "5000123",
"endDate" : "2020-01-31T23:59:59Z"
} ],
"currentCompany" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo",
"legalName" : "legalName",
"siren" : "siren",
"siret" : "siret",
"calendar" : {
"id" : "5000123",
"code" : "Text",
"name" : "Text",
"default" : true,
"daysNotWorked" : [ 6, 6 ],
"holidays" : [ {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
}, {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
} ]
},
"calendarId" : "calendarId",
"color" : "color",
"currency" : {
"id" : "5000123",
"name" : "Euro",
"code" : "EUR",
"order" : 17,
"euro" : true,
"euroRate" : 0.9678,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"euroRateStartDate" : "2020-01-23T04:56:07Z",
"euroRateEndDate" : "2020-01-23T04:56:07Z"
},
"currencyId" : "currencyId",
"address" : {
"id" : "id",
"line1" : "221B Baker Street",
"line2" : "2nd Floor",
"line3" : "First door at your right",
"cedex" : "CEDEX 14",
"postalCode" : "69002",
"city" : "London",
"country" : "FR (for 'FRANCE')",
"countryName" : "FRANCE",
"department" : "75 (for 'PARIS')",
"geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
"region" : "65 (for 'ILE DE FRANCE')",
"regionName" : "ILE DE FRANCE",
"phone" : "06 00 00 00 01",
"phone2" : "06 00 00 00 02",
"email" : "myemail@mail.com",
"mobilePhone" : "06 00 00 00 02",
"fax" : "04 00 00 00 07",
"webSite" : "mysite.com"
},
"addressId" : "addressId"
},
"currentCompanyId" : "5000123",
"bankingInformation" : {
"id" : "5000123",
"sepa" : {
"bankDetails" : {
"entity" : "30002",
"counter" : "550",
"accountNumber" : "0000157841Z",
"key" : "25",
"domiciliation" : "AURA"
},
"bic" : {
"country" : "FR (for 'FRANCE')",
"bank" : "DAAE",
"location" : "PP",
"branch" : "CCT"
},
"iban" : {
"country" : "FR (for 'FRANCE')",
"key" : "69",
"accountNumber" : "0000157841Z"
}
},
"noneSepa" : {
"defaultBankDetail" : false,
"beneficiary" : {
"holder" : {
"name" : "RITA",
"firstName" : "BRITA",
"accountType" : "{}",
"accountNumber" : "123456789"
},
"bank" : {
"bankName" : "UBA",
"bankName2" : "UBA",
"bankType" : "{}",
"bankCode" : "C8",
"bankAddress" : {
"id" : "id",
"line1" : "221B Baker Street",
"line2" : "2nd Floor",
"line3" : "First door at your right",
"cedex" : "CEDEX 14",
"postalCode" : "69002",
"city" : "London",
"country" : "FR (for 'FRANCE')",
"countryName" : "FRANCE",
"department" : "75 (for 'PARIS')",
"geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
"region" : "65 (for 'ILE DE FRANCE')",
"regionName" : "ILE DE FRANCE",
"phone" : "06 00 00 00 01",
"phone2" : "06 00 00 00 02",
"email" : "myemail@mail.com",
"mobilePhone" : "06 00 00 00 02",
"fax" : "04 00 00 00 07",
"webSite" : "mysite.com"
}
}
},
"intermediate" : {
"holder" : {
"name" : "RITA",
"firstName" : "BRITA",
"accountType" : "{}",
"accountNumber" : "123456789"
},
"bank" : {
"bankName" : "UBA",
"bankName2" : "UBA",
"bankType" : "{}",
"bankCode" : "C8",
"bankAddress" : {
"id" : "id",
"line1" : "221B Baker Street",
"line2" : "2nd Floor",
"line3" : "First door at your right",
"cedex" : "CEDEX 14",
"postalCode" : "69002",
"city" : "London",
"country" : "FR (for 'FRANCE')",
"countryName" : "FRANCE",
"department" : "75 (for 'PARIS')",
"geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
"region" : "65 (for 'ILE DE FRANCE')",
"regionName" : "ILE DE FRANCE",
"phone" : "06 00 00 00 01",
"phone2" : "06 00 00 00 02",
"email" : "myemail@mail.com",
"mobilePhone" : "06 00 00 00 02",
"fax" : "04 00 00 00 07",
"webSite" : "mysite.com"
}
}
}
},
"statusChangeDate" : "2000-06-21T04:56:07.000+00:00",
"statusChangeArgument" : {
"comment" : "Comment",
"status" : "{}"
},
"validator" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"validatorId" : "5000123",
"action" : "{}",
"type" : "{}"
},
"faxNumber" : "418 643 3210",
"phoneExtensionNumber" : "04 00 00 00 07"
}
2.5.41. Update an employee fluently
POST |
/fluent/employees/{employee_code} |
Description
Update an employee fluently using the list of parameters below.
DMF required:
-
DMF A40102: Api Workforce / Employees / Update
-
DMF 160802: Tools / Resources / Modify
-
DMF 160866: Tools / Resources / Modify Status History
-
DMF 160851: Tools / Resources / Modify Linked Employees
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
employee_code |
The employee's code |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
employeesFluent |
The employee to update EmployeeFluent |
X |
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Employee successfully updated |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}",
"title" : "GEN",
"phone" : "+33 6 04 04 04 05",
"mobilePhone" : "+33 6 00 00 00 01",
"email" : "myemail@bechmail.com",
"noTimesDunning" : true,
"assignmentMultiCompany" : false,
"modeTimeRecording" : 1,
"modeInputSchedule" : 3,
"timeRecordingInputMode" : "{}",
"scheduleInputMode" : "{}",
"executive" : true,
"generic" : true,
"candidate" : false,
"external" : false,
"managerMultiCompany" : true,
"employeeFunctions" : {
"allFunctions" : false,
"allSales" : true,
"allPurchases" : false,
"allOperational" : true,
"projectSalesManager" : false,
"projectFinanceManager" : true,
"projectProductionManager" : false,
"projectAccountManager" : true,
"projectAssignment" : false,
"projectPhaseManager" : true,
"projectSendOnMission" : false,
"salesSalesAssistant" : true,
"salesOrderAndEstimateTracking" : false,
"salesBillingSchedulesTracking" : true,
"purchasingBuyer" : false,
"timeRecording" : true,
"inputOfExpenseReport" : false,
"purchasesReceptionTracking" : false,
"inputSchedule" : false,
"CMMSContractSalesManager" : false,
"CMMSContractTechnicalManager" : false,
"CMMSMRAndEOManager" : false
},
"employeeHistory" : [ {
"id" : "5000123",
"employeeHistoryType" : "5000123",
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 7.42,
"weekHours" : 38.3,
"occupancyRate" : 0.8,
"manager" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"managerId" : "5000123",
"company" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo"
},
"companyId" : "5000123",
"directHourlyRate" : 10.42,
"standardHourlyRate" : 10,
"dailyCost" : 59.36,
"dailySellingPrice" : 80,
"entity" : "5000123",
"serviceRef" : {
"id" : "5000123",
"name" : "Professional services",
"code" : "PS"
},
"service" : "5000123",
"position" : "Developer",
"skillRef" : {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
},
"skill" : "5000123",
"family1" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family1Id" : "5000123",
"family2" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family2Id" : "5000123",
"family3" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family3Id" : "5000123",
"leave" : false,
"standardWeek" : {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
}
},
"standardWeekId" : "5000123",
"salary" : 1024
}, {
"id" : "5000123",
"employeeHistoryType" : "5000123",
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 7.42,
"weekHours" : 38.3,
"occupancyRate" : 0.8,
"manager" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"managerId" : "5000123",
"company" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo"
},
"companyId" : "5000123",
"directHourlyRate" : 10.42,
"standardHourlyRate" : 10,
"dailyCost" : 59.36,
"dailySellingPrice" : 80,
"entity" : "5000123",
"serviceRef" : {
"id" : "5000123",
"name" : "Professional services",
"code" : "PS"
},
"service" : "5000123",
"position" : "Developer",
"skillRef" : {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
},
"skill" : "5000123",
"family1" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family1Id" : "5000123",
"family2" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family2Id" : "5000123",
"family3" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family3Id" : "5000123",
"leave" : false,
"standardWeek" : {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
}
},
"standardWeekId" : "5000123",
"salary" : 1024
} ],
"companyChanges" : [ {
"id" : "5000123",
"employeeId" : "500123",
"companyId" : "5000123",
"startDate" : "2020-01-23T04:56:07Z",
"endDate" : "2020-01-23T04:56:07Z",
"companyChangeState" : "{}",
"comment" : "Limpso usum"
}, {
"id" : "5000123",
"employeeId" : "500123",
"companyId" : "5000123",
"startDate" : "2020-01-23T04:56:07Z",
"endDate" : "2020-01-23T04:56:07Z",
"companyChangeState" : "{}",
"comment" : "Limpso usum"
} ],
"timeRecordingRules" : {
"id" : "5000123",
"employeeId" : "5000123",
"min" : 0,
"max" : 24,
"step" : 0.01,
"prettyStep" : 0.3,
"base" : 60,
"unit" : "H",
"unitDuration" : "{}",
"allowManualEntry" : true,
"employeeWeeks" : [ {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
},
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 8,
"dailyMinutes" : 10,
"weekHours" : 40,
"leave" : false
}, {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
},
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 8,
"dailyMinutes" : 10,
"weekHours" : 40,
"leave" : false
} ],
"closingDates" : [ {
"closingDate" : "2020-01-31T23:59:59Z",
"module" : "DATE_MODULE",
"beginningOfPeriod" : "2020-01-31T23:59:59Z",
"endOfPeriod" : "2020-01-31T23:59:59Z"
}, {
"closingDate" : "2020-01-31T23:59:59Z",
"module" : "DATE_MODULE",
"beginningOfPeriod" : "2020-01-31T23:59:59Z",
"endOfPeriod" : "2020-01-31T23:59:59Z"
} ],
"simpleDuration" : 750,
"completionMode" : "WEEKLY"
},
"scheduleRules" : {
"id" : "5000123",
"employeeId" : "5000123",
"min" : 0,
"max" : 24,
"step" : 0.01,
"prettyStep" : 0.3,
"base" : 60,
"unit" : "H",
"unitDuration" : "{}",
"allowManualEntry" : true,
"employeeWeeks" : [ {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
},
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 8,
"dailyMinutes" : 10,
"weekHours" : 40,
"leave" : false
}, {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
},
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 8,
"dailyMinutes" : 10,
"weekHours" : 40,
"leave" : false
} ],
"closingDates" : [ {
"closingDate" : "2020-01-31T23:59:59Z",
"module" : "DATE_MODULE",
"beginningOfPeriod" : "2020-01-31T23:59:59Z",
"endOfPeriod" : "2020-01-31T23:59:59Z"
}, {
"closingDate" : "2020-01-31T23:59:59Z",
"module" : "DATE_MODULE",
"beginningOfPeriod" : "2020-01-31T23:59:59Z",
"endOfPeriod" : "2020-01-31T23:59:59Z"
} ],
"timestamped" : true
},
"businessCards" : [ {
"id" : "5000123",
"employeeId" : "5000123",
"cardNumber" : "XXXX XXXX XXXX 7568",
"encryptedCardNumber" : "0",
"name" : "Management card",
"type" : "{}",
"endDate" : "2020-01-31T23:59:59Z"
}, {
"id" : "5000123",
"employeeId" : "5000123",
"cardNumber" : "XXXX XXXX XXXX 7568",
"encryptedCardNumber" : "0",
"name" : "Management card",
"type" : "{}",
"endDate" : "2020-01-31T23:59:59Z"
} ],
"sector" : "Marketing",
"number" : "84",
"relations" : [ {
"id" : "5000123",
"relationType" : {
"id" : "5000123",
"code" : "TUTOR",
"name" : "Tutor for internship"
},
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"relatedEmployee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"relatedEmployeeId" : "5000123"
}, {
"id" : "5000123",
"relationType" : {
"id" : "5000123",
"code" : "TUTOR",
"name" : "Tutor for internship"
},
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"relatedEmployee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"relatedEmployeeId" : "5000123"
} ],
"employeeAbilities" : [ {
"id" : "5000123",
"skill" : {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
},
"level" : {
"id" : "5000123",
"code" : "EXP",
"name" : "Expert"
},
"startDate" : "2020-01-31T23:59:59Z",
"endDate" : "2020-01-31T23:59:59Z",
"employeeId" : "5000123"
}, {
"id" : "5000123",
"skill" : {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
},
"level" : {
"id" : "5000123",
"code" : "EXP",
"name" : "Expert"
},
"startDate" : "2020-01-31T23:59:59Z",
"endDate" : "2020-01-31T23:59:59Z",
"employeeId" : "5000123"
} ],
"jobType" : {
"id" : "5000123",
"companyCode" : "AKSAS",
"code" : "ADMIN",
"name" : "Administrator",
"category" : "{}",
"validity" : {
"type" : "{}",
"date" : "2000-06-21T04:56:07.000+00:00"
},
"default" : true
},
"jobTypeId" : "100245",
"address" : {
"id" : "id",
"line1" : "221B Baker Street",
"line2" : "2nd Floor",
"line3" : "First door at your right",
"cedex" : "CEDEX 14",
"postalCode" : "69002",
"city" : "London",
"country" : "FR (for 'FRANCE')",
"countryName" : "FRANCE",
"department" : "75 (for 'PARIS')",
"geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
"region" : "65 (for 'ILE DE FRANCE')",
"regionName" : "ILE DE FRANCE",
"phone" : "06 00 00 00 01",
"phone2" : "06 00 00 00 02",
"email" : "myemail@mail.com",
"mobilePhone" : "06 00 00 00 02",
"fax" : "04 00 00 00 07",
"webSite" : "mysite.com"
},
"addressId" : "5000123",
"birthDate" : "2000-06-21T04:56:07.000+00:00",
"customData" : {
"key" : {
"type" : "{}",
"value" : "Autoref 010520",
"name" : "Reference 4",
"realOrder" : 0,
"label" : "REFERENCE_4"
}
},
"color" : "#FF0000",
"targetTace" : 75,
"formConfig" : {
"type" : "{}",
"fields" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"controls" : {
"key" : {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}
},
"insertable" : true,
"editable" : false,
"deletable" : false,
"formSearchHidden" : false
},
"changeTracking" : {
"createdTime" : "2000-06-21T04:56:07.000+00:00",
"createdBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"createdById" : "5000123",
"modificationTime" : "2000-06-21T04:56:07.000+00:00",
"modificationBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"modificationById" : "5000123"
},
"vehicles" : [ {
"id" : "5000123",
"power" : 5,
"licensePlate" : "licensePlate",
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"expenseType" : {
"id" : "5000123",
"code" : "MEAL",
"description" : "Plane",
"km" : false,
"notRefundable" : true,
"icon" : "fa fa-plane",
"color" : "00ff40",
"receiptRequired" : false,
"commentRequired" : false,
"guestsRequired" : false,
"notRefundableEditable" : true,
"billableEditable" : true,
"amountEditable" : true,
"showQuantity" : false,
"showAdditionalComment" : false,
"showReceiptNumber" : true,
"showAmountCategory" : true,
"showBillable" : true,
"hideVat" : false,
"vat1Code" : "1",
"vat2Code" : "2",
"vat3Code" : "3",
"expenseThreshold" : 100,
"defaultAmount" : 45,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"expenseCategory" : "{}",
"expenseRebillableOptions" : "{}",
"showCustomRequest" : true,
"showAmountWithoutVat" : true,
"controlsBehavior" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"calculateKilometers" : true,
"freeEntryProhibited" : true,
"controls" : {
"enableDuplicate" : true,
"enablelOnNonWorkingDay" : true,
"enableOnDayWithLeaveRequest" : true,
"enableOnDayWithTimesheetOrSchedule" : true
},
"expenseThresholdExceededNoVat" : false
},
"expenseTypeId" : "5000123",
"endDate" : "2020-01-31T23:59:59Z"
}, {
"id" : "5000123",
"power" : 5,
"licensePlate" : "licensePlate",
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"expenseType" : {
"id" : "5000123",
"code" : "MEAL",
"description" : "Plane",
"km" : false,
"notRefundable" : true,
"icon" : "fa fa-plane",
"color" : "00ff40",
"receiptRequired" : false,
"commentRequired" : false,
"guestsRequired" : false,
"notRefundableEditable" : true,
"billableEditable" : true,
"amountEditable" : true,
"showQuantity" : false,
"showAdditionalComment" : false,
"showReceiptNumber" : true,
"showAmountCategory" : true,
"showBillable" : true,
"hideVat" : false,
"vat1Code" : "1",
"vat2Code" : "2",
"vat3Code" : "3",
"expenseThreshold" : 100,
"defaultAmount" : 45,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"expenseCategory" : "{}",
"expenseRebillableOptions" : "{}",
"showCustomRequest" : true,
"showAmountWithoutVat" : true,
"controlsBehavior" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"calculateKilometers" : true,
"freeEntryProhibited" : true,
"controls" : {
"enableDuplicate" : true,
"enablelOnNonWorkingDay" : true,
"enableOnDayWithLeaveRequest" : true,
"enableOnDayWithTimesheetOrSchedule" : true
},
"expenseThresholdExceededNoVat" : false
},
"expenseTypeId" : "5000123",
"endDate" : "2020-01-31T23:59:59Z"
} ],
"currentCompany" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo",
"legalName" : "legalName",
"siren" : "siren",
"siret" : "siret",
"calendar" : {
"id" : "5000123",
"code" : "Text",
"name" : "Text",
"default" : true,
"daysNotWorked" : [ 6, 6 ],
"holidays" : [ {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
}, {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
} ]
},
"calendarId" : "calendarId",
"color" : "color",
"currency" : {
"id" : "5000123",
"name" : "Euro",
"code" : "EUR",
"order" : 17,
"euro" : true,
"euroRate" : 0.9678,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"euroRateStartDate" : "2020-01-23T04:56:07Z",
"euroRateEndDate" : "2020-01-23T04:56:07Z"
},
"currencyId" : "currencyId",
"address" : {
"id" : "id",
"line1" : "221B Baker Street",
"line2" : "2nd Floor",
"line3" : "First door at your right",
"cedex" : "CEDEX 14",
"postalCode" : "69002",
"city" : "London",
"country" : "FR (for 'FRANCE')",
"countryName" : "FRANCE",
"department" : "75 (for 'PARIS')",
"geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
"region" : "65 (for 'ILE DE FRANCE')",
"regionName" : "ILE DE FRANCE",
"phone" : "06 00 00 00 01",
"phone2" : "06 00 00 00 02",
"email" : "myemail@mail.com",
"mobilePhone" : "06 00 00 00 02",
"fax" : "04 00 00 00 07",
"webSite" : "mysite.com"
},
"addressId" : "addressId"
},
"currentCompanyId" : "5000123",
"bankingInformation" : {
"id" : "5000123",
"sepa" : {
"bankDetails" : {
"entity" : "30002",
"counter" : "550",
"accountNumber" : "0000157841Z",
"key" : "25",
"domiciliation" : "AURA"
},
"bic" : {
"country" : "FR (for 'FRANCE')",
"bank" : "DAAE",
"location" : "PP",
"branch" : "CCT"
},
"iban" : {
"country" : "FR (for 'FRANCE')",
"key" : "69",
"accountNumber" : "0000157841Z"
}
},
"noneSepa" : {
"defaultBankDetail" : false,
"beneficiary" : {
"holder" : {
"name" : "RITA",
"firstName" : "BRITA",
"accountType" : "{}",
"accountNumber" : "123456789"
},
"bank" : {
"bankName" : "UBA",
"bankName2" : "UBA",
"bankType" : "{}",
"bankCode" : "C8",
"bankAddress" : {
"id" : "id",
"line1" : "221B Baker Street",
"line2" : "2nd Floor",
"line3" : "First door at your right",
"cedex" : "CEDEX 14",
"postalCode" : "69002",
"city" : "London",
"country" : "FR (for 'FRANCE')",
"countryName" : "FRANCE",
"department" : "75 (for 'PARIS')",
"geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
"region" : "65 (for 'ILE DE FRANCE')",
"regionName" : "ILE DE FRANCE",
"phone" : "06 00 00 00 01",
"phone2" : "06 00 00 00 02",
"email" : "myemail@mail.com",
"mobilePhone" : "06 00 00 00 02",
"fax" : "04 00 00 00 07",
"webSite" : "mysite.com"
}
}
},
"intermediate" : {
"holder" : {
"name" : "RITA",
"firstName" : "BRITA",
"accountType" : "{}",
"accountNumber" : "123456789"
},
"bank" : {
"bankName" : "UBA",
"bankName2" : "UBA",
"bankType" : "{}",
"bankCode" : "C8",
"bankAddress" : {
"id" : "id",
"line1" : "221B Baker Street",
"line2" : "2nd Floor",
"line3" : "First door at your right",
"cedex" : "CEDEX 14",
"postalCode" : "69002",
"city" : "London",
"country" : "FR (for 'FRANCE')",
"countryName" : "FRANCE",
"department" : "75 (for 'PARIS')",
"geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
"region" : "65 (for 'ILE DE FRANCE')",
"regionName" : "ILE DE FRANCE",
"phone" : "06 00 00 00 01",
"phone2" : "06 00 00 00 02",
"email" : "myemail@mail.com",
"mobilePhone" : "06 00 00 00 02",
"fax" : "04 00 00 00 07",
"webSite" : "mysite.com"
}
}
}
},
"statusChangeDate" : "2000-06-21T04:56:07.000+00:00",
"statusChangeArgument" : {
"comment" : "Comment",
"status" : "{}"
},
"validator" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"validatorId" : "5000123",
"action" : "{}",
"type" : "{}"
},
"faxNumber" : "418 643 3210",
"phoneExtensionNumber" : "04 00 00 00 07",
"historiqueCollaborateur" : [ {
"id" : "5000123",
"employeeHistoryType" : "5000123",
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 7.42,
"weekHours" : 38.3,
"occupancyRate" : 0.8,
"manager" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"managerId" : "5000123",
"company" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo"
},
"companyId" : "5000123",
"directHourlyRate" : 10.42,
"standardHourlyRate" : 10,
"dailyCost" : 59.36,
"dailySellingPrice" : 80,
"entity" : "5000123",
"serviceRef" : {
"id" : "5000123",
"name" : "Professional services",
"code" : "PS"
},
"service" : "5000123",
"position" : "Developer",
"skillRef" : {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
},
"skill" : "5000123",
"family1" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family1Id" : "5000123",
"family2" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family2Id" : "5000123",
"family3" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family3Id" : "5000123",
"leave" : false,
"standardWeek" : {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
}
},
"standardWeekId" : "5000123",
"salary" : 1024,
"entityCode" : "AKSAS",
"serviceCode" : "PS",
"skillCode" : "ENG",
"employeeFamily1Code" : "CDI",
"employeeFamily2Code" : "DAY",
"employeeFamily3Code" : "PS-S",
"managerCode" : "CASH"
}, {
"id" : "5000123",
"employeeHistoryType" : "5000123",
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 7.42,
"weekHours" : 38.3,
"occupancyRate" : 0.8,
"manager" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"managerId" : "5000123",
"company" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo"
},
"companyId" : "5000123",
"directHourlyRate" : 10.42,
"standardHourlyRate" : 10,
"dailyCost" : 59.36,
"dailySellingPrice" : 80,
"entity" : "5000123",
"serviceRef" : {
"id" : "5000123",
"name" : "Professional services",
"code" : "PS"
},
"service" : "5000123",
"position" : "Developer",
"skillRef" : {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
},
"skill" : "5000123",
"family1" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family1Id" : "5000123",
"family2" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family2Id" : "5000123",
"family3" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family3Id" : "5000123",
"leave" : false,
"standardWeek" : {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
}
},
"standardWeekId" : "5000123",
"salary" : 1024,
"entityCode" : "AKSAS",
"serviceCode" : "PS",
"skillCode" : "ENG",
"employeeFamily1Code" : "CDI",
"employeeFamily2Code" : "DAY",
"employeeFamily3Code" : "PS-S",
"managerCode" : "CASH"
} ]
}
2.5.42. Update an employee history
POST |
/employees/{employee_id}/history |
Description
Update the employee history matching the specified employee’s\
\ ID and using the list of parameters below.
DMF required:
-
DMF A40102: Api Workforce / Employees / Update
-
DMF 160802: Tools / Resources / Modify
-
DMF 160866: Tools / Resources / Modify Status History
-
DMF 160851: Tools / Resources / Modify Linked Employees
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
employee_id |
Id of an employee |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
employee |
The employee history to update EmployeeHistory |
X |
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
from |
Start date of the search interval |
- |
null |
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Employee history successfully updated |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"id" : "5000123",
"employeeHistoryType" : "5000123",
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 7.42,
"weekHours" : 38.3,
"occupancyRate" : 0.8,
"manager" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"managerId" : "5000123",
"company" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo"
},
"companyId" : "5000123",
"directHourlyRate" : 10.42,
"standardHourlyRate" : 10,
"dailyCost" : 59.36,
"dailySellingPrice" : 80,
"entity" : "5000123",
"serviceRef" : {
"id" : "5000123",
"name" : "Professional services",
"code" : "PS"
},
"service" : "5000123",
"position" : "Developer",
"skillRef" : {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
},
"skill" : "5000123",
"family1" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family1Id" : "5000123",
"family2" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family2Id" : "5000123",
"family3" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family3Id" : "5000123",
"leave" : false,
"standardWeek" : {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
}
},
"standardWeekId" : "5000123",
"salary" : 1024
}
2.5.43. Update an employee history fluently
POST |
/fluent/employees/{employee_code}/history |
Description
Update the employee history fluently matching the specified employee’s ID and using the list of parameters below.
DMF required:
-
DMF A40102: Api Workforce / Employees / Update
-
DMF 160802: Tools / Resources / Modify
-
DMF 160866: Tools / Resources / Modify Status History
-
DMF 160851: Tools / Resources / Modify Linked Employees
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
employee_code |
The employee's code |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
history |
The employee to update EmployeeHistoryFluent |
X |
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
from |
Start date of the search interval |
- |
null |
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Employee history successfully updated |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"id" : "5000123",
"employeeHistoryType" : "5000123",
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 7.42,
"weekHours" : 38.3,
"occupancyRate" : 0.8,
"manager" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"managerId" : "5000123",
"company" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo"
},
"companyId" : "5000123",
"directHourlyRate" : 10.42,
"standardHourlyRate" : 10,
"dailyCost" : 59.36,
"dailySellingPrice" : 80,
"entity" : "5000123",
"serviceRef" : {
"id" : "5000123",
"name" : "Professional services",
"code" : "PS"
},
"service" : "5000123",
"position" : "Developer",
"skillRef" : {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
},
"skill" : "5000123",
"family1" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family1Id" : "5000123",
"family2" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family2Id" : "5000123",
"family3" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family3Id" : "5000123",
"leave" : false,
"standardWeek" : {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
}
},
"standardWeekId" : "5000123",
"salary" : 1024,
"entityCode" : "AKSAS",
"serviceCode" : "PS",
"skillCode" : "ENG",
"employeeFamily1Code" : "CDI",
"employeeFamily2Code" : "DAY",
"employeeFamily3Code" : "PS-S",
"managerCode" : "CASH"
}
2.5.44. Update an employee history with its id
POST |
/employees/{employee_id}/histories/{employee_history_id} |
Description
Update an employee history matching the specified employee’s ID and the specified employee history’s ID.
Updating the end date of the first history is not possible if there are subsequent histories.
Updating the start and end dates of intermediate histories is not feasible.
On a last history, you can update the end date as well as the other fields, but you cannot update the start date.
DMF required:
-
DMF A40152: Api Workforce / Employees / Update Employee History
-
DMF 160802: Tools / Resources / Modify
-
DMF 160826: Tools / Resources / Show Values
-
DMF 160827: Tools / Resources / Modify Values
-
DMF 160857: Tools / Resources / Show Status History Tracking
-
DMF 160859: Tools / Resources / Modify Status History Dates
-
DMF 160860: Tools / Resources / Status History
-
DMF 160866: Tools / Resources / Modify Status History
-
DMF 160868: Tools / Resources / Split Status History
-
DMF 160825: Tools / Resources / Modify Organizational Data
-
DMF 160858: Tools / Resources / Modify Status History Tracking
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
employee_id |
Id of an employee |
X |
null |
|
employee_history_id |
Id of an employee history |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
employeeHistory |
The employee history to update EmployeeHistory |
X |
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Employee history successfully updated |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"id" : "5000123",
"employeeHistoryType" : "5000123",
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 7.42,
"weekHours" : 38.3,
"occupancyRate" : 0.8,
"manager" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"managerId" : "5000123",
"company" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo"
},
"companyId" : "5000123",
"directHourlyRate" : 10.42,
"standardHourlyRate" : 10,
"dailyCost" : 59.36,
"dailySellingPrice" : 80,
"entity" : "5000123",
"serviceRef" : {
"id" : "5000123",
"name" : "Professional services",
"code" : "PS"
},
"service" : "5000123",
"position" : "Developer",
"skillRef" : {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
},
"skill" : "5000123",
"family1" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family1Id" : "5000123",
"family2" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family2Id" : "5000123",
"family3" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family3Id" : "5000123",
"leave" : false,
"standardWeek" : {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
}
},
"standardWeekId" : "5000123",
"salary" : 1024
}
2.5.45. Update the vehicle assigned to an employee
POST |
/employees/{employee_id}/update-vehicle |
Description
Update the vehicle assigned to an employee.
If the vehicle has already been used for mileage expense entries, only the end date can be updated.
The following fields are always required: vehicle power, registration number, and expense type.
The employee cannot be changed, and the same license plate cannot be associated more than once with the same employee.
DMF required:
-
DMF A40150: Api Workforce / Employees / Update Vehicle
-
DMF 160853: Tools / Resources / Modify Taxable Powers
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
employee_id |
Id of an employee |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
vehicle |
The vehicle to update Vehicle |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
The vehicle has been successfully updated to the employee |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"id" : "5000123",
"power" : 5,
"licensePlate" : "licensePlate",
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"expenseType" : {
"id" : "5000123",
"code" : "MEAL",
"description" : "Plane",
"km" : false,
"notRefundable" : true,
"icon" : "fa fa-plane",
"color" : "00ff40",
"receiptRequired" : false,
"commentRequired" : false,
"guestsRequired" : false,
"notRefundableEditable" : true,
"billableEditable" : true,
"amountEditable" : true,
"showQuantity" : false,
"showAdditionalComment" : false,
"showReceiptNumber" : true,
"showAmountCategory" : true,
"showBillable" : true,
"hideVat" : false,
"vat1Code" : "1",
"vat2Code" : "2",
"vat3Code" : "3",
"expenseThreshold" : 100,
"defaultAmount" : 45,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"expenseCategory" : "{}",
"expenseRebillableOptions" : "{}",
"showCustomRequest" : true,
"showAmountWithoutVat" : true,
"controlsBehavior" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"calculateKilometers" : true,
"freeEntryProhibited" : true,
"controls" : {
"enableDuplicate" : true,
"enablelOnNonWorkingDay" : true,
"enableOnDayWithLeaveRequest" : true,
"enableOnDayWithTimesheetOrSchedule" : true
},
"expenseThresholdExceededNoVat" : false
},
"expenseTypeId" : "5000123",
"endDate" : "2020-01-31T23:59:59Z"
}
2.5.46. Upload the avatar of an employee
POST |
/employees/{employee_id}/avatar/upload |
Description
Upload an employee avatar
DMF required:
-
DMF A40143: Api Workforce / Employees / Employee Avatar
-
DMF 160828: Tools / Resources / Modify Photo
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
employee_id |
Id of an employee |
X |
null |
Form Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
document |
The file to upload. [file] |
X |
null |
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
s |
Size in pixels of the image |
- |
null |
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
The avatar has successfully been uploaded |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.5.47. Upsert an employee history
POST |
/employees/{employee_id}/histories/upsert |
Description
Update an employee history matching the specified employee’s ID.
It is possible to change the start date of the first or last history to a lower date.
For the last history, the end date of the previous history will be automatically updated according to this new start date of the last history.
If the modified start date is greater than the existing one, a new situation will be inserted.
On a last history, it is possible to open the situation, close it (i.e. set the end date to blank ) or modify its end date.
DMF required:
-
DMF A40102: Api Workforce / Employees / Update
-
DMF 160802: Tools / Resources / Modify
-
DMF 160866: Tools / Resources / Modify Status History
-
DMF 160851: Tools / Resources / Modify Linked Employees
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
employee_id |
Id of an employee |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
employeeHistory |
The employee history to update EmployeeHistory |
X |
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Employee history successfully updated |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"id" : "5000123",
"employeeHistoryType" : "5000123",
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 7.42,
"weekHours" : 38.3,
"occupancyRate" : 0.8,
"manager" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"managerId" : "5000123",
"company" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo"
},
"companyId" : "5000123",
"directHourlyRate" : 10.42,
"standardHourlyRate" : 10,
"dailyCost" : 59.36,
"dailySellingPrice" : 80,
"entity" : "5000123",
"serviceRef" : {
"id" : "5000123",
"name" : "Professional services",
"code" : "PS"
},
"service" : "5000123",
"position" : "Developer",
"skillRef" : {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
},
"skill" : "5000123",
"family1" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family1Id" : "5000123",
"family2" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family2Id" : "5000123",
"family3" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family3Id" : "5000123",
"leave" : false,
"standardWeek" : {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
}
},
"standardWeekId" : "5000123",
"salary" : 1024
}
2.6. Employees Categories
2.6.1. Create an employees category
PUT |
/employees/categories |
Description
Create an employees category using the list of parameters below.
DMF required:
-
DMF A40112: Api Workforce / Employees / Search Employee Categories
-
DMF 160836: Tools / Resources / Show Types
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
category |
The employees category to create Category |
X |
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
The employees category successfully created |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
}
2.6.2. Delete an employees category
DELETE |
/employees/categories/{employees_category_id} |
Description
Delete an employees category matching the specified ID.
DMF required:
-
DMF A40112: Api Workforce / Employees / Search Employee Categories
-
DMF 160836: Tools / Resources / Show Types
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
employees_category_id |
The id of the employees category |
X |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
The employees category successfully deleted |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.6.3. Get all possible employees categories
GET |
/employees/categories |
Description
Get all employees categories.
DMF required:
-
DMF A40112: Api Workforce / Employees / Search Employee Categories
-
DMF 160836: Tools / Resources / Show Types
Return Type
array[Category]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Employees categories successfully loaded |
List[Category] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.6.4. Search an employees category by its ID
GET |
/employees/categories/{employees_category_id} |
Description
Get the employees category matching the specified ID.
DMF required:
-
DMF A40112: Api Workforce / Employees / Search Employee Categories
-
DMF 160836: Tools / Resources / Show Types
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
employees_category_id |
The id of the employees category |
X |
null |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
The employees category successfully loaded |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.6.5. Search for employees categories (with search criteria)
POST |
/employees/categories/search |
Description
Get the list of employees categories matching the search criteria.
DMF required:
-
DMF A40112: Api Workforce / Employees / Search Employee Categories
-
DMF 160836: Tools / Resources / Show Types
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
criteria |
Criteria that you choose (Code, name, etc…) CategoryCriteria |
X |
Return Type
array[Category]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Employees categories successfully loaded |
List[Category] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"companyId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"code" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"endDate" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
},
"name" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"id" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"tag" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"validity" : {
"type" : "{}",
"date" : "2000-06-21T04:56:07.000+00:00"
},
"type" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"grouping" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
}
}
2.6.6. Update an employees category
POST |
/employees/categories/{employees_category_id} |
Description
Update an employees category using the list of parameters below.
DMF required:
-
DMF A40112: Api Workforce / Employees / Search Employee Categories
-
DMF 160836: Tools / Resources / Show Types
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
employees_category_id |
The id of the employees category |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
category |
The employees category to update Category |
X |
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
The employees category successfully updated |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
}
2.7. Expense Reports
2.7.1. Bill an expense report
POST |
/expense-report/{expense_report_id}/bill |
Description
Bill an expense report matching the specified ID.
DMF required:
-
DMF A40214: Api Workforce / Expenses / Bill
-
DMF 041508: Purchases / Expense Reports / Generate Invoices
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
expense_report_id |
Id of an expense report |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
billing_parameters |
Parameters for the billing ExpenseReportBillingParameters |
X |
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Expense report successfully billed |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"billingDate" : "2020-01-31T23:59:59Z",
"mergeJustificatories" : true,
"invoiceDateWithExpenseCreationDate" : true,
"entityId" : "12",
"paymentDate" : "2020-01-31T23:59:59Z",
"fiscalYearId" : "5000123",
"accountingJournalId" : "5000123"
}
2.7.2. Cancel an expense report completion
POST |
/expense-reports/{expense_report_id}/cancel-completion |
Description
Cancel the completion of the expense report matching the specified ID.
DMF required:
-
DMF A40220: Api Workforce / Expenses / Cancel Completion
-
DMF 041521: Purchases / Expense Reports / Cancel Completion
-
DMF 190506: Web Portal / Expense Reports / Cancel Expense Report Completion
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
expense_report_id |
Id of an expense report |
X |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Expense report completion successfully cancelled |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.7.3. Cancel validation of an expense report
POST |
/expense-report/{expense_report_id}/cancel-validation |
Description
Cancel validation of the expense report matching the specified ID.
If the expense report is validated, after cancelling, the validation the expense report will come back to its previous state, completed or in progress. The expense report could be submitted to update and / or validation again.
If the expense report is refused, after cancelling the validation, the expense report will be a state in progress and submitted again to the employee for change and / or completion. The rejection comment and rejection date are cleared.
DMF required:
-
DMF A40215: Api Workforce / Expenses / Validate
-
DMF 041507: Purchases / Expense Reports / Validate Completed Expense Report
-
DMF 041527: Purchases / Expense Reports / Validate Non-completed Expense Report
-
DMF 041541: Purchases / Expense Reports / Force Validation
-
DMF 190801: Web Portal / Expense Reports Validation / My Team
-
DMF 190802: Web Portal / Expense Reports Validation / My Teams
-
DMF 190803: Web Portal / Expense Reports Validation / History
-
DMF 190805: Web Portal / Expense Reports Validation / Validate Non-completed Expense Report
-
DMF 041520: Purchases / Expense Reports / Cancel Validation
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
expense_report_id |
Id of an expense report |
X |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Validation's Expense report successfully canceled |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.7.4. Check the mileage scale
GET |
/expense-reports/{expense_report_id}/check-mileage-scale |
Description
Check if the mileage scale will change if the expense report is completed.
DMF required:
-
DMF A40222: Api Workforce / Expenses / Check Mileage Scale
-
DMF 041517: Purchases / Expense Reports / Complete
-
DMF 041542: Purchases / Expense Reports / Complete Multiple Expense Reports
-
DMF 190505: Web Portal / Expense Reports / Complete Expense Report
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
expense_report_id |
Id of an expense report |
X |
null |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Mileage scale successfully checked. |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.7.5. Complete an expense report
POST |
/expense-reports/{expense_report_id}/complete |
Description
Complete the expense report matching the specified ID.
DMF required:
-
DMF A40219: Api Workforce / Expenses / Complete
-
DMF 041517: Purchases / Expense Reports / Complete
-
DMF 041542: Purchases / Expense Reports / Complete Multiple Expense Reports
-
DMF 190505: Web Portal / Expense Reports / Complete Expense Report
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
expense_report_id |
Id of an expense report |
X |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Expense report successfully completed |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.7.6. Create an expense
PUT |
/employees/{employee_id}/expense-reports/expenses |
Description
Create an expense using the list of parameters below.
DMF required:
-
DMF A40217: Api Workforce / Expenses / Insert Expense
-
DMF 041501: Purchases / Expense Reports / New
-
DMF 041502: Purchases / Expense Reports / Modify
-
DMF 190501: Web Portal / Expense Reports / Show
-
DMF 190505: Web Portal / Expense Reports / Complete Expense Report
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
employee_id |
Id of an employee |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
expense |
The expense to create Expense |
X |
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Expense successfully created |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"id" : "5000123",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJT_001",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"subPhase" : {
"id" : "5000123",
"code" : "SB_1",
"name" : "Sub Phase 1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"order" : 1
},
"subPhaseId" : "51000122",
"projectTask" : {
"id" : "5000123",
"code" : "code",
"name" : "Team building",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJT_001",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"subPhase" : {
"id" : "5000123",
"code" : "SB_1",
"name" : "Sub Phase 1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"order" : 1
},
"subPhaseId" : "51000122",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"order" : 2,
"startDate" : "2000-06-21T04:56:07.000+00:00",
"endDate" : "2000-06-21T04:56:07.000+00:00",
"description" : "description"
},
"projectTaskId" : "5000123",
"managementObjectId" : "5000123",
"name" : "Helpdesk",
"quantity" : 3,
"unitPriceCurrency" : 36.32,
"unitPrice" : 40,
"amountTotalCurrency" : 1200,
"amountTotal" : 1200,
"rankNumber" : 2,
"action" : "{}",
"complementName" : "Lorem ipsum",
"afterTaxAmountTotalCurrency" : 1500,
"afterTaxAmountTotal" : 1500,
"generalAccount" : "411000",
"totalPriceCurrency" : 1200,
"totalPrice" : 1200,
"additionalFreeFields" : {
"field1" : "Free field",
"field2" : "Free field",
"field3" : "Free field",
"field4" : "Free field",
"field5" : "Free field"
},
"resource" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"resourceId" : "resourceId",
"formConfig" : {
"type" : "{}",
"fields" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"controls" : {
"key" : {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}
},
"insertable" : true,
"editable" : false,
"deletable" : false,
"formSearchHidden" : false
},
"forcedVat" : true,
"vat1" : {
"id" : "5000123",
"code" : "7",
"rate" : 1.4658129805029452
},
"vat2" : {
"id" : "5000123",
"code" : "7",
"rate" : 1.4658129805029452
},
"vatAmount1" : 120,
"vatAmount2" : 110,
"vatAmount1Currency" : 126.57,
"vatAmount2Currency" : 113.26,
"guid" : "12004502",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"expenseType" : {
"id" : "5000123",
"code" : "MEAL",
"description" : "Plane",
"km" : false,
"notRefundable" : true,
"icon" : "fa fa-plane",
"color" : "00ff40",
"receiptRequired" : false,
"commentRequired" : false,
"guestsRequired" : false,
"notRefundableEditable" : true,
"billableEditable" : true,
"amountEditable" : true,
"showQuantity" : false,
"showAdditionalComment" : false,
"showReceiptNumber" : true,
"showAmountCategory" : true,
"showBillable" : true,
"hideVat" : false,
"vat1Code" : "1",
"vat2Code" : "2",
"vat3Code" : "3",
"expenseThreshold" : 100,
"defaultAmount" : 45,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"expenseCategory" : "{}",
"expenseRebillableOptions" : "{}",
"showCustomRequest" : true,
"showAmountWithoutVat" : true,
"controlsBehavior" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"calculateKilometers" : true,
"freeEntryProhibited" : true,
"controls" : {
"enableDuplicate" : true,
"enablelOnNonWorkingDay" : true,
"enableOnDayWithLeaveRequest" : true,
"enableOnDayWithTimesheetOrSchedule" : true
},
"expenseThresholdExceededNoVat" : false
},
"expenseTypeId" : "5000123",
"expenseDate" : "2020-01-31T23:59:59Z",
"rebillable" : true,
"notRefundable" : false,
"numberOfDocuments" : 2,
"syncError" : false,
"receiptNumber" : "AK0001",
"missionNumber" : "AK0001",
"kilometers" : 100,
"refused" : false,
"refusalComment" : "Lorem ipsum",
"refusingEmployee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"refusingEmployeeId" : "5000123",
"expenseReportId" : "5000123",
"dateOfDenial" : "2020-01-31T23:59:59Z",
"afterTaxAmountRefunded" : 12.23,
"afterTaxCurrencyAmountRefunded" : 11.17,
"preTaxAmountRefunded" : 10,
"preTaxCurrencyAmountRefunded" : 8.87,
"employeeAcceptationOfDenial" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeAcceptationOfDenialId" : "5000123",
"dateAcceptationOfDenial" : "2020-01-31T23:59:59Z",
"previousExpenseId" : "5000123",
"dateCancellationOfDenial" : "2020-01-31T23:59:59Z",
"employeeCancellationOfDenial" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeCancellationOfDenialId" : "5000123",
"preTaxExpenseAmount" : 20,
"guests" : [ {
"id" : "5000123",
"expenseId" : "5000123",
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}",
"title" : "GEN",
"phone" : "+33 6 04 04 04 05",
"mobilePhone" : "+33 6 00 00 00 01",
"email" : "myemail@bechmail.com",
"noTimesDunning" : true,
"assignmentMultiCompany" : false,
"modeTimeRecording" : 1,
"modeInputSchedule" : 3,
"timeRecordingInputMode" : "{}",
"scheduleInputMode" : "{}",
"executive" : true,
"generic" : true,
"candidate" : false,
"external" : false,
"managerMultiCompany" : true,
"employeeFunctions" : {
"allFunctions" : false,
"allSales" : true,
"allPurchases" : false,
"allOperational" : true,
"projectSalesManager" : false,
"projectFinanceManager" : true,
"projectProductionManager" : false,
"projectAccountManager" : true,
"projectAssignment" : false,
"projectPhaseManager" : true,
"projectSendOnMission" : false,
"salesSalesAssistant" : true,
"salesOrderAndEstimateTracking" : false,
"salesBillingSchedulesTracking" : true,
"purchasingBuyer" : false,
"timeRecording" : true,
"inputOfExpenseReport" : false,
"purchasesReceptionTracking" : false,
"inputSchedule" : false,
"CMMSContractSalesManager" : false,
"CMMSContractTechnicalManager" : false,
"CMMSMRAndEOManager" : false
},
"employeeHistory" : [ {
"id" : "5000123",
"employeeHistoryType" : "5000123",
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 7.42,
"weekHours" : 38.3,
"occupancyRate" : 0.8,
"manager" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"managerId" : "5000123",
"company" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo"
},
"companyId" : "5000123",
"directHourlyRate" : 10.42,
"standardHourlyRate" : 10,
"dailyCost" : 59.36,
"dailySellingPrice" : 80,
"entity" : "5000123",
"serviceRef" : {
"id" : "5000123",
"name" : "Professional services",
"code" : "PS"
},
"service" : "5000123",
"position" : "Developer",
"skillRef" : {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
},
"skill" : "5000123",
"family1" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family1Id" : "5000123",
"family2" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family2Id" : "5000123",
"family3" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family3Id" : "5000123",
"leave" : false,
"standardWeek" : {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
}
},
"standardWeekId" : "5000123",
"salary" : 1024
}, {
"id" : "5000123",
"employeeHistoryType" : "5000123",
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 7.42,
"weekHours" : 38.3,
"occupancyRate" : 0.8,
"manager" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"managerId" : "5000123",
"company" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo"
},
"companyId" : "5000123",
"directHourlyRate" : 10.42,
"standardHourlyRate" : 10,
"dailyCost" : 59.36,
"dailySellingPrice" : 80,
"entity" : "5000123",
"serviceRef" : {
"id" : "5000123",
"name" : "Professional services",
"code" : "PS"
},
"service" : "5000123",
"position" : "Developer",
"skillRef" : {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
},
"skill" : "5000123",
"family1" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family1Id" : "5000123",
"family2" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family2Id" : "5000123",
"family3" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family3Id" : "5000123",
"leave" : false,
"standardWeek" : {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
}
},
"standardWeekId" : "5000123",
"salary" : 1024
} ],
"companyChanges" : [ {
"id" : "5000123",
"employeeId" : "500123",
"companyId" : "5000123",
"startDate" : "2020-01-23T04:56:07Z",
"endDate" : "2020-01-23T04:56:07Z",
"companyChangeState" : "{}",
"comment" : "Limpso usum"
}, {
"id" : "5000123",
"employeeId" : "500123",
"companyId" : "5000123",
"startDate" : "2020-01-23T04:56:07Z",
"endDate" : "2020-01-23T04:56:07Z",
"companyChangeState" : "{}",
"comment" : "Limpso usum"
} ],
"timeRecordingRules" : {
"id" : "5000123",
"employeeId" : "5000123",
"min" : 0,
"max" : 24,
"step" : 0.01,
"prettyStep" : 0.3,
"base" : 60,
"unit" : "H",
"unitDuration" : "{}",
"allowManualEntry" : true,
"employeeWeeks" : [ {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
},
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 8,
"dailyMinutes" : 10,
"weekHours" : 40,
"leave" : false
}, {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
},
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 8,
"dailyMinutes" : 10,
"weekHours" : 40,
"leave" : false
} ],
"closingDates" : [ {
"closingDate" : "2020-01-31T23:59:59Z",
"module" : "DATE_MODULE",
"beginningOfPeriod" : "2020-01-31T23:59:59Z",
"endOfPeriod" : "2020-01-31T23:59:59Z"
}, {
"closingDate" : "2020-01-31T23:59:59Z",
"module" : "DATE_MODULE",
"beginningOfPeriod" : "2020-01-31T23:59:59Z",
"endOfPeriod" : "2020-01-31T23:59:59Z"
} ],
"simpleDuration" : 750,
"completionMode" : "WEEKLY"
},
"scheduleRules" : {
"id" : "5000123",
"employeeId" : "5000123",
"min" : 0,
"max" : 24,
"step" : 0.01,
"prettyStep" : 0.3,
"base" : 60,
"unit" : "H",
"unitDuration" : "{}",
"allowManualEntry" : true,
"employeeWeeks" : [ {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
},
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 8,
"dailyMinutes" : 10,
"weekHours" : 40,
"leave" : false
}, {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
},
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 8,
"dailyMinutes" : 10,
"weekHours" : 40,
"leave" : false
} ],
"closingDates" : [ {
"closingDate" : "2020-01-31T23:59:59Z",
"module" : "DATE_MODULE",
"beginningOfPeriod" : "2020-01-31T23:59:59Z",
"endOfPeriod" : "2020-01-31T23:59:59Z"
}, {
"closingDate" : "2020-01-31T23:59:59Z",
"module" : "DATE_MODULE",
"beginningOfPeriod" : "2020-01-31T23:59:59Z",
"endOfPeriod" : "2020-01-31T23:59:59Z"
} ],
"timestamped" : true
},
"businessCards" : [ {
"id" : "5000123",
"employeeId" : "5000123",
"cardNumber" : "XXXX XXXX XXXX 7568",
"encryptedCardNumber" : "0",
"name" : "Management card",
"type" : "{}",
"endDate" : "2020-01-31T23:59:59Z"
}, {
"id" : "5000123",
"employeeId" : "5000123",
"cardNumber" : "XXXX XXXX XXXX 7568",
"encryptedCardNumber" : "0",
"name" : "Management card",
"type" : "{}",
"endDate" : "2020-01-31T23:59:59Z"
} ],
"sector" : "Marketing",
"number" : "84",
"relations" : [ {
"id" : "5000123",
"relationType" : {
"id" : "5000123",
"code" : "TUTOR",
"name" : "Tutor for internship"
},
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"relatedEmployee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"relatedEmployeeId" : "5000123"
}, {
"id" : "5000123",
"relationType" : {
"id" : "5000123",
"code" : "TUTOR",
"name" : "Tutor for internship"
},
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"relatedEmployee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"relatedEmployeeId" : "5000123"
} ],
"employeeAbilities" : [ {
"id" : "5000123",
"skill" : {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
},
"level" : {
"id" : "5000123",
"code" : "EXP",
"name" : "Expert"
},
"startDate" : "2020-01-31T23:59:59Z",
"endDate" : "2020-01-31T23:59:59Z",
"employeeId" : "5000123"
}, {
"id" : "5000123",
"skill" : {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
},
"level" : {
"id" : "5000123",
"code" : "EXP",
"name" : "Expert"
},
"startDate" : "2020-01-31T23:59:59Z",
"endDate" : "2020-01-31T23:59:59Z",
"employeeId" : "5000123"
} ],
"jobType" : {
"id" : "5000123",
"companyCode" : "AKSAS",
"code" : "ADMIN",
"name" : "Administrator",
"category" : "{}",
"validity" : {
"type" : "{}",
"date" : "2000-06-21T04:56:07.000+00:00"
},
"default" : true
},
"jobTypeId" : "100245",
"address" : {
"id" : "id",
"line1" : "221B Baker Street",
"line2" : "2nd Floor",
"line3" : "First door at your right",
"cedex" : "CEDEX 14",
"postalCode" : "69002",
"city" : "London",
"country" : "FR (for 'FRANCE')",
"countryName" : "FRANCE",
"department" : "75 (for 'PARIS')",
"geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
"region" : "65 (for 'ILE DE FRANCE')",
"regionName" : "ILE DE FRANCE",
"phone" : "06 00 00 00 01",
"phone2" : "06 00 00 00 02",
"email" : "myemail@mail.com",
"mobilePhone" : "06 00 00 00 02",
"fax" : "04 00 00 00 07",
"webSite" : "mysite.com"
},
"addressId" : "5000123",
"birthDate" : "2000-06-21T04:56:07.000+00:00",
"customData" : {
"key" : {
"type" : "{}",
"value" : "Autoref 010520",
"name" : "Reference 4",
"realOrder" : 0,
"label" : "REFERENCE_4"
}
},
"color" : "#FF0000",
"targetTace" : 75,
"formConfig" : {
"type" : "{}",
"fields" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"controls" : {
"key" : {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}
},
"insertable" : true,
"editable" : false,
"deletable" : false,
"formSearchHidden" : false
},
"changeTracking" : {
"createdTime" : "2000-06-21T04:56:07.000+00:00",
"createdBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"createdById" : "5000123",
"modificationTime" : "2000-06-21T04:56:07.000+00:00",
"modificationBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"modificationById" : "5000123"
},
"vehicles" : [ {
"id" : "5000123",
"power" : 5,
"licensePlate" : "licensePlate",
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"expenseType" : {
"id" : "5000123",
"code" : "MEAL",
"description" : "Plane",
"km" : false,
"notRefundable" : true,
"icon" : "fa fa-plane",
"color" : "00ff40",
"receiptRequired" : false,
"commentRequired" : false,
"guestsRequired" : false,
"notRefundableEditable" : true,
"billableEditable" : true,
"amountEditable" : true,
"showQuantity" : false,
"showAdditionalComment" : false,
"showReceiptNumber" : true,
"showAmountCategory" : true,
"showBillable" : true,
"hideVat" : false,
"vat1Code" : "1",
"vat2Code" : "2",
"vat3Code" : "3",
"expenseThreshold" : 100,
"defaultAmount" : 45,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"expenseCategory" : "{}",
"expenseRebillableOptions" : "{}",
"showCustomRequest" : true,
"showAmountWithoutVat" : true,
"controlsBehavior" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"calculateKilometers" : true,
"freeEntryProhibited" : true,
"controls" : {
"enableDuplicate" : true,
"enablelOnNonWorkingDay" : true,
"enableOnDayWithLeaveRequest" : true,
"enableOnDayWithTimesheetOrSchedule" : true
},
"expenseThresholdExceededNoVat" : false
},
"expenseTypeId" : "5000123",
"endDate" : "2020-01-31T23:59:59Z"
}, {
"id" : "5000123",
"power" : 5,
"licensePlate" : "licensePlate",
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"expenseType" : {
"id" : "5000123",
"code" : "MEAL",
"description" : "Plane",
"km" : false,
"notRefundable" : true,
"icon" : "fa fa-plane",
"color" : "00ff40",
"receiptRequired" : false,
"commentRequired" : false,
"guestsRequired" : false,
"notRefundableEditable" : true,
"billableEditable" : true,
"amountEditable" : true,
"showQuantity" : false,
"showAdditionalComment" : false,
"showReceiptNumber" : true,
"showAmountCategory" : true,
"showBillable" : true,
"hideVat" : false,
"vat1Code" : "1",
"vat2Code" : "2",
"vat3Code" : "3",
"expenseThreshold" : 100,
"defaultAmount" : 45,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"expenseCategory" : "{}",
"expenseRebillableOptions" : "{}",
"showCustomRequest" : true,
"showAmountWithoutVat" : true,
"controlsBehavior" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"calculateKilometers" : true,
"freeEntryProhibited" : true,
"controls" : {
"enableDuplicate" : true,
"enablelOnNonWorkingDay" : true,
"enableOnDayWithLeaveRequest" : true,
"enableOnDayWithTimesheetOrSchedule" : true
},
"expenseThresholdExceededNoVat" : false
},
"expenseTypeId" : "5000123",
"endDate" : "2020-01-31T23:59:59Z"
} ],
"currentCompany" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo",
"legalName" : "legalName",
"siren" : "siren",
"siret" : "siret",
"calendar" : {
"id" : "5000123",
"code" : "Text",
"name" : "Text",
"default" : true,
"daysNotWorked" : [ 6, 6 ],
"holidays" : [ {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
}, {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
} ]
},
"calendarId" : "calendarId",
"color" : "color",
"currency" : {
"id" : "5000123",
"name" : "Euro",
"code" : "EUR",
"order" : 17,
"euro" : true,
"euroRate" : 0.9678,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"euroRateStartDate" : "2020-01-23T04:56:07Z",
"euroRateEndDate" : "2020-01-23T04:56:07Z"
},
"currencyId" : "currencyId",
"address" : {
"id" : "id",
"line1" : "221B Baker Street",
"line2" : "2nd Floor",
"line3" : "First door at your right",
"cedex" : "CEDEX 14",
"postalCode" : "69002",
"city" : "London",
"country" : "FR (for 'FRANCE')",
"countryName" : "FRANCE",
"department" : "75 (for 'PARIS')",
"geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
"region" : "65 (for 'ILE DE FRANCE')",
"regionName" : "ILE DE FRANCE",
"phone" : "06 00 00 00 01",
"phone2" : "06 00 00 00 02",
"email" : "myemail@mail.com",
"mobilePhone" : "06 00 00 00 02",
"fax" : "04 00 00 00 07",
"webSite" : "mysite.com"
},
"addressId" : "addressId"
},
"currentCompanyId" : "5000123",
"bankingInformation" : {
"id" : "5000123",
"sepa" : {
"bankDetails" : {
"entity" : "30002",
"counter" : "550",
"accountNumber" : "0000157841Z",
"key" : "25",
"domiciliation" : "AURA"
},
"bic" : {
"country" : "FR (for 'FRANCE')",
"bank" : "DAAE",
"location" : "PP",
"branch" : "CCT"
},
"iban" : {
"country" : "FR (for 'FRANCE')",
"key" : "69",
"accountNumber" : "0000157841Z"
}
},
"noneSepa" : {
"defaultBankDetail" : false,
"beneficiary" : {
"holder" : {
"name" : "RITA",
"firstName" : "BRITA",
"accountType" : "{}",
"accountNumber" : "123456789"
},
"bank" : {
"bankName" : "UBA",
"bankName2" : "UBA",
"bankType" : "{}",
"bankCode" : "C8",
"bankAddress" : {
"id" : "id",
"line1" : "221B Baker Street",
"line2" : "2nd Floor",
"line3" : "First door at your right",
"cedex" : "CEDEX 14",
"postalCode" : "69002",
"city" : "London",
"country" : "FR (for 'FRANCE')",
"countryName" : "FRANCE",
"department" : "75 (for 'PARIS')",
"geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
"region" : "65 (for 'ILE DE FRANCE')",
"regionName" : "ILE DE FRANCE",
"phone" : "06 00 00 00 01",
"phone2" : "06 00 00 00 02",
"email" : "myemail@mail.com",
"mobilePhone" : "06 00 00 00 02",
"fax" : "04 00 00 00 07",
"webSite" : "mysite.com"
}
}
},
"intermediate" : {
"holder" : {
"name" : "RITA",
"firstName" : "BRITA",
"accountType" : "{}",
"accountNumber" : "123456789"
},
"bank" : {
"bankName" : "UBA",
"bankName2" : "UBA",
"bankType" : "{}",
"bankCode" : "C8",
"bankAddress" : {
"id" : "id",
"line1" : "221B Baker Street",
"line2" : "2nd Floor",
"line3" : "First door at your right",
"cedex" : "CEDEX 14",
"postalCode" : "69002",
"city" : "London",
"country" : "FR (for 'FRANCE')",
"countryName" : "FRANCE",
"department" : "75 (for 'PARIS')",
"geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
"region" : "65 (for 'ILE DE FRANCE')",
"regionName" : "ILE DE FRANCE",
"phone" : "06 00 00 00 01",
"phone2" : "06 00 00 00 02",
"email" : "myemail@mail.com",
"mobilePhone" : "06 00 00 00 02",
"fax" : "04 00 00 00 07",
"webSite" : "mysite.com"
}
}
}
},
"statusChangeDate" : "2000-06-21T04:56:07.000+00:00",
"statusChangeArgument" : {
"comment" : "Comment",
"status" : "{}"
},
"validator" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"validatorId" : "5000123",
"action" : "{}",
"type" : "{}"
},
"faxNumber" : "418 643 3210",
"phoneExtensionNumber" : "04 00 00 00 07"
},
"employeeId" : "5000123",
"lastName" : "DOE",
"firstName" : "John",
"company" : "AKSAS"
}, {
"id" : "5000123",
"expenseId" : "5000123",
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}",
"title" : "GEN",
"phone" : "+33 6 04 04 04 05",
"mobilePhone" : "+33 6 00 00 00 01",
"email" : "myemail@bechmail.com",
"noTimesDunning" : true,
"assignmentMultiCompany" : false,
"modeTimeRecording" : 1,
"modeInputSchedule" : 3,
"timeRecordingInputMode" : "{}",
"scheduleInputMode" : "{}",
"executive" : true,
"generic" : true,
"candidate" : false,
"external" : false,
"managerMultiCompany" : true,
"employeeFunctions" : {
"allFunctions" : false,
"allSales" : true,
"allPurchases" : false,
"allOperational" : true,
"projectSalesManager" : false,
"projectFinanceManager" : true,
"projectProductionManager" : false,
"projectAccountManager" : true,
"projectAssignment" : false,
"projectPhaseManager" : true,
"projectSendOnMission" : false,
"salesSalesAssistant" : true,
"salesOrderAndEstimateTracking" : false,
"salesBillingSchedulesTracking" : true,
"purchasingBuyer" : false,
"timeRecording" : true,
"inputOfExpenseReport" : false,
"purchasesReceptionTracking" : false,
"inputSchedule" : false,
"CMMSContractSalesManager" : false,
"CMMSContractTechnicalManager" : false,
"CMMSMRAndEOManager" : false
},
"employeeHistory" : [ {
"id" : "5000123",
"employeeHistoryType" : "5000123",
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 7.42,
"weekHours" : 38.3,
"occupancyRate" : 0.8,
"manager" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"managerId" : "5000123",
"company" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo"
},
"companyId" : "5000123",
"directHourlyRate" : 10.42,
"standardHourlyRate" : 10,
"dailyCost" : 59.36,
"dailySellingPrice" : 80,
"entity" : "5000123",
"serviceRef" : {
"id" : "5000123",
"name" : "Professional services",
"code" : "PS"
},
"service" : "5000123",
"position" : "Developer",
"skillRef" : {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
},
"skill" : "5000123",
"family1" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family1Id" : "5000123",
"family2" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family2Id" : "5000123",
"family3" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family3Id" : "5000123",
"leave" : false,
"standardWeek" : {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
}
},
"standardWeekId" : "5000123",
"salary" : 1024
}, {
"id" : "5000123",
"employeeHistoryType" : "5000123",
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 7.42,
"weekHours" : 38.3,
"occupancyRate" : 0.8,
"manager" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"managerId" : "5000123",
"company" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo"
},
"companyId" : "5000123",
"directHourlyRate" : 10.42,
"standardHourlyRate" : 10,
"dailyCost" : 59.36,
"dailySellingPrice" : 80,
"entity" : "5000123",
"serviceRef" : {
"id" : "5000123",
"name" : "Professional services",
"code" : "PS"
},
"service" : "5000123",
"position" : "Developer",
"skillRef" : {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
},
"skill" : "5000123",
"family1" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family1Id" : "5000123",
"family2" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family2Id" : "5000123",
"family3" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family3Id" : "5000123",
"leave" : false,
"standardWeek" : {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
}
},
"standardWeekId" : "5000123",
"salary" : 1024
} ],
"companyChanges" : [ {
"id" : "5000123",
"employeeId" : "500123",
"companyId" : "5000123",
"startDate" : "2020-01-23T04:56:07Z",
"endDate" : "2020-01-23T04:56:07Z",
"companyChangeState" : "{}",
"comment" : "Limpso usum"
}, {
"id" : "5000123",
"employeeId" : "500123",
"companyId" : "5000123",
"startDate" : "2020-01-23T04:56:07Z",
"endDate" : "2020-01-23T04:56:07Z",
"companyChangeState" : "{}",
"comment" : "Limpso usum"
} ],
"timeRecordingRules" : {
"id" : "5000123",
"employeeId" : "5000123",
"min" : 0,
"max" : 24,
"step" : 0.01,
"prettyStep" : 0.3,
"base" : 60,
"unit" : "H",
"unitDuration" : "{}",
"allowManualEntry" : true,
"employeeWeeks" : [ {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
},
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 8,
"dailyMinutes" : 10,
"weekHours" : 40,
"leave" : false
}, {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
},
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 8,
"dailyMinutes" : 10,
"weekHours" : 40,
"leave" : false
} ],
"closingDates" : [ {
"closingDate" : "2020-01-31T23:59:59Z",
"module" : "DATE_MODULE",
"beginningOfPeriod" : "2020-01-31T23:59:59Z",
"endOfPeriod" : "2020-01-31T23:59:59Z"
}, {
"closingDate" : "2020-01-31T23:59:59Z",
"module" : "DATE_MODULE",
"beginningOfPeriod" : "2020-01-31T23:59:59Z",
"endOfPeriod" : "2020-01-31T23:59:59Z"
} ],
"simpleDuration" : 750,
"completionMode" : "WEEKLY"
},
"scheduleRules" : {
"id" : "5000123",
"employeeId" : "5000123",
"min" : 0,
"max" : 24,
"step" : 0.01,
"prettyStep" : 0.3,
"base" : 60,
"unit" : "H",
"unitDuration" : "{}",
"allowManualEntry" : true,
"employeeWeeks" : [ {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
},
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 8,
"dailyMinutes" : 10,
"weekHours" : 40,
"leave" : false
}, {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
},
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 8,
"dailyMinutes" : 10,
"weekHours" : 40,
"leave" : false
} ],
"closingDates" : [ {
"closingDate" : "2020-01-31T23:59:59Z",
"module" : "DATE_MODULE",
"beginningOfPeriod" : "2020-01-31T23:59:59Z",
"endOfPeriod" : "2020-01-31T23:59:59Z"
}, {
"closingDate" : "2020-01-31T23:59:59Z",
"module" : "DATE_MODULE",
"beginningOfPeriod" : "2020-01-31T23:59:59Z",
"endOfPeriod" : "2020-01-31T23:59:59Z"
} ],
"timestamped" : true
},
"businessCards" : [ {
"id" : "5000123",
"employeeId" : "5000123",
"cardNumber" : "XXXX XXXX XXXX 7568",
"encryptedCardNumber" : "0",
"name" : "Management card",
"type" : "{}",
"endDate" : "2020-01-31T23:59:59Z"
}, {
"id" : "5000123",
"employeeId" : "5000123",
"cardNumber" : "XXXX XXXX XXXX 7568",
"encryptedCardNumber" : "0",
"name" : "Management card",
"type" : "{}",
"endDate" : "2020-01-31T23:59:59Z"
} ],
"sector" : "Marketing",
"number" : "84",
"relations" : [ {
"id" : "5000123",
"relationType" : {
"id" : "5000123",
"code" : "TUTOR",
"name" : "Tutor for internship"
},
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"relatedEmployee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"relatedEmployeeId" : "5000123"
}, {
"id" : "5000123",
"relationType" : {
"id" : "5000123",
"code" : "TUTOR",
"name" : "Tutor for internship"
},
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"relatedEmployee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"relatedEmployeeId" : "5000123"
} ],
"employeeAbilities" : [ {
"id" : "5000123",
"skill" : {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
},
"level" : {
"id" : "5000123",
"code" : "EXP",
"name" : "Expert"
},
"startDate" : "2020-01-31T23:59:59Z",
"endDate" : "2020-01-31T23:59:59Z",
"employeeId" : "5000123"
}, {
"id" : "5000123",
"skill" : {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
},
"level" : {
"id" : "5000123",
"code" : "EXP",
"name" : "Expert"
},
"startDate" : "2020-01-31T23:59:59Z",
"endDate" : "2020-01-31T23:59:59Z",
"employeeId" : "5000123"
} ],
"jobType" : {
"id" : "5000123",
"companyCode" : "AKSAS",
"code" : "ADMIN",
"name" : "Administrator",
"category" : "{}",
"validity" : {
"type" : "{}",
"date" : "2000-06-21T04:56:07.000+00:00"
},
"default" : true
},
"jobTypeId" : "100245",
"address" : {
"id" : "id",
"line1" : "221B Baker Street",
"line2" : "2nd Floor",
"line3" : "First door at your right",
"cedex" : "CEDEX 14",
"postalCode" : "69002",
"city" : "London",
"country" : "FR (for 'FRANCE')",
"countryName" : "FRANCE",
"department" : "75 (for 'PARIS')",
"geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
"region" : "65 (for 'ILE DE FRANCE')",
"regionName" : "ILE DE FRANCE",
"phone" : "06 00 00 00 01",
"phone2" : "06 00 00 00 02",
"email" : "myemail@mail.com",
"mobilePhone" : "06 00 00 00 02",
"fax" : "04 00 00 00 07",
"webSite" : "mysite.com"
},
"addressId" : "5000123",
"birthDate" : "2000-06-21T04:56:07.000+00:00",
"customData" : {
"key" : {
"type" : "{}",
"value" : "Autoref 010520",
"name" : "Reference 4",
"realOrder" : 0,
"label" : "REFERENCE_4"
}
},
"color" : "#FF0000",
"targetTace" : 75,
"formConfig" : {
"type" : "{}",
"fields" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"controls" : {
"key" : {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}
},
"insertable" : true,
"editable" : false,
"deletable" : false,
"formSearchHidden" : false
},
"changeTracking" : {
"createdTime" : "2000-06-21T04:56:07.000+00:00",
"createdBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"createdById" : "5000123",
"modificationTime" : "2000-06-21T04:56:07.000+00:00",
"modificationBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"modificationById" : "5000123"
},
"vehicles" : [ {
"id" : "5000123",
"power" : 5,
"licensePlate" : "licensePlate",
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"expenseType" : {
"id" : "5000123",
"code" : "MEAL",
"description" : "Plane",
"km" : false,
"notRefundable" : true,
"icon" : "fa fa-plane",
"color" : "00ff40",
"receiptRequired" : false,
"commentRequired" : false,
"guestsRequired" : false,
"notRefundableEditable" : true,
"billableEditable" : true,
"amountEditable" : true,
"showQuantity" : false,
"showAdditionalComment" : false,
"showReceiptNumber" : true,
"showAmountCategory" : true,
"showBillable" : true,
"hideVat" : false,
"vat1Code" : "1",
"vat2Code" : "2",
"vat3Code" : "3",
"expenseThreshold" : 100,
"defaultAmount" : 45,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"expenseCategory" : "{}",
"expenseRebillableOptions" : "{}",
"showCustomRequest" : true,
"showAmountWithoutVat" : true,
"controlsBehavior" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"calculateKilometers" : true,
"freeEntryProhibited" : true,
"controls" : {
"enableDuplicate" : true,
"enablelOnNonWorkingDay" : true,
"enableOnDayWithLeaveRequest" : true,
"enableOnDayWithTimesheetOrSchedule" : true
},
"expenseThresholdExceededNoVat" : false
},
"expenseTypeId" : "5000123",
"endDate" : "2020-01-31T23:59:59Z"
}, {
"id" : "5000123",
"power" : 5,
"licensePlate" : "licensePlate",
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"expenseType" : {
"id" : "5000123",
"code" : "MEAL",
"description" : "Plane",
"km" : false,
"notRefundable" : true,
"icon" : "fa fa-plane",
"color" : "00ff40",
"receiptRequired" : false,
"commentRequired" : false,
"guestsRequired" : false,
"notRefundableEditable" : true,
"billableEditable" : true,
"amountEditable" : true,
"showQuantity" : false,
"showAdditionalComment" : false,
"showReceiptNumber" : true,
"showAmountCategory" : true,
"showBillable" : true,
"hideVat" : false,
"vat1Code" : "1",
"vat2Code" : "2",
"vat3Code" : "3",
"expenseThreshold" : 100,
"defaultAmount" : 45,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"expenseCategory" : "{}",
"expenseRebillableOptions" : "{}",
"showCustomRequest" : true,
"showAmountWithoutVat" : true,
"controlsBehavior" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"calculateKilometers" : true,
"freeEntryProhibited" : true,
"controls" : {
"enableDuplicate" : true,
"enablelOnNonWorkingDay" : true,
"enableOnDayWithLeaveRequest" : true,
"enableOnDayWithTimesheetOrSchedule" : true
},
"expenseThresholdExceededNoVat" : false
},
"expenseTypeId" : "5000123",
"endDate" : "2020-01-31T23:59:59Z"
} ],
"currentCompany" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo",
"legalName" : "legalName",
"siren" : "siren",
"siret" : "siret",
"calendar" : {
"id" : "5000123",
"code" : "Text",
"name" : "Text",
"default" : true,
"daysNotWorked" : [ 6, 6 ],
"holidays" : [ {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
}, {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
} ]
},
"calendarId" : "calendarId",
"color" : "color",
"currency" : {
"id" : "5000123",
"name" : "Euro",
"code" : "EUR",
"order" : 17,
"euro" : true,
"euroRate" : 0.9678,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"euroRateStartDate" : "2020-01-23T04:56:07Z",
"euroRateEndDate" : "2020-01-23T04:56:07Z"
},
"currencyId" : "currencyId",
"address" : {
"id" : "id",
"line1" : "221B Baker Street",
"line2" : "2nd Floor",
"line3" : "First door at your right",
"cedex" : "CEDEX 14",
"postalCode" : "69002",
"city" : "London",
"country" : "FR (for 'FRANCE')",
"countryName" : "FRANCE",
"department" : "75 (for 'PARIS')",
"geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
"region" : "65 (for 'ILE DE FRANCE')",
"regionName" : "ILE DE FRANCE",
"phone" : "06 00 00 00 01",
"phone2" : "06 00 00 00 02",
"email" : "myemail@mail.com",
"mobilePhone" : "06 00 00 00 02",
"fax" : "04 00 00 00 07",
"webSite" : "mysite.com"
},
"addressId" : "addressId"
},
"currentCompanyId" : "5000123",
"bankingInformation" : {
"id" : "5000123",
"sepa" : {
"bankDetails" : {
"entity" : "30002",
"counter" : "550",
"accountNumber" : "0000157841Z",
"key" : "25",
"domiciliation" : "AURA"
},
"bic" : {
"country" : "FR (for 'FRANCE')",
"bank" : "DAAE",
"location" : "PP",
"branch" : "CCT"
},
"iban" : {
"country" : "FR (for 'FRANCE')",
"key" : "69",
"accountNumber" : "0000157841Z"
}
},
"noneSepa" : {
"defaultBankDetail" : false,
"beneficiary" : {
"holder" : {
"name" : "RITA",
"firstName" : "BRITA",
"accountType" : "{}",
"accountNumber" : "123456789"
},
"bank" : {
"bankName" : "UBA",
"bankName2" : "UBA",
"bankType" : "{}",
"bankCode" : "C8",
"bankAddress" : {
"id" : "id",
"line1" : "221B Baker Street",
"line2" : "2nd Floor",
"line3" : "First door at your right",
"cedex" : "CEDEX 14",
"postalCode" : "69002",
"city" : "London",
"country" : "FR (for 'FRANCE')",
"countryName" : "FRANCE",
"department" : "75 (for 'PARIS')",
"geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
"region" : "65 (for 'ILE DE FRANCE')",
"regionName" : "ILE DE FRANCE",
"phone" : "06 00 00 00 01",
"phone2" : "06 00 00 00 02",
"email" : "myemail@mail.com",
"mobilePhone" : "06 00 00 00 02",
"fax" : "04 00 00 00 07",
"webSite" : "mysite.com"
}
}
},
"intermediate" : {
"holder" : {
"name" : "RITA",
"firstName" : "BRITA",
"accountType" : "{}",
"accountNumber" : "123456789"
},
"bank" : {
"bankName" : "UBA",
"bankName2" : "UBA",
"bankType" : "{}",
"bankCode" : "C8",
"bankAddress" : {
"id" : "id",
"line1" : "221B Baker Street",
"line2" : "2nd Floor",
"line3" : "First door at your right",
"cedex" : "CEDEX 14",
"postalCode" : "69002",
"city" : "London",
"country" : "FR (for 'FRANCE')",
"countryName" : "FRANCE",
"department" : "75 (for 'PARIS')",
"geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
"region" : "65 (for 'ILE DE FRANCE')",
"regionName" : "ILE DE FRANCE",
"phone" : "06 00 00 00 01",
"phone2" : "06 00 00 00 02",
"email" : "myemail@mail.com",
"mobilePhone" : "06 00 00 00 02",
"fax" : "04 00 00 00 07",
"webSite" : "mysite.com"
}
}
}
},
"statusChangeDate" : "2000-06-21T04:56:07.000+00:00",
"statusChangeArgument" : {
"comment" : "Comment",
"status" : "{}"
},
"validator" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"validatorId" : "5000123",
"action" : "{}",
"type" : "{}"
},
"faxNumber" : "418 643 3210",
"phoneExtensionNumber" : "04 00 00 00 07"
},
"employeeId" : "5000123",
"lastName" : "DOE",
"firstName" : "John",
"company" : "AKSAS"
} ],
"fiscalPower" : {
"id" : "5000123",
"power" : 5,
"rate" : 0.36,
"startDate" : "2020-01-31T23:59:59Z",
"endDate" : "2020-01-31T23:59:59Z",
"expenseTypeId" : "5000123"
},
"currency" : {
"id" : "5000123",
"name" : "Euro",
"code" : "EUR",
"order" : 17,
"euro" : true,
"euroRate" : 0.9678,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"euroRateStartDate" : "2020-01-23T04:56:07Z",
"euroRateEndDate" : "2020-01-23T04:56:07Z"
},
"currencyCode" : "EUR",
"parts" : 2,
"amountCategory" : "{}",
"alerts" : [ {
"message" : "Lorem ipsum",
"level" : "ERROR"
}, {
"message" : "Lorem ipsum",
"level" : "ERROR"
} ],
"customAssignment" : "CST_PROJECT",
"businessCard" : true,
"documents" : [ {
"id" : "5000123",
"title" : "Title",
"versionId" : "5000123",
"changeTracking" : {
"createdTime" : "2000-06-21T04:56:07.000+00:00",
"createdBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"createdById" : "5000123",
"modificationTime" : "2000-06-21T04:56:07.000+00:00",
"modificationBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"modificationById" : "5000123"
},
"publishedBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"publishedById" : "5001206",
"classification" : "STD",
"subClassification" : "EDITIONS",
"category1" : "CAT1",
"category2" : "CAT2",
"category3" : "CAT3",
"companyId" : "5000123",
"publicationDate" : "2000-06-21T04:56:07.000+00:00",
"version" : 1,
"documentType" : "File",
"fileUrl" : "myFiles/thisFile.pdf",
"fileName" : "thisFile.pdf",
"lienUrl" : "myStorage.com/myFiles/thisFile.pdf",
"url" : "myFiles/thisFile.pdf",
"original" : false,
"preview" : "data:image",
"tokenPreview" : "8946A85V85D851DF",
"externalDMSUuid" : "OD1245126",
"links" : [ {
"id" : "5000123",
"original" : true,
"documentId" : "5000123",
"objectId" : "5000123",
"objectType" : "{}"
}, {
"id" : "5000123",
"original" : true,
"documentId" : "5000123",
"objectId" : "5000123",
"objectType" : "{}"
} ],
"archived" : false,
"action" : "{}",
"owner" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"ownerId" : "5001206",
"description" : "Text",
"category" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"categoryId" : "100024",
"subCategory" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"company" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo",
"legalName" : "legalName",
"siren" : "siren",
"siret" : "siret",
"calendar" : {
"id" : "5000123",
"code" : "Text",
"name" : "Text",
"default" : true,
"daysNotWorked" : [ 6, 6 ],
"holidays" : [ {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
}, {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
} ]
},
"calendarId" : "calendarId",
"color" : "color",
"currency" : {
"id" : "5000123",
"name" : "Euro",
"code" : "EUR",
"order" : 17,
"euro" : true,
"euroRate" : 0.9678,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"euroRateStartDate" : "2020-01-23T04:56:07Z",
"euroRateEndDate" : "2020-01-23T04:56:07Z"
},
"currencyId" : "currencyId",
"address" : {
"id" : "id",
"line1" : "221B Baker Street",
"line2" : "2nd Floor",
"line3" : "First door at your right",
"cedex" : "CEDEX 14",
"postalCode" : "69002",
"city" : "London",
"country" : "FR (for 'FRANCE')",
"countryName" : "FRANCE",
"department" : "75 (for 'PARIS')",
"geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
"region" : "65 (for 'ILE DE FRANCE')",
"regionName" : "ILE DE FRANCE",
"phone" : "06 00 00 00 01",
"phone2" : "06 00 00 00 02",
"email" : "myemail@mail.com",
"mobilePhone" : "06 00 00 00 02",
"fax" : "04 00 00 00 07",
"webSite" : "mysite.com"
},
"addressId" : "addressId"
},
"companyId" : "5000123",
"type" : "{}",
"category" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"categoryId" : "500143",
"grouping" : "grouping",
"ranking" : 2
},
"subCategoryId" : "11037",
"locked" : false
}, {
"id" : "5000123",
"title" : "Title",
"versionId" : "5000123",
"changeTracking" : {
"createdTime" : "2000-06-21T04:56:07.000+00:00",
"createdBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"createdById" : "5000123",
"modificationTime" : "2000-06-21T04:56:07.000+00:00",
"modificationBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"modificationById" : "5000123"
},
"publishedBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"publishedById" : "5001206",
"classification" : "STD",
"subClassification" : "EDITIONS",
"category1" : "CAT1",
"category2" : "CAT2",
"category3" : "CAT3",
"companyId" : "5000123",
"publicationDate" : "2000-06-21T04:56:07.000+00:00",
"version" : 1,
"documentType" : "File",
"fileUrl" : "myFiles/thisFile.pdf",
"fileName" : "thisFile.pdf",
"lienUrl" : "myStorage.com/myFiles/thisFile.pdf",
"url" : "myFiles/thisFile.pdf",
"original" : false,
"preview" : "data:image",
"tokenPreview" : "8946A85V85D851DF",
"externalDMSUuid" : "OD1245126",
"links" : [ {
"id" : "5000123",
"original" : true,
"documentId" : "5000123",
"objectId" : "5000123",
"objectType" : "{}"
}, {
"id" : "5000123",
"original" : true,
"documentId" : "5000123",
"objectId" : "5000123",
"objectType" : "{}"
} ],
"archived" : false,
"action" : "{}",
"owner" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"ownerId" : "5001206",
"description" : "Text",
"category" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"categoryId" : "100024",
"subCategory" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"company" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo",
"legalName" : "legalName",
"siren" : "siren",
"siret" : "siret",
"calendar" : {
"id" : "5000123",
"code" : "Text",
"name" : "Text",
"default" : true,
"daysNotWorked" : [ 6, 6 ],
"holidays" : [ {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
}, {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
} ]
},
"calendarId" : "calendarId",
"color" : "color",
"currency" : {
"id" : "5000123",
"name" : "Euro",
"code" : "EUR",
"order" : 17,
"euro" : true,
"euroRate" : 0.9678,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"euroRateStartDate" : "2020-01-23T04:56:07Z",
"euroRateEndDate" : "2020-01-23T04:56:07Z"
},
"currencyId" : "currencyId",
"address" : {
"id" : "id",
"line1" : "221B Baker Street",
"line2" : "2nd Floor",
"line3" : "First door at your right",
"cedex" : "CEDEX 14",
"postalCode" : "69002",
"city" : "London",
"country" : "FR (for 'FRANCE')",
"countryName" : "FRANCE",
"department" : "75 (for 'PARIS')",
"geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
"region" : "65 (for 'ILE DE FRANCE')",
"regionName" : "ILE DE FRANCE",
"phone" : "06 00 00 00 01",
"phone2" : "06 00 00 00 02",
"email" : "myemail@mail.com",
"mobilePhone" : "06 00 00 00 02",
"fax" : "04 00 00 00 07",
"webSite" : "mysite.com"
},
"addressId" : "addressId"
},
"companyId" : "5000123",
"type" : "{}",
"category" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"categoryId" : "500143",
"grouping" : "grouping",
"ranking" : 2
},
"subCategoryId" : "11037",
"locked" : false
} ],
"changeTracking" : {
"createdTime" : "2000-06-21T04:56:07.000+00:00",
"createdBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"createdById" : "5000123",
"modificationTime" : "2000-06-21T04:56:07.000+00:00",
"modificationBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"modificationById" : "5000123"
},
"smartScan" : "{}",
"customRequest" : {
"id" : "5000123",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJT_001",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"subPhase" : {
"id" : "5000123",
"code" : "SB_1",
"name" : "Sub Phase 1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"order" : 1
},
"subPhaseId" : "51000122",
"projectTask" : {
"id" : "5000123",
"code" : "code",
"name" : "Team building",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJT_001",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"subPhase" : {
"id" : "5000123",
"code" : "SB_1",
"name" : "Sub Phase 1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"order" : 1
},
"subPhaseId" : "51000122",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"order" : 2,
"startDate" : "2000-06-21T04:56:07.000+00:00",
"endDate" : "2000-06-21T04:56:07.000+00:00",
"description" : "description"
},
"projectTaskId" : "5000123",
"number" : "CC00001",
"name" : "Label for my doc",
"type" : "{}",
"companyCode" : "AKSAS",
"companyId" : "5000123",
"currencyCode" : "EUR",
"currency" : {
"id" : "5000123",
"name" : "Euro",
"code" : "EUR",
"order" : 17,
"euro" : true,
"euroRate" : 0.9678,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"euroRateStartDate" : "2020-01-23T04:56:07Z",
"euroRateEndDate" : "2020-01-23T04:56:07Z"
},
"date" : "2000-06-21T04:56:07.000+00:00",
"description" : "Lorem ipsum",
"entityCode" : "Lyon",
"afterTaxAmount" : 120.37,
"preTaxAmount" : 100.14,
"thirdPartyId" : "CUSTOMER01",
"customData" : {
"key" : {
"type" : "{}",
"value" : "Autoref 010520",
"name" : "Reference 4",
"realOrder" : 0,
"label" : "REFERENCE_4"
}
},
"changeTracking" : {
"createdTime" : "2000-06-21T04:56:07.000+00:00",
"createdBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"createdById" : "5000123",
"modificationTime" : "2000-06-21T04:56:07.000+00:00",
"modificationBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"modificationById" : "5000123"
},
"approvalState" : "{}",
"approvalDate" : "2000-06-21T04:56:07.000+00:00",
"lines" : [ {
"id" : "5000123",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJT_001",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"subPhase" : {
"id" : "5000123",
"code" : "SB_1",
"name" : "Sub Phase 1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"order" : 1
},
"subPhaseId" : "51000122",
"projectTask" : {
"id" : "5000123",
"code" : "code",
"name" : "Team building",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJT_001",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"subPhase" : {
"id" : "5000123",
"code" : "SB_1",
"name" : "Sub Phase 1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"order" : 1
},
"subPhaseId" : "51000122",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"order" : 2,
"startDate" : "2000-06-21T04:56:07.000+00:00",
"endDate" : "2000-06-21T04:56:07.000+00:00",
"description" : "description"
},
"projectTaskId" : "5000123",
"managementObjectId" : "5000123",
"name" : "Helpdesk",
"quantity" : 3,
"unitPriceCurrency" : 36.32,
"unitPrice" : 40,
"amountTotalCurrency" : 1200,
"amountTotal" : 1200,
"rankNumber" : 2,
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"expenseTypeExpected" : {
"id" : "5000123",
"code" : "AIR-PL",
"name" : "Airplane",
"description" : "Transportation",
"endDate" : "2000-06-21T04:56:07.000+00:00",
"expenseType" : {
"id" : "5000123",
"code" : "MEAL",
"description" : "Plane",
"km" : false,
"notRefundable" : true,
"icon" : "fa fa-plane",
"color" : "00ff40",
"receiptRequired" : false,
"commentRequired" : false,
"guestsRequired" : false,
"notRefundableEditable" : true,
"billableEditable" : true,
"amountEditable" : true,
"showQuantity" : false,
"showAdditionalComment" : false,
"showReceiptNumber" : true,
"showAmountCategory" : true,
"showBillable" : true,
"hideVat" : false,
"vat1Code" : "1",
"vat2Code" : "2",
"vat3Code" : "3",
"expenseThreshold" : 100,
"defaultAmount" : 45,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"expenseCategory" : "{}",
"expenseRebillableOptions" : "{}",
"showCustomRequest" : true,
"showAmountWithoutVat" : true,
"controlsBehavior" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"calculateKilometers" : true,
"freeEntryProhibited" : true,
"controls" : {
"enableDuplicate" : true,
"enablelOnNonWorkingDay" : true,
"enableOnDayWithLeaveRequest" : true,
"enableOnDayWithTimesheetOrSchedule" : true
},
"expenseThresholdExceededNoVat" : false
},
"expenseTypeId" : "expenseTypeId",
"editableExpenseReport" : true,
"defaultExpenseReport" : true
},
"expenseTypeExpectedId" : "5000123",
"isExpenseReport" : true
}, {
"id" : "5000123",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJT_001",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"subPhase" : {
"id" : "5000123",
"code" : "SB_1",
"name" : "Sub Phase 1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"order" : 1
},
"subPhaseId" : "51000122",
"projectTask" : {
"id" : "5000123",
"code" : "code",
"name" : "Team building",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJT_001",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"subPhase" : {
"id" : "5000123",
"code" : "SB_1",
"name" : "Sub Phase 1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"order" : 1
},
"subPhaseId" : "51000122",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"order" : 2,
"startDate" : "2000-06-21T04:56:07.000+00:00",
"endDate" : "2000-06-21T04:56:07.000+00:00",
"description" : "description"
},
"projectTaskId" : "5000123",
"managementObjectId" : "5000123",
"name" : "Helpdesk",
"quantity" : 3,
"unitPriceCurrency" : 36.32,
"unitPrice" : 40,
"amountTotalCurrency" : 1200,
"amountTotal" : 1200,
"rankNumber" : 2,
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"expenseTypeExpected" : {
"id" : "5000123",
"code" : "AIR-PL",
"name" : "Airplane",
"description" : "Transportation",
"endDate" : "2000-06-21T04:56:07.000+00:00",
"expenseType" : {
"id" : "5000123",
"code" : "MEAL",
"description" : "Plane",
"km" : false,
"notRefundable" : true,
"icon" : "fa fa-plane",
"color" : "00ff40",
"receiptRequired" : false,
"commentRequired" : false,
"guestsRequired" : false,
"notRefundableEditable" : true,
"billableEditable" : true,
"amountEditable" : true,
"showQuantity" : false,
"showAdditionalComment" : false,
"showReceiptNumber" : true,
"showAmountCategory" : true,
"showBillable" : true,
"hideVat" : false,
"vat1Code" : "1",
"vat2Code" : "2",
"vat3Code" : "3",
"expenseThreshold" : 100,
"defaultAmount" : 45,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"expenseCategory" : "{}",
"expenseRebillableOptions" : "{}",
"showCustomRequest" : true,
"showAmountWithoutVat" : true,
"controlsBehavior" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"calculateKilometers" : true,
"freeEntryProhibited" : true,
"controls" : {
"enableDuplicate" : true,
"enablelOnNonWorkingDay" : true,
"enableOnDayWithLeaveRequest" : true,
"enableOnDayWithTimesheetOrSchedule" : true
},
"expenseThresholdExceededNoVat" : false
},
"expenseTypeId" : "expenseTypeId",
"editableExpenseReport" : true,
"defaultExpenseReport" : true
},
"expenseTypeExpectedId" : "5000123",
"isExpenseReport" : true
} ],
"category" : {
"id" : "50000012",
"code" : "CATEGORY_1",
"name" : "Category one",
"endDate" : "2000-06-21T04:56:07.000+00:00",
"icon" : "fas fa-pen",
"companyId" : "companyId",
"enableActualDates" : true,
"enableEndDate" : true,
"editableWithoutExpense" : true,
"defaultValueWithoutExpense" : true,
"scheduleCreation" : true,
"timesheetCreation" : true,
"departureLocation" : true,
"departureLocationType" : "{}",
"destinationLocation" : true,
"destinationLocationType" : "{}",
"accreditationLevelType" : 1,
"accreditationOptions" : "{}",
"displayCustomData" : true,
"customDataStart" : 1,
"customDataEnd" : 9,
"customDataNbColumns" : 2
},
"categoryId" : "5000123",
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}",
"title" : "GEN",
"phone" : "+33 6 04 04 04 05",
"mobilePhone" : "+33 6 00 00 00 01",
"email" : "myemail@bechmail.com",
"noTimesDunning" : true,
"assignmentMultiCompany" : false,
"modeTimeRecording" : 1,
"modeInputSchedule" : 3,
"timeRecordingInputMode" : "{}",
"scheduleInputMode" : "{}",
"executive" : true,
"generic" : true,
"candidate" : false,
"external" : false,
"managerMultiCompany" : true,
"employeeFunctions" : {
"allFunctions" : false,
"allSales" : true,
"allPurchases" : false,
"allOperational" : true,
"projectSalesManager" : false,
"projectFinanceManager" : true,
"projectProductionManager" : false,
"projectAccountManager" : true,
"projectAssignment" : false,
"projectPhaseManager" : true,
"projectSendOnMission" : false,
"salesSalesAssistant" : true,
"salesOrderAndEstimateTracking" : false,
"salesBillingSchedulesTracking" : true,
"purchasingBuyer" : false,
"timeRecording" : true,
"inputOfExpenseReport" : false,
"purchasesReceptionTracking" : false,
"inputSchedule" : false,
"CMMSContractSalesManager" : false,
"CMMSContractTechnicalManager" : false,
"CMMSMRAndEOManager" : false
},
"employeeHistory" : [ {
"id" : "5000123",
"employeeHistoryType" : "5000123",
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 7.42,
"weekHours" : 38.3,
"occupancyRate" : 0.8,
"manager" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"managerId" : "5000123",
"company" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo"
},
"companyId" : "5000123",
"directHourlyRate" : 10.42,
"standardHourlyRate" : 10,
"dailyCost" : 59.36,
"dailySellingPrice" : 80,
"entity" : "5000123",
"serviceRef" : {
"id" : "5000123",
"name" : "Professional services",
"code" : "PS"
},
"service" : "5000123",
"position" : "Developer",
"skillRef" : {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
},
"skill" : "5000123",
"family1" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family1Id" : "5000123",
"family2" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family2Id" : "5000123",
"family3" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family3Id" : "5000123",
"leave" : false,
"standardWeek" : {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
}
},
"standardWeekId" : "5000123",
"salary" : 1024
}, {
"id" : "5000123",
"employeeHistoryType" : "5000123",
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 7.42,
"weekHours" : 38.3,
"occupancyRate" : 0.8,
"manager" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"managerId" : "5000123",
"company" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo"
},
"companyId" : "5000123",
"directHourlyRate" : 10.42,
"standardHourlyRate" : 10,
"dailyCost" : 59.36,
"dailySellingPrice" : 80,
"entity" : "5000123",
"serviceRef" : {
"id" : "5000123",
"name" : "Professional services",
"code" : "PS"
},
"service" : "5000123",
"position" : "Developer",
"skillRef" : {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
},
"skill" : "5000123",
"family1" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family1Id" : "5000123",
"family2" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family2Id" : "5000123",
"family3" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family3Id" : "5000123",
"leave" : false,
"standardWeek" : {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
}
},
"standardWeekId" : "5000123",
"salary" : 1024
} ],
"companyChanges" : [ {
"id" : "5000123",
"employeeId" : "500123",
"companyId" : "5000123",
"startDate" : "2020-01-23T04:56:07Z",
"endDate" : "2020-01-23T04:56:07Z",
"companyChangeState" : "{}",
"comment" : "Limpso usum"
}, {
"id" : "5000123",
"employeeId" : "500123",
"companyId" : "5000123",
"startDate" : "2020-01-23T04:56:07Z",
"endDate" : "2020-01-23T04:56:07Z",
"companyChangeState" : "{}",
"comment" : "Limpso usum"
} ],
"timeRecordingRules" : {
"id" : "5000123",
"employeeId" : "5000123",
"min" : 0,
"max" : 24,
"step" : 0.01,
"prettyStep" : 0.3,
"base" : 60,
"unit" : "H",
"unitDuration" : "{}",
"allowManualEntry" : true,
"employeeWeeks" : [ {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
},
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 8,
"dailyMinutes" : 10,
"weekHours" : 40,
"leave" : false
}, {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
},
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 8,
"dailyMinutes" : 10,
"weekHours" : 40,
"leave" : false
} ],
"closingDates" : [ {
"closingDate" : "2020-01-31T23:59:59Z",
"module" : "DATE_MODULE",
"beginningOfPeriod" : "2020-01-31T23:59:59Z",
"endOfPeriod" : "2020-01-31T23:59:59Z"
}, {
"closingDate" : "2020-01-31T23:59:59Z",
"module" : "DATE_MODULE",
"beginningOfPeriod" : "2020-01-31T23:59:59Z",
"endOfPeriod" : "2020-01-31T23:59:59Z"
} ],
"simpleDuration" : 750,
"completionMode" : "WEEKLY"
},
"scheduleRules" : {
"id" : "5000123",
"employeeId" : "5000123",
"min" : 0,
"max" : 24,
"step" : 0.01,
"prettyStep" : 0.3,
"base" : 60,
"unit" : "H",
"unitDuration" : "{}",
"allowManualEntry" : true,
"employeeWeeks" : [ {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
},
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 8,
"dailyMinutes" : 10,
"weekHours" : 40,
"leave" : false
}, {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
},
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 8,
"dailyMinutes" : 10,
"weekHours" : 40,
"leave" : false
} ],
"closingDates" : [ {
"closingDate" : "2020-01-31T23:59:59Z",
"module" : "DATE_MODULE",
"beginningOfPeriod" : "2020-01-31T23:59:59Z",
"endOfPeriod" : "2020-01-31T23:59:59Z"
}, {
"closingDate" : "2020-01-31T23:59:59Z",
"module" : "DATE_MODULE",
"beginningOfPeriod" : "2020-01-31T23:59:59Z",
"endOfPeriod" : "2020-01-31T23:59:59Z"
} ],
"timestamped" : true
},
"businessCards" : [ {
"id" : "5000123",
"employeeId" : "5000123",
"cardNumber" : "XXXX XXXX XXXX 7568",
"encryptedCardNumber" : "0",
"name" : "Management card",
"type" : "{}",
"endDate" : "2020-01-31T23:59:59Z"
}, {
"id" : "5000123",
"employeeId" : "5000123",
"cardNumber" : "XXXX XXXX XXXX 7568",
"encryptedCardNumber" : "0",
"name" : "Management card",
"type" : "{}",
"endDate" : "2020-01-31T23:59:59Z"
} ],
"sector" : "Marketing",
"number" : "84",
"relations" : [ {
"id" : "5000123",
"relationType" : {
"id" : "5000123",
"code" : "TUTOR",
"name" : "Tutor for internship"
},
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"relatedEmployee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"relatedEmployeeId" : "5000123"
}, {
"id" : "5000123",
"relationType" : {
"id" : "5000123",
"code" : "TUTOR",
"name" : "Tutor for internship"
},
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"relatedEmployee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"relatedEmployeeId" : "5000123"
} ],
"employeeAbilities" : [ {
"id" : "5000123",
"skill" : {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
},
"level" : {
"id" : "5000123",
"code" : "EXP",
"name" : "Expert"
},
"startDate" : "2020-01-31T23:59:59Z",
"endDate" : "2020-01-31T23:59:59Z",
"employeeId" : "5000123"
}, {
"id" : "5000123",
"skill" : {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
},
"level" : {
"id" : "5000123",
"code" : "EXP",
"name" : "Expert"
},
"startDate" : "2020-01-31T23:59:59Z",
"endDate" : "2020-01-31T23:59:59Z",
"employeeId" : "5000123"
} ],
"jobType" : {
"id" : "5000123",
"companyCode" : "AKSAS",
"code" : "ADMIN",
"name" : "Administrator",
"category" : "{}",
"validity" : {
"type" : "{}",
"date" : "2000-06-21T04:56:07.000+00:00"
},
"default" : true
},
"jobTypeId" : "100245",
"address" : {
"id" : "id",
"line1" : "221B Baker Street",
"line2" : "2nd Floor",
"line3" : "First door at your right",
"cedex" : "CEDEX 14",
"postalCode" : "69002",
"city" : "London",
"country" : "FR (for 'FRANCE')",
"countryName" : "FRANCE",
"department" : "75 (for 'PARIS')",
"geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
"region" : "65 (for 'ILE DE FRANCE')",
"regionName" : "ILE DE FRANCE",
"phone" : "06 00 00 00 01",
"phone2" : "06 00 00 00 02",
"email" : "myemail@mail.com",
"mobilePhone" : "06 00 00 00 02",
"fax" : "04 00 00 00 07",
"webSite" : "mysite.com"
},
"addressId" : "5000123",
"birthDate" : "2000-06-21T04:56:07.000+00:00",
"customData" : {
"key" : {
"type" : "{}",
"value" : "Autoref 010520",
"name" : "Reference 4",
"realOrder" : 0,
"label" : "REFERENCE_4"
}
},
"color" : "#FF0000",
"targetTace" : 75,
"formConfig" : {
"type" : "{}",
"fields" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"controls" : {
"key" : {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}
},
"insertable" : true,
"editable" : false,
"deletable" : false,
"formSearchHidden" : false
},
"changeTracking" : {
"createdTime" : "2000-06-21T04:56:07.000+00:00",
"createdBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"createdById" : "5000123",
"modificationTime" : "2000-06-21T04:56:07.000+00:00",
"modificationBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"modificationById" : "5000123"
},
"vehicles" : [ {
"id" : "5000123",
"power" : 5,
"licensePlate" : "licensePlate",
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"expenseType" : {
"id" : "5000123",
"code" : "MEAL",
"description" : "Plane",
"km" : false,
"notRefundable" : true,
"icon" : "fa fa-plane",
"color" : "00ff40",
"receiptRequired" : false,
"commentRequired" : false,
"guestsRequired" : false,
"notRefundableEditable" : true,
"billableEditable" : true,
"amountEditable" : true,
"showQuantity" : false,
"showAdditionalComment" : false,
"showReceiptNumber" : true,
"showAmountCategory" : true,
"showBillable" : true,
"hideVat" : false,
"vat1Code" : "1",
"vat2Code" : "2",
"vat3Code" : "3",
"expenseThreshold" : 100,
"defaultAmount" : 45,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"expenseCategory" : "{}",
"expenseRebillableOptions" : "{}",
"showCustomRequest" : true,
"showAmountWithoutVat" : true,
"controlsBehavior" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"calculateKilometers" : true,
"freeEntryProhibited" : true,
"controls" : {
"enableDuplicate" : true,
"enablelOnNonWorkingDay" : true,
"enableOnDayWithLeaveRequest" : true,
"enableOnDayWithTimesheetOrSchedule" : true
},
"expenseThresholdExceededNoVat" : false
},
"expenseTypeId" : "5000123",
"endDate" : "2020-01-31T23:59:59Z"
}, {
"id" : "5000123",
"power" : 5,
"licensePlate" : "licensePlate",
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"expenseType" : {
"id" : "5000123",
"code" : "MEAL",
"description" : "Plane",
"km" : false,
"notRefundable" : true,
"icon" : "fa fa-plane",
"color" : "00ff40",
"receiptRequired" : false,
"commentRequired" : false,
"guestsRequired" : false,
"notRefundableEditable" : true,
"billableEditable" : true,
"amountEditable" : true,
"showQuantity" : false,
"showAdditionalComment" : false,
"showReceiptNumber" : true,
"showAmountCategory" : true,
"showBillable" : true,
"hideVat" : false,
"vat1Code" : "1",
"vat2Code" : "2",
"vat3Code" : "3",
"expenseThreshold" : 100,
"defaultAmount" : 45,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"expenseCategory" : "{}",
"expenseRebillableOptions" : "{}",
"showCustomRequest" : true,
"showAmountWithoutVat" : true,
"controlsBehavior" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"calculateKilometers" : true,
"freeEntryProhibited" : true,
"controls" : {
"enableDuplicate" : true,
"enablelOnNonWorkingDay" : true,
"enableOnDayWithLeaveRequest" : true,
"enableOnDayWithTimesheetOrSchedule" : true
},
"expenseThresholdExceededNoVat" : false
},
"expenseTypeId" : "5000123",
"endDate" : "2020-01-31T23:59:59Z"
} ],
"currentCompany" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo",
"legalName" : "legalName",
"siren" : "siren",
"siret" : "siret",
"calendar" : {
"id" : "5000123",
"code" : "Text",
"name" : "Text",
"default" : true,
"daysNotWorked" : [ 6, 6 ],
"holidays" : [ {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
}, {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
} ]
},
"calendarId" : "calendarId",
"color" : "color",
"currency" : {
"id" : "5000123",
"name" : "Euro",
"code" : "EUR",
"order" : 17,
"euro" : true,
"euroRate" : 0.9678,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"euroRateStartDate" : "2020-01-23T04:56:07Z",
"euroRateEndDate" : "2020-01-23T04:56:07Z"
},
"currencyId" : "currencyId",
"address" : {
"id" : "id",
"line1" : "221B Baker Street",
"line2" : "2nd Floor",
"line3" : "First door at your right",
"cedex" : "CEDEX 14",
"postalCode" : "69002",
"city" : "London",
"country" : "FR (for 'FRANCE')",
"countryName" : "FRANCE",
"department" : "75 (for 'PARIS')",
"geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
"region" : "65 (for 'ILE DE FRANCE')",
"regionName" : "ILE DE FRANCE",
"phone" : "06 00 00 00 01",
"phone2" : "06 00 00 00 02",
"email" : "myemail@mail.com",
"mobilePhone" : "06 00 00 00 02",
"fax" : "04 00 00 00 07",
"webSite" : "mysite.com"
},
"addressId" : "addressId"
},
"currentCompanyId" : "5000123",
"bankingInformation" : {
"id" : "5000123",
"sepa" : {
"bankDetails" : {
"entity" : "30002",
"counter" : "550",
"accountNumber" : "0000157841Z",
"key" : "25",
"domiciliation" : "AURA"
},
"bic" : {
"country" : "FR (for 'FRANCE')",
"bank" : "DAAE",
"location" : "PP",
"branch" : "CCT"
},
"iban" : {
"country" : "FR (for 'FRANCE')",
"key" : "69",
"accountNumber" : "0000157841Z"
}
},
"noneSepa" : {
"defaultBankDetail" : false,
"beneficiary" : {
"holder" : {
"name" : "RITA",
"firstName" : "BRITA",
"accountType" : "{}",
"accountNumber" : "123456789"
},
"bank" : {
"bankName" : "UBA",
"bankName2" : "UBA",
"bankType" : "{}",
"bankCode" : "C8",
"bankAddress" : {
"id" : "id",
"line1" : "221B Baker Street",
"line2" : "2nd Floor",
"line3" : "First door at your right",
"cedex" : "CEDEX 14",
"postalCode" : "69002",
"city" : "London",
"country" : "FR (for 'FRANCE')",
"countryName" : "FRANCE",
"department" : "75 (for 'PARIS')",
"geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
"region" : "65 (for 'ILE DE FRANCE')",
"regionName" : "ILE DE FRANCE",
"phone" : "06 00 00 00 01",
"phone2" : "06 00 00 00 02",
"email" : "myemail@mail.com",
"mobilePhone" : "06 00 00 00 02",
"fax" : "04 00 00 00 07",
"webSite" : "mysite.com"
}
}
},
"intermediate" : {
"holder" : {
"name" : "RITA",
"firstName" : "BRITA",
"accountType" : "{}",
"accountNumber" : "123456789"
},
"bank" : {
"bankName" : "UBA",
"bankName2" : "UBA",
"bankType" : "{}",
"bankCode" : "C8",
"bankAddress" : {
"id" : "id",
"line1" : "221B Baker Street",
"line2" : "2nd Floor",
"line3" : "First door at your right",
"cedex" : "CEDEX 14",
"postalCode" : "69002",
"city" : "London",
"country" : "FR (for 'FRANCE')",
"countryName" : "FRANCE",
"department" : "75 (for 'PARIS')",
"geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
"region" : "65 (for 'ILE DE FRANCE')",
"regionName" : "ILE DE FRANCE",
"phone" : "06 00 00 00 01",
"phone2" : "06 00 00 00 02",
"email" : "myemail@mail.com",
"mobilePhone" : "06 00 00 00 02",
"fax" : "04 00 00 00 07",
"webSite" : "mysite.com"
}
}
}
},
"statusChangeDate" : "2000-06-21T04:56:07.000+00:00",
"statusChangeArgument" : {
"comment" : "Comment",
"status" : "{}"
},
"validator" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"validatorId" : "5000123",
"action" : "{}",
"type" : "{}"
},
"faxNumber" : "418 643 3210",
"phoneExtensionNumber" : "04 00 00 00 07"
},
"employeeId" : "5000123",
"departureDate" : "2020-01-31T23:59:59Z",
"departureActualDate" : "2020-01-31T23:59:59Z",
"departureCity" : {
"id" : "5000123",
"name" : "City 1",
"default" : true,
"postcode" : "73000",
"country" : {
"id" : "5000123",
"name" : "Country 1",
"currency" : {
"id" : "5000123",
"name" : "Euro",
"code" : "EUR",
"order" : 17,
"euro" : true,
"euroRate" : 0.9678,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"euroRateStartDate" : "2020-01-23T04:56:07Z",
"euroRateEndDate" : "2020-01-23T04:56:07Z"
},
"currencyId" : "5000123",
"calendar" : {
"id" : "5000123",
"code" : "Text",
"name" : "Text",
"default" : true,
"daysNotWorked" : [ 6, 6 ],
"holidays" : [ {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
}, {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
} ]
},
"calendarId" : "5000123",
"code" : "FR",
"companyCode" : "AKSAS",
"companyId" : "5000123",
"isPartOfEU" : true,
"continent" : "AFRICA"
},
"countryId" : "5000123",
"department" : {
"id" : "5000123",
"code" : "01-A",
"companyCode" : "AKSAS",
"name" : "Lorem Ipsum",
"analysis" : "analysis",
"comment" : "comment",
"entity" : {
"id" : "5000123",
"code" : "01-BRDX",
"name" : "Bordeaux",
"legalName" : "Customer care",
"division" : {
"id" : "5000123",
"name" : "Rhone-Alpes",
"code" : "RA",
"group" : {
"id" : "5000123",
"name" : "West",
"code" : "WST",
"serviceId" : "5000123"
},
"groupId" : "5000123",
"companyId" : "5000123"
},
"divisionId" : "5000123",
"divisionCode" : "01-DIV",
"companyId" : "5000123",
"endDate" : "2020-01-23T04:56:07Z"
},
"entityId" : "entityId",
"projectType" : "{}",
"activities" : [ {
"id" : "5000123",
"code" : "code",
"name" : "name"
}, {
"id" : "5000123",
"code" : "code",
"name" : "name"
} ]
},
"departmentId" : "5000123",
"regionId" : "123456",
"companyCode" : "AKSAS",
"latitude" : "5.9845W",
"longitude" : "37.3891N"
},
"departureLocation" : "Lyon",
"arrivalDate" : "2020-01-31T23:59:59Z",
"arrivalActualDate" : "2020-01-31T23:59:59Z",
"arrivalCity" : {
"id" : "5000123",
"name" : "City 1",
"default" : true,
"postcode" : "73000",
"country" : {
"id" : "5000123",
"name" : "Country 1",
"currency" : {
"id" : "5000123",
"name" : "Euro",
"code" : "EUR",
"order" : 17,
"euro" : true,
"euroRate" : 0.9678,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"euroRateStartDate" : "2020-01-23T04:56:07Z",
"euroRateEndDate" : "2020-01-23T04:56:07Z"
},
"currencyId" : "5000123",
"calendar" : {
"id" : "5000123",
"code" : "Text",
"name" : "Text",
"default" : true,
"daysNotWorked" : [ 6, 6 ],
"holidays" : [ {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
}, {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
} ]
},
"calendarId" : "5000123",
"code" : "FR",
"companyCode" : "AKSAS",
"companyId" : "5000123",
"isPartOfEU" : true,
"continent" : "AFRICA"
},
"countryId" : "5000123",
"department" : {
"id" : "5000123",
"code" : "01-A",
"companyCode" : "AKSAS",
"name" : "Lorem Ipsum",
"analysis" : "analysis",
"comment" : "comment",
"entity" : {
"id" : "5000123",
"code" : "01-BRDX",
"name" : "Bordeaux",
"legalName" : "Customer care",
"division" : {
"id" : "5000123",
"name" : "Rhone-Alpes",
"code" : "RA",
"group" : {
"id" : "5000123",
"name" : "West",
"code" : "WST",
"serviceId" : "5000123"
},
"groupId" : "5000123",
"companyId" : "5000123"
},
"divisionId" : "5000123",
"divisionCode" : "01-DIV",
"companyId" : "5000123",
"endDate" : "2020-01-23T04:56:07Z"
},
"entityId" : "entityId",
"projectType" : "{}",
"activities" : [ {
"id" : "5000123",
"code" : "code",
"name" : "name"
}, {
"id" : "5000123",
"code" : "code",
"name" : "name"
} ]
},
"departmentId" : "5000123",
"regionId" : "123456",
"companyCode" : "AKSAS",
"latitude" : "5.9845W",
"longitude" : "37.3891N"
},
"arrivalLocation" : "Oslo",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"documents" : [ {
"id" : "5000123",
"title" : "Title",
"versionId" : "5000123",
"changeTracking" : {
"createdTime" : "2000-06-21T04:56:07.000+00:00",
"createdBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"createdById" : "5000123",
"modificationTime" : "2000-06-21T04:56:07.000+00:00",
"modificationBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"modificationById" : "5000123"
},
"publishedBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"publishedById" : "5001206",
"classification" : "STD",
"subClassification" : "EDITIONS",
"category1" : "CAT1",
"category2" : "CAT2",
"category3" : "CAT3",
"companyId" : "5000123",
"publicationDate" : "2000-06-21T04:56:07.000+00:00",
"version" : 1,
"documentType" : "File",
"fileUrl" : "myFiles/thisFile.pdf",
"fileName" : "thisFile.pdf",
"lienUrl" : "myStorage.com/myFiles/thisFile.pdf",
"url" : "myFiles/thisFile.pdf",
"original" : false,
"preview" : "data:image",
"tokenPreview" : "8946A85V85D851DF",
"externalDMSUuid" : "OD1245126",
"links" : [ {
"id" : "5000123",
"original" : true,
"documentId" : "5000123",
"objectId" : "5000123",
"objectType" : "{}"
}, {
"id" : "5000123",
"original" : true,
"documentId" : "5000123",
"objectId" : "5000123",
"objectType" : "{}"
} ],
"archived" : false,
"action" : "{}",
"owner" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"ownerId" : "5001206",
"description" : "Text",
"category" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"categoryId" : "100024",
"subCategory" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"company" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo",
"legalName" : "legalName",
"siren" : "siren",
"siret" : "siret",
"calendar" : {
"id" : "5000123",
"code" : "Text",
"name" : "Text",
"default" : true,
"daysNotWorked" : [ 6, 6 ],
"holidays" : [ {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
}, {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
} ]
},
"calendarId" : "calendarId",
"color" : "color",
"currency" : {
"id" : "5000123",
"name" : "Euro",
"code" : "EUR",
"order" : 17,
"euro" : true,
"euroRate" : 0.9678,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"euroRateStartDate" : "2020-01-23T04:56:07Z",
"euroRateEndDate" : "2020-01-23T04:56:07Z"
},
"currencyId" : "currencyId",
"address" : {
"id" : "id",
"line1" : "221B Baker Street",
"line2" : "2nd Floor",
"line3" : "First door at your right",
"cedex" : "CEDEX 14",
"postalCode" : "69002",
"city" : "London",
"country" : "FR (for 'FRANCE')",
"countryName" : "FRANCE",
"department" : "75 (for 'PARIS')",
"geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
"region" : "65 (for 'ILE DE FRANCE')",
"regionName" : "ILE DE FRANCE",
"phone" : "06 00 00 00 01",
"phone2" : "06 00 00 00 02",
"email" : "myemail@mail.com",
"mobilePhone" : "06 00 00 00 02",
"fax" : "04 00 00 00 07",
"webSite" : "mysite.com"
},
"addressId" : "addressId"
},
"companyId" : "5000123",
"type" : "{}",
"category" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"categoryId" : "500143",
"grouping" : "grouping",
"ranking" : 2
},
"subCategoryId" : "11037",
"locked" : false
}, {
"id" : "5000123",
"title" : "Title",
"versionId" : "5000123",
"changeTracking" : {
"createdTime" : "2000-06-21T04:56:07.000+00:00",
"createdBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"createdById" : "5000123",
"modificationTime" : "2000-06-21T04:56:07.000+00:00",
"modificationBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"modificationById" : "5000123"
},
"publishedBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"publishedById" : "5001206",
"classification" : "STD",
"subClassification" : "EDITIONS",
"category1" : "CAT1",
"category2" : "CAT2",
"category3" : "CAT3",
"companyId" : "5000123",
"publicationDate" : "2000-06-21T04:56:07.000+00:00",
"version" : 1,
"documentType" : "File",
"fileUrl" : "myFiles/thisFile.pdf",
"fileName" : "thisFile.pdf",
"lienUrl" : "myStorage.com/myFiles/thisFile.pdf",
"url" : "myFiles/thisFile.pdf",
"original" : false,
"preview" : "data:image",
"tokenPreview" : "8946A85V85D851DF",
"externalDMSUuid" : "OD1245126",
"links" : [ {
"id" : "5000123",
"original" : true,
"documentId" : "5000123",
"objectId" : "5000123",
"objectType" : "{}"
}, {
"id" : "5000123",
"original" : true,
"documentId" : "5000123",
"objectId" : "5000123",
"objectType" : "{}"
} ],
"archived" : false,
"action" : "{}",
"owner" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"ownerId" : "5001206",
"description" : "Text",
"category" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"categoryId" : "100024",
"subCategory" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"company" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo",
"legalName" : "legalName",
"siren" : "siren",
"siret" : "siret",
"calendar" : {
"id" : "5000123",
"code" : "Text",
"name" : "Text",
"default" : true,
"daysNotWorked" : [ 6, 6 ],
"holidays" : [ {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
}, {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
} ]
},
"calendarId" : "calendarId",
"color" : "color",
"currency" : {
"id" : "5000123",
"name" : "Euro",
"code" : "EUR",
"order" : 17,
"euro" : true,
"euroRate" : 0.9678,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"euroRateStartDate" : "2020-01-23T04:56:07Z",
"euroRateEndDate" : "2020-01-23T04:56:07Z"
},
"currencyId" : "currencyId",
"address" : {
"id" : "id",
"line1" : "221B Baker Street",
"line2" : "2nd Floor",
"line3" : "First door at your right",
"cedex" : "CEDEX 14",
"postalCode" : "69002",
"city" : "London",
"country" : "FR (for 'FRANCE')",
"countryName" : "FRANCE",
"department" : "75 (for 'PARIS')",
"geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
"region" : "65 (for 'ILE DE FRANCE')",
"regionName" : "ILE DE FRANCE",
"phone" : "06 00 00 00 01",
"phone2" : "06 00 00 00 02",
"email" : "myemail@mail.com",
"mobilePhone" : "06 00 00 00 02",
"fax" : "04 00 00 00 07",
"webSite" : "mysite.com"
},
"addressId" : "addressId"
},
"companyId" : "5000123",
"type" : "{}",
"category" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"categoryId" : "500143",
"grouping" : "grouping",
"ranking" : 2
},
"subCategoryId" : "11037",
"locked" : false
} ],
"numberOfDocuments" : 2,
"formConfig" : {
"type" : "{}",
"fields" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"controls" : {
"key" : {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}
},
"insertable" : true,
"editable" : false,
"deletable" : false,
"formSearchHidden" : false
},
"cancellationDate" : "2020-01-31T23:59:59Z",
"cancellationUser" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"cancellationUserId" : "5000123",
"archiveDate" : "2020-01-31T23:59:59Z",
"archiveUser" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"archiveUserId" : "5000123",
"comment" : "Lorem ipsum",
"multiProjects" : true
},
"customRequestId" : "5000123",
"threshold" : 80,
"vat3" : {
"id" : "5000123",
"code" : "7",
"rate" : 1.4658129805029452
},
"vatAmount3" : 110,
"vatAmount3Currency" : 126.57,
"exchangeRate" : {
"id" : "5000123",
"currency" : {
"id" : "5000123",
"name" : "Euro",
"code" : "EUR",
"order" : 17,
"euro" : true,
"euroRate" : 0.9678,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"euroRateStartDate" : "2020-01-23T04:56:07Z",
"euroRateEndDate" : "2020-01-23T04:56:07Z"
},
"currencyId" : "12006",
"rate" : 0.9156852,
"startDate" : "2000-06-21T04:56:07.000+00:00",
"endDate" : "2000-06-21T04:56:07.000+00:00"
},
"amountWithoutVat" : 1.8,
"vehicle" : {
"id" : "5000123",
"power" : 5,
"licensePlate" : "licensePlate",
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"expenseType" : {
"id" : "5000123",
"code" : "MEAL",
"description" : "Plane",
"km" : false,
"notRefundable" : true,
"icon" : "fa fa-plane",
"color" : "00ff40",
"receiptRequired" : false,
"commentRequired" : false,
"guestsRequired" : false,
"notRefundableEditable" : true,
"billableEditable" : true,
"amountEditable" : true,
"showQuantity" : false,
"showAdditionalComment" : false,
"showReceiptNumber" : true,
"showAmountCategory" : true,
"showBillable" : true,
"hideVat" : false,
"vat1Code" : "1",
"vat2Code" : "2",
"vat3Code" : "3",
"expenseThreshold" : 100,
"defaultAmount" : 45,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"expenseCategory" : "{}",
"expenseRebillableOptions" : "{}",
"showCustomRequest" : true,
"showAmountWithoutVat" : true,
"controlsBehavior" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"calculateKilometers" : true,
"freeEntryProhibited" : true,
"controls" : {
"enableDuplicate" : true,
"enablelOnNonWorkingDay" : true,
"enableOnDayWithLeaveRequest" : true,
"enableOnDayWithTimesheetOrSchedule" : true
},
"expenseThresholdExceededNoVat" : false
},
"expenseTypeId" : "5000123",
"endDate" : "2020-01-31T23:59:59Z"
},
"kmTotal" : 50,
"amountCalculated" : 35,
"amountRefunded" : 700,
"amountDue" : 35,
"retrievedExpense" : false,
"departureLocation" : "27 Rue Auguste Comte, 69002 Lyon, France",
"arrivalLocation" : "27 Rue Auguste Comte, 69002 Lyon, France",
"controls" : {
"duplicateForSameEmployee" : true,
"duplicateForSeveralEmployees" : true,
"onNonWorkingDay" : true,
"onLeaveDay" : true
}
}
2.7.7. Delete an expense
DELETE |
/expense-reports/{expense_report_id}/expenses/{expense_id} |
Description
Delete the expense matching specified expense report ID and expense ID.
DMF required:
-
DMF A40203: Api Workforce / Expenses / Delete
-
DMF 041503: Purchases / Expense Reports / Delete
-
DMF 190502: Web Portal / Expense Reports / Modify
-
DMF 190512: Web Portal / Expense Reports / Delete Expense Report
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
expense_report_id |
Id of an expense report |
X |
null |
|
expense_id |
Id of an expense |
X |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Expense successfully deleted |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.7.8. Delete an expense report
DELETE |
/expense-reports/{expense_report_id} |
Description
Delete the expense report matching the specified ID.
DMF required:
-
DMF A40203: Api Workforce / Expenses / Delete
-
DMF 041503: Purchases / Expense Reports / Delete
-
DMF 190502: Web Portal / Expense Reports / Modify
-
DMF 190512: Web Portal / Expense Reports / Delete Expense Report
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
expense_report_id |
Id of an expense report |
X |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Expense report successfully deleted |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.7.9. Advanced search for expenses
POST |
/expense-report/dashboard |
Description
This API provides an advanced search for expenses. The search results can be processed: categorization, groupings, total amounts…
DMF required:
-
DMF A40204: Api Workforce / Expenses / Search
-
DMF 041504: Purchases / Expense Reports / Search
-
DMF 190501: Web Portal / Expense Reports / Show
-
DMF 190509: Web Portal / Expense Reports / Change Employee (employees Managed By Me Only)
-
DMF 190510: Web Portal / Expense Reports / Change Employee (all Employees)
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
criteria |
Criteria that you choose (Employee id, code, etc…) ExpenseDashboardCriteria |
- |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Expenses successfully loaded |
List[ExpenseDashboardResult] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"expenseCriteria" : {
"date" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
},
"refused" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"onDayWithLeaveRequestControl" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"syncError" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"proofNumber" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"project" : {
"departmentId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"entityId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"subCategoryId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"managerId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"projectState" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"divisionGroupingId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"activityId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"financialManagerId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"projectGroupCode" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"productionManagerId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"name" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"customerId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"id" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"tag" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"divisionId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"salesManagerId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"subCategoryLevel2Id" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"categoryId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"referentialDate" : "2000-01-23T04:56:07.000+00:00"
},
"missionNumber" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"billable" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"expenseTypeId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"duplicateForSameEmployeeControl" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"id" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"receiptNumber" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"duplicateForSeveralEmployeeControl" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"onNonWorkingDayControl" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
}
},
"expenseReportCriteria" : {
"date" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
},
"acceptationOfDenial" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"code" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"employeeDivisionId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"rejected" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"missionNumber" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"readOption" : {
"options" : [ "SUPPLIER", "SUPPLIER" ]
},
"isMultiCompany" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"billed" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"validated" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"id" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"regularizationReason" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"employeeEstablishmentId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"companyCode" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"invoicedDate" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
},
"refused" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"employeeId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"managerId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"completed" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"employeeServiceId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"expenseDate" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
},
"expenseId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"cancelled" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"employeeDivisionGroupingId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
}
}
}
2.7.10. Search for an expense report by its ID
GET |
/expense-reports/{expense_report_id} |
Description
Get the expense report matching the specified ID.
DMF required:
-
DMF A40206: Api Workforce / Expenses / Info
-
DMF 041506: Purchases / Expense Reports / Show History
-
DMF 190501: Web Portal / Expense Reports / Show
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
expense_report_id |
Id of an expense report |
X |
null |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Expense report successfully loaded |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.7.11. Search for specific publish parameters in expense reports
GET |
/expense-report/publishing/templates/parameters |
Description
Get the list of specific publish parameters in expense reports.
DMF required:
-
DMF A40216: Api Workforce / Expenses / Publish
-
DMF 041505: Purchases / Expense Reports / Print
-
DMF 190201: Web Portal / Reports Menu / Expense Reports
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Specific publish parameters successfully loaded |
List[PublishTemplateParameter] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.7.12. Search for idents of the related company codes
POST |
/expense-report/intercompany-rebilling/related-company-code |
Description
Get the list of idents of the related company codes.
DMF required:
-
DMF A40206: Api Workforce / Expenses / Info
-
DMF 041506: Purchases / Expense Reports / Show History
-
DMF 190501: Web Portal / Expense Reports / Show
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
expense_report_id_list |
The list of idents of the expense reports ExpenseReportIdListParamHolder |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Ids of the related company successfully loaded |
List[[string]] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"expenseReportIdList" : [ "expenseReportIdList", "expenseReportIdList" ]
}
2.7.13. Give up an expense
POST |
/expense-reports/{expense_report_id}/expenses/{expense_id}/give-up |
Description
Give up an expense matching specified expense report ID and expense ID.
DMF required:
-
DMF A40212: Api Workforce / Expenses / Give Up
-
DMF 041502: Purchases / Expense Reports / Modify
-
DMF 190502: Web Portal / Expense Reports / Modify
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
expense_report_id |
Id of an expense report |
X |
null |
|
expense_id |
Id of an expense |
X |
null |
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Expense successfully give up |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.7.14. Publish an expense report
POST |
/expense-report/{expense_report_id}/publish |
Description
Publish an expense report using the template given as a parameter.
DMF required:
-
DMF A40216: Api Workforce / Expenses / Publish
-
DMF 041505: Purchases / Expense Reports / Print
-
DMF 190201: Web Portal / Reports Menu / Expense Reports
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
expense_report_id |
Id of an expense report |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
publish_arguments |
The arguments for publishing expense report PublishArguments |
X |
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
link_receipts |
Set as True if receipts have to be linked to the document |
- |
null |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Published document |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"template" : {
"id" : "5000123",
"code" : "MODELE_EDITION_001",
"name" : "Edition model for my documents",
"type" : {
"code" : "TEMP01",
"name" : "Template one",
"modelId" : "5000123",
"modelDescription" : "Lorem Ipsum"
},
"publishType" : "{}",
"path" : "C://MyDoc/Template/modele_edition_001",
"endDate" : "2000-06-21T04:56:07.000+00:00",
"extensions" : ".pdf, .docx",
"defaultTemplate" : true,
"interactive" : true,
"order" : 1
},
"extension" : ".pdf",
"parameters" : [ {
"groupName" : "text_box",
"labelText" : "Detail BL",
"pattern" : "cl",
"nameField" : "DetailBL",
"selectionList" : [ {
"label" : "Bank transfer",
"value" : "BT"
}, {
"label" : "Bank transfer",
"value" : "BT"
} ],
"nameFieldNext" : "DetailCheckbox",
"value" : "checked",
"required" : true
}, {
"groupName" : "text_box",
"labelText" : "Detail BL",
"pattern" : "cl",
"nameField" : "DetailBL",
"selectionList" : [ {
"label" : "Bank transfer",
"value" : "BT"
}, {
"label" : "Bank transfer",
"value" : "BT"
} ],
"nameFieldNext" : "DetailCheckbox",
"value" : "checked",
"required" : true
} ],
"saveDocument" : true
}
2.7.15. Search for an expense report with read options
POST |
/expense-reports/{expense_report_id}/read |
Description
Get an expense report, with additional information of your choice (example: supplier information).
You can add this information with Read Options. These are listed in the link below.
DMF required:
-
DMF A40206: Api Workforce / Expenses / Info
-
DMF 041506: Purchases / Expense Reports / Show History
-
DMF 190501: Web Portal / Expense Reports / Show
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
expense_report_id |
Id of an expense report |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
read_option |
The read options for returned expense report ExpenseReportReadOption |
- |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Expense report successfully loaded |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"options" : [ "SUPPLIER", "SUPPLIER" ]
}
2.7.16. Search for employee's expense reports (with search criteria)
POST |
/employees/{employee_id}/expense-reports/search |
Description
Get the list of expense reports of the employee matching the specified employee ID.
DMF required:
-
DMF A40204: Api Workforce / Expenses / Search
-
DMF 041504: Purchases / Expense Reports / Search
-
DMF 190501: Web Portal / Expense Reports / Show
-
DMF 190509: Web Portal / Expense Reports / Change Employee (employees Managed By Me Only)
-
DMF 190510: Web Portal / Expense Reports / Change Employee (all Employees)
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
employee_id |
Id of an employee |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
criteria |
Criteria that you choose (Code, date, etc…) ExpenseReportCriteria |
- |
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
range |
The range of reports (ex 10-15) |
- |
null |
Return Type
array[ExpenseReport]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Employee's expense reports successfully loaded |
List[ExpenseReport] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"date" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
},
"acceptationOfDenial" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"code" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"employeeDivisionId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"rejected" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"missionNumber" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"readOption" : {
"options" : [ "SUPPLIER", "SUPPLIER" ]
},
"isMultiCompany" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"billed" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"validated" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"id" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"regularizationReason" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"employeeEstablishmentId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"companyCode" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"invoicedDate" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
},
"refused" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"employeeId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"managerId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"completed" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"employeeServiceId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"expenseDate" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
},
"expenseId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"cancelled" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"employeeDivisionGroupingId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
}
}
2.7.17. Search for my expense reports (with read options and time slot)
POST |
/expense-reports/mine |
Description
Get the list of my expense reports, with a history in the corresponding time slot and additional information of your choice (example: project information).
You can add this information with Read Options. These are listed in the link below.
DMF required:
-
DMF A40206: Api Workforce / Expenses / Info
-
DMF 041506: Purchases / Expense Reports / Show History
-
DMF 190501: Web Portal / Expense Reports / Show
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
read_option |
Read options for returned expenses ExpenseReportReadOption |
- |
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
from |
Start date of the search interval |
- |
null |
|
to |
End date of the search interval |
- |
null |
|
mode |
If 'latest' then filter the expense reports with all non invoiced and the latest invoiced |
- |
null |
Return Type
array[ExpenseReport]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Expense reports successfully loaded |
List[ExpenseReport] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"options" : [ "SUPPLIER", "SUPPLIER" ]
}
2.7.18. 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.
The recovered expense will match specified expense report ID and expense ID.
DMF required:
-
DMF A40213: Api Workforce / Expenses / Recover
-
DMF 041502: Purchases / Expense Reports / Modify
-
DMF 190502: Web Portal / Expense Reports / Modify
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
expense_report_id |
Id of an expense report |
X |
null |
|
expense_id |
Id of an expense |
X |
null |
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Expense successfully recovered |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.7.19. Refuse an expense report
POST |
/expense-report/{expense_report_id}/refuse |
Description
Refuse expense report matching the specified ID.
DMF required:
-
DMF A40215: Api Workforce / Expenses / Validate
-
DMF 041507: Purchases / Expense Reports / Validate Completed Expense Report
-
DMF 041527: Purchases / Expense Reports / Validate Non-completed Expense Report
-
DMF 041541: Purchases / Expense Reports / Force Validation
-
DMF 190801: Web Portal / Expense Reports Validation / My Team
-
DMF 190802: Web Portal / Expense Reports Validation / My Teams
-
DMF 190803: Web Portal / Expense Reports Validation / History
-
DMF 190805: Web Portal / Expense Reports Validation / Validate Non-completed Expense Report
-
DMF 041520: Purchases / Expense Reports / Cancel Validation
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
expense_report_id |
Id of an expense report |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
reason |
The reason for refusal [string] |
- |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Expense report successfully refused |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
reason_example
2.7.20. Search for assignment (with search criteria)
POST |
/expense-reports/assignments/search |
Description
Get the list of assignment matching the search criteria.
DMF required:
-
DMF A90104: Api Project / Projects / Search External
-
DMF 0202__: Sales / Quotations
-
DMF 020202: Sales / Quotations / Modify
-
DMF 020204: Sales / Quotations / Search
-
DMF 060104: Projects
-
DMF 142602: Helpdesk / Simplified Issue / Modify
-
DMF 190302: Web Portal / Timesheets / Modify
-
DMF 190402: Web Portal / Schedules / Modify
-
DMF 1905__: Web Portal / Expense Reports
-
DMF 2501__: Project / Schedule View
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
criteria |
Criteria that you choose (Company id, customer id, etc…) AssignmentCriteria |
- |
Return Type
array[AssignmentNode]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Assignment successfully loaded |
List[AssignmentNode] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"lowerAssignmentType" : "{}",
"projectSubcategorieLevel2Id" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"scheduled" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"countAssignmentType" : "{}",
"projectClosed" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"departmentId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"phaseId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"projectOnLeave" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"projectProductionManagerId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"yearId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"activityId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"projectStateCode" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"employeePartitioning" : true,
"projectTaskEmployeeLinkedId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"customerId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"tag" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"phaseCode" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"divisionId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"upperAssignmentType" : "{}",
"subPhaseCode" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"projectCategorieId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"referentialDate" : "2000-01-23T04:56:07.000+00:00",
"divisionGroupId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"referentialDateEnd" : "2000-01-23T04:56:07.000+00:00",
"projectInternal" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"employeeId" : "employeeId",
"entityId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"ignoreProjectAllCustomer" : true,
"employeeIdScheduled" : [ "employeeIdScheduled", "employeeIdScheduled" ],
"projectTaskId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"companyId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"projectGroupCode" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"subPhaseId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"allCompanies" : true,
"mainCustomer" : true,
"projectManagerId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"projectSalesManagerId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"tagIdScheduled" : [ "tagIdScheduled", "tagIdScheduled" ],
"projectId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"projectFinancialManagerId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"projectSubCategorieId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"projectEmployeeLinkedId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
}
}
2.7.21. Search for expense reports (with search criteria)
POST |
/expense-reports/search |
Description
Get the list of expense reports matching the search criteria.
DMF required:
-
DMF A40204: Api Workforce / Expenses / Search
-
DMF 041504: Purchases / Expense Reports / Search
-
DMF 190501: Web Portal / Expense Reports / Show
-
DMF 190509: Web Portal / Expense Reports / Change Employee (employees Managed By Me Only)
-
DMF 190510: Web Portal / Expense Reports / Change Employee (all Employees)
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
criteria |
Criteria that you choose (Expense id, company code, etc…) ExpenseReportCriteria |
- |
Return Type
array[ExpenseReport]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Expense report successfully loaded |
List[ExpenseReport] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"date" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
},
"acceptationOfDenial" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"code" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"employeeDivisionId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"rejected" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"missionNumber" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"readOption" : {
"options" : [ "SUPPLIER", "SUPPLIER" ]
},
"isMultiCompany" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"billed" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"validated" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"id" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"regularizationReason" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"employeeEstablishmentId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"companyCode" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"invoicedDate" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
},
"refused" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"employeeId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"managerId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"completed" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"employeeServiceId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"expenseDate" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
},
"expenseId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"cancelled" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"employeeDivisionGroupingId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
}
}
2.7.22. Search for expense identifiers and aggregate results with groupBy
POST |
/expense-reports/aggregate |
Description
This API retrieves the identifiers of expenses based on specified search criteria for expenses and/or expense reports (expenseCriteria and expenseReportCriteria) and groups the results using the groupBy parameter, such as GUESTS_EMPLOYEE_CODE, EXPENSE_TYPE_NAME, or EMPLOYEE_CODE.
DMF required:
-
DMF A40223: Api Workforce / Expenses / Search Expense With Groupby
-
DMF 041504: Purchases / Expense Reports / Search
-
DMF 190501: Web Portal / Expense Reports / Show
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
aggregateParamHolder |
Parameters that you choose (expenseCriteria, expenseReportCriteria, etc) AggregateExpenseReportParamHolder |
- |
Return Type
array[GroupByResult]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
The expenses have been successfully generated |
List[GroupByResult] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"criteria" : {
"expenseCriteria" : {
"date" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
},
"refused" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"onDayWithLeaveRequestControl" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"syncError" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"proofNumber" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"project" : {
"departmentId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"entityId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"subCategoryId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"managerId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"projectState" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"divisionGroupingId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"activityId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"financialManagerId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"projectGroupCode" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"productionManagerId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"name" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"customerId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"id" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"tag" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"divisionId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"salesManagerId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"subCategoryLevel2Id" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"categoryId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"referentialDate" : "2000-01-23T04:56:07.000+00:00"
},
"missionNumber" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"billable" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"expenseTypeId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"duplicateForSameEmployeeControl" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"id" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"receiptNumber" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"duplicateForSeveralEmployeeControl" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"onNonWorkingDayControl" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
}
},
"expenseReportCriteria" : {
"date" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
},
"acceptationOfDenial" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"code" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"employeeDivisionId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"rejected" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"missionNumber" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"readOption" : {
"options" : [ "SUPPLIER", "SUPPLIER" ]
},
"isMultiCompany" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"billed" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"validated" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"id" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"regularizationReason" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"employeeEstablishmentId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"companyCode" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"invoicedDate" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
},
"refused" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"employeeId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"managerId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"completed" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"employeeServiceId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"expenseDate" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
},
"expenseId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"cancelled" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"employeeDivisionGroupingId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
}
}
}
}
2.7.23. Search for search field behavior for the Expense Reports
GET |
/expense-reports/search-fields-information |
Deprecated
|
Tip
|
This API will soon be removed as it is no longer functional. No data will be returned when using it. |
Description
Get the list of search field behavior for Expense Reports
DMF required:
-
DMF A40204: Api Workforce / Expenses / Search
-
DMF 041504: Purchases / Expense Reports / Search
-
DMF 190501: Web Portal / Expense Reports / Show
-
DMF 190509: Web Portal / Expense Reports / Change Employee (employees Managed By Me Only)
-
DMF 190510: Web Portal / Expense Reports / Change Employee (all Employees)
Parameters
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
manager_mode |
If true then get settings for the manager screen |
- |
null |
Return Type
array[SearchControlBehavior]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Search field behavior results |
List[SearchControlBehavior] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.7.24. Update an expense
POST |
/expense-reports/{expense_report_id}/expenses/{expense_id} |
Description
Update the expense matching specified expense report ID and expense ID.
DMF required:
-
DMF A40218: Api Workforce / Expenses / Update Expense
-
DMF 041502: Purchases / Expense Reports / Modify
-
DMF 041510: Purchases / Expense Reports / Modify Validated Expense Report
-
DMF 041518: Purchases / Expense Reports / Modify Completed Expense Report
-
DMF 041532: Purchases / Expense Reports / Correct Expense Reports
-
DMF 190502: Web Portal / Expense Reports / Modify
-
DMF 190511: Web Portal / Expense Reports / Modify Another Employee''s Expense Report
-
DMF 190903: Web Portal / Approvals / Modify Expense
-
DMF 190904: Web Portal / Approvals / Modify Refunded Threshold
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
expense_report_id |
Id of an expense report |
X |
null |
|
expense_id |
Id of an expense |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
expense |
The expense to be updated Expense |
X |
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Expense successfully updated |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"id" : "5000123",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJT_001",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"subPhase" : {
"id" : "5000123",
"code" : "SB_1",
"name" : "Sub Phase 1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"order" : 1
},
"subPhaseId" : "51000122",
"projectTask" : {
"id" : "5000123",
"code" : "code",
"name" : "Team building",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJT_001",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"subPhase" : {
"id" : "5000123",
"code" : "SB_1",
"name" : "Sub Phase 1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"order" : 1
},
"subPhaseId" : "51000122",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"order" : 2,
"startDate" : "2000-06-21T04:56:07.000+00:00",
"endDate" : "2000-06-21T04:56:07.000+00:00",
"description" : "description"
},
"projectTaskId" : "5000123",
"managementObjectId" : "5000123",
"name" : "Helpdesk",
"quantity" : 3,
"unitPriceCurrency" : 36.32,
"unitPrice" : 40,
"amountTotalCurrency" : 1200,
"amountTotal" : 1200,
"rankNumber" : 2,
"action" : "{}",
"complementName" : "Lorem ipsum",
"afterTaxAmountTotalCurrency" : 1500,
"afterTaxAmountTotal" : 1500,
"generalAccount" : "411000",
"totalPriceCurrency" : 1200,
"totalPrice" : 1200,
"additionalFreeFields" : {
"field1" : "Free field",
"field2" : "Free field",
"field3" : "Free field",
"field4" : "Free field",
"field5" : "Free field"
},
"resource" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"resourceId" : "resourceId",
"formConfig" : {
"type" : "{}",
"fields" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"controls" : {
"key" : {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}
},
"insertable" : true,
"editable" : false,
"deletable" : false,
"formSearchHidden" : false
},
"forcedVat" : true,
"vat1" : {
"id" : "5000123",
"code" : "7",
"rate" : 1.4658129805029452
},
"vat2" : {
"id" : "5000123",
"code" : "7",
"rate" : 1.4658129805029452
},
"vatAmount1" : 120,
"vatAmount2" : 110,
"vatAmount1Currency" : 126.57,
"vatAmount2Currency" : 113.26,
"guid" : "12004502",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"expenseType" : {
"id" : "5000123",
"code" : "MEAL",
"description" : "Plane",
"km" : false,
"notRefundable" : true,
"icon" : "fa fa-plane",
"color" : "00ff40",
"receiptRequired" : false,
"commentRequired" : false,
"guestsRequired" : false,
"notRefundableEditable" : true,
"billableEditable" : true,
"amountEditable" : true,
"showQuantity" : false,
"showAdditionalComment" : false,
"showReceiptNumber" : true,
"showAmountCategory" : true,
"showBillable" : true,
"hideVat" : false,
"vat1Code" : "1",
"vat2Code" : "2",
"vat3Code" : "3",
"expenseThreshold" : 100,
"defaultAmount" : 45,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"expenseCategory" : "{}",
"expenseRebillableOptions" : "{}",
"showCustomRequest" : true,
"showAmountWithoutVat" : true,
"controlsBehavior" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"calculateKilometers" : true,
"freeEntryProhibited" : true,
"controls" : {
"enableDuplicate" : true,
"enablelOnNonWorkingDay" : true,
"enableOnDayWithLeaveRequest" : true,
"enableOnDayWithTimesheetOrSchedule" : true
},
"expenseThresholdExceededNoVat" : false
},
"expenseTypeId" : "5000123",
"expenseDate" : "2020-01-31T23:59:59Z",
"rebillable" : true,
"notRefundable" : false,
"numberOfDocuments" : 2,
"syncError" : false,
"receiptNumber" : "AK0001",
"missionNumber" : "AK0001",
"kilometers" : 100,
"refused" : false,
"refusalComment" : "Lorem ipsum",
"refusingEmployee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"refusingEmployeeId" : "5000123",
"expenseReportId" : "5000123",
"dateOfDenial" : "2020-01-31T23:59:59Z",
"afterTaxAmountRefunded" : 12.23,
"afterTaxCurrencyAmountRefunded" : 11.17,
"preTaxAmountRefunded" : 10,
"preTaxCurrencyAmountRefunded" : 8.87,
"employeeAcceptationOfDenial" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeAcceptationOfDenialId" : "5000123",
"dateAcceptationOfDenial" : "2020-01-31T23:59:59Z",
"previousExpenseId" : "5000123",
"dateCancellationOfDenial" : "2020-01-31T23:59:59Z",
"employeeCancellationOfDenial" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeCancellationOfDenialId" : "5000123",
"preTaxExpenseAmount" : 20,
"guests" : [ {
"id" : "5000123",
"expenseId" : "5000123",
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}",
"title" : "GEN",
"phone" : "+33 6 04 04 04 05",
"mobilePhone" : "+33 6 00 00 00 01",
"email" : "myemail@bechmail.com",
"noTimesDunning" : true,
"assignmentMultiCompany" : false,
"modeTimeRecording" : 1,
"modeInputSchedule" : 3,
"timeRecordingInputMode" : "{}",
"scheduleInputMode" : "{}",
"executive" : true,
"generic" : true,
"candidate" : false,
"external" : false,
"managerMultiCompany" : true,
"employeeFunctions" : {
"allFunctions" : false,
"allSales" : true,
"allPurchases" : false,
"allOperational" : true,
"projectSalesManager" : false,
"projectFinanceManager" : true,
"projectProductionManager" : false,
"projectAccountManager" : true,
"projectAssignment" : false,
"projectPhaseManager" : true,
"projectSendOnMission" : false,
"salesSalesAssistant" : true,
"salesOrderAndEstimateTracking" : false,
"salesBillingSchedulesTracking" : true,
"purchasingBuyer" : false,
"timeRecording" : true,
"inputOfExpenseReport" : false,
"purchasesReceptionTracking" : false,
"inputSchedule" : false,
"CMMSContractSalesManager" : false,
"CMMSContractTechnicalManager" : false,
"CMMSMRAndEOManager" : false
},
"employeeHistory" : [ {
"id" : "5000123",
"employeeHistoryType" : "5000123",
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 7.42,
"weekHours" : 38.3,
"occupancyRate" : 0.8,
"manager" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"managerId" : "5000123",
"company" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo"
},
"companyId" : "5000123",
"directHourlyRate" : 10.42,
"standardHourlyRate" : 10,
"dailyCost" : 59.36,
"dailySellingPrice" : 80,
"entity" : "5000123",
"serviceRef" : {
"id" : "5000123",
"name" : "Professional services",
"code" : "PS"
},
"service" : "5000123",
"position" : "Developer",
"skillRef" : {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
},
"skill" : "5000123",
"family1" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family1Id" : "5000123",
"family2" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family2Id" : "5000123",
"family3" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family3Id" : "5000123",
"leave" : false,
"standardWeek" : {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
}
},
"standardWeekId" : "5000123",
"salary" : 1024
}, {
"id" : "5000123",
"employeeHistoryType" : "5000123",
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 7.42,
"weekHours" : 38.3,
"occupancyRate" : 0.8,
"manager" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"managerId" : "5000123",
"company" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo"
},
"companyId" : "5000123",
"directHourlyRate" : 10.42,
"standardHourlyRate" : 10,
"dailyCost" : 59.36,
"dailySellingPrice" : 80,
"entity" : "5000123",
"serviceRef" : {
"id" : "5000123",
"name" : "Professional services",
"code" : "PS"
},
"service" : "5000123",
"position" : "Developer",
"skillRef" : {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
},
"skill" : "5000123",
"family1" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family1Id" : "5000123",
"family2" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family2Id" : "5000123",
"family3" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family3Id" : "5000123",
"leave" : false,
"standardWeek" : {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
}
},
"standardWeekId" : "5000123",
"salary" : 1024
} ],
"companyChanges" : [ {
"id" : "5000123",
"employeeId" : "500123",
"companyId" : "5000123",
"startDate" : "2020-01-23T04:56:07Z",
"endDate" : "2020-01-23T04:56:07Z",
"companyChangeState" : "{}",
"comment" : "Limpso usum"
}, {
"id" : "5000123",
"employeeId" : "500123",
"companyId" : "5000123",
"startDate" : "2020-01-23T04:56:07Z",
"endDate" : "2020-01-23T04:56:07Z",
"companyChangeState" : "{}",
"comment" : "Limpso usum"
} ],
"timeRecordingRules" : {
"id" : "5000123",
"employeeId" : "5000123",
"min" : 0,
"max" : 24,
"step" : 0.01,
"prettyStep" : 0.3,
"base" : 60,
"unit" : "H",
"unitDuration" : "{}",
"allowManualEntry" : true,
"employeeWeeks" : [ {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
},
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 8,
"dailyMinutes" : 10,
"weekHours" : 40,
"leave" : false
}, {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
},
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 8,
"dailyMinutes" : 10,
"weekHours" : 40,
"leave" : false
} ],
"closingDates" : [ {
"closingDate" : "2020-01-31T23:59:59Z",
"module" : "DATE_MODULE",
"beginningOfPeriod" : "2020-01-31T23:59:59Z",
"endOfPeriod" : "2020-01-31T23:59:59Z"
}, {
"closingDate" : "2020-01-31T23:59:59Z",
"module" : "DATE_MODULE",
"beginningOfPeriod" : "2020-01-31T23:59:59Z",
"endOfPeriod" : "2020-01-31T23:59:59Z"
} ],
"simpleDuration" : 750,
"completionMode" : "WEEKLY"
},
"scheduleRules" : {
"id" : "5000123",
"employeeId" : "5000123",
"min" : 0,
"max" : 24,
"step" : 0.01,
"prettyStep" : 0.3,
"base" : 60,
"unit" : "H",
"unitDuration" : "{}",
"allowManualEntry" : true,
"employeeWeeks" : [ {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
},
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 8,
"dailyMinutes" : 10,
"weekHours" : 40,
"leave" : false
}, {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
},
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 8,
"dailyMinutes" : 10,
"weekHours" : 40,
"leave" : false
} ],
"closingDates" : [ {
"closingDate" : "2020-01-31T23:59:59Z",
"module" : "DATE_MODULE",
"beginningOfPeriod" : "2020-01-31T23:59:59Z",
"endOfPeriod" : "2020-01-31T23:59:59Z"
}, {
"closingDate" : "2020-01-31T23:59:59Z",
"module" : "DATE_MODULE",
"beginningOfPeriod" : "2020-01-31T23:59:59Z",
"endOfPeriod" : "2020-01-31T23:59:59Z"
} ],
"timestamped" : true
},
"businessCards" : [ {
"id" : "5000123",
"employeeId" : "5000123",
"cardNumber" : "XXXX XXXX XXXX 7568",
"encryptedCardNumber" : "0",
"name" : "Management card",
"type" : "{}",
"endDate" : "2020-01-31T23:59:59Z"
}, {
"id" : "5000123",
"employeeId" : "5000123",
"cardNumber" : "XXXX XXXX XXXX 7568",
"encryptedCardNumber" : "0",
"name" : "Management card",
"type" : "{}",
"endDate" : "2020-01-31T23:59:59Z"
} ],
"sector" : "Marketing",
"number" : "84",
"relations" : [ {
"id" : "5000123",
"relationType" : {
"id" : "5000123",
"code" : "TUTOR",
"name" : "Tutor for internship"
},
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"relatedEmployee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"relatedEmployeeId" : "5000123"
}, {
"id" : "5000123",
"relationType" : {
"id" : "5000123",
"code" : "TUTOR",
"name" : "Tutor for internship"
},
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"relatedEmployee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"relatedEmployeeId" : "5000123"
} ],
"employeeAbilities" : [ {
"id" : "5000123",
"skill" : {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
},
"level" : {
"id" : "5000123",
"code" : "EXP",
"name" : "Expert"
},
"startDate" : "2020-01-31T23:59:59Z",
"endDate" : "2020-01-31T23:59:59Z",
"employeeId" : "5000123"
}, {
"id" : "5000123",
"skill" : {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
},
"level" : {
"id" : "5000123",
"code" : "EXP",
"name" : "Expert"
},
"startDate" : "2020-01-31T23:59:59Z",
"endDate" : "2020-01-31T23:59:59Z",
"employeeId" : "5000123"
} ],
"jobType" : {
"id" : "5000123",
"companyCode" : "AKSAS",
"code" : "ADMIN",
"name" : "Administrator",
"category" : "{}",
"validity" : {
"type" : "{}",
"date" : "2000-06-21T04:56:07.000+00:00"
},
"default" : true
},
"jobTypeId" : "100245",
"address" : {
"id" : "id",
"line1" : "221B Baker Street",
"line2" : "2nd Floor",
"line3" : "First door at your right",
"cedex" : "CEDEX 14",
"postalCode" : "69002",
"city" : "London",
"country" : "FR (for 'FRANCE')",
"countryName" : "FRANCE",
"department" : "75 (for 'PARIS')",
"geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
"region" : "65 (for 'ILE DE FRANCE')",
"regionName" : "ILE DE FRANCE",
"phone" : "06 00 00 00 01",
"phone2" : "06 00 00 00 02",
"email" : "myemail@mail.com",
"mobilePhone" : "06 00 00 00 02",
"fax" : "04 00 00 00 07",
"webSite" : "mysite.com"
},
"addressId" : "5000123",
"birthDate" : "2000-06-21T04:56:07.000+00:00",
"customData" : {
"key" : {
"type" : "{}",
"value" : "Autoref 010520",
"name" : "Reference 4",
"realOrder" : 0,
"label" : "REFERENCE_4"
}
},
"color" : "#FF0000",
"targetTace" : 75,
"formConfig" : {
"type" : "{}",
"fields" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"controls" : {
"key" : {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}
},
"insertable" : true,
"editable" : false,
"deletable" : false,
"formSearchHidden" : false
},
"changeTracking" : {
"createdTime" : "2000-06-21T04:56:07.000+00:00",
"createdBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"createdById" : "5000123",
"modificationTime" : "2000-06-21T04:56:07.000+00:00",
"modificationBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"modificationById" : "5000123"
},
"vehicles" : [ {
"id" : "5000123",
"power" : 5,
"licensePlate" : "licensePlate",
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"expenseType" : {
"id" : "5000123",
"code" : "MEAL",
"description" : "Plane",
"km" : false,
"notRefundable" : true,
"icon" : "fa fa-plane",
"color" : "00ff40",
"receiptRequired" : false,
"commentRequired" : false,
"guestsRequired" : false,
"notRefundableEditable" : true,
"billableEditable" : true,
"amountEditable" : true,
"showQuantity" : false,
"showAdditionalComment" : false,
"showReceiptNumber" : true,
"showAmountCategory" : true,
"showBillable" : true,
"hideVat" : false,
"vat1Code" : "1",
"vat2Code" : "2",
"vat3Code" : "3",
"expenseThreshold" : 100,
"defaultAmount" : 45,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"expenseCategory" : "{}",
"expenseRebillableOptions" : "{}",
"showCustomRequest" : true,
"showAmountWithoutVat" : true,
"controlsBehavior" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"calculateKilometers" : true,
"freeEntryProhibited" : true,
"controls" : {
"enableDuplicate" : true,
"enablelOnNonWorkingDay" : true,
"enableOnDayWithLeaveRequest" : true,
"enableOnDayWithTimesheetOrSchedule" : true
},
"expenseThresholdExceededNoVat" : false
},
"expenseTypeId" : "5000123",
"endDate" : "2020-01-31T23:59:59Z"
}, {
"id" : "5000123",
"power" : 5,
"licensePlate" : "licensePlate",
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"expenseType" : {
"id" : "5000123",
"code" : "MEAL",
"description" : "Plane",
"km" : false,
"notRefundable" : true,
"icon" : "fa fa-plane",
"color" : "00ff40",
"receiptRequired" : false,
"commentRequired" : false,
"guestsRequired" : false,
"notRefundableEditable" : true,
"billableEditable" : true,
"amountEditable" : true,
"showQuantity" : false,
"showAdditionalComment" : false,
"showReceiptNumber" : true,
"showAmountCategory" : true,
"showBillable" : true,
"hideVat" : false,
"vat1Code" : "1",
"vat2Code" : "2",
"vat3Code" : "3",
"expenseThreshold" : 100,
"defaultAmount" : 45,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"expenseCategory" : "{}",
"expenseRebillableOptions" : "{}",
"showCustomRequest" : true,
"showAmountWithoutVat" : true,
"controlsBehavior" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"calculateKilometers" : true,
"freeEntryProhibited" : true,
"controls" : {
"enableDuplicate" : true,
"enablelOnNonWorkingDay" : true,
"enableOnDayWithLeaveRequest" : true,
"enableOnDayWithTimesheetOrSchedule" : true
},
"expenseThresholdExceededNoVat" : false
},
"expenseTypeId" : "5000123",
"endDate" : "2020-01-31T23:59:59Z"
} ],
"currentCompany" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo",
"legalName" : "legalName",
"siren" : "siren",
"siret" : "siret",
"calendar" : {
"id" : "5000123",
"code" : "Text",
"name" : "Text",
"default" : true,
"daysNotWorked" : [ 6, 6 ],
"holidays" : [ {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
}, {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
} ]
},
"calendarId" : "calendarId",
"color" : "color",
"currency" : {
"id" : "5000123",
"name" : "Euro",
"code" : "EUR",
"order" : 17,
"euro" : true,
"euroRate" : 0.9678,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"euroRateStartDate" : "2020-01-23T04:56:07Z",
"euroRateEndDate" : "2020-01-23T04:56:07Z"
},
"currencyId" : "currencyId",
"address" : {
"id" : "id",
"line1" : "221B Baker Street",
"line2" : "2nd Floor",
"line3" : "First door at your right",
"cedex" : "CEDEX 14",
"postalCode" : "69002",
"city" : "London",
"country" : "FR (for 'FRANCE')",
"countryName" : "FRANCE",
"department" : "75 (for 'PARIS')",
"geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
"region" : "65 (for 'ILE DE FRANCE')",
"regionName" : "ILE DE FRANCE",
"phone" : "06 00 00 00 01",
"phone2" : "06 00 00 00 02",
"email" : "myemail@mail.com",
"mobilePhone" : "06 00 00 00 02",
"fax" : "04 00 00 00 07",
"webSite" : "mysite.com"
},
"addressId" : "addressId"
},
"currentCompanyId" : "5000123",
"bankingInformation" : {
"id" : "5000123",
"sepa" : {
"bankDetails" : {
"entity" : "30002",
"counter" : "550",
"accountNumber" : "0000157841Z",
"key" : "25",
"domiciliation" : "AURA"
},
"bic" : {
"country" : "FR (for 'FRANCE')",
"bank" : "DAAE",
"location" : "PP",
"branch" : "CCT"
},
"iban" : {
"country" : "FR (for 'FRANCE')",
"key" : "69",
"accountNumber" : "0000157841Z"
}
},
"noneSepa" : {
"defaultBankDetail" : false,
"beneficiary" : {
"holder" : {
"name" : "RITA",
"firstName" : "BRITA",
"accountType" : "{}",
"accountNumber" : "123456789"
},
"bank" : {
"bankName" : "UBA",
"bankName2" : "UBA",
"bankType" : "{}",
"bankCode" : "C8",
"bankAddress" : {
"id" : "id",
"line1" : "221B Baker Street",
"line2" : "2nd Floor",
"line3" : "First door at your right",
"cedex" : "CEDEX 14",
"postalCode" : "69002",
"city" : "London",
"country" : "FR (for 'FRANCE')",
"countryName" : "FRANCE",
"department" : "75 (for 'PARIS')",
"geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
"region" : "65 (for 'ILE DE FRANCE')",
"regionName" : "ILE DE FRANCE",
"phone" : "06 00 00 00 01",
"phone2" : "06 00 00 00 02",
"email" : "myemail@mail.com",
"mobilePhone" : "06 00 00 00 02",
"fax" : "04 00 00 00 07",
"webSite" : "mysite.com"
}
}
},
"intermediate" : {
"holder" : {
"name" : "RITA",
"firstName" : "BRITA",
"accountType" : "{}",
"accountNumber" : "123456789"
},
"bank" : {
"bankName" : "UBA",
"bankName2" : "UBA",
"bankType" : "{}",
"bankCode" : "C8",
"bankAddress" : {
"id" : "id",
"line1" : "221B Baker Street",
"line2" : "2nd Floor",
"line3" : "First door at your right",
"cedex" : "CEDEX 14",
"postalCode" : "69002",
"city" : "London",
"country" : "FR (for 'FRANCE')",
"countryName" : "FRANCE",
"department" : "75 (for 'PARIS')",
"geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
"region" : "65 (for 'ILE DE FRANCE')",
"regionName" : "ILE DE FRANCE",
"phone" : "06 00 00 00 01",
"phone2" : "06 00 00 00 02",
"email" : "myemail@mail.com",
"mobilePhone" : "06 00 00 00 02",
"fax" : "04 00 00 00 07",
"webSite" : "mysite.com"
}
}
}
},
"statusChangeDate" : "2000-06-21T04:56:07.000+00:00",
"statusChangeArgument" : {
"comment" : "Comment",
"status" : "{}"
},
"validator" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"validatorId" : "5000123",
"action" : "{}",
"type" : "{}"
},
"faxNumber" : "418 643 3210",
"phoneExtensionNumber" : "04 00 00 00 07"
},
"employeeId" : "5000123",
"lastName" : "DOE",
"firstName" : "John",
"company" : "AKSAS"
}, {
"id" : "5000123",
"expenseId" : "5000123",
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}",
"title" : "GEN",
"phone" : "+33 6 04 04 04 05",
"mobilePhone" : "+33 6 00 00 00 01",
"email" : "myemail@bechmail.com",
"noTimesDunning" : true,
"assignmentMultiCompany" : false,
"modeTimeRecording" : 1,
"modeInputSchedule" : 3,
"timeRecordingInputMode" : "{}",
"scheduleInputMode" : "{}",
"executive" : true,
"generic" : true,
"candidate" : false,
"external" : false,
"managerMultiCompany" : true,
"employeeFunctions" : {
"allFunctions" : false,
"allSales" : true,
"allPurchases" : false,
"allOperational" : true,
"projectSalesManager" : false,
"projectFinanceManager" : true,
"projectProductionManager" : false,
"projectAccountManager" : true,
"projectAssignment" : false,
"projectPhaseManager" : true,
"projectSendOnMission" : false,
"salesSalesAssistant" : true,
"salesOrderAndEstimateTracking" : false,
"salesBillingSchedulesTracking" : true,
"purchasingBuyer" : false,
"timeRecording" : true,
"inputOfExpenseReport" : false,
"purchasesReceptionTracking" : false,
"inputSchedule" : false,
"CMMSContractSalesManager" : false,
"CMMSContractTechnicalManager" : false,
"CMMSMRAndEOManager" : false
},
"employeeHistory" : [ {
"id" : "5000123",
"employeeHistoryType" : "5000123",
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 7.42,
"weekHours" : 38.3,
"occupancyRate" : 0.8,
"manager" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"managerId" : "5000123",
"company" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo"
},
"companyId" : "5000123",
"directHourlyRate" : 10.42,
"standardHourlyRate" : 10,
"dailyCost" : 59.36,
"dailySellingPrice" : 80,
"entity" : "5000123",
"serviceRef" : {
"id" : "5000123",
"name" : "Professional services",
"code" : "PS"
},
"service" : "5000123",
"position" : "Developer",
"skillRef" : {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
},
"skill" : "5000123",
"family1" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family1Id" : "5000123",
"family2" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family2Id" : "5000123",
"family3" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family3Id" : "5000123",
"leave" : false,
"standardWeek" : {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
}
},
"standardWeekId" : "5000123",
"salary" : 1024
}, {
"id" : "5000123",
"employeeHistoryType" : "5000123",
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 7.42,
"weekHours" : 38.3,
"occupancyRate" : 0.8,
"manager" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"managerId" : "5000123",
"company" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo"
},
"companyId" : "5000123",
"directHourlyRate" : 10.42,
"standardHourlyRate" : 10,
"dailyCost" : 59.36,
"dailySellingPrice" : 80,
"entity" : "5000123",
"serviceRef" : {
"id" : "5000123",
"name" : "Professional services",
"code" : "PS"
},
"service" : "5000123",
"position" : "Developer",
"skillRef" : {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
},
"skill" : "5000123",
"family1" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family1Id" : "5000123",
"family2" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family2Id" : "5000123",
"family3" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family3Id" : "5000123",
"leave" : false,
"standardWeek" : {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
}
},
"standardWeekId" : "5000123",
"salary" : 1024
} ],
"companyChanges" : [ {
"id" : "5000123",
"employeeId" : "500123",
"companyId" : "5000123",
"startDate" : "2020-01-23T04:56:07Z",
"endDate" : "2020-01-23T04:56:07Z",
"companyChangeState" : "{}",
"comment" : "Limpso usum"
}, {
"id" : "5000123",
"employeeId" : "500123",
"companyId" : "5000123",
"startDate" : "2020-01-23T04:56:07Z",
"endDate" : "2020-01-23T04:56:07Z",
"companyChangeState" : "{}",
"comment" : "Limpso usum"
} ],
"timeRecordingRules" : {
"id" : "5000123",
"employeeId" : "5000123",
"min" : 0,
"max" : 24,
"step" : 0.01,
"prettyStep" : 0.3,
"base" : 60,
"unit" : "H",
"unitDuration" : "{}",
"allowManualEntry" : true,
"employeeWeeks" : [ {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
},
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 8,
"dailyMinutes" : 10,
"weekHours" : 40,
"leave" : false
}, {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
},
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 8,
"dailyMinutes" : 10,
"weekHours" : 40,
"leave" : false
} ],
"closingDates" : [ {
"closingDate" : "2020-01-31T23:59:59Z",
"module" : "DATE_MODULE",
"beginningOfPeriod" : "2020-01-31T23:59:59Z",
"endOfPeriod" : "2020-01-31T23:59:59Z"
}, {
"closingDate" : "2020-01-31T23:59:59Z",
"module" : "DATE_MODULE",
"beginningOfPeriod" : "2020-01-31T23:59:59Z",
"endOfPeriod" : "2020-01-31T23:59:59Z"
} ],
"simpleDuration" : 750,
"completionMode" : "WEEKLY"
},
"scheduleRules" : {
"id" : "5000123",
"employeeId" : "5000123",
"min" : 0,
"max" : 24,
"step" : 0.01,
"prettyStep" : 0.3,
"base" : 60,
"unit" : "H",
"unitDuration" : "{}",
"allowManualEntry" : true,
"employeeWeeks" : [ {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
},
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 8,
"dailyMinutes" : 10,
"weekHours" : 40,
"leave" : false
}, {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
},
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 8,
"dailyMinutes" : 10,
"weekHours" : 40,
"leave" : false
} ],
"closingDates" : [ {
"closingDate" : "2020-01-31T23:59:59Z",
"module" : "DATE_MODULE",
"beginningOfPeriod" : "2020-01-31T23:59:59Z",
"endOfPeriod" : "2020-01-31T23:59:59Z"
}, {
"closingDate" : "2020-01-31T23:59:59Z",
"module" : "DATE_MODULE",
"beginningOfPeriod" : "2020-01-31T23:59:59Z",
"endOfPeriod" : "2020-01-31T23:59:59Z"
} ],
"timestamped" : true
},
"businessCards" : [ {
"id" : "5000123",
"employeeId" : "5000123",
"cardNumber" : "XXXX XXXX XXXX 7568",
"encryptedCardNumber" : "0",
"name" : "Management card",
"type" : "{}",
"endDate" : "2020-01-31T23:59:59Z"
}, {
"id" : "5000123",
"employeeId" : "5000123",
"cardNumber" : "XXXX XXXX XXXX 7568",
"encryptedCardNumber" : "0",
"name" : "Management card",
"type" : "{}",
"endDate" : "2020-01-31T23:59:59Z"
} ],
"sector" : "Marketing",
"number" : "84",
"relations" : [ {
"id" : "5000123",
"relationType" : {
"id" : "5000123",
"code" : "TUTOR",
"name" : "Tutor for internship"
},
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"relatedEmployee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"relatedEmployeeId" : "5000123"
}, {
"id" : "5000123",
"relationType" : {
"id" : "5000123",
"code" : "TUTOR",
"name" : "Tutor for internship"
},
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"relatedEmployee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"relatedEmployeeId" : "5000123"
} ],
"employeeAbilities" : [ {
"id" : "5000123",
"skill" : {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
},
"level" : {
"id" : "5000123",
"code" : "EXP",
"name" : "Expert"
},
"startDate" : "2020-01-31T23:59:59Z",
"endDate" : "2020-01-31T23:59:59Z",
"employeeId" : "5000123"
}, {
"id" : "5000123",
"skill" : {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
},
"level" : {
"id" : "5000123",
"code" : "EXP",
"name" : "Expert"
},
"startDate" : "2020-01-31T23:59:59Z",
"endDate" : "2020-01-31T23:59:59Z",
"employeeId" : "5000123"
} ],
"jobType" : {
"id" : "5000123",
"companyCode" : "AKSAS",
"code" : "ADMIN",
"name" : "Administrator",
"category" : "{}",
"validity" : {
"type" : "{}",
"date" : "2000-06-21T04:56:07.000+00:00"
},
"default" : true
},
"jobTypeId" : "100245",
"address" : {
"id" : "id",
"line1" : "221B Baker Street",
"line2" : "2nd Floor",
"line3" : "First door at your right",
"cedex" : "CEDEX 14",
"postalCode" : "69002",
"city" : "London",
"country" : "FR (for 'FRANCE')",
"countryName" : "FRANCE",
"department" : "75 (for 'PARIS')",
"geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
"region" : "65 (for 'ILE DE FRANCE')",
"regionName" : "ILE DE FRANCE",
"phone" : "06 00 00 00 01",
"phone2" : "06 00 00 00 02",
"email" : "myemail@mail.com",
"mobilePhone" : "06 00 00 00 02",
"fax" : "04 00 00 00 07",
"webSite" : "mysite.com"
},
"addressId" : "5000123",
"birthDate" : "2000-06-21T04:56:07.000+00:00",
"customData" : {
"key" : {
"type" : "{}",
"value" : "Autoref 010520",
"name" : "Reference 4",
"realOrder" : 0,
"label" : "REFERENCE_4"
}
},
"color" : "#FF0000",
"targetTace" : 75,
"formConfig" : {
"type" : "{}",
"fields" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"controls" : {
"key" : {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}
},
"insertable" : true,
"editable" : false,
"deletable" : false,
"formSearchHidden" : false
},
"changeTracking" : {
"createdTime" : "2000-06-21T04:56:07.000+00:00",
"createdBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"createdById" : "5000123",
"modificationTime" : "2000-06-21T04:56:07.000+00:00",
"modificationBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"modificationById" : "5000123"
},
"vehicles" : [ {
"id" : "5000123",
"power" : 5,
"licensePlate" : "licensePlate",
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"expenseType" : {
"id" : "5000123",
"code" : "MEAL",
"description" : "Plane",
"km" : false,
"notRefundable" : true,
"icon" : "fa fa-plane",
"color" : "00ff40",
"receiptRequired" : false,
"commentRequired" : false,
"guestsRequired" : false,
"notRefundableEditable" : true,
"billableEditable" : true,
"amountEditable" : true,
"showQuantity" : false,
"showAdditionalComment" : false,
"showReceiptNumber" : true,
"showAmountCategory" : true,
"showBillable" : true,
"hideVat" : false,
"vat1Code" : "1",
"vat2Code" : "2",
"vat3Code" : "3",
"expenseThreshold" : 100,
"defaultAmount" : 45,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"expenseCategory" : "{}",
"expenseRebillableOptions" : "{}",
"showCustomRequest" : true,
"showAmountWithoutVat" : true,
"controlsBehavior" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"calculateKilometers" : true,
"freeEntryProhibited" : true,
"controls" : {
"enableDuplicate" : true,
"enablelOnNonWorkingDay" : true,
"enableOnDayWithLeaveRequest" : true,
"enableOnDayWithTimesheetOrSchedule" : true
},
"expenseThresholdExceededNoVat" : false
},
"expenseTypeId" : "5000123",
"endDate" : "2020-01-31T23:59:59Z"
}, {
"id" : "5000123",
"power" : 5,
"licensePlate" : "licensePlate",
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"expenseType" : {
"id" : "5000123",
"code" : "MEAL",
"description" : "Plane",
"km" : false,
"notRefundable" : true,
"icon" : "fa fa-plane",
"color" : "00ff40",
"receiptRequired" : false,
"commentRequired" : false,
"guestsRequired" : false,
"notRefundableEditable" : true,
"billableEditable" : true,
"amountEditable" : true,
"showQuantity" : false,
"showAdditionalComment" : false,
"showReceiptNumber" : true,
"showAmountCategory" : true,
"showBillable" : true,
"hideVat" : false,
"vat1Code" : "1",
"vat2Code" : "2",
"vat3Code" : "3",
"expenseThreshold" : 100,
"defaultAmount" : 45,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"expenseCategory" : "{}",
"expenseRebillableOptions" : "{}",
"showCustomRequest" : true,
"showAmountWithoutVat" : true,
"controlsBehavior" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"calculateKilometers" : true,
"freeEntryProhibited" : true,
"controls" : {
"enableDuplicate" : true,
"enablelOnNonWorkingDay" : true,
"enableOnDayWithLeaveRequest" : true,
"enableOnDayWithTimesheetOrSchedule" : true
},
"expenseThresholdExceededNoVat" : false
},
"expenseTypeId" : "5000123",
"endDate" : "2020-01-31T23:59:59Z"
} ],
"currentCompany" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo",
"legalName" : "legalName",
"siren" : "siren",
"siret" : "siret",
"calendar" : {
"id" : "5000123",
"code" : "Text",
"name" : "Text",
"default" : true,
"daysNotWorked" : [ 6, 6 ],
"holidays" : [ {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
}, {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
} ]
},
"calendarId" : "calendarId",
"color" : "color",
"currency" : {
"id" : "5000123",
"name" : "Euro",
"code" : "EUR",
"order" : 17,
"euro" : true,
"euroRate" : 0.9678,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"euroRateStartDate" : "2020-01-23T04:56:07Z",
"euroRateEndDate" : "2020-01-23T04:56:07Z"
},
"currencyId" : "currencyId",
"address" : {
"id" : "id",
"line1" : "221B Baker Street",
"line2" : "2nd Floor",
"line3" : "First door at your right",
"cedex" : "CEDEX 14",
"postalCode" : "69002",
"city" : "London",
"country" : "FR (for 'FRANCE')",
"countryName" : "FRANCE",
"department" : "75 (for 'PARIS')",
"geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
"region" : "65 (for 'ILE DE FRANCE')",
"regionName" : "ILE DE FRANCE",
"phone" : "06 00 00 00 01",
"phone2" : "06 00 00 00 02",
"email" : "myemail@mail.com",
"mobilePhone" : "06 00 00 00 02",
"fax" : "04 00 00 00 07",
"webSite" : "mysite.com"
},
"addressId" : "addressId"
},
"currentCompanyId" : "5000123",
"bankingInformation" : {
"id" : "5000123",
"sepa" : {
"bankDetails" : {
"entity" : "30002",
"counter" : "550",
"accountNumber" : "0000157841Z",
"key" : "25",
"domiciliation" : "AURA"
},
"bic" : {
"country" : "FR (for 'FRANCE')",
"bank" : "DAAE",
"location" : "PP",
"branch" : "CCT"
},
"iban" : {
"country" : "FR (for 'FRANCE')",
"key" : "69",
"accountNumber" : "0000157841Z"
}
},
"noneSepa" : {
"defaultBankDetail" : false,
"beneficiary" : {
"holder" : {
"name" : "RITA",
"firstName" : "BRITA",
"accountType" : "{}",
"accountNumber" : "123456789"
},
"bank" : {
"bankName" : "UBA",
"bankName2" : "UBA",
"bankType" : "{}",
"bankCode" : "C8",
"bankAddress" : {
"id" : "id",
"line1" : "221B Baker Street",
"line2" : "2nd Floor",
"line3" : "First door at your right",
"cedex" : "CEDEX 14",
"postalCode" : "69002",
"city" : "London",
"country" : "FR (for 'FRANCE')",
"countryName" : "FRANCE",
"department" : "75 (for 'PARIS')",
"geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
"region" : "65 (for 'ILE DE FRANCE')",
"regionName" : "ILE DE FRANCE",
"phone" : "06 00 00 00 01",
"phone2" : "06 00 00 00 02",
"email" : "myemail@mail.com",
"mobilePhone" : "06 00 00 00 02",
"fax" : "04 00 00 00 07",
"webSite" : "mysite.com"
}
}
},
"intermediate" : {
"holder" : {
"name" : "RITA",
"firstName" : "BRITA",
"accountType" : "{}",
"accountNumber" : "123456789"
},
"bank" : {
"bankName" : "UBA",
"bankName2" : "UBA",
"bankType" : "{}",
"bankCode" : "C8",
"bankAddress" : {
"id" : "id",
"line1" : "221B Baker Street",
"line2" : "2nd Floor",
"line3" : "First door at your right",
"cedex" : "CEDEX 14",
"postalCode" : "69002",
"city" : "London",
"country" : "FR (for 'FRANCE')",
"countryName" : "FRANCE",
"department" : "75 (for 'PARIS')",
"geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
"region" : "65 (for 'ILE DE FRANCE')",
"regionName" : "ILE DE FRANCE",
"phone" : "06 00 00 00 01",
"phone2" : "06 00 00 00 02",
"email" : "myemail@mail.com",
"mobilePhone" : "06 00 00 00 02",
"fax" : "04 00 00 00 07",
"webSite" : "mysite.com"
}
}
}
},
"statusChangeDate" : "2000-06-21T04:56:07.000+00:00",
"statusChangeArgument" : {
"comment" : "Comment",
"status" : "{}"
},
"validator" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"validatorId" : "5000123",
"action" : "{}",
"type" : "{}"
},
"faxNumber" : "418 643 3210",
"phoneExtensionNumber" : "04 00 00 00 07"
},
"employeeId" : "5000123",
"lastName" : "DOE",
"firstName" : "John",
"company" : "AKSAS"
} ],
"fiscalPower" : {
"id" : "5000123",
"power" : 5,
"rate" : 0.36,
"startDate" : "2020-01-31T23:59:59Z",
"endDate" : "2020-01-31T23:59:59Z",
"expenseTypeId" : "5000123"
},
"currency" : {
"id" : "5000123",
"name" : "Euro",
"code" : "EUR",
"order" : 17,
"euro" : true,
"euroRate" : 0.9678,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"euroRateStartDate" : "2020-01-23T04:56:07Z",
"euroRateEndDate" : "2020-01-23T04:56:07Z"
},
"currencyCode" : "EUR",
"parts" : 2,
"amountCategory" : "{}",
"alerts" : [ {
"message" : "Lorem ipsum",
"level" : "ERROR"
}, {
"message" : "Lorem ipsum",
"level" : "ERROR"
} ],
"customAssignment" : "CST_PROJECT",
"businessCard" : true,
"documents" : [ {
"id" : "5000123",
"title" : "Title",
"versionId" : "5000123",
"changeTracking" : {
"createdTime" : "2000-06-21T04:56:07.000+00:00",
"createdBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"createdById" : "5000123",
"modificationTime" : "2000-06-21T04:56:07.000+00:00",
"modificationBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"modificationById" : "5000123"
},
"publishedBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"publishedById" : "5001206",
"classification" : "STD",
"subClassification" : "EDITIONS",
"category1" : "CAT1",
"category2" : "CAT2",
"category3" : "CAT3",
"companyId" : "5000123",
"publicationDate" : "2000-06-21T04:56:07.000+00:00",
"version" : 1,
"documentType" : "File",
"fileUrl" : "myFiles/thisFile.pdf",
"fileName" : "thisFile.pdf",
"lienUrl" : "myStorage.com/myFiles/thisFile.pdf",
"url" : "myFiles/thisFile.pdf",
"original" : false,
"preview" : "data:image",
"tokenPreview" : "8946A85V85D851DF",
"externalDMSUuid" : "OD1245126",
"links" : [ {
"id" : "5000123",
"original" : true,
"documentId" : "5000123",
"objectId" : "5000123",
"objectType" : "{}"
}, {
"id" : "5000123",
"original" : true,
"documentId" : "5000123",
"objectId" : "5000123",
"objectType" : "{}"
} ],
"archived" : false,
"action" : "{}",
"owner" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"ownerId" : "5001206",
"description" : "Text",
"category" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"categoryId" : "100024",
"subCategory" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"company" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo",
"legalName" : "legalName",
"siren" : "siren",
"siret" : "siret",
"calendar" : {
"id" : "5000123",
"code" : "Text",
"name" : "Text",
"default" : true,
"daysNotWorked" : [ 6, 6 ],
"holidays" : [ {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
}, {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
} ]
},
"calendarId" : "calendarId",
"color" : "color",
"currency" : {
"id" : "5000123",
"name" : "Euro",
"code" : "EUR",
"order" : 17,
"euro" : true,
"euroRate" : 0.9678,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"euroRateStartDate" : "2020-01-23T04:56:07Z",
"euroRateEndDate" : "2020-01-23T04:56:07Z"
},
"currencyId" : "currencyId",
"address" : {
"id" : "id",
"line1" : "221B Baker Street",
"line2" : "2nd Floor",
"line3" : "First door at your right",
"cedex" : "CEDEX 14",
"postalCode" : "69002",
"city" : "London",
"country" : "FR (for 'FRANCE')",
"countryName" : "FRANCE",
"department" : "75 (for 'PARIS')",
"geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
"region" : "65 (for 'ILE DE FRANCE')",
"regionName" : "ILE DE FRANCE",
"phone" : "06 00 00 00 01",
"phone2" : "06 00 00 00 02",
"email" : "myemail@mail.com",
"mobilePhone" : "06 00 00 00 02",
"fax" : "04 00 00 00 07",
"webSite" : "mysite.com"
},
"addressId" : "addressId"
},
"companyId" : "5000123",
"type" : "{}",
"category" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"categoryId" : "500143",
"grouping" : "grouping",
"ranking" : 2
},
"subCategoryId" : "11037",
"locked" : false
}, {
"id" : "5000123",
"title" : "Title",
"versionId" : "5000123",
"changeTracking" : {
"createdTime" : "2000-06-21T04:56:07.000+00:00",
"createdBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"createdById" : "5000123",
"modificationTime" : "2000-06-21T04:56:07.000+00:00",
"modificationBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"modificationById" : "5000123"
},
"publishedBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"publishedById" : "5001206",
"classification" : "STD",
"subClassification" : "EDITIONS",
"category1" : "CAT1",
"category2" : "CAT2",
"category3" : "CAT3",
"companyId" : "5000123",
"publicationDate" : "2000-06-21T04:56:07.000+00:00",
"version" : 1,
"documentType" : "File",
"fileUrl" : "myFiles/thisFile.pdf",
"fileName" : "thisFile.pdf",
"lienUrl" : "myStorage.com/myFiles/thisFile.pdf",
"url" : "myFiles/thisFile.pdf",
"original" : false,
"preview" : "data:image",
"tokenPreview" : "8946A85V85D851DF",
"externalDMSUuid" : "OD1245126",
"links" : [ {
"id" : "5000123",
"original" : true,
"documentId" : "5000123",
"objectId" : "5000123",
"objectType" : "{}"
}, {
"id" : "5000123",
"original" : true,
"documentId" : "5000123",
"objectId" : "5000123",
"objectType" : "{}"
} ],
"archived" : false,
"action" : "{}",
"owner" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"ownerId" : "5001206",
"description" : "Text",
"category" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"categoryId" : "100024",
"subCategory" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"company" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo",
"legalName" : "legalName",
"siren" : "siren",
"siret" : "siret",
"calendar" : {
"id" : "5000123",
"code" : "Text",
"name" : "Text",
"default" : true,
"daysNotWorked" : [ 6, 6 ],
"holidays" : [ {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
}, {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
} ]
},
"calendarId" : "calendarId",
"color" : "color",
"currency" : {
"id" : "5000123",
"name" : "Euro",
"code" : "EUR",
"order" : 17,
"euro" : true,
"euroRate" : 0.9678,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"euroRateStartDate" : "2020-01-23T04:56:07Z",
"euroRateEndDate" : "2020-01-23T04:56:07Z"
},
"currencyId" : "currencyId",
"address" : {
"id" : "id",
"line1" : "221B Baker Street",
"line2" : "2nd Floor",
"line3" : "First door at your right",
"cedex" : "CEDEX 14",
"postalCode" : "69002",
"city" : "London",
"country" : "FR (for 'FRANCE')",
"countryName" : "FRANCE",
"department" : "75 (for 'PARIS')",
"geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
"region" : "65 (for 'ILE DE FRANCE')",
"regionName" : "ILE DE FRANCE",
"phone" : "06 00 00 00 01",
"phone2" : "06 00 00 00 02",
"email" : "myemail@mail.com",
"mobilePhone" : "06 00 00 00 02",
"fax" : "04 00 00 00 07",
"webSite" : "mysite.com"
},
"addressId" : "addressId"
},
"companyId" : "5000123",
"type" : "{}",
"category" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"categoryId" : "500143",
"grouping" : "grouping",
"ranking" : 2
},
"subCategoryId" : "11037",
"locked" : false
} ],
"changeTracking" : {
"createdTime" : "2000-06-21T04:56:07.000+00:00",
"createdBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"createdById" : "5000123",
"modificationTime" : "2000-06-21T04:56:07.000+00:00",
"modificationBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"modificationById" : "5000123"
},
"smartScan" : "{}",
"customRequest" : {
"id" : "5000123",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJT_001",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"subPhase" : {
"id" : "5000123",
"code" : "SB_1",
"name" : "Sub Phase 1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"order" : 1
},
"subPhaseId" : "51000122",
"projectTask" : {
"id" : "5000123",
"code" : "code",
"name" : "Team building",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJT_001",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"subPhase" : {
"id" : "5000123",
"code" : "SB_1",
"name" : "Sub Phase 1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"order" : 1
},
"subPhaseId" : "51000122",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"order" : 2,
"startDate" : "2000-06-21T04:56:07.000+00:00",
"endDate" : "2000-06-21T04:56:07.000+00:00",
"description" : "description"
},
"projectTaskId" : "5000123",
"number" : "CC00001",
"name" : "Label for my doc",
"type" : "{}",
"companyCode" : "AKSAS",
"companyId" : "5000123",
"currencyCode" : "EUR",
"currency" : {
"id" : "5000123",
"name" : "Euro",
"code" : "EUR",
"order" : 17,
"euro" : true,
"euroRate" : 0.9678,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"euroRateStartDate" : "2020-01-23T04:56:07Z",
"euroRateEndDate" : "2020-01-23T04:56:07Z"
},
"date" : "2000-06-21T04:56:07.000+00:00",
"description" : "Lorem ipsum",
"entityCode" : "Lyon",
"afterTaxAmount" : 120.37,
"preTaxAmount" : 100.14,
"thirdPartyId" : "CUSTOMER01",
"customData" : {
"key" : {
"type" : "{}",
"value" : "Autoref 010520",
"name" : "Reference 4",
"realOrder" : 0,
"label" : "REFERENCE_4"
}
},
"changeTracking" : {
"createdTime" : "2000-06-21T04:56:07.000+00:00",
"createdBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"createdById" : "5000123",
"modificationTime" : "2000-06-21T04:56:07.000+00:00",
"modificationBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"modificationById" : "5000123"
},
"approvalState" : "{}",
"approvalDate" : "2000-06-21T04:56:07.000+00:00",
"lines" : [ {
"id" : "5000123",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJT_001",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"subPhase" : {
"id" : "5000123",
"code" : "SB_1",
"name" : "Sub Phase 1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"order" : 1
},
"subPhaseId" : "51000122",
"projectTask" : {
"id" : "5000123",
"code" : "code",
"name" : "Team building",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJT_001",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"subPhase" : {
"id" : "5000123",
"code" : "SB_1",
"name" : "Sub Phase 1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"order" : 1
},
"subPhaseId" : "51000122",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"order" : 2,
"startDate" : "2000-06-21T04:56:07.000+00:00",
"endDate" : "2000-06-21T04:56:07.000+00:00",
"description" : "description"
},
"projectTaskId" : "5000123",
"managementObjectId" : "5000123",
"name" : "Helpdesk",
"quantity" : 3,
"unitPriceCurrency" : 36.32,
"unitPrice" : 40,
"amountTotalCurrency" : 1200,
"amountTotal" : 1200,
"rankNumber" : 2,
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"expenseTypeExpected" : {
"id" : "5000123",
"code" : "AIR-PL",
"name" : "Airplane",
"description" : "Transportation",
"endDate" : "2000-06-21T04:56:07.000+00:00",
"expenseType" : {
"id" : "5000123",
"code" : "MEAL",
"description" : "Plane",
"km" : false,
"notRefundable" : true,
"icon" : "fa fa-plane",
"color" : "00ff40",
"receiptRequired" : false,
"commentRequired" : false,
"guestsRequired" : false,
"notRefundableEditable" : true,
"billableEditable" : true,
"amountEditable" : true,
"showQuantity" : false,
"showAdditionalComment" : false,
"showReceiptNumber" : true,
"showAmountCategory" : true,
"showBillable" : true,
"hideVat" : false,
"vat1Code" : "1",
"vat2Code" : "2",
"vat3Code" : "3",
"expenseThreshold" : 100,
"defaultAmount" : 45,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"expenseCategory" : "{}",
"expenseRebillableOptions" : "{}",
"showCustomRequest" : true,
"showAmountWithoutVat" : true,
"controlsBehavior" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"calculateKilometers" : true,
"freeEntryProhibited" : true,
"controls" : {
"enableDuplicate" : true,
"enablelOnNonWorkingDay" : true,
"enableOnDayWithLeaveRequest" : true,
"enableOnDayWithTimesheetOrSchedule" : true
},
"expenseThresholdExceededNoVat" : false
},
"expenseTypeId" : "expenseTypeId",
"editableExpenseReport" : true,
"defaultExpenseReport" : true
},
"expenseTypeExpectedId" : "5000123",
"isExpenseReport" : true
}, {
"id" : "5000123",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJT_001",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"subPhase" : {
"id" : "5000123",
"code" : "SB_1",
"name" : "Sub Phase 1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"order" : 1
},
"subPhaseId" : "51000122",
"projectTask" : {
"id" : "5000123",
"code" : "code",
"name" : "Team building",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJT_001",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"subPhase" : {
"id" : "5000123",
"code" : "SB_1",
"name" : "Sub Phase 1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"order" : 1
},
"subPhaseId" : "51000122",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"order" : 2,
"startDate" : "2000-06-21T04:56:07.000+00:00",
"endDate" : "2000-06-21T04:56:07.000+00:00",
"description" : "description"
},
"projectTaskId" : "5000123",
"managementObjectId" : "5000123",
"name" : "Helpdesk",
"quantity" : 3,
"unitPriceCurrency" : 36.32,
"unitPrice" : 40,
"amountTotalCurrency" : 1200,
"amountTotal" : 1200,
"rankNumber" : 2,
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"expenseTypeExpected" : {
"id" : "5000123",
"code" : "AIR-PL",
"name" : "Airplane",
"description" : "Transportation",
"endDate" : "2000-06-21T04:56:07.000+00:00",
"expenseType" : {
"id" : "5000123",
"code" : "MEAL",
"description" : "Plane",
"km" : false,
"notRefundable" : true,
"icon" : "fa fa-plane",
"color" : "00ff40",
"receiptRequired" : false,
"commentRequired" : false,
"guestsRequired" : false,
"notRefundableEditable" : true,
"billableEditable" : true,
"amountEditable" : true,
"showQuantity" : false,
"showAdditionalComment" : false,
"showReceiptNumber" : true,
"showAmountCategory" : true,
"showBillable" : true,
"hideVat" : false,
"vat1Code" : "1",
"vat2Code" : "2",
"vat3Code" : "3",
"expenseThreshold" : 100,
"defaultAmount" : 45,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"expenseCategory" : "{}",
"expenseRebillableOptions" : "{}",
"showCustomRequest" : true,
"showAmountWithoutVat" : true,
"controlsBehavior" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"calculateKilometers" : true,
"freeEntryProhibited" : true,
"controls" : {
"enableDuplicate" : true,
"enablelOnNonWorkingDay" : true,
"enableOnDayWithLeaveRequest" : true,
"enableOnDayWithTimesheetOrSchedule" : true
},
"expenseThresholdExceededNoVat" : false
},
"expenseTypeId" : "expenseTypeId",
"editableExpenseReport" : true,
"defaultExpenseReport" : true
},
"expenseTypeExpectedId" : "5000123",
"isExpenseReport" : true
} ],
"category" : {
"id" : "50000012",
"code" : "CATEGORY_1",
"name" : "Category one",
"endDate" : "2000-06-21T04:56:07.000+00:00",
"icon" : "fas fa-pen",
"companyId" : "companyId",
"enableActualDates" : true,
"enableEndDate" : true,
"editableWithoutExpense" : true,
"defaultValueWithoutExpense" : true,
"scheduleCreation" : true,
"timesheetCreation" : true,
"departureLocation" : true,
"departureLocationType" : "{}",
"destinationLocation" : true,
"destinationLocationType" : "{}",
"accreditationLevelType" : 1,
"accreditationOptions" : "{}",
"displayCustomData" : true,
"customDataStart" : 1,
"customDataEnd" : 9,
"customDataNbColumns" : 2
},
"categoryId" : "5000123",
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}",
"title" : "GEN",
"phone" : "+33 6 04 04 04 05",
"mobilePhone" : "+33 6 00 00 00 01",
"email" : "myemail@bechmail.com",
"noTimesDunning" : true,
"assignmentMultiCompany" : false,
"modeTimeRecording" : 1,
"modeInputSchedule" : 3,
"timeRecordingInputMode" : "{}",
"scheduleInputMode" : "{}",
"executive" : true,
"generic" : true,
"candidate" : false,
"external" : false,
"managerMultiCompany" : true,
"employeeFunctions" : {
"allFunctions" : false,
"allSales" : true,
"allPurchases" : false,
"allOperational" : true,
"projectSalesManager" : false,
"projectFinanceManager" : true,
"projectProductionManager" : false,
"projectAccountManager" : true,
"projectAssignment" : false,
"projectPhaseManager" : true,
"projectSendOnMission" : false,
"salesSalesAssistant" : true,
"salesOrderAndEstimateTracking" : false,
"salesBillingSchedulesTracking" : true,
"purchasingBuyer" : false,
"timeRecording" : true,
"inputOfExpenseReport" : false,
"purchasesReceptionTracking" : false,
"inputSchedule" : false,
"CMMSContractSalesManager" : false,
"CMMSContractTechnicalManager" : false,
"CMMSMRAndEOManager" : false
},
"employeeHistory" : [ {
"id" : "5000123",
"employeeHistoryType" : "5000123",
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 7.42,
"weekHours" : 38.3,
"occupancyRate" : 0.8,
"manager" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"managerId" : "5000123",
"company" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo"
},
"companyId" : "5000123",
"directHourlyRate" : 10.42,
"standardHourlyRate" : 10,
"dailyCost" : 59.36,
"dailySellingPrice" : 80,
"entity" : "5000123",
"serviceRef" : {
"id" : "5000123",
"name" : "Professional services",
"code" : "PS"
},
"service" : "5000123",
"position" : "Developer",
"skillRef" : {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
},
"skill" : "5000123",
"family1" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family1Id" : "5000123",
"family2" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family2Id" : "5000123",
"family3" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family3Id" : "5000123",
"leave" : false,
"standardWeek" : {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
}
},
"standardWeekId" : "5000123",
"salary" : 1024
}, {
"id" : "5000123",
"employeeHistoryType" : "5000123",
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 7.42,
"weekHours" : 38.3,
"occupancyRate" : 0.8,
"manager" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"managerId" : "5000123",
"company" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo"
},
"companyId" : "5000123",
"directHourlyRate" : 10.42,
"standardHourlyRate" : 10,
"dailyCost" : 59.36,
"dailySellingPrice" : 80,
"entity" : "5000123",
"serviceRef" : {
"id" : "5000123",
"name" : "Professional services",
"code" : "PS"
},
"service" : "5000123",
"position" : "Developer",
"skillRef" : {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
},
"skill" : "5000123",
"family1" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family1Id" : "5000123",
"family2" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family2Id" : "5000123",
"family3" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family3Id" : "5000123",
"leave" : false,
"standardWeek" : {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
}
},
"standardWeekId" : "5000123",
"salary" : 1024
} ],
"companyChanges" : [ {
"id" : "5000123",
"employeeId" : "500123",
"companyId" : "5000123",
"startDate" : "2020-01-23T04:56:07Z",
"endDate" : "2020-01-23T04:56:07Z",
"companyChangeState" : "{}",
"comment" : "Limpso usum"
}, {
"id" : "5000123",
"employeeId" : "500123",
"companyId" : "5000123",
"startDate" : "2020-01-23T04:56:07Z",
"endDate" : "2020-01-23T04:56:07Z",
"companyChangeState" : "{}",
"comment" : "Limpso usum"
} ],
"timeRecordingRules" : {
"id" : "5000123",
"employeeId" : "5000123",
"min" : 0,
"max" : 24,
"step" : 0.01,
"prettyStep" : 0.3,
"base" : 60,
"unit" : "H",
"unitDuration" : "{}",
"allowManualEntry" : true,
"employeeWeeks" : [ {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
},
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 8,
"dailyMinutes" : 10,
"weekHours" : 40,
"leave" : false
}, {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
},
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 8,
"dailyMinutes" : 10,
"weekHours" : 40,
"leave" : false
} ],
"closingDates" : [ {
"closingDate" : "2020-01-31T23:59:59Z",
"module" : "DATE_MODULE",
"beginningOfPeriod" : "2020-01-31T23:59:59Z",
"endOfPeriod" : "2020-01-31T23:59:59Z"
}, {
"closingDate" : "2020-01-31T23:59:59Z",
"module" : "DATE_MODULE",
"beginningOfPeriod" : "2020-01-31T23:59:59Z",
"endOfPeriod" : "2020-01-31T23:59:59Z"
} ],
"simpleDuration" : 750,
"completionMode" : "WEEKLY"
},
"scheduleRules" : {
"id" : "5000123",
"employeeId" : "5000123",
"min" : 0,
"max" : 24,
"step" : 0.01,
"prettyStep" : 0.3,
"base" : 60,
"unit" : "H",
"unitDuration" : "{}",
"allowManualEntry" : true,
"employeeWeeks" : [ {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
},
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 8,
"dailyMinutes" : 10,
"weekHours" : 40,
"leave" : false
}, {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
},
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 8,
"dailyMinutes" : 10,
"weekHours" : 40,
"leave" : false
} ],
"closingDates" : [ {
"closingDate" : "2020-01-31T23:59:59Z",
"module" : "DATE_MODULE",
"beginningOfPeriod" : "2020-01-31T23:59:59Z",
"endOfPeriod" : "2020-01-31T23:59:59Z"
}, {
"closingDate" : "2020-01-31T23:59:59Z",
"module" : "DATE_MODULE",
"beginningOfPeriod" : "2020-01-31T23:59:59Z",
"endOfPeriod" : "2020-01-31T23:59:59Z"
} ],
"timestamped" : true
},
"businessCards" : [ {
"id" : "5000123",
"employeeId" : "5000123",
"cardNumber" : "XXXX XXXX XXXX 7568",
"encryptedCardNumber" : "0",
"name" : "Management card",
"type" : "{}",
"endDate" : "2020-01-31T23:59:59Z"
}, {
"id" : "5000123",
"employeeId" : "5000123",
"cardNumber" : "XXXX XXXX XXXX 7568",
"encryptedCardNumber" : "0",
"name" : "Management card",
"type" : "{}",
"endDate" : "2020-01-31T23:59:59Z"
} ],
"sector" : "Marketing",
"number" : "84",
"relations" : [ {
"id" : "5000123",
"relationType" : {
"id" : "5000123",
"code" : "TUTOR",
"name" : "Tutor for internship"
},
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"relatedEmployee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"relatedEmployeeId" : "5000123"
}, {
"id" : "5000123",
"relationType" : {
"id" : "5000123",
"code" : "TUTOR",
"name" : "Tutor for internship"
},
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"relatedEmployee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"relatedEmployeeId" : "5000123"
} ],
"employeeAbilities" : [ {
"id" : "5000123",
"skill" : {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
},
"level" : {
"id" : "5000123",
"code" : "EXP",
"name" : "Expert"
},
"startDate" : "2020-01-31T23:59:59Z",
"endDate" : "2020-01-31T23:59:59Z",
"employeeId" : "5000123"
}, {
"id" : "5000123",
"skill" : {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
},
"level" : {
"id" : "5000123",
"code" : "EXP",
"name" : "Expert"
},
"startDate" : "2020-01-31T23:59:59Z",
"endDate" : "2020-01-31T23:59:59Z",
"employeeId" : "5000123"
} ],
"jobType" : {
"id" : "5000123",
"companyCode" : "AKSAS",
"code" : "ADMIN",
"name" : "Administrator",
"category" : "{}",
"validity" : {
"type" : "{}",
"date" : "2000-06-21T04:56:07.000+00:00"
},
"default" : true
},
"jobTypeId" : "100245",
"address" : {
"id" : "id",
"line1" : "221B Baker Street",
"line2" : "2nd Floor",
"line3" : "First door at your right",
"cedex" : "CEDEX 14",
"postalCode" : "69002",
"city" : "London",
"country" : "FR (for 'FRANCE')",
"countryName" : "FRANCE",
"department" : "75 (for 'PARIS')",
"geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
"region" : "65 (for 'ILE DE FRANCE')",
"regionName" : "ILE DE FRANCE",
"phone" : "06 00 00 00 01",
"phone2" : "06 00 00 00 02",
"email" : "myemail@mail.com",
"mobilePhone" : "06 00 00 00 02",
"fax" : "04 00 00 00 07",
"webSite" : "mysite.com"
},
"addressId" : "5000123",
"birthDate" : "2000-06-21T04:56:07.000+00:00",
"customData" : {
"key" : {
"type" : "{}",
"value" : "Autoref 010520",
"name" : "Reference 4",
"realOrder" : 0,
"label" : "REFERENCE_4"
}
},
"color" : "#FF0000",
"targetTace" : 75,
"formConfig" : {
"type" : "{}",
"fields" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"controls" : {
"key" : {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}
},
"insertable" : true,
"editable" : false,
"deletable" : false,
"formSearchHidden" : false
},
"changeTracking" : {
"createdTime" : "2000-06-21T04:56:07.000+00:00",
"createdBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"createdById" : "5000123",
"modificationTime" : "2000-06-21T04:56:07.000+00:00",
"modificationBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"modificationById" : "5000123"
},
"vehicles" : [ {
"id" : "5000123",
"power" : 5,
"licensePlate" : "licensePlate",
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"expenseType" : {
"id" : "5000123",
"code" : "MEAL",
"description" : "Plane",
"km" : false,
"notRefundable" : true,
"icon" : "fa fa-plane",
"color" : "00ff40",
"receiptRequired" : false,
"commentRequired" : false,
"guestsRequired" : false,
"notRefundableEditable" : true,
"billableEditable" : true,
"amountEditable" : true,
"showQuantity" : false,
"showAdditionalComment" : false,
"showReceiptNumber" : true,
"showAmountCategory" : true,
"showBillable" : true,
"hideVat" : false,
"vat1Code" : "1",
"vat2Code" : "2",
"vat3Code" : "3",
"expenseThreshold" : 100,
"defaultAmount" : 45,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"expenseCategory" : "{}",
"expenseRebillableOptions" : "{}",
"showCustomRequest" : true,
"showAmountWithoutVat" : true,
"controlsBehavior" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"calculateKilometers" : true,
"freeEntryProhibited" : true,
"controls" : {
"enableDuplicate" : true,
"enablelOnNonWorkingDay" : true,
"enableOnDayWithLeaveRequest" : true,
"enableOnDayWithTimesheetOrSchedule" : true
},
"expenseThresholdExceededNoVat" : false
},
"expenseTypeId" : "5000123",
"endDate" : "2020-01-31T23:59:59Z"
}, {
"id" : "5000123",
"power" : 5,
"licensePlate" : "licensePlate",
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"expenseType" : {
"id" : "5000123",
"code" : "MEAL",
"description" : "Plane",
"km" : false,
"notRefundable" : true,
"icon" : "fa fa-plane",
"color" : "00ff40",
"receiptRequired" : false,
"commentRequired" : false,
"guestsRequired" : false,
"notRefundableEditable" : true,
"billableEditable" : true,
"amountEditable" : true,
"showQuantity" : false,
"showAdditionalComment" : false,
"showReceiptNumber" : true,
"showAmountCategory" : true,
"showBillable" : true,
"hideVat" : false,
"vat1Code" : "1",
"vat2Code" : "2",
"vat3Code" : "3",
"expenseThreshold" : 100,
"defaultAmount" : 45,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"expenseCategory" : "{}",
"expenseRebillableOptions" : "{}",
"showCustomRequest" : true,
"showAmountWithoutVat" : true,
"controlsBehavior" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"calculateKilometers" : true,
"freeEntryProhibited" : true,
"controls" : {
"enableDuplicate" : true,
"enablelOnNonWorkingDay" : true,
"enableOnDayWithLeaveRequest" : true,
"enableOnDayWithTimesheetOrSchedule" : true
},
"expenseThresholdExceededNoVat" : false
},
"expenseTypeId" : "5000123",
"endDate" : "2020-01-31T23:59:59Z"
} ],
"currentCompany" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo",
"legalName" : "legalName",
"siren" : "siren",
"siret" : "siret",
"calendar" : {
"id" : "5000123",
"code" : "Text",
"name" : "Text",
"default" : true,
"daysNotWorked" : [ 6, 6 ],
"holidays" : [ {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
}, {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
} ]
},
"calendarId" : "calendarId",
"color" : "color",
"currency" : {
"id" : "5000123",
"name" : "Euro",
"code" : "EUR",
"order" : 17,
"euro" : true,
"euroRate" : 0.9678,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"euroRateStartDate" : "2020-01-23T04:56:07Z",
"euroRateEndDate" : "2020-01-23T04:56:07Z"
},
"currencyId" : "currencyId",
"address" : {
"id" : "id",
"line1" : "221B Baker Street",
"line2" : "2nd Floor",
"line3" : "First door at your right",
"cedex" : "CEDEX 14",
"postalCode" : "69002",
"city" : "London",
"country" : "FR (for 'FRANCE')",
"countryName" : "FRANCE",
"department" : "75 (for 'PARIS')",
"geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
"region" : "65 (for 'ILE DE FRANCE')",
"regionName" : "ILE DE FRANCE",
"phone" : "06 00 00 00 01",
"phone2" : "06 00 00 00 02",
"email" : "myemail@mail.com",
"mobilePhone" : "06 00 00 00 02",
"fax" : "04 00 00 00 07",
"webSite" : "mysite.com"
},
"addressId" : "addressId"
},
"currentCompanyId" : "5000123",
"bankingInformation" : {
"id" : "5000123",
"sepa" : {
"bankDetails" : {
"entity" : "30002",
"counter" : "550",
"accountNumber" : "0000157841Z",
"key" : "25",
"domiciliation" : "AURA"
},
"bic" : {
"country" : "FR (for 'FRANCE')",
"bank" : "DAAE",
"location" : "PP",
"branch" : "CCT"
},
"iban" : {
"country" : "FR (for 'FRANCE')",
"key" : "69",
"accountNumber" : "0000157841Z"
}
},
"noneSepa" : {
"defaultBankDetail" : false,
"beneficiary" : {
"holder" : {
"name" : "RITA",
"firstName" : "BRITA",
"accountType" : "{}",
"accountNumber" : "123456789"
},
"bank" : {
"bankName" : "UBA",
"bankName2" : "UBA",
"bankType" : "{}",
"bankCode" : "C8",
"bankAddress" : {
"id" : "id",
"line1" : "221B Baker Street",
"line2" : "2nd Floor",
"line3" : "First door at your right",
"cedex" : "CEDEX 14",
"postalCode" : "69002",
"city" : "London",
"country" : "FR (for 'FRANCE')",
"countryName" : "FRANCE",
"department" : "75 (for 'PARIS')",
"geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
"region" : "65 (for 'ILE DE FRANCE')",
"regionName" : "ILE DE FRANCE",
"phone" : "06 00 00 00 01",
"phone2" : "06 00 00 00 02",
"email" : "myemail@mail.com",
"mobilePhone" : "06 00 00 00 02",
"fax" : "04 00 00 00 07",
"webSite" : "mysite.com"
}
}
},
"intermediate" : {
"holder" : {
"name" : "RITA",
"firstName" : "BRITA",
"accountType" : "{}",
"accountNumber" : "123456789"
},
"bank" : {
"bankName" : "UBA",
"bankName2" : "UBA",
"bankType" : "{}",
"bankCode" : "C8",
"bankAddress" : {
"id" : "id",
"line1" : "221B Baker Street",
"line2" : "2nd Floor",
"line3" : "First door at your right",
"cedex" : "CEDEX 14",
"postalCode" : "69002",
"city" : "London",
"country" : "FR (for 'FRANCE')",
"countryName" : "FRANCE",
"department" : "75 (for 'PARIS')",
"geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
"region" : "65 (for 'ILE DE FRANCE')",
"regionName" : "ILE DE FRANCE",
"phone" : "06 00 00 00 01",
"phone2" : "06 00 00 00 02",
"email" : "myemail@mail.com",
"mobilePhone" : "06 00 00 00 02",
"fax" : "04 00 00 00 07",
"webSite" : "mysite.com"
}
}
}
},
"statusChangeDate" : "2000-06-21T04:56:07.000+00:00",
"statusChangeArgument" : {
"comment" : "Comment",
"status" : "{}"
},
"validator" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"validatorId" : "5000123",
"action" : "{}",
"type" : "{}"
},
"faxNumber" : "418 643 3210",
"phoneExtensionNumber" : "04 00 00 00 07"
},
"employeeId" : "5000123",
"departureDate" : "2020-01-31T23:59:59Z",
"departureActualDate" : "2020-01-31T23:59:59Z",
"departureCity" : {
"id" : "5000123",
"name" : "City 1",
"default" : true,
"postcode" : "73000",
"country" : {
"id" : "5000123",
"name" : "Country 1",
"currency" : {
"id" : "5000123",
"name" : "Euro",
"code" : "EUR",
"order" : 17,
"euro" : true,
"euroRate" : 0.9678,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"euroRateStartDate" : "2020-01-23T04:56:07Z",
"euroRateEndDate" : "2020-01-23T04:56:07Z"
},
"currencyId" : "5000123",
"calendar" : {
"id" : "5000123",
"code" : "Text",
"name" : "Text",
"default" : true,
"daysNotWorked" : [ 6, 6 ],
"holidays" : [ {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
}, {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
} ]
},
"calendarId" : "5000123",
"code" : "FR",
"companyCode" : "AKSAS",
"companyId" : "5000123",
"isPartOfEU" : true,
"continent" : "AFRICA"
},
"countryId" : "5000123",
"department" : {
"id" : "5000123",
"code" : "01-A",
"companyCode" : "AKSAS",
"name" : "Lorem Ipsum",
"analysis" : "analysis",
"comment" : "comment",
"entity" : {
"id" : "5000123",
"code" : "01-BRDX",
"name" : "Bordeaux",
"legalName" : "Customer care",
"division" : {
"id" : "5000123",
"name" : "Rhone-Alpes",
"code" : "RA",
"group" : {
"id" : "5000123",
"name" : "West",
"code" : "WST",
"serviceId" : "5000123"
},
"groupId" : "5000123",
"companyId" : "5000123"
},
"divisionId" : "5000123",
"divisionCode" : "01-DIV",
"companyId" : "5000123",
"endDate" : "2020-01-23T04:56:07Z"
},
"entityId" : "entityId",
"projectType" : "{}",
"activities" : [ {
"id" : "5000123",
"code" : "code",
"name" : "name"
}, {
"id" : "5000123",
"code" : "code",
"name" : "name"
} ]
},
"departmentId" : "5000123",
"regionId" : "123456",
"companyCode" : "AKSAS",
"latitude" : "5.9845W",
"longitude" : "37.3891N"
},
"departureLocation" : "Lyon",
"arrivalDate" : "2020-01-31T23:59:59Z",
"arrivalActualDate" : "2020-01-31T23:59:59Z",
"arrivalCity" : {
"id" : "5000123",
"name" : "City 1",
"default" : true,
"postcode" : "73000",
"country" : {
"id" : "5000123",
"name" : "Country 1",
"currency" : {
"id" : "5000123",
"name" : "Euro",
"code" : "EUR",
"order" : 17,
"euro" : true,
"euroRate" : 0.9678,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"euroRateStartDate" : "2020-01-23T04:56:07Z",
"euroRateEndDate" : "2020-01-23T04:56:07Z"
},
"currencyId" : "5000123",
"calendar" : {
"id" : "5000123",
"code" : "Text",
"name" : "Text",
"default" : true,
"daysNotWorked" : [ 6, 6 ],
"holidays" : [ {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
}, {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
} ]
},
"calendarId" : "5000123",
"code" : "FR",
"companyCode" : "AKSAS",
"companyId" : "5000123",
"isPartOfEU" : true,
"continent" : "AFRICA"
},
"countryId" : "5000123",
"department" : {
"id" : "5000123",
"code" : "01-A",
"companyCode" : "AKSAS",
"name" : "Lorem Ipsum",
"analysis" : "analysis",
"comment" : "comment",
"entity" : {
"id" : "5000123",
"code" : "01-BRDX",
"name" : "Bordeaux",
"legalName" : "Customer care",
"division" : {
"id" : "5000123",
"name" : "Rhone-Alpes",
"code" : "RA",
"group" : {
"id" : "5000123",
"name" : "West",
"code" : "WST",
"serviceId" : "5000123"
},
"groupId" : "5000123",
"companyId" : "5000123"
},
"divisionId" : "5000123",
"divisionCode" : "01-DIV",
"companyId" : "5000123",
"endDate" : "2020-01-23T04:56:07Z"
},
"entityId" : "entityId",
"projectType" : "{}",
"activities" : [ {
"id" : "5000123",
"code" : "code",
"name" : "name"
}, {
"id" : "5000123",
"code" : "code",
"name" : "name"
} ]
},
"departmentId" : "5000123",
"regionId" : "123456",
"companyCode" : "AKSAS",
"latitude" : "5.9845W",
"longitude" : "37.3891N"
},
"arrivalLocation" : "Oslo",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"documents" : [ {
"id" : "5000123",
"title" : "Title",
"versionId" : "5000123",
"changeTracking" : {
"createdTime" : "2000-06-21T04:56:07.000+00:00",
"createdBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"createdById" : "5000123",
"modificationTime" : "2000-06-21T04:56:07.000+00:00",
"modificationBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"modificationById" : "5000123"
},
"publishedBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"publishedById" : "5001206",
"classification" : "STD",
"subClassification" : "EDITIONS",
"category1" : "CAT1",
"category2" : "CAT2",
"category3" : "CAT3",
"companyId" : "5000123",
"publicationDate" : "2000-06-21T04:56:07.000+00:00",
"version" : 1,
"documentType" : "File",
"fileUrl" : "myFiles/thisFile.pdf",
"fileName" : "thisFile.pdf",
"lienUrl" : "myStorage.com/myFiles/thisFile.pdf",
"url" : "myFiles/thisFile.pdf",
"original" : false,
"preview" : "data:image",
"tokenPreview" : "8946A85V85D851DF",
"externalDMSUuid" : "OD1245126",
"links" : [ {
"id" : "5000123",
"original" : true,
"documentId" : "5000123",
"objectId" : "5000123",
"objectType" : "{}"
}, {
"id" : "5000123",
"original" : true,
"documentId" : "5000123",
"objectId" : "5000123",
"objectType" : "{}"
} ],
"archived" : false,
"action" : "{}",
"owner" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"ownerId" : "5001206",
"description" : "Text",
"category" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"categoryId" : "100024",
"subCategory" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"company" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo",
"legalName" : "legalName",
"siren" : "siren",
"siret" : "siret",
"calendar" : {
"id" : "5000123",
"code" : "Text",
"name" : "Text",
"default" : true,
"daysNotWorked" : [ 6, 6 ],
"holidays" : [ {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
}, {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
} ]
},
"calendarId" : "calendarId",
"color" : "color",
"currency" : {
"id" : "5000123",
"name" : "Euro",
"code" : "EUR",
"order" : 17,
"euro" : true,
"euroRate" : 0.9678,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"euroRateStartDate" : "2020-01-23T04:56:07Z",
"euroRateEndDate" : "2020-01-23T04:56:07Z"
},
"currencyId" : "currencyId",
"address" : {
"id" : "id",
"line1" : "221B Baker Street",
"line2" : "2nd Floor",
"line3" : "First door at your right",
"cedex" : "CEDEX 14",
"postalCode" : "69002",
"city" : "London",
"country" : "FR (for 'FRANCE')",
"countryName" : "FRANCE",
"department" : "75 (for 'PARIS')",
"geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
"region" : "65 (for 'ILE DE FRANCE')",
"regionName" : "ILE DE FRANCE",
"phone" : "06 00 00 00 01",
"phone2" : "06 00 00 00 02",
"email" : "myemail@mail.com",
"mobilePhone" : "06 00 00 00 02",
"fax" : "04 00 00 00 07",
"webSite" : "mysite.com"
},
"addressId" : "addressId"
},
"companyId" : "5000123",
"type" : "{}",
"category" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"categoryId" : "500143",
"grouping" : "grouping",
"ranking" : 2
},
"subCategoryId" : "11037",
"locked" : false
}, {
"id" : "5000123",
"title" : "Title",
"versionId" : "5000123",
"changeTracking" : {
"createdTime" : "2000-06-21T04:56:07.000+00:00",
"createdBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"createdById" : "5000123",
"modificationTime" : "2000-06-21T04:56:07.000+00:00",
"modificationBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"modificationById" : "5000123"
},
"publishedBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"publishedById" : "5001206",
"classification" : "STD",
"subClassification" : "EDITIONS",
"category1" : "CAT1",
"category2" : "CAT2",
"category3" : "CAT3",
"companyId" : "5000123",
"publicationDate" : "2000-06-21T04:56:07.000+00:00",
"version" : 1,
"documentType" : "File",
"fileUrl" : "myFiles/thisFile.pdf",
"fileName" : "thisFile.pdf",
"lienUrl" : "myStorage.com/myFiles/thisFile.pdf",
"url" : "myFiles/thisFile.pdf",
"original" : false,
"preview" : "data:image",
"tokenPreview" : "8946A85V85D851DF",
"externalDMSUuid" : "OD1245126",
"links" : [ {
"id" : "5000123",
"original" : true,
"documentId" : "5000123",
"objectId" : "5000123",
"objectType" : "{}"
}, {
"id" : "5000123",
"original" : true,
"documentId" : "5000123",
"objectId" : "5000123",
"objectType" : "{}"
} ],
"archived" : false,
"action" : "{}",
"owner" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"ownerId" : "5001206",
"description" : "Text",
"category" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"categoryId" : "100024",
"subCategory" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"company" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo",
"legalName" : "legalName",
"siren" : "siren",
"siret" : "siret",
"calendar" : {
"id" : "5000123",
"code" : "Text",
"name" : "Text",
"default" : true,
"daysNotWorked" : [ 6, 6 ],
"holidays" : [ {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
}, {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
} ]
},
"calendarId" : "calendarId",
"color" : "color",
"currency" : {
"id" : "5000123",
"name" : "Euro",
"code" : "EUR",
"order" : 17,
"euro" : true,
"euroRate" : 0.9678,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"euroRateStartDate" : "2020-01-23T04:56:07Z",
"euroRateEndDate" : "2020-01-23T04:56:07Z"
},
"currencyId" : "currencyId",
"address" : {
"id" : "id",
"line1" : "221B Baker Street",
"line2" : "2nd Floor",
"line3" : "First door at your right",
"cedex" : "CEDEX 14",
"postalCode" : "69002",
"city" : "London",
"country" : "FR (for 'FRANCE')",
"countryName" : "FRANCE",
"department" : "75 (for 'PARIS')",
"geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
"region" : "65 (for 'ILE DE FRANCE')",
"regionName" : "ILE DE FRANCE",
"phone" : "06 00 00 00 01",
"phone2" : "06 00 00 00 02",
"email" : "myemail@mail.com",
"mobilePhone" : "06 00 00 00 02",
"fax" : "04 00 00 00 07",
"webSite" : "mysite.com"
},
"addressId" : "addressId"
},
"companyId" : "5000123",
"type" : "{}",
"category" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"categoryId" : "500143",
"grouping" : "grouping",
"ranking" : 2
},
"subCategoryId" : "11037",
"locked" : false
} ],
"numberOfDocuments" : 2,
"formConfig" : {
"type" : "{}",
"fields" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"controls" : {
"key" : {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}
},
"insertable" : true,
"editable" : false,
"deletable" : false,
"formSearchHidden" : false
},
"cancellationDate" : "2020-01-31T23:59:59Z",
"cancellationUser" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"cancellationUserId" : "5000123",
"archiveDate" : "2020-01-31T23:59:59Z",
"archiveUser" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"archiveUserId" : "5000123",
"comment" : "Lorem ipsum",
"multiProjects" : true
},
"customRequestId" : "5000123",
"threshold" : 80,
"vat3" : {
"id" : "5000123",
"code" : "7",
"rate" : 1.4658129805029452
},
"vatAmount3" : 110,
"vatAmount3Currency" : 126.57,
"exchangeRate" : {
"id" : "5000123",
"currency" : {
"id" : "5000123",
"name" : "Euro",
"code" : "EUR",
"order" : 17,
"euro" : true,
"euroRate" : 0.9678,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"euroRateStartDate" : "2020-01-23T04:56:07Z",
"euroRateEndDate" : "2020-01-23T04:56:07Z"
},
"currencyId" : "12006",
"rate" : 0.9156852,
"startDate" : "2000-06-21T04:56:07.000+00:00",
"endDate" : "2000-06-21T04:56:07.000+00:00"
},
"amountWithoutVat" : 1.8,
"vehicle" : {
"id" : "5000123",
"power" : 5,
"licensePlate" : "licensePlate",
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"expenseType" : {
"id" : "5000123",
"code" : "MEAL",
"description" : "Plane",
"km" : false,
"notRefundable" : true,
"icon" : "fa fa-plane",
"color" : "00ff40",
"receiptRequired" : false,
"commentRequired" : false,
"guestsRequired" : false,
"notRefundableEditable" : true,
"billableEditable" : true,
"amountEditable" : true,
"showQuantity" : false,
"showAdditionalComment" : false,
"showReceiptNumber" : true,
"showAmountCategory" : true,
"showBillable" : true,
"hideVat" : false,
"vat1Code" : "1",
"vat2Code" : "2",
"vat3Code" : "3",
"expenseThreshold" : 100,
"defaultAmount" : 45,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"expenseCategory" : "{}",
"expenseRebillableOptions" : "{}",
"showCustomRequest" : true,
"showAmountWithoutVat" : true,
"controlsBehavior" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"calculateKilometers" : true,
"freeEntryProhibited" : true,
"controls" : {
"enableDuplicate" : true,
"enablelOnNonWorkingDay" : true,
"enableOnDayWithLeaveRequest" : true,
"enableOnDayWithTimesheetOrSchedule" : true
},
"expenseThresholdExceededNoVat" : false
},
"expenseTypeId" : "5000123",
"endDate" : "2020-01-31T23:59:59Z"
},
"kmTotal" : 50,
"amountCalculated" : 35,
"amountRefunded" : 700,
"amountDue" : 35,
"retrievedExpense" : false,
"departureLocation" : "27 Rue Auguste Comte, 69002 Lyon, France",
"arrivalLocation" : "27 Rue Auguste Comte, 69002 Lyon, France",
"controls" : {
"duplicateForSameEmployee" : true,
"duplicateForSeveralEmployees" : true,
"onNonWorkingDay" : true,
"onLeaveDay" : true
}
}
2.7.25. Update an expense report with a patch
PATCH |
/expense-reports/{expense_report_id} |
Description
Update an expense report with a list of patches given in parameters.
DMF required:
-
DMF A40202: Api Workforce / Expenses / Update
-
DMF 041502: Purchases / Expense Reports / Modify
-
DMF 1905__: Web Portal / Expense Reports
-
DMF 190502: Web Portal / Expense Reports / Modify
-
DMF 190511: Web Portal / Expense Reports / Modify Another Employee''s Expense Report
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
expense_report_id |
Id of an expense report |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
patch_elements |
List of patches to apply PatchElement |
- |
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Expense report successfully updated using the patch |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"op" : "ADD",
"path" : "path",
"from" : "from",
"value" : "{}"
}
2.7.26. This API authorizes an expense to exceed its defined threshold.
POST |
/expense-reports/{expense_report_id}/expenses/{expense_id}/exceed-threshold |
Description
This API authorizes an expense to exceed its defined threshold.
The behavior depends on the user’s rights (DMF):
- If the user has the appropriate rights, the API authorizes the expense to exceed its threshold without cancelling the existing approvals.
- Otherwise, the API authorizes the expense to exceed its threshold but cancels all existing approvals.
This API is used on expenses associated with an expense type that has a defined threshold.
DMF required:
-
DMF A40224: Api Workforce / Expenses / Exceed Threshold
-
DMF 041516: Purchases / Expense Reports / Threshold
-
DMF 190807: Web Portal / Expense Reports Validation / Modify Refunded Threshold
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
expense_report_id |
Id of an expense report |
X |
null |
|
expense_id |
Id of an expense |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
expenseThresholdParamHolder |
The expense's threshold to update ExpenseThresholdParamHolder |
X |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Expense's threshold updated |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"threshold" : 100
}
2.7.27. Validate an expense report
POST |
/expense-report/{expense_report_id}/validate |
Description
Validate expense report matching the specified ID.
DMF required:
-
DMF A40215: Api Workforce / Expenses / Validate
-
DMF 041507: Purchases / Expense Reports / Validate Completed Expense Report
-
DMF 041527: Purchases / Expense Reports / Validate Non-completed Expense Report
-
DMF 041541: Purchases / Expense Reports / Force Validation
-
DMF 190801: Web Portal / Expense Reports Validation / My Team
-
DMF 190802: Web Portal / Expense Reports Validation / My Teams
-
DMF 190803: Web Portal / Expense Reports Validation / History
-
DMF 190805: Web Portal / Expense Reports Validation / Validate Non-completed Expense Report
-
DMF 041520: Purchases / Expense Reports / Cancel Validation
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
expense_report_id |
Id of an expense report |
X |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Expense report successfully validated |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.8. Expense Types Expected
2.8.1. Search for the expected expense types (with search criteria)
POST |
/settings/expense-types-expected/search |
Description
Get the list of expected expense types matching the search criteria
DMF required:
-
DMF A62604: Api Settings / Expected Expense Types / Search
-
DMF 191103: Web Portal / Custom Requests / Modify
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
criteria |
Criteria that you choose (Company Id, code, etc…) ExpenseTypeExpectedCriteria |
X |
Return Type
array[ExpenseTypeExpected]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Expected expense types successfully loaded |
List[ExpenseTypeExpected] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"companyId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"code" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"name" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"id" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"tag" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"validity" : {
"type" : "{}",
"date" : "2000-06-21T04:56:07.000+00:00"
},
"readOption" : {
"options" : [ "EXPENSE_TYPE", "EXPENSE_TYPE" ]
}
}
2.9. Expenses
2.9.1. Calculate kilometers compensation
POST |
/expenses/calculate-amounts-kilometers-compensation |
Description
Calculate total of kilometers driven and amounts for kilometers compensation for a given employee in the current year.
DMF required:
-
DMF A41210: Api Workforce / Vehicle / Calculate Amounts For Kilometers Compensation
-
DMF 190505: Web Portal / Expense Reports / Complete Expense Report
-
DMF 160852: Tools / Resources / Show Taxable Powers
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
expenseWithVehicleParamHolder |
The context of the expense. ExpenseWithVehicleParamHolder |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Successfully calculated |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"licensePlate" : "AA-123-BB",
"kilometersEnteredOnCurrentExpense" : 512,
"expenseId" : "5000123",
"employeeId" : "5000428",
"expenseTypeId" : "5000987",
"power" : 5,
"completed" : true,
"expenseReportId" : "5000728",
"expenseDate" : "2020-01-31T23:59:59Z"
}
2.9.2. Calculate remaining threshold
GET |
/employees/{employee_id}/expense-type/{expense_type_code}/threshold/calculate-remaining-threshold |
Description
Calculate remaining threshold for the expense type given in parameters and matching the specified employee ID.
DMF required:
-
DMF A40206: Api Workforce / Expenses / Info
-
DMF 041506: Purchases / Expense Reports / Show History
-
DMF 190501: Web Portal / Expense Reports / Show
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
employee_id |
Id of an employee |
X |
null |
|
expense_type_code |
The code of the expense type |
X |
null |
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
expenseDate |
Date of the expense |
- |
null |
|
alreadyUsed |
Set as True if the expense type is already used the same day |
- |
null |
|
expense_report_to_exclude_id |
ID of the expense report to exclude from the calculation |
- |
null |
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Remaining threshold for the employee and the expense type |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.9.3. Cancel a refusal for an expense
POST |
/expenses/{expense_id}/cancel-refusal |
Description
Cancel a refusal for an expense matching specified expense ID.
DMF required:
-
DMF A40211: Api Workforce / Expenses / Cancel Rejection
-
DMF 041538: Purchases / Expense Reports / Modify Denial From Another Employee In Non-validated Expense Report
-
DMF 041539: Purchases / Expense Reports / Modify Denial From Another Employee In Validated Expense Report
-
DMF 190901: Web Portal / Approvals
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
expense_id |
Id of an expense |
X |
null |
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Expense's refusal successfully cancelled |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.9.4. Cancel a smart scan
POST |
/expense-reports/{expense_report_id}/expenses/{expense_id}/cancel-smart-scan |
Description
Cancel a smart scan matching specified expense report ID and expense ID.
DMF required:
-
DMF A40221: Api Workforce / Expenses / Ocr
-
DMF 041545: Purchases / Expense Reports / Ocr
-
DMF 190513: Web Portal / Expense Reports / Ocr
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
expense_report_id |
Id of an expense report |
X |
null |
|
expense_id |
Id of an expense |
X |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Smart scan successfully cancelled |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.9.5. Get receipts linked to an expense report
GET |
/expense-reports/{expense_report_id}/expense-receipts |
Description
Get the list of receipts linked to an expense report matching specified expense report ID.
DMF required:
-
DMF A40206: Api Workforce / Expenses / Info
-
DMF 041506: Purchases / Expense Reports / Show History
-
DMF 190501: Web Portal / Expense Reports / Show
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
expense_report_id |
Id of an expense report |
X |
null |
Return Type
array[ExpenseReceiptSummary]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Receipts successfully loaded |
List[ExpenseReceiptSummary] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.9.6. Search an expense's threshold
GET |
/employees/{employee_id}/expense-type/{expense_type_code}/threshold |
Description
Search for the expense’s threshold of the expense type given in parameters and matching the specified employee ID.
DMF required:
-
DMF A40206: Api Workforce / Expenses / Info
-
DMF 041506: Purchases / Expense Reports / Show History
-
DMF 190501: Web Portal / Expense Reports / Show
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
employee_id |
Id of an employee |
X |
null |
|
expense_type_code |
The code of the expense type |
X |
null |
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
expenseDate |
Date of the expense |
- |
null |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Expense threshold successfully loaded |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.9.7. Smart scan in progress
GET |
/expense-reports/{expense_report_id}/expenses/{expense_id}/smart-scan-in-progress |
Description
Is the smartScan in progress
DMF required:
-
DMF A40221: Api Workforce / Expenses / Ocr
-
DMF 041545: Purchases / Expense Reports / Ocr
-
DMF 190513: Web Portal / Expense Reports / Ocr
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
expense_report_id |
Id of an expense report |
X |
null |
|
expense_id |
Id of an expense |
X |
null |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
true if smart scan in progress |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.9.8. 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.
The moved expense will match specified expense report ID and expense ID.
DMF required:
-
DMF A40218: Api Workforce / Expenses / Update Expense
-
DMF 041502: Purchases / Expense Reports / Modify
-
DMF 041510: Purchases / Expense Reports / Modify Validated Expense Report
-
DMF 041518: Purchases / Expense Reports / Modify Completed Expense Report
-
DMF 041532: Purchases / Expense Reports / Correct Expense Reports
-
DMF 190502: Web Portal / Expense Reports / Modify
-
DMF 190511: Web Portal / Expense Reports / Modify Another Employee''s Expense Report
-
DMF 190903: Web Portal / Approvals / Modify Expense
-
DMF 190904: Web Portal / Approvals / Modify Refunded Threshold
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
expense_report_id |
Id of an expense report |
X |
null |
|
expense_id |
Id of an expense |
X |
null |
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
new_expense_report_id |
Id of the target expense report |
- |
null |
|
expense_date |
The expense date |
- |
null |
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Expense successfully moved |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.9.9. Pre-fill an employee's expense
POST |
/employees/{employee_id}/expenses/pre-fill |
Description
Pre-fill a previously created expense of an employee matching the specified employee ID.
DMF required:
-
DMF A40201: Api Workforce / Expenses / Insert
-
DMF 041501: Purchases / Expense Reports / New
-
DMF 1905__: Web Portal / Expense Reports
-
DMF 190502: Web Portal / Expense Reports / Modify
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
employee_id |
Id of an employee |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
expense |
The expense to be prefilled Expense |
X |
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
object_type |
The type of object (see SchedulePreFillObjectType) |
- |
null |
|
object_id |
The id of the object used to fill in the schedule |
- |
null |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Expense successfully pre-filled |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"id" : "5000123",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJT_001",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"subPhase" : {
"id" : "5000123",
"code" : "SB_1",
"name" : "Sub Phase 1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"order" : 1
},
"subPhaseId" : "51000122",
"projectTask" : {
"id" : "5000123",
"code" : "code",
"name" : "Team building",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJT_001",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"subPhase" : {
"id" : "5000123",
"code" : "SB_1",
"name" : "Sub Phase 1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"order" : 1
},
"subPhaseId" : "51000122",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"order" : 2,
"startDate" : "2000-06-21T04:56:07.000+00:00",
"endDate" : "2000-06-21T04:56:07.000+00:00",
"description" : "description"
},
"projectTaskId" : "5000123",
"managementObjectId" : "5000123",
"name" : "Helpdesk",
"quantity" : 3,
"unitPriceCurrency" : 36.32,
"unitPrice" : 40,
"amountTotalCurrency" : 1200,
"amountTotal" : 1200,
"rankNumber" : 2,
"action" : "{}",
"complementName" : "Lorem ipsum",
"afterTaxAmountTotalCurrency" : 1500,
"afterTaxAmountTotal" : 1500,
"generalAccount" : "411000",
"totalPriceCurrency" : 1200,
"totalPrice" : 1200,
"additionalFreeFields" : {
"field1" : "Free field",
"field2" : "Free field",
"field3" : "Free field",
"field4" : "Free field",
"field5" : "Free field"
},
"resource" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"resourceId" : "resourceId",
"formConfig" : {
"type" : "{}",
"fields" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"controls" : {
"key" : {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}
},
"insertable" : true,
"editable" : false,
"deletable" : false,
"formSearchHidden" : false
},
"forcedVat" : true,
"vat1" : {
"id" : "5000123",
"code" : "7",
"rate" : 1.4658129805029452
},
"vat2" : {
"id" : "5000123",
"code" : "7",
"rate" : 1.4658129805029452
},
"vatAmount1" : 120,
"vatAmount2" : 110,
"vatAmount1Currency" : 126.57,
"vatAmount2Currency" : 113.26,
"guid" : "12004502",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"expenseType" : {
"id" : "5000123",
"code" : "MEAL",
"description" : "Plane",
"km" : false,
"notRefundable" : true,
"icon" : "fa fa-plane",
"color" : "00ff40",
"receiptRequired" : false,
"commentRequired" : false,
"guestsRequired" : false,
"notRefundableEditable" : true,
"billableEditable" : true,
"amountEditable" : true,
"showQuantity" : false,
"showAdditionalComment" : false,
"showReceiptNumber" : true,
"showAmountCategory" : true,
"showBillable" : true,
"hideVat" : false,
"vat1Code" : "1",
"vat2Code" : "2",
"vat3Code" : "3",
"expenseThreshold" : 100,
"defaultAmount" : 45,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"expenseCategory" : "{}",
"expenseRebillableOptions" : "{}",
"showCustomRequest" : true,
"showAmountWithoutVat" : true,
"controlsBehavior" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"calculateKilometers" : true,
"freeEntryProhibited" : true,
"controls" : {
"enableDuplicate" : true,
"enablelOnNonWorkingDay" : true,
"enableOnDayWithLeaveRequest" : true,
"enableOnDayWithTimesheetOrSchedule" : true
},
"expenseThresholdExceededNoVat" : false
},
"expenseTypeId" : "5000123",
"expenseDate" : "2020-01-31T23:59:59Z",
"rebillable" : true,
"notRefundable" : false,
"numberOfDocuments" : 2,
"syncError" : false,
"receiptNumber" : "AK0001",
"missionNumber" : "AK0001",
"kilometers" : 100,
"refused" : false,
"refusalComment" : "Lorem ipsum",
"refusingEmployee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"refusingEmployeeId" : "5000123",
"expenseReportId" : "5000123",
"dateOfDenial" : "2020-01-31T23:59:59Z",
"afterTaxAmountRefunded" : 12.23,
"afterTaxCurrencyAmountRefunded" : 11.17,
"preTaxAmountRefunded" : 10,
"preTaxCurrencyAmountRefunded" : 8.87,
"employeeAcceptationOfDenial" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeAcceptationOfDenialId" : "5000123",
"dateAcceptationOfDenial" : "2020-01-31T23:59:59Z",
"previousExpenseId" : "5000123",
"dateCancellationOfDenial" : "2020-01-31T23:59:59Z",
"employeeCancellationOfDenial" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeCancellationOfDenialId" : "5000123",
"preTaxExpenseAmount" : 20,
"guests" : [ {
"id" : "5000123",
"expenseId" : "5000123",
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}",
"title" : "GEN",
"phone" : "+33 6 04 04 04 05",
"mobilePhone" : "+33 6 00 00 00 01",
"email" : "myemail@bechmail.com",
"noTimesDunning" : true,
"assignmentMultiCompany" : false,
"modeTimeRecording" : 1,
"modeInputSchedule" : 3,
"timeRecordingInputMode" : "{}",
"scheduleInputMode" : "{}",
"executive" : true,
"generic" : true,
"candidate" : false,
"external" : false,
"managerMultiCompany" : true,
"employeeFunctions" : {
"allFunctions" : false,
"allSales" : true,
"allPurchases" : false,
"allOperational" : true,
"projectSalesManager" : false,
"projectFinanceManager" : true,
"projectProductionManager" : false,
"projectAccountManager" : true,
"projectAssignment" : false,
"projectPhaseManager" : true,
"projectSendOnMission" : false,
"salesSalesAssistant" : true,
"salesOrderAndEstimateTracking" : false,
"salesBillingSchedulesTracking" : true,
"purchasingBuyer" : false,
"timeRecording" : true,
"inputOfExpenseReport" : false,
"purchasesReceptionTracking" : false,
"inputSchedule" : false,
"CMMSContractSalesManager" : false,
"CMMSContractTechnicalManager" : false,
"CMMSMRAndEOManager" : false
},
"employeeHistory" : [ {
"id" : "5000123",
"employeeHistoryType" : "5000123",
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 7.42,
"weekHours" : 38.3,
"occupancyRate" : 0.8,
"manager" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"managerId" : "5000123",
"company" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo"
},
"companyId" : "5000123",
"directHourlyRate" : 10.42,
"standardHourlyRate" : 10,
"dailyCost" : 59.36,
"dailySellingPrice" : 80,
"entity" : "5000123",
"serviceRef" : {
"id" : "5000123",
"name" : "Professional services",
"code" : "PS"
},
"service" : "5000123",
"position" : "Developer",
"skillRef" : {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
},
"skill" : "5000123",
"family1" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family1Id" : "5000123",
"family2" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family2Id" : "5000123",
"family3" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family3Id" : "5000123",
"leave" : false,
"standardWeek" : {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
}
},
"standardWeekId" : "5000123",
"salary" : 1024
}, {
"id" : "5000123",
"employeeHistoryType" : "5000123",
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 7.42,
"weekHours" : 38.3,
"occupancyRate" : 0.8,
"manager" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"managerId" : "5000123",
"company" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo"
},
"companyId" : "5000123",
"directHourlyRate" : 10.42,
"standardHourlyRate" : 10,
"dailyCost" : 59.36,
"dailySellingPrice" : 80,
"entity" : "5000123",
"serviceRef" : {
"id" : "5000123",
"name" : "Professional services",
"code" : "PS"
},
"service" : "5000123",
"position" : "Developer",
"skillRef" : {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
},
"skill" : "5000123",
"family1" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family1Id" : "5000123",
"family2" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family2Id" : "5000123",
"family3" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family3Id" : "5000123",
"leave" : false,
"standardWeek" : {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
}
},
"standardWeekId" : "5000123",
"salary" : 1024
} ],
"companyChanges" : [ {
"id" : "5000123",
"employeeId" : "500123",
"companyId" : "5000123",
"startDate" : "2020-01-23T04:56:07Z",
"endDate" : "2020-01-23T04:56:07Z",
"companyChangeState" : "{}",
"comment" : "Limpso usum"
}, {
"id" : "5000123",
"employeeId" : "500123",
"companyId" : "5000123",
"startDate" : "2020-01-23T04:56:07Z",
"endDate" : "2020-01-23T04:56:07Z",
"companyChangeState" : "{}",
"comment" : "Limpso usum"
} ],
"timeRecordingRules" : {
"id" : "5000123",
"employeeId" : "5000123",
"min" : 0,
"max" : 24,
"step" : 0.01,
"prettyStep" : 0.3,
"base" : 60,
"unit" : "H",
"unitDuration" : "{}",
"allowManualEntry" : true,
"employeeWeeks" : [ {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
},
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 8,
"dailyMinutes" : 10,
"weekHours" : 40,
"leave" : false
}, {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
},
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 8,
"dailyMinutes" : 10,
"weekHours" : 40,
"leave" : false
} ],
"closingDates" : [ {
"closingDate" : "2020-01-31T23:59:59Z",
"module" : "DATE_MODULE",
"beginningOfPeriod" : "2020-01-31T23:59:59Z",
"endOfPeriod" : "2020-01-31T23:59:59Z"
}, {
"closingDate" : "2020-01-31T23:59:59Z",
"module" : "DATE_MODULE",
"beginningOfPeriod" : "2020-01-31T23:59:59Z",
"endOfPeriod" : "2020-01-31T23:59:59Z"
} ],
"simpleDuration" : 750,
"completionMode" : "WEEKLY"
},
"scheduleRules" : {
"id" : "5000123",
"employeeId" : "5000123",
"min" : 0,
"max" : 24,
"step" : 0.01,
"prettyStep" : 0.3,
"base" : 60,
"unit" : "H",
"unitDuration" : "{}",
"allowManualEntry" : true,
"employeeWeeks" : [ {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
},
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 8,
"dailyMinutes" : 10,
"weekHours" : 40,
"leave" : false
}, {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
},
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 8,
"dailyMinutes" : 10,
"weekHours" : 40,
"leave" : false
} ],
"closingDates" : [ {
"closingDate" : "2020-01-31T23:59:59Z",
"module" : "DATE_MODULE",
"beginningOfPeriod" : "2020-01-31T23:59:59Z",
"endOfPeriod" : "2020-01-31T23:59:59Z"
}, {
"closingDate" : "2020-01-31T23:59:59Z",
"module" : "DATE_MODULE",
"beginningOfPeriod" : "2020-01-31T23:59:59Z",
"endOfPeriod" : "2020-01-31T23:59:59Z"
} ],
"timestamped" : true
},
"businessCards" : [ {
"id" : "5000123",
"employeeId" : "5000123",
"cardNumber" : "XXXX XXXX XXXX 7568",
"encryptedCardNumber" : "0",
"name" : "Management card",
"type" : "{}",
"endDate" : "2020-01-31T23:59:59Z"
}, {
"id" : "5000123",
"employeeId" : "5000123",
"cardNumber" : "XXXX XXXX XXXX 7568",
"encryptedCardNumber" : "0",
"name" : "Management card",
"type" : "{}",
"endDate" : "2020-01-31T23:59:59Z"
} ],
"sector" : "Marketing",
"number" : "84",
"relations" : [ {
"id" : "5000123",
"relationType" : {
"id" : "5000123",
"code" : "TUTOR",
"name" : "Tutor for internship"
},
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"relatedEmployee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"relatedEmployeeId" : "5000123"
}, {
"id" : "5000123",
"relationType" : {
"id" : "5000123",
"code" : "TUTOR",
"name" : "Tutor for internship"
},
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"relatedEmployee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"relatedEmployeeId" : "5000123"
} ],
"employeeAbilities" : [ {
"id" : "5000123",
"skill" : {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
},
"level" : {
"id" : "5000123",
"code" : "EXP",
"name" : "Expert"
},
"startDate" : "2020-01-31T23:59:59Z",
"endDate" : "2020-01-31T23:59:59Z",
"employeeId" : "5000123"
}, {
"id" : "5000123",
"skill" : {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
},
"level" : {
"id" : "5000123",
"code" : "EXP",
"name" : "Expert"
},
"startDate" : "2020-01-31T23:59:59Z",
"endDate" : "2020-01-31T23:59:59Z",
"employeeId" : "5000123"
} ],
"jobType" : {
"id" : "5000123",
"companyCode" : "AKSAS",
"code" : "ADMIN",
"name" : "Administrator",
"category" : "{}",
"validity" : {
"type" : "{}",
"date" : "2000-06-21T04:56:07.000+00:00"
},
"default" : true
},
"jobTypeId" : "100245",
"address" : {
"id" : "id",
"line1" : "221B Baker Street",
"line2" : "2nd Floor",
"line3" : "First door at your right",
"cedex" : "CEDEX 14",
"postalCode" : "69002",
"city" : "London",
"country" : "FR (for 'FRANCE')",
"countryName" : "FRANCE",
"department" : "75 (for 'PARIS')",
"geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
"region" : "65 (for 'ILE DE FRANCE')",
"regionName" : "ILE DE FRANCE",
"phone" : "06 00 00 00 01",
"phone2" : "06 00 00 00 02",
"email" : "myemail@mail.com",
"mobilePhone" : "06 00 00 00 02",
"fax" : "04 00 00 00 07",
"webSite" : "mysite.com"
},
"addressId" : "5000123",
"birthDate" : "2000-06-21T04:56:07.000+00:00",
"customData" : {
"key" : {
"type" : "{}",
"value" : "Autoref 010520",
"name" : "Reference 4",
"realOrder" : 0,
"label" : "REFERENCE_4"
}
},
"color" : "#FF0000",
"targetTace" : 75,
"formConfig" : {
"type" : "{}",
"fields" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"controls" : {
"key" : {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}
},
"insertable" : true,
"editable" : false,
"deletable" : false,
"formSearchHidden" : false
},
"changeTracking" : {
"createdTime" : "2000-06-21T04:56:07.000+00:00",
"createdBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"createdById" : "5000123",
"modificationTime" : "2000-06-21T04:56:07.000+00:00",
"modificationBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"modificationById" : "5000123"
},
"vehicles" : [ {
"id" : "5000123",
"power" : 5,
"licensePlate" : "licensePlate",
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"expenseType" : {
"id" : "5000123",
"code" : "MEAL",
"description" : "Plane",
"km" : false,
"notRefundable" : true,
"icon" : "fa fa-plane",
"color" : "00ff40",
"receiptRequired" : false,
"commentRequired" : false,
"guestsRequired" : false,
"notRefundableEditable" : true,
"billableEditable" : true,
"amountEditable" : true,
"showQuantity" : false,
"showAdditionalComment" : false,
"showReceiptNumber" : true,
"showAmountCategory" : true,
"showBillable" : true,
"hideVat" : false,
"vat1Code" : "1",
"vat2Code" : "2",
"vat3Code" : "3",
"expenseThreshold" : 100,
"defaultAmount" : 45,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"expenseCategory" : "{}",
"expenseRebillableOptions" : "{}",
"showCustomRequest" : true,
"showAmountWithoutVat" : true,
"controlsBehavior" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"calculateKilometers" : true,
"freeEntryProhibited" : true,
"controls" : {
"enableDuplicate" : true,
"enablelOnNonWorkingDay" : true,
"enableOnDayWithLeaveRequest" : true,
"enableOnDayWithTimesheetOrSchedule" : true
},
"expenseThresholdExceededNoVat" : false
},
"expenseTypeId" : "5000123",
"endDate" : "2020-01-31T23:59:59Z"
}, {
"id" : "5000123",
"power" : 5,
"licensePlate" : "licensePlate",
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"expenseType" : {
"id" : "5000123",
"code" : "MEAL",
"description" : "Plane",
"km" : false,
"notRefundable" : true,
"icon" : "fa fa-plane",
"color" : "00ff40",
"receiptRequired" : false,
"commentRequired" : false,
"guestsRequired" : false,
"notRefundableEditable" : true,
"billableEditable" : true,
"amountEditable" : true,
"showQuantity" : false,
"showAdditionalComment" : false,
"showReceiptNumber" : true,
"showAmountCategory" : true,
"showBillable" : true,
"hideVat" : false,
"vat1Code" : "1",
"vat2Code" : "2",
"vat3Code" : "3",
"expenseThreshold" : 100,
"defaultAmount" : 45,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"expenseCategory" : "{}",
"expenseRebillableOptions" : "{}",
"showCustomRequest" : true,
"showAmountWithoutVat" : true,
"controlsBehavior" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"calculateKilometers" : true,
"freeEntryProhibited" : true,
"controls" : {
"enableDuplicate" : true,
"enablelOnNonWorkingDay" : true,
"enableOnDayWithLeaveRequest" : true,
"enableOnDayWithTimesheetOrSchedule" : true
},
"expenseThresholdExceededNoVat" : false
},
"expenseTypeId" : "5000123",
"endDate" : "2020-01-31T23:59:59Z"
} ],
"currentCompany" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo",
"legalName" : "legalName",
"siren" : "siren",
"siret" : "siret",
"calendar" : {
"id" : "5000123",
"code" : "Text",
"name" : "Text",
"default" : true,
"daysNotWorked" : [ 6, 6 ],
"holidays" : [ {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
}, {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
} ]
},
"calendarId" : "calendarId",
"color" : "color",
"currency" : {
"id" : "5000123",
"name" : "Euro",
"code" : "EUR",
"order" : 17,
"euro" : true,
"euroRate" : 0.9678,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"euroRateStartDate" : "2020-01-23T04:56:07Z",
"euroRateEndDate" : "2020-01-23T04:56:07Z"
},
"currencyId" : "currencyId",
"address" : {
"id" : "id",
"line1" : "221B Baker Street",
"line2" : "2nd Floor",
"line3" : "First door at your right",
"cedex" : "CEDEX 14",
"postalCode" : "69002",
"city" : "London",
"country" : "FR (for 'FRANCE')",
"countryName" : "FRANCE",
"department" : "75 (for 'PARIS')",
"geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
"region" : "65 (for 'ILE DE FRANCE')",
"regionName" : "ILE DE FRANCE",
"phone" : "06 00 00 00 01",
"phone2" : "06 00 00 00 02",
"email" : "myemail@mail.com",
"mobilePhone" : "06 00 00 00 02",
"fax" : "04 00 00 00 07",
"webSite" : "mysite.com"
},
"addressId" : "addressId"
},
"currentCompanyId" : "5000123",
"bankingInformation" : {
"id" : "5000123",
"sepa" : {
"bankDetails" : {
"entity" : "30002",
"counter" : "550",
"accountNumber" : "0000157841Z",
"key" : "25",
"domiciliation" : "AURA"
},
"bic" : {
"country" : "FR (for 'FRANCE')",
"bank" : "DAAE",
"location" : "PP",
"branch" : "CCT"
},
"iban" : {
"country" : "FR (for 'FRANCE')",
"key" : "69",
"accountNumber" : "0000157841Z"
}
},
"noneSepa" : {
"defaultBankDetail" : false,
"beneficiary" : {
"holder" : {
"name" : "RITA",
"firstName" : "BRITA",
"accountType" : "{}",
"accountNumber" : "123456789"
},
"bank" : {
"bankName" : "UBA",
"bankName2" : "UBA",
"bankType" : "{}",
"bankCode" : "C8",
"bankAddress" : {
"id" : "id",
"line1" : "221B Baker Street",
"line2" : "2nd Floor",
"line3" : "First door at your right",
"cedex" : "CEDEX 14",
"postalCode" : "69002",
"city" : "London",
"country" : "FR (for 'FRANCE')",
"countryName" : "FRANCE",
"department" : "75 (for 'PARIS')",
"geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
"region" : "65 (for 'ILE DE FRANCE')",
"regionName" : "ILE DE FRANCE",
"phone" : "06 00 00 00 01",
"phone2" : "06 00 00 00 02",
"email" : "myemail@mail.com",
"mobilePhone" : "06 00 00 00 02",
"fax" : "04 00 00 00 07",
"webSite" : "mysite.com"
}
}
},
"intermediate" : {
"holder" : {
"name" : "RITA",
"firstName" : "BRITA",
"accountType" : "{}",
"accountNumber" : "123456789"
},
"bank" : {
"bankName" : "UBA",
"bankName2" : "UBA",
"bankType" : "{}",
"bankCode" : "C8",
"bankAddress" : {
"id" : "id",
"line1" : "221B Baker Street",
"line2" : "2nd Floor",
"line3" : "First door at your right",
"cedex" : "CEDEX 14",
"postalCode" : "69002",
"city" : "London",
"country" : "FR (for 'FRANCE')",
"countryName" : "FRANCE",
"department" : "75 (for 'PARIS')",
"geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
"region" : "65 (for 'ILE DE FRANCE')",
"regionName" : "ILE DE FRANCE",
"phone" : "06 00 00 00 01",
"phone2" : "06 00 00 00 02",
"email" : "myemail@mail.com",
"mobilePhone" : "06 00 00 00 02",
"fax" : "04 00 00 00 07",
"webSite" : "mysite.com"
}
}
}
},
"statusChangeDate" : "2000-06-21T04:56:07.000+00:00",
"statusChangeArgument" : {
"comment" : "Comment",
"status" : "{}"
},
"validator" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"validatorId" : "5000123",
"action" : "{}",
"type" : "{}"
},
"faxNumber" : "418 643 3210",
"phoneExtensionNumber" : "04 00 00 00 07"
},
"employeeId" : "5000123",
"lastName" : "DOE",
"firstName" : "John",
"company" : "AKSAS"
}, {
"id" : "5000123",
"expenseId" : "5000123",
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}",
"title" : "GEN",
"phone" : "+33 6 04 04 04 05",
"mobilePhone" : "+33 6 00 00 00 01",
"email" : "myemail@bechmail.com",
"noTimesDunning" : true,
"assignmentMultiCompany" : false,
"modeTimeRecording" : 1,
"modeInputSchedule" : 3,
"timeRecordingInputMode" : "{}",
"scheduleInputMode" : "{}",
"executive" : true,
"generic" : true,
"candidate" : false,
"external" : false,
"managerMultiCompany" : true,
"employeeFunctions" : {
"allFunctions" : false,
"allSales" : true,
"allPurchases" : false,
"allOperational" : true,
"projectSalesManager" : false,
"projectFinanceManager" : true,
"projectProductionManager" : false,
"projectAccountManager" : true,
"projectAssignment" : false,
"projectPhaseManager" : true,
"projectSendOnMission" : false,
"salesSalesAssistant" : true,
"salesOrderAndEstimateTracking" : false,
"salesBillingSchedulesTracking" : true,
"purchasingBuyer" : false,
"timeRecording" : true,
"inputOfExpenseReport" : false,
"purchasesReceptionTracking" : false,
"inputSchedule" : false,
"CMMSContractSalesManager" : false,
"CMMSContractTechnicalManager" : false,
"CMMSMRAndEOManager" : false
},
"employeeHistory" : [ {
"id" : "5000123",
"employeeHistoryType" : "5000123",
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 7.42,
"weekHours" : 38.3,
"occupancyRate" : 0.8,
"manager" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"managerId" : "5000123",
"company" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo"
},
"companyId" : "5000123",
"directHourlyRate" : 10.42,
"standardHourlyRate" : 10,
"dailyCost" : 59.36,
"dailySellingPrice" : 80,
"entity" : "5000123",
"serviceRef" : {
"id" : "5000123",
"name" : "Professional services",
"code" : "PS"
},
"service" : "5000123",
"position" : "Developer",
"skillRef" : {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
},
"skill" : "5000123",
"family1" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family1Id" : "5000123",
"family2" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family2Id" : "5000123",
"family3" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family3Id" : "5000123",
"leave" : false,
"standardWeek" : {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
}
},
"standardWeekId" : "5000123",
"salary" : 1024
}, {
"id" : "5000123",
"employeeHistoryType" : "5000123",
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 7.42,
"weekHours" : 38.3,
"occupancyRate" : 0.8,
"manager" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"managerId" : "5000123",
"company" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo"
},
"companyId" : "5000123",
"directHourlyRate" : 10.42,
"standardHourlyRate" : 10,
"dailyCost" : 59.36,
"dailySellingPrice" : 80,
"entity" : "5000123",
"serviceRef" : {
"id" : "5000123",
"name" : "Professional services",
"code" : "PS"
},
"service" : "5000123",
"position" : "Developer",
"skillRef" : {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
},
"skill" : "5000123",
"family1" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family1Id" : "5000123",
"family2" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family2Id" : "5000123",
"family3" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family3Id" : "5000123",
"leave" : false,
"standardWeek" : {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
}
},
"standardWeekId" : "5000123",
"salary" : 1024
} ],
"companyChanges" : [ {
"id" : "5000123",
"employeeId" : "500123",
"companyId" : "5000123",
"startDate" : "2020-01-23T04:56:07Z",
"endDate" : "2020-01-23T04:56:07Z",
"companyChangeState" : "{}",
"comment" : "Limpso usum"
}, {
"id" : "5000123",
"employeeId" : "500123",
"companyId" : "5000123",
"startDate" : "2020-01-23T04:56:07Z",
"endDate" : "2020-01-23T04:56:07Z",
"companyChangeState" : "{}",
"comment" : "Limpso usum"
} ],
"timeRecordingRules" : {
"id" : "5000123",
"employeeId" : "5000123",
"min" : 0,
"max" : 24,
"step" : 0.01,
"prettyStep" : 0.3,
"base" : 60,
"unit" : "H",
"unitDuration" : "{}",
"allowManualEntry" : true,
"employeeWeeks" : [ {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
},
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 8,
"dailyMinutes" : 10,
"weekHours" : 40,
"leave" : false
}, {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
},
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 8,
"dailyMinutes" : 10,
"weekHours" : 40,
"leave" : false
} ],
"closingDates" : [ {
"closingDate" : "2020-01-31T23:59:59Z",
"module" : "DATE_MODULE",
"beginningOfPeriod" : "2020-01-31T23:59:59Z",
"endOfPeriod" : "2020-01-31T23:59:59Z"
}, {
"closingDate" : "2020-01-31T23:59:59Z",
"module" : "DATE_MODULE",
"beginningOfPeriod" : "2020-01-31T23:59:59Z",
"endOfPeriod" : "2020-01-31T23:59:59Z"
} ],
"simpleDuration" : 750,
"completionMode" : "WEEKLY"
},
"scheduleRules" : {
"id" : "5000123",
"employeeId" : "5000123",
"min" : 0,
"max" : 24,
"step" : 0.01,
"prettyStep" : 0.3,
"base" : 60,
"unit" : "H",
"unitDuration" : "{}",
"allowManualEntry" : true,
"employeeWeeks" : [ {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
},
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 8,
"dailyMinutes" : 10,
"weekHours" : 40,
"leave" : false
}, {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
},
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 8,
"dailyMinutes" : 10,
"weekHours" : 40,
"leave" : false
} ],
"closingDates" : [ {
"closingDate" : "2020-01-31T23:59:59Z",
"module" : "DATE_MODULE",
"beginningOfPeriod" : "2020-01-31T23:59:59Z",
"endOfPeriod" : "2020-01-31T23:59:59Z"
}, {
"closingDate" : "2020-01-31T23:59:59Z",
"module" : "DATE_MODULE",
"beginningOfPeriod" : "2020-01-31T23:59:59Z",
"endOfPeriod" : "2020-01-31T23:59:59Z"
} ],
"timestamped" : true
},
"businessCards" : [ {
"id" : "5000123",
"employeeId" : "5000123",
"cardNumber" : "XXXX XXXX XXXX 7568",
"encryptedCardNumber" : "0",
"name" : "Management card",
"type" : "{}",
"endDate" : "2020-01-31T23:59:59Z"
}, {
"id" : "5000123",
"employeeId" : "5000123",
"cardNumber" : "XXXX XXXX XXXX 7568",
"encryptedCardNumber" : "0",
"name" : "Management card",
"type" : "{}",
"endDate" : "2020-01-31T23:59:59Z"
} ],
"sector" : "Marketing",
"number" : "84",
"relations" : [ {
"id" : "5000123",
"relationType" : {
"id" : "5000123",
"code" : "TUTOR",
"name" : "Tutor for internship"
},
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"relatedEmployee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"relatedEmployeeId" : "5000123"
}, {
"id" : "5000123",
"relationType" : {
"id" : "5000123",
"code" : "TUTOR",
"name" : "Tutor for internship"
},
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"relatedEmployee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"relatedEmployeeId" : "5000123"
} ],
"employeeAbilities" : [ {
"id" : "5000123",
"skill" : {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
},
"level" : {
"id" : "5000123",
"code" : "EXP",
"name" : "Expert"
},
"startDate" : "2020-01-31T23:59:59Z",
"endDate" : "2020-01-31T23:59:59Z",
"employeeId" : "5000123"
}, {
"id" : "5000123",
"skill" : {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
},
"level" : {
"id" : "5000123",
"code" : "EXP",
"name" : "Expert"
},
"startDate" : "2020-01-31T23:59:59Z",
"endDate" : "2020-01-31T23:59:59Z",
"employeeId" : "5000123"
} ],
"jobType" : {
"id" : "5000123",
"companyCode" : "AKSAS",
"code" : "ADMIN",
"name" : "Administrator",
"category" : "{}",
"validity" : {
"type" : "{}",
"date" : "2000-06-21T04:56:07.000+00:00"
},
"default" : true
},
"jobTypeId" : "100245",
"address" : {
"id" : "id",
"line1" : "221B Baker Street",
"line2" : "2nd Floor",
"line3" : "First door at your right",
"cedex" : "CEDEX 14",
"postalCode" : "69002",
"city" : "London",
"country" : "FR (for 'FRANCE')",
"countryName" : "FRANCE",
"department" : "75 (for 'PARIS')",
"geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
"region" : "65 (for 'ILE DE FRANCE')",
"regionName" : "ILE DE FRANCE",
"phone" : "06 00 00 00 01",
"phone2" : "06 00 00 00 02",
"email" : "myemail@mail.com",
"mobilePhone" : "06 00 00 00 02",
"fax" : "04 00 00 00 07",
"webSite" : "mysite.com"
},
"addressId" : "5000123",
"birthDate" : "2000-06-21T04:56:07.000+00:00",
"customData" : {
"key" : {
"type" : "{}",
"value" : "Autoref 010520",
"name" : "Reference 4",
"realOrder" : 0,
"label" : "REFERENCE_4"
}
},
"color" : "#FF0000",
"targetTace" : 75,
"formConfig" : {
"type" : "{}",
"fields" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"controls" : {
"key" : {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}
},
"insertable" : true,
"editable" : false,
"deletable" : false,
"formSearchHidden" : false
},
"changeTracking" : {
"createdTime" : "2000-06-21T04:56:07.000+00:00",
"createdBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"createdById" : "5000123",
"modificationTime" : "2000-06-21T04:56:07.000+00:00",
"modificationBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"modificationById" : "5000123"
},
"vehicles" : [ {
"id" : "5000123",
"power" : 5,
"licensePlate" : "licensePlate",
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"expenseType" : {
"id" : "5000123",
"code" : "MEAL",
"description" : "Plane",
"km" : false,
"notRefundable" : true,
"icon" : "fa fa-plane",
"color" : "00ff40",
"receiptRequired" : false,
"commentRequired" : false,
"guestsRequired" : false,
"notRefundableEditable" : true,
"billableEditable" : true,
"amountEditable" : true,
"showQuantity" : false,
"showAdditionalComment" : false,
"showReceiptNumber" : true,
"showAmountCategory" : true,
"showBillable" : true,
"hideVat" : false,
"vat1Code" : "1",
"vat2Code" : "2",
"vat3Code" : "3",
"expenseThreshold" : 100,
"defaultAmount" : 45,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"expenseCategory" : "{}",
"expenseRebillableOptions" : "{}",
"showCustomRequest" : true,
"showAmountWithoutVat" : true,
"controlsBehavior" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"calculateKilometers" : true,
"freeEntryProhibited" : true,
"controls" : {
"enableDuplicate" : true,
"enablelOnNonWorkingDay" : true,
"enableOnDayWithLeaveRequest" : true,
"enableOnDayWithTimesheetOrSchedule" : true
},
"expenseThresholdExceededNoVat" : false
},
"expenseTypeId" : "5000123",
"endDate" : "2020-01-31T23:59:59Z"
}, {
"id" : "5000123",
"power" : 5,
"licensePlate" : "licensePlate",
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"expenseType" : {
"id" : "5000123",
"code" : "MEAL",
"description" : "Plane",
"km" : false,
"notRefundable" : true,
"icon" : "fa fa-plane",
"color" : "00ff40",
"receiptRequired" : false,
"commentRequired" : false,
"guestsRequired" : false,
"notRefundableEditable" : true,
"billableEditable" : true,
"amountEditable" : true,
"showQuantity" : false,
"showAdditionalComment" : false,
"showReceiptNumber" : true,
"showAmountCategory" : true,
"showBillable" : true,
"hideVat" : false,
"vat1Code" : "1",
"vat2Code" : "2",
"vat3Code" : "3",
"expenseThreshold" : 100,
"defaultAmount" : 45,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"expenseCategory" : "{}",
"expenseRebillableOptions" : "{}",
"showCustomRequest" : true,
"showAmountWithoutVat" : true,
"controlsBehavior" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"calculateKilometers" : true,
"freeEntryProhibited" : true,
"controls" : {
"enableDuplicate" : true,
"enablelOnNonWorkingDay" : true,
"enableOnDayWithLeaveRequest" : true,
"enableOnDayWithTimesheetOrSchedule" : true
},
"expenseThresholdExceededNoVat" : false
},
"expenseTypeId" : "5000123",
"endDate" : "2020-01-31T23:59:59Z"
} ],
"currentCompany" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo",
"legalName" : "legalName",
"siren" : "siren",
"siret" : "siret",
"calendar" : {
"id" : "5000123",
"code" : "Text",
"name" : "Text",
"default" : true,
"daysNotWorked" : [ 6, 6 ],
"holidays" : [ {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
}, {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
} ]
},
"calendarId" : "calendarId",
"color" : "color",
"currency" : {
"id" : "5000123",
"name" : "Euro",
"code" : "EUR",
"order" : 17,
"euro" : true,
"euroRate" : 0.9678,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"euroRateStartDate" : "2020-01-23T04:56:07Z",
"euroRateEndDate" : "2020-01-23T04:56:07Z"
},
"currencyId" : "currencyId",
"address" : {
"id" : "id",
"line1" : "221B Baker Street",
"line2" : "2nd Floor",
"line3" : "First door at your right",
"cedex" : "CEDEX 14",
"postalCode" : "69002",
"city" : "London",
"country" : "FR (for 'FRANCE')",
"countryName" : "FRANCE",
"department" : "75 (for 'PARIS')",
"geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
"region" : "65 (for 'ILE DE FRANCE')",
"regionName" : "ILE DE FRANCE",
"phone" : "06 00 00 00 01",
"phone2" : "06 00 00 00 02",
"email" : "myemail@mail.com",
"mobilePhone" : "06 00 00 00 02",
"fax" : "04 00 00 00 07",
"webSite" : "mysite.com"
},
"addressId" : "addressId"
},
"currentCompanyId" : "5000123",
"bankingInformation" : {
"id" : "5000123",
"sepa" : {
"bankDetails" : {
"entity" : "30002",
"counter" : "550",
"accountNumber" : "0000157841Z",
"key" : "25",
"domiciliation" : "AURA"
},
"bic" : {
"country" : "FR (for 'FRANCE')",
"bank" : "DAAE",
"location" : "PP",
"branch" : "CCT"
},
"iban" : {
"country" : "FR (for 'FRANCE')",
"key" : "69",
"accountNumber" : "0000157841Z"
}
},
"noneSepa" : {
"defaultBankDetail" : false,
"beneficiary" : {
"holder" : {
"name" : "RITA",
"firstName" : "BRITA",
"accountType" : "{}",
"accountNumber" : "123456789"
},
"bank" : {
"bankName" : "UBA",
"bankName2" : "UBA",
"bankType" : "{}",
"bankCode" : "C8",
"bankAddress" : {
"id" : "id",
"line1" : "221B Baker Street",
"line2" : "2nd Floor",
"line3" : "First door at your right",
"cedex" : "CEDEX 14",
"postalCode" : "69002",
"city" : "London",
"country" : "FR (for 'FRANCE')",
"countryName" : "FRANCE",
"department" : "75 (for 'PARIS')",
"geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
"region" : "65 (for 'ILE DE FRANCE')",
"regionName" : "ILE DE FRANCE",
"phone" : "06 00 00 00 01",
"phone2" : "06 00 00 00 02",
"email" : "myemail@mail.com",
"mobilePhone" : "06 00 00 00 02",
"fax" : "04 00 00 00 07",
"webSite" : "mysite.com"
}
}
},
"intermediate" : {
"holder" : {
"name" : "RITA",
"firstName" : "BRITA",
"accountType" : "{}",
"accountNumber" : "123456789"
},
"bank" : {
"bankName" : "UBA",
"bankName2" : "UBA",
"bankType" : "{}",
"bankCode" : "C8",
"bankAddress" : {
"id" : "id",
"line1" : "221B Baker Street",
"line2" : "2nd Floor",
"line3" : "First door at your right",
"cedex" : "CEDEX 14",
"postalCode" : "69002",
"city" : "London",
"country" : "FR (for 'FRANCE')",
"countryName" : "FRANCE",
"department" : "75 (for 'PARIS')",
"geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
"region" : "65 (for 'ILE DE FRANCE')",
"regionName" : "ILE DE FRANCE",
"phone" : "06 00 00 00 01",
"phone2" : "06 00 00 00 02",
"email" : "myemail@mail.com",
"mobilePhone" : "06 00 00 00 02",
"fax" : "04 00 00 00 07",
"webSite" : "mysite.com"
}
}
}
},
"statusChangeDate" : "2000-06-21T04:56:07.000+00:00",
"statusChangeArgument" : {
"comment" : "Comment",
"status" : "{}"
},
"validator" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"validatorId" : "5000123",
"action" : "{}",
"type" : "{}"
},
"faxNumber" : "418 643 3210",
"phoneExtensionNumber" : "04 00 00 00 07"
},
"employeeId" : "5000123",
"lastName" : "DOE",
"firstName" : "John",
"company" : "AKSAS"
} ],
"fiscalPower" : {
"id" : "5000123",
"power" : 5,
"rate" : 0.36,
"startDate" : "2020-01-31T23:59:59Z",
"endDate" : "2020-01-31T23:59:59Z",
"expenseTypeId" : "5000123"
},
"currency" : {
"id" : "5000123",
"name" : "Euro",
"code" : "EUR",
"order" : 17,
"euro" : true,
"euroRate" : 0.9678,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"euroRateStartDate" : "2020-01-23T04:56:07Z",
"euroRateEndDate" : "2020-01-23T04:56:07Z"
},
"currencyCode" : "EUR",
"parts" : 2,
"amountCategory" : "{}",
"alerts" : [ {
"message" : "Lorem ipsum",
"level" : "ERROR"
}, {
"message" : "Lorem ipsum",
"level" : "ERROR"
} ],
"customAssignment" : "CST_PROJECT",
"businessCard" : true,
"documents" : [ {
"id" : "5000123",
"title" : "Title",
"versionId" : "5000123",
"changeTracking" : {
"createdTime" : "2000-06-21T04:56:07.000+00:00",
"createdBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"createdById" : "5000123",
"modificationTime" : "2000-06-21T04:56:07.000+00:00",
"modificationBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"modificationById" : "5000123"
},
"publishedBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"publishedById" : "5001206",
"classification" : "STD",
"subClassification" : "EDITIONS",
"category1" : "CAT1",
"category2" : "CAT2",
"category3" : "CAT3",
"companyId" : "5000123",
"publicationDate" : "2000-06-21T04:56:07.000+00:00",
"version" : 1,
"documentType" : "File",
"fileUrl" : "myFiles/thisFile.pdf",
"fileName" : "thisFile.pdf",
"lienUrl" : "myStorage.com/myFiles/thisFile.pdf",
"url" : "myFiles/thisFile.pdf",
"original" : false,
"preview" : "data:image",
"tokenPreview" : "8946A85V85D851DF",
"externalDMSUuid" : "OD1245126",
"links" : [ {
"id" : "5000123",
"original" : true,
"documentId" : "5000123",
"objectId" : "5000123",
"objectType" : "{}"
}, {
"id" : "5000123",
"original" : true,
"documentId" : "5000123",
"objectId" : "5000123",
"objectType" : "{}"
} ],
"archived" : false,
"action" : "{}",
"owner" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"ownerId" : "5001206",
"description" : "Text",
"category" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"categoryId" : "100024",
"subCategory" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"company" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo",
"legalName" : "legalName",
"siren" : "siren",
"siret" : "siret",
"calendar" : {
"id" : "5000123",
"code" : "Text",
"name" : "Text",
"default" : true,
"daysNotWorked" : [ 6, 6 ],
"holidays" : [ {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
}, {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
} ]
},
"calendarId" : "calendarId",
"color" : "color",
"currency" : {
"id" : "5000123",
"name" : "Euro",
"code" : "EUR",
"order" : 17,
"euro" : true,
"euroRate" : 0.9678,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"euroRateStartDate" : "2020-01-23T04:56:07Z",
"euroRateEndDate" : "2020-01-23T04:56:07Z"
},
"currencyId" : "currencyId",
"address" : {
"id" : "id",
"line1" : "221B Baker Street",
"line2" : "2nd Floor",
"line3" : "First door at your right",
"cedex" : "CEDEX 14",
"postalCode" : "69002",
"city" : "London",
"country" : "FR (for 'FRANCE')",
"countryName" : "FRANCE",
"department" : "75 (for 'PARIS')",
"geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
"region" : "65 (for 'ILE DE FRANCE')",
"regionName" : "ILE DE FRANCE",
"phone" : "06 00 00 00 01",
"phone2" : "06 00 00 00 02",
"email" : "myemail@mail.com",
"mobilePhone" : "06 00 00 00 02",
"fax" : "04 00 00 00 07",
"webSite" : "mysite.com"
},
"addressId" : "addressId"
},
"companyId" : "5000123",
"type" : "{}",
"category" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"categoryId" : "500143",
"grouping" : "grouping",
"ranking" : 2
},
"subCategoryId" : "11037",
"locked" : false
}, {
"id" : "5000123",
"title" : "Title",
"versionId" : "5000123",
"changeTracking" : {
"createdTime" : "2000-06-21T04:56:07.000+00:00",
"createdBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"createdById" : "5000123",
"modificationTime" : "2000-06-21T04:56:07.000+00:00",
"modificationBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"modificationById" : "5000123"
},
"publishedBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"publishedById" : "5001206",
"classification" : "STD",
"subClassification" : "EDITIONS",
"category1" : "CAT1",
"category2" : "CAT2",
"category3" : "CAT3",
"companyId" : "5000123",
"publicationDate" : "2000-06-21T04:56:07.000+00:00",
"version" : 1,
"documentType" : "File",
"fileUrl" : "myFiles/thisFile.pdf",
"fileName" : "thisFile.pdf",
"lienUrl" : "myStorage.com/myFiles/thisFile.pdf",
"url" : "myFiles/thisFile.pdf",
"original" : false,
"preview" : "data:image",
"tokenPreview" : "8946A85V85D851DF",
"externalDMSUuid" : "OD1245126",
"links" : [ {
"id" : "5000123",
"original" : true,
"documentId" : "5000123",
"objectId" : "5000123",
"objectType" : "{}"
}, {
"id" : "5000123",
"original" : true,
"documentId" : "5000123",
"objectId" : "5000123",
"objectType" : "{}"
} ],
"archived" : false,
"action" : "{}",
"owner" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"ownerId" : "5001206",
"description" : "Text",
"category" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"categoryId" : "100024",
"subCategory" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"company" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo",
"legalName" : "legalName",
"siren" : "siren",
"siret" : "siret",
"calendar" : {
"id" : "5000123",
"code" : "Text",
"name" : "Text",
"default" : true,
"daysNotWorked" : [ 6, 6 ],
"holidays" : [ {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
}, {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
} ]
},
"calendarId" : "calendarId",
"color" : "color",
"currency" : {
"id" : "5000123",
"name" : "Euro",
"code" : "EUR",
"order" : 17,
"euro" : true,
"euroRate" : 0.9678,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"euroRateStartDate" : "2020-01-23T04:56:07Z",
"euroRateEndDate" : "2020-01-23T04:56:07Z"
},
"currencyId" : "currencyId",
"address" : {
"id" : "id",
"line1" : "221B Baker Street",
"line2" : "2nd Floor",
"line3" : "First door at your right",
"cedex" : "CEDEX 14",
"postalCode" : "69002",
"city" : "London",
"country" : "FR (for 'FRANCE')",
"countryName" : "FRANCE",
"department" : "75 (for 'PARIS')",
"geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
"region" : "65 (for 'ILE DE FRANCE')",
"regionName" : "ILE DE FRANCE",
"phone" : "06 00 00 00 01",
"phone2" : "06 00 00 00 02",
"email" : "myemail@mail.com",
"mobilePhone" : "06 00 00 00 02",
"fax" : "04 00 00 00 07",
"webSite" : "mysite.com"
},
"addressId" : "addressId"
},
"companyId" : "5000123",
"type" : "{}",
"category" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"categoryId" : "500143",
"grouping" : "grouping",
"ranking" : 2
},
"subCategoryId" : "11037",
"locked" : false
} ],
"changeTracking" : {
"createdTime" : "2000-06-21T04:56:07.000+00:00",
"createdBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"createdById" : "5000123",
"modificationTime" : "2000-06-21T04:56:07.000+00:00",
"modificationBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"modificationById" : "5000123"
},
"smartScan" : "{}",
"customRequest" : {
"id" : "5000123",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJT_001",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"subPhase" : {
"id" : "5000123",
"code" : "SB_1",
"name" : "Sub Phase 1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"order" : 1
},
"subPhaseId" : "51000122",
"projectTask" : {
"id" : "5000123",
"code" : "code",
"name" : "Team building",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJT_001",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"subPhase" : {
"id" : "5000123",
"code" : "SB_1",
"name" : "Sub Phase 1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"order" : 1
},
"subPhaseId" : "51000122",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"order" : 2,
"startDate" : "2000-06-21T04:56:07.000+00:00",
"endDate" : "2000-06-21T04:56:07.000+00:00",
"description" : "description"
},
"projectTaskId" : "5000123",
"number" : "CC00001",
"name" : "Label for my doc",
"type" : "{}",
"companyCode" : "AKSAS",
"companyId" : "5000123",
"currencyCode" : "EUR",
"currency" : {
"id" : "5000123",
"name" : "Euro",
"code" : "EUR",
"order" : 17,
"euro" : true,
"euroRate" : 0.9678,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"euroRateStartDate" : "2020-01-23T04:56:07Z",
"euroRateEndDate" : "2020-01-23T04:56:07Z"
},
"date" : "2000-06-21T04:56:07.000+00:00",
"description" : "Lorem ipsum",
"entityCode" : "Lyon",
"afterTaxAmount" : 120.37,
"preTaxAmount" : 100.14,
"thirdPartyId" : "CUSTOMER01",
"customData" : {
"key" : {
"type" : "{}",
"value" : "Autoref 010520",
"name" : "Reference 4",
"realOrder" : 0,
"label" : "REFERENCE_4"
}
},
"changeTracking" : {
"createdTime" : "2000-06-21T04:56:07.000+00:00",
"createdBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"createdById" : "5000123",
"modificationTime" : "2000-06-21T04:56:07.000+00:00",
"modificationBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"modificationById" : "5000123"
},
"approvalState" : "{}",
"approvalDate" : "2000-06-21T04:56:07.000+00:00",
"lines" : [ {
"id" : "5000123",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJT_001",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"subPhase" : {
"id" : "5000123",
"code" : "SB_1",
"name" : "Sub Phase 1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"order" : 1
},
"subPhaseId" : "51000122",
"projectTask" : {
"id" : "5000123",
"code" : "code",
"name" : "Team building",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJT_001",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"subPhase" : {
"id" : "5000123",
"code" : "SB_1",
"name" : "Sub Phase 1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"order" : 1
},
"subPhaseId" : "51000122",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"order" : 2,
"startDate" : "2000-06-21T04:56:07.000+00:00",
"endDate" : "2000-06-21T04:56:07.000+00:00",
"description" : "description"
},
"projectTaskId" : "5000123",
"managementObjectId" : "5000123",
"name" : "Helpdesk",
"quantity" : 3,
"unitPriceCurrency" : 36.32,
"unitPrice" : 40,
"amountTotalCurrency" : 1200,
"amountTotal" : 1200,
"rankNumber" : 2,
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"expenseTypeExpected" : {
"id" : "5000123",
"code" : "AIR-PL",
"name" : "Airplane",
"description" : "Transportation",
"endDate" : "2000-06-21T04:56:07.000+00:00",
"expenseType" : {
"id" : "5000123",
"code" : "MEAL",
"description" : "Plane",
"km" : false,
"notRefundable" : true,
"icon" : "fa fa-plane",
"color" : "00ff40",
"receiptRequired" : false,
"commentRequired" : false,
"guestsRequired" : false,
"notRefundableEditable" : true,
"billableEditable" : true,
"amountEditable" : true,
"showQuantity" : false,
"showAdditionalComment" : false,
"showReceiptNumber" : true,
"showAmountCategory" : true,
"showBillable" : true,
"hideVat" : false,
"vat1Code" : "1",
"vat2Code" : "2",
"vat3Code" : "3",
"expenseThreshold" : 100,
"defaultAmount" : 45,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"expenseCategory" : "{}",
"expenseRebillableOptions" : "{}",
"showCustomRequest" : true,
"showAmountWithoutVat" : true,
"controlsBehavior" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"calculateKilometers" : true,
"freeEntryProhibited" : true,
"controls" : {
"enableDuplicate" : true,
"enablelOnNonWorkingDay" : true,
"enableOnDayWithLeaveRequest" : true,
"enableOnDayWithTimesheetOrSchedule" : true
},
"expenseThresholdExceededNoVat" : false
},
"expenseTypeId" : "expenseTypeId",
"editableExpenseReport" : true,
"defaultExpenseReport" : true
},
"expenseTypeExpectedId" : "5000123",
"isExpenseReport" : true
}, {
"id" : "5000123",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJT_001",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"subPhase" : {
"id" : "5000123",
"code" : "SB_1",
"name" : "Sub Phase 1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"order" : 1
},
"subPhaseId" : "51000122",
"projectTask" : {
"id" : "5000123",
"code" : "code",
"name" : "Team building",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJT_001",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"subPhase" : {
"id" : "5000123",
"code" : "SB_1",
"name" : "Sub Phase 1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"order" : 1
},
"subPhaseId" : "51000122",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"order" : 2,
"startDate" : "2000-06-21T04:56:07.000+00:00",
"endDate" : "2000-06-21T04:56:07.000+00:00",
"description" : "description"
},
"projectTaskId" : "5000123",
"managementObjectId" : "5000123",
"name" : "Helpdesk",
"quantity" : 3,
"unitPriceCurrency" : 36.32,
"unitPrice" : 40,
"amountTotalCurrency" : 1200,
"amountTotal" : 1200,
"rankNumber" : 2,
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"expenseTypeExpected" : {
"id" : "5000123",
"code" : "AIR-PL",
"name" : "Airplane",
"description" : "Transportation",
"endDate" : "2000-06-21T04:56:07.000+00:00",
"expenseType" : {
"id" : "5000123",
"code" : "MEAL",
"description" : "Plane",
"km" : false,
"notRefundable" : true,
"icon" : "fa fa-plane",
"color" : "00ff40",
"receiptRequired" : false,
"commentRequired" : false,
"guestsRequired" : false,
"notRefundableEditable" : true,
"billableEditable" : true,
"amountEditable" : true,
"showQuantity" : false,
"showAdditionalComment" : false,
"showReceiptNumber" : true,
"showAmountCategory" : true,
"showBillable" : true,
"hideVat" : false,
"vat1Code" : "1",
"vat2Code" : "2",
"vat3Code" : "3",
"expenseThreshold" : 100,
"defaultAmount" : 45,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"expenseCategory" : "{}",
"expenseRebillableOptions" : "{}",
"showCustomRequest" : true,
"showAmountWithoutVat" : true,
"controlsBehavior" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"calculateKilometers" : true,
"freeEntryProhibited" : true,
"controls" : {
"enableDuplicate" : true,
"enablelOnNonWorkingDay" : true,
"enableOnDayWithLeaveRequest" : true,
"enableOnDayWithTimesheetOrSchedule" : true
},
"expenseThresholdExceededNoVat" : false
},
"expenseTypeId" : "expenseTypeId",
"editableExpenseReport" : true,
"defaultExpenseReport" : true
},
"expenseTypeExpectedId" : "5000123",
"isExpenseReport" : true
} ],
"category" : {
"id" : "50000012",
"code" : "CATEGORY_1",
"name" : "Category one",
"endDate" : "2000-06-21T04:56:07.000+00:00",
"icon" : "fas fa-pen",
"companyId" : "companyId",
"enableActualDates" : true,
"enableEndDate" : true,
"editableWithoutExpense" : true,
"defaultValueWithoutExpense" : true,
"scheduleCreation" : true,
"timesheetCreation" : true,
"departureLocation" : true,
"departureLocationType" : "{}",
"destinationLocation" : true,
"destinationLocationType" : "{}",
"accreditationLevelType" : 1,
"accreditationOptions" : "{}",
"displayCustomData" : true,
"customDataStart" : 1,
"customDataEnd" : 9,
"customDataNbColumns" : 2
},
"categoryId" : "5000123",
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}",
"title" : "GEN",
"phone" : "+33 6 04 04 04 05",
"mobilePhone" : "+33 6 00 00 00 01",
"email" : "myemail@bechmail.com",
"noTimesDunning" : true,
"assignmentMultiCompany" : false,
"modeTimeRecording" : 1,
"modeInputSchedule" : 3,
"timeRecordingInputMode" : "{}",
"scheduleInputMode" : "{}",
"executive" : true,
"generic" : true,
"candidate" : false,
"external" : false,
"managerMultiCompany" : true,
"employeeFunctions" : {
"allFunctions" : false,
"allSales" : true,
"allPurchases" : false,
"allOperational" : true,
"projectSalesManager" : false,
"projectFinanceManager" : true,
"projectProductionManager" : false,
"projectAccountManager" : true,
"projectAssignment" : false,
"projectPhaseManager" : true,
"projectSendOnMission" : false,
"salesSalesAssistant" : true,
"salesOrderAndEstimateTracking" : false,
"salesBillingSchedulesTracking" : true,
"purchasingBuyer" : false,
"timeRecording" : true,
"inputOfExpenseReport" : false,
"purchasesReceptionTracking" : false,
"inputSchedule" : false,
"CMMSContractSalesManager" : false,
"CMMSContractTechnicalManager" : false,
"CMMSMRAndEOManager" : false
},
"employeeHistory" : [ {
"id" : "5000123",
"employeeHistoryType" : "5000123",
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 7.42,
"weekHours" : 38.3,
"occupancyRate" : 0.8,
"manager" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"managerId" : "5000123",
"company" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo"
},
"companyId" : "5000123",
"directHourlyRate" : 10.42,
"standardHourlyRate" : 10,
"dailyCost" : 59.36,
"dailySellingPrice" : 80,
"entity" : "5000123",
"serviceRef" : {
"id" : "5000123",
"name" : "Professional services",
"code" : "PS"
},
"service" : "5000123",
"position" : "Developer",
"skillRef" : {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
},
"skill" : "5000123",
"family1" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family1Id" : "5000123",
"family2" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family2Id" : "5000123",
"family3" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family3Id" : "5000123",
"leave" : false,
"standardWeek" : {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
}
},
"standardWeekId" : "5000123",
"salary" : 1024
}, {
"id" : "5000123",
"employeeHistoryType" : "5000123",
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 7.42,
"weekHours" : 38.3,
"occupancyRate" : 0.8,
"manager" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"managerId" : "5000123",
"company" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo"
},
"companyId" : "5000123",
"directHourlyRate" : 10.42,
"standardHourlyRate" : 10,
"dailyCost" : 59.36,
"dailySellingPrice" : 80,
"entity" : "5000123",
"serviceRef" : {
"id" : "5000123",
"name" : "Professional services",
"code" : "PS"
},
"service" : "5000123",
"position" : "Developer",
"skillRef" : {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
},
"skill" : "5000123",
"family1" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family1Id" : "5000123",
"family2" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family2Id" : "5000123",
"family3" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family3Id" : "5000123",
"leave" : false,
"standardWeek" : {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
}
},
"standardWeekId" : "5000123",
"salary" : 1024
} ],
"companyChanges" : [ {
"id" : "5000123",
"employeeId" : "500123",
"companyId" : "5000123",
"startDate" : "2020-01-23T04:56:07Z",
"endDate" : "2020-01-23T04:56:07Z",
"companyChangeState" : "{}",
"comment" : "Limpso usum"
}, {
"id" : "5000123",
"employeeId" : "500123",
"companyId" : "5000123",
"startDate" : "2020-01-23T04:56:07Z",
"endDate" : "2020-01-23T04:56:07Z",
"companyChangeState" : "{}",
"comment" : "Limpso usum"
} ],
"timeRecordingRules" : {
"id" : "5000123",
"employeeId" : "5000123",
"min" : 0,
"max" : 24,
"step" : 0.01,
"prettyStep" : 0.3,
"base" : 60,
"unit" : "H",
"unitDuration" : "{}",
"allowManualEntry" : true,
"employeeWeeks" : [ {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
},
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 8,
"dailyMinutes" : 10,
"weekHours" : 40,
"leave" : false
}, {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
},
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 8,
"dailyMinutes" : 10,
"weekHours" : 40,
"leave" : false
} ],
"closingDates" : [ {
"closingDate" : "2020-01-31T23:59:59Z",
"module" : "DATE_MODULE",
"beginningOfPeriod" : "2020-01-31T23:59:59Z",
"endOfPeriod" : "2020-01-31T23:59:59Z"
}, {
"closingDate" : "2020-01-31T23:59:59Z",
"module" : "DATE_MODULE",
"beginningOfPeriod" : "2020-01-31T23:59:59Z",
"endOfPeriod" : "2020-01-31T23:59:59Z"
} ],
"simpleDuration" : 750,
"completionMode" : "WEEKLY"
},
"scheduleRules" : {
"id" : "5000123",
"employeeId" : "5000123",
"min" : 0,
"max" : 24,
"step" : 0.01,
"prettyStep" : 0.3,
"base" : 60,
"unit" : "H",
"unitDuration" : "{}",
"allowManualEntry" : true,
"employeeWeeks" : [ {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
},
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 8,
"dailyMinutes" : 10,
"weekHours" : 40,
"leave" : false
}, {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
},
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 8,
"dailyMinutes" : 10,
"weekHours" : 40,
"leave" : false
} ],
"closingDates" : [ {
"closingDate" : "2020-01-31T23:59:59Z",
"module" : "DATE_MODULE",
"beginningOfPeriod" : "2020-01-31T23:59:59Z",
"endOfPeriod" : "2020-01-31T23:59:59Z"
}, {
"closingDate" : "2020-01-31T23:59:59Z",
"module" : "DATE_MODULE",
"beginningOfPeriod" : "2020-01-31T23:59:59Z",
"endOfPeriod" : "2020-01-31T23:59:59Z"
} ],
"timestamped" : true
},
"businessCards" : [ {
"id" : "5000123",
"employeeId" : "5000123",
"cardNumber" : "XXXX XXXX XXXX 7568",
"encryptedCardNumber" : "0",
"name" : "Management card",
"type" : "{}",
"endDate" : "2020-01-31T23:59:59Z"
}, {
"id" : "5000123",
"employeeId" : "5000123",
"cardNumber" : "XXXX XXXX XXXX 7568",
"encryptedCardNumber" : "0",
"name" : "Management card",
"type" : "{}",
"endDate" : "2020-01-31T23:59:59Z"
} ],
"sector" : "Marketing",
"number" : "84",
"relations" : [ {
"id" : "5000123",
"relationType" : {
"id" : "5000123",
"code" : "TUTOR",
"name" : "Tutor for internship"
},
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"relatedEmployee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"relatedEmployeeId" : "5000123"
}, {
"id" : "5000123",
"relationType" : {
"id" : "5000123",
"code" : "TUTOR",
"name" : "Tutor for internship"
},
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"relatedEmployee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"relatedEmployeeId" : "5000123"
} ],
"employeeAbilities" : [ {
"id" : "5000123",
"skill" : {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
},
"level" : {
"id" : "5000123",
"code" : "EXP",
"name" : "Expert"
},
"startDate" : "2020-01-31T23:59:59Z",
"endDate" : "2020-01-31T23:59:59Z",
"employeeId" : "5000123"
}, {
"id" : "5000123",
"skill" : {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
},
"level" : {
"id" : "5000123",
"code" : "EXP",
"name" : "Expert"
},
"startDate" : "2020-01-31T23:59:59Z",
"endDate" : "2020-01-31T23:59:59Z",
"employeeId" : "5000123"
} ],
"jobType" : {
"id" : "5000123",
"companyCode" : "AKSAS",
"code" : "ADMIN",
"name" : "Administrator",
"category" : "{}",
"validity" : {
"type" : "{}",
"date" : "2000-06-21T04:56:07.000+00:00"
},
"default" : true
},
"jobTypeId" : "100245",
"address" : {
"id" : "id",
"line1" : "221B Baker Street",
"line2" : "2nd Floor",
"line3" : "First door at your right",
"cedex" : "CEDEX 14",
"postalCode" : "69002",
"city" : "London",
"country" : "FR (for 'FRANCE')",
"countryName" : "FRANCE",
"department" : "75 (for 'PARIS')",
"geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
"region" : "65 (for 'ILE DE FRANCE')",
"regionName" : "ILE DE FRANCE",
"phone" : "06 00 00 00 01",
"phone2" : "06 00 00 00 02",
"email" : "myemail@mail.com",
"mobilePhone" : "06 00 00 00 02",
"fax" : "04 00 00 00 07",
"webSite" : "mysite.com"
},
"addressId" : "5000123",
"birthDate" : "2000-06-21T04:56:07.000+00:00",
"customData" : {
"key" : {
"type" : "{}",
"value" : "Autoref 010520",
"name" : "Reference 4",
"realOrder" : 0,
"label" : "REFERENCE_4"
}
},
"color" : "#FF0000",
"targetTace" : 75,
"formConfig" : {
"type" : "{}",
"fields" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"controls" : {
"key" : {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}
},
"insertable" : true,
"editable" : false,
"deletable" : false,
"formSearchHidden" : false
},
"changeTracking" : {
"createdTime" : "2000-06-21T04:56:07.000+00:00",
"createdBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"createdById" : "5000123",
"modificationTime" : "2000-06-21T04:56:07.000+00:00",
"modificationBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"modificationById" : "5000123"
},
"vehicles" : [ {
"id" : "5000123",
"power" : 5,
"licensePlate" : "licensePlate",
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"expenseType" : {
"id" : "5000123",
"code" : "MEAL",
"description" : "Plane",
"km" : false,
"notRefundable" : true,
"icon" : "fa fa-plane",
"color" : "00ff40",
"receiptRequired" : false,
"commentRequired" : false,
"guestsRequired" : false,
"notRefundableEditable" : true,
"billableEditable" : true,
"amountEditable" : true,
"showQuantity" : false,
"showAdditionalComment" : false,
"showReceiptNumber" : true,
"showAmountCategory" : true,
"showBillable" : true,
"hideVat" : false,
"vat1Code" : "1",
"vat2Code" : "2",
"vat3Code" : "3",
"expenseThreshold" : 100,
"defaultAmount" : 45,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"expenseCategory" : "{}",
"expenseRebillableOptions" : "{}",
"showCustomRequest" : true,
"showAmountWithoutVat" : true,
"controlsBehavior" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"calculateKilometers" : true,
"freeEntryProhibited" : true,
"controls" : {
"enableDuplicate" : true,
"enablelOnNonWorkingDay" : true,
"enableOnDayWithLeaveRequest" : true,
"enableOnDayWithTimesheetOrSchedule" : true
},
"expenseThresholdExceededNoVat" : false
},
"expenseTypeId" : "5000123",
"endDate" : "2020-01-31T23:59:59Z"
}, {
"id" : "5000123",
"power" : 5,
"licensePlate" : "licensePlate",
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"expenseType" : {
"id" : "5000123",
"code" : "MEAL",
"description" : "Plane",
"km" : false,
"notRefundable" : true,
"icon" : "fa fa-plane",
"color" : "00ff40",
"receiptRequired" : false,
"commentRequired" : false,
"guestsRequired" : false,
"notRefundableEditable" : true,
"billableEditable" : true,
"amountEditable" : true,
"showQuantity" : false,
"showAdditionalComment" : false,
"showReceiptNumber" : true,
"showAmountCategory" : true,
"showBillable" : true,
"hideVat" : false,
"vat1Code" : "1",
"vat2Code" : "2",
"vat3Code" : "3",
"expenseThreshold" : 100,
"defaultAmount" : 45,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"expenseCategory" : "{}",
"expenseRebillableOptions" : "{}",
"showCustomRequest" : true,
"showAmountWithoutVat" : true,
"controlsBehavior" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"calculateKilometers" : true,
"freeEntryProhibited" : true,
"controls" : {
"enableDuplicate" : true,
"enablelOnNonWorkingDay" : true,
"enableOnDayWithLeaveRequest" : true,
"enableOnDayWithTimesheetOrSchedule" : true
},
"expenseThresholdExceededNoVat" : false
},
"expenseTypeId" : "5000123",
"endDate" : "2020-01-31T23:59:59Z"
} ],
"currentCompany" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo",
"legalName" : "legalName",
"siren" : "siren",
"siret" : "siret",
"calendar" : {
"id" : "5000123",
"code" : "Text",
"name" : "Text",
"default" : true,
"daysNotWorked" : [ 6, 6 ],
"holidays" : [ {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
}, {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
} ]
},
"calendarId" : "calendarId",
"color" : "color",
"currency" : {
"id" : "5000123",
"name" : "Euro",
"code" : "EUR",
"order" : 17,
"euro" : true,
"euroRate" : 0.9678,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"euroRateStartDate" : "2020-01-23T04:56:07Z",
"euroRateEndDate" : "2020-01-23T04:56:07Z"
},
"currencyId" : "currencyId",
"address" : {
"id" : "id",
"line1" : "221B Baker Street",
"line2" : "2nd Floor",
"line3" : "First door at your right",
"cedex" : "CEDEX 14",
"postalCode" : "69002",
"city" : "London",
"country" : "FR (for 'FRANCE')",
"countryName" : "FRANCE",
"department" : "75 (for 'PARIS')",
"geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
"region" : "65 (for 'ILE DE FRANCE')",
"regionName" : "ILE DE FRANCE",
"phone" : "06 00 00 00 01",
"phone2" : "06 00 00 00 02",
"email" : "myemail@mail.com",
"mobilePhone" : "06 00 00 00 02",
"fax" : "04 00 00 00 07",
"webSite" : "mysite.com"
},
"addressId" : "addressId"
},
"currentCompanyId" : "5000123",
"bankingInformation" : {
"id" : "5000123",
"sepa" : {
"bankDetails" : {
"entity" : "30002",
"counter" : "550",
"accountNumber" : "0000157841Z",
"key" : "25",
"domiciliation" : "AURA"
},
"bic" : {
"country" : "FR (for 'FRANCE')",
"bank" : "DAAE",
"location" : "PP",
"branch" : "CCT"
},
"iban" : {
"country" : "FR (for 'FRANCE')",
"key" : "69",
"accountNumber" : "0000157841Z"
}
},
"noneSepa" : {
"defaultBankDetail" : false,
"beneficiary" : {
"holder" : {
"name" : "RITA",
"firstName" : "BRITA",
"accountType" : "{}",
"accountNumber" : "123456789"
},
"bank" : {
"bankName" : "UBA",
"bankName2" : "UBA",
"bankType" : "{}",
"bankCode" : "C8",
"bankAddress" : {
"id" : "id",
"line1" : "221B Baker Street",
"line2" : "2nd Floor",
"line3" : "First door at your right",
"cedex" : "CEDEX 14",
"postalCode" : "69002",
"city" : "London",
"country" : "FR (for 'FRANCE')",
"countryName" : "FRANCE",
"department" : "75 (for 'PARIS')",
"geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
"region" : "65 (for 'ILE DE FRANCE')",
"regionName" : "ILE DE FRANCE",
"phone" : "06 00 00 00 01",
"phone2" : "06 00 00 00 02",
"email" : "myemail@mail.com",
"mobilePhone" : "06 00 00 00 02",
"fax" : "04 00 00 00 07",
"webSite" : "mysite.com"
}
}
},
"intermediate" : {
"holder" : {
"name" : "RITA",
"firstName" : "BRITA",
"accountType" : "{}",
"accountNumber" : "123456789"
},
"bank" : {
"bankName" : "UBA",
"bankName2" : "UBA",
"bankType" : "{}",
"bankCode" : "C8",
"bankAddress" : {
"id" : "id",
"line1" : "221B Baker Street",
"line2" : "2nd Floor",
"line3" : "First door at your right",
"cedex" : "CEDEX 14",
"postalCode" : "69002",
"city" : "London",
"country" : "FR (for 'FRANCE')",
"countryName" : "FRANCE",
"department" : "75 (for 'PARIS')",
"geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
"region" : "65 (for 'ILE DE FRANCE')",
"regionName" : "ILE DE FRANCE",
"phone" : "06 00 00 00 01",
"phone2" : "06 00 00 00 02",
"email" : "myemail@mail.com",
"mobilePhone" : "06 00 00 00 02",
"fax" : "04 00 00 00 07",
"webSite" : "mysite.com"
}
}
}
},
"statusChangeDate" : "2000-06-21T04:56:07.000+00:00",
"statusChangeArgument" : {
"comment" : "Comment",
"status" : "{}"
},
"validator" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"validatorId" : "5000123",
"action" : "{}",
"type" : "{}"
},
"faxNumber" : "418 643 3210",
"phoneExtensionNumber" : "04 00 00 00 07"
},
"employeeId" : "5000123",
"departureDate" : "2020-01-31T23:59:59Z",
"departureActualDate" : "2020-01-31T23:59:59Z",
"departureCity" : {
"id" : "5000123",
"name" : "City 1",
"default" : true,
"postcode" : "73000",
"country" : {
"id" : "5000123",
"name" : "Country 1",
"currency" : {
"id" : "5000123",
"name" : "Euro",
"code" : "EUR",
"order" : 17,
"euro" : true,
"euroRate" : 0.9678,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"euroRateStartDate" : "2020-01-23T04:56:07Z",
"euroRateEndDate" : "2020-01-23T04:56:07Z"
},
"currencyId" : "5000123",
"calendar" : {
"id" : "5000123",
"code" : "Text",
"name" : "Text",
"default" : true,
"daysNotWorked" : [ 6, 6 ],
"holidays" : [ {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
}, {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
} ]
},
"calendarId" : "5000123",
"code" : "FR",
"companyCode" : "AKSAS",
"companyId" : "5000123",
"isPartOfEU" : true,
"continent" : "AFRICA"
},
"countryId" : "5000123",
"department" : {
"id" : "5000123",
"code" : "01-A",
"companyCode" : "AKSAS",
"name" : "Lorem Ipsum",
"analysis" : "analysis",
"comment" : "comment",
"entity" : {
"id" : "5000123",
"code" : "01-BRDX",
"name" : "Bordeaux",
"legalName" : "Customer care",
"division" : {
"id" : "5000123",
"name" : "Rhone-Alpes",
"code" : "RA",
"group" : {
"id" : "5000123",
"name" : "West",
"code" : "WST",
"serviceId" : "5000123"
},
"groupId" : "5000123",
"companyId" : "5000123"
},
"divisionId" : "5000123",
"divisionCode" : "01-DIV",
"companyId" : "5000123",
"endDate" : "2020-01-23T04:56:07Z"
},
"entityId" : "entityId",
"projectType" : "{}",
"activities" : [ {
"id" : "5000123",
"code" : "code",
"name" : "name"
}, {
"id" : "5000123",
"code" : "code",
"name" : "name"
} ]
},
"departmentId" : "5000123",
"regionId" : "123456",
"companyCode" : "AKSAS",
"latitude" : "5.9845W",
"longitude" : "37.3891N"
},
"departureLocation" : "Lyon",
"arrivalDate" : "2020-01-31T23:59:59Z",
"arrivalActualDate" : "2020-01-31T23:59:59Z",
"arrivalCity" : {
"id" : "5000123",
"name" : "City 1",
"default" : true,
"postcode" : "73000",
"country" : {
"id" : "5000123",
"name" : "Country 1",
"currency" : {
"id" : "5000123",
"name" : "Euro",
"code" : "EUR",
"order" : 17,
"euro" : true,
"euroRate" : 0.9678,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"euroRateStartDate" : "2020-01-23T04:56:07Z",
"euroRateEndDate" : "2020-01-23T04:56:07Z"
},
"currencyId" : "5000123",
"calendar" : {
"id" : "5000123",
"code" : "Text",
"name" : "Text",
"default" : true,
"daysNotWorked" : [ 6, 6 ],
"holidays" : [ {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
}, {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
} ]
},
"calendarId" : "5000123",
"code" : "FR",
"companyCode" : "AKSAS",
"companyId" : "5000123",
"isPartOfEU" : true,
"continent" : "AFRICA"
},
"countryId" : "5000123",
"department" : {
"id" : "5000123",
"code" : "01-A",
"companyCode" : "AKSAS",
"name" : "Lorem Ipsum",
"analysis" : "analysis",
"comment" : "comment",
"entity" : {
"id" : "5000123",
"code" : "01-BRDX",
"name" : "Bordeaux",
"legalName" : "Customer care",
"division" : {
"id" : "5000123",
"name" : "Rhone-Alpes",
"code" : "RA",
"group" : {
"id" : "5000123",
"name" : "West",
"code" : "WST",
"serviceId" : "5000123"
},
"groupId" : "5000123",
"companyId" : "5000123"
},
"divisionId" : "5000123",
"divisionCode" : "01-DIV",
"companyId" : "5000123",
"endDate" : "2020-01-23T04:56:07Z"
},
"entityId" : "entityId",
"projectType" : "{}",
"activities" : [ {
"id" : "5000123",
"code" : "code",
"name" : "name"
}, {
"id" : "5000123",
"code" : "code",
"name" : "name"
} ]
},
"departmentId" : "5000123",
"regionId" : "123456",
"companyCode" : "AKSAS",
"latitude" : "5.9845W",
"longitude" : "37.3891N"
},
"arrivalLocation" : "Oslo",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"documents" : [ {
"id" : "5000123",
"title" : "Title",
"versionId" : "5000123",
"changeTracking" : {
"createdTime" : "2000-06-21T04:56:07.000+00:00",
"createdBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"createdById" : "5000123",
"modificationTime" : "2000-06-21T04:56:07.000+00:00",
"modificationBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"modificationById" : "5000123"
},
"publishedBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"publishedById" : "5001206",
"classification" : "STD",
"subClassification" : "EDITIONS",
"category1" : "CAT1",
"category2" : "CAT2",
"category3" : "CAT3",
"companyId" : "5000123",
"publicationDate" : "2000-06-21T04:56:07.000+00:00",
"version" : 1,
"documentType" : "File",
"fileUrl" : "myFiles/thisFile.pdf",
"fileName" : "thisFile.pdf",
"lienUrl" : "myStorage.com/myFiles/thisFile.pdf",
"url" : "myFiles/thisFile.pdf",
"original" : false,
"preview" : "data:image",
"tokenPreview" : "8946A85V85D851DF",
"externalDMSUuid" : "OD1245126",
"links" : [ {
"id" : "5000123",
"original" : true,
"documentId" : "5000123",
"objectId" : "5000123",
"objectType" : "{}"
}, {
"id" : "5000123",
"original" : true,
"documentId" : "5000123",
"objectId" : "5000123",
"objectType" : "{}"
} ],
"archived" : false,
"action" : "{}",
"owner" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"ownerId" : "5001206",
"description" : "Text",
"category" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"categoryId" : "100024",
"subCategory" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"company" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo",
"legalName" : "legalName",
"siren" : "siren",
"siret" : "siret",
"calendar" : {
"id" : "5000123",
"code" : "Text",
"name" : "Text",
"default" : true,
"daysNotWorked" : [ 6, 6 ],
"holidays" : [ {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
}, {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
} ]
},
"calendarId" : "calendarId",
"color" : "color",
"currency" : {
"id" : "5000123",
"name" : "Euro",
"code" : "EUR",
"order" : 17,
"euro" : true,
"euroRate" : 0.9678,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"euroRateStartDate" : "2020-01-23T04:56:07Z",
"euroRateEndDate" : "2020-01-23T04:56:07Z"
},
"currencyId" : "currencyId",
"address" : {
"id" : "id",
"line1" : "221B Baker Street",
"line2" : "2nd Floor",
"line3" : "First door at your right",
"cedex" : "CEDEX 14",
"postalCode" : "69002",
"city" : "London",
"country" : "FR (for 'FRANCE')",
"countryName" : "FRANCE",
"department" : "75 (for 'PARIS')",
"geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
"region" : "65 (for 'ILE DE FRANCE')",
"regionName" : "ILE DE FRANCE",
"phone" : "06 00 00 00 01",
"phone2" : "06 00 00 00 02",
"email" : "myemail@mail.com",
"mobilePhone" : "06 00 00 00 02",
"fax" : "04 00 00 00 07",
"webSite" : "mysite.com"
},
"addressId" : "addressId"
},
"companyId" : "5000123",
"type" : "{}",
"category" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"categoryId" : "500143",
"grouping" : "grouping",
"ranking" : 2
},
"subCategoryId" : "11037",
"locked" : false
}, {
"id" : "5000123",
"title" : "Title",
"versionId" : "5000123",
"changeTracking" : {
"createdTime" : "2000-06-21T04:56:07.000+00:00",
"createdBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"createdById" : "5000123",
"modificationTime" : "2000-06-21T04:56:07.000+00:00",
"modificationBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"modificationById" : "5000123"
},
"publishedBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"publishedById" : "5001206",
"classification" : "STD",
"subClassification" : "EDITIONS",
"category1" : "CAT1",
"category2" : "CAT2",
"category3" : "CAT3",
"companyId" : "5000123",
"publicationDate" : "2000-06-21T04:56:07.000+00:00",
"version" : 1,
"documentType" : "File",
"fileUrl" : "myFiles/thisFile.pdf",
"fileName" : "thisFile.pdf",
"lienUrl" : "myStorage.com/myFiles/thisFile.pdf",
"url" : "myFiles/thisFile.pdf",
"original" : false,
"preview" : "data:image",
"tokenPreview" : "8946A85V85D851DF",
"externalDMSUuid" : "OD1245126",
"links" : [ {
"id" : "5000123",
"original" : true,
"documentId" : "5000123",
"objectId" : "5000123",
"objectType" : "{}"
}, {
"id" : "5000123",
"original" : true,
"documentId" : "5000123",
"objectId" : "5000123",
"objectType" : "{}"
} ],
"archived" : false,
"action" : "{}",
"owner" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"ownerId" : "5001206",
"description" : "Text",
"category" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"categoryId" : "100024",
"subCategory" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"company" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo",
"legalName" : "legalName",
"siren" : "siren",
"siret" : "siret",
"calendar" : {
"id" : "5000123",
"code" : "Text",
"name" : "Text",
"default" : true,
"daysNotWorked" : [ 6, 6 ],
"holidays" : [ {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
}, {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
} ]
},
"calendarId" : "calendarId",
"color" : "color",
"currency" : {
"id" : "5000123",
"name" : "Euro",
"code" : "EUR",
"order" : 17,
"euro" : true,
"euroRate" : 0.9678,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"euroRateStartDate" : "2020-01-23T04:56:07Z",
"euroRateEndDate" : "2020-01-23T04:56:07Z"
},
"currencyId" : "currencyId",
"address" : {
"id" : "id",
"line1" : "221B Baker Street",
"line2" : "2nd Floor",
"line3" : "First door at your right",
"cedex" : "CEDEX 14",
"postalCode" : "69002",
"city" : "London",
"country" : "FR (for 'FRANCE')",
"countryName" : "FRANCE",
"department" : "75 (for 'PARIS')",
"geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
"region" : "65 (for 'ILE DE FRANCE')",
"regionName" : "ILE DE FRANCE",
"phone" : "06 00 00 00 01",
"phone2" : "06 00 00 00 02",
"email" : "myemail@mail.com",
"mobilePhone" : "06 00 00 00 02",
"fax" : "04 00 00 00 07",
"webSite" : "mysite.com"
},
"addressId" : "addressId"
},
"companyId" : "5000123",
"type" : "{}",
"category" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"categoryId" : "500143",
"grouping" : "grouping",
"ranking" : 2
},
"subCategoryId" : "11037",
"locked" : false
} ],
"numberOfDocuments" : 2,
"formConfig" : {
"type" : "{}",
"fields" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"controls" : {
"key" : {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}
},
"insertable" : true,
"editable" : false,
"deletable" : false,
"formSearchHidden" : false
},
"cancellationDate" : "2020-01-31T23:59:59Z",
"cancellationUser" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"cancellationUserId" : "5000123",
"archiveDate" : "2020-01-31T23:59:59Z",
"archiveUser" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"archiveUserId" : "5000123",
"comment" : "Lorem ipsum",
"multiProjects" : true
},
"customRequestId" : "5000123",
"threshold" : 80,
"vat3" : {
"id" : "5000123",
"code" : "7",
"rate" : 1.4658129805029452
},
"vatAmount3" : 110,
"vatAmount3Currency" : 126.57,
"exchangeRate" : {
"id" : "5000123",
"currency" : {
"id" : "5000123",
"name" : "Euro",
"code" : "EUR",
"order" : 17,
"euro" : true,
"euroRate" : 0.9678,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"euroRateStartDate" : "2020-01-23T04:56:07Z",
"euroRateEndDate" : "2020-01-23T04:56:07Z"
},
"currencyId" : "12006",
"rate" : 0.9156852,
"startDate" : "2000-06-21T04:56:07.000+00:00",
"endDate" : "2000-06-21T04:56:07.000+00:00"
},
"amountWithoutVat" : 1.8,
"vehicle" : {
"id" : "5000123",
"power" : 5,
"licensePlate" : "licensePlate",
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"expenseType" : {
"id" : "5000123",
"code" : "MEAL",
"description" : "Plane",
"km" : false,
"notRefundable" : true,
"icon" : "fa fa-plane",
"color" : "00ff40",
"receiptRequired" : false,
"commentRequired" : false,
"guestsRequired" : false,
"notRefundableEditable" : true,
"billableEditable" : true,
"amountEditable" : true,
"showQuantity" : false,
"showAdditionalComment" : false,
"showReceiptNumber" : true,
"showAmountCategory" : true,
"showBillable" : true,
"hideVat" : false,
"vat1Code" : "1",
"vat2Code" : "2",
"vat3Code" : "3",
"expenseThreshold" : 100,
"defaultAmount" : 45,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"expenseCategory" : "{}",
"expenseRebillableOptions" : "{}",
"showCustomRequest" : true,
"showAmountWithoutVat" : true,
"controlsBehavior" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"calculateKilometers" : true,
"freeEntryProhibited" : true,
"controls" : {
"enableDuplicate" : true,
"enablelOnNonWorkingDay" : true,
"enableOnDayWithLeaveRequest" : true,
"enableOnDayWithTimesheetOrSchedule" : true
},
"expenseThresholdExceededNoVat" : false
},
"expenseTypeId" : "5000123",
"endDate" : "2020-01-31T23:59:59Z"
},
"kmTotal" : 50,
"amountCalculated" : 35,
"amountRefunded" : 700,
"amountDue" : 35,
"retrievedExpense" : false,
"departureLocation" : "27 Rue Auguste Comte, 69002 Lyon, France",
"arrivalLocation" : "27 Rue Auguste Comte, 69002 Lyon, France",
"controls" : {
"duplicateForSameEmployee" : true,
"duplicateForSeveralEmployees" : true,
"onNonWorkingDay" : true,
"onLeaveDay" : true
}
}
2.9.10. Search for refused expenses of an employee by employee's ID
GET |
/employees/{employee_id}/expenses/refused |
Description
Get the list of refused expenses of an employee matching the specified employee ID.
DMF required:
-
DMF A40206: Api Workforce / Expenses / Info
-
DMF 041506: Purchases / Expense Reports / Show History
-
DMF 190501: Web Portal / Expense Reports / Show
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
employee_id |
Id of an employee |
X |
null |
Return Type
array[Expense]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Refused expenses of the employee successfully loaded |
List[Expense] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.9.11. Refuse an expense
POST |
/expense-reports/{expense_report_id}/expenses/{expense_id}/refuse |
Description
Refuse an expense matching specified expense report ID and expense ID.
DMF required:
-
DMF A40210: Api Workforce / Expenses / Refuse
-
DMF 041524: Purchases / Expense Reports / Reject
-
DMF 041534: Purchases / Expense Reports / Deny Expense In Expense Report
-
DMF 041535: Purchases / Expense Reports / Deny Expense In Non-completed Expense Report
-
DMF 041536: Purchases / Expense Reports / Deny Expense In Validated Expense Report
-
DMF 041537: Purchases / Expense Reports / Deny Expense In My Expense Report
-
DMF 190901: Web Portal / Approvals
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
expense_report_id |
Id of an expense report |
X |
null |
|
expense_id |
Id of an expense |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
comment |
Refusal comment [string] |
- |
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Expense successfully refused |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
comment_example
2.9.12. Search for expense types (with search criteria)
POST |
/employees/expense-types/search |
Description
Get the list of expense types matching the search criteria.
DMF required:
-
DMF A40206: Api Workforce / Expenses / Info
-
DMF 041506: Purchases / Expense Reports / Show History
-
DMF 190501: Web Portal / Expense Reports / Show
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
criteria |
Criteria that you choose (Employee id, company code, etc…) ExpenseTypeCriteria |
X |
Return Type
array[ExpenseType]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Expense types successfully loaded |
List[ExpenseType] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"companyCode" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"code" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"onDayWithLeaveRequestControl" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"description" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"duplicateControl" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"employeeId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"id" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"tag" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"validity" : {
"type" : "{}",
"date" : "2000-06-21T04:56:07.000+00:00"
},
"onDayWithTimesheetOrScheduleControl" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"onNonWorkingDayControl" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"readOption" : {
"options" : [ "CONTROLS_BEHAVIOR", "CONTROLS_BEHAVIOR" ]
}
}
2.9.13. Search for the expense types of an employee (with search criteria)
POST |
/employees/{employee_id}/expense-types/search |
Description
Get the list of expense types matching the search criteria and the specified employee ID.
DMF required:
-
DMF A40206: Api Workforce / Expenses / Info
-
DMF 041506: Purchases / Expense Reports / Show History
-
DMF 190501: Web Portal / Expense Reports / Show
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
employee_id |
Id of an employee |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
criteria |
Criteria that you choose (Employee id, code, etc…) ExpenseTypeCriteria |
X |
Return Type
array[ExpenseType]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Expense types successfully loaded |
List[ExpenseType] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"companyCode" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"code" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"onDayWithLeaveRequestControl" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"description" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"duplicateControl" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"employeeId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"id" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"tag" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"validity" : {
"type" : "{}",
"date" : "2000-06-21T04:56:07.000+00:00"
},
"onDayWithTimesheetOrScheduleControl" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"onNonWorkingDayControl" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"readOption" : {
"options" : [ "CONTROLS_BEHAVIOR", "CONTROLS_BEHAVIOR" ]
}
}
2.10. Leaves
2.10.1. Add an adjustment of leave rights
PUT |
/employees/{employee_id}/leave-rights/{leave_right_id}/adjustments |
Description
Add an adjustment of leave right.
DMF required:
-
DMF A40806: Api Workforce / Leave-rights / Info
-
DMF 160807: Tools / Resources / Manage Acquired Rights
-
DMF 160876: Tools / Resources / Right Adjustment
-
DMF 190103: Web Portal / Timesheets & Schedules Menu / Leave Requests
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
employee_id |
Id of an employee |
X |
null |
|
leave_right_id |
The id of the leave right |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
adjustment |
The adjustment to be added LeaveAdjustment |
X |
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Leave adjustment accumulated |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"id" : "5000123",
"reason" : "Parental leave",
"value" : -2.08,
"date" : "2020-01-31T23:59:59Z",
"user" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"userId" : "5000123"
}
2.10.2. Send mail to cancel validation
POST |
/leaves/{leave_id}/ask-for-cancellation |
Description
Send mail to cancel validation
DMF required:
-
DMF A40302: Api Workforce / Leaves / Update
-
DMF 160202: Tools / Leave Requests Management / Modify
-
DMF 160213: Tools / Leave Requests Management / Modify Validated Request
-
DMF 190103: Web Portal / Timesheets & Schedules Menu / Leave Requests
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
leave_id |
The id of the leave |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
message |
The message to send [string] |
- |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Cancellation successfully asked |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
message_example
2.10.3. Cancel a leave request
POST |
/leaves/{leave_id}/cancel |
Description
Cancel a leave request
DMF required:
-
DMF A40310: Api Workforce / Leaves / Cancel
-
DMF 160210: Tools / Leave Requests Management / Cancel
-
DMF 190103: Web Portal / Timesheets & Schedules Menu / Leave Requests
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
leave_id |
The id of the leave |
X |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Successful cancellation |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.10.4. Cancel validation of leave
POST |
/leaves/{leave_id}/cancel-validation |
Description
Cancel validation of leave
DMF required:
-
DMF A40313: Api Workforce / Leaves / Cancel Validation
-
DMF 160211: Tools / Leave Requests Management / Reactivate
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
leave_id |
The id of the leave |
X |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Successful validation canceled |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.10.5. Create a leave
PUT |
/leaves |
Description
Create a leave using the list of parameters below.
DMF required:
-
DMF A40301: Api Workforce / Leaves / Insert
-
DMF 160201: Tools / Leave Requests Management / New
-
DMF 190103: Web Portal / Timesheets & Schedules Menu / Leave Requests
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
leave |
The leave to create Leave |
X |
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Leaves successfully created |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"id" : "5000123",
"guid" : "5000123",
"leaveRight" : {
"id" : "5000123",
"name" : "Public holiday",
"startDate" : "2020-01-31T23:59:59Z",
"endDate" : "2020-01-31T23:59:59Z",
"right" : 25,
"tolerance" : 2,
"employeeId" : "5000123",
"leaveType" : {
"id" : "5000123",
"code" : "RTT",
"name" : "Absence maladie",
"endDate" : "2020-01-31T23:59:59Z",
"company" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo"
},
"companyId" : "5000123",
"entity" : {
"id" : "5000123",
"code" : "01-BRDX",
"name" : "Bordeaux"
},
"entityId" : "5000123",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"subPhase" : {
"id" : "5000123",
"code" : "SB_1",
"name" : "Sub Phase 1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"order" : 1
},
"subPhaseId" : "5000123",
"actionCode" : {
"id" : "5000123",
"name" : "ADD"
},
"actionCodeId" : "5000123",
"receiver" : true,
"transmitter" : false,
"thresholdTolerance" : 1,
"restricted" : false,
"unit" : "{}",
"type" : "{}",
"entry" : "{}",
"counterValue" : 15,
"increment" : 3,
"order" : 2,
"countDownPartTime" : false,
"freeAnalyticCode" : "102",
"acquiredCounterDecimals" : 2
},
"leaveTypeId" : "5000123",
"comment" : "Lorem Ipsum",
"acquisitionStartDate" : "2020-01-31T23:59:59Z",
"acquisitionEndDate" : "2020-01-31T23:59:59Z",
"adjustment" : 1,
"estimatedMaxRight" : 25,
"acquiredRight" : 25,
"leavesAccepted" : 20,
"leavesRequested" : 2.5,
"remainingDays" : 17
},
"leaveRightId" : "5000123",
"requestDate" : "2020-01-31T23:59:59Z",
"startDate" : "2020-01-31T23:59:59Z",
"endDate" : "2020-01-31T23:59:59Z",
"duration" : 2,
"comment" : "Lorem ipsum",
"leaveState" : "{}",
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"modificationTime" : "2000-06-21T04:56:07.000+00:00",
"changeTracking" : {
"createdTime" : "2000-06-21T04:56:07.000+00:00",
"createdBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"createdById" : "5000123",
"modificationTime" : "2000-06-21T04:56:07.000+00:00",
"modificationBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"modificationById" : "5000123"
},
"startAfterNoon" : false,
"commentValidator" : "Lorem ipsum by manager",
"dateValidator" : "2020-01-31T23:59:59Z",
"employeeValidator" : "MARTIN",
"leaveType" : "RTT",
"formConfig" : {
"type" : "{}",
"fields" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"controls" : {
"key" : {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}
},
"insertable" : true,
"editable" : false,
"deletable" : false,
"formSearchHidden" : false
}
}
2.10.6. Create a leaveType
PUT |
/leave-types |
Description
Create a leaveType
DMF required:
-
DMF A41001: Api Workforce / Leave Type / Insert
-
DMF 0901__: Administrator / Setup
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
leaveType |
The LeaveType to create LeaveType |
X |
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
LeaveType successfully created |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"id" : "5000123",
"code" : "RTT",
"name" : "Absence maladie",
"endDate" : "2020-01-31T23:59:59Z",
"company" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo"
},
"companyId" : "5000123",
"entity" : {
"id" : "5000123",
"code" : "01-BRDX",
"name" : "Bordeaux"
},
"entityId" : "5000123",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"subPhase" : {
"id" : "5000123",
"code" : "SB_1",
"name" : "Sub Phase 1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"order" : 1
},
"subPhaseId" : "5000123",
"actionCode" : {
"id" : "5000123",
"name" : "ADD"
},
"actionCodeId" : "5000123",
"receiver" : true,
"transmitter" : false,
"thresholdTolerance" : 1,
"restricted" : false,
"unit" : "{}",
"type" : "{}",
"entry" : "{}",
"counterValue" : 15,
"increment" : 3,
"order" : 2,
"countDownPartTime" : false,
"freeAnalyticCode" : "102",
"acquiredCounterDecimals" : 2
}
2.10.7. Delete a leave
DELETE |
/leaves/{leave_id} |
Description
Delete a leave
DMF required:
-
DMF A40303: Api Workforce / Leaves / Delete
-
DMF 160203: Tools / Leave Requests Management / Delete
-
DMF 190103: Web Portal / Timesheets & Schedules Menu / Leave Requests
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
leave_id |
The id of the leave |
X |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Successfully deleted |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.10.8. Delete a leave right for an existing leave right and a given period
DELETE |
/employees/{employee_id}/leave-rights/{leave_right_id} |
Description
Delete the leave right of an employee given as a parameter and\
\ matching specified IDs (employee and leave right).
DMF required:
-
DMF A40803: Api Workforce / Leave-rights / Delete
-
DMF 160807: Tools / Resources / Manage Acquired Rights
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
employee_id |
Id of an employee |
X |
null |
|
leave_right_id |
The id of the leave right |
X |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Leave right successfully deleted |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.10.9. Delete a LeaveType
DELETE |
/leave-types/{leave_type_id} |
Description
Delete a LeaveType
DMF required:
-
DMF A41003: Api Workforce / Leave Type / Delete
-
DMF 0901__: Administrator / Setup
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
leave_type_id |
The id of the leave type |
X |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
LeaveType successfully deleted |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.10.10. Estimate the leave rights at a specific date
POST |
/employees/{employee_id}/leave-rights/{leave_right_id}/estimate |
Description
Estimate the leave rights at a specific date.
DMF required:
-
DMF A40806: Api Workforce / Leave-rights / Info
-
DMF 160807: Tools / Resources / Manage Acquired Rights
-
DMF 160876: Tools / Resources / Right Adjustment
-
DMF 190103: Web Portal / Timesheets & Schedules Menu / Leave Requests
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
employee_id |
Id of an employee |
X |
null |
|
leave_right_id |
The id of the leave right |
X |
null |
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
date |
The date in query /leave-rights/{leave_right_id}/estimate?date=2020-10-29T08%3A10%3A10%2B200 |
- |
null |
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
The value of the remaining right at the specified date |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.10.11. Estimate the leave rights at the end of the acquisition period
POST |
/employees/{employee_id}/leave-rights/{leave_right_id}/estimate-end-rights |
Description
Estimate the leave rights at the end of the acquisition period.
DMF required:
-
DMF A40806: Api Workforce / Leave-rights / Info
-
DMF 160807: Tools / Resources / Manage Acquired Rights
-
DMF 160876: Tools / Resources / Right Adjustment
-
DMF 190103: Web Portal / Timesheets & Schedules Menu / Leave Requests
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
employee_id |
Id of an employee |
X |
null |
|
leave_right_id |
The id of the leave right |
X |
null |
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
The value of the whole right at the end of the acquisition period |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.10.12. Estimate my leave rights at a specific date
POST |
/leave-rights/mine/{leave_right_id}/estimate |
Description
Estimate my leave rights at a specific date
DMF required:
-
DMF A40807: Api Workforce / Leave-rights / Mine
-
DMF 160205: Tools / Leave Requests Management / Show History
-
DMF 190103: Web Portal / Timesheets & Schedules Menu / Leave Requests
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
leave_right_id |
The id of the leave right |
X |
null |
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
date |
The date in query |
- |
null |
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
The value of the remaining right at the specified date |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.10.13. Fill in duration properties in the leave
POST |
/leave-rights/{leave_right_id}/fill-duration |
Description
Fill in duration properties in the leave (end of leave OR duration) according to the leave right and other properties (start of leave / end of leave OR duration) and returns the completed leave without saving it.
DMF required:
-
DMF A40806: Api Workforce / Leave-rights / Info
-
DMF 160807: Tools / Resources / Manage Acquired Rights
-
DMF 160876: Tools / Resources / Right Adjustment
-
DMF 190103: Web Portal / Timesheets & Schedules Menu / Leave Requests
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
leave_right_id |
The id of the leave right |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
properties |
The duration properties to be filled in LeaveDuration |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Leave's duration filled in |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"duration" : 20.5,
"estimatedRightAtStart" : 12,
"startAfterNoon" : true,
"start" : "2020-01-31T23:59:59Z",
"end" : "2020-01-31T23:59:59Z"
}
2.10.14. Get all adjustment of leave rights
GET |
/employees/{employee_id}/leave-rights/{leave_right_id}/adjustments |
Description
Get all adjustment of a leave right.
DMF required:
-
DMF A40806: Api Workforce / Leave-rights / Info
-
DMF 160807: Tools / Resources / Manage Acquired Rights
-
DMF 160876: Tools / Resources / Right Adjustment
-
DMF 190103: Web Portal / Timesheets & Schedules Menu / Leave Requests
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
employee_id |
Id of an employee |
X |
null |
|
leave_right_id |
The id of the leave right |
X |
null |
Return Type
array[LeaveAdjustment]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
All adjustment of leave right successfully loaded |
List[LeaveAdjustment] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.10.15. Search a leave by its ID
GET |
/leaves/{leave_id} |
Description
Get the leave matching the specified ID.
DMF required:
-
DMF A40306: Api Workforce / Leaves / Info
-
DMF 160205: Tools / Leave Requests Management / Show History
-
DMF 190103: Web Portal / Timesheets & Schedules Menu / Leave Requests
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
leave_id |
The id of the leave |
X |
null |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Leave successfully loaded |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.10.16. Get a Leave Right
GET |
/employees/{employee_id}/leave-rights/{leave_right_id} |
Description
Get a Leave Right
DMF required:
-
DMF A40806: Api Workforce / Leave-rights / Info
-
DMF 160807: Tools / Resources / Manage Acquired Rights
-
DMF 160876: Tools / Resources / Right Adjustment
-
DMF 190103: Web Portal / Timesheets & Schedules Menu / Leave Requests
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
employee_id |
Id of an employee |
X |
null |
|
leave_right_id |
The id of the leave right |
X |
null |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
A LeaveRight having this id |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.10.17. Search leave rights for an employee
GET |
/employees/{employee_id}/leave-rights |
Description
Get the list of leave rights of the employee matching the specified employee’s ID.
DMF required:
-
DMF A40806: Api Workforce / Leave-rights / Info
-
DMF 160807: Tools / Resources / Manage Acquired Rights
-
DMF 160876: Tools / Resources / Right Adjustment
-
DMF 190103: Web Portal / Timesheets & Schedules Menu / Leave Requests
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
employee_id |
Id of an employee |
X |
null |
Return Type
array[LeaveRight]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Leave rights of the employee successfully loaded |
List[LeaveRight] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.10.18. Get a LeaveType
GET |
/leave-types/{leave_type_id} |
Description
Get a LeaveType
DMF required:
-
DMF A41006: Api Workforce / Leave Type / Info
-
DMF 0901__: Administrator / Setup
-
DMF 160807: Tools / Resources / Manage Acquired Rights
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
leave_type_id |
The id of the leave type |
X |
null |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
LeaveType successfully loaded |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.10.19. Search my leave rights
GET |
/leave-rights/mine |
Description
Get the list of my leave rights.
DMF required:
-
DMF A40807: Api Workforce / Leave-rights / Mine
-
DMF 160205: Tools / Leave Requests Management / Show History
-
DMF 190103: Web Portal / Timesheets & Schedules Menu / Leave Requests
Return Type
array[LeaveRight]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Leave rights successfully loaded |
List[LeaveRight] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.10.20. Retrieve my leaves
GET |
/leaves/mine |
Description
Retrieve my leaves
DMF required:
-
DMF A40307: Api Workforce / Leaves / Mine
-
DMF 160205: Tools / Leave Requests Management / Show History
-
DMF 190103: Web Portal / Timesheets & Schedules Menu / Leave Requests
Return Type
array[Leave]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
My Leaves |
List[Leave] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.10.21. Create leave right for an employee
PUT |
/employees/{employee_id}/leave-rights |
Description
Create leave right using the list of parameters below for the employee matching the specified ID.
DMF required:
-
DMF A40801: Api Workforce / Leave-rights / Insert
-
DMF 160807: Tools / Resources / Manage Acquired Rights
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
employee_id |
Id of an employee |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
leaveRight |
The leave right to create LeaveRight |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Leave right successfully created |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"id" : "5000123",
"name" : "Public holiday",
"startDate" : "2020-01-31T23:59:59Z",
"endDate" : "2020-01-31T23:59:59Z",
"right" : 25,
"tolerance" : 2,
"employeeId" : "5000123",
"leaveType" : {
"id" : "5000123",
"code" : "RTT",
"name" : "Absence maladie",
"endDate" : "2020-01-31T23:59:59Z",
"company" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo"
},
"companyId" : "5000123",
"entity" : {
"id" : "5000123",
"code" : "01-BRDX",
"name" : "Bordeaux"
},
"entityId" : "5000123",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"subPhase" : {
"id" : "5000123",
"code" : "SB_1",
"name" : "Sub Phase 1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"order" : 1
},
"subPhaseId" : "5000123",
"actionCode" : {
"id" : "5000123",
"name" : "ADD"
},
"actionCodeId" : "5000123",
"receiver" : true,
"transmitter" : false,
"thresholdTolerance" : 1,
"restricted" : false,
"unit" : "{}",
"type" : "{}",
"entry" : "{}",
"counterValue" : 15,
"increment" : 3,
"order" : 2,
"countDownPartTime" : false,
"freeAnalyticCode" : "102",
"acquiredCounterDecimals" : 2
},
"leaveTypeId" : "5000123",
"comment" : "Lorem Ipsum",
"acquisitionStartDate" : "2020-01-31T23:59:59Z",
"acquisitionEndDate" : "2020-01-31T23:59:59Z",
"adjustment" : 1,
"estimatedMaxRight" : 25,
"acquiredRight" : 25,
"leavesAccepted" : 20,
"leavesRequested" : 2.5,
"remainingDays" : 17
}
2.10.22. Pre-fill a leave request
POST |
/leaves/pre-fill |
Description
Pre-fill a previously created leave request.
DMF required:
-
DMF A40301: Api Workforce / Leaves / Insert
-
DMF 160201: Tools / Leave Requests Management / New
-
DMF 190103: Web Portal / Timesheets & Schedules Menu / Leave Requests
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
Leave |
The leave request to be prefilled Leave |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Leave request successfully pre-filled |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"id" : "5000123",
"guid" : "5000123",
"leaveRight" : {
"id" : "5000123",
"name" : "Public holiday",
"startDate" : "2020-01-31T23:59:59Z",
"endDate" : "2020-01-31T23:59:59Z",
"right" : 25,
"tolerance" : 2,
"employeeId" : "5000123",
"leaveType" : {
"id" : "5000123",
"code" : "RTT",
"name" : "Absence maladie",
"endDate" : "2020-01-31T23:59:59Z",
"company" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo"
},
"companyId" : "5000123",
"entity" : {
"id" : "5000123",
"code" : "01-BRDX",
"name" : "Bordeaux"
},
"entityId" : "5000123",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"subPhase" : {
"id" : "5000123",
"code" : "SB_1",
"name" : "Sub Phase 1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"order" : 1
},
"subPhaseId" : "5000123",
"actionCode" : {
"id" : "5000123",
"name" : "ADD"
},
"actionCodeId" : "5000123",
"receiver" : true,
"transmitter" : false,
"thresholdTolerance" : 1,
"restricted" : false,
"unit" : "{}",
"type" : "{}",
"entry" : "{}",
"counterValue" : 15,
"increment" : 3,
"order" : 2,
"countDownPartTime" : false,
"freeAnalyticCode" : "102",
"acquiredCounterDecimals" : 2
},
"leaveTypeId" : "5000123",
"comment" : "Lorem Ipsum",
"acquisitionStartDate" : "2020-01-31T23:59:59Z",
"acquisitionEndDate" : "2020-01-31T23:59:59Z",
"adjustment" : 1,
"estimatedMaxRight" : 25,
"acquiredRight" : 25,
"leavesAccepted" : 20,
"leavesRequested" : 2.5,
"remainingDays" : 17
},
"leaveRightId" : "5000123",
"requestDate" : "2020-01-31T23:59:59Z",
"startDate" : "2020-01-31T23:59:59Z",
"endDate" : "2020-01-31T23:59:59Z",
"duration" : 2,
"comment" : "Lorem ipsum",
"leaveState" : "{}",
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"modificationTime" : "2000-06-21T04:56:07.000+00:00",
"changeTracking" : {
"createdTime" : "2000-06-21T04:56:07.000+00:00",
"createdBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"createdById" : "5000123",
"modificationTime" : "2000-06-21T04:56:07.000+00:00",
"modificationBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"modificationById" : "5000123"
},
"startAfterNoon" : false,
"commentValidator" : "Lorem ipsum by manager",
"dateValidator" : "2020-01-31T23:59:59Z",
"employeeValidator" : "MARTIN",
"leaveType" : "RTT",
"formConfig" : {
"type" : "{}",
"fields" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"controls" : {
"key" : {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}
},
"insertable" : true,
"editable" : false,
"deletable" : false,
"formSearchHidden" : false
}
}
2.10.23. Reactivate a cancelled leave request
POST |
/leaves/{leave_id}/reactivate |
Description
Reactivate a cancelled leave request
DMF required:
-
DMF A40310: Api Workforce / Leaves / Cancel
-
DMF 160210: Tools / Leave Requests Management / Cancel
-
DMF 190103: Web Portal / Timesheets & Schedules Menu / Leave Requests
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
leave_id |
The id of the leave |
X |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Successful reactivation |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.10.24. Read a Leave
POST |
/leaves/{leave_id}/read |
Description
Read a Leave
DMF required:
-
DMF A40306: Api Workforce / Leaves / Info
-
DMF 160205: Tools / Leave Requests Management / Show History
-
DMF 190103: Web Portal / Timesheets & Schedules Menu / Leave Requests
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
leave_id |
The id of the leave |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
read_options |
The read options for returned leave LeaveReadOption |
- |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Leave successfully read |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"options" : [ "LEAVE_RIGHT", "LEAVE_RIGHT" ]
}
2.10.25. Read a LeaveType
POST |
/leave-types/{leave_type_id}/read |
Description
Read a LeaveType
DMF required:
-
DMF A41006: Api Workforce / Leave Type / Info
-
DMF 0901__: Administrator / Setup
-
DMF 160807: Tools / Resources / Manage Acquired Rights
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
leave_type_id |
The id of the leave type |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
read_options |
The read options for returned employee LeaveTypeReadOption |
- |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
LeaveType successfully read |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"options" : [ "COMPANY", "COMPANY" ]
}
2.10.26. Refuse a leave
POST |
/leaves/{leave_id}/refuse |
Description
Refuse a leave
DMF required:
-
DMF A40312: Api Workforce / Leaves / Refuse
-
DMF 160209: Tools / Leave Requests Management / Reject
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
leave_id |
The id of the leave |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
reason |
The reason for refusal [string] |
- |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Successful deny |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
reason_example
2.10.27. Search for search field behavior for the Leaves
GET |
/leaves/search-fields-information |
Deprecated
|
Tip
|
This API will soon be removed as it is no longer functional. No data will be returned when using it. |
Description
Get the list of search field behavior for Leaves
DMF required:
-
DMF A40304: Api Workforce / Leaves / Search
-
DMF 160204: Tools / Leave Requests Management / Search
-
DMF 190103: Web Portal / Timesheets & Schedules Menu / Leave Requests
Parameters
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
manager_mode |
If true then get settings for the manager screen |
- |
null |
Return Type
array[SearchControlBehavior]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Search field behavior results |
List[SearchControlBehavior] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.10.28. Get the list of leaveTypes
POST |
/leave-types/search |
Description
Search leaveTypes
DMF required:
-
DMF A41004: Api Workforce / Leave Type / Search
-
DMF 0901__: Administrator / Setup
-
DMF 160807: Tools / Resources / Manage Acquired Rights
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
criteria |
The criteria LeaveTypeCriteria |
X |
Return Type
array[LeaveType]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
LeaveTypes successfully loaded |
List[LeaveType] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"code" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"receiver" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"phaseId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"increment" : {
"operator" : "IS",
"value" : 12.6,
"includeNullResults" : false
},
"entityId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"type" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"readOption" : {
"options" : [ "COMPANY", "COMPANY" ]
},
"entry" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"counterValue" : {
"operator" : "IS",
"value" : 12.6,
"includeNullResults" : false
},
"companyId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"unit" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"thresholdTolerance" : {
"operator" : "IS",
"value" : 12.6,
"includeNullResults" : false
},
"restricted" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"name" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"subPhaseId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"actionId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"id" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"validity" : {
"type" : "{}",
"date" : "2000-06-21T04:56:07.000+00:00"
},
"projectId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"transmitter" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"order" : {
"operator" : "IS",
"value" : 12.6,
"includeNullResults" : false
}
}
2.10.29. Search for leaves (with search criteria)
POST |
/leaves/search |
Description
Get the list of leaves matching the search criteria.
DMF required:
-
DMF A40304: Api Workforce / Leaves / Search
-
DMF 160204: Tools / Leave Requests Management / Search
-
DMF 190103: Web Portal / Timesheets & Schedules Menu / Leave Requests
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
criteria |
Criteria that you choose (comment, duration, etc…) LeaveCriteria |
- |
Return Type
array[Leave]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Leaves successfully loaded |
List[Leave] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"rightEndDate" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
},
"endDate" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
},
"startAfterNoon" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"leaveRightId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"employeeId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"managerId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"readOption" : {
"options" : [ "LEAVE_RIGHT", "LEAVE_RIGHT" ]
},
"duration" : {
"operator" : "IS",
"value" : 12.6,
"includeNullResults" : false
},
"leaveState" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"modificationTime" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
},
"requestDate" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
},
"guid" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"comment" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"id" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"startDate" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
},
"rightStartDate" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
}
}
2.10.30. Search for leaves rights (with search criteria)
POST |
/leave-rights/search |
Description
Get the list of leaves rights matching the search criteria.
DMF required:
-
DMF A40804: Api Workforce / Leave-rights / Search
-
DMF 160807: Tools / Resources / Manage Acquired Rights
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
criteria |
Criteria that you choose (comment, duration, etc…) LeaveRightCriteria |
- |
Return Type
array[LeaveRight]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Leaves Rights successfully loaded |
List[LeaveRight] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"companyId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"endDate" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
},
"employeeId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"leaveId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"id" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"startDate" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
},
"readOption" : {
"options" : [ "LEAVE_TYPE", "LEAVE_TYPE" ]
}
}
2.10.31. Search my leave rights (with search criteria)
POST |
/leave-rights/mine/search |
Description
Get my leaves rights matching the search criteria.
DMF required:
-
DMF A40807: Api Workforce / Leave-rights / Mine
-
DMF 160205: Tools / Leave Requests Management / Show History
-
DMF 190103: Web Portal / Timesheets & Schedules Menu / Leave Requests
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
criteria |
Criteria that you choose (comment, duration, etc…) LeaveRightCriteria |
- |
Return Type
array[LeaveRight]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Leaves Rights successfully loaded |
List[LeaveRight] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"companyId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"endDate" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
},
"employeeId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"leaveId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"id" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"startDate" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
},
"readOption" : {
"options" : [ "LEAVE_TYPE", "LEAVE_TYPE" ]
}
}
2.10.32. Update a leave
POST |
/leaves/{leave_id} |
Description
Update the leave matching the specified ID and using the list of parameters below.
DMF required:
-
DMF A40302: Api Workforce / Leaves / Update
-
DMF 160202: Tools / Leave Requests Management / Modify
-
DMF 160213: Tools / Leave Requests Management / Modify Validated Request
-
DMF 190103: Web Portal / Timesheets & Schedules Menu / Leave Requests
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
leave_id |
The id of the leave |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
leave |
The leave to update Leave |
X |
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Leave successfully updated |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"id" : "5000123",
"guid" : "5000123",
"leaveRight" : {
"id" : "5000123",
"name" : "Public holiday",
"startDate" : "2020-01-31T23:59:59Z",
"endDate" : "2020-01-31T23:59:59Z",
"right" : 25,
"tolerance" : 2,
"employeeId" : "5000123",
"leaveType" : {
"id" : "5000123",
"code" : "RTT",
"name" : "Absence maladie",
"endDate" : "2020-01-31T23:59:59Z",
"company" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo"
},
"companyId" : "5000123",
"entity" : {
"id" : "5000123",
"code" : "01-BRDX",
"name" : "Bordeaux"
},
"entityId" : "5000123",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"subPhase" : {
"id" : "5000123",
"code" : "SB_1",
"name" : "Sub Phase 1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"order" : 1
},
"subPhaseId" : "5000123",
"actionCode" : {
"id" : "5000123",
"name" : "ADD"
},
"actionCodeId" : "5000123",
"receiver" : true,
"transmitter" : false,
"thresholdTolerance" : 1,
"restricted" : false,
"unit" : "{}",
"type" : "{}",
"entry" : "{}",
"counterValue" : 15,
"increment" : 3,
"order" : 2,
"countDownPartTime" : false,
"freeAnalyticCode" : "102",
"acquiredCounterDecimals" : 2
},
"leaveTypeId" : "5000123",
"comment" : "Lorem Ipsum",
"acquisitionStartDate" : "2020-01-31T23:59:59Z",
"acquisitionEndDate" : "2020-01-31T23:59:59Z",
"adjustment" : 1,
"estimatedMaxRight" : 25,
"acquiredRight" : 25,
"leavesAccepted" : 20,
"leavesRequested" : 2.5,
"remainingDays" : 17
},
"leaveRightId" : "5000123",
"requestDate" : "2020-01-31T23:59:59Z",
"startDate" : "2020-01-31T23:59:59Z",
"endDate" : "2020-01-31T23:59:59Z",
"duration" : 2,
"comment" : "Lorem ipsum",
"leaveState" : "{}",
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"modificationTime" : "2000-06-21T04:56:07.000+00:00",
"changeTracking" : {
"createdTime" : "2000-06-21T04:56:07.000+00:00",
"createdBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"createdById" : "5000123",
"modificationTime" : "2000-06-21T04:56:07.000+00:00",
"modificationBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"modificationById" : "5000123"
},
"startAfterNoon" : false,
"commentValidator" : "Lorem ipsum by manager",
"dateValidator" : "2020-01-31T23:59:59Z",
"employeeValidator" : "MARTIN",
"leaveType" : "RTT",
"formConfig" : {
"type" : "{}",
"fields" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"controls" : {
"key" : {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}
},
"insertable" : true,
"editable" : false,
"deletable" : false,
"formSearchHidden" : false
}
}
2.10.33. Update leave right for an employee
POST |
/employees/{employee_id}/leave-rights/{leave_right_id} |
Description
Update the leave right of an employee matching specified IDs (employee\
\ and leave right) and using the list of parameters below.
DMF required:
-
DMF A40802: Api Workforce / Leave-rights / Update
-
DMF 160807: Tools / Resources / Manage Acquired Rights
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
employee_id |
Id of an employee |
X |
null |
|
leave_right_id |
The id of the leave right |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
leaveRight |
The leave right to update LeaveRight |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Leave right successfully updated |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"id" : "5000123",
"name" : "Public holiday",
"startDate" : "2020-01-31T23:59:59Z",
"endDate" : "2020-01-31T23:59:59Z",
"right" : 25,
"tolerance" : 2,
"employeeId" : "5000123",
"leaveType" : {
"id" : "5000123",
"code" : "RTT",
"name" : "Absence maladie",
"endDate" : "2020-01-31T23:59:59Z",
"company" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo"
},
"companyId" : "5000123",
"entity" : {
"id" : "5000123",
"code" : "01-BRDX",
"name" : "Bordeaux"
},
"entityId" : "5000123",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"subPhase" : {
"id" : "5000123",
"code" : "SB_1",
"name" : "Sub Phase 1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"order" : 1
},
"subPhaseId" : "5000123",
"actionCode" : {
"id" : "5000123",
"name" : "ADD"
},
"actionCodeId" : "5000123",
"receiver" : true,
"transmitter" : false,
"thresholdTolerance" : 1,
"restricted" : false,
"unit" : "{}",
"type" : "{}",
"entry" : "{}",
"counterValue" : 15,
"increment" : 3,
"order" : 2,
"countDownPartTime" : false,
"freeAnalyticCode" : "102",
"acquiredCounterDecimals" : 2
},
"leaveTypeId" : "5000123",
"comment" : "Lorem Ipsum",
"acquisitionStartDate" : "2020-01-31T23:59:59Z",
"acquisitionEndDate" : "2020-01-31T23:59:59Z",
"adjustment" : 1,
"estimatedMaxRight" : 25,
"acquiredRight" : 25,
"leavesAccepted" : 20,
"leavesRequested" : 2.5,
"remainingDays" : 17
}
2.10.34. Update a LeaveType
POST |
/leave-types/{leave_type_id} |
Description
Update a LeaveType
DMF required:
-
DMF A41002: Api Workforce / Leave Type / Update
-
DMF 0901__: Administrator / Setup
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
leave_type_id |
The id of the leave type |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
leaveType |
The LeaveType to update LeaveType |
X |
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
LeaveType successfully updated |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"id" : "5000123",
"code" : "RTT",
"name" : "Absence maladie",
"endDate" : "2020-01-31T23:59:59Z",
"company" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo"
},
"companyId" : "5000123",
"entity" : {
"id" : "5000123",
"code" : "01-BRDX",
"name" : "Bordeaux"
},
"entityId" : "5000123",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"subPhase" : {
"id" : "5000123",
"code" : "SB_1",
"name" : "Sub Phase 1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"order" : 1
},
"subPhaseId" : "5000123",
"actionCode" : {
"id" : "5000123",
"name" : "ADD"
},
"actionCodeId" : "5000123",
"receiver" : true,
"transmitter" : false,
"thresholdTolerance" : 1,
"restricted" : false,
"unit" : "{}",
"type" : "{}",
"entry" : "{}",
"counterValue" : 15,
"increment" : 3,
"order" : 2,
"countDownPartTime" : false,
"freeAnalyticCode" : "102",
"acquiredCounterDecimals" : 2
}
2.10.35. Validate a leave
POST |
/leaves/{leave_id}/validate |
Description
Validate a leave
DMF required:
-
DMF A40311: Api Workforce / Leaves / Validate
-
DMF 160208: Tools / Leave Requests Management / Validate
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
leave_id |
The id of the leave |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
reason |
The reason for acceptation [string] |
- |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Successful validation |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
reason_example
2.11. Project Events
2.11.1. Duplicate a project event
POST |
/project-events/{project_event_type}/{project_event_id}/duplicate |
Description
Duplicate a project event using the list of parameters below.
DMF required:
-
DMF A40401: Api Workforce / Schedules / Insert
-
DMF 060201: Projects / Schedules / New
-
DMF 190402: Web Portal / Schedules / Modify
-
DMF 250102: Project / Schedule View / New
-
DMF 250104: Project / Schedule View / Dissociate Scheduled Item
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
project_event_type |
The type of an project event |
X |
null |
|
project_event_id |
The id of an project event |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
project-event-information |
Project event information used to fill the duplicated project event ProjectEventInformationHolder |
X |
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
mode |
Mode of the duplication. If 'DELETE_CREATE' the original event is deleted and the a new one is created, otherwise 'COPY' it is a simple copy. |
- |
null |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Ident (one id or several) of the project event duplicated |
List[[string]] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"duration" : 5,
"allowPublicHoliday" : true,
"allowSaturday" : false,
"validated" : true,
"endDate" : "2020-01-31T23:59:59Z",
"allowSunday" : true,
"employeeId" : "5000123",
"startDate" : "2020-01-31T23:59:59Z"
}
2.11.2. Delete a project event
DELETE |
/project-events/{project_event_type}/{project_event_id} |
Description
Delete a project event matching the specified ID and the project event type given in parameter.
DMF required:
-
DMF A40403: Api Workforce / Schedules / Delete
-
DMF 060203: Projects / Schedules / Delete
-
DMF 190403: Web Portal / Schedules / Delete
-
DMF 250110: Project / Schedule View / Delete Unvalidated Schedule
-
DMF 250111: Project / Schedule View / Delete Validated Schedule
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
project_event_type |
The type of an project event |
X |
null |
|
project_event_id |
The id of an project event |
X |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Project event successfully deleted |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.11.3. Delete project events of a specified project event type
POST |
/project-events/{project_event_type}/delete |
Description
Delete a list of project events matching the specified type and project event IDs.
DMF required:
-
DMF A40403: Api Workforce / Schedules / Delete
-
DMF 060203: Projects / Schedules / Delete
-
DMF 190403: Web Portal / Schedules / Delete
-
DMF 250110: Project / Schedule View / Delete Unvalidated Schedule
-
DMF 250111: Project / Schedule View / Delete Validated Schedule
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
project_event_type |
The type of an project event |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
project-event-ids |
Ids of project event to delete [string] |
X |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Project event successfully deleted |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
2.11.4. Search a project event by its ID
GET |
/project-events/{project_event_type}/{project_event_id} |
Description
Get the project event matching the specified project event ID and the project type.
DMF required:
-
DMF A40406: Api Workforce / Schedules / Info
-
DMF 060204: Projects / Schedules / Search
-
DMF 190401: Web Portal / Schedules / Show
-
DMF 250101: Project / Schedule View / View
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
project_event_type |
The type of an project event |
X |
null |
|
project_event_id |
The id of an project event |
X |
null |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Project event successfully loaded |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.11.5. Search employees events summaries (with search criteria)
POST |
/employees/events/summaries/search |
Description
Get the list of employees events summaries matching the search criteria.
DMF required:
-
DMF A40116: Api Workforce / Employees / Search Employee Events Summary
-
DMF 060204: Projects / Schedules / Search
-
DMF 060211: Projects / Schedules / Search Resources
-
DMF 060243: Projects / Schedules / View Schedule From Resource List
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
criteria |
Criteria that you choose (employee ID, starting date, etc…) EmployeeEventsSummariesCriteria |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Employees events summaries successfully loaded |
List[EmployeesEventsSummary] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"employeeId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z"
}
2.11.6. Search for project events (with search criteria)
POST |
/project-events/search |
Description
Get the list of project events matching the search criteria.
DMF required:
-
DMF A40404: Api Workforce / Schedules / Search
-
DMF 060204: Projects / Schedules / Search
-
DMF 190401: Web Portal / Schedules / Show
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
criteria |
Criteria that you choose (employee ID, project event type, etc…) ProjectEventCriteria |
X |
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
unit |
Unit of duration of the event Default value is set as DAY |
- |
null |
Return Type
array[ProjectEvent]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Project event successfully loaded |
List[ProjectEvent] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"quotationId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"subject" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"actionCodeCode" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"phaseId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"employeeId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"type" : [ "{}", "{}" ],
"done" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"readOption" : {
"options" : [ "CUSTOMER", "CUSTOMER" ]
},
"projectTaskId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"employeeIdOnVacation" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"name" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"customerId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"subPhaseId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"withinDayPrecision" : false,
"location" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"from" : "2020-01-31T23:59:59Z",
"id" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"to" : "2020-01-31T23:59:59Z",
"projectId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
}
}
2.11.7. Search for search field behavior for the project events
GET |
/project-events/search-fields-information |
Deprecated
|
Tip
|
This API will soon be removed as it is no longer functional. No data will be returned when using it. |
Description
Get the list of search field behavior for Leaproject eventsves
DMF required:
-
DMF A40404: Api Workforce / Schedules / Search
-
DMF 060204: Projects / Schedules / Search
-
DMF 190401: Web Portal / Schedules / Show
Return Type
array[SearchControlBehavior]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Search field behavior results |
List[SearchControlBehavior] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.11.8. Search for project my events (with search criteria)
POST |
/project-events/mine/search |
Description
Get the list of my project events matching the search criteria.
DMF required:
-
DMF A40415: Api Workforce / Schedules / Search My Events
-
DMF 190401: Web Portal / Schedules / Show
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
criteria |
Criteria that you choose (employee ID, project event type, etc…) ProjectEventCriteria |
X |
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
unit |
Unit of duration of the event Default value is set as DAY |
- |
null |
Return Type
array[ProjectEvent]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Project event successfully loaded |
List[ProjectEvent] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"quotationId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"subject" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"actionCodeCode" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"phaseId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"employeeId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"type" : [ "{}", "{}" ],
"done" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"readOption" : {
"options" : [ "CUSTOMER", "CUSTOMER" ]
},
"projectTaskId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"employeeIdOnVacation" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"name" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"customerId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"subPhaseId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"withinDayPrecision" : false,
"location" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"from" : "2020-01-31T23:59:59Z",
"id" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"to" : "2020-01-31T23:59:59Z",
"projectId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
}
}
2.11.9. Split a project event
POST |
/project-events/{project_event_type}/{project_event_id}/split |
Description
Split a project event into several project events using the list of parameters below.
DMF required:
-
DMF A40401: Api Workforce / Schedules / Insert
-
DMF 060201: Projects / Schedules / New
-
DMF 190402: Web Portal / Schedules / Modify
-
DMF 250102: Project / Schedule View / New
-
DMF 250104: Project / Schedule View / Dissociate Scheduled Item
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
project_event_type |
The type of an project event |
X |
null |
|
project_event_id |
The id of an project event |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
split-elements |
Ordered array of split elements SplitElement |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Ids of split project events |
List[[string]] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"order" : 1,
"action" : "{}",
"type" : "SCHEDULE",
"startDate" : "2020-01-31T23:59:59Z",
"duration" : 3,
"unit" : "{}",
"validated" : true,
"allowPublicHoliday" : true,
"allowSaturday" : false,
"allowSunday" : true
}
2.11.10. Update a project event
POST |
/project-events/{project_event_id} |
Description
Update a project event using the list of parameters below.
DMF required:
-
DMF A40402: Api Workforce / Schedules / Update
-
DMF 060202: Projects / Schedules / Modify
-
DMF 190402: Web Portal / Schedules / Modify
-
DMF 250106: Project / Schedule View / Modify Undone Allocation
-
DMF 250108: Project / Schedule View / Modify Done Allocation
-
DMF 250103: Project / Schedule View / Reschedule
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
project_event_id |
The id of an project event |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
project-event |
The project event to update ProjectEvent |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Project event successfully updated |
List[[string]] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"id" : "5000123",
"startDate" : "2020-01-31T23:59:59Z",
"endDate" : "2020-01-31T23:59:59Z",
"duration" : 5,
"durations" : {
"durationMinute" : 240,
"durationHourMinute" : 2.3,
"durationHour" : 2.7,
"durationDay" : 0.25
},
"subject" : "Internal formation",
"description" : "Internal formation about the project management",
"employeeReferential" : {
"id" : "5000123",
"startDate" : "2020-01-31T23:59:59Z",
"endDate" : "2020-01-31T23:59:59Z",
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}",
"title" : "GEN",
"phone" : "+33 6 04 04 04 05",
"mobilePhone" : "+33 6 00 00 00 01",
"email" : "myemail@bechmail.com",
"noTimesDunning" : true,
"assignmentMultiCompany" : false,
"modeTimeRecording" : 1,
"modeInputSchedule" : 3,
"timeRecordingInputMode" : "{}",
"scheduleInputMode" : "{}",
"executive" : true,
"generic" : true,
"candidate" : false,
"external" : false,
"managerMultiCompany" : true,
"employeeFunctions" : {
"allFunctions" : false,
"allSales" : true,
"allPurchases" : false,
"allOperational" : true,
"projectSalesManager" : false,
"projectFinanceManager" : true,
"projectProductionManager" : false,
"projectAccountManager" : true,
"projectAssignment" : false,
"projectPhaseManager" : true,
"projectSendOnMission" : false,
"salesSalesAssistant" : true,
"salesOrderAndEstimateTracking" : false,
"salesBillingSchedulesTracking" : true,
"purchasingBuyer" : false,
"timeRecording" : true,
"inputOfExpenseReport" : false,
"purchasesReceptionTracking" : false,
"inputSchedule" : false,
"CMMSContractSalesManager" : false,
"CMMSContractTechnicalManager" : false,
"CMMSMRAndEOManager" : false
},
"employeeHistory" : [ {
"id" : "5000123",
"employeeHistoryType" : "5000123",
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 7.42,
"weekHours" : 38.3,
"occupancyRate" : 0.8,
"manager" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"managerId" : "5000123",
"company" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo"
},
"companyId" : "5000123",
"directHourlyRate" : 10.42,
"standardHourlyRate" : 10,
"dailyCost" : 59.36,
"dailySellingPrice" : 80,
"entity" : "5000123",
"serviceRef" : {
"id" : "5000123",
"name" : "Professional services",
"code" : "PS"
},
"service" : "5000123",
"position" : "Developer",
"skillRef" : {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
},
"skill" : "5000123",
"family1" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family1Id" : "5000123",
"family2" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family2Id" : "5000123",
"family3" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family3Id" : "5000123",
"leave" : false,
"standardWeek" : {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
}
},
"standardWeekId" : "5000123",
"salary" : 1024
}, {
"id" : "5000123",
"employeeHistoryType" : "5000123",
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 7.42,
"weekHours" : 38.3,
"occupancyRate" : 0.8,
"manager" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"managerId" : "5000123",
"company" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo"
},
"companyId" : "5000123",
"directHourlyRate" : 10.42,
"standardHourlyRate" : 10,
"dailyCost" : 59.36,
"dailySellingPrice" : 80,
"entity" : "5000123",
"serviceRef" : {
"id" : "5000123",
"name" : "Professional services",
"code" : "PS"
},
"service" : "5000123",
"position" : "Developer",
"skillRef" : {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
},
"skill" : "5000123",
"family1" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family1Id" : "5000123",
"family2" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family2Id" : "5000123",
"family3" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family3Id" : "5000123",
"leave" : false,
"standardWeek" : {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
}
},
"standardWeekId" : "5000123",
"salary" : 1024
} ],
"companyChanges" : [ {
"id" : "5000123",
"employeeId" : "500123",
"companyId" : "5000123",
"startDate" : "2020-01-23T04:56:07Z",
"endDate" : "2020-01-23T04:56:07Z",
"companyChangeState" : "{}",
"comment" : "Limpso usum"
}, {
"id" : "5000123",
"employeeId" : "500123",
"companyId" : "5000123",
"startDate" : "2020-01-23T04:56:07Z",
"endDate" : "2020-01-23T04:56:07Z",
"companyChangeState" : "{}",
"comment" : "Limpso usum"
} ],
"timeRecordingRules" : {
"id" : "5000123",
"employeeId" : "5000123",
"min" : 0,
"max" : 24,
"step" : 0.01,
"prettyStep" : 0.3,
"base" : 60,
"unit" : "H",
"unitDuration" : "{}",
"allowManualEntry" : true,
"employeeWeeks" : [ {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
},
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 8,
"dailyMinutes" : 10,
"weekHours" : 40,
"leave" : false
}, {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
},
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 8,
"dailyMinutes" : 10,
"weekHours" : 40,
"leave" : false
} ],
"closingDates" : [ {
"closingDate" : "2020-01-31T23:59:59Z",
"module" : "DATE_MODULE",
"beginningOfPeriod" : "2020-01-31T23:59:59Z",
"endOfPeriod" : "2020-01-31T23:59:59Z"
}, {
"closingDate" : "2020-01-31T23:59:59Z",
"module" : "DATE_MODULE",
"beginningOfPeriod" : "2020-01-31T23:59:59Z",
"endOfPeriod" : "2020-01-31T23:59:59Z"
} ],
"simpleDuration" : 750,
"completionMode" : "WEEKLY"
},
"scheduleRules" : {
"id" : "5000123",
"employeeId" : "5000123",
"min" : 0,
"max" : 24,
"step" : 0.01,
"prettyStep" : 0.3,
"base" : 60,
"unit" : "H",
"unitDuration" : "{}",
"allowManualEntry" : true,
"employeeWeeks" : [ {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
},
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 8,
"dailyMinutes" : 10,
"weekHours" : 40,
"leave" : false
}, {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
},
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 8,
"dailyMinutes" : 10,
"weekHours" : 40,
"leave" : false
} ],
"closingDates" : [ {
"closingDate" : "2020-01-31T23:59:59Z",
"module" : "DATE_MODULE",
"beginningOfPeriod" : "2020-01-31T23:59:59Z",
"endOfPeriod" : "2020-01-31T23:59:59Z"
}, {
"closingDate" : "2020-01-31T23:59:59Z",
"module" : "DATE_MODULE",
"beginningOfPeriod" : "2020-01-31T23:59:59Z",
"endOfPeriod" : "2020-01-31T23:59:59Z"
} ],
"timestamped" : true
},
"businessCards" : [ {
"id" : "5000123",
"employeeId" : "5000123",
"cardNumber" : "XXXX XXXX XXXX 7568",
"encryptedCardNumber" : "0",
"name" : "Management card",
"type" : "{}",
"endDate" : "2020-01-31T23:59:59Z"
}, {
"id" : "5000123",
"employeeId" : "5000123",
"cardNumber" : "XXXX XXXX XXXX 7568",
"encryptedCardNumber" : "0",
"name" : "Management card",
"type" : "{}",
"endDate" : "2020-01-31T23:59:59Z"
} ],
"sector" : "Marketing",
"number" : "84",
"relations" : [ {
"id" : "5000123",
"relationType" : {
"id" : "5000123",
"code" : "TUTOR",
"name" : "Tutor for internship"
},
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"relatedEmployee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"relatedEmployeeId" : "5000123"
}, {
"id" : "5000123",
"relationType" : {
"id" : "5000123",
"code" : "TUTOR",
"name" : "Tutor for internship"
},
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"relatedEmployee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"relatedEmployeeId" : "5000123"
} ],
"employeeAbilities" : [ {
"id" : "5000123",
"skill" : {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
},
"level" : {
"id" : "5000123",
"code" : "EXP",
"name" : "Expert"
},
"startDate" : "2020-01-31T23:59:59Z",
"endDate" : "2020-01-31T23:59:59Z",
"employeeId" : "5000123"
}, {
"id" : "5000123",
"skill" : {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
},
"level" : {
"id" : "5000123",
"code" : "EXP",
"name" : "Expert"
},
"startDate" : "2020-01-31T23:59:59Z",
"endDate" : "2020-01-31T23:59:59Z",
"employeeId" : "5000123"
} ],
"jobType" : {
"id" : "5000123",
"companyCode" : "AKSAS",
"code" : "ADMIN",
"name" : "Administrator",
"category" : "{}",
"validity" : {
"type" : "{}",
"date" : "2000-06-21T04:56:07.000+00:00"
},
"default" : true
},
"jobTypeId" : "100245",
"address" : {
"id" : "id",
"line1" : "221B Baker Street",
"line2" : "2nd Floor",
"line3" : "First door at your right",
"cedex" : "CEDEX 14",
"postalCode" : "69002",
"city" : "London",
"country" : "FR (for 'FRANCE')",
"countryName" : "FRANCE",
"department" : "75 (for 'PARIS')",
"geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
"region" : "65 (for 'ILE DE FRANCE')",
"regionName" : "ILE DE FRANCE",
"phone" : "06 00 00 00 01",
"phone2" : "06 00 00 00 02",
"email" : "myemail@mail.com",
"mobilePhone" : "06 00 00 00 02",
"fax" : "04 00 00 00 07",
"webSite" : "mysite.com"
},
"addressId" : "5000123",
"birthDate" : "2000-06-21T04:56:07.000+00:00",
"customData" : {
"key" : {
"type" : "{}",
"value" : "Autoref 010520",
"name" : "Reference 4",
"realOrder" : 0,
"label" : "REFERENCE_4"
}
},
"color" : "#FF0000",
"targetTace" : 75,
"formConfig" : {
"type" : "{}",
"fields" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"controls" : {
"key" : {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}
},
"insertable" : true,
"editable" : false,
"deletable" : false,
"formSearchHidden" : false
},
"changeTracking" : {
"createdTime" : "2000-06-21T04:56:07.000+00:00",
"createdBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"createdById" : "5000123",
"modificationTime" : "2000-06-21T04:56:07.000+00:00",
"modificationBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"modificationById" : "5000123"
},
"vehicles" : [ {
"id" : "5000123",
"power" : 5,
"licensePlate" : "licensePlate",
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"expenseType" : {
"id" : "5000123",
"code" : "MEAL",
"description" : "Plane",
"km" : false,
"notRefundable" : true,
"icon" : "fa fa-plane",
"color" : "00ff40",
"receiptRequired" : false,
"commentRequired" : false,
"guestsRequired" : false,
"notRefundableEditable" : true,
"billableEditable" : true,
"amountEditable" : true,
"showQuantity" : false,
"showAdditionalComment" : false,
"showReceiptNumber" : true,
"showAmountCategory" : true,
"showBillable" : true,
"hideVat" : false,
"vat1Code" : "1",
"vat2Code" : "2",
"vat3Code" : "3",
"expenseThreshold" : 100,
"defaultAmount" : 45,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"expenseCategory" : "{}",
"expenseRebillableOptions" : "{}",
"showCustomRequest" : true,
"showAmountWithoutVat" : true,
"controlsBehavior" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"calculateKilometers" : true,
"freeEntryProhibited" : true,
"controls" : {
"enableDuplicate" : true,
"enablelOnNonWorkingDay" : true,
"enableOnDayWithLeaveRequest" : true,
"enableOnDayWithTimesheetOrSchedule" : true
},
"expenseThresholdExceededNoVat" : false
},
"expenseTypeId" : "5000123",
"endDate" : "2020-01-31T23:59:59Z"
}, {
"id" : "5000123",
"power" : 5,
"licensePlate" : "licensePlate",
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"expenseType" : {
"id" : "5000123",
"code" : "MEAL",
"description" : "Plane",
"km" : false,
"notRefundable" : true,
"icon" : "fa fa-plane",
"color" : "00ff40",
"receiptRequired" : false,
"commentRequired" : false,
"guestsRequired" : false,
"notRefundableEditable" : true,
"billableEditable" : true,
"amountEditable" : true,
"showQuantity" : false,
"showAdditionalComment" : false,
"showReceiptNumber" : true,
"showAmountCategory" : true,
"showBillable" : true,
"hideVat" : false,
"vat1Code" : "1",
"vat2Code" : "2",
"vat3Code" : "3",
"expenseThreshold" : 100,
"defaultAmount" : 45,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"expenseCategory" : "{}",
"expenseRebillableOptions" : "{}",
"showCustomRequest" : true,
"showAmountWithoutVat" : true,
"controlsBehavior" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"calculateKilometers" : true,
"freeEntryProhibited" : true,
"controls" : {
"enableDuplicate" : true,
"enablelOnNonWorkingDay" : true,
"enableOnDayWithLeaveRequest" : true,
"enableOnDayWithTimesheetOrSchedule" : true
},
"expenseThresholdExceededNoVat" : false
},
"expenseTypeId" : "5000123",
"endDate" : "2020-01-31T23:59:59Z"
} ],
"currentCompany" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo",
"legalName" : "legalName",
"siren" : "siren",
"siret" : "siret",
"calendar" : {
"id" : "5000123",
"code" : "Text",
"name" : "Text",
"default" : true,
"daysNotWorked" : [ 6, 6 ],
"holidays" : [ {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
}, {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
} ]
},
"calendarId" : "calendarId",
"color" : "color",
"currency" : {
"id" : "5000123",
"name" : "Euro",
"code" : "EUR",
"order" : 17,
"euro" : true,
"euroRate" : 0.9678,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"euroRateStartDate" : "2020-01-23T04:56:07Z",
"euroRateEndDate" : "2020-01-23T04:56:07Z"
},
"currencyId" : "currencyId",
"address" : {
"id" : "id",
"line1" : "221B Baker Street",
"line2" : "2nd Floor",
"line3" : "First door at your right",
"cedex" : "CEDEX 14",
"postalCode" : "69002",
"city" : "London",
"country" : "FR (for 'FRANCE')",
"countryName" : "FRANCE",
"department" : "75 (for 'PARIS')",
"geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
"region" : "65 (for 'ILE DE FRANCE')",
"regionName" : "ILE DE FRANCE",
"phone" : "06 00 00 00 01",
"phone2" : "06 00 00 00 02",
"email" : "myemail@mail.com",
"mobilePhone" : "06 00 00 00 02",
"fax" : "04 00 00 00 07",
"webSite" : "mysite.com"
},
"addressId" : "addressId"
},
"currentCompanyId" : "5000123",
"bankingInformation" : {
"id" : "5000123",
"sepa" : {
"bankDetails" : {
"entity" : "30002",
"counter" : "550",
"accountNumber" : "0000157841Z",
"key" : "25",
"domiciliation" : "AURA"
},
"bic" : {
"country" : "FR (for 'FRANCE')",
"bank" : "DAAE",
"location" : "PP",
"branch" : "CCT"
},
"iban" : {
"country" : "FR (for 'FRANCE')",
"key" : "69",
"accountNumber" : "0000157841Z"
}
},
"noneSepa" : {
"defaultBankDetail" : false,
"beneficiary" : {
"holder" : {
"name" : "RITA",
"firstName" : "BRITA",
"accountType" : "{}",
"accountNumber" : "123456789"
},
"bank" : {
"bankName" : "UBA",
"bankName2" : "UBA",
"bankType" : "{}",
"bankCode" : "C8",
"bankAddress" : {
"id" : "id",
"line1" : "221B Baker Street",
"line2" : "2nd Floor",
"line3" : "First door at your right",
"cedex" : "CEDEX 14",
"postalCode" : "69002",
"city" : "London",
"country" : "FR (for 'FRANCE')",
"countryName" : "FRANCE",
"department" : "75 (for 'PARIS')",
"geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
"region" : "65 (for 'ILE DE FRANCE')",
"regionName" : "ILE DE FRANCE",
"phone" : "06 00 00 00 01",
"phone2" : "06 00 00 00 02",
"email" : "myemail@mail.com",
"mobilePhone" : "06 00 00 00 02",
"fax" : "04 00 00 00 07",
"webSite" : "mysite.com"
}
}
},
"intermediate" : {
"holder" : {
"name" : "RITA",
"firstName" : "BRITA",
"accountType" : "{}",
"accountNumber" : "123456789"
},
"bank" : {
"bankName" : "UBA",
"bankName2" : "UBA",
"bankType" : "{}",
"bankCode" : "C8",
"bankAddress" : {
"id" : "id",
"line1" : "221B Baker Street",
"line2" : "2nd Floor",
"line3" : "First door at your right",
"cedex" : "CEDEX 14",
"postalCode" : "69002",
"city" : "London",
"country" : "FR (for 'FRANCE')",
"countryName" : "FRANCE",
"department" : "75 (for 'PARIS')",
"geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
"region" : "65 (for 'ILE DE FRANCE')",
"regionName" : "ILE DE FRANCE",
"phone" : "06 00 00 00 01",
"phone2" : "06 00 00 00 02",
"email" : "myemail@mail.com",
"mobilePhone" : "06 00 00 00 02",
"fax" : "04 00 00 00 07",
"webSite" : "mysite.com"
}
}
}
},
"statusChangeDate" : "2000-06-21T04:56:07.000+00:00",
"statusChangeArgument" : {
"comment" : "Comment",
"status" : "{}"
},
"validator" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"validatorId" : "5000123",
"action" : "{}",
"type" : "{}"
},
"faxNumber" : "418 643 3210",
"phoneExtensionNumber" : "04 00 00 00 07"
},
"company" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo"
},
"service" : {
"id" : "5000123",
"name" : "Professional services",
"code" : "PS"
},
"manager" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}",
"title" : "GEN",
"phone" : "+33 6 04 04 04 05",
"mobilePhone" : "+33 6 00 00 00 01",
"email" : "myemail@bechmail.com",
"noTimesDunning" : true,
"assignmentMultiCompany" : false,
"modeTimeRecording" : 1,
"modeInputSchedule" : 3,
"timeRecordingInputMode" : "{}",
"scheduleInputMode" : "{}",
"executive" : true,
"generic" : true,
"candidate" : false,
"external" : false,
"managerMultiCompany" : true,
"employeeFunctions" : {
"allFunctions" : false,
"allSales" : true,
"allPurchases" : false,
"allOperational" : true,
"projectSalesManager" : false,
"projectFinanceManager" : true,
"projectProductionManager" : false,
"projectAccountManager" : true,
"projectAssignment" : false,
"projectPhaseManager" : true,
"projectSendOnMission" : false,
"salesSalesAssistant" : true,
"salesOrderAndEstimateTracking" : false,
"salesBillingSchedulesTracking" : true,
"purchasingBuyer" : false,
"timeRecording" : true,
"inputOfExpenseReport" : false,
"purchasesReceptionTracking" : false,
"inputSchedule" : false,
"CMMSContractSalesManager" : false,
"CMMSContractTechnicalManager" : false,
"CMMSMRAndEOManager" : false
},
"employeeHistory" : [ {
"id" : "5000123",
"employeeHistoryType" : "5000123",
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 7.42,
"weekHours" : 38.3,
"occupancyRate" : 0.8,
"manager" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"managerId" : "5000123",
"company" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo"
},
"companyId" : "5000123",
"directHourlyRate" : 10.42,
"standardHourlyRate" : 10,
"dailyCost" : 59.36,
"dailySellingPrice" : 80,
"entity" : "5000123",
"serviceRef" : {
"id" : "5000123",
"name" : "Professional services",
"code" : "PS"
},
"service" : "5000123",
"position" : "Developer",
"skillRef" : {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
},
"skill" : "5000123",
"family1" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family1Id" : "5000123",
"family2" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family2Id" : "5000123",
"family3" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family3Id" : "5000123",
"leave" : false,
"standardWeek" : {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
}
},
"standardWeekId" : "5000123",
"salary" : 1024
}, {
"id" : "5000123",
"employeeHistoryType" : "5000123",
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 7.42,
"weekHours" : 38.3,
"occupancyRate" : 0.8,
"manager" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"managerId" : "5000123",
"company" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo"
},
"companyId" : "5000123",
"directHourlyRate" : 10.42,
"standardHourlyRate" : 10,
"dailyCost" : 59.36,
"dailySellingPrice" : 80,
"entity" : "5000123",
"serviceRef" : {
"id" : "5000123",
"name" : "Professional services",
"code" : "PS"
},
"service" : "5000123",
"position" : "Developer",
"skillRef" : {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
},
"skill" : "5000123",
"family1" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family1Id" : "5000123",
"family2" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family2Id" : "5000123",
"family3" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family3Id" : "5000123",
"leave" : false,
"standardWeek" : {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
}
},
"standardWeekId" : "5000123",
"salary" : 1024
} ],
"companyChanges" : [ {
"id" : "5000123",
"employeeId" : "500123",
"companyId" : "5000123",
"startDate" : "2020-01-23T04:56:07Z",
"endDate" : "2020-01-23T04:56:07Z",
"companyChangeState" : "{}",
"comment" : "Limpso usum"
}, {
"id" : "5000123",
"employeeId" : "500123",
"companyId" : "5000123",
"startDate" : "2020-01-23T04:56:07Z",
"endDate" : "2020-01-23T04:56:07Z",
"companyChangeState" : "{}",
"comment" : "Limpso usum"
} ],
"timeRecordingRules" : {
"id" : "5000123",
"employeeId" : "5000123",
"min" : 0,
"max" : 24,
"step" : 0.01,
"prettyStep" : 0.3,
"base" : 60,
"unit" : "H",
"unitDuration" : "{}",
"allowManualEntry" : true,
"employeeWeeks" : [ {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
},
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 8,
"dailyMinutes" : 10,
"weekHours" : 40,
"leave" : false
}, {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
},
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 8,
"dailyMinutes" : 10,
"weekHours" : 40,
"leave" : false
} ],
"closingDates" : [ {
"closingDate" : "2020-01-31T23:59:59Z",
"module" : "DATE_MODULE",
"beginningOfPeriod" : "2020-01-31T23:59:59Z",
"endOfPeriod" : "2020-01-31T23:59:59Z"
}, {
"closingDate" : "2020-01-31T23:59:59Z",
"module" : "DATE_MODULE",
"beginningOfPeriod" : "2020-01-31T23:59:59Z",
"endOfPeriod" : "2020-01-31T23:59:59Z"
} ],
"simpleDuration" : 750,
"completionMode" : "WEEKLY"
},
"scheduleRules" : {
"id" : "5000123",
"employeeId" : "5000123",
"min" : 0,
"max" : 24,
"step" : 0.01,
"prettyStep" : 0.3,
"base" : 60,
"unit" : "H",
"unitDuration" : "{}",
"allowManualEntry" : true,
"employeeWeeks" : [ {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
},
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 8,
"dailyMinutes" : 10,
"weekHours" : 40,
"leave" : false
}, {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
},
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 8,
"dailyMinutes" : 10,
"weekHours" : 40,
"leave" : false
} ],
"closingDates" : [ {
"closingDate" : "2020-01-31T23:59:59Z",
"module" : "DATE_MODULE",
"beginningOfPeriod" : "2020-01-31T23:59:59Z",
"endOfPeriod" : "2020-01-31T23:59:59Z"
}, {
"closingDate" : "2020-01-31T23:59:59Z",
"module" : "DATE_MODULE",
"beginningOfPeriod" : "2020-01-31T23:59:59Z",
"endOfPeriod" : "2020-01-31T23:59:59Z"
} ],
"timestamped" : true
},
"businessCards" : [ {
"id" : "5000123",
"employeeId" : "5000123",
"cardNumber" : "XXXX XXXX XXXX 7568",
"encryptedCardNumber" : "0",
"name" : "Management card",
"type" : "{}",
"endDate" : "2020-01-31T23:59:59Z"
}, {
"id" : "5000123",
"employeeId" : "5000123",
"cardNumber" : "XXXX XXXX XXXX 7568",
"encryptedCardNumber" : "0",
"name" : "Management card",
"type" : "{}",
"endDate" : "2020-01-31T23:59:59Z"
} ],
"sector" : "Marketing",
"number" : "84",
"relations" : [ {
"id" : "5000123",
"relationType" : {
"id" : "5000123",
"code" : "TUTOR",
"name" : "Tutor for internship"
},
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"relatedEmployee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"relatedEmployeeId" : "5000123"
}, {
"id" : "5000123",
"relationType" : {
"id" : "5000123",
"code" : "TUTOR",
"name" : "Tutor for internship"
},
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"relatedEmployee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"relatedEmployeeId" : "5000123"
} ],
"employeeAbilities" : [ {
"id" : "5000123",
"skill" : {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
},
"level" : {
"id" : "5000123",
"code" : "EXP",
"name" : "Expert"
},
"startDate" : "2020-01-31T23:59:59Z",
"endDate" : "2020-01-31T23:59:59Z",
"employeeId" : "5000123"
}, {
"id" : "5000123",
"skill" : {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
},
"level" : {
"id" : "5000123",
"code" : "EXP",
"name" : "Expert"
},
"startDate" : "2020-01-31T23:59:59Z",
"endDate" : "2020-01-31T23:59:59Z",
"employeeId" : "5000123"
} ],
"jobType" : {
"id" : "5000123",
"companyCode" : "AKSAS",
"code" : "ADMIN",
"name" : "Administrator",
"category" : "{}",
"validity" : {
"type" : "{}",
"date" : "2000-06-21T04:56:07.000+00:00"
},
"default" : true
},
"jobTypeId" : "100245",
"address" : {
"id" : "id",
"line1" : "221B Baker Street",
"line2" : "2nd Floor",
"line3" : "First door at your right",
"cedex" : "CEDEX 14",
"postalCode" : "69002",
"city" : "London",
"country" : "FR (for 'FRANCE')",
"countryName" : "FRANCE",
"department" : "75 (for 'PARIS')",
"geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
"region" : "65 (for 'ILE DE FRANCE')",
"regionName" : "ILE DE FRANCE",
"phone" : "06 00 00 00 01",
"phone2" : "06 00 00 00 02",
"email" : "myemail@mail.com",
"mobilePhone" : "06 00 00 00 02",
"fax" : "04 00 00 00 07",
"webSite" : "mysite.com"
},
"addressId" : "5000123",
"birthDate" : "2000-06-21T04:56:07.000+00:00",
"customData" : {
"key" : {
"type" : "{}",
"value" : "Autoref 010520",
"name" : "Reference 4",
"realOrder" : 0,
"label" : "REFERENCE_4"
}
},
"color" : "#FF0000",
"targetTace" : 75,
"formConfig" : {
"type" : "{}",
"fields" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"controls" : {
"key" : {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}
},
"insertable" : true,
"editable" : false,
"deletable" : false,
"formSearchHidden" : false
},
"changeTracking" : {
"createdTime" : "2000-06-21T04:56:07.000+00:00",
"createdBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"createdById" : "5000123",
"modificationTime" : "2000-06-21T04:56:07.000+00:00",
"modificationBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"modificationById" : "5000123"
},
"vehicles" : [ {
"id" : "5000123",
"power" : 5,
"licensePlate" : "licensePlate",
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"expenseType" : {
"id" : "5000123",
"code" : "MEAL",
"description" : "Plane",
"km" : false,
"notRefundable" : true,
"icon" : "fa fa-plane",
"color" : "00ff40",
"receiptRequired" : false,
"commentRequired" : false,
"guestsRequired" : false,
"notRefundableEditable" : true,
"billableEditable" : true,
"amountEditable" : true,
"showQuantity" : false,
"showAdditionalComment" : false,
"showReceiptNumber" : true,
"showAmountCategory" : true,
"showBillable" : true,
"hideVat" : false,
"vat1Code" : "1",
"vat2Code" : "2",
"vat3Code" : "3",
"expenseThreshold" : 100,
"defaultAmount" : 45,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"expenseCategory" : "{}",
"expenseRebillableOptions" : "{}",
"showCustomRequest" : true,
"showAmountWithoutVat" : true,
"controlsBehavior" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"calculateKilometers" : true,
"freeEntryProhibited" : true,
"controls" : {
"enableDuplicate" : true,
"enablelOnNonWorkingDay" : true,
"enableOnDayWithLeaveRequest" : true,
"enableOnDayWithTimesheetOrSchedule" : true
},
"expenseThresholdExceededNoVat" : false
},
"expenseTypeId" : "5000123",
"endDate" : "2020-01-31T23:59:59Z"
}, {
"id" : "5000123",
"power" : 5,
"licensePlate" : "licensePlate",
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"expenseType" : {
"id" : "5000123",
"code" : "MEAL",
"description" : "Plane",
"km" : false,
"notRefundable" : true,
"icon" : "fa fa-plane",
"color" : "00ff40",
"receiptRequired" : false,
"commentRequired" : false,
"guestsRequired" : false,
"notRefundableEditable" : true,
"billableEditable" : true,
"amountEditable" : true,
"showQuantity" : false,
"showAdditionalComment" : false,
"showReceiptNumber" : true,
"showAmountCategory" : true,
"showBillable" : true,
"hideVat" : false,
"vat1Code" : "1",
"vat2Code" : "2",
"vat3Code" : "3",
"expenseThreshold" : 100,
"defaultAmount" : 45,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"expenseCategory" : "{}",
"expenseRebillableOptions" : "{}",
"showCustomRequest" : true,
"showAmountWithoutVat" : true,
"controlsBehavior" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"calculateKilometers" : true,
"freeEntryProhibited" : true,
"controls" : {
"enableDuplicate" : true,
"enablelOnNonWorkingDay" : true,
"enableOnDayWithLeaveRequest" : true,
"enableOnDayWithTimesheetOrSchedule" : true
},
"expenseThresholdExceededNoVat" : false
},
"expenseTypeId" : "5000123",
"endDate" : "2020-01-31T23:59:59Z"
} ],
"currentCompany" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo",
"legalName" : "legalName",
"siren" : "siren",
"siret" : "siret",
"calendar" : {
"id" : "5000123",
"code" : "Text",
"name" : "Text",
"default" : true,
"daysNotWorked" : [ 6, 6 ],
"holidays" : [ {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
}, {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
} ]
},
"calendarId" : "calendarId",
"color" : "color",
"currency" : {
"id" : "5000123",
"name" : "Euro",
"code" : "EUR",
"order" : 17,
"euro" : true,
"euroRate" : 0.9678,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"euroRateStartDate" : "2020-01-23T04:56:07Z",
"euroRateEndDate" : "2020-01-23T04:56:07Z"
},
"currencyId" : "currencyId",
"address" : {
"id" : "id",
"line1" : "221B Baker Street",
"line2" : "2nd Floor",
"line3" : "First door at your right",
"cedex" : "CEDEX 14",
"postalCode" : "69002",
"city" : "London",
"country" : "FR (for 'FRANCE')",
"countryName" : "FRANCE",
"department" : "75 (for 'PARIS')",
"geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
"region" : "65 (for 'ILE DE FRANCE')",
"regionName" : "ILE DE FRANCE",
"phone" : "06 00 00 00 01",
"phone2" : "06 00 00 00 02",
"email" : "myemail@mail.com",
"mobilePhone" : "06 00 00 00 02",
"fax" : "04 00 00 00 07",
"webSite" : "mysite.com"
},
"addressId" : "addressId"
},
"currentCompanyId" : "5000123",
"bankingInformation" : {
"id" : "5000123",
"sepa" : {
"bankDetails" : {
"entity" : "30002",
"counter" : "550",
"accountNumber" : "0000157841Z",
"key" : "25",
"domiciliation" : "AURA"
},
"bic" : {
"country" : "FR (for 'FRANCE')",
"bank" : "DAAE",
"location" : "PP",
"branch" : "CCT"
},
"iban" : {
"country" : "FR (for 'FRANCE')",
"key" : "69",
"accountNumber" : "0000157841Z"
}
},
"noneSepa" : {
"defaultBankDetail" : false,
"beneficiary" : {
"holder" : {
"name" : "RITA",
"firstName" : "BRITA",
"accountType" : "{}",
"accountNumber" : "123456789"
},
"bank" : {
"bankName" : "UBA",
"bankName2" : "UBA",
"bankType" : "{}",
"bankCode" : "C8",
"bankAddress" : {
"id" : "id",
"line1" : "221B Baker Street",
"line2" : "2nd Floor",
"line3" : "First door at your right",
"cedex" : "CEDEX 14",
"postalCode" : "69002",
"city" : "London",
"country" : "FR (for 'FRANCE')",
"countryName" : "FRANCE",
"department" : "75 (for 'PARIS')",
"geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
"region" : "65 (for 'ILE DE FRANCE')",
"regionName" : "ILE DE FRANCE",
"phone" : "06 00 00 00 01",
"phone2" : "06 00 00 00 02",
"email" : "myemail@mail.com",
"mobilePhone" : "06 00 00 00 02",
"fax" : "04 00 00 00 07",
"webSite" : "mysite.com"
}
}
},
"intermediate" : {
"holder" : {
"name" : "RITA",
"firstName" : "BRITA",
"accountType" : "{}",
"accountNumber" : "123456789"
},
"bank" : {
"bankName" : "UBA",
"bankName2" : "UBA",
"bankType" : "{}",
"bankCode" : "C8",
"bankAddress" : {
"id" : "id",
"line1" : "221B Baker Street",
"line2" : "2nd Floor",
"line3" : "First door at your right",
"cedex" : "CEDEX 14",
"postalCode" : "69002",
"city" : "London",
"country" : "FR (for 'FRANCE')",
"countryName" : "FRANCE",
"department" : "75 (for 'PARIS')",
"geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
"region" : "65 (for 'ILE DE FRANCE')",
"regionName" : "ILE DE FRANCE",
"phone" : "06 00 00 00 01",
"phone2" : "06 00 00 00 02",
"email" : "myemail@mail.com",
"mobilePhone" : "06 00 00 00 02",
"fax" : "04 00 00 00 07",
"webSite" : "mysite.com"
}
}
}
},
"statusChangeDate" : "2000-06-21T04:56:07.000+00:00",
"statusChangeArgument" : {
"comment" : "Comment",
"status" : "{}"
},
"validator" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"validatorId" : "5000123",
"action" : "{}",
"type" : "{}"
},
"faxNumber" : "418 643 3210",
"phoneExtensionNumber" : "04 00 00 00 07"
},
"division" : {
"id" : "5000123",
"name" : "Rhone-Alpes",
"code" : "RA",
"group" : {
"id" : "5000123",
"name" : "West",
"code" : "WST",
"serviceId" : "5000123"
},
"groupId" : "5000123",
"companyId" : "5000123"
},
"category1" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"category2" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"category3" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"divisionGroup" : {
"id" : "5000123",
"name" : "West",
"code" : "WST",
"serviceId" : "5000123"
},
"entity" : {
"id" : "5000123",
"code" : "01-BRDX",
"name" : "Bordeaux"
},
"skill" : {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
},
"standardWeek" : {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
}
},
"employeeHistoryId" : "5600123"
},
"employeeId" : "50001060",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"assignmentReferential" : {
"id" : "5000123",
"company" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo"
},
"divisionGroup" : {
"id" : "5000123",
"name" : "West",
"code" : "WST",
"serviceId" : "5000123"
},
"division" : {
"id" : "5000123",
"name" : "Rhone-Alpes",
"code" : "RA",
"group" : {
"id" : "5000123",
"name" : "West",
"code" : "WST",
"serviceId" : "5000123"
},
"groupId" : "5000123",
"companyId" : "5000123"
},
"entity" : {
"id" : "5000123",
"code" : "01-BRDX",
"name" : "Bordeaux",
"legalName" : "Customer care",
"division" : {
"id" : "5000123",
"name" : "Rhone-Alpes",
"code" : "RA",
"group" : {
"id" : "5000123",
"name" : "West",
"code" : "WST",
"serviceId" : "5000123"
},
"groupId" : "5000123",
"companyId" : "5000123"
},
"divisionId" : "5000123",
"divisionCode" : "01-DIV",
"companyId" : "5000123",
"endDate" : "2020-01-23T04:56:07Z"
},
"projectGroup" : {
"id" : "5000123",
"name" : "PARC",
"description" : "Lorem ipsum",
"code" : "PARC"
},
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}",
"projectStart" : "2000-06-21T04:56:07.000+00:00",
"projectEnd" : "2000-06-21T04:56:07.000+00:00",
"projectState" : {
"id" : "id",
"code" : "PRO",
"name" : "Production",
"companyCode" : "AKSAS",
"companyId" : "5000123"
},
"projectStateId" : "5000123",
"color" : "color"
},
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"subPhase" : {
"id" : "5000123",
"code" : "SB_1",
"name" : "Sub Phase 1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"order" : 1
},
"projectTask" : {
"id" : "5000123",
"code" : "code",
"name" : "Team building",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJT_001",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"subPhase" : {
"id" : "5000123",
"code" : "SB_1",
"name" : "Sub Phase 1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"order" : 1
},
"subPhaseId" : "51000122",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"order" : 2,
"startDate" : "2000-06-21T04:56:07.000+00:00",
"endDate" : "2000-06-21T04:56:07.000+00:00",
"description" : "description"
},
"projectManager" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"projectProductionManager" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"activity" : {
"id" : "5000123",
"code" : "code",
"name" : "name"
},
"department" : {
"id" : "5000123",
"code" : "01-A",
"companyCode" : "AKSAS",
"name" : "Lorem Ipsum",
"analysis" : "analysis",
"comment" : "comment",
"entity" : {
"id" : "5000123",
"code" : "01-BRDX",
"name" : "Bordeaux",
"legalName" : "Customer care",
"division" : {
"id" : "5000123",
"name" : "Rhone-Alpes",
"code" : "RA",
"group" : {
"id" : "5000123",
"name" : "West",
"code" : "WST",
"serviceId" : "5000123"
},
"groupId" : "5000123",
"companyId" : "5000123"
},
"divisionId" : "5000123",
"divisionCode" : "01-DIV",
"companyId" : "5000123",
"endDate" : "2020-01-23T04:56:07Z"
},
"entityId" : "entityId",
"projectType" : "{}",
"activities" : [ {
"id" : "5000123",
"code" : "code",
"name" : "name"
}, {
"id" : "5000123",
"code" : "code",
"name" : "name"
} ]
},
"category" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"subCategory" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"subCategoryLevel2" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"projectState" : {
"id" : "id",
"code" : "PRO",
"name" : "Production",
"companyCode" : "AKSAS",
"companyId" : "5000123"
},
"year" : {
"id" : "5000123",
"code" : "2025",
"name" : "Text",
"previousYearId" : "5000123",
"validityEndDate" : "2020-01-23T04:56:07Z",
"disabledDate" : "2020-01-23T04:56:07Z",
"repeating" : "{}"
}
},
"projectId" : "PRJ_1",
"phaseId" : "5000123",
"subPhaseId" : "5000123",
"projectTaskId" : "5000123",
"type" : "{}",
"validated" : true,
"refused" : true,
"done" : true,
"public" : true,
"period" : "{}",
"color" : "#FF0000",
"actionCode" : {
"id" : "5000123",
"name" : "ADD"
},
"actionCodeId" : "5000123",
"actionCode2" : {
"id" : "5000123",
"code" : "ADD",
"name" : "ADD"
},
"actionCode2Id" : "5000123",
"tags" : [ {
"id" : "5000123",
"companyId" : "5000123",
"type" : "{}",
"code" : "ERR",
"name" : "ISSUE",
"comment" : "Lorem ipsum",
"color" : "#56b7c",
"icon" : "fa fa-plus",
"endDate" : "2000-06-21T04:56:07.000+00:00",
"objectId" : "5000123",
"action" : "{}"
}, {
"id" : "5000123",
"companyId" : "5000123",
"type" : "{}",
"code" : "ERR",
"name" : "ISSUE",
"comment" : "Lorem ipsum",
"color" : "#56b7c",
"icon" : "fa fa-plus",
"endDate" : "2000-06-21T04:56:07.000+00:00",
"objectId" : "5000123",
"action" : "{}"
} ],
"quotationId" : "5000123",
"taskId" : "5000123",
"dayMode" : true,
"fullDay" : true,
"onlineMeeting" : true,
"dayPart" : 0.5,
"changeTracking" : {
"createdTime" : "2000-06-21T04:56:07.000+00:00",
"createdBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"createdById" : "5000123",
"modificationTime" : "2000-06-21T04:56:07.000+00:00",
"modificationBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"modificationById" : "5000123"
},
"location" : "Paris"
}
2.12. Remote Work
2.12.1. Analysis dashboard for remote work
POST |
/remote-work-entries/analysis |
Description
Analysis dashboard for remote work
DMF required:
-
DMF A40911: Api Workforce / Remote Work Records / Analysis
-
DMF 1513__: Dashboards / Remote Work
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
criteria |
Search criteria containing the filters (criteria), the groups (to group by the search results) and the view (to specify the specific display). RemoteWorkEntryAnalysis |
- |
Return Type
array[AnalysisResult]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Successful analysis meeting the filter, group by groups and displayed by the view. |
List[AnalysisResult] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"filter" : {
"axeType" : "axeType",
"projectId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"projectCompanyCode" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"projectDivisionGroupId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"projectDivisionId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"projectEstablishmentId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"projectDepartmentId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"projectActivityId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"projectFamilyId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"projectSubFamilyId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"projectSubFamily2Id" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"projectVintageId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"projectManagerId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"projectSalesManagerId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"projectFinancialManagerId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"projectProductionManagerId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"projectCampaignId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"projectState" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"projectMarketId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"phaseId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"subPhaseId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"customerId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"customerFamilyId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"customerSubFamilyId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"customerGrouping1" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"customerGrouping2" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"customerSectorId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"customerState" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"customerCountryId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"customerRegionId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"customerAccountManagerId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"customerSalesmanId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"customerAccountManagerSupervisorId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"customerSalesmanSupervisorId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"groupCustomer" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"prospect" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"employeeId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"companyId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"entityId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"divisionId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"date" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
},
"excludeResourceWhoHaveLeftTheCompany" : true,
"managerCriteria" : {
"managerId" : "5000123",
"includeManager" : true,
"includeResourcesTwoManagementLevelsBelow" : true
}
},
"view" : {
"dateLike" : "MONTH"
},
"objects" : [ "REMOTE_WORK_BY_MONTH", "REMOTE_WORK_BY_MONTH" ],
"group" : {
"by" : [ null, null ],
"axes" : {
"example" : [ "PROJECT_ACTIVITY_NAME", "PROJECT_ACTIVITY_ID" ]
}
}
}
2.12.2. Declare a recurring remote work for a period
POST |
/employees/{employee_id}/remote-work-entries/declare-recurring |
Description
Declare a recurring remote work for a period
DMF required:
-
DMF A40910: Api Workforce / Remote Work Records / Declare Recurring
-
DMF 1615__: Tools / Remote Work
-
DMF 190121: Web Portal / Timesheets & Schedules Menu / Remote Work
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
employee_id |
Id of an employee |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
recurringRemoteWork |
The recurring remote work declaration RecurringRemoteWork |
X |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Successful declaration of recurring remote work |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"sunday" : {
"afternoon" : true,
"morning" : false
},
"saturday" : {
"afternoon" : true,
"morning" : false
},
"tuesday" : {
"afternoon" : true,
"morning" : false
},
"endDate" : "2020-01-31T23:59:59Z",
"wednesday" : {
"afternoon" : true,
"morning" : false
},
"thursday" : {
"afternoon" : true,
"morning" : false
},
"friday" : {
"afternoon" : true,
"morning" : false
},
"startDate" : "2020-01-31T23:59:59Z",
"monday" : {
"afternoon" : true,
"morning" : false
}
}
2.12.3. Delete a remote work entry
DELETE |
/employees/{employee_id}/remote-work-entries/{remote_work_entry_id} |
Description
Delete a remote work entry
DMF required:
-
DMF A40903: Api Workforce / Remote Work Records / Delete
-
DMF 1615__: Tools / Remote Work
-
DMF 190121: Web Portal / Timesheets & Schedules Menu / Remote Work
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
employee_id |
Id of an employee |
X |
null |
|
remote_work_entry_id |
The id of the remote work entry |
X |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Successfully deleted |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.12.4. Get the list of remote work entries of an employee
GET |
/employees/{employee_id}/remote-work-entries |
Description
Get all the remote work entries of an employee
DMF required:
-
DMF A40904: Api Workforce / Remote Work Records / Search
-
DMF 1615__: Tools / Remote Work
-
DMF 161501: Tools / Remote Work / Search
-
DMF 190121: Web Portal / Timesheets & Schedules Menu / Remote Work
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
employee_id |
Id of an employee |
X |
null |
Return Type
array[RemoteWorkEntry]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
All the remote work entries of an employee having this id |
List[RemoteWorkEntry] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.12.5. Get a remote work entry of an employee by its id
GET |
/employees/{employee_id}/remote-work-entries/{remote_work_entry_id} |
Description
Get a remote work entry of an employee by its id
DMF required:
-
DMF A40906: Api Workforce / Remote Work Records / Info
-
DMF 1615__: Tools / Remote Work
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
employee_id |
Id of an employee |
X |
null |
|
remote_work_entry_id |
The id of the remote work entry |
X |
null |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
The remote work entry |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.12.6. Create remote work entry for an employee
PUT |
/employees/{employee_id}/remote-work-entries |
Description
Create remote work entry for an employee. If there’s already an entry for the employee and the date, it will be replaced.
DMF required:
-
DMF A40901: Api Workforce / Remote Work Records / Insert
-
DMF 1615__: Tools / Remote Work
-
DMF 190121: Web Portal / Timesheets & Schedules Menu / Remote Work
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
employee_id |
Id of an employee |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
remoteWorkEntry |
The remote work entry to insert RemoteWorkEntry |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
The remote work entry created |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"id" : "5000123",
"date" : "2020-01-31T23:59:59Z",
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"morning" : false,
"afternoon" : true
}
2.12.7. Get the list of the remote work entries
POST |
/remote-work-entries/search |
Description
Get the list of the remote work entries
DMF required:
-
DMF A40904: Api Workforce / Remote Work Records / Search
-
DMF 1615__: Tools / Remote Work
-
DMF 161501: Tools / Remote Work / Search
-
DMF 190121: Web Portal / Timesheets & Schedules Menu / Remote Work
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
criteria |
The criteria RemoteWorkEntryCriteria |
X |
Return Type
array[RemoteWorkEntry]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Remote work entries meeting the search criteria |
List[RemoteWorkEntry] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"date" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
},
"companyId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"employeeId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"id" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"employeeCode" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"readOption" : {
"options" : [ "EMPLOYEE", "EMPLOYEE" ]
}
}
2.12.8. Update remote work entry for an employee
POST |
/employees/{employee_id}/remote-work-entries/{remote_work_entry_id} |
Description
Update remote work entry for an employee
DMF required:
-
DMF A40902: Api Workforce / Remote Work Records / Update
-
DMF 1615__: Tools / Remote Work
-
DMF 190121: Web Portal / Timesheets & Schedules Menu / Remote Work
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
employee_id |
Id of an employee |
X |
null |
|
remote_work_entry_id |
The id of the remote work entry |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
remoteWorkEntry |
The remote work entry to update RemoteWorkEntry |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
A remote work entry having this id |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"id" : "5000123",
"date" : "2020-01-31T23:59:59Z",
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"morning" : false,
"afternoon" : true
}
2.13. Schedules
2.13.1. Create a schedule fluently
PUT |
/fluent/schedule |
Description
Create a schedule fluently using the list of parameters below.
DMF required:
-
DMF A40401: Api Workforce / Schedules / Insert
-
DMF 060201: Projects / Schedules / New
-
DMF 190402: Web Portal / Schedules / Modify
-
DMF 250102: Project / Schedule View / New
-
DMF 250104: Project / Schedule View / Dissociate Scheduled Item
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
schedule |
The schedule to create ScheduleFluent |
- |
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Schedule successfully created |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJT_1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"subPhase" : {
"id" : "5000123",
"code" : "SB_1",
"name" : "Sub Phase 1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"order" : 1
},
"subPhaseId" : "5000123",
"projectTask" : {
"id" : "5000123",
"code" : "code",
"name" : "Team building"
},
"projectTaskId" : "5000123",
"id" : "id",
"guid" : "guid",
"type" : "SCHEDULE",
"date" : "2000-06-21T04:56:07.000+00:00",
"duration" : 2,
"unit" : "{}",
"durations" : {
"durationMinute" : 240,
"durationHourMinute" : 2.3,
"durationHour" : 2.7,
"durationDay" : 0.25
},
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"actionCode" : {
"id" : "5000123",
"name" : "ADD"
},
"actionCodeId" : "130012",
"comment" : "comment",
"location" : "Paris",
"validated" : true,
"changeTracking" : {
"createdTime" : "2000-06-21T04:56:07.000+00:00",
"createdBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"createdById" : "5000123",
"modificationTime" : "2000-06-21T04:56:07.000+00:00",
"modificationBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"modificationById" : "5000123"
},
"taskId" : "5000123",
"description" : "Lorem ipsum",
"done" : false,
"formConfig" : {
"type" : "{}",
"fields" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"controls" : {
"key" : {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}
},
"insertable" : true,
"editable" : false,
"deletable" : false,
"formSearchHidden" : false
},
"salesOrderLine" : {
"id" : "5000123",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJT_001",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"subPhase" : {
"id" : "5000123",
"code" : "SB_1",
"name" : "Sub Phase 1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"order" : 1
},
"subPhaseId" : "51000122",
"projectTask" : {
"id" : "5000123",
"code" : "code",
"name" : "Team building",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJT_001",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"subPhase" : {
"id" : "5000123",
"code" : "SB_1",
"name" : "Sub Phase 1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"order" : 1
},
"subPhaseId" : "51000122",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"order" : 2,
"startDate" : "2000-06-21T04:56:07.000+00:00",
"endDate" : "2000-06-21T04:56:07.000+00:00",
"description" : "description"
},
"projectTaskId" : "5000123",
"managementObjectId" : "5000123",
"name" : "Helpdesk",
"quantity" : 3,
"unitPriceCurrency" : 36.32,
"unitPrice" : 40,
"amountTotalCurrency" : 1200,
"amountTotal" : 1200,
"rankNumber" : 2,
"action" : "{}",
"complementName" : "Lorem ipsum",
"afterTaxAmountTotalCurrency" : 1500,
"afterTaxAmountTotal" : 1500,
"generalAccount" : "411000",
"totalPriceCurrency" : 1200,
"totalPrice" : 1200,
"additionalFreeFields" : {
"field1" : "Free field",
"field2" : "Free field",
"field3" : "Free field",
"field4" : "Free field",
"field5" : "Free field"
},
"resource" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"resourceId" : "resourceId",
"formConfig" : {
"type" : "{}",
"fields" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"controls" : {
"key" : {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}
},
"insertable" : true,
"editable" : false,
"deletable" : false,
"formSearchHidden" : false
}
},
"quotationId" : "5000123",
"salesOrderLineId" : "5000123",
"publication" : "2020-01-31T23:59:59Z",
"period" : "DAY",
"endDate" : "2020-01-31T23:59:59Z",
"dayMode" : true,
"tags" : [ {
"id" : "5000123",
"companyId" : "5000123",
"type" : "{}",
"code" : "ERR",
"name" : "ISSUE",
"comment" : "Lorem ipsum",
"color" : "#56b7c",
"icon" : "fa fa-plus",
"endDate" : "2000-06-21T04:56:07.000+00:00",
"objectId" : "5000123",
"action" : "{}"
}, {
"id" : "5000123",
"companyId" : "5000123",
"type" : "{}",
"code" : "ERR",
"name" : "ISSUE",
"comment" : "Lorem ipsum",
"color" : "#56b7c",
"icon" : "fa fa-plus",
"endDate" : "2000-06-21T04:56:07.000+00:00",
"objectId" : "5000123",
"action" : "{}"
} ],
"dayPart" : 0.5,
"onlineMeeting" : true,
"siteId" : "5000123",
"color" : "#FF0000",
"employeeCode" : "CASH",
"customerCode" : "CUSTOM_01",
"projectCode" : "PROJECT_001",
"phaseCode" : "PH_1",
"subPhaseCode" : "SB_1",
"projectTaskCode" : "TASK1"
}
2.13.2. Create a schedule with options
PUT |
/schedules/create-options |
Description
Create a schedule with additional options. These are listed in the link below.
DMF required:
-
DMF A40401: Api Workforce / Schedules / Insert
-
DMF 060201: Projects / Schedules / New
-
DMF 190402: Web Portal / Schedules / Modify
-
DMF 250102: Project / Schedule View / New
-
DMF 250104: Project / Schedule View / Dissociate Scheduled Item
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
scheduleCreateOptions |
Schedule to create ScheduleCreateParamHolder |
- |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Schedule successfully created |
List[[string]] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"schedule" : {
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJT_1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"subPhase" : {
"id" : "5000123",
"code" : "SB_1",
"name" : "Sub Phase 1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"order" : 1
},
"subPhaseId" : "5000123",
"projectTask" : {
"id" : "5000123",
"code" : "code",
"name" : "Team building"
},
"projectTaskId" : "5000123",
"id" : "id",
"guid" : "guid",
"type" : "SCHEDULE",
"date" : "2000-06-21T04:56:07.000+00:00",
"duration" : 2,
"unit" : "{}",
"durations" : {
"durationMinute" : 240,
"durationHourMinute" : 2.3,
"durationHour" : 2.7,
"durationDay" : 0.25
},
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"actionCode" : {
"id" : "5000123",
"name" : "ADD"
},
"actionCodeId" : "130012",
"comment" : "comment",
"location" : "Paris",
"validated" : true,
"changeTracking" : {
"createdTime" : "2000-06-21T04:56:07.000+00:00",
"createdBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"createdById" : "5000123",
"modificationTime" : "2000-06-21T04:56:07.000+00:00",
"modificationBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"modificationById" : "5000123"
},
"taskId" : "5000123",
"description" : "Lorem ipsum",
"done" : false,
"formConfig" : {
"type" : "{}",
"fields" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"controls" : {
"key" : {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}
},
"insertable" : true,
"editable" : false,
"deletable" : false,
"formSearchHidden" : false
},
"salesOrderLine" : {
"id" : "5000123",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJT_001",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"subPhase" : {
"id" : "5000123",
"code" : "SB_1",
"name" : "Sub Phase 1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"order" : 1
},
"subPhaseId" : "51000122",
"projectTask" : {
"id" : "5000123",
"code" : "code",
"name" : "Team building",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJT_001",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"subPhase" : {
"id" : "5000123",
"code" : "SB_1",
"name" : "Sub Phase 1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"order" : 1
},
"subPhaseId" : "51000122",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"order" : 2,
"startDate" : "2000-06-21T04:56:07.000+00:00",
"endDate" : "2000-06-21T04:56:07.000+00:00",
"description" : "description"
},
"projectTaskId" : "5000123",
"managementObjectId" : "5000123",
"name" : "Helpdesk",
"quantity" : 3,
"unitPriceCurrency" : 36.32,
"unitPrice" : 40,
"amountTotalCurrency" : 1200,
"amountTotal" : 1200,
"rankNumber" : 2,
"action" : "{}",
"complementName" : "Lorem ipsum",
"afterTaxAmountTotalCurrency" : 1500,
"afterTaxAmountTotal" : 1500,
"generalAccount" : "411000",
"totalPriceCurrency" : 1200,
"totalPrice" : 1200,
"additionalFreeFields" : {
"field1" : "Free field",
"field2" : "Free field",
"field3" : "Free field",
"field4" : "Free field",
"field5" : "Free field"
},
"resource" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"resourceId" : "resourceId",
"formConfig" : {
"type" : "{}",
"fields" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"controls" : {
"key" : {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}
},
"insertable" : true,
"editable" : false,
"deletable" : false,
"formSearchHidden" : false
}
},
"quotationId" : "5000123",
"salesOrderLineId" : "5000123",
"publication" : "2020-01-31T23:59:59Z",
"period" : "DAY",
"endDate" : "2020-01-31T23:59:59Z",
"dayMode" : true,
"tags" : [ {
"id" : "5000123",
"companyId" : "5000123",
"type" : "{}",
"code" : "ERR",
"name" : "ISSUE",
"comment" : "Lorem ipsum",
"color" : "#56b7c",
"icon" : "fa fa-plus",
"endDate" : "2000-06-21T04:56:07.000+00:00",
"objectId" : "5000123",
"action" : "{}"
}, {
"id" : "5000123",
"companyId" : "5000123",
"type" : "{}",
"code" : "ERR",
"name" : "ISSUE",
"comment" : "Lorem ipsum",
"color" : "#56b7c",
"icon" : "fa fa-plus",
"endDate" : "2000-06-21T04:56:07.000+00:00",
"objectId" : "5000123",
"action" : "{}"
} ],
"dayPart" : 0.5,
"onlineMeeting" : true,
"siteId" : "5000123",
"color" : "#FF0000"
},
"allowSaturday" : false,
"allowPublicHoliday" : true,
"applyEmployeeWeek" : false,
"allowSunday" : true
}
2.13.3. Delete schedules in a time slot
POST |
/schedules/delete |
Description
Delete all schedules within the given interval specified in the query parameter.
You must filter by at least one employee or project by entering in the body: employeeId or employeeCode or projectCode.
DMF required:
-
DMF A40403: Api Workforce / Schedules / Delete
-
DMF 060203: Projects / Schedules / Delete
-
DMF 190403: Web Portal / Schedules / Delete
-
DMF 250110: Project / Schedule View / Delete Unvalidated Schedule
-
DMF 250111: Project / Schedule View / Delete Validated Schedule
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
criteria |
Criteria that you choose (employee ID, customer ID, etc…) ScheduleCriteria |
X |
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
from |
Start date of the search interval |
- |
null |
|
to |
End date of the search interval |
- |
null |
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Schedules successfully deleted |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"modificationDateFrom" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
},
"phaseId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"creationDateFrom" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
},
"description" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"employeeCode" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"readOption" : {
"options" : [ "EMPLOYEE", "EMPLOYEE" ]
},
"creationDateTo" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
},
"employeeIdOnVacation" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"validated" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"scheduleCriteriaType" : "scheduleCriteriaType",
"projectCode" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"customerId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"actionCode" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"id" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"phaseCode" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"subPhaseCode" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"quotationId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"employeeId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"done" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"projectTaskCode" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"projectLeave" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"projectTaskId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"modificationDateTo" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
},
"subPhaseId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"comment" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"location" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
}
}
2.13.4. Delete a schedule
DELETE |
/schedules/{schedule_id} |
Description
Delete the schedule matching specified ID.
DMF required:
-
DMF A40403: Api Workforce / Schedules / Delete
-
DMF 060203: Projects / Schedules / Delete
-
DMF 190403: Web Portal / Schedules / Delete
-
DMF 250110: Project / Schedule View / Delete Unvalidated Schedule
-
DMF 250111: Project / Schedule View / Delete Validated Schedule
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
schedule_id |
The id of the schedule |
X |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Delete successful |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.13.5. Delete schedules fluently in a time slot
POST |
/fluent/schedule/delete |
Description
Delete all schedules within the given interval specified in the query parameter.
You must filter by at least one employee or project by entering in the body: employeeId or employeeCode or projectCode.
DMF required:
-
DMF A40403: Api Workforce / Schedules / Delete
-
DMF 060203: Projects / Schedules / Delete
-
DMF 190403: Web Portal / Schedules / Delete
-
DMF 250110: Project / Schedule View / Delete Unvalidated Schedule
-
DMF 250111: Project / Schedule View / Delete Validated Schedule
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
criteria |
Criteria that you choose (action code, employee code, etc…) ScheduleCriteriaFluent |
X |
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
from |
Start date of the search interval |
- |
null |
|
to |
End date of the search interval |
- |
null |
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Schedule successfully deleted |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"id" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"employeeId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"employeeCode" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"actionCode" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"customerId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"projectCode" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"projectLeave" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"phaseId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"phaseCode" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"subPhaseId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"subPhaseCode" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"projectTaskId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"projectTaskCode" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"quotationId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"comment" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"location" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"description" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"creationDateFrom" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
},
"creationDateTo" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
},
"modificationDateFrom" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
},
"modificationDateTo" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
},
"validated" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"done" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"readOption" : {
"options" : [ "EMPLOYEE", "EMPLOYEE" ]
},
"scheduleCriteriaType" : "scheduleCriteriaType",
"employeeIdOnVacation" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
}
}
2.13.6. Duplicate a schedule with options
POST |
/schedules/duplicate |
Description
Duplicate a schedule with options like keep status, keep the date. These are listed in the link below.
DMF required:
-
DMF A40401: Api Workforce / Schedules / Insert
-
DMF 060201: Projects / Schedules / New
-
DMF 190402: Web Portal / Schedules / Modify
-
DMF 250102: Project / Schedule View / New
-
DMF 250104: Project / Schedule View / Dissociate Scheduled Item
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
paramHolder |
Parameters to duplicate the schedule ScheduleDuplicationParamHolder |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Ids of schedules duplicated |
List[[string]] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"date" : "2020-01-31T23:59:59Z",
"numberOfOccurrency" : 4,
"deleteOriginal" : true,
"allowSunday" : true,
"employeeIds" : "<5000142, 5000265, ...>",
"projectTaskId" : "5000123",
"allowSaturday" : false,
"allowPublicHoliday" : true,
"numberOfRepetition" : 2,
"until" : "2020-01-31T23:59:59Z",
"scheduleIds" : "<1100452, 1100236, ...>",
"occurrency" : 2
}
2.13.7. Fill in a schedule
POST |
/schedules/fill |
Description
Fill in a schedule to update several fields. Options to fill in the schedule are listed in the link below.
DMF required:
-
DMF A40401: Api Workforce / Schedules / Insert
-
DMF 060201: Projects / Schedules / New
-
DMF 190402: Web Portal / Schedules / Modify
-
DMF 250102: Project / Schedule View / New
-
DMF 250104: Project / Schedule View / Dissociate Scheduled Item
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
scheduleFillParamHolder |
The schedule to be filled in ScheduleFillParamHolder |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Schedule successfully filled in |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"schedule" : {
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJT_1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"subPhase" : {
"id" : "5000123",
"code" : "SB_1",
"name" : "Sub Phase 1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"order" : 1
},
"subPhaseId" : "5000123",
"projectTask" : {
"id" : "5000123",
"code" : "code",
"name" : "Team building"
},
"projectTaskId" : "5000123",
"id" : "id",
"guid" : "guid",
"type" : "SCHEDULE",
"date" : "2000-06-21T04:56:07.000+00:00",
"duration" : 2,
"unit" : "{}",
"durations" : {
"durationMinute" : 240,
"durationHourMinute" : 2.3,
"durationHour" : 2.7,
"durationDay" : 0.25
},
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"actionCode" : {
"id" : "5000123",
"name" : "ADD"
},
"actionCodeId" : "130012",
"comment" : "comment",
"location" : "Paris",
"validated" : true,
"changeTracking" : {
"createdTime" : "2000-06-21T04:56:07.000+00:00",
"createdBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"createdById" : "5000123",
"modificationTime" : "2000-06-21T04:56:07.000+00:00",
"modificationBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"modificationById" : "5000123"
},
"taskId" : "5000123",
"description" : "Lorem ipsum",
"done" : false,
"formConfig" : {
"type" : "{}",
"fields" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"controls" : {
"key" : {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}
},
"insertable" : true,
"editable" : false,
"deletable" : false,
"formSearchHidden" : false
},
"salesOrderLine" : {
"id" : "5000123",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJT_001",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"subPhase" : {
"id" : "5000123",
"code" : "SB_1",
"name" : "Sub Phase 1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"order" : 1
},
"subPhaseId" : "51000122",
"projectTask" : {
"id" : "5000123",
"code" : "code",
"name" : "Team building",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJT_001",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"subPhase" : {
"id" : "5000123",
"code" : "SB_1",
"name" : "Sub Phase 1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"order" : 1
},
"subPhaseId" : "51000122",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"order" : 2,
"startDate" : "2000-06-21T04:56:07.000+00:00",
"endDate" : "2000-06-21T04:56:07.000+00:00",
"description" : "description"
},
"projectTaskId" : "5000123",
"managementObjectId" : "5000123",
"name" : "Helpdesk",
"quantity" : 3,
"unitPriceCurrency" : 36.32,
"unitPrice" : 40,
"amountTotalCurrency" : 1200,
"amountTotal" : 1200,
"rankNumber" : 2,
"action" : "{}",
"complementName" : "Lorem ipsum",
"afterTaxAmountTotalCurrency" : 1500,
"afterTaxAmountTotal" : 1500,
"generalAccount" : "411000",
"totalPriceCurrency" : 1200,
"totalPrice" : 1200,
"additionalFreeFields" : {
"field1" : "Free field",
"field2" : "Free field",
"field3" : "Free field",
"field4" : "Free field",
"field5" : "Free field"
},
"resource" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"resourceId" : "resourceId",
"formConfig" : {
"type" : "{}",
"fields" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"controls" : {
"key" : {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}
},
"insertable" : true,
"editable" : false,
"deletable" : false,
"formSearchHidden" : false
}
},
"quotationId" : "5000123",
"salesOrderLineId" : "5000123",
"publication" : "2020-01-31T23:59:59Z",
"period" : "DAY",
"endDate" : "2020-01-31T23:59:59Z",
"dayMode" : true,
"tags" : [ {
"id" : "5000123",
"companyId" : "5000123",
"type" : "{}",
"code" : "ERR",
"name" : "ISSUE",
"comment" : "Lorem ipsum",
"color" : "#56b7c",
"icon" : "fa fa-plus",
"endDate" : "2000-06-21T04:56:07.000+00:00",
"objectId" : "5000123",
"action" : "{}"
}, {
"id" : "5000123",
"companyId" : "5000123",
"type" : "{}",
"code" : "ERR",
"name" : "ISSUE",
"comment" : "Lorem ipsum",
"color" : "#56b7c",
"icon" : "fa fa-plus",
"endDate" : "2000-06-21T04:56:07.000+00:00",
"objectId" : "5000123",
"action" : "{}"
} ],
"dayPart" : 0.5,
"onlineMeeting" : true,
"siteId" : "5000123",
"color" : "#FF0000"
},
"options" : { }
}
2.13.8. Retrieve a schedule by its ID
GET |
/schedules/{schedule_id} |
Description
Get the schedule matching the specified ID.
DMF required:
-
DMF A40406: Api Workforce / Schedules / Info
-
DMF 060204: Projects / Schedules / Search
-
DMF 190401: Web Portal / Schedules / Show
-
DMF 250101: Project / Schedule View / View
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
schedule_id |
The id of the schedule |
X |
null |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Schedule successfully loaded |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.13.9. Invalidate a schedule
POST |
/schedules/{schedule_id}/invalidate |
Description
Invalidate the schedule matching the specified ID.
DMF required:
-
DMF A40410: Api Workforce / Schedules / Validate
-
DMF 060202: Projects / Schedules / Modify
-
DMF 250114: Project / Schedule View / Validate
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
schedule_id |
The id of the schedule |
X |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Schedule successfully invalidated |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.13.10. Invalidate a list of schedules
POST |
/schedules/invalidate |
Description
Invalidate the list of schedules given in parameter.
DMF required:
-
DMF A40410: Api Workforce / Schedules / Validate
-
DMF 060202: Projects / Schedules / Modify
-
DMF 250114: Project / Schedule View / Validate
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
schedules_ids |
The ids of the schedules [string] |
X |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Schedules successfully invalidated |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
2.13.11. Mark a schedule as done
POST |
/schedules/{schedule_id}/done |
Description
Mark as done the schedule matching the specified ID.
DMF required:
-
DMF A40411: Api Workforce / Schedules / Mark As Done
-
DMF 060239: Projects / Schedules / Mark Schedule Assignment As Not Completed
-
DMF 250107: Project / Schedule View / Modify Allocation''s Done Indicator
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
schedule_id |
The id of the schedule |
X |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Schedule successfully marked as done |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.13.12. Mark a list of schedules as done
POST |
/schedules/done |
Description
Mark the list of schedules given in parameter as done.
DMF required:
-
DMF A40411: Api Workforce / Schedules / Mark As Done
-
DMF 060239: Projects / Schedules / Mark Schedule Assignment As Not Completed
-
DMF 250107: Project / Schedule View / Modify Allocation''s Done Indicator
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
schedules_ids |
The ids of the schedules [string] |
X |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Schedules successfully marked as done |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
2.13.13. Mark a schedule as private
POST |
/schedules/{schedule_id}/mark-as-private |
Description
Mark as private the schedule matching the specified ID.
DMF required:
-
DMF A40412: Api Workforce / Schedules / Mark As Public
-
DMF 060241: Projects / Schedules / Publish
-
DMF 250115: Project / Schedule View / Publish
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
schedule_id |
The id of the schedule |
X |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Schedule successfully marked as private |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.13.14. Mark a list of schedules as private
POST |
/schedules/mark-as-private |
Description
Mark as private a list of schedules given in parameter.
DMF required:
-
DMF A40412: Api Workforce / Schedules / Mark As Public
-
DMF 060241: Projects / Schedules / Publish
-
DMF 250115: Project / Schedule View / Publish
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
schedules_ids |
The ids of the schedules [string] |
X |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Schedules successfully marked as private |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
2.13.15. Mark a schedule as public
POST |
/schedules/{schedule_id}/mark-as-public |
Description
Mark as public the schedule matching the specified ID.
DMF required:
-
DMF A40412: Api Workforce / Schedules / Mark As Public
-
DMF 060241: Projects / Schedules / Publish
-
DMF 250115: Project / Schedule View / Publish
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
schedule_id |
The id of the schedule |
X |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Schedule successfully marked as public |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.13.16. Mark a list of schedules as public
POST |
/schedules/mark-as-public |
Description
Mark as public the schedules.
DMF required:
-
DMF A40412: Api Workforce / Schedules / Mark As Public
-
DMF 060241: Projects / Schedules / Publish
-
DMF 250115: Project / Schedule View / Publish
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
schedules_ids |
The ids of the schedules [string] |
X |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Schedules successfully marked as public |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
2.13.17. Mark a schedule as undone
POST |
/schedules/{schedule_id}/undone |
Description
Mark as undone the schedule matching the specified ID.
DMF required:
-
DMF A40416: Api Workforce / Schedules / Mark As Undone
-
DMF 250107: Project / Schedule View / Modify Allocation''s Done Indicator
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
schedule_id |
The id of the schedule |
X |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Schedule successfully undone |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.13.18. Mark a list of schedules as undone
POST |
/schedules/undone |
Description
Mark as undone the list of schedules given in parameter.
DMF required:
-
DMF A40416: Api Workforce / Schedules / Mark As Undone
-
DMF 250107: Project / Schedule View / Modify Allocation''s Done Indicator
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
schedules_ids |
The ids of the schedules [string] |
X |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Schedules successfully undone |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
2.13.19. Patch schedules
PATCH |
/schedules/batch-update |
Description
Patch schedules matching the specified IDs and using the list of parameters below.
DMF required:
-
DMF A40402: Api Workforce / Schedules / Update
-
DMF 060202: Projects / Schedules / Modify
-
DMF 190402: Web Portal / Schedules / Modify
-
DMF 250106: Project / Schedule View / Modify Undone Allocation
-
DMF 250108: Project / Schedule View / Modify Done Allocation
-
DMF 250103: Project / Schedule View / Reschedule
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
patch_holder |
List of patches to apply PatchHolder |
- |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Schedules successfully patched |
List[[string]] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"ids" : [ "ids", "ids" ],
"patchElements" : [ {
"op" : "ADD",
"path" : "path",
"from" : "from",
"value" : "{}"
}, {
"op" : "ADD",
"path" : "path",
"from" : "from",
"value" : "{}"
} ]
}
2.13.20. Pre-fill a schedule
POST |
/schedules/pre-fill |
Description
Pre-fill a previously created schedule with an object given in parameter.
DMF required:
-
DMF A40401: Api Workforce / Schedules / Insert
-
DMF 060201: Projects / Schedules / New
-
DMF 190402: Web Portal / Schedules / Modify
-
DMF 250102: Project / Schedule View / New
-
DMF 250104: Project / Schedule View / Dissociate Scheduled Item
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
schedule |
The schedule to be prefilled Schedule |
X |
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
object_type |
The type of object (see SchedulePreFillObjectType or TimesheetPreFillObjectType) |
- |
null |
|
object_id |
The id of the object used to fill in the schedule or the timesheet or … |
- |
null |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Schedule successfully pre-filled |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJT_1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"subPhase" : {
"id" : "5000123",
"code" : "SB_1",
"name" : "Sub Phase 1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"order" : 1
},
"subPhaseId" : "5000123",
"projectTask" : {
"id" : "5000123",
"code" : "code",
"name" : "Team building"
},
"projectTaskId" : "5000123",
"id" : "id",
"guid" : "guid",
"type" : "SCHEDULE",
"date" : "2000-06-21T04:56:07.000+00:00",
"duration" : 2,
"unit" : "{}",
"durations" : {
"durationMinute" : 240,
"durationHourMinute" : 2.3,
"durationHour" : 2.7,
"durationDay" : 0.25
},
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"actionCode" : {
"id" : "5000123",
"name" : "ADD"
},
"actionCodeId" : "130012",
"comment" : "comment",
"location" : "Paris",
"validated" : true,
"changeTracking" : {
"createdTime" : "2000-06-21T04:56:07.000+00:00",
"createdBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"createdById" : "5000123",
"modificationTime" : "2000-06-21T04:56:07.000+00:00",
"modificationBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"modificationById" : "5000123"
},
"taskId" : "5000123",
"description" : "Lorem ipsum",
"done" : false,
"formConfig" : {
"type" : "{}",
"fields" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"controls" : {
"key" : {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}
},
"insertable" : true,
"editable" : false,
"deletable" : false,
"formSearchHidden" : false
},
"salesOrderLine" : {
"id" : "5000123",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJT_001",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"subPhase" : {
"id" : "5000123",
"code" : "SB_1",
"name" : "Sub Phase 1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"order" : 1
},
"subPhaseId" : "51000122",
"projectTask" : {
"id" : "5000123",
"code" : "code",
"name" : "Team building",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJT_001",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"subPhase" : {
"id" : "5000123",
"code" : "SB_1",
"name" : "Sub Phase 1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"order" : 1
},
"subPhaseId" : "51000122",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"order" : 2,
"startDate" : "2000-06-21T04:56:07.000+00:00",
"endDate" : "2000-06-21T04:56:07.000+00:00",
"description" : "description"
},
"projectTaskId" : "5000123",
"managementObjectId" : "5000123",
"name" : "Helpdesk",
"quantity" : 3,
"unitPriceCurrency" : 36.32,
"unitPrice" : 40,
"amountTotalCurrency" : 1200,
"amountTotal" : 1200,
"rankNumber" : 2,
"action" : "{}",
"complementName" : "Lorem ipsum",
"afterTaxAmountTotalCurrency" : 1500,
"afterTaxAmountTotal" : 1500,
"generalAccount" : "411000",
"totalPriceCurrency" : 1200,
"totalPrice" : 1200,
"additionalFreeFields" : {
"field1" : "Free field",
"field2" : "Free field",
"field3" : "Free field",
"field4" : "Free field",
"field5" : "Free field"
},
"resource" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"resourceId" : "resourceId",
"formConfig" : {
"type" : "{}",
"fields" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"controls" : {
"key" : {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}
},
"insertable" : true,
"editable" : false,
"deletable" : false,
"formSearchHidden" : false
}
},
"quotationId" : "5000123",
"salesOrderLineId" : "5000123",
"publication" : "2020-01-31T23:59:59Z",
"period" : "DAY",
"endDate" : "2020-01-31T23:59:59Z",
"dayMode" : true,
"tags" : [ {
"id" : "5000123",
"companyId" : "5000123",
"type" : "{}",
"code" : "ERR",
"name" : "ISSUE",
"comment" : "Lorem ipsum",
"color" : "#56b7c",
"icon" : "fa fa-plus",
"endDate" : "2000-06-21T04:56:07.000+00:00",
"objectId" : "5000123",
"action" : "{}"
}, {
"id" : "5000123",
"companyId" : "5000123",
"type" : "{}",
"code" : "ERR",
"name" : "ISSUE",
"comment" : "Lorem ipsum",
"color" : "#56b7c",
"icon" : "fa fa-plus",
"endDate" : "2000-06-21T04:56:07.000+00:00",
"objectId" : "5000123",
"action" : "{}"
} ],
"dayPart" : 0.5,
"onlineMeeting" : true,
"siteId" : "5000123",
"color" : "#FF0000"
}
2.13.21. Publish a schedule
POST |
/schedules/publish |
Description
Publish a schedule using the context given as a parameter.
DMF required:
-
DMF A40405: Api Workforce / Schedules / Publish
-
DMF 050205: Inventory / Sold Products / Print
-
DMF 190404: Web Portal / Schedules / Print
-
DMF 250112: Project / Schedule View / Print
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
publish_context |
The context for publishing the schedule SchedulePublishParamHolder |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Published document |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"context" : {
"filters" : "Entity, Services, Employee, etc...",
"displayOptions" : "Weekend, Scheduled rate, Validated, etc...",
"contextType" : "Timesheet entries",
"currentView" : "HOME_PROJECT",
"startDate" : "2020-01-31T23:59:59Z",
"endDate" : "2020-01-31T23:59:59Z",
"selectedRessources" : [ "selectedRessources", "selectedRessources" ],
"selectedSchedules" : [ "selectedSchedules", "selectedSchedules" ]
},
"arguments" : {
"template" : {
"id" : "5000123",
"code" : "MODELE_EDITION_001",
"name" : "Edition model for my documents",
"type" : {
"code" : "TEMP01",
"name" : "Template one",
"modelId" : "5000123",
"modelDescription" : "Lorem Ipsum"
},
"publishType" : "{}",
"path" : "C://MyDoc/Template/modele_edition_001",
"endDate" : "2000-06-21T04:56:07.000+00:00",
"extensions" : ".pdf, .docx",
"defaultTemplate" : true,
"interactive" : true,
"order" : 1
},
"extension" : ".pdf",
"parameters" : [ {
"groupName" : "text_box",
"labelText" : "Detail BL",
"pattern" : "cl",
"nameField" : "DetailBL",
"selectionList" : [ {
"label" : "Bank transfer",
"value" : "BT"
}, {
"label" : "Bank transfer",
"value" : "BT"
} ],
"nameFieldNext" : "DetailCheckbox",
"value" : "checked",
"required" : true
}, {
"groupName" : "text_box",
"labelText" : "Detail BL",
"pattern" : "cl",
"nameField" : "DetailBL",
"selectionList" : [ {
"label" : "Bank transfer",
"value" : "BT"
}, {
"label" : "Bank transfer",
"value" : "BT"
} ],
"nameFieldNext" : "DetailCheckbox",
"value" : "checked",
"required" : true
} ],
"saveDocument" : true
}
}
2.13.22. Search a schedule with read options
POST |
/schedules/{schedule_id}/read |
Description
Get a schedule, with additional information of your choice (example:\
\ customer information).\nYou can add this information with Read Options.\
\ These are listed in the link below.
DMF required:
-
DMF A40406: Api Workforce / Schedules / Info
-
DMF 060204: Projects / Schedules / Search
-
DMF 190401: Web Portal / Schedules / Show
-
DMF 250101: Project / Schedule View / View
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
schedule_id |
The id of the schedule |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
read_option |
The read options for returned schedule ScheduleReadOption |
- |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Schedule successfully loaded |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"options" : [ "EMPLOYEE", "EMPLOYEE" ]
}
2.13.23. Search for schedules (with search criteria)
POST |
/schedules/search |
Description
Get the list of schedules matching the search criteria.
DMF required:
-
DMF A40404: Api Workforce / Schedules / Search
-
DMF 060204: Projects / Schedules / Search
-
DMF 190401: Web Portal / Schedules / Show
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
criteria |
Criteria that you choose (customer ID, location, etc…) ScheduleCriteria |
X |
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
from |
Start date of the search interval |
- |
null |
|
to |
End date of the search interval |
- |
null |
|
unit |
Unit of duration (Default value: UNIT_OF_EMPLOYEE) |
- |
null |
Return Type
array[Schedule]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Schedules successfully loaded |
List[Schedule] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"modificationDateFrom" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
},
"phaseId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"creationDateFrom" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
},
"description" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"employeeCode" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"readOption" : {
"options" : [ "EMPLOYEE", "EMPLOYEE" ]
},
"creationDateTo" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
},
"employeeIdOnVacation" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"validated" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"scheduleCriteriaType" : "scheduleCriteriaType",
"projectCode" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"customerId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"actionCode" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"id" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"phaseCode" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"subPhaseCode" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"quotationId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"employeeId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"done" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"projectTaskCode" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"projectLeave" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"projectTaskId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"modificationDateTo" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
},
"subPhaseId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"comment" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"location" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
}
}
2.13.24. Search for schedule locations
GET |
/schedules/locations/search |
Description
Get the list of schedule locations matching specified customer ID.
DMF required:
-
DMF A40401: Api Workforce / Schedules / Insert
-
DMF 060201: Projects / Schedules / New
-
DMF 190402: Web Portal / Schedules / Modify
-
DMF 250102: Project / Schedule View / New
-
DMF 250104: Project / Schedule View / Dissociate Scheduled Item
Parameters
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
customer_id |
ID of the customer |
- |
null |
|
tag |
Name of the tag |
- |
null |
Return Type
array[EventLocation]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Locations successfully loaded |
List[EventLocation] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.13.25. Search a schedule by its tags
POST |
/schedules/tags/search |
Description
Get the list of schedules having specified tags.
DMF required:
-
DMF A40401: Api Workforce / Schedules / Insert
-
DMF 060201: Projects / Schedules / New
-
DMF 190402: Web Portal / Schedules / Modify
-
DMF 250102: Project / Schedule View / New
-
DMF 250104: Project / Schedule View / Dissociate Scheduled Item
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
criteria |
Criteria that you choose (company ID, tag, etc…) TagCriteria |
- |
Return Type
array[Tag]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Schedules successfully loaded |
List[Tag] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"companyId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"code" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"name" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"id" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"tag" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"validity" : {
"type" : "{}",
"date" : "2000-06-21T04:56:07.000+00:00"
},
"type" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
}
}
2.13.26. Transfer a Schedule into timesheets
POST |
/schedules/{schedule_id}/transfer-in-timesheets |
Description
Transfer a Schedule into timesheets
DMF required:
-
DMF A40413: Api Workforce / Schedules / Transfer In Timesheet Entry
-
DMF 190406: Web Portal / Schedules / Transfer Timesheets
-
DMF 250123: Project / Schedule View / Transfer Schedules Into Timesheets
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
schedule_id |
The id of the schedule |
X |
null |
Header Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
X-ignore-warnings |
Do not return an error for warnings. Default value : false. |
- |
null |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Schedule successfully transferred |
List[[string]] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.13.27. Transfer one’s own schedule into timesheets.
POST |
/schedules/{schedule_id}/transfer-in-timesheets/mine |
Description
Transfer one’s own schedule into timesheets.
DMF required:
-
DMF A40417: Api Workforce / Schedules / Transfer My Timesheet Entry
-
DMF 190406: Web Portal / Schedules / Transfer Timesheets
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
schedule_id |
The id of the schedule |
X |
null |
Header Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
X-ignore-warnings |
Do not return an error for warnings. Default value : false. |
- |
null |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Schedule successfully transferred |
List[[string]] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.13.28. Transfer Schedules into timesheets
POST |
/schedules/transfer-in-timesheets |
Description
Transfer Schedules into timesheets
DMF required:
-
DMF A40413: Api Workforce / Schedules / Transfer In Timesheet Entry
-
DMF 190406: Web Portal / Schedules / Transfer Timesheets
-
DMF 250123: Project / Schedule View / Transfer Schedules Into Timesheets
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
scheduleIds |
Ids of schedule to transfer [string] |
- |
Header Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
X-ignore-warnings |
Do not return an error for warnings. Default value : false. |
- |
null |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Schedules successfully transferred |
List[[string]] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
2.13.29. Transfer one's own schedules to timesheets.
POST |
/schedules/transfer-in-timesheets/mine |
Description
Transfer one’s own schedules to timesheets.
DMF required:
-
DMF A40417: Api Workforce / Schedules / Transfer My Timesheet Entry
-
DMF 190406: Web Portal / Schedules / Transfer Timesheets
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
scheduleIds |
Ids of schedule to transfer [string] |
- |
Header Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
X-ignore-warnings |
Do not return an error for warnings. Default value : false. |
- |
null |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Schedules successfully transferred |
List[[string]] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
2.13.30. Update options on a schedule
POST |
/schedules/{schedule_id}/update-options |
Description
Update options on the schedule matching the specified ID and using the list of parameters below.
DMF required:
-
DMF A40402: Api Workforce / Schedules / Update
-
DMF 060202: Projects / Schedules / Modify
-
DMF 190402: Web Portal / Schedules / Modify
-
DMF 250106: Project / Schedule View / Modify Undone Allocation
-
DMF 250108: Project / Schedule View / Modify Done Allocation
-
DMF 250103: Project / Schedule View / Reschedule
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
schedule_id |
The id of the schedule |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
scheduleParamHolder |
The schedule to update ScheduleCreateParamHolder |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Schedule successfully updated |
List[[string]] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"schedule" : {
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJT_1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"subPhase" : {
"id" : "5000123",
"code" : "SB_1",
"name" : "Sub Phase 1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"order" : 1
},
"subPhaseId" : "5000123",
"projectTask" : {
"id" : "5000123",
"code" : "code",
"name" : "Team building"
},
"projectTaskId" : "5000123",
"id" : "id",
"guid" : "guid",
"type" : "SCHEDULE",
"date" : "2000-06-21T04:56:07.000+00:00",
"duration" : 2,
"unit" : "{}",
"durations" : {
"durationMinute" : 240,
"durationHourMinute" : 2.3,
"durationHour" : 2.7,
"durationDay" : 0.25
},
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"actionCode" : {
"id" : "5000123",
"name" : "ADD"
},
"actionCodeId" : "130012",
"comment" : "comment",
"location" : "Paris",
"validated" : true,
"changeTracking" : {
"createdTime" : "2000-06-21T04:56:07.000+00:00",
"createdBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"createdById" : "5000123",
"modificationTime" : "2000-06-21T04:56:07.000+00:00",
"modificationBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"modificationById" : "5000123"
},
"taskId" : "5000123",
"description" : "Lorem ipsum",
"done" : false,
"formConfig" : {
"type" : "{}",
"fields" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"controls" : {
"key" : {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}
},
"insertable" : true,
"editable" : false,
"deletable" : false,
"formSearchHidden" : false
},
"salesOrderLine" : {
"id" : "5000123",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJT_001",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"subPhase" : {
"id" : "5000123",
"code" : "SB_1",
"name" : "Sub Phase 1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"order" : 1
},
"subPhaseId" : "51000122",
"projectTask" : {
"id" : "5000123",
"code" : "code",
"name" : "Team building",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJT_001",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"subPhase" : {
"id" : "5000123",
"code" : "SB_1",
"name" : "Sub Phase 1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"order" : 1
},
"subPhaseId" : "51000122",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"order" : 2,
"startDate" : "2000-06-21T04:56:07.000+00:00",
"endDate" : "2000-06-21T04:56:07.000+00:00",
"description" : "description"
},
"projectTaskId" : "5000123",
"managementObjectId" : "5000123",
"name" : "Helpdesk",
"quantity" : 3,
"unitPriceCurrency" : 36.32,
"unitPrice" : 40,
"amountTotalCurrency" : 1200,
"amountTotal" : 1200,
"rankNumber" : 2,
"action" : "{}",
"complementName" : "Lorem ipsum",
"afterTaxAmountTotalCurrency" : 1500,
"afterTaxAmountTotal" : 1500,
"generalAccount" : "411000",
"totalPriceCurrency" : 1200,
"totalPrice" : 1200,
"additionalFreeFields" : {
"field1" : "Free field",
"field2" : "Free field",
"field3" : "Free field",
"field4" : "Free field",
"field5" : "Free field"
},
"resource" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"resourceId" : "resourceId",
"formConfig" : {
"type" : "{}",
"fields" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"controls" : {
"key" : {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}
},
"insertable" : true,
"editable" : false,
"deletable" : false,
"formSearchHidden" : false
}
},
"quotationId" : "5000123",
"salesOrderLineId" : "5000123",
"publication" : "2020-01-31T23:59:59Z",
"period" : "DAY",
"endDate" : "2020-01-31T23:59:59Z",
"dayMode" : true,
"tags" : [ {
"id" : "5000123",
"companyId" : "5000123",
"type" : "{}",
"code" : "ERR",
"name" : "ISSUE",
"comment" : "Lorem ipsum",
"color" : "#56b7c",
"icon" : "fa fa-plus",
"endDate" : "2000-06-21T04:56:07.000+00:00",
"objectId" : "5000123",
"action" : "{}"
}, {
"id" : "5000123",
"companyId" : "5000123",
"type" : "{}",
"code" : "ERR",
"name" : "ISSUE",
"comment" : "Lorem ipsum",
"color" : "#56b7c",
"icon" : "fa fa-plus",
"endDate" : "2000-06-21T04:56:07.000+00:00",
"objectId" : "5000123",
"action" : "{}"
} ],
"dayPart" : 0.5,
"onlineMeeting" : true,
"siteId" : "5000123",
"color" : "#FF0000"
},
"allowSaturday" : false,
"allowPublicHoliday" : true,
"applyEmployeeWeek" : false,
"allowSunday" : true
}
2.13.31. Validate a schedule
POST |
/schedules/{schedule_id}/validate |
Description
Validate the schedule matching the specified ID.
DMF required:
-
DMF A40410: Api Workforce / Schedules / Validate
-
DMF 060202: Projects / Schedules / Modify
-
DMF 250114: Project / Schedule View / Validate
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
schedule_id |
The id of the schedule |
X |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Schedule successfully validated |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.13.32. Validate a list of schedules
POST |
/schedules/validate |
Description
Validate the list of schedules given in parameter.
DMF required:
-
DMF A40410: Api Workforce / Schedules / Validate
-
DMF 060202: Projects / Schedules / Modify
-
DMF 250114: Project / Schedule View / Validate
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
schedules_ids |
The ids of the schedules [string] |
X |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Schedules successfully validated |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
2.14. Timesheets
2.14.1. Add completion to a timesheet entry
POST |
/timesheet-entries/completion/add |
Description
Add completion to the timesheet entry matching the specified ID
DMF required:
-
DMF A40501: Api Workforce / Time Recordings / Insert
-
DMF 060301: Projects / Timesheets / New
-
DMF 060302: Projects / Timesheets / Modify
-
DMF 060319: Projects / Timesheets / Report Timesheet Of Another Resource
-
DMF 190302: Web Portal / Timesheets / Modify
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
completion |
Details about the completion TimesheetEntryCompletion |
X |
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Return id of the completed timesheet entry. |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"id" : "5000123",
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}",
"title" : "GEN",
"phone" : "+33 6 04 04 04 05",
"mobilePhone" : "+33 6 00 00 00 01",
"email" : "myemail@bechmail.com",
"noTimesDunning" : true,
"assignmentMultiCompany" : false,
"modeTimeRecording" : 1,
"modeInputSchedule" : 3,
"timeRecordingInputMode" : "{}",
"scheduleInputMode" : "{}",
"executive" : true,
"generic" : true,
"candidate" : false,
"external" : false,
"managerMultiCompany" : true,
"employeeFunctions" : {
"allFunctions" : false,
"allSales" : true,
"allPurchases" : false,
"allOperational" : true,
"projectSalesManager" : false,
"projectFinanceManager" : true,
"projectProductionManager" : false,
"projectAccountManager" : true,
"projectAssignment" : false,
"projectPhaseManager" : true,
"projectSendOnMission" : false,
"salesSalesAssistant" : true,
"salesOrderAndEstimateTracking" : false,
"salesBillingSchedulesTracking" : true,
"purchasingBuyer" : false,
"timeRecording" : true,
"inputOfExpenseReport" : false,
"purchasesReceptionTracking" : false,
"inputSchedule" : false,
"CMMSContractSalesManager" : false,
"CMMSContractTechnicalManager" : false,
"CMMSMRAndEOManager" : false
},
"employeeHistory" : [ {
"id" : "5000123",
"employeeHistoryType" : "5000123",
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 7.42,
"weekHours" : 38.3,
"occupancyRate" : 0.8,
"manager" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"managerId" : "5000123",
"company" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo"
},
"companyId" : "5000123",
"directHourlyRate" : 10.42,
"standardHourlyRate" : 10,
"dailyCost" : 59.36,
"dailySellingPrice" : 80,
"entity" : "5000123",
"serviceRef" : {
"id" : "5000123",
"name" : "Professional services",
"code" : "PS"
},
"service" : "5000123",
"position" : "Developer",
"skillRef" : {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
},
"skill" : "5000123",
"family1" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family1Id" : "5000123",
"family2" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family2Id" : "5000123",
"family3" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family3Id" : "5000123",
"leave" : false,
"standardWeek" : {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
}
},
"standardWeekId" : "5000123",
"salary" : 1024
}, {
"id" : "5000123",
"employeeHistoryType" : "5000123",
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 7.42,
"weekHours" : 38.3,
"occupancyRate" : 0.8,
"manager" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"managerId" : "5000123",
"company" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo"
},
"companyId" : "5000123",
"directHourlyRate" : 10.42,
"standardHourlyRate" : 10,
"dailyCost" : 59.36,
"dailySellingPrice" : 80,
"entity" : "5000123",
"serviceRef" : {
"id" : "5000123",
"name" : "Professional services",
"code" : "PS"
},
"service" : "5000123",
"position" : "Developer",
"skillRef" : {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
},
"skill" : "5000123",
"family1" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family1Id" : "5000123",
"family2" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family2Id" : "5000123",
"family3" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"family3Id" : "5000123",
"leave" : false,
"standardWeek" : {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
}
},
"standardWeekId" : "5000123",
"salary" : 1024
} ],
"companyChanges" : [ {
"id" : "5000123",
"employeeId" : "500123",
"companyId" : "5000123",
"startDate" : "2020-01-23T04:56:07Z",
"endDate" : "2020-01-23T04:56:07Z",
"companyChangeState" : "{}",
"comment" : "Limpso usum"
}, {
"id" : "5000123",
"employeeId" : "500123",
"companyId" : "5000123",
"startDate" : "2020-01-23T04:56:07Z",
"endDate" : "2020-01-23T04:56:07Z",
"companyChangeState" : "{}",
"comment" : "Limpso usum"
} ],
"timeRecordingRules" : {
"id" : "5000123",
"employeeId" : "5000123",
"min" : 0,
"max" : 24,
"step" : 0.01,
"prettyStep" : 0.3,
"base" : 60,
"unit" : "H",
"unitDuration" : "{}",
"allowManualEntry" : true,
"employeeWeeks" : [ {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
},
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 8,
"dailyMinutes" : 10,
"weekHours" : 40,
"leave" : false
}, {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
},
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 8,
"dailyMinutes" : 10,
"weekHours" : 40,
"leave" : false
} ],
"closingDates" : [ {
"closingDate" : "2020-01-31T23:59:59Z",
"module" : "DATE_MODULE",
"beginningOfPeriod" : "2020-01-31T23:59:59Z",
"endOfPeriod" : "2020-01-31T23:59:59Z"
}, {
"closingDate" : "2020-01-31T23:59:59Z",
"module" : "DATE_MODULE",
"beginningOfPeriod" : "2020-01-31T23:59:59Z",
"endOfPeriod" : "2020-01-31T23:59:59Z"
} ],
"simpleDuration" : 750,
"completionMode" : "WEEKLY"
},
"scheduleRules" : {
"id" : "5000123",
"employeeId" : "5000123",
"min" : 0,
"max" : 24,
"step" : 0.01,
"prettyStep" : 0.3,
"base" : 60,
"unit" : "H",
"unitDuration" : "{}",
"allowManualEntry" : true,
"employeeWeeks" : [ {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
},
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 8,
"dailyMinutes" : 10,
"weekHours" : 40,
"leave" : false
}, {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week",
"companyCode" : "AKSAS",
"typicalDaysByWeekDay" : {
"key" : {
"morningMinutes" : 240,
"afternoonMinutes" : 240,
"morningStartTime" : 9,
"morningEndTime" : 13,
"afternoonStartTime" : 14,
"afternoonEndTime" : 18
}
},
"employeeId" : "5000123",
"from" : "2020-01-31T23:59:59Z",
"to" : "2020-01-31T23:59:59Z",
"dailyHours" : 8,
"dailyMinutes" : 10,
"weekHours" : 40,
"leave" : false
} ],
"closingDates" : [ {
"closingDate" : "2020-01-31T23:59:59Z",
"module" : "DATE_MODULE",
"beginningOfPeriod" : "2020-01-31T23:59:59Z",
"endOfPeriod" : "2020-01-31T23:59:59Z"
}, {
"closingDate" : "2020-01-31T23:59:59Z",
"module" : "DATE_MODULE",
"beginningOfPeriod" : "2020-01-31T23:59:59Z",
"endOfPeriod" : "2020-01-31T23:59:59Z"
} ],
"timestamped" : true
},
"businessCards" : [ {
"id" : "5000123",
"employeeId" : "5000123",
"cardNumber" : "XXXX XXXX XXXX 7568",
"encryptedCardNumber" : "0",
"name" : "Management card",
"type" : "{}",
"endDate" : "2020-01-31T23:59:59Z"
}, {
"id" : "5000123",
"employeeId" : "5000123",
"cardNumber" : "XXXX XXXX XXXX 7568",
"encryptedCardNumber" : "0",
"name" : "Management card",
"type" : "{}",
"endDate" : "2020-01-31T23:59:59Z"
} ],
"sector" : "Marketing",
"number" : "84",
"relations" : [ {
"id" : "5000123",
"relationType" : {
"id" : "5000123",
"code" : "TUTOR",
"name" : "Tutor for internship"
},
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"relatedEmployee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"relatedEmployeeId" : "5000123"
}, {
"id" : "5000123",
"relationType" : {
"id" : "5000123",
"code" : "TUTOR",
"name" : "Tutor for internship"
},
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"relatedEmployee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"relatedEmployeeId" : "5000123"
} ],
"employeeAbilities" : [ {
"id" : "5000123",
"skill" : {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
},
"level" : {
"id" : "5000123",
"code" : "EXP",
"name" : "Expert"
},
"startDate" : "2020-01-31T23:59:59Z",
"endDate" : "2020-01-31T23:59:59Z",
"employeeId" : "5000123"
}, {
"id" : "5000123",
"skill" : {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
},
"level" : {
"id" : "5000123",
"code" : "EXP",
"name" : "Expert"
},
"startDate" : "2020-01-31T23:59:59Z",
"endDate" : "2020-01-31T23:59:59Z",
"employeeId" : "5000123"
} ],
"jobType" : {
"id" : "5000123",
"companyCode" : "AKSAS",
"code" : "ADMIN",
"name" : "Administrator",
"category" : "{}",
"validity" : {
"type" : "{}",
"date" : "2000-06-21T04:56:07.000+00:00"
},
"default" : true
},
"jobTypeId" : "100245",
"address" : {
"id" : "id",
"line1" : "221B Baker Street",
"line2" : "2nd Floor",
"line3" : "First door at your right",
"cedex" : "CEDEX 14",
"postalCode" : "69002",
"city" : "London",
"country" : "FR (for 'FRANCE')",
"countryName" : "FRANCE",
"department" : "75 (for 'PARIS')",
"geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
"region" : "65 (for 'ILE DE FRANCE')",
"regionName" : "ILE DE FRANCE",
"phone" : "06 00 00 00 01",
"phone2" : "06 00 00 00 02",
"email" : "myemail@mail.com",
"mobilePhone" : "06 00 00 00 02",
"fax" : "04 00 00 00 07",
"webSite" : "mysite.com"
},
"addressId" : "5000123",
"birthDate" : "2000-06-21T04:56:07.000+00:00",
"customData" : {
"key" : {
"type" : "{}",
"value" : "Autoref 010520",
"name" : "Reference 4",
"realOrder" : 0,
"label" : "REFERENCE_4"
}
},
"color" : "#FF0000",
"targetTace" : 75,
"formConfig" : {
"type" : "{}",
"fields" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"controls" : {
"key" : {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}
},
"insertable" : true,
"editable" : false,
"deletable" : false,
"formSearchHidden" : false
},
"changeTracking" : {
"createdTime" : "2000-06-21T04:56:07.000+00:00",
"createdBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"createdById" : "5000123",
"modificationTime" : "2000-06-21T04:56:07.000+00:00",
"modificationBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"modificationById" : "5000123"
},
"vehicles" : [ {
"id" : "5000123",
"power" : 5,
"licensePlate" : "licensePlate",
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"expenseType" : {
"id" : "5000123",
"code" : "MEAL",
"description" : "Plane",
"km" : false,
"notRefundable" : true,
"icon" : "fa fa-plane",
"color" : "00ff40",
"receiptRequired" : false,
"commentRequired" : false,
"guestsRequired" : false,
"notRefundableEditable" : true,
"billableEditable" : true,
"amountEditable" : true,
"showQuantity" : false,
"showAdditionalComment" : false,
"showReceiptNumber" : true,
"showAmountCategory" : true,
"showBillable" : true,
"hideVat" : false,
"vat1Code" : "1",
"vat2Code" : "2",
"vat3Code" : "3",
"expenseThreshold" : 100,
"defaultAmount" : 45,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"expenseCategory" : "{}",
"expenseRebillableOptions" : "{}",
"showCustomRequest" : true,
"showAmountWithoutVat" : true,
"controlsBehavior" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"calculateKilometers" : true,
"freeEntryProhibited" : true,
"controls" : {
"enableDuplicate" : true,
"enablelOnNonWorkingDay" : true,
"enableOnDayWithLeaveRequest" : true,
"enableOnDayWithTimesheetOrSchedule" : true
},
"expenseThresholdExceededNoVat" : false
},
"expenseTypeId" : "5000123",
"endDate" : "2020-01-31T23:59:59Z"
}, {
"id" : "5000123",
"power" : 5,
"licensePlate" : "licensePlate",
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"expenseType" : {
"id" : "5000123",
"code" : "MEAL",
"description" : "Plane",
"km" : false,
"notRefundable" : true,
"icon" : "fa fa-plane",
"color" : "00ff40",
"receiptRequired" : false,
"commentRequired" : false,
"guestsRequired" : false,
"notRefundableEditable" : true,
"billableEditable" : true,
"amountEditable" : true,
"showQuantity" : false,
"showAdditionalComment" : false,
"showReceiptNumber" : true,
"showAmountCategory" : true,
"showBillable" : true,
"hideVat" : false,
"vat1Code" : "1",
"vat2Code" : "2",
"vat3Code" : "3",
"expenseThreshold" : 100,
"defaultAmount" : 45,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"expenseCategory" : "{}",
"expenseRebillableOptions" : "{}",
"showCustomRequest" : true,
"showAmountWithoutVat" : true,
"controlsBehavior" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"calculateKilometers" : true,
"freeEntryProhibited" : true,
"controls" : {
"enableDuplicate" : true,
"enablelOnNonWorkingDay" : true,
"enableOnDayWithLeaveRequest" : true,
"enableOnDayWithTimesheetOrSchedule" : true
},
"expenseThresholdExceededNoVat" : false
},
"expenseTypeId" : "5000123",
"endDate" : "2020-01-31T23:59:59Z"
} ],
"currentCompany" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo",
"legalName" : "legalName",
"siren" : "siren",
"siret" : "siret",
"calendar" : {
"id" : "5000123",
"code" : "Text",
"name" : "Text",
"default" : true,
"daysNotWorked" : [ 6, 6 ],
"holidays" : [ {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
}, {
"date" : "2000-06-21T04:56:07.000+00:00",
"type" : "FERIE"
} ]
},
"calendarId" : "calendarId",
"color" : "color",
"currency" : {
"id" : "5000123",
"name" : "Euro",
"code" : "EUR",
"order" : 17,
"euro" : true,
"euroRate" : 0.9678,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"euroRateStartDate" : "2020-01-23T04:56:07Z",
"euroRateEndDate" : "2020-01-23T04:56:07Z"
},
"currencyId" : "currencyId",
"address" : {
"id" : "id",
"line1" : "221B Baker Street",
"line2" : "2nd Floor",
"line3" : "First door at your right",
"cedex" : "CEDEX 14",
"postalCode" : "69002",
"city" : "London",
"country" : "FR (for 'FRANCE')",
"countryName" : "FRANCE",
"department" : "75 (for 'PARIS')",
"geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
"region" : "65 (for 'ILE DE FRANCE')",
"regionName" : "ILE DE FRANCE",
"phone" : "06 00 00 00 01",
"phone2" : "06 00 00 00 02",
"email" : "myemail@mail.com",
"mobilePhone" : "06 00 00 00 02",
"fax" : "04 00 00 00 07",
"webSite" : "mysite.com"
},
"addressId" : "addressId"
},
"currentCompanyId" : "5000123",
"bankingInformation" : {
"id" : "5000123",
"sepa" : {
"bankDetails" : {
"entity" : "30002",
"counter" : "550",
"accountNumber" : "0000157841Z",
"key" : "25",
"domiciliation" : "AURA"
},
"bic" : {
"country" : "FR (for 'FRANCE')",
"bank" : "DAAE",
"location" : "PP",
"branch" : "CCT"
},
"iban" : {
"country" : "FR (for 'FRANCE')",
"key" : "69",
"accountNumber" : "0000157841Z"
}
},
"noneSepa" : {
"defaultBankDetail" : false,
"beneficiary" : {
"holder" : {
"name" : "RITA",
"firstName" : "BRITA",
"accountType" : "{}",
"accountNumber" : "123456789"
},
"bank" : {
"bankName" : "UBA",
"bankName2" : "UBA",
"bankType" : "{}",
"bankCode" : "C8",
"bankAddress" : {
"id" : "id",
"line1" : "221B Baker Street",
"line2" : "2nd Floor",
"line3" : "First door at your right",
"cedex" : "CEDEX 14",
"postalCode" : "69002",
"city" : "London",
"country" : "FR (for 'FRANCE')",
"countryName" : "FRANCE",
"department" : "75 (for 'PARIS')",
"geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
"region" : "65 (for 'ILE DE FRANCE')",
"regionName" : "ILE DE FRANCE",
"phone" : "06 00 00 00 01",
"phone2" : "06 00 00 00 02",
"email" : "myemail@mail.com",
"mobilePhone" : "06 00 00 00 02",
"fax" : "04 00 00 00 07",
"webSite" : "mysite.com"
}
}
},
"intermediate" : {
"holder" : {
"name" : "RITA",
"firstName" : "BRITA",
"accountType" : "{}",
"accountNumber" : "123456789"
},
"bank" : {
"bankName" : "UBA",
"bankName2" : "UBA",
"bankType" : "{}",
"bankCode" : "C8",
"bankAddress" : {
"id" : "id",
"line1" : "221B Baker Street",
"line2" : "2nd Floor",
"line3" : "First door at your right",
"cedex" : "CEDEX 14",
"postalCode" : "69002",
"city" : "London",
"country" : "FR (for 'FRANCE')",
"countryName" : "FRANCE",
"department" : "75 (for 'PARIS')",
"geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
"region" : "65 (for 'ILE DE FRANCE')",
"regionName" : "ILE DE FRANCE",
"phone" : "06 00 00 00 01",
"phone2" : "06 00 00 00 02",
"email" : "myemail@mail.com",
"mobilePhone" : "06 00 00 00 02",
"fax" : "04 00 00 00 07",
"webSite" : "mysite.com"
}
}
}
},
"statusChangeDate" : "2000-06-21T04:56:07.000+00:00",
"statusChangeArgument" : {
"comment" : "Comment",
"status" : "{}"
},
"validator" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"validatorId" : "5000123",
"action" : "{}",
"type" : "{}"
},
"faxNumber" : "418 643 3210",
"phoneExtensionNumber" : "04 00 00 00 07"
},
"employeeId" : "5000123",
"year" : 2021,
"number" : 23,
"completionType" : "WEEK"
}
2.14.2. Add duration in minutes to this timesheet entry
POST |
/timesheet-entries/{timesheet_entry_id}/add-duration |
Description
Add positive or negative duration in minutes to this timesheet entry
DMF required:
-
DMF A40502: Api Workforce / Time Recordings / Update
-
DMF 060226: Projects / Schedules / View Schedule History
-
DMF 060302: Projects / Timesheets / Modify
-
DMF 060303: Projects / Timesheets / Delete
-
DMF 060328: Projects / Timesheets / Modify Time Without Weekly Time Control
-
DMF 060344: Projects / Timesheets / Modify Completed Timesheets
-
DMF 190302: Web Portal / Timesheets / Modify
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
timesheet_entry_id |
The id of the timesheet entry |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
durationToAdd |
The duration in minutes to add [double] |
- |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Duration successfully updated |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
1.2
2.14.3. Create a timesheet entry
POST |
/timesheet-entries/add |
Description
Create a timesheet entry using the list of parameters below.
DMF required:
-
DMF A40501: Api Workforce / Time Recordings / Insert
-
DMF 060301: Projects / Timesheets / New
-
DMF 060302: Projects / Timesheets / Modify
-
DMF 060319: Projects / Timesheets / Report Timesheet Of Another Resource
-
DMF 190302: Web Portal / Timesheets / Modify
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
timesheet_entry |
The timesheet entry to create TimesheetEntry |
X |
Header Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
X-ignore-warnings |
Do not return an error for warnings. Defaults to false. |
- |
null |
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Timesheet entry successfully created |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJT_1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"subPhase" : {
"id" : "5000123",
"code" : "SB_1",
"name" : "Sub Phase 1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"order" : 1
},
"subPhaseId" : "5000123",
"projectTask" : {
"id" : "5000123",
"code" : "code",
"name" : "Team building"
},
"projectTaskId" : "5000123",
"id" : "id",
"guid" : "guid",
"type" : "SCHEDULE",
"date" : "2000-06-21T04:56:07.000+00:00",
"duration" : 2,
"unit" : "{}",
"durations" : {
"durationMinute" : 240,
"durationHourMinute" : 2.3,
"durationHour" : 2.7,
"durationDay" : 0.25
},
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"actionCode" : {
"id" : "5000123",
"name" : "ADD"
},
"actionCodeId" : "130012",
"comment" : "comment",
"location" : "Paris",
"validated" : true,
"changeTracking" : {
"createdTime" : "2000-06-21T04:56:07.000+00:00",
"createdBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"createdById" : "5000123",
"modificationTime" : "2000-06-21T04:56:07.000+00:00",
"modificationBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"modificationById" : "5000123"
},
"taskId" : "5000123",
"actionCode2" : {
"id" : "5000123",
"code" : "ADD",
"name" : "ADD"
},
"actionCode2Id" : "5000123",
"approval" : "BRUT",
"approvalLabel" : "Refused",
"completionDate" : "2000-06-21T04:56:07.000+00:00",
"formConfig" : {
"type" : "{}",
"fields" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"controls" : {
"key" : {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}
},
"insertable" : true,
"editable" : false,
"deletable" : false,
"formSearchHidden" : false
}
}
2.14.4. Create a timesheet entry on a specific object
POST |
/timesheet-entries/{object_type}/{object_id}/create |
Description
Create a timesheet entry on a specific object using the list of parameters below.
DMF required:
-
DMF A40501: Api Workforce / Time Recordings / Insert
-
DMF 060301: Projects / Timesheets / New
-
DMF 060302: Projects / Timesheets / Modify
-
DMF 060319: Projects / Timesheets / Report Timesheet Of Another Resource
-
DMF 190302: Web Portal / Timesheets / Modify
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
object_type |
The type of object TimesheetCreateObjectType |
X |
null |
|
object_id |
The id of the object |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
timesheet_entry |
The timesheet entry to create TimesheetEntry |
X |
Header Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
X-ignore-warnings |
Do not return an error for warnings. Defaults to false. |
- |
null |
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
201 |
Timesheet entry successfully created |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJT_1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"subPhase" : {
"id" : "5000123",
"code" : "SB_1",
"name" : "Sub Phase 1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"order" : 1
},
"subPhaseId" : "5000123",
"projectTask" : {
"id" : "5000123",
"code" : "code",
"name" : "Team building"
},
"projectTaskId" : "5000123",
"id" : "id",
"guid" : "guid",
"type" : "SCHEDULE",
"date" : "2000-06-21T04:56:07.000+00:00",
"duration" : 2,
"unit" : "{}",
"durations" : {
"durationMinute" : 240,
"durationHourMinute" : 2.3,
"durationHour" : 2.7,
"durationDay" : 0.25
},
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"actionCode" : {
"id" : "5000123",
"name" : "ADD"
},
"actionCodeId" : "130012",
"comment" : "comment",
"location" : "Paris",
"validated" : true,
"changeTracking" : {
"createdTime" : "2000-06-21T04:56:07.000+00:00",
"createdBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"createdById" : "5000123",
"modificationTime" : "2000-06-21T04:56:07.000+00:00",
"modificationBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"modificationById" : "5000123"
},
"taskId" : "5000123",
"actionCode2" : {
"id" : "5000123",
"code" : "ADD",
"name" : "ADD"
},
"actionCode2Id" : "5000123",
"approval" : "BRUT",
"approvalLabel" : "Refused",
"completionDate" : "2000-06-21T04:56:07.000+00:00",
"formConfig" : {
"type" : "{}",
"fields" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"controls" : {
"key" : {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}
},
"insertable" : true,
"editable" : false,
"deletable" : false,
"formSearchHidden" : false
}
}
2.14.5. Cancel completion
POST |
/timesheet-entries/completion/cancel |
Description
Cancel completion for the list of timesheet entries given in parameters.
DMF required:
-
DMF A40512: Api Workforce / Time Recordings / Cancel Validation
-
DMF 060307: Projects / Timesheets / Validate
-
DMF 060360: Projects / Timesheets / Cancel Completion Of My Timesheets
-
DMF 060341: Projects / Timesheets / Cancel Validation
-
DMF 191709: Web Portal / Employees Timesheets Validation / Cancel Timesheet Validation
-
DMF 191710: Web Portal / Employees Timesheets Validation / Cancel Validation For Billed Timesheet
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
ids |
Ids of timesheet entries to cancel completion [string] |
- |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Completion successfully cancelled |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
2.14.6. Cancel the validation of timesheet entries
POST |
/timesheet-entries/cancel-validation |
Description
Cancel the validation of the list of timesheet entries given in parameters.
DMF required:
-
DMF A40512: Api Workforce / Time Recordings / Cancel Validation
-
DMF 060307: Projects / Timesheets / Validate
-
DMF 060360: Projects / Timesheets / Cancel Completion Of My Timesheets
-
DMF 060341: Projects / Timesheets / Cancel Validation
-
DMF 191709: Web Portal / Employees Timesheets Validation / Cancel Timesheet Validation
-
DMF 191710: Web Portal / Employees Timesheets Validation / Cancel Validation For Billed Timesheet
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
idents |
Ids of timesheet entries [string] |
- |
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Number of canceled timesheet entries |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
2.14.7. Create a Quick Entry from a Timesheet entry
PUT |
/timesheet-entries/{timesheet_entry_id}/quick-entries |
Description
Create a Quick Entry from a Timesheet entry
DMF required:
-
DMF A40506: Api Workforce / Time Recordings / Info
-
DMF 060304: Projects / Timesheets / Search
-
DMF 190301: Web Portal / Timesheets / Show
-
DMF 190302: Web Portal / Timesheets / Modify
-
DMF 250122: Project / Schedule View / Show Timesheets
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
timesheet_entry_id |
The id of the timesheet entry |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
label |
The label for the Quick Entry [string] |
- |
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Timesheet entry Quick Entry successfully created |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
label_example
2.14.8. Batch create timesheet entries.
POST |
/timesheet-entries/batch-create |
Description
Batch create timesheet entries.
Nota : The saving of timesheets will be interrupted at the first error on a timesheet. The remaining part of the request, after the error, will be ignored.
DMF required:
-
DMF A40501: Api Workforce / Time Recordings / Insert
-
DMF 060301: Projects / Timesheets / New
-
DMF 060302: Projects / Timesheets / Modify
-
DMF 060319: Projects / Timesheets / Report Timesheet Of Another Resource
-
DMF 190302: Web Portal / Timesheets / Modify
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
TimesheetEntry |
All Timesheet entries to create TimesheetEntry |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
201 |
Timesheet entries successfully created |
List[[string]] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJT_1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"subPhase" : {
"id" : "5000123",
"code" : "SB_1",
"name" : "Sub Phase 1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"order" : 1
},
"subPhaseId" : "5000123",
"projectTask" : {
"id" : "5000123",
"code" : "code",
"name" : "Team building"
},
"projectTaskId" : "5000123",
"id" : "id",
"guid" : "guid",
"type" : "SCHEDULE",
"date" : "2000-06-21T04:56:07.000+00:00",
"duration" : 2,
"unit" : "{}",
"durations" : {
"durationMinute" : 240,
"durationHourMinute" : 2.3,
"durationHour" : 2.7,
"durationDay" : 0.25
},
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"actionCode" : {
"id" : "5000123",
"name" : "ADD"
},
"actionCodeId" : "130012",
"comment" : "comment",
"location" : "Paris",
"validated" : true,
"changeTracking" : {
"createdTime" : "2000-06-21T04:56:07.000+00:00",
"createdBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"createdById" : "5000123",
"modificationTime" : "2000-06-21T04:56:07.000+00:00",
"modificationBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"modificationById" : "5000123"
},
"taskId" : "5000123",
"actionCode2" : {
"id" : "5000123",
"code" : "ADD",
"name" : "ADD"
},
"actionCode2Id" : "5000123",
"approval" : "BRUT",
"approvalLabel" : "Refused",
"completionDate" : "2000-06-21T04:56:07.000+00:00",
"formConfig" : {
"type" : "{}",
"fields" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"controls" : {
"key" : {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}
},
"insertable" : true,
"editable" : false,
"deletable" : false,
"formSearchHidden" : false
}
}
2.14.9. Batch create timesheet entries on a specific object using the list of parameters below.
POST |
/timesheet-entries/{object_type}/{object_id}/batch-create |
Description
Batch create timesheet entries on a specific object using the list of parameters below.
Nota : The saving of timesheets will be interrupted at the first error on a timesheet. The remaining part of the request, after the error, will be ignored.
DMF required:
-
DMF A40501: Api Workforce / Time Recordings / Insert
-
DMF 060301: Projects / Timesheets / New
-
DMF 060302: Projects / Timesheets / Modify
-
DMF 060319: Projects / Timesheets / Report Timesheet Of Another Resource
-
DMF 190302: Web Portal / Timesheets / Modify
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
object_type |
The type of object TimesheetCreateObjectType |
X |
null |
|
object_id |
The id of the object |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
timesheetEntries |
All Timesheet entries to create TimesheetEntry |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
201 |
Timesheet entries has been successfully created |
List[[string]] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJT_1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"subPhase" : {
"id" : "5000123",
"code" : "SB_1",
"name" : "Sub Phase 1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"order" : 1
},
"subPhaseId" : "5000123",
"projectTask" : {
"id" : "5000123",
"code" : "code",
"name" : "Team building"
},
"projectTaskId" : "5000123",
"id" : "id",
"guid" : "guid",
"type" : "SCHEDULE",
"date" : "2000-06-21T04:56:07.000+00:00",
"duration" : 2,
"unit" : "{}",
"durations" : {
"durationMinute" : 240,
"durationHourMinute" : 2.3,
"durationHour" : 2.7,
"durationDay" : 0.25
},
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"actionCode" : {
"id" : "5000123",
"name" : "ADD"
},
"actionCodeId" : "130012",
"comment" : "comment",
"location" : "Paris",
"validated" : true,
"changeTracking" : {
"createdTime" : "2000-06-21T04:56:07.000+00:00",
"createdBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"createdById" : "5000123",
"modificationTime" : "2000-06-21T04:56:07.000+00:00",
"modificationBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"modificationById" : "5000123"
},
"taskId" : "5000123",
"actionCode2" : {
"id" : "5000123",
"code" : "ADD",
"name" : "ADD"
},
"actionCode2Id" : "5000123",
"approval" : "BRUT",
"approvalLabel" : "Refused",
"completionDate" : "2000-06-21T04:56:07.000+00:00",
"formConfig" : {
"type" : "{}",
"fields" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"controls" : {
"key" : {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}
},
"insertable" : true,
"editable" : false,
"deletable" : false,
"formSearchHidden" : false
}
}
2.14.10. Delete a quick entry time
DELETE |
/timesheet-entries/quick-entries-time/{quick_entry_time_id} |
Description
Delete a quick entry time
DMF required:
-
DMF A40506: Api Workforce / Time Recordings / Info
-
DMF 060304: Projects / Timesheets / Search
-
DMF 190301: Web Portal / Timesheets / Show
-
DMF 190302: Web Portal / Timesheets / Modify
-
DMF 250122: Project / Schedule View / Show Timesheets
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
quick_entry_time_id |
The id of the quick entry time |
X |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Successfully deleted |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.14.11. Delete a timesheet entry matching the specified ID.
DELETE |
/timesheet-entries/{timesheet_entry_id} |
Description
Delete a timesheet entry matching the specified ID.
DMF required:
-
DMF A40503: Api Workforce / Time Recordings / Delete
-
DMF 060303: Projects / Timesheets / Delete
-
DMF 190302: Web Portal / Timesheets / Modify
-
DMF 190305: Web Portal / Timesheets / Delete Rejected Timesheet
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
timesheet_entry_id |
The id of the timesheet entry |
X |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Successfully deleted |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.14.12. Duplicate timesheet entries for a number of weeks
POST |
/employees/{employee_id}/timesheet-entries/duplicate |
Description
Duplicate timesheet entries for a number of weeks
DMF required:
-
DMF A40501: Api Workforce / Time Recordings / Insert
-
DMF 060301: Projects / Timesheets / New
-
DMF 060302: Projects / Timesheets / Modify
-
DMF 060319: Projects / Timesheets / Report Timesheet Of Another Resource
-
DMF 190302: Web Portal / Timesheets / Modify
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
employee_id |
Id of an employee |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
recurringTimesheetEntry |
The recurring timesheet entries declaration RecurringTimesheetEntry |
X |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Successful duplication of timesheet entries |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"sunday" : true,
"saturday" : true,
"tuesday" : true,
"wednesday" : true,
"thursday" : true,
"friday" : true,
"nbWeeks" : 2,
"referentialDate" : "2020-01-31T23:59:59Z",
"monday" : true
}
2.14.13. Search for all approvals
GET |
/approvals |
Description
Get the list of all approvals.
DMF required:
-
DMF A50106: Api Approval Process / Approvals / Info
-
DMF 061803: Projects / Approvals / Show My Approvals Screen
-
DMF 190901: Web Portal / Approvals
-
DMF 191701: Web Portal / Employees Timesheets Validation / Access Time Review
Return Type
array[Approval]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Approvals successfully loaded |
List[Approval] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.14.14. Get completion from its id
GET |
/timesheet-entries/completion/{completion_id} |
Description
Get completion to the timesheet entry matching the specified ID
DMF required:
-
DMF A40506: Api Workforce / Time Recordings / Info
-
DMF 060304: Projects / Timesheets / Search
-
DMF 190301: Web Portal / Timesheets / Show
-
DMF 190302: Web Portal / Timesheets / Modify
-
DMF 250122: Project / Schedule View / Show Timesheets
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
completion_id |
The id of the completion |
X |
null |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Completion successfully loaded |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.14.15. Search for my approvals
GET |
/approvals/mine |
Description
Get the list of my approvals.
DMF required:
-
DMF A50106: Api Approval Process / Approvals / Info
-
DMF 061803: Projects / Approvals / Show My Approvals Screen
-
DMF 190901: Web Portal / Approvals
-
DMF 191701: Web Portal / Employees Timesheets Validation / Access Time Review
Parameters
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
exclude_refused |
Set as True to exclude the refused approvals from the result |
- |
null |
Return Type
array[Approval]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Approvals successfully loaded |
List[Approval] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.14.16. Search for my timesheet entries
GET |
/timesheet-entries/mine |
Description
Get the list of my timesheet entries, included in the time slot given in parameters..
DMF required:
-
DMF A40506: Api Workforce / Time Recordings / Info
-
DMF 060304: Projects / Timesheets / Search
-
DMF 190301: Web Portal / Timesheets / Show
-
DMF 190302: Web Portal / Timesheets / Modify
-
DMF 250122: Project / Schedule View / Show Timesheets
Parameters
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
from |
Start date of the search interval |
- |
null |
|
to |
End date of the search interval |
- |
null |
Return Type
array[TimesheetEntry]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
My timesheet entries successfully loaded |
List[TimesheetEntry] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.14.17. Search for timesheet entry completions of an employee
GET |
/employees/{employee_id}/timesheet-entries/completions |
Description
Get the list of timesheet entry completions of the employee matching the specified ID.
A time slot is required to search.
DMF required:
-
DMF A40506: Api Workforce / Time Recordings / Info
-
DMF 060304: Projects / Timesheets / Search
-
DMF 190301: Web Portal / Timesheets / Show
-
DMF 190302: Web Portal / Timesheets / Modify
-
DMF 250122: Project / Schedule View / Show Timesheets
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
employee_id |
Id of an employee |
X |
null |
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
from |
Start date of the search interval |
- |
null |
|
to |
End date of the search interval |
- |
null |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Timesheet entry completions successfully loaded |
List[TimesheetEntryCompletion] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.14.18. Search for timesheet entry completions of employees for a given manager
GET |
/managers/{manager_id}/employees/timesheet-entries/completions |
Description
Get the list of timesheet entry completions of the employees of a manager matching the specified manager ID.
A time slot is required to search.
DMF required:
-
DMF A40506: Api Workforce / Time Recordings / Info
-
DMF 060304: Projects / Timesheets / Search
-
DMF 190301: Web Portal / Timesheets / Show
-
DMF 190302: Web Portal / Timesheets / Modify
-
DMF 250122: Project / Schedule View / Show Timesheets
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
manager_id |
The id of the manager |
X |
null |
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
from |
Start date of the search interval |
- |
null |
|
to |
End date of the search interval |
- |
null |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Timesheet entry completions for a given manager successfully loaded |
List[TimesheetEntryCompletion] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.14.19. Search for timesheet entries of the employees for a given manager
GET |
/managers/{manager_id}/employees/timesheet-entries |
Description
Get the list of timesheet entries of the employees of the manager matching the specified manager ID.
DMF required:
-
DMF A40506: Api Workforce / Time Recordings / Info
-
DMF 060304: Projects / Timesheets / Search
-
DMF 190301: Web Portal / Timesheets / Show
-
DMF 190302: Web Portal / Timesheets / Modify
-
DMF 250122: Project / Schedule View / Show Timesheets
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
manager_id |
The id of the manager |
X |
null |
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
from |
Start date of the search interval |
- |
null |
|
to |
End date of the search interval |
- |
null |
|
unit |
Unit of duration of the timesheet entry Default value is set as MINUTE |
- |
null |
Return Type
array[TimesheetEntry]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Timesheet entries successfully loaded |
List[TimesheetEntry] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.14.20. Retrieve a timesheet entry by its ID
GET |
/timesheet-entries/{timesheet_entry_id} |
Description
Get the timesheet entry matching the specified ID.
DMF required:
-
DMF A40506: Get information about a timesheet entry.
DMF required:
-
DMF A40506: Api Workforce / Time Recordings / Info
-
DMF 060304: Projects / Timesheets / Search
-
DMF 190301: Web Portal / Timesheets / Show
-
DMF 190302: Web Portal / Timesheets / Modify
-
DMF 250122: Project / Schedule View / Show Timesheets
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
timesheet_entry_id |
The id of the timesheet entry |
X |
null |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
TimesheetEntry successfully loaded |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.14.21. Patch a quick entry time
PATCH |
/timesheet-entries/quick-entries-time/{quick_entry_time_id} |
Description
Patch a quick entry time
DMF required:
-
DMF A40506: Api Workforce / Time Recordings / Info
-
DMF 060304: Projects / Timesheets / Search
-
DMF 190301: Web Portal / Timesheets / Show
-
DMF 190302: Web Portal / Timesheets / Modify
-
DMF 250122: Project / Schedule View / Show Timesheets
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
quick_entry_time_id |
The id of the quick entry time |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
patch_elements |
List of patches to apply PatchElement |
- |
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Quick entry time successfully patched |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"op" : "ADD",
"path" : "path",
"from" : "from",
"value" : "{}"
}
2.14.22. Patch timesheet entries
PATCH |
/timesheet-entries/batch-update |
Description
Patch timesheet entries matching the specified IDs and using the list of parameters below.
DMF required:
-
DMF A40513: Api Workforce / Time Recordings / Patch Timesheet Entries
-
DMF 190709: Web Portal / Timesheets Validation / Reassign Multiple Time Entries At Once
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
patch_holder |
List of patches to apply PatchHolder |
- |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Timesheet entries successfully patched |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"ids" : [ "ids", "ids" ],
"patchElements" : [ {
"op" : "ADD",
"path" : "path",
"from" : "from",
"value" : "{}"
}, {
"op" : "ADD",
"path" : "path",
"from" : "from",
"value" : "{}"
} ]
}
2.14.23. Pre-fill a timesheet entry
POST |
/timesheet-entries/pre-fill |
Description
Pre-fill a previously created timesheet entry with an object given in parameter.
DMF required:
-
DMF A40501: Insert a timesheet entry.
DMF required:
-
DMF A40501: Api Workforce / Time Recordings / Insert
-
DMF 060301: Projects / Timesheets / New
-
DMF 060302: Projects / Timesheets / Modify
-
DMF 060319: Projects / Timesheets / Report Timesheet Of Another Resource
-
DMF 190302: Web Portal / Timesheets / Modify
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
TimesheetEntry |
The timesheet entry to be prefilled TimesheetEntry |
X |
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
object_type |
The type of object (see SchedulePreFillObjectType or TimesheetPreFillObjectType) |
- |
null |
|
object_id |
The id of the object used to fill in the schedule or the timesheet or … |
- |
null |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
TimesheetEntry successfully pre-filled |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJT_1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"subPhase" : {
"id" : "5000123",
"code" : "SB_1",
"name" : "Sub Phase 1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"order" : 1
},
"subPhaseId" : "5000123",
"projectTask" : {
"id" : "5000123",
"code" : "code",
"name" : "Team building"
},
"projectTaskId" : "5000123",
"id" : "id",
"guid" : "guid",
"type" : "SCHEDULE",
"date" : "2000-06-21T04:56:07.000+00:00",
"duration" : 2,
"unit" : "{}",
"durations" : {
"durationMinute" : 240,
"durationHourMinute" : 2.3,
"durationHour" : 2.7,
"durationDay" : 0.25
},
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"actionCode" : {
"id" : "5000123",
"name" : "ADD"
},
"actionCodeId" : "130012",
"comment" : "comment",
"location" : "Paris",
"validated" : true,
"changeTracking" : {
"createdTime" : "2000-06-21T04:56:07.000+00:00",
"createdBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"createdById" : "5000123",
"modificationTime" : "2000-06-21T04:56:07.000+00:00",
"modificationBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"modificationById" : "5000123"
},
"taskId" : "5000123",
"actionCode2" : {
"id" : "5000123",
"code" : "ADD",
"name" : "ADD"
},
"actionCode2Id" : "5000123",
"approval" : "BRUT",
"approvalLabel" : "Refused",
"completionDate" : "2000-06-21T04:56:07.000+00:00",
"formConfig" : {
"type" : "{}",
"fields" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"controls" : {
"key" : {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}
},
"insertable" : true,
"editable" : false,
"deletable" : false,
"formSearchHidden" : false
}
}
2.14.24. Publish employees timesheet entries
POST |
/employees/timesheet-entries/publish |
Description
Publish employees timesheet entries using the context given as a parameter.
DMF required:
-
DMF A40505: Api Workforce / Time Recordings / Publish
-
DMF 060305: Projects / Timesheets / Print
-
DMF 190304: Web Portal / Timesheets / Print
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
publish_context |
The context for publishing employee's timesheet entries EmployeeTimeRecordingsParamHolder |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Published document |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"context" : {
"filters" : "Entity, Services, Employee, etc...",
"displayOptions" : "Weekend, Scheduled rate, Validated, etc...",
"contextType" : "Timesheet entries",
"startDate" : "2020-01-31T23:59:59Z",
"employeeId" : "5000123"
},
"arguments" : {
"template" : {
"id" : "5000123",
"code" : "MODELE_EDITION_001",
"name" : "Edition model for my documents",
"type" : {
"code" : "TEMP01",
"name" : "Template one",
"modelId" : "5000123",
"modelDescription" : "Lorem Ipsum"
},
"publishType" : "{}",
"path" : "C://MyDoc/Template/modele_edition_001",
"endDate" : "2000-06-21T04:56:07.000+00:00",
"extensions" : ".pdf, .docx",
"defaultTemplate" : true,
"interactive" : true,
"order" : 1
},
"extension" : ".pdf",
"parameters" : [ {
"groupName" : "text_box",
"labelText" : "Detail BL",
"pattern" : "cl",
"nameField" : "DetailBL",
"selectionList" : [ {
"label" : "Bank transfer",
"value" : "BT"
}, {
"label" : "Bank transfer",
"value" : "BT"
} ],
"nameFieldNext" : "DetailCheckbox",
"value" : "checked",
"required" : true
}, {
"groupName" : "text_box",
"labelText" : "Detail BL",
"pattern" : "cl",
"nameField" : "DetailBL",
"selectionList" : [ {
"label" : "Bank transfer",
"value" : "BT"
}, {
"label" : "Bank transfer",
"value" : "BT"
} ],
"nameFieldNext" : "DetailCheckbox",
"value" : "checked",
"required" : true
} ],
"saveDocument" : true
}
}
2.14.25. Search for my timesheet entries quick entries with read options
POST |
/timesheet-entries/quick-entries-time/read-mine |
Description
Get a list of my timesheet entries quick entries, with additional information of your choice (example: employee information).
You can add this information with Read Options. These are listed in the link below.
DMF required:
-
DMF A40506: Api Workforce / Time Recordings / Info
-
DMF 060304: Projects / Timesheets / Search
-
DMF 190301: Web Portal / Timesheets / Show
-
DMF 190302: Web Portal / Timesheets / Modify
-
DMF 250122: Project / Schedule View / Show Timesheets
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
read_option |
The read options for returned timesheet entries quick entries QuickEntryTimeReadOption |
- |
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
unit |
Unit of duration (Default value: UNIT_OF_EMPLOYEE) |
- |
null |
Return Type
array[QuickEntryTime]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
My timesheet entries quick entries successfully loaded |
List[QuickEntryTime] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"options" : [ "EMPLOYEE", "EMPLOYEE" ]
}
2.14.26. Search a timesheet entry with read options
POST |
/timesheet-entries/{timesheet_entry_id}/read |
Description
Get a timesheet entry, with additional information of your choice (example: customer information).
You can add this information with Read Options. These are listed in the link below.
DMF required:
-
DMF A40506: Get information about the timesheet entry.
DMF required:
-
DMF A40506: Api Workforce / Time Recordings / Info
-
DMF 060304: Projects / Timesheets / Search
-
DMF 190301: Web Portal / Timesheets / Show
-
DMF 190302: Web Portal / Timesheets / Modify
-
DMF 250122: Project / Schedule View / Show Timesheets
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
timesheet_entry_id |
The id of the timesheet entry |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
read_option |
The read options for returned timesheet entry TimesheetEntryReadOption |
- |
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
unit |
Unit of duration (Default value: UNIT_OF_EMPLOYEE) |
- |
null |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
TimesheetEntry successfully loaded |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"options" : [ "EMPLOYEE", "EMPLOYEE" ]
}
2.14.27. Refuse timesheet entries
POST |
/timesheet-entries/refuse |
Description
Refuse timesheet entries given in parameters.
DMF required:
-
DMF A40511: Api Workforce / Time Recordings / Validate
-
DMF 060307: Projects / Timesheets / Validate
-
DMF 060309: Projects / Timesheets / Validate Timesheets Of Managed Resources
-
DMF 060310: Projects / Timesheets / Validate Timesheets For Managed Projects
-
DMF 060314: Projects / Timesheets / Validate Timesheets Of All Resources
-
DMF 060323: Projects / Timesheets / Global Validation Per Month
-
DMF 060357: Projects / Timesheets / Validate Timesheet Linked To Managed Project Phases
-
DMF 060361: Projects / Timesheets / Validate Non-completed Timesheets
-
DMF 1907__: Web Portal / Timesheets Validation
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
approvalValidation |
Details about the refusal (Reason, idents of timesheet entries, …) ApprovalValidation |
- |
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Number of refused timesheet entries |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"reason" : "Refused because too much time on this project.",
"approval" : {
"code" : "VALID",
"ident" : "v",
"name" : "Refused by manager",
"order" : 2
},
"idents" : "<115203, 663802, 225410>"
}
2.14.28. Replace a timesheet entry
POST |
/timesheet-entries/replace |
Description
Replace a timesheet entry by the one given in parameters.
DMF required:
-
DMF A40502: Api Workforce / Time Recordings / Update
-
DMF 060226: Projects / Schedules / View Schedule History
-
DMF 060302: Projects / Timesheets / Modify
-
DMF 060303: Projects / Timesheets / Delete
-
DMF 060328: Projects / Timesheets / Modify Time Without Weekly Time Control
-
DMF 060344: Projects / Timesheets / Modify Completed Timesheets
-
DMF 190302: Web Portal / Timesheets / Modify
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
timesheet_entry |
The timesheet entry to replace TimesheetEntry |
X |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Timesheet entry successfully replaced |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJT_1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"subPhase" : {
"id" : "5000123",
"code" : "SB_1",
"name" : "Sub Phase 1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"order" : 1
},
"subPhaseId" : "5000123",
"projectTask" : {
"id" : "5000123",
"code" : "code",
"name" : "Team building"
},
"projectTaskId" : "5000123",
"id" : "id",
"guid" : "guid",
"type" : "SCHEDULE",
"date" : "2000-06-21T04:56:07.000+00:00",
"duration" : 2,
"unit" : "{}",
"durations" : {
"durationMinute" : 240,
"durationHourMinute" : 2.3,
"durationHour" : 2.7,
"durationDay" : 0.25
},
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"actionCode" : {
"id" : "5000123",
"name" : "ADD"
},
"actionCodeId" : "130012",
"comment" : "comment",
"location" : "Paris",
"validated" : true,
"changeTracking" : {
"createdTime" : "2000-06-21T04:56:07.000+00:00",
"createdBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"createdById" : "5000123",
"modificationTime" : "2000-06-21T04:56:07.000+00:00",
"modificationBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"modificationById" : "5000123"
},
"taskId" : "5000123",
"actionCode2" : {
"id" : "5000123",
"code" : "ADD",
"name" : "ADD"
},
"actionCode2Id" : "5000123",
"approval" : "BRUT",
"approvalLabel" : "Refused",
"completionDate" : "2000-06-21T04:56:07.000+00:00",
"formConfig" : {
"type" : "{}",
"fields" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"controls" : {
"key" : {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}
},
"insertable" : true,
"editable" : false,
"deletable" : false,
"formSearchHidden" : false
}
}
2.14.29. Search for search field behavior for the Timesheets
GET |
/timesheet-entries/search-fields-information |
Deprecated
|
Tip
|
This API will soon be removed as it is no longer functional. No data will be returned when using it. |
Description
Get the list of search field behavior for Timesheets
DMF required:
-
DMF A40504: Api Workforce / Time Recordings / Search
-
DMF 060304: Projects / Timesheets / Search
-
DMF 190301: Web Portal / Timesheets / Show
-
DMF 250122: Project / Schedule View / Show Timesheets
Return Type
array[SearchControlBehavior]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Search field behavior results |
List[SearchControlBehavior] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.14.30. Search for my timesheet quick entries
GET |
/timesheet-entries/quick-entries-time/mine |
Description
Get all my timesheet quick entries.
DMF required:
-
DMF A40504: Api Workforce / Time Recordings / Search
-
DMF 060304: Projects / Timesheets / Search
-
DMF 190301: Web Portal / Timesheets / Show
-
DMF 250122: Project / Schedule View / Show Timesheets
Parameters
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
unit |
Unit of duration (Default value: UNIT_OF_EMPLOYEE) |
- |
null |
Return Type
array[QuickEntryTime]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
My timesheet quick entries successfully loaded |
List[QuickEntryTime] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.14.31. Search for a timesheet entry
POST |
/timesheet-entries/search |
Description
Get a list of timesheet entries matching the search criteria.
DMF required:
-
DMF A40504: Api Workforce / Time Recordings / Search
-
DMF 060304: Projects / Timesheets / Search
-
DMF 190301: Web Portal / Timesheets / Show
-
DMF 250122: Project / Schedule View / Show Timesheets
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
criteria |
Criteria that you choose (Project ID, entity ID, etc…) TimesheetEntryCriteria |
X |
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
unit |
Unit of duration (Default value: UNIT_OF_EMPLOYEE) |
- |
null |
Return Type
array[TimesheetEntry]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Timesheet entries successfully loaded |
List[TimesheetEntry] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"date" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
},
"actionCodeCode" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"phaseId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"project" : {
"departmentId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"entityId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"subCategoryId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"managerId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"projectState" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"divisionGroupingId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"activityId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"financialManagerId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"projectGroupCode" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"productionManagerId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"name" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"customerId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"id" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"tag" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"divisionId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"salesManagerId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"subCategoryLevel2Id" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"categoryId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"referentialDate" : "2000-01-23T04:56:07.000+00:00"
},
"readOption" : {
"options" : [ "EMPLOYEE", "EMPLOYEE" ]
},
"divisionGroupingId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"doNotRoundUp" : true,
"controlsManagerId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"customerId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"id" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"divisionId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"serviceId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"period" : {
"inclusivity" : "inclusivity",
"from" : "2000-01-23T04:56:07.000+00:00",
"to" : "2000-01-23T04:56:07.000+00:00"
},
"approval" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"employeeId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"entityId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"managerId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"actionCode2Id" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"notBilled" : true,
"companyId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"projectTaskId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"productionId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"subPhaseId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"onlyFinishedTimes" : true,
"comment" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"location" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"projectId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
}
}
2.14.32. Search for timesheet entry locations
GET |
/timesheet-entries/locations/search |
Description
Get a list of timesheet entry locations matching with parameters below.
DMF required:
-
DMF A40506: Api Workforce / Time Recordings / Info
-
DMF 060304: Projects / Timesheets / Search
-
DMF 190301: Web Portal / Timesheets / Show
-
DMF 190302: Web Portal / Timesheets / Modify
-
DMF 250122: Project / Schedule View / Show Timesheets
Parameters
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
customer_id |
ID of the customer |
- |
null |
|
tag |
Fill in this field to filter the timesheet entries search by tag |
- |
null |
Return Type
array[EventLocation]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Event locations successfully loaded |
List[EventLocation] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.14.33. Notify employees with incomplete timesheet entries
POST |
/timesheet-entries/send |
Description
Notify by email employees with incomplete timesheet entries.
You can add criteria to filter timesheet entries.
DMF required:
-
DMF A40510: Api Workforce / Time Recordings / Send
-
DMF 060237: Projects / Schedules / Send Schedule Assignment By Email
-
DMF 191715: Web Portal / Employees Timesheets Validation / Remind Employees
-
DMF 191901: Web Portal / Email / Send Email
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
criteria |
Criteria that you choose (Project ID, entity ID, etc…) TimesheetEntryCriteria |
X |
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Number of sent emails |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"date" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
},
"actionCodeCode" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"phaseId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"project" : {
"departmentId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"entityId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"subCategoryId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"managerId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"projectState" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"divisionGroupingId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"activityId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"financialManagerId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"projectGroupCode" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"productionManagerId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"name" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"customerId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"id" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"tag" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"divisionId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"salesManagerId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"subCategoryLevel2Id" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"categoryId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"referentialDate" : "2000-01-23T04:56:07.000+00:00"
},
"readOption" : {
"options" : [ "EMPLOYEE", "EMPLOYEE" ]
},
"divisionGroupingId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"doNotRoundUp" : true,
"controlsManagerId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"customerId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"id" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"divisionId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"serviceId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"period" : {
"inclusivity" : "inclusivity",
"from" : "2000-01-23T04:56:07.000+00:00",
"to" : "2000-01-23T04:56:07.000+00:00"
},
"approval" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"employeeId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"entityId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"managerId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"actionCode2Id" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"notBilled" : true,
"companyId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"projectTaskId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"productionId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"subPhaseId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"onlyFinishedTimes" : true,
"comment" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"location" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"projectId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
}
}
2.14.34. Update a quick entry time
POST |
/timesheet-entries/quick-entries-time/{quick_entry_time_id} |
Description
Update a quick entry time
DMF required:
-
DMF A40506: Api Workforce / Time Recordings / Info
-
DMF 060304: Projects / Timesheets / Search
-
DMF 190301: Web Portal / Timesheets / Show
-
DMF 190302: Web Portal / Timesheets / Modify
-
DMF 250122: Project / Schedule View / Show Timesheets
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
quick_entry_time_id |
The id of the quick entry time |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
quickEntryTime |
The quick entry time to update QuickEntryTime |
X |
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
The quick entry time has been successfully updated |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJT_1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"subPhase" : {
"id" : "5000123",
"code" : "SB_1",
"name" : "Sub Phase 1",
"phase" : {
"id" : "5000123",
"code" : "PHS_1",
"name" : "Phase 1",
"project" : {
"id" : "5000123",
"name" : "My project",
"companyCode" : "AKSAS",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "5000123",
"endCustomer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"endCustomerId" : "5000123",
"internal" : false,
"leave" : false,
"leaveType" : "{}",
"customerType" : "{}"
},
"projectId" : "PRJ_1",
"order" : 1
},
"phaseId" : "5000123",
"order" : 1
},
"subPhaseId" : "5000123",
"projectTask" : {
"id" : "5000123",
"code" : "code",
"name" : "Team building"
},
"projectTaskId" : "5000123",
"id" : "id",
"guid" : "guid",
"type" : "SCHEDULE",
"date" : "2000-06-21T04:56:07.000+00:00",
"duration" : 2,
"unit" : "{}",
"durations" : {
"durationMinute" : 240,
"durationHourMinute" : 2.3,
"durationHour" : 2.7,
"durationDay" : 0.25
},
"employee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"employeeId" : "5000123",
"actionCode" : {
"id" : "5000123",
"name" : "ADD"
},
"actionCodeId" : "130012",
"comment" : "comment",
"location" : "Paris",
"validated" : true,
"changeTracking" : {
"createdTime" : "2000-06-21T04:56:07.000+00:00",
"createdBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"createdById" : "5000123",
"modificationTime" : "2000-06-21T04:56:07.000+00:00",
"modificationBy" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"modificationById" : "5000123"
},
"taskId" : "5000123",
"actionCode2" : {
"id" : "5000123",
"code" : "ADD",
"name" : "ADD"
},
"actionCode2Id" : "5000123",
"approval" : "BRUT",
"approvalLabel" : "Refused",
"completionDate" : "2000-06-21T04:56:07.000+00:00",
"formConfig" : {
"type" : "{}",
"fields" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"controls" : {
"key" : {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}
},
"insertable" : true,
"editable" : false,
"deletable" : false,
"formSearchHidden" : false
},
"name" : "Service"
}
2.14.35. Validate timesheet entries
POST |
/timesheet-entries/validate |
Description
Validate the list of timesheet entries given in parameters.
DMF required:
-
DMF A40511: Api Workforce / Time Recordings / Validate
-
DMF 060307: Projects / Timesheets / Validate
-
DMF 060309: Projects / Timesheets / Validate Timesheets Of Managed Resources
-
DMF 060310: Projects / Timesheets / Validate Timesheets For Managed Projects
-
DMF 060314: Projects / Timesheets / Validate Timesheets Of All Resources
-
DMF 060323: Projects / Timesheets / Global Validation Per Month
-
DMF 060357: Projects / Timesheets / Validate Timesheet Linked To Managed Project Phases
-
DMF 060361: Projects / Timesheets / Validate Non-completed Timesheets
-
DMF 1907__: Web Portal / Timesheets Validation
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
approvalValidation |
Details about the validation (Reason, idents of timesheet entries, …) ApprovalValidation |
- |
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Number of validated timesheet entries |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"reason" : "Refused because too much time on this project.",
"approval" : {
"code" : "VALID",
"ident" : "v",
"name" : "Refused by manager",
"order" : 2
},
"idents" : "<115203, 663802, 225410>"
}
2.15. Timesheets Settings
2.15.1. Search action codes 2
POST |
/settings/action-codes2/search |
Description
Search action codes 2
DMF required:
-
DMF A41304: Api Workforce / Action Codes 2 / Search
-
DMF 0901__: Administrator / Setup
-
DMF 190302: Web Portal / Timesheets / Modify
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
criteria |
Search criteria ActionCode2Criteria |
X |
Return Type
array[ActionCode2]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Search action code2 successfully completed |
List[ActionCode2] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"code" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"name" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"id" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"tag" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"validity" : {
"type" : "{}",
"date" : "2000-06-21T04:56:07.000+00:00"
}
}
3. Models
3.1. Ability
Ability
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
level |
Details about the level associated with the skill |
|||
skill |
Details about the skill |
3.2. AbilityCriteria
Search criteria used on an ability
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
abilityFilter |
List of AbilityFilter |
Details about the skill and the associated level |
||
code |
Code of the skill |
|||
employeeId |
Id of the employee |
|||
id |
Id of the ability |
|||
name |
Name of the skill |
|||
tag |
You can use this clause to do a text search on the code and name |
3.3. AbilityFilter
Criteria used to filter by ability
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
levelId |
Id of the level |
|||
skillId |
ID of the skill |
3.4. AbilityLevel
Level of expertise of an employee on a specific skill
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Code of the expertise level |
|||
id |
Id in database |
|||
name |
Name of the expertise level |
3.6. AccountingJournal
Accounting journal
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
The accounting journal code |
|||
endDate |
End date of. Cannot be set directly please use the //TBD path. |
date |
||
excludedByDefault |
Excluded by default from accounting reports (trial balance, General ledger, accounting entries seach) |
|||
id |
Id in database |
|||
miscellaneousTransactionsProhibited |
Miscellaneous transactions Prohibited |
|||
name |
The accounting journal name |
|||
startDate |
Accounting journal start date |
date |
3.7. AccountingJournalBase
Accounting journal
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
The accounting journal code |
|||
id |
Id in database |
|||
name |
The accounting journal name |
3.9. Action
Verb of the request to specify which type of action you will send.
Type : enum (ADD, UPDATE, REMOVE)
3.10. ActionCode2
Details about the second action code
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Code of the second action code |
|||
id |
Id in database |
|||
name |
Name of the action code |
3.11. ActionCode2Criteria
Criteria used on Action Code 2 when doing an Action Code 2 search
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
||||
id |
||||
name |
||||
tag |
You can use this clause to do a text search on the code and name |
|||
validity |
3.12. ActionCodeBase
Details about the action code
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
Id in database |
|||
name |
Name of the action code |
3.13. ActionManagementObjectLine
ActionManagementObjectLine
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
action |
The action verb (ADD / UPDATE / REMOVE) |
|||
amountTotal |
Total amount expressed in company currency |
double |
||
amountTotalCurrency |
Total amount in the currency |
double |
||
id |
Id in database |
|||
managementObjectId |
Id of the management object |
|||
name |
Name of the line |
|||
phase |
Details about the phase of the project. |
|||
phaseId |
ID of the phase |
|||
project |
All details about the project |
|||
projectId |
ID of the project (equivalent to the code of the project) |
|||
projectTask |
Details about the project task of the project |
|||
projectTaskId |
Id of the project task |
|||
quantity |
Quantity of the product |
double |
||
rankNumber |
Rank number of the line |
double |
||
subPhase |
Details about the sub-phase of the project |
|||
subPhaseId |
ID of the sub-phase |
|||
unitPrice |
Unit price of the product expressed in company currency |
double |
||
unitPriceCurrency |
Unit price of the product expressed in company currency. The value in this field is not stored. Upon retrieval, it is calculated based on the rate in effect on the date of the management sales object. |
double |
3.14. ActiveModule
List of active modules
Note: MISSION represents the Variable Item
Type : enum (EXPENSE_REPORTS, TIMES_RECORDING, SCHEDULE, QUOTATION, QUOTATION_SIGNED_ORDERED_UNSIGNED, SALES_ORDER, INVOICE, SALES_BILLING_TABLE, DELIVERY, PURCHASE_ORDER, QUOTE, RECEPTION, PURCHASE_INVOICE, PURCHASE_BILLING_TABLE, HELP_DESK, PRODUCTION, MISSION, QUOTE_SIGNED_ORDERED_UNSIGNED, SALES_CREDIT_NOTE, PURCHASE_CREDIT_NOTE, INVENTORY_MOVEMENTS, FLOWS, ACCOUNTING, CASH_FLOW, OPERATING_ACCOUNT, PAYMENT_MONTH)
3.15. ActivityBase
Division
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Code of the activity |
|||
id |
Id in database |
|||
name |
Name of the activity |
3.16. AdditionalFreeFields
Free fields of a Management Object Line
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
field1 |
Free field 1 |
|||
field2 |
Free field 2 |
|||
field3 |
Free field 3 |
|||
field4 |
Free field 4 |
|||
field5 |
Free field 5 |
3.17. AdditionalFreeFieldsCriteria
Search criteria for additional free fields
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
additionalFreeField1 |
||||
additionalFreeField2 |
||||
additionalFreeField3 |
||||
additionalFreeField4 |
||||
additionalFreeField5 |
3.18. Address
Details about the address
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
cedex |
Special number assigned to a company by the French postal code |
|||
city |
City of the address |
|||
country |
Country code of the address in the database |
|||
countryName |
Country name of the address |
|||
department |
Geographical department code of the address in the database |
|||
Email of the address |
||||
fax |
Fax of the address |
|||
geographicalDepartmentName |
Name of the geographical department for the address |
|||
id (Deprecated) |
Id in database |
|||
line1 |
First line of the address |
|||
line2 |
Second line of the address |
|||
line3 |
Third line of the address |
|||
mobilePhone |
Mobile Phone of the address |
|||
phone |
Phone of the address |
|||
phone2 |
Second phone of the address |
|||
postalCode |
Postal code of the city |
|||
region |
Region code of the address in the database |
|||
regionName |
Region name of the address |
|||
webSite |
Web Site of the address |
3.19. AggregateExpenseReportCriteria
Criteria used on aggregate expense report when doing an aggregate expense report search
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
expenseCriteria |
Search criteria for expenses |
|||
expenseReportCriteria |
Search criteria for expense reports |
3.20. AggregateExpenseReportParamHolder
Parameters used for aggregating the results when searching expense reports
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
criteria |
Criteria that you choose (Date, refused, expenseTypeId, etc…) |
|||
groupBy |
The criterion by which the results are grouped |
3.21. Alert
Alert message
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
level |
Level of the alert |
Enum: ERROR, WARNING, INFO, ERROR, WARNING, INFO |
||
message |
Message of the alert |
3.24. AnalysisResult
Analysis result consisting of a value, a date and a set of analysis groups
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
date |
Aggregate date of the analysis (see dateLike) |
date-time |
||
group |
Map of [object] |
All analysis groups |
||
value |
Aggregate value of the analysis |
double |
3.25. ApplicationControlBase
Application control
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
The code of the application control base. |
|||
id |
Id in database |
|||
info1 |
The first information about the application control base. |
|||
info2 |
The second information about the application control base. |
|||
info3 |
The third information about the application control base. |
|||
info4 |
The fourth information about the application control base. |
|||
info5 |
The fifth information about the application control base. |
3.26. Approval
Approval
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Code of the approval |
|||
ident |
ID of the approval |
|||
name |
Name of the approval |
|||
order |
Order number of the approval |
3.27. ApprovalManagementObject
Information on the approval of a management object (pièce de gestion)
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
afterTaxAmount |
After-Tax amount expressed in company currency |
double |
||
approvalDate |
Date of approval |
date-time |
||
approvalState |
State of approval |
|||
changeTracking |
||||
companyCode |
The company code |
|||
companyId |
ID of the company |
|||
currency |
Currency used in the management object |
|||
currencyCode |
Code of the currency used in the management object |
|||
customData |
Map of CustomData |
The custom data (when present) |
||
date |
Date on the management object |
date-time |
||
description |
Description |
|||
entityCode (Deprecated) |
The entity code |
|||
id |
Id in database |
|||
name |
Name of the management object |
|||
number |
The number of the management object |
|||
phase |
Details about the phase of the project. |
|||
phaseId |
ID of the phase |
|||
preTaxAmount |
Pre-Tax Amount expressed in company currency |
double |
||
project |
All details about the project |
|||
projectId |
ID of the project (equivalent to the code of the project) |
|||
projectTask |
Details about the project task of the project |
|||
projectTaskId |
Id of the project task |
|||
subPhase |
Details about the sub-phase of the project |
|||
subPhaseId |
ID of the sub-phase |
|||
thirdPartyId |
The Id of the third-party |
|||
type |
Example : QUOTATION |
3.28. ApprovalState
State of the Approval
Type : enum (NONE, TO_REQUEST, TO_APPROVE, REFUSED, APPROVED)
3.29. ApprovalValidation
ApprovalValidation
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
approval |
Details about the approval |
|||
idents |
List of [string] |
Ids of the timesheet entries |
||
reason |
Reason of the approval |
3.30. ArchiveArgument
Arguments to archive
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
comment |
Comment to describe the archiving reason |
|||
reasonId |
The ID of the archiving reason |
3.31. ArchiveReasonBase
Details about the reasons to archive
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Code of the reason to archive |
|||
id |
Id in database |
|||
name |
Name of the reason to archive |
3.32. Assignment
Assignment
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
customer |
Details about the customer |
|||
customerId |
ID of the customer |
|||
phase |
Details about the phase |
|||
phaseId |
ID of the phase |
|||
project |
Details about the project |
|||
projectId |
ID of the project (equivalent to the code of the project) |
|||
projectTask |
Details about the task |
|||
projectTaskId |
ID of the project |
|||
subPhase |
Details about the sub-phase |
|||
subPhaseId |
ID of the sub-phase |
3.33. AssignmentCriteria
Criteria used to get more details about an assignment
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
activityId |
Ident of the activity |
|||
allCompanies |
Set as True if you don't want to filter on companies |
|||
companyId |
Ident of the company |
|||
countAssignmentType |
Define the node type when counting an assignment tree. Used like a query parameter limit. |
|||
customerId |
Ident of the customer |
|||
departmentId |
Ident of the department |
|||
divisionGroupId |
Ident of the division group |
|||
divisionId |
Ident of the division |
|||
employeeId |
ID of the employee |
|||
employeeIdScheduled |
List of [string] |
Ids of employees for which the project has schedules |
||
employeePartitioning |
Set as True if you want to apply the partitioning by employee |
|||
entityId |
Ident of the entity |
|||
ignoreProjectAllCustomer |
Set as True if you want to ignore all customer projects |
|||
lowerAssignmentType |
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. |
|||
mainCustomer |
Set as True if you want to filter only main customers |
|||
phaseCode |
Code of the phase |
|||
phaseId |
Ident of the phase |
|||
projectCategorieId |
Ident of the project category |
|||
projectClosed |
Set as True if you want to include closed projects |
|||
projectEmployeeLinkedId |
Ids of employees linked to the project (Include projects with no employee linked) |
|||
projectFilterType |
Filter on project (may override some other clauses like divisionId or entityId) |
|||
projectFinancialManagerId |
Ident of the project financial manager |
|||
projectGroupCode |
Code of the project group |
|||
projectId |
Ident of the project (equivalent to the code of the project) |
|||
projectInternal |
Set as True if you want to include internal projects |
|||
projectManagerId |
Ident of the project manager |
|||
projectOnLeave |
Set as True if you want to include leave projects |
|||
projectProductionManagerId |
Ident of the project production manager |
|||
projectSalesManagerId |
Ident of the project sales manager |
|||
projectStateCode |
Code of the projectState |
|||
projectSubCategorieId |
Ident of the sub-category |
|||
projectSubcategorieLevel2Id |
Ident of the sub-category level 2 |
|||
projectTaskEmployeeLinkedId |
Ids of employees linked to the project task (Include project tasks with no employee linked) |
|||
projectTaskId |
Ident of the task |
|||
referentialDate |
Start referential date. If the field is not filled in, it take today's date by default |
date-time |
||
referentialDateEnd |
End referential date. This date must be after the referentialDate. |
date-time |
||
scheduled |
Assignment with schedules over the period (see referentialDate) |
|||
subPhaseCode |
Code of the sub-phase |
|||
subPhaseId |
Ident of the sub-phase |
|||
tag |
You can fill in the code or name of the assignment in this field |
|||
tagIdScheduled |
List of [string] |
Ids of tag for which the project has scheduled tags |
||
upperAssignmentType |
Define the root node type when searching an assignment tree. If this field is not filled in, default root node type is CUSTOMER. |
|||
yearId |
Ident of the year |
3.34. AssignmentIndicator
The project indicator.
By default, this field contains the value 'SINGLE_PROJECT_MONO_PHASE'.
If this field is on 'SINGLE_PROJECT_MONO_PHASE', it is mandatory to enter the projet_id, phase_id and subphase_id in the quotation.
If this field is on 'SINGLE_PROJECT_MULTI_PHASES', it is mandatory to enter the project_id in the quotation and it is not possible to enter the phase_id and subphase_id in the quotation but only in the quotation line.
If this field is on 'MULTI_PROJECTS', it is not possible to enter the projet_id, phase_id and subphase_id in the quotation but it is mandatory to write them in the quotation line.
Type : enum (SINGLE_PROJECT_MONO_PHASE, SINGLE_PROJECT_MULTI_PHASES, MULTI_PROJECTS)
3.35. AssignmentNode
Assignment
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
additionalProperties |
Map of [string] |
Additonal functional properties available on this node |
||
assignments |
List of AssignmentNode |
Assignment node's child |
||
code |
Code of the assignment |
|||
description |
Short description of the assignment |
|||
id |
Id in database |
|||
longDescription |
Long description of the assignment |
|||
parentId |
ID of the parent |
|||
parentType |
Details about the parent |
|||
selectable |
Return True if the assignment node can be selected |
|||
type |
Details about the assignment type |
3.36. AssignmentReferential
Assignment referential
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
activity |
Details about the activity |
|||
category |
Details about the category |
|||
company |
Details about the company |
|||
customer |
Details about the customer |
|||
department |
Details about the departement |
|||
division |
Details about the divison |
|||
divisionGroup |
Details about the division grouping |
|||
entity |
Details about the entity |
|||
id |
Id in database |
|||
phase |
Details about the phase |
|||
project |
Details about the project |
|||
projectGroup |
Details about the project group |
|||
projectManager |
Details about the project manager |
|||
projectProductionManager |
Details about the production manager |
|||
projectState |
Details about the project state code |
|||
projectTask |
Details about the task |
|||
subCategory |
Details about the sub-category |
|||
subCategoryLevel2 |
Details about the second sub-category |
|||
subPhase |
Details about the sub-phase |
|||
year |
Details about the year |
3.37. AssignmentSubType
Subtype of Assignment
Type : enum (PROJECT_GROUP, DEPARTMENT, ACTIVITY, CATEGORY, SUB_CATEGORY, SUB_CATEGORY_2, PROJECT_STATE, YEAR)
3.38. AssignmentType
Type of Assignment
Type : enum (COMPANY, DIVISION_GROUP, DIVISION, ENTITY, CUSTOMER, PROJECT, PHASE, SUBPHASE, PROJECT_TASK)
3.39. AttachFileLocation
If ATTACH, the file will be added as an attachement. If BODY the report will be integrated into the email's body.
Type : enum (BODY, ATTACH)
3.40. Avatar
Entity avatar
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
content |
The base64-encoded binary content or URL of the entity's avatar image. |
3.41. AxeCriteria
Standard criteria for filtering data from the analysis
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
axeType |
X |
Unused (technical field) |
||
customerAccountManagerId |
Ident of customer's account manager |
|||
customerAccountManagerSupervisorId |
Ident of customer's account manager supervisor |
|||
customerCountryId |
Ident of customer's country |
|||
customerFamilyId |
Ident of the customer's project category |
|||
customerGrouping1 |
Customer's grouping |
|||
customerGrouping2 |
Customer's grouping 2 |
|||
customerId |
Ident of customer |
|||
customerRegionId |
Ident of customer's address region |
|||
customerSalesmanId |
Ident of customer's salesman |
|||
customerSalesmanSupervisorId |
Ident of customer's salesman supervisor |
|||
customerSectorId |
Ident of customer's sector |
|||
customerState |
Customer's state |
|||
customerSubFamilyId |
Ident of the customer's project subcategory |
|||
groupCustomer |
Group of companies of the customer |
|||
phaseId |
Ident of the phase |
|||
projectActivityId |
||||
projectCampaignId |
Ident of the project's compaign |
|||
projectCompanyCode |
Code of the project's company |
|||
projectDepartmentId |
Ident of the project's department |
|||
projectDivisionGroupId |
Ident of the project's division group |
|||
projectDivisionId |
Ident of the project's division |
|||
projectEstablishmentId |
||||
projectFamilyId |
Ident of the project's category |
|||
projectFinancialManagerId |
Ident of the project's financial manager |
|||
projectId |
Ident of the project (equivalent to the code of the project) |
|||
projectManagerId |
Ident of the project manager of the project |
|||
projectMarketId |
Ident of project group of the project |
|||
projectProductionManagerId |
Ident of the project's product manager |
|||
projectSalesManagerId |
Ident of the project's sales manager |
|||
projectState |
State of project |
|||
projectSubFamily2Id |
Ident of the project's sub-category level 2 |
|||
projectSubFamilyId |
Ident of the project's sub-category |
|||
projectVintageId |
Ident of the year (vintage) of the project |
|||
prospect |
True is customer is a prospect |
|||
subPhaseId |
Ident of the sub-phase |
3.42. AxeGroupsType
Standard analysis axis
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.43. BIC
Details about the BIC of a people
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
bank |
Code of the bank - 4 digits max |
|||
branch |
Code of the optional branch - 3 digits max |
|||
country |
Country code of the address in the database |
|||
location |
Code of the location - 2 digits max |
3.44. BankDetails
Details about the bank of a people
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
accountNumber |
Account number - 11 digits max |
|||
counter |
Code of the counter - 5 digits max |
|||
domiciliation |
Bank domiciliation |
|||
entity |
Code of the bank - 5 digits max |
|||
key |
Key of the RIB - 2 digits max |
3.45. BankType
Type of the bank (nature de banque) for international bank detail
Type : enum (BIC, ABA, NOT_DEFINED)
3.46. BankingInformation
Banking informations
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
action |
The action verb (ADD / UPDATE / REMOVE) |
|||
id |
ID in database |
|||
noneSepa |
Details about the none SEPA banking information (exclusive with the sepa field) |
|||
sepa |
Details about the SEPA banking information (exclusive with the noneSepa field) |
|||
statusChangeArgument |
Argument to change the status of a banking information |
|||
statusChangeDate |
This field is automatically set with the validation date when the Banking Information is validated or with the rejection date when the Banking Information is refused. |
date-time |
||
type |
The type of banking information used to indicate whether the data refers to SEPA details (with BIC, IBAN, and bankDetails) or international bank details. |
|||
validator |
Details about the employee who will validate banking data. |
|||
validatorId |
Set as true if this rule for validating banking data is applied to employees. |
3.47. BankingInformationStatus
The status of the Banking Information
Type : enum (VALIDATED, TO_VALIDATE, REFUSED)
3.48. BankingInformationStatusParamHolder
Argument to change the status of a banking information
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
comment |
Comment about the change status |
|||
status |
X |
The status of the Banking Information |
3.49. BankingInformationSupplierType
Supplier type of banking information
Type : enum (ALL, INTERNAL, EXTERNAL, VIRTUAL)
3.50. BankingInformationType
List of banking information type
Type : enum (SEPA, INTERNATIONAL_BANK)
3.51. BaseRateBase
Basic information for rates.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
ID in database of base rate |
|||
name |
The description of the base rate |
3.52. BatchArchiveArgumentParamHolder
The parameters for archiving the quotations
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
archiveArgument |
The argument for archiving |
|||
ids |
List of [string] |
IDs of the elements to archive |
3.53. BatchParameter
Parameter used to manage batch operations
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
ids |
List of [string] |
Ids of the objects |
3.54. BatchUpdateCustomDataParamHolder
All the information to perform the batch update on custom data
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
customData |
X |
Map of CustomData |
All custom data to update |
|
ids |
X |
List of [string] |
List of id on which the update must be done |
3.55. BatchUpdateSalesMObjectLines
Object for batch updating certain fields in sales management object lines
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
billingMode |
Billing mode for the line |
|||
ids |
List of [string] |
Ids of the objects |
||
notPublishable |
Set to “true” if the line is not to be shown when the sales management object containing said line (quotation, invoice, etc.) is published. |
|||
resourceId |
Id of the resource allocated to complete the task |
3.56. BillingMode
Billing mode of a product or sales line
Type : enum (TIME_BASED, FIXED_PRICE, RECURRENT, PRODUCTION_TO_BE_BILLED)
3.57. BlockedType
Type of object to be tested in the customer blocking control
Type : enum (OPPORTUNITY, QUOTATION, DELIVERY, PURCHASE_BILLING_TABLE, SALES_INVOICE, PROJECT, TRAINING_OPPORTUNITY, REGISTRATION_FORM, CUSTOMER_CONTRAT)
3.58. BlockingInformation
Blocking information (Customer, …)
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
alerted |
Operation is not blocked for this customer but has alerts. |
|||
blocked |
X |
Operation is blocked for this customer. |
||
reason |
Reason why customer is blocked. |
3.59. BlockingParamHolder
Blocking information needed to apply checking
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
amount |
X |
Amount to be checked |
double |
|
objectId |
Object tested (only in modifcation) |
|||
objectType |
X |
Type of parameterized object tested |
3.60. BooleanParamHolder
Parameter value (Boolean).
See the documentation of the calling API body for further information
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
value |
Value |
3.61. BusinessCard
Business card
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
cardNumber |
Number of the card |
|||
employeeId |
Id of the employee linked to the card |
|||
encryptedCardNumber |
Encrypted number of the card |
|||
endDate |
End date of validity of the business card |
date-time |
||
id |
Id in database |
|||
name |
Name of the card |
|||
type |
Type of the business card |
3.62. BusinessCardCriteria
Criteria used to get more details about business card
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
employeeId |
Ident of the employee |
|||
encryptedCardNumber |
Encrypted number of the card |
|||
endDate |
End date of validity of the business card |
|||
id |
Ident of the business card |
|||
name |
Name of the card |
|||
type |
Type of the business card |
3.64. BusinessEntity
BusinessEntity manages project-related information, including its phases and sub-phases.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
phase |
Details about the phase of the project. |
|||
phaseId |
ID of the phase |
|||
project |
All details about the project |
|||
projectId |
ID of the project (equivalent to the code of the project) |
|||
subPhase |
Details about the sub-phase of the project |
|||
subPhaseId |
ID of the sub-phase |
3.65. BusinessReferential
BusinessReferential manages project-related information, including phases, sub-phases, and associated project tasks.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
phase |
Details about the phase of the project. |
|||
phaseId |
ID of the phase |
|||
project |
All details about the project |
|||
projectId |
ID of the project (equivalent to the code of the project) |
|||
projectTask |
Details about the project task of the project |
|||
projectTaskId |
Id of the project task |
|||
subPhase |
Details about the sub-phase of the project |
|||
subPhaseId |
ID of the sub-phase |
3.66. Calendar
Calendar
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
The code of the calendar. |
|||
daysNotWorked |
List of [integer] |
Days not worked (ISO day of the week with 1 being Monday and 7 being Sunday) |
int32 |
|
default |
Set as 'true' to use this calendar by default. |
|||
holidays |
List of Holiday |
Details about list of holidays. |
||
id |
Id in database |
|||
name |
The name of the calendar. |
3.67. CalendarEvent
CalendarEvent
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
actionCode |
Details about the action verb |
|||
actionCodeId |
ID of the action code |
|||
changeTracking |
Date and user in case of creation and modification |
|||
comment |
Comment of the calendar event |
|||
customer |
Details about the customer |
|||
customerId |
ID of the customer |
|||
date |
Date of the calendar event |
date-time |
||
duration |
Duration of the calendar event |
double |
||
durations |
Duration in different units |
|||
employee |
Details about the employee |
|||
employeeId |
ID of the employee |
|||
guid |
Global identifier of the calendar event (for mobile version only) |
|||
id |
ID of the calendar event |
|||
location |
Location of the calendar event |
|||
phase |
Details about the phase |
|||
phaseId |
ID of the phase |
|||
project |
Details about the project |
|||
projectId |
ID of the project (equivalent to the code of the project) |
|||
projectTask |
Details about the task |
|||
projectTaskId |
ID of the project |
|||
subPhase |
Details about the sub-phase |
|||
subPhaseId |
ID of the sub-phase |
|||
taskId |
Helpdesk's task ident |
|||
type |
Type of the calendar event |
|||
unit |
Details about the unit of duration |
|||
validated |
Return True if the calendar event is validated |
3.68. CalendarEventRules
CalendarEventRules
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
allowManualEntry |
Return true if manual input is allowed. If false is returned, only input by range will be allowed. |
|||
base |
Calculation base to deduce the maximum value of authorized decimal. This calculation can be used in other calculation on timesheets. |
double |
||
closingDates |
List of ClosingDate |
Deadline to input schedule or time |
||
employeeId |
ID of the employee |
|||
employeeWeeks |
List of EmployeeWeek |
Details about the standard week |
||
id |
ID of the calendar event |
|||
max |
Maximal limit (excluded) to input duration |
double |
||
min |
Minimal limit (excluded) to input duration |
double |
||
prettyStep |
Incremental graphic step for a duration |
double |
||
step |
Precision of a duration. Used to calculate the increment |
double |
||
unit |
Code of the unit duration |
|||
unitDuration |
Unit duration |
3.69. CampaignBase
Marketing campaign
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
The code of the campaign. |
|||
id |
ID in database |
|||
name |
The name of the campaign. |
3.70. Category
Category
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
The code of the category |
|||
companyCode |
The code of the company |
|||
endDate |
End date for using the category of the product |
date |
||
grouping |
Grouping field for category |
|||
id |
Id in database |
|||
name |
The name of the category |
|||
ranking |
Category ranking in help lists |
int32 |
||
type |
Type of the category. |
3.71. CategoryCriteria
Criteria used on Category when doing a Category search
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Code of the category |
|||
companyId |
Company of the category |
|||
endDate |
End date of validity for the category |
|||
grouping |
Grouping field of the category |
|||
id |
Ident of the category |
|||
name |
Name of the category |
|||
tag |
You can fill in the code or name of the category in this field |
|||
type |
Type of the category |
|||
validity |
Details about the validity of the category |
3.72. CategoryType
Type of category
Type : enum (SALES_ITEM, PURCHASE_ITEM, PROJECT_CATEGORY, PROJECT_SUB_CATEGORY, PROJECT_SUB_CATEGORY_LEVEL2, EMPLOYEE_CATEGORY_LEVEL1, EMPLOYEE_CATEGORY_LEVEL2, EMPLOYEE_CATEGORY_LEVEL3, CUSTOMER, TECHNICAL_DOMAIN, OTHER_THIRDPARTIES, WORKGROUP, VERSION, CUSTOMERS_CONTRACTS, RETAILER_CONTRACTS, DOCUMENT, TRAINING_ITEM, SUPPLIER, MAINTAINED_ITEM)
3.73. ChangeTracking
History of all changes made
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
createdBy |
Code of the creator (user) |
|||
createdById |
Id of the creator (user) |
|||
createdTime |
Creation Date |
date-time |
||
modificationBy |
Code of the user who did the modification |
|||
modificationById |
Id of the user who did the modification |
|||
modificationTime |
Date of the modification. |
date-time |
3.74. ChangeTrackingCriteria
Standard criteria for filtering data from the change tracking
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
createdById |
The ID of the user who created the object. |
|||
createdTime |
The date and time when the object was created. |
|||
updatedById |
The ID of the user who last updated the object. |
|||
updatedTime |
The date and time when the object was last updated. |
3.75. CheckbookBase
Customer checkbook base
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
Id in database |
|||
name |
The name of the checkbook |
3.76. ChorusInvoiceStatus
Chorus status for e-invoices sent
Type : enum (DRAFT, SUBMITTED, IN_TRANSIT, AVAILABLE, COMPLETED, TO_BE_RECYCLED, SUSPENDED, REJECTED, SERVICE_RENDERED, MANDATED, AVAILABLE_FOR_ACCOUNTING, ACCOUNTED, PAYMENT_INITIATED)
3.77. ChorusServiceInformation
Chorus service information
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
serviceCode |
Code of Chorus service |
|||
serviceName |
Name of Chorus service |
3.78. City
City
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
companyCode |
The code of the company linked to the city |
|||
country |
The country where the city is located |
|||
countryId |
Id of the country where the city is located |
|||
default |
Returns true if the city is the default city |
|||
department |
The department where the city is located |
|||
departmentId |
Id of the department where the city is located |
|||
id |
Id in database |
|||
latitude |
Latitude of the city |
|||
longitude |
Longitude of the city |
|||
name |
Name of the city |
|||
postcode |
Postcode of the city |
|||
regionId |
Id of the region |
3.79. Clause
Basic clause type
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
includeNullResults |
Set as true to include null results |
|||
operator |
X |
The operator for your operation. |
||
value |
X |
The value you search |
3.80. ClauseBoolean
Boolean clause type
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
includeNullResults |
Set as true to include null results |
|||
operator |
X |
The operator for your operation. |
||
value |
X |
The value you search. |
3.81. ClauseDate
String clause type
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
includeNullResults |
Set as true to include null results |
|||
operator |
X |
The operator for your operation. |
||
value |
X |
The value you search. |
date-time |
|
withTime |
Whether or not the time part should be taken into account (false by default) |
3.82. ClauseDouble
Double clause type
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
includeNullResults |
Set as true to include null results |
|||
operator |
X |
The operator for your operation. |
||
value |
X |
The value you search. |
3.83. ClauseOperation
Operation used by the clause
Type : enum (LIKE, NOT_LIKE, IS, IS_NOT, IN, NOT_IN, IS_NULL, IS_NOT_NULL, CLAUSES, GREATER_OR_EQUALS, GREATER, LOWER_OR_EQUALS, LOWER)
3.84. ClauseString
String clause type
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
includeNullResults |
Set as true to include null results |
|||
operator |
X |
The operator for your operation. |
||
value |
X |
The value you search. |
||
wildcards |
When using the LIKE operator, indicates which characters should be interpreted as wildcards ('*%_' by default) |
3.85. ClosingDate
Closing date
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
beginningOfPeriod |
Beginning date to input time |
date-time |
||
closingDate |
Deadline to validate time |
date-time |
||
endOfPeriod |
End date to input time |
date-time |
||
module |
Module name of the closing date |
3.86. ColorCodes
ColorCodes
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
color1 |
First color code |
|||
color2 |
Second color code |
|||
color3 |
Third color code |
3.87. Command
Command
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
endDate |
End of the command |
date-time |
||
error |
Error of the command |
|||
id |
The Id of the command |
|||
progress |
Progress of the command |
|||
result |
Result of the command |
|||
startDate |
Start of the command |
date-time |
||
status |
Status of the command |
Enum: STARTED, NOT_STARTED, FINISHED, UNKNOWN, ERROR, STARTED, NOT_STARTED, FINISHED, UNKNOWN, ERROR |
3.88. CommandProgress
Command progress status
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
current |
Current index of the progress |
|||
max |
Max index of the progress |
3.89. Company
Company (Société)
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
address |
The company's main address |
|||
addressId |
The id of the company's main address |
|||
calendar |
Details of the calendar |
|||
calendarId |
ID of the calendar |
|||
code |
Code of the company |
|||
color |
Color attached to the company |
|||
currency |
Details about the currency |
|||
currencyId |
The currency id |
|||
id |
Id in database |
|||
legalName |
Legal name of the company |
|||
name |
Name of a company |
|||
siren |
SIREN number |
|||
siret |
SIRET number |
3.90. CompanyBase
Company
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Code of the company |
|||
id |
Id in database |
|||
name |
Name of a company |
3.91. CompanyChange
Informations about a company change for the employee
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
comment |
All comments about the change. |
|||
companyChangeState |
State of change in the company for an employee. |
|||
companyId |
Id of the company. |
|||
employeeId |
Id of the employee. |
|||
endDate |
End date of the employee's company change history. |
date-time |
||
id |
Id in database |
|||
startDate |
Start date of the employee's company change history. |
date-time |
3.92. CompanyChangeState
State of change in the company for an employee.
Type : enum (ACTIVE, INACTIVE, TRANSFER_IN_PROGRESS)
3.93. ComparisonOperator
Comparison operator
Type : enum (BEFORE, AFTER, EQUAL, BEFORE_EQUAL, AFTER_EQUAL)
3.94. ConditionOfPayment
The condition of payment
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Payment code |
|||
day |
Day of the month on which the payment will be done |
double |
||
deadLine |
Number of days to carry out the payment |
|||
term |
Period of payment |
3.95. ContactBase
Contact
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
The code of the contact. |
|||
firstName |
The first name of the contact. |
|||
id |
Id in database |
|||
name |
The name of the contact. |
3.96. ContractBase
Contracts
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
accountingJournal |
Details of the accounting journal |
|||
accountingJournalId |
ID of Accounting Journal |
|||
afterTaxAmount |
After-Tax amount expressed in company currency |
double |
||
afterTaxAmountCurrency |
After-Tax amount in the currency |
double |
||
approvalDate |
Date of approval |
date-time |
||
approvalState |
State of approval |
|||
assignmentIndicator |
Specifies the type of project and phase: mono project and mono phase, mono project and multi phase, or multi project. |
|||
changeTracking |
||||
code |
Code of the contract |
|||
companyCode |
The company code |
|||
companyId |
ID of the company |
|||
conditionOfPayment |
||||
currency |
Currency used in the management object |
|||
currencyCode |
Code of the currency used in the management object |
|||
customData |
Map of CustomData |
The custom data (when present) |
||
date |
Date on the management object |
date-time |
||
description |
Description |
|||
entityCode (Deprecated) |
The entity code |
|||
exchangeRate |
The currency's exchange rate |
double |
||
fiscalYear |
Belonging fiscal year |
|||
fiscalYearId |
Id of the fiscalYear |
|||
group |
Group object |
|||
id |
Id in database |
|||
internal |
Internal object |
|||
manager |
Details of the employee |
|||
managerId |
Id of the manager |
|||
methodOfPayment |
Method of payment |
|||
name |
Name of the management object |
|||
number |
The number of the management object |
|||
payment (Deprecated) |
Deprecated : Use conditionOfPayment instead |
|||
phase |
Details about the phase of the project. |
|||
phaseId |
ID of the phase |
|||
preTaxAmount |
Pre-Tax Amount expressed in company currency |
double |
||
preTaxAmountCurrency |
Pre-Tax Amount in the currency |
double |
||
pricingMethod |
Details about the pricing method. The method by which pricing is to be determined. |
|||
pricingMethodId |
The id of the pricing method |
|||
project |
All details about the project |
|||
projectId |
ID of the project (equivalent to the code of the project) |
|||
projectTask |
Details about the project task of the project |
|||
projectTaskId |
Id of the project task |
|||
subPhase |
Details about the sub-phase of the project |
|||
subPhaseId |
ID of the sub-phase |
|||
thirdPartyId |
The Id of the third-party |
|||
thirdPartyToBillId |
The Id of the third-party to bill |
|||
type |
Example : QUOTATION |
3.97. ContractServiceBase
Contact service (basic information)
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
The code of the contract service. |
|||
id |
Id in database |
|||
name |
The name of the contract service. |
3.98. ControlBehavior
Field control behavior
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
additionalValueSelectors |
List of [string] |
Additional information related to the valueSelectors, providing context or supplementary details for the list of permissible values. |
||
allowMultipleValues |
Set as 'true' if the user is allowed to select multiple values from the valueSelectors. |
|||
defaultValue |
Default value of the field |
|||
enabled |
Return true if the field is enabled |
|||
freeValue |
Set as 'true' if the user is not restricted to the values listed in valueSelectors and can set a freely chosen value. |
|||
id |
ID of the control behavior |
|||
information |
Additional information of the field |
|||
property |
Name of the property controlled |
|||
required |
Return true if the field is required |
|||
valueSelectors |
List of [string] |
Customizable list of values for selection, allowing the restriction of permissible values in fields. |
||
visible |
Return true if the field is visible |
3.99. Country
Country
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
calendar |
The calendar of the company linked to the country |
|||
calendarId |
Id of the calendar |
|||
code |
Code of the country |
|||
companyCode |
The code of the company linked to the country |
|||
companyId |
ID of the company |
|||
continent |
The continent where the country is located |
|||
currency |
The country's currency |
|||
currencyId |
Id of the country's currency |
|||
id |
Id in database |
|||
isPartOfEU |
Returns true if the country is part of the European Union |
|||
name |
Name of the country |
3.100. Currency
Currency
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Code of the currency |
|||
endDate |
End date for using the currency |
date-time |
||
euro |
Returns true if the currency is in euro |
|||
euroRate |
Exchange rate against the euro. |
double |
||
euroRateEndDate |
End date of the exchange rate (euroRate field). |
date-time |
||
euroRateStartDate |
Start date of the exchange rate (euroRate field). |
date-time |
||
id |
Id in database |
|||
name |
Name of the currency |
|||
order |
Order number of the currency |
3.101. CustomData
Custom data
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
label |
Label of the custom data |
|||
name |
Name of the custom data |
|||
realOrder |
Order number to display |
int32 |
||
type |
Type of the custom data |
|||
value |
Value of the custom data |
3.102. CustomDataPage
Page of the custom data
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
columnNumber |
Number of custom data page columns. |
|||
id |
ID of the custom data page |
|||
name |
The name of the custom data page. |
|||
order |
The order (ranking) of the custom data page. |
int32 |
3.103. CustomDataParam
Description of a parameter of custom data
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
ID of the custom data |
|||
keywordId |
ID of the keyword |
|||
label |
Label of the custom data |
|||
multiLine |
True if custom data is multi line |
|||
name |
Name of the custom data |
|||
order |
Order of the custom data |
int32 |
||
page |
Page of the custom data |
|||
pageId |
ID of the page |
|||
pattern |
Validation pattern of the custom field |
|||
property |
Property of the custom data |
|||
realOrder |
Real order of the custom data |
int32 |
||
section |
Section of the custom data |
|||
sectionId |
ID of the section |
|||
sequence |
Sequence of the custom data |
int32 |
||
textLimit |
Text limit of the custom data |
int32 |
||
type |
Type of the custom data |
|||
viewLabel |
True if label is visible |
3.104. CustomDataPattern
Custom data pattern
Type : enum (DATE_TIME, UPPER_CASE, LOWER_CASE, PROPER_CASE, PHONE, INTEGER, INTEGER_THOUSAND_SEPARATOR, INTEGER_ZERO_NOT_SIGNIFICANT, TWO_DIGITS_AFTER_DECIMAL_POINT, THREE_DIGITS_AFTER_DECIMAL_POINT, CURRENCY, CURRENCY_ZERO_NOT_SIGNIFICANT, URL, PERCENTAGE, PERCENTAGE_ONE_DIGIT, PERCENTAGE_TWO_DIGITS, PERCENTAGE_THREE_DIGITS, SIGNATURE, PASSWORD)
3.105. CustomDataSection
Section for custom data
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
columnNumber |
Column number of the custom data section |
|||
id |
ID of the custom data section |
|||
name |
Name of the custom data section |
|||
order |
Order number of the custom data section |
int32 |
||
pageId |
ID of the page |
|||
type |
By default set as SECTION |
3.106. CustomDataSectionType
SECTION to add the custom data into a section label;
COMPOSITE to add the custom data one after the other, without grouping them under a section label.
Type : enum (SECTION, COMPOSITE)
3.108. CustomRequest
Custom request
If the custom request project is null, this means the custom request is multi project.
In this case, each custom request line can be linked to a different project.
On the other hand, if the custom request project is not null, the custom request is mono project,
and in this case, all the custom request lines are linked to the same project.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
afterTaxAmount |
After-Tax amount expressed in company currency |
double |
||
approvalDate |
Date of approval |
date-time |
||
approvalState |
State of approval |
|||
archiveDate |
Archive date |
date-time |
||
archiveUser |
User who made the archive |
|||
archiveUserId |
Archive user |
|||
arrivalActualDate |
Actual arrival date |
date-time |
||
arrivalCity |
Arrival city |
|||
arrivalDate |
Arrival date |
date-time |
||
arrivalLocation |
Arrival location |
|||
cancellationDate |
Cancellation date |
date-time |
||
cancellationUser |
User who made the cancellation |
|||
cancellationUserId |
Cancellation user |
|||
category |
Category of the custom request |
|||
categoryId |
Id of the category. |
|||
changeTracking |
||||
comment |
Comment |
|||
companyCode |
The company code |
|||
companyId |
ID of the company |
|||
currency |
Currency used in the management object |
|||
currencyCode |
Code of the currency used in the management object |
|||
customData |
Map of CustomData |
The custom data (when present) |
||
customer |
Details about the customer |
|||
customerId |
Id of the customer |
|||
date |
Date on the management object |
date-time |
||
departureActualDate |
Actual departure date |
date-time |
||
departureCity |
Departure city |
|||
departureDate |
Departure date |
date-time |
||
departureLocation |
Departure location |
|||
description |
Description |
|||
documents |
List of Document |
Details about documents linked to the custom request |
||
employee |
Employee of the custom request |
|||
employeeId |
Id of the employee |
|||
entityCode (Deprecated) |
The entity code |
|||
id |
Id in database |
|||
lines |
List of CustomRequestLine |
List of the custom request's lines with their details |
||
multiProjects |
Set to true to allow the custom request to contain multiple projects across its lines. |
|||
name |
Name of the management object |
|||
number |
The number of the management object |
|||
numberOfDocuments |
Number of documents linked to the expense |
|||
phase |
Details about the phase of the project. |
|||
phaseId |
ID of the phase |
|||
preTaxAmount |
Pre-Tax Amount expressed in company currency |
double |
||
project |
All details about the project |
|||
projectId |
ID of the project (equivalent to the code of the project) |
|||
projectTask |
Details about the project task of the project |
|||
projectTaskId |
Id of the project task |
|||
subPhase |
Details about the sub-phase of the project |
|||
subPhaseId |
ID of the sub-phase |
|||
thirdPartyId |
The Id of the third-party |
|||
type |
Example : QUOTATION |
3.109. CustomRequestCategory
Custom request category
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
accreditationLevelType |
Level of confidentiality allowed for the custom request category |
double |
||
accreditationOptions |
Options of accreditation level allowed for the custom request category |
|||
code |
The code given to the custom request category |
|||
companyId |
Id of the company |
|||
customDataEnd |
End index of custom data to display |
double |
||
customDataNbColumns |
Nb columns to dispatch custom data |
double |
||
customDataStart |
Start index of custom data to display |
double |
||
defaultValueWithoutExpense |
True to setup the category without expenses as default value |
|||
departureLocation |
Enable departure location |
|||
departureLocationType |
Type of departure location |
|||
destinationLocation |
Enable destination location |
|||
destinationLocationType |
Type of destination location |
|||
displayCustomData |
Display custom data |
|||
editableWithoutExpense |
True to allow edit mode on adding expenses to the custom request |
|||
enableActualDates |
Enable actual dates |
|||
enableEndDate |
Enable end date |
|||
endDate |
The validity end date of the custom request category |
date-time |
||
icon |
The icon representing the category |
|||
id |
Id in database |
|||
name |
The name of the custom request category |
|||
scheduleCreation |
Enable creation on a schedule |
|||
timesheetCreation |
Enable creation on a timesheet entry |
3.110. CustomRequestCategoryCriteria
Criteria
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
accreditationLevelType |
The accreditation level type |
|||
accreditationOptions |
||||
code |
||||
companyId |
||||
defaultValueWithoutExpense |
True if there is a default value without an expense |
|||
departureLocation |
True if it allows departure location |
|||
departureLocationType |
||||
destinationLocation |
True if it allows destination location |
|||
destinationLocationType |
||||
displayCustomData |
The custom data (when present) |
|||
editableWithoutExpense |
True if the category is editable without an expense |
|||
enableActualDates |
True if it enables actual dates |
|||
enableEndDate |
True if it enables end date |
|||
endDate |
Criteria about the end date of the category |
|||
id |
||||
name |
||||
scheduleCreation |
True if it allows schedule creation |
|||
timesheetCreation |
True if it allows timesheet creation |
|||
validity |
Criteria about the validity of the category |
3.111. CustomRequestCriteria
Criteria used to get more details about the custom request
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
afterTaxAmount |
After tax amount of the management object |
|||
approvalDate |
Approval date of the management object |
|||
approvalState |
Approval state of the management object |
|||
archiveDate |
Archive date |
|||
archiveUserId |
The Id of the archiver user |
|||
arrivalActualDate |
Actual arrival date |
|||
arrivalDate |
Arrival date |
|||
arrivalLocation |
Arrival location |
|||
cancellationDate |
Cancellation date |
|||
cancellationUserId |
The Id of the canceller user |
|||
categoryId |
The Id of the category |
|||
companyCode |
Company code of the management object |
|||
creationDate |
Creation date of the management object |
|||
currencyCode |
Currency code of the currency used in the management object |
|||
customData |
Map of Clause |
The custom data (when present) |
||
date |
Date of the management object |
|||
departureActualDate |
Actual departure date |
|||
departureDate |
Departure date |
|||
departureLocation |
Departure location |
|||
description |
Description of the management object |
|||
employeeId |
The Id of the employee |
|||
entityCode |
Entity code of the management object |
|||
fiscalYearId |
Id of the fiscal year |
|||
group |
True if group |
|||
id |
ID of the management object |
|||
internal |
True if management object is internal |
|||
journalId |
Id of the journal |
|||
managerId |
Id of the manager linked with the management object |
|||
methodOfPayment |
Method of payment of the management object |
|||
name |
Name of the management object |
|||
number |
The number of the custom request |
|||
preTaxAmount |
Pre tax amount of the management object |
|||
projectId |
Ident of the project (equivalent to the code of the project) |
|||
readOption |
Options for retrieving extra information concerning the custom request |
|||
thirdPartyId |
Id of the third party |
|||
thirdPartyToBillId |
Id of the third party to bill |
|||
validationDate |
Validation of the management object |
3.112. CustomRequestLine
Custom request line
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
amountTotal |
Total amount expressed in company currency |
double |
||
amountTotalCurrency |
Total amount in the currency |
double |
||
customer |
The customer linked to the custom request |
|||
customerId |
The id of the customer |
|||
expenseTypeExpected |
Details about the expected expense type |
|||
expenseTypeExpectedId |
Id of the expected expense type |
|||
id |
Id in database |
|||
isExpenseReport |
Return true if the custom request line is linked to an expense report |
|||
managementObjectId |
Id of the management object |
|||
name |
Name of the line |
|||
phase |
Details about the phase of the project. |
|||
phaseId |
ID of the phase |
|||
project |
All details about the project |
|||
projectId |
ID of the project (equivalent to the code of the project) |
|||
projectTask |
Details about the project task of the project |
|||
projectTaskId |
Id of the project task |
|||
quantity |
Quantity of the product |
double |
||
rankNumber |
Rank number of the line |
double |
||
subPhase |
Details about the sub-phase of the project |
|||
subPhaseId |
ID of the sub-phase |
|||
unitPrice |
Unit price of the product expressed in company currency |
double |
||
unitPriceCurrency |
Unit price of the product expressed in company currency. The value in this field is not stored. Upon retrieval, it is calculated based on the rate in effect on the date of the management sales object. |
double |
3.113. CustomRequestLocationParamHolder
Parameters used when doing a search on custom request locations
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
customerIds |
List of [string] |
Id(s) of the customer(s) linked to the custom request |
||
searchText |
You can fill in the code or name of the tag in this field |
|||
type |
Example : DEPARTURE |
3.115. CustomRequestPreFillObjectType
Query param for object type
Type : enum (CUSTOM_REQUEST, SCHEDULE, TIMESHEET_ENTRY)
3.116. CustomRequestReadOption
The options you can use to get more information about the custom request.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
options |
List of [string] |
List of options used to get more details about the custom request |
Enum: CATEGORY, CUSTOMER, PROJECT, PHASE, SUB_PHASE, CHANGE_TRACKING, CURRENCY, DOCUMENT, DOCUMENTS_COUNT, LINE, LINE_EXPENSE_TYPE_EXPECTED, LINE_EXPENSE_TYPE_EXPECTED_EXPENSE_TYPE, LINE_CUSTOMER, LINE_PROJECT, LINE_PHASE, LINE_SUB_PHASE, CUSTOM_DATA, FORM_CONFIG, EMPLOYEE, CANCELLATION_USER, ARCHIVE_USER |
3.117. CustomerBase
Customer
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
The code of the third party (customer, supplier, other third party). |
|||
id |
Id in database |
|||
name |
The name of the third party (customer, supplier, other third party). |
3.118. CustomerIndicator
Customer Indicator
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
byDefault |
Set as true to use this customer indicator by default. Set as false by default |
|||
code |
Code of the Customer Indicator |
|||
colorHexCode |
The Hexadecimal color code for this customer Indicator |
|||
customerId (Deprecated) |
ID of the Customer |
|||
id |
Id in database |
|||
name |
Name of the Customer Indicator |
|||
order |
The order (ranking) of this customer indicator |
int32 |
3.119. CustomerIndicatorCriteria
Criteria used to get more details about the customer indicator
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
byDefault |
True if customer indicator is by default |
|||
code |
||||
colorHexCode |
||||
id |
||||
name |
3.120. CustomerIndicators
Indicators of a customer
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
customerId |
ID of the Customer |
|||
indicator1 |
The first indicator |
|||
indicator2 |
The second indicator |
|||
indicator3 |
The third indicator |
3.121. CustomerSiteBase
Customer Sites
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Code of the customer site |
|||
customer (Deprecated) |
Details about the customer |
|||
customerId (Deprecated) |
Code of the associated customer |
|||
id |
Id in database |
|||
name |
Name of the customer site |
3.122. CustomerStatus
Customer Status
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Code of the Customer Status |
|||
companyId |
ID of the company |
|||
endDate |
The end date of the customer status. |
date-time |
||
id |
Id in database |
|||
name |
Name of the Customer Status |
|||
ranking |
The customer status ranking in the list |
int32 |
3.123. CustomizableResources
Customizable resources (Ressources personnalisables)
Type : enum (ISSUE, OPPORTUNITY, OPPORTUNITY_LINE, CUSTOM_REQUEST, EVENT, PROJECT, PHASE, SUB_PHASE, EMPLOYEE, CUSTOMER, CONTACT, SALES, PURCHASE)
3.124. DateParamHolder
Date given in parameter
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
date |
Date |
date-time |
3.126. DelegationModule
DelegationModule
Type : enum (SAISIE_TPS_PASSES, VALIDATION_ET_CONTROLE_DES_TEMPS, ACTIVITES_PAR_DEFAUT, DEMANDES_ABSENCE, NDF, APPROBATIONS)
3.127. Department
Division
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
activities |
List of ActivityBase |
Activities of the department |
||
analysis |
Analysis of the department |
|||
code |
Code of the department |
|||
comment |
Comment of the department |
|||
companyCode |
Code of the company |
|||
entity |
Details of the entity |
|||
entityId |
ID of the entity |
|||
id |
Id in database |
|||
name |
Description of the department |
|||
projectType |
Type of the project |
3.128. DepartureLocationType
Type of departure location
Type : enum (ENTITIES, DOMICILE, UNRESTRICTED_INPUT)
3.129. DestinationLocationType
Type of destination location
Type : enum (CUSTOMER_SITES, CITIES, UNRESTRICTED_INPUT)
3.130. Discount
Discount on a Management Object Line
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
amount |
The discount amount |
double |
||
amountCurrency |
The discount amount in the currency |
double |
||
percentage |
The discount percentage |
double |
||
type |
Type of discount (PERCENT, AMOUNT) |
3.132. Division
Division
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Code of a division |
|||
companyId |
Id of the company |
|||
group |
Details about the group |
|||
groupId |
ID of the group |
|||
id |
Id in database |
|||
name |
Name of a division |
3.133. DivisionGrouping
Division grouping
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Code of a division grouping |
|||
id |
Id in database |
|||
name |
Name of a division grouping |
|||
serviceId |
ID of the service |
3.134. DmfBase
A dmf (a right in akuiteo D - Functional Area, M - Module, F - Feature)
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
The code of the right(dmf). |
|||
id |
Id in database |
|||
name |
The name of the right(dmf). |
3.135. Document
Details about document (file or link)
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
action |
Details about the action performed on the document |
|||
archived |
Return true if the document is archived. |
|||
category |
All details about the category of the product |
|||
category1 |
First category of the document |
|||
category2 |
Second category of the document |
|||
category3 |
Third category of the document |
|||
categoryId |
The Id of the category |
|||
changeTracking |
Creation and modification date and user |
|||
classification |
Classification of the document. |
|||
companyId |
ID of the company |
|||
description |
The description of the document |
|||
documentType |
Type of the document. |
|||
externalDMSUuid |
External ID when you use a DMS |
|||
fileName |
File name |
|||
fileUrl |
File url. This field cannot be updated once it has been created. |
|||
id |
Is of the document |
|||
lienUrl |
URL of the document |
|||
links |
List of DocumentLink |
Details about document's links |
||
locked |
Set as true if the document is locked. |
|||
original |
Return true if the document is an original. |
|||
owner |
Details about the publisher of the document. |
|||
ownerId |
ID of the owner of the document. |
|||
preview |
Preview of the document |
|||
publicationDate |
Publication date |
date-time |
||
publishedBy |
Details about the publisher of the document. |
|||
publishedById |
ID of the publisher of the document. |
|||
subCategory |
All details about the sub-category of the product |
|||
subCategoryId |
The Id of the sub-category |
|||
subClassification |
Sub-classification of the document |
|||
title |
X |
Title of the document |
||
tokenPreview |
Token to request by url the preview of the document |
|||
url |
URL of the document |
|||
version |
Version of the document |
double |
||
versionId |
ID of the version |
3.136. DocumentLink
A link between a document and any other object
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
document |
Details about the document |
|||
documentId |
ID of the document |
|||
id |
ID of the link |
|||
objectId |
ID of the object linked to the document |
|||
objectType |
Details about the type of object linked |
|||
original |
Return true if the document is an original |
3.137. DocumentVersion
DocumentVersion
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
classification |
Classification of the document. |
|||
documentId |
ID of the document |
|||
id |
Id in database |
|||
title |
Title of the document |
|||
version |
Version number |
double |
3.138. DueDate
Due date
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
amount |
Amount to pay |
double |
||
currencyCode |
Code of the currency |
|||
date |
Due date |
date-time |
||
id |
Id in database |
|||
invoiceId |
ID of the invoice |
3.139. DueDateCriteria
Criteria used to get more details about the due date
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
invoiceId |
Ident of the invoice |
3.140. DuplicateMode
Mode of the duplication. If 'DELETE_CREATE' the original event is deleted and the a new one is created, otherwise 'COPY' it is a simple copy.
Type : enum (DELETE_CREATE, COPY)
3.141. Durations
Duration in different units
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
durationDay |
Duration in day |
double |
||
durationHour |
Duration in hour |
double |
||
durationHourMinute |
Duration in hour minute |
double |
||
durationMinute |
Duration in minute |
double |
3.142. DutiableCriteria
Search criteria for dutiable fields
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
forcedVat |
Forced VAT clause |
|||
vat1 |
VAT code 1 |
|||
vat2 |
VAT code 2 |
3.143. DutiableLine
Tax Line
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
action |
The action verb (ADD / UPDATE / REMOVE) |
|||
additionalFreeFields |
Additional free fields of a line |
|||
afterTaxAmountTotal |
Total After-Tax amount expressed in company currency |
double |
||
afterTaxAmountTotalCurrency |
Total After-Tax amount in the currency |
double |
||
amountTotal |
Total amount expressed in company currency |
double |
||
amountTotalCurrency |
Total amount in the currency |
double |
||
complementName |
Description of the line |
|||
forcedVat |
Forced VAT for the line |
|||
generalAccount |
General Account |
|||
id |
Id in database |
|||
managementObjectId |
Id of the management object |
|||
name |
Name of the line |
|||
phase |
Details about the phase of the project. |
|||
phaseId |
ID of the phase |
|||
project |
All details about the project |
|||
projectId |
ID of the project (equivalent to the code of the project) |
|||
projectTask |
Details about the project task of the project |
|||
projectTaskId |
Id of the project task |
|||
quantity |
Quantity of the product |
double |
||
rankNumber |
Rank number of the line |
double |
||
resource |
Resource allocated to complete the task |
|||
resourceId |
Id of the resource allocated to complete the task |
|||
subPhase |
Details about the sub-phase of the project |
|||
subPhaseId |
ID of the sub-phase |
|||
totalPrice |
Total price before discount expressed in company currency (unit price * quantity) |
double |
||
totalPriceCurrency |
Total price before discount in the currency (unit price * quantity) |
double |
||
unitPrice |
Unit price of the product expressed in company currency |
double |
||
unitPriceCurrency |
Unit price of the product expressed in company currency. The value in this field is not stored. Upon retrieval, it is calculated based on the rate in effect on the date of the management sales object. |
double |
||
vat1 |
Details about the first VAT rate |
|||
vat2 |
Details about the second VAT rate |
|||
vatAmount1 |
Amount expressed in company currency with the first VAT |
double |
||
vatAmount1Currency |
Amount in currency for the first VAT |
double |
||
vatAmount2 |
Amount expressed in company currency for the second VAT |
double |
||
vatAmount2Currency |
Amount in currency for the second VAT |
double |
3.144. ESignatureMessage
Message for electronic signature of a management object.
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.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
ccRecipients |
List of MessageRecipient |
Cc mail recipients |
||
publishArguments |
Required arguments to publish a document |
|||
toRecipients |
List of MessageRecipient |
Main mail recipients |
3.145. ESignatureSignatoryType
Defines the type of signatory for electronic signatures.
A signatory can be either an employee or a contact.
Type : enum (CONTACT, EMPLOYEE)
3.146. ESignatureStatus
Electronic signature status of a management object
Type : enum (IN_PROGRESS, CANCELED, EXPIRED, SIGNED, FAILED, PENDING, SIGNATURE_REQUESTED)
3.147. ESignatureTransaction
Information on transactions for electronic signatures
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
date |
The date of the transaction |
date-time |
||
daysSpent |
Number of days since transaction was requested |
double |
||
id |
Id in database |
|||
ranking |
Rank number of transaction. |
int32 |
||
rejectionReason |
The reason for rejection if the signatory has refused to sign the document. |
|||
requesterId |
The ID of the the transaction requester. |
|||
signatoryEmail |
Signatory e-mail address |
|||
signatoryId |
The ID of th signatory |
|||
signatoryType |
The type of signatory for electronic signatures. |
|||
signatureDate |
The date of signature. |
date-time |
||
signatureStatus |
Status of the signature |
|||
status |
Status of the transaction |
3.148. Employee
Employee
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
action |
The action verb |
|||
address |
Details about the address |
|||
addressId |
Id of the address |
|||
assignmentMultiCompany |
Return true if it is a multi-company employee |
|||
bankingInformation |
Details about the banking information for an employee. |
|||
birthDate |
Employee date of birth |
date-time |
||
businessCards |
List of BusinessCard |
Details about business cards linked to the employee |
||
candidate |
Return true if the employee is a candidate |
|||
changeTracking |
||||
code |
Code of the employee |
|||
color |
Color of the employee (hexadecimal code) |
|||
companyChanges |
List of CompanyChange |
Details about the employee company changes |
||
currentCompany |
Details about the current company |
|||
currentCompanyId |
Id of the current company oh the employee |
|||
customData |
Map of CustomData |
The custom data (when present) |
||
Email of the employee |
||||
employeeAbilities |
List of EmployeeAbility |
Details about the secondary abilities of the employee |
||
employeeFunctions |
Details about the employee's functions |
|||
employeeHistory |
List of EmployeeHistory |
Details about the employee's history |
||
executive |
Return true if the employee is executive |
|||
external |
Return true if the employee is external |
|||
faxNumber |
Employee's fax number |
|||
firstName |
First name of the employee |
|||
generic |
Return true if the employee is generic |
|||
id |
Id in database |
|||
jobType |
Details about the job type |
|||
jobTypeId |
ID of the job type |
|||
managerMultiCompany |
Return true if the employee is defined as a multi-company manager |
|||
mobilePhone |
Phone number of the employee |
|||
modeInputSchedule (Deprecated) |
Number of the schedule input mode chosen for the employee |
double |
||
modeTimeRecording (Deprecated) |
Number of the time-record input mode chosen for the employee |
double |
||
name |
Name of the employee |
|||
noTimesDunning |
Return true if the employee does not have time to dun |
|||
number |
The employee number |
|||
phone |
The office phone of the employee |
|||
phoneExtensionNumber |
Employee's extension phone number |
|||
relations |
List of Relation |
Details about relations of the employee with other employees |
||
scheduleInputMode |
Schedule input mode |
|||
scheduleRules |
Details about schedule rules |
|||
sector |
Related sales sector |
|||
targetTace |
Targeted TACE (percentage) |
double |
||
timeRecordingInputMode |
Time input mode |
|||
timeRecordingRules |
Details about time rules |
|||
title |
Title of the employee |
|||
vehicles |
List of Vehicle |
Details about vehicles |
3.149. EmployeeAbility
Ability of an employee
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
employeeId |
Id of the linked employee |
|||
endDate |
Date by which the ability ends for the employee |
date-time |
||
id |
Id in database |
|||
level |
Details about the level associated with the skill |
|||
skill |
Details about the skill |
|||
startDate |
Date by which the ability starts for the employee |
date-time |
3.150. EmployeeBase
Employees
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
action |
The action verb |
|||
code |
Code of the employee |
|||
firstName |
First name of the employee |
|||
id |
Id in database |
|||
name |
Name of the employee |
3.151. EmployeeCodeChange
Parameters to change employee code
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
excludePreviousCode |
Set to 'true' if the previous code is to be excluded. |
|||
newCode |
The new code to assign to the employee. |
|||
oldCode |
The employee's current code to be changed. |
3.152. EmployeeCriteria
Criteria used to get more details about employee
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
assignmentMultiCompany |
Set as True if you want to have employees assigned on multiple company |
|||
batchKey |
||||
code |
Code of the employee |
|||
companyId |
Ident of the company |
|||
createdById |
||||
createdTime |
The date of creation of the employee |
|||
customData |
Map of Clause |
Criteria used on custom data |
||
Email of the employee |
||||
employeeFunction |
Details about the employee's functions |
|||
employeePartitioning |
Set as true if you want to apply the partitioning by employee |
|||
entityId |
Ident of the entity |
|||
excludeCandidate |
Set as True if you want to exclude candidate employees |
|||
excludeExternal |
Set as True if you want to exclude external employees |
|||
excludeGeneric |
Set as True if you want to exclude generic employees |
|||
id |
Ident of the employee |
|||
managerId |
Ident of the manager |
|||
modificationById |
||||
modificationTime |
The modification date of the employee |
|||
noTimesDunning |
Set as True if you want to select employees without time to dun, ie. no reminders on entering time |
|||
number |
Number of the employee |
|||
onlyPresent |
Set as True if you want to have only present employees |
|||
readOption |
Options for retrieving extra information concerning the employee |
|||
relatedEmployeeId |
Ident of the related employee |
|||
relationTypeId |
Ident of the employee's relation type |
|||
shouldBeNotified (Deprecated) |
Set as True if you want to select employees without time to dun |
|||
tag |
You can use this clause to do a text search on the code, first name and last name |
|||
teamId |
Ident of the team |
3.153. EmployeeEventsSummariesCriteria
Search criteria for employee events summaries
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
employeeId |
Ident of the employee |
|||
from |
Date by which the summary starts |
date-time |
||
to |
Date by which the summary ends |
date-time |
3.154. EmployeeFluent
Employee fluent
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
action |
The action verb |
|||
address |
Details about the address |
|||
addressId |
Id of the address |
|||
assignmentMultiCompany |
Return true if it is a multi-company employee |
|||
bankingInformation |
Details about the banking information for an employee. |
|||
birthDate |
Employee date of birth |
date-time |
||
businessCards |
List of BusinessCard |
Details about business cards linked to the employee |
||
candidate |
Return true if the employee is a candidate |
|||
changeTracking |
||||
code |
Code of the employee |
|||
color |
Color of the employee (hexadecimal code) |
|||
companyChanges |
List of CompanyChange |
Details about the employee company changes |
||
currentCompany |
Details about the current company |
|||
currentCompanyId |
Id of the current company oh the employee |
|||
customData |
Map of CustomData |
The custom data (when present) |
||
Email of the employee |
||||
employeeAbilities |
List of EmployeeAbility |
Details about the secondary abilities of the employee |
||
employeeFunctions |
X |
Details about the employee's functions |
||
employeeHistory |
X |
List of EmployeeHistory |
Details about the employee's history |
|
executive |
Return true if the employee is executive |
|||
external |
Return true if the employee is external |
|||
faxNumber |
Employee's fax number |
|||
firstName |
First name of the employee |
|||
generic |
Return true if the employee is generic |
|||
historiqueCollaborateur |
List of EmployeeHistoryFluent |
Details about the fluent employee history |
||
id |
Id in database |
|||
jobType |
Details about the job type |
|||
jobTypeId |
ID of the job type |
|||
managerMultiCompany |
Return true if the employee is defined as a multi-company manager |
|||
mobilePhone |
Phone number of the employee |
|||
modeInputSchedule (Deprecated) |
X |
Number of the schedule input mode chosen for the employee |
double |
|
modeTimeRecording (Deprecated) |
X |
Number of the time-record input mode chosen for the employee |
double |
|
name |
Name of the employee |
|||
noTimesDunning |
Return true if the employee does not have time to dun |
|||
number |
The employee number |
|||
phone |
The office phone of the employee |
|||
phoneExtensionNumber |
Employee's extension phone number |
|||
relations |
List of Relation |
Details about relations of the employee with other employees |
||
scheduleInputMode |
Schedule input mode |
|||
scheduleRules |
Details about schedule rules |
|||
sector |
Related sales sector |
|||
targetTace |
Targeted TACE (percentage) |
double |
||
timeRecordingInputMode |
Time input mode |
|||
timeRecordingRules |
Details about time rules |
|||
title |
Title of the employee |
|||
vehicles |
List of Vehicle |
Details about vehicles |
3.155. EmployeeFunction
EmployeeFunction
Type : enum (PROJECT_SALES_MANAGER, PROJECT_FINANCE_MANAGER, PROJECT_PRODUCTION_MANAGER, PROJECT_ACCOUNT_MANAGER, PROJECT_ASSIGNMENT, PROJECT_PHASE_MANAGER, PROJECT_SEND_ON_MISSION, SALES_SALES_ASSISTANT, SALES_ORDER_AND_ESTIMATE_TRACKING, SALES_BILLING_SCHEDULES_TRACKING, PURCHASING_BUYER, TIME_RECORDING, INPUT_OF_EXPENSE_REPORT, PURCHASES_RECEPTION_TRACKING, INPUT_SCHEDULE, CMMS_CONTRACT_SALES_MANAGER, CMMS_CONTRACT_TECHNICAL_MANAGER, CMMS_MR_AND_EO_MANAGER)
3.156. EmployeeFunctions
Employee functions
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
CMMSContractSalesManager |
Return true if the employee is defined as the sales manager for helpdesk contracts |
|||
CMMSContractTechnicalManager |
Return true if the employee is defined as the technical manager for helpdesk contracts |
|||
CMMSMRAndEOManager |
Return true if the employee is defined as the migration and responder manager for helpdesk contracts |
|||
allFunctions |
Return true if the employee has all functions in each domain |
|||
allOperational |
Return true if the employee has all operational functions |
|||
allPurchases |
Return true if the employee has all purchases functions |
|||
allSales |
Return true if the employee has all sales functions |
|||
inputOfExpenseReport |
Return true if the employee has the 'Input expense report' function |
|||
inputSchedule |
Return true if the employee has the 'Schedule Input' function |
|||
projectAccountManager |
Return true if the employee is defined as the project's account manager |
|||
projectAssignment |
Return true if the employee has the project assignment option |
|||
projectFinanceManager |
Return true if the employee is defined as the project's finance manager |
|||
projectPhaseManager |
Return true if the employee is defined as the project's phase manager |
|||
projectProductionManager |
Return true if the employee is defined as the project's production manager |
|||
projectSalesManager |
Return true if the employee is defined as the project's sales manager |
|||
projectSendOnMission |
Return true if the employee has the sent on mission option |
|||
purchasesReceptionTracking |
Return true if the employee has the 'purchase reception tracking' function |
|||
purchasingBuyer |
Return true if the employee is defined as the purchase buyer |
|||
salesBillingSchedulesTracking |
Return true if the employee has the sales billing schedule management option |
|||
salesOrderAndEstimateTracking |
Return true if the employee has the sales order and quotation management option |
|||
salesSalesAssistant |
Return true if the employee has the salesman option |
|||
timeRecording |
Return true if the employee has the 'Time input' function |
3.157. EmployeeHistory
Employee history
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
company |
Details about the company |
|||
companyId |
ID of the company |
|||
dailyCost |
Daily cost of the employee |
double |
||
dailyHours |
Daily hours worked |
double |
||
dailySellingPrice |
Daily selling price of the employee |
double |
||
directHourlyRate |
Direct hourly cost |
double |
||
employeeHistoryType (Deprecated) |
ID of the standard week used |
|||
employeeId |
ID of the employee |
|||
entity |
ID of the entity |
|||
family1 |
Details about the first family |
|||
family1Id |
ID of the first family |
|||
family2 |
Details about the second family |
|||
family2Id |
ID of the second family |
|||
family3 |
Details about the third family |
|||
family3Id |
ID of the third family |
|||
from |
Date by which the situation starts |
date-time |
||
id |
Id in database |
|||
leave |
Return true if the employee is absent |
|||
manager |
Details about the manager |
|||
managerId |
ID of the manager |
|||
occupancyRate |
Average occupancy rate |
double |
||
position |
Employee position |
|||
salary |
Salary of the employee |
double |
||
service |
ID of the service |
|||
serviceRef |
Reference to the service of the employee |
|||
skill |
ID of the main skill of the employee |
|||
skillRef |
Reference to the skill of the employee |
|||
standardHourlyRate |
Standard hourly cost |
double |
||
standardWeek |
Details about the standard week |
|||
standardWeekId |
ID of the standard week used |
|||
to |
Date by which the situation ends |
date-time |
||
weekHours |
Week hours worked |
double |
3.158. EmployeeHistoryCriteria
Criteria used to get more details about employee history
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
employeeId |
||||
from |
Date from which the employee history will be retrieved |
|||
id |
||||
managerId |
||||
to |
Date to which the employee history will be retrieved |
3.159. EmployeeHistoryFluent
Fluent employee history
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
company |
Details about the company |
|||
companyId |
ID of the company |
|||
dailyCost |
Daily cost of the employee |
double |
||
dailyHours |
Daily hours worked |
double |
||
dailySellingPrice |
Daily selling price of the employee |
double |
||
directHourlyRate |
Direct hourly cost |
double |
||
employeeFamily1Code |
Code of the first employee family |
|||
employeeFamily2Code |
Code of the second employee family |
|||
employeeFamily3Code |
Code of the third employee family |
|||
employeeHistoryType (Deprecated) |
ID of the standard week used |
|||
employeeId |
ID of the employee |
|||
entity |
ID of the entity |
|||
entityCode |
Code of the entity |
|||
family1 |
Details about the first family |
|||
family1Id |
ID of the first family |
|||
family2 |
Details about the second family |
|||
family2Id |
ID of the second family |
|||
family3 |
Details about the third family |
|||
family3Id |
ID of the third family |
|||
from |
Date by which the situation starts |
date-time |
||
id |
Id in database |
|||
leave |
Return true if the employee is absent |
|||
manager |
Details about the manager |
|||
managerCode |
Code of the employee's manager |
|||
managerId |
ID of the manager |
|||
occupancyRate |
Average occupancy rate |
double |
||
position |
Employee position |
|||
salary |
Salary of the employee |
double |
||
service |
ID of the service |
|||
serviceCode |
Code of the service |
|||
serviceRef |
Reference to the service of the employee |
|||
skill |
ID of the main skill of the employee |
|||
skillCode |
Code of the skill |
|||
skillRef |
Reference to the skill of the employee |
|||
standardHourlyRate |
Standard hourly cost |
double |
||
standardWeek |
Details about the standard week |
|||
standardWeekId |
ID of the standard week used |
|||
to |
Date by which the situation ends |
date-time |
||
weekHours |
Week hours worked |
double |
3.160. EmployeeHistoryReadOption
Option used to get more details concerning EmployeeHistory.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
options |
List of [string] |
List of options used to get more details about the employee history |
Enum: COMPANY, FAMILIES, SKILL, MANAGER, SERVICE, STANDARD_WEEK |
3.161. EmployeeReadOption
Criteria used to get more details about an employee.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
options |
List of [string] |
List of options used to get more details about the employee |
Enum: EMPLOYEE_HISTORY, CALENDAR_RULES, BUSINESS_CARDS, RELATED_EMPLOYEES, EMPLOYEE_ABILITIES, ADDRESS, EMPLOYEE_HISTORY_STANDARD_WEEK, JOB_TYPE, CUSTOM_DATA, FORM_CONFIG, VEHICLES, COMPANY_CHANGES, CURRENT_COMPANY, BANKING_INFORMATIONS |
3.162. EmployeeReferential
Employee referential
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
category1 |
Details about the first category |
|||
category2 |
Details about the second category |
|||
category3 |
Details about the third category |
|||
company |
Details about the company |
|||
division |
Details about the division |
|||
divisionGroup |
Details about the division grouping |
|||
employee |
Details about the employee |
|||
employeeHistoryId |
Id of the employee history |
|||
endDate |
End date |
date-time |
||
entity |
Details about the entity |
|||
id |
Id in database |
|||
manager |
Details about the manager |
|||
service |
Details about the service |
|||
skill |
Details about the skill |
|||
standardWeek |
Details about the standard week |
|||
startDate |
Starting date |
date-time |
3.163. EmployeeReferentialCriteria
Criteria used to get more details about the employee referential.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
abilityFilter |
List of AbilityFilter |
Details about ability |
||
allCompanies |
Set as true to search on all companies |
|||
category1Code |
Code of the first category |
|||
category1Id |
Ident of the first category |
|||
category2Code |
Code of the second category |
|||
category2Id |
Ident of the second category |
|||
category3Code |
Code of the third category |
|||
category3Id |
Ident of the third category |
|||
companyId |
Ident of the company |
|||
customerIdScheduled |
List of [string] |
Ids of customers for which the employee has schedules |
||
divisionGroupId |
Ident of the division grouping |
|||
divisionId |
Ident of the division |
|||
employeeAbsent |
Set as true if you want to search for absent employees |
|||
employeeCandidate |
Set as true if you want to search for candidate employees |
|||
employeeCode |
Code of the employee |
|||
employeeExecutive |
Set as true if you want to search for executive employees |
|||
employeeExternal |
Set as true if you want to search for external employees |
|||
employeeFirstName |
First name of the employee |
|||
employeeGeneric |
Set as true if you want to search for generic employees |
|||
employeeId |
Ident of the employee |
|||
employeeName |
Name of the employee |
|||
employeePartitioning |
Set as true to apply the partitioning by employee |
|||
entityId |
Ident of the entity |
|||
managerCode |
Code of the manager |
|||
managerFirstName |
First name of the manager |
|||
managerId |
Ident of the manager |
|||
managerIncluded |
Does the search include or not the manager |
|||
managerName |
Name of the manager |
|||
projectId |
Ident of the project (equivalent to the code of the project) linked to the employee (Only supports IN or IS operators) |
|||
projectIdScheduled |
List of [string] |
Ids of the projects (=Codes of the projects) for which the employee has schedules |
||
projectTaskId |
Ident of the project tasks linked to the employee |
|||
readOption |
Options used to get more information about the employee referential |
|||
referentialDate |
Referential date. The default value is today's date |
date-time |
||
referentialDateEnd |
End referential date. If this field is filled (and higher than referentialDate), the search is done on an interval |
date-time |
||
scheduled |
Employee with schedules over the period (see referentialDate) |
|||
serviceCode |
Code of the service |
|||
serviceId |
Ident of the service |
|||
skillCode |
Code of the skill |
|||
skillId |
Ident of the skill |
|||
standardWeekCode |
||||
standardWeekId |
||||
tag |
You can use this clause to do a text search on the code, first name and last name |
|||
tagIdScheduled |
List of [string] |
Ids of tags for which the employee has scheduled tags |
3.164. EmployeeReferentialReadOption
The options you can use to get more information about employee referential.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
options |
List of [string] |
List of options used to get more details about the employee referential |
Enum: STANDARD_WEEK, DUMMY |
3.165. EmployeeTimeRecordingsParamHolder
Holder for the parameter necessary for publishing employee's time recordings
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
arguments |
The arguments for publishing an employee's time recording |
|||
context |
Context for publishing an employee's time recording |
3.166. EmployeeTimeRecordingsPublishContext
Context describing the various options to edit employee's time recordings
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
contextType |
Context of the publish |
|||
displayOptions |
Map of [string] |
Options for data display |
||
employeeId |
ID of the employee |
|||
filters |
Map of [array] |
Filter for data selection discriminating by object IDs grouped by object type |
||
startDate |
Starting date of the time which will be published |
date-time |
3.167. EmployeeWeek
Standard week of the employee
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Code of the standard week |
|||
companyCode |
Code of the company |
|||
dailyHours |
Daily hours worked |
double |
||
dailyMinutes |
Daily minutes worked |
double |
||
employeeId |
ID of the employee |
|||
from |
Date by which standard week can be used |
date-time |
||
id |
Id in database |
|||
leave |
Return True if the employee is absent in this time slot |
|||
name |
Name of the standard week |
|||
to |
Date by which standard week stops being used |
date-time |
||
typicalDaysByWeekDay |
Details of the worked hours for each day |
|||
weekHours |
Week hours worked |
double |
3.168. EmployeesEventsDateDetail
Detail concerning employee's events on a specific date
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
date |
Date of the event |
date-time |
||
employeeId |
ID of the employee |
|||
eventCount |
Number of events |
double |
||
nbLeaveDays |
Number of leave days |
double |
||
nbScheduledDays |
Number of scheduled days |
double |
||
nbWorkedDays |
Number of worked days |
double |
3.169. EmployeesEventsSummary
Summary about employees event on a period
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
employeeId |
ID of the employee |
|||
endDate |
Date by which the summary ends |
date-time |
||
eventCount |
The event count of the employee |
double |
||
nbLeaveDays |
Number of leave days |
double |
||
nbScheduledDays |
Number of scheduled days |
double |
||
nbWorkedDays |
Number of worked days |
double |
||
periodDetails |
List of EmployeesEventsDateDetail |
Details about the event date |
||
scheduledRate |
Result of nbScheduledDays / (nbWorkedDays - nbLeaveDays) |
double |
||
startDate |
Date by which the summary starts |
date-time |
||
targetTace |
Targeted TACE (percentage) |
double |
3.170. Entity
Entity
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
The code of the entity |
|||
companyId |
ID of the company |
|||
division |
Details of the division |
|||
divisionCode |
Code of the division |
|||
divisionId |
ID of the division |
|||
endDate |
End date of the entity |
date-time |
||
id |
Id in database |
|||
legalName |
Legal name of the entity |
|||
name |
The name of the entity |
3.171. EntityBase
Entity
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
The code of the entity |
|||
id |
Id in database |
|||
name |
The name of the entity |
3.172. ErrorMessage
Error message for batch processing
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
ID of the object in error |
|||
message |
Detailed error message related to the identifier |
3.173. ErrorResponse
The canonical model for problem details is a JSON [RFC7159] object.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
A human-readable explanation specific to this occurrence of the problem. |
|||
message |
A human-readable explanation specific to this occurrence of the problem. |
|||
status |
The HTTP status code ([RFC7231], Section 6) |
|||
timestamp |
Timestamp of the error |
date-time |
||
title |
A short, human-readable summary of the problem |
|||
type |
A URI reference [RFC3986] that identifies the problem type |
3.174. EventLocation
Event location
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
description |
Description of the event location |
|||
id |
Id in database |
|||
value |
Value of the event location |
3.175. EventType
Type of event
Type : enum (COMMAND_TASK, COMPANY, CUSTOMER, SUPPLIER, DIVISION, DIVISION_GROUP, EMPLOYEE, EMPLOYEE_HISTORY, ENTITY, EXPENSE, EXPENSE_REPORTS, FEATURE_FLAG, INVOICES_CHECK, ISSUE, PHASE, PROJECT, PROJECT_TASK, SCHEDULE, SPRINT, SUB_PHASE, TASK, TIMERECORDING, DOCUMENT, YEAR, TITLE, FAMILY, SKILL, SERVICE, JOB_TYPE, STANDARD_WEEK, EXPENSE_PROFILE, LANGUAGE, PROJECT_OPTIONS, PROJECT_GROUP, ACTIVITY, DEPARTMENT, REFRESH_CQRS, SPRINT_CARD, WEBHOOK, CONTRACT, QUOTATION, SALES_ORDER, OPPORTUNITY, PURCHASED_ITEM, SOLD_ITEM, CONTACT, EVENT, ALL, SPRINT_CARD_GROUP)
3.176. ExchangeRate
Exchange Rate
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
currency |
Details about the currency |
|||
currencyId |
Id of the currency |
|||
endDate |
End date for using the exchange rate |
date-time |
||
id |
Id in database |
|||
rate |
Exchange rate to convert the amount from euro into an amount in the revelant currency |
double |
||
startDate |
Start date for using the exchange rate |
date-time |
3.177. Expense
Expense
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
action |
The action verb (ADD / UPDATE / REMOVE) |
|||
additionalFreeFields |
Additional free fields of a line |
|||
afterTaxAmountRefunded |
Refunded after-Tax Amount |
double |
||
afterTaxAmountTotal |
Total After-Tax amount expressed in company currency |
double |
||
afterTaxAmountTotalCurrency |
Total After-Tax amount in the currency |
double |
||
afterTaxCurrencyAmountRefunded |
Refunded after-Tax Amount in currency |
double |
||
alerts |
List of Alert |
Details about alert messages |
||
amountCalculated |
Amount calculated |
double |
||
amountCategory |
Amount Category (Unitary/Total) |
|||
amountDue |
Amount due |
double |
||
amountRefunded |
Amount already refunded |
double |
||
amountTotal |
Total amount expressed in company currency |
double |
||
amountTotalCurrency |
Total amount in the currency |
double |
||
amountWithoutVat |
Amount exempt from VAT |
double |
||
arrivalLocation |
Location of departure |
|||
businessCard |
Return true if the expense has been realized with a business card |
|||
changeTracking |
Date and user of creation and modification |
|||
complementName |
Description of the line |
|||
controls |
Controls to be enabled on expenses. |
|||
currency |
Details about the currency |
|||
currencyCode |
Code of the currency |
|||
customAssignment |
Custom assignment (for mobile version only) |
|||
customRequest |
Details about the custom request |
|||
customRequestId |
ID of the custom request |
|||
customer |
Details about the customer |
|||
customerId |
ID of the customer |
|||
dateAcceptationOfDenial |
Acceptation date of the denial |
date-time |
||
dateCancellationOfDenial |
Cancellation date of the denial |
date-time |
||
dateOfDenial |
Denial date of the expense |
date-time |
||
departureLocation |
Location of departure |
|||
documents |
List of Document |
Details about documents linked to the expense |
||
employeeAcceptationOfDenial |
Details about the employee who accepted the denial |
|||
employeeAcceptationOfDenialId |
ID of the employee who accepted the denial |
|||
employeeCancellationOfDenial |
Details about the employee who cancelled the denial |
|||
employeeCancellationOfDenialId |
ID of the employee who cancelled the denial |
|||
exchangeRate |
Details about the exchange rate |
|||
expenseDate |
Date of the expense |
date-time |
||
expenseReportId |
ID of the expense report |
|||
expenseType |
Details about the expense type |
|||
expenseTypeId |
ID of the expense type |
|||
fiscalPower |
Details about fiscal power |
|||
forcedVat |
Forced VAT for the line |
|||
generalAccount |
General Account |
|||
guests |
List of Guest |
Details about guests |
||
guid |
ID of the expense (for mobile version only) |
|||
id |
Id in database |
|||
kilometers |
Number of kilometers. |
double |
||
kmTotal |
Total of kilometers driven |
double |
||
managementObjectId |
Id of the management object |
|||
missionNumber |
Number of the mission |
|||
name |
Name of the line |
|||
notRefundable |
Return true if the expense cannot be refunded |
|||
numberOfDocuments |
Number of documents linked to the expense |
|||
parts |
Number of parts |
double |
||
phase |
Details about the phase of the project. |
|||
phaseId |
ID of the phase |
|||
preTaxAmountRefunded |
Refunded pre-Tax Amount |
double |
||
preTaxCurrencyAmountRefunded |
Refunded pre-Tax Amount in currency |
double |
||
preTaxExpenseAmount |
Pre-tax amount |
double |
||
previousExpenseId |
ID of the previous expense |
|||
project |
All details about the project |
|||
projectId |
ID of the project (equivalent to the code of the project) |
|||
projectTask |
Details about the project task of the project |
|||
projectTaskId |
Id of the project task |
|||
quantity |
Quantity of the product |
double |
||
rankNumber |
Rank number of the line |
double |
||
rebillable |
Return true if the expense can be rebilled |
|||
receiptNumber |
Number of the receipt |
|||
refusalComment |
Refusal comment |
|||
refused |
Return true if the expense has been refused |
|||
refusingEmployee |
Details about the refusing employee |
|||
refusingEmployeeId |
ID of the refusing employee |
|||
resource |
Resource allocated to complete the task |
|||
resourceId |
Id of the resource allocated to complete the task |
|||
retrievedExpense |
Indicates whether the expense was retrieved following a refusal. This field is False by default. |
|||
smartScan |
Details about the Smartscan state |
|||
subPhase |
Details about the sub-phase of the project |
|||
subPhaseId |
ID of the sub-phase |
|||
syncError |
Return true if the expense is not completed |
|||
threshold |
Threshold of the expense, defined by the expense type |
double |
||
totalPrice |
Total price before discount expressed in company currency (unit price * quantity) |
double |
||
totalPriceCurrency |
Total price before discount in the currency (unit price * quantity) |
double |
||
unitPrice |
Unit price of the product expressed in company currency |
double |
||
unitPriceCurrency |
Unit price of the product expressed in company currency. The value in this field is not stored. Upon retrieval, it is calculated based on the rate in effect on the date of the management sales object. |
double |
||
vat1 |
Details about the first VAT rate |
|||
vat2 |
Details about the second VAT rate |
|||
vat3 |
Details about the third VAT rate |
|||
vatAmount1 |
Amount expressed in company currency with the first VAT |
double |
||
vatAmount1Currency |
Amount in currency for the first VAT |
double |
||
vatAmount2 |
Amount expressed in company currency for the second VAT |
double |
||
vatAmount2Currency |
Amount in currency for the second VAT |
double |
||
vatAmount3 |
Amount in euro for the third VAT |
double |
||
vatAmount3Currency |
Amount in currency for the third VAT |
double |
||
vehicle |
Details about vehicle |
3.178. ExpenseCategory
Category of expense type
Type : enum (REGULAR, MILEAGE, TOLL, RESTAURANT_DOUBLE_VAT)
3.179. ExpenseControl
Control elements to be applied on expense
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
duplicateForSameEmployee |
This field is set on true if the expense is a duplicate expense for the same employee. |
|||
duplicateForSeveralEmployees |
This field is set to true if the expense is a duplicate expense for several employees. |
|||
onLeaveDay |
This field is set to true if the expense is entered on a day the employee is absent. |
|||
onNonWorkingDay |
This field is set to true if the expense is entered on an employee's non-working day. |
3.180. ExpenseCriteria
All the criteria that can be used to search for Expense
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
billable |
Set as True if you want to include billed expenses |
|||
date |
Date of the expense |
|||
duplicateForSameEmployeeControl |
Set to true to return duplicate expenses for the same employee. |
|||
duplicateForSeveralEmployeeControl |
Set to true to return duplicate expenses for several employees. |
|||
expenseTypeId |
Ident of the expense type |
|||
id |
Ident of the expense |
|||
missionNumber |
Number of the mission |
|||
onDayWithLeaveRequestControl |
Set to true to return expenses entered on a day with an leave request. |
|||
onNonWorkingDayControl |
Set to true to return expenses entered on a non-working day. |
|||
project |
Project linked to the expense |
|||
proofNumber |
Number of the proof (use receiptNumber instead) |
|||
receiptNumber |
Number of the receipt |
|||
refused |
Set as True to return expense refused |
|||
syncError |
Set as True if you want to include incomplete expenses |
3.181. ExpenseDashboardCriteria
All the criteria that can be used to search for ExpenseDashboard
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
expenseCriteria |
Search criteria for expenses |
|||
expenseReportCriteria |
Search criteria for expense reports |
3.182. ExpenseDashboardResult
Result of expenses dashboard
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
expense |
Details about expenses |
|||
expenseReport |
Details about expense reports |
|||
id |
Id in database |
3.183. ExpenseLineTemplate
Expense line's template
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
expenseReportTemplateId |
Ident of the template |
|||
expenseTypeExpected |
Expense type expected for this template |
|||
expenseTypeExpectedId |
Id of the Expense type expected |
|||
id |
Ident of the line template |
|||
quantity |
Quantity by default |
double |
||
rankNumber |
Rank number of the line |
double |
||
type |
Type of the template line. |
|||
unitPrice |
Unit price by default |
double |
||
withExpenseReport |
Meant for expense reports |
3.186. ExpenseRebillableOptions
Default option to bill again the customer
Type : enum (REFUND_AMOUNT, INPUT_AMOUNT, NOTHING)
3.187. ExpenseReceiptSummary
Details about the expense receipt
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
amount |
Amount on the receipt |
double |
||
currencyCode |
Code of the currency |
|||
date |
Date of the document |
date-time |
||
expenseTypeCode |
Code of expense's type |
|||
filePath |
Path of the document |
|||
rebillable |
Return true if the expense can be rebilled |
3.188. ExpenseReport
ExpenseReport
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
accountingJournal |
Details of the accounting journal |
|||
accountingJournalId |
ID of Accounting Journal |
|||
afterTaxAmount |
After-Tax amount expressed in company currency |
double |
||
afterTaxAmountCurrency |
After-Tax amount in the currency |
double |
||
approvalDate |
Date of approval |
date-time |
||
approvalState |
State of approval |
|||
assignmentIndicator |
Specifies the type of project and phase: mono project and mono phase, mono project and multi phase, or multi project. |
|||
changeTracking |
||||
code |
Code of the expense report |
|||
comment |
Comment |
|||
companyCode |
The company code |
|||
companyId |
ID of the company |
|||
completionDate |
Date by which the expense report is completed |
date-time |
||
conditionOfPayment |
||||
currency |
Currency used in the management object |
|||
currencyCode |
Code of the currency used in the management object |
|||
customData |
Map of CustomData |
The custom data (when present) |
||
date |
Date on the management object |
date-time |
||
description |
Description |
|||
employee |
Details about the employee |
|||
employeeId |
ID of the employee |
|||
entityCode (Deprecated) |
The entity code |
|||
exchangeRate |
The currency's exchange rate |
double |
||
expenses |
List of Expense |
Details about expenses |
||
fiscalYear |
Belonging fiscal year |
|||
fiscalYearId |
Id of the fiscalYear |
|||
group |
Group object |
|||
guid |
ID of the expense report (for mobile version only) |
|||
id |
Id in database |
|||
internal |
Internal object |
|||
invoicedDate |
Date by which the expense report is billed |
date-time |
||
manager |
Details of the employee |
|||
managerId |
Id of the manager |
|||
methodOfPayment |
Method of payment |
|||
missionNumber |
Number of the mission |
|||
name |
Name of the management object |
|||
number |
The number of the management object |
|||
paidDate |
Date by which the expense report is paid |
date-time |
||
payment (Deprecated) |
Deprecated : Use conditionOfPayment instead |
|||
phase |
Details about the phase of the project. |
|||
phaseId |
ID of the phase |
|||
preTaxAmount |
Pre-Tax Amount expressed in company currency |
double |
||
preTaxAmountCurrency |
Pre-Tax Amount in the currency |
double |
||
pricingMethod |
Details about the pricing method. The method by which pricing is to be determined. |
|||
pricingMethodId |
The id of the pricing method |
|||
project |
All details about the project |
|||
projectId |
ID of the project (equivalent to the code of the project) |
|||
projectTask |
Details about the project task of the project |
|||
projectTaskId |
Id of the project task |
|||
regularizationReason |
Reason of the regularization |
|||
rejectionComment |
Reason of the rejection |
|||
rejectionDate |
Date by which the expense report is rejected |
date-time |
||
subPhase |
Details about the sub-phase of the project |
|||
subPhaseId |
ID of the sub-phase |
|||
supplier |
Details about the supplier |
|||
thirdPartyId |
The Id of the third-party |
|||
thirdPartyToBillId |
The Id of the third-party to bill |
|||
type |
Example : QUOTATION |
|||
validationDate |
Date by which the expense report is validated |
date-time |
3.189. ExpenseReportBillingParameters
ExpenseReportBillingParameters
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
accountingJournalId |
ID of the accounting journal |
|||
billingDate |
Date by which the expense report will be billed |
date-time |
||
entityId |
ID of the entity |
|||
fiscalYearId |
ID of the fiscal year |
|||
invoiceDateWithExpenseCreationDate |
Set as True if you want Purchase Invoice Date equal Expense Report Date |
|||
mergeJustificatories |
Set as True if you want to merge receipts |
|||
paymentDate |
Date by which the expense report will be paid |
date-time |
3.190. ExpenseReportCriteria
Criteria used to get more details about expense report
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
acceptationOfDenial |
Set as True if you want to search an expense with an accepted denial date |
|||
billed |
Set as True if you want to include billed expense report |
|||
cancelled |
Set as True if you want to include cancelled expense reports |
|||
code |
Code of the expense report |
|||
companyCode |
Code of the company |
|||
completed |
Set as True if you want to include completed expense report |
|||
date |
Date of the expense report |
|||
employeeDivisionGroupingId |
Ident of the employee's division grouping |
|||
employeeDivisionId |
Ident of the employee's division |
|||
employeeEstablishmentId |
Ident of the employee's entity |
|||
employeeId |
Ident of the employee |
|||
employeeServiceId |
Ident of the employee's service |
|||
expenseDate |
Expense date in the expense report |
|||
expenseId |
Ident of the expense |
|||
id |
Ident of the expense report |
|||
invoicedDate |
Date by which the expense report has been billed |
|||
isMultiCompany |
Set as True if you want to search on all companies |
|||
managerId |
Ident of the manager |
|||
missionNumber |
The mission number |
|||
mode |
If mode is set as 'latest' then the research will include all non invoiced and the latest expense invoiced. |
|||
readOption |
Options for retrieving extra information concerning the expense report |
|||
refused |
Set as True if you want to include refused expense reports |
|||
regularizationReason |
Reason of the regularization |
|||
rejected |
Set as True if you want to include rejected expense reports |
|||
validated |
Set as True if you want to include validated expense report |
3.191. ExpenseReportGroupBy
Group results based on the given combination in this enumeration
Type : enum (GUESTS_EMPLOYEE_CODE, EXPENSE_TYPE_NAME, EMPLOYEE_CODE)
3.192. ExpenseReportIdListParamHolder
ExpenseReportIdListParamHolder
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
expenseReportIdList |
List of [string] |
List of expense report's id |
3.194. ExpenseReportReadOption
Criteria used to get more details about an expense report.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
options |
List of [string] |
List of options used to get more details about an expense report |
Enum: SUPPLIER, EMPLOYEE, EMPLOYEE_BUSINESS_CARDS, MANAGER, CHANGE_TRACKING, 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 |
3.195. ExpenseReportTemplate
Expense Report's template
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Code of the template |
|||
companyId |
The ident of the company |
|||
endDate |
End date for using the template |
date-time |
||
id |
Ident of the template |
|||
lines |
List of ExpenseLineTemplate |
Line of expense's template |
||
name |
Name of the template |
3.196. ExpenseReportTemplateCriteria
Criteria
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
||||
companyId |
||||
endDate |
The expense report template end date |
|||
id |
||||
name |
||||
readOption |
Options for retrieving extra information concerning the template |
3.197. ExpenseReportTemplateReadOption
ReadOption of an Expense Report's Template
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
options |
List of [string] |
List of options used to get more details about an expense report template |
Enum: LINE, LINE_EXPENSE_TYPE_EXPECTED |
3.198. ExpenseThreshold
Expense limit for an employee and a given expenseType
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
hasThreshold |
Return True if the expense type has a threshold |
|||
id |
Id in database |
|||
threshold |
Threshold of an expense |
double |
3.199. ExpenseThresholdParamHolder
Information required to authorize exceeding the threshold of an expense report without cancelling the approvals.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
threshold |
Threshold information required to authorize exceeding the limit. |
double |
3.200. ExpenseType
Expense type
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
amountEditable |
Return true if the amount can be modified |
|||
billableEditable |
Return true if the billable indicator can be modified |
|||
calculateKilometers |
Return true to calculate the number of kilometers with Google APIs. |
|||
code |
Code of the expense type |
|||
color |
Hexadecimal code of the color |
|||
commentRequired |
Return true if a comment is required |
|||
controls |
Controls to be enabled on expense types. |
|||
controlsBehavior |
List of ControlBehavior |
Field control behavior for expense Type |
||
defaultAmount |
Default amount |
double |
||
description |
Description of the expense type |
|||
endDate |
End date of validity of the expense type |
date-time |
||
expenseCategory |
Details about the expense category |
|||
expenseRebillableOptions |
Details about the rebillable options |
|||
expenseThreshold |
Threshold by expense |
double |
||
expenseThresholdExceededNoVat |
No VAT if exceeded threshold. If true, VAT is disabled and reset to 0 on the expense when the amount is over the threshold. |
|||
freeEntryProhibited |
Return true if free entry of kilometers is forbidden. |
|||
guestsRequired |
Return true if a guest is required |
|||
hideVat |
Return true if the VAT is hidden |
|||
icon |
Name of the icon |
|||
id |
Id in database |
|||
km |
Return true if the expense type is a mileage allowance |
|||
notRefundable |
Return true if the expense type is not refundable |
|||
notRefundableEditable |
Return true if the expense type is refundable and can be modified (Web portal and phone display) |
|||
receiptRequired |
Return true if a receipt is required |
|||
showAdditionalComment |
Return true if the additional comment is displayed for the web portal and the phone app |
|||
showAmountCategory |
Return true if the amount category is displayed for the web portal and the phone app |
|||
showAmountWithoutVat |
Return true if web portal and phone display the amount without VAT |
|||
showBillable |
Return true if the checkbox billable is displayed for the web portal and the phone app |
|||
showCustomRequest |
Return True if custom requests are allowed on this expense type |
|||
showQuantity |
Return true if web portal and phone display quantity |
|||
showReceiptNumber |
Return true if the receipt number is displayed for the web portal and the phone app |
|||
vat1Code |
First VAT code |
|||
vat2Code |
Second VAT code |
|||
vat3Code |
Third VAT code |
3.201. ExpenseTypeControl
Control elements to be applied on expense type
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
enableDuplicate |
This field is set to true to enable duplicate expense report control |
|||
enableOnDayWithLeaveRequest |
This field is set to true to enable expense type control for expense type incurred on a day with an leave request. |
|||
enableOnDayWithTimesheetOrSchedule |
This field is set to true to enable control of expense types incurred on days with timesheet or schedules entered on a project for leaves. |
|||
enablelOnNonWorkingDay |
This field is set to true to enable expense report control for expense report incurred on a non-working day. |
3.202. ExpenseTypeCriteria
Criteria used on Expense Type when doing a search
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Code of the expense type |
|||
companyCode |
Code of the company |
|||
description |
Description of the expense type |
|||
duplicateControl |
Set to 'true' for expense types with duplicate expense type control enabled. |
|||
employeeId |
Ident of the employee |
|||
id |
Ident of the expense type |
|||
onDayWithLeaveRequestControl |
Set to 'true' for expense types with control enable on expenses incurred on a day with an leave request. |
|||
onDayWithTimesheetOrScheduleControl |
Set to 'true' for control enable on expense types incurred on a day with timesheet or schedule entered on a project for leaves. |
|||
onNonWorkingDayControl |
Set to 'true' for expense types with control enable on expenses incurred on a non-working day. |
|||
readOption |
Options for retrieving extra information concerning the expense type. |
|||
tag |
You can fill in the code or name of the expense type in this field |
|||
validity |
Details about the validity criteria |
3.203. ExpenseTypeExpected
Expected expense type
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Code of the expected expense type |
|||
defaultExpenseReport |
Whether or not the custom request line will be an expense report by default |
|||
description |
Description of the expected expense type |
|||
editableExpenseReport |
Whether or not we can choose to transform the custom request line into an expense report |
|||
endDate |
End date for using the expected expense type |
date-time |
||
expenseType |
Expense type |
|||
expenseTypeId |
The expense type id |
|||
id |
Id in database |
|||
name |
Name of the expected expense type |
3.204. ExpenseTypeExpectedCriteria
Criteria used on Expected Expense Type when doing a search
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Code of the expected expense type |
|||
companyId |
Ident of the company |
|||
id |
Ident of the expected expense type |
|||
name |
Name of the expected expense type |
|||
readOption |
Options for retrieving extra information concerning the expected expense type |
|||
tag |
You can fill in the code or name of the expected expense type in this field |
|||
validity |
Details about the validity criteria |
3.205. ExpenseTypeExpectedReadOption
Criteria used to get more details about an expected expense type.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
options |
List of [string] |
List of options used to get more details about an expected expense type |
Enum: EXPENSE_TYPE |
3.206. ExpenseTypeReadOption
Criteria used to get more details about an expense type.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
options |
List of [string] |
List of options used to get more details about the expense type |
Enum: CONTROLS_BEHAVIOR |
3.207. ExpenseWithVehicleParamHolder
Param holder for expense with vehicle
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
completed |
Return true if the expense report is completed |
|||
employeeId |
Ident of the employee |
|||
expenseDate |
Date of the expense |
date-time |
||
expenseId |
Ident of the expense |
|||
expenseReportId |
Ident of the expense report |
|||
expenseTypeId |
Ident of the expense type |
|||
kilometersEnteredOnCurrentExpense |
Number of kilometers driven |
double |
||
licensePlate |
License Plate of the vehicle |
|||
power |
Power of the engine |
double |
3.208. FeatureFlag
Application feature
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
active |
If the feature is active |
|||
domain |
Feature classification (main level) |
|||
id |
Feature identifier |
|||
label |
Feature description |
|||
subDomain |
Feature classification (detail level) |
3.209. FieldError
Object containg the error for a field
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
elementId |
The id of the sub element in error (which can have several errors) |
|||
fieldName |
X |
The fieldName of the field in error |
||
message |
X |
The error message |
3.210. FinancialConditionOfPayment
The condition of payment for a customer
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Payment code |
|||
day |
Day of the month on which the payment will be done |
double |
||
deadLine |
Number of days to carry out the payment |
|||
referenceOnBankStatement |
Reference on bank statement |
|||
term |
Period of payment |
3.211. FiscalPower
Fiscal power
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
endDate |
Date by which the fiscal power ends |
date-time |
||
expenseTypeId |
ID of the expense type linked |
|||
id |
Id in database |
|||
power |
Power of the engine |
double |
||
rate |
Refund rate |
double |
||
startDate |
Date by which the fiscal power starts |
date-time |
3.212. FiscalPowerCriteria
Criteria used to get more details about a fiscal power
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
companyCode |
Code of the company |
|||
employeeId |
Ident of the employee |
|||
expenseTypeId |
Ident of the expense type |
|||
id |
Ident of the fiscal power |
|||
power |
Power of the engine |
|||
rate |
Refund rate |
|||
validity |
Details about the validity criteria |
3.213. FiscalYearBase
Fiscal Year
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Code of the FiscalYear |
|||
id |
Id in database |
|||
journalEntryNumberingId |
Id of the JournalEntryNumbering |
|||
name |
Name of the FiscalYear |
3.214. FiscalYearCommon
Fiscal Year
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
closingDate |
Date on which the fiscal year is officially closed. |
date |
||
code |
Code of the FiscalYear |
|||
endDate |
Fiscal year's end date |
date |
||
id |
Id in database |
|||
journalEntryNumberingId |
Id of the JournalEntryNumbering |
|||
name |
Name of the FiscalYear |
|||
startDate |
Fiscal year's start date |
date |
3.215. FixedAssetRecordSheetBase
Fixed asset record sheet
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
Id in database |
|||
name |
Name of fixed asset record sheet |
3.216. FixedAssetRecordSheetCommon
Fixed asset record sheet
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
Id in database |
|||
name |
Name of fixed asset record sheet |
|||
number |
Number of fixed assets |
3.218. ForcedVatAmountHolder
VAT Amount and forced indicator holder
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
amount |
Forced amount |
double |
||
forced |
X |
Returns true if the amount is forced |
||
managementObjectLineId |
ID of the management object line |
3.219. FormConfig
Form Config
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
controls |
Map of ControlBehavior |
Details about the control behavior linked to the field |
||
deletable |
Deletion allowed |
|||
editable |
Update allowed |
|||
fields (Deprecated) |
List of ControlBehavior |
Details about the control behavior linked to the field |
||
formSearchHidden |
Form search hidden |
|||
insertable |
Creation allowed |
|||
type |
Type of the formConfig |
3.220. FormConfigType
Type of form config
Type : enum (TIMESHEET, SCHEDULE, PROJECT, SEARCH_PROJECT, PHASE, SUB_PHASE, PROJECT_TASK, SEARCH_PROJECT_TASK, SEARCH_EMPLOYEE, EMPLOYEE, SEARCH_CUSTOMER, CUSTOMER, SEARCH_CONTACT, CONTACT, SEARCH_EVENT, EVENT, SEARCH_ISSUE, ISSUE, ISSUE_TASK, SEARCH_SPRINT_CARDS, LEAVE_REQUEST, CUSTOM_REQUEST, SEARCH_PROJECT_EVENT, SEARCH_LEAVE_REQUEST_EMPLOYEE, SEARCH_LEAVE_REQUEST_MANAGER, SEARCH_APPROVAL, SEARCH_TIMESHEET_ENTRY, SEARCH_SCHEDULE, SEARCH_EXPENSE_REPORT_EMPLOYEE, SEARCH_EXPENSE_REPORT_MANAGER, SEARCH_CUSTOM_REQUEST, OPPORTUNITY, OPPORTUNITY_LINE, QUOTATION, QUOTATION_LINE, SALES_ORDER, SALES_ORDER_LINE, SALES_BILLING_TABLE, SALES_INVOICE, DELIVERY, DELIVERY_LINE, PRODUCTION_TO_BE_BILLED, PIPELINE_STAGE, SEARCH_PIPELINE_STAGE, QUOTE, QUOTE_LINE, PURCHASE_ORDER, PURCHASE_ORDER_LINE, PURCHASE_BILLING_TABLE, PURCHASE_INVOICE, RECEPTION, TEMPORARY_PURCHASE_INVOICE, SEARCH_OPPORTUNITY, SEARCH_QUOTATION, SEARCH_SALES_ORDER, SEARCH_SALES_BILLING_TABLE, SEARCH_SALES_INVOICE, SEARCH_DELIVERY, SEARCH_PRODUCTION_TO_BE_BILLED_EMPLOYEE, SEARCH_PRODUCTION_TO_BE_BILLED_MANAGER, SEARCH_QUOTE, SEARCH_PURCHASE_ORDER, SEARCH_PURCHASE_BILLING_TABLE, SEARCH_PURCHASE_INVOICE, SEARCH_RECEPTION, SEARCH_TEMPORARY_PURCHASE_INVOICE, SEARCH_SCHEDULE_BY_PROJECT, SEARCH_SCHEDULE_BY_EMPLOYEE, SEARCH_SCHEDULE_TIMESTAMPED, SEARCH_SCHEDULE_WORKLOAD)
3.221. GeneralAccountBase
General account (ident example AKSAS22106800)
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
Id in database |
|||
name |
General account label |
3.222. GeneralAccountCommon
General account
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
Id in database |
|||
name |
General account label |
|||
number |
General account number |
3.223. GeographicalDepartment
Geographical department
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Code of the geographical department |
|||
companyId |
The id of the company |
|||
id |
Id in database |
|||
name |
Name of the geographical department |
|||
regionId |
The id of the region |
3.224. GroupByResult
Criteria used for aggregating the results when searching expense reports
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
groupByValue |
The value by which the results are grouped |
|||
groupIds |
List of [string] |
List of IDs that will be grouped by 'groupByValue' |
3.225. Guest
A guest of an expense report
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
company |
Company of the guest |
|||
employee |
Details about the guest employee |
|||
employeeId |
ID of the guest employee |
|||
expenseId |
ID of the expense linked |
|||
firstName |
First name of the guest |
|||
id |
Id in database |
|||
lastName |
Last name of the guest |
3.226. HistoryEntry
State of a project
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
action |
Action of the modification |
|||
changeTracking |
Date and user in case of creation and modification |
|||
comment |
Comment of the modification |
|||
entryType |
Type of the entry |
|||
fieldName |
Name of the modified field |
|||
historyType |
Type of the modified object |
|||
id |
ID of the modification |
|||
objectId |
ID of the modified object |
|||
valueAfter |
Value after the modification |
|||
valueBefore |
Value before the modification |
3.227. HistoryEntryReadOption
ReadOption of a HistoryEntry
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
options |
List of [string] |
List of options used to get more details about the history entry |
Enum: CHANGE_TRACKING |
3.229. HistoryType
Type of the modified object
Type : enum (ISSUE, TASK, OPPORTUNITY, QUOTATION, SALES_ORDER, SALES_INVOICE, SALES_BILLING_TABLE, DELIVERY, QUOTE, PURCHASE_ORDER, PURCHASE_INVOICE, PURCHASE_BILLING_TABLE, RECEPTION, CONTACT, EMPLOYEE, EVENT, CUSTOMER, PROJECT)
3.230. Holiday
Holiday
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
date |
Date of the holiday |
date-time |
||
type |
Type of holiday |
3.231. IBAN
Details about the IBAN of a people
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
accountNumber |
Account number - 11 digits max |
|||
country |
Country code of the address in the database |
|||
key |
Key of the IBAN |
3.232. IdIdentifiable
Basic type for all pojos with an API ID
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
Id in database |
3.233. InternationalBankAccountDetails
International bank account details
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
bank |
Details to identify the international bank |
|||
holder |
Holder of the international bank |
3.234. InternationalBankHolder
Holder of the international bank
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
accountNumber |
Account number |
|||
accountType |
Type of the account for the holder |
|||
firstName |
The first name of the holder |
|||
name |
The name of the holder |
3.235. InternationalBankIdentification
Details to identify the international bank
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
bankAddress |
Details about bank address |
|||
bankCode |
The code of the bank |
|||
bankName |
The name of the bank |
|||
bankName2 |
The name 2 of the bank |
|||
bankType |
The type of the bank |
3.236. InventoryAndPackaging
Details about Inventory and Packaging
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
packagingType |
The packaging type of the item |
|||
packagingUnit |
The packaging unit of the item |
double |
3.238. IssueBase
Issue base
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
Id in database |
3.239. IssueCommon
Issue common
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
Id in database |
|||
number |
The number of the issue. |
|||
title |
The title of the issue. |
3.240. Item
Item
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
accountSettings |
Accounting information for an item. |
|||
billingMode |
defaut billing mode for the item |
|||
category |
All details about the category of the product |
|||
categoryId |
The Id of the category |
|||
comment |
Comment on the product |
|||
companyCode |
The company code |
|||
customData |
Map of CustomData |
All custom data to update |
||
entityCode |
The entity code |
|||
family (Deprecated) |
The category of the product |
|||
grouping |
The grouping of the product |
|||
id |
Id in database |
|||
inventory |
Returns true if the product is in the inventory |
|||
inventoryAndPackaging |
Details about Inventory and Packaging |
|||
name |
Identification name |
|||
productionEstimatedDuration |
Estimated duration in minutes |
double |
||
quantityPrecision |
Number of decimals for this item quantity |
double |
||
reference |
The reference of the product |
|||
shortName |
Abbreviated designation |
|||
subCategory |
All details about the sub-category of the product |
|||
subCategoryId |
The Id of the sub-category |
|||
subFamily (Deprecated) |
The sub-category of the product |
|||
unitPricePrecision |
Number of decimals for this item unit price |
double |
3.241. ItemAccountingInfo
Accounting information for an item
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
disabledDate |
Disabled date of the purchased item. |
date |
||
exportCostAccount |
Number of the export cost account set for purchased item export transactions. |
|||
exportGroupAccount |
Number of the export group account set for purchased item export group transactions. |
|||
intraComCostAccount |
Number of the intra-community cost account set for purchased item intracom transactions. |
|||
intraComGroupAccount |
Number of the intra-community group account set for purchased item intracom group transactions. |
|||
intraComInternalAccount |
Number of intra-community internal account set for purchased item intracom internal transactions. |
|||
intraComSubscriptionAccount |
Number of the intra-community subscription account set for purchased item intracom subscription transactions. |
|||
localCostAccount |
Number of the local cost account set for purchased item local transactions. |
|||
localGroupAccount |
Number of the local group account set for purchased item local group transactions. |
|||
localInternalAccount |
Number of the local internal account set for purchased item local internal transactions. |
|||
localSubscriptionAccount |
Number of the local subscription account set for purchased item local subscription transactions. |
|||
marketEndDate |
End of market of the purchased item. |
date |
||
reverseVAT |
Set the purchased item with reverse VAT liability. |
|||
toBeEstablishedAccount |
To be established account |
|||
vatCode |
X |
Code of the VAT tax rate for the purchased item. |
3.242. ItemBase
Item
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
Id in database |
3.243. ItemCommon
Details about the commons item's properties
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
grouping |
The grouping of the product |
|||
id |
Id in database |
|||
name |
The name of the product |
|||
reference |
The reference of the product |
3.244. ItemLine
ItemLine
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
action |
The action verb (ADD / UPDATE / REMOVE) |
|||
additionalFreeFields |
Additional free fields of a line |
|||
afterTaxAmountTotal |
Total After-Tax amount expressed in company currency |
double |
||
afterTaxAmountTotalCurrency |
Total After-Tax amount in the currency |
double |
||
amountTotal |
Total amount expressed in company currency |
double |
||
amountTotalCurrency |
Total amount in the currency |
double |
||
complementName |
Description of the line |
|||
discount |
Discount applied |
|||
endDate |
Period end date |
date-time |
||
forcedVat |
Forced VAT for the line |
|||
generalAccount |
General Account |
|||
id |
Id in database |
|||
item |
Details about the item |
|||
itemId |
The Id of the product |
|||
managementObjectId |
Id of the management object |
|||
name |
Name of the line |
|||
phase |
Details about the phase of the project. |
|||
phaseId |
ID of the phase |
|||
project |
All details about the project |
|||
projectId |
ID of the project (equivalent to the code of the project) |
|||
projectTask |
Details about the project task of the project |
|||
projectTaskId |
Id of the project task |
|||
quantity |
Quantity of the product |
double |
||
rankNumber |
Rank number of the line |
double |
||
resource |
Resource allocated to complete the task |
|||
resourceId |
Id of the resource allocated to complete the task |
|||
startDate |
Period start date |
date-time |
||
subPhase |
Details about the sub-phase of the project |
|||
subPhaseId |
ID of the sub-phase |
|||
totalPrice |
Total price before discount expressed in company currency (unit price * quantity) |
double |
||
totalPriceCurrency |
Total price before discount in the currency (unit price * quantity) |
double |
||
unitPrice |
Unit price of the product expressed in company currency |
double |
||
unitPriceCurrency |
Unit price of the product expressed in company currency. The value in this field is not stored. Upon retrieval, it is calculated based on the rate in effect on the date of the management sales object. |
double |
||
vat1 |
Details about the first VAT rate |
|||
vat2 |
Details about the second VAT rate |
|||
vatAmount1 |
Amount expressed in company currency with the first VAT |
double |
||
vatAmount1Currency |
Amount in currency for the first VAT |
double |
||
vatAmount2 |
Amount expressed in company currency for the second VAT |
double |
||
vatAmount2Currency |
Amount in currency for the second VAT |
double |
3.245. JobType
Job type of an employee
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
category |
Details about the job type category |
|||
code |
Code of the job type |
|||
companyCode |
Code of the company |
|||
default |
Return true if this job type is used by default |
|||
id |
Id in database |
|||
name |
Name of the job type |
|||
validity |
End date of validity |
3.246. JobTypeCategory
Category of the job type
Type : enum (NOT_SPECIFIED, COMMERCIAL, ADMINISTRATIVE, MANAGEMENT, OPERATIONAL, EQUIPMENT)
3.247. JournalEntryNumberingBase
Numbering of the fiscal year journal entries
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
fiscalYearId |
Id of the fiscalYear |
|||
id |
Id in database |
|||
prefix |
Prefix of the JournalEntryNumbering |
3.249. KilometerCompensation
Details about kilometers compensation. This resource is done to calculate amounts due, refunded, calculated and the total kilometers driven.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
amountCalculated |
Amount calculated |
double |
||
amountDue |
Amount due |
double |
||
amountRefunded |
Amount already refunded |
double |
||
kmTotal |
Number of kilometers driven |
double |
3.250. Leave
Leave
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
changeTracking |
Date and user of creation and modification |
|||
comment |
Description of the leave |
|||
commentValidator |
Comment wrote by the manager |
|||
dateValidator |
Date by which the leave is validated |
date-time |
||
duration |
Duration of the leave |
double |
||
employee |
Employee |
|||
employeeId |
ID of the employee |
|||
employeeValidator |
Name of the validator employee (Usually, it's the manager of the employee) |
|||
endDate |
Date by which the leave ends |
date-time |
||
guid |
ID of the leave |
|||
id |
Id in database |
|||
leaveRight |
Leave right |
|||
leaveRightId |
ID of the leave right |
|||
leaveState |
Details about the leave state |
|||
leaveType |
Type of the leave |
|||
modificationTime (Deprecated) |
Date of the last modification |
date-time |
||
requestDate |
Creation date of the leave request |
date-time |
||
startAfterNoon |
Return true if the leave starts in the afternoon |
|||
startDate |
Date by which the leave starts |
date-time |
3.251. LeaveAdjustment
Adjustment of leave rights of an employee
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
date |
Adjustment date |
date-time |
||
id |
Id in database |
|||
reason |
Reason of the adjustment |
|||
user |
User who made the adjustment |
|||
userId |
ID of the user who made the adjustment |
|||
value |
Value of the adjustment (can be positive or negative) |
double |
3.252. LeaveCriteria
Search criteria for leave request
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
comment |
Comment of the leave request |
|||
duration |
Duration of the leave |
|||
employeeId |
Ident of the employee |
|||
endDate |
Date by which the leave ends |
|||
guid |
Global identifier of the leave request |
|||
id |
Ident of the leave request |
|||
leaveRightId |
Ident of the leave right |
|||
leaveState |
Leave state |
|||
managerId |
Ident of the manager |
|||
modificationTime |
Last modification date |
|||
readOption |
Options for retrieving extra information concerning the leave |
|||
requestDate |
Date by which the leave request has been created |
|||
rightEndDate |
End of right |
|||
rightStartDate |
Start of right |
|||
startAfterNoon |
If the leave starts the afternoon, set this field as True |
|||
startDate |
Date by which the leave starts |
3.253. LeaveDuration
Duration of leave according some properties
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
duration |
Duration in days |
double |
||
end |
End of leave |
date-time |
||
estimatedRightAtStart |
Estimated rights at start date |
double |
||
start |
Start of leave |
date-time |
||
startAfterNoon |
True if the leave starts in the afternoon |
3.254. LeaveReadOption
Criteria used to get more details about leave.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
options |
List of [string] |
List of options used to get more details about leave |
Enum: LEAVE_RIGHT, LEAVE_RIGHT_TYPE, EMPLOYEE, CHANGE_TRACKING, FORM_CONFIG |
3.255. LeaveRight
Leave rights of an employee
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
acquiredRight |
The right already acquired |
double |
||
acquisitionEndDate |
Acquisition end date of the leave right |
date-time |
||
acquisitionStartDate |
Acquisition start date of the leave right |
date-time |
||
adjustment |
The adjustment number of the leave right |
double |
||
comment |
Comment on the leave right |
|||
employeeId |
ID of the employee |
|||
endDate |
End date of the leave right |
date-time |
||
estimatedMaxRight |
The estimated right at the acquisition end date |
double |
||
id |
Id in database |
|||
leaveType |
Details about the leave type |
|||
leaveTypeId |
ID of the leave type |
|||
leavesAccepted |
The leaves already accepted |
double |
||
leavesRequested |
The leaves requested |
double |
||
name |
Name of the leave right |
|||
remainingDays |
The remaining days |
double |
||
right |
The remaining right, taking into account the right transfers. This field is read-only |
double |
||
startDate |
Starting date of the leave right |
date-time |
||
tolerance |
Number of additional days that the employee has the right to take |
double |
3.256. LeaveRightCriteria
Criteria for fetching an Employee Rights
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
companyId |
||||
employeeId |
||||
endDate |
End date of the leave right |
|||
id |
||||
leaveId |
||||
readOption |
Options for retrieving extra information concerning the leave rights |
|||
startDate |
Start date of the leave right |
3.257. LeaveRightReadOption
Criteria used to get more details about leave rights.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
options |
List of [string] |
List of options used to get more details about the leave right |
Enum: LEAVE_TYPE |
3.259. LeaveType
The type of leave
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
acquiredCounterDecimals |
Number of decimal places for the earned leave counter. Only values between 2 and 4 are allowed. By default, the value is set to 2 if the field is null. This field cannot be updated if the leave type is incremental (LeaveType = INCREMENT). |
double |
||
actionCode |
Details about the action code of the leave type |
|||
actionCodeId |
ID of the action code of the leave type |
|||
code |
Code of the leave type |
|||
company |
Details about the company |
|||
companyId |
ID of the company |
|||
countDownPartTime |
True if non work days for part-time employees are counted as leave |
|||
counterValue |
Counter Value of the leave type |
double |
||
endDate |
End date of the leave type |
date-time |
||
entity |
Details about the entity |
|||
entityId |
ID of the entity |
|||
entry |
Entry of the leave type |
|||
freeAnalyticCode |
Free analytic code use in a software interface context. |
|||
id |
Id in database |
|||
increment |
Increment of the leave type |
double |
||
name |
Name of the leave type |
|||
order |
The order of the leave type |
double |
||
phase |
Details about the phase |
|||
phaseId |
ID of the phase |
|||
project |
Details about the project |
|||
projectId |
ID of the project (equivalent to the code of the project) |
|||
receiver |
Return true if the employee is a receiver |
|||
restricted |
Return true if the leave type is restricted |
|||
subPhase |
Details about the sub-phase |
|||
subPhaseId |
ID of the sub-phase |
|||
thresholdTolerance |
The threshold tolerance of the leave type |
double |
||
transmitter |
Return true if the employee is a transmitter |
|||
type |
Type of the leave type |
|||
unit |
Unit of the leave type |
3.260. LeaveTypeCriteria
Criteria used on Leave Type when doing a Leave Type search
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
actionId |
Action code of the time recording. Fill in this field with its id. |
|||
code |
||||
companyId |
Ident of the company |
|||
counterValue |
The counter value of the leave type |
|||
entityId |
Ident of the entity |
|||
entry |
||||
id |
||||
increment |
The increment of the leave type |
|||
name |
||||
order |
The order of the leave type |
|||
phaseId |
Ident of the phase |
|||
projectId |
Ident of the project (equivalent to the code of the project) |
|||
readOption |
Options for retrieving extra information concerning the leave type |
|||
receiver |
True if the leave type has a receiver |
|||
restricted |
True if the leave type is restricted |
|||
subPhaseId |
Ident of the sub-phase |
|||
thresholdTolerance |
The threshold tolerance of the leave type |
|||
transmitter |
True if the leave type has a transmitter |
|||
type |
||||
unit |
||||
validity |
Details about the validity criteria |
3.262. LeaveTypeReadOption
Criteria used to get more details about leave type.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
options |
List of [string] |
List of options used to get more details about the leave type |
Enum: COMPANY, PROJECT, ENTITY, PHASE, SUB_PHASE, ACTION_CODE |
3.265. LinkDirectionEnum
A filation link type can be set with a link direction
Type : enum (ASCENDING, DESCENDING, TRANSVERSE, NOT_APPLICABLE)
3.266. 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, CONTRACT, COMPANY, RECEPTION, SALES_BILLING_TABLE, PURCHASE_BILLING_TABLE, TRAINING_SESSION, ASSIGNED_TO, OTHER_THIRD_PARTY, PURCHASE_CONTRACT, DISBURSEMENT, PURCHASE_REQUEST, JOURNAL_ENTRY, RECEIPT, REGISTRATION, REGISTRATION_FILE, TASK, PURCHASE_REQUEST_LINE, PHASE, PROJECT_GROUP, MISCELLANEOUS_TRANSACTIONS, PART, SERVICE, PROSPECT, THIRD_PARTY_SITE, CUSTOMER_SITE, SUPPLIER_SITE, INTERNSHIP, PROJECT_TASK, CUSTOM_REQUEST, TEMPORARY_PURCHASE_INVOICE, FIXED_ASSET, SUB_PHASE, CAMPAIGN, DIRECT_DEBIT_MANDATE)
3.267. LocationStatusBase
Basic information for Status of the maintained product.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Code of the locations status. |
|||
id |
Id in database |
|||
name |
Name of the location status. |
3.268. Mail
Represents all information needed to send a mail (recipient, subject and body)
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
body |
Content of the mail as a text |
|||
cc |
List of [string] |
Mail carbon copy recipients |
||
cci |
List of [string] |
Mail hidden carbon copy recipients |
||
from |
Mail sender |
|||
replyTo |
Mail reply to |
|||
title |
Mail title |
|||
to |
List of [string] |
Mail recipients |
3.269. ManagementCustomerCriteria
Criteria used on Customer when doing a Customer search
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
accountManagerId |
The ID of the account manager for the customer |
|||
categoryId |
Category of the customer |
|||
code |
Name of the customer |
|||
id |
Ident of the customer |
|||
salesmanId |
The ID of the sales man for the customer |
|||
sectorId |
Sector of the customer |
|||
subCategoryId |
Subcategory of the customer |
|||
type |
Type of the customer (between PROSPECT and CUSTOMER) |
3.270. ManagementObject
Management object (pièce de gestion)
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
accountingJournal |
Details of the accounting journal |
|||
accountingJournalId |
ID of Accounting Journal |
|||
afterTaxAmount |
After-Tax amount expressed in company currency |
double |
||
afterTaxAmountCurrency |
After-Tax amount in the currency |
double |
||
approvalDate |
Date of approval |
date-time |
||
approvalState |
State of approval |
|||
assignmentIndicator |
Specifies the type of project and phase: mono project and mono phase, mono project and multi phase, or multi project. |
|||
changeTracking |
||||
companyCode |
The company code |
|||
companyId |
ID of the company |
|||
conditionOfPayment |
||||
currency |
Currency used in the management object |
|||
currencyCode |
Code of the currency used in the management object |
|||
customData |
Map of CustomData |
The custom data (when present) |
||
date |
Date on the management object |
date-time |
||
description |
Description |
|||
entityCode (Deprecated) |
The entity code |
|||
exchangeRate |
The currency's exchange rate |
double |
||
fiscalYear |
Belonging fiscal year |
|||
fiscalYearId |
Id of the fiscalYear |
|||
group |
Group object |
|||
id |
Id in database |
|||
internal |
Internal object |
|||
manager |
Details of the employee |
|||
managerId |
Id of the manager |
|||
methodOfPayment |
Method of payment |
|||
name |
Name of the management object |
|||
number |
The number of the management object |
|||
payment (Deprecated) |
Deprecated : Use conditionOfPayment instead |
|||
phase |
Details about the phase of the project. |
|||
phaseId |
ID of the phase |
|||
preTaxAmount |
Pre-Tax Amount expressed in company currency |
double |
||
preTaxAmountCurrency |
Pre-Tax Amount in the currency |
double |
||
pricingMethod |
Details about the pricing method. The method by which pricing is to be determined. |
|||
pricingMethodId |
The id of the pricing method |
|||
project |
All details about the project |
|||
projectId |
ID of the project (equivalent to the code of the project) |
|||
projectTask |
Details about the project task of the project |
|||
projectTaskId |
Id of the project task |
|||
subPhase |
Details about the sub-phase of the project |
|||
subPhaseId |
ID of the sub-phase |
|||
thirdPartyId |
The Id of the third-party |
|||
thirdPartyToBillId |
The Id of the third-party to bill |
|||
type |
Example : QUOTATION |
3.271. ManagementObjectBase
Basic information on the management object (pièce de gestion)
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
Id in database |
|||
name |
Name of the management object |
|||
number |
The number of the management object |
|||
phase |
Details about the phase of the project. |
|||
phaseId |
ID of the phase |
|||
project |
All details about the project |
|||
projectId |
ID of the project (equivalent to the code of the project) |
|||
projectTask |
Details about the project task of the project |
|||
projectTaskId |
Id of the project task |
|||
subPhase |
Details about the sub-phase of the project |
|||
subPhaseId |
ID of the sub-phase |
3.272. ManagementObjectBatchResult
Object containing :
- the ids of the successfully treated management objects
- the ids of the management objects with errors
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
errors |
List of ErrorMessage |
Contains a list of detailed error messages related to the processing of each identifier. |
||
idsOnError |
List of [string] |
Ids of the management object not processed in batches |
||
idsOnSuccess |
List of [string] |
Ids of the management object processed in batches |
||
managementObjectType |
Type of the management object processed in batches |
3.273. ManagementObjectCommon
Details on common properties of management object (pièce de gestion)
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
afterTaxAmount |
After-Tax amount expressed in company currency |
double |
||
changeTracking |
||||
companyCode |
The company code |
|||
companyId |
ID of the company |
|||
currency |
Currency used in the management object |
|||
currencyCode |
Code of the currency used in the management object |
|||
customData |
Map of CustomData |
The custom data (when present) |
||
date |
Date on the management object |
date-time |
||
description |
Description |
|||
entityCode (Deprecated) |
The entity code |
|||
id |
Id in database |
|||
name |
Name of the management object |
|||
number |
The number of the management object |
|||
phase |
Details about the phase of the project. |
|||
phaseId |
ID of the phase |
|||
preTaxAmount |
Pre-Tax Amount expressed in company currency |
double |
||
project |
All details about the project |
|||
projectId |
ID of the project (equivalent to the code of the project) |
|||
projectTask |
Details about the project task of the project |
|||
projectTaskId |
Id of the project task |
|||
subPhase |
Details about the sub-phase of the project |
|||
subPhaseId |
ID of the sub-phase |
|||
thirdPartyId |
The Id of the third-party |
|||
type |
Example : QUOTATION |
3.274. ManagementObjectCriteria
Criteria used to get more details about the management object.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
afterTaxAmount |
After tax amount of the management object |
|||
approvalDate |
Approval date of the management object |
|||
approvalState |
Approval state of the management object |
|||
companyCode |
Company code of the management object |
|||
creationDate |
Creation date of the management object |
|||
currencyCode |
Currency code of the currency used in the management object |
|||
customData |
Map of Clause |
The custom data (when present) |
||
date |
Date of the management object |
|||
description |
Description of the management object |
|||
entityCode |
Entity code of the management object |
|||
fiscalYearId |
Id of the fiscal year |
|||
group |
True if group |
|||
id |
ID of the management object |
|||
internal |
True if management object is internal |
|||
journalId |
Id of the journal |
|||
managerId |
Id of the manager linked with the management object |
|||
methodOfPayment |
Method of payment of the management object |
|||
name |
Name of the management object |
|||
preTaxAmount |
Pre tax amount of the management object |
|||
thirdPartyId |
Id of the third party |
|||
thirdPartyToBillId |
Id of the third party to bill |
|||
validationDate |
Validation of the management object |
3.275. ManagementObjectLine
Management object line (ligne de pièce de gestion)
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
action |
The action verb (ADD / UPDATE / REMOVE) |
|||
additionalFreeFields |
Additional free fields of a line |
|||
afterTaxAmountTotal |
Total After-Tax amount expressed in company currency |
double |
||
afterTaxAmountTotalCurrency |
Total After-Tax amount in the currency |
double |
||
amountTotal |
Total amount expressed in company currency |
double |
||
amountTotalCurrency |
Total amount in the currency |
double |
||
complementName |
Description of the line |
|||
generalAccount |
General Account |
|||
id |
Id in database |
|||
managementObjectId |
Id of the management object |
|||
name |
Name of the line |
|||
phase |
Details about the phase of the project. |
|||
phaseId |
ID of the phase |
|||
project |
All details about the project |
|||
projectId |
ID of the project (equivalent to the code of the project) |
|||
projectTask |
Details about the project task of the project |
|||
projectTaskId |
Id of the project task |
|||
quantity |
Quantity of the product |
double |
||
rankNumber |
Rank number of the line |
double |
||
resource |
Resource allocated to complete the task |
|||
resourceId |
Id of the resource allocated to complete the task |
|||
subPhase |
Details about the sub-phase of the project |
|||
subPhaseId |
ID of the sub-phase |
|||
totalPrice |
Total price before discount expressed in company currency (unit price * quantity) |
double |
||
totalPriceCurrency |
Total price before discount in the currency (unit price * quantity) |
double |
||
unitPrice |
Unit price of the product expressed in company currency |
double |
||
unitPriceCurrency |
Unit price of the product expressed in company currency. The value in this field is not stored. Upon retrieval, it is calculated based on the rate in effect on the date of the management sales object. |
double |
3.276. ManagementObjectLineCommon
Common properties of management object line
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
amountTotal |
Total amount expressed in company currency |
double |
||
amountTotalCurrency |
Total amount in the currency |
double |
||
id |
Id in database |
|||
managementObjectId |
Id of the management object |
|||
name |
Name of the line |
|||
phase |
Details about the phase of the project. |
|||
phaseId |
ID of the phase |
|||
project |
All details about the project |
|||
projectId |
ID of the project (equivalent to the code of the project) |
|||
projectTask |
Details about the project task of the project |
|||
projectTaskId |
Id of the project task |
|||
quantity |
Quantity of the product |
double |
||
rankNumber |
Rank number of the line |
double |
||
subPhase |
Details about the sub-phase of the project |
|||
subPhaseId |
ID of the sub-phase |
|||
unitPrice |
Unit price of the product expressed in company currency |
double |
||
unitPriceCurrency |
Unit price of the product expressed in company currency. The value in this field is not stored. Upon retrieval, it is calculated based on the rate in effect on the date of the management sales object. |
double |
3.277. ManagementObjectLineCriteria
Criteria used to get more details about the management object line.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
additionalFreeFieldCriteria |
||||
dutiableCriteria |
||||
endDate |
End period clause |
|||
generalAccountNumber |
||||
grouping |
Grouping of the item |
|||
id |
||||
phaseId |
||||
projectCriteria |
Criteria on project linked to the line |
|||
projectId |
||||
reference |
Reference of the item |
|||
resourceId |
Resource allocated to complete the task |
|||
startDate |
Start period clause |
|||
subPhaseId |
3.278. ManagementObjectType
Type of the management object
Type : enum (QUOTATION, SALES_ORDER, QUOTE, PURCHASE_ORDER, CUSTOM_REQUEST, PURCHASE_INVOICE, EXPENSE_REPORT, EXPENSE, INVOICE, SALES_BILLING_TABLE, PURCHASE_BILLING_TABLE, RECEPTION, DELIVERY, PRODUCTION)
3.279. ManagementProjectCriteria
Criteria used on Project when doing a Project search
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
activityId |
||||
categoryId |
||||
companyId |
The Id of the company |
|||
customerId |
||||
customerProjectId |
Ident of the project (equivalent to the code of the project) |
|||
departmentId |
||||
divisionGroupingId |
||||
divisionId |
||||
entityId |
||||
financialManagerId |
||||
id |
||||
managerId |
||||
name |
||||
productionManagerId |
||||
projectGroupCode |
||||
projectState |
||||
referentialDate |
Date à laquelle l'affaire doit être active (en prod) |
date-time |
||
salesManagerId |
||||
subCategoryId |
||||
subCategoryLevel2Id |
||||
tag |
Unused at the moment |
|||
yearId |
Ident of the year |
3.280. ManagerCriteria
Criteria used to get more details about the manager
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
endDate |
End date |
|||
startDate |
Starting date |
|||
tag |
You can use this clause to do a text search on the code, first name and last name |
3.281. ManagerDelegatedCriteria
Criteria used to get more details about the delegated manager
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
delegationModule |
Details about delegation module |
|||
tag |
You can use this clause to do a text search on the code, first name and last name |
3.282. ManagerVisibilityCriteria
Manager's criteria
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
includeManager |
Include manager in the search result |
|||
includeResourcesTwoManagementLevelsBelow |
Include resources from two management levels below (N-2) in the search result |
|||
managerId |
Id of the manager |
3.283. 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.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
attachFile |
Location of the file to be attached. |
|||
ccRecipients |
List of MessageRecipient |
List of recipients to be included in CC (carbon copy). |
||
cciRecipients |
List of MessageRecipient |
List of recipients to be included in BCC (blind carbon copy - CCI). |
||
All details required to send an email (recipients, subject, body). |
||||
publishedDocuments |
List of PublishedDocument |
List of documents to be published as attached files. |
||
replyTo |
Mail recipient for reply-to. |
|||
toRecipients |
List of MessageRecipient |
List of primary recipients. |
3.284. MessageRecipient
Recipient of a message
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
address |
The email address of the recipient. |
|||
id |
Id in database |
|||
summary |
A brief summary or description of the recipient. |
|||
type |
Type of message recipient. |
3.285. MessageRecipientType
Message recipient type
Type : enum (USER, EMPLOYEE, CONTACT, TEAM, MAIL_ADDRESS)
3.286. MethodOfPayment
Method of payment
Type : enum (CREDIT_CARD, CHECK, CASH, CHECK_LETTER, DIRECT_DEBIT, INTER_BANK_PAYMENT_DOCUMENT, BANK_DRAFT, BANK_TRANSFER, BANK_TRANSFER_CURRENCY, OTHER)
3.287. NoneSEPA
International bank detail
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
beneficiary |
Details of the beneficiary's international bank account, including identification and account holder information. |
|||
defaultBankDetail |
Set as true if this international bank detail will be used by default. |
|||
intermediate |
Details of the intermediate's international bank account, including identification and account holder information. |
3.288. ObjectHistoryLink
A link between a target object and other objects
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
objectId |
Id of the object linked to a target object |
|||
objectType |
Example : CUSTOMER |
|||
targetId |
Id of target object |
3.289. OpportunityBase
OpportunityBase
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
The code of the opportunity. |
|||
id |
Id in database |
|||
name |
The name of the opportunity. |
3.290. OtherThirdPartieBase
Other Third Partie Base (Autre Tiers)
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
The code of the third party (customer, supplier, other third party). |
|||
id |
Id in database |
|||
name |
The name of the third party (customer, supplier, other third party). |
3.291. OtherThirdPartyTypeBase
Type of Other Third-Party
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
X |
The code of the other third-party type |
||
id |
Id in database |
|||
name |
X |
The name of the other third-party type |
3.292. PatchElement
A JSONPatch as defined by RFC 6902
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
from |
X |
A JSON-Pointer @see https://tools.ietf.org/html/rfc6901 |
||
op |
X |
The operation to be performed |
Enum: ADD, REMOVE, REPLACE, TEST, MOVE, COPY, AK_APPEND, ADD, REMOVE, REPLACE, TEST, MOVE, COPY, AK_APPEND |
|
path |
X |
A JSON-Pointer @see https://tools.ietf.org/html/rfc6901 |
||
value |
The value to be used within the operations. |
3.293. PatchHolder
List of patches to apply to the idents specified
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
ids |
List of [string] |
Idents to patch |
||
patchElements |
List of PatchElement |
List of patches to apply |
3.294. Payment
Payment
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Payment code |
|||
day |
Day of the month on which the payment will be done |
double |
||
deadLine |
Number of days to carry out the payment |
|||
term |
Period of payment |
3.295. PendingTask
Pending task
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Code of the pending task |
|||
company |
All details about the company. |
|||
companyId |
Id of the company |
|||
description |
Description of the pending task. |
|||
employee |
All details about the employee. |
|||
employeeId |
Id of the employee |
|||
furtherInformation |
This field is set according to the pending task type. |
|||
furtherMiscellaneousData |
This field is intended for backend use to store various values unspecified such as dates, IDs etc. |
|||
id |
Id in database |
|||
name |
Name of the pending task |
|||
objectDate |
Start date of the week if the timesheet concerns a weekly period. |
date-time |
||
objectId |
Id of the object |
|||
objectType |
Type of the management object for the pending task. |
|||
pendingTaskType |
The type of pending task. |
|||
project |
All details about the project |
|||
projectId |
Id of the project |
|||
thirdParty |
Details about third-Party |
|||
thirdPartyId |
Id of the third-party |
|||
thirdPartyType |
Type of the source third party linked (PROSPECT, CUSTOMER, SUPPLIER OR OTHER_THIRD_PARTY) |
3.296. PendingTaskCriteria
Search criteria for pendinfg task
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
employeeId |
Id of the employee |
|||
objectType |
Type of the object for the pending task. |
|||
projectId |
Id of the project |
|||
readOption |
Options for retrieving extra information concerning the pendinfg task |
3.297. PendingTaskReadOption
Criteria used to get more details about a pending task.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
options |
List of [string] |
List of options used to get more details about the pending task |
Enum: PROJECT, EMPLOYEE, COMPANY, THIRD_PARTY |
3.298. PendingTaskType
The type of pending task.
Type : enum (QUOTATION, SALES_ORDER, APPROVAL, EXPENSE_REPORT, EXPENSE_REPORT_MANAGER, LEAVE_REQUEST, TIMESHEET_ENTRIES, TIMESHEET_ENTRIES_MANAGER, EVENT, ISSUE, PRODUCTION, PRODUCTION_MANAGER)
3.299. PeopleLink
People Link
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
defaultLink |
Determine the default people link used in the case. 'True' if the people link is the one to apply by default |
|||
id |
Id in database |
|||
linkSource |
Detail about the people link relationship between the path third party and another third party. |
|||
linkSourceId |
Id of the type of people link for the source third party. |
|||
linkTarget |
Detail about the people linkTarget relationship between the path third party and another third party. |
|||
linkTargetId |
Id of the type of people link for the target third party. |
|||
linkType |
A link can be set as a Management Link or a Filiation Link. |
|||
sourceThirdParty |
Detail about the third party. |
|||
sourceThirdPartyId |
Id of the source third party. |
|||
sourceThirdPartyType |
Type of the source third party linked (PROSPECT, CUSTOMER, SUPPLIER OR OTHER_THIRD_PARTY) |
|||
targetThirdParty |
Detail about the third party |
|||
targetThirdPartyId |
Id of target third party to link. |
|||
targetThirdPartyType |
Type of the target third party linked (PROSPECT, CUSTOMER, SUPPLIER OR OTHER_THIRD_PARTY) |
3.300. PeopleLinkCriteria
Criteria used on People Link when doing a People Link search
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
defaultLink |
If true, the people link is the one set by default on the third party with the link |
|||
id |
||||
linkSourceId |
Id of the people link relationship between the path third party and another third party |
|||
linkTargetId |
Id of the people link relationship between a third party and the path third party |
|||
linkType |
A link can be set as a Management Link or a Filiation Link |
|||
readOption |
Options for retrieving extra information concerning the peopleLink |
|||
sourceThirdPartyId |
Id of the third party linked |
|||
sourceThirdPartyType |
Type of the source third party linked (PROSPECT, CUSTOMER, SUPPLIER OR OTHER_THIRD_PARTY) |
|||
targetThirdPartyId |
Id of the target third party with people links |
|||
targetThirdPartyType |
Type of the third party with people links (PROSPECT, CUSTOMER, SUPPLIER OR OTHER_THIRD_PARTY) |
3.301. PeopleLinkReadOption
Options used to get additional information when doing a peopleLink's search
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
options |
List of [string] |
List of options used to get more details about the people link |
Enum: LINK_SOURCE, LINK_TARGET, SOURCE_THIRD_PARTY, TARGET_THIRD_PARTY |
3.302. PeopleLinkType
People Link Type
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
The code for the type of People link. |
|||
companyCode |
The code of the company. |
|||
description |
The description for the type of People link. |
|||
id |
Id in database |
|||
linkDirection |
A filation link type can be set with a link direction |
|||
static |
A link can be set as static if it is not intended to be modified |
|||
type |
A link can be set as a Management Link or a Filiation Link |
3.303. PeopleLinkTypeCriteria
Criteria used on People Link Type when doing a Link Type search
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
||||
companyCode |
||||
id |
||||
type |
A link can be set as a Management Link or a Filiation Link |
3.304. PeopleLinkTypeEnum
A link can be set as a Management Link or a Filiation Link
Type : enum (MANAGEMENT_LINK, FILIATION_LINK)
3.305. Period
Period
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
from |
Smaller date of the period |
date-time |
||
granularity |
To limit the granularity to a unit other than milliseconds, pass the units as the third parameter. DAY by default. |
|||
inclusivity |
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. |
|||
to |
Bigger date of the period |
date-time |
3.306. PeriodGranularity
Granularity of a period
Type : enum (YEAR, MONTH, DAY, HOUR, MINUTE, SECOND)
3.307. Periodicity
Periodicity
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Periodicity of payment (0 ⇒ Unique (default); 1 ⇒ Annual; 2 ⇒ Bi-annual; 3 ⇒ Quarterly; 4 ⇒ Monthly) |
|||
duration |
Duration in month |
double |
||
id |
Id in database |
|||
lineStartDate |
Start date of the line |
date-time |
||
startDate |
Date by which the periodicity is starting |
date-time |
||
tacitAgrement |
Returns true if the checkbox 'tacit renewal' is checked |
|||
term |
Returns true if not due, false if due |
3.309. PhaseBase
Phase
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Code of a phase |
|||
id |
Id in database |
|||
name |
Name of a phase |
|||
order |
Order number of the project |
int32 |
||
project |
Details about the corresponding project |
|||
projectId |
ID of the corresponding project (i.e. Code of the project) |
3.310. PhaseState
State of a phase
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
The code of the phase state |
|||
companyId |
ID of the company |
|||
default |
Set as true to use this phase state by default. Set as false by default |
|||
id |
ID of the phase state |
|||
name |
The name of the phase state |
3.311. PhaseStateCriteria
Criteria used on phase state when doing a phase state search
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
||||
companyId |
||||
id |
||||
name |
3.312. PipeBase
Pipe base
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Code of the pipe |
|||
id |
Id in database |
|||
name |
Name of the pipe |
3.313. PluginFeature
Plugin Feature
Type : enum (BRIDGE, CHORUS, EDOC, PRESTATIONS, UNIVERSIGN, API_GOOGLE, AKUITEO_SAAS)
3.314. Postpone
Object used to postpone management object lines.
The line date can be postponed by setting a precise date, shifting by a period, or resetting the date.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
exactDate |
Precise date to be updated. |
date-time |
||
period |
Period shift information for postponing the date. To use this field, type must be set to SHIFT_BY_PERIOD. |
|||
type |
X |
Defines how the date is postponed: either by exact date, period shift, or reset. |
3.315. PostponePeriod
Defines the number of occurrences for the postponement and the time unit, allowing the date to be modified based on a given period.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
numberOfOccurrency |
Number of times the period should be shifted. |
|||
shiftPeriod |
Time unit for shifting the period. |
3.316. PostponeType
Defines how the date postponement is handled
Type : enum (EXACT_DATE, SHIFT_BY_PERIOD, RESET_DATE)
3.317. PricingMethodBase
The method by which pricing is to be determined
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
The code of the pricing method |
|||
id |
The ID in database of the pricing methods |
|||
name |
The name given to the pricing method |
3.319. ProductionInformations
Production informations
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
billingTargetDay |
Billing target day of the month for the production to be billed. Empty if the billing mode is not production to be billed. |
int32 |
||
defaultDisplay |
Determines whether the production is the most frequently used and should be displayed by default. Set as 'True' if the production is to be displayed by default. |
|||
estimatedDuration |
The production estimated duration in minutes. Empty if the billing mode is not production to be billed. |
int32 |
||
linkedToAdvancePayments |
Returns true if the production is linked to advance payments. Set as 'false' by default. |
|||
targetDay |
Target day of the month for the production. Empty if the billing mode is not production to be billed. |
int32 |
||
team |
Details about the production team. |
|||
teamId |
ID of the production team |
3.320. ProductionTeamBase
Production team base
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Code of the production team |
|||
id |
Id in database |
|||
name |
Name of the production team |
3.321. Profession
Details about the profession of the people
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Code of the Profession |
|||
id |
Id in database |
|||
name |
Name of the Profession |
3.322. ProfessionalCategory
Professional Category
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Code of the Professional Category |
|||
companyId |
ID of the company |
|||
id |
Id in database |
|||
name |
Name of the Professional Category |
|||
ranking |
The professional category ranking in the list |
int32 |
3.323. ProjectBase
Project
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
companyCode |
Code of the company |
|||
customer |
Details of the customer |
|||
customerId |
Id of the project's customer |
|||
customerType |
Customer type |
|||
endCustomer |
Details of the customer |
|||
endCustomerId |
Id of the project's end customer |
|||
id |
Id in database |
|||
internal |
If the project is internal or not |
|||
leave |
Return true if the project is a leave project |
|||
leaveType |
Details about leave type |
|||
name |
Name of a project |
3.324. ProjectCommon
Shared information about projects, across domains.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
color |
Color of the project (hexadecimal code) |
|||
companyCode |
Code of the company |
|||
customer |
Details of the customer |
|||
customerId |
Id of the project's customer |
|||
customerType |
Customer type |
|||
endCustomer |
Details of the customer |
|||
endCustomerId |
Id of the project's end customer |
|||
id |
Id in database |
|||
internal |
If the project is internal or not |
|||
leave |
Return true if the project is a leave project |
|||
leaveType |
Details about leave type |
|||
name |
Name of a project |
|||
projectEnd (Deprecated) |
End date of a project |
date-time |
||
projectStart (Deprecated) |
Start date of a project |
date-time |
||
projectState |
State of the project |
|||
projectStateId |
Id of the state of the project |
3.325. ProjectCustomerType
Type of relation with the customers
Type : enum (ALL_CUSTOMERS, MULTI_CUSTOMERS, SINGLE_CUSTOMER)
3.326. ProjectEvent
Project Event
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
actionCode |
Details about the action code |
|||
actionCode2 |
Details about the action code 2 |
|||
actionCode2Id |
ID of the action code 2 |
|||
actionCodeId |
ID of the action code |
|||
assignmentReferential |
Details about the assignment referential |
|||
changeTracking |
Creation and modification date and user |
|||
color |
Color of the project event (if filled then this color overrides color set by parameters) |
|||
customer |
Details about the customer |
|||
customerId |
ID of the customer |
|||
dayMode |
True when the schedule is in day mode (1 day, half day…) |
|||
dayPart |
Part of the day on which to position the schedule created, according to the standard week. |
double |
||
description |
Description of the project event |
|||
done |
Return True if the project event is done |
|||
duration |
Duration of the project event |
double |
||
durations |
Duration in different units |
|||
employeeId |
ID of the employee |
|||
employeeReferential |
Details about the employee referential |
|||
endDate |
End date of the project event |
date-time |
||
fullDay |
True when the schedule is a full day event |
|||
id |
Id in database |
|||
location |
Location of the event |
|||
onlineMeeting |
Return True if the meeting is online. |
|||
period |
Details about the period of the project event |
|||
phaseId |
ID of the phase |
|||
projectId |
ID of the project (equivalent to the code of the project) |
|||
projectTaskId |
ID of the task |
|||
public |
Return True if the project event is public |
|||
quotationId |
ID of the associated quotation. If set, this implies that the event is provisional. |
|||
refused |
Return True if the project event is refused (meaning validated with approval code REFUSE). Available only for timesheet entry. |
|||
startDate |
Start date of the project event |
date-time |
||
subPhaseId |
ID of the sub-phase |
|||
subject |
Subject of the project event |
|||
tags |
List of TagLinked |
Details about tag linked |
||
taskId |
ID of the issue's task. |
|||
type |
Details about the type of the project event |
|||
validated |
Return True if the project event is validated |
3.327. ProjectEventCriteria
Criteria used when doing a project Event search
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
actionCodeCode |
Code of the action code |
|||
customerId |
Ident of the customer |
|||
done |
Clause for done or not done events |
|||
employeeId |
Ident of the employee |
|||
employeeIdOnVacation |
Filter employees on vacation (either employee's id matches this criteria OR project is NOT typed 'leave') |
|||
from |
Start date of the search interval |
date-time |
||
id |
Ident of the project event |
|||
location |
Location of the event |
|||
name |
Name of the project event |
|||
phaseId |
Ident of the phase |
|||
projectId |
Ident of the project (equivalent to the code of the project) |
|||
projectTaskId |
Ident of the task |
|||
quotationId |
Clause concerning a potential linked quote. When present a quotationId implies that the project event is provisional. |
|||
readOption |
Options used to get more information about the project event |
|||
subPhaseId |
Ident of the sub-phase |
|||
subject |
Subject of the project event |
|||
to |
End date of the search interval |
date-time |
||
type |
List of ProjectEventType |
Details about the type of the project event |
||
withinDayPrecision |
Set as True for more precision about the day |
3.328. ProjectEventInformationHolder
Project Event information needed for creation
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
allowPublicHoliday |
Whether or not planning elements are allowed on public holidays |
|||
allowSaturday |
Whether or not planning elements are allowed on Saturdays |
|||
allowSunday |
Whether or not planning elements are allowed on Sundays |
|||
duration |
Duration of the project event |
double |
||
employeeId |
ID of the employee |
|||
endDate |
End date of the project event |
date-time |
||
startDate |
Start date of the project event |
date-time |
||
validated |
True if the project event is validated, false if not validated. By default keep the status of the project event. |
3.329. ProjectEventModificationElement
Describe a modification to apply to project event
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
action |
X |
Details about the action verb |
||
order |
Order number of the project event |
|||
type |
X |
Type of the project event |
3.330. ProjectEventModificationType
Type of modification apply to a Project Event. SPLIT: cut ProjectEvent into 2 or more ProjectEvent
Type : enum (SPLIT)
3.332. ProjectEventReadOption
ProjectEventReadOption
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
options |
List of [string] |
List of options used to get more details about the project event |
Enum: CUSTOMER, PROJECT_TASK, EMPLOYEE, ACTION, ACTION_2, TAGS, CHANGE_TRACKING, ASSIGNMENT_REFERENTIAL |
3.333. ProjectEventType
Details about the type of the project event
Type : enum (SCHEDULE, TIMERECORDING, PROJECT_TASK_SUMMARY)
3.334. ProjectFilterType
Type of filter on project
Type : enum (NONE, SCHEDULED_FOR_MONTH, WITH_MY_TIMESHEET, FROM_MANAGERS_IN_MY_DIVISION, FROM_MY_DIVISION, INTERNAL_IN_MY_DIVISION, FROM_MY_ENTITY, INTERNAL_IN_MY_ENTITY, MANAGED_BY_ME)
3.335. ProjectGroup
ProjectGroup
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
The code of the project group. |
|||
description |
Description of the project group. |
|||
id |
Id in database |
|||
name |
The name of the project group. |
3.337. ProjectLink
Link between a project and a resource or management object
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
linkType |
Type of link |
|||
projectId |
ID of the project (equivalent to the code of the project) |
3.338. ProjectLinkCriteria
Criteria used when doing a Project Link search
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
checkEmployeeCompany |
Set as True if you want to check the employee's company |
|||
checkSchedule |
Set as True if you want to check schedule |
|||
checkTimesheet |
Set as True if you want to check time |
|||
from |
Starting date |
|||
to |
End date |
3.340. ProjectState
State of a project
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
The code of the project state |
|||
companyCode (Deprecated) |
Code of the company |
|||
companyId |
ID of the company |
|||
id |
ID of the project state |
|||
name |
The name of the project state |
3.341. ProjectStateCriteria
Criteria used on project state when doing a project state search
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
activeModule |
Example : EXPENSE_REPORTS |
|||
code |
||||
companyId |
||||
id |
||||
name |
||||
tag |
You can fill in the code or name of the tag in this field |
3.342. ProjectTaskBase
The Project task base
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code (Deprecated) |
Code of the task |
|||
id |
Id in database |
|||
name |
Name of the task |
3.343. ProjectTaskCommon
The Project task common
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code (Deprecated) |
Code of the task |
|||
customer |
Details about the customer |
|||
customerId |
ID of the customer |
|||
description |
Description of the task |
|||
endDate |
End date of the task |
date-time |
||
id |
Id in database |
|||
name |
Name of the task |
|||
order |
Order number of the task |
int32 |
||
phase |
Details about the phase of the project. |
|||
phaseId |
ID of the phase |
|||
project |
All details about the project |
|||
projectId |
ID of the project (equivalent to the code of the project) |
|||
startDate |
Start date of the task |
date-time |
||
subPhase |
Details about the sub-phase of the project |
|||
subPhaseId |
ID of the sub-phase |
3.344. ProjectTaskEventsSummary
Summary about project task event on a period
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
customerId |
ID of the customer of the event |
|||
endDate |
The end date of the event |
date-time |
||
id |
ID of the project task event |
|||
nbScheduledDays |
Number of scheduled days |
double |
||
phaseId |
ID of the phase |
|||
projectId |
ID of the project (equivalent to the code of the project) |
|||
projectTaskId |
ID the project task |
|||
schedules |
List of Schedule |
List of schedules of the event |
||
startDate |
The start date of the event |
date-time |
||
subPhaseId |
ID of the sub-phase |
3.345. ProjectTaskType
The parameters of different type of project task
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
byDefault |
Set as true to use this type of task by default when adding a new task. |
|||
code |
The code to give to this project task type |
|||
companyId |
ID of the company |
|||
id |
ID of the project task type |
|||
label |
The project task type name / label |
|||
rankNumber |
The project task type ranking in the list |
|||
type |
Example : TIME_BASED |
3.347. PublishArguments
Required arguments to publish a document.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
extension |
Document type |
|||
parameters |
List of PublishTemplateParameter |
Details about the template parameters |
||
saveDocument |
Return true if the generated document is linked to the business document. |
|||
template |
Details about the template |
3.348. PublishContextBase
Context for publication, destined for use by specific API
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
contextType |
Context of the publish |
|||
displayOptions |
Map of [string] |
Options for data display |
||
filters |
Map of [array] |
Filter for data selection discriminating by object IDs grouped by object type |
3.349. PublishTemplate
Details about the template used to publish.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
The template code |
|||
defaultTemplate |
Return true if it's the default's template |
|||
endDate |
End of validity of the template |
date-time |
||
extensions |
List of [string] |
Extension types available for the document |
||
id |
Id in database |
|||
interactive |
Return true if the model needs any parameters to be generated |
|||
name |
The template name |
|||
order |
Order number |
int32 |
||
path |
Path where you can find the template. |
|||
publishType |
Publish type |
|||
type |
Details about the template type |
3.350. PublishTemplateParameter
Parameters of a Publish template.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
controlType |
Details about the type of the parameter |
|||
groupName |
Name of the parameter group |
|||
labelText |
Label of the parameter |
|||
nameField |
Name of the parameter |
|||
nameFieldNext |
Name of the next parameter |
|||
pattern |
Pattern of the parameter |
|||
required |
Return true if the paramater is required |
|||
selectionList |
List of PublishTemplateParameterChoice |
Details of each value of a LIST_BOX parameter |
||
value |
Value of the parameter |
3.351. PublishTemplateParameterChoice
If controlType is equal to LIST_BOX, there is a list of each object in the list
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
label |
The label |
|||
value |
The value |
3.352. PublishTemplateParameterType
Type of parameter.
Type : enum (TEXT_BOX, LIST_BOX, DATE_BOX, RADIO_BUTTON, CHECK_BOX, COMBO_BOX)
3.353. PublishTemplateType
Describe the Publish template type which is unique by code-modelId tuple. Allowed ModelId values depend on choosen code value.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Code of the template type |
|||
modelDescription |
Description of the model |
|||
modelId |
ID of the model |
|||
name |
Name of the template type |
3.354. PublishType
Type of the published document.
Defines the type of document that can be published. Some objects can be published individually, while others support batch publishing. For batch publishing, use the type ending with 'LIST.'
Type : enum (OPPORTUNITY, QUOTATION, QUOTATION_LIST, SALES_ORDER, SALES_ORDER_LIST, SALES_INVOICE, SALES_INVOICE_LIST, SALES_BILLING_TABLE, SALES_BILLING_TABLE_LIST, DELIVERY, DELIVERY_LIST, QUOTE, PURCHASE_ORDER, PURCHASE_INVOICE, PURCHASE_BILLING_TABLE, RECEPTION, CUSTOMER, CUSTOM_REQUEST, EXPENSE_REPORT, EXPENSE, EXPENSE_REPORT_LIST, SCHEDULE, SCHEDULE_EMPLOYEE, TIMERECORDING, ISSUE, PRODUCTION_TO_BE_BILLED, OVERVIEW_HELPDESK, OVERVIEW_PURCHASE, OVERVIEW_SALES, OVERVIEW_SCHEDULE, OVERVIEW_TIMESHEET, OVERVIEW_STOCK, OVERVIEW_COMMON, OVERVIEW_MISCELLANEOUS, PROJECT, PROJECT_LIST, CONTACT, QUOTATION_EXPENSE_LINE, BANKING_INFORMATION)
3.355. PublishedDocument
Published Document.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
documentId |
Document ID |
|||
isDocument |
Return true if the document is available in Akuiteo |
|||
token |
Details about the published document (whether the publish is okay or not, where you can find the document, its size) |
3.356. QuickEntryTime
QuickEntryTime
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
actionCode |
Details about the action verb |
|||
actionCode2 |
Details of the action code |
|||
actionCode2Id |
ID of the second action code |
|||
actionCodeId |
ID of the action code |
|||
approval |
Approval of the timesheet entry |
Enum: BRUT, CONTROLE, VALIDE, GRATUIT, NON_FACTURE, FACTURE, REFUSE, DISSOCIE, BRUT, CONTROLE, VALIDE, GRATUIT, NON_FACTURE, FACTURE, REFUSE, DISSOCIE |
||
approvalLabel |
Label of the approval |
|||
changeTracking |
Date and user in case of creation and modification |
|||
comment |
Comment of the calendar event |
|||
completionDate |
Completion Date |
date-time |
||
customer |
Details about the customer |
|||
customerId |
ID of the customer |
|||
date |
Date of the calendar event |
date-time |
||
duration |
Duration of the calendar event |
double |
||
durations |
Duration in different units |
|||
employee |
Details about the employee |
|||
employeeId |
ID of the employee |
|||
guid |
Global identifier of the calendar event (for mobile version only) |
|||
id |
ID of the calendar event |
|||
location |
Location of the calendar event |
|||
name |
Name of the timesheet entry |
|||
phase |
Details about the phase |
|||
phaseId |
ID of the phase |
|||
project |
Details about the project |
|||
projectId |
ID of the project (equivalent to the code of the project) |
|||
projectTask |
Details about the task |
|||
projectTaskId |
ID of the project |
|||
subPhase |
Details about the sub-phase |
|||
subPhaseId |
ID of the sub-phase |
|||
taskId |
Helpdesk's task ident |
|||
type |
Type of the calendar event |
|||
unit |
Details about the unit of duration |
|||
validated |
Return True if the calendar event is validated |
3.357. QuickEntryTimeReadOption
Criteria used to get more details about timesheet quick entries.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
options |
List of [string] |
List of options used to get more details about the quick entry time |
Enum: EMPLOYEE, CUSTOMER, PROJECT, PHASE, SUB_PHASE, PROJECT_TASK, ACTION, ACTION_2 |
3.358. RecipientContact
Contact recipient of a management object
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
companyId |
ID of the company |
|||
contactId |
The ID of the contact |
|||
The email of the contact recipient |
||||
firstName |
The first name of the contact recipient |
|||
id |
Id in database |
|||
name |
The name of the contact recipient . |
|||
title |
Civility of the contact recipient |
|||
type |
Example : IN_COPY |
3.360. RecurringAmountsInfo
Amounts calculated based on the recurrence period defined in the management object lines.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
afterTaxAmount |
After-tax amount in the company currency, calculated automatically, considering any recurrence |
double |
||
afterTaxAmountCurrency |
After-tax amount in the specified currency, calculated automatically, considering any recurrence |
double |
||
preTaxAmount |
Pre-tax amount in the company currency, calculated automatically, considering any recurrence |
double |
||
preTaxAmountCurrency |
Pre-tax amount in the specified currency, calculated automatically, considering any recurrence |
double |
||
vatAmount |
VAT amount expressed in the company currency |
double |
||
vatAmountCurrency |
VAT amount expressed in the specified currency |
double |
3.361. RecurringRemoteWork
Declaration of recurring remote work
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
endDate |
End date of the recurring remote work declaration (hours ignored) |
date-time |
||
friday |
||||
monday |
||||
saturday |
||||
startDate |
Start date of the recurring remote work declaration (hours ignored) |
date-time |
||
sunday |
||||
thursday |
||||
tuesday |
||||
wednesday |
3.362. RecurringRemoteWorkDay
Remote work entry of an Employee at a date
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
afternoon |
Remote work the afternoon |
|||
morning |
Remote work the morning |
3.363. RecurringTimesheetEntry
Duplication of timesheet entries of a week
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
friday |
Duplicate friday |
|||
monday |
Duplicate monday |
|||
nbWeeks |
X |
Repetition number of week |
||
referentialDate |
X |
Week date referential to duplicate |
date-time |
|
saturday |
Duplicate saturday |
|||
sunday |
Duplicate sunday |
|||
thursday |
Duplicate thursday |
|||
tuesday |
Duplicate tuesday |
|||
wednesday |
Duplicate wednesday |
3.364. Region
Region
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Code of the region |
|||
companyCode |
The code of the company linked to the region |
|||
companyId |
ID of the company |
|||
country |
The country where the region is located |
|||
countryId |
Id of the country where the region is located |
|||
id |
Id in database |
|||
name |
Name of the region |
3.365. Relation
Details about a relation between two employees
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
employee |
Details about the employee |
|||
employeeId |
ID of the employee |
|||
id |
Id in database |
|||
relatedEmployee |
Details about the related employee |
|||
relatedEmployeeId |
ID of the related employee |
|||
relationType |
Details about the relation type |
3.366. RelationCriteria
Criteria used to get more details about the custom relation
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
employeeId |
||||
employeeIdOrRelatedEmployeeId |
||||
relatedEmployeeId |
3.367. RelationType
Type of a relation
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Code of the relation type |
|||
id |
Id in database |
|||
name |
Name of the relation type |
3.368. RemoteWorkEntry
Remote work entry of an Employee at a date
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
afternoon |
Remote work the afternoon |
|||
date |
Date of the remote work entry (hours ignored) |
date-time |
||
employee |
Details about the employee |
|||
employeeId |
ID of the employee |
|||
id |
Id in database |
|||
morning |
Remote work the morning |
3.369. RemoteWorkEntryAnalysis
Search criteria including filters, groupings (to categorize the search results) and display options.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
filter |
The filters (criteria) |
|||
group |
The groups (to group by the search results) |
|||
objects |
List of [string] |
List of remote work entry analysis options |
Enum: REMOTE_WORK_BY_MONTH |
|
view |
The view (to specify the specific display). |
3.370. RemoteWorkEntryAnalysisFilter
Filters (criteria) use in a RemoteWorkEntryAnalysis
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
axeType |
X |
Unused (technical field) |
||
companyId |
||||
customerAccountManagerId |
Ident of customer's account manager |
|||
customerAccountManagerSupervisorId |
Ident of customer's account manager supervisor |
|||
customerCountryId |
Ident of customer's country |
|||
customerFamilyId |
Ident of the customer's project category |
|||
customerGrouping1 |
Customer's grouping |
|||
customerGrouping2 |
Customer's grouping 2 |
|||
customerId |
Ident of customer |
|||
customerRegionId |
Ident of customer's address region |
|||
customerSalesmanId |
Ident of customer's salesman |
|||
customerSalesmanSupervisorId |
Ident of customer's salesman supervisor |
|||
customerSectorId |
Ident of customer's sector |
|||
customerState |
Customer's state |
|||
customerSubFamilyId |
Ident of the customer's project subcategory |
|||
date |
Date to which retrieve the remote work entry |
|||
divisionId |
||||
employeeId |
||||
entityId |
||||
excludeResourceWhoHaveLeftTheCompany |
Exclude resource who have left the company |
|||
groupCustomer |
Group of companies of the customer |
|||
managerCriteria |
||||
phaseId |
Ident of the phase |
|||
projectActivityId |
||||
projectCampaignId |
Ident of the project's compaign |
|||
projectCompanyCode |
Code of the project's company |
|||
projectDepartmentId |
Ident of the project's department |
|||
projectDivisionGroupId |
Ident of the project's division group |
|||
projectDivisionId |
Ident of the project's division |
|||
projectEstablishmentId |
||||
projectFamilyId |
Ident of the project's category |
|||
projectFinancialManagerId |
Ident of the project's financial manager |
|||
projectId |
Ident of the project (equivalent to the code of the project) |
|||
projectManagerId |
Ident of the project manager of the project |
|||
projectMarketId |
Ident of project group of the project |
|||
projectProductionManagerId |
Ident of the project's product manager |
|||
projectSalesManagerId |
Ident of the project's sales manager |
|||
projectState |
State of project |
|||
projectSubFamily2Id |
Ident of the project's sub-category level 2 |
|||
projectSubFamilyId |
Ident of the project's sub-category |
|||
projectVintageId |
Ident of the year (vintage) of the project |
|||
prospect |
True is customer is a prospect |
|||
subPhaseId |
Ident of the sub-phase |
3.371. RemoteWorkEntryAnalysisGroup
Groupings (to group by the search results) use in a RemoteWorkEntryAnalysis
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
axes |
List of AxeGroupsType |
Set of analysis axis |
||
by |
List of RemoteWorkEntryAnalysisGroupType |
List of remote work entry analysis group type |
3.372. RemoteWorkEntryAnalysisGroupType
Type of the remote work entry Group
Type : enum (EMPLOYEE_ID, EMPLOYEE_CODE, EMPLOYEE_NAME, EMPLOYEE_FIRST_NAME, EMPLOYEE_NUMBER, EMPLOYEE_END_DATE, EMPLOYEE_COMPANY_CODE, EMPLOYEE_DIVISION_GROUPING_CODE, EMPLOYEE_DIVISION_CODE, EMPLOYEE_ENTITY_CODE, EMPLOYEE_DAILY_HOURS, EMPLOYEE_SERVICE_CODE, DUMMY)
3.373. RemoteWorkEntryAnalysisView
Display options of a RemoteWorkEntry
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
dateLike |
Name of the remote work entry analysis view |
Enum: MONTH, MONTH |
3.374. RemoteWorkEntryCriteria
Criteria used on remote work entries when doing a search
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
companyId |
||||
date |
Date of the remote work entry |
|||
employeeCode |
Code of the employee |
|||
employeeId |
||||
id |
||||
readOption |
Options for retrieving extra information concerning the employee |
3.375. RemoteWorkEntryReadOption
Criteria used to get more details about remote work entry.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
options |
List of [string] |
List of options used to get more details about the remote work entry |
Enum: EMPLOYEE |
3.377. SEPA
Details SEPA banking information
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
bankDetails |
Details about the bank |
|||
bic |
Details about the BIC |
|||
iban |
Details about the IBAN |
3.378. Schedule
Schedule
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
actionCode |
Details about the action verb |
|||
actionCodeId |
ID of the action code |
|||
changeTracking |
Date and user in case of creation and modification |
|||
color |
Color of the schedule (hexadecimal code) |
|||
comment |
Comment of the calendar event |
|||
customer |
Details about the customer |
|||
customerId |
ID of the customer |
|||
date |
Date of the calendar event |
date-time |
||
dayMode |
True when the schedule is in day mode (1 day, half day…) |
|||
dayPart |
Part of the day on which to position the schedule created, according to the standard week. |
double |
||
description |
Description of the schedule |
|||
done |
Return True if the schedule is done |
|||
duration |
Duration of the calendar event |
double |
||
durations |
Duration in different units |
|||
employee |
Details about the employee |
|||
employeeId |
ID of the employee |
|||
endDate |
End date of the schedule |
date-time |
||
guid |
Global identifier of the calendar event (for mobile version only) |
|||
id |
ID of the calendar event |
|||
location |
Location of the calendar event |
|||
onlineMeeting |
Return True if the meeting is online |
|||
period |
Period of the schedule |
Enum: DAY, MORNING, AFTERNOON, DAY, MORNING, AFTERNOON |
||
phase |
Details about the phase |
|||
phaseId |
ID of the phase |
|||
project |
Details about the project |
|||
projectId |
ID of the project (equivalent to the code of the project) |
|||
projectTask |
Details about the task |
|||
projectTaskId |
ID of the project |
|||
publication |
Publication date of the schedule |
date-time |
||
quotationId |
ID of the associated quotation. If set, this implies that the schedule is provisional. |
|||
salesOrderLine |
Details about sales order line |
|||
salesOrderLineId |
ID of the sales order line |
|||
siteId |
ID of the site |
|||
subPhase |
Details about the sub-phase |
|||
subPhaseId |
ID of the sub-phase |
|||
tags |
List of TagLinked |
Details about the tag linked |
||
taskId |
Helpdesk's task ident |
|||
type |
Type of the calendar event |
|||
unit |
Details about the unit of duration |
|||
validated |
Return True if the calendar event is validated |
3.379. ScheduleBase
Schedules
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
actionCode |
Details about the action verb |
|||
actionCodeId |
ID of the action code |
|||
changeTracking |
Date and user in case of creation and modification |
|||
comment |
Comment of the calendar event |
|||
customer |
Details about the customer |
|||
customerId |
ID of the customer |
|||
date |
Date of the calendar event |
date-time |
||
description |
Description of the schedule |
|||
done |
Return True if the schedule is done |
|||
duration |
Duration of the calendar event |
double |
||
durations |
Duration in different units |
|||
employee |
Details about the employee |
|||
employeeId |
ID of the employee |
|||
guid |
Global identifier of the calendar event (for mobile version only) |
|||
id |
ID of the calendar event |
|||
location |
Location of the calendar event |
|||
phase |
Details about the phase |
|||
phaseId |
ID of the phase |
|||
project |
Details about the project |
|||
projectId |
ID of the project (equivalent to the code of the project) |
|||
projectTask |
Details about the task |
|||
projectTaskId |
ID of the project |
|||
subPhase |
Details about the sub-phase |
|||
subPhaseId |
ID of the sub-phase |
|||
taskId |
Helpdesk's task ident |
|||
type |
Type of the calendar event |
|||
unit |
Details about the unit of duration |
|||
validated |
Return True if the calendar event is validated |
3.380. ScheduleCreateParamHolder
ScheduleCreateParamHolder
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
allowPublicHoliday |
Set as true to allow public holiday for schedule creation |
|||
allowSaturday |
Set as true to allow saturday for schedule creation |
|||
allowSunday |
Set as true to allow sunday for schedule creation |
|||
applyEmployeeWeek |
Set as true to apply the employee week model |
|||
schedule |
Details about schedule |
3.381. ScheduleCriteria
Criteria used to get more details about schedule
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
actionCode |
Code of the action code |
|||
comment |
Comment of the schedule |
|||
creationDateFrom |
Starting creation date of the schedule |
|||
creationDateTo |
End creation date of the schedule |
|||
customerId |
Ident of the customer |
|||
description |
Description of the schedule |
|||
done |
Set as True to only search for done schedules, or False for not done schedules |
|||
employeeCode |
Code of the employee |
|||
employeeId |
Ident of the employee |
|||
employeeIdOnVacation |
Filter employees on vacation (either employee's id matches this criteria OR project is NOT typed 'leave') |
|||
id |
Ident of the schedule |
|||
location |
||||
modificationDateFrom |
Starting modification date of the schedule |
|||
modificationDateTo |
End modification date of the schedule |
|||
phaseCode |
Code of the phase |
|||
phaseId |
Ident of the phase |
|||
projectCode |
Code of the project |
|||
projectLeave |
Set as True if you want to include leave project |
|||
projectTaskCode |
Code of the task |
|||
projectTaskId |
Ident of the task |
|||
quotationId |
Clause concerning a potential linked quote. When present a quotationId implies that the schedule is provisional. |
|||
readOption |
Options used to get more information about the schedule |
|||
scheduleCriteriaType |
X |
The type of schedule |
||
subPhaseCode |
Code of the sub-phase |
|||
subPhaseId |
Ident of the sub-phase |
|||
validated |
Set as True to only search for validated schedules |
3.382. ScheduleCriteriaFluent
Criteria used to get more details about schedules
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
actionCode |
Code of the action code |
|||
comment |
Comment of the schedule |
|||
creationDateFrom |
Starting creation date of the schedule |
|||
creationDateTo |
End creation date of the schedule |
|||
customerId |
Ident of the customer |
|||
description |
Description of the schedule |
|||
done |
Set as True to only search for done schedules, or False for not done schedules |
|||
employeeCode |
Code of the employee |
|||
employeeId |
Ident of the employee |
|||
employeeIdOnVacation |
Filter employees on vacation (either employee's id matches this criteria OR project is NOT typed 'leave') |
|||
id |
Ident of the schedule |
|||
location |
||||
modificationDateFrom |
Starting modification date of the schedule |
|||
modificationDateTo |
End modification date of the schedule |
|||
phaseCode |
Code of the phase |
|||
phaseId |
Ident of the phase |
|||
projectCode |
Code of the project |
|||
projectLeave |
Set as True if you want to include leave project |
|||
projectTaskCode |
Code of the task |
|||
projectTaskId |
Ident of the task |
|||
quotationId |
Clause concerning a potential linked quote. When present a quotationId implies that the schedule is provisional. |
|||
readOption |
Options used to get more information about the schedule |
|||
scheduleCriteriaType |
X |
The type of schedule |
||
subPhaseCode |
Code of the sub-phase |
|||
subPhaseId |
Ident of the sub-phase |
|||
validated |
Set as True to only search for validated schedules |
3.383. ScheduleDuplicationAtDateType
Type of schedule duplication where the duplication is by date
Type : enum (ALL_ELEMENTS_AT, FIRST_ELEMENT_FROM)
3.384. ScheduleDuplicationParamHolder
Parameter holder used to duplicate schedules
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
allowPublicHoliday |
Set as true to allow public holiday for schedule duplication |
|||
allowSaturday |
Set as true to allow saturday for schedule duplication |
|||
allowSunday |
Set as true to allow sunday for schedule duplication |
|||
date |
Date of the duplication |
date-time |
||
deleteOriginal |
Set as True if you want to delete original schedule. |
|||
duplicationAtDateType |
Details about the duplication at date type |
|||
duplicationNumberOfOccurrencyType |
Details about the duplication period type |
|||
duplicationPeriodRepetitionType |
Details about the duplication period type |
|||
duplicationStatusType |
Details about the duplication status type |
|||
duplicationType |
Details about the duplication type |
|||
employeeIds |
List of [string] |
List of employee's idents |
||
numberOfOccurrency |
Number of occurrency to duplicate schedule(s) given in scheduleIds |
|||
numberOfRepetition |
Repetition number |
|||
occurrency |
Number of occurrency for each schedule |
|||
projectTaskId |
ID of the project task to reassign |
|||
scheduleIds |
List of [string] |
List of schedule's idents |
||
until |
Duplicate schedule(s) until the date given in this parameter |
date-time |
3.385. ScheduleDuplicationPeriodType
Period available for the schedule's duplication
Type : enum (YEARLY, QUARTERLY, MONTHLY, WEEKLY, DAILY)
3.386. ScheduleDuplicationStatusType
Type of schedule duplication for the status. Keep the status, set validated or not validated
Type : enum (KEEP_STATUS, VALIDATED, NOT_VALIDATED)
3.387. ScheduleDuplicationType
Type of schedule duplication
Type : enum (AT_DATE, PERIODIC, WITH_OCCURRENCY)
3.388. ScheduleFillOptions
Options needed to fill the schedule
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
endMoment |
Indicates that the end date ends at this moment |
|||
startMoment |
Indicates that the start date begins at this moment |
3.389. ScheduleFillParamHolder
Object containing the schedule to fill and the options needed to fill the schedule
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
options |
Details about schedule's fill options |
|||
schedule |
Details about schedule |
3.390. ScheduleFluent
Schedule fluent
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
actionCode |
Details about the action verb |
|||
actionCodeId |
ID of the action code |
|||
changeTracking |
Date and user in case of creation and modification |
|||
color |
Color of the schedule (hexadecimal code) |
|||
comment |
Comment of the calendar event |
|||
customer |
Details about the customer |
|||
customerCode |
Code of the customer |
|||
customerId |
ID of the customer |
|||
date |
Date of the calendar event |
date-time |
||
dayMode |
True when the schedule is in day mode (1 day, half day…) |
|||
dayPart |
Part of the day on which to position the schedule created, according to the standard week. |
double |
||
description |
Description of the schedule |
|||
done |
Return True if the schedule is done |
|||
duration |
Duration of the calendar event |
double |
||
durations |
Duration in different units |
|||
employee |
Details about the employee |
|||
employeeCode |
Code of the employee |
|||
employeeId |
ID of the employee |
|||
endDate |
End date of the schedule |
date-time |
||
guid |
Global identifier of the calendar event (for mobile version only) |
|||
id |
ID of the calendar event |
|||
location |
Location of the calendar event |
|||
onlineMeeting |
Return True if the meeting is online |
|||
period |
Period of the schedule |
Enum: DAY, MORNING, AFTERNOON, DAY, MORNING, AFTERNOON |
||
phase |
Details about the phase |
|||
phaseCode |
Code of the phase |
|||
phaseId |
ID of the phase |
|||
project |
Details about the project |
|||
projectCode |
Code of the project |
|||
projectId |
ID of the project (equivalent to the code of the project) |
|||
projectTask |
Details about the task |
|||
projectTaskCode |
Code of the task |
|||
projectTaskId |
ID of the project |
|||
publication |
Publication date of the schedule |
date-time |
||
quotationId |
ID of the associated quotation. If set, this implies that the schedule is provisional. |
|||
salesOrderLine |
Details about sales order line |
|||
salesOrderLineId |
ID of the sales order line |
|||
siteId |
ID of the site |
|||
subPhase |
Details about the sub-phase |
|||
subPhaseCode |
Code of the sub-phase |
|||
subPhaseId |
ID of the sub-phase |
|||
tags |
List of TagLinked |
Details about the tag linked |
||
taskId |
Helpdesk's task ident |
|||
type |
Type of the calendar event |
|||
unit |
Details about the unit of duration |
|||
validated |
Return True if the calendar event is validated |
3.392. SchedulePublishContext
Context describing the various filters and options which make up the display of a schedule
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
contextType |
Context of the publish |
|||
currentView |
Schedule view from which ressource type can be extrapolated |
Enum: HOME_PROJECT, HOME_EMPLOYEE, EMPLOYEE, PROJECT, HOME_PROJECT, HOME_EMPLOYEE, EMPLOYEE, PROJECT |
||
displayOptions |
Map of [string] |
Options for data display |
||
endDate |
End date of the schedule to be published |
date-time |
||
filters |
Map of [array] |
Filter for data selection discriminating by object IDs grouped by object type |
||
selectedRessources |
List of [string] |
List of all ressources including extra ressources which are not already selected by the filters |
||
selectedSchedules |
List of [string] |
List of all selected schedules |
||
startDate |
Starting date of the schedule to be published |
date-time |
3.393. SchedulePublishParamHolder
Holder for the parameter necessary for publishing a schedule
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
arguments |
Details about publish arguments |
|||
context |
Details about the publish context |
3.394. ScheduleReadOption
The options you can use to get more information about the schedule.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
options |
List of [string] |
List of options used to get more details about the schedule |
Enum: EMPLOYEE, CUSTOMER, PROJECT, PHASE, SUB_PHASE, PROJECT_TASK, ACTION, CHANGE_TRACKING, FORM_CONFIG, SALES_ORDER_LINE, TAGS |
3.395. ScheduleRules
ScheduleRules
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
allowManualEntry |
Return true if manual input is allowed. If false is returned, only input by range will be allowed. |
|||
base |
Calculation base to deduce the maximum value of authorized decimal. This calculation can be used in other calculation on timesheets. |
double |
||
closingDates |
List of ClosingDate |
Deadline to input schedule or time |
||
employeeId |
ID of the employee |
|||
employeeWeeks |
List of EmployeeWeek |
Details about the standard week |
||
id |
ID of the calendar event |
|||
max |
Maximal limit (excluded) to input duration |
double |
||
min |
Minimal limit (excluded) to input duration |
double |
||
prettyStep |
Incremental graphic step for a duration |
double |
||
step |
Precision of a duration. Used to calculate the increment |
double |
||
timestamped |
Timestamped Schedule activated (see PLG_HORODATE) |
|||
unit |
Code of the unit duration |
|||
unitDuration |
Unit duration |
3.396. SearchControlBehavior
Detail about behavior and area to display the field
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
controlBehavior |
Details about the control behavior linked to the field |
|||
searchFieldInformation |
Details about the area linked to the field |
3.397. SearchFieldInformation
Informations sur un champ utilisé dans la configuration de la recherche. Le champ peut être affiché dans une zone différente en fonction du champ principal ou secondaire.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
categorySection |
The section in which the search field will be displayed. |
|||
categoryTab |
The tab in which the search field will be displayed. |
|||
code |
The code of the search field |
|||
fieldOrder |
Order number of the field |
int32 |
||
group |
Membership group of the field |
|||
id |
The Id of the search field |
|||
name |
The name of the search field |
|||
primary |
True when the search field is primary and will be displayed in the main search area |
|||
searchType |
The type of the search field |
|||
secondary |
True when the search field is secondary and will be displayed in the secondary search area. |
|||
sectionOrder |
Order number of the section |
int32 |
||
tabOrder |
Order number of the tab |
int32 |
3.398. SearchFieldType
Type of search field
Type : enum (DROPDOWN_LIST, DATE, TEXT, BOOLEAN, NUMBER)
3.399. SearchType
Type of search
Type : enum (PIPELINE_KANBAN, OPPORTUNITY, QUOTATION, SALES_ORDER, SALES_BILLING_TABLE, DELIVERY, SALES_INVOICE, CUSTOMER, SOLD_ITEM, QUOTE, PURCHASE_ORDER, PURCHASE_BILLING_TABLE, RECEPTION, PURCHASE_TEMPORARY_INVOICE, PURCHASE_INVOICE, CONTACT, EVENT, EMPLOYEE, PROJECT, PROJECT_TASK, ISSUE, SPRINT_CARD, PROJECT_EVENT, TIMESHEET_ENTRY, SCHEDULE, LEAVE_REQUEST_EMPLOYEE, EXPENSE_REPORT_EMPLOYEE, CUSTOM_REQUEST, PRODUCTION_TO_BILL_EMPLOYEE, PRODUCTION_TO_BILL_MANAGER, LEAVE_REQUEST_MANAGER, APPROVAL, EXPENSE_REPORT_MANAGER, SCHEDULE_BY_PROJECT, SCHEDULE_BY_EMPLOYEE, SCHEDULE_TIMESTAMPED, SCHEDULE_WORKLOAD, TASK_MANAGER)
3.400. Sector
Sector
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Code of the Sector |
|||
companyId |
ID of the company |
|||
endDate |
The end date of the Sector. |
date-time |
||
id |
Id in database |
|||
name |
Name of the Sector |
|||
ranking |
The sector ranking in the list |
int32 |
3.401. SelectOption
Option used to get select resource fields when doing a search
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
fields |
List of [string] |
List of the select option fields |
||
mode |
Mode of fields selection. If INCLUDE or EXCLUDE without fields all fields will be included |
Enum: INCLUDE, EXCLUDE, INCLUDE, EXCLUDE |
3.402. Service
Service
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Code of the service |
|||
id |
Id in database |
|||
name |
Name of the service |
3.403. ServiceCriteria
Criteria used when doing a Service search
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Code of a service |
|||
id |
Ident of a service |
|||
name |
Name of a service |
3.404. ShiftPeriod
Time unit for shifting the period.
Type : enum (YEAR, HALF_YEAR, QUARTER, MONTH, WEEK, DAY)
3.405. Skill
Skill of an employee
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Code of the skill |
|||
id |
Id in database |
|||
name |
Name of the skill |
|||
typeCode |
Code of the skill's type |
|||
typeLabel |
Label of the skill's type |
3.406. SkillCriteria
Criteria used when doing a skill search
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Code of the skill |
|||
id |
Ident of the skill |
|||
name |
Name of the skill |
|||
onlyMainSkill |
Set as true if you only want to search for main skills |
|||
projectTaskId |
Ident of the task |
|||
tag |
You can use this clause to do a text search on the code and name |
3.408. SoldItem
Sold item
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
accountSettings |
Accounting information for an item. |
|||
automaticTitle |
Automatic title for a sold item, used for structuring and hierarchization of elements that utilize this sold item. |
|||
billingMode |
defaut billing mode for the item |
|||
category |
All details about the category of the product |
|||
categoryId |
The Id of the category |
|||
comment |
Comment on the product |
|||
companyCode |
The company code |
|||
customData |
Map of CustomData |
All custom data to update |
||
entityCode |
The entity code |
|||
family (Deprecated) |
The category of the product |
|||
grouping |
The grouping of the product |
|||
id |
Id in database |
|||
inventory |
Returns true if the product is in the inventory |
|||
inventoryAndPackaging |
Details about Inventory and Packaging |
|||
name |
Identification name |
|||
productionEstimatedDuration |
Estimated duration in minutes |
double |
||
productionInformations |
Details about productions informations |
|||
quantityPrecision |
Number of decimals for this item quantity |
double |
||
reference |
The reference of the product |
|||
shortName |
Abbreviated designation |
|||
subCategory |
All details about the sub-category of the product |
|||
subCategoryId |
The Id of the sub-category |
|||
subFamily (Deprecated) |
The sub-category of the product |
|||
unitPricePrecision |
Number of decimals for this item unit price |
double |
3.409. SoldItemCriteria
Search criteria for sold items
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
billingMode |
Billing mode for the sold item |
|||
categoryId |
The ID of the category |
|||
companyCode |
Code of the company |
|||
customData |
Map of Clause |
The custom data (when present) |
||
defaultDisplay |
Set as “True” to load only productions should be displayed by default. If not specified, all productions are loaded. |
|||
entityId |
Ident of the entity of the sold item |
|||
grouping |
Grouping of the sold item |
|||
id |
Ident of the sold item |
|||
inventory |
Returns true if the product is in the inventory |
|||
linkedToAdvancePayments |
Set as True to return production linked to advance payments. |
|||
marketEndDate |
End-of-sale date for the sold item. Indicates when the product stopped being available for sale |
|||
name |
Identification name |
|||
packagingType |
The packaging type of the sold item |
|||
readOption |
Options for retrieving extra information concerning the billing table |
|||
reference |
Reference of the sold item |
|||
subCategoryId |
The ID of the sub category |
|||
tag |
You can fill in the reference or grouping of the tag in this field |
|||
teamId |
The ID of the production team |
|||
validity |
Details about the validity of the sold item |
3.410. SoldItemReadOption
ReadOption of a SoldItem
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
options |
List of [string] |
List of options used to get more details about the sold item |
Enum: PRODUCTION_INFORMATIONS, PRODUCTION_INFORMATIONS_TEAM, CATEGORY, SUB_CATEGORY, CUSTOM_DATA |
3.411. SortField
Couple field/sort type
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
fieldName |
Name of the field |
|||
order |
Sort type. (ASC or DESC) |
3.413. SplitElement
Information used to split a Project Event into n parts
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
action |
X |
Details about the action verb |
||
allowPublicHoliday |
Whether or not planning elements are allowed on public holidays |
|||
allowSaturday |
Whether or not planning elements are allowed on Saturdays |
|||
allowSunday |
Whether or not planning elements are allowed on Sundays |
|||
duration |
Duration of the project event |
double |
||
order |
Order number of the project event |
|||
startDate |
Start date of the project event |
date-time |
||
type |
X |
Type of the project event |
||
unit |
Details about the unit duration |
|||
validated |
True if the project event is validated, false if not validated. By default keep the status of the original element. |
3.414. StageBase
Oppportunity Stage Base
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
The code of the opportunity stage |
|||
id |
Id in database |
|||
name |
Name of the opportunity stage |
3.416. StandardWeek
Standard week
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Code of the standard week |
|||
companyCode |
Code of the company |
|||
id |
Id in database |
|||
name |
Name of the standard week |
|||
typicalDaysByWeekDay |
Details of the worked hours for each day |
3.417. StandardWeekBase
Represents a standard week configuration, typically used to define recurring working patterns (e.g., default work week).
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Code of the standard week |
|||
id |
Id in database |
|||
name |
Name of the standard week |
3.418. StandardWeekCriteria
Criteria used when doing a standard week search
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
||||
companyCode |
||||
default |
Set to true to retrieve the default standard weeks |
|||
id |
3.419. StandardWeekTypicalDaysByWeekDay
Details of the worked hours for each day
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
afternoonEndTime |
End time when the employee stops working in the afternoon |
double |
||
afternoonMinutes |
Minutes worked in the afternoon |
double |
||
afternoonStartTime |
Start time when the employee starts working in the afternoon |
double |
||
morningEndTime |
End time when the employee stops working in the morning |
double |
||
morningMinutes |
Minutes worked in the morning |
double |
||
morningStartTime |
Start time when the employee starts working in the morning |
double |
3.420. StatusFilter
Filtering criteria based on resource status.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
dateOperator |
Defines how the reference date is used to filter resources based on whether they have the specified status or not. |
|||
isActive |
Indicates whether the resource status is active or inactive. |
|||
referenceDate |
The reference date to check the status of the resource. If not provided, the current date is used by default. |
date-time |
3.421. StringParamHolder
Parameter value (String).
See the documentation of the calling API body for further information
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
value |
Value |
3.422. StringsParamHolder
Parameter value (Array[String]).
See the documentation of the calling API body for further information
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
value |
List of [string] |
Value |
3.423. SubCategory
Sub-Category
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
category |
Details about the category |
|||
categoryId |
The Id of the category |
|||
code |
The code of the sub-category |
|||
company |
Details about the company |
|||
companyCode (Deprecated) |
The code of the company |
|||
companyId |
ID of the company |
|||
endDate |
End date for using the sub-category |
date |
||
grouping |
Grouping field for sub-category |
|||
id |
Id in database |
|||
name |
The name of the sub-category |
|||
ranking |
Sub-category ranking in help lists |
int32 |
||
type |
Type of the category. |
3.424. SubCategoryCriteria
Criteria used on sub-category when doing a sub-category search
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
categoryId |
Category's ident of the sub-category |
|||
code |
Code of the sub-category |
|||
companyId |
Company of the sub-category |
|||
endDate |
End date of validity for the sub-category |
|||
grouping |
Grouping field of the sub-category |
|||
id |
Ident of the sub-category |
|||
name |
Name of the sub-category |
|||
nature |
Nature of the sub-category |
|||
readOption |
Options for retrieving extra information concerning the sub-category |
|||
tag |
You can fill in the code or name of the sub-category in this field |
|||
type |
Type of the sub-category |
|||
validity |
Details about the validity of the sub-category |
3.425. SubCategoryItem
Sub category of an item
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
category |
Details about the category |
|||
categoryId |
The Id of the category |
|||
code |
The code of the sub-category |
|||
company |
Details about the company |
|||
companyCode (Deprecated) |
The code of the company |
|||
companyId |
ID of the company |
|||
endDate |
End date for using the sub-category |
date |
||
grouping |
Grouping field for sub-category |
|||
id |
Id in database |
|||
name |
The name of the sub-category |
|||
ranking |
Sub-category ranking in help lists |
int32 |
||
subCategoryType |
Type of the purchased item sub-category |
|||
type |
Type of the category. |
3.426. SubCategoryItemClassification
Purchased item sub-category classification
Type : enum (EXTERNAL, INTERNAL, NOT_SPECIFIED, OTHERS, PRICE_REVIEW)
3.427. SubCategoryItemCriteria
Criteria used to get more details about Sub category of an item
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
categoryId |
The Id of the category |
|||
code |
The code of the sub-category item |
|||
companyId |
The Id of the company |
|||
endDate |
End date of validity for the sub-category item |
|||
grouping |
Grouping field for sub-category item |
|||
id |
The Id of the sub-category item |
|||
name |
Name of the sub-category item |
|||
nature (Deprecated) |
Nature of the sub-category item |
|||
readOption |
Options for retrieving extra information concerning the sub-category of an item |
|||
subCategoryType |
Type of the purchased item sub-category item |
|||
tag |
You can fill in the code or name of the sub-category item in this field |
|||
type |
Type of the sub-category item. |
|||
validity |
Details about the validity of the sub-category item |
3.428. SubCategoryItemReadOption
The options you can use to get more information about the sub category of an item
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
options |
List of [string] |
List of options used to get more details about the sub category of an item |
Enum: CATEGORY, COMPANY |
3.429. 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, FORMATION)
3.430. SubCategoryReadOption
The options you can use to get more information about the sub category
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
options |
List of [string] |
List of options used to get more details about the sub category |
Enum: CATEGORY, COMPANY |
3.431. SubPhaseBase
SubPhase
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Code of a sub-phase |
|||
id |
Id in database |
|||
name |
Name of a sub-phase |
|||
order |
Order number of the sub-phase |
int32 |
||
phase |
Details about the corresponding phase |
|||
phaseId |
ID of the corresponding phase |
3.432. SubPhaseState
State of a sub-phase
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
The code of the sub-phase state |
|||
companyId |
ID of the company |
|||
id |
ID of the sub phase state |
|||
name |
The name of the sub-phase state |
3.433. SubPhaseStateCriteria
Criteria used on sub-phase state when doing a sub-phase state search
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
||||
companyId |
||||
id |
||||
name |
3.434. SubledgerAccountBase
Subledger account (ident example AKSAS22106800)
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
Id in database |
|||
name |
Subledger account label |
3.435. SubledgerAccountCommon
Subledger account
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
Id in database |
|||
name |
Subledger account label |
|||
number |
Subledger account number |
3.436. Subscription
Subscription to listen events using SSE
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
excludeMyOwnEvents |
Set as true to exclude the event of which I am the author. |
|||
token |
The token code allocated to the susbscription. |
|||
topic |
Topic to listen events |
3.437. SupplierBase
Suppliers
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
The code of the third party (customer, supplier, other third party). |
|||
id |
Id in database |
|||
name |
The name of the third party (customer, supplier, other third party). |
3.438. SupplierSiteBase
Supplier Site Base (Site Fournisseur)
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
Id in database |
|||
name |
Name of the supplier site |
|||
supplierId (Deprecated) |
Warning : The supplier ID cannot be changed once the supplier site has been created. Any modification will not be taken into account. |
3.440. SupplierVariety
The variety of the supplier.
SUPPLIER_EMPLOYEE is set if the supplier is refers to an employee.
Type : enum (SUPPLIER_EMPLOYEE, SUPPLIER, ALL)
3.441. Tag
Tag
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Code of the tag |
|||
color |
Color of the tag |
|||
comment |
Comment of the tag |
|||
companyId |
ID of the company |
|||
endDate |
End of validity of the tag |
date-time |
||
icon |
Icon of the tag |
|||
id |
Id in database |
|||
name |
Name of the tag |
|||
type |
Type of the tag |
3.442. TagCriteria
Criteria used when doing a tag search
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Code of the tag |
|||
companyId |
Ident of the company |
|||
id |
Ident of the tag |
|||
name |
Name of the tag |
|||
tag |
You can fill in the code or name of the tag in this field |
|||
type |
Type of the tag |
|||
validity |
Details about validity |
3.443. TagLinked
Tag linked
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
action |
Details about the action verb |
|||
code |
Code of the tag |
|||
color |
Color of the tag |
|||
comment |
Comment of the tag |
|||
companyId |
ID of the company |
|||
endDate |
End of validity of the tag |
date-time |
||
icon |
Icon of the tag |
|||
id |
Id in database |
|||
name |
Name of the tag |
|||
objectId |
ID of the linked object |
|||
type |
Type of the tag |
3.445. TaskBase
Task base
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
Id in database |
3.446. TaskBillingType
The list of value of billing type of the type of project task.
Type : enum (TIME_BASED, TIME_BASED_FIXED_PRICE_MONTHLY)
3.447. TaskCommon
Task common
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
Id in database |
|||
number |
The number of the task. |
int32 |
3.448. TaxInformation
Tax Information
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
VATAreaId (Deprecated) |
The Id of the VAT Area |
|||
VATNumber (Deprecated) |
The number of the VAT rate |
|||
euExempt |
The 'euExempt' field indicates whether Intracommunity VAT exemption applies. |
|||
exempt |
The 'exempt' field indicates whether there is VAT exemption. |
|||
vatArea |
Details about the VAT Area. |
|||
vatAreaId |
The Id of the VAT Area |
|||
vatNumber |
The number of the VAT rate |
3.449. TemplatedMessage
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.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
message |
||||
parameters |
List of PublishTemplateParameter |
Details about the template parameters |
||
templateId |
The publish template needed to generate and attach the report |
3.450. ThirdPartyBase
Third Party Base
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
The code of the third party (customer, supplier, other third party). |
|||
id |
Id in database |
|||
name |
The name of the third party (customer, supplier, other third party). |
3.451. ThirdPartyLinkType
Third Party Link Type
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
The code of third party link type |
|||
company |
Details about the company |
|||
companyId |
The Id of the company |
|||
endDate |
End date for third party link type. When the date is reached, the type can no longer be used. |
date-time |
||
id |
ID in database |
|||
name |
The name of third party link type |
|||
requiredSiren |
Set as 'true' to make SIREN entry mandatory for this type. |
3.452. ThirdPartyTypeEnum
A type of the third party with people links
Type : enum (PROSPECT, CUSTOMER, SUPPLIER, OTHER_THIRD_PARTY)
3.453. Timeline
Timeline which define the initial date, the expected date and the actual date
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
actualDate |
The actual or effective date. |
date-time |
||
expectedDate |
The currently expected date. |
date-time |
||
initialDate |
The initially defined date. |
date-time |
3.454. TimelineCriteria
Timeline criteria which define the initial date, the expected date and the actual date
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
actualDate |
The actual or effective date. |
|||
expectedDate |
The currently expected date. |
|||
initialDate |
The initially defined date. |
3.455. TimesheetCreateObjectType
Query param for object type
Type : enum (PRODUCTION_TO_BE_BILLED, ISSUE_TASK)
3.456. TimesheetEntry
TimesheetEntry
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
actionCode |
Details about the action verb |
|||
actionCode2 |
Details of the action code |
|||
actionCode2Id |
ID of the second action code |
|||
actionCodeId |
ID of the action code |
|||
approval |
Approval of the timesheet entry |
Enum: BRUT, CONTROLE, VALIDE, GRATUIT, NON_FACTURE, FACTURE, REFUSE, DISSOCIE, BRUT, CONTROLE, VALIDE, GRATUIT, NON_FACTURE, FACTURE, REFUSE, DISSOCIE |
||
approvalLabel |
Label of the approval |
|||
changeTracking |
Date and user in case of creation and modification |
|||
comment |
Comment of the calendar event |
|||
completionDate |
Completion Date |
date-time |
||
customer |
Details about the customer |
|||
customerId |
ID of the customer |
|||
date |
Date of the calendar event |
date-time |
||
duration |
Duration of the calendar event |
double |
||
durations |
Duration in different units |
|||
employee |
Details about the employee |
|||
employeeId |
ID of the employee |
|||
guid |
Global identifier of the calendar event (for mobile version only) |
|||
id |
ID of the calendar event |
|||
location |
Location of the calendar event |
|||
phase |
Details about the phase |
|||
phaseId |
ID of the phase |
|||
project |
Details about the project |
|||
projectId |
ID of the project (equivalent to the code of the project) |
|||
projectTask |
Details about the task |
|||
projectTaskId |
ID of the project |
|||
subPhase |
Details about the sub-phase |
|||
subPhaseId |
ID of the sub-phase |
|||
taskId |
Helpdesk's task ident |
|||
type |
Type of the calendar event |
|||
unit |
Details about the unit of duration |
|||
validated |
Return True if the calendar event is validated |
3.457. TimesheetEntryBase
TimesheetEntryBase
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
actionCode |
Details about the action verb |
|||
actionCode2 |
Details of the action code |
|||
actionCode2Id |
ID of the second action code |
|||
actionCodeId |
ID of the action code |
|||
approval |
Approval of the timesheet entry |
Enum: BRUT, CONTROLE, VALIDE, GRATUIT, NON_FACTURE, FACTURE, REFUSE, DISSOCIE, BRUT, CONTROLE, VALIDE, GRATUIT, NON_FACTURE, FACTURE, REFUSE, DISSOCIE |
||
approvalLabel |
Label of the approval |
|||
changeTracking |
Date and user in case of creation and modification |
|||
comment |
Comment of the calendar event |
|||
completionDate |
Completion Date |
date-time |
||
customer |
Details about the customer |
|||
customerId |
ID of the customer |
|||
date |
Date of the calendar event |
date-time |
||
duration |
Duration of the calendar event |
double |
||
durations |
Duration in different units |
|||
employee |
Details about the employee |
|||
employeeId |
ID of the employee |
|||
guid |
Global identifier of the calendar event (for mobile version only) |
|||
id |
ID of the calendar event |
|||
location |
Location of the calendar event |
|||
phase |
Details about the phase |
|||
phaseId |
ID of the phase |
|||
project |
Details about the project |
|||
projectId |
ID of the project (equivalent to the code of the project) |
|||
projectTask |
Details about the task |
|||
projectTaskId |
ID of the project |
|||
subPhase |
Details about the sub-phase |
|||
subPhaseId |
ID of the sub-phase |
|||
taskId |
Helpdesk's task ident |
|||
type |
Type of the calendar event |
|||
unit |
Details about the unit of duration |
|||
validated |
Return True if the calendar event is validated |
3.458. TimesheetEntryCompletion
TimesheetEntryCompletion
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
completionType |
Type of the completion |
Enum: WEEK, MONTH, WEEK, MONTH |
||
employee |
Remark : In add APIs (mainly PUT requests) |
|||
employeeId |
ID of the employee |
|||
id |
Id in database |
|||
number |
Week number of the completion (Only if the completion type is set as WEEK) |
double |
||
year |
Year of the completion (Only if the completion type is set as MONTH) |
double |
3.459. TimesheetEntryCompletionCriteria
TimesheetEntryCompletionCriteria
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
employeeId |
||||
id |
||||
managerId |
||||
number |
Timesheet entry completion number |
|||
type |
||||
year |
Timesheet entry completion year |
3.460. TimesheetEntryCriteria
Criteria used on Category when doing a timesheet entry search
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
actionCode2Id |
ActionCode2 stands for the 'action code 2' related to the timesheet entry, so this clause lets users search for the 'action code 2' id |
|||
actionCodeCode |
ActionCode stands for the 'action code' related to the timesheet entry, so this clause lets users search for the 'action code' code |
|||
approval |
||||
comment |
||||
companyId |
||||
controlsManagerId |
Controls Manager for the time's project |
|||
customerId |
||||
date |
Date of the timesheet entry |
|||
divisionGroupingId |
||||
divisionId |
||||
doNotRoundUp |
Set to true if the timesheet entry is not rounded up |
|||
employeeId |
||||
entityId |
||||
id |
||||
location |
||||
managerId |
||||
notBilled |
The time is not billed, there's no delivery linked |
|||
onlyFinishedTimes |
Set as True if you want to search for completed times only |
|||
period |
||||
phaseId |
||||
productionId |
Id of the Production to be billed |
|||
project |
||||
projectId |
||||
projectTaskId |
||||
readOption |
Options used to get more details about the timesheet entry |
|||
serviceId |
||||
subPhaseId |
3.461. TimesheetEntryReadOption
Criteria used to get more details about timesheet entries.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
options |
List of [string] |
List of options used to get more details about the timesheet entries |
Enum: EMPLOYEE, CUSTOMER, PROJECT, PHASE, SUB_PHASE, PROJECT_TASK, ACTION, ACTION_2, CHANGE_TRACKING, FORM_CONFIG |
3.462. TimesheetEntryRules
Time rules
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
allowManualEntry |
Return true if manual input is allowed. If false is returned, only input by range will be allowed. |
|||
base |
Calculation base to deduce the maximum value of authorized decimal. This calculation can be used in other calculation on timesheets. |
double |
||
closingDates |
List of ClosingDate |
Deadline to input schedule or time |
||
completionMode |
The completion mode used. Please refer to the TPS_TERMINAISON control |
Enum: WEEKLY, MONTHLY, WEEKLY_MONTHLY, NONE, WEEKLY, MONTHLY, WEEKLY_MONTHLY, NONE |
||
employeeId |
ID of the employee |
|||
employeeWeeks |
List of EmployeeWeek |
Details about the standard week |
||
id |
ID of the calendar event |
|||
max |
Maximal limit (excluded) to input duration |
double |
||
min |
Minimal limit (excluded) to input duration |
double |
||
prettyStep |
Incremental graphic step for a duration |
double |
||
simpleDuration |
Duration of a day in minutes. Please refer to the TPSCTRL_SIMPLE control |
double |
||
step |
Precision of a duration. Used to calculate the increment |
double |
||
unit |
Code of the unit duration |
|||
unitDuration |
Unit duration |
3.463. TimesheetPreFillObjectType
Query param for object type
Type : enum (PROJECT_TASK, ISSUE, ISSUE_TASK, CARD, QUICK_ENTRY, PRODUCTION_TO_BE_BILLED)
3.464. Title
Title / Marriage status
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Code of the title |
|||
companyId |
ID of the company |
|||
id |
Id of the title |
|||
name |
Name of the title |
|||
order |
Order number of the title |
int32 |
||
titleType |
Type of the title |
3.466. Topic
Topic to listen events
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
action |
The action verb (ADD / UPDATE / REMOVE). |
|||
id |
ID of the topic |
|||
type |
Type of event. |
3.467. TransactionStatus
Transaction status for electronic signatures
Type : enum (IN_PROGRESS, CANCELED, EXPIRED, COMPLETED)
3.468. TransferEmployeeParamHolder
Parameters when transferring an employee.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
comment |
All comments about the change. |
|||
newCompanyId |
Ident of the new company. |
|||
startDate |
Departure date of the employee to another company. |
date-time |
3.469. UnitDuration
Unit of duration
Type : enum (MINUTE, HOUR_MINUTE, HOUR_DECIMAL, DAY, UNIT_OF_EMPLOYEE, UNIT_OF_COMPANY)
3.470. UnitPrice
Unit price of an item
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
value |
Unit price of an item |
double |
3.471. UserBase
User
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Code of the user |
|||
firstName |
First name of the user |
|||
id |
Id in database |
|||
name |
Name of the user |
3.472. UserCriteria
UserCriteria
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
||||
readOption |
Options for retrieving extra information concerning the user |
|||
tag |
Code or Last Name or First Name of the User |
3.473. UserProfileBase
User Profile Base
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Code of the user profile |
|||
id |
Id in database |
|||
name |
Name of the user profile |
3.474. UserReadOption
Options used to get additional information on user
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
options |
List of [string] |
List of options used to get more details about the user |
Enum: EMPLOYEE |
3.475. VAT
VAT
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
VAT code |
|||
companyCode |
The company code |
|||
endDate |
End date of the VAT |
date-time |
||
id |
Id in database |
|||
name |
Name |
|||
purchasingAccountNumber |
General purchasing account number linked to the tax code |
|||
rate |
VAT rate in percentage |
double |
||
reduced |
Returns true if the rate is reduced |
|||
salesAccountNumber |
General sales account number linked to the tax code |
|||
startDate |
Start date of the VAT |
date-time |
3.476. VATAreaBase
VAT Area Base
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
The code of the VAT area |
|||
id |
Id in database |
|||
name |
The name of the VAT area |
3.477. VATBase
VAT
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
VAT code |
|||
id |
Id in database |
|||
rate |
VAT rate in percentage |
double |
3.478. Validity
Validity criteria
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
date |
Date of validity of the item |
date-time |
||
type |
Details about the type of validity. |
3.480. Vehicle
Informations about vehicle of an employee
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
employee |
Employee |
|||
employeeId |
ID of the employee |
|||
endDate |
Date by which the vehicle ends |
date-time |
||
expenseType |
Details about the expense type |
|||
expenseTypeId |
ID of the expense type |
|||
id |
Id in database |
|||
licensePlate |
License Plate of the vehicle |
|||
power |
Power of the engine |
double |
3.481. VehicleCriteria
Search criteria for vehicle
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
employeeId |
Ident of the employee |
|||
expenseTypeId |
Ident of the expense type |
|||
id |
Ident of the vehicle |
|||
licensePlate |
License Plate of the vehicle |
|||
power |
Power of the engine |
|||
validity |
Details about the validity criteria |
3.482. WorkforceProjectCriteria
Criteria used on Project when doing a Project search
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
activityId |
||||
categoryId |
||||
customerId |
||||
departmentId |
||||
divisionGroupingId |
||||
divisionId |
||||
entityId |
||||
financialManagerId |
||||
id |
||||
managerId |
||||
name |
||||
productionManagerId |
||||
projectGroupCode |
||||
projectState |
||||
referentialDate |
Date à laquelle l'affaire doit être active (en prod) |
date-time |
||
salesManagerId |
||||
subCategoryId |
||||
subCategoryLevel2Id |
||||
tag |
Unused at the moment |
3.483. Year
Year (vintage) of the opportunity
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
The code of the year (vintage). |
|||
disabledDate |
Date of disability |
date-time |
||
id |
Id in database |
|||
name |
The name of the year (vintage). |
|||
previousYearId |
Previous year (vintage) ID. |
|||
repeating |
Set as true if the vintage is recurrent. |
|||
validityEndDate |
The end date of validity. |
date-time |
3.484. YearCriteria
Criteria used to search Year (vintage)
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
The code of the year (vintage) |
|||
companyId |
ID of the company |
|||
disabledDate |
Date on which the year will become inactive |
|||
id |
The ID of the year (vintage) |
|||
name |
The name of the year (vintage) |
|||
previousYearId |
Previous year (vintage) ID |
|||
validityEndDate |
Validity applicable on end date of the year |
4. Access
-
HTTP Basic Authentication BasicAuth BasicAuth
-
OAuth AuthorizationUrl: _, TokenUrl: _https://api.akuiteo.fr/akuiteo/oauth2/token
Unresolved directive in index.adoc - include::../../dist/deprecated.adoc[]
Unresolved directive in index.adoc - include::../../dist/lexique.adoc[]
Publication date : 2025-10-02 11:52:30
Copyright : Akuiteo © 2025