1. Introduction
The Administration domain contains APIs used for server administration, comparable to the features available in the Administration Console.
1.3. Tags
-
AdminServer : Runtime server information
-
BackgroundTasks : Background task management
-
Caches : Cache refreshing
-
Endpoints : Server Endpoints
-
Extended logs : Extended logs
-
Features : Features management
-
Import services : Import services management
-
OAuth : OAuth security
-
OneShotProbe : One Shot Probe management
-
Properties : Properties management
-
Sessions : Session Management
-
Technical events : Technical Journal
-
Tools : Server Tools
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. Admin Server
2.1.1. Change the server restricted status
POST |
/server/status/change-restricted-status |
Description
Change the server restricted status
DMF required:
-
DMF A30113: Api Admin / Server / Change Status
-
DMF 090201: Administrator / Setup / Server Administration Console
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
state |
New restricted server status State |
X |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Server status changed successfully |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to 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
{
"value" : true
}
2.1.2. Disable Database Logs
POST |
/server/logs/database/disable |
Description
Disable Database Logs
DMF required:
-
DMF A30110: Api Admin / Server / Logs
-
DMF 090201: Administrator / Setup / Server Administration Console
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Database logs disabled successfully |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.1.3. Enable database logs
POST |
/server/logs/database/enable |
Description
Enable database logs
DMF required:
-
DMF A30110: Api Admin / Server / Logs
-
DMF 090201: Administrator / Setup / Server Administration Console
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Database logs enabled successfully |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to 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.4. Get log levels
GET |
/server/logs/logs-level |
Description
Get log levels
DMF required:
-
DMF A30110: Api Admin / Server / Logs
-
DMF 090201: Administrator / Setup / Server Administration Console
Return Type
array[PackageLogsLevel]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Give for each log level (DEBUG, WARN…) the list of packages for this level |
List[PackageLogsLevel] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to 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.5. Get technical information about database
GET |
/server/info/database |
Description
Get technical information about database
DMF required:
-
DMF A30116: Api Admin / Server / Database
-
DMF 090201: Administrator / Setup / Server Administration Console
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Database information successfully retrieved |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to 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.6. Get an excerpt of a log file
GET |
/server/logs/{file_name}/{index} |
Description
Get an excerpt of a log file, starting from a give file index position to the end of file.
DMF required:
-
DMF A30110: Api Admin / Server / Logs
-
DMF 090201: Administrator / Setup / Server Administration Console
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
file_name |
File Name |
X |
null |
|
index |
Starting point |
X |
null |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Excerpt successfully returned |
|
404 |
File not found |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to 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.7. Get technical information about server
GET |
/server/info |
Description
Get technical information about server
DMF required:
-
DMF A30114: Api Admin / Server / Search
-
DMF 090201: Administrator / Setup / Server Administration Console
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Server information successfully retrieved |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to 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.8. Get the runtime status of the server
GET |
/server/status |
Description
Get the runtime status of the server
DMF required:
-
DMF A30112: Api Admin / Server / Status
-
DMF 090201: Administrator / Setup / Server Administration Console
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Server status loaded successfully |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to 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.9. Load a jar file containing all classes of Akuiteo
GET |
/server/classes-archive |
Description
Load a jar file containing all classes of Akuiteo
DMF required:
-
DMF A30115: Api Admin / Server / Load Jar File
-
DMF 090201: Administrator / Setup / Server Administration Console
Content Type
-
application/octet-stream
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Jar file downloaded |
|
404 |
Requested resource could not be found |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to 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.10. Load an Akuiteo library jar file (stored in /WEB-INF/lib directory)
GET |
/server/libs/{file_name} |
Description
Load an Akuiteo library jar file (stored in /WEB-INF/lib directory)
DMF required:
-
DMF A30111: Api Admin / Server / Libraries
-
DMF 090201: Administrator / Setup / Server Administration Console
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
file_name |
File Name |
X |
null |
Content Type
-
application/octet-stream
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Library downloaded |
|
404 |
Requested resource could not be found |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to 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.11. Return the MD5 hash for an Akuiteo library jar file (stored in /WEB-INF/lib directory)
GET |
/server/libs/{file_name}/md5 |
Description
Return the MD5 hash for an Akuiteo library jar file (stored in /WEB-INF/lib directory)
DMF required:
-
DMF A30111: Api Admin / Server / Libraries
-
DMF 090201: Administrator / Setup / Server Administration Console
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
file_name |
File Name |
X |
null |
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
MD5 hash successfully returned |
|
404 |
Requested resource could not be found |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to 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.12. Change logs level at runtime for a given list of packages
POST |
/server/logs/logs-level |
Description
Change logs level at runtime for a given list of packages
DMF required:
-
DMF A30110: Api Admin / Server / Logs
-
DMF 090201: Administrator / Setup / Server Administration Console
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
packagesLogsLevel |
List of packages with updated log levels PackageLogsLevel |
- |
Return Type
array[PackageLogsLevel]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Changes applied, logs level updated |
List[PackageLogsLevel] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to 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
{
"level" : "OFF",
"packageNames" : [ "packageNames", "packageNames" ],
"status" : "IN_PROGRESS"
}
2.2. Background Tasks
2.2.1. Disable a background Task
POST |
/background-tasks/{task_id}/disable |
Description
Disable a background Task
DMF required:
-
ADMINW: Server administration console user.
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
task_id |
Task id |
X |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Background task disabled |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.2.2. Enable a background Task
POST |
/background-tasks/{task_id}/enable |
Description
Enable a background Task
DMF required:
-
ADMINW: Server administration console user.
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
task_id |
Task id |
X |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Background task enabled |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.2.3. Get all background Tasks
GET |
/background-tasks |
Description
Get all background Tasks
DMF required:
-
DMF A30906: Api Admin / Background Tasks / Get
-
DMF 090201: Administrator / Setup / Server Administration Console
Return Type
array[BackgroundTask]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
List of all background tasks |
List[BackgroundTask] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.2.4. Launch a background Task
POST |
/background-tasks/{task_id}/launch |
Description
Launch a background Task
DMF required:
-
ADMINW: Server administration console user.
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
task_id |
Task id |
X |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Background task executed |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to 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. Caches
2.3.1. Refresh all caches
POST |
/caches/refresh |
Description
Refresh all caches
DMF required:
-
DMF A30410: Api Admin / Caches / Refresh
-
DMF 090201: Administrator / Setup / Server Administration Console
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Caches refreshed successfully |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to 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. Refresh cache_type
POST |
/caches/{cache_type}/refresh |
Description
Refresh cache_type
DMF required:
-
DMF A30410: Api Admin / Caches / Refresh
-
DMF 090201: Administrator / Setup / Server Administration Console
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
cache_type |
Cache type |
X |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Cache refreshed successfully |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.4. Endpoints
2.4.1. Create an endpoint
PUT |
/endpoints |
Description
Create an endpoint
DMF required:
-
DMF A30501: Api Admin / Endpoints / Insert
-
DMF 090201: Administrator / Setup / Server Administration Console
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
endpoint |
The endpoint to be created Endpoint |
X |
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Endpoint 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
{
"protocol" : "Lorem ipsum",
"default" : true,
"application" : "Lorem ipsum",
"port" : 1,
"xml" : true,
"name" : "Lorem ipsum",
"host" : "Lorem ipsum",
"mobile" : true,
"description" : "Lorem ipsum",
"active" : true,
"id" : "5000130"
}
2.4.2. Delete an endpoint
DELETE |
/endpoints/{endpoint_id} |
Description
Delete an endpoint
DMF required:
-
DMF A30503: Api Admin / Endpoints / Delete
-
DMF 090201: Administrator / Setup / Server Administration Console
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
endpoint_id |
The endpoint id |
X |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Endpoint 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.4.3. Export all endpoints as xml
GET |
/endpoints/export |
Description
Export all endpoints as xml
DMF required:
-
DMF A30510: Api Admin / Endpoints / Export
-
DMF 090201: Administrator / Setup / Server Administration Console
Content Type
-
application/xml; charset=UTF-8
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Endpoints successfully exported |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.4.4. Get default endpoint
GET |
/endpoints/default |
Description
Get default endpoint
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Default endpoint 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.4.5. List of all endpoints
GET |
/endpoints |
Description
List of all endpoints
DMF required:
-
DMF A30506: Api Admin / Endpoints / Get
-
DMF 090201: Administrator / Setup / Server Administration Console
Return Type
array[Endpoint]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Endpoints list retrieved |
List[Endpoint] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.4.6. Import new endpoints using an xml
POST |
/endpoints/import |
Description
Import new endpoints using an xml
DMF required:
-
DMF A30511: Api Admin / Endpoints / Import
-
DMF 090201: Administrator / Setup / Server Administration Console
Parameters
Form Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
xmlFile |
The file to upload. [file] |
X |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Endpoints successfully imported |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.4.7. Update an endpoint
POST |
/endpoints/{endpoint_id} |
Description
Update an endpoint
DMF required:
-
DMF A30502: Api Admin / Endpoints / Update
-
DMF 090201: Administrator / Setup / Server Administration Console
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
endpoint_id |
The endpoint id |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
endpoint |
The endpoint to be updated Endpoint |
X |
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Endpoint 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
{
"protocol" : "Lorem ipsum",
"default" : true,
"application" : "Lorem ipsum",
"port" : 1,
"xml" : true,
"name" : "Lorem ipsum",
"host" : "Lorem ipsum",
"mobile" : true,
"description" : "Lorem ipsum",
"active" : true,
"id" : "5000130"
}
2.5. Extended Logs
2.5.1. Get the user for which extended logs is activated (empty if none)
GET |
/server/extended-logs/configure |
Description
Get the user for which extended logs is activated (empty if none)
DMF required:
-
DMF A30110: Api Admin / Server / Logs
-
DMF 090201: Administrator / Setup / Server Administration Console
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
User for which extended logs is activated (empty if none) |
|
404 |
Requested resource could not be found |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to 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. Activate extended logs for a given user (or deactive if user is not specified)
POST |
/server/extended-logs/configure |
Description
Activate extended logs for a given user (or deactive if user is not specified)
DMF required:
-
DMF A30110: Api Admin / Server / Logs
-
DMF 090201: Administrator / Setup / Server Administration Console
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
user_code |
User code ExtendedLogConfig |
- |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Extended logs behavior changed successfully |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to 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
{
"userCode" : "ABC"
}
2.6. Features
2.6.1. Disable a feature
POST |
/features/{feature_id}/disable |
Description
Disable a feature
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
feature_id |
The feature id |
X |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Feature successfully disabled |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to 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. Enable a feature
POST |
/features/{feature_id}/enable |
Description
Enable a feature
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
feature_id |
The feature id |
X |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Feature successfully enabled |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.6.3. Get a feature
GET |
/features/{feature_id} |
Description
Get a feature
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
feature_id |
The feature id |
X |
null |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Feature retrieved successfully |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to 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. List of all features
GET |
/features |
Description
List of all features
Return Type
array[FeatureFlag]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Features list retrieved |
List[FeatureFlag] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.6.5. Search features
POST |
/features/search |
Description
Search features
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
FeatureCriteria |
Search criteria FeatureCriteria |
X |
Return Type
array[FeatureFlag]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Active features list retrieved |
List[FeatureFlag] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to 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
{
"active" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
}
}
2.7. Import Services
2.7.1. Get imports services status
GET |
/import-services |
Description
Get imports services status
DMF required:
-
DMF A30806: Api Admin / Import Services / Get
-
DMF 090201: Administrator / Setup / Server Administration Console
Return Type
array[ImportService]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
List of imports services |
List[ImportService] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.7.2. Kill running import service
POST |
/import-service/{service_name}/kill |
Description
Kill running import service
DMF required:
-
DMF A30803: Api Admin / Import Services / Delete
-
DMF 090201: Administrator / Setup / Server Administration Console
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
service_name |
Service name |
X |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Service successfully killed |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to 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. O Auth
2.8.1. Create an allowed client
PUT |
/oauthclients |
Description
Create an allowed client
DMF required:
-
DMF A30201: Api Admin / Oauth / Insert
-
DMF 090201: Administrator / Setup / Server Administration Console
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
oauthclient |
The client to be created OAuthClient |
X |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Allowed client 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
{
"validityPeriod" : 1,
"clientId" : "5000130",
"refreshPeriod" : 1,
"scope" : "password,refresh_token",
"clientSecret" : "Lorem ipsum",
"grantType" : "Lorem ipsum"
}
2.8.2. Delete an allowed client
DELETE |
/oauthclients/{oauthclient_id} |
Description
Delete an allowed client
DMF required:
-
DMF A30203: Api Admin / Oauth / Delete
-
DMF 090201: Administrator / Setup / Server Administration Console
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
oauthclient_id |
The client id |
X |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Allowed client 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.8.3. List of all allowed clients
GET |
/oauthclients |
Description
List of all allowed clients
DMF required:
-
DMF A30206: Api Admin / Oauth / Get
-
DMF 090201: Administrator / Setup / Server Administration Console
Return Type
array[OAuthClient]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Allowed clients list retrieved |
List[OAuthClient] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to 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.4. List of all tokens
GET |
/oauthclients/{oauthclient_id}/tokens |
Description
List of all tokens
DMF required:
-
DMF A30210: Api Admin / Oauth / Tokens
-
DMF 090201: Administrator / Setup / Server Administration Console
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
oauthclient_id |
The client id |
X |
null |
Return Type
array[OAuthToken]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Tokens list retrieved |
List[OAuthToken] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to 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.5. Update an allowed client
POST |
/oauthclients/{oauthclient_id} |
Description
Update an allowed client
DMF required:
-
DMF A30202: Api Admin / Oauth / Update
-
DMF 090201: Administrator / Setup / Server Administration Console
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
oauthclient_id |
The client id |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
oauthclient |
The client to be updated OAuthClient |
X |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Allowed client 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
{
"validityPeriod" : 1,
"clientId" : "5000130",
"refreshPeriod" : 1,
"scope" : "password,refresh_token",
"clientSecret" : "Lorem ipsum",
"grantType" : "Lorem ipsum"
}
2.10. Properties
2.10.1. List of all available property categories
GET |
/properties/categories |
Description
List of all available property categories
DMF required:
-
DMF A30306: Api Admin / Properties / Info
-
DMF 090201: Administrator / Setup / Server Administration Console
Return Type
array[PropertyCategory]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Property categories list |
List[PropertyCategory] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to 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.2. List of all available properties
GET |
/properties |
Description
List of all available properties
DMF required:
-
DMF A30306: Api Admin / Properties / Info
-
DMF 090201: Administrator / Setup / Server Administration Console
Return Type
array[Property]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Available properties retrieved |
List[Property] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to 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 property from key
GET |
/properties/{property_key} |
Description
Get property from key
DMF required:
-
DMF A30306: Api Admin / Properties / Info
-
DMF 090201: Administrator / Setup / Server Administration Console
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
property_key |
The property key |
X |
null |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Property retrieved successfully |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to 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. List of all available properties by group
GET |
/properties/categories/groups |
Description
List of all available properties by group
DMF required:
-
DMF A30306: Api Admin / Properties / Info
-
DMF 090201: Administrator / Setup / Server Administration Console
Parameters
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
group |
Name of group |
X |
null |
Return Type
array[PropertyCategoryType]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Available properties retrieved |
List[PropertyCategoryType] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to 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. List of all available property categories matching the expected types
POST |
/properties/categories/find |
Description
List of all available property categories matching the expected types
DMF required:
-
DMF A30304: Api Admin / Properties / Search
-
DMF 090201: Administrator / Setup / Server Administration Console
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
types |
Search types PropertyCategoryType |
- |
Return Type
array[PropertyCategory]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Search successfully ended |
List[PropertyCategory] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to 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
null
2.10.6. List of all available properties matching the expected category types
POST |
/properties/search |
Description
List of all available properties matching the expected category types
DMF required:
-
DMF A30304: Api Admin / Properties / Search
-
DMF 090201: Administrator / Setup / Server Administration Console
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
types |
Search types PropertyCategoryType |
- |
Return Type
array[Property]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Search successfully ended |
List[Property] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to 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
null
2.10.7. Test if the connection to the specified interface is up or down. If connection is down, an exception is thrown
GET |
/interfaces/{interface_type}/test |
Description
Test if the connection to the specified interface is up or down. If connection is down, an exception is thrown
DMF required:
-
DMF A30310: Api Admin / Properties / Test
-
DMF 090201: Administrator / Setup / Server Administration Console
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
interface_type |
Interface type |
X |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Interface is up |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.10.8. Update a property
POST |
/properties/{property_key} |
Description
Update a property
DMF required:
-
DMF A30302: Api Admin / Properties / Update
-
DMF 090201: Administrator / Setup / Server Administration Console
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
property_key |
The property key |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
value |
The value to be updated for property key [string] |
- |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Property updated successfully |
Map[[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
value_example
2.11. Sessions
2.11.1. Get all connected users
GET |
/sessions |
Description
Get all connected users
DMF required:
-
DMF A31006: Api Admin / Sessions / Get
-
DMF 090201: Administrator / Setup / Server Administration Console
Return Type
array[Session]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
List of all sessions |
List[Session] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to 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. Kill all sessions
DELETE |
/sessions |
Deprecated
|
Tip
|
Use new API /sessions/disconnect View |
Description
Kill all sessions
DMF required:
-
DMF A31003: Api Admin / Sessions / Delete
-
DMF 090201: Administrator / Setup / Server Administration Console
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
All sessions killed successfully |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.11.3. Disconnect user
DELETE |
/sessions/{user_name} |
Deprecated
|
Tip
|
Use new API /sessions/disconnect View |
Description
Disconnect user
DMF required:
-
DMF A31003: Api Admin / Sessions / Delete
-
DMF 090201: Administrator / Setup / Server Administration Console
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
user_name |
Username |
X |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
User disconnected successfully |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to 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.4. Disconnect user(s)
POST |
/sessions/disconnect |
Description
Disconnect user(s)
DMF required:
-
DMF A31003: Api Admin / Sessions / Delete
-
DMF 090201: Administrator / Setup / Server Administration Console
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
SessionParamHolder |
The available options for this operation SessionParamHolder |
X |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Session(s) killed successfully / User(s) disconnected |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to 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
{
"all" : true,
"username" : "admin"
}
2.11.5. Send message to sessions
POST |
/sessions/send-message |
Description
Send message to sessions
DMF required:
-
DMF A31010: Api Admin / Sessions / Send Message
-
DMF 090201: Administrator / Setup / Server Administration Console
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
message |
Send message to sessions AdminMessage |
- |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Message sent |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to 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
{
"type" : "MAIL",
"title" : "Lorem ipsum",
"body" : "Lorem ipsum"
}
2.12. Technical Events
2.12.1. Create a technical event
PUT |
/technical-events |
Description
Create a technical event
DMF required:
-
DMF A30701: Api Admin / Technical Events / Insert
-
DMF 090201: Administrator / Setup / Server Administration Console
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
technical-event |
The technical event to create TechnicalEvent |
- |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Technical event 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
{
"date" : "2020-01-23T04:56:07Z",
"companyCode" : "AK001",
"reason" : "Lorem ipsum",
"operationCode" : "5000130",
"module" : "Lorem ipsum",
"description" : "Lorem ipsum",
"id" : "5000130",
"objectId" : "5000130",
"operationLabel" : "Lorem ipsum",
"employeeCode" : "ABC",
"badHash" : true
}
2.12.2. Download technical events
POST |
/technical-events/download |
Description
Download technical events
DMF required:
-
DMF A30704: Api Admin / Technical Events / Search
-
DMF 090201: Administrator / Setup / Server Administration Console
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
criteria |
Search criteria TechnicalEventCriteria |
- |
Content Type
-
application/vnd.ms-excel
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Search ended successfully |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"companyCode" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"endDate" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
},
"operationCode" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"startDate" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
}
}
2.12.3. Get operations list
GET |
/technical-events/operations |
Description
Get operations list
DMF required:
-
DMF A30706: Api Admin / Technical Events / Get
-
DMF 090201: Administrator / Setup / Server Administration Console
Return Type
array[TechnicalOperation]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Search successfully ended |
List[TechnicalOperation] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to 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. Search technical events
POST |
/technical-events/search |
Description
Search technical events
DMF required:
-
DMF A30704: Api Admin / Technical Events / Search
-
DMF 090201: Administrator / Setup / Server Administration Console
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
criteria |
Search criteria TechnicalEventCriteria |
- |
Return Type
array[TechnicalEvent]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Search ended successfully |
List[TechnicalEvent] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"companyCode" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"endDate" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
},
"operationCode" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"startDate" : {
"operator" : "IS",
"value" : "2000-06-21T04:56:07.000+00:00",
"includeNullResults" : false,
"withTime" : false
}
}
2.13. Tools
2.13.1. Run a task on the server
POST |
/tools/commands/{command_type}/execute |
Description
Run a task on the server
DMF required:
-
DMF A30610: Api Admin / Tools / Execute Command
-
DMF 090201: Administrator / Setup / Server Administration Console
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
command_type |
Command type |
X |
null |
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
command_parameter |
Custom command parameter. Value depends on the command type (it can be ignored, optional or required). |
- |
null |
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Successful operation. Returns the command identifier |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.13.2. Get a running command and its state
GET |
/tools/commands/{command_id} |
Description
Get a running command and its state
DMF required:
-
DMF A30612: Api Admin / Tools / Get A Running Command
-
DMF 090201: Administrator / Setup / Server Administration Console
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
command_id |
The id of the command |
X |
null |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Running command retrieved successfully |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.13.3. Get all running commands and their states
GET |
/tools/commands |
Description
Get all running commands and their states
DMF required:
-
DMF A30611: Api Admin / Tools / Search Commands
-
DMF 090201: Administrator / Setup / Server Administration Console
Parameters
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
command_type |
Command type |
X |
null |
Return Type
array[Command]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
All running commands retrieved successfully |
List[Command] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.13.4. Retrieve last 10 sent emails
GET |
/tools/last-emails-delivery-information |
Description
This endpoint retrieves the delivery status of the last 10 sent emails, including information such as the sending status (success, failure, or pending), the sending date, recipients, email subject, and error codes in case of delivery issues.
DMF required:
-
DMF A30614: Api Admin / Tools / List Mails
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
List of emails |
List[EmailDeliveryInformation] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.13.5. Send mail in order to test mail service availability
POST |
/tools/send-mail |
Description
Send mail in order to test mail service availability
DMF required:
-
DMF A30613: Api Admin / Tools / Send Mail
-
DMF 090201: Administrator / Setup / Server Administration Console
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
Send mail in order to test mail service availability AdminMail |
- |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Mail send |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to 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
{
"recipient" : "Lorem ipsum",
"title" : "Lorem ipsum",
"body" : "Lorem ipsum"
}
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. 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.6. ActionCodeBase
Details about the action code
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
Id in database |
|||
name |
Name of the action code |
3.7. 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.8. 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.9. ActivityBase
Division
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Code of the activity |
|||
id |
Id in database |
|||
name |
Name of the activity |
3.10. 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.11. AdditionalFreeFieldsCriteria
Search criteria for additional free fields
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
additionalFreeField1 |
||||
additionalFreeField2 |
||||
additionalFreeField3 |
||||
additionalFreeField4 |
||||
additionalFreeField5 |
3.12. 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.14. AdminMail
The mail to send
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
body |
Mail body |
|||
recipient |
Mail recipient |
|||
title |
Mail title |
3.15. AdminMessage
Message to send
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
body |
Body of the admin message |
|||
title |
Title of the admin message |
|||
type |
Type of admin message |
Enum: MAIL, MAIL |
3.16. 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.19. 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.20. 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.21. 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.22. ApprovalState
State of the Approval
Type : enum (NONE, TO_REQUEST, TO_APPROVE, REFUSED, APPROVED)
3.23. 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.24. 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.25. 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.26. 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.27. 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.28. 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.29. 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.30. AssignmentSubType
Subtype of Assignment
Type : enum (PROJECT_GROUP, DEPARTMENT, ACTIVITY, CATEGORY, SUB_CATEGORY, SUB_CATEGORY_2, PROJECT_STATE, YEAR)
3.31. AssignmentType
Type of Assignment
Type : enum (COMPANY, DIVISION_GROUP, DIVISION, ENTITY, CUSTOMER, PROJECT, PHASE, SUBPHASE, PROJECT_TASK)
3.32. 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.33. Avatar
Entity avatar
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
content |
The base64-encoded binary content or URL of the entity's avatar image. |
3.34. 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.35. 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.36. 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.37. BackgroundTask
Background Task
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
active |
True if background task is active |
|||
counter |
Counter of the background task |
|||
delay |
Delay of the background task |
|||
errorCounter |
Error counter of the background task |
|||
id |
ID of the background task |
|||
interval |
Interval of the background task |
|||
lastError |
Date of the last error of the background task |
date-time |
||
lastErrorMessage |
Error message of the last error of the background task |
|||
lastExecution |
Last execution date of the background task |
date-time |
||
name |
Name of the background task |
3.38. 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.39. BankType
Type of the bank (nature de banque) for international bank detail
Type : enum (BIC, ABA, NOT_DEFINED)
3.40. 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.41. BankingInformationStatus
The status of the Banking Information
Type : enum (VALIDATED, TO_VALIDATE, REFUSED)
3.42. 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.43. BankingInformationSupplierType
Supplier type of banking information
Type : enum (ALL, INTERNAL, EXTERNAL, VIRTUAL)
3.44. BankingInformationType
List of banking information type
Type : enum (SEPA, INTERNATIONAL_BANK)
3.45. 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.46. 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.47. BatchParameter
Parameter used to manage batch operations
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
ids |
List of [string] |
Ids of the objects |
3.48. 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.49. 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.50. BillingMode
Billing mode of a product or sales line
Type : enum (TIME_BASED, FIXED_PRICE, RECURRENT, PRODUCTION_TO_BE_BILLED)
3.51. 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.52. 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.53. 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.54. BooleanParamHolder
Parameter value (Boolean).
See the documentation of the calling API body for further information
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
value |
Value |
3.55. 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.56. 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.57. CacheType
Cache type
Type : enum (LANGUAGES, APPLICATION_CONTROLS, SEARCH_RESULT_LIMITS, TRIGGERS, HIBERNATE_SEQUENCES, CQRS, FILL_MISSING_LIB_LANGUE)
3.58. 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.59. 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.60. 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.61. 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.62. 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.63. 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.64. 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.65. 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.66. CheckbookBase
Customer checkbook base
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
Id in database |
|||
name |
The name of the checkbook |
3.67. 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.68. ChorusServiceInformation
Chorus service information
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
serviceCode |
Code of Chorus service |
|||
serviceName |
Name of Chorus service |
3.69. 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.70. 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.71. 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.72. 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.73. 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.74. 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.75. 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.76. ColorCodes
ColorCodes
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
color1 |
First color code |
|||
color2 |
Second color code |
|||
color3 |
Third color code |
3.77. 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.78. CommandProgress
Command progress status
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
current |
Current index of the progress |
|||
max |
Max index of the progress |
3.79. 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.80. CompanyBase
Company
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Code of the company |
|||
id |
Id in database |
|||
name |
Name of a company |
3.81. ComparisonOperator
Comparison operator
Type : enum (BEFORE, AFTER, EQUAL, BEFORE_EQUAL, AFTER_EQUAL)
3.82. 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.83. 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.84. 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.85. 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.86. 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.87. 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.88. 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.89. 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.90. 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.91. 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.92. 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.93. 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.94. 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.96. 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.97. 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.98. 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.99. 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.100. 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.101. 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.102. CustomizableResources
Customizable resources (Ressources personnalisables)
Type : enum (ISSUE, OPPORTUNITY, OPPORTUNITY_LINE, CUSTOM_REQUEST, EVENT, PROJECT, PHASE, SUB_PHASE, EMPLOYEE, CUSTOMER, CONTACT, SALES, PURCHASE)
3.103. DatabaseInfo
Database info
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
akuiteoDriveActive |
True if the Akuiteo Driver is active |
|||
akuiteoDriverUsed |
True if the Akuiteo Driver is used |
|||
driver |
Driver of the database info |
|||
scriptDateMax |
ScriptDateMax database info |
|||
scriptMax |
ScriptMax database info |
|||
type |
Type of the database info |
|||
url |
Url of the database info |
|||
user |
Name of the user |
3.104. DateParamHolder
Date given in parameter
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
date |
Date |
date-time |
3.106. 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.107. 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.109. 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.110. 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.111. 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.112. 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.113. 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.114. 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.115. 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.116. DueDateCriteria
Criteria used to get more details about the due date
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
invoiceId |
Ident of the invoice |
3.117. 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.118. 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.119. 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.120. 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.121. ESignatureSignatoryType
Defines the type of signatory for electronic signatures.
A signatory can be either an employee or a contact.
Type : enum (CONTACT, EMPLOYEE)
3.122. ESignatureStatus
Electronic signature status of a management object
Type : enum (IN_PROGRESS, CANCELED, EXPIRED, SIGNED, FAILED, PENDING, SIGNATURE_REQUESTED)
3.123. 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.124. EmailDeliveryInformation
The mail to send
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
lastRetrySentDate |
Mail last retry send date |
date-time |
||
recipients |
List of [string] |
Mail recipients |
||
returnCode |
Mail sending return code |
|||
sender |
Mail sender |
|||
sentDate |
Mail send date |
date-time |
||
title |
Mail title |
3.125. 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.126. Endpoint
Server endpoint
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
active |
True if endpoint is active |
|||
application |
Name of the application of the endpoint |
|||
default |
True if default endpoint |
|||
description |
Description of the endpoint |
|||
host |
Host of the endpoint |
|||
id |
ID of the endpoint |
|||
mobile |
True if mobile endpoint |
|||
name |
Name of the endpoint |
|||
port |
Port of the endpoint |
|||
protocol |
Protocol of the endpoint |
|||
xml |
True if xml endpoint |
3.127. 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.128. 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.129. 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.130. 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.131. 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.132. 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.133. 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.134. ExtendedLogConfig
ExtendedLog Configuration
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
userCode |
The code of the user |
3.135. FeatureCriteria
Feature search criteria
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
active |
Set as true if feature is active |
3.136. 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.137. 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.138. FileCheck
File check
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
message |
Message of the file check |
|||
state |
State of the file check |
Enum: KO, OK, KO, OK |
3.139. 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.140. 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.141. 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.142. FixedAssetRecordSheetBase
Fixed asset record sheet
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
Id in database |
|||
name |
Name of fixed asset record sheet |
3.143. 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.145. 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.146. 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.147. 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.148. GeneralAccountBase
General account (ident example AKSAS22106800)
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
Id in database |
|||
name |
General account label |
3.149. GeneralAccountCommon
General account
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
Id in database |
|||
name |
General account label |
|||
number |
General account number |
3.150. 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.152. 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.153. 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.155. 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.156. Holiday
Holiday
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
date |
Date of the holiday |
date-time |
||
type |
Type of holiday |
3.157. 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.158. IdIdentifiable
Basic type for all pojos with an API ID
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
Id in database |
3.159. ImportService
Import service
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
name |
Name of the import service |
|||
running |
True if the import service is running |
3.160. InterfaceType
Interface type
Type : enum (TILKEE, OCR_MINDEE, EXCHANGE, CATCH_MAIL, LDAP, ELASTIC, ELECTRONIC_SIGNATURE, INTEGRATION_UNIVERSIGN, API_SIRENE, INTEGRATION_BRIDGE, WEBHOOK, GOOGLE_PLACE_AUTOCOMPLETE, GOOGLE_DISTANCE_MATRIX)
3.161. 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.162. 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.163. 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.164. 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.166. IssueBase
Issue base
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
Id in database |
3.167. 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.168. 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.169. 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.170. ItemBase
Item
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
Id in database |
3.171. 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.172. 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.173. 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.175. LinkDirectionEnum
A filation link type can be set with a link direction
Type : enum (ASCENDING, DESCENDING, TRANSVERSE, NOT_APPLICABLE)
3.176. 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.177. 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.178. LogExcerpt
Excerpt of a log file
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
data |
Data of the LogExcerpt |
|||
lastIndex |
Last index of the LogExcerpt |
int64 |
3.179. 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.180. 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.181. 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.182. 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.183. 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.184. 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.185. 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.186. 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.187. 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.188. 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.189. 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.190. 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.191. 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.192. 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.193. 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.194. MessageRecipientType
Message recipient type
Type : enum (USER, EMPLOYEE, CONTACT, TEAM, MAIL_ADDRESS)
3.195. 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.196. 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.197. OAuthClient
OAuth client
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
clientId |
ID of the client |
|||
clientSecret |
Secret key of the client |
|||
grantType |
Grant type of the OAuthClient |
|||
refreshPeriod |
The refresh period |
|||
scope |
OAuthClient scope |
|||
validityPeriod |
The validity period of the OAuthClient |
3.198. OAuthToken
An access token issued by the authorization server
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
expiration |
Expiration date of the token |
date-time |
||
expiresIn |
Integer related to the expiration date |
|||
scope |
Scope of the token |
|||
tokenType |
Type of the token |
|||
value |
The token value |
3.199. 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.200. OneShotProbeConfig
Configuration of an active OneShot probe
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
className |
Full class name being traced |
|||
methodName |
Complete method signature being traced |
|||
used |
Whether the probe has been consumed (used for tracing) |
3.201. OneShotProbeDeactivationResponse
Response after deactivating a OneShot probe
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
status |
Status of the probe deactivation |
Enum: deactivated, deactivated |
3.202. OneShotProbeRequest
Request to activate a OneShot probe for performance tracing
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
methodSignature |
X |
Complete AspectJ method signature to trace |
3.203. OneShotProbeResponse
Response after activating a OneShot probe
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
className |
Extracted class name from method signature |
|||
methodSignature |
Complete method signature that was activated |
|||
probeKey |
Unique key identifying the activated probe |
|||
status |
Status of the probe activation |
Enum: activated, activated |
3.204. 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.205. 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.206. 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.207. PackageLogsLevel
List of package names for a given debug level (DEBUG, INFO, WARN…)
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
level |
X |
Package logs level |
Enum: OFF, ERROR, WARN, INFO, DEBUG, TRACE, ALL, OFF, ERROR, WARN, INFO, DEBUG, TRACE, ALL |
|
packageNames |
X |
List of [string] |
Names of the packages |
|
status |
Status of the package |
3.208. 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.209. 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.210. 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.211. 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.212. 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.213. 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.214. 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.215. 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.216. PeopleLinkTypeEnum
A link can be set as a Management Link or a Filiation Link
Type : enum (MANAGEMENT_LINK, FILIATION_LINK)
3.217. 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.218. PeriodGranularity
Granularity of a period
Type : enum (YEAR, MONTH, DAY, HOUR, MINUTE, SECOND)
3.219. 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.221. 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.222. 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.223. PhaseStateCriteria
Criteria used on phase state when doing a phase state search
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
||||
companyId |
||||
id |
||||
name |
3.224. PipeBase
Pipe base
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Code of the pipe |
|||
id |
Id in database |
|||
name |
Name of the pipe |
3.225. PluginFeature
Plugin Feature
Type : enum (BRIDGE, CHORUS, EDOC, PRESTATIONS, UNIVERSIGN, API_GOOGLE, AKUITEO_SAAS)
3.226. 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.227. 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.228. PostponeType
Defines how the date postponement is handled
Type : enum (EXACT_DATE, SHIFT_BY_PERIOD, RESET_DATE)
3.229. 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.231. 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.232. 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.233. 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.234. 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.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. ProjectCustomerType
Type of relation with the customers
Type : enum (ALL_CUSTOMERS, MULTI_CUSTOMERS, SINGLE_CUSTOMER)
3.238. 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.239. 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. 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.242. 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.243. 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.244. 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.245. 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.247. Property
Property
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
actualValue |
Actual value of the property |
|||
allowedValues |
List of PropertyAllowedValue |
If not empty, contains the full list of allowed values for this property |
||
databaseValue |
Database value of the property |
|||
key |
Key of the property |
|||
name |
Name of the property |
|||
type |
Type of the property |
3.248. PropertyAllowedValue
Poperty allowed value
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
name |
Name of the property allowed value |
|||
value |
Value of the property allowed value |
3.249. PropertyCategory
Property category
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
name |
Name of the property category |
|||
type |
Example : GENERAL |
3.250. PropertyCategoryType
Property category type
Type : enum (GENERAL, TEMP_TABLES, I18N, BUSINESS_LAYER, UPGRADE, MAIL, CATCH_MAIL, CATCH_MAIL_MESSAGING, DIRECTORY, ELASTIC, EXCHANGE, HIBERNATE, PAGINATION, PAGINATION_DETAILS, PASSWORD, TILKEE, OCR_MINDEE, DEMAT_CHORUS, CHORUS_INTERFACE, ELECTRONIC_SIGNATURE, API_SIRENE, AKUITEO_CONNECT, WEBHOOK, PROXY_CONFIGURATION, BIRT, DAS2, GMAIL, GOOGLE_PLACE_AUTOCOMPLETE, GOOGLE_DISTANCE_MATRIX, GITHUB, FILE_CONTROL, BSOFT)
3.252. 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.253. 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.254. 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.255. 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.256. 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.257. PublishTemplateParameterType
Type of parameter.
Type : enum (TEXT_BOX, LIST_BOX, DATE_BOX, RADIO_BUTTON, CHECK_BOX, COMBO_BOX)
3.258. 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.259. 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.260. 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.261. 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.263. 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.264. 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.266. 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.267. 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.268. 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.269. 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.270. SearchFieldType
Type of search field
Type : enum (DROPDOWN_LIST, DATE, TEXT, BOOLEAN, NUMBER)
3.271. 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.272. 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.273. 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.274. ServerInfo
Server info
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
akJars |
List of [string] |
List of ak jars |
||
buildjdk |
Jdk build of the server |
|||
buildtime |
Build time of the server |
|||
categorieCertificat |
Certificat category |
|||
currentjdk |
Current jdk of the server |
|||
extJars |
List of [string] |
List of ext jars |
||
numeroCertificat |
Certificat number |
|||
serveursXml |
||||
version |
X |
Version of the server |
3.275. ServerStatus
Server status
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
external_url |
Example : www.example.com |
|||
info |
The server info |
|||
restricted |
Example : true |
|||
version |
X |
Example : 1 |
3.276. Service
Service
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Code of the service |
|||
id |
Id in database |
|||
name |
Name of the service |
3.277. Session
Session
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
Email attached to the session |
||||
firstName |
First name attached to the session |
|||
lastAction |
Last action of the session |
|||
lastName |
Last name attached to the session |
|||
loggedFrom |
Origin of the session log |
|||
remoteAdress |
Remote address attached to the session |
|||
userToken |
User token attached to the session |
|||
username |
Username attached to the session |
3.278. SessionParamHolder
The available options for disconnecting sessions
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
all |
If 'true' then all sessions will be disconnected and the username parameter ignored |
|||
username |
Username to be disconnected |
3.279. ShiftPeriod
Time unit for shifting the period.
Type : enum (YEAR, HALF_YEAR, QUARTER, MONTH, WEEK, DAY)
3.280. 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.281. 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.282. 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.283. 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.284. SortField
Couple field/sort type
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
fieldName |
Name of the field |
|||
order |
Sort type. (ASC or DESC) |
3.286. 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.288. 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.289. State
State bool
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
value |
The state value |
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. 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.302. 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.303. 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.304. SubledgerAccountBase
Subledger account (ident example AKSAS22106800)
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
Id in database |
|||
name |
Subledger account label |
3.305. SubledgerAccountCommon
Subledger account
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
Id in database |
|||
name |
Subledger account label |
|||
number |
Subledger account number |
3.306. 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.307. 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.308. 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.310. 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.311. 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.312. 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.313. 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.315. TaskBase
Task base
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
Id in database |
3.316. TaskBillingType
The list of value of billing type of the type of project task.
Type : enum (TIME_BASED, TIME_BASED_FIXED_PRICE_MONTHLY)
3.317. TaskCommon
Task common
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
Id in database |
|||
number |
The number of the task. |
int32 |
3.318. 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.319. TechnicalEvent
Technical event
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
badHash |
True if the hash is incorrect |
|||
companyCode |
Code of the company |
|||
date |
Date of the technical event |
date-time |
||
description |
Description of the technical event |
|||
employeeCode |
Code of the employee |
|||
id |
Id of the technical event |
|||
module |
Name of the module |
|||
objectId |
ID of the object |
|||
operationCode |
Code of the operation |
|||
operationLabel |
Label of the operation |
|||
reason |
Reason for this technical event |
3.320. TechnicalEventCriteria
Technical event criteria
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
companyCode |
Code of the company |
|||
endDate |
End date of the technical event |
|||
operationCode |
Code of the operation |
|||
startDate |
Start date of the technical event |
3.321. TechnicalOperation
Technical operation
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Code of the technical operation |
|||
label |
Label of the technical operation |
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. UnitDuration
Unit of duration
Type : enum (MINUTE, HOUR_MINUTE, HOUR_DECIMAL, DAY, UNIT_OF_EMPLOYEE, UNIT_OF_COMPANY)
3.334. UnitPrice
Unit price of an item
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
value |
Unit price of an item |
double |
3.335. 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.336. 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.337. 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.338. 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.339. 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.340. 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.341. VATBase
VAT
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
VAT code |
|||
id |
Id in database |
|||
rate |
VAT rate in percentage |
double |
3.342. 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.344. 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.345. 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:40:22
Copyright : Akuiteo © 2025