Akuiteo Settings

1. Introduction

The Settings domain gives you access to many setup options: triggers, translations, web portals, preferences, currencies and so on.

1.1. Licence information

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

1.2. URI Scheme

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

1.3. Tags

Accounting Journal : Accounting Journal service
Applications : Applications
Archive Reasons : Archive Reasons
Authentication service : Authentication service
Chorus configuration : Chorus configuration
Closing Schedules : Closing Schedules
Companies : Companies
Company configs : Company configs
Controls : Controls
Countries : Countries
Currencies : Currencies resource
Custom data : Custom data
Customer Indicators : Customer Indicators
Customer Status : Customer Status
Electronic Signature : Electronic Signature
Feature settings : Features
Filters : Filters
Fixed asset : Fixed asset
Geographical Departments : Geographical Departments
Keywords : Keywords resource
Location Status : Location Status
On Boarding News : Onboarding news
Opportunity settings : Opportunity
Other Third-party Type : Other Third-party Type
People Links Types : People Links Types
Portals : Portals
Preferences : Preferences
Pricing Methods : Pricing Methods
Production Teams : Production Teams
Professional Category : Professional Category
Project settings : Projects
Project Task Types : Project Task Types service
Purchase Accounting Journal : Purchase Accounting Journal service
Regions : Regions
Resources : Resources
Sales Accounting Journal : Sales Accounting Journal service
Saved Searches : Saved Searches service
Search Fields Settings : Search Fields Settings
Sector : Sector
Settings : Settings
Table texts : Table texts service
Tags : Tags
Temp Purchase Invoices : Temp Purchase Invoices
Third Party Link Type : Third Party Link Type
Titles : Titles management
Translations : Translations resource
Triggers : Server triggers
VAT : VAT
VAT Area : VAT Area
Validation Banking Data Rules : Validation Banking Data Rules
Web module settings : Web module settings
Workforce : Workforce
Years : Years (vintage)

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. Accounting Journal

2.1.1. Close the accounting journal.

POST	/journals/{journal_id}/close

Description

This operation is irreversible. It will no longer be possible to change the closing date to a date prior to the chosen date

DMF required:

DMF A62711: Api Settings / Purchase Journal / Close
DMF 070703: Accounting / Setup / Journals

Parameters

Path Parameters

Name	Description	Required	Default	Pattern
journal_id	The id of an accounting journal	X	null

Name

Description

Required

Default

Pattern

journal_id

The id of an accounting journal

null

Body Parameter

Name	Description	Required	Default	Pattern
closingInformation	JournalClosingInformation	-

Name

Description

Required

Default

Pattern

closingInformation

JournalClosingInformation

Responses

Table 1. http response codes
Code	Message	Datatype
200	The accounting journal has been successfully closed	[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


{
  "closingReason" : "Lorem ipsum dolor",
  "closingDate" : "2020-01-31T23:59:59Z"
}

2.1.2. Search for Accounting journals

POST	/journals/search

Description

Get the list of accounting journals matching the search criteria

DMF required:

DMF A62704: Api Settings / Purchase Journal / Search
DMF 070703: Accounting / Setup / Journals
DMF 0202__: Sales / Quotations
DMF 020202: Sales / Quotations / Modify
DMF 020204: Sales / Quotations / Search
DMF 040901: Purchases / Temporary Invoices / New
DMF 040902: Purchases / Temporary Invoices / Modify
DMF 040904: Purchases / Temporary Invoices / Search
DMF 040905: Purchases / Temporary Invoices / Print
DMF 040907: Purchases / Temporary Invoices / Import
DMF 090182: Administrator / Setup / Tempory Invoices Journal Links

Parameters

Body Parameter

Name	Description	Required	Default	Pattern
criteria	Criteria that you choose (id, code, etc…) AccountingJournalCriteria	X

Name

Description

Required

Default

Pattern

criteria

Criteria that you choose (id, code, etc…) AccountingJournalCriteria

Query Parameters

Name	Description	Required	Default	Pattern
offset	The index of first element	-	null
limit	The max number of elements	-	null

Name

Description

Required

Default

Pattern

offset

The index of first element

null

limit

The max number of elements

null

Return Type

array[ManagementObjectsAccountingJournal]

Responses

Table 2. http response codes
Code	Message	Datatype
200	Accounting journals have been successfully loaded	List[ManagementObjectsAccountingJournal]
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


{
  "companyId" : {
    "operator" : "IS",
    "value" : "Abcd",
    "includeNullResults" : false,
    "wildcards" : "*"
  },
  "code" : {
    "operator" : "IS",
    "value" : "Abcd",
    "includeNullResults" : false,
    "wildcards" : "*"
  },
  "journalType" : {
    "operator" : "IS",
    "value" : "Abcd",
    "includeNullResults" : false,
    "wildcards" : "*"
  },
  "name" : {
    "operator" : "IS",
    "value" : "Abcd",
    "includeNullResults" : false,
    "wildcards" : "*"
  },
  "id" : {
    "operator" : "IS",
    "value" : "Abcd",
    "includeNullResults" : false,
    "wildcards" : "*"
  },
  "tag" : {
    "operator" : "IS",
    "value" : "Abcd",
    "includeNullResults" : false,
    "wildcards" : "*"
  },
  "validity" : {
    "type" : "{}",
    "date" : "2000-06-21T04:56:07.000+00:00"
  }
}

2.1.3. Set the end date of the accounting journal.

POST	/journals/{journal_id}/set-end-date

Description

Specifying the end date below prevents entries from being written in this journal any date later than the end date

DMF required:

DMF A62710: Api Settings / Purchase Journal / Set End Date
DMF 070703: Accounting / Setup / Journals

Parameters

Path Parameters

Name	Description	Required	Default	Pattern
journal_id	The id of an accounting journal	X	null

Name

Description

Required

Default

Pattern

journal_id

The id of an accounting journal

null

Body Parameter

Name	Description	Required	Default	Pattern
endDate	End date of the accounting journal [date]	X

Name

Description

Required

Default

Pattern

endDate

End date of the accounting journal [date]

Responses

Table 3. http response codes
Code	Message	Datatype
200	The end date has been correctly set on the accounting journal	[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


2013-10-20

2.2. Applications

2.2.1. Create an application

PUT	/applications

DMF required:

DMF A61301: Api Settings / Applications / Insert
DMF 090602: Administrator / Customer Portal / Launcher

Parameters

Body Parameter

Name	Description	Required	Default	Pattern
application	The application to create Application	X

Name

Description

Required

Default

Pattern

application

The application to create Application

Responses

Table 4. http response codes
Code	Message	Datatype
200	Application successful created	[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


{
  "id" : "5000123",
  "name" : "Lorem ipsum",
  "url" : "https://example.com/lorem-ipsum",
  "type" : "{}",
  "portalType" : "{}",
  "color" : "#FF0000",
  "image" : "image",
  "order" : 1,
  "right" : {
    "id" : "5000123",
    "code" : "AF0406",
    "name" : "INFO"
  },
  "rightId" : "5000123"
}

2.2.2. Delete an application

DELETE

/applications/{app_id}

DMF required:

DMF A61303: Api Settings / Applications / Delete
DMF 090602: Administrator / Customer Portal / Launcher

Parameters

Path Parameters

Name	Description	Required	Default	Pattern
app_id	The id of the application	X	null

Name

Description

Required

Default

Pattern

app_id

The id of the application

null

Responses

Table 5. http response codes
Code	Message	Datatype
204	Application successful deleted	<<>>
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

2.2.3. Get an application

GET	/applications/{app_id}

DMF required:

DMF A61306: Api Settings / Applications / Info
DMF 1901__: Web Portal / Timesheets & Schedules Menu
DMF 1903__: Web Portal / Timesheets
DMF 1904__: Web Portal / Schedules
DMF 1905__: Web Portal / Expense Reports
DMF 1906__: Web Portal / Leave Requests Validation
DMF 1907__: Web Portal / Timesheets Validation
DMF 1908__: Web Portal / Expense Reports Validation
DMF 1909__: Web Portal / Approvals
DMF 1910__: Web Portal / Reports
DMF 1911__: Web Portal / Custom Requests
DMF 1912__: Web Portal / Clear Cache

Parameters

Path Parameters

Name	Description	Required	Default	Pattern
app_id	The id of the application	X	null

Name

Description

Required

Default

Pattern

app_id

The id of the application

null

Responses

Table 6. http response codes
Code	Message	Datatype
200	Application successful loaded	Application
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

2.2.4. Get connected user applications

GET	/applications/mine

Responses

Table 7. http response codes
Code	Message	Datatype
200	User applications	List[Application]
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

2.2.5. Move an user application

POST	/applications/{app_id}/move/{position}

Parameters

Path Parameters

Name	Description	Required	Default	Pattern
app_id	The id of the application	X	null
position	The new app position	X	null

Name

Description

Required

Default

Pattern

app_id

The id of the application

null

position

The new app position

null

Responses

Table 8. http response codes
Code	Message	Datatype
204	Application successful updated	<<>>
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

2.2.6. Search applications

POST	/applications/search

DMF required:

DMF A61304: Api Settings / Applications / Search
DMF 1901__: Web Portal / Timesheets & Schedules Menu
DMF 1903__: Web Portal / Timesheets
DMF 1904__: Web Portal / Schedules
DMF 1905__: Web Portal / Expense Reports
DMF 1906__: Web Portal / Leave Requests Validation
DMF 1907__: Web Portal / Timesheets Validation
DMF 1908__: Web Portal / Expense Reports Validation
DMF 1909__: Web Portal / Approvals
DMF 1910__: Web Portal / Reports
DMF 1911__: Web Portal / Custom Requests
DMF 1912__: Web Portal / Clear Cache

Parameters

Body Parameter

Name	Description	Required	Default	Pattern
criteria	Search criteria ApplicationCriteria	-

Name

Description

Required

Default

Pattern

criteria

Search criteria ApplicationCriteria

Responses

Table 9. http response codes
Code	Message	Datatype
200	Successful Application search	List[Application]
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


{
  "id" : {
    "operator" : "IS",
    "value" : "Abcd",
    "includeNullResults" : false,
    "wildcards" : "*"
  },
  "type" : {
    "operator" : "IS",
    "value" : "Abcd",
    "includeNullResults" : false,
    "wildcards" : "*"
  }
}

2.2.7. Update an application

POST	/applications/{app_id}

DMF required:

DMF A61302: Api Settings / Applications / Update
DMF 090602: Administrator / Customer Portal / Launcher

Parameters

Path Parameters

Name	Description	Required	Default	Pattern
app_id	The id of the application	X	null

Name

Description

Required

Default

Pattern

app_id

The id of the application

null

Body Parameter

Name	Description	Required	Default	Pattern
application	The application to be updated Application	X

Name

Description

Required

Default

Pattern

application

The application to be updated Application

Responses

Table 10. http response codes
Code	Message	Datatype
200	Application successful 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


{
  "id" : "5000123",
  "name" : "Lorem ipsum",
  "url" : "https://example.com/lorem-ipsum",
  "type" : "{}",
  "portalType" : "{}",
  "color" : "#FF0000",
  "image" : "image",
  "order" : 1,
  "right" : {
    "id" : "5000123",
    "code" : "AF0406",
    "name" : "INFO"
  },
  "rightId" : "5000123"
}

2.3. Archive Reasons

2.3.1. Search archive reasons

POST	/archive-reasons/search

Description

Get the list of the archive reasons matching the search criteria.

DMF required:

DMF A63604: Api Settings / Archive Reasons / Search
DMF 020223: Sales / Quotations / Archive
DMF 020235: Sales / Quotations / Archive Signed Quotation
DMF 090162: Administrator / Setup / Archiving Reason
DMF 010216: Prospecting / Opportunities / Mark Opportunity As Won/lost
DMF 191412: Web Portal / Opportunities / Win / Lose

Parameters

Body Parameter

Name	Description	Required	Default	Pattern
criteria	Criteria that you choose (ID, name, etc,…) ArchiveReasonCriteria	X

Name

Description

Required

Default

Pattern

criteria

Criteria that you choose (ID, name, etc,…) ArchiveReasonCriteria

Responses

Table 11. http response codes
Code	Message	Datatype
200	Archive reasons have been successfully loaded	List[ArchiveReason]
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


{
  "companyId" : {
    "operator" : "IS",
    "value" : "Abcd",
    "includeNullResults" : false,
    "wildcards" : "*"
  },
  "code" : {
    "operator" : "IS",
    "value" : "Abcd",
    "includeNullResults" : false,
    "wildcards" : "*"
  },
  "crmPortal" : {
    "operator" : "IS",
    "value" : false,
    "includeNullResults" : false
  },
  "endDate" : {
    "operator" : "IS",
    "value" : "2000-06-21T04:56:07.000+00:00",
    "includeNullResults" : false,
    "withTime" : false
  },
  "name" : {
    "operator" : "IS",
    "value" : "Abcd",
    "includeNullResults" : false,
    "wildcards" : "*"
  },
  "id" : {
    "operator" : "IS",
    "value" : "Abcd",
    "includeNullResults" : false,
    "wildcards" : "*"
  },
  "type" : {
    "operator" : "IS",
    "value" : "Abcd",
    "includeNullResults" : false,
    "wildcards" : "*"
  },
  "stageId" : {
    "operator" : "IS",
    "value" : "Abcd",
    "includeNullResults" : false,
    "wildcards" : "*"
  },
  "readOption" : {
    "options" : [ "STAGE", "STAGE" ]
  }
}

2.4. Authentication Service

2.4.1. Create an Azure AD configuration

PUT	/authentication-service/azure-ad

DMF required:

DMF A60601: Api Settings / Authentication / Insert
DMF 090150: Administrator / Setup / Akuiteo Search

Parameters

Body Parameter

Name	Description	Required	Default	Pattern
azure_ad_config	The AzureAD configuration that has to be created AzureADConfig	X

Name

Description

Required

Default

Pattern

azure_ad_config

The AzureAD configuration that has to be created AzureADConfig

Responses

Table 12. http response codes
Code	Message	Datatype
200	AzureAD configuration has been created	[String]
404	There is no AzureAD configuration with this identifier	<<>>
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


{
  "id" : "5000123",
  "code" : "AKSAS",
  "tenantId" : "5000123",
  "clientId" : "5000123",
  "clientSecret" : "Lorem ipsum",
  "applicationId" : "5000123",
  "authenticate" : true
}

2.4.2. Create an LdapAD Config

PUT	/authentication-service/ldap-ad

DMF required:

DMF A60601: Api Settings / Authentication / Insert
DMF 090150: Administrator / Setup / Akuiteo Search

Parameters

Body Parameter

Name	Description	Required	Default	Pattern
ldapADConfig	The LdapAD Config to create LdapADConfig	X

Name

Description

Required

Default

Pattern

ldapADConfig

The LdapAD Config to create LdapADConfig

Query Parameters

Name	Description	Required	Default	Pattern
test_ldap_ad_config	Test LdapAD configuration before saving	-	null

Name

Description

Required

Default

Pattern

test_ldap_ad_config

Test LdapAD configuration before saving

null

Responses

Table 13. http response codes
Code	Message	Datatype
200	LdapADConfig successfully created	[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


{
  "code" : "LDAPAS",
  "authenticate" : true,
  "dnBase" : "dnBase",
  "url5" : "url5",
  "url3" : "url3",
  "password" : "password",
  "default" : true,
  "url4" : "url4",
  "url1" : "url1",
  "url2" : "url2",
  "dnBind" : "Lorem ipsum",
  "id" : "5000123",
  "user" : "user",
  "searchFilter" : "Lorem ipsum"
}

2.4.3. Create a SAML configuration

PUT	/authentication-service/saml

DMF required:

DMF A60601: Api Settings / Authentication / Insert
DMF 090150: Administrator / Setup / Akuiteo Search

Parameters

Body Parameter

Name	Description	Required	Default	Pattern
samlConfig	The SAML configuration to create SamlConfig	X

Name

Description

Required

Default

Pattern

samlConfig

The SAML configuration to create SamlConfig

Responses

Table 14. http response codes
Code	Message	Datatype
200	SAML configuration successfully created	[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


{
  "keyPwd" : "Lorem",
  "redirectDomainWhitelist" : "akuiteo.myakuiteo.com",
  "audience" : "Lorem ipsum",
  "code" : "AKSAS",
  "idp" : "Lorem ipsum",
  "keyAlias" : "Lorem ipsum",
  "keyLocation" : "Lorem ipsum",
  "metaLocation" : "Lorem ipsum",
  "userNameDomains" : "akuiteo.com",
  "active" : true,
  "id" : "5000123"
}

2.4.4. Delete an AzureAD configuration

DELETE

/authentication-service/azure-ad/{azure_ad_config_id}

DMF required:

DMF A60603: Api Settings / Authentication / Delete
DMF 090150: Administrator / Setup / Akuiteo Search

Parameters

Path Parameters

Name	Description	Required	Default	Pattern
azure_ad_config_id	The id of the AzureAD configuration	X	null

Name

Description

Required

Default

Pattern

azure_ad_config_id

The id of the AzureAD configuration

null

Responses

Table 15. http response codes
Code	Message	Datatype
204	AzureAD configuration has been deleted	<<>>
404	There is no AzureAD configuration with this identifier	<<>>
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

2.4.5. Delete an LdapAD Config

DELETE

/authentication-service/ldap-ad/{ldap_ad_config_id}

DMF required:

DMF A60603: Api Settings / Authentication / Delete
DMF 090150: Administrator / Setup / Akuiteo Search

Parameters

Path Parameters

Name

Description

Required

Default

Pattern

ldap_ad_config_id

The id of an LdapAD configuration

null

Responses

Table 16. http response codes
Code	Message	Datatype
204	LdapAD Config successfully deleted	<<>>
404	There is no LdapAD configuration with this identifier	<<>>
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

2.4.6. Delete a SAML Config

DELETE

/authentication-service/saml/{saml_config_id}

DMF required:

DMF A60603: Api Settings / Authentication / Delete
DMF 090150: Administrator / Setup / Akuiteo Search

Parameters

Path Parameters

Name

Description

Required

Default

Pattern

saml_config_id

The id of a SAML configuration

null

Responses

Table 17. http response codes
Code	Message	Datatype
204	SAML configuration successfully deleted	<<>>
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

2.4.7. Get the list of all the parameterized AzureAD

GET	/authentication-service/azure-ad

Description

Get the list of all the parameterized AzureAD (AzureADConfig schema)

DMF required:

DMF A60606: Api Settings / Authentication / Info
DMF 090150: Administrator / Setup / Akuiteo Search

Responses

Table 18. http response codes
Code	Message	Datatype
200	List of AzureAD configurations successfully returned	List[AzureADConfig]
404	There is no declared AzureAD configuration	<<>>
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

2.4.8. Get all LdapAD Configs

GET	/authentication-service/ldap-ad

DMF required:

DMF A60604: Api Settings / Authentication / Search
DMF 090150: Administrator / Setup / Akuiteo Search

Responses

Table 19. http response codes
Code	Message	Datatype
200	List of LdapAD configurations successfully returned	List[LdapADConfig]
404	There is no declared LdapAD configuration	<<>>
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

2.4.9. Get an AzureAD configuration

GET	/authentication-service/azure-ad/{azure_ad_config_id}

Description

Get an AzureAD configuration (AzureADConfig schema)

DMF required:

DMF A60606: Api Settings / Authentication / Info
DMF 090150: Administrator / Setup / Akuiteo Search

Parameters

Path Parameters

Name

Description

Required

Default

Pattern

azure_ad_config_id

The id of the AzureAD configuration

null

Responses

Table 20. http response codes
Code	Message	Datatype
200	AzureAD configuration has been loaded	AzureADConfig
404	There is no AzureAD configuration with this identifier	<<>>
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

2.4.10. Get an LdapAD Config

GET	/authentication-service/ldap-ad/{ldap_ad_config_id}

DMF required:

DMF A60606: Api Settings / Authentication / Info
DMF 090150: Administrator / Setup / Akuiteo Search

Parameters

Path Parameters

Name

Description

Required

Default

Pattern

ldap_ad_config_id

The id of an LdapAD configuration

null

Responses

Table 21. http response codes
Code	Message	Datatype
200	LdapAD Config successfully loaded	LdapADConfig
404	There is no LdapAD configuration with this identifier	<<>>
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

2.4.11. Get a SAML configuration

GET	/authentication-service/saml/{saml_config_id}

DMF required:

DMF A60606: Api Settings / Authentication / Info
DMF 090150: Administrator / Setup / Akuiteo Search

Parameters

Path Parameters

Name

Description

Required

Default

Pattern

saml_config_id

The id of a SAML configuration

null

Responses

Table 22. http response codes
Code	Message	Datatype
200	SAML configuration successfully loaded	SamlConfig
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

2.4.12. Is saml authentication active.

GET	/authentication-service/saml/has-active-configuration

Description

Check whether or not there is an active saml authentication configuration on this server

Responses

Table 23. http response codes
Code	Message	Datatype
200	True if saml authentication is active on this server	[Boolean]
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

2.4.13. Make the AzureAD configuration active

POST	/authentication-service/azure-ad/{azure_ad_config_id}/make-only-active

Description

Make the AzureAD configuration active and deactivate other configurations

DMF required:

DMF A606**: Api Settings / Authentication

Parameters

Path Parameters

Name

Description

Required

Default

Pattern

azure_ad_config_id

The id of the AzureAD configuration

null

Responses

Table 24. http response codes
Code	Message	Datatype
200	Configuration is now the only one active	AzureADConfig
404	There is no AzureAD configuration with this identifier	<<>>
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

2.4.14. Make the SAML configuration active

POST	/authentication-service/saml/{saml_config_id}/make-only-active

Description

Make the SAML configuration active and deactivate other configurations

DMF required:

DMF A606**: Api Settings / Authentication

Parameters

Path Parameters

Name

Description

Required

Default

Pattern

saml_config_id

The id of a SAML configuration

null

Responses

Table 25. http response codes
Code	Message	Datatype
204	Configuration is now the only one active	<<>>
404	There is no SAML configuration with this identifier	<<>>
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

2.4.15. Get the list of SAML Configurations

POST	/authentication-service/saml/search

DMF required:

DMF A60604: Api Settings / Authentication / Search
DMF 090150: Administrator / Setup / Akuiteo Search

Parameters

Body Parameter

Name

Description

Required

Default

Pattern

criteria

The criteria SamlConfigCriteria

Responses

Table 26. http response codes
Code	Message	Datatype
200	SAML Configurations successfully loaded	List[SamlConfig]
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


{
  "audience" : {
    "operator" : "IS",
    "value" : "Abcd",
    "includeNullResults" : false,
    "wildcards" : "*"
  },
  "code" : {
    "operator" : "IS",
    "value" : "Abcd",
    "includeNullResults" : false,
    "wildcards" : "*"
  },
  "idp" : {
    "operator" : "IS",
    "value" : "Abcd",
    "includeNullResults" : false,
    "wildcards" : "*"
  },
  "keyAlias" : {
    "operator" : "IS",
    "value" : "Abcd",
    "includeNullResults" : false,
    "wildcards" : "*"
  },
  "keyLocation" : {
    "operator" : "IS",
    "value" : "Abcd",
    "includeNullResults" : false,
    "wildcards" : "*"
  },
  "metaLocation" : {
    "operator" : "IS",
    "value" : "Abcd",
    "includeNullResults" : false,
    "wildcards" : "*"
  },
  "active" : {
    "operator" : "IS",
    "value" : false,
    "includeNullResults" : false
  },
  "id" : {
    "operator" : "IS",
    "value" : "Abcd",
    "includeNullResults" : false,
    "wildcards" : "*"
  }
}

2.4.16. Update an AzureAD configuration

POST	/authentication-service/azure-ad/{azure_ad_config_id}

Description

Update an AzureAD configuration (AzureADConfig schema)

DMF required:

DMF A60602: Api Settings / Authentication / Update
DMF 090150: Administrator / Setup / Akuiteo Search

Parameters

Path Parameters

Name

Description

Required

Default

Pattern

azure_ad_config_id

The id of the AzureAD configuration

null

Body Parameter

Name

Description

Required

Default

Pattern

azure_ad_config

The AzureAD configuration that has to be updated AzureADConfig

Responses

Table 27. http response codes
Code	Message	Datatype
200	AzureAD configuration has been updated	[String]
404	There is no AzureAD configuration with this identifier	<<>>
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


{
  "id" : "5000123",
  "code" : "AKSAS",
  "tenantId" : "5000123",
  "clientId" : "5000123",
  "clientSecret" : "Lorem ipsum",
  "applicationId" : "5000123",
  "authenticate" : true
}

2.4.17. Update an LdapAD Config

POST	/authentication-service/ldap-ad/{ldap_ad_config_id}

DMF required:

DMF A60602: Api Settings / Authentication / Update
DMF 090150: Administrator / Setup / Akuiteo Search

Parameters

Path Parameters

Name

Description

Required

Default

Pattern

ldap_ad_config_id

The id of an LdapAD configuration

null

Body Parameter

Name

Description

Required

Default

Pattern

ldapADConfig

The LdapAD Config to update LdapADConfig

Query Parameters

Name

Description

Required

Default

Pattern

test_ldap_ad_config

Test LdapAD configuration before saving

null

Responses

Table 28. http response codes
Code	Message	Datatype
200	LdapAD Config successfully updated	[String]
404	There is no LdapAD configuration with this identifier	<<>>
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


{
  "code" : "LDAPAS",
  "authenticate" : true,
  "dnBase" : "dnBase",
  "url5" : "url5",
  "url3" : "url3",
  "password" : "password",
  "default" : true,
  "url4" : "url4",
  "url1" : "url1",
  "url2" : "url2",
  "dnBind" : "Lorem ipsum",
  "id" : "5000123",
  "user" : "user",
  "searchFilter" : "Lorem ipsum"
}

2.4.18. Update a SAML configuration

POST	/authentication-service/saml/{saml_config_id}

DMF required:

DMF A60602: Api Settings / Authentication / Update
DMF 090150: Administrator / Setup / Akuiteo Search

Parameters

Path Parameters

Name

Description

Required

Default

Pattern

saml_config_id

The id of a SAML configuration

null

Body Parameter

Name

Description

Required

Default

Pattern

samlConfig

The SAML configuration to update SamlConfig

Responses

Table 29. http response codes
Code	Message	Datatype
200	SAML configuration 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


{
  "keyPwd" : "Lorem",
  "redirectDomainWhitelist" : "akuiteo.myakuiteo.com",
  "audience" : "Lorem ipsum",
  "code" : "AKSAS",
  "idp" : "Lorem ipsum",
  "keyAlias" : "Lorem ipsum",
  "keyLocation" : "Lorem ipsum",
  "metaLocation" : "Lorem ipsum",
  "userNameDomains" : "akuiteo.com",
  "active" : true,
  "id" : "5000123"
}

2.5. Chorus Configuration

2.5.1. Create a Chorus configuration

POST	/chorus-configurations

DMF required:

DMF A61101: Api Settings / Chorus / Insert
DMF 090175: Administrator / Setup / Chorus

Parameters

Body Parameter

Name

Description

Required

Default

Pattern

chorusConfig

The Chorus configuration to update ChorusConfig

Responses

Table 30. http response codes
Code	Message	Datatype
200	Chorus configuration successfully created	[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


{
  "chorusLogin" : "YOUR_CHORUS_LOGIN",
  "chorusPassword" : "YOUR_CHORUS_PASSWORD",
  "companyId" : "5000123",
  "clientId" : "5000123",
  "clientSecret" : "YOUR_CLIENT_SECRET",
  "id" : "5000123",
  "chorusUserId" : 2
}

2.5.2. Delete a Chorus configuration

DELETE

/chorus-configurations/{chorus_config_id}

DMF required:

DMF A61103: Api Settings / Chorus / Delete
DMF 090175: Administrator / Setup / Chorus

Parameters

Path Parameters

Name

Description

Required

Default

Pattern

chorus_config_id

The id of a Chorus configuration

null

Responses

Table 31. http response codes
Code	Message	Datatype
204	Chorus configuration successfully deleted	<<>>
404	There is no Chorus configuration with this identifier	<<>>
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

2.5.3. Get a Chorus configuration

GET	/chorus-configurations/{chorus_config_id}

DMF required:

DMF A61106: Api Settings / Chorus / Info
DMF 090175: Administrator / Setup / Chorus

Parameters

Path Parameters

Name

Description

Required

Default

Pattern

chorus_config_id

The id of a Chorus configuration

null

Responses

Table 32. http response codes
Code	Message	Datatype
200	Chorus configuration successfully loaded	ChorusConfig
404	There is no Chorus configuration with this identifier	<<>>
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

2.5.4. Get Chorus configuration for a company

GET	/chorus-configurations/companies/{company_id}

DMF required:

DMF A61106: Api Settings / Chorus / Info
DMF 090175: Administrator / Setup / Chorus

Parameters

Path Parameters

Name

Description

Required

Default

Pattern

company_id

The id of a company

null

Responses

Table 33. http response codes
Code	Message	Datatype
200	Chorus configuration successfully loaded	ChorusConfig
404	There is no Chorus configuration for this company	<<>>
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

2.5.5. Search Chorus configurations

POST	/chorus-configurations/search

DMF required:

DMF A61104: Api Settings / Chorus / Search
DMF 090175: Administrator / Setup / Chorus

Parameters

Body Parameter

Name

Description

Required

Default

Pattern

criteria

Search criteria ChorusConfigCriteria

Responses

Table 34. http response codes
Code	Message	Datatype
200	Successful Chorus configurations search	List[ChorusConfig]
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


{
  "companyId" : {
    "operator" : "IS",
    "value" : "Abcd",
    "includeNullResults" : false,
    "wildcards" : "*"
  },
  "id" : {
    "operator" : "IS",
    "value" : "Abcd",
    "includeNullResults" : false,
    "wildcards" : "*"
  }
}

2.5.6. Test Chorus configuration for a company

GET	/chorus-configurations/companies/{company_id}/test

Description

Test if the connection to Chorus is up or down for the specified company. If connection is down, an exception is thrown

DMF required:

DMF A61106: Api Settings / Chorus / Info
DMF 090175: Administrator / Setup / Chorus

Parameters

Path Parameters

Name

Description

Required

Default

Pattern

company_id

The id of a company

null

Responses

Table 35. http response codes
Code	Message	Datatype
204	Chorus configuration is up	<<>>
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

2.5.7. Transfer a Chorus configuration to another company

POST	/chorus-configurations/{chorus_config_id}/transfer/{company_id}

Description

Transfer a Chorus configuration to another company

DMF required:

DMF A61102: Api Settings / Chorus / Update
DMF 090175: Administrator / Setup / Chorus

Parameters

Path Parameters

Name

Description

Required

Default

Pattern

chorus_config_id

The id of a Chorus configuration

null

company_id

The id of a company

null

Responses

Table 36. http response codes
Code	Message	Datatype
204	Chorus configuration successfully transferred	<<>>
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

2.5.8. Update a Chorus configuration

POST	/chorus-configurations/{chorus_config_id}

DMF required:

DMF A61102: Api Settings / Chorus / Update
DMF 090175: Administrator / Setup / Chorus

Parameters

Path Parameters

Name

Description

Required

Default

Pattern

chorus_config_id

The id of a Chorus configuration

null

Body Parameter

Name

Description

Required

Default

Pattern

chorusConfig

The Chorus configuration to update ChorusConfig

Responses

Table 37. http response codes
Code	Message	Datatype
200	Chorus configuration successfully updated	[String]
404	There is no Chorus configuration with this identifier	<<>>
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


{
  "chorusLogin" : "YOUR_CHORUS_LOGIN",
  "chorusPassword" : "YOUR_CHORUS_PASSWORD",
  "companyId" : "5000123",
  "clientId" : "5000123",
  "clientSecret" : "YOUR_CLIENT_SECRET",
  "id" : "5000123",
  "chorusUserId" : 2
}

2.6. Closing Schedules

2.6.1. Search for closing schedyle entries

POST	/closing-schedules/entries/search

Description

Search for Closing Schedule Entries.
This API allows searching for specific closing schedule entries (ClosingScheduleEntry) based on specific criteria.

DMF required:

DMF A65004: Api Settings / Closing Schedule Entries / Search
DMF 090114: Administrator / Setup / Calendar

Parameters

Body Parameter

Name

Description

Required

Default

Pattern

criteria

Criteria that you choose ClosingScheduleEntryCriteria

Query Parameters

Name

Description

Required

Default

Pattern

offset

The index of first element

null

limit

The max number of elements

null

Responses

Table 38. http response codes
Code	Message	Datatype
200	Closing schedule entry successfully loaded	List[ClosingScheduleEntry]
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


{
  "period" : {
    "operator" : "IS",
    "value" : "2000-06-21T04:56:07.000+00:00",
    "includeNullResults" : false,
    "withTime" : false
  },
  "companyId" : {
    "operator" : "IS",
    "value" : "Abcd",
    "includeNullResults" : false,
    "wildcards" : "*"
  },
  "activeModule" : {
    "operator" : "IS",
    "value" : "Abcd",
    "includeNullResults" : false,
    "wildcards" : "*"
  },
  "closingDate" : {
    "operator" : "IS",
    "value" : "2000-06-21T04:56:07.000+00:00",
    "includeNullResults" : false,
    "withTime" : false
  }
}

2.6.2. Search for closing schedules

POST	/closing-schedules/search

Description

Search for closing schedules.
This API allows searching for closing schedules (ClosingSchedule) based on specific criteria.

DMF required:

DMF A64904: Api Settings / Closing Schedules / Search
DMF 090114: Administrator / Setup / Calendar

Parameters

Body Parameter

Name

Description

Required

Default

Pattern

criteria

Criteria that you choose ClosingScheduleCriteria

Query Parameters

Name

Description

Required

Default

Pattern

offset

The index of first element

null

limit

The max number of elements

null

Responses

Table 39. http response codes
Code	Message	Datatype
200	Closing schedules successfully loaded	List[ClosingSchedule]
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


{
  "period" : {
    "operator" : "IS",
    "value" : "2000-06-21T04:56:07.000+00:00",
    "includeNullResults" : false,
    "withTime" : false
  },
  "companyId" : {
    "operator" : "IS",
    "value" : "Abcd",
    "includeNullResults" : false,
    "wildcards" : "*"
  }
}

2.7. Companies

2.7.1. Search companies

POST	/companies/search

DMF required:

DMF A60704: Api Settings / Companies / Search
DMF 2501__: Project / Schedule View
DMF 1901__: Web Portal / Timesheets & Schedules Menu
DMF 1906__: Web Portal / Leave Requests Validation
DMF 1909__: Web Portal / Approvals

Parameters

Body Parameter

Name

Description

Required

Default

Pattern

criteria

Search criteria CompanyCriteria

Responses

Table 40. http response codes
Code	Message	Datatype
200	Search successfully completed	List[Company]
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


{
  "code" : {
    "operator" : "IS",
    "value" : "Abcd",
    "includeNullResults" : false,
    "wildcards" : "*"
  },
  "siren" : {
    "operator" : "IS",
    "value" : "Abcd",
    "includeNullResults" : false,
    "wildcards" : "*"
  },
  "id" : {
    "operator" : "IS",
    "value" : "Abcd",
    "includeNullResults" : false,
    "wildcards" : "*"
  },
  "tag" : {
    "operator" : "IS",
    "value" : "Abcd",
    "includeNullResults" : false,
    "wildcards" : "*"
  },
  "siret" : {
    "operator" : "IS",
    "value" : "Abcd",
    "includeNullResults" : false,
    "wildcards" : "*"
  },
  "readOption" : {
    "options" : [ "CALENDAR", "CALENDAR" ]
  }
}

2.7.2. Search entities

POST	/entities/search

DMF required:

DMF A60304: Api Settings / Entities / Search
DMF 020101: Sales / Customer / New
DMF 020102: Sales / Customer / Modify
DMF 020104: Sales / Customer / Search
DMF 0202__: Sales / Quotations
DMF 020202: Sales / Quotations / Modify
DMF 090104: Administrator / Setup / Company
DMF 090150: Administrator / Setup / Akuiteo Search
DMF 250119: Project / Schedule View / Employee Details
DMF 020204: Sales / Quotations / Search

Parameters

Body Parameter

Name

Description

Required

Default

Pattern

criteria

Search criteria EntityCriteria

Responses

Table 41. http response codes
Code	Message	Datatype
200	Search successfully completed	List[Entity]
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


{
  "companyId" : {
    "operator" : "IS",
    "value" : "Abcd",
    "includeNullResults" : false,
    "wildcards" : "*"
  },
  "code" : {
    "operator" : "IS",
    "value" : "Abcd",
    "includeNullResults" : false,
    "wildcards" : "*"
  },
  "name" : {
    "operator" : "IS",
    "value" : "Abcd",
    "includeNullResults" : false,
    "wildcards" : "*"
  },
  "id" : {
    "operator" : "IS",
    "value" : "Abcd",
    "includeNullResults" : false,
    "wildcards" : "*"
  },
  "divisionId" : {
    "operator" : "IS",
    "value" : "Abcd",
    "includeNullResults" : false,
    "wildcards" : "*"
  },
  "validity" : {
    "type" : "{}",
    "date" : "2000-06-21T04:56:07.000+00:00"
  },
  "tag" : {
    "operator" : "IS",
    "value" : "Abcd",
    "includeNullResults" : false,
    "wildcards" : "*"
  },
  "readOption" : {
    "options" : [ "DIVISION", "DIVISION" ]
  }
}

2.8. Company Configs

2.8.1. Get the conversion rules configurations defined for a company.

GET	/companies/{company_id}/configs/conversion-rules

Description

Get the conversion rules configurations defined for a company.

DMF required:

DMF A65306: Api Settings / Companies Configs / Info
DMF 060621: Projects / Setup / Project Options

Parameters

Path Parameters

Name

Description

Required

Default

Pattern

company_id

The id of a company

null

Responses

Table 42. http response codes
Code	Message	Datatype
200	Conversion rules config has been successfully loaded.	ConversionRulesConfig
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

2.8.2. Get the quotation cost configurations defined for a company.

GET	/companies/{company_id}/configs/quotation-costs

Description

Get the quotation cost configurations defined for a company.

DMF required:

DMF A65306: Api Settings / Companies Configs / Info
DMF 060621: Projects / Setup / Project Options

Parameters

Path Parameters

Name

Description

Required

Default

Pattern

company_id

The id of a company

null

Responses

Table 43. http response codes
Code	Message	Datatype
200	Quotation cost config has been successfully loaded	QuotationCostConfig
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

2.9. Controls

2.9.1. Create a form config

PUT	/form-configs

DMF required:

DMF A64601: Api Settings / Form Configs / Insert
DMF 090187: Administrator / Setup / Initialization Custom Controls

Parameters

Body Parameter

Name

Description

Required

Default

Pattern

formConfig

The form config to create FormConfigSettings

Responses

Table 44. http response codes
Code	Message	Datatype
200	The form config has been successfully created	[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


{
  "type" : "{}",
  "fields" : [ {
    "id" : "50000123",
    "property" : "Kilometers",
    "required" : true,
    "visible" : true,
    "enabled" : true,
    "defaultValue" : "50 (for the field 'Kilometers' case)",
    "valueSelectors" : [ "valueSelectors", "valueSelectors" ],
    "additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
    "freeValue" : true,
    "allowMultipleValues" : true,
    "information" : "Lorem ipsum"
  }, {
    "id" : "50000123",
    "property" : "Kilometers",
    "required" : true,
    "visible" : true,
    "enabled" : true,
    "defaultValue" : "50 (for the field 'Kilometers' case)",
    "valueSelectors" : [ "valueSelectors", "valueSelectors" ],
    "additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
    "freeValue" : true,
    "allowMultipleValues" : true,
    "information" : "Lorem ipsum"
  } ],
  "controls" : {
    "key" : {
      "id" : "50000123",
      "property" : "Kilometers",
      "required" : true,
      "visible" : true,
      "enabled" : true,
      "defaultValue" : "50 (for the field 'Kilometers' case)",
      "valueSelectors" : [ "valueSelectors", "valueSelectors" ],
      "additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
      "freeValue" : true,
      "allowMultipleValues" : true,
      "information" : "Lorem ipsum"
    }
  },
  "insertable" : true,
  "editable" : false,
  "deletable" : false,
  "formSearchHidden" : false,
  "id" : "50000123",
  "company" : {
    "id" : "5000123",
    "code" : "AK",
    "name" : "Akuiteo",
    "legalName" : "legalName",
    "siren" : "siren",
    "siret" : "siret",
    "calendar" : {
      "id" : "5000123",
      "code" : "Text",
      "name" : "Text",
      "default" : true,
      "daysNotWorked" : [ 6, 6 ],
      "holidays" : [ {
        "date" : "2000-06-21T04:56:07.000+00:00",
        "type" : "FERIE"
      }, {
        "date" : "2000-06-21T04:56:07.000+00:00",
        "type" : "FERIE"
      } ]
    },
    "calendarId" : "calendarId",
    "color" : "color",
    "currency" : {
      "id" : "5000123",
      "name" : "Euro",
      "code" : "EUR",
      "order" : 17,
      "euro" : true,
      "euroRate" : 0.9678,
      "endDate" : "2000-06-21T04:56:07.000+00:00",
      "euroRateStartDate" : "2020-01-23T04:56:07Z",
      "euroRateEndDate" : "2020-01-23T04:56:07Z"
    },
    "currencyId" : "currencyId",
    "address" : {
      "id" : "id",
      "line1" : "221B Baker Street",
      "line2" : "2nd Floor",
      "line3" : "First door at your right",
      "cedex" : "CEDEX 14",
      "postalCode" : "69002",
      "city" : "London",
      "country" : "FR (for 'FRANCE')",
      "countryName" : "FRANCE",
      "department" : "75 (for 'PARIS')",
      "geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
      "region" : "65 (for 'ILE DE FRANCE')",
      "regionName" : "ILE DE FRANCE",
      "phone" : "06 00 00 00 01",
      "phone2" : "06 00 00 00 02",
      "email" : "myemail@mail.com",
      "mobilePhone" : "06 00 00 00 02",
      "fax" : "04 00 00 00 07",
      "webSite" : "mysite.com"
    },
    "addressId" : "addressId"
  },
  "companyId" : "5000666",
  "division" : {
    "id" : "5000123",
    "name" : "Rhone-Alpes",
    "code" : "RA",
    "group" : {
      "id" : "5000123",
      "name" : "West",
      "code" : "WST",
      "serviceId" : "5000123"
    },
    "groupId" : "5000123",
    "companyId" : "5000123"
  },
  "divisionId" : "5000666",
  "entity" : {
    "id" : "5000123",
    "code" : "01-BRDX",
    "name" : "Bordeaux"
  },
  "entityId" : "5000666",
  "resourceType" : "5000012312345678",
  "controlSettings" : [ {
    "id" : "50000123",
    "property" : "Kilometers",
    "required" : true,
    "visible" : true,
    "enabled" : true,
    "defaultValue" : "50 (for the field 'Kilometers' case)",
    "valueSelectors" : [ "valueSelectors", "valueSelectors" ],
    "additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
    "freeValue" : true,
    "allowMultipleValues" : true,
    "information" : "Lorem ipsum",
    "applicableKeyword" : {
      "id" : "5000123",
      "code" : "5000123",
      "description" : "Lorem ipsum dolor sit amet",
      "name" : "Lorem ipsum",
      "family" : "Lorem ipsum",
      "subFamily" : "Lorem ipsum",
      "type" : "{}",
      "sourceCode" : "ABC",
      "society" : "Lorem ipsum"
    },
    "applicableKeywordId" : "5000123",
    "hiddenKeyword" : {
      "id" : "5000123",
      "code" : "5000123",
      "description" : "Lorem ipsum dolor sit amet",
      "name" : "Lorem ipsum",
      "family" : "Lorem ipsum",
      "subFamily" : "Lorem ipsum",
      "type" : "{}",
      "sourceCode" : "ABC",
      "society" : "Lorem ipsum"
    },
    "hiddenKeywordId" : "5000123",
    "requiredKeyword" : {
      "id" : "5000123",
      "code" : "5000123",
      "description" : "Lorem ipsum dolor sit amet",
      "name" : "Lorem ipsum",
      "family" : "Lorem ipsum",
      "subFamily" : "Lorem ipsum",
      "type" : "{}",
      "sourceCode" : "ABC",
      "society" : "Lorem ipsum"
    },
    "requiredKeywordId" : "5000123",
    "disabledKeyword" : {
      "id" : "5000123",
      "code" : "5000123",
      "description" : "Lorem ipsum dolor sit amet",
      "name" : "Lorem ipsum",
      "family" : "Lorem ipsum",
      "subFamily" : "Lorem ipsum",
      "type" : "{}",
      "sourceCode" : "ABC",
      "society" : "Lorem ipsum"
    },
    "disabledKeywordId" : "5000123",
    "defaultValueKeyword" : {
      "id" : "5000123",
      "code" : "5000123",
      "description" : "Lorem ipsum dolor sit amet",
      "name" : "Lorem ipsum",
      "family" : "Lorem ipsum",
      "subFamily" : "Lorem ipsum",
      "type" : "{}",
      "sourceCode" : "ABC",
      "society" : "Lorem ipsum"
    },
    "defaultValueKeywordId" : "5000123",
    "valueSelectorsKeyword" : {
      "id" : "5000123",
      "code" : "5000123",
      "description" : "Lorem ipsum dolor sit amet",
      "name" : "Lorem ipsum",
      "family" : "Lorem ipsum",
      "subFamily" : "Lorem ipsum",
      "type" : "{}",
      "sourceCode" : "ABC",
      "society" : "Lorem ipsum"
    },
    "valueSelectorsKeywordId" : "5000123",
    "informationKeyword" : {
      "id" : "5000123",
      "code" : "5000123",
      "description" : "Lorem ipsum dolor sit amet",
      "name" : "Lorem ipsum",
      "family" : "Lorem ipsum",
      "subFamily" : "Lorem ipsum",
      "type" : "{}",
      "sourceCode" : "ABC",
      "society" : "Lorem ipsum"
    },
    "informationKeywordId" : "5000123",
    "useLabeInsteadOfCode" : true
  }, {
    "id" : "50000123",
    "property" : "Kilometers",
    "required" : true,
    "visible" : true,
    "enabled" : true,
    "defaultValue" : "50 (for the field 'Kilometers' case)",
    "valueSelectors" : [ "valueSelectors", "valueSelectors" ],
    "additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
    "freeValue" : true,
    "allowMultipleValues" : true,
    "information" : "Lorem ipsum",
    "applicableKeyword" : {
      "id" : "5000123",
      "code" : "5000123",
      "description" : "Lorem ipsum dolor sit amet",
      "name" : "Lorem ipsum",
      "family" : "Lorem ipsum",
      "subFamily" : "Lorem ipsum",
      "type" : "{}",
      "sourceCode" : "ABC",
      "society" : "Lorem ipsum"
    },
    "applicableKeywordId" : "5000123",
    "hiddenKeyword" : {
      "id" : "5000123",
      "code" : "5000123",
      "description" : "Lorem ipsum dolor sit amet",
      "name" : "Lorem ipsum",
      "family" : "Lorem ipsum",
      "subFamily" : "Lorem ipsum",
      "type" : "{}",
      "sourceCode" : "ABC",
      "society" : "Lorem ipsum"
    },
    "hiddenKeywordId" : "5000123",
    "requiredKeyword" : {
      "id" : "5000123",
      "code" : "5000123",
      "description" : "Lorem ipsum dolor sit amet",
      "name" : "Lorem ipsum",
      "family" : "Lorem ipsum",
      "subFamily" : "Lorem ipsum",
      "type" : "{}",
      "sourceCode" : "ABC",
      "society" : "Lorem ipsum"
    },
    "requiredKeywordId" : "5000123",
    "disabledKeyword" : {
      "id" : "5000123",
      "code" : "5000123",
      "description" : "Lorem ipsum dolor sit amet",
      "name" : "Lorem ipsum",
      "family" : "Lorem ipsum",
      "subFamily" : "Lorem ipsum",
      "type" : "{}",
      "sourceCode" : "ABC",
      "society" : "Lorem ipsum"
    },
    "disabledKeywordId" : "5000123",
    "defaultValueKeyword" : {
      "id" : "5000123",
      "code" : "5000123",
      "description" : "Lorem ipsum dolor sit amet",
      "name" : "Lorem ipsum",
      "family" : "Lorem ipsum",
      "subFamily" : "Lorem ipsum",
      "type" : "{}",
      "sourceCode" : "ABC",
      "society" : "Lorem ipsum"
    },
    "defaultValueKeywordId" : "5000123",
    "valueSelectorsKeyword" : {
      "id" : "5000123",
      "code" : "5000123",
      "description" : "Lorem ipsum dolor sit amet",
      "name" : "Lorem ipsum",
      "family" : "Lorem ipsum",
      "subFamily" : "Lorem ipsum",
      "type" : "{}",
      "sourceCode" : "ABC",
      "society" : "Lorem ipsum"
    },
    "valueSelectorsKeywordId" : "5000123",
    "informationKeyword" : {
      "id" : "5000123",
      "code" : "5000123",
      "description" : "Lorem ipsum dolor sit amet",
      "name" : "Lorem ipsum",
      "family" : "Lorem ipsum",
      "subFamily" : "Lorem ipsum",
      "type" : "{}",
      "sourceCode" : "ABC",
      "society" : "Lorem ipsum"
    },
    "informationKeywordId" : "5000123",
    "useLabeInsteadOfCode" : true
  } ],
  "changeTracking" : {
    "createdTime" : "2000-06-21T04:56:07.000+00:00",
    "createdBy" : {
      "id" : "5000123",
      "code" : "TRI",
      "name" : "Doe",
      "firstName" : "John"
    },
    "createdById" : "5000123",
    "modificationTime" : "2000-06-21T04:56:07.000+00:00",
    "modificationBy" : {
      "id" : "5000123",
      "code" : "TRI",
      "name" : "Doe",
      "firstName" : "John"
    },
    "modificationById" : "5000123"
  }
}

2.9.2. Delete a form config

DELETE

/form-configs/{form_config_id}

DMF required:

DMF A64603: Api Settings / Form Configs / Delete
DMF 090187: Administrator / Setup / Initialization Custom Controls

Parameters

Path Parameters

Name

Description

Required

Default

Pattern

form_config_id

The id of a FormConfig

null

Responses

Table 45. http response codes
Code	Message	Datatype
204	The form config has been successfully deleted	<<>>
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

2.9.3. Get a form config

GET	/form-configs/{form_config_id}

DMF required:

DMF A64606: Api Settings / Form Configs / Info
DMF 090187: Administrator / Setup / Initialization Custom Controls

Parameters

Path Parameters

Name

Description

Required

Default

Pattern

form_config_id

The id of a FormConfig

null

Responses

Table 46. http response codes
Code	Message	Datatype
200	The form config has been successfully loaded	FormConfigSettings
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

2.9.4. Search for a form config with read options

POST	/form-configs/{form_config_id}/read

Description

Get a form config, with additional information of your choice (example: change tracking information).
You can add this information with Read Options.
These are listed in the link below.

DMF required:

DMF A64606: Api Settings / Form Configs / Info
DMF 090187: Administrator / Setup / Initialization Custom Controls

Parameters

Path Parameters

Name

Description

Required

Default

Pattern

form_config_id

The id of a FormConfig

null

Body Parameter

Name

Description

Required

Default

Pattern

read_option

The read options for returned form config FormConfigReadOption

Responses

Table 47. http response codes
Code	Message	Datatype
200	Form config successfully loaded	FormConfigSettings
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" : [ "COMPANY", "COMPANY" ]
}

2.9.5. Search application controls

POST	/application-controls/search

DMF required:

DMF A61804: Api Settings / Controls / Search
DMF 1901__: Web Portal / Timesheets & Schedules Menu
DMF 1903__: Web Portal / Timesheets
DMF 1904__: Web Portal / Schedules
DMF 1905__: Web Portal / Expense Reports
DMF 1906__: Web Portal / Leave Requests Validation
DMF 1907__: Web Portal / Timesheets Validation
DMF 1908__: Web Portal / Expense Reports Validation
DMF 1909__: Web Portal / Approvals
DMF 1910__: Web Portal / Reports
DMF 1911__: Web Portal / Custom Requests
DMF 1912__: Web Portal / Clear Cache

Parameters

Body Parameter

Name

Description

Required

Default

Pattern

criteria

Search criteria ApplicationControlCriteria

Responses

Table 48. http response codes
Code	Message	Datatype
200	Search successfully completed	List[ApplicationControl]
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


{
  "active" : {
    "operator" : "IS",
    "value" : false,
    "includeNullResults" : false
  }
}

2.9.6. Search for form configs

POST	/form-configs/search

Description

Get the list of form configs matching the search criteria

DMF required:

DMF A64604: Api Settings / Form Configs / Search
DMF 090187: Administrator / Setup / Initialization Custom Controls

Parameters

Body Parameter

Name

Description

Required

Default

Pattern

criteria

Criteria that you choose (id, code, etc…) FormConfigCriteria

Responses

Table 49. http response codes
Code	Message	Datatype
200	The form configs have been successfully loaded	List[FormConfigSettings]
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


{
  "companyId" : {
    "operator" : "IS",
    "value" : "Abcd",
    "includeNullResults" : false,
    "wildcards" : "*"
  },
  "code" : {
    "operator" : "IS",
    "value" : "Abcd",
    "includeNullResults" : false,
    "wildcards" : "*"
  },
  "editable" : {
    "operator" : "IS",
    "value" : false,
    "includeNullResults" : false
  },
  "name" : {
    "operator" : "IS",
    "value" : "Abcd",
    "includeNullResults" : false,
    "wildcards" : "*"
  },
  "deletable" : {
    "operator" : "IS",
    "value" : false,
    "includeNullResults" : false
  },
  "entityId" : {
    "operator" : "IS",
    "value" : "Abcd",
    "includeNullResults" : false,
    "wildcards" : "*"
  },
  "id" : {
    "operator" : "IS",
    "value" : "Abcd",
    "includeNullResults" : false,
    "wildcards" : "*"
  },
  "divisionId" : {
    "operator" : "IS",
    "value" : "Abcd",
    "includeNullResults" : false,
    "wildcards" : "*"
  },
  "type" : {
    "operator" : "IS",
    "value" : "Abcd",
    "includeNullResults" : false,
    "wildcards" : "*"
  },
  "resourceType" : {
    "operator" : "IS",
    "value" : "Abcd",
    "includeNullResults" : false,
    "wildcards" : "*"
  },
  "insertable" : {
    "operator" : "IS",
    "value" : false,
    "includeNullResults" : false
  },
  "readOption" : {
    "options" : [ "COMPANY", "COMPANY" ]
  }
}

2.9.7. Search Init controls

POST	/init-controls/search

DMF required:

DMF A61804: Api Settings / Controls / Search
DMF 1901__: Web Portal / Timesheets & Schedules Menu
DMF 1903__: Web Portal / Timesheets
DMF 1904__: Web Portal / Schedules
DMF 1905__: Web Portal / Expense Reports
DMF 1906__: Web Portal / Leave Requests Validation
DMF 1907__: Web Portal / Timesheets Validation
DMF 1908__: Web Portal / Expense Reports Validation
DMF 1909__: Web Portal / Approvals
DMF 1910__: Web Portal / Reports
DMF 1911__: Web Portal / Custom Requests
DMF 1912__: Web Portal / Clear Cache

Parameters

Body Parameter

Name

Description

Required

Default

Pattern

criteria

Search criteria InitControlCriteria

Responses

Table 50. http response codes
Code	Message	Datatype
200	Search successfully completed	List[InitControl]
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


{
  "readOption" : {
    "options" : [ "PATH", "PATH" ]
  }
}

2.9.8. Search post controls

POST	/post-controls/search

DMF required:

DMF A61804: Api Settings / Controls / Search
DMF 1901__: Web Portal / Timesheets & Schedules Menu
DMF 1903__: Web Portal / Timesheets
DMF 1904__: Web Portal / Schedules
DMF 1905__: Web Portal / Expense Reports
DMF 1906__: Web Portal / Leave Requests Validation
DMF 1907__: Web Portal / Timesheets Validation
DMF 1908__: Web Portal / Expense Reports Validation
DMF 1909__: Web Portal / Approvals
DMF 1910__: Web Portal / Reports
DMF 1911__: Web Portal / Custom Requests
DMF 1912__: Web Portal / Clear Cache

Parameters

Body Parameter

Name

Description

Required

Default

Pattern

criteria

Search criteria PostControlCriteria

Responses

Table 51. http response codes
Code	Message	Datatype
200	Search successfully completed	List[PostControl]
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


{
  "readOption" : {
    "options" : [ "PATH", "PATH" ]
  }
}

2.9.9. Update a form config

POST	/form-configs/{form_config_id}

DMF required:

DMF A64602: Api Settings / Form Configs / Update
DMF 090187: Administrator / Setup / Initialization Custom Controls

Parameters

Path Parameters

Name

Description

Required

Default

Pattern

form_config_id

The id of a FormConfig

null

Body Parameter

Name

Description

Required

Default

Pattern

formConfig

The form config to update FormConfigSettings

Responses

Table 52. http response codes
Code	Message	Datatype
200	The form config 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


{
  "type" : "{}",
  "fields" : [ {
    "id" : "50000123",
    "property" : "Kilometers",
    "required" : true,
    "visible" : true,
    "enabled" : true,
    "defaultValue" : "50 (for the field 'Kilometers' case)",
    "valueSelectors" : [ "valueSelectors", "valueSelectors" ],
    "additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
    "freeValue" : true,
    "allowMultipleValues" : true,
    "information" : "Lorem ipsum"
  }, {
    "id" : "50000123",
    "property" : "Kilometers",
    "required" : true,
    "visible" : true,
    "enabled" : true,
    "defaultValue" : "50 (for the field 'Kilometers' case)",
    "valueSelectors" : [ "valueSelectors", "valueSelectors" ],
    "additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
    "freeValue" : true,
    "allowMultipleValues" : true,
    "information" : "Lorem ipsum"
  } ],
  "controls" : {
    "key" : {
      "id" : "50000123",
      "property" : "Kilometers",
      "required" : true,
      "visible" : true,
      "enabled" : true,
      "defaultValue" : "50 (for the field 'Kilometers' case)",
      "valueSelectors" : [ "valueSelectors", "valueSelectors" ],
      "additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
      "freeValue" : true,
      "allowMultipleValues" : true,
      "information" : "Lorem ipsum"
    }
  },
  "insertable" : true,
  "editable" : false,
  "deletable" : false,
  "formSearchHidden" : false,
  "id" : "50000123",
  "company" : {
    "id" : "5000123",
    "code" : "AK",
    "name" : "Akuiteo",
    "legalName" : "legalName",
    "siren" : "siren",
    "siret" : "siret",
    "calendar" : {
      "id" : "5000123",
      "code" : "Text",
      "name" : "Text",
      "default" : true,
      "daysNotWorked" : [ 6, 6 ],
      "holidays" : [ {
        "date" : "2000-06-21T04:56:07.000+00:00",
        "type" : "FERIE"
      }, {
        "date" : "2000-06-21T04:56:07.000+00:00",
        "type" : "FERIE"
      } ]
    },
    "calendarId" : "calendarId",
    "color" : "color",
    "currency" : {
      "id" : "5000123",
      "name" : "Euro",
      "code" : "EUR",
      "order" : 17,
      "euro" : true,
      "euroRate" : 0.9678,
      "endDate" : "2000-06-21T04:56:07.000+00:00",
      "euroRateStartDate" : "2020-01-23T04:56:07Z",
      "euroRateEndDate" : "2020-01-23T04:56:07Z"
    },
    "currencyId" : "currencyId",
    "address" : {
      "id" : "id",
      "line1" : "221B Baker Street",
      "line2" : "2nd Floor",
      "line3" : "First door at your right",
      "cedex" : "CEDEX 14",
      "postalCode" : "69002",
      "city" : "London",
      "country" : "FR (for 'FRANCE')",
      "countryName" : "FRANCE",
      "department" : "75 (for 'PARIS')",
      "geographicalDepartmentName" : "CENTRE VAL DE LOIRE",
      "region" : "65 (for 'ILE DE FRANCE')",
      "regionName" : "ILE DE FRANCE",
      "phone" : "06 00 00 00 01",
      "phone2" : "06 00 00 00 02",
      "email" : "myemail@mail.com",
      "mobilePhone" : "06 00 00 00 02",
      "fax" : "04 00 00 00 07",
      "webSite" : "mysite.com"
    },
    "addressId" : "addressId"
  },
  "companyId" : "5000666",
  "division" : {
    "id" : "5000123",
    "name" : "Rhone-Alpes",
    "code" : "RA",
    "group" : {
      "id" : "5000123",
      "name" : "West",
      "code" : "WST",
      "serviceId" : "5000123"
    },
    "groupId" : "5000123",
    "companyId" : "5000123"
  },
  "divisionId" : "5000666",
  "entity" : {
    "id" : "5000123",
    "code" : "01-BRDX",
    "name" : "Bordeaux"
  },
  "entityId" : "5000666",
  "resourceType" : "5000012312345678",
  "controlSettings" : [ {
    "id" : "50000123",
    "property" : "Kilometers",
    "required" : true,
    "visible" : true,
    "enabled" : true,
    "defaultValue" : "50 (for the field 'Kilometers' case)",
    "valueSelectors" : [ "valueSelectors", "valueSelectors" ],
    "additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
    "freeValue" : true,
    "allowMultipleValues" : true,
    "information" : "Lorem ipsum",
    "applicableKeyword" : {
      "id" : "5000123",
      "code" : "5000123",
      "description" : "Lorem ipsum dolor sit amet",
      "name" : "Lorem ipsum",
      "family" : "Lorem ipsum",
      "subFamily" : "Lorem ipsum",
      "type" : "{}",
      "sourceCode" : "ABC",
      "society" : "Lorem ipsum"
    },
    "applicableKeywordId" : "5000123",
    "hiddenKeyword" : {
      "id" : "5000123",
      "code" : "5000123",
      "description" : "Lorem ipsum dolor sit amet",
      "name" : "Lorem ipsum",
      "family" : "Lorem ipsum",
      "subFamily" : "Lorem ipsum",
      "type" : "{}",
      "sourceCode" : "ABC",
      "society" : "Lorem ipsum"
    },
    "hiddenKeywordId" : "5000123",
    "requiredKeyword" : {
      "id" : "5000123",
      "code" : "5000123",
      "description" : "Lorem ipsum dolor sit amet",
      "name" : "Lorem ipsum",
      "family" : "Lorem ipsum",
      "subFamily" : "Lorem ipsum",
      "type" : "{}",
      "sourceCode" : "ABC",
      "society" : "Lorem ipsum"
    },
    "requiredKeywordId" : "5000123",
    "disabledKeyword" : {
      "id" : "5000123",
      "code" : "5000123",
      "description" : "Lorem ipsum dolor sit amet",
      "name" : "Lorem ipsum",
      "family" : "Lorem ipsum",
      "subFamily" : "Lorem ipsum",
      "type" : "{}",
      "sourceCode" : "ABC",
      "society" : "Lorem ipsum"
    },
    "disabledKeywordId" : "5000123",
    "defaultValueKeyword" : {
      "id" : "5000123",
      "code" : "5000123",
      "description" : "Lorem ipsum dolor sit amet",
      "name" : "Lorem ipsum",
      "family" : "Lorem ipsum",
      "subFamily" : "Lorem ipsum",
      "type" : "{}",
      "sourceCode" : "ABC",
      "society" : "Lorem ipsum"
    },
    "defaultValueKeywordId" : "5000123",
    "valueSelectorsKeyword" : {
      "id" : "5000123",
      "code" : "5000123",
      "description" : "Lorem ipsum dolor sit amet",
      "name" : "Lorem ipsum",
      "family" : "Lorem ipsum",
      "subFamily" : "Lorem ipsum",
      "type" : "{}",
      "sourceCode" : "ABC",
      "society" : "Lorem ipsum"
    },
    "valueSelectorsKeywordId" : "5000123",
    "informationKeyword" : {
      "id" : "5000123",
      "code" : "5000123",
      "description" : "Lorem ipsum dolor sit amet",
      "name" : "Lorem ipsum",
      "family" : "Lorem ipsum",
      "subFamily" : "Lorem ipsum",
      "type" : "{}",
      "sourceCode" : "ABC",
      "society" : "Lorem ipsum"
    },
    "informationKeywordId" : "5000123",
    "useLabeInsteadOfCode" : true
  }, {
    "id" : "50000123",
    "property" : "Kilometers",
    "required" : true,
    "visible" : true,
    "enabled" : true,
    "defaultValue" : "50 (for the field 'Kilometers' case)",
    "valueSelectors" : [ "valueSelectors", "valueSelectors" ],
    "additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
    "freeValue" : true,
    "allowMultipleValues" : true,
    "information" : "Lorem ipsum",
    "applicableKeyword" : {
      "id" : "5000123",
      "code" : "5000123",
      "description" : "Lorem ipsum dolor sit amet",
      "name" : "Lorem ipsum",
      "family" : "Lorem ipsum",
      "subFamily" : "Lorem ipsum",
      "type" : "{}",
      "sourceCode" : "ABC",
      "society" : "Lorem ipsum"
    },
    "applicableKeywordId" : "5000123",
    "hiddenKeyword" : {
      "id" : "5000123",
      "code" : "5000123",
      "description" : "Lorem ipsum dolor sit amet",
      "name" : "Lorem ipsum",
      "family" : "Lorem ipsum",
      "subFamily" : "Lorem ipsum",
      "type" : "{}",
      "sourceCode" : "ABC",
      "society" : "Lorem ipsum"
    },
    "hiddenKeywordId" : "5000123",
    "requiredKeyword" : {
      "id" : "5000123",
      "code" : "5000123",
      "description" : "Lorem ipsum dolor sit amet",
      "name" : "Lorem ipsum",
      "family" : "Lorem ipsum",
      "subFamily" : "Lorem ipsum",
      "type" : "{}",
      "sourceCode" : "ABC",
      "society" : "Lorem ipsum"
    },
    "requiredKeywordId" : "5000123",
    "disabledKeyword" : {
      "id" : "5000123",
      "code" : "5000123",
      "description" : "Lorem ipsum dolor sit amet",
      "name" : "Lorem ipsum",
      "family" : "Lorem ipsum",
      "subFamily" : "Lorem ipsum",
      "type" : "{}",
      "sourceCode" : "ABC",
      "society" : "Lorem ipsum"
    },
    "disabledKeywordId" : "5000123",
    "defaultValueKeyword" : {
      "id" : "5000123",
      "code" : "5000123",
      "description" : "Lorem ipsum dolor sit amet",
      "name" : "Lorem ipsum",
      "family" : "Lorem ipsum",
      "subFamily" : "Lorem ipsum",
      "type" : "{}",
      "sourceCode" : "ABC",
      "society" : "Lorem ipsum"
    },
    "defaultValueKeywordId" : "5000123",
    "valueSelectorsKeyword" : {
      "id" : "5000123",
      "code" : "5000123",
      "description" : "Lorem ipsum dolor sit amet",
      "name" : "Lorem ipsum",
      "family" : "Lorem ipsum",
      "subFamily" : "Lorem ipsum",
      "type" : "{}",
      "sourceCode" : "ABC",
      "society" : "Lorem ipsum"
    },
    "valueSelectorsKeywordId" : "5000123",
    "informationKeyword" : {
      "id" : "5000123",
      "code" : "5000123",
      "description" : "Lorem ipsum dolor sit amet",
      "name" : "Lorem ipsum",
      "family" : "Lorem ipsum",
      "subFamily" : "Lorem ipsum",
      "type" : "{}",
      "sourceCode" : "ABC",
      "society" : "Lorem ipsum"
    },
    "informationKeywordId" : "5000123",
    "useLabeInsteadOfCode" : true
  } ],
  "changeTracking" : {
    "createdTime" : "2000-06-21T04:56:07.000+00:00",
    "createdBy" : {
      "id" : "5000123",
      "code" : "TRI",
      "name" : "Doe",
      "firstName" : "John"
    },
    "createdById" : "5000123",
    "modificationTime" : "2000-06-21T04:56:07.000+00:00",
    "modificationBy" : {
      "id" : "5000123",
      "code" : "TRI",
      "name" : "Doe",
      "firstName" : "John"
    },
    "modificationById" : "5000123"
  }
}

2.10. Countries

2.10.1. Search for countries

POST	/countries/search

Description

Search for countries matching the search criteria

DMF required:

DMF A66104: Api Settings / Countries / Search
DMF 090113: Administrator / Setup / Country

Parameters

Body Parameter

Name

Description

Required

Default

Pattern

criteria

Search criteria (name, id, …) CountryCriteria

Query Parameters

Name

Description

Required

Default

Pattern

offset

The index of first element

null

limit

The max number of elements

null

Responses

Table 53. http response codes
Code	Message	Datatype
200	Countries successfully loaded	List[Country]
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


{
  "continent" : {
    "operator" : "IS",
    "value" : "Abcd",
    "includeNullResults" : false,
    "wildcards" : "*"
  },
  "companyId" : {
    "operator" : "IS",
    "value" : "Abcd",
    "includeNullResults" : false,
    "wildcards" : "*"
  },
  "code" : {
    "operator" : "IS",
    "value" : "Abcd",
    "includeNullResults" : false,
    "wildcards" : "*"
  },
  "name" : {
    "operator" : "IS",
    "value" : "Abcd",
    "includeNullResults" : false,
    "wildcards" : "*"
  },
  "calendardId" : {
    "operator" : "IS",
    "value" : "Abcd",
    "includeNullResults" : false,
    "wildcards" : "*"
  },
  "id" : {
    "operator" : "IS",
    "value" : "Abcd",
    "includeNullResults" : false,
    "wildcards" : "*"
  },
  "isPartOfEU" : {
    "operator" : "IS",
    "value" : false,
    "includeNullResults" : false
  }
}

2.11. Currencies

2.11.1. Retrieve all currencies

GET	/currencies

DMF required:

DMF A61604: Api Settings / Currencies / Search
DMF 190501: Web Portal / Expense Reports / Show
DMF 190502: Web Portal / Expense Reports / Modify
DMF 190511: Web Portal / Expense Reports / Modify Another Employee''s Expense Report
DMF 190513: Web Portal / Expense Reports / Ocr
DMF 0202__: Sales / Quotations
DMF 020202: Sales / Quotations / Modify
DMF 020204: Sales / Quotations / Search

Responses

Table 54. http response codes
Code	Message	Datatype
200	Currencies successfully retrieved	List[Currency]
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

2.11.2. Get a currency

GET	/currencies/{currency_code}

DMF required:

DMF A61606: Api Settings / Currencies / Info
DMF 190501: Web Portal / Expense Reports / Show
DMF 190502: Web Portal / Expense Reports / Modify
DMF 190511: Web Portal / Expense Reports / Modify Another Employee''s Expense Report
DMF 190513: Web Portal / Expense Reports / Ocr

Parameters

Path Parameters

Name

Description

Required

Default

Pattern

currency_code

The code of the currency

null

Responses

Table 55. http response codes
Code	Message	Datatype
200	Currency successfully retrieved	Currency
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

2.11.3. Search currencies

POST	/currencies/search

DMF required:

DMF A61604: Api Settings / Currencies / Search
DMF 190501: Web Portal / Expense Reports / Show
DMF 190502: Web Portal / Expense Reports / Modify
DMF 190511: Web Portal / Expense Reports / Modify Another Employee''s Expense Report
DMF 190513: Web Portal / Expense Reports / Ocr
DMF 0202__: Sales / Quotations
DMF 020202: Sales / Quotations / Modify
DMF 020204: Sales / Quotations / Search

Parameters

Body Parameter

Name

Description

Required

Default

Pattern

criteria

Search criteria CurrencyCriteria

Responses

Table 56. http response codes
Code	Message	Datatype
200	Search successfully completed	List[Currency]
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


{
  "code" : {
    "operator" : "IS",
    "value" : "Abcd",
    "includeNullResults" : false,
    "wildcards" : "*"
  },
  "availableExpenseReport" : {
    "operator" : "IS",
    "value" : false,
    "includeNullResults" : false
  },
  "id" : {
    "operator" : "IS",
    "value" : "Abcd",
    "includeNullResults" : false,
    "wildcards" : "*"
  },
  "dateEnd" : {
    "operator" : "IS",
    "value" : "2000-06-21T04:56:07.000+00:00",
    "includeNullResults" : false,
    "withTime" : false
  },
  "euroRateValidity" : {
    "type" : "{}",
    "date" : "2000-06-21T04:56:07.000+00:00"
  }
}

2.12. Custom Data

2.12.1. Get all custom data parameters for the type of customizable resource

GET	/custom-data-params/{customizable_resource}

Description

Get all custom data parameters for the type of customizable resource

Parameters

Path Parameters

Name

Description

Required

Default

Pattern

customizable_resource

The type of customizable resource

null

Query Parameters

Name

Description

Required

Default

Pattern

customizable_resource_id

The id of customizable resource

null

Responses

Table 57. http response codes
Code	Message	Datatype
200	List of all params of custom data for the customizable resource	List[CustomDataParam]
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

2.12.2. Get all custom data parameters

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

Parameters

Path Parameters

Name

Description

Required

Default

Pattern

customizable_resource

The type of customizable resource

null

Query Parameters

Name

Description

Required

Default

Pattern

customizable_resource_id

The id of customizable resource

null

Responses

Table 58. http response codes
Code	Message	Datatype
200	List of all params of custom data for the customizable resource	List[CustomDataParam]
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

2.13. Customer Indicators

2.13.1. Get the list of customer indicators

POST	/customer-indicators/search

DMF required:

DMF A63904: Api Settings / Customer Color Indicator / Customer Color Indicator Search
DMF 0901__: Administrator / Setup
DMF 020101: Sales / Customer / New
DMF 020102: Sales / Customer / Modify

Parameters

Body Parameter

Name

Description

Required

Default

Pattern

criteria

Search criteria CustomerIndicatorCriteria

Responses

Table 59. http response codes
Code	Message	Datatype
200	Successful customer indicators search	List[CustomerIndicator]
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


{
  "code" : {
    "operator" : "IS",
    "value" : "Abcd",
    "includeNullResults" : false,
    "wildcards" : "*"
  },
  "byDefault" : {
    "operator" : "IS",
    "value" : false,
    "includeNullResults" : false
  },
  "name" : {
    "operator" : "IS",
    "value" : "Abcd",
    "includeNullResults" : false,
    "wildcards" : "*"
  },
  "colorHexCode" : {
    "operator" : "IS",
    "value" : "Abcd",
    "includeNullResults" : false,
    "wildcards" : "*"
  },
  "id" : {
    "operator" : "IS",
    "value" : "Abcd",
    "includeNullResults" : false,
    "wildcards" : "*"
  }
}

2.14. Customer Status

2.14.1. Create a customer status.

PUT	/customer-status

Description

Create a customer status.
The creation of two customer status with the same code within the same company is not possible.

DMF required:

DMF A64401: Api Settings / Customer Status / Insert
DMF 0901__: Administrator / Setup

Parameters

Body Parameter

Name

Description

Required

Default

Pattern

customer_status

The customer status to create CustomerStatus

Responses

Table 60. http response codes
Code	Message	Datatype
201	Customer status has been succesfully created	[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


{
  "id" : "5000123",
  "code" : "CODE",
  "name" : "Name",
  "endDate" : "2000-06-21T04:56:07.000+00:00",
  "companyId" : "5000123",
  "ranking" : 5
}

2.14.2. Delete a customer status.

DELETE

/customer-status/{customer_status_id}

Description

Delete a customer status.
It is not possible to delete the setup of a customer status that is already in use.

DMF required:

DMF A64403: Api Settings / Customer Status / Delete
DMF 0901__: Administrator / Setup

Parameters

Path Parameters

Name

Description

Required

Default

Pattern

customer_status_id

The id of the customer status

null

Responses

Table 61. http response codes
Code	Message	Datatype
204	Customer status has been succesfully deleted	<<>>
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

2.14.3. Get a customer status.

GET	/customer-status/{customer_status_id}

DMF required:

DMF A64406: Api Settings / Customer Status / Info
DMF 0901__: Administrator / Setup

Parameters

Path Parameters

Name

Description

Required

Default

Pattern

customer_status_id

The id of the customer status

null

Responses

Table 62. http response codes
Code	Message	Datatype
200	Customer status has been succesfully loaded	CustomerStatus
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

2.14.4. Search for customer status (with search criteria)

POST	/customer-status/search

Description

Get the list of customer status matching the search criteria.

DMF required:

DMF A64404: Api Settings / Customer Status / Search
DMF 0901__: Administrator / Setup
DMF 020101: Sales / Customer / New
DMF 020102: Sales / Customer / Modify
DMF 020104: Sales / Customer / Search

Parameters

Body Parameter

Name

Description

Required

Default

Pattern

criteria

Criteria that you choose (code, name, etc…) CustomerStatusCriteria

Query Parameters

Name

Description

Required

Default

Pattern

offset

The index of first element

null

limit

The max number of elements

null

Responses

Table 63. http response codes
Code	Message	Datatype
200	Customer status succesfully loaded	List[CustomerStatus]
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


{
  "companyId" : {
    "operator" : "IS",
    "value" : "Abcd",
    "includeNullResults" : false,
    "wildcards" : "*"
  },
  "code" : {
    "operator" : "IS",
    "value" : "Abcd",
    "includeNullResults" : false,
    "wildcards" : "*"
  },
  "name" : {
    "operator" : "IS",
    "value" : "Abcd",
    "includeNullResults" : false,
    "wildcards" : "*"
  },
  "id" : {
    "operator" : "IS",
    "value" : "Abcd",
    "includeNullResults" : false,
    "wildcards" : "*"
  },
  "validity" : {
    "type" : "{}",
    "date" : "2000-06-21T04:56:07.000+00:00"
  }
}

2.14.5. Update a customer status

POST	/customer-status/{customer_status_id}

DMF required:

DMF A64402: Api Settings / Customer Status / Update
DMF 0901__: Administrator / Setup

Parameters

Path Parameters

Name

Description

Required

Default

Pattern

customer_status_id

The id of the customer status

null

Body Parameter

Name

Description

Required

Default

Pattern

customer_status

The customer status to update CustomerStatus

Responses

Table 64. http response codes
Code	Message	Datatype
200	Customer status has been succesfully 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


{
  "id" : "5000123",
  "code" : "CODE",
  "name" : "Name",
  "endDate" : "2000-06-21T04:56:07.000+00:00",
  "companyId" : "5000123",
  "ranking" : 5
}

2.15. Electronic Signature

2.15.1. Get electronic signature configuration settings

GET	/signature-control-settings

Get electronic signature configuration settings.
Use the query parameter to specify the domain for which you wish to get the electronic signature configuration settings.
For example: to get electronic signature configuration settings set the url as follows: 'GET /signature-control-settings?domain=sales'

DMF required:

DMF A65106: Api Settings / E-sign / Info
DMF 090151: Administrator / Setup / Labor
DMF 020201: Sales / Quotations / New
DMF 020206: Sales / Quotations / Show History

Parameters

Query Parameters

Name

Description

Required

Default

Pattern

domain

Specifies the domain for which to get the electronic signature configuration settings.

null

Return Type

array[ESignatureControlSetting]

Content Type

application/json

Responses

Table 65. http response codes
Code	Message	Datatype
200	The setup of sales electronic signatures successfully loaded	List[ESignatureControlSetting]
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.16. Feature Settings

2.16.1. Get the list of active features

GET	/features/active

Description

Get the list of active features

DMF required:

Parameters

Return Type

array[FeatureFlag]

Content Type

application/json

Responses

Table 66. http response codes
Code	Message	Datatype
200	Active features list retrieved	List[FeatureFlag]
400	Bad Request - Standard failure code. This code is used when no other specific code applies.	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.17. Filters

2.17.1. Create a filter

POST	/apps/{app_code}/project-filters

Description

Create a filter

DMF required:

DMF A60501: Api Settings / Filters / Insert
DMF 2501__: Project / Schedule View

Parameters

Path Parameters

Name

Description

Required

Default

Pattern

app_code

The application code

null

Body Parameter

Name

Description

Required

Default

Pattern

filter

The filter to be created ProjectFilter

Code	Message	Datatype
200	Filter successfully created	[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

Code	Message	Datatype
204	Filter successfully deleted	<<>>
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

Code	Message	Datatype
200	Filter successfully loaded	ProjectFilter
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

Code	Message	Datatype
200	The Filter successfully loaded	List[ProjectFilter]
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

Code	Message	Datatype
200	Filter 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

Code	Message	Datatype
200	The setup of fixed assets successfully loaded	FixedAssetSetup
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

Code	Message	Datatype
200	Geographical department successfully loaded	List[GeographicalDepartment]
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

Code	Message	Datatype
200	List of values of a keyword	List[KeywordValue]
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

Code	Message	Datatype
200	Keywords successfully retrieved	List[Keyword]
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

Code	Message	Datatype
200	Location status of maintened items have been successfully loaded	List[LocationStatus]
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

Code	Message	Datatype
200	My On boarding News	List[OnBoardingNews]
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

Code	Message	Datatype
200	OpportunityStage successfully created	[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

Code	Message	Datatype
200	OpportunityStagesTemplate successfully created	[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

Code	Message	Datatype
204	OpportunityStage successfully deleted	<<>>
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

Code	Message	Datatype
204	OpportunityStagesTemplate successfully deleted	<<>>
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

Code	Message	Datatype
200	OpportunityStage successfully loaded	OpportunityStage
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

Code	Message	Datatype
200	OpportunityStagesTemplate successfully loaded	OpportunityStagesTemplate
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

Code	Message	Datatype
200	Opportunity stages template successfully loaded with read options	OpportunityStagesTemplate
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

Code	Message	Datatype
200	Successful SprintStage search	List[OpportunityStage]
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

Code	Message	Datatype
200	Successful OpportunityStagesTemplate search	List[OpportunityStagesTemplate]
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

Code	Message	Datatype
200	OpportunityStage 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

Code	Message	Datatype
200	OpportunityStagesTemplate 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

Code	Message	Datatype
200	Types of other third party successfully loaded	List[OtherThirdPartyType]
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

Code	Message	Datatype
200	PeopleLinkType successfully created	[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

Code	Message	Datatype
204	People link type successfully deleted	<<>>
404	There is no people link type with this identifier	<<>>
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

Code	Message	Datatype
200	People link type successfully loaded	PeopleLinkType
404	There is no people link type	<<>>
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

Code	Message	Datatype
200	PeopleLinkType List loaded	List[PeopleLinkType]
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

Code	Message	Datatype
200	Search People Links Types results.	List[PeopleLinkType]
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

Code	Message	Datatype
200	PeopleLinkType successfully updated	[String]
404	There is no people link type	<<>>
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

Code	Message	Datatype
200	A Portal list	List[Portal]
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