1. Introduction

The Approval process domain enables you to manage the different types of approvals available: quotes and quotations, sales and purchase orders, purchase invoices, expense reports, and others.

1.1. Licence information

https://www.akuiteo.com/mentions-legales

1.2. URI Scheme

BasePath : https://api.akuiteo.fr/akuiteo/rest/approvalprocess

1.3. Tags

  • Approvals : Approvals Management

  • Banking Informations : Banking Informations

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. Approvals

2.1.1. Approve

POST

/approvals/{approval_id}/approve
Description

Approve

DMF required:

  • DMF A50110: Api Approval Process / Approvals / Approve Or Refuse

  • DMF 061808: Projects / Approvals / Approve

  • DMF 061809: Projects / Approvals / Deny

  • DMF 061813: Projects / Approvals / Reset Approvals

  • DMF 190901: Web Portal / Approvals

Parameters
Path Parameters
Name Description Required Default Pattern

approval_id

The id of the Approval

X

null
Body Parameter
Name Description Required Default Pattern

comment

Comment [string]

-
Return Type

-

Responses
Table 1. http response codes
Code Message Datatype

204

Approbation approved

<<>>

400

Bad Request - Standard failure code. This code is used when no other specific code applies.

ErrorResponse

401

Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource.

ErrorResponse

402

Request Failed - The parameters were valid but the request failed.

ErrorResponse

403

Forbidden - The user does not have permissions to perform the request.

ErrorResponse

404

Not Found - The requested resource does not exist.

ErrorResponse

405

Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented.

ErrorResponse

406

Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request.

ErrorResponse

500

Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end.

ErrorResponse
Samples
Body parameter
Click to expand 

comment_example

2.1.2. Approve all

POST

/approvals/approve-all
Description

Approve all

DMF required:

  • DMF A50110: Api Approval Process / Approvals / Approve Or Refuse

  • DMF 061808: Projects / Approvals / Approve

  • DMF 061809: Projects / Approvals / Deny

  • DMF 061813: Projects / Approvals / Reset Approvals

  • DMF 190901: Web Portal / Approvals

Parameters
Body Parameter
Name Description Required Default Pattern

approvalIds

Approvals id list [string]

X
Query Parameters
Name Description Required Default Pattern

approval_comment

The comment of the Approval

-

null
Return Type

-

Responses
Table 2. http response codes
Code Message Datatype

204

Approbations approved

<<>>

400

Bad Request - Standard failure code. This code is used when no other specific code applies.

ErrorResponse

401

Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource.

ErrorResponse

402

Request Failed - The parameters were valid but the request failed.

ErrorResponse

403

Forbidden - The user does not have permissions to perform the request.

ErrorResponse

404

Not Found - The requested resource does not exist.

ErrorResponse

405

Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented.

ErrorResponse

406

Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request.

ErrorResponse

500

Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end.

ErrorResponse
Samples
Body parameter
Click to expand

2.1.3. Ask for approval for a management object.

POST

/approvals/{object_type}/{object_id}/ask
Description

Ask for approval for a management object.
If the status of the management object does not allow generating the approval, the approval request will be ignored.

DMF required:

  • DMF A50101: Api Approval Process / Approvals / Insert

  • DMF 061807: Projects / Approvals / Request

Parameters
Path Parameters
Name Description Required Default Pattern

object_type

The type of object (see ApprovalType)

X

null

object_id

The id of the object

X

null
Return Type

-

Responses
Table 3. http response codes
Code Message Datatype

204

Approval has been successfully requested

<<>>

400

Bad Request - Standard failure code. This code is used when no other specific code applies.

ErrorResponse

401

Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource.

ErrorResponse

402

Request Failed - The parameters were valid but the request failed.

ErrorResponse

403

Forbidden - The user does not have permissions to perform the request.

ErrorResponse

404

Not Found - The requested resource does not exist.

ErrorResponse

405

Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented.

ErrorResponse

406

Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request.

ErrorResponse

500

Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end.

ErrorResponse
Samples

2.1.4. Get an Approval

GET

/approvals/{approval_id}
Description

Get an Approval

DMF required:

  • DMF A50106: Api Approval Process / Approvals / Info

  • DMF 061803: Projects / Approvals / Show My Approvals Screen

  • DMF 190901: Web Portal / Approvals

  • DMF 191701: Web Portal / Employees Timesheets Validation / Access Time Review

Or

  • DMF A40511: Api Workforce / Time Recordings / Validate

  • DMF 060307: Projects / Timesheets / Validate

  • DMF 060309: Projects / Timesheets / Validate Timesheets Of Managed Resources

  • DMF 060310: Projects / Timesheets / Validate Timesheets For Managed Projects

  • DMF 060314: Projects / Timesheets / Validate Timesheets Of All Resources

  • DMF 060323: Projects / Timesheets / Global Validation Per Month

  • DMF 060357: Projects / Timesheets / Validate Timesheet Linked To Managed Project Phases

  • DMF 060361: Projects / Timesheets / Validate Non-completed Timesheets

  • DMF 1907__: Web Portal / Timesheets Validation

Parameters
Path Parameters
Name Description Required Default Pattern

approval_id

The id of the Approval

X

null
Return Type

Approval

Content Type

  • application/json

Responses
Table 4. http response codes
Code Message Datatype

200

Approval having this id

Approval

400

Bad Request - Standard failure code. This code is used when no other specific code applies.

ErrorResponse

401

Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource.

ErrorResponse

402

Request Failed - The parameters were valid but the request failed.

ErrorResponse

403

Forbidden - The user does not have permissions to perform the request.

ErrorResponse

404

Not Found - The requested resource does not exist.

ErrorResponse

405

Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented.

ErrorResponse

406

Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request.

ErrorResponse

500

Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end.

ErrorResponse
Samples

2.1.5. Read the list of the approvals for a management object

POST

/approvals/{object_type}/{object_id}/read
Description

Read the list of the approvals for a management object

DMF required:

  • DMF A50112: Api Approval Process / Approvals / Search Approvals Of An Object

  • DMF 0202__: Sales / Quotations

  • DMF 061803: Projects / Approvals / Show My Approvals Screen

  • DMF 061804: Projects / Approvals / My Approvals / Switch Resource

  • DMF 061811: Projects / Approvals / Delete Approval Requests

  • DMF 061812: Projects / Approvals / Modify Approved Object Without Reset

  • DMF 061813: Projects / Approvals / Reset Approvals

  • DMF 0203__: Sales / Sales Orders

  • DMF 0402__: Purchases / Quotes

  • DMF 0403__: Purchases / Purchase Orders

  • DMF 0406__: Purchases / Purchase Invoices

Parameters
Path Parameters
Name Description Required Default Pattern

object_type

The type of object (see ApprovalType)

X

null

object_id

The id of the object

X

null
Body Parameter
Name Description Required Default Pattern

readOption

The read options for returned approvals ApprovalReadOption

-
Return Type

array[Approval]

Content Type

  • application/json

Responses
Table 5. http response codes
Code Message Datatype

200

Approvals of the management object

List[Approval]

400

Bad Request - Standard failure code. This code is used when no other specific code applies.

ErrorResponse

401

Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource.

ErrorResponse

402

Request Failed - The parameters were valid but the request failed.

ErrorResponse

403

Forbidden - The user does not have permissions to perform the request.

ErrorResponse

404

Not Found - The requested resource does not exist.

ErrorResponse

405

Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented.

ErrorResponse

406

Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request.

ErrorResponse

500

Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end.

ErrorResponse
Samples
Body parameter
Click to expand 

{
  "options" : [ "OBJECT_SUMMARY", "OBJECT_SUMMARY" ]
}

2.1.6. Get a skeleton message of Approval

GET

/approvals/{approval_id}/skeleton-message
Description

Get a skeleton message of Approval

DMF required:

  • DMF A50106: Api Approval Process / Approvals / Info

  • DMF 061803: Projects / Approvals / Show My Approvals Screen

  • DMF 190901: Web Portal / Approvals

  • DMF 191701: Web Portal / Employees Timesheets Validation / Access Time Review

Or

  • DMF A40511: Api Workforce / Time Recordings / Validate

  • DMF 060307: Projects / Timesheets / Validate

  • DMF 060309: Projects / Timesheets / Validate Timesheets Of Managed Resources

  • DMF 060310: Projects / Timesheets / Validate Timesheets For Managed Projects

  • DMF 060314: Projects / Timesheets / Validate Timesheets Of All Resources

  • DMF 060323: Projects / Timesheets / Global Validation Per Month

  • DMF 060357: Projects / Timesheets / Validate Timesheet Linked To Managed Project Phases

  • DMF 060361: Projects / Timesheets / Validate Non-completed Timesheets

  • DMF 1907__: Web Portal / Timesheets Validation

Parameters
Path Parameters
Name Description Required Default Pattern

approval_id

The id of the Approval

X

null
Return Type

Message

Content Type

  • application/json

Responses
Table 6. http response codes
Code Message Datatype

200

Skeleton message of Approval having this id

Message

400

Bad Request - Standard failure code. This code is used when no other specific code applies.

ErrorResponse

401

Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource.

ErrorResponse

402

Request Failed - The parameters were valid but the request failed.

ErrorResponse

403

Forbidden - The user does not have permissions to perform the request.

ErrorResponse

404

Not Found - The requested resource does not exist.

ErrorResponse

405

Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented.

ErrorResponse

406

Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request.

ErrorResponse

500

Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end.

ErrorResponse
Samples

2.1.7. Refuse

POST

/approvals/{approval_id}/refuse
Description

Refuse

DMF required:

  • DMF A50110: Api Approval Process / Approvals / Approve Or Refuse

  • DMF 061808: Projects / Approvals / Approve

  • DMF 061809: Projects / Approvals / Deny

  • DMF 061813: Projects / Approvals / Reset Approvals

  • DMF 190901: Web Portal / Approvals

Parameters
Path Parameters
Name Description Required Default Pattern

approval_id

The id of the Approval

X

null
Body Parameter
Name Description Required Default Pattern

comment

Comment [string]

-
Return Type

-

Responses
Table 7. http response codes
Code Message Datatype

204

Approbation refused

<<>>

400

Bad Request - Standard failure code. This code is used when no other specific code applies.

ErrorResponse

401

Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource.

ErrorResponse

402

Request Failed - The parameters were valid but the request failed.

ErrorResponse

403

Forbidden - The user does not have permissions to perform the request.

ErrorResponse

404

Not Found - The requested resource does not exist.

ErrorResponse

405

Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented.

ErrorResponse

406

Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request.

ErrorResponse

500

Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end.

ErrorResponse
Samples
Body parameter
Click to expand 

comment_example

2.1.8. Refuse all

POST

/approvals/refuse-all
Description

Refuse all

DMF required:

  • DMF A50110: Api Approval Process / Approvals / Approve Or Refuse

  • DMF 061808: Projects / Approvals / Approve

  • DMF 061809: Projects / Approvals / Deny

  • DMF 061813: Projects / Approvals / Reset Approvals

  • DMF 190901: Web Portal / Approvals

Parameters
Body Parameter
Name Description Required Default Pattern

approvalIds

Approvals id list [string]

X
Query Parameters
Name Description Required Default Pattern

approval_comment

The comment of the Approval

-

null
Return Type

-

Responses
Table 8. http response codes
Code Message Datatype

204

Approbations refused

<<>>

400

Bad Request - Standard failure code. This code is used when no other specific code applies.

ErrorResponse

401

Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource.

ErrorResponse

402

Request Failed - The parameters were valid but the request failed.

ErrorResponse

403

Forbidden - The user does not have permissions to perform the request.

ErrorResponse

404

Not Found - The requested resource does not exist.

ErrorResponse

405

Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented.

ErrorResponse

406

Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request.

ErrorResponse

500

Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end.

ErrorResponse
Samples
Body parameter
Click to expand

2.1.9. Reset the approbation

GET

/approvals/{approval_id}/reset
Description

Reset the approbation

DMF required:

  • DMF A50111: Api Approval Process / Approvals / Reset

  • DMF 061810: Projects / Approvals / Cancel

  • DMF 061813: Projects / Approvals / Reset Approvals

  • DMF 190901: Web Portal / Approvals

Parameters
Path Parameters
Name Description Required Default Pattern

approval_id

The id of the Approval

X

null
Return Type

[String]

Content Type

  • text/plain

Responses
Table 9. http response codes
Code Message Datatype

200

Approbation successfully reset

[String]

400

Bad Request - Standard failure code. This code is used when no other specific code applies.

ErrorResponse

401

Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource.

ErrorResponse

402

Request Failed - The parameters were valid but the request failed.

ErrorResponse

403

Forbidden - The user does not have permissions to perform the request.

ErrorResponse

404

Not Found - The requested resource does not exist.

ErrorResponse

405

Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented.

ErrorResponse

406

Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request.

ErrorResponse

500

Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end.

ErrorResponse
Samples

2.1.10. Resets approvals for a management object and triggers new approval requests on that management object.

POST

/approvals/{object_type}/{object_id}/reset
Description

Resets approvals for a management object and triggers new approval requests on that management object.
This API clears the current approval requests on the management object and initiates a fresh approval process based on the applicable rules.

DMF required:

  • DMF A50111: Api Approval Process / Approvals / Reset

  • DMF 061810: Projects / Approvals / Cancel

  • DMF 061813: Projects / Approvals / Reset Approvals

  • DMF 190901: Web Portal / Approvals

Parameters
Path Parameters
Name Description Required Default Pattern

object_type

The type of object (see ApprovalType)

X

null

object_id

The id of the object

X

null
Return Type

-

Responses
Table 10. http response codes
Code Message Datatype

204

The new approval requests have been successfully reset

<<>>

400

Bad Request - Standard failure code. This code is used when no other specific code applies.

ErrorResponse

401

Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource.

ErrorResponse

402

Request Failed - The parameters were valid but the request failed.

ErrorResponse

403

Forbidden - The user does not have permissions to perform the request.

ErrorResponse

404

Not Found - The requested resource does not exist.

ErrorResponse

405

Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented.

ErrorResponse

406

Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request.

ErrorResponse

500

Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end.

ErrorResponse
Samples

POST

/approvals/search
Description

Get the list of the approvals meeting the search criteria

DMF required:

  • DMF A50104: Api Approval Process / Approvals / Search

  • DMF 061803: Projects / Approvals / Show My Approvals Screen

  • DMF 061804: Projects / Approvals / My Approvals / Switch Resource

  • DMF 1508__: Dashboards / Approvals

  • DMF 190901: Web Portal / Approvals

  • DMF 1911__: Web Portal / Custom Requests

Parameters
Body Parameter
Name Description Required Default Pattern

criteria

The search criteria ApprovalCriteria

-
Return Type

array[Approval]

Content Type

  • application/json

Responses
Table 11. http response codes
Code Message Datatype

200

Approvals meeting the search criteria

List[Approval]

400

Bad Request - Standard failure code. This code is used when no other specific code applies.

ErrorResponse

401

Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource.

ErrorResponse

402

Request Failed - The parameters were valid but the request failed.

ErrorResponse

403

Forbidden - The user does not have permissions to perform the request.

ErrorResponse

404

Not Found - The requested resource does not exist.

ErrorResponse

405

Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented.

ErrorResponse

406

Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request.

ErrorResponse

500

Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end.

ErrorResponse
Samples
Body parameter
Click to expand 

{
  "requesterId" : {
    "operator" : "IS",
    "value" : "Abcd",
    "includeNullResults" : false,
    "wildcards" : "*"
  },
  "approvalDate" : {
    "operator" : "IS",
    "value" : "2000-06-21T04:56:07.000+00:00",
    "includeNullResults" : false,
    "withTime" : false
  },
  "level" : {
    "operator" : "IS",
    "value" : "Abcd",
    "includeNullResults" : false,
    "wildcards" : "*"
  },
  "approverId" : {
    "operator" : "IS",
    "value" : "Abcd",
    "includeNullResults" : false,
    "wildcards" : "*"
  },
  "approvalSummaryCriteria" : {
    "archived" : {
      "operator" : "IS",
      "value" : false,
      "includeNullResults" : false
    },
    "objectDate" : {
      "operator" : "IS",
      "value" : "2000-06-21T04:56:07.000+00:00",
      "includeNullResults" : false,
      "withTime" : false
    },
    "supplierId" : {
      "operator" : "IS",
      "value" : "Abcd",
      "includeNullResults" : false,
      "wildcards" : "*"
    },
    "multiCompany" : {
      "operator" : "IS",
      "value" : false,
      "includeNullResults" : false
    },
    "customRequestId" : {
      "operator" : "IS",
      "value" : "Abcd",
      "includeNullResults" : false,
      "wildcards" : "*"
    },
    "customerId" : {
      "operator" : "IS",
      "value" : "Abcd",
      "includeNullResults" : false,
      "wildcards" : "*"
    }
  },
  "approvalApproverCriteria" : {
    "employeeEntityId" : {
      "operator" : "IS",
      "value" : "Abcd",
      "includeNullResults" : false,
      "wildcards" : "*"
    },
    "employeeDivisionId" : {
      "operator" : "IS",
      "value" : "Abcd",
      "includeNullResults" : false,
      "wildcards" : "*"
    },
    "managerId" : {
      "operator" : "IS",
      "value" : "Abcd",
      "includeNullResults" : false,
      "wildcards" : "*"
    },
    "serviceId" : {
      "operator" : "IS",
      "value" : "Abcd",
      "includeNullResults" : false,
      "wildcards" : "*"
    }
  },
  "objectType" : {
    "operator" : "IS",
    "value" : "Abcd",
    "includeNullResults" : false,
    "wildcards" : "*"
  },
  "states" : {
    "operator" : "IS",
    "value" : "Abcd",
    "includeNullResults" : false,
    "wildcards" : "*"
  },
  "readOption" : {
    "options" : [ "OBJECT_SUMMARY", "OBJECT_SUMMARY" ]
  },
  "approvalProjectCriteria" : {
    "internalProject" : {
      "operator" : "IS",
      "value" : false,
      "includeNullResults" : false
    },
    "projectGroupCode" : {
      "operator" : "IS",
      "value" : "Abcd",
      "includeNullResults" : false,
      "wildcards" : "*"
    },
    "entityId" : {
      "operator" : "IS",
      "value" : "Abcd",
      "includeNullResults" : false,
      "wildcards" : "*"
    },
    "divisionId" : {
      "operator" : "IS",
      "value" : "Abcd",
      "includeNullResults" : false,
      "wildcards" : "*"
    },
    "projectId" : {
      "operator" : "IS",
      "value" : "Abcd",
      "includeNullResults" : false,
      "wildcards" : "*"
    }
  },
  "requestDate" : {
    "operator" : "IS",
    "value" : "2000-06-21T04:56:07.000+00:00",
    "includeNullResults" : false,
    "withTime" : false
  },
  "comment" : {
    "operator" : "IS",
    "value" : "Abcd",
    "includeNullResults" : false,
    "wildcards" : "*"
  },
  "id" : {
    "operator" : "IS",
    "value" : "Abcd",
    "includeNullResults" : false,
    "wildcards" : "*"
  },
  "objectId" : {
    "operator" : "IS",
    "value" : "Abcd",
    "includeNullResults" : false,
    "wildcards" : "*"
  }
}

2.1.12. Search for search field behavior for the approvals

GET

/approvals/search-fields-information
Deprecated
Tip
 This API will soon be removed as it is no longer functional.
No data will be returned when using it.
Description

Get the list of search field behavior for approvals

DMF required:

  • DMF A50104: Api Approval Process / Approvals / Search

  • DMF 061803: Projects / Approvals / Show My Approvals Screen

  • DMF 061804: Projects / Approvals / My Approvals / Switch Resource

  • DMF 1508__: Dashboards / Approvals

  • DMF 190901: Web Portal / Approvals

  • DMF 1911__: Web Portal / Custom Requests

Or

  • DMF A50113: Api Approval Process / Approvals / Search My Approvals

  • DMF 061803: Projects / Approvals / Show My Approvals Screen

  • DMF 190901: Web Portal / Approvals

Parameters
Return Type

array[SearchControlBehavior]

Content Type

  • application/json

Responses
Table 12. http response codes
Code Message Datatype

200

Search field behavior results

List[SearchControlBehavior]

400

Bad Request - Standard failure code. This code is used when no other specific code applies.

ErrorResponse

401

Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource.

ErrorResponse

402

Request Failed - The parameters were valid but the request failed.

ErrorResponse

403

Forbidden - The user does not have permissions to perform the request.

ErrorResponse

404

Not Found - The requested resource does not exist.

ErrorResponse

405

Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented.

ErrorResponse

406

Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request.

ErrorResponse

500

Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end.

ErrorResponse
Samples

2.1.13. Get the list of the approvals I have a delegation for matching the search criteria

POST

/approvals/approvers/{approver_id}/search
Description

Get the list of the approvals I have a delegation for matching the search criteria

DMF required:

  • DMF A50114: Api Approval Process / Approvals / Search Approvals Of An Approver

  • DMF 061804: Projects / Approvals / My Approvals / Switch Resource

  • DMF 190901: Web Portal / Approvals

Parameters
Path Parameters
Name Description Required Default Pattern

approver_id

The id of the approver

X

null
Body Parameter
Name Description Required Default Pattern

criteria

The search criteria ApprovalCriteria

-
Return Type

array[Approval]

Content Type

  • application/json

Responses
Table 13. http response codes
Code Message Datatype

200

Approvals meeting the search criteria

List[Approval]

400

Bad Request - Standard failure code. This code is used when no other specific code applies.

ErrorResponse

401

Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource.

ErrorResponse

402

Request Failed - The parameters were valid but the request failed.

ErrorResponse

403

Forbidden - The user does not have permissions to perform the request.

ErrorResponse

404

Not Found - The requested resource does not exist.

ErrorResponse

405

Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented.

ErrorResponse

406

Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request.

ErrorResponse

500

Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end.

ErrorResponse
Samples
Body parameter
Click to expand 

{
  "requesterId" : {
    "operator" : "IS",
    "value" : "Abcd",
    "includeNullResults" : false,
    "wildcards" : "*"
  },
  "approvalDate" : {
    "operator" : "IS",
    "value" : "2000-06-21T04:56:07.000+00:00",
    "includeNullResults" : false,
    "withTime" : false
  },
  "level" : {
    "operator" : "IS",
    "value" : "Abcd",
    "includeNullResults" : false,
    "wildcards" : "*"
  },
  "approverId" : {
    "operator" : "IS",
    "value" : "Abcd",
    "includeNullResults" : false,
    "wildcards" : "*"
  },
  "approvalSummaryCriteria" : {
    "archived" : {
      "operator" : "IS",
      "value" : false,
      "includeNullResults" : false
    },
    "objectDate" : {
      "operator" : "IS",
      "value" : "2000-06-21T04:56:07.000+00:00",
      "includeNullResults" : false,
      "withTime" : false
    },
    "supplierId" : {
      "operator" : "IS",
      "value" : "Abcd",
      "includeNullResults" : false,
      "wildcards" : "*"
    },
    "multiCompany" : {
      "operator" : "IS",
      "value" : false,
      "includeNullResults" : false
    },
    "customRequestId" : {
      "operator" : "IS",
      "value" : "Abcd",
      "includeNullResults" : false,
      "wildcards" : "*"
    },
    "customerId" : {
      "operator" : "IS",
      "value" : "Abcd",
      "includeNullResults" : false,
      "wildcards" : "*"
    }
  },
  "approvalApproverCriteria" : {
    "employeeEntityId" : {
      "operator" : "IS",
      "value" : "Abcd",
      "includeNullResults" : false,
      "wildcards" : "*"
    },
    "employeeDivisionId" : {
      "operator" : "IS",
      "value" : "Abcd",
      "includeNullResults" : false,
      "wildcards" : "*"
    },
    "managerId" : {
      "operator" : "IS",
      "value" : "Abcd",
      "includeNullResults" : false,
      "wildcards" : "*"
    },
    "serviceId" : {
      "operator" : "IS",
      "value" : "Abcd",
      "includeNullResults" : false,
      "wildcards" : "*"
    }
  },
  "objectType" : {
    "operator" : "IS",
    "value" : "Abcd",
    "includeNullResults" : false,
    "wildcards" : "*"
  },
  "states" : {
    "operator" : "IS",
    "value" : "Abcd",
    "includeNullResults" : false,
    "wildcards" : "*"
  },
  "readOption" : {
    "options" : [ "OBJECT_SUMMARY", "OBJECT_SUMMARY" ]
  },
  "approvalProjectCriteria" : {
    "internalProject" : {
      "operator" : "IS",
      "value" : false,
      "includeNullResults" : false
    },
    "projectGroupCode" : {
      "operator" : "IS",
      "value" : "Abcd",
      "includeNullResults" : false,
      "wildcards" : "*"
    },
    "entityId" : {
      "operator" : "IS",
      "value" : "Abcd",
      "includeNullResults" : false,
      "wildcards" : "*"
    },
    "divisionId" : {
      "operator" : "IS",
      "value" : "Abcd",
      "includeNullResults" : false,
      "wildcards" : "*"
    },
    "projectId" : {
      "operator" : "IS",
      "value" : "Abcd",
      "includeNullResults" : false,
      "wildcards" : "*"
    }
  },
  "requestDate" : {
    "operator" : "IS",
    "value" : "2000-06-21T04:56:07.000+00:00",
    "includeNullResults" : false,
    "withTime" : false
  },
  "comment" : {
    "operator" : "IS",
    "value" : "Abcd",
    "includeNullResults" : false,
    "wildcards" : "*"
  },
  "id" : {
    "operator" : "IS",
    "value" : "Abcd",
    "includeNullResults" : false,
    "wildcards" : "*"
  },
  "objectId" : {
    "operator" : "IS",
    "value" : "Abcd",
    "includeNullResults" : false,
    "wildcards" : "*"
  }
}

2.1.14. Get the list of my approvals matching the search criteria

POST

/approvals/mine/search
Description

Get the list of my approvals matching the search criteria

DMF required:

  • DMF A50113: Api Approval Process / Approvals / Search My Approvals

  • DMF 061803: Projects / Approvals / Show My Approvals Screen

  • DMF 190901: Web Portal / Approvals

Parameters
Body Parameter
Name Description Required Default Pattern

criteria

The search criteria ApprovalCriteria

-
Return Type

array[Approval]

Content Type

  • application/json

Responses
Table 14. http response codes
Code Message Datatype

200

Approvals meeting the search criteria

List[Approval]

400

Bad Request - Standard failure code. This code is used when no other specific code applies.

ErrorResponse

401

Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource.

ErrorResponse

402

Request Failed - The parameters were valid but the request failed.

ErrorResponse

403

Forbidden - The user does not have permissions to perform the request.

ErrorResponse

404

Not Found - The requested resource does not exist.

ErrorResponse

405

Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented.

ErrorResponse

406

Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request.

ErrorResponse

500

Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end.

ErrorResponse
Samples
Body parameter
Click to expand 

{
  "requesterId" : {
    "operator" : "IS",
    "value" : "Abcd",
    "includeNullResults" : false,
    "wildcards" : "*"
  },
  "approvalDate" : {
    "operator" : "IS",
    "value" : "2000-06-21T04:56:07.000+00:00",
    "includeNullResults" : false,
    "withTime" : false
  },
  "level" : {
    "operator" : "IS",
    "value" : "Abcd",
    "includeNullResults" : false,
    "wildcards" : "*"
  },
  "approverId" : {
    "operator" : "IS",
    "value" : "Abcd",
    "includeNullResults" : false,
    "wildcards" : "*"
  },
  "approvalSummaryCriteria" : {
    "archived" : {
      "operator" : "IS",
      "value" : false,
      "includeNullResults" : false
    },
    "objectDate" : {
      "operator" : "IS",
      "value" : "2000-06-21T04:56:07.000+00:00",
      "includeNullResults" : false,
      "withTime" : false
    },
    "supplierId" : {
      "operator" : "IS",
      "value" : "Abcd",
      "includeNullResults" : false,
      "wildcards" : "*"
    },
    "multiCompany" : {
      "operator" : "IS",
      "value" : false,
      "includeNullResults" : false
    },
    "customRequestId" : {
      "operator" : "IS",
      "value" : "Abcd",
      "includeNullResults" : false,
      "wildcards" : "*"
    },
    "customerId" : {
      "operator" : "IS",
      "value" : "Abcd",
      "includeNullResults" : false,
      "wildcards" : "*"
    }
  },
  "approvalApproverCriteria" : {
    "employeeEntityId" : {
      "operator" : "IS",
      "value" : "Abcd",
      "includeNullResults" : false,
      "wildcards" : "*"
    },
    "employeeDivisionId" : {
      "operator" : "IS",
      "value" : "Abcd",
      "includeNullResults" : false,
      "wildcards" : "*"
    },
    "managerId" : {
      "operator" : "IS",
      "value" : "Abcd",
      "includeNullResults" : false,
      "wildcards" : "*"
    },
    "serviceId" : {
      "operator" : "IS",
      "value" : "Abcd",
      "includeNullResults" : false,
      "wildcards" : "*"
    }
  },
  "objectType" : {
    "operator" : "IS",
    "value" : "Abcd",
    "includeNullResults" : false,
    "wildcards" : "*"
  },
  "states" : {
    "operator" : "IS",
    "value" : "Abcd",
    "includeNullResults" : false,
    "wildcards" : "*"
  },
  "readOption" : {
    "options" : [ "OBJECT_SUMMARY", "OBJECT_SUMMARY" ]
  },
  "approvalProjectCriteria" : {
    "internalProject" : {
      "operator" : "IS",
      "value" : false,
      "includeNullResults" : false
    },
    "projectGroupCode" : {
      "operator" : "IS",
      "value" : "Abcd",
      "includeNullResults" : false,
      "wildcards" : "*"
    },
    "entityId" : {
      "operator" : "IS",
      "value" : "Abcd",
      "includeNullResults" : false,
      "wildcards" : "*"
    },
    "divisionId" : {
      "operator" : "IS",
      "value" : "Abcd",
      "includeNullResults" : false,
      "wildcards" : "*"
    },
    "projectId" : {
      "operator" : "IS",
      "value" : "Abcd",
      "includeNullResults" : false,
      "wildcards" : "*"
    }
  },
  "requestDate" : {
    "operator" : "IS",
    "value" : "2000-06-21T04:56:07.000+00:00",
    "includeNullResults" : false,
    "withTime" : false
  },
  "comment" : {
    "operator" : "IS",
    "value" : "Abcd",
    "includeNullResults" : false,
    "wildcards" : "*"
  },
  "id" : {
    "operator" : "IS",
    "value" : "Abcd",
    "includeNullResults" : false,
    "wildcards" : "*"
  },
  "objectId" : {
    "operator" : "IS",
    "value" : "Abcd",
    "includeNullResults" : false,
    "wildcards" : "*"
  }
}

2.2. Banking Informations

2.2.1. Change the status of banking informations matching the specified ID.

POST

/validations/banking-informations/{banking_information_id}/change-status
Description

Change the status of banking informations matching the specified ID.

DMF required:

  • DMF A50211: Api Approval Process / Banking Information / Remove Validation

  • DMF 192301: Web Portal / Bank Details / Search

  • DMF 192302: Web Portal / Bank Details / Validate All

Parameters
Path Parameters
Name Description Required Default Pattern

banking_information_id

The id of the banking informations

X

null
Body Parameter
Name Description Required Default Pattern

status

The status for the banking informations. Set 'TO_VALIDATE' , to remove validation of bank details.the banking informations. Set 'VALIDATED' , to validate the banking informations. Set 'REFUSED' , to refuse the banking informations. BankingInformationStatusParamHolder

-
Return Type

[String]

Content Type

  • text/plain

Responses
Table 15. http response codes
Code Message Datatype

200

The status of the banking informations has been successfully updated.

[String]

400

Bad Request - Standard failure code. This code is used when no other specific code applies.

ErrorResponse

401

Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource.

ErrorResponse

402

Request Failed - The parameters were valid but the request failed.

ErrorResponse

403

Forbidden - The user does not have permissions to perform the request.

ErrorResponse

404

Not Found - The requested resource does not exist.

ErrorResponse

405

Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented.

ErrorResponse

406

Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request.

ErrorResponse

500

Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end.

ErrorResponse
Samples
Body parameter
Click to expand 

{
  "comment" : "Comment"
}

2.2.2. Get a skeleton message of Banking Information

GET

/validations/banking-informations/{banking_information_id}/skeleton-message
Description

Get a skeleton message of Banking Information

DMF required:

  • DMF A50212: Api Approval Process / Banking Information / Validate

  • DMF 040139: Purchases / Suppliers / Print Bank Details

  • DMF 192303: Web Portal / Bank Details / Send Email Requester

Parameters
Path Parameters
Name Description Required Default Pattern

banking_information_id

The id of the banking informations

X

null
Return Type

Message

Content Type

  • application/json

Responses
Table 16. http response codes
Code Message Datatype

200

Skeleton message of Banking Information having this id

Message

400

Bad Request - Standard failure code. This code is used when no other specific code applies.

ErrorResponse

401

Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource.

ErrorResponse

402

Request Failed - The parameters were valid but the request failed.

ErrorResponse

403

Forbidden - The user does not have permissions to perform the request.

ErrorResponse

404

Not Found - The requested resource does not exist.

ErrorResponse

405

Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented.

ErrorResponse

406

Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request.

ErrorResponse

500

Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end.

ErrorResponse
Samples

2.2.3. Publish a banking information

POST

/validations/banking-informations/{banking_information_id}/publish
Description

Publish a banking information using the template given as parameter

DMF required:

  • DMF A50204: Api Approval Process / Banking Information / Search

  • DMF 040139: Purchases / Suppliers / Print Bank Details

  • DMF 192302: Web Portal / Bank Details / Validate All

Parameters
Path Parameters
Name Description Required Default Pattern

banking_information_id

The id of the banking informations

X

null
Body Parameter
Name Description Required Default Pattern

publish_arguments

The arguments for publishing banking information PublishArguments

X
Return Type

PublishedDocument

Content Type

  • application/json

Responses
Table 17. http response codes
Code Message Datatype

200

Published document

PublishedDocument

400

Bad Request - Standard failure code. This code is used when no other specific code applies.

ErrorResponse

401

Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource.

ErrorResponse

402

Request Failed - The parameters were valid but the request failed.

ErrorResponse

403

Forbidden - The user does not have permissions to perform the request.

ErrorResponse

404

Not Found - The requested resource does not exist.

ErrorResponse

405

Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented.

ErrorResponse

406

Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request.

ErrorResponse

500

Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end.

ErrorResponse
Samples
Body parameter
Click to expand 

{
  "template" : {
    "id" : "5000123",
    "code" : "MODELE_EDITION_001",
    "name" : "Edition model for my documents",
    "type" : {
      "code" : "TEMP01",
      "name" : "Template one",
      "modelId" : "5000123",
      "modelDescription" : "Lorem Ipsum"
    },
    "publishType" : "{}",
    "path" : "C://MyDoc/Template/modele_edition_001",
    "endDate" : "2000-06-21T04:56:07.000+00:00",
    "extensions" : ".pdf, .docx",
    "defaultTemplate" : true,
    "interactive" : true,
    "order" : 1
  },
  "extension" : ".pdf",
  "parameters" : [ {
    "groupName" : "text_box",
    "labelText" : "Detail BL",
    "pattern" : "cl",
    "nameField" : "DetailBL",
    "selectionList" : [ {
      "label" : "Bank transfer",
      "value" : "BT"
    }, {
      "label" : "Bank transfer",
      "value" : "BT"
    } ],
    "nameFieldNext" : "DetailCheckbox",
    "value" : "checked",
    "required" : true
  }, {
    "groupName" : "text_box",
    "labelText" : "Detail BL",
    "pattern" : "cl",
    "nameField" : "DetailBL",
    "selectionList" : [ {
      "label" : "Bank transfer",
      "value" : "BT"
    }, {
      "label" : "Bank transfer",
      "value" : "BT"
    } ],
    "nameFieldNext" : "DetailCheckbox",
    "value" : "checked",
    "required" : true
  } ],
  "saveDocument" : true
}

2.2.4. Search for banking informations.

POST

/validations/banking-informations/search
Description

Search for banking informations.

DMF required:

  • DMF A50204: Api Approval Process / Banking Information / Search

  • DMF 040139: Purchases / Suppliers / Print Bank Details

  • DMF 192302: Web Portal / Bank Details / Validate All

Parameters
Body Parameter
Name Description Required Default Pattern

criteria

Criteria that you choose (id, company, etc…) BankingInformationCriteria

X
Query Parameters
Name Description Required Default Pattern

offset

The index of first element

-

null

limit

The max number of elements

-

null
Return Type

array[BankingInformationValidation]

Content Type

  • application/json

Responses
Table 18. http response codes
Code Message Datatype

200

Banking informations loaded

List[BankingInformationValidation]

400

Bad Request - Standard failure code. This code is used when no other specific code applies.

ErrorResponse

401

Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource.

ErrorResponse

402

Request Failed - The parameters were valid but the request failed.

ErrorResponse

403

Forbidden - The user does not have permissions to perform the request.

ErrorResponse

404

Not Found - The requested resource does not exist.

ErrorResponse

405

Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented.

ErrorResponse

406

Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request.

ErrorResponse

500

Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end.

ErrorResponse
Samples
Body parameter
Click to expand 

{
  "concernedObjectType" : {
    "operator" : "IS",
    "value" : "Abcd",
    "includeNullResults" : false,
    "wildcards" : "*"
  },
  "id" : {
    "operator" : "IS",
    "value" : "Abcd",
    "includeNullResults" : false,
    "wildcards" : "*"
  },
  "status" : {
    "operator" : "IS",
    "value" : "Abcd",
    "includeNullResults" : false,
    "wildcards" : "*"
  },
  "readOption" : {
    "options" : [ "VALIDATOR", "VALIDATOR" ]
  }
}

2.2.5. Search for banking informations for which I am the validator.

POST

/validations/banking-informations/mine/search
Description

Search for banking informations for which I am the validator.

DMF required:

  • DMF A50210: Api Approval Process / Banking Information / Search Mine

  • DMF 192301: Web Portal / Bank Details / Search

Parameters
Body Parameter
Name Description Required Default Pattern

criteria

Criteria that you choose (id, company, etc…) BankingInformationCriteria

X
Query Parameters
Name Description Required Default Pattern

offset

The index of first element

-

null

limit

The max number of elements

-

null
Return Type

array[BankingInformationValidation]

Content Type

  • application/json

Responses
Table 19. http response codes
Code Message Datatype

200

Banking informations loaded

List[BankingInformationValidation]

400

Bad Request - Standard failure code. This code is used when no other specific code applies.

ErrorResponse

401

Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource.

ErrorResponse

402

Request Failed - The parameters were valid but the request failed.

ErrorResponse

403

Forbidden - The user does not have permissions to perform the request.

ErrorResponse

404

Not Found - The requested resource does not exist.

ErrorResponse

405

Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented.

ErrorResponse

406

Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request.

ErrorResponse

500

Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end.

ErrorResponse
Samples
Body parameter
Click to expand 

{
  "concernedObjectType" : {
    "operator" : "IS",
    "value" : "Abcd",
    "includeNullResults" : false,
    "wildcards" : "*"
  },
  "id" : {
    "operator" : "IS",
    "value" : "Abcd",
    "includeNullResults" : false,
    "wildcards" : "*"
  },
  "status" : {
    "operator" : "IS",
    "value" : "Abcd",
    "includeNullResults" : false,
    "wildcards" : "*"
  },
  "readOption" : {
    "options" : [ "VALIDATOR", "VALIDATOR" ]
  }
}

2.2.6. Send Message for a banking information

POST

/validations/banking-informations/{banking_information_id}/send-message
Description

A complex Mail sent with a list of recipients represented by a recipient object, a body and a title. Each MessageRecipient object will be handled in order to match Akuiteo 'Tiers' to real world email addresses.

DMF required:

  • DMF A50212: Api Approval Process / Banking Information / Validate

  • DMF 040139: Purchases / Suppliers / Print Bank Details

  • DMF 192303: Web Portal / Bank Details / Send Email Requester

Parameters
Path Parameters
Name Description Required Default Pattern

banking_information_id

The id of the banking informations

X

null
Body Parameter
Name Description Required Default Pattern

mail

The message to send TemplatedMessage

-
Return Type

-

Responses
Table 20. http response codes
Code Message Datatype

204

The mail has been correctly staged for background sending process

<<>>

400

Bad Request - Standard failure code. This code is used when no other specific code applies.

ErrorResponse

401

Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource.

ErrorResponse

402

Request Failed - The parameters were valid but the request failed.

ErrorResponse

403

Forbidden - The user does not have permissions to perform the request.

ErrorResponse

404

Not Found - The requested resource does not exist.

ErrorResponse

405

Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented.

ErrorResponse

406

Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request.

ErrorResponse

500

Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end.

ErrorResponse
Samples
Body parameter
Click to expand 

{
  "message" : {
    "toRecipients" : [ {
      "id" : "5000123",
      "summary" : "Text",
      "address" : "jean@email.com",
      "type" : "{}"
    }, {
      "id" : "5000123",
      "summary" : "Text",
      "address" : "jean@email.com",
      "type" : "{}"
    } ],
    "mail" : {
      "cc" : [ "cc", "cc" ],
      "cci" : [ "cci", "cci" ],
      "replyTo" : "replyTo",
      "from" : "from",
      "to" : [ "to", "to" ],
      "title" : "title",
      "body" : "body"
    },
    "replyTo" : {
      "id" : "5000123",
      "summary" : "Text",
      "address" : "jean@email.com",
      "type" : "{}"
    },
    "ccRecipients" : [ {
      "id" : "5000123",
      "summary" : "Text",
      "address" : "jean@email.com",
      "type" : "{}"
    }, {
      "id" : "5000123",
      "summary" : "Text",
      "address" : "jean@email.com",
      "type" : "{}"
    } ],
    "cciRecipients" : [ {
      "id" : "5000123",
      "summary" : "Text",
      "address" : "jean@email.com",
      "type" : "{}"
    }, {
      "id" : "5000123",
      "summary" : "Text",
      "address" : "jean@email.com",
      "type" : "{}"
    } ],
    "publishedDocuments" : [ {
      "isDocument" : true,
      "documentId" : "112302",
      "token" : "token"
    }, {
      "isDocument" : true,
      "documentId" : "112302",
      "token" : "token"
    } ]
  },
  "templateId" : "255644",
  "parameters" : [ {
    "groupName" : "text_box",
    "labelText" : "Detail BL",
    "pattern" : "cl",
    "nameField" : "DetailBL",
    "selectionList" : [ {
      "label" : "Bank transfer",
      "value" : "BT"
    }, {
      "label" : "Bank transfer",
      "value" : "BT"
    } ],
    "nameFieldNext" : "DetailCheckbox",
    "value" : "checked",
    "required" : true
  }, {
    "groupName" : "text_box",
    "labelText" : "Detail BL",
    "pattern" : "cl",
    "nameField" : "DetailBL",
    "selectionList" : [ {
      "label" : "Bank transfer",
      "value" : "BT"
    }, {
      "label" : "Bank transfer",
      "value" : "BT"
    } ],
    "nameFieldNext" : "DetailCheckbox",
    "value" : "checked",
    "required" : true
  } ]
}

3. Models

3.1. AccountType

Type of the account for international bank detail

Type : enum (IBAN, BBAN, OTHER)

3.2. AccountingJournal

Accounting journal

Field Name Required Type Description Format

code

[String]

The accounting journal code
Warning : The accounting journal code cannot be changed once it has been created. Any modification will not be taken into account.

endDate

[date]

End date of. Cannot be set directly please use the //TBD path.
Example : 2020-12-25

date

excludedByDefault

[Boolean]

Excluded by default from accounting reports (trial balance, General ledger, accounting entries seach)

id

[String]

Id in database
Example : 5000123

miscellaneousTransactionsProhibited

[Boolean]

Miscellaneous transactions Prohibited

name

[String]

The accounting journal name

startDate

[date]

Accounting journal start date
Example : 2020-12-25

date

3.3. AccountingJournalBase

Accounting journal

Field Name Required Type Description Format

code

[String]

The accounting journal code
Warning : The accounting journal code cannot be changed once it has been created. Any modification will not be taken into account.

id

[String]

Id in database
Example : 5000123

name

[String]

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

[String]

Code of the second action code
Example : ADD

id

[String]

Id in database
Example : 5000123

name

[String]

Name of the action code
Example : ADD

3.6. ActionCodeBase

Details about the action code

Field Name Required Type Description Format

id

[String]

Id in database
Example : 5000123

name

[String]

Name of the action code
Example : ADD

3.7. ActionManagementObjectLine

ActionManagementObjectLine

Field Name Required Type Description Format

action

Action

The action verb (ADD / UPDATE / REMOVE)
Example : ADD

amountTotal

[Double]

Total amount expressed in company currency
Example : 1200

double

amountTotalCurrency

[Double]

Total amount in the currency
Example : 1200

double

id

[String]

Id in database
Example : 5000123

managementObjectId

[String]

Id of the management object
Example : 5000123

name

[String]

Name of the line
Example : Helpdesk

phase

PhaseBase

Details about the phase of the project.
Remark : In add APIs (mainly PUT requests) phase model is not expected, use the phaseId field instead.

phaseId

[String]

ID of the phase
Example : 5000123

project

ProjectBase

All details about the project
Remark : In add APIs (mainly PUT requests) project model is not expected, use the projectId field instead.

projectId

[String]

ID of the project (equivalent to the code of the project)
Example : PRJT_001

projectTask

ProjectTaskCommon

Details about the project task of the project
Remark : In add APIs (mainly PUT requests) projectTask model is not expected, use the projectTaskId field instead.

projectTaskId

[String]

Id of the project task
Example : 5000123

quantity

[Double]

Quantity of the product
Example : 3

double

rankNumber

[Double]

Rank number of the line
Example : 2

double

subPhase

SubPhaseBase

Details about the sub-phase of the project
Remark : In add APIs (mainly PUT requests) subPhase model is not expected, use the subPhaseId field instead.

subPhaseId

[String]

ID of the sub-phase
Example : 51000122

unitPrice

[Double]

Unit price of the product expressed in company currency
Example : 40

double

unitPriceCurrency

[Double]

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.

Example : 36.32

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

[String]

Code of the activity

id

[String]

Id in database
Example : 5000123

name

[String]

Name of the activity

3.10. AdditionalFreeFields

Free fields of a Management Object Line

Field Name Required Type Description Format

field1

[String]

Free field 1
Example : Free field

field2

[String]

Free field 2
Example : Free field

field3

[String]

Free field 3
Example : Free field

field4

[String]

Free field 4
Example : Free field

field5

[String]

Free field 5
Example : Free field

3.11. AdditionalFreeFieldsCriteria

Search criteria for additional free fields

Field Name Required Type Description Format

additionalFreeField1

ClauseString

additionalFreeField2

ClauseString

additionalFreeField3

ClauseString

additionalFreeField4

ClauseString

additionalFreeField5

ClauseString

3.12. Address

Details about the address

Field Name Required Type Description Format

cedex

[String]

Special number assigned to a company by the French postal code
Example : CEDEX 14

city

[String]

City of the address
Example : London

country

[String]

Country code of the address in the database
Example : FR (for 'FRANCE')

countryName

[String]

Country name of the address
Example : FRANCE
Remark : This property is read-only and provides current data without allowing modifications.

department

[String]

Geographical department code of the address in the database
Example : 75 (for 'PARIS')

email

[String]

Email of the address
Example : myemail@mail.com

fax

[String]

Fax of the address
Example : 04 00 00 00 07

geographicalDepartmentName

[String]

Name of the geographical department for the address
Example : CENTRE VAL DE LOIRE
Remark : This property is read-only and provides current data without allowing modifications.

id (Deprecated)

[String]

Id in database
Deprecated : This field is unused and will soon be removed.

line1

[String]

First line of the address
Example : 221B Baker Street

line2

[String]

Second line of the address
Example : 2nd Floor

line3

[String]

Third line of the address
Example : First door at your right

mobilePhone

[String]

Mobile Phone of the address
Example : 06 00 00 00 02

phone

[String]

Phone of the address
Example : 06 00 00 00 01

phone2

[String]

Second phone of the address
Example : 06 00 00 00 02

postalCode

[String]

Postal code of the city
Example : 69002

region

[String]

Region code of the address in the database
Example : 65 (for 'ILE DE FRANCE')

regionName

[String]

Region name of the address
Example : ILE DE FRANCE
Remark : This property is read-only and provides current data without allowing modifications.

webSite

[String]

Web Site of the address
Example : mysite.com

3.13. Alert

Alert message

Field Name Required Type Description Format

level

[String]

Level of the alert
Example : ERROR

Enum: ERROR, WARNING, INFO, ERROR, WARNING, INFO

message

[String]

Message of the alert
Example : Lorem ipsum

3.14. AmortizationMethod

The method of amortization

Type : enum (LINEAR, SLIDING_SCALE)

3.15. AmountCategoryType

Amount Category (Unitary/Total)

Type : enum (UNITARY, TOTAL)

3.16. AnalysisResult

Analysis result consisting of a value, a date and a set of analysis groups

Field Name Required Type Description Format

date

[Date]

Aggregate date of the analysis (see dateLike)
Example : 2020-01-23T04:56:07.000+00:00

date-time

group

Map of [object]

All analysis groups
Example : {"SALES_MANAGER_SUPERVISOR_CODE":"BLR"}

value

[Double]

Aggregate value of the analysis
Example : 4000

double

3.17. ApplicationControlBase

Application control

Field Name Required Type Description Format

code

[String]

The code of the application control base.
Example : Text

id

[String]

Id in database
Example : 5000123

info1

[String]

The first information about the application control base.
Example : Text

info2

[String]

The second information about the application control base.
Example : Text

info3

[String]

The third information about the application control base.
Example : Text

info4

[String]

The fourth information about the application control base.
Example : Text

info5

[String]

The fifth information about the application control base.
Example : Text

3.18. Approval

Approval

Field Name Required Type Description Format

approvalDate

[Date]

The approval date of the approval
Example : 2020-01-23T04:56:07Z

date-time

approvedBy

UserBase

Details about the user who approved
Remark : In add APIs (mainly PUT requests) approvedBy model is not expected, use the approvedById field instead.

approvedById

[String]

ID of the user who approved
Example : 5000130

approver

Approver

Details about the approver
Remark : In add APIs (mainly PUT requests) approver model is not expected, use the approverId field instead.

approverId

[String]

ID of the approver
Example : 5000130

code

[String]

The code of the approval
Example : ABC

comment

[String]

The comment of the approval
Example : Lorem ipsum

company

[String]

The company of the approval
Example : Akuiteo

id

[String]

Id in database
Example : 5000123

integralObject

[oas_any_type_not_mapped]

Integral object

isAutoApproved

[Boolean]

Set to true if approval has been approved automatically.
This occurs when the requester is also the approver of the document and the approval parameter allows automatic approving.
If this field is set to “true”, approvedById will automatically be set to “null”.

Example : true

level

[Integer]

The level of the approval
Example : 1

name

[String]

The name of the approval
Example : Lorem ipsum

object (Deprecated)

ApprovalObjectSummary

Details about the approval object summary
Deprecated : Use objectSummary instead
Remark : In add APIs (mainly PUT requests) object model is not expected, use the objectId field instead.

objectEntityCode

[String]

The object entity code of the approval
Example : 1

objectId (Deprecated)

[String]

ID of the approval object summary
Deprecated : Use objectSummaryId instead

objectSummary

ApprovalObjectSummary

Details about the approval object summary
Remark : In add APIs (mainly PUT requests) objectSummary model is not expected, use the objectSummaryId field instead.

objectSummaryId

[String]

ID of the approval object summary
Example : 5000130

objectType

ApprovalType

The approval type
Example : QUOTATION

ongoingLevelNumber

[Integer]

The on going level number of the approval
Example : 1

order

[Integer]

The order of the approval
Example : 1

otherApprovals

List of Approval

Other approvals for the same object

requestDate

[Date]

The request date of the approval
Example : 2020-01-23T04:56:07Z

date-time

requester

EmployeeBase

Details about the requester
Remark : In add APIs (mainly PUT requests) requester model is not expected, use the requesterId field instead.

requesterId

[String]

ID of the requester
Example : 5000130

state

ApprovalState

Example : NONE

totalLevelNumber

[Integer]

The total level number of the approval
Example : 1

viewCustomData

[Integer]

The view custom data of the approval
Example : 1

3.19. ApprovalApproverCriteria

Criteria used on approver when doing an Approval search

Field Name Required Type Description Format

employeeDivisionId

ClauseString

employeeEntityId

ClauseString

managerId

ClauseString

serviceId

ClauseString

3.20. ApprovalCriteria

Criteria used when doing an Approval search (critère de recherche d'approbation)

Field Name Required Type Description Format

approvalApproverCriteria

ApprovalApproverCriteria

approvalDate

ClauseDate

Approval date of the approval

approvalProjectCriteria

ApprovalProjectCriteria

approvalSummaryCriteria

ApprovalSummaryCriteria

approverId

ClauseString

comment

ClauseString

id

ClauseString

level

ClauseString

objectId

ClauseString

objectType

ClauseString

readOption

ApprovalReadOption

Options for retrieving extra information concerning the approval

requestDate

ClauseDate

Request date of the approval

requesterId

ClauseString

states

ClauseString

3.21. ApprovalManagementObject

Information on the approval of a management object (pièce de gestion)

Field Name Required Type Description Format

afterTaxAmount

[Double]

After-Tax amount expressed in company currency
Example : 120.37

double

approvalDate

[Date]

Date of approval
Example : 2020-01-23T04:56:07.000+00:00

date-time

approvalState

ApprovalState

State of approval
Example : NONE

changeTracking

ChangeTracking

companyCode

[String]

The company code
Example : AKSAS

companyId

[String]

ID of the company
Example : 5000123

currency

Currency

Currency used in the management object

currencyCode

[String]

Code of the currency used in the management object
Example : EUR

customData

Map of CustomData

The custom data (when present)

date

[Date]

Date on the management object
Example : 2020-01-23T04:56:07.000+00:00

date-time

description

[String]

Description
Example : Lorem ipsum

entityCode (Deprecated)

[String]

The entity code
Example : Lyon
Deprecated : Use entityId instead

id

[String]

Id in database
Example : 5000123

name

[String]

Name of the management object
Example : Label for my doc

number

[String]

The number of the management object
Example : CC00001

phase

PhaseBase

Details about the phase of the project.
Remark : In add APIs (mainly PUT requests) phase model is not expected, use the phaseId field instead.

phaseId

[String]

ID of the phase
Example : 5000123

preTaxAmount

[Double]

Pre-Tax Amount expressed in company currency
Example : 100.14

double

project

ProjectBase

All details about the project
Remark : In add APIs (mainly PUT requests) project model is not expected, use the projectId field instead.

projectId

[String]

ID of the project (equivalent to the code of the project)
Example : PRJT_001

projectTask

ProjectTaskCommon

Details about the project task of the project
Remark : In add APIs (mainly PUT requests) projectTask model is not expected, use the projectTaskId field instead.

projectTaskId

[String]

Id of the project task
Example : 5000123

subPhase

SubPhaseBase

Details about the sub-phase of the project
Remark : In add APIs (mainly PUT requests) subPhase model is not expected, use the subPhaseId field instead.

subPhaseId

[String]

ID of the sub-phase
Example : 51000122

thirdPartyId

[String]

The Id of the third-party
Example : CUSTOMER01

type

ManagementObjectType

Example : QUOTATION

3.22. ApprovalObjectSummary

ApprovalObjectSummary (résumé de l'approbation)

Field Name Required Type Description Format

afterTaxAmount

[Double]

After-Tax amount expressed in company currency
Example : 1500
Remark : This property is read-only and provides current data without allowing modifications.

double

afterTaxAmountCurrency

[Double]

After-Tax amount in the currency
Example : 1500
Remark : This property is read-only and provides current data without allowing modifications.

double

companyCode

[String]

The code of the company
Example : AKSAS

currencyCode

[String]

The code of the currency
Example : EUR

customData

Map of CustomData

The custom data (when present)

date

[Date]

The date of approval submitted
Example : 2020-01-23T04:56:07Z

date-time

description

[String]

The description about the approval
Example : Text

entityCode

[String]

The code of the entity
Example : RD

id

[String]

Id in database
Example : 5000123

name

[String]

The name of the approval
Example : TEXT

number

[String]

The number of the management object concerned
Example : CC00001

preTaxAmount

[Double]

Pre-Tax Amount expressed in company currency
Example : 1500
Remark : This property is read-only and provides current data without allowing modifications.

double

preTaxAmountCurrency

[Double]

Pre-Tax Amount in the currency
Example : 100.14
Remark : This property is read-only and provides current data without allowing modifications.

double

projectId

[String]

The ID of the project related to the management object concerned
Example : 5000123

projectName

[String]

The name of the project related to the management object concerned
Example : PROJECT

projectedApprovalDate

[Date]

The expected approval date
Example : 2020-01-23T04:56:07Z

date-time

thirdPartyCode

[String]

The third-party code of the management object concerned
Example : CUSTOMER01

thirdPartyId

[String]

The third-party ID of the management object concerned
Example : 5000123

thirdPartyName

[String]

The name of third party for the management object concerned
Example : CUSTOMER01

3.23. ApprovalProjectCriteria

Criteria used on project when doing an Approval search

Field Name Required Type Description Format

divisionId

ClauseString

entityId

ClauseString

internalProject

ClauseBoolean

Set as true if the approval project is internal

projectGroupCode

ClauseString

Code of project group

projectId

ClauseString

Ident of the project (equivalent to the code of the project)

3.24. ApprovalReadOption

Options used to get additional information when doing an Approval search

Field Name Required Type Description Format

options

List of [string]

List of options used to get more details about the approval

Enum: OBJECT_SUMMARY, CUSTOM_DATA, INTEGRAL_OBJECT, OTHER_APPROVALS

3.25. ApprovalState

State of the Approval

Type : enum (NONE, TO_REQUEST, TO_APPROVE, REFUSED, APPROVED)

3.26. ApprovalSummaryCriteria

Criteria used on summary when doing an Approval search

Field Name Required Type Description Format

archived

ClauseBoolean

Set as true to include only archived approval summaries

customRequestId

ClauseString

customerId

ClauseString

multiCompany

ClauseBoolean

Set as true to return approval summaries involving multiple companies.

objectDate

ClauseDate

Date of the management object linked to the approval summary

supplierId

ClauseString

3.27. ApprovalType

Type of the Approval

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

3.28. Approver

Approver (approbateur)

Field Name Required Type Description Format

action

Action

The action verb
Example : ADD

code

[String]

Code of the employee
Example : CASH

email

[String]

Email of the approver

firstName

[String]

First name of the employee
Example : Jean

id

[String]

Id in database
Example : 5000123

name

[String]

Name of the employee
Example : DUPONT

3.29. ArchiveArgument

Arguments to archive

Field Name Required Type Description Format

comment

[String]

Comment to describe the archiving reason
Example : Lorem ipnum

reasonId

[String]

The ID of the archiving reason
Example : 5000152

3.30. ArchiveReasonBase

Details about the reasons to archive

Field Name Required Type Description Format

code

[String]

Code of the reason to archive

id

[String]

Id in database
Example : 5000123

name

[String]

Name of the reason to archive

3.31. Assignment

Assignment

Field Name Required Type Description Format

customer

CustomerBase

Details about the customer
Remark : In add APIs (mainly PUT requests) customer model is not expected, use the customerId field instead.

customerId

[String]

ID of the customer
Example : 5000123

phase

PhaseBase

Details about the phase
Remark : In add APIs (mainly PUT requests) phase model is not expected, use the phaseId field instead.

phaseId

[String]

ID of the phase
Example : 5000123

project

ProjectBase

Details about the project
Remark : In add APIs (mainly PUT requests) project model is not expected, use the projectId field instead.

projectId

[String]

ID of the project (equivalent to the code of the project)
Example : PRJT_1

projectTask

ProjectTaskBase

Details about the task
Remark : In add APIs (mainly PUT requests) projectTask model is not expected, use the projectTaskId field instead.

projectTaskId

[String]

ID of the project
Example : 5000123

subPhase

SubPhaseBase

Details about the sub-phase
Remark : In add APIs (mainly PUT requests) subPhase model is not expected, use the subPhaseId field instead.

subPhaseId

[String]

ID of the sub-phase
Example : 5000123

3.32. AssignmentCriteria

Criteria used to get more details about an assignment

Field Name Required Type Description Format

activityId

ClauseString

Ident of the activity

allCompanies

[Boolean]

Set as True if you don't want to filter on companies

companyId

ClauseString

Ident of the company

countAssignmentType

AssignmentType

Define the node type when counting an assignment tree. Used like a query parameter limit.
Example : COMPANY

customerId

ClauseString

Ident of the customer

departmentId

ClauseString

Ident of the department

divisionGroupId

ClauseString

Ident of the division group

divisionId

ClauseString

Ident of the division

employeeId

[String]

ID of the employee

employeeIdScheduled

List of [string]

Ids of employees for which the project has schedules

employeePartitioning

[Boolean]

Set as True if you want to apply the partitioning by employee

entityId

ClauseString

Ident of the entity

ignoreProjectAllCustomer

[Boolean]

Set as True if you want to ignore all customer projects

lowerAssignmentType

AssignmentType

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.
Example : COMPANY

mainCustomer

[Boolean]

Set as True if you want to filter only main customers

phaseCode

ClauseString

Code of the phase

phaseId

ClauseString

Ident of the phase

projectCategorieId

ClauseString

Ident of the project category

projectClosed

ClauseBoolean

Set as True if you want to include closed projects

projectEmployeeLinkedId

ClauseString

Ids of employees linked to the project (Include projects with no employee linked)
Only supports IN or IS operators

projectFilterType

ProjectFilterType

Filter on project (may override some other clauses like divisionId or entityId)
Example : NONE

projectFinancialManagerId

ClauseString

Ident of the project financial manager

projectGroupCode

ClauseString

Code of the project group

projectId

ClauseString

Ident of the project (equivalent to the code of the project)

projectInternal

ClauseBoolean

Set as True if you want to include internal projects

projectManagerId

ClauseString

Ident of the project manager

projectOnLeave

ClauseBoolean

Set as True if you want to include leave projects

projectProductionManagerId

ClauseString

Ident of the project production manager

projectSalesManagerId

ClauseString

Ident of the project sales manager

projectStateCode

ClauseString

Code of the projectState

projectSubCategorieId

ClauseString

Ident of the sub-category

projectSubcategorieLevel2Id

ClauseString

Ident of the sub-category level 2

projectTaskEmployeeLinkedId

ClauseString

Ids of employees linked to the project task (Include project tasks with no employee linked)
Only supports IN or IS operators

projectTaskId

ClauseString

Ident of the task

referentialDate

[Date]

Start referential date. If the field is not filled in, it take today's date by default
Example : 2020-01-23T04:56:07.000+00:00

date-time

referentialDateEnd

[Date]

End referential date. This date must be after the referentialDate.
Example : 2020-01-23T04:56:07.000+00:00

date-time

scheduled

ClauseBoolean

Assignment with schedules over the period (see referentialDate)

subPhaseCode

ClauseString

Code of the sub-phase

subPhaseId

ClauseString

Ident of the sub-phase

tag

ClauseString

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

AssignmentType

Define the root node type when searching an assignment tree. If this field is not filled in, default root node type is CUSTOMER.
Example : COMPANY

yearId

ClauseString

Ident of the year

3.33. 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.34. AssignmentNode

Assignment

Field Name Required Type Description Format

additionalProperties

Map of [string]

Additonal functional properties available on this node
Example : <project, customerId>

assignments

List of AssignmentNode

Assignment node's child
Example : see AssignmentNode

code

[String]

Code of the assignment
Example : 01-MAINT

description

[String]

Short description of the assignment
Example : Short lorem ipsum

id

[String]

Id in database
Example : 5000123

longDescription

[String]

Long description of the assignment
Example : Long lorem ipsum

parentId

[String]

ID of the parent
Example : 120047

parentType

AssignmentType

Details about the parent
Example : COMPANY

selectable

[Boolean]

Return True if the assignment node can be selected
Example : true

type

AssignmentType

Details about the assignment type
Example : COMPANY

3.35. AssignmentReferential

Assignment referential

Field Name Required Type Description Format

activity

ActivityBase

Details about the activity

category

Category

Details about the category

company

CompanyBase

Details about the company

customer

CustomerBase

Details about the customer

department

Department

Details about the departement

division

Division

Details about the divison

divisionGroup

DivisionGrouping

Details about the division grouping

entity

Entity

Details about the entity

id

[String]

Id in database
Example : 5000123

phase

PhaseBase

Details about the phase

project

ProjectCommon

Details about the project

projectGroup

ProjectGroup

Details about the project group

projectManager

EmployeeBase

Details about the project manager

projectProductionManager

EmployeeBase

Details about the production manager

projectState

ProjectState

Details about the project state code

projectTask

ProjectTaskCommon

Details about the task

subCategory

Category

Details about the sub-category

subCategoryLevel2

Category

Details about the second sub-category

subPhase

SubPhaseBase

Details about the sub-phase

year

Year

Details about the year

3.36. AssignmentSubType

Subtype of Assignment

Type : enum (PROJECT_GROUP, DEPARTMENT, ACTIVITY, CATEGORY, SUB_CATEGORY, SUB_CATEGORY_2, PROJECT_STATE, YEAR)

3.37. AssignmentType

Type of Assignment

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

3.38. 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.39. Avatar

Entity avatar

Field Name Required Type Description Format

content

[String]

The base64-encoded binary content or URL of the entity's avatar image.
Example : iVBORw0KGgoAAAANS

3.40. AxeCriteria

Standard criteria for filtering data from the analysis

Field Name Required Type Description Format

axeType

X

[String]

Unused (technical field)

customerAccountManagerId

ClauseString

Ident of customer's account manager

customerAccountManagerSupervisorId

ClauseString

Ident of customer's account manager supervisor

customerCountryId

ClauseString

Ident of customer's country

customerFamilyId

ClauseString

Ident of the customer's project category

customerGrouping1

ClauseString

Customer's grouping

customerGrouping2

ClauseString

Customer's grouping 2

customerId

ClauseString

Ident of customer

customerRegionId

ClauseString

Ident of customer's address region

customerSalesmanId

ClauseString

Ident of customer's salesman

customerSalesmanSupervisorId

ClauseString

Ident of customer's salesman supervisor

customerSectorId

ClauseString

Ident of customer's sector

customerState

ClauseString

Customer's state

customerSubFamilyId

ClauseString

Ident of the customer's project subcategory

groupCustomer

ClauseBoolean

Group of companies of the customer

phaseId

ClauseString

Ident of the phase

projectActivityId

ClauseString

projectCampaignId

ClauseString

Ident of the project's compaign

projectCompanyCode

ClauseString

Code of the project's company

projectDepartmentId

ClauseString

Ident of the project's department

projectDivisionGroupId

ClauseString

Ident of the project's division group

projectDivisionId

ClauseString

Ident of the project's division

projectEstablishmentId

ClauseString

projectFamilyId

ClauseString

Ident of the project's category

projectFinancialManagerId

ClauseString

Ident of the project's financial manager

projectId

ClauseString

Ident of the project (equivalent to the code of the project)

projectManagerId

ClauseString

Ident of the project manager of the project

projectMarketId

ClauseString

Ident of project group of the project

projectProductionManagerId

ClauseString

Ident of the project's product manager

projectSalesManagerId

ClauseString

Ident of the project's sales manager

projectState

ClauseString

State of project

projectSubFamily2Id

ClauseString

Ident of the project's sub-category level 2

projectSubFamilyId

ClauseString

Ident of the project's sub-category

projectVintageId

ClauseString

Ident of the year (vintage) of the project

prospect

ClauseBoolean

True is customer is a prospect

subPhaseId

ClauseString

Ident of the sub-phase

3.41. 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.42. BIC

Details about the BIC of a people

Field Name Required Type Description Format

bank

[String]

Code of the bank - 4 digits max
Example : DAAE

branch

[String]

Code of the optional branch - 3 digits max
Example : CCT

country

[String]

Country code of the address in the database
Example : FR (for 'FRANCE')

location

[String]

Code of the location - 2 digits max
Example : PP

3.43. BankDetails

Details about the bank of a people

Field Name Required Type Description Format

accountNumber

[String]

Account number - 11 digits max
Example : 0000157841Z

counter

[String]

Code of the counter - 5 digits max
Example : 550

domiciliation

[String]

Bank domiciliation
Example : AURA

entity

[String]

Code of the bank - 5 digits max
Example : 30002

key

[String]

Key of the RIB - 2 digits max
Example : 25

3.44. BankType

Type of the bank (nature de banque) for international bank detail

Type : enum (BIC, ABA, NOT_DEFINED)

3.45. BankingInformation

Banking informations

Field Name Required Type Description Format

action

Action

The action verb (ADD / UPDATE / REMOVE)
Example : ADD

id

[String]

ID in database
Example : 5000123

noneSepa

NoneSEPA

Details about the none SEPA banking information (exclusive with the sepa field)

sepa

SEPA

Details about the SEPA banking information (exclusive with the noneSepa field)

statusChangeArgument

BankingInformationStatusParamHolder

Argument to change the status of a banking information

statusChangeDate

[Date]

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.
Example : 2020-01-23T04:56:07.000+00:00

date-time

type

BankingInformationType

The type of banking information used to indicate whether the data refers to SEPA details (with BIC, IBAN, and bankDetails) or international bank details.
If the type is SEPA, only the sepa field must be filled.
If the type is INTERNATIONAL_BANK, only the noneSepa field must be filled.
The default value is SEPA. This field cannot be null.

Example : SEPA

validator

EmployeeBase

Details about the employee who will validate banking data.
Remark : In add APIs (mainly PUT requests) validator model is not expected, use the validatorId field instead.

validatorId

[String]

Set as true if this rule for validating banking data is applied to employees.
Example : 5000123

3.46. BankingInformationCriteria

Criteria used to get more details about Banking Information

Field Name Required Type Description Format

concernedObjectType

ClauseString

Type of the object to which the banking informations belong (only IS and IN operators are supported)

id

ClauseString

ID in database

readOption

BankingInformationReadOption

Options for retrieving extra information concerning the banking information.

status

ClauseString

The status of the Banking Information

3.47. BankingInformationObjectType

Type of the object to which the banking information belongs

Type : enum (EMPLOYEE, SUPPLIER, SUPPLIER_SITE)

3.48. BankingInformationReadOption

The options you can use to get more information about banking information.

Field Name Required Type Description Format

options

List of [string]

List of options used to get more details about the banking information

Enum: VALIDATOR

3.49. BankingInformationStatus

The status of the Banking Information

Type : enum (VALIDATED, TO_VALIDATE, REFUSED)

3.50. BankingInformationStatusParamHolder

Argument to change the status of a banking information

Field Name Required Type Description Format

comment

[String]

Comment about the change status
Example : Comment

status

X

BankingInformationStatus

The status of the Banking Information
Example : VALIDATED

3.51. BankingInformationSupplierType

Supplier type of banking information

Type : enum (ALL, INTERNAL, EXTERNAL, VIRTUAL)

3.52. BankingInformationType

List of banking information type

Type : enum (SEPA, INTERNATIONAL_BANK)

3.53. BankingInformationValidation

Banking information for validation

Field Name Required Type Description Format

bankingInformation

BankingInformation

previousBankingInformation

BankingInformation

validationContext

BankingInformationValidationContext

3.54. BankingInformationValidationContext

Validation context of the banking informations belong

Field Name Required Type Description Format

address

Address

code

[String]

The code of the banking information object.
Example : CAU

concernedObjectId

[String]

The ID of the object concernd by banking information validation.
Example : 5000123

concernedObjectType

BankingInformationObjectType

Example : EMPLOYEE

name

[String]

The name of the banking information object.
Example : Vinz

3.55. BaseRateBase

Basic information for rates.

Field Name Required Type Description Format

id

[String]

ID in database of base rate
Example : 5000123

name

[String]

The description of the base rate
Example : Lorem Ipsum

3.56. BatchArchiveArgumentParamHolder

The parameters for archiving the quotations

Field Name Required Type Description Format

archiveArgument

ArchiveArgument

The argument for archiving

ids

List of [string]

IDs of the elements to archive

3.57. BatchParameter

Parameter used to manage batch operations

Field Name Required Type Description Format

ids

List of [string]

Ids of the objects

3.58. 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.59. BatchUpdateSalesMObjectLines

Object for batch updating certain fields in sales management object lines

Field Name Required Type Description Format

billingMode

BillingMode

Billing mode for the line
Example : TIME_BASED

ids

List of [string]

Ids of the objects

notPublishable

[Boolean]

Set to “true” if the line is not to be shown when the sales management object containing said line (quotation, invoice, etc.) is published.
Set as 'false' by default.

Example : false

resourceId

[String]

Id of the resource allocated to complete the task
Example : 5000123

3.60. BillingMode

Billing mode of a product or sales line

Type : enum (TIME_BASED, FIXED_PRICE, RECURRENT, PRODUCTION_TO_BE_BILLED)

3.61. 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.62. BlockingInformation

Blocking information (Customer, …​)

Field Name Required Type Description Format

alerted

[Boolean]

Operation is not blocked for this customer but has alerts.

blocked

X

[Boolean]

Operation is blocked for this customer.

reason

[String]

Reason why customer is blocked.

3.63. BlockingParamHolder

Blocking information needed to apply checking

Field Name Required Type Description Format

amount

X

[Double]

Amount to be checked

double

objectId

[String]

Object tested (only in modifcation)

objectType

X

BlockedType

Type of parameterized object tested
Example : OPPORTUNITY

3.64. BooleanParamHolder

Parameter value (Boolean).
See the documentation of the calling API body for further information

Field Name Required Type Description Format

value

[Boolean]

Value

3.65. BusinessEntity

BusinessEntity manages project-related information, including its phases and sub-phases.

Field Name Required Type Description Format

phase

PhaseBase

Details about the phase of the project.
Remark : In add APIs (mainly PUT requests) phase model is not expected, use the phaseId field instead.

phaseId

[String]

ID of the phase
Example : 5000123

project

ProjectBase

All details about the project
Remark : In add APIs (mainly PUT requests) project model is not expected, use the projectId field instead.

projectId

[String]

ID of the project (equivalent to the code of the project)
Example : PRJT_001

subPhase

SubPhaseBase

Details about the sub-phase of the project
Remark : In add APIs (mainly PUT requests) subPhase model is not expected, use the subPhaseId field instead.

subPhaseId

[String]

ID of the sub-phase
Example : 51000122

3.66. BusinessReferential

BusinessReferential manages project-related information, including phases, sub-phases, and associated project tasks.

Field Name Required Type Description Format

phase

PhaseBase

Details about the phase of the project.
Remark : In add APIs (mainly PUT requests) phase model is not expected, use the phaseId field instead.

phaseId

[String]

ID of the phase
Example : 5000123

project

ProjectBase

All details about the project
Remark : In add APIs (mainly PUT requests) project model is not expected, use the projectId field instead.

projectId

[String]

ID of the project (equivalent to the code of the project)
Example : PRJT_001

projectTask

ProjectTaskCommon

Details about the project task of the project
Remark : In add APIs (mainly PUT requests) projectTask model is not expected, use the projectTaskId field instead.

projectTaskId

[String]

Id of the project task
Example : 5000123

subPhase

SubPhaseBase

Details about the sub-phase of the project
Remark : In add APIs (mainly PUT requests) subPhase model is not expected, use the subPhaseId field instead.

subPhaseId

[String]

ID of the sub-phase
Example : 51000122

3.67. Calendar

Calendar

Field Name Required Type Description Format

code

[String]

The code of the calendar.
Example : Text

daysNotWorked

List of [integer]

Days not worked (ISO day of the week with 1 being Monday and 7 being Sunday)

int32

default

[Boolean]

Set as 'true' to use this calendar by default.
Set as 'false' by default.

Example : true

holidays

List of Holiday

Details about list of holidays.

id

[String]

Id in database
Example : 5000123

name

[String]

The name of the calendar.
Example : Text

3.68. CalendarEvent

CalendarEvent

Field Name Required Type Description Format

actionCode

ActionCodeBase

Details about the action verb
Remark : In add APIs (mainly PUT requests) actionCode model is not expected, use the actionCodeId field instead.

actionCodeId

[String]

ID of the action code
Example : 130012

changeTracking

ChangeTracking

Date and user in case of creation and modification

comment

[String]

Comment of the calendar event

customer

CustomerBase

Details about the customer
Remark : In add APIs (mainly PUT requests) customer model is not expected, use the customerId field instead.

customerId

[String]

ID of the customer
Example : 5000123

date

[Date]

Date of the calendar event
Example : 2020-01-23T04:56:07.000+00:00

date-time

duration

[Double]

Duration of the calendar event
Example : 2

double

durations

Durations

Duration in different units

employee

EmployeeBase

Details about the employee
Remark : In add APIs (mainly PUT requests) employee model is not expected, use the employeeId field instead.

employeeId

[String]

ID of the employee
Example : 5000123

guid

[String]

Global identifier of the calendar event (for mobile version only)

id

[String]

ID of the calendar event

location

[String]

Location of the calendar event
Example : Paris

phase

PhaseBase

Details about the phase
Remark : In add APIs (mainly PUT requests) phase model is not expected, use the phaseId field instead.

phaseId

[String]

ID of the phase
Example : 5000123

project

ProjectBase

Details about the project
Remark : In add APIs (mainly PUT requests) project model is not expected, use the projectId field instead.

projectId

[String]

ID of the project (equivalent to the code of the project)
Example : PRJT_1

projectTask

ProjectTaskBase

Details about the task
Remark : In add APIs (mainly PUT requests) projectTask model is not expected, use the projectTaskId field instead.

projectTaskId

[String]

ID of the project
Example : 5000123

subPhase

SubPhaseBase

Details about the sub-phase
Remark : In add APIs (mainly PUT requests) subPhase model is not expected, use the subPhaseId field instead.

subPhaseId

[String]

ID of the sub-phase
Example : 5000123

taskId

[String]

Helpdesk's task ident
Example : 5000123

type

[String]

Type of the calendar event
Example : SCHEDULE

unit

UnitDuration

Details about the unit of duration
Example : MINUTE

validated

[Boolean]

Return True if the calendar event is validated

3.69. CampaignBase

Marketing campaign

Field Name Required Type Description Format

code

[String]

The code of the campaign.
Example : CMP_2024_001

id

[String]

ID in database
Example : 5000123

name

[String]

The name of the campaign.
Example : Campaign 2024-01

3.70. Category

Category

Field Name Required Type Description Format

code

[String]

The code of the category
Example : LANG

companyCode

[String]

The code of the company
Example : AKSAS

endDate

[date]

End date for using the category of the product
Example : 2020-12-25

date

grouping

[String]

Grouping field for category

id

[String]

Id in database
Example : 5000123

name

[String]

The name of the category
Example : Language

ranking

[Integer]

Category ranking in help lists

int32

type

CategoryType

Type of the category.
Example : SALES_ITEM

3.71. CategoryCriteria

Criteria used on Category when doing a Category search

Field Name Required Type Description Format

code

ClauseString

Code of the category

companyId

ClauseString

Company of the category

endDate

ClauseDate

End date of validity for the category

grouping

ClauseString

Grouping field of the category

id

ClauseString

Ident of the category

name

ClauseString

Name of the category

tag

ClauseString

You can fill in the code or name of the category in this field

type

ClauseString

Type of the category
(See CategoryType)

validity

Validity

Details about the validity of the category

3.72. CategoryType

Type of category

Type : enum (SALES_ITEM, PURCHASE_ITEM, PROJECT_CATEGORY, PROJECT_SUB_CATEGORY, PROJECT_SUB_CATEGORY_LEVEL2, EMPLOYEE_CATEGORY_LEVEL1, EMPLOYEE_CATEGORY_LEVEL2, EMPLOYEE_CATEGORY_LEVEL3, CUSTOMER, TECHNICAL_DOMAIN, OTHER_THIRDPARTIES, WORKGROUP, VERSION, CUSTOMERS_CONTRACTS, RETAILER_CONTRACTS, DOCUMENT, TRAINING_ITEM, SUPPLIER, MAINTAINED_ITEM)

3.73. ChangeTracking

History of all changes made

Field Name Required Type Description Format

createdBy

UserBase

Code of the creator (user)
Remark : In add APIs (mainly PUT requests) createdBy model is not expected, use the createdById field instead.

createdById

[String]

Id of the creator (user)
Example : 5000123

createdTime

[Date]

Creation Date
Example : 2020-01-23T04:56:07.000+00:00

date-time

modificationBy

UserBase

Code of the user who did the modification
Remark : In add APIs (mainly PUT requests) modificationBy model is not expected, use the modificationById field instead.

modificationById

[String]

Id of the user who did the modification
Example : 5000123

modificationTime

[Date]

Date of the modification.
Example : 2020-01-23T04:56:07.000+00:00

date-time

3.74. ChangeTrackingCriteria

Standard criteria for filtering data from the change tracking

Field Name Required Type Description Format

createdById

ClauseString

The ID of the user who created the object.

createdTime

ClauseDate

The date and time when the object was created.

updatedById

ClauseString

The ID of the user who last updated the object.

updatedTime

ClauseDate

The date and time when the object was last updated.

3.75. CheckbookBase

Customer checkbook base

Field Name Required Type Description Format

id

[String]

Id in database
Example : 5000123

name

[String]

The name of the checkbook
Example : A10_CHECKBOOK

3.76. ChorusInvoiceStatus

Chorus status for e-invoices sent

Type : enum (DRAFT, SUBMITTED, IN_TRANSIT, AVAILABLE, COMPLETED, TO_BE_RECYCLED, SUSPENDED, REJECTED, SERVICE_RENDERED, MANDATED, AVAILABLE_FOR_ACCOUNTING, ACCOUNTED, PAYMENT_INITIATED)

3.77. ChorusServiceInformation

Chorus service information

Field Name Required Type Description Format

serviceCode

[String]

Code of Chorus service
Example : Z-FDJ-CA

serviceName

[String]

Name of Chorus service
Example : SCA

3.78. City

City

Field Name Required Type Description Format

companyCode

[String]

The code of the company linked to the city
Example : AKSAS

country

Country

The country where the city is located
Remark : In add APIs (mainly PUT requests) country model is not expected, use the countryId field instead.

countryId

[String]

Id of the country where the city is located
Example : 5000123

default

[Boolean]

Returns true if the city is the default city
Example : true

department

Department

The department where the city is located
Remark : In add APIs (mainly PUT requests) department model is not expected, use the departmentId field instead.

departmentId

[String]

Id of the department where the city is located
Example : 5000123

id

[String]

Id in database
Example : 5000123

latitude

[String]

Latitude of the city
Example : 5.9845W

longitude

[String]

Longitude of the city
Example : 37.3891N

name

[String]

Name of the city
Example : City 1

postcode

[String]

Postcode of the city
Example : 73000

regionId

[String]

Id of the region
Example : 123456

3.79. Clause

Basic clause type

Field Name Required Type Description Format

includeNullResults

[Boolean]

Set as true to include null results
Example : false

operator

X

ClauseOperation

The operator for your operation.
Example : IS

value

X

[Object]

The value you search

3.80. ClauseBoolean

Boolean clause type

Field Name Required Type Description Format

includeNullResults

[Boolean]

Set as true to include null results
Example : false

operator

X

ClauseOperation

The operator for your operation.
Example : IS

value

X

[Boolean]

The value you search.
Example : false

3.81. ClauseDate

String clause type

Field Name Required Type Description Format

includeNullResults

[Boolean]

Set as true to include null results
Example : false

operator

X

ClauseOperation

The operator for your operation.
Example : IS

value

X

[Date]

The value you search.
Example : 2020-01-23T04:56:07.000+00:00

date-time

withTime

[Boolean]

Whether or not the time part should be taken into account (false by default)
Example : false

3.82. ClauseDouble

Double clause type

Field Name Required Type Description Format

includeNullResults

[Boolean]

Set as true to include null results
Example : false

operator

X

ClauseOperation

The operator for your operation.
Example : IS

value

X

[BigDecimal]

The value you search.
Example : 12.6

3.83. ClauseOperation

Operation used by the clause

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

3.84. ClauseString

String clause type

Field Name Required Type Description Format

includeNullResults

[Boolean]

Set as true to include null results
Example : false

operator

X

ClauseOperation

The operator for your operation.
Example : IS

value

X

[String]

The value you search.
Example : Abcd

wildcards

[String]

When using the LIKE operator, indicates which characters should be interpreted as wildcards ('*%_' by default)
Example : *

3.85. ColorCodes

ColorCodes

Field Name Required Type Description Format

color1

[String]

First color code

color2

[String]

Second color code

color3

[String]

Third color code

3.86. Command

Command

Field Name Required Type Description Format

endDate

[Date]

End of the command
Example : 2020-01-23T04:56:07.000+00:00

date-time

error

[String]

Error of the command

id

[String]

The Id of the command

progress

CommandProgress

Progress of the command

result

[String]

Result of the command

startDate

[Date]

Start of the command
Example : 2020-01-23T04:56:07.000+00:00

date-time

status

[String]

Status of the command
Example : STARTED

Enum: STARTED, NOT_STARTED, FINISHED, UNKNOWN, ERROR, STARTED, NOT_STARTED, FINISHED, UNKNOWN, ERROR

3.87. CommandProgress

Command progress status

Field Name Required Type Description Format

current

[Integer]

Current index of the progress

max

[Integer]

Max index of the progress

3.88. Company

Company (Société)

Field Name Required Type Description Format

address

Address

The company's main address
Remark : In add APIs (mainly PUT requests) address model is not expected, use the addressId field instead.

addressId

[String]

The id of the company's main address

calendar

Calendar

Details of the calendar
Remark : In add APIs (mainly PUT requests) calendar model is not expected, use the calendarId field instead.

calendarId

[String]

ID of the calendar

code

[String]

Code of the company
Example : AK

color

[String]

Color attached to the company

currency

Currency

Details about the currency
Remark : In add APIs (mainly PUT requests) currency model is not expected, use the currencyId field instead.

currencyId

[String]

The currency id

id

[String]

Id in database
Example : 5000123

legalName

[String]

Legal name of the company

name

[String]

Name of a company
Example : Akuiteo

siren

[String]

SIREN number

siret

[String]

SIRET number

3.89. CompanyBase

Company

Field Name Required Type Description Format

code

[String]

Code of the company
Example : AK

id

[String]

Id in database
Example : 5000123

name

[String]

Name of a company
Example : Akuiteo

3.90. ComparisonOperator

Comparison operator

Type : enum (BEFORE, AFTER, EQUAL, BEFORE_EQUAL, AFTER_EQUAL)

3.91. ConditionOfPayment

The condition of payment

Field Name Required Type Description Format

code

[String]

Payment code
Example : 5 days End of month by bank transfer
Remark : This property is read-only and provides current data without allowing modifications.

day

[Double]

Day of the month on which the payment will be done
Example : 10

double

deadLine

[String]

Number of days to carry out the payment
Example : 5

term

[String]

Period of payment
Example : 1

3.92. ContactBase

Contact

Field Name Required Type Description Format

code

[String]

The code of the contact.
Example : CT2024

firstName

[String]

The first name of the contact.
Example : Phillipe

id

[String]

Id in database
Example : 5000123

name

[String]

The name of the contact.
This field is mandatory.

Example : Jean

3.93. ContractBase

Contracts

Field Name Required Type Description Format

accountingJournal

AccountingJournal

Details of the accounting journal
Remark : In add APIs (mainly PUT requests) accountingJournal model is not expected, use the accountingJournalId field instead.

accountingJournalId

[String]

ID of Accounting Journal
Example : 1203

afterTaxAmount

[Double]

After-Tax amount expressed in company currency
Example : 120.37

double

afterTaxAmountCurrency

[Double]

After-Tax amount in the currency
Example : 1500

double

approvalDate

[Date]

Date of approval
Example : 2020-01-23T04:56:07.000+00:00

date-time

approvalState

ApprovalState

State of approval
Example : NONE

assignmentIndicator

AssignmentIndicator

Specifies the type of project and phase: mono project and mono phase, mono project and multi phase, or multi project.

Example : SINGLE_PROJECT_MONO_PHASE

changeTracking

ChangeTracking

code

[String]

Code of the contract

companyCode

[String]

The company code
Example : AKSAS

companyId

[String]

ID of the company
Example : 5000123

conditionOfPayment

ConditionOfPayment

currency

Currency

Currency used in the management object

currencyCode

[String]

Code of the currency used in the management object
Example : EUR

customData

Map of CustomData

The custom data (when present)

date

[Date]

Date on the management object
Example : 2020-01-23T04:56:07.000+00:00

date-time

description

[String]

Description
Example : Lorem ipsum

entityCode (Deprecated)

[String]

The entity code
Example : Lyon
Deprecated : Use entityId instead

exchangeRate

[Double]

The currency's exchange rate
Warning: This property will soon be read-only. We advise against modifying its value when creating or updating the object that contains it.

Example : 10.26

double

fiscalYear

FiscalYearBase

Belonging fiscal year
Remark : In add APIs (mainly PUT requests) fiscalYear model is not expected, use the fiscalYearId field instead.

fiscalYearId

[String]

Id of the fiscalYear
Example : 5000123

group

[Boolean]

Group object

id

[String]

Id in database
Example : 5000123

internal

[Boolean]

Internal object

manager

EmployeeBase

Details of the employee
Remark : In add APIs (mainly PUT requests) manager model is not expected, use the managerId field instead.

managerId

[String]

Id of the manager
Example : 5000123

methodOfPayment

MethodOfPayment

Method of payment
Example : CREDIT_CARD

name

[String]

Name of the management object
Example : Label for my doc

number

[String]

The number of the management object
Example : CC00001

payment (Deprecated)

Payment

Deprecated : Use conditionOfPayment instead

phase

PhaseBase

Details about the phase of the project.
Remark : In add APIs (mainly PUT requests) phase model is not expected, use the phaseId field instead.

phaseId

[String]

ID of the phase
Example : 5000123

preTaxAmount

[Double]

Pre-Tax Amount expressed in company currency
Example : 100.14

double

preTaxAmountCurrency

[Double]

Pre-Tax Amount in the currency
Example : 100.14

double

pricingMethod

PricingMethodBase

Details about the pricing method. The method by which pricing is to be determined.
Remark : In add APIs (mainly PUT requests) pricingMethod model is not expected, use the pricingMethodId field instead.

pricingMethodId

[String]

The id of the pricing method
Example : 5000125

project

ProjectBase

All details about the project
Remark : In add APIs (mainly PUT requests) project model is not expected, use the projectId field instead.

projectId

[String]

ID of the project (equivalent to the code of the project)
Example : PRJT_001

projectTask

ProjectTaskCommon

Details about the project task of the project
Remark : In add APIs (mainly PUT requests) projectTask model is not expected, use the projectTaskId field instead.

projectTaskId

[String]

Id of the project task
Example : 5000123

subPhase

SubPhaseBase

Details about the sub-phase of the project
Remark : In add APIs (mainly PUT requests) subPhase model is not expected, use the subPhaseId field instead.

subPhaseId

[String]

ID of the sub-phase
Example : 51000122

thirdPartyId

[String]

The Id of the third-party
Example : CUSTOMER01

thirdPartyToBillId

[String]

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

type

ManagementObjectType

Example : QUOTATION

3.94. ContractServiceBase

Contact service (basic information)

Field Name Required Type Description Format

code

[String]

The code of the contract service.
Example : CODE

id

[String]

Id in database
Example : 5000123

name

[String]

The name of the contract service.
Example : Text

3.95. 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

[Boolean]

Set as 'true' if the user is allowed to select multiple values from the valueSelectors.
Set as 'false' by default.

Example : true

defaultValue

[Object]

Default value of the field
Example : 50 (for the field 'Kilometers' case)

enabled

[Boolean]

Return true if the field is enabled
Example : true

freeValue

[Boolean]

Set as 'true' if the user is not restricted to the values listed in valueSelectors and can set a freely chosen value.
Example : true

id

[String]

ID of the control behavior
Example : 50000123

information

[String]

Additional information of the field
Example : Lorem ipsum

property

[String]

Name of the property controlled
Example : Kilometers

required

[Boolean]

Return true if the field is required
Example : true

valueSelectors

List of [string]

Customizable list of values for selection, allowing the restriction of permissible values in fields.

visible

[Boolean]

Return true if the field is visible
Example : true

3.96. Country

Country

Field Name Required Type Description Format

calendar

Calendar

The calendar of the company linked to the country
Remark : In add APIs (mainly PUT requests) calendar model is not expected, use the calendarId field instead.

calendarId

[String]

Id of the calendar
Example : 5000123

code

[String]

Code of the country
Example : FR

companyCode

[String]

The code of the company linked to the country
Example : AKSAS

companyId

[String]

ID of the company
Example : 5000123

continent

[String]

The continent where the country is located
Example : AFRICA

currency

Currency

The country's currency
Remark : In add APIs (mainly PUT requests) currency model is not expected, use the currencyId field instead.

currencyId

[String]

Id of the country's currency
Example : 5000123

id

[String]

Id in database
Example : 5000123

isPartOfEU

[Boolean]

Returns true if the country is part of the European Union
Example : true

name

[String]

Name of the country
Example : Country 1

3.97. Currency

Currency

Field Name Required Type Description Format

code

[String]

Code of the currency
Example : EUR

endDate

[Date]

End date for using the currency
Example : 2020-01-23T04:56:07.000+00:00

date-time

euro

[Boolean]

Returns true if the currency is in euro
Example : true

euroRate

[Double]

Exchange rate against the euro.
By default, this field contains the exchange rate corresponding to the current date.

Example : 0.9678

double

euroRateEndDate

[Date]

End date of the exchange rate (euroRate field).
Example : 2020-01-23T04:56:07Z
Remark : This property is read-only and provides current data without allowing modifications.

date-time

euroRateStartDate

[Date]

Start date of the exchange rate (euroRate field).
Example : 2020-01-23T04:56:07Z
Remark : This property is read-only and provides current data without allowing modifications.

date-time

id

[String]

Id in database
Example : 5000123

name

[String]

Name of the currency
Example : Euro

order

[Integer]

Order number of the currency
Example : 17

3.98. CustomData

Custom data

Field Name Required Type Description Format

label

[String]

Label of the custom data
Example : REFERENCE_4

name

[String]

Name of the custom data
Example : Reference 4

realOrder

[Integer]

Order number to display

int32

type

CustomDataType

Type of the custom data
Example : NUMBER

value

[Object]

Value of the custom data
Example : Autoref 010520

3.99. CustomDataPage

Page of the custom data

Field Name Required Type Description Format

columnNumber

[Integer]

Number of custom data page columns.
Example : 15

id

[String]

ID of the custom data page

name

[String]

The name of the custom data page.
Example : Text

order

[Integer]

The order (ranking) of the custom data page.
Example : 1

int32

3.100. CustomDataParam

Description of a parameter of custom data

Field Name Required Type Description Format

id

[String]

ID of the custom data

keywordId

[String]

ID of the keyword

label

[String]

Label of the custom data
Example : REFERENCE_4

multiLine

[Boolean]

True if custom data is multi line

name

[String]

Name of the custom data

order

[Integer]

Order of the custom data

int32

page

CustomDataPage

Page of the custom data
Remark : In add APIs (mainly PUT requests) page model is not expected, use the pageId field instead.

pageId

[String]

ID of the page
Example : 5000123

pattern

CustomDataPattern

Validation pattern of the custom field
Example : DATE_TIME

property

[String]

Property of the custom data

realOrder

[Integer]

Real order of the custom data

int32

section

CustomDataSection

Section of the custom data
Remark : In add APIs (mainly PUT requests) section model is not expected, use the sectionId field instead.

sectionId

[String]

ID of the section
Example : 5000123

sequence

[Integer]

Sequence of the custom data

int32

textLimit

[Integer]

Text limit of the custom data

int32

type

CustomDataType

Type of the custom data
Example : NUMBER

viewLabel

[Boolean]

True if label is visible

3.101. 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.102. CustomDataSection

Section for custom data

Field Name Required Type Description Format

columnNumber

[Integer]

Column number of the custom data section

id

[String]

ID of the custom data section

name

[String]

Name of the custom data section

order

[Integer]

Order number of the custom data section
Example : 1

int32

pageId

[String]

ID of the page
Example : 5000123

type

CustomDataSectionType

By default set as SECTION
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.

Example : SECTION

3.103. 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.104. CustomDataType

Type of the CustomData

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

3.105. CustomerBase

Customer

Field Name Required Type Description Format

code

[String]

The code of the third party (customer, supplier, other third party).
This field cannot be updated once it has been created.

Example : CA122

id

[String]

Id in database
Example : 5000123

name

[String]

The name of the third party (customer, supplier, other third party).
This field is mandatory.

Example : Akuiteo

3.106. CustomerIndicator

Customer Indicator

Field Name Required Type Description Format

byDefault

[Boolean]

Set as true to use this customer indicator by default. Set as false by default
Example : false

code

[String]

Code of the Customer Indicator

colorHexCode

[String]

The Hexadecimal color code for this customer Indicator

customerId (Deprecated)

[String]

ID of the Customer
Example : 5000123
Deprecated : This field is deprecated and will be removed in future versions.

id

[String]

Id in database
Example : 5000123

name

[String]

Name of the Customer Indicator

order

[Integer]

The order (ranking) of this customer indicator

int32

3.107. CustomerIndicatorCriteria

Criteria used to get more details about the customer indicator

Field Name Required Type Description Format

byDefault

ClauseBoolean

True if customer indicator is by default

code

ClauseString

colorHexCode

ClauseString

id

ClauseString

name

ClauseString

3.108. CustomerIndicators

Indicators of a customer

Field Name Required Type Description Format

customerId

[String]

ID of the Customer
Example : 5000123

indicator1

CustomerIndicator

The first indicator

indicator2

CustomerIndicator

The second indicator

indicator3

CustomerIndicator

The third indicator

3.109. CustomerSiteBase

Customer Sites

Field Name Required Type Description Format

code

[String]

Code of the customer site

customer (Deprecated)

CustomerBase

Details about the customer
Deprecated : This field is deprecated and will soon be moved to Site. You can continue to use this field.
Remark : In add APIs (mainly PUT requests) customer model is not expected, use the customerId field instead.

customerId (Deprecated)

[String]

Code of the associated customer
Example : CUST_001
Deprecated : This field is deprecated and will soon be moved to Site. You can continue to use this field.

id

[String]

Id in database
Example : 5000123

name

[String]

Name of the customer site
Example : Paris

3.110. CustomerStatus

Customer Status

Field Name Required Type Description Format

code

[String]

Code of the Customer Status
Example : CODE

companyId

[String]

ID of the company
Example : 5000123

endDate

[Date]

The end date of the customer status.
Example : 2020-01-23T04:56:07.000+00:00

date-time

id

[String]

Id in database
Example : 5000123

name

[String]

Name of the Customer Status
Example : Name

ranking

[Integer]

The customer status ranking in the list
Example : 5

int32

3.111. CustomizableResources

Customizable resources (Ressources personnalisables)

Type : enum (ISSUE, OPPORTUNITY, OPPORTUNITY_LINE, CUSTOM_REQUEST, EVENT, PROJECT, PHASE, SUB_PHASE, EMPLOYEE, CUSTOMER, CONTACT, SALES, PURCHASE)

3.112. DateParamHolder

Date given in parameter

Field Name Required Type Description Format

date

[Date]

Date
Example : 2020-01-23T04:56:07.000+00:00

date-time

3.113. DayMoment

The moment in a day.

Type : enum (MORNING, AFTERNOON)

3.114. Department

Division

Field Name Required Type Description Format

activities

List of ActivityBase

Activities of the department

analysis

[String]

Analysis of the department

code

[String]

Code of the department
Example : 01-A

comment

[String]

Comment of the department

companyCode

[String]

Code of the company
Example : AKSAS

entity

Entity

Details of the entity
Remark : In add APIs (mainly PUT requests) entity model is not expected, use the entityId field instead.

entityId

[String]

ID of the entity

id

[String]

Id in database
Example : 5000123

name

[String]

Description of the department
Example : Lorem Ipsum

projectType

ProjectType

Type of the project
Example : EXTERNAL

3.115. Discount

Discount on a Management Object Line

Field Name Required Type Description Format

amount

[Double]

The discount amount
Example : 150.75

double

amountCurrency

[Double]

The discount amount in the currency
Example : 150.75

double

percentage

[Double]

The discount percentage
Example : 20

double

type

DiscountType

Type of discount (PERCENT, AMOUNT)
Example : PERCENT

3.116. DiscountType

Type of discount

Type : enum (PERCENT, AMOUNT)

3.117. Division

Division

Field Name Required Type Description Format

code

[String]

Code of a division
Example : RA

companyId

[String]

Id of the company
Example : 5000123

group

DivisionGrouping

Details about the group
Remark : In add APIs (mainly PUT requests) group model is not expected, use the groupId field instead.

groupId

[String]

ID of the group
Example : 5000123

id

[String]

Id in database
Example : 5000123

name

[String]

Name of a division
Example : Rhone-Alpes

3.118. DivisionGrouping

Division grouping

Field Name Required Type Description Format

code

[String]

Code of a division grouping
Example : WST

id

[String]

Id in database
Example : 5000123

name

[String]

Name of a division grouping
Example : West

serviceId

[String]

ID of the service
Example : 5000123

3.119. DmfBase

A dmf (a right in akuiteo D - Functional Area, M - Module, F - Feature)

Field Name Required Type Description Format

code

[String]

The code of the right(dmf).
Example : AF0406

id

[String]

Id in database
Example : 5000123

name

[String]

The name of the right(dmf).
Example : INFO

3.120. Document

Details about document (file or link)

Field Name Required Type Description Format

action

Action

Details about the action performed on the document
Example : ADD

archived

[Boolean]

Return true if the document is archived.
To update this field, use Archive or unarchive document

Example : false

category

Category

All details about the category of the product
Remark : In add APIs (mainly PUT requests) category model is not expected, use the categoryId field instead.

category1

[String]

First category of the document
Example : CAT1

category2

[String]

Second category of the document
Example : CAT2

category3

[String]

Third category of the document
Example : CAT3

categoryId

[String]

The Id of the category
Example : 100024

changeTracking

ChangeTracking

Creation and modification date and user

classification

[String]

Classification of the document.
To change this field, use Classify a document

Example : STD

companyId

[String]

ID of the company
Example : 5000123

description

[String]

The description of the document
Example : Text

documentType

[String]

Type of the document.
Warning: This property will soon be read-only. We advise against modifying its value when creating or updating the object that contains it.

Example : File

externalDMSUuid

[String]

External ID when you use a DMS
Example : OD1245126

fileName

[String]

File name
Example : thisFile.pdf

fileUrl

[String]

File url. This field cannot be updated once it has been created.
Example : myFiles/thisFile.pdf

id

[String]

Is of the document
Example : 5000123

lienUrl

[String]

URL of the document
Example : myStorage.com/myFiles/thisFile.pdf

links

List of DocumentLink

Details about document's links

locked

[Boolean]

Set as true if the document is locked.
To update this field, use Lock and unlock document

Example : false

original

[Boolean]

Return true if the document is an original.
To update this field, use only the specific API: Set a document record sheet as original or Set a document record sheet as not original

Example : false

owner

EmployeeBase

Details about the publisher of the document.
Remark : In add APIs (mainly PUT requests) owner model is not expected, use the ownerId field instead.

ownerId

[String]

ID of the owner of the document.
Example : 5001206

preview

[String]

Preview of the document
Example : data:image

publicationDate

[Date]

Publication date
Example : 2020-01-23T04:56:07.000+00:00

date-time

publishedBy

UserBase

Details about the publisher of the document.
Remark : In add APIs (mainly PUT requests) publishedBy model is not expected, use the publishedById field instead.

publishedById

[String]

ID of the publisher of the document.
Example : 5001206

subCategory

SubCategory

All details about the sub-category of the product
Remark : In add APIs (mainly PUT requests) subCategory model is not expected, use the subCategoryId field instead.

subCategoryId

[String]

The Id of the sub-category
Example : 11037

subClassification

[String]

Sub-classification of the document
To change this field, use Classify a document

Example : EDITIONS

title

X

[String]

Title of the document
Example : Title

tokenPreview

[String]

Token to request by url the preview of the document
Example : 8946A85V85D851DF

url

[String]

URL of the document
Example : myFiles/thisFile.pdf

version

[Double]

Version of the document
Example : 1

double

versionId

[String]

ID of the version
Example : 5000123

A link between a document and any other object

Field Name Required Type Description Format

document

Document

Details about the document
Remark : In add APIs (mainly PUT requests) document model is not expected, use the documentId field instead.

documentId

[String]

ID of the document
Example : 5000123

id

[String]

ID of the link
Example : 5000123

objectId

[String]

ID of the object linked to the document
Example : 5000123

objectType

LinkedObjectType

Details about the type of object linked
Example : CUSTOMER

original

[Boolean]

Return true if the document is an original
Example : true

3.122. DocumentVersion

DocumentVersion

Field Name Required Type Description Format

classification

[String]

Classification of the document.
Example : STD

documentId

[String]

ID of the document
Example : 500111635

id

[String]

Id in database
Example : 5000123

title

[String]

Title of the document
Example : Title

version

[Double]

Version number
Example : 1

double

3.123. DueDate

Due date

Field Name Required Type Description Format

amount

[Double]

Amount to pay
Example : 5000123

double

currencyCode

[String]

Code of the currency
Example : EUR

date

[Date]

Due date
Example : 2020-01-23T04:56:07.000+00:00

date-time

id

[String]

Id in database
Example : 5000123

invoiceId

[String]

ID of the invoice
Example : 5000123

3.124. DueDateCriteria

Criteria used to get more details about the due date

Field Name Required Type Description Format

invoiceId

ClauseString

Ident of the invoice

3.125. Durations

Duration in different units

Field Name Required Type Description Format

durationDay

[Double]

Duration in day
Example : 0.25

double

durationHour

[Double]

Duration in hour
Example : 2.7

double

durationHourMinute

[Double]

Duration in hour minute
Example : 2.3

double

durationMinute

[Double]

Duration in minute
Example : 240

double

3.126. DutiableCriteria

Search criteria for dutiable fields

Field Name Required Type Description Format

forcedVat

ClauseBoolean

Forced VAT clause

vat1

ClauseString

VAT code 1

vat2

ClauseString

VAT code 2

3.127. DutiableLine

Tax Line

Field Name Required Type Description Format

action

Action

The action verb (ADD / UPDATE / REMOVE)
Example : ADD

additionalFreeFields

AdditionalFreeFields

Additional free fields of a line

afterTaxAmountTotal

[Double]

Total After-Tax amount expressed in company currency
Example : 1500

double

afterTaxAmountTotalCurrency

[Double]

Total After-Tax amount in the currency
Example : 1500

double

amountTotal

[Double]

Total amount expressed in company currency
Example : 1200

double

amountTotalCurrency

[Double]

Total amount in the currency
Example : 1200

double

complementName

[String]

Description of the line
Example : Lorem ipsum

forcedVat

[Boolean]

Forced VAT for the line
Example : true

generalAccount

[String]

General Account
Example : 411000

id

[String]

Id in database
Example : 5000123

managementObjectId

[String]

Id of the management object
Example : 5000123

name

[String]

Name of the line
Example : Helpdesk

phase

PhaseBase

Details about the phase of the project.
Remark : In add APIs (mainly PUT requests) phase model is not expected, use the phaseId field instead.

phaseId

[String]

ID of the phase
Example : 5000123

project

ProjectBase

All details about the project
Remark : In add APIs (mainly PUT requests) project model is not expected, use the projectId field instead.

projectId

[String]

ID of the project (equivalent to the code of the project)
Example : PRJT_001

projectTask

ProjectTaskCommon

Details about the project task of the project
Remark : In add APIs (mainly PUT requests) projectTask model is not expected, use the projectTaskId field instead.

projectTaskId

[String]

Id of the project task
Example : 5000123

quantity

[Double]

Quantity of the product
Example : 3

double

rankNumber

[Double]

Rank number of the line
Example : 2

double

resource

EmployeeBase

Resource allocated to complete the task
Remark : In add APIs (mainly PUT requests) resource model is not expected, use the resourceId field instead.

resourceId

[String]

Id of the resource allocated to complete the task

subPhase

SubPhaseBase

Details about the sub-phase of the project
Remark : In add APIs (mainly PUT requests) subPhase model is not expected, use the subPhaseId field instead.

subPhaseId

[String]

ID of the sub-phase
Example : 51000122

totalPrice

[Double]

Total price before discount expressed in company currency (unit price * quantity)
Example : 1200

double

totalPriceCurrency

[Double]

Total price before discount in the currency (unit price * quantity)
Example : 1200

double

unitPrice

[Double]

Unit price of the product expressed in company currency
Example : 40

double

unitPriceCurrency

[Double]

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.

Example : 36.32

double

vat1

VATBase

Details about the first VAT rate

vat2

VATBase

Details about the second VAT rate

vatAmount1

[Double]

Amount expressed in company currency with the first VAT
Example : 120

double

vatAmount1Currency

[Double]

Amount in currency for the first VAT
Example : 126.57

double

vatAmount2

[Double]

Amount expressed in company currency for the second VAT
Example : 110

double

vatAmount2Currency

[Double]

Amount in currency for the second VAT
Example : 113.26

double

3.128. 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

PublishArguments

Required arguments to publish a document

toRecipients

List of MessageRecipient

Main mail recipients

3.129. ESignatureSignatoryType

Defines the type of signatory for electronic signatures.
A signatory can be either an employee or a contact.

Type : enum (CONTACT, EMPLOYEE)

3.130. ESignatureStatus

Electronic signature status of a management object

Type : enum (IN_PROGRESS, CANCELED, EXPIRED, SIGNED, FAILED, PENDING, SIGNATURE_REQUESTED)

3.131. ESignatureTransaction

Information on transactions for electronic signatures

Field Name Required Type Description Format

date

[Date]

The date of the transaction
Example : 2024-11-23T04:56:07Z
Remark : This property is read-only and provides current data without allowing modifications.

date-time

daysSpent

[Double]

Number of days since transaction was requested
Example : 240
Remark : This property is read-only and provides current data without allowing modifications.

double

id

[String]

Id in database
Example : 5000123

ranking

[Integer]

Rank number of transaction.
Example : 2

int32

rejectionReason

[String]

The reason for rejection if the signatory has refused to sign the document.
Example : Lorem ipsum

requesterId

[String]

The ID of the the transaction requester.
Example : 5000123

signatoryEmail

[String]

Signatory e-mail address
Example : user@email.com

signatoryId

[String]

The ID of th signatory
Example : 500012

signatoryType

ESignatureSignatoryType

The type of signatory for electronic signatures.
This field is required if signatoryId is provided.

Example : CONTACT

signatureDate

[Date]

The date of signature.
Example : 2024-11-23T04:56:07Z
Remark : This property is read-only and provides current data without allowing modifications.

date-time

signatureStatus

ESignatureStatus

Status of the signature
Example : IN_PROGRESS

status

TransactionStatus

Status of the transaction
Example : IN_PROGRESS

3.132. EmployeeBase

Employees

Field Name Required Type Description Format

action

Action

The action verb
Example : ADD

code

[String]

Code of the employee
Example : CASH

firstName

[String]

First name of the employee
Example : Jean

id

[String]

Id in database
Example : 5000123

name

[String]

Name of the employee
Example : DUPONT

3.133. Entity

Entity

Field Name Required Type Description Format

code

[String]

The code of the entity
Example : 01-BRDX

companyId

[String]

ID of the company
Example : 5000123

division

Division

Details of the division
Remark : In add APIs (mainly PUT requests) division model is not expected, use the divisionId field instead.

divisionCode

[String]

Code of the division
Example : 01-DIV

divisionId

[String]

ID of the division
Example : 5000123

endDate

[Date]

End date of the entity
Example : 2020-01-23T04:56:07Z

date-time

id

[String]

Id in database
Example : 5000123

legalName

[String]

Legal name of the entity
Example : Customer care

name

[String]

The name of the entity
Example : Bordeaux

3.134. EntityBase

Entity

Field Name Required Type Description Format

code

[String]

The code of the entity
Example : 01-BRDX

id

[String]

Id in database
Example : 5000123

name

[String]

The name of the entity
Example : Bordeaux

3.135. ErrorMessage

Error message for batch processing

Field Name Required Type Description Format

id

[String]

ID of the object in error
Example : 5000123

message

[String]

Detailed error message related to the identifier
Example : Lorem ipsum

3.136. ErrorResponse

The canonical model for problem details is a JSON [RFC7159] object.

Field Name Required Type Description Format

code

[String]

A human-readable explanation specific to this occurrence of the problem.

message

[String]

A human-readable explanation specific to this occurrence of the problem.

status

[Integer]

The HTTP status code ([RFC7231], Section 6)
Example : 404

timestamp

[Date]

Timestamp of the error
Example : 2020-01-23T04:56:07.000+00:00

date-time

title

[String]

A short, human-readable summary of the problem

type

[String]

A URI reference [RFC3986] that identifies the problem type

3.137. 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.138. ExchangeRate

Exchange Rate

Field Name Required Type Description Format

currency

Currency

Details about the currency
Remark : In add APIs (mainly PUT requests) currency model is not expected, use the currencyId field instead.

currencyId

[String]

Id of the currency
Example : 12006

endDate

[Date]

End date for using the exchange rate
Example : 2020-01-23T04:56:07.000+00:00

date-time

id

[String]

Id in database
Example : 5000123

rate

[Double]

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

double

startDate

[Date]

Start date for using the exchange rate
Example : 2020-01-23T04:56:07.000+00:00

date-time

3.139. ExpenseReceiptSummary

Details about the expense receipt

Field Name Required Type Description Format

amount

[Double]

Amount on the receipt
Example : 240

double

currencyCode

[String]

Code of the currency
Example : EUR

date

[Date]

Date of the document
Example : 2020-01-23T04:56:07.000+00:00

date-time

expenseTypeCode

[String]

Code of expense's type
Example : FC

filePath

[String]

Path of the document
Example : C/User/MyUser/MyReceipt.pdf

rebillable

[Boolean]

Return true if the expense can be rebilled
Example : true

3.140. FeatureFlag

Application feature

Field Name Required Type Description Format

active

[Boolean]

If the feature is active

domain

[String]

Feature classification (main level)

id

[String]

Feature identifier

label

[String]

Feature description

subDomain

[String]

Feature classification (detail level)

3.141. FieldError

Object containg the error for a field

Field Name Required Type Description Format

elementId

[String]

The id of the sub element in error (which can have several errors)
Example : 154478

fieldName

X

[String]

The fieldName of the field in error
Example : code

message

X

[String]

The error message
Example : The field is required

3.142. FinancialConditionOfPayment

The condition of payment for a customer

Field Name Required Type Description Format

code

[String]

Payment code
Example : 5 days End of month by bank transfer
Remark : This property is read-only and provides current data without allowing modifications.

day

[Double]

Day of the month on which the payment will be done
Example : 10

double

deadLine

[String]

Number of days to carry out the payment
Example : 5

referenceOnBankStatement

[String]

Reference on bank statement
Example : LIVIA

term

[String]

Period of payment
Example : 1

3.143. FiscalYearBase

Fiscal Year

Field Name Required Type Description Format

code

[String]

Code of the FiscalYear

id

[String]

Id in database
Example : 5000123

journalEntryNumberingId

[String]

Id of the JournalEntryNumbering
Example : 5000123

name

[String]

Name of the FiscalYear

3.144. FiscalYearCommon

Fiscal Year

Field Name Required Type Description Format

closingDate

[date]

Date on which the fiscal year is officially closed.
This field is automatically updated during the accounting closure process.

Example : 2020-12-25
Remark : This property is read-only and provides current data without allowing modifications.

date

code

[String]

Code of the FiscalYear

endDate

[date]

Fiscal year's end date
Example : 2020-12-25

date

id

[String]

Id in database
Example : 5000123

journalEntryNumberingId

[String]

Id of the JournalEntryNumbering
Example : 5000123

name

[String]

Name of the FiscalYear

startDate

[date]

Fiscal year's start date
Example : 2020-12-25

date

3.145. FixedAssetRecordSheetBase

Fixed asset record sheet

Field Name Required Type Description Format

id

[String]

Id in database
Example : 5000123

name

[String]

Name of fixed asset record sheet
Example : IMMO0409

3.146. FixedAssetRecordSheetCommon

Fixed asset record sheet

Field Name Required Type Description Format

id

[String]

Id in database
Example : 5000123

name

[String]

Name of fixed asset record sheet
Example : IMMO0409

number

[String]

Number of fixed assets

Example : IMMO0409
Remark : This property is read-only and provides current data without allowing modifications.

3.147. FixedAssetType

Type of fixed asset

Type : enum (TANGIBLE, INTANGIBLE, FINANCIAL, NONE)

3.148. ForcedVatAmountHolder

VAT Amount and forced indicator holder

Field Name Required Type Description Format

amount

[Double]

Forced amount
Example : 124.56

double

forced

X

[Boolean]

Returns true if the amount is forced
Example : true

managementObjectLineId

[String]

ID of the management object line
Example : 780023

3.149. FormConfig

Form Config

Field Name Required Type Description Format

controls

Map of ControlBehavior

Details about the control behavior linked to the field

deletable

[Boolean]

Deletion allowed
Example : false

editable

[Boolean]

Update allowed
Example : false

fields (Deprecated)

List of ControlBehavior

Details about the control behavior linked to the field
Deprecated : Use controls instead

formSearchHidden

[Boolean]

Form search hidden
Example : false

insertable

[Boolean]

Creation allowed
Example : true

type

FormConfigType

Type of the formConfig
Example : TIMESHEET

3.150. 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.151. GeneralAccountBase

General account (ident example AKSAS22106800)

Field Name Required Type Description Format

id

[String]

Id in database
Example : 5000123

name

[String]

General account label
Example : Customers

3.152. GeneralAccountCommon

General account

Field Name Required Type Description Format

id

[String]

Id in database
Example : 5000123

name

[String]

General account label
Example : Customers

number

[String]

General account number
Example : 411000

3.153. GeographicalDepartment

Geographical department

Field Name Required Type Description Format

code

[String]

Code of the geographical department
Example : 7

companyId

[String]

The id of the company
Example : 5000123

id

[String]

Id in database
Example : 5000123

name

[String]

Name of the geographical department
Example : ARDECHE

regionId

[String]

The id of the region
Example : 5000123

3.154. HistoryEntry

State of a project

Field Name Required Type Description Format

action

[String]

Action of the modification
Example : MODIFICATION

changeTracking

ChangeTracking

Date and user in case of creation and modification

comment

[String]

Comment of the modification
Example : MODIF_EN_LOT

entryType

HistoryEntryType

Type of the entry
Example : HEADER

fieldName

[String]

Name of the modified field
Example : Domaine

historyType

HistoryType

Type of the modified object
Example : ISSUE

id

[String]

ID of the modification
Example : 5000123

objectId

[String]

ID of the modified object
Example : 5000123

valueAfter

[String]

Value after the modification
Example : PROJECT_2

valueBefore

[String]

Value before the modification
Example : PROJECT_1

3.155. HistoryEntryReadOption

ReadOption of a HistoryEntry

Field Name Required Type Description Format

options

List of [string]

List of options used to get more details about the history entry

Enum: CHANGE_TRACKING

3.156. HistoryEntryType

Type of the entry

Type : enum (HEADER, DETAIL)

3.157. 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.158. Holiday

Holiday

Field Name Required Type Description Format

date

[Date]

Date of the holiday
Example : 2020-01-23T04:56:07.000+00:00

date-time

type

[String]

Type of holiday
Example : FERIE

3.159. IBAN

Details about the IBAN of a people

Field Name Required Type Description Format

accountNumber

[String]

Account number - 11 digits max
Example : 0000157841Z

country

[String]

Country code of the address in the database
Example : FR (for 'FRANCE')

key

[String]

Key of the IBAN
Example : 69

3.160. IdIdentifiable

Basic type for all pojos with an API ID

Field Name Required Type Description Format

id

[String]

Id in database
Example : 5000123

3.161. InternationalBankAccountDetails

International bank account details

Field Name Required Type Description Format

bank

InternationalBankIdentification

Details to identify the international bank

holder

InternationalBankHolder

Holder of the international bank

3.162. InternationalBankHolder

Holder of the international bank

Field Name Required Type Description Format

accountNumber

[String]

Account number
Example : 123456789

accountType

AccountType

Type of the account for the holder
Example : IBAN

firstName

[String]

The first name of the holder
Example : BRITA

name

[String]

The name of the holder
Example : RITA

3.163. InternationalBankIdentification

Details to identify the international bank

Field Name Required Type Description Format

bankAddress

Address

Details about bank address

bankCode

[String]

The code of the bank
Example : C8

bankName

[String]

The name of the bank
Example : UBA

bankName2

[String]

The name 2 of the bank
Example : UBA

bankType

BankType

The type of the bank
Example : BIC

3.164. InventoryAndPackaging

Details about Inventory and Packaging

Field Name Required Type Description Format

packagingType

[String]

The packaging type of the item
Example : Warehouse

packagingUnit

[Double]

The packaging unit of the item
Example : 12

double

3.165. InvoiceTypeEnum

Invoice type

Type : enum (INVOICE, CREDIT)

3.166. IssueBase

Issue base

Field Name Required Type Description Format

id

[String]

Id in database
Example : 5000123

3.167. IssueCommon

Issue common

Field Name Required Type Description Format

id

[String]

Id in database
Example : 5000123

number

[String]

The number of the issue.
Example : 24121212

title

[String]

The title of the issue.
Example : Text

3.168. Item

Item

Field Name Required Type Description Format

accountSettings

ItemAccountingInfo

Accounting information for an item.

billingMode

BillingMode

defaut billing mode for the item
Example : TIME_BASED

category

Category

All details about the category of the product
Remark : In add APIs (mainly PUT requests) category model is not expected, use the categoryId field instead.

categoryId

[String]

The Id of the category
Example : 10024

comment

[String]

Comment on the product
Example : Lorem ipsum

companyCode

[String]

The company code
Example : AKSAS

customData

Map of CustomData

All custom data to update

entityCode

[String]

The entity code
Example : Lyon

family (Deprecated)

[String]

The category of the product
Example : FML-LICENCE
Deprecated : Use category instead

grouping

[String]

The grouping of the product
Example : LICENCE

id

[String]

Id in database
Example : 5000123

inventory

[Boolean]

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

inventoryAndPackaging

InventoryAndPackaging

Details about Inventory and Packaging

name

[String]

Identification name
Example : Maintenance

productionEstimatedDuration

[Double]

Estimated duration in minutes
Example : 30

double

quantityPrecision

[Double]

Number of decimals for this item quantity
Example : 2

double

reference

[String]

The reference of the product
Example : ENGLISH

shortName

[String]

Abbreviated designation
Example : Maint

subCategory

SubCategoryItem

All details about the sub-category of the product
Remark : In add APIs (mainly PUT requests) subCategory model is not expected, use the subCategoryId field instead.

subCategoryId

[String]

The Id of the sub-category
Example : 11037

subFamily (Deprecated)

[String]

The sub-category of the product
Example : RECCURENT
Deprecated : Use subCategory instead

unitPricePrecision

[Double]

Number of decimals for this item unit price
Example : 3

double

3.169. ItemAccountingInfo

Accounting information for an item

Field Name Required Type Description Format

disabledDate

[date]

Disabled date of the purchased item.
Example : 2020-12-25

date

exportCostAccount

[String]

Number of the export cost account set for purchased item export transactions.
Example : 411000

exportGroupAccount

[String]

Number of the export group account set for purchased item export group transactions.
Example : 411000

intraComCostAccount

[String]

Number of the intra-community cost account set for purchased item intracom transactions.
Example : 411000

intraComGroupAccount

[String]

Number of the intra-community group account set for purchased item intracom group transactions.
Example : 411000

intraComInternalAccount

[String]

Number of intra-community internal account set for purchased item intracom internal transactions.
Example : 411000

intraComSubscriptionAccount

[String]

Number of the intra-community subscription account set for purchased item intracom subscription transactions.
Example : 411000

localCostAccount

[String]

Number of the local cost account set for purchased item local transactions.
Remark: the account number must be a general cost account

Example : 411000

localGroupAccount

[String]

Number of the local group account set for purchased item local group transactions.
Example : 411000

localInternalAccount

[String]

Number of the local internal account set for purchased item local internal transactions.
Example : 411000

localSubscriptionAccount

[String]

Number of the local subscription account set for purchased item local subscription transactions.
Example : 411000

marketEndDate

[date]

End of market of the purchased item.
Example : 2020-12-25

date

reverseVAT

[Boolean]

Set the purchased item with reverse VAT liability.
Example : true

toBeEstablishedAccount

[String]

To be established account
Example : 411000

vatCode

X

[String]

Code of the VAT tax rate for the purchased item.
Example : 1

3.170. ItemBase

Item

Field Name Required Type Description Format

id

[String]

Id in database
Example : 5000123

3.171. ItemCommon

Details about the commons item's properties

Field Name Required Type Description Format

grouping

[String]

The grouping of the product
Example : LICENCE

id

[String]

Id in database
Example : 5000123

name

[String]

The name of the product
Example : English licence

reference

[String]

The reference of the product
Example : ENGLISH

3.172. ItemLine

ItemLine

Field Name Required Type Description Format

action

Action

The action verb (ADD / UPDATE / REMOVE)
Example : ADD

additionalFreeFields

AdditionalFreeFields

Additional free fields of a line

afterTaxAmountTotal

[Double]

Total After-Tax amount expressed in company currency
Example : 1500

double

afterTaxAmountTotalCurrency

[Double]

Total After-Tax amount in the currency
Example : 1500

double

amountTotal

[Double]

Total amount expressed in company currency
Example : 1200

double

amountTotalCurrency

[Double]

Total amount in the currency
Example : 1200

double

complementName

[String]

Description of the line
Example : Lorem ipsum

discount

Discount

Discount applied

endDate

[Date]

Period end date
Example : 2020-01-23T04:56:07.000+00:00

date-time

forcedVat

[Boolean]

Forced VAT for the line
Example : true

generalAccount

[String]

General Account
Example : 411000

id

[String]

Id in database
Example : 5000123

item

Item

Details about the item
Remark : In add APIs (mainly PUT requests) item model is not expected, use the itemId field instead.

itemId

[String]

The Id of the product
Example : 10727

managementObjectId

[String]

Id of the management object
Example : 5000123

name

[String]

Name of the line
Example : Helpdesk

phase

PhaseBase

Details about the phase of the project.
Remark : In add APIs (mainly PUT requests) phase model is not expected, use the phaseId field instead.

phaseId

[String]

ID of the phase
Example : 5000123

project

ProjectBase

All details about the project
Remark : In add APIs (mainly PUT requests) project model is not expected, use the projectId field instead.

projectId

[String]

ID of the project (equivalent to the code of the project)
Example : PRJT_001

projectTask

ProjectTaskCommon

Details about the project task of the project
Remark : In add APIs (mainly PUT requests) projectTask model is not expected, use the projectTaskId field instead.

projectTaskId

[String]

Id of the project task
Example : 5000123

quantity

[Double]

Quantity of the product
Example : 3

double

rankNumber

[Double]

Rank number of the line
Example : 2

double

resource

EmployeeBase

Resource allocated to complete the task
Remark : In add APIs (mainly PUT requests) resource model is not expected, use the resourceId field instead.

resourceId

[String]

Id of the resource allocated to complete the task

startDate

[Date]

Period start date
Example : 2020-01-23T04:56:07.000+00:00

date-time

subPhase

SubPhaseBase

Details about the sub-phase of the project
Remark : In add APIs (mainly PUT requests) subPhase model is not expected, use the subPhaseId field instead.

subPhaseId

[String]

ID of the sub-phase
Example : 51000122

totalPrice

[Double]

Total price before discount expressed in company currency (unit price * quantity)
Example : 1200

double

totalPriceCurrency

[Double]

Total price before discount in the currency (unit price * quantity)
Example : 1200

double

unitPrice

[Double]

Unit price of the product expressed in company currency
Example : 40

double

unitPriceCurrency

[Double]

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.

Example : 36.32

double

vat1

VATBase

Details about the first VAT rate

vat2

VATBase

Details about the second VAT rate

vatAmount1

[Double]

Amount expressed in company currency with the first VAT
Example : 120

double

vatAmount1Currency

[Double]

Amount in currency for the first VAT
Example : 126.57

double

vatAmount2

[Double]

Amount expressed in company currency for the second VAT
Example : 110

double

vatAmount2Currency

[Double]

Amount in currency for the second VAT
Example : 113.26

double

3.173. JournalEntryNumberingBase

Numbering of the fiscal year journal entries

Field Name Required Type Description Format

fiscalYearId

[String]

Id of the fiscalYear
Example : 5000123

id

[String]

Id in database
Example : 5000123

prefix

[String]

Prefix of the JournalEntryNumbering

3.174. JournalType

Type of journal

Type : enum (SALES, PURCHASE, BANK, TRANSACTION, SIMULATION)

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

[String]

Code of the locations status.
Example : PRET

id

[String]

Id in database
Example : 5000123

name

[String]

Name of the location status.
Example : PRET MATERIEL

3.178. Mail

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

Field Name Required Type Description Format

body

[String]

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

[String]

Mail sender

replyTo

[String]

Mail reply to

title

[String]

Mail title

to

List of [string]

Mail recipients

3.179. ManagementCustomerCriteria

Criteria used on Customer when doing a Customer search

Field Name Required Type Description Format

accountManagerId

ClauseString

The ID of the account manager for the customer

categoryId

ClauseString

Category of the customer

code

ClauseString

Name of the customer

id

ClauseString

Ident of the customer

salesmanId

ClauseString

The ID of the sales man for the customer

sectorId

ClauseString

Sector of the customer

subCategoryId

ClauseString

Subcategory of the customer

type

ClauseString

Type of the customer (between PROSPECT and CUSTOMER)

3.180. ManagementObject

Management object (pièce de gestion)

Field Name Required Type Description Format

accountingJournal

AccountingJournal

Details of the accounting journal
Remark : In add APIs (mainly PUT requests) accountingJournal model is not expected, use the accountingJournalId field instead.

accountingJournalId

[String]

ID of Accounting Journal
Example : 1203

afterTaxAmount

[Double]

After-Tax amount expressed in company currency
Example : 120.37

double

afterTaxAmountCurrency

[Double]

After-Tax amount in the currency
Example : 1500

double

approvalDate

[Date]

Date of approval
Example : 2020-01-23T04:56:07.000+00:00

date-time

approvalState

ApprovalState

State of approval
Example : NONE

assignmentIndicator

AssignmentIndicator

Specifies the type of project and phase: mono project and mono phase, mono project and multi phase, or multi project.

Example : SINGLE_PROJECT_MONO_PHASE

changeTracking

ChangeTracking

companyCode

[String]

The company code
Example : AKSAS

companyId

[String]

ID of the company
Example : 5000123

conditionOfPayment

ConditionOfPayment

currency

Currency

Currency used in the management object

currencyCode

[String]

Code of the currency used in the management object
Example : EUR

customData

Map of CustomData

The custom data (when present)

date

[Date]

Date on the management object
Example : 2020-01-23T04:56:07.000+00:00

date-time

description

[String]

Description
Example : Lorem ipsum

entityCode (Deprecated)

[String]

The entity code
Example : Lyon
Deprecated : Use entityId instead

exchangeRate

[Double]

The currency's exchange rate
Warning: This property will soon be read-only. We advise against modifying its value when creating or updating the object that contains it.

Example : 10.26

double

fiscalYear

FiscalYearBase

Belonging fiscal year
Remark : In add APIs (mainly PUT requests) fiscalYear model is not expected, use the fiscalYearId field instead.

fiscalYearId

[String]

Id of the fiscalYear
Example : 5000123

group

[Boolean]

Group object

id

[String]

Id in database
Example : 5000123

internal

[Boolean]

Internal object

manager

EmployeeBase

Details of the employee
Remark : In add APIs (mainly PUT requests) manager model is not expected, use the managerId field instead.

managerId

[String]

Id of the manager
Example : 5000123

methodOfPayment

MethodOfPayment

Method of payment
Example : CREDIT_CARD

name

[String]

Name of the management object
Example : Label for my doc

number

[String]

The number of the management object
Example : CC00001

payment (Deprecated)

Payment

Deprecated : Use conditionOfPayment instead

phase

PhaseBase

Details about the phase of the project.
Remark : In add APIs (mainly PUT requests) phase model is not expected, use the phaseId field instead.

phaseId

[String]

ID of the phase
Example : 5000123

preTaxAmount

[Double]

Pre-Tax Amount expressed in company currency
Example : 100.14

double

preTaxAmountCurrency

[Double]

Pre-Tax Amount in the currency
Example : 100.14

double

pricingMethod

PricingMethodBase

Details about the pricing method. The method by which pricing is to be determined.
Remark : In add APIs (mainly PUT requests) pricingMethod model is not expected, use the pricingMethodId field instead.

pricingMethodId

[String]

The id of the pricing method
Example : 5000125

project

ProjectBase

All details about the project
Remark : In add APIs (mainly PUT requests) project model is not expected, use the projectId field instead.

projectId

[String]

ID of the project (equivalent to the code of the project)
Example : PRJT_001

projectTask

ProjectTaskCommon

Details about the project task of the project
Remark : In add APIs (mainly PUT requests) projectTask model is not expected, use the projectTaskId field instead.

projectTaskId

[String]

Id of the project task
Example : 5000123

subPhase

SubPhaseBase

Details about the sub-phase of the project
Remark : In add APIs (mainly PUT requests) subPhase model is not expected, use the subPhaseId field instead.

subPhaseId

[String]

ID of the sub-phase
Example : 51000122

thirdPartyId

[String]

The Id of the third-party
Example : CUSTOMER01

thirdPartyToBillId

[String]

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

type

ManagementObjectType

Example : QUOTATION

3.181. ManagementObjectBase

Basic information on the management object (pièce de gestion)

Field Name Required Type Description Format

id

[String]

Id in database
Example : 5000123

name

[String]

Name of the management object
Example : Label for my doc

number

[String]

The number of the management object
Example : CC00001

phase

PhaseBase

Details about the phase of the project.
Remark : In add APIs (mainly PUT requests) phase model is not expected, use the phaseId field instead.

phaseId

[String]

ID of the phase
Example : 5000123

project

ProjectBase

All details about the project
Remark : In add APIs (mainly PUT requests) project model is not expected, use the projectId field instead.

projectId

[String]

ID of the project (equivalent to the code of the project)
Example : PRJT_001

projectTask

ProjectTaskCommon

Details about the project task of the project
Remark : In add APIs (mainly PUT requests) projectTask model is not expected, use the projectTaskId field instead.

projectTaskId

[String]

Id of the project task
Example : 5000123

subPhase

SubPhaseBase

Details about the sub-phase of the project
Remark : In add APIs (mainly PUT requests) subPhase model is not expected, use the subPhaseId field instead.

subPhaseId

[String]

ID of the sub-phase
Example : 51000122

3.182. 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

[String]

Type of the management object processed in batches

3.183. ManagementObjectCommon

Details on common properties of management object (pièce de gestion)

Field Name Required Type Description Format

afterTaxAmount

[Double]

After-Tax amount expressed in company currency
Example : 120.37

double

changeTracking

ChangeTracking

companyCode

[String]

The company code
Example : AKSAS

companyId

[String]

ID of the company
Example : 5000123

currency

Currency

Currency used in the management object

currencyCode

[String]

Code of the currency used in the management object
Example : EUR

customData

Map of CustomData

The custom data (when present)

date

[Date]

Date on the management object
Example : 2020-01-23T04:56:07.000+00:00

date-time

description

[String]

Description
Example : Lorem ipsum

entityCode (Deprecated)

[String]

The entity code
Example : Lyon
Deprecated : Use entityId instead

id

[String]

Id in database
Example : 5000123

name

[String]

Name of the management object
Example : Label for my doc

number

[String]

The number of the management object
Example : CC00001

phase

PhaseBase

Details about the phase of the project.
Remark : In add APIs (mainly PUT requests) phase model is not expected, use the phaseId field instead.

phaseId

[String]

ID of the phase
Example : 5000123

preTaxAmount

[Double]

Pre-Tax Amount expressed in company currency
Example : 100.14

double

project

ProjectBase

All details about the project
Remark : In add APIs (mainly PUT requests) project model is not expected, use the projectId field instead.

projectId

[String]

ID of the project (equivalent to the code of the project)
Example : PRJT_001

projectTask

ProjectTaskCommon

Details about the project task of the project
Remark : In add APIs (mainly PUT requests) projectTask model is not expected, use the projectTaskId field instead.

projectTaskId

[String]

Id of the project task
Example : 5000123

subPhase

SubPhaseBase

Details about the sub-phase of the project
Remark : In add APIs (mainly PUT requests) subPhase model is not expected, use the subPhaseId field instead.

subPhaseId

[String]

ID of the sub-phase
Example : 51000122

thirdPartyId

[String]

The Id of the third-party
Example : CUSTOMER01

type

ManagementObjectType

Example : QUOTATION

3.184. ManagementObjectCriteria

Criteria used to get more details about the management object.

Field Name Required Type Description Format

afterTaxAmount

ClauseDouble

After tax amount of the management object

approvalDate

ClauseDate

Approval date of the management object

approvalState

ClauseString

Approval state of the management object

companyCode

ClauseString

Company code of the management object

creationDate

ClauseDate

Creation date of the management object

currencyCode

ClauseString

Currency code of the currency used in the management object

customData

Map of Clause

The custom data (when present)

date

ClauseDate

Date of the management object

description

ClauseString

Description of the management object

entityCode

ClauseString

Entity code of the management object

fiscalYearId

ClauseString

Id of the fiscal year

group

ClauseBoolean

True if group

id

ClauseString

ID of the management object

internal

ClauseBoolean

True if management object is internal

journalId

ClauseString

Id of the journal

managerId

ClauseString

Id of the manager linked with the management object

methodOfPayment

ClauseString

Method of payment of the management object

name

ClauseString

Name of the management object

preTaxAmount

ClauseDouble

Pre tax amount of the management object

thirdPartyId

ClauseString

Id of the third party

thirdPartyToBillId

ClauseString

Id of the third party to bill

validationDate

ClauseDate

Validation of the management object

3.185. ManagementObjectLine

Management object line (ligne de pièce de gestion)

Field Name Required Type Description Format

action

Action

The action verb (ADD / UPDATE / REMOVE)
Example : ADD

additionalFreeFields

AdditionalFreeFields

Additional free fields of a line

afterTaxAmountTotal

[Double]

Total After-Tax amount expressed in company currency
Example : 1500

double

afterTaxAmountTotalCurrency

[Double]

Total After-Tax amount in the currency
Example : 1500

double

amountTotal

[Double]

Total amount expressed in company currency
Example : 1200

double

amountTotalCurrency

[Double]

Total amount in the currency
Example : 1200

double

complementName

[String]

Description of the line
Example : Lorem ipsum

generalAccount

[String]

General Account
Example : 411000

id

[String]

Id in database
Example : 5000123

managementObjectId

[String]

Id of the management object
Example : 5000123

name

[String]

Name of the line
Example : Helpdesk

phase

PhaseBase

Details about the phase of the project.
Remark : In add APIs (mainly PUT requests) phase model is not expected, use the phaseId field instead.

phaseId

[String]

ID of the phase
Example : 5000123

project

ProjectBase

All details about the project
Remark : In add APIs (mainly PUT requests) project model is not expected, use the projectId field instead.

projectId

[String]

ID of the project (equivalent to the code of the project)
Example : PRJT_001

projectTask

ProjectTaskCommon

Details about the project task of the project
Remark : In add APIs (mainly PUT requests) projectTask model is not expected, use the projectTaskId field instead.

projectTaskId

[String]

Id of the project task
Example : 5000123

quantity

[Double]

Quantity of the product
Example : 3

double

rankNumber

[Double]

Rank number of the line
Example : 2

double

resource

EmployeeBase

Resource allocated to complete the task
Remark : In add APIs (mainly PUT requests) resource model is not expected, use the resourceId field instead.

resourceId

[String]

Id of the resource allocated to complete the task

subPhase

SubPhaseBase

Details about the sub-phase of the project
Remark : In add APIs (mainly PUT requests) subPhase model is not expected, use the subPhaseId field instead.

subPhaseId

[String]

ID of the sub-phase
Example : 51000122

totalPrice

[Double]

Total price before discount expressed in company currency (unit price * quantity)
Example : 1200

double

totalPriceCurrency

[Double]

Total price before discount in the currency (unit price * quantity)
Example : 1200

double

unitPrice

[Double]

Unit price of the product expressed in company currency
Example : 40

double

unitPriceCurrency

[Double]

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.

Example : 36.32

double

3.186. ManagementObjectLineCommon

Common properties of management object line

Field Name Required Type Description Format

amountTotal

[Double]

Total amount expressed in company currency
Example : 1200

double

amountTotalCurrency

[Double]

Total amount in the currency
Example : 1200

double

id

[String]

Id in database
Example : 5000123

managementObjectId

[String]

Id of the management object
Example : 5000123

name

[String]

Name of the line
Example : Helpdesk

phase

PhaseBase

Details about the phase of the project.
Remark : In add APIs (mainly PUT requests) phase model is not expected, use the phaseId field instead.

phaseId

[String]

ID of the phase
Example : 5000123

project

ProjectBase

All details about the project
Remark : In add APIs (mainly PUT requests) project model is not expected, use the projectId field instead.

projectId

[String]

ID of the project (equivalent to the code of the project)
Example : PRJT_001

projectTask

ProjectTaskCommon

Details about the project task of the project
Remark : In add APIs (mainly PUT requests) projectTask model is not expected, use the projectTaskId field instead.

projectTaskId

[String]

Id of the project task
Example : 5000123

quantity

[Double]

Quantity of the product
Example : 3

double

rankNumber

[Double]

Rank number of the line
Example : 2

double

subPhase

SubPhaseBase

Details about the sub-phase of the project
Remark : In add APIs (mainly PUT requests) subPhase model is not expected, use the subPhaseId field instead.

subPhaseId

[String]

ID of the sub-phase
Example : 51000122

unitPrice

[Double]

Unit price of the product expressed in company currency
Example : 40

double

unitPriceCurrency

[Double]

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.

Example : 36.32

double

3.187. ManagementObjectLineCriteria

Criteria used to get more details about the management object line.

Field Name Required Type Description Format

additionalFreeFieldCriteria

AdditionalFreeFieldsCriteria

dutiableCriteria

DutiableCriteria

endDate

ClauseDate

End period clause

generalAccountNumber

ClauseString

grouping

ClauseString

Grouping of the item

id

ClauseString

phaseId

ClauseString

projectCriteria

ManagementProjectCriteria

Criteria on project linked to the line

projectId

ClauseString

reference

ClauseString

Reference of the item

resourceId

ClauseString

Resource allocated to complete the task

startDate

ClauseDate

Start period clause

subPhaseId

ClauseString

3.188. 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.189. ManagementProjectCriteria

Criteria used on Project when doing a Project search

Field Name Required Type Description Format

activityId

ClauseString

categoryId

ClauseString

companyId

ClauseString

The Id of the company

customerId

ClauseString

customerProjectId

ClauseString

Ident of the project (equivalent to the code of the project)

departmentId

ClauseString

divisionGroupingId

ClauseString

divisionId

ClauseString

entityId

ClauseString

financialManagerId

ClauseString

id

ClauseString

managerId

ClauseString

name

ClauseString

productionManagerId

ClauseString

projectGroupCode

ClauseString

projectState

ClauseString

referentialDate

[Date]

Date à laquelle l'affaire doit être active (en prod)
Example : 2020-01-23T04:56:07.000+00:00

date-time

salesManagerId

ClauseString

subCategoryId

ClauseString

subCategoryLevel2Id

ClauseString

tag

ClauseString

Unused at the moment

yearId

ClauseString

Ident of the year

3.190. ManagerVisibilityCriteria

Manager's criteria

Field Name Required Type Description Format

includeManager

[Boolean]

Include manager in the search result

includeResourcesTwoManagementLevelsBelow

[Boolean]

Include resources from two management levels below (N-2) in the search result

managerId

[String]

Id of the manager
Example : 5000123

3.191. 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

AttachFileLocation

Location of the file to be attached.
Example : BODY

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).

mail

Mail

All details required to send an email (recipients, subject, body).

publishedDocuments

List of PublishedDocument

List of documents to be published as attached files.

replyTo

MessageRecipient

Mail recipient for reply-to.

toRecipients

List of MessageRecipient

List of primary recipients.

3.192. MessageRecipient

Recipient of a message

Field Name Required Type Description Format

address

[String]

The email address of the recipient.
Example : jean@email.com

id

[String]

Id in database
Example : 5000123

summary

[String]

A brief summary or description of the recipient.
Example : Text

type

MessageRecipientType

Type of message recipient.
Example : USER

3.193. MessageRecipientType

Message recipient type

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

3.194. 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.195. NoneSEPA

International bank detail

Field Name Required Type Description Format

beneficiary

InternationalBankAccountDetails

Details of the beneficiary's international bank account, including identification and account holder information.

defaultBankDetail

[Boolean]

Set as true if this international bank detail will be used by default.
Example : false

intermediate

InternationalBankAccountDetails

Details of the intermediate's international bank account, including identification and account holder information.

A link between a target object and other objects

Field Name Required Type Description Format

objectId

[String]

Id of the object linked to a target object
Example : 5000123

objectType

LinkedObjectType

Example : CUSTOMER

targetId

[String]

Id of target object
Example : 5000123

3.197. OpportunityBase

OpportunityBase

Field Name Required Type Description Format

code

[String]

The code of the opportunity.

Example : OP2025

id

[String]

Id in database
Example : 5000123

name

[String]

The name of the opportunity.
Example : ON PREMISE

3.198. OtherThirdPartieBase

Other Third Partie Base (Autre Tiers)

Field Name Required Type Description Format

code

[String]

The code of the third party (customer, supplier, other third party).
This field cannot be updated once it has been created.

Example : CA122

id

[String]

Id in database
Example : 5000123

name

[String]

The name of the third party (customer, supplier, other third party).
This field is mandatory.

Example : Akuiteo

3.199. OtherThirdPartyTypeBase

Type of Other Third-Party

Field Name Required Type Description Format

code

X

[String]

The code of the other third-party type
Example : AMOA

id

[String]

Id in database
Example : 5000123

name

X

[String]

The name of the other third-party type
Example : AMOA

3.200. PatchElement

A JSONPatch as defined by RFC 6902

Field Name Required Type Description Format

from

X

[String]

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

op

X

[String]

The operation to be performed
Example : ADD

Enum: ADD, REMOVE, REPLACE, TEST, MOVE, COPY, AK_APPEND, ADD, REMOVE, REPLACE, TEST, MOVE, COPY, AK_APPEND

path

X

[String]

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

value

[Object]

The value to be used within the operations.

3.201. PatchHolder

List of patches to apply to the idents specified

Field Name Required Type Description Format

ids

List of [string]

Idents to patch

patchElements

List of PatchElement

List of patches to apply

3.202. Payment

Payment

Field Name Required Type Description Format

code

[String]

Payment code
Example : 5 days End of month by bank transfer

day

[Double]

Day of the month on which the payment will be done
Example : 10

double

deadLine

[String]

Number of days to carry out the payment
Example : 5

term

[String]

Period of payment
Example : End of month

People Link

Field Name Required Type Description Format

defaultLink

[Boolean]

Determine the default people link used in the case. 'True' if the people link is the one to apply by default
Example : true

id

[String]

Id in database
Example : 5000123

linkSource

PeopleLinkType

Detail about the people link relationship between the path third party and another third party.
Remark : In add APIs (mainly PUT requests) linkSource model is not expected, use the linkSourceId field instead.

linkSourceId

[String]

Id of the type of people link for the source third party.
Example : 5000123

linkTarget

PeopleLinkType

Detail about the people linkTarget relationship between the path third party and another third party.
Remark : In add APIs (mainly PUT requests) linkTarget model is not expected, use the linkTargetId field instead.

linkTargetId

[String]

Id of the type of people link for the target third party.
Example : 5000123

linkType

PeopleLinkTypeEnum

A link can be set as a Management Link or a Filiation Link.
Example : MANAGEMENT_LINK

sourceThirdParty

ThirdPartyBase

Detail about the third party.
Remark : In add APIs (mainly PUT requests) sourceThirdParty model is not expected, use the sourceThirdPartyId field instead.

sourceThirdPartyId

[String]

Id of the source third party.
Example : 5000123

sourceThirdPartyType

ThirdPartyTypeEnum

Type of the source third party linked (PROSPECT, CUSTOMER, SUPPLIER OR OTHER_THIRD_PARTY)
Example : PROSPECT

targetThirdParty

ThirdPartyBase

Detail about the third party
Remark : In add APIs (mainly PUT requests) targetThirdParty model is not expected, use the targetThirdPartyId field instead.

targetThirdPartyId

[String]

Id of target third party to link.
Example : 5000123

targetThirdPartyType

ThirdPartyTypeEnum

Type of the target third party linked (PROSPECT, CUSTOMER, SUPPLIER OR OTHER_THIRD_PARTY)
Example : PROSPECT

3.204. PeopleLinkCriteria

Criteria used on People Link when doing a People Link search

Field Name Required Type Description Format

defaultLink

ClauseBoolean

If true, the people link is the one set by default on the third party with the link

id

ClauseString

linkSourceId

ClauseString

Id of the people link relationship between the path third party and another third party

linkTargetId

ClauseString

Id of the people link relationship between a third party and the path third party

linkType

ClauseString

A link can be set as a Management Link or a Filiation Link

readOption

PeopleLinkReadOption

Options for retrieving extra information concerning the peopleLink

sourceThirdPartyId

ClauseString

Id of the third party linked

sourceThirdPartyType

ClauseString

Type of the source third party linked (PROSPECT, CUSTOMER, SUPPLIER OR OTHER_THIRD_PARTY)

targetThirdPartyId

ClauseString

Id of the target third party with people links

targetThirdPartyType

ClauseString

Type of the third party with people links (PROSPECT, CUSTOMER, SUPPLIER OR OTHER_THIRD_PARTY)

3.205. PeopleLinkReadOption

Options used to get additional information when doing a peopleLink's search

Field Name Required Type Description Format

options

List of [string]

List of options used to get more details about the people link

Enum: LINK_SOURCE, LINK_TARGET, SOURCE_THIRD_PARTY, TARGET_THIRD_PARTY

3.206. PeopleLinkType

People Link Type

Field Name Required Type Description Format

code

[String]

The code for the type of People link.
Example : CODE

companyCode

[String]

The code of the company.
Example : AKSAS

description

[String]

The description for the type of People link.
Example : Loremp ipsum

id

[String]

Id in database
Example : 5000123

linkDirection

LinkDirectionEnum

A filation link type can be set with a link direction
Example : ASCENDING

static

[Boolean]

A link can be set as static if it is not intended to be modified
Example : true

type

PeopleLinkTypeEnum

A link can be set as a Management Link or a Filiation Link
Example : MANAGEMENT_LINK

3.207. PeopleLinkTypeCriteria

Criteria used on People Link Type when doing a Link Type search

Field Name Required Type Description Format

code

ClauseString

companyCode

ClauseString

id

ClauseString

type

ClauseString

A link can be set as a Management Link or a Filiation Link

3.208. PeopleLinkTypeEnum

A link can be set as a Management Link or a Filiation Link

Type : enum (MANAGEMENT_LINK, FILIATION_LINK)

3.209. Period

Period

Field Name Required Type Description Format

from

[Date]

Smaller date of the period
Example : 2020-01-23T04:56:07.000+00:00

date-time

granularity

PeriodGranularity

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

inclusivity

[String]

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

[Date]

Bigger date of the period
Example : 2020-01-23T04:56:07.000+00:00

date-time

3.210. PeriodGranularity

Granularity of a period

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

3.211. Periodicity

Periodicity

Field Name Required Type Description Format

code

PeriodicityCodeType

Periodicity of payment (0 &#8658; Unique (default); 1 &#8658; Annual; 2 &#8658; Bi-annual; 3 &#8658; Quarterly; 4 &#8658; Monthly)
Example : UNIQUE

duration

[Double]

Duration in month
Example : 3

double

id

[String]

Id in database
Example : 5000123

lineStartDate

[Date]

Start date of the line
Example : 2020-01-23T04:56:07Z

date-time

startDate

[Date]

Date by which the periodicity is starting
Example : 2020-01-23T04:56:07.000+00:00

date-time

tacitAgrement

[Boolean]

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

term

[Boolean]

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

3.212. PeriodicityCodeType

Type of tag

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

3.213. PhaseBase

Phase

Field Name Required Type Description Format

code

[String]

Code of a phase
Note: The phase code cannot be changed once it has been created.

Example : PHS_1

id

[String]

Id in database
Example : 5000123

name

[String]

Name of a phase
Example : Phase 1

order

[Integer]

Order number of the project
Example : 1

int32

project

ProjectBase

Details about the corresponding project
Remark : In add APIs (mainly PUT requests) project model is not expected, use the projectId field instead.

projectId

[String]

ID of the corresponding project (i.e. Code of the project)
Example : PRJ_1

3.214. PhaseState

State of a phase

Field Name Required Type Description Format

code

[String]

The code of the phase state
Example : PRO

companyId

[String]

ID of the company
Example : 5000123

default

[Boolean]

Set as true to use this phase state by default. Set as false by default
Example : false

id

[String]

ID of the phase state

name

[String]

The name of the phase state
Example : Production

3.215. PhaseStateCriteria

Criteria used on phase state when doing a phase state search

Field Name Required Type Description Format

code

ClauseString

companyId

ClauseString

id

ClauseString

name

ClauseString

3.216. PipeBase

Pipe base

Field Name Required Type Description Format

code

[String]

Code of the pipe
Example : BIZZ

id

[String]

Id in database
Example : 5000123

name

[String]

Name of the pipe
Example : Business

3.217. PluginFeature

Plugin Feature

Type : enum (BRIDGE, CHORUS, EDOC, PRESTATIONS, UNIVERSIGN, API_GOOGLE, AKUITEO_SAAS)

3.218. 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

[Date]

Precise date to be updated.
If provided, this date will automatically be set on the object.
To use this field, type must be set to EXACT_DATE.

Example : 2020-01-23T04:56:07Z

date-time

period

PostponePeriod

Period shift information for postponing the date. To use this field, type must be set to SHIFT_BY_PERIOD.

type

X

PostponeType

Defines how the date is postponed: either by exact date, period shift, or reset.
EXACT_DATE allows postponing to a specific date.
SHIFT_BY_PERIOD allows postponing using a defined period shift.
RESET_DATE allows clearing the date.
If this field is set to RESET_DATE, the values in postponeToExactDate and postponeByPeriod are ignored, if provided, and the line date will be cleared.

Example : EXACT_DATE

3.219. 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

[Integer]

Number of times the period should be shifted.
Example : 4

shiftPeriod

ShiftPeriod

Time unit for shifting the period.
Example : YEAR

3.220. PostponeType

Defines how the date postponement is handled

Type : enum (EXACT_DATE, SHIFT_BY_PERIOD, RESET_DATE)

3.221. PricingMethodBase

The method by which pricing is to be determined

Field Name Required Type Description Format

code

[String]

The code of the pricing method
Example : AKAS

id

[String]

The ID in database of the pricing methods
Example : 5000123

name

[String]

The name given to the pricing method
Example : TARIFS AKAS

3.222. ProbabilityLevel

Probability of the level being accepted.

Type : enum (0, 1, 2, 3, 4, 9)

3.223. ProductionInformations

Production informations

Field Name Required Type Description Format

billingTargetDay

[Integer]

Billing target day of the month for the production to be billed. Empty if the billing mode is not production to be billed.
Example : 5

int32

defaultDisplay

[Boolean]

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.
Example : false

estimatedDuration

[Integer]

The production estimated duration in minutes. Empty if the billing mode is not production to be billed.
Example : 240

int32

linkedToAdvancePayments

[Boolean]

Returns true if the production is linked to advance payments. Set as 'false' by default.
Example : true

targetDay

[Integer]

Target day of the month for the production. Empty if the billing mode is not production to be billed.
Example : 22

int32

team

ProductionTeamBase

Details about the production team.
Remark : In add APIs (mainly PUT requests) team model is not expected, use the teamId field instead.

teamId

[String]

ID of the production team
Example : 5000123

3.224. ProductionTeamBase

Production team base

Field Name Required Type Description Format

code

[String]

Code of the production team
Example : PRD

id

[String]

Id in database
Example : 5000123

name

[String]

Name of the production team
Example : PROD

3.225. Profession

Details about the profession of the people

Field Name Required Type Description Format

code

[String]

Code of the Profession
Example : LYR

id

[String]

Id in database
Example : 5000123

name

[String]

Name of the Profession
Example : Lawyer

3.226. ProfessionalCategory

Professional Category

Field Name Required Type Description Format

code

[String]

Code of the Professional Category
Example : CODE

companyId

[String]

ID of the company
Example : 5000123

id

[String]

Id in database
Example : 5000123

name

[String]

Name of the Professional Category
Example : Name

ranking

[Integer]

The professional category ranking in the list
Example : 5

int32

3.227. ProjectBase

Project

Field Name Required Type Description Format

companyCode

[String]

Code of the company
Example : AKSAS

customer

CustomerBase

Details of the customer
Remark : In add APIs (mainly PUT requests) customer model is not expected, use the customerId field instead.

customerId

[String]

Id of the project's customer
To update this field,use the specific API : Update the customer's project

Example : 5000123

customerType

ProjectCustomerType

Customer type
Example : ALL_CUSTOMERS

endCustomer

CustomerBase

Details of the customer
Remark : In add APIs (mainly PUT requests) endCustomer model is not expected, use the endCustomerId field instead.

endCustomerId

[String]

Id of the project's end customer
Example : 5000123

id

[String]

Id in database
Example : 5000123

internal

[Boolean]

If the project is internal or not
Example : false

leave

[Boolean]

Return true if the project is a leave project
Example : false

leaveType

ProjectLeaveType

Details about leave type
Example : WITH_REQUEST

name

[String]

Name of a project
Example : My project

3.228. ProjectCommon

Shared information about projects, across domains.

Field Name Required Type Description Format

color

[String]

Color of the project (hexadecimal code)

companyCode

[String]

Code of the company
Example : AKSAS

customer

CustomerBase

Details of the customer
Remark : In add APIs (mainly PUT requests) customer model is not expected, use the customerId field instead.

customerId

[String]

Id of the project's customer
To update this field,use the specific API : Update the customer's project

Example : 5000123

customerType

ProjectCustomerType

Customer type
Example : ALL_CUSTOMERS

endCustomer

CustomerBase

Details of the customer
Remark : In add APIs (mainly PUT requests) endCustomer model is not expected, use the endCustomerId field instead.

endCustomerId

[String]

Id of the project's end customer
Example : 5000123

id

[String]

Id in database
Example : 5000123

internal

[Boolean]

If the project is internal or not
Example : false

leave

[Boolean]

Return true if the project is a leave project
Example : false

leaveType

ProjectLeaveType

Details about leave type
Example : WITH_REQUEST

name

[String]

Name of a project
Example : My project

projectEnd (Deprecated)

[Date]

End date of a project
Example : 2020-01-23T04:56:07.000+00:00
Deprecated : Use project/productionEnd/actualDate instead

date-time

projectStart (Deprecated)

[Date]

Start date of a project
Example : 2020-01-23T04:56:07.000+00:00
Deprecated : Use project/productionStart/actualDate instead

date-time

projectState

ProjectState

State of the project
Remark : In add APIs (mainly PUT requests) projectState model is not expected, use the projectStateId field instead.

projectStateId

[String]

Id of the state of the project
Example : 5000123

3.229. ProjectCustomerType

Type of relation with the customers

Type : enum (ALL_CUSTOMERS, MULTI_CUSTOMERS, SINGLE_CUSTOMER)

3.230. 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.231. ProjectGroup

ProjectGroup

Field Name Required Type Description Format

code

[String]

The code of the project group.
Example : PARC

description

[String]

Description of the project group.
Example : Lorem ipsum

id

[String]

Id in database
Example : 5000123

name

[String]

The name of the project group.
Example : PARC

3.232. ProjectLeaveType

Type of Project leave

Type : enum (WITH_REQUEST, CALENDAR, NO_TIMESHEETS)

3.233. ProjectState

State of a project

Field Name Required Type Description Format

code

[String]

The code of the project state
Example : PRO

companyCode (Deprecated)

[String]

Code of the company
Example : AKSAS
Deprecated : Use companyId instead

companyId

[String]

ID of the company
Example : 5000123

id

[String]

ID of the project state

name

[String]

The name of the project state
Example : Production

3.234. ProjectStateCriteria

Criteria used on project state when doing a project state search

Field Name Required Type Description Format

activeModule

ActiveModule

Example : EXPENSE_REPORTS

code

ClauseString

companyId

ClauseString

id

ClauseString

name

ClauseString

tag

ClauseString

You can fill in the code or name of the tag in this field

3.235. ProjectTaskBase

The Project task base

Field Name Required Type Description Format

code (Deprecated)

[String]

Code of the task
Deprecated : unused

id

[String]

Id in database
Example : 5000123

name

[String]

Name of the task
Example : Team building

3.236. ProjectTaskCommon

The Project task common

Field Name Required Type Description Format

code (Deprecated)

[String]

Code of the task
Deprecated : unused

customer

CustomerBase

Details about the customer
Remark : In add APIs (mainly PUT requests) customer model is not expected, use the customerId field instead.

customerId

[String]

ID of the customer
Example : 5000123

description

[String]

Description of the task

endDate

[Date]

End date of the task
Example : 2020-01-23T04:56:07.000+00:00

date-time

id

[String]

Id in database
Example : 5000123

name

[String]

Name of the task
Example : Team building

order

[Integer]

Order number of the task
Example : 2

int32

phase

PhaseBase

Details about the phase of the project.
Remark : In add APIs (mainly PUT requests) phase model is not expected, use the phaseId field instead.

phaseId

[String]

ID of the phase
Example : 5000123

project

ProjectBase

All details about the project
Remark : In add APIs (mainly PUT requests) project model is not expected, use the projectId field instead.

projectId

[String]

ID of the project (equivalent to the code of the project)
Example : PRJT_001

startDate

[Date]

Start date of the task
Example : 2020-01-23T04:56:07.000+00:00

date-time

subPhase

SubPhaseBase

Details about the sub-phase of the project
Remark : In add APIs (mainly PUT requests) subPhase model is not expected, use the subPhaseId field instead.

subPhaseId

[String]

ID of the sub-phase
Example : 51000122

3.237. ProjectTaskType

The parameters of different type of project task

Field Name Required Type Description Format

byDefault

[Boolean]

Set as true to use this type of task by default when adding a new task.
Example : false

code

[String]

The code to give to this project task type
Example : R&D

companyId

[String]

ID of the company
Example : 5000123

id

[String]

ID of the project task type

label

[String]

The project task type name / label
Example : Tâche R&D

rankNumber

[Integer]

The project task type ranking in the list
Example : 5

type

TaskBillingType

Example : TIME_BASED

3.238. ProjectType

Project type

Type : enum (EXTERNAL, INTERNAL, ALL)

3.239. PublishArguments

Required arguments to publish a document.

Field Name Required Type Description Format

extension

[String]

Document type
Example : .pdf

parameters

List of PublishTemplateParameter

Details about the template parameters

saveDocument

[Boolean]

Return true if the generated document is linked to the business document.
Example : true

template

PublishTemplate

Details about the template

3.240. PublishContextBase

Context for publication, destined for use by specific API

Field Name Required Type Description Format

contextType

[String]

Context of the publish
Example : Timesheet entries

displayOptions

Map of [string]

Options for data display
Example : Weekend, Scheduled rate, Validated, etc…​

filters

Map of [array]

Filter for data selection discriminating by object IDs grouped by object type
Example : Entity, Services, Employee, etc…​

3.241. PublishTemplate

Details about the template used to publish.

Field Name Required Type Description Format

code

[String]

The template code
Example : MODELE_EDITION_001

defaultTemplate

[Boolean]

Return true if it's the default's template
Example : true

endDate

[Date]

End of validity of the template
Example : 2020-01-23T04:56:07.000+00:00

date-time

extensions

List of [string]

Extension types available for the document
Example : .pdf, .docx

id

[String]

Id in database
Example : 5000123

interactive

[Boolean]

Return true if the model needs any parameters to be generated
Example : true

name

[String]

The template name
Example : Edition model for my documents

order

[Integer]

Order number
Example : 1

int32

path

[String]

Path where you can find the template.
Example : C://MyDoc/Template/modele_edition_001

publishType

PublishType

Publish type
Example : OPPORTUNITY

type

PublishTemplateType

Details about the template type

3.242. PublishTemplateParameter

Parameters of a Publish template.

Field Name Required Type Description Format

controlType

PublishTemplateParameterType

Details about the type of the parameter
Example : TEXT_BOX

groupName

[String]

Name of the parameter group
Example : text_box

labelText

[String]

Label of the parameter
Example : Detail BL

nameField

[String]

Name of the parameter
Example : DetailBL

nameFieldNext

[String]

Name of the next parameter
Example : DetailCheckbox

pattern

[String]

Pattern of the parameter
Example : cl

required

[Boolean]

Return true if the paramater is required
Example : true

selectionList

List of PublishTemplateParameterChoice

Details of each value of a LIST_BOX parameter

value

[Object]

Value of the parameter
Example : checked

3.243. 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

[String]

The label
Example : Bank transfer

value

[String]

The value
Example : BT

3.244. PublishTemplateParameterType

Type of parameter.

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

3.245. 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

[String]

Code of the template type
Example : TEMP01

modelDescription

[String]

Description of the model
Example : Lorem Ipsum

modelId

[String]

ID of the model
Example : 5000123

name

[String]

Name of the template type
Example : Template one

3.246. 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.247. PublishedDocument

Published Document.

Field Name Required Type Description Format

documentId

[String]

Document ID
Example : 112302

isDocument

[Boolean]

Return true if the document is available in Akuiteo
Example : true

token

[String]

Details about the published document (whether the publish is okay or not, where you can find the document, its size)

3.248. RecipientContact

Contact recipient of a management object

Field Name Required Type Description Format

companyId

[String]

ID of the company
Example : 5000123
Remark : This property is read-only and provides current data without allowing modifications.

contactId

[String]

The ID of the contact
Example : 5000023

email

[String]

The email of the contact recipient
Example : email@email.com
Remark : This property is read-only and provides current data without allowing modifications.

firstName

[String]

The first name of the contact recipient
Example : John
Remark : This property is read-only and provides current data without allowing modifications.

id

[String]

Id in database
Example : 5000123

name

[String]

The name of the contact recipient .
Example : Doe
Remark : This property is read-only and provides current data without allowing modifications.

title

[String]

Civility of the contact recipient
Example : Mr
Remark : This property is read-only and provides current data without allowing modifications.

type

RecipientContactType

Example : IN_COPY

3.249. RecipientContactType

Type of recipient

Type : enum (IN_COPY, RECIPIENT)

3.250. RecurringAmountsInfo

Amounts calculated based on the recurrence period defined in the management object lines.

Field Name Required Type Description Format

afterTaxAmount

[Double]

After-tax amount in the company currency, calculated automatically, considering any recurrence
Example : 1440

double

afterTaxAmountCurrency

[Double]

After-tax amount in the specified currency, calculated automatically, considering any recurrence
Example : 1440

double

preTaxAmount

[Double]

Pre-tax amount in the company currency, calculated automatically, considering any recurrence
Example : 1200

double

preTaxAmountCurrency

[Double]

Pre-tax amount in the specified currency, calculated automatically, considering any recurrence
Example : 1200

double

vatAmount

[Double]

VAT amount expressed in the company currency
Example : 240

double

vatAmountCurrency

[Double]

VAT amount expressed in the specified currency
Example : 240

double

3.251. Region

Region

Field Name Required Type Description Format

code

[String]

Code of the region
Example : 84

companyCode

[String]

The code of the company linked to the region
Example : AKSAS

companyId

[String]

ID of the company
Example : 5000123

country

Country

The country where the region is located
Remark : In add APIs (mainly PUT requests) country model is not expected, use the countryId field instead.

countryId

[String]

Id of the country where the region is located
Example : 5000123

id

[String]

Id in database
Example : 5000123

name

[String]

Name of the region
Example : Region 1

3.252. RepeatingYear

Repeating Year

Type : enum (YES, NO)

3.253. SEPA

Details SEPA banking information

Field Name Required Type Description Format

bankDetails

BankDetails

Details about the bank

bic

BIC

Details about the BIC

iban

IBAN

Details about the IBAN

3.254. ScheduleBase

Schedules

Field Name Required Type Description Format

actionCode

ActionCodeBase

Details about the action verb
Remark : In add APIs (mainly PUT requests) actionCode model is not expected, use the actionCodeId field instead.

actionCodeId

[String]

ID of the action code
Example : 130012

changeTracking

ChangeTracking

Date and user in case of creation and modification

comment

[String]

Comment of the calendar event

customer

CustomerBase

Details about the customer
Remark : In add APIs (mainly PUT requests) customer model is not expected, use the customerId field instead.

customerId

[String]

ID of the customer
Example : 5000123

date

[Date]

Date of the calendar event
Example : 2020-01-23T04:56:07.000+00:00

date-time

description

[String]

Description of the schedule
Example : Lorem ipsum

done

[Boolean]

Return True if the schedule is done
Example : false

duration

[Double]

Duration of the calendar event
Example : 2

double

durations

Durations

Duration in different units

employee

EmployeeBase

Details about the employee
Remark : In add APIs (mainly PUT requests) employee model is not expected, use the employeeId field instead.

employeeId

[String]

ID of the employee
Example : 5000123

guid

[String]

Global identifier of the calendar event (for mobile version only)

id

[String]

ID of the calendar event

location

[String]

Location of the calendar event
Example : Paris

phase

PhaseBase

Details about the phase
Remark : In add APIs (mainly PUT requests) phase model is not expected, use the phaseId field instead.

phaseId

[String]

ID of the phase
Example : 5000123

project

ProjectBase

Details about the project
Remark : In add APIs (mainly PUT requests) project model is not expected, use the projectId field instead.

projectId

[String]

ID of the project (equivalent to the code of the project)
Example : PRJT_1

projectTask

ProjectTaskBase

Details about the task
Remark : In add APIs (mainly PUT requests) projectTask model is not expected, use the projectTaskId field instead.

projectTaskId

[String]

ID of the project
Example : 5000123

subPhase

SubPhaseBase

Details about the sub-phase
Remark : In add APIs (mainly PUT requests) subPhase model is not expected, use the subPhaseId field instead.

subPhaseId

[String]

ID of the sub-phase
Example : 5000123

taskId

[String]

Helpdesk's task ident
Example : 5000123

type

[String]

Type of the calendar event
Example : SCHEDULE

unit

UnitDuration

Details about the unit of duration
Example : MINUTE

validated

[Boolean]

Return True if the calendar event is validated

3.255. SearchControlBehavior

Detail about behavior and area to display the field

Field Name Required Type Description Format

controlBehavior

ControlBehavior

Details about the control behavior linked to the field

searchFieldInformation

SearchFieldInformation

Details about the area linked to the field

3.256. 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

[String]

The section in which the search field will be displayed.
Example : Informations du devis

categoryTab

[String]

The tab in which the search field will be displayed.
Example : Critères principaux

code

[String]

The code of the search field
Example : CODE_ETAT

fieldOrder

[Integer]

Order number of the field
Example : 1

int32

group

[String]

Membership group of the field
Example : 10-DMF

id

[String]

The Id of the search field

name

[String]

The name of the search field
Example : Code état

primary

[Boolean]

True when the search field is primary and will be displayed in the main search area
Example : true

searchType

SearchFieldType

The type of the search field
Example : DROPDOWN_LIST

secondary

[Boolean]

True when the search field is secondary and will be displayed in the secondary search area.
Example : true

sectionOrder

[Integer]

Order number of the section
Example : 1

int32

tabOrder

[Integer]

Order number of the tab
Example : 1

int32

3.257. SearchFieldType

Type of search field

Type : enum (DROPDOWN_LIST, DATE, TEXT, BOOLEAN, NUMBER)

3.258. 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.259. Sector

Sector

Field Name Required Type Description Format

code

[String]

Code of the Sector
Example : CODE

companyId

[String]

ID of the company
Example : 5000123

endDate

[Date]

The end date of the Sector.
Example : 2020-01-23T04:56:07.000+00:00

date-time

id

[String]

Id in database
Example : 5000123

name

[String]

Name of the Sector
Example : Name

ranking

[Integer]

The sector ranking in the list
Example : 5

int32

3.260. 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

[String]

Mode of fields selection. If INCLUDE or EXCLUDE without fields all fields will be included
Example : INCLUDE

Enum: INCLUDE, EXCLUDE, INCLUDE, EXCLUDE

3.261. Service

Service

Field Name Required Type Description Format

code

[String]

Code of the service
Example : PS

id

[String]

Id in database
Example : 5000123

name

[String]

Name of the service
Example : Professional services

3.262. ShiftPeriod

Time unit for shifting the period.

Type : enum (YEAR, HALF_YEAR, QUARTER, MONTH, WEEK, DAY)

3.263. Skill

Skill of an employee

Field Name Required Type Description Format

code

[String]

Code of the skill
Example : ENG

id

[String]

Id in database
Example : 5000123

name

[String]

Name of the skill
Example : English

typeCode

[String]

Code of the skill's type
Example : LANGUAGE

typeLabel

[String]

Label of the skill's type
Example : Language

3.264. SoldItem

Sold item

Field Name Required Type Description Format

accountSettings

ItemAccountingInfo

Accounting information for an item.

automaticTitle

[String]

Automatic title for a sold item, used for structuring and hierarchization of elements that utilize this sold item.
Example : IT PRODUCT

billingMode

BillingMode

defaut billing mode for the item
Example : TIME_BASED

category

Category

All details about the category of the product
Remark : In add APIs (mainly PUT requests) category model is not expected, use the categoryId field instead.

categoryId

[String]

The Id of the category
Example : 10024

comment

[String]

Comment on the product
Example : Lorem ipsum

companyCode

[String]

The company code
Example : AKSAS

customData

Map of CustomData

All custom data to update

entityCode

[String]

The entity code
Example : Lyon

family (Deprecated)

[String]

The category of the product
Example : FML-LICENCE
Deprecated : Use category instead

grouping

[String]

The grouping of the product
Example : LICENCE

id

[String]

Id in database
Example : 5000123

inventory

[Boolean]

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

inventoryAndPackaging

InventoryAndPackaging

Details about Inventory and Packaging

name

[String]

Identification name
Example : Maintenance

productionEstimatedDuration

[Double]

Estimated duration in minutes
Example : 30

double

productionInformations

ProductionInformations

Details about productions informations

quantityPrecision

[Double]

Number of decimals for this item quantity
Example : 2

double

reference

[String]

The reference of the product
Example : ENGLISH

shortName

[String]

Abbreviated designation
Example : Maint

subCategory

SubCategoryItem

All details about the sub-category of the product
Remark : In add APIs (mainly PUT requests) subCategory model is not expected, use the subCategoryId field instead.

subCategoryId

[String]

The Id of the sub-category
Example : 11037

subFamily (Deprecated)

[String]

The sub-category of the product
Example : RECCURENT
Deprecated : Use subCategory instead

unitPricePrecision

[Double]

Number of decimals for this item unit price
Example : 3

double

3.265. SoldItemCriteria

Search criteria for sold items

Field Name Required Type Description Format

billingMode

ClauseString

Billing mode for the sold item

categoryId

ClauseString

The ID of the category

companyCode

ClauseString

Code of the company

customData

Map of Clause

The custom data (when present)

defaultDisplay

ClauseBoolean

Set as “True” to load only productions should be displayed by default. If not specified, all productions are loaded.

entityId

ClauseString

Ident of the entity of the sold item

grouping

ClauseString

Grouping of the sold item

id

ClauseString

Ident of the sold item

inventory

ClauseBoolean

Returns true if the product is in the inventory

linkedToAdvancePayments

ClauseBoolean

Set as True to return production linked to advance payments.

marketEndDate

ClauseDate

End-of-sale date for the sold item. Indicates when the product stopped being available for sale

name

ClauseString

Identification name

packagingType

ClauseString

The packaging type of the sold item

readOption

SoldItemReadOption

Options for retrieving extra information concerning the billing table

reference

ClauseString

Reference of the sold item

subCategoryId

ClauseString

The ID of the sub category

tag

ClauseString

You can fill in the reference or grouping of the tag in this field

teamId

ClauseString

The ID of the production team

validity

Validity

Details about the validity of the sold item

3.266. 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.267. SortField

Couple field/sort type

Field Name Required Type Description Format

fieldName

[String]

Name of the field
Example : number

order

SortType

Sort type. (ASC or DESC)
Example : ASC

3.268. SortType

Sort type for search

Type : enum (ASC, DESC)

3.269. StageBase

Oppportunity Stage Base

Field Name Required Type Description Format

code

[String]

The code of the opportunity stage
Example : ANNULATION

id

[String]

Id in database
Example : 5000123

name

[String]

Name of the opportunity stage
Example : Analysis

3.270. StandardAction

Standard action for an event

Type : enum (INSERT, UPDATE, DELETE)

3.271. 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

[String]

Code of the standard week
Example : DEFAULT

id

[String]

Id in database
Example : 5000123

name

[String]

Name of the standard week
Example : Default week

3.272. StatusFilter

Filtering criteria based on resource status.

Field Name Required Type Description Format

dateOperator

ComparisonOperator

Defines how the reference date is used to filter resources based on whether they have the specified status or not.
If set to BEFORE, the filter retrieves all resources having or not the specified status before the reference date.
If set to AFTER, it retrieves resources having or not the status after the reference date. BEFORE_EQUAL includes resources having or not the status on or before the reference date, while AFTER_EQUAL includes those having it on or after the reference date.
EQUAL retrieves only the resources having or not the status exactly on the reference date.
If this field is not provided, the default comparison operator is BEFORE_EQUAL with the reference date.
If no reference date is provided, the comparison will use BEFORE_EQUAL with the current date.

Example : BEFORE

isActive

[Boolean]

Indicates whether the resource status is active or inactive.
Example : true

referenceDate

[Date]

The reference date to check the status of the resource. If not provided, the current date is used by default.
Example : 2029-01-23T04:56:07Z

date-time

3.273. StringParamHolder

Parameter value (String).
See the documentation of the calling API body for further information

Field Name Required Type Description Format

value

[String]

Value
Example : true

3.274. 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.275. SubCategory

Sub-Category

Field Name Required Type Description Format

category

Category

Details about the category
Remark : In add APIs (mainly PUT requests) category model is not expected, use the categoryId field instead.

categoryId

[String]

The Id of the category
Example : 500143

code

[String]

The code of the sub-category
Example : LANG

company

Company

Details about the company
Remark : In add APIs (mainly PUT requests) company model is not expected, use the companyId field instead.

companyCode (Deprecated)

[String]

The code of the company
Example : AKSAS
Deprecated : Use companyId instead

companyId

[String]

ID of the company
Example : 5000123

endDate

[date]

End date for using the sub-category
Example : 2020-12-25

date

grouping

[String]

Grouping field for sub-category

id

[String]

Id in database
Example : 5000123

name

[String]

The name of the sub-category
Example : Language

ranking

[Integer]

Sub-category ranking in help lists

int32

type

CategoryType

Type of the category.
Example : SALES_ITEM

3.276. SubCategoryCriteria

Criteria used on sub-category when doing a sub-category search

Field Name Required Type Description Format

categoryId

ClauseString

Category's ident of the sub-category

code

ClauseString

Code of the sub-category

companyId

ClauseString

Company of the sub-category

endDate

ClauseDate

End date of validity for the sub-category

grouping

ClauseString

Grouping field of the sub-category

id

ClauseString

Ident of the sub-category

name

ClauseString

Name of the sub-category

nature

ClauseString

Nature of the sub-category

readOption

SubCategoryReadOption

Options for retrieving extra information concerning the sub-category

tag

ClauseString

You can fill in the code or name of the sub-category in this field

type

ClauseString

Type of the sub-category

validity

Validity

Details about the validity of the sub-category

3.277. SubCategoryItem

Sub category of an item

Field Name Required Type Description Format

category

Category

Details about the category
Remark : In add APIs (mainly PUT requests) category model is not expected, use the categoryId field instead.

categoryId

[String]

The Id of the category
Example : 500143

code

[String]

The code of the sub-category
Example : LANG

company

Company

Details about the company
Remark : In add APIs (mainly PUT requests) company model is not expected, use the companyId field instead.

companyCode (Deprecated)

[String]

The code of the company
Example : AKSAS
Deprecated : Use companyId instead

companyId

[String]

ID of the company
Example : 5000123

endDate

[date]

End date for using the sub-category
Example : 2020-12-25

date

grouping

[String]

Grouping field for sub-category

id

[String]

Id in database
Example : 5000123

name

[String]

The name of the sub-category
Example : Language

ranking

[Integer]

Sub-category ranking in help lists

int32

subCategoryType

SubCategoryItemType

Type of the purchased item sub-category
Example : PRESTATION

type

CategoryType

Type of the category.
Example : SALES_ITEM

3.278. SubCategoryItemClassification

Purchased item sub-category classification

Type : enum (EXTERNAL, INTERNAL, NOT_SPECIFIED, OTHERS, PRICE_REVIEW)

3.279. SubCategoryItemCriteria

Criteria used to get more details about Sub category of an item

Field Name Required Type Description Format

categoryId

ClauseString

The Id of the category

code

ClauseString

The code of the sub-category item

companyId

ClauseString

The Id of the company

endDate

ClauseDate

End date of validity for the sub-category item

grouping

ClauseString

Grouping field for sub-category item

id

ClauseString

The Id of the sub-category item

name

ClauseString

Name of the sub-category item

nature (Deprecated)

ClauseString

Nature of the sub-category item
Deprecated : Use subCategoryType instead

readOption

SubCategoryItemReadOption

Options for retrieving extra information concerning the sub-category of an item

subCategoryType

ClauseString

Type of the purchased item sub-category item

tag

ClauseString

You can fill in the code or name of the sub-category item in this field

type

ClauseString

Type of the sub-category item.

validity

Validity

Details about the validity of the sub-category item

3.280. 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.281. 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.282. 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.283. SubPhaseBase

SubPhase

Field Name Required Type Description Format

code

[String]

Code of a sub-phase
Example : SB_1

id

[String]

Id in database
Example : 5000123

name

[String]

Name of a sub-phase
Example : Sub Phase 1

order

[Integer]

Order number of the sub-phase
Example : 1

int32

phase

PhaseBase

Details about the corresponding phase
Remark : In add APIs (mainly PUT requests) phase model is not expected, use the phaseId field instead.

phaseId

[String]

ID of the corresponding phase
Example : 5000123

3.284. SubPhaseState

State of a sub-phase

Field Name Required Type Description Format

code

[String]

The code of the sub-phase state
Example : PRO

companyId

[String]

ID of the company
Example : 5000123

id

[String]

ID of the sub phase state

name

[String]

The name of the sub-phase state
Example : Production

3.285. SubPhaseStateCriteria

Criteria used on sub-phase state when doing a sub-phase state search

Field Name Required Type Description Format

code

ClauseString

companyId

ClauseString

id

ClauseString

name

ClauseString

3.286. SubledgerAccountBase

Subledger account (ident example AKSAS22106800)

Field Name Required Type Description Format

id

[String]

Id in database
Example : 5000123

name

[String]

Subledger account label
Example : Customer name

3.287. SubledgerAccountCommon

Subledger account

Field Name Required Type Description Format

id

[String]

Id in database
Example : 5000123

name

[String]

Subledger account label
Example : Customer name

number

[String]

Subledger account number

Example : C2181

3.288. Subscription

Subscription to listen events using SSE

Field Name Required Type Description Format

excludeMyOwnEvents

[Boolean]

Set as true to exclude the event of which I am the author.
Set as false by default.

Example : true

token

[String]

The token code allocated to the susbscription.
Example : ciOiJIUzI1NiIsInR5cCI6IkpXVCJ9

topic

Topic

Topic to listen events

3.289. SupplierBase

Suppliers

Field Name Required Type Description Format

code

[String]

The code of the third party (customer, supplier, other third party).
This field cannot be updated once it has been created.

Example : CA122

id

[String]

Id in database
Example : 5000123

name

[String]

The name of the third party (customer, supplier, other third party).
This field is mandatory.

Example : Akuiteo

3.290. SupplierSiteBase

Supplier Site Base (Site Fournisseur)

Field Name Required Type Description Format

id

[String]

Id in database
Example : 5000123

name

[String]

Name of the supplier site

supplierId (Deprecated)

[String]

Warning : The supplier ID cannot be changed once the supplier site has been created. Any modification will not be taken into account.

Deprecated : This field is deprecated and will soon be moved to supplierSite. You can continue to use this field.

3.291. SupplierType

Supplier type

Type : enum (INTERNAL, EXTERNAL, VIRTUAL)

3.292. 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.293. Tag

Tag

Field Name Required Type Description Format

code

[String]

Code of the tag
Example : ERR

color

[String]

Color of the tag
Example : #56b7c

comment

[String]

Comment of the tag
Example : Lorem ipsum

companyId

[String]

ID of the company
Example : 5000123

endDate

[Date]

End of validity of the tag
Example : 2020-01-23T04:56:07.000+00:00

date-time

icon

[String]

Icon of the tag
Example : fa fa-plus

id

[String]

Id in database
Example : 5000123

name

[String]

Name of the tag
Example : ISSUE

type

TagType

Type of the tag
Example : ISSUE

3.294. TagCriteria

Criteria used when doing a tag search

Field Name Required Type Description Format

code

ClauseString

Code of the tag

companyId

ClauseString

Ident of the company

id

ClauseString

Ident of the tag

name

ClauseString

Name of the tag

tag

ClauseString

You can fill in the code or name of the tag in this field

type

ClauseString

Type of the tag

validity

Validity

Details about validity

3.295. TagLinked

Tag linked

Field Name Required Type Description Format

action

Action

Details about the action verb
Example : ADD

code

[String]

Code of the tag
Example : ERR

color

[String]

Color of the tag
Example : #56b7c

comment

[String]

Comment of the tag
Example : Lorem ipsum

companyId

[String]

ID of the company
Example : 5000123

endDate

[Date]

End of validity of the tag
Example : 2020-01-23T04:56:07.000+00:00

date-time

icon

[String]

Icon of the tag
Example : fa fa-plus

id

[String]

Id in database
Example : 5000123

name

[String]

Name of the tag
Example : ISSUE

objectId

[String]

ID of the linked object
Example : 5000123

type

TagType

Type of the tag
Example : ISSUE

3.296. TagType

Type of tag

Type : enum (ISSUE, SCHEDULE, OPPORTUNITY)

3.297. TaskBase

Task base

Field Name Required Type Description Format

id

[String]

Id in database
Example : 5000123

3.298. TaskBillingType

The list of value of billing type of the type of project task.

Type : enum (TIME_BASED, TIME_BASED_FIXED_PRICE_MONTHLY)

3.299. TaskCommon

Task common

Field Name Required Type Description Format

id

[String]

Id in database
Example : 5000123

number

[Integer]

The number of the task.
Example : 10

int32

3.300. TaxInformation

Tax Information

Field Name Required Type Description Format

VATAreaId (Deprecated)

[String]

The Id of the VAT Area
Example : 500123
Deprecated : Use vatAreaId instead

VATNumber (Deprecated)

[String]

The number of the VAT rate
Example : 1
Deprecated : Use vatNumber instead

euExempt

[Boolean]

The 'euExempt' field indicates whether Intracommunity VAT exemption applies.
This field can only be updated if the third party is an intra-EU party, meaning the third party's country is within the EU, and the third party is not local (i.e., the third party's country is different from the current company's country).
Set as 'false' by default.

Example : true

exempt

[Boolean]

The 'exempt' field indicates whether there is VAT exemption.
Set to true if the third party is exempt from VAT. This field can only be updated if the third party is in the same country as the current company.
Set as 'false' by default.

Example : true

vatArea

VATAreaBase

Details about the VAT Area.
Remark : In add APIs (mainly PUT requests) vatArea model is not expected, use the vatAreaId field instead.

vatAreaId

[String]

The Id of the VAT Area
Example : 500123

vatNumber

[String]

The number of the VAT rate
Example : 1

3.301. 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

Message

parameters

List of PublishTemplateParameter

Details about the template parameters

templateId

[String]

The publish template needed to generate and attach the report
Example : 255644

3.302. ThirdPartyBase

Third Party Base

Field Name Required Type Description Format

code

[String]

The code of the third party (customer, supplier, other third party).
This field cannot be updated once it has been created.

Example : CA122

id

[String]

Id in database
Example : 5000123

name

[String]

The name of the third party (customer, supplier, other third party).
This field is mandatory.

Example : Akuiteo

3.303. ThirdPartyLinkType

Third Party Link Type

Field Name Required Type Description Format

code

[String]

The code of third party link type
Example : VARIOUS

company

Company

Details about the company
Remark : In add APIs (mainly PUT requests) company model is not expected, use the companyId field instead.

companyId

[String]

The Id of the company
Example : 5000666

endDate

[Date]

End date for third party link type. When the date is reached, the type can no longer be used.
Example : 2020-01-23T04:56:07Z

date-time

id

[String]

ID in database
Example : 5000123

name

[String]

The name of third party link type
Example : Various

requiredSiren

[Boolean]

Set as 'true' to make SIREN entry mandatory for this type.
When this field is on 'true', and the 'thirdPartyLinkType' field is filled in on a customer or supplier, the 'SIREN number' field becomes mandatory on a customer or supplier.
Set as 'false' by default.

Example : false

3.304. ThirdPartyTypeEnum

A type of the third party with people links

Type : enum (PROSPECT, CUSTOMER, SUPPLIER, OTHER_THIRD_PARTY)

3.305. Timeline

Timeline which define the initial date, the expected date and the actual date

Field Name Required Type Description Format

actualDate

[Date]

The actual or effective date.
Example : 2020-01-23T04:56:07.000+00:00

date-time

expectedDate

[Date]

The currently expected date.
Example : 2020-01-23T04:56:07.000+00:00

date-time

initialDate

[Date]

The initially defined date.
Example : 2020-01-23T04:56:07.000+00:00

date-time

3.306. TimelineCriteria

Timeline criteria which define the initial date, the expected date and the actual date

Field Name Required Type Description Format

actualDate

ClauseDate

The actual or effective date.

expectedDate

ClauseDate

The currently expected date.

initialDate

ClauseDate

The initially defined date.

3.307. TimesheetEntryBase

TimesheetEntryBase

Field Name Required Type Description Format

actionCode

ActionCodeBase

Details about the action verb
Remark : In add APIs (mainly PUT requests) actionCode model is not expected, use the actionCodeId field instead.

actionCode2

ActionCode2

Details of the action code
Remark : In add APIs (mainly PUT requests) actionCode2 model is not expected, use the actionCode2Id field instead.

actionCode2Id

[String]

ID of the second action code
Example : 5000123

actionCodeId

[String]

ID of the action code
Example : 130012

approval

[String]

Approval of the timesheet entry
Example : BRUT

Enum: BRUT, CONTROLE, VALIDE, GRATUIT, NON_FACTURE, FACTURE, REFUSE, DISSOCIE, BRUT, CONTROLE, VALIDE, GRATUIT, NON_FACTURE, FACTURE, REFUSE, DISSOCIE

approvalLabel

[String]

Label of the approval
Example : Refused

changeTracking

ChangeTracking

Date and user in case of creation and modification

comment

[String]

Comment of the calendar event

completionDate

[Date]

Completion Date
Example : 2020-01-23T04:56:07.000+00:00

date-time

customer

CustomerBase

Details about the customer
Remark : In add APIs (mainly PUT requests) customer model is not expected, use the customerId field instead.

customerId

[String]

ID of the customer
Example : 5000123

date

[Date]

Date of the calendar event
Example : 2020-01-23T04:56:07.000+00:00

date-time

duration

[Double]

Duration of the calendar event
Example : 2

double

durations

Durations

Duration in different units

employee

EmployeeBase

Details about the employee
Remark : In add APIs (mainly PUT requests) employee model is not expected, use the employeeId field instead.

employeeId

[String]

ID of the employee
Example : 5000123

guid

[String]

Global identifier of the calendar event (for mobile version only)

id

[String]

ID of the calendar event

location

[String]

Location of the calendar event
Example : Paris

phase

PhaseBase

Details about the phase
Remark : In add APIs (mainly PUT requests) phase model is not expected, use the phaseId field instead.

phaseId

[String]

ID of the phase
Example : 5000123

project

ProjectBase

Details about the project
Remark : In add APIs (mainly PUT requests) project model is not expected, use the projectId field instead.

projectId

[String]

ID of the project (equivalent to the code of the project)
Example : PRJT_1

projectTask

ProjectTaskBase

Details about the task
Remark : In add APIs (mainly PUT requests) projectTask model is not expected, use the projectTaskId field instead.

projectTaskId

[String]

ID of the project
Example : 5000123

subPhase

SubPhaseBase

Details about the sub-phase
Remark : In add APIs (mainly PUT requests) subPhase model is not expected, use the subPhaseId field instead.

subPhaseId

[String]

ID of the sub-phase
Example : 5000123

taskId

[String]

Helpdesk's task ident
Example : 5000123

type

[String]

Type of the calendar event
Example : SCHEDULE

unit

UnitDuration

Details about the unit of duration
Example : MINUTE

validated

[Boolean]

Return True if the calendar event is validated

3.308. Title

Title / Marriage status

Field Name Required Type Description Format

code

[String]

Code of the title

companyId

[String]

ID of the company
Example : 5000123

id

[String]

Id of the title

name

[String]

Name of the title

order

[Integer]

Order number of the title
Example : 1

int32

titleType

TitleType

Type of the title
Example : UNKNOWN

3.309. TitleType

Type of title

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

3.310. Topic

Topic to listen events

Field Name Required Type Description Format

action

[String]

The action verb (ADD / UPDATE / REMOVE).
This field is used to add, update or remove a topic from a resource that uses it.

Example : ADD

id

[String]

ID of the topic

type

EventType

Type of event.
Example : COMMAND_TASK

3.311. TransactionStatus

Transaction status for electronic signatures

Type : enum (IN_PROGRESS, CANCELED, EXPIRED, COMPLETED)

3.312. UnitDuration

Unit of duration

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

3.313. UnitPrice

Unit price of an item

Field Name Required Type Description Format

value

[Double]

Unit price of an item
Example : 4

double

3.314. UserBase

User

Field Name Required Type Description Format

code

[String]

Code of the user
Example : TRI

firstName

[String]

First name of the user
Example : John

id

[String]

Id in database
Example : 5000123

name

[String]

Name of the user
Example : Doe

3.315. UserCriteria

UserCriteria

Field Name Required Type Description Format

id

ClauseString

readOption

UserReadOption

Options for retrieving extra information concerning the user

tag

ClauseString

Code or Last Name or First Name of the User

3.316. UserProfileBase

User Profile Base

Field Name Required Type Description Format

code

[String]

Code of the user profile
Example : PROFIL_TECH

id

[String]

Id in database
Example : 5000123

name

[String]

Name of the user profile
Example : Profil tech

3.317. 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.318. VAT

VAT

Field Name Required Type Description Format

code

[String]

VAT code
Example : 7

companyCode

[String]

The company code
Example : AKSAS

endDate

[Date]

End date of the VAT
Example : 2020-01-23T04:56:07.000+00:00

date-time

id

[String]

Id in database
Example : 5000123

name

[String]

Name
Example : VAT for capital asset

purchasingAccountNumber

[String]

General purchasing account number linked to the tax code

rate

[Double]

VAT rate in percentage

double

reduced

[Boolean]

Returns true if the rate is reduced
Example : true

salesAccountNumber

[String]

General sales account number linked to the tax code

startDate

[Date]

Start date of the VAT
Example : 2020-01-23T04:56:07.000+00:00

date-time

3.319. VATAreaBase

VAT Area Base

Field Name Required Type Description Format

code

[String]

The code of the VAT area
Example : AREA

id

[String]

Id in database
Example : 5000123

name

[String]

The name of the VAT area
Example : Area

3.320. VATBase

VAT

Field Name Required Type Description Format

code

[String]

VAT code
Example : 7

id

[String]

Id in database
Example : 5000123

rate

[Double]

VAT rate in percentage

double

3.321. Validity

Validity criteria

Field Name Required Type Description Format

date

[Date]

Date of validity of the item
If the date retrieved is null, then the validity date is on the current day.

Example : 2020-01-23T04:56:07.000+00:00

date-time

type

ValidityType

Details about the type of validity.
Example : VALID

3.322. ValidityType

Type of validity

Type : enum (VALID, INVALID)

3.323. Year

Year (vintage) of the opportunity

Field Name Required Type Description Format

code

[String]

The code of the year (vintage).
Example : 2025

disabledDate

[Date]

Date of disability
Example : 2020-01-23T04:56:07Z

date-time

id

[String]

Id in database
Example : 5000123

name

[String]

The name of the year (vintage).
Example : Text

previousYearId

[String]

Previous year (vintage) ID.
Example : 5000123

repeating

RepeatingYear

Set as true if the vintage is recurrent.
Set as false by default.

Example : YES

validityEndDate

[Date]

The end date of validity.
Example : 2020-01-23T04:56:07Z

date-time

3.324. YearCriteria

Criteria used to search Year (vintage)

Field Name Required Type Description Format

code

ClauseString

The code of the year (vintage)

companyId

ClauseString

ID of the company

disabledDate

ClauseDate

Date on which the year will become inactive

id

ClauseString

The ID of the year (vintage)

name

ClauseString

The name of the year (vintage)

previousYearId

ClauseString

Previous year (vintage) ID

validityEndDate

Validity

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:41:14
Copyright : Akuiteo © 2025