We launched the new version of our API in October 2022. This guide will assist you in migrating from API v2 to API v3, while also helping you stay up to date with any updates and fixes made over time to API v3. This version is linked to Akuiteo version 5.0.

1. What’s new

The v3 API is using the Open API 3.1.0 unified API framework as the standard to develop REST APIs.

You can benefit from:

  • A more responsive and faster API

  • An interactive documentation with examples for all endpoints

2. API Users

All API users who are currently using the API v2 or any legacy version should migrate to this latest API version prior to upgrade to a 5.0 or upper version of Akuiteo and ensure that applications or integrations are not affected.

This means that the API v2 libraries will no longer be maintained or extended in the future. Any user must instead make use of their upgraded versions which encapsulate all the extended functionalities API v3 now offers.

3. Migration guide

Migrating from v2 to v3 requires that you update your endpoint URLs to call the new v3 and that you update your applications to support the resource or field changes implemented in v3.

3.1. Update your API calls to use v3 endpoints

To make calls to v3, update your requests to use the new v3 endpoints.

For example, to call the method to validate timesheets of a manager’s employees with v2, you would use :

GET

/workforce/managers/{manager_id}/employees/timerecording-terminations

For v3, update the URL as following:

GET

/workforce/managers/{manager_id}/employees/timesheet-entries/completions

To learn more about v3 services and endpoints, see the Akuiteo API v5.0 reference documentation.

3.2. Update your API resources and fields to use v3 ones

To make calls to v3, update any of the resource name or field changes implemented in v3.

For example, the TimeRecordingTermination resource has been replaced by TimesheetEntryCompletion in the APIs. For v2, you would use:

{
  "TimeRecordingTermination": {
      "id": 2341501,
      "employee": {},
      "employeeId": 123456789,
      "year": 2021.0,
      "terminationType" :"WEEK"
  }
}

For v3, update the resource name as following:

{
  "TimesheetEntryCompletion": {
      "id": 2341501,
      "employee": {},
      "employeeId": 123456789,
      "year": 2021.0,
      "completionType" :"WEEK"
  }
}

3.3. Important changes

3.3.1. Method POST and PUT

From the getting started guide :

  • POST: Updates the targeted resource or all the items in a collection. This method is also used for functional operations and for Akuiteo-specific APIs.

  • PUT: Creates a resource.

In v2, an API error was made and corrected in v3.

For example, in the update API /documents/{document_id} in Document managed domain, verbs should be replaced from

PUT

/documentmanagement/documents/{document_id}

to

PUT

/documentmanagement/documents/{document_id}

3.3.2. Custom Fields renamed as Custom Data

"Custom field" is a wrong term, we will use "custom data" instead.

In all read or search APIs (/read or /search) using the custom data recovery option, you must use CUSTOM_DATA instead of CUSTOM_FIELDS.

For example, in the CRM/Customer/Search API, the body content must be replaced from

POST /crm/customers/search

{
    "code" : {
        "operator": "IS",
        "value": "C999"
    },
    "readOption": {
        "options" :["ADDRESS","CATEGORY","CUSTOM_FIELDS"]
    }
}

to

POST /crm/customers/search

{
    "code" : {
        "operator": "IS",
        "value": "C393"
    },
    "readOption": {
        "options" :["ADDRESS","CATEGORY","CUSTOM_DATA"]
    }
}

4. List of changes

We have created a mapping of v2 terms and their equivalent in the API v3 to ease your migration process.

  • URL

  • Resources names

  • Resources fields

The tables list terms changes from v2 to v3 in full. Any unlisted terms are unchanged.

To learn more about all the v3 available services and functions, see the Akuiteo API v5.0 reference documentation..

4.1. Commons

4.1.1. Updated resource names

Version 2 Version 3

BusinessDocument

ManagementObject

BusinessDocumentCriteria

ManagementObjectCriteria

BusinessDocumentLine

ManagementObjectLine

BusinessDocumentSalesLine

ManagementObjectSalesLine

BusinessDocumentType

ManagementObjectType

TimeRecording

TimesheetEntry

TimeRecordingBase

TimesheetEntryBase

TimeRecordingCompletion

TimesheetEntryCompletion

TimeRecordingCompletionCriteria

TimesheetEntryCompletionCriteria

TimeRecordingCriteria

TimesheetEntryCriteria

TimeRecordingReadOption

TimesheetEntryReadOption

TimeRecordingRules

TimesheetEntryRules

4.1.2. Updated resource fields

Resource Version 2 Version 3

ApplicationFeature

TIMERECORDING_TERMINATION_CANCEL

TIMESHEET_ENTRY_COMPLETION_CANCEL

AssignmentReferential

projectGroupCode

projectGroup

BatchUpdateCustomDataParamHolder

customFields

customData

BatchUpdateCustomFieldParamHolder

BatchUpdateCustomFieldParamHolder

BatchUpdateCustomDataParamHolder

CalendarEvent

place

location

Contract

terminationDate

completionDate

CustomDataParam

CustomFieldPattern

CustomDataPattern

CustomField

CustomField

CustomData

CustomFieldParam

CustomFieldParam

CustomDataParam

CustomFieldType

CustomFieldType

CustomDataType

CustomRequestLine

businessDocumentId

managementObjectId

Division

serviceId

groupId

Document

createdBy

changeTracking.createdBy

Document

createdById

changeTracking.createdById

Document

creationDate

changeTracking.creationDate

Document

sysName

fileName

DutiableLine

businessDocumentId

managementObjectId

Expense

businessDocumentId

managementObjectId

ForcedVatAmountHolder

businessDocumentLineId

managementObjectLineId

InvoiceLine

businessDocumentId

managementObjectId

ItemLine

businessDocumentId

managementObjectId

ItemLine

discount

discount.amount

ManagementObjectLine

businessDocumentId

managementObjectId

ManagementObjectSalesLine

businessDocumentId

managementObjectId

MobActiviteParDefaut

place

location

ProjectLeaveType

NO_TIMERECORDING

NO_TIMESHEETS

PurchaseInvoiceLine

businessDocumentId

managementObjectId

PurchaseOrderLine

businessDocumentId

managementObjectId

QuickEntryTime

place

location

QuotationLine

businessDocumentId

managementObjectId

QuoteLine

businessDocumentId

managementObjectId

ReceptionLine

businessDocumentId

managementObjectId

SalesOrderLine

businessDocumentId

managementObjectId

Schedule

place

location

ScheduleBase

place

location

ScheduleFluent

place

location

SubCategoryItem

subType

subCategoryType

TimesheetEntry

place

location

TimesheetEntryBase

place

location

UserBase

firstname

firstName

PeopleLink

defaultLink

defaultLink: this field can be updated; it will be set to false if omitted or if its value is null. Only one link is possible by default.

PeopleLink

id

id: this field is mandatory and must match the ID in the URL as well as exist in the database.

PeopleLink

linkSourceId

linkSourceId: this field is mandatory and can be updated with an existing ID in the database.

PeopleLink

linkTargetId

linkTargetId: this field is mandatory and can be updated with an existing ID in the database.

PeopleLink

linkType

linkType: this field is mandatory and can be updated with an existing type.

PeopleLink

sourceThirdPartyType

sourceThirdPartyType: if this field is omitted, the API will use the url type by default.

PeopleLink

sourceThirdPartyId

sourceThirdPartyId: if this field is omitted, the API will use the url type by default.

PeopleLink

targetThirdPartyId

targetThirdPartyId: this field is mandatory and can be updated with an existing ID in the database.

PeopleLink

targetThirdPartyType

targetThirdPartyType: this field is mandatory and can be updated with an existing type.

4.1.3. Removed resource fields

Resource Version 2 CategoryType

RETAILER

ProjectState

companyCode

SubCategory

companyCode

SubCategoryItemCriteria

nature

TaxInformation

VATAreaId

4.2. Accounting

4.2.1. Updated URLs

Version 2 Version 3

POST /fiscal-years

PUT /fiscal-years See

4.3. Admin

4.3.1. Updated URLs

Version 2 Version 3

POST /properties/categories

PUT /properties/categories/find See

4.3.2. Updated resource fields

Resource Version 2 Version 3

Endpoint

applicationName

application

Endpoint

defaultEndpoint

default

Endpoint

https

protocol

4.4. Approval process

4.4.1. Updated resource fields

Resource Version 2 Version 3

Approval

viewCustomFields

viewCustomData

ApprovalObjectSummary

customFields

customData

ApprovalReadOption

CUSTOM_FIELDS

CUSTOM_DATA

4.5. CRM

4.5.1. Updated URLs

Version 2 Version 3

POST /customers/{customer_id}/contacts/

PUT /customers/{customer_id}/contacts/ See

POST /events/breakdown

POST /events/breakdown/search See

POST /events/categories

POST /events/categories/search See

POST /events/replies

POST /events/replies/search See

4.5.2. Updated resource names

Version 2 Version 3

Profession

commons/Profession

4.5.3. Updated resource fields

Resource Version 2 Version 3

CategoryEvent

endCustomField

endCustomData

CategoryEvent

nbColsCustomField

nbColsCustomData

CategoryEvent

startCustomField

startCustomData

Contact

address

address: this field cannot be set to null or omitted when creating a customer site , as it must at least include the mandatory 'country' field. When updating a customer site , it must contain at least the 'id' field if 'addressId' is set to null.

Contact

addressId

addressId: this field is deprecated. When updating a customer , it must be set to an existing ID in the database if 'address' is set to null.

Contact

code

code: this field will be cleared if omitted or if its value is null.

Contact

comment

comment: this field will be cleared if omitted or if its value is null.

Contact

customFields

customData

Contact

disappeared

disappeared: this field can be updated; it will be set to false if omitted or if its value is null.

Contact

disappearedOn

disappearedOn: this field can be updated; it will be cleared if omitted or if its value is null

Contact

email

email: this field will be cleared if omitted or if its value is null.

Contact

email2

email2: this field will be cleared if omitted or if its value is null.

Contact

mobilePhone

mobilePhone: this field will be cleared if omitted or if its value is null.

Contact

name

name: this field is mandatory.

Contact

phone

phone: this field will be cleared if omitted or if its value is null.

Contact

title

title : If this field is omitted or null, it will automatically be set to the value 'M'.

ContactCriteria

customFields

customData

ContactReadOption

CUSTOM_FIELDS

CUSTOM_DATA

Customer

APE

APE: this field can be updated with an existing APE code; it will be cleared if omitted or if its value is null.

Customer

accountManagerId

accountManagerId: this field can be updated with an existing ID in the database; it will be cleared if omitted or if its value is null.

Customer

accountingParameters

accountingParameters

Customer

accountingPeriod

accountingPeriod: this field can be updated; it will be cleared if omitted or if its value is null.

Customer

address

address: this field cannot be set to null or omitted when creating a customer , as it must at least include the mandatory 'country' field. When updating a customer , it must contain at least the 'id' field if 'addressId' is set to null.

Customer

addressId

addressId: this field is deprecated. When updating a customer , it must be set to an existing ID in the database if 'address' is set to null.

Customer

categoryId

categoryId: this field can be updated with an existing ID in the database; it will be cleared if omitted or if its value is null.

Customer

closure

closure: this field cannot be updated using the customer creation or update API.

Customer

code

code: this field will be cleared if omitted or if its value is null.

Customer

customFields

customData

Customer

SIREN

SIREN: this field can be updated; it will be cleared if omitted or if its value is null.

Customer

SIRET

SIRET: this field can be updated; it will be cleared if omitted or if its value is null.

Customer

email

email: this field is read-only and provides current data without allowing modifications.

Customer

entityId

entityId: this field can be updated with an existing ID in the database; it will be cleared if omitted or if its value is null.

Customer

equity

equity: this field can be updated; it will be cleared if omitted or if its value is null.

Customer

exclusionCodes

exclusionCodes: this field can be updated; it will be cleared if omitted or if its value is null.

Customer

firstPricingMethodId

firstPricingMethodId: this field can be updated with an existing ID in the database; it will be cleared if omitted or if its value is null.

Customer

headcount

headcount: this field can be updated; it will be cleared if omitted or if its value is null.

Customer

indicators

indicators: this field can be updated; it will be cleared if omitted or if its value is null.

Customer

keywords

keywords: this field can be updated; it will be cleared if omitted or if its value is null.

Customer

languageCode

languageCode: this field can be updated; it will be cleared if omitted or if its value is null.

Customer

lastTracking

lastTracking: this field will be cleared if omitted or if its value is null.

Customer

legalForm

legalForm: this field can be updated; it will be cleared if omitted or if its value is null.

Customer

legalName

legalName: if this field is omitted or null, it will automatically be set to the value of the 'name' field.

Customer

legalName2

legalName2: this field can be updated; it will be cleared if omitted or if its value is null.

Customer

level1grouping

level1grouping: this field will be cleared if omitted or if its value is null.

Customer

level2grouping

level2grouping: this field will be cleared if omitted or if its value is null.

Customer

methodOfPayment

methodOfPayment: this field can be updated; it will be cleared if omitted or if its value is null.

Customer

open

open: this field can be updated; it will be cleared if omitted or if its value is null.

Customer

phone

phone: this field is read-only and provides current data without allowing modifications.

Customer

professionId

professionId: this field can be updated with an existing ID in the database; it will be cleared if omitted or if its value is null.

Customer

professionalCategoryId

professionalCategoryId: this field can be updated with an existing ID in the database; it will be cleared if omitted or if its value is null.

Customer

revenue

revenue: this field can be updated; it will be cleared if omitted or if its value is null.

Customer

secondPricingMethodId

secondPricingMethodId: this field can be updated with an existing ID in the database; it will be cleared if omitted or if its value is null.

Customer

sectorId

sectorId: this field can be updated with an existing ID in the database; it will be cleared if omitted or if its value is null.

Customer

serviceProviderProject

serviceProviderProject: this field will be cleared if omitted or if its value is null.

Customer

statusId

statusId: this field can be updated with an existing ID in the database; it will be cleared if omitted or if its value is null.

Customer

subCategoryId

subCategoryId: this field can be updated with an existing ID in the database; it will be cleared if omitted or if its value is null.

Customer

thirdPartyLinkTypeId

thirdPartyLinkTypeId: this field can be updated with an existing ID in the database; it will be cleared if omitted or if its value is null.

Customer

type

type: this field is mandatory.

Customer

unit

unit: this field can be updated; it will be cleared if omitted or if its value is null.

CustomerCriteria

customFields

customData

Event

customFields

customData

Event

categoryId

categoryId: this field can be updated with an existing ID in the database; it will be cleared if omitted or if its value is null.

Event

completion

completion: If this field is omitted or null, it will automatically be set to the value 'NOT_STARDTED'.

Event

ownerId

ownerId: this field can be updated with an existing ID in the database; it will be cleared if omitted or if its value is null.

Event

replyId

replyId: this field can be updated with an existing ID in the database; it will be cleared if omitted or if its value is null.

Event

type

type: this field is mandatory

Event

subject

subject: this field is mandatory

EventCriteria

customFields

customData

EventReadOption

CUSTOM_FIELDS

CUSTOM_DATA

Opportunity

customFields

customData

Opportunity

opportunityId

id

Opportunity

city

This field is deprecated, use address instead

Opportunity

country

This field is deprecated, use address instead

Opportunity

postalCode

This field is deprecated, use address instead

Opportunity

-

address: New field, use “ADDRESS” in OpportunityReadOption to get the details of this field. Remark : This property is read-only and provides current data without allowing modifications.

Opportunity

-

addressId: New field. Remark : This property is read-only and provides current data without allowing modifications.

Opportunity

activityId

activityId: this field can be updated with an existing ID in the database; it will be cleared if omitted or if its value is null.

Opportunity

archiveComment

archiveComment: this field can be updated; it will be set to false if omitted or if its value is null.

Opportunity

code

code: this field is mandatory.

Opportunity

customerId

customerId: this field can be updated with an existing ID in the database; it will be cleared if omitted or if its value is null.

Opportunity

customerLocationId

customerLocationId: this field can be updated with an existing ID in the database; it will be cleared if omitted or if its value is null.

Opportunity

departmentId

departmentId: this field can be updated with an existing ID in the database; it will be cleared if omitted or if its value is null.

Opportunity

description

description: this field can be updated; it will be set to false if omitted or if its value is null.

Opportunity

endCustomerId

endCustomerId: this field can be updated with an existing ID in the database; it will be cleared if omitted or if its value is null.

Opportunity

entityId

entityId: this field can be updated with an existing ID in the database; it will be cleared if omitted or if its value is null.

Opportunity

financialManagerId

financialManagerId: this field can be updated with an existing ID in the database; it will be cleared if omitted or if its value is null.

Opportunity

title

title: this field can be updated; it will be set to false if omitted or if its value is null.

Opportunity

lossDate

lossDate: this field can be updated; it will be set to false if omitted or if its value is null.

Opportunity

mainContactId

mainContactId: this field can be updated with an existing ID in the database; it will be cleared if omitted or if its value is null.

Opportunity

openingDate

openingDate: this field is mandatory.

Opportunity

origin

origin: this field can be updated; it will be set to false if omitted or if its value is null.

Opportunity

pipeId

pipeId: this field can be updated with an existing ID in the database; it will be cleared if omitted or if its value is null.

Opportunity

probabilityLevel

probabilityLevel: this field can be updated; it will be set to false if omitted or if its value is null.

Opportunity

productionManagerId

productionManagerId: this field can be updated with an existing ID in the database; it will be cleared if omitted or if its value is null.

Opportunity

projectCategoryId

projectCategoryId: this field can be updated with an existing ID in the database; it will be cleared if omitted or if its value is null.

Opportunity

projectManagerId

projectManagerId: this field can be updated with an existing ID in the database; it will be cleared if omitted or if its value is null.

Opportunity

projectSubCategoryId

projectSubCategoryId: this field can be updated with an existing ID in the database; it will be cleared if omitted or if its value is null.

Opportunity

projectSubCategoryLevel2Id

projectSubCategoryLevel2Id: this field can be updated with an existing ID in the database; it will be cleared if omitted or if its value is null.

Opportunity

salesManagerId

salesManagerId: this field can be updated with an existing ID in the database; it will be cleared if omitted or if its value is null.

Opportunity

stageDate

stageDate: this field can be updated; it will be set to false if omitted or if its value is null.

Opportunity

yearId

yearId: this field can be updated with an existing ID in the database; it will be cleared if omitted or if its value is null.

OpportunityCriteria

creationDate

changeTracking createdTime

OpportunityLine

customFields

customData

OpportunityLineReadOption

CUSTOM_FIELDS

CUSTOM_DATA

OpportunityReadOption

CUSTOM_FIELDS

CUSTOM_DATA

Pipe

stages List of SiteRelatedInformation

stages List of Stage

PipeReadOption

STAGE

STAGES

Site

fullName2

fullName2: this field will be cleared if omitted or if its value is null.

Site

managerId

managerId: this field can be updated with an existing ID in the database; it will be cleared if omitted or if its value is null.

Site

siteCode

siteCode: this field is deprecated, use code instead.

Site

main

main: to update this field , use the specific api Set this site as main site of the customer

4.5.4. Removed resource fields

Resource Version 2 Contact

function

SiteRelatedInformation

function

4.6. Document management

4.6.1. Updated URLs

Version 2 Version 3

PUT /documents/{document_id}

POST /documents/{document_id} See

4.6.2. Deleted URLs

Version 2 Use instead

POST /documents/create-from-file

POST /documents/upload See

4.6.3. Updated resource fields

Resource Version 2 Version 3

Document

archived

archived: to update this field, use Archive or unarchive document

Document

classification

classification: to update this field, use Classify a document

Document

externalDMSUuid

externalDMSUuid: this field can be updated; it will be set to false if omitted or if its value is null

Document

id

id : this field must be consistent with the ID in the URL of the update API.

Document

locked

locked: to update this field, use Lock and unlock document

Document

original

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

Document

publicationDate

publicationDate: this field cannot be updated.

Document

publishedById

publishedById: this field cannot be updated.

Document

subClassification

subClassification: to update this field, use Classify a document

Document

fileUrl

fileUrl: this field cannot be updated once it has been created.

4.7. Mobile

4.7.1. Updated URLs

Version 2 Version 3

DELETE /time-recordings/{time_recording_id}

DELETE /timesheet-entries/{timesheet_entry_id} See

DELETE /time-recordings/quick-entries/{time_recording_quick_entry_id}

DELETE /timesheet-entries/quick-entries/{timesheet_quick_entry_id} See

GET /schedules/{schedule_id}/transfer-in-time-recording

GET /schedules/{schedule_id}/transfer-in-timesheets See

GET /schedules/places/default

GET /schedules/locations/default See

GET /schedules/places/Search

GET /schedules/locations/search See

GET /time-recordings/{time_recording_id}

GET /timesheet-entries/{timesheet_entry_id} See

GET /time-recordings/mine

GET /timesheet-entries/mine See

GET /time-recordings/places/default

GET /timesheet-entries/locations/default See

GET /time-recordings/places/search

GET /timesheet-entries/locations/search See

GET /time-recordings/quick-entries/mine

GET /timesheet-entries/quick-entries/mine See

POST /employees

POST /employees/search See

POST /schedules

POST /schedules/search See

POST /time-recordings/{time_recording_id}

POST /timesheet-entries/{timesheet_entry_id} See

POST /time-recordings/termination/add

POST /timesheet-entries/completion/add See

POST /time-recordings/termination/remove

POST /timesheet-entries/completion/remove See

PUT /time-recordings/{time_recording_id}/quick-entries

PUT /timesheet-entries/{timesheet_entry_id}/quick-entries See

PUT /time-recordings

PUT /timesheet-entries See

4.7.2. Updated resource names

Version 2 Version 3

MobEventPlace

MobEventLocation

MobTimeRecording

MobTimesheetEntry

MobTimeRecordingRules

MobTimesheetEntryRules

MobTimeRecordingTermination

MobTimesheetEntryCompletion

4.7.3. Updated resource fields

Resource Version 2 Version 3

MobCalendarEvent

calendarEventState

state

MobCalendarEvents

timeRecordings

timesheetEntries

MobCompletionType

terminationType

completionType

MobParametrage

timeRecordingRules

timesheetEntryRules

MobTimeRecording

terminationDate

completionDate

MobTimeRecordingTermination

terminationType

completionType

MobTimeRecordingRules

terminationType

completionType

MobSchedule

datCre

datCre: this field is read-only and provides current data without allowing modifications.

MobSchedule

date

date: this field is mandatory.

MobSchedule

duration

duration: this field is mandatory, it cannot

MobSchedule

onlineMeeting

onlineMeeting: this field can be updated; it will be set to false if omitted or if its value is null.

MobSchedule

siteId

siteId: this field can be updated with an existing ID in the database; it will be cleared if omitted or if its value is null.

MobSchedule

taskId

taskId: this field can be updated with an existing ID in the database; it will be cleared if omitted or if its value is null.

MobTimesheetEntry

datCre

datCre: this field is read-only and provides current data without allowing modifications.

MobTimesheetEntry

taskId

taskId: this field can be updated with an existing ID in the database; it will be cleared if omitted or if its value is null.

MobTimesheetEntry

ident

ident: this field must to set with an existing ID in the database and consistent with the one in the url

4.8. Project management

4.8.1. Updated URLs

Version 2 Version 3

PUT /project-tasks/{project_task_id}

POST /project-tasks/{project_task_id} See

POST /projects/{project_id}/phases/{phase_id}/sub-phases/{sub_phase_id}

GET /projects/{project_id}/phases/{phase_id}/sub-phases/{sub_phase_id} See

4.8.2. Updated resource fields

Resource Version 2 Version 3

EmployeeLinkCriteria

checkEmployeeCompagny

checkEmployeeCompany

EmployeeLinkCriteria

checkTimerecordings

checkTimesheet

Project

customFields

customData

Project

customerId

customerId: this field is mantadatory and can be updated with an existing ID in the database.

Project

customerType

customerType: If this field is omitted or null, it will automatically be set to the value 'SINGLE_CUSTOMER'.

Project

endCustomerId

endCustomerId: this field is mandatory and can be updated with an existing ID in the database. If omitted or null, it will automatically be set to the value of 'customerId'.

Project

isPilot

isPilot: this field can be updated; it will be set to false if omitted or if its value is null.

Project

isServiceProvider

isServiceProvider: this field can be updated; it will be set to false if omitted or if its value is null.

Project

productionEnd

productionEnd: this field can be updated; it will be set to false if omitted or if its value is null

Project

productionStart

productionStart: this field can be updated; it will be set to false if omitted or if its value is null

Project

projectStateId

projectStateId: this field can be updated with an existing ID in the database; it will be cleared if omitted or if its value is null.

ProjectReadOption

CUSTOM_FIELDS

CUSTOM_DATA

ProjectTask

endDate

endDate: this field is mandatory

ProjectTask

phaseId

phaseId: this field is mandatory and must be set to the ID of an existing phase in the database, consistent with the project task.

ProjectTask

id

id : this field must be consistent with the ID in the URL of the update API.

ProjectTask

projectId

projectId: this field is mandatory and must be set to the ID of an existing project in the database, consistent with the project task.

ProjectTask

projectTaskTypeId

projectTaskTypeId: this field can be updated with an existing ID in the database; it will be cleared if omitted or if its value is null.

ProjectTask

riskLevelId

riskLevelId: this field can be updated with an existing ID in the database; it will be cleared if omitted or if its value is null.

ProjectTask

soldItemId

soldItemId: this field can be updated with an existing ID in the database; it will be cleared if omitted or if its value is null.

ProjectTask

standardWeekId

standardWeekId: this field can be updated with an existing ID in the database; it will be cleared if omitted or if its value is null.

ProjectTask

subPhaseId

subPhaseId: this field is mandatory and must be set to the ID of an existing sub phase in the database, consistent with the project task.

Phase

actualEnd

actualEnd: this field can be updated; it will be set to false if omitted or if its value is null

Phase

actualStart

actualStart: this field can be updated; it will be set to false if omitted or if its value is null

Phase

code

code: this field cannot be updated once it has been created.

Phase

customerContact

customerContact: this field can be updated; it will be set to false if omitted or if its value is null.

Phase

customerHostSiteId

customerHostSiteId: this field can be updated with an existing ID in the database; it will be cleared if omitted or if its value is null.

Phase

expectedEnd

expectedEnd: this field can be updated; it will be set to false if omitted or if its value is null

Phase

expectedStart

expectedStart: this field can be updated; it will be set to false if omitted or if its value is null

Phase

name

name: this field is mandatory

Phase

projectId

projectId: this field is mandatory and must be set to the ID of an existing project in the database, consistent with the phase.

Phase

stateId

stateId: this field can be updated with an existing ID in the database; it will be cleared if omitted or if its value is null.

SubPhase

actualEnd

actualEnd: this field must have a value consistent with the phase dates and greater than 'actualStart'.

SubPhase

actualStart

actualStart: this field must have a value consistent with the phase dates.

SubPhase

closure

closure: to update this field , use the specific api: Close a sub-phase of a project

SubPhase

code

code: this field cannot be changed once it has been created.

SubPhase

expectedEnd

expectedEnd: this field can be updated; it will be set to false if omitted or if its value is null.

SubPhase

expectedStart

expectedStart: this field can be updated; it will be set to false if omitted or if its value is null.

SubPhase

managerId

managerId: this field is mandatory and must be set to the ID of an existing project in the database, consistent with the phase.

SubPhase

name

name: this field is mandatory

SubPhase

phaseId

phaseId: this field is mandatory and must be set to the ID of an existing phase in the database, consistent with the sub phase.

SubPhase

projectId

phaseId: this field is mandatory and must be set to the ID of an existing phase in the database, consistent with the sub phase.

SubPhase

stateId

stateId: this field can be updated with an existing ID in the database; it will be cleared if omitted or if its value is null.

4.9. Purchase

4.9.1. Updated resource names

Version 2 Version 3

PurchaseBusinessDocument

PurchaseManagementObject

PurchaseBusinessDocumentCriteria

PurchaseManagementObjectCriteria

4.9.2. Updated resource fields

Resource Version 2 Version 3

PurchasedItemCriteria

readOptions

readOption

PurchaseInvoiceCriteria

readOptions

readOption

PurchaseOrderCriteria

readOptions

readOption

QuoteCriteria

readOptions

readOption

ReceptionCriteria

readOptions

readOption

SupplierCriteria

readOptions

readOption

Supplier

phone

Address/phone

Supplier

email

Address/email

Supplier

entityCode

entityId

Supplier

accountingPeriod

accountingPeriod: this field cannot contain more than 2 characters.

Supplier

address

address: this field cannot be set to null or omitted; it must at least include the mandatory 'country' field.

Supplier

addressId

addressId: this field is deprecated

Supplier

ape

ape: this field can be updated with an existing APE code; it will be cleared if omitted or if its value is null.

Supplier

categoryId

categoryId: this field can be updated with an existing ID in the database; it will be cleared if omitted or if its value is null.

Supplier

code

code: this field cannot be modified in the Supplier update API.

Supplier

entityId

entityId: this field can be updated with an existing ID in the database; it will be cleared if omitted or if its value is null.

Supplier

id

id: this field is mandatory and must match the ID in the URL as well as exist in the database.

Supplier

legalName

legalName: if this field is omitted or null, it will automatically be set to the value of the 'name' field.

Supplier

professionId

professionId: this field can be updated with an existing ID in the database; it will be cleared if omitted or if its value is null.

Supplier

subCategoryId

subCategoryId: this field can be updated with an existing ID in the database; it will be cleared if omitted or if its value is null.

Supplier

phone

Address/phone

Supplier

email

Address/email

SupplierSite

address

address: this field cannot be set to null or omitted when creating a supplier site, as it must at least include the mandatory 'country' field. When updating a supplier site, it must contain at least the 'id' field if 'addressId' is set to null.

SupplierSite

addressId

addressId: this field is deprecated. When updating a supplier site, it must be set to an existing ID in the database if 'address' is set to null.

SupplierSite

id

id : this field must be consistent with the ID in the URL of the update API.

SupplierSite

legalName1

legalName1: if this field is omitted or null, it will automatically be set to the value of the 'name' field.

SupplierSite

legalName2

legalName2: this field can be updated; it will be cleared if omitted or if its value is null.

SupplierSite

main

main: to update this field , use the specific api: Set a site as main site of a supplier

SupplierSite

managerId

managerId: this field can be updated with an existing ID in the database; it will be cleared if omitted or if its value is null.

SupplierSite

siteCode

siteCode: this field can be updated; it will be cleared if omitted or if its value is null.

SupplierSite

supplierId

supplierId: this field can be updated with an existing ID in the database; it will be cleared if omitted or if its value is null.

TemporaryPurchaseInvoice

accountingJournalId

accountingJournalId: this field can be updated with an existing ID in the database; it will be cleared if omitted or if its value is null.

TemporaryPurchaseInvoice

afterTaxAmount

afterTaxAmount: this field is automatically calculated from the 'afterTaxAmountCurrency' field and cannot be updated

TemporaryPurchaseInvoice

approverId

approverId: this field can be updated with an existing ID in the database; it will be cleared if omitted or if its value is null.

TemporaryPurchaseInvoice

invoiceNumber

invoiceNumber: this field is mandatory.

TemporaryPurchaseInvoice

preTaxAmount

preTaxAmount: this field is automatically calculated from the 'preTaxAmountCurrency' field and cannot be updated

TemporaryPurchaseInvoice

phaseId

phaseId: this field can be updated with an existing ID in the database; it will be cleared if omitted or if its value is null

TemporaryPurchaseInvoice

projectId

projectId: this field can be updated with an existing ID in the database; it will be cleared if omitted or if its value is null.

TemporaryPurchaseInvoice

status

status: to update this field use the specific api : Create the final invoice from a temporary invoice or Reject the temporary invoice

TemporaryPurchaseInvoice

taxAmount

taxAmount: this field is automatically calculated from the 'preTaxAmountCurrency' field and cannot be updated

TemporaryPurchaseInvoice

validationDate

validationDate: this field cannot be modified in the update api.

TemporaryPurchaseInvoice

action

action: this field is mandatory to “ADD” a line, “Update” a line or “REMOVE” a line.

TemporaryPurchaseInvoice

endDate

endDate: this field can be updated with a date greater than the date in startDate; it will be cleared if omitted or if its value is null.

TemporaryPurchaseInvoice

generalAccount

generalAccount: this field can be updated with an existing ACCOUNT in the database; it will be cleared if omitted or if its value is null.

TemporaryPurchaseInvoice

reconciliationAccount

reconciliationAccount: this field can be updated with an existing ACCOUNT in the database; it will be cleared if omitted or if its value is null.

TemporaryPurchaseInvoice

totalPrice

totalPrice: this field is automatically calculated from the 'totalPriceCurrency' field and cannot be updated

TemporaryPurchaseInvoice

unitPrice

unitPrice: this field is automatically calculated from the 'unitPriceCurrency' field and cannot be updated

PurchasedItem

categoryId

categoryId: this field is mandatory and can be updated with an existing ID in the database

PurchasedItem

customData

customData: this field can be updated

PurchasedItem

quantityPrecision

quantityPrecision: this field can be updated with a value betwen 0 and 5; it will be cleared if omitted or if its value is null.

PurchasedItem

unitPricePrecision

unitPricePrecision: this field can be updated with a value betwen 0 and 5; it will be cleared if omitted or if its value is null.

4.10. Sales

4.10.1. Updated URLs

Version 2 Version 3

GET /invoices/{invoice_id}/get-linked-expense-receipt

GET /invoices/{invoice_id}/expense-receipts See

Version 3

Version 4

POST /sold-items/{sold_item_id}/get-unit-price

POST /sold-items/{sold_item_id}/get-pricing-information See

4.10.2. Updated resource names

Version 2 Version 3

SalesBusinessDocument

SalesManagementObject

SalesBusinessDocumentCriteria

SalesManagementObjectCriteria

4.10.3. Updated resource fields

Resource Version 2 Version 3

QuotationExpenseLine

type

type: This field is mandatory.

QuotationExpenseLine

employeeId

employeeId: This field is mandatory if the type of quotation expense line is 'SERVICE_PROVIDER'. If the type is OTHER_COSTS, this field is ignored.

QuotationExpenseLine

supplierId

supplierId: This field is mandatory if the type of quotation expense line is 'PURCHASE_ITEM'. If the type is OTHER_COSTS, this field is ignored.

QuotationExpenseLine

purchasedProductId

purchasedProductId: This field is mandatory if the type of quotation expense line is 'PURCHASE_ITEM' or 'OTHER_COSTS'.

QuotationExpenseLine

label

label: This field is mandatory.

QuotationExpenseLine

quantity

quantity: This field is mandatory.

QuotationExpenseLine

unitCost

unitCost: This field is mandatory if the type is 'OTHER_COSTS' or 'PURCHASE_ITEM'.

QuotationExpenseLine

coeficient

coeficient: By default, this field is set to 1.

QuotationExpenseLine

currencyId

currencyId: By default this field is set to the currencyId of the quotation if the type is 'OTHER_COSTS' or 'SERVICE_PROVIDER'.

InvoiceCriteria

readOptions

readOption

Quotation

assignmentIndicator

assignmentIndicator: by default, this field is set to 'SINGLE_PROJECT_MONO_PHASE' if its value is null or omitted.

Quotation

billingSiteId

billingSiteId: this field is automatically set with the billing site ID of the customer to be billed on the quotation. To update this field, use the specific API: Associate or modify the customer site address in a quotation.

Quotation

customFields

customData

Quotation

deliverySiteId

deliverySiteId: this field is automatically set with the delivery site ID of the customer on the quotation. To update this field, use the specific API: Associate or modify the customer site address in a quotation.

Quotation

salesOrderSiteId

salesOrderSiteId : this field is automatically set with the sales order site ID of the customer on the quotation. To update this field, use the specific API: Associate or modify the customer site address in a quotation.

Quotation

chorusProperties

chorusProperties: if this field is null or omitted, the values of the fields within its details will be set to null.

Quotation

contractNumber

contractNumber: this field is deprecated, use chorusProperties/contractNumber instead

Quotation

customerDate

customerDate: this field can be updated; it will be clearedif omitted or if its value is null.

Quotation

durationOfValidity

durationOfValidity: this field can be updated; it will be cleared if omitted or if its value is null.

Quotation

entityCode

entityCode: this field is deprecated, use entityId instead. Until it is removed, if this field is set, its value will take precedence over the entitiId.

Quotation

entityId

entityId: with an existing ID in the database; its value is taken into account if entitycode is null. A consistency check is performed with the project entity on the quotation or on its lines.

Quotation

notified

notified: this field can be updated; it will be set to false if omitted or if its value is null.

Quotation

pipeId

pipeId: this field can be updated with an existing ID in the database; it will be cleared if omitted or if its value is null.

Quotation

quotationProbability

quotationProbability: by default, this field is set to '0' if its value is null or omitted.

Quotation

salesManagerId

salesManagerId: this field can be updated with an existing ID in the database; it will be cleared if omitted or if its value is null.

Quotation

technicalManagerId

technicalManagerId: this field can be updated with an existing ID in the database; it will be cleared if omitted or if its value is null.

Quotation

state

state: If this field is set to VALIDATED, it cannot be modified or omitted in the quotation update API.

QuotationLine

amountDiscount

discount.amount

QuotationLine

percentDiscount

discount.percent

QuotationLine

edited

notPublishable

QuotationLine

helpdeskProperties

helpdeskProperties: if this field is null or omitted, the values of the fields within its details will be set to null.

HelpdeskProperties

contractNumber

contractNumber: The contract number is checked for correctness. If the number is incorrect, both this field and the associated contract ID will be set to null.

QuotationLine

notificationComment

notificationComment: to update this field, notified filed in quotation must be set to true.

QuotationLine

notificationDate

notificationDate: to update this field, notified filed in quotation must be set to true.

QuotationLine

phaseId

phaseId: if the project indicated in the quotation line contains phases, this field is mandatory.

QuotationLine

projectId

projectId: this field is mandatory and must be set with an existing project id in the database.

QuotationLine

projectTaskId

projectTaskId: this field must be set with the ID of an existing project task in the database, matching the subphase or phase and project indicated in the quotation line.

QuotationLine

salesPersonId

salesPersonId: this field can be updated; it will be cleared if omitted or if its value is null.

QuotationLine

subPhaseId

subPhaseId: this field must be set with the ID of an existing sub phase in the database, matching the phase and project indicated in the quotation line.

QuotationReadOption

CUSTOM_FIELDS

CUSTOM_DATA

QuotationCriteria

readOptions

readOption

SalesOrderCriteria

readOptions

readOption

PackLine

itemId

soldItemId

4.10.4. Removed resource fields

Resource Version 2 Quotation

estimatedDeliveryDate

Quotation

estimatedBillingDate

QuotationLine

amountDiscount

QuotationLine

4.11. Security

4.11.1. Updated URLs

Version 2 Version 3

GET /users/{user_code}/switch

POST /users/{user_code}/switch See

POST /unmark-to-anonymizee

POST /unmark-to-anonymize See

4.12. Services integration

4.12.1. Updated URLs

Version 2 Version 3

PUT /bridge/users/{bridge_user_id}/items/{bridge_item_id}

GET /bridge/users/{bridge_user_id}/items/{bridge_item_id} See

PUT /bridge/users/{bridge_user_id}/items

GET /bridge/users/{bridge_user_id}/items See

4.13. Settings

4.13.1. Updated URLs

Version 2 Version 3

GET /custom-field-params/{customizable_resource}/search

GET /custom-data-params/{customizable_resource} See

POST /authentication-service/saml

POST /authentication-service/saml/search See

POST /triggers

PUT /triggers See

PUT /apps/{app_code}/preferences/{preference_id}

POST /apps/{app_code}/preferences/{preference_id} See

PUT /apps/{app_code}/project-filters/{filter_id}

POST /apps/{app_code}/project-filters/{filter_id} See

PUT /chorus-configurations/{chorus_config_id}

POST /chorus-configurations/{chorus_config_id} See

PUT /tags/{tag_id}

POST /tags/{tag_id} See

PUT /triggers/{trigger_id}

POST /triggers/{trigger_id} See

4.13.2. Updated resource fields

Resource Version 2 Version 3

ResourceType

DEPARTEMENT

DEPARTMENT

ResourceType

INVOICE_ORDER

SALES_INVOICE

PurchaseAccountingJournal

code

code: this field is mandatory and cannot be updated once it has been created.

PurchaseAccountingJournal

creditNotesJournalId

creditNotesJournalId: this field can be updated with an existing ID in the database; it will be cleared if omitted or if its value is null.

PurchaseAccountingJournal

divisionId

divisionId: this field can be updated with an existing ID in the database; it will be cleared if omitted or if its value is null.

PurchaseAccountingJournal

entityId

entityId: this field can be updated with an existing ID in the database; it will be cleared if omitted or if its value is null.

PurchaseAccountingJournal

finalJournal

finalJournal: this field can be updated; it will be set to false if omitted or if its value is null.

PurchaseAccountingJournal

journalType

journalType: this field is read-only and provides current data without allowing modifications.

PurchaseAccountingJournal

linkedGroupJournalId

linkedGroupJournalId: this field can be updated with an existing ID in the database; it will be cleared if omitted or if its value is null.

PurchaseAccountingJournal

linkedInternalJournalId

linkedInternalJournalId: this field can be updated with an existing ID in the database; it will be cleared if omitted or if its value is null.

PurchaseAccountingJournal

name

name: this field is mandatory

PurchaseAccountingJournal

reversingAccountNumber

reversingAccountNumber: this field can be updated with an existing account number in the database; it will be cleared if omitted or if its value is null.

SalesAccountingJournal

code

code: this field is mandatory and cannot be updated once it has been created.

SalesAccountingJournal

creditNotesJournalId

creditNotesJournalId: this field can be updated with an existing ID in the database; it will be cleared if omitted or if its value is null.

SalesAccountingJournal

divisionId

divisionId: this field can be updated with an existing ID in the database; it will be cleared if omitted or if its value is null.

SalesAccountingJournal

finalJournal

finalJournal: this field can be updated; it will be set to false if omitted or if its value is null.

SalesAccountingJournal

journalType

journalType: this field is read-only and provides current data without allowing modifications.

SalesAccountingJournal

linkedGroupJournalId

linkedGroupJournalId: this field can be updated with an existing ID in the database; it will be cleared if omitted or if its value is null.

SalesAccountingJournal

linkedInternalJournalId

linkedInternalJournalId: this field can be updated with an existing ID in the database; it will be cleared if omitted or if its value is null.

SalesAccountingJournal

name

name: this field is mandatory

SalesAccountingJournal

reversingAccountNumber

reversingAccountNumber: this field can be updated with an existing account number in the database; it will be cleared if omitted or if its value is null.

ValidationBankingDataRule

entityId

entityId: this field can be updated with an existing ID in the database; it will be cleared if omitted or if its value is null.

ValidationBankingDataRule

filterGroupSupplier

filterGroupSupplier: If this field is omitted or null, it will automatically be set to the value 'ALL'.

ValidationBankingDataRule

supplierType

supplierType: If this field is omitted or null, it will automatically be set to the value 'ALL'.

ValidationBankingDataRule

supplierVariety

supplierVariety: If this field is omitted or null, it will automatically be set to the value 'ALL'.

ValidationBankingDataRule

validatorId

validatorId: this field can be updated with an existing ID in the database; it will be cleared if omitted or if its value is null.

WebModuleSetting

id

id: this field must to set with an existing ID in the database and consistent with the one in the url

WebModuleSetting

module

module: this field is mandatory. It can be updated with the ID of an existing WebModule.

4.14. Support

4.14.1. Updated URLs

Version 2 Version 3

GET /issues/{issue_id}/tasks/{task_id}/timerecordings/mine

GET /issues/{issue_id}/tasks/{task_id}/timesheet-entries/mine See

GET /issues/{issue_id}/tasks/{task_id}/timerecordings

GET /issues/{issue_id}/tasks/{task_id}/timesheet-entries See

GET /issues/custom-fields

GET /issues/custom-Data See

POST /card-groups/{card_group_id}/timerecordings

POST /card-groups/{card_group_id}/timesheet-entries See

POST /issues/{issue_id}/suspend-afterwards

POST /issues/{issue_id}/put-closed-on-hold See

POST /issues/{issue_id}/suspend

POST /issues/{issue_id}/put-on-hold See

POST /issues/{issue_id}/tasks/{task_id}/timerecordings/delete-all

POST /issues/{issue_id}/tasks/{task_id}/timesheet-entries/delete-all See

POST /issues/{issue_id}/tasks/{task_id}/timerecordings/replace

POST /issues/{issue_id}/tasks/{task_id}/timesheet-entries/replace See

POST /issues/{issue_id}/tasks/{task_id}/timerecordings

POST /issues/{issue_id}/tasks/{task_id}/timesheet-entries See

POST /issues/custom-fields/batch-update

POST /issues/custom-data/batch-update See

POST /issues/suspension-reasons/search

POST /issues/on-hold-reasons/search See

POST /sprints/{sprint_id}/cancel_end

POST /sprints/{sprint_id}/cancel-end See

POST /sprints/{sprint_id}/cancel_start

POST /sprints/{sprint_id}/cancel-start See

POST /sprints/{sprint_id}/cards

PUT /sprints/{sprint_id}/cards See

POST /sprints/{sprint_id}/quick-entries/{quick_entry_issue_id}/quick-create

PUT /sprints/{sprint_id}/quick-entries/{quick_entry_issue_id}/quick-create See

4.14.2. Updated resource names

Version 2 Version 3

CustomFieldsIssueMap

CustomDataIssueMap

Suspension

OnHold

SuspensionReason

OnHoldReason

SuspensionReasonCriteria

OnHoldReasonCriteria

4.14.3. Updated resource fields

Resource Version 2 Version 3

Completion

nextRespondingEmployee

nextRespondingEmployeeId

Completion

nextTeam

nextTeamId

IndexSplittingType

QUATERLY

QUARTERLY

RevisionPeriod

QUATERLY

QUARTERLY

Issue

createdBy

changeTracking.createdBy

Issue

createdById

changeTracking.createdById

Issue

createdTime

changeTracking.createdTime

Issue

customFields

customData

Issue

modificationTime

changeTracking.modificationTime

Issue

suspension

onHold

Issue

suspensionId

onHoldId

IssueCriteria

customFields

customData

IssueCriteria

withoutCustomFields

withoutCustomData

IssueReadOption

CREATED_BY

CHANGE_TRACKING

IssueReadOption

CUSTOM_FIELDS

CUSTOM_DATA

IssueReadOption

SUSPENSION

ONHOLD

IssueStatusType

CLOTURE_EXT

CLOSE_EXT

IssueStatusType

CLOTURE_INT

CLOSE_INT

IssueStatusType

EN_COURS

IN_PROGRESS

IssueStatusType

OUVERT

CREATED

IssueStatusType

RESOLU

RESOLVED

IssueStatusType

SUSPENDU

ON_HOLD

OnHold

reason

onHoldReason

OnHold

reasonId

onHoldReasonId

OnHold

suspensionDate

date

OnHold

suspensionReason

reason

SupportDashboardReadOption

SUSPENSION

ON_HOLD

SupportDashboardResult

customFields

customData

Task

createdBy

changeTracking.createdBy

Task

createdById

changeTracking.createdById

Task

createdTime

changeTracking.createdTime

Task

modificationTime

changeTracking.modificationTime

Task

updatedBy

changeTracking.modificationBy

Task

updatedById

changeTracking.modificationById

TaskType

REMOVE_SUSPENSION

REMOVE_ONHOLD

Contract

accountingJournalId

accountingJournalId: this field can be updated with an existing ID in the database; it will be cleared if omitted or if its value is null.

Contract

adminManagerId

adminManagerId: this field can be updated with an existing ID in the database; it will be cleared if omitted or if its value is null.

Contract

anniversary

anniversary: this field can be updated; it will be set to false if omitted or if its value is null

Contract

billingBlockedDate

billingBlockedDate: this field can be updated; it will be set to false if omitted or if its value is null

Contract

billingSiteId

billingSiteId: this field can be updated with an existing ID in the database; it will be cleared if omitted or if its value is null.

Contract

categoryId

categoryId: this field can be updated with an existing ID in the database; it will be cleared if omitted or if its value is null.

Contract

comments

comments: this field can be updated; it will be set to false if omitted or if its value is null

Contract

contractNature

contractNature: this field cannot be updated after a contract is created.

Contract

contractTypeId

contractTypeId: this field is mandatory and can be updated with an existing ID in the database.

Contract

currencyCode

currencyCode: this field is mandatory and can be updated with an existing currency in the database.

Contract

customerId

customerId: if the 'contractNature' field is set to 'CUSTOMER,' this field becomes mandatory and can be updated with an existing ID in the database.

Contract

customerToBillId

customerToBillId: this field is mandatory and can be updated with an existing ID in the database. If omitted or null, it will automatically be set to the value of 'customerId'.

Contract

deliveryGenerationUnit

deliveryGenerationUnit: If this field is omitted or null, it will automatically be set to the value 'PER_CONTRACT'.

Contract

effectiveDate

effectiveDate: this field is mandatory

Contract

endDate

endDate: this field can be updated; it will be set to false if omitted or if its value is null. Note : updating this field may require the activation of a pilot.

Contract

extensionNumber

extensionNumber: this field is read-only and provides current data without allowing modifications.

Contract

externalReference

externalReference: this field can be updated; it will be set to false if omitted or if its value is null.

Contract

inactiveContract

inactiveContract: this field can be updated; it will be set to false if omitted or if its value is null.

Contract

internalReference

internalReference: this field can be updated; it will be set to false if omitted or if its value is null.

Contract

isHiddenHD

isHiddenHD: this field can be updated; it will be set to false if omitted or if its value is null.

Contract

isMultiProject

isMultiProject: this field can be updated; it will be set to false if omitted or if its value is null. If this field is set to false, project (projectId) and its sub-elements must be set.

Contract

maintenanceSiteId

maintenanceSiteId: this field can be updated with an existing ID in the database; it will be cleared if omitted or if its value is null.

Contract

manualBilling

manualBilling: this field can be updated; it will be set to false if omitted or if its value is null.

Contract

name

name: this field is mandatory

Contract

notBillable

notBillable: this field can be updated; it will be set to false if omitted or if its value is null.

Contract

phaseId

phaseId: this field can be updated with the ID of an existing phase in the database, consistent with the project.

Contract

projectId

projectId: this field can be updated with the ID of an existing phase in the database. If “isMultiProject” field is set to true, this field cannot be uptated.

Contract

reasonForTermination

reasonForTermination: this field can be updated; it will be set to false if omitted or if its value is null.

Contract

reminder

reminder: this field can be updated; it will be set to false if omitted or if its value is null.

Contract

renewalDate

renewalDate: this field can be updated; it will be set to false if omitted or if its value is null.

Contract

renewalReminder

renewalReminder: this field can be updated; it will be set to false if omitted or if its value is null.

Contract

renewalReminderDate

renewalReminderDate: this field can be updated; it will be set to false if omitted or if its value is null.

Contract

renewalTypeId

renewalTypeId: this field can be updated with an existing ID in the database; it will be cleared if omitted or if its value is null.

Contract

salesManagerId

salesManagerId: this field can be updated with an existing ID in the database; it will be cleared if omitted or if its value is null.

Contract

signatureDate

signatureDate: this field can be updated; it will be set to false if omitted or if its value is null.

Contract

subCategoryId

subCategoryId: this field can be updated with an existing ID in the database; it will be cleared if omitted or if its value is null.

Contract

subPhaseId

subPhaseId: this field can be updated with the ID of an existing sub phase in the database, consistent with the project and phase.

Contract

supplierId

supplierId: if the 'contractNature' field is set to 'SUPPLIER,' this field becomes mandatory and can be updated with an existing ID in the database.

Contract

supplierToPayId

supplierToPayId: this field is mandatory and can be updated with an existing ID in the database. If omitted or null, it will automatically be set to the value of 'supplierId'.

Contract

technicalManagerId

technicalManagerId: this field can be updated with an existing ID in the database; it will be cleared if omitted or if its value is null.

Contract

terminationEffectiveDate

terminationEffectiveDate: this field can be updated; it will be set to false if omitted or if its value is null.

Contract

terminationNoticeLimit

terminationNoticeLimit: this field can be updated; it will be set to false if omitted or if its value is null.

Contract

terminationReceptionDate

terminationReceptionDate: this field can be updated; it will be set to false if omitted or if its value is null.

ContractService

code

code: this field can be updated with an existing code in the database but cannot be updated ged once created. It is mandatory if the 'templateContractServiceId' field is set to null.

ContractService

contractId

contractId: this field must to set with an ID consistent with the one in the url and containing the contract service

ContractService

criticalityId

criticalityId: this field can be updated with an existing ID in the database; it will be cleared if omitted or if its value is null.

ContractService

id

id: this field must to set with an existing ID in the database and consistent with the one in the url

ContractService

issueTypeId

issueTypeId: this field can be updated with an existing ID in the database; it will be cleared if omitted or if its value is null.

ContractService

name

name: this field can be updated and it is mandatory

ContractService

phaseId

phaseId: this field can be updated with the ID of an existing phase in the database, consistent with the project.

ContractService

priorityId

priorityId: this field can be updated with an existing ID in the database; it will be cleared if omitted or if its value is null.

ContractService

productBilledId

productBilledId: this field can be updated with an existing ID in the database; it will be cleared if omitted or if its value is null.

ContractService

projectId

projectId: this field can be updated with the ID of an existing phase in the database. If “isMultiProject” field is set to true, this field cannot be uptated.

ContractService

regression

regression: this field can be updated; it will be set to false if omitted or if its value is null.

ContractService

severityId

severityId: this field can be updated with an existing ID in the database; it will be cleared if omitted or if its value is null.

ContractService

subPhaseId

subPhaseId: this field can be updated with the ID of an existing sub phase in the database, consistent with the project and phase.

ContractService

teamId

teamId: this field can be updated with an existing ID in the database; it will be cleared if omitted or if its value is null.

ContractService

templateContractServiceId

templateContractServiceId: this field can be with the ID of an existing code in the database. It is mandatory if the ‘code’ field is set to null.

ContractServiceLine

contractServiceId

contractServiceId: this field must to set with an ID consistent with the one in the url and containing the contract service line

ContractServiceLine

phaseId

phaseId: this field can be updated with the ID of an existing phase in the database, consistent with the project.

ContractServiceLine

productId

productId: this field can be updated with an existing ID in the database; it is a mandatory field

ContractServiceLine

projectId

projectId: this field can be updated with the ID of an existing phase in the database. If “isMultiProject” field in contract service is set to true, this field cannot be uptated.

ContractServiceLine

quantity

quantity: this field is mandatory

ContractServiceLine

serialNumber

serialNumber: this field cannot be updated

ContractServiceLine

subPhaseId

subPhaseId: this field can be updated with the ID of an existing sub phase in the database, consistent with the project and phase.

ContractServiceLine

totalAmount

totalAmount: this field cannot be updated. It is automatically calculted.

4.14.4. Removed resource fields

Resource Version 2 ContractCriteria

accountingJourna

OnHold

estimatedEndDate

Contract

terminationDate

ContractServiceCriteria

4.15. Workforce

4.15.1. Updated URLs

Version 2 Version 3

DELETE /employees/{employee_id}/abilities

POST /employees/{employee_id}/abilities/delete See

DELETE /fluent/schedule

POST /fluent/schedule/delete See

DELETE /schedules

POST /schedules/delete See

GET /approvals-without-refuse

GET /approvals/mine with query param: exclude_refused See

GET /approvals

GET /approvals/mine See

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

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

GET /employees/{employee_id}/timerecording-terminations

GET /employees/{employee_id}/timesheet-entries/completions See

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

GET /expense-reports/{expense_report_id}/expense-receipts See

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

GET /managers/{manager_id}/employees/timesheet-entries/completions See

GET /managers/{manager_id}/employees/timerecordings

GET /managers/{manager_id}/employees/timesheet-entries See

GET /schedules/places/search

GET /schedules/locations/search See

GET /timerecordings/mine

GET /timesheet-entries/mine See

GET /timerecordings/places/search

GET /timesheet-entries/locations/search See

GET /timerecordings/quick-entries-time/mine

GET /timesheet-entries/quick-entries-time/mine See

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

GET /timesheet-entries/quick-entries-time/mine See

POST /employees/categories

PUT /employees/categories See

POST /employees/events/summaries

POST /employees/events/summaries/search See

POST /employees/timerecordings/publish

POST /employees/timesheet-entries/publish See

POST /employees

PUT /employees See

POST /fluent/employees

PUT /fluent/employees See

POST /fluent/schedule

PUT /fluent/schedule See

POST /leave-types

POST /leave-types/search See

POST /managers-delegated/mine

POST /managers-delegated/mine/search See

POST /schedules/create-options

PUT /schedules/create-options See

POST /time-recordings/termination/add

POST /timesheet-entries/completion/add See

POST /time-recordings/termination/cancel

POST /timesheet-entries/completion/cancel See

POST /timerecordings/add

POST /timesheet-entries/add See

POST /timerecordings/cancel-validation

POST /timesheet-entries/cancel-validation See

POST /timerecordings/quick-entries-time/read-mine

POST /timesheet-entries/quick-entries-time/read-mine See

POST /timerecordings/refuse

POST /timesheet-entries/refuse See

POST /timerecordings/replace

POST /timesheet-entries/replace See

POST /timerecordings/reset

POST /timesheet-entries/reset See

POST /timerecordings/search

POST /timesheet-entries/search See

POST /timerecordings/send

POST /timesheet-entries/send See

POST /timerecordings/validate

POST /timesheet-entries/validate See

PUT /employees/{employee_id}/history

POST /employees/{employee_id}/history See

PUT /employees/{employee_id}

POST /employees/{employee_id} See

PUT /employees/categories/{employees_category_id}

POST /employees/categories/{employees_category_id} See

PUT /fluent/employees/{employee_code}

POST /fluent/employees/{employee_code} See

4.15.2. Updated resource names

Version 2 Version 3

EventPlace

EventLocation

TimeRecordingTermination

TimeRecordingCompletion

TimeRecordingTerminationCriteria

TimeRecordingCompletionCriteria

4.15.3. Updated resource fields

Resource Version 2 Version 3

CustomRequest

arrivalPlace

arrivalLocation

CustomRequest

category

category.name

CustomRequest

customFields

customData

CustomRequest

departurePlace

departureLocation

CustomRequest

accountingJournal

accountingJournal: this field was previously incorrectly added to CustomRequest, as the object already inherited it from ManagementObject. It has now been removed from CustomRequest.

CustomRequest

accountingJournalId

accountingJournalId: this field was previously incorrectly added to CustomRequest, as the object already inherited it from ManagementObject. It has now been removed from CustomRequest.

CustomRequest

assignmentIndicator

assignmentIndicator: this field was previously incorrectly added to CustomRequest, as the object already inherited it from ManagementObject. It has now been removed from CustomRequest.

CustomRequest

categoryId

categoryId: this field is mandatory when creating a custom request. It is no longer editable in the custom request update API.

CustomRequest

conditionOfPayment

conditionOfPayment: this field was previously incorrectly added to CustomRequest, as the object already inherited it from ManagementObject. It has now been removed from CustomRequest.

CustomRequest

entityCode

entityCode: this fields is deprecated

CustomRequest

exchangeRate

exchangeRate: this field was previously incorrectly added to CustomRequest, as the object already inherited it from ManagementObject. It has now been removed from CustomRequest.

CustomRequest

fiscalYear

fiscalYear: this field was previously incorrectly added to CustomRequest, as the object already inherited it from ManagementObject. It has now been removed from CustomRequest.

CustomRequest

group

group: this field was previously incorrectly added to CustomRequest, as the object already inherited it from ManagementObject. It has now been removed from CustomRequest.

CustomRequest

manager

manager: this field was previously incorrectly added to CustomRequest, as the object already inherited it from ManagementObject. It has now been removed from CustomRequest.

CustomRequest

managerId

managerId: this field was previously incorrectly added to CustomRequest, as the object already inherited it from ManagementObject. It has now been removed from CustomRequest.

CustomRequest

methodOfPayment

methodOfPayment: this field was previously incorrectly added to CustomRequest, as the object already inherited it from ManagementObject. It has now been removed from CustomRequest.

CustomRequest

pricingMethod

pricingMethod: this field was previously incorrectly added to CustomRequest, as the object already inherited it from ManagementObject. It has now been removed from CustomRequest.

CustomRequest

pricingMethodId

pricingMethodId: this field was previously incorrectly added to CustomRequest, as the object already inherited it from ManagementObject. It has now been removed from CustomRequest.

CustomRequest

thirdPartyToBillId

thirdPartyToBillId: this field was previously incorrectly added to CustomRequest, as the object already inherited it from ManagementObject. It has now been removed from CustomRequest.

CustomRequestLine

action

action: this field was previously incorrectly added to CustomRequestLine, as the object already inherited it from ManagementObjectLine. It has now been removed from CustomRequestLine.

CustomRequestLine

additionalFreeFields

additionalFreeFields: this field was previously incorrectly added to CustomRequestLine, as the object already inherited it from ManagementObjectLine. It has now been removed from CustomRequestLine.

CustomRequestLine

afterTaxAmountTotal

afterTaxAmountTotal: this field was previously incorrectly added to CustomRequestLine, as the object already inherited it from ManagementObjectLine. It has now been removed from CustomRequestLine.

CustomRequestLine

afterTaxAmountTotalCurrency

afterTaxAmountTotalCurrency: this field was previously incorrectly added to CustomRequestLine, as the object already inherited it from ManagementObjectLine. It has now been removed from CustomRequestLine.

CustomRequestLine

complementName

complementName: this field was previously incorrectly added to CustomRequestLine, as the object already inherited it from ManagementObjectLine. It has now been removed from CustomRequestLine.

CustomRequestLine

customerId

customerId: this field is read-only and provides current data without allowing modifications.

CustomRequestLine

expenseTypeExpectedId

expenseTypeExpectedId: this field was previously incorrectly added to CustomRequestLine, as the object already inherited it from ManagementObjectLine. It has now been removed from CustomRequestLine.

CustomRequestLine

managementObjectId

managementObjectId: this field was previously incorrectly added to CustomRequestLine, as the object already inherited it from ManagementObjectLine. It has now been removed from CustomRequestLine.

CustomRequestLine

phaseId

phaseId: this field is read-only and provides current data without allowing modifications.

CustomRequestLine

projectId

projectId: this field is read-only and provides current data without allowing modifications.

CustomRequestLine

projectTaskId

projectTaskId: this field is read-only and provides current data without allowing modifications.

CustomRequestLine

resource

resource: this field was previously incorrectly added to CustomRequestLine, as the object already inherited it from ManagementObjectLine. It has now been removed from CustomRequestLine.

CustomRequestLine

resourceId

resourceId: this field was previously incorrectly added to CustomRequestLine, as the object already inherited it from ManagementObjectLine. It has now been removed from CustomRequestLine.

CustomRequestLine

subPhaseId

subPhaseId: this field is read-only and provides current data without allowing modifications.

CustomRequestLine

totalPrice

totalPrice: this field was previously incorrectly added to CustomRequestLine, as the object already inherited it from ManagementObjectLine. It has now been removed from CustomRequestLine.

CustomRequestLine

totalPriceCurrency

totalPriceCurrency: this field was previously incorrectly added to CustomRequestLine, as the object already inherited it from ManagementObjectLine. It has now been removed from CustomRequestLine.

CustomRequestReadOption

CUSTOM_FIELDS

CUSTOM_DATA

Employee

customFields

customData

Employee

code

code: this field cannot be omitted, null, or modified in the Employee update API.

EmployeeFluent

code

code: this field cannot be omitted, null, or modified in the Employee update API.

EmployeeFunctions

cMMSContractSalesManager

CMMSContractSalesManager

EmployeeFunctions

cMMSContractTechnicalManager

CMMSContractTechnicalManager

EmployeeFunctions

cMMSMRAndEOManager

CMMSMRAndEOManager

EmployeeHistory

employeeFamily2

family2Id

EmployeeHistory

employeeFamily3

family3Id

EmployeeHistory

family1employeeFamily1Id

family1Id

EmployeeHistory

dailyCost

dailyCost: if this field is null or omitted, it will be automatically set to 0.

EmployeeHistory

dailyHours

dailyHours: if this field is null or omitted, it will be automatically set to the value of dailyHours in EmployeeWeek (standard week of the employee).

EmployeeHistory

dailySellingPrice

dailySellingPrice: if this field is null or omitted, it will be automatically set to 0.

EmployeeHistory

directHourlyRate

directHourlyRate: if this field is null or omitted, it will be automatically set to 0.

EmployeeHistory

employeeHistoryType

employeeHistoryType: this field is deprecated , use standardWeekId instead

EmployeeHistory

employeeId

employeeId: the employee ID in the URL must exist in the database and also match the value of this field.

EmployeeHistory

family1Id

family1Id: this field can be updated with an existing ID in the database; it will be cleared if omitted or if its value is null.

EmployeeHistory

family2Id

family2Id: this field can be updated with an existing ID in the database; it will be cleared if omitted or if its value is null.

EmployeeHistory

family3Id

family3Id: this field can be updated with an existing ID in the database; it will be cleared if omitted or if its value is null.

EmployeeHistory

leave

leave: this field can be updated; it will be set to false if omitted or if its value is null.

EmployeeHistory

managerId

managerId: this field can be updated with an existing ID in the database; it will be cleared if omitted or if its value is null.

EmployeeHistory

occupancyRate

occupancyRate: if this field is null or omitted, it will be automatically set to 0.

EmployeeHistory

position

position: this field can be updated; it will be cleared if omitted or if its value is null.

EmployeeHistory

service

service: this field can be updated with an existing ID in the database; it will be cleared if omitted or if its value is null.

EmployeeHistory

skill

skill: this field can be updated with an existing ID in the database; it will be cleared if omitted or if its value is null.

EmployeeHistoryFluent

dailyCost

dailyCost: if this field is null or omitted, it will be automatically set to 0.

EmployeeHistoryFluent

dailyHours

dailyHours: if this field is null or omitted, it will be automatically set to the value of dailyHours in EmployeeWeek (standard week of the employee).

EmployeeHistoryFluent

dailySellingPrice

dailySellingPrice: if this field is null or omitted, it will be automatically set to 0.

EmployeeHistoryFluent

directHourlyRate

directHourlyRate: if this field is null or omitted, it will be automatically set to 0.

EmployeeHistoryFluent

employeeHistoryType

employeeHistoryType: this field is deprecated , use standardWeekId instead

EmployeeHistoryFluent

employeeId

employeeId: the employee ID in the URL must exist in the database and also match the value of this field.

EmployeeHistoryFluent

family1Id

family1Id: this field can be updated with an existing ID in the database; it will be cleared if omitted or if its value is null.

EmployeeHistoryFluent

family2Id

family2Id: this field can be updated with an existing ID in the database; it will be cleared if omitted or if its value is null.

EmployeeHistoryFluent

family3Id

family3Id: this field can be updated with an existing ID in the database; it will be cleared if omitted or if its value is null.

EmployeeHistoryFluent

leave

leave: this field can be updated; it will be set to false if omitted or if its value is null.

EmployeeHistoryFluent

managerId

managerId: this field can be updated with an existing ID in the database; it will be cleared if omitted or if its value is null.

EmployeeHistoryFluent

occupancyRate

occupancyRate: if this field is null or omitted, it will be automatically set to 0.

EmployeeHistoryFluent

position

position: this field can be updated; it will be cleared if omitted or if its value is null.

EmployeeHistoryFluent

service

service: this field can be updated with an existing ID in the database; it will be cleared if omitted or if its value is null.

EmployeeHistoryFluent

skill

skill: this field can be updated with an existing ID in the database; it will be cleared if omitted or if its value is null.

EmployeeReadOption

CUSTOM_FIELDS

CUSTOM_DATA

ExpenseReportCriteria

terminated

completed

ProjectLinkCriteria

checkEmployeeCompagny

checkEmployeeCompany

ProjectLinkCriteria

checkTimerecordings

checkTimesheet

ProjectLinkCriteria

endDate

date

ProjectLinkCriteria

startDate

date

Schedule

salesOrderId

quotationId

ScheduleCriteria

place

location

ScheduleDuplicationParamHolder

duplicationPeriodRepetionType

duplicationPeriodRepetitionType

ScheduleDuplicationParamHolder

occurency

occurrency

ScheduleDuplicationParamHolder

numberOfOccurency

numberOfOccurrency

ScheduleDuplicationParamHolder

duplicationNumberOfOccurencyType

duplicationNumberOfOccurrencyType

ScheduleDuplicationType

WITH_OCCURENCY

WITH_OCCURRENCY

ScheduleDuplicationPeriodType

QUATERLY

QUARTERLY

TimeRecordingCompletion

terminationType

completionType

TimeRecordingCriteria

from

period.from

TimeRecordingCriteria

to

period.to

TimeRecordingRules

terminationMode

completionMode

TimeRecordingRules

terminationType

completionType

Employee

multiCompany

assignmentMultiCompany

TimesheetEntryCriteria

from

period.from

TimesheetEntryCriteria

to

period.to

EmployeeCriteria

shouldBeNotified

noTimesDunning

QuickEntryTime

phaseId

phaseId: if the project in the QuickEntryTime contains phases, this field is mandatory and must correspond to an existing ID in the database.

QuickEntryTime

projectId

projectId: this field is mandatory and must correspond to an existing ID in the database.

QuickEntryTime

projectTaskId

projectTaskId: this field is mandatory and must correspond to an existing ID in the database, matching the sub-phase or phase and project indicated in the QuickEntryTime.

QuickEntryTime

subPhaseId

subPhaseId: if the project in the QuickEntryTime contains phases and sub phases, this field is mandatory and must correspond to an existing ID in the database.

4.15.4. Removed resource fields

Resource Version 2 ScheduleDuplicationParamHolder

useDateHours

Employee

modeTimeRecording

5. Compliance Upgrade of APIs

5.1. Version: 5.10.0

5.1.1. Harmonization of update APIs (POST)

Starting with version 5.10.0, the update APIs have been harmonized. The changes to be considered when using update requests (POST) are outlined below.

The POST request process

1. Mandatory Fields:

  • Must always be included in the request, even if their value is not changing.

  • Missing a mandatory field will result in a 400 (Bad Request) error.

2. Non-mandatory Fields:

  • It is recommended to include all non-mandatory fields in the request.

  • If a non-mandatory field containing a value is omitted, it will automatically be set to NULL.

  • To empty a field, include it in the request body with the value NULL rather than omitting it.

3. Fields Requiring a dedicated API:

  • Some fields, such as businessCards in Employee, must be updated through a dedicated API. If included in a regular update request, they will be ignored.

4. Boolean Fields:

  • It is recommended to always include them exhaustively in the request. If a boolean field is omitted, it will default to unchecked (set to ‘False’).

Recommendations

We recommend following this process:

1. Retrieve the resource before updating:

  • Use an API to get the full resource before making any updates:

  • GET API: Retrieves all necessary fields for the update.

  • SEARCH API: If the GET API is unavailable or the resource ID is unknown, use a search API.

2. Build the update request:

  • Use the response to ensure all necessary fields are included, even if some are not being modified.

List of update APIs concerned
Domain API

CRM See

Update a contact See

CRM See

Update a Customer See

CRM See

Update a people link between two third parties See

CRM See

Update a Customer site See

CRM See

Update an event See

CRM See

Update an opportunity See

Sales See

Update a quotation See

Purchase See

Update a purchased item See

Purchase See

Update a supplier See

Purchase See

Update a supplier site See

Purchase See

Update a people link between two third parties See

Purchase See

Update a temporary invoice See

Workforce See

Update a Custom Request See

Workforce See

Update a custom request line See

Workforce See

update an employee See

Workforce See

Update an employee fluently See

Workforce See

Update an employee history with its id See

Workforce See

Update a quick entry time See

Settings See

Update an opportunity stage See

Settings See

Update an opportunity stages template See

Settings See

Update a purchase accounting journal See

Settings See

Update a sales accounting journal See

Settings See

Update a banking data validation rule See

Settings See

Update the web module setting See

Settings See

Create or update web module settings list See

Document Management See

Update a document See

Project Management See

Update a project task See

Project Management See

Update a project task of a project See

Project Management See

Update a sub-phase See

Project Management See

Update a phase See

Project Management See

Update a project See

Mobile See

Update a Schedule See

Mobile See

Update a timesheet entry See

Support See

Update an contract See

Support See

Update the customer of a contract See

5.1.2. Harmonization of Company Fields for a Resource

Starting with version 5.10.0, the management of resource company fields in APIs has been harmonized.

The changes to be considered for creation (PUT) and update (POST) requests for resources concerned are described below.

The PUT and POST request process

1.Creation of a Resource (PUT): The resource is automatically linked to the company of the connected user (the user sending the API request) or the one specified in the request header.

  • If a company is mentioned in both the body and the header, they must match. Otherwise, an error is returned.

  • If the company is only specified in the header, the resource will be created under that company indicated in the header.

  • If the company is only in the body, and the user does not belong to that company, an error is returned. Conversely, if the connected user belongs to the same company as the one for which they want to create the resource, the resource will be successfully created.

  • Once created, the company cannot be changed.

Note: The user must have the necessary rights to create a resource for a specific company.

2.Modification of a Resource (POST):

  • If the user belongs to a different company than the resource’s, an error will occur.

  • Specifying a different company in the header than the resource’s company will also cause an error.

  • Any attempt to modify the company, either through the header or the request body, will result in an error, as the resource remains permanently linked to the original company.If the user’s company matches that of the resource or is mentioned in the header, the update will proceed if the user has the necessary rights.

Recommendations:

We recommend following this process:

1.Creation of a Resource (via PUT):

  • Specify the user’s company in the header, for example, in the "Key" column, enter "X-COMPANY-CODE" and in the "Value" column, enter "AKSAS". Here, "AKSAS" is an example of a company code.

    • Optionally and depending on the resources, you can specify the company in the request body, but it must match the header.

  • If you do not specify a company in the header of the request, the resource will be created automatically under the company of the connected user.

For example, when creating a project, you can set the company code in the header as follows.

PostmanHeaderCompany

2.Modification of a Resource (via POST):

  • You must also specify the company in the header of the request. Again, use "X-COMPANY-CODE" in the "Key" column and "AKSAS" in the "Value" column. Here, "AKSAS" corresponds to the company code for the resource.

    • If you have the required rights to modify a resource in this company, the resource can be modified. Otherwise, you will be prevented from making any modifications.

  • You cannot specify a different company in the header other than the one under which the resource was created.

  • Any attempt to modify the company-related fields in an update request (POST) will be ignored.

5.2. Version: 5.13.0

5.2.1. APIs deletion

For security reasons, some APIs will be removed starting with version 5.13.0.

Domain API Recommendations

Document Management See

Get a file as html by a temporary provided token See

Use Download a file See