1. Introduction
The Project management domain enables you to manage projects, phases, sub-phases and project tasks.
1.3. Tags
-
Activities : Activities
-
Assignments : Project Management
-
Departments : Departments
-
Divisions : Divisions
-
Phase states : Phase states
-
Phases : Project Management
-
Project groups : Project groups
-
Project states : Project states
-
Project tasks : Project Management
-
Projects : Project Management
-
Sub-phase states : Sub-phase states
-
Sub-phases : Project Management
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. Activities
2.1.1. Get an activity
GET |
/activities/{activity_id} |
Deprecated
|
Tip
|
This API will soon be moved to another domain but remains functional. |
Description
Get an activity
DMF required:
-
DMF A90506: Api Project / Activities / Info
-
DMF 060104: Projects
-
DMF 090104: Administrator / Setup / Company
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
activity_id |
The id of the activity |
X |
null |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Activity 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.1.2. Get an activity with read options
POST |
/activities/{activity_id}/read |
Deprecated
|
Tip
|
This API will soon be moved to another domain but remains functional. |
Description
Get an activity with read options
DMF required:
-
DMF A90506: Api Project / Activities / Info
-
DMF 060104: Projects
-
DMF 090104: Administrator / Setup / Company
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
activity_id |
The id of the activity |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
read_option |
The read options for returned activity ActivityReadOption |
- |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Activity 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" : [ "DEPARTMENT", "DEPARTMENT" ]
}
2.1.3. Search activities
POST |
/activities/search |
Deprecated
|
Tip
|
This API will soon be moved to another domain but remains functional. |
Description
Search activities
DMF required:
-
DMF A90504: Api Project / Activities / Search
-
DMF 060104: Projects
-
DMF 090104: Administrator / Setup / Company
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
criteria |
Search criteria ActivityCriteria |
- |
Return Type
array[Activity]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Activities successfully loaded |
List[Activity] |
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" : "2020-01-23T04:56:07Z",
"departmentId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"name" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"id" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
}
}
2.2. Assignments
2.2.1. Search Assignment
POST |
/assignments/{active_module}/search |
Description
Search Assignment
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
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
active_module |
The active module |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
criteria |
Search criteria AssignmentCriteria |
- |
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
limit |
The max number of ancestor nodes (ex if countAssignmentType = PROJECT then the number of projects will be limited to the 'limit' specified) |
- |
null |
Return Type
array[AssignmentNode]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Projects 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.2.2. Search Assignment Referential
POST |
/assignments-referential/{active_module}/search |
Description
Search Assignment Referential
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
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
active_module |
The active module |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
criteria |
Search criteria AssignmentCriteria |
- |
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
limit |
The max number of ancestor nodes (ex if countAssignmentType = PROJECT then the number of projects will be limited to the 'limit' specified) |
- |
null |
|
subtype |
Subtype of assignment |
- |
null |
Return Type
array[AssignmentReferential]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Assignment Referential successfully loaded |
List[AssignmentReferential] |
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.3. Departments
2.3.1. Get a department
GET |
/departments/{department_id} |
Deprecated
|
Tip
|
This API will soon be moved to another domain but remains functional. |
Description
Get an department
DMF required:
-
DMF A90606: Api Project / Divisions / Info
-
DMF 060104: Projects
-
DMF 090104: Administrator / Setup / Company
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
department_id |
The id of the department |
X |
null |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Department 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.2. Search departments
POST |
/departments/search |
Deprecated
|
Tip
|
This API will soon be moved to another domain but remains functional. |
Description
Search departments
DMF required:
-
DMF A90604: Api Project / Divisions / Search
-
DMF 090104: Administrator / Setup / Company
-
DMF 020204: Sales / Quotations / Search
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
criteria |
Search criteria DepartmentCriteria |
- |
Return Type
array[Department]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Departments successfully loaded |
List[Department] |
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" : "*"
}
}
2.4. Divisions
2.4.1. Search divisions
POST |
/divisions/search |
Deprecated
|
Tip
|
This API will soon be moved to another domain but remains functional. |
Description
Search divisions
DMF required:
-
DMF A90604: Api Project / Divisions / Search
-
DMF 090104: Administrator / Setup / Company
-
DMF 020204: Sales / Quotations / Search
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
criteria |
Search criteria DivisionCriteria |
- |
Return Type
array[Division]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Divisions successfully loaded |
List[Division] |
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" : "*"
},
"serviceId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
}
}
2.5. Phase States
2.5.1. Get a phase state
GET |
/phase-states/{phase_state_id} |
Description
Get a phase state
DMF required:
-
DMF A91006: Api Project / Phase States / Info
-
DMF 060612: Projects / Setup / Projects' Status Codes
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
phase_state_id |
The id of the phase state |
X |
null |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Phase state 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.2. Search phase states
POST |
/phase-states/search |
Description
Search phase states
DMF required:
-
DMF A91004: Api Project / Phase States / Search
-
DMF 060612: Projects / Setup / Projects' Status Codes
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
criteria |
Search criteria PhaseStateCriteria |
- |
Return Type
array[PhaseState]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Phase states successfully loaded |
List[PhaseState] |
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" : "*"
}
}
2.6. Phases
2.6.1. Close a phase of a project
POST |
/projects/{project_id}/phases/{phase_id}/close |
Description
Close a phase
DMF required:
-
DMF A90209: Api Project / Phases / Close The Phase Of Project
-
DMF 060807: Projects / Phases / Close
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
project_id |
The id of the project |
X |
null |
|
phase_id |
The id of the phase |
X |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Phase has been successfully closed |
<<>> |
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.2. Create a phase of a project
PUT |
/projects/{project_id}/phases |
Description
Create a phase using the list of parameters below
DMF required:
-
DMF A90201: Api Project / Phases / Insert
-
DMF 060801: Projects / Phases / New
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
project_id |
The id of the project |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
phase |
The phase to create Phase |
X |
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
201 |
The phase 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",
"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,
"expectedStart" : "2000-06-21",
"expectedEnd" : "2000-06-21",
"description" : "Lorem ipsum",
"state" : {
"id" : "id",
"code" : "PRO",
"name" : "Production",
"companyId" : "5000123",
"default" : false
},
"stateId" : "5000123",
"manager" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"managerId" : "5000123",
"quoteNumber" : "123",
"customerContact" : "customerContact",
"actualStart" : "2000-06-21",
"actualEnd" : "2000-06-21",
"customerHostSite" : {
"id" : "5000123",
"code" : "code",
"name" : "Paris",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "CUST_001"
},
"customerHostSiteId" : "5000123",
"closure" : false,
"customData" : {
"key" : {
"type" : "{}",
"value" : "Autoref 010520",
"name" : "Reference 4",
"realOrder" : 0,
"label" : "REFERENCE_4"
}
},
"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.6.3. Delete a phase of a project
DELETE |
/projects/{project_id}/phases/{phase_id} |
Description
Delete a phase of project
DMF required:
-
DMF A90203: Api Project / Phases / Delete
-
DMF 060803: Projects / Phases / Delete
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
project_id |
The id of the project |
X |
null |
|
phase_id |
The id of the phase |
X |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
The phase 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.6.4. Get phase of project
GET |
/projects/{project_id}/phases/{phase_id} |
Description
Get phase of project
DMF required:
-
DMF A90206: Api Project / Phases / Info
-
DMF 141301: Helpdesk / Issues / New
-
DMF 142601: Helpdesk / Simplified Issue / New
-
DMF 142626: Helpdesk / Simplified Issue / New Issue From Template
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
project_id |
The id of the project |
X |
null |
|
phase_id |
The id of the phase |
X |
null |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Phase 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. Update the state code of the phase
POST |
/projects/{project_id}/phases/{phase_id}/modify-state |
Description
Update the state code of the phase
DMF required:
-
DMF A90208: Api Project / Phases / Update The State Code Of The Phase
-
DMF 060810: Projects / Phases / Modify Status Code
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
project_id |
The id of the project |
X |
null |
|
phase_id |
The id of the phase |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
phaseState |
The arguments for updating the state code PhaseState |
X |
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
The state code 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" : "id",
"code" : "PRO",
"name" : "Production",
"companyId" : "5000123",
"default" : false
}
2.6.6. Patch a phase
PATCH |
/projects/{project_id}/phases/{phase_id} |
Description
Patch the phase matching the specified ID and using the list of parameters below.
DMF required:
-
DMF A90202: Api Project / Phases / Update
-
DMF 060802: Projects / Phases / Modify
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
project_id |
The id of the project |
X |
null |
|
phase_id |
The id of the phase |
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 |
Phase 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.6.7. Pre-fill a phase of a project
POST |
/projects/{project_id}/phases/pre-fill |
Description
Pre-fill a phase of a project with default values or values specified in the request body.
DMF required:
-
DMF A90201: Api Project / Phases / Insert
-
DMF 060801: Projects / Phases / New
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
project_id |
The id of the project |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
phase |
The phase to pre-fill Phase |
- |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Phase 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",
"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,
"expectedStart" : "2000-06-21",
"expectedEnd" : "2000-06-21",
"description" : "Lorem ipsum",
"state" : {
"id" : "id",
"code" : "PRO",
"name" : "Production",
"companyId" : "5000123",
"default" : false
},
"stateId" : "5000123",
"manager" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"managerId" : "5000123",
"quoteNumber" : "123",
"customerContact" : "customerContact",
"actualStart" : "2000-06-21",
"actualEnd" : "2000-06-21",
"customerHostSite" : {
"id" : "5000123",
"code" : "code",
"name" : "Paris",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "CUST_001"
},
"customerHostSiteId" : "5000123",
"closure" : false,
"customData" : {
"key" : {
"type" : "{}",
"value" : "Autoref 010520",
"name" : "Reference 4",
"realOrder" : 0,
"label" : "REFERENCE_4"
}
},
"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.6.8. Get a phase with read options
POST |
/projects/{project_id}/phases/{phase_id}/read |
Description
Get a phase with read options
DMF required:
-
DMF A90206: Api Project / Phases / Info
-
DMF 141301: Helpdesk / Issues / New
-
DMF 142601: Helpdesk / Simplified Issue / New
-
DMF 142626: Helpdesk / Simplified Issue / New Issue From Template
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
project_id |
The id of the project |
X |
null |
|
phase_id |
The id of the phase |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
read_option |
The read options for returned phase PhaseReadOption |
- |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Phase 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" : [ "PROJECT", "PROJECT" ]
}
2.6.9. Search phase templates
POST |
/projects/phase-templates/search |
Description
Search phase templates.
DMF required:
-
DMF A90904: Api Project / Phase Template / Search
-
DMF 060806: Projects / Phases / Show History
-
DMF 060804: Projects / Phases / Search
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
criteria |
The criteria PhaseTemplateCriteria |
X |
Return Type
array[PhaseTemplate]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
The list of template phases has been successfully uploaded |
List[PhaseTemplate] |
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
{
"phaseEndDate" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
},
"companyId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"templateName" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"id" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"type" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
}
}
2.6.10. Search phases
POST |
/projects/phases/search |
Description
Search phases
DMF required:
-
DMF A90204: Api Project / Phases / Search
-
DMF 060804: Projects / Phases / Search
-
DMF 0202__: Sales / Quotations
-
DMF 020202: Sales / Quotations / Modify
-
DMF 020204: Sales / Quotations / Search
-
DMF 142602: Helpdesk / Simplified Issue / Modify
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
criteria |
Search criteria PhaseCriteria |
- |
Return Type
array[Phase]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Phases successfully loaded |
List[Phase] |
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" : "*"
},
"expectedEnd" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
},
"stateId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"actualEnd" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
},
"expectedStart" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
},
"managerId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"phaseValidity" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
},
"readOption" : {
"options" : [ "PROJECT", "PROJECT" ]
},
"name" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"id" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"tag" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"projectId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"actualStart" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
},
"closure" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"referentialDate" : "2020-01-23T04:56:07Z"
}
2.6.11. Search phases by project
POST |
/projects/{project_id}/phases/search |
Description
Search phases
DMF required:
-
DMF A90204: Api Project / Phases / Search
-
DMF 060804: Projects / Phases / Search
-
DMF 0202__: Sales / Quotations
-
DMF 020202: Sales / Quotations / Modify
-
DMF 020204: Sales / Quotations / Search
-
DMF 142602: Helpdesk / Simplified Issue / Modify
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
project_id |
The id of the project |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
criteria |
Search criteria PhaseCriteria |
- |
Return Type
array[Phase]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Phases successfully loaded |
List[Phase] |
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" : "*"
},
"expectedEnd" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
},
"stateId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"actualEnd" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
},
"expectedStart" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
},
"managerId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"phaseValidity" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
},
"readOption" : {
"options" : [ "PROJECT", "PROJECT" ]
},
"name" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"id" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"tag" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"projectId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"actualStart" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
},
"closure" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"referentialDate" : "2020-01-23T04:56:07Z"
}
2.6.12. Transfer a phase of a project
POST |
/projects/{project_id}/phases/{phase_id}/transfer |
Description
Transfer a phase to another phase
DMF required:
-
DMF A90210: Api Project / Phases / Transfert A Phase
-
DMF 060802: Projects / Phases / Modify
-
DMF 061606: Projects / Project Tasks / Import
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
project_id |
The id of the project |
X |
null |
|
phase_id |
The id of the phase |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
transferAffectation |
Affectation parameters when doing a transfer TransferAffectation |
X |
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Phase has been successfully transferred The returned identifier is the id of the updated project |
|
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
{
"toPhaseId" : "5000123",
"toSubPhaseId" : "5000123",
"start" : "2020-01-23T04:56:07Z",
"end" : "2020-01-23T04:56:07Z",
"toProjectId" : "5000123"
}
2.6.13. Update a phase
POST |
/projects/{project_id}/phases/{phase_id} |
Description
Update the phase matching the specified ID and using the list of parameters below.
DMF required:
-
DMF A90202: Api Project / Phases / Update
-
DMF 060802: Projects / Phases / Modify
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
project_id |
The id of the project |
X |
null |
|
phase_id |
The id of the phase |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
phase |
The phase to update Phase |
X |
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Phase 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" : "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,
"expectedStart" : "2000-06-21",
"expectedEnd" : "2000-06-21",
"description" : "Lorem ipsum",
"state" : {
"id" : "id",
"code" : "PRO",
"name" : "Production",
"companyId" : "5000123",
"default" : false
},
"stateId" : "5000123",
"manager" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"managerId" : "5000123",
"quoteNumber" : "123",
"customerContact" : "customerContact",
"actualStart" : "2000-06-21",
"actualEnd" : "2000-06-21",
"customerHostSite" : {
"id" : "5000123",
"code" : "code",
"name" : "Paris",
"customer" : {
"id" : "5000123",
"code" : "CA122",
"name" : "Akuiteo"
},
"customerId" : "CUST_001"
},
"customerHostSiteId" : "5000123",
"closure" : false,
"customData" : {
"key" : {
"type" : "{}",
"value" : "Autoref 010520",
"name" : "Reference 4",
"realOrder" : 0,
"label" : "REFERENCE_4"
}
},
"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.7. Project Groups
2.7.1. Search project groups
POST |
/project-groups/search |
Description
Search project groups
DMF required:
-
DMF A90704: Api Project / Project Groups / Search
-
DMF 061004: Projects / Project Groups / Search
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
criteria |
Search criteria ProjectGroupCriteria |
- |
Return Type
array[ProjectGroup]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Project groups successfully loaded |
List[ProjectGroup] |
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" : "*"
},
"description" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"id" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
}
}
2.8. Project States
2.8.1. Get a project state
GET |
/project-states/{project_state_id} |
Description
Get a project state
DMF required:
-
DMF A90806: Api Project / Project States / Info
-
DMF 060612: Projects / Setup / Projects' Status Codes
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
project_state_id |
The id of the project state |
X |
null |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Project state 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.8.2. Get next project states of a project state
POST |
/project-states/{project_state_id}/get-next-states |
Description
Get the list of project states that can follow the specified project state, based on the configured transitions in the settings.
DMF required:
-
DMF A90806: Api Project / Project States / Info
-
DMF 060612: Projects / Setup / Projects' Status Codes
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
project_state_id |
The id of the project state |
X |
null |
Return Type
array[ProjectState]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Next project states successfully loaded |
List[ProjectState] |
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.3. Search project states
POST |
/project-states/search |
Description
Search project states
DMF required:
-
DMF A90804: Api Project / Project States / Search
-
DMF 060612: Projects / Setup / Projects' Status Codes
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
criteria |
Search criteria ProjectStateCriteria |
- |
Return Type
array[ProjectState]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Project states successfully loaded |
List[ProjectState] |
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" : "*"
}
}
2.9. Project Tasks
2.9.1. Create a project task
PUT |
/project-tasks |
Description
Create a project task using the list of parameters below
DMF required:
-
DMF A90401: Api Project / Project Tasks / Insert
-
DMF 061601: Projects / Project Tasks / New
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
projectTask |
The project task to create ProjectTask |
X |
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
The project task 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",
"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",
"progress" : {
"workload" : 10,
"excess" : 2.75,
"scheduled" : 0.75,
"done" : 2.25,
"doneAndValidated" : 2.25,
"toBeScheduled" : 7.5,
"remainingTasks" : 10.25,
"calculatedRemainingTasks" : false,
"hoursHundredthsWorkload" : 2.7,
"type" : "{}"
},
"manager" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"managerId" : "5000123",
"linkedEmployee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"linkedEmployeeId" : "5000123",
"skills" : [ {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
}, {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
} ],
"location" : "Lyon",
"defaultTask" : false,
"executionDate" : "2020-01-23T04:56:07Z",
"riskLevelId" : "5000123",
"standardWeek" : {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week"
},
"standardWeekId" : "5000123",
"dailyPriceCurrency" : 20,
"quantityOfDays" : 7,
"soldItem" : {
"id" : "5000123",
"reference" : "ENGLISH",
"grouping" : "LICENCE",
"family" : "FML-LICENCE",
"subFamily" : "RECCURENT",
"category" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"categoryId" : "10024",
"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" : 5,
"subCategoryType" : "{}"
},
"subCategoryId" : "11037",
"companyCode" : "AKSAS",
"entityCode" : "Lyon",
"shortName" : "Maint",
"name" : "Maintenance",
"inventory" : true,
"comment" : "Lorem ipsum",
"billingMode" : "{}",
"quantityPrecision" : 2,
"unitPricePrecision" : 3,
"productionEstimatedDuration" : 30,
"inventoryAndPackaging" : {
"packagingType" : "Warehouse",
"packagingUnit" : 12
},
"customData" : {
"key" : {
"type" : "{}",
"value" : "Autoref 010520",
"name" : "Reference 4",
"realOrder" : 0,
"label" : "REFERENCE_4"
}
},
"accountSettings" : {
"localCostAccount" : "411000",
"localGroupAccount" : "411000",
"localSubscriptionAccount" : "411000",
"localInternalAccount" : "411000",
"intraComCostAccount" : "411000",
"intraComGroupAccount" : "411000",
"intraComSubscriptionAccount" : "411000",
"intraComInternalAccount" : "411000",
"exportCostAccount" : "411000",
"exportGroupAccount" : "411000",
"toBeEstablishedAccount" : "411000",
"vatCode" : "1",
"reverseVAT" : true,
"disabledDate" : "2000-06-21",
"marketEndDate" : "2000-06-21"
},
"productionInformations" : {
"linkedToAdvancePayments" : true,
"targetDay" : 22,
"billingTargetDay" : 5,
"estimatedDuration" : 240,
"defaultDisplay" : false,
"team" : {
"id" : "5000123",
"code" : "PRD",
"name" : "PROD"
},
"teamId" : "5000123"
},
"automaticTitle" : "IT PRODUCT"
},
"soldItemId" : "FORMATION",
"occurrenceType" : "{}",
"authorizedEmployees" : [ {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
}, {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
} ],
"projectTaskType" : {
"id" : "id",
"code" : "R&D",
"label" : "Tâche R&D",
"rankNumber" : 5,
"type" : "{}",
"byDefault" : false,
"companyId" : "5000123"
},
"projectTaskTypeId" : "5000123",
"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.9.2. Create a project task of a project
PUT |
/projects/{project_id}/project-tasks |
Description
Create a project task using the list of parameters below
DMF required:
-
DMF A90401: Api Project / Project Tasks / Insert
-
DMF 061601: Projects / Project Tasks / New
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
project_id |
The id of the project |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
projectTask |
The project task to create ProjectTask |
X |
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
The project task 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",
"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",
"progress" : {
"workload" : 10,
"excess" : 2.75,
"scheduled" : 0.75,
"done" : 2.25,
"doneAndValidated" : 2.25,
"toBeScheduled" : 7.5,
"remainingTasks" : 10.25,
"calculatedRemainingTasks" : false,
"hoursHundredthsWorkload" : 2.7,
"type" : "{}"
},
"manager" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"managerId" : "5000123",
"linkedEmployee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"linkedEmployeeId" : "5000123",
"skills" : [ {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
}, {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
} ],
"location" : "Lyon",
"defaultTask" : false,
"executionDate" : "2020-01-23T04:56:07Z",
"riskLevelId" : "5000123",
"standardWeek" : {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week"
},
"standardWeekId" : "5000123",
"dailyPriceCurrency" : 20,
"quantityOfDays" : 7,
"soldItem" : {
"id" : "5000123",
"reference" : "ENGLISH",
"grouping" : "LICENCE",
"family" : "FML-LICENCE",
"subFamily" : "RECCURENT",
"category" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"categoryId" : "10024",
"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" : 5,
"subCategoryType" : "{}"
},
"subCategoryId" : "11037",
"companyCode" : "AKSAS",
"entityCode" : "Lyon",
"shortName" : "Maint",
"name" : "Maintenance",
"inventory" : true,
"comment" : "Lorem ipsum",
"billingMode" : "{}",
"quantityPrecision" : 2,
"unitPricePrecision" : 3,
"productionEstimatedDuration" : 30,
"inventoryAndPackaging" : {
"packagingType" : "Warehouse",
"packagingUnit" : 12
},
"customData" : {
"key" : {
"type" : "{}",
"value" : "Autoref 010520",
"name" : "Reference 4",
"realOrder" : 0,
"label" : "REFERENCE_4"
}
},
"accountSettings" : {
"localCostAccount" : "411000",
"localGroupAccount" : "411000",
"localSubscriptionAccount" : "411000",
"localInternalAccount" : "411000",
"intraComCostAccount" : "411000",
"intraComGroupAccount" : "411000",
"intraComSubscriptionAccount" : "411000",
"intraComInternalAccount" : "411000",
"exportCostAccount" : "411000",
"exportGroupAccount" : "411000",
"toBeEstablishedAccount" : "411000",
"vatCode" : "1",
"reverseVAT" : true,
"disabledDate" : "2000-06-21",
"marketEndDate" : "2000-06-21"
},
"productionInformations" : {
"linkedToAdvancePayments" : true,
"targetDay" : 22,
"billingTargetDay" : 5,
"estimatedDuration" : 240,
"defaultDisplay" : false,
"team" : {
"id" : "5000123",
"code" : "PRD",
"name" : "PROD"
},
"teamId" : "5000123"
},
"automaticTitle" : "IT PRODUCT"
},
"soldItemId" : "FORMATION",
"occurrenceType" : "{}",
"authorizedEmployees" : [ {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
}, {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
} ],
"projectTaskType" : {
"id" : "id",
"code" : "R&D",
"label" : "Tâche R&D",
"rankNumber" : 5,
"type" : "{}",
"byDefault" : false,
"companyId" : "5000123"
},
"projectTaskTypeId" : "5000123",
"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.9.3. Delete a linked employee of a project task
DELETE |
/projects/{project_id}/project-tasks/{project_task_id}/linked-employees/{employee_id} |
Description
Delete a linked employee of a project task
DMF required:
-
DMF A90410: Api Project / Project Tasks / Delete A Linked Employee Of A Project Task
-
DMF 0616__: Projects / Project Tasks
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
project_id |
The id of the project |
X |
null |
|
project_task_id |
The id of the project task |
X |
null |
|
employee_id |
The id of an employee |
X |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
The linked employee 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.9.4. Delete a project task
DELETE |
/project-tasks/{project_task_id} |
Description
Delete a project task
DMF required:
-
DMF A90403: Api Project / Project Tasks / Delete
-
DMF 061603: Projects / Project Tasks / Delete
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
project_task_id |
The id of the project task |
X |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
The project task 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.9.5. Delete a project task of a project
DELETE |
/projects/{project_id}/project-tasks/{project_task_id} |
Description
Delete a project task of a project
DMF required:
-
DMF A90403: Api Project / Project Tasks / Delete
-
DMF 061603: Projects / Project Tasks / Delete
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
project_id |
The id of the project |
X |
null |
|
project_task_id |
The id of the project task |
X |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
The project task 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.9.6. Generate a project task's schedule
POST |
/projects/{project_id}/generate-schedule |
Description
Generate the schedule of a selected project task using the list of parameters below
DMF required:
-
DMF A90408: Api Project / Project Tasks / Generate A Project Task''s Schedule
-
DMF 060201: Projects / Schedules / New
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
project_id |
The id of the project |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
scheduleGenerationOption |
Schedule creation options ScheduleGenerationOption |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
The schedule has been successfully generated |
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
{
"authorisationPublicHoliday" : true,
"authorisationSat" : true,
"actionCodeId" : "INTERNE",
"projectTasks" : [ "projectTasks", "projectTasks" ],
"fromEndDate" : true,
"authorisationSun" : true
}
2.9.7. Get a list of all linked employees of a project task
GET |
/projects/{project_id}/project-tasks/{project_task_id}/linked-employees |
Description
Get all linked employees of a project task
DMF required:
-
DMF A90411: Api Project / Project Tasks / Get All Linked Employees Of A Project Task
-
DMF 0616__: Projects / Project Tasks
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
project_id |
The id of the project |
X |
null |
|
project_task_id |
The id of the project task |
X |
null |
Return Type
array[EmployeeBase]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Linked employees has been successfully listed |
List[EmployeeBase] |
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. Get a project task
GET |
/project-tasks/{project_task_id} |
Description
Get a project task
DMF required:
-
DMF A90406: Api Project / Project Tasks / Info
-
DMF 2501__: Project / Schedule View
-
DMF 1903__: Web Portal / Timesheets
-
DMF 1904__: Web Portal / Schedules
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
project_task_id |
The id of the project task |
X |
null |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Project task 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.9. Link an employee to a project task of a project and phase
POST |
/projects/{project_id}/phases/{phase_id}/project-tasks/{project_task_id}/link-employees |
Description
Link an employee to a project task using the list of parameters below
DMF required:
-
DMF A90407: Api Project / Project Tasks / Link An Employee To A Project Task
-
DMF 0602__: Projects / Schedules
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
project_id |
The id of the project |
X |
null |
|
phase_id |
The id of the phase |
X |
null |
|
project_task_id |
The id of the project task |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
employeeIdList |
List of employee's ident [string] |
X |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Employees has been successfully associated |
<<>> |
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.9.10. Link an employee to a project task of a project, phase and sub phase
POST |
/projects/{project_id}/phases/{phase_id}/sub-phase/{sub_phase_id}/project-tasks/{project_task_id}/link-employees |
Description
Link an employee to a project task using the list of parameters below
DMF required:
-
DMF A90407: Api Project / Project Tasks / Link An Employee To A Project Task
-
DMF 0602__: Projects / Schedules
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
project_id |
The id of the project |
X |
null |
|
phase_id |
The id of the phase |
X |
null |
|
sub_phase_id |
The id of the sub-phase |
X |
null |
|
project_task_id |
The id of the project task |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
employeeIdList |
List of employee's ident [string] |
X |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Employees has been successfully associated |
<<>> |
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.9.11. Link an employee to a project task of a project
POST |
/projects/{project_id}/project-tasks/{project_task_id}/link-employees |
Description
Link an employee to a project task using the list of parameters below
DMF required:
-
DMF A90407: Api Project / Project Tasks / Link An Employee To A Project Task
-
DMF 0602__: Projects / Schedules
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
project_id |
The id of the project |
X |
null |
|
project_task_id |
The id of the project task |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
employeeIdList |
List of employee's ident [string] |
X |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Employees has been successfully associated |
<<>> |
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.9.12. Link an employee to a project task
POST |
/project-tasks/{project_task_id}/link-employees |
Description
Link an employee to a project task using the list of parameters below
DMF required:
-
DMF A90407: Api Project / Project Tasks / Link An Employee To A Project Task
-
DMF 0602__: Projects / Schedules
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
project_task_id |
The id of the project task |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
employeeIdList |
List of employee's ident [string] |
X |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Employees has been successfully associated |
<<>> |
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.9.13. Patch a project task
PATCH |
/project-tasks/{project_task_id} |
Description
Patch the project task matching the specified ID and using the list of parameters below.
DMF required:
-
DMF A90402: Api Project / Project Tasks / Update
-
DMF 061602: Projects / Project Tasks / Modify
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
project_task_id |
The id of the project task |
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 |
Project Task 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.9.14. Patch a project task of a project
PATCH |
/projects/{project_id}/project-tasks/{project_task_id} |
Description
Patch the project task matching the specified ID and using the list of parameters below.
DMF required:
-
DMF A90402: Api Project / Project Tasks / Update
-
DMF 061602: Projects / Project Tasks / Modify
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
project_id |
The id of the project |
X |
null |
|
project_task_id |
The id of the project task |
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 |
Project Task 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.9.15. Pre-fill a project task of a project (and phase and sub-phase)
POST |
/projects/{project_id}/project-tasks/pre-fill |
Description
Pre-fill project task of a project (and phase and sub-phase)
DMF required:
-
DMF A90401: Api Project / Project Tasks / Insert
-
DMF 061601: Projects / Project Tasks / New
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
project_id |
The id of the project |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
projectTask |
The project task to pre-fill ProjectTask |
- |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Project task 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",
"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",
"progress" : {
"workload" : 10,
"excess" : 2.75,
"scheduled" : 0.75,
"done" : 2.25,
"doneAndValidated" : 2.25,
"toBeScheduled" : 7.5,
"remainingTasks" : 10.25,
"calculatedRemainingTasks" : false,
"hoursHundredthsWorkload" : 2.7,
"type" : "{}"
},
"manager" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"managerId" : "5000123",
"linkedEmployee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"linkedEmployeeId" : "5000123",
"skills" : [ {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
}, {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
} ],
"location" : "Lyon",
"defaultTask" : false,
"executionDate" : "2020-01-23T04:56:07Z",
"riskLevelId" : "5000123",
"standardWeek" : {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week"
},
"standardWeekId" : "5000123",
"dailyPriceCurrency" : 20,
"quantityOfDays" : 7,
"soldItem" : {
"id" : "5000123",
"reference" : "ENGLISH",
"grouping" : "LICENCE",
"family" : "FML-LICENCE",
"subFamily" : "RECCURENT",
"category" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"categoryId" : "10024",
"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" : 5,
"subCategoryType" : "{}"
},
"subCategoryId" : "11037",
"companyCode" : "AKSAS",
"entityCode" : "Lyon",
"shortName" : "Maint",
"name" : "Maintenance",
"inventory" : true,
"comment" : "Lorem ipsum",
"billingMode" : "{}",
"quantityPrecision" : 2,
"unitPricePrecision" : 3,
"productionEstimatedDuration" : 30,
"inventoryAndPackaging" : {
"packagingType" : "Warehouse",
"packagingUnit" : 12
},
"customData" : {
"key" : {
"type" : "{}",
"value" : "Autoref 010520",
"name" : "Reference 4",
"realOrder" : 0,
"label" : "REFERENCE_4"
}
},
"accountSettings" : {
"localCostAccount" : "411000",
"localGroupAccount" : "411000",
"localSubscriptionAccount" : "411000",
"localInternalAccount" : "411000",
"intraComCostAccount" : "411000",
"intraComGroupAccount" : "411000",
"intraComSubscriptionAccount" : "411000",
"intraComInternalAccount" : "411000",
"exportCostAccount" : "411000",
"exportGroupAccount" : "411000",
"toBeEstablishedAccount" : "411000",
"vatCode" : "1",
"reverseVAT" : true,
"disabledDate" : "2000-06-21",
"marketEndDate" : "2000-06-21"
},
"productionInformations" : {
"linkedToAdvancePayments" : true,
"targetDay" : 22,
"billingTargetDay" : 5,
"estimatedDuration" : 240,
"defaultDisplay" : false,
"team" : {
"id" : "5000123",
"code" : "PRD",
"name" : "PROD"
},
"teamId" : "5000123"
},
"automaticTitle" : "IT PRODUCT"
},
"soldItemId" : "FORMATION",
"occurrenceType" : "{}",
"authorizedEmployees" : [ {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
}, {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
} ],
"projectTaskType" : {
"id" : "id",
"code" : "R&D",
"label" : "Tâche R&D",
"rankNumber" : 5,
"type" : "{}",
"byDefault" : false,
"companyId" : "5000123"
},
"projectTaskTypeId" : "5000123",
"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.9.16. Purge a project task's schedule
POST |
/projects/{project_id}/purge-schedule |
Description
Purge the schedule of a selected project task using the list of parameters below
DMF required:
-
DMF A90409: Api Project / Project Tasks / Purge A Project Task''s Schedule
-
DMF 061607: Projects / Project Tasks / Reset Schedule
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
project_id |
The id of the project |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
scheduleGenerationOption |
The schedule to purge ScheduleGenerationOption |
X |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
The schedule has been successfully purged |
<<>> |
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
{
"authorisationPublicHoliday" : true,
"authorisationSat" : true,
"actionCodeId" : "INTERNE",
"projectTasks" : [ "projectTasks", "projectTasks" ],
"fromEndDate" : true,
"authorisationSun" : true
}
2.9.17. Get a project task with read options
POST |
/project-tasks/{project_task_id}/read |
Description
Get a project task with read options
DMF required:
-
DMF A90406: Api Project / Project Tasks / Info
-
DMF 2501__: Project / Schedule View
-
DMF 1903__: Web Portal / Timesheets
-
DMF 1904__: Web Portal / Schedules
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
project_task_id |
The id of the project task |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
read_option |
The read options for returned project ProjectTaskReadOption |
- |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Project task 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" : [ "CUSTOMER", "CUSTOMER" ]
}
2.9.18. Search project tasks
POST |
/project-tasks/search |
Description
Search project tasks
DMF required:
-
DMF A90404: Api Project / Project Tasks / Search
-
DMF 061604: Projects / Project Tasks / Search
-
DMF 0202__: Sales / Quotations
-
DMF 020202: Sales / Quotations / Modify
-
DMF 020204: Sales / Quotations / Search
-
DMF 142602: Helpdesk / Simplified Issue / Modify
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
criteria |
Search criteria ProjectTaskCriteria |
- |
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
limit |
The max number of project tasks |
- |
null |
Return Type
array[ProjectTask]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Project tasks successfully loaded |
List[ProjectTask] |
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
{
"standardWeeksId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"endDate" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
},
"phaseId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"executionDate" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
},
"occurrenceType" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"projectValidity" : {
"date" : "2000-01-23T04:56:07.000+00:00"
},
"readOption" : {
"options" : [ "CUSTOMER", "CUSTOMER" ]
},
"divisionGroupingId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"customerId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"hidePrivateProject" : false,
"id" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"tag" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"divisionId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"referentialDate" : "2020-01-23T04:56:07Z",
"projectCriteria" : {
"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" : "*"
},
"yearId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"divisionGroupingId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"activityId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"companyId" : {
"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" : "*"
},
"customerProjectId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"referentialDate" : "2000-01-23T04:56:07.000+00:00"
},
"employeeScheduleType" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"entityId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"managerId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"companyId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"projectTaskTypeId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"withWorkload" : true,
"referentialDateEndBound" : "2020-01-23T04:56:07Z",
"name" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"subPhaseId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"linkedEmployeeId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"soldItemId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"projectId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"startDate" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
}
}
2.9.19. Search project tasks of a phase
POST |
/projects/{project_id}/phases/{phase_id}/project-tasks/search |
Description
Search project tasks of a phase
DMF required:
-
DMF A90404: Api Project / Project Tasks / Search
-
DMF 061604: Projects / Project Tasks / Search
-
DMF 0202__: Sales / Quotations
-
DMF 020202: Sales / Quotations / Modify
-
DMF 020204: Sales / Quotations / Search
-
DMF 142602: Helpdesk / Simplified Issue / Modify
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
project_id |
The id of the project |
X |
null |
|
phase_id |
The id of the phase |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
criteria |
Search criteria ProjectTaskCriteria |
- |
Return Type
array[ProjectTask]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Project tasks successfully loaded |
List[ProjectTask] |
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
{
"standardWeeksId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"endDate" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
},
"phaseId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"executionDate" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
},
"occurrenceType" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"projectValidity" : {
"date" : "2000-01-23T04:56:07.000+00:00"
},
"readOption" : {
"options" : [ "CUSTOMER", "CUSTOMER" ]
},
"divisionGroupingId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"customerId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"hidePrivateProject" : false,
"id" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"tag" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"divisionId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"referentialDate" : "2020-01-23T04:56:07Z",
"projectCriteria" : {
"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" : "*"
},
"yearId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"divisionGroupingId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"activityId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"companyId" : {
"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" : "*"
},
"customerProjectId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"referentialDate" : "2000-01-23T04:56:07.000+00:00"
},
"employeeScheduleType" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"entityId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"managerId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"companyId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"projectTaskTypeId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"withWorkload" : true,
"referentialDateEndBound" : "2020-01-23T04:56:07Z",
"name" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"subPhaseId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"linkedEmployeeId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"soldItemId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"projectId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"startDate" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
}
}
2.9.20. Search project tasks of a project
POST |
/projects/{project_id}/project-tasks/search |
Description
Search project tasks of a project
DMF required:
-
DMF A90404: Api Project / Project Tasks / Search
-
DMF 061604: Projects / Project Tasks / Search
-
DMF 0202__: Sales / Quotations
-
DMF 020202: Sales / Quotations / Modify
-
DMF 020204: Sales / Quotations / Search
-
DMF 142602: Helpdesk / Simplified Issue / Modify
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
project_id |
The id of the project |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
criteria |
Search criteria ProjectTaskCriteria |
- |
Return Type
array[ProjectTask]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Project tasks successfully loaded |
List[ProjectTask] |
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
{
"standardWeeksId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"endDate" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
},
"phaseId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"executionDate" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
},
"occurrenceType" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"projectValidity" : {
"date" : "2000-01-23T04:56:07.000+00:00"
},
"readOption" : {
"options" : [ "CUSTOMER", "CUSTOMER" ]
},
"divisionGroupingId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"customerId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"hidePrivateProject" : false,
"id" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"tag" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"divisionId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"referentialDate" : "2020-01-23T04:56:07Z",
"projectCriteria" : {
"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" : "*"
},
"yearId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"divisionGroupingId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"activityId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"companyId" : {
"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" : "*"
},
"customerProjectId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"referentialDate" : "2000-01-23T04:56:07.000+00:00"
},
"employeeScheduleType" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"entityId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"managerId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"companyId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"projectTaskTypeId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"withWorkload" : true,
"referentialDateEndBound" : "2020-01-23T04:56:07Z",
"name" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"subPhaseId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"linkedEmployeeId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"soldItemId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"projectId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"startDate" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
}
}
2.9.21. Search project tasks of a sub-phase
POST |
/projects/{project_id}/phases/{phase_id}/sub-phases/{sub_phase_id}/project-tasks/search |
Description
Search project tasks of a sub-phase
DMF required:
-
DMF A90404: Api Project / Project Tasks / Search
-
DMF 061604: Projects / Project Tasks / Search
-
DMF 0202__: Sales / Quotations
-
DMF 020202: Sales / Quotations / Modify
-
DMF 020204: Sales / Quotations / Search
-
DMF 142602: Helpdesk / Simplified Issue / Modify
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
project_id |
The id of the project |
X |
null |
|
phase_id |
The id of the phase |
X |
null |
|
sub_phase_id |
The id of the sub-phase |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
criteria |
Search criteria ProjectTaskCriteria |
- |
Return Type
array[ProjectTask]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Project tasks successfully loaded |
List[ProjectTask] |
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
{
"standardWeeksId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"endDate" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
},
"phaseId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"executionDate" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
},
"occurrenceType" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"projectValidity" : {
"date" : "2000-01-23T04:56:07.000+00:00"
},
"readOption" : {
"options" : [ "CUSTOMER", "CUSTOMER" ]
},
"divisionGroupingId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"customerId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"hidePrivateProject" : false,
"id" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"tag" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"divisionId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"referentialDate" : "2020-01-23T04:56:07Z",
"projectCriteria" : {
"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" : "*"
},
"yearId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"divisionGroupingId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"activityId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"companyId" : {
"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" : "*"
},
"customerProjectId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"referentialDate" : "2000-01-23T04:56:07.000+00:00"
},
"employeeScheduleType" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"entityId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"managerId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"companyId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"projectTaskTypeId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"withWorkload" : true,
"referentialDateEndBound" : "2020-01-23T04:56:07Z",
"name" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"subPhaseId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"linkedEmployeeId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"soldItemId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"projectId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"startDate" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
}
}
2.9.22. Update a project task
POST |
/project-tasks/{project_task_id} |
Description
Update a project task
DMF required:
-
DMF A90402: Api Project / Project Tasks / Update
-
DMF 061602: Projects / Project Tasks / Modify
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
project_task_id |
The id of the project task |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
project task |
The project task to update ProjectTask |
X |
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
The project task 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",
"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",
"progress" : {
"workload" : 10,
"excess" : 2.75,
"scheduled" : 0.75,
"done" : 2.25,
"doneAndValidated" : 2.25,
"toBeScheduled" : 7.5,
"remainingTasks" : 10.25,
"calculatedRemainingTasks" : false,
"hoursHundredthsWorkload" : 2.7,
"type" : "{}"
},
"manager" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"managerId" : "5000123",
"linkedEmployee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"linkedEmployeeId" : "5000123",
"skills" : [ {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
}, {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
} ],
"location" : "Lyon",
"defaultTask" : false,
"executionDate" : "2020-01-23T04:56:07Z",
"riskLevelId" : "5000123",
"standardWeek" : {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week"
},
"standardWeekId" : "5000123",
"dailyPriceCurrency" : 20,
"quantityOfDays" : 7,
"soldItem" : {
"id" : "5000123",
"reference" : "ENGLISH",
"grouping" : "LICENCE",
"family" : "FML-LICENCE",
"subFamily" : "RECCURENT",
"category" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"categoryId" : "10024",
"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" : 5,
"subCategoryType" : "{}"
},
"subCategoryId" : "11037",
"companyCode" : "AKSAS",
"entityCode" : "Lyon",
"shortName" : "Maint",
"name" : "Maintenance",
"inventory" : true,
"comment" : "Lorem ipsum",
"billingMode" : "{}",
"quantityPrecision" : 2,
"unitPricePrecision" : 3,
"productionEstimatedDuration" : 30,
"inventoryAndPackaging" : {
"packagingType" : "Warehouse",
"packagingUnit" : 12
},
"customData" : {
"key" : {
"type" : "{}",
"value" : "Autoref 010520",
"name" : "Reference 4",
"realOrder" : 0,
"label" : "REFERENCE_4"
}
},
"accountSettings" : {
"localCostAccount" : "411000",
"localGroupAccount" : "411000",
"localSubscriptionAccount" : "411000",
"localInternalAccount" : "411000",
"intraComCostAccount" : "411000",
"intraComGroupAccount" : "411000",
"intraComSubscriptionAccount" : "411000",
"intraComInternalAccount" : "411000",
"exportCostAccount" : "411000",
"exportGroupAccount" : "411000",
"toBeEstablishedAccount" : "411000",
"vatCode" : "1",
"reverseVAT" : true,
"disabledDate" : "2000-06-21",
"marketEndDate" : "2000-06-21"
},
"productionInformations" : {
"linkedToAdvancePayments" : true,
"targetDay" : 22,
"billingTargetDay" : 5,
"estimatedDuration" : 240,
"defaultDisplay" : false,
"team" : {
"id" : "5000123",
"code" : "PRD",
"name" : "PROD"
},
"teamId" : "5000123"
},
"automaticTitle" : "IT PRODUCT"
},
"soldItemId" : "FORMATION",
"occurrenceType" : "{}",
"authorizedEmployees" : [ {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
}, {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
} ],
"projectTaskType" : {
"id" : "id",
"code" : "R&D",
"label" : "Tâche R&D",
"rankNumber" : 5,
"type" : "{}",
"byDefault" : false,
"companyId" : "5000123"
},
"projectTaskTypeId" : "5000123",
"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.9.23. Update a project task of a project
POST |
/projects/{project_id}/project-tasks/{project_task_id} |
Description
Update a project task of a project
DMF required:
-
DMF A90402: Api Project / Project Tasks / Update
-
DMF 061602: Projects / Project Tasks / Modify
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
project_id |
The id of the project |
X |
null |
|
project_task_id |
The id of the project task |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
project task |
The project task to update ProjectTask |
X |
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
The project task 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",
"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",
"progress" : {
"workload" : 10,
"excess" : 2.75,
"scheduled" : 0.75,
"done" : 2.25,
"doneAndValidated" : 2.25,
"toBeScheduled" : 7.5,
"remainingTasks" : 10.25,
"calculatedRemainingTasks" : false,
"hoursHundredthsWorkload" : 2.7,
"type" : "{}"
},
"manager" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"managerId" : "5000123",
"linkedEmployee" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"linkedEmployeeId" : "5000123",
"skills" : [ {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
}, {
"id" : "5000123",
"code" : "ENG",
"name" : "English",
"typeCode" : "LANGUAGE",
"typeLabel" : "Language"
} ],
"location" : "Lyon",
"defaultTask" : false,
"executionDate" : "2020-01-23T04:56:07Z",
"riskLevelId" : "5000123",
"standardWeek" : {
"id" : "5000123",
"code" : "DEFAULT",
"name" : "Default week"
},
"standardWeekId" : "5000123",
"dailyPriceCurrency" : 20,
"quantityOfDays" : 7,
"soldItem" : {
"id" : "5000123",
"reference" : "ENGLISH",
"grouping" : "LICENCE",
"family" : "FML-LICENCE",
"subFamily" : "RECCURENT",
"category" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"categoryId" : "10024",
"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" : 5,
"subCategoryType" : "{}"
},
"subCategoryId" : "11037",
"companyCode" : "AKSAS",
"entityCode" : "Lyon",
"shortName" : "Maint",
"name" : "Maintenance",
"inventory" : true,
"comment" : "Lorem ipsum",
"billingMode" : "{}",
"quantityPrecision" : 2,
"unitPricePrecision" : 3,
"productionEstimatedDuration" : 30,
"inventoryAndPackaging" : {
"packagingType" : "Warehouse",
"packagingUnit" : 12
},
"customData" : {
"key" : {
"type" : "{}",
"value" : "Autoref 010520",
"name" : "Reference 4",
"realOrder" : 0,
"label" : "REFERENCE_4"
}
},
"accountSettings" : {
"localCostAccount" : "411000",
"localGroupAccount" : "411000",
"localSubscriptionAccount" : "411000",
"localInternalAccount" : "411000",
"intraComCostAccount" : "411000",
"intraComGroupAccount" : "411000",
"intraComSubscriptionAccount" : "411000",
"intraComInternalAccount" : "411000",
"exportCostAccount" : "411000",
"exportGroupAccount" : "411000",
"toBeEstablishedAccount" : "411000",
"vatCode" : "1",
"reverseVAT" : true,
"disabledDate" : "2000-06-21",
"marketEndDate" : "2000-06-21"
},
"productionInformations" : {
"linkedToAdvancePayments" : true,
"targetDay" : 22,
"billingTargetDay" : 5,
"estimatedDuration" : 240,
"defaultDisplay" : false,
"team" : {
"id" : "5000123",
"code" : "PRD",
"name" : "PROD"
},
"teamId" : "5000123"
},
"automaticTitle" : "IT PRODUCT"
},
"soldItemId" : "FORMATION",
"occurrenceType" : "{}",
"authorizedEmployees" : [ {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
}, {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
} ],
"projectTaskType" : {
"id" : "id",
"code" : "R&D",
"label" : "Tâche R&D",
"rankNumber" : 5,
"type" : "{}",
"byDefault" : false,
"companyId" : "5000123"
},
"projectTaskTypeId" : "5000123",
"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. Projects
2.10.1. Create a project
PUT |
/projects |
Description
Create a project using the list of parameters below
DMF required:
-
DMF A90101: Api Project / Projects / Insert
-
DMF 060101: Projects
-
DMF 060192: Projects
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
project |
The project to create Project |
X |
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
The project 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",
"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",
"code" : "5000130",
"description" : "Lorem ipsum dolor sit amet",
"projectCategory" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"projectCategoryId" : "5000123",
"projectSubCategory" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"projectSubCategoryId" : "5000123",
"projectSubCategoryLevel2" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"projectSubCategoryLevel2Id" : "5000123",
"manager" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"managerId" : "5000123",
"prodManager" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"prodManagerId" : "5000123",
"financialManager" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"financialManagerId" : "5000123",
"salesManager" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"salesManagerId" : "5000123",
"company" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo"
},
"companyId" : "5000123",
"division" : {
"id" : "5000123",
"name" : "Rhone-Alpes",
"code" : "RA",
"group" : {
"id" : "5000123",
"name" : "West",
"code" : "WST",
"serviceId" : "5000123"
},
"groupId" : "5000123",
"companyId" : "5000123"
},
"divisionId" : "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"
},
"entityId" : "5000123",
"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"
} ]
},
"departmentId" : "5000123",
"endDate" : "2020-01-23T04:56:07Z"
},
"activityId" : "5000123",
"projectGroup" : {
"id" : "5000123",
"name" : "PARC",
"description" : "Lorem ipsum",
"code" : "PARC"
},
"projectGroupId" : "5000123",
"projectGroupCode" : "PRJ_1",
"previousProject" : {
"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" : "{}"
},
"previousProjectId" : "PRJ_1",
"budget" : 1000,
"year" : {
"id" : "5000123",
"code" : "2025",
"name" : "Text",
"previousYearId" : "5000123",
"validityEndDate" : "2020-01-23T04:56:07Z",
"disabledDate" : "2020-01-23T04:56:07Z",
"repeating" : "{}"
},
"yearId" : "5000123",
"customData" : {
"key" : {
"type" : "{}",
"value" : "Autoref 010520",
"name" : "Reference 4",
"realOrder" : 0,
"label" : "REFERENCE_4"
}
},
"signatureForFirstOrder" : {
"initialDate" : "2000-06-21T04:56:07.000+00:00",
"expectedDate" : "2000-06-21T04:56:07.000+00:00",
"actualDate" : "2000-06-21T04:56:07.000+00:00"
},
"productionStart" : {
"initialDate" : "2000-06-21T04:56:07.000+00:00",
"expectedDate" : "2000-06-21T04:56:07.000+00:00",
"actualDate" : "2000-06-21T04:56:07.000+00:00"
},
"productionEnd" : {
"initialDate" : "2000-06-21T04:56:07.000+00:00",
"expectedDate" : "2000-06-21T04:56:07.000+00:00",
"actualDate" : "2000-06-21T04:56:07.000+00:00"
},
"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",
"languageCode" : "EN",
"countryId" : "5000123",
"prospectionStart" : "2000-06-21T04:56:07.000+00:00",
"phaseTemplate" : {
"id" : "5000123",
"templateName" : "template for phase 1",
"description" : "Lorem ipsum dolor sit amet",
"company" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo"
},
"companyId" : "5000123",
"phaseEndDate" : "2020-01-23T04:56:07Z",
"order" : 1,
"type" : "{}"
},
"phaseTemplateId" : "5000123",
"remainingTask" : false,
"exemptionVAT" : false,
"training" : true,
"accountant" : true,
"campaign" : {
"id" : "5000123",
"code" : "CMP_2024_001",
"name" : "Campaign 2024-01"
},
"campaignId" : "5000123",
"opportunity" : {
"id" : "5000123",
"code" : "OP2025",
"name" : "ON PREMISE"
},
"opportunityId" : "5000123",
"permittedActionCodes" : [ {
"id" : "5000123",
"code" : "5000123",
"description" : "Lorem ipsum dolor sit amet",
"grouping" : "Grouping name",
"validity" : "2020-01-23T04:56:07Z",
"entityId" : "5000123",
"dailyDirectCost" : 20,
"dailyStandardCost" : 10,
"hourlyDirectCost" : 5,
"hourlyStandardCost" : 2,
"valuationCoefficient" : 0.5,
"smoothingCoefficient" : 0.3,
"type" : "{}",
"natureType" : "{}"
}, {
"id" : "5000123",
"code" : "5000123",
"description" : "Lorem ipsum dolor sit amet",
"grouping" : "Grouping name",
"validity" : "2020-01-23T04:56:07Z",
"entityId" : "5000123",
"dailyDirectCost" : 20,
"dailyStandardCost" : 10,
"hourlyDirectCost" : 5,
"hourlyStandardCost" : 2,
"valuationCoefficient" : 0.5,
"smoothingCoefficient" : 0.3,
"type" : "{}",
"natureType" : "{}"
} ],
"actionCodes" : [ {
"id" : "5000123",
"code" : "5000123",
"description" : "Lorem ipsum dolor sit amet",
"grouping" : "Grouping name",
"validity" : "2020-01-23T04:56:07Z",
"entityId" : "5000123",
"dailyDirectCost" : 20,
"dailyStandardCost" : 10,
"hourlyDirectCost" : 5,
"hourlyStandardCost" : 2,
"valuationCoefficient" : 0.5,
"smoothingCoefficient" : 0.3,
"type" : "{}",
"natureType" : "{}"
}, {
"id" : "5000123",
"code" : "5000123",
"description" : "Lorem ipsum dolor sit amet",
"grouping" : "Grouping name",
"validity" : "2020-01-23T04:56:07Z",
"entityId" : "5000123",
"dailyDirectCost" : 20,
"dailyStandardCost" : 10,
"hourlyDirectCost" : 5,
"hourlyStandardCost" : 2,
"valuationCoefficient" : 0.5,
"smoothingCoefficient" : 0.3,
"type" : "{}",
"natureType" : "{}"
} ],
"conditionOfPayment" : {
"code" : "5 days End of month by bank transfer",
"deadLine" : "5",
"term" : "1",
"day" : 10
},
"contractualConditionOfPayment" : {
"code" : "5 days End of month by bank transfer",
"deadLine" : "5",
"term" : "1",
"day" : 10,
"accountingJournal" : {
"id" : "5000123",
"code" : "code",
"name" : "name"
},
"accountingJournalId" : "1203",
"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"
},
"methodOfPayment" : "{}",
"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
},
"isPilot" : true,
"isServiceProvider" : true,
"isPrivate" : 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"
}
}
2.10.2. Delete an existing project
DELETE |
/projects/{project_id} |
Description
Delete a project
DMF required:
-
DMF A90103: Api Project / Projects / Delete
-
DMF 060103: Projects
-
DMF 060194: Projects
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
project_id |
The id of the project |
X |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
The project 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.10.3. Get Actions authorized within a project
GET |
/projects/{project_id}/authorized-actions |
Description
List the actions authorized within a project
DMF required:
-
DMF A90111: Api Project / Projects / Get Authorized Actions
-
DMF 250117: Project / Schedule View / Project Details
-
DMF 250119: Project / Schedule View / Employee Details
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
project_id |
The id of the project |
X |
null |
Return Type
array[ActionCodeBase]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
List of actions authorized within the project identified by 'project_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.10.4. Get a project
GET |
/projects/{project_id} |
Description
Get a project
DMF required:
-
DMF A90106: Api Project / Projects / Info
-
DMF 060195: Projects
-
DMF 190302: Web Portal / Timesheets / Modify
-
DMF 190402: Web Portal / Schedules / Modify
-
DMF 2501__: Project / Schedule View
-
DMF 250117: Project / Schedule View / Project Details
-
DMF 250102: Project / Schedule View / New
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
project_id |
The id of the project |
X |
null |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Project 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.5. Modify the entity of the project
POST |
/projects/{project_id}/modify-entity |
Description
Update the entity
DMF required:
-
DMF A90112: Api Project / Projects / Modify The Entity Of The Project
-
DMF 060102: Projects
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
project_id |
The id of the project |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
entity |
The arguments for updating the entity EntityBase |
X |
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
The entity 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",
"code" : "01-BRDX",
"name" : "Bordeaux"
}
2.10.6. Update the opportunity of the project
POST |
/projects/{project_id}/modify-opportunity |
Description
Update the opportunity of the project
DMF required:
-
DMF A90109: Api Project / Projects / Update The Opportunity Of The Project
-
DMF 060102: Projects
-
DMF 060132: Projects
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
project_id |
The id of the project |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
opportunity |
The arguments for updating the opportunity OpportunityBase |
X |
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
The opportunity 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",
"code" : "OP2025",
"name" : "ON PREMISE"
}
2.10.7. Update the state code of the project
POST |
/projects/{project_id}/modify-state |
Description
Update the state code
DMF required:
-
DMF A90108: Api Project / Projects / Update The State Code Of The Project
-
DMF 060102: Projects
-
DMF 060612: Projects / Setup / Projects' Status Codes
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
project_id |
The id of the project |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
projectState |
The arguments for updating the state code ProjectState |
X |
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
The state code 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" : "id",
"code" : "PRO",
"name" : "Production",
"companyCode" : "AKSAS",
"companyId" : "5000123"
}
2.10.8. Patch a project
PATCH |
/projects/{project_id} |
Description
Patch the project matching the specified ID and using the list of parameters below.
DMF required:
-
DMF A90102: Api Project / Projects / Update
-
DMF 060102: Projects
-
DMF 060193: Projects
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
project_id |
The id of the project |
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 |
Project 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.10.9. Pre-fill a project
POST |
/projects/pre-fill |
Description
Pre-fill a project with default values or values specified in the request body.
DMF required:
-
DMF A90101: Api Project / Projects / Insert
-
DMF 060101: Projects
-
DMF 060192: Projects
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
project |
The project to pre-fill Project |
- |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Project 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",
"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",
"code" : "5000130",
"description" : "Lorem ipsum dolor sit amet",
"projectCategory" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"projectCategoryId" : "5000123",
"projectSubCategory" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"projectSubCategoryId" : "5000123",
"projectSubCategoryLevel2" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"projectSubCategoryLevel2Id" : "5000123",
"manager" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"managerId" : "5000123",
"prodManager" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"prodManagerId" : "5000123",
"financialManager" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"financialManagerId" : "5000123",
"salesManager" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"salesManagerId" : "5000123",
"company" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo"
},
"companyId" : "5000123",
"division" : {
"id" : "5000123",
"name" : "Rhone-Alpes",
"code" : "RA",
"group" : {
"id" : "5000123",
"name" : "West",
"code" : "WST",
"serviceId" : "5000123"
},
"groupId" : "5000123",
"companyId" : "5000123"
},
"divisionId" : "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"
},
"entityId" : "5000123",
"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"
} ]
},
"departmentId" : "5000123",
"endDate" : "2020-01-23T04:56:07Z"
},
"activityId" : "5000123",
"projectGroup" : {
"id" : "5000123",
"name" : "PARC",
"description" : "Lorem ipsum",
"code" : "PARC"
},
"projectGroupId" : "5000123",
"projectGroupCode" : "PRJ_1",
"previousProject" : {
"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" : "{}"
},
"previousProjectId" : "PRJ_1",
"budget" : 1000,
"year" : {
"id" : "5000123",
"code" : "2025",
"name" : "Text",
"previousYearId" : "5000123",
"validityEndDate" : "2020-01-23T04:56:07Z",
"disabledDate" : "2020-01-23T04:56:07Z",
"repeating" : "{}"
},
"yearId" : "5000123",
"customData" : {
"key" : {
"type" : "{}",
"value" : "Autoref 010520",
"name" : "Reference 4",
"realOrder" : 0,
"label" : "REFERENCE_4"
}
},
"signatureForFirstOrder" : {
"initialDate" : "2000-06-21T04:56:07.000+00:00",
"expectedDate" : "2000-06-21T04:56:07.000+00:00",
"actualDate" : "2000-06-21T04:56:07.000+00:00"
},
"productionStart" : {
"initialDate" : "2000-06-21T04:56:07.000+00:00",
"expectedDate" : "2000-06-21T04:56:07.000+00:00",
"actualDate" : "2000-06-21T04:56:07.000+00:00"
},
"productionEnd" : {
"initialDate" : "2000-06-21T04:56:07.000+00:00",
"expectedDate" : "2000-06-21T04:56:07.000+00:00",
"actualDate" : "2000-06-21T04:56:07.000+00:00"
},
"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",
"languageCode" : "EN",
"countryId" : "5000123",
"prospectionStart" : "2000-06-21T04:56:07.000+00:00",
"phaseTemplate" : {
"id" : "5000123",
"templateName" : "template for phase 1",
"description" : "Lorem ipsum dolor sit amet",
"company" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo"
},
"companyId" : "5000123",
"phaseEndDate" : "2020-01-23T04:56:07Z",
"order" : 1,
"type" : "{}"
},
"phaseTemplateId" : "5000123",
"remainingTask" : false,
"exemptionVAT" : false,
"training" : true,
"accountant" : true,
"campaign" : {
"id" : "5000123",
"code" : "CMP_2024_001",
"name" : "Campaign 2024-01"
},
"campaignId" : "5000123",
"opportunity" : {
"id" : "5000123",
"code" : "OP2025",
"name" : "ON PREMISE"
},
"opportunityId" : "5000123",
"permittedActionCodes" : [ {
"id" : "5000123",
"code" : "5000123",
"description" : "Lorem ipsum dolor sit amet",
"grouping" : "Grouping name",
"validity" : "2020-01-23T04:56:07Z",
"entityId" : "5000123",
"dailyDirectCost" : 20,
"dailyStandardCost" : 10,
"hourlyDirectCost" : 5,
"hourlyStandardCost" : 2,
"valuationCoefficient" : 0.5,
"smoothingCoefficient" : 0.3,
"type" : "{}",
"natureType" : "{}"
}, {
"id" : "5000123",
"code" : "5000123",
"description" : "Lorem ipsum dolor sit amet",
"grouping" : "Grouping name",
"validity" : "2020-01-23T04:56:07Z",
"entityId" : "5000123",
"dailyDirectCost" : 20,
"dailyStandardCost" : 10,
"hourlyDirectCost" : 5,
"hourlyStandardCost" : 2,
"valuationCoefficient" : 0.5,
"smoothingCoefficient" : 0.3,
"type" : "{}",
"natureType" : "{}"
} ],
"actionCodes" : [ {
"id" : "5000123",
"code" : "5000123",
"description" : "Lorem ipsum dolor sit amet",
"grouping" : "Grouping name",
"validity" : "2020-01-23T04:56:07Z",
"entityId" : "5000123",
"dailyDirectCost" : 20,
"dailyStandardCost" : 10,
"hourlyDirectCost" : 5,
"hourlyStandardCost" : 2,
"valuationCoefficient" : 0.5,
"smoothingCoefficient" : 0.3,
"type" : "{}",
"natureType" : "{}"
}, {
"id" : "5000123",
"code" : "5000123",
"description" : "Lorem ipsum dolor sit amet",
"grouping" : "Grouping name",
"validity" : "2020-01-23T04:56:07Z",
"entityId" : "5000123",
"dailyDirectCost" : 20,
"dailyStandardCost" : 10,
"hourlyDirectCost" : 5,
"hourlyStandardCost" : 2,
"valuationCoefficient" : 0.5,
"smoothingCoefficient" : 0.3,
"type" : "{}",
"natureType" : "{}"
} ],
"conditionOfPayment" : {
"code" : "5 days End of month by bank transfer",
"deadLine" : "5",
"term" : "1",
"day" : 10
},
"contractualConditionOfPayment" : {
"code" : "5 days End of month by bank transfer",
"deadLine" : "5",
"term" : "1",
"day" : 10,
"accountingJournal" : {
"id" : "5000123",
"code" : "code",
"name" : "name"
},
"accountingJournalId" : "1203",
"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"
},
"methodOfPayment" : "{}",
"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
},
"isPilot" : true,
"isServiceProvider" : true,
"isPrivate" : 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"
}
}
2.10.10. Publish a project
POST |
/projects/{project_id}/publish |
Description
Publish a project
DMF required:
-
DMF A90105: Api Project / Projects / Publish
-
DMF 060105: Projects
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
project_id |
The id of the project |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
publishArguments |
The arguments for publishing a project 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.10.11. Get a project with read options
POST |
/projects/{project_id}/read |
Description
Get a project with read options
DMF required:
-
DMF A90106: Api Project / Projects / Info
-
DMF 060195: Projects
-
DMF 190302: Web Portal / Timesheets / Modify
-
DMF 190402: Web Portal / Schedules / Modify
-
DMF 2501__: Project / Schedule View
-
DMF 250117: Project / Schedule View / Project Details
-
DMF 250102: Project / Schedule View / New
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
project_id |
The id of the project |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
read_option |
The read options for returned project ProjectReadOption |
- |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Project 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" : [ "CUSTOMER", "CUSTOMER" ]
}
2.10.12. Get links to the employees linked to a project
POST |
/projects/{project_id}/employee-links/search |
Description
Get links to the employees linked to a project
DMF required:
-
DMF A90110: Api Project / Projects / Search Linked Employees
-
DMF 160804: Tools / Resources / Search
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
project_id |
The id of the project |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
criteria |
The criteria EmployeeLinkCriteria |
X |
Return Type
array[EmployeeLink]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Links successfully loaded |
List[EmployeeLink] |
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.10.13. Search projects
POST |
/projects/search |
Description
Search projects
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 |
Search criteria ProjectCriteria |
- |
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
offset |
The index of first element |
- |
null |
|
limit |
The max number of elements |
- |
null |
Return Type
array[Project]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Assignments successfully loaded |
List[Project] |
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
{
"signatureForFirstOrder" : {
"actualDate" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
},
"expectedDate" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
},
"initialDate" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
}
},
"internal" : false,
"code" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"departmentId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"isPrivate" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"countryId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"yearId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"readOption" : {
"options" : [ "CUSTOMER", "CUSTOMER" ]
},
"divisionGroupingId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"productionEnd" : {
"actualDate" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
},
"expectedDate" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
},
"initialDate" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
}
},
"activityId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"customerType" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"opportunityId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"financialManagerId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"countryCode" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"controlsManagerId" : {
"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" : "*"
},
"referentialDate" : "2000-01-23T04:56:07.000+00:00",
"campaignId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"stateId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"previousProjectId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"projectGroupId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"entityId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"isPilot" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"subCategoryId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"managerId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"projectState" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"isInternal" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"companyId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"changeTracking" : {
"updatedTime" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
},
"createdTime" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
},
"updatedById" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"createdById" : {
"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" : "*"
},
"isServiceProvider" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"productionStart" : {
"actualDate" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
},
"expectedDate" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
},
"initialDate" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
}
},
"projectManagerId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"endCustomerId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"categoryId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
}
}
2.10.14. Update the customer's project
POST |
/projects/{project_id}/modify-customer |
Description
Update the customer’s project
DMF required:
-
DMF A90107: Api Project / Projects / Update Customer''s Project
-
DMF 060118: Projects
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
project_id |
The id of the project |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
customer |
The customer to update CustomerBase |
X |
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
The customer's project 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",
"code" : "CA122",
"name" : "Akuiteo"
}
2.10.15. Update a project
POST |
/projects/{project_id} |
Description
Update the project matching the specified ID and using the list of parameters below.
DMF required:
-
DMF A90102: Api Project / Projects / Update
-
DMF 060102: Projects
-
DMF 060193: Projects
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
project_id |
The id of the project |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
project |
The project to update Project |
X |
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Project 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" : "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",
"code" : "5000130",
"description" : "Lorem ipsum dolor sit amet",
"projectCategory" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"projectCategoryId" : "5000123",
"projectSubCategory" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"projectSubCategoryId" : "5000123",
"projectSubCategoryLevel2" : {
"id" : "5000123",
"code" : "LANG",
"name" : "Language",
"endDate" : "2000-06-21",
"companyCode" : "AKSAS",
"type" : "{}",
"grouping" : "grouping",
"ranking" : 5
},
"projectSubCategoryLevel2Id" : "5000123",
"manager" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"managerId" : "5000123",
"prodManager" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"prodManagerId" : "5000123",
"financialManager" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"financialManagerId" : "5000123",
"salesManager" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"salesManagerId" : "5000123",
"company" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo"
},
"companyId" : "5000123",
"division" : {
"id" : "5000123",
"name" : "Rhone-Alpes",
"code" : "RA",
"group" : {
"id" : "5000123",
"name" : "West",
"code" : "WST",
"serviceId" : "5000123"
},
"groupId" : "5000123",
"companyId" : "5000123"
},
"divisionId" : "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"
},
"entityId" : "5000123",
"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"
} ]
},
"departmentId" : "5000123",
"endDate" : "2020-01-23T04:56:07Z"
},
"activityId" : "5000123",
"projectGroup" : {
"id" : "5000123",
"name" : "PARC",
"description" : "Lorem ipsum",
"code" : "PARC"
},
"projectGroupId" : "5000123",
"projectGroupCode" : "PRJ_1",
"previousProject" : {
"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" : "{}"
},
"previousProjectId" : "PRJ_1",
"budget" : 1000,
"year" : {
"id" : "5000123",
"code" : "2025",
"name" : "Text",
"previousYearId" : "5000123",
"validityEndDate" : "2020-01-23T04:56:07Z",
"disabledDate" : "2020-01-23T04:56:07Z",
"repeating" : "{}"
},
"yearId" : "5000123",
"customData" : {
"key" : {
"type" : "{}",
"value" : "Autoref 010520",
"name" : "Reference 4",
"realOrder" : 0,
"label" : "REFERENCE_4"
}
},
"signatureForFirstOrder" : {
"initialDate" : "2000-06-21T04:56:07.000+00:00",
"expectedDate" : "2000-06-21T04:56:07.000+00:00",
"actualDate" : "2000-06-21T04:56:07.000+00:00"
},
"productionStart" : {
"initialDate" : "2000-06-21T04:56:07.000+00:00",
"expectedDate" : "2000-06-21T04:56:07.000+00:00",
"actualDate" : "2000-06-21T04:56:07.000+00:00"
},
"productionEnd" : {
"initialDate" : "2000-06-21T04:56:07.000+00:00",
"expectedDate" : "2000-06-21T04:56:07.000+00:00",
"actualDate" : "2000-06-21T04:56:07.000+00:00"
},
"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",
"languageCode" : "EN",
"countryId" : "5000123",
"prospectionStart" : "2000-06-21T04:56:07.000+00:00",
"phaseTemplate" : {
"id" : "5000123",
"templateName" : "template for phase 1",
"description" : "Lorem ipsum dolor sit amet",
"company" : {
"id" : "5000123",
"code" : "AK",
"name" : "Akuiteo"
},
"companyId" : "5000123",
"phaseEndDate" : "2020-01-23T04:56:07Z",
"order" : 1,
"type" : "{}"
},
"phaseTemplateId" : "5000123",
"remainingTask" : false,
"exemptionVAT" : false,
"training" : true,
"accountant" : true,
"campaign" : {
"id" : "5000123",
"code" : "CMP_2024_001",
"name" : "Campaign 2024-01"
},
"campaignId" : "5000123",
"opportunity" : {
"id" : "5000123",
"code" : "OP2025",
"name" : "ON PREMISE"
},
"opportunityId" : "5000123",
"permittedActionCodes" : [ {
"id" : "5000123",
"code" : "5000123",
"description" : "Lorem ipsum dolor sit amet",
"grouping" : "Grouping name",
"validity" : "2020-01-23T04:56:07Z",
"entityId" : "5000123",
"dailyDirectCost" : 20,
"dailyStandardCost" : 10,
"hourlyDirectCost" : 5,
"hourlyStandardCost" : 2,
"valuationCoefficient" : 0.5,
"smoothingCoefficient" : 0.3,
"type" : "{}",
"natureType" : "{}"
}, {
"id" : "5000123",
"code" : "5000123",
"description" : "Lorem ipsum dolor sit amet",
"grouping" : "Grouping name",
"validity" : "2020-01-23T04:56:07Z",
"entityId" : "5000123",
"dailyDirectCost" : 20,
"dailyStandardCost" : 10,
"hourlyDirectCost" : 5,
"hourlyStandardCost" : 2,
"valuationCoefficient" : 0.5,
"smoothingCoefficient" : 0.3,
"type" : "{}",
"natureType" : "{}"
} ],
"actionCodes" : [ {
"id" : "5000123",
"code" : "5000123",
"description" : "Lorem ipsum dolor sit amet",
"grouping" : "Grouping name",
"validity" : "2020-01-23T04:56:07Z",
"entityId" : "5000123",
"dailyDirectCost" : 20,
"dailyStandardCost" : 10,
"hourlyDirectCost" : 5,
"hourlyStandardCost" : 2,
"valuationCoefficient" : 0.5,
"smoothingCoefficient" : 0.3,
"type" : "{}",
"natureType" : "{}"
}, {
"id" : "5000123",
"code" : "5000123",
"description" : "Lorem ipsum dolor sit amet",
"grouping" : "Grouping name",
"validity" : "2020-01-23T04:56:07Z",
"entityId" : "5000123",
"dailyDirectCost" : 20,
"dailyStandardCost" : 10,
"hourlyDirectCost" : 5,
"hourlyStandardCost" : 2,
"valuationCoefficient" : 0.5,
"smoothingCoefficient" : 0.3,
"type" : "{}",
"natureType" : "{}"
} ],
"conditionOfPayment" : {
"code" : "5 days End of month by bank transfer",
"deadLine" : "5",
"term" : "1",
"day" : 10
},
"contractualConditionOfPayment" : {
"code" : "5 days End of month by bank transfer",
"deadLine" : "5",
"term" : "1",
"day" : 10,
"accountingJournal" : {
"id" : "5000123",
"code" : "code",
"name" : "name"
},
"accountingJournalId" : "1203",
"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"
},
"methodOfPayment" : "{}",
"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
},
"isPilot" : true,
"isServiceProvider" : true,
"isPrivate" : 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"
}
}
2.11. Sub Phase States
2.11.1. Get a sub-phase state
GET |
/sub-phase-states/{sub_phase_state_id} |
Description
Get a sub-phase state
DMF required:
-
DMF A91106: Api Project / Sub-phase States / Info
-
DMF 060612: Projects / Setup / Projects' Status Codes
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
sub_phase_state_id |
The id of the sub-phase state |
X |
null |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Sub-phase state 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.2. Search sub-phase states
POST |
/sub-phase-states/search |
Description
Search sub-phase states
DMF required:
-
DMF A91104: Api Project / Sub-phase States / Search
-
DMF 060612: Projects / Setup / Projects' Status Codes
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
criteria |
Search criteria SubPhaseStateCriteria |
- |
Return Type
array[SubPhaseState]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Sub-phase states successfully loaded |
List[SubPhaseState] |
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" : "*"
}
}
2.12. Sub Phases
2.12.1. Close a sub-phase of a project
POST |
/projects/{project_id}/phases/{phase_id}/sub-phases/{sub_phase_id}/close |
Description
Close a sub-phase
DMF required:
-
DMF A90308: Api Project / Sub-phases / Close The Sub-phase Of Project
-
DMF 060907: Projects / Sub-phases / Close
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
project_id |
The id of the project |
X |
null |
|
phase_id |
The id of the phase |
X |
null |
|
sub_phase_id |
The id of the sub-phase |
X |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Sub-phase has been successfully closed |
<<>> |
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.2. Create a sub-phase of a Project and a Phase
PUT |
/projects/{project_id}/phases/{phase_id}/sub-phases |
Description
Create a sub-phase using the list of parameters below
DMF required:
-
DMF A90301: Api Project / Sub-phases / Insert
-
DMF 060901: Projects / Sub-phases / New
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
project_id |
The id of the project |
X |
null |
|
phase_id |
The id of the phase |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
subPhase |
The sub-phase to create SubPhase |
X |
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
201 |
The sub-phase 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",
"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,
"expectedStart" : "2000-06-21",
"actualStart" : "2000-06-21",
"expectedEnd" : "2000-06-21",
"actualEnd" : "2000-06-21",
"description" : "Lorem ipsum dolor sit amet",
"manager" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"managerId" : "5000123",
"state" : {
"id" : "id",
"code" : "PRO",
"name" : "Production",
"companyId" : "5000123"
},
"stateId" : "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",
"closure" : false,
"customData" : {
"key" : {
"type" : "{}",
"value" : "Autoref 010520",
"name" : "Reference 4",
"realOrder" : 0,
"label" : "REFERENCE_4"
}
},
"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.12.3. Delete an existing sub-phase of a project
DELETE |
/projects/{project_id}/phases/{phase_id}/sub-phases/{sub_phase_id} |
Description
Delete a sub-phase of a project
DMF required:
-
DMF A90303: Api Project / Sub-phases / Delete
-
DMF 060903: Projects / Sub-phases / Delete
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
project_id |
The id of the project |
X |
null |
|
phase_id |
The id of the phase |
X |
null |
|
sub_phase_id |
The id of the sub-phase |
X |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
The sub-phase 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.12.4. Get sub-phase of phase
GET |
/projects/{project_id}/phases/{phase_id}/sub-phases/{sub_phase_id} |
Description
Get sub-phase of phase
DMF required:
-
DMF A90306: Api Project / Sub-phases / Info
-
DMF 141301: Helpdesk / Issues / New
-
DMF 142601: Helpdesk / Simplified Issue / New
-
DMF 142626: Helpdesk / Simplified Issue / New Issue From Template
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
project_id |
The id of the project |
X |
null |
|
phase_id |
The id of the phase |
X |
null |
|
sub_phase_id |
The id of the sub-phase |
X |
null |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Sub-phase 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.12.5. Update the state code of a sub-phase
POST |
/projects/{project_id}/phases/{phase_id}/sub-phases/{sub_phase_id}/modify-state |
Description
Update the state code of the sub-phase
DMF required:
-
DMF A90307: Api Project / Sub-phases / Update The Sub-phase State Code
-
DMF 060908: Projects / Sub-phases / Modify Status Code
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
project_id |
The id of the project |
X |
null |
|
phase_id |
The id of the phase |
X |
null |
|
sub_phase_id |
The id of the sub-phase |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
subPhaseState |
The arguments for updating the state code SubPhaseState |
X |
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
The state code 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" : "id",
"code" : "PRO",
"name" : "Production",
"companyId" : "5000123"
}
2.12.6. Patch a sub-phase
PATCH |
/projects/{project_id}/phases/{phase_id}/sub-phases/{sub_phase_id} |
Description
Patch the sub-phase matching the specified ID and using the list of parameters below.
DMF required:
-
DMF A90302: Api Project / Sub-phases / Update
-
DMF 060902: Projects / Sub-phases / Modify
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
project_id |
The id of the project |
X |
null |
|
phase_id |
The id of the phase |
X |
null |
|
sub_phase_id |
The id of the sub-phase |
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 |
Sub-phase 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.12.7. Pre-fill a sub-phase of a project and phase
POST |
/projects/{project_id}/phases/{phase_id}/sub-phases/pre-fill |
Description
Pre-fill a sub-phase of a project and a phase with default values or values specified in the request body.
DMF required:
-
DMF A90301: Api Project / Sub-phases / Insert
-
DMF 060901: Projects / Sub-phases / New
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
project_id |
The id of the project |
X |
null |
|
phase_id |
The id of the phase |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
subPhase |
The sub-phase to pre-fill SubPhase |
- |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Sub-phase 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",
"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,
"expectedStart" : "2000-06-21",
"actualStart" : "2000-06-21",
"expectedEnd" : "2000-06-21",
"actualEnd" : "2000-06-21",
"description" : "Lorem ipsum dolor sit amet",
"manager" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"managerId" : "5000123",
"state" : {
"id" : "id",
"code" : "PRO",
"name" : "Production",
"companyId" : "5000123"
},
"stateId" : "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",
"closure" : false,
"customData" : {
"key" : {
"type" : "{}",
"value" : "Autoref 010520",
"name" : "Reference 4",
"realOrder" : 0,
"label" : "REFERENCE_4"
}
},
"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.12.8. Get a sub-phase with read options
POST |
/projects/{project_id}/phases/{phase_id}/sub-phases/{sub_phase_id}/read |
Description
Get a sub-phase with read options
DMF required:
-
DMF A90306: Api Project / Sub-phases / Info
-
DMF 141301: Helpdesk / Issues / New
-
DMF 142601: Helpdesk / Simplified Issue / New
-
DMF 142626: Helpdesk / Simplified Issue / New Issue From Template
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
project_id |
The id of the project |
X |
null |
|
phase_id |
The id of the phase |
X |
null |
|
sub_phase_id |
The id of the sub-phase |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
read_option |
The read options for returned sub-phase SubPhaseReadOption |
- |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Sub-phase 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" : [ "PROJECT", "PROJECT" ]
}
2.12.9. Search sub-phases
POST |
/projects/phases/sub-phases/search |
Description
Search sub-phases
DMF required:
-
DMF A90304: Api Project / Sub-phases / Search
-
DMF 060904: Projects / Sub-phases / Search
-
DMF 0202__: Sales / Quotations
-
DMF 020202: Sales / Quotations / Modify
-
DMF 020204: Sales / Quotations / Search
-
DMF 142602: Helpdesk / Simplified Issue / Modify
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
criteria |
Search criteria SubPhaseCriteria |
- |
Return Type
array[SubPhase]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Sub-phases successfully loaded |
List[SubPhase] |
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
{
"expectedEnd" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
},
"stateId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"phaseId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"actualEnd" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
},
"expectedStart" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
},
"managerId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"readOption" : {
"options" : [ "PROJECT", "PROJECT" ]
},
"subPhaseValidity" : {
"date" : "2000-01-23T04:56:07.000+00:00"
},
"name" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"stateCode" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"id" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"tag" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"projectId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"actualStart" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
},
"closure" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"referentialDate" : "2020-01-23T04:56:07Z"
}
2.12.10. Search the sub-phases of a Project and a Phase
POST |
/projects/{project_id}/phases/{phase_id}/sub-phases/search |
Description
Search sub-phases
DMF required:
-
DMF A90304: Api Project / Sub-phases / Search
-
DMF 060904: Projects / Sub-phases / Search
-
DMF 0202__: Sales / Quotations
-
DMF 020202: Sales / Quotations / Modify
-
DMF 020204: Sales / Quotations / Search
-
DMF 142602: Helpdesk / Simplified Issue / Modify
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
project_id |
The id of the project |
X |
null |
|
phase_id |
The id of the phase |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
criteria |
Search criteria SubPhaseCriteria |
- |
Return Type
array[SubPhase]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Sub-phases successfully loaded |
List[SubPhase] |
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
{
"expectedEnd" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
},
"stateId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"phaseId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"actualEnd" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
},
"expectedStart" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
},
"managerId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"readOption" : {
"options" : [ "PROJECT", "PROJECT" ]
},
"subPhaseValidity" : {
"date" : "2000-01-23T04:56:07.000+00:00"
},
"name" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"stateCode" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"id" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"tag" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"projectId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"actualStart" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
},
"closure" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"referentialDate" : "2020-01-23T04:56:07Z"
}
2.12.11. Transfer a sub-phase of a project
POST |
/projects/{project_id}/phases/{phase_id}/sub-phases/{sub_phase_id}/transfer |
Description
Transfer a sub-phase to another sub-phase
DMF required:
-
DMF A90309: Api Project / Sub-phases / Transfer A Sub-phase Of Project
-
DMF 060902: Projects / Sub-phases / Modify
-
DMF 061606: Projects / Project Tasks / Import
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
project_id |
The id of the project |
X |
null |
|
phase_id |
The id of the phase |
X |
null |
|
sub_phase_id |
The id of the sub-phase |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
transferAffectation |
Affectation parameters when doing a transfer TransferAffectation |
X |
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Sub-Phase has been successfully transferred The returned identifier is the id of the updated project |
|
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
{
"toPhaseId" : "5000123",
"toSubPhaseId" : "5000123",
"start" : "2020-01-23T04:56:07Z",
"end" : "2020-01-23T04:56:07Z",
"toProjectId" : "5000123"
}
2.12.12. Update a sub-phase
POST |
/projects/{project_id}/phases/{phase_id}/sub-phases/{sub_phase_id} |
Description
Update the sub-phase matching the specified ID and using the list of parameters below.
DMF required:
-
DMF A90302: Api Project / Sub-phases / Update
-
DMF 060902: Projects / Sub-phases / Modify
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
project_id |
The id of the project |
X |
null |
|
phase_id |
The id of the phase |
X |
null |
|
sub_phase_id |
The id of the sub-phase |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
sub-phase |
The sub-phase to update SubPhase |
X |
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Sub-phase 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" : "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,
"expectedStart" : "2000-06-21",
"actualStart" : "2000-06-21",
"expectedEnd" : "2000-06-21",
"actualEnd" : "2000-06-21",
"description" : "Lorem ipsum dolor sit amet",
"manager" : {
"id" : "5000123",
"code" : "CASH",
"name" : "DUPONT",
"firstName" : "Jean",
"action" : "{}"
},
"managerId" : "5000123",
"state" : {
"id" : "id",
"code" : "PRO",
"name" : "Production",
"companyId" : "5000123"
},
"stateId" : "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",
"closure" : false,
"customData" : {
"key" : {
"type" : "{}",
"value" : "Autoref 010520",
"name" : "Reference 4",
"realOrder" : 0,
"label" : "REFERENCE_4"
}
},
"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
}
}
3. Models
3.2. 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.3. AccountingJournalBase
Accounting journal
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
The accounting journal code |
|||
id |
Id in database |
|||
name |
The accounting journal name |
3.4. Action
Verb of the request to specify which type of action you will send.
Type : enum (ADD, UPDATE, REMOVE)
3.5. ActionCode
Action code permitted for the project
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Action code |
|||
dailyDirectCost |
Direct cost per day sold |
double |
||
dailyStandardCost |
Standard cost per day sold |
double |
||
description |
Description of the action |
|||
entityId |
Entity id |
|||
grouping |
Name of the grouping |
|||
hourlyDirectCost |
Direct cost per hour sold |
double |
||
hourlyStandardCost |
Standard cost per hour sold |
double |
||
id |
Action id |
|||
natureType |
The nature type of the action |
|||
smoothingCoefficient |
Smoothing coefficient of the action cost |
double |
||
type |
The type of the action |
|||
validity |
The date until the action is valid |
date-time |
||
valuationCoefficient |
Valuation coefficient of the action cost |
double |
3.6. 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.7. ActionCodeBase
Details about the action code
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
Id in database |
|||
name |
Name of the action code |
3.8. 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.9. ActionNatureType
The nature of the action
Type : enum (SOLD, INVESTMENT, LOGISTICS, NON_PRODUCTIVE)
3.10. ActionType
Type of the action
Type : enum (OTHER, LEAVE, WORKFORCE, TRAINING, SERVICES, INTERNAL, INVESTMENT)
3.11. 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.12. Activity
Division
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Code of the activity |
|||
department |
Department of an activity |
|||
departmentId |
ID of the department |
|||
endDate |
End of validity |
date-time |
||
id |
Id in database |
|||
name |
Name of the activity |
3.13. ActivityBase
Division
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Code of the activity |
|||
id |
Id in database |
|||
name |
Name of the activity |
3.14. ActivityCriteria
Criteria used on activity when doing an activity search
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
The code of activity |
|||
companyId |
ID of the company |
|||
departmentId |
ID of the department |
|||
endDate |
End date of the activity |
date-time |
||
id |
The ID of the activity |
|||
name |
The name of the activity |
3.15. ActivityReadOption
ReadOption of a Activity
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
options |
List of [string] |
List of options used to get more details about the activity |
Enum: DEPARTMENT |
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. 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.22. 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.23. 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.24. 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.25. ApprovalState
State of the Approval
Type : enum (NONE, TO_REQUEST, TO_APPROVE, REFUSED, APPROVED)
3.26. 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.27. 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.28. 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.29. 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.30. 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.31. 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.32. 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.33. AssignmentSubType
Subtype of Assignment
Type : enum (PROJECT_GROUP, DEPARTMENT, ACTIVITY, CATEGORY, SUB_CATEGORY, SUB_CATEGORY_2, PROJECT_STATE, YEAR)
3.34. AssignmentType
Type of Assignment
Type : enum (COMPANY, DIVISION_GROUP, DIVISION, ENTITY, CUSTOMER, PROJECT, PHASE, SUBPHASE, PROJECT_TASK)
3.35. 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.36. Avatar
Entity avatar
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
content |
The base64-encoded binary content or URL of the entity's avatar image. |
3.37. 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.38. 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.39. 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.40. 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.41. BankType
Type of the bank (nature de banque) for international bank detail
Type : enum (BIC, ABA, NOT_DEFINED)
3.42. 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.43. BankingInformationStatus
The status of the Banking Information
Type : enum (VALIDATED, TO_VALIDATE, REFUSED)
3.44. 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.45. BankingInformationSupplierType
Supplier type of banking information
Type : enum (ALL, INTERNAL, EXTERNAL, VIRTUAL)
3.46. BankingInformationType
List of banking information type
Type : enum (SEPA, INTERNATIONAL_BANK)
3.47. 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.48. 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.49. BatchParameter
Parameter used to manage batch operations
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
ids |
List of [string] |
Ids of the objects |
3.50. 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.51. 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.52. BillingMode
Billing mode of a product or sales line
Type : enum (TIME_BASED, FIXED_PRICE, RECURRENT, PRODUCTION_TO_BE_BILLED)
3.53. 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.54. 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.55. 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.56. BooleanParamHolder
Parameter value (Boolean).
See the documentation of the calling API body for further information
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
value |
Value |
3.57. 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.58. 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.59. 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.60. 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.61. 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.62. 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.63. 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.64. 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.65. 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.66. 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.67. CheckbookBase
Customer checkbook base
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
Id in database |
|||
name |
The name of the checkbook |
3.68. 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.69. ChorusServiceInformation
Chorus service information
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
serviceCode |
Code of Chorus service |
|||
serviceName |
Name of Chorus service |
3.70. 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.71. 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.72. 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.73. 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.74. 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.75. 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.76. 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.77. ColorCodes
ColorCodes
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
color1 |
First color code |
|||
color2 |
Second color code |
|||
color3 |
Third color code |
3.78. 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.79. CommandProgress
Command progress status
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
current |
Current index of the progress |
|||
max |
Max index of the progress |
3.80. 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.81. CompanyBase
Company
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Code of the company |
|||
id |
Id in database |
|||
name |
Name of a company |
3.82. ComparisonOperator
Comparison operator
Type : enum (BEFORE, AFTER, EQUAL, BEFORE_EQUAL, AFTER_EQUAL)
3.83. 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.84. 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.85. 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.86. 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.87. ContractualConditionOfPayment
The contractual condition of payment of the project
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
accountingJournal |
Details about the accounting journal |
|||
accountingJournalId |
ID of Accounting Journal |
|||
code |
Payment code |
|||
currency |
Details about the currency |
|||
currencyId |
Id of the currency |
|||
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.88. 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.89. 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.90. 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.91. 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.92. 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.93. 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.94. 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.95. 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.96. 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.98. 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.99. 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.100. 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.101. 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.102. 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.103. 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.104. CustomizableResources
Customizable resources (Ressources personnalisables)
Type : enum (ISSUE, OPPORTUNITY, OPPORTUNITY_LINE, CUSTOM_REQUEST, EVENT, PROJECT, PHASE, SUB_PHASE, EMPLOYEE, CUSTOMER, CONTACT, SALES, PURCHASE)
3.105. DateParamHolder
Date given in parameter
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
date |
Date |
date-time |
3.107. 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.108. DepartmentCriteria
Criteria used on department when doing an department search
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
The code of department |
|||
companyId |
ID of the company |
|||
id |
The ID of the department |
|||
name |
The name of the department |
3.109. 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.111. 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.112. DivisionCriteria
Criteria used on division when doing a division search
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
||||
companyId |
ID of the company |
|||
id |
||||
name |
||||
serviceId |
3.113. 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.114. 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.115. 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.116. 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.117. 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.118. 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.119. DueDateCriteria
Criteria used to get more details about the due date
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
invoiceId |
Ident of the invoice |
3.120. 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.121. 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.122. 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.123. 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.124. ESignatureSignatoryType
Defines the type of signatory for electronic signatures.
A signatory can be either an employee or a contact.
Type : enum (CONTACT, EMPLOYEE)
3.125. ESignatureStatus
Electronic signature status of a management object
Type : enum (IN_PROGRESS, CANCELED, EXPIRED, SIGNED, FAILED, PENDING, SIGNATURE_REQUESTED)
3.126. 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.127. 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.128. EmployeeLink
Relation between an employee and a Project
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
employeeId |
ID of the employee |
|||
linkType |
Type of like between something and a project |
3.129. EmployeeLinkCriteria
Criteria used when doing a Project Link search
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
checkEmployeeCompany |
True if employee link with employee company |
|||
checkSchedule |
True if employee link with schedule |
|||
checkTimesheet |
True if employee link with timesheet |
|||
from |
From date of the link |
|||
to |
To date of the link |
3.130. EmployeeLinkType
Type of link with an Employee
Type : enum (EMPLOYEE_COMPANY, TIMERECORDING, SCHEDULE)
3.131. EmployeeScheduleType
Type of employee schedule
Type : enum (ALL, GENERIC, EXCLUDING_GENERICS)
3.132. 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.133. 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.134. 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.135. 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.136. 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.137. 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.138. 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.139. 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.140. 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.141. 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.142. 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.143. 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.144. FixedAssetRecordSheetBase
Fixed asset record sheet
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
Id in database |
|||
name |
Name of fixed asset record sheet |
3.145. 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.147. 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.148. 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.149. 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.150. GeneralAccountBase
General account (ident example AKSAS22106800)
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
Id in database |
|||
name |
General account label |
3.151. GeneralAccountCommon
General account
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
Id in database |
|||
name |
General account label |
|||
number |
General account number |
3.152. 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.153. 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.154. 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.156. 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.157. Holiday
Holiday
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
date |
Date of the holiday |
date-time |
||
type |
Type of holiday |
3.158. 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.159. IdIdentifiable
Basic type for all pojos with an API ID
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
Id in database |
3.160. 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.161. 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.162. 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.163. 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.165. IssueBase
Issue base
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
Id in database |
3.166. 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.167. 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.168. 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.169. ItemBase
Item
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
Id in database |
3.170. 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.171. 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.172. 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.174. LinkDirectionEnum
A filation link type can be set with a link direction
Type : enum (ASCENDING, DESCENDING, TRANSVERSE, NOT_APPLICABLE)
3.175. 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.176. 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.177. 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.178. 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.179. 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.180. 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.181. 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.182. 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.183. 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.184. 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.185. 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.186. 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.187. 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.188. 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.189. 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.190. 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.191. 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.192. MessageRecipientType
Message recipient type
Type : enum (USER, EMPLOYEE, CONTACT, TEAM, MAIL_ADDRESS)
3.193. 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.194. 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.195. 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.196. OccurrenceType
Type of occurrence project task
Type : enum (NORMAL_TASK, FIXED_MILESTONE, NON_FIXED_MILESTONE)
3.197. 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.198. 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.199. 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.200. 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.201. 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.202. 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.203. 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.204. 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.205. 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.206. 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.207. 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.208. PeopleLinkTypeEnum
A link can be set as a Management Link or a Filiation Link
Type : enum (MANAGEMENT_LINK, FILIATION_LINK)
3.209. 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.210. PeriodGranularity
Granularity of a period
Type : enum (YEAR, MONTH, DAY, HOUR, MINUTE, SECOND)
3.211. 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.213. PermittedActionCode
Action code permitted for the project
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Action code |
|||
dailyDirectCost |
Direct cost per day sold |
double |
||
dailyStandardCost |
Standard cost per day sold |
double |
||
description |
Description of the action |
|||
entityId |
Entity id |
|||
grouping |
Name of the grouping |
|||
hourlyDirectCost |
Direct cost per hour sold |
double |
||
hourlyStandardCost |
Standard cost per hour sold |
double |
||
id |
Action id |
|||
natureType |
The nature type of the action |
|||
smoothingCoefficient |
Smoothing coefficient of the action cost |
double |
||
type |
The type of the action |
|||
validity |
The date until the action is valid |
date-time |
||
valuationCoefficient |
Valuation coefficient of the action cost |
double |
3.214. Phase
Phase
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
actualEnd |
The expected production ending date of the phase |
date |
||
actualStart |
The actual production ending date of the phase |
date |
||
closure |
Phase completion status |
|||
code |
Code of a phase |
|||
customData |
Map of CustomData |
Details about the custom data |
||
customerContact |
Information about the customer contact. |
|||
customerHostSite |
Host site of the phase |
|||
customerHostSiteId |
Host site id of the phase |
|||
description |
Complementary description of the phase |
|||
expectedEnd |
The expected production ending date of the phase |
date |
||
expectedStart |
The expected production starting date of the phase |
date |
||
id |
Id in database |
|||
manager |
Manager of the phase |
|||
managerId |
Id of the manager |
|||
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) |
|||
quoteNumber |
Quotation number used for ranking a printed document related to the project |
|||
state |
State of the phase |
|||
stateId |
Id of the state of the phase |
3.215. 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.216. PhaseCriteria
Criteria used on Phase when doing a Phase search
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
activeModule |
The active module |
|||
actualEnd |
The expected production ending date of the phase |
|||
actualStart |
The actual production ending date of the phase |
|||
closure |
Phase completion status |
|||
code |
||||
expectedEnd |
The expected production ending date of the phase |
|||
expectedStart |
The expected production starting date of the phase |
|||
id |
||||
managerId |
Id of the manager |
|||
name |
||||
phaseValidity |
Date from which the phase of the project is active (in production) |
|||
projectId |
Ident of the project (i.e. to the code of the project) |
|||
readOption |
Options used to retrieve more information about the phase |
|||
referentialDate |
Date from which the project phase is active (in production) |
date-time |
||
stateId |
State code of the phase |
|||
tag |
You can use this clause to do a text search on the code and designation |
3.217. PhaseReadOption
ReadOption of a Phase
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
options |
List of [string] |
List of options used to get more details about the phase |
Enum: PROJECT, CUSTOMER_HOST_SITE, MANAGER, PHASE_STATE, LINKED_STAKEHOLDERS, CUSTOM_DATA, FORM_CONFIG |
3.218. 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.219. PhaseStateCriteria
Criteria used on phase state when doing a phase state search
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
||||
companyId |
||||
id |
||||
name |
3.220. PhaseTemplate
Phase template
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
company |
The company using the template |
|||
companyId |
Id of the company using the template |
|||
description |
Description of the phase template |
|||
id |
Id of phase template |
|||
order |
Order number of the phase |
|||
phaseEndDate |
Phase end date of the template |
date-time |
||
templateName |
Phase template name |
|||
type |
Status type of phase |
3.221. PhaseTemplateCriteria
Criteria used on PhaseTemplate when doing a PhaseTemplate search
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
companyId |
Ident of the company |
|||
id |
||||
phaseEndDate |
End date of the phase template |
|||
templateName |
||||
type |
3.223. PipeBase
Pipe base
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Code of the pipe |
|||
id |
Id in database |
|||
name |
Name of the pipe |
3.224. PluginFeature
Plugin Feature
Type : enum (BRIDGE, CHORUS, EDOC, PRESTATIONS, UNIVERSIGN, API_GOOGLE, AKUITEO_SAAS)
3.225. 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.226. 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.227. PostponeType
Defines how the date postponement is handled
Type : enum (EXACT_DATE, SHIFT_BY_PERIOD, RESET_DATE)
3.228. 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.230. 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.231. 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.232. 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.233. 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.234. Project
Project
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
accountant |
Enable the allocation of indirect expenses required for analysis reports |
|||
actionCodes |
List of ActionCode |
List of action codes permitted for the project |
||
activity |
Details about the project activity |
|||
activityId |
Id of the activity |
|||
address |
Remark : In add APIs (mainly PUT requests) |
|||
addressId |
ID of the address |
|||
budget |
Budget of the project |
double |
||
campaign |
Details about the campaign related to the project. |
|||
campaignId |
ID of the campaign related to the project. |
|||
changeTracking |
Creation and modification date and user |
|||
code |
Code of the project |
|||
color |
Color of the project (hexadecimal code) |
|||
company |
Details about the project company |
|||
companyCode |
Code of the company |
|||
companyId |
ID of the company |
|||
conditionOfPayment (Deprecated) |
Deprecated : Use contractualConditionOfPayment instead |
|||
contractualConditionOfPayment |
The contractual condition of payment for a project |
|||
countryId |
Id of country available |
|||
customData |
Map of CustomData |
The custom data details (when present) |
||
customer |
Details of the customer |
|||
customerId |
Id of the project's customer |
|||
customerType |
Customer type |
|||
description |
Description of the project |
|||
division |
Details about the project division |
|||
divisionId |
ID of the division |
|||
endCustomer |
Details of the customer |
|||
endCustomerId |
Id of the project's end customer |
|||
entity |
Details about the project entity |
|||
entityId |
Id of the entity |
|||
exemptionVAT |
If the phase is exempted of VAT |
|||
financialManager |
Details about the financial manager |
|||
financialManagerId |
Id of the financial manager |
|||
id |
Id in database |
|||
internal |
If the project is internal or not |
|||
isPilot |
Return true if the project is a pilot project when sub contracting |
|||
isPrivate |
Return true if the project is a private project |
|||
isServiceProvider |
Return true if the project is a service provider project when sub contracting |
|||
languageCode |
Code of the language available |
|||
leave |
Return true if the project is a leave project |
|||
leaveType |
Details about leave type |
|||
manager |
Details about the manager |
|||
managerId |
ID of the manager |
|||
methodOfPayment |
Method of payment |
|||
name |
Name of a project |
|||
opportunity |
Details about the opportunity |
|||
opportunityId |
Id of the opportunity |
|||
permittedActionCodes (Deprecated) |
List of PermittedActionCode |
List of action codes permitted for the project |
||
phaseTemplate |
Remark : In add APIs (mainly PUT requests) |
|||
phaseTemplateId |
Id of phase template |
|||
previousProject |
Details about the previous project |
|||
previousProjectId |
Id of the previous project (i.e. Code of the previous project) |
|||
prodManager |
Details about the production manager |
|||
prodManagerId |
Id of the production manager |
|||
productionEnd |
||||
productionStart |
||||
projectCategory |
Remark : In add APIs (mainly PUT requests) |
|||
projectCategoryId |
ID of the project category |
|||
projectEnd (Deprecated) |
End date of a project |
date-time |
||
projectGroup |
Details about the project group |
|||
projectGroupCode |
Code of the project group |
|||
projectGroupId |
Id of the project group |
|||
projectStart (Deprecated) |
Start date of a project |
date-time |
||
projectState |
State of the project |
|||
projectStateId |
Id of the state of the project |
|||
projectSubCategory |
Remark : In add APIs (mainly PUT requests) |
|||
projectSubCategoryId |
ID of the project sub category |
|||
projectSubCategoryLevel2 |
Remark : In add APIs (mainly PUT requests) |
|||
projectSubCategoryLevel2Id |
ID of the project sub category level 2 |
|||
prospectionStart |
Beginning of the prospection phase |
date-time |
||
remainingTask |
Take into account the remaining task |
|||
salesManager |
Details about the sales manager |
|||
salesManagerId |
Id of the sales manager |
|||
signatureForFirstOrder |
||||
training |
Enable training management project |
|||
year |
Details about the project year |
|||
yearId |
Id of the year |
3.235. 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.236. 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.237. ProjectCriteria
Criteria used on Project when doing a Project search
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
activeModule |
Example : EXPENSE_REPORTS |
|||
activityId |
||||
campaignId |
The ID of the campaign related. |
|||
categoryId |
||||
changeTracking |
Change tracking criteria |
|||
code |
||||
companyId |
Ident of the company |
|||
controlsManagerId |
Controls Manager for the project |
|||
countryCode |
||||
countryId |
||||
customerId |
||||
customerType |
Type of relation with the customers |
|||
departmentId |
||||
divisionGroupingId |
||||
divisionId |
||||
endCustomerId |
||||
entityId |
||||
financialManagerId |
||||
id |
||||
internal |
Restricts search to internal projects |
|||
isInternal |
Restricts search to internal projects |
|||
isPilot |
Restricts search to pilot projects |
|||
isPrivate |
Restricts search to private projects |
|||
isServiceProvider |
Restricts search to service provider projects |
|||
managerId |
||||
name |
||||
opportunityId |
Id of the opportunity |
|||
previousProjectId |
Ident of the previous project (i.e. Code of the previous project) |
|||
productionEnd |
Criteria related to the production end period of the project. |
|||
productionManagerId |
||||
productionStart |
Criteria related to the production start period of the project. |
|||
projectGroupCode |
||||
projectGroupId |
||||
projectManagerId |
||||
projectState |
||||
readOption |
Options used to retrieve more information about the project |
|||
referentialDate |
Date from which the project is active (in production) |
date-time |
||
salesManagerId |
||||
signatureForFirstOrder |
Criteria related to the date of signature for the project's first order. |
|||
stateId |
||||
subCategoryId |
||||
subCategoryLevel2Id |
||||
tag |
You can use this clause to do a text search on the id and name |
|||
yearId |
Year of the project |
3.238. ProjectCustomerType
Type of relation with the customers
Type : enum (ALL_CUSTOMERS, MULTI_CUSTOMERS, SINGLE_CUSTOMER)
3.239. 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.240. 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.241. ProjectGroupCriteria
Criteria used on project group when doing a project group search
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
||||
description |
||||
id |
||||
name |
3.243. ProjectReadOption
ReadOption of a Project
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
options |
List of [string] |
List of options used to get more details about the project |
Enum: CUSTOMER, END_CUSTOMER, PROJECT_CATEGORY, PROJECT_SUB_CATEGORY, PROJECT_SUB_CATEGORY_LEVEL2, MANAGER, PROD_MANAGER, FINANCIAL_MANAGER, SALES_MANAGER, CHANGE_TRACKING, COMPANY, DIVISION, ENTITY, ACTIVITY, PROJECT_STATE, PROJECT_GROUP, PREVIOUS_PROJECT, YEAR, CUSTOM_DATA, FORM_CONFIG, ADDRESS, OPPORTUNITY, PHASE_TEMPLATE, PERMITTED_ACTION_CODE, CAMPAIGN, CONDITION_OF_PAYMENT, CONDITION_OF_PAYMENT_CURRENCY, CONDITION_OF_PAYMENT_ACCOUNTING_JOURNAL |
3.244. 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.245. 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.246. ProjectTask
Project
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
authorizedEmployees |
List of EmployeeBase |
List of employees and generic employees who can access the task in their timesheet entries and schedules |
||
code (Deprecated) |
Code of the task |
|||
customer |
Details about the customer |
|||
customerId |
ID of the customer |
|||
dailyPriceCurrency |
Average daily price of the sold product in currency |
double |
||
defaultTask |
If it is the default task for help desk scheduling |
|||
description |
Description of the task |
|||
endDate |
End date of the task |
date-time |
||
executionDate |
Execution date of the task |
date-time |
||
id |
Id in database |
|||
linkedEmployee |
Details about the linked employee |
|||
linkedEmployeeId |
ID of the employee |
|||
location |
Location of the project task |
|||
manager |
Details about the manager |
|||
managerId |
ID of the manager |
|||
name |
Name of the task |
|||
occurrenceType |
Type of occurrence |
|||
order |
Order number of the task |
int32 |
||
phase |
Details about the phase of the project. |
|||
phaseId |
ID of the phase |
|||
progress |
||||
project |
All details about the project |
|||
projectId |
ID of the project (equivalent to the code of the project) |
|||
projectTaskType |
The type of a project task |
|||
projectTaskTypeId |
The id of the type of project task |
|||
quantityOfDays |
Standard number of days per month needed to perform the task |
double |
||
riskLevelId |
Evaluates the progress risk level |
|||
skills |
List of Skill |
List of skills |
||
soldItem |
Sold Item |
|||
soldItemId |
The grouping of the sold product |
|||
standardWeek |
Details about the standard week used. |
|||
standardWeekId |
ID of the standard week used |
|||
startDate |
Start date of the task |
date-time |
||
subPhase |
Details about the sub-phase of the project |
|||
subPhaseId |
ID of the sub-phase |
3.247. 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.248. 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.249. ProjectTaskCriteria
Criteria used on Project Task when doing a Project Task search
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
activeModule |
The active module |
|||
companyId |
Ident of the company to which the project task is assigned |
|||
customerId |
||||
divisionGroupingId (Deprecated) |
Ident of the grouping division to which the project task is assigned |
|||
divisionId (Deprecated) |
Ident of the division to which the project task is assigned |
|||
employeeScheduleType |
Type of employee schedule |
|||
endDate |
End date of the task |
|||
entityId (Deprecated) |
Ident of the company's entity to which the project task is assigned |
|||
executionDate |
Execution date of the task |
|||
hidePrivateProject |
When true excludes private projects |
|||
id |
||||
linkedEmployeeId |
Ident of the linked employee of the project task |
|||
managerId |
Ident of the manager of the project task |
|||
name |
||||
occurrenceType |
Type of occurrence |
|||
phaseId |
Ident of the corresponding phase |
|||
projectCriteria |
Criteria on project linked to the project task |
|||
projectId |
Ident of the project (i.e. to the code of the project) |
|||
projectTaskTypeId |
The id of the type of the project task |
|||
projectValidity |
Date from which the project of the task is active (in production) |
|||
readOption |
Options used to retrieve more information about the project task |
|||
referentialDate |
Date from which the task is active (in production) |
date-time |
||
referentialDateEndBound |
Date before which the task is active (in production) |
date-time |
||
soldItemId |
The grouping of the sold product |
|||
standardWeeksId |
Ident of the standard week |
|||
startDate |
Start date of the task |
|||
subPhaseId |
Ident of the sub-phase to which the task belongs |
|||
tag |
You can use this clause to do a text search on the name |
|||
withWorkload |
Restricts search to tasks with an associated workload (> 0) |
3.250. ProjectTaskProgress
Progress of a Project Task
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
calculatedRemainingTasks |
Set as true if the remaining task is automatically calculated from the task workload (quantityOfDays) minus time recorded for that task from time sheets |
|||
done |
What has been completed (validated or not) of the scheduled work |
double |
||
doneAndValidated |
What has been completed and validated of the scheduled work |
double |
||
excess |
What exceeds the estimated workload |
double |
||
hoursHundredthsWorkload |
Task workload expressed in hours hundredths. |
double |
||
remainingTasks |
What remains from the estimated workload after what has been done and validated (difference between the estimated workload and doneAndValidated) |
double |
||
scheduled |
What has been scheduled on the estimated workload |
double |
||
toBeScheduled |
What still needs to be scheduled from the estimated workload |
double |
||
type |
Project task progress indicator allowing to define if the project task workload is expressed in days or hundredths of hours. |
|||
workload |
Estimated workload for the project task |
double |
3.251. ProjectTaskProgressIndicator
Project Task Progress Indicator
Type : enum (DAYS, HOURS_HUNDREDTHS)
3.252. ProjectTaskReadOption
ReadOption of a Project Task
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
options |
List of [string] |
List of options used to get more details about the project task |
Enum: CUSTOMER, PROJECT, PHASE, SUB_PHASE, TASK_PROGRESS, SKILLS, MANAGER, LINKED_EMPLOYEE, SOLD_ITEM, AUTHORIZED_EMPLOYEES, PROJECT_TASK_TYPE, STANDARD_WEEK, FORM_CONFIG |
3.253. 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.255. 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.256. 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.257. 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.258. 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.259. 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.260. PublishTemplateParameterType
Type of parameter.
Type : enum (TEXT_BOX, LIST_BOX, DATE_BOX, RADIO_BUTTON, CHECK_BOX, COMBO_BOX)
3.261. 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.262. 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.263. 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.264. 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.266. 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.267. 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.269. 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.270. 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.271. ScheduleGenerationOption
Options when generating a schedule for the selected project tasks
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
actionCodeId |
Id of the action code selected |
|||
authorisationPublicHoliday |
Allowing the schedule to generate project tasks on public holiday |
|||
authorisationSat |
Allowing the schedule to generate project tasks on Saturdays |
|||
authorisationSun |
Allowing the schedule to generate project tasks on Sundays |
|||
fromEndDate |
Generate the schedule based on the end date of a project task |
|||
projectTasks |
List of [string] |
Selected project tasks used when generating a schedule |
||
type |
Type of action performed on the schedule |
|||
workloadType |
Type of project task workload generated on the schedule |
3.272. ScheduleGenerationType
Type of action performed on the schedule
Type : enum (GENERATE, PURGE)
3.273. 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.274. 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.275. SearchFieldType
Type of search field
Type : enum (DROPDOWN_LIST, DATE, TEXT, BOOLEAN, NUMBER)
3.276. 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.277. 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.278. 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.279. Service
Service
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Code of the service |
|||
id |
Id in database |
|||
name |
Name of the service |
3.280. ShiftPeriod
Time unit for shifting the period.
Type : enum (YEAR, HALF_YEAR, QUARTER, MONTH, WEEK, DAY)
3.281. 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.282. 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.283. 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.284. 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.285. SortField
Couple field/sort type
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
fieldName |
Name of the field |
|||
order |
Sort type. (ASC or DESC) |
3.287. 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.289. 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.290. 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.291. StringParamHolder
Parameter value (String).
See the documentation of the calling API body for further information
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
value |
Value |
3.292. 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.293. 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.294. 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.295. 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.296. SubCategoryItemClassification
Purchased item sub-category classification
Type : enum (EXTERNAL, INTERNAL, NOT_SPECIFIED, OTHERS, PRICE_REVIEW)
3.297. 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.298. 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.299. 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.300. 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.301. SubPhase
Sub-phase
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
actualEnd |
The actual ending date of the sub-phase |
date |
||
actualStart |
The actual starting date of the sub-phase |
date |
||
closure |
Sub-Phase completion status |
|||
code |
Code of a sub-phase |
|||
customData |
Map of CustomData |
Details about the custom data |
||
description |
Complementary description of the sub-phase |
|||
expectedEnd |
The expected ending date of the sub-phase |
date |
||
expectedStart |
The expected starting date of the sub-phase |
date |
||
id |
Id in database |
|||
manager |
Details about the manager |
|||
managerId |
Ident of the manager |
|||
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 |
|||
project |
Details about the corresponding project |
|||
projectId |
ID of the corresponding project (i.e. Code of the project) |
|||
state |
Details about the state |
|||
stateId |
State id of the sub-phase |
3.302. 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.303. SubPhaseCriteria
Criteria used on Sub-phase when doing a Sub-phase search
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
activeModule |
The active module |
|||
actualEnd |
The expected ending date |
|||
actualStart |
The actual ending date |
|||
closure |
Phase completion status |
|||
expectedEnd |
The expected ending date |
|||
expectedStart |
The expected starting date |
|||
id |
||||
managerId |
Id of the manager |
|||
name |
||||
phaseId |
||||
projectId |
Ident of the project (i.e. the code of the project) |
|||
readOption |
Options used to retrieve more information about the sub phase |
|||
referentialDate |
Date from which the project sub phase is active (in production) |
date-time |
||
stateCode |
State code of the phase |
|||
stateId |
State id of the phase |
|||
subPhaseValidity |
Date from which the sub-phase of the project is active (in production) |
|||
tag |
You can use this clause to do a text search on the code and designation |
3.304. SubPhaseReadOption
ReadOption of a SubPhase
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
options |
List of [string] |
List of options used to get more details about the sub phase |
Enum: PROJECT, PHASE, MANAGER, SUB_PHASE_STATE, CUSTOM_DATA, FORM_CONFIG |
3.305. 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.306. 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.307. SubledgerAccountBase
Subledger account (ident example AKSAS22106800)
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
Id in database |
|||
name |
Subledger account label |
3.308. SubledgerAccountCommon
Subledger account
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
Id in database |
|||
name |
Subledger account label |
|||
number |
Subledger account number |
3.309. 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.310. 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.311. 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.313. 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.314. 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.315. 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.316. 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.318. TaskBase
Task base
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
Id in database |
3.319. TaskBillingType
The list of value of billing type of the type of project task.
Type : enum (TIME_BASED, TIME_BASED_FIXED_PRICE_MONTHLY)
3.320. TaskCommon
Task common
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
Id in database |
|||
number |
The number of the task. |
int32 |
3.321. 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.322. 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.323. 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.324. 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.325. ThirdPartyTypeEnum
A type of the third party with people links
Type : enum (PROSPECT, CUSTOMER, SUPPLIER, OTHER_THIRD_PARTY)
3.326. 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.327. 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.328. 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.329. 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.331. 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.332. TransactionStatus
Transaction status for electronic signatures
Type : enum (IN_PROGRESS, CANCELED, EXPIRED, COMPLETED)
3.333. TransferAffectation
Affectation parameters when doing a transfer
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
end |
The end date of the transfer |
date-time |
||
start |
The starting date of the transfer |
date-time |
||
toPhaseId |
Id of the selected phase to transfer |
|||
toProjectId |
Id of the selected project to transfer |
|||
toSubPhaseId |
Id of the selected phase to transfer |
3.334. UnitDuration
Unit of duration
Type : enum (MINUTE, HOUR_MINUTE, HOUR_DECIMAL, DAY, UNIT_OF_EMPLOYEE, UNIT_OF_COMPANY)
3.335. UnitPrice
Unit price of an item
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
value |
Unit price of an item |
double |
3.336. 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.337. 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.338. 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.339. 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.340. 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.341. 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.342. VATBase
VAT
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
VAT code |
|||
id |
Id in database |
|||
rate |
VAT rate in percentage |
double |
3.343. 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.345. WorkloadGenerationType
Type of project task workload generated on the schedule
Type : enum (OVERALL_WORKLOAD, REMAINING_WORKLOAD)
3.346. 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.347. 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:47:26
Copyright : Akuiteo © 2025